type

Request

type Request struct {
	Collection  schema.Collection
	Collections map[schema.StableID]schema.Collection
	ID          string
	Filter      *query.Node
	Access      *query.Node
	Page        int
	Limit       int
	Sort        []query.Sort
	// IndexWindow is set only for a count-free range read over one direct,
	// unique, indexed text field. Adapters must not broaden this range into a
	// count or offset query.
	IndexWindow *IndexWindow
	// Select is nil for all authored fields. A non-nil empty slice returns only
	// document metadata.
	Select           []query.Path
	Populate         []query.Population
	PopulationAccess map[schema.StableID]*query.Node
	// PopulationBudget is shared by every recursive population read that
	// contributes to one response. Official adapters initialize a default when
	// callers omit it so direct store use cannot bypass the materialization cap.
	PopulationBudget *PopulationBudget
	// PublishedOnly restricts every versioned collection read participating in
	// this request, including populated targets. Unversioned collections ignore it.
	PublishedOnly    bool
	Deletion         DeletionMode
	ExpectedRevision int
	// Locales is the complete configured locale order used to decode canonical
	// localized storage. LocaleChain starts with the requested locale and then
	// contains effective fallbacks used by atomic filtering and sorting.
	Locales     []schema.LocaleCode
	LocaleChain []schema.LocaleCode
	AllLocales  bool
	// Lock identifies the row lock required by a semantic read. Ordinary reads
	// use LockNone; relationship validation uses LockReference to keep an
	// accepted target from changing or being deleted before the enclosing write
	// commits. Coordinated framework mutations use LockMutation and acquire all
	// participants in deterministic reference order.
	Lock LockMode
}

Collection schema, predicates, pagination, locale, projection, and lock controls.

Source store/store.go:52

Collectionschema.Collection: Resolved target schema.
Collectionsmap[schema.StableID]schema.Collection: Schemas available for relationship operations.
IDstring: Target document ID.
Filter*query.Node: Caller-owned filter predicate.
Access*query.Node: Authorization predicate applied atomically with Filter.
Pageint: One-based result page.
Limitint: Maximum documents per page.
Sort[]query.Sort: Stable ordering.
IndexWindow*IndexWindow: Optional bounded unique-index range used by ListWindow.
Select[]query.Path: Selected stored fields.
Populate[]query.Population: Relationship population requests.
PopulationAccessmap[schema.StableID]*query.Node: The PopulationAccess value.
PopulationBudget*PopulationBudget: PopulationBudget is shared by every recursive population read that contributes to one response. Official adapters initialize a default when callers omit it so direct store use cannot bypass the materialization cap.
PublishedOnlybool: Restrict versioned reads to published documents.
DeletionDeletionMode: Active or trashed selection.
ExpectedRevisionint: Optimistic concurrency revision.
Locales[]schema.LocaleCode: Locales is the complete configured locale order used to decode canonical localized storage. LocaleChain starts with the requested locale and then contains effective fallbacks used by atomic filtering and sorting.
LocaleChain[]schema.LocaleCode: Requested locale followed by effective fallbacks.
AllLocalesbool: Select every locale.
LockLockMode: Required row-lock strength.