Scans visible JSON documents starting at an optional document key. Each item includes the key, full document value, and commit metadata exposed by the executor output.
Paginated responses use opaque cursors. Clients should pass the returned cursor back to the same command shape and must not parse cursor contents.
Examples
Scan documents from the start, in key order.
CLI
$ strata command run --command-json '{"entries":[{"key":"a","path":"$","value":{"v":1}},{"key":"b","path":"$","value":{"v":2}}],"type":"json_batch_set"}'
$ strata json scanWire
{"entries":[{"key":"a","path":"$","value":{"v":1}},{"key":"b","path":"$","value":{"v":2}}],"type":"json_batch_set"}
{"type":"json_scan"}Parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Optional row limit. |
start | string | no | Optional inclusive start document key. |
Plus the optional scope: branch and space (default to the session branch and the "default" space).
Returns
Page<JsonSampleItem, String>.
Errors
failed_precondition.engine.runtime_closednot_found.engine.branchinvalid_argument.engine.product_spaceinvalid_argument.engine.json_document_id
Invocation
- CLI:
strata json scan - Wire type:
json_scan