datastore

Documentation

Overview

Package datastore provides abstraction to datastore operations.

Index

• type Direction
• type Filter
• type Order
• type Query

Types

type Direction

type Direction string

Direction represents the sorting direction.

const (
	DirectionASC  Direction = "ASC"
	DirectionDESC Direction = "DESC"
)

Possible ordering directions.

type Filter

type Filter struct {
	Path     string      `json:"path"`
	Operator string      `json:"operator"`
	Value    interface{} `json:"value"`
}

Filter represents a filtering criteria.

type Order

type Order struct {
	Path      string    `json:"path"`
	Direction Direction `json:"direction"`
}

Order represents an ordering criteria.

type Query

type Query struct {
	Limit   int      `json:"limit"`
	Orders  []Order  `json:"orders"`
	Filters []Filter `json:"filters"`
}

Query represents the abstraction of any datastore query.

For a query with multiple Filters, they are treated as a set of criterion joined with AND condition behind the scenes.

For queries needing to use the OR condition, it is more efficient to split the query into multiple separate ones, run them separately in concurrently and combine the results afterwards.