Top.Mail.Ru
index_object:delete() | Tarantool
 

index_object:delete()

index_object:delete()

object index_object
index_object:delete(key)

Delete a tuple identified by a key.

Same as box.space…delete(), but key is searched in this index instead of in the primary-key index. This index ought to be unique.

Parameters:
  • index_object (index_object) – an object reference.
  • key (scalar/table) – values to be matched against the index key
Return:

the deleted tuple.

Rtype:

tuple

Note re storage engine: vinyl will return nil, rather than the deleted tuple.