Tarantool CE/EE Documentation portal logo
Support
Updated at July 17, 2026   02:08 PM

index_object:get()

index_object

get(key)

Search for a tuple via the given index, as described in the select topic.

Parameters:

  • index_object (index_object) — an object reference.

  • key (scalar/table) — values to be matched against the index key

Returns

the tuple whose index-key fields are equal to the passed key values.

Return type

tuple

Possible errors:

  • no such index;
  • wrong type;
  • more than one tuple matches.

Complexity factors: Index size, Index type. See also space_object:get().

Example:

tarantool> box.space.tester.index.primary:get(2)---- [2, 'Music']...