json
list
List JSON document keys with optional prefix filtering.
strata json listdb.json.keys(prefix: 'Optional[str]' = None, *, limit: 'Optional[int]' = None, cursor: 'Optional[Any]' = None, as_of: 'Optional[int]' = None, as_of_time: 'Optional[TimeLike]' = None) -> 'Page'wire json_list
Lists visible JSON document keys in byte order. Prefix, cursor, limit, and timestamp parameters constrain the page returned by the executor.
Paginated responses use opaque cursors. Clients should pass the returned cursor back to the same command shape and must not parse cursor contents.
To see the complete help for this command, run:
strata json list --helphelp(db.json.keys)
Example
List document keys under a prefix, in key order.
strata json set user:1 $ {"v":1}strata json set user:2 $ {"v":2}strata json set other $ {"v":3}strata json list --prefix user:
_ = db.json.set("user:1", "$", {"v": 1})_ = db.json.set("user:2", "$", {"v": 2})_ = db.json.set("other", "$", {"v": 3})db.json.keys("user:").items
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| as_of | integer or null | no | Read as of a position on the logical commit timeline - the `timestamp` from `history` output, not the `version`, and never a calendar date. To read as of a real time, use `as_of_time` instead. |
| as_of_time | integer or null | no | Read as of a real time: a wall-clock instant in microseconds since the Unix epoch (UTC), as reported by `committed_at` on a write ack or on any `history` row. Resolves to the commit at or before that instant, and fails rather than guessing if the instant falls outside the branch's recorded history. Mutually exclusive with `as_of`. |
| branch | string or null | no | Target branch. Defaults to the executor handle branch. |
| cursor | string or null | no | Optional document key cursor. |
| limit | integer or null | no | Optional item limit. |
| prefix | string or null | no | Optional document key prefix. |
| space | string or null | no | Target product space. Defaults to `"default"`. |
Returns
Page<String, String>
- dataobject
Shared pagination continuation facts.
- 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 |