Module index

Box: indices

The index submodule provides access for index definitions and index keys. They provide an API for ordered iteration over tuples. This API is a direct binding to corresponding methods of index objects of type box.index in the storage engine.

See also:

• Indexes
• Lua reference: Submodule box.index

Structs

Builder

FieldMustBeNumber

Index

An index is a group of key values and pointers.

IndexIterator

Index iterator. Can be used with for statement.

IndexOptions

List of options for new or updated index.

Metadata

Representation of a tuple holding index metadata in system _index space.

Part

Index part.

SeqSpec

Enums

FieldType

Type of index part.

IndexType

Type of index.

IteratorType

Controls how to iterate over tuples in an index. Different index types support different iterator types. For example, one can start iteration from a particular value (request key) and then retrieve all tuples where keys are greater or equal (= GE) to this key.

RtreeIndexDistanceType

Type of distance for retree index.

SequenceOpt

Sequence option for new or updated index.

Type Aliases

IndexFieldTypeDeprecated

IndexId

IndexPartDeprecated

IndexSequenceOptionDeprecated

Use SequenceOpt instead