kv

batch_delete

Delete multiple KV keys in one itemwise batch.

db.kv.delete_many(keys: 'Sequence[str | bytes]') -> 'BatchResult'

wire kv_batch_delete

Deletes multiple KV keys and returns one positional mutation result per key. Missing keys are represented as no-op item results.

Itemwise batches return one positional item result per input item. The outer batch status summarizes whether all, some, or none of the items succeeded.

To see the complete help for this command, run:

help(db.kv.delete_many)

Example

Delete many keys in one commit.

_ = db.kv.put_many([{"key": "a", "value": "1"}, {"key": "b", "value": "2"}])_ = db.kv.delete_many(["a", "b"])db.kv.exists_many(["a", "b"])

Parameters

NameTypeRequiredDescription
keysarrayyesKeys to delete.
branchstring or nullnoTarget branch. Defaults to the executor handle branch.
spacestring or nullnoTarget product space. Defaults to `"default"`.

Returns

BatchResult<KvMutationItem>

  • dataBatchResult
  • typestring

Errors

Recover by code. Retry policy and commit outcome come from the shipped error registry.

← All 13 Key-value commands

agents: this page as markdown → /docs/reference/kv/batch_delete.md