json

batch_get

Read multiple JSON values by document and path.

db.json.get_many(entries: 'Any') -> 'list[Any]'

wire json_batch_get

Reads several document/path entries and returns positional item results. Each item records whether the value was found and includes version metadata when present.

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.get_many)

Example

Read many documents at once.

_ = db.json.set_many([{"key": "a", "path": "$", "value": {"v": 1}}, {"key": "b", "path": "$", "value": {"v": 2}}])db.json.get_many([{"key": "a", "path": "$"}, {"key": "b", "path": "$"}])

Parameters

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

Returns

BatchResult<Maybe<JsonValue>>

  • dataBatchResult4
  • typestring

Errors

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

← All 16 JSON commands

agents: this page as markdown → /docs/reference/json/batch_get.md