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

index_object:rename()

index_object

rename(index-name)

Rename an index.

Parameters:

  • index_object (index_object) — an object reference.

  • index-name (string) — new name for index

Returns

nil

Possible errors: index_object does not exist.

Example:

tarantool> box.space.space55.index.primary:rename('secondary')---...

Complexity factors: Index size, Index type, Number of tuples accessed.