type

ListOptions

type ListOptions struct {
	// Where filters documents before pagination and remains atomic with access predicates.
	Where query.Expression
	// Page is the one-based result page. Zero selects the first page.
	Page int
	// Limit is the maximum documents returned per page.
	Limit int
	// Sort orders results by authored field paths.
	Sort []query.Sort
	// Select restricts returned document fields.
	Select []query.Path
	// Populate expands configured relationship paths.
	Populate []query.Population
	// OutputFields limits computed and inverse-join resolution without
	// projecting away stored fields. Nil resolves all output fields; a non-nil
	// empty slice resolves none.
	OutputFields []query.Path
	// Draft explicitly includes draft documents when true or restricts reads to
	// published documents when false. Nil preserves the Local API default.
	Draft *bool
	// Actor is the authenticated document used by access rules.
	Actor *store.Document
	// ActorCollection identifies the exact auth collection that owns Actor.
	ActorCollection schema.CollectionSlug
	// TrashOnly returns deleted documents and is valid only for trash-enabled collections.
	TrashOnly bool
	// Locale selects one configured content locale. Empty uses the application default.
	Locale schema.LocaleCode
	// FallbackLocales replaces the locale's configured fallback chain when non-nil.
	FallbackLocales []schema.LocaleCode
	// DisableFallback requires an exact value in Locale.
	DisableFallback bool
	// AllLocales returns locale-keyed values for localized fields.
	AllLocales bool
}

Filtering, pagination, projection, population, authorization, and locale controls for a list read.

Source core/local.go:20

Wherequery.Expression: Filter documents atomically with the access predicate.
Pageint: One-based page; zero selects the first.
Limitint: Maximum documents returned per page.
Sort[]query.Sort: Stable authored-field ordering.
Select[]query.Path: Restrict returned stored fields.
Populate[]query.Population: Expand configured relationship paths.
OutputFields[]query.Path: Limit computed and inverse-join fields independently of Select.
Draft*bool: Include drafts when true or require published content when false.
Actor*store.Document: Actor used by access rules.
ActorCollectionschema.CollectionSlug: Exact auth collection owning Actor.
TrashOnlybool: List trashed documents only.
Localeschema.LocaleCode: Selected content locale.
FallbackLocales[]schema.LocaleCode: Optional replacement fallback chain.
DisableFallbackbool: Disable locale fallbacks.
AllLocalesbool: Return all localized values.

The root package re-exports this type as ridu.ListOptions. TrashOnly is valid only for trash-enabled collections.