Docs menu · Reference

Scans visible KV rows starting at an optional key. Each item includes the key, 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 full rows from the start, in key order.

CLI

$ strata command run --command-json '{"entries":[{"key":"YQ==","value":"MQ=="},{"key":"Yg==","value":"Mg=="}],"type":"kv_batch_put"}'
$ strata kv scan

Wire

{"entries":[{"key":"YQ==","value":"MQ=="},{"key":"Yg==","value":"Mg=="}],"type":"kv_batch_put"}
{"type":"kv_scan"}

Parameters

NameTypeRequiredDescription
limitintegernoOptional row limit.
startBytesnoOptional inclusive start key.

Plus the optional scope: branch and space (default to the session branch and the "default" space).

Returns

Page<ScanItem, Bytes>.

Errors

Invocation

  • CLI: strata kv scan
  • Wire type: kv_scan

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