storage

type And []Filter

type Condition struct {
	Field string
	Op    Operator
	Value any
}

type ConflictError struct {
	Fields []string // fields of the violated index, in API terms; may be empty
}

type Const bool

type Document = map[string]any

type Eraser interface {
	// CountOwned counts the documents whose _meta.owner is the user.
	CountOwned(ctx context.Context, owner string) (int64, error)
	// CountReferences counts the documents where field (an array of strings
	// when array is true, else a string) holds value.
	CountReferences(ctx context.Context, field, value string, array bool) (int64, error)
	// DeleteOwned deletes up to limit documents the user owns.
	DeleteOwned(ctx context.Context, owner string, limit int) (int64, error)
	// AnonymizeOwned removes the fields in remove, sets those in replace and
	// clears _meta.owner on up to limit documents the user owns.
	AnonymizeOwned(ctx context.Context, owner string, remove []string, replace map[string]any, limit int, now time.Time) (int64, error)
	// PullReference removes value from the array field of up to limit
	// documents that contain it.
	PullReference(ctx context.Context, field, value string, limit int, now time.Time) (int64, error)
	// ClearReference unsets the string field of up to limit documents where
	// it equals value.
	ClearReference(ctx context.Context, field, value string, limit int, now time.Time) (int64, error)
}

type Filter interface {
	// contains filtered or unexported methods
}

type Not struct{ Filter Filter }

type Operator string

type Or []Filter

type Page struct {
	Items   []Document
	HasMore bool
	Total   *int64 // set only when Query.Count is true
}

type Query struct {
	// Filter is the client's where: a tree of conditions combined with
	// And and Or. nil matches everything.
	Filter Filter
	Sort   []SortField // applied in order; ends with "id" as a tiebreaker
	Limit  int
	Skip   int
	Count  bool // also compute the total number of matching documents
	// Access restricts the query to documents the caller may read
	// (from access rules); nil means no restriction.
	Access Filter
	// After restricts the page to the documents positioned after a cursor in
	// Sort (query.ParseCursor builds it). It narrows the page, not the Total.
	After Filter
}

type Repository interface {
	// Create stores doc, which must already carry "id" and "_meta".
	Create(ctx context.Context, doc Document) error
	// Get returns the document with the given id, or ErrNotFound.
	Get(ctx context.Context, id string) (Document, error)
	// List returns a page of documents.
	List(ctx context.Context, q Query) (Page, error)
	// Replace overwrites the document with doc["id"] only if its stored
	// _meta.version equals ifVersion (0 means "stored without a version").
	// It returns ErrNotFound or ErrVersionMismatch otherwise.
	Replace(ctx context.Context, doc Document, ifVersion int64) error
	// Delete removes the document with the given id. When ifVersion is not
	// nil the stored version must equal it. It returns ErrNotFound or
	// ErrVersionMismatch otherwise.
	Delete(ctx context.Context, id string, ifVersion *int64) error
}

type SortField struct {
	Field string
	Desc  bool
}