Skip to main content

Module index

Module index 

Source
Expand description

Declared secondary indexes. Declared secondary indexes: the client chooses what is fast.

An index belongs to one record label and one property (by normalized family name, so it covers every typed definition of that property). Its entries are derived rows maintained by the apply-time deriver; the state decides which records they cover, so entries always equal a from-scratch derivation of the base rows, including while a build or drop is running.

Structs§

IndexDef
One declared index.

Enums§

IndexKind
What an index answers.
IndexState
Lifecycle of an index. Records covered by the entries: Building{cursor} covers ordinals < cursor, Ready covers all, and Dropping{cursor} covers ordinals ≥ cursor.
TextConsistency
When a text search sees committed writes.

Constants§

TEXT_ALL_PROPERTIES
Property name of a text index covering every string property (and of a structural index, which covers no single property).