Module tarantool::index

source ·
Expand description

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:

Structs

An index is a group of key values and pointers.
Index iterator. Can be used with for statement.
List of options for new or updated index.
Index part.

Enums

Type of index part.
Type of index.
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.
Type of distance for retree index.
Sequence option for new or updated index.

Type Definitions

IndexFieldTypeDeprecated
IndexPartDeprecated
Use SequenceOpt instead