type
ListOptions
Filter, page, sort, projection, population, actor, draft, trash, and locale list controls.
Properties
| Property | Type | Description |
|---|---|---|
Where | query.Expression | Filter documents atomically with the access predicate. |
Page | int | One-based page; zero selects the first. |
Limit | int | Maximum documents returned per page. |
SkipTotal | bool | SkipTotal skips counting every match, like REST pagination=false. The page then has a nil Total and an exact HasNextPage. |
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. |
ActorCollection | schema.CollectionSlug | Exact auth collection owning Actor. |
System | bool | System runs the call as trusted server code: collection, field, draft and reference access rules are skipped. Validation, hooks, versions and reference integrity still apply, and Actor, when set, still reaches hooks. Only Go code can set it; REST and GraphQL never do. |
TrashOnly | bool | List trashed documents only. |
Locale | schema.LocaleCode | Selected content locale. |
FallbackLocales | []schema.LocaleCode | Optional replacement fallback chain. |
DisableFallback | bool | Disable locale fallbacks. |
AllLocales | bool | Return all localized values. |
How it works
The root package re-exports this type as ridu.ListOptions. TrashOnly is valid only for trash-enabled collections.