json
batch_delete
Delete multiple JSON documents or paths in one itemwise batch.
db.json.delete_many(entries: 'Any') -> 'BatchResult'wire json_batch_delete
Deletes multiple document/path entries and returns one positional mutation result per entry. Missing documents and paths are represented as no-op item results; applied items share one engine commit.
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.json.delete_many)
Example
Delete many documents in one commit.
_ = db.json.set_many([{"key": "a", "path": "$", "value": {"v": 1}}])_ = db.json.delete_many([{"key": "a", "path": "$"}])db.json.exists("a")
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| entries | array | yes | Entries to delete. |
| branch | string or null | no | Target branch. Defaults to the executor handle branch. |
| space | string or null | no | Target product space. Defaults to `"default"`. |
Returns
BatchResult<JsonMutationItem>
- dataBatchResult3
- typestring
Errors
Recover by code. Retry policy and commit outcome come from the shipped error registry.
| Code | Retry | Commit outcome |
|---|---|---|
| failed_precondition.engine.runtime_closed | never | not_started |
| not_found.engine.branch | never | not_applicable |
| invalid_argument.engine.product_space | never | not_started |
| invalid_argument.engine.json_document_id | never | not_started |
| invalid_argument.engine.json_path | never | not_started |
| invalid_argument.engine.json_path_too_long | never | not_started |
| invalid_argument.engine.json_path_type | never | not_started |
| invalid_argument.executor.json_batch_duplicate_key | never | not_started |