space_object:delete()
-
object
space_object
¶ -
space_object:
delete
(key)¶ Delete a tuple identified by the primary key.
Parameters: - space_object (
space_object
) – an object reference - key (
scalar/table
) – primary-key field values, must be passed as a Lua table if key is multi-part
Return: the deleted tuple
Rtype: tuple
Possible errors:
ER_TRANSACTION_CONFLICT
if a transaction conflict is detected in the MVCC transaction mode.
Complexity factors: Index size, Index type
Note regarding storage engine: vinyl will return
nil
, rather than the deleted tuple.Example:
tarantool> box.space.tester:delete(1) --- - [1, 'My first tuple'] ... tarantool> box.space.tester:delete(1) --- ... tarantool> box.space.tester:delete('a') --- - error: 'Supplied key type of part 0 does not match index part type: expected unsigned' ...
For more usage scenarios and typical errors see Example: using data operations further in this section.
- space_object (
-