type

ListWindowOptions

A count-free bounded unique-index range for background work.

Properties

Property	Type	Description
`Index`	`query.Path`	Direct unique, indexed, non-localized text field used for ordering.
`LowerBound`	`string`	Inclusive non-empty lower index bound.
`UpperBound`	`string`	Exclusive non-empty upper index bound.
`Limit`	`int`	Maximum documents returned.
`Select`	`[]query.Path`	Restrict returned stored fields.
`Actor`	`*store.Document`	Actor used by access rules.
`ActorCollection`	`schema.CollectionSlug`	Exact auth collection owning Actor.
`System`	`bool`	System skips access rules for trusted server code; see ListOptions.System.
`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.ListWindowOptions. The store transaction must implement the optional store.WindowTransaction capability.

Full signature

type ListWindowOptions struct {
	Index           query.Path
	LowerBound      string
	UpperBound      string
	Limit           int
	Select          []query.Path
	Actor           *store.Document
	ActorCollection schema.CollectionSlug
	// System skips access rules for trusted server code; see ListOptions.System.
	System          bool
	Locale          schema.LocaleCode
	FallbackLocales []schema.LocaleCode
	DisableFallback bool
	AllLocales      bool
}

Source core/local.go:100