Docs menu · Reference

Lists visible KV 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.

Examples

List keys under a prefix, in key order.

CLI

$ strata command run --command-json '{"entries":[{"key":"dXNlcjox","value":"YQ=="},{"key":"dXNlcjoy","value":"Yg=="},{"key":"b3RoZXI=","value":"Yw=="}],"type":"kv_batch_put"}'
$ strata kv list --prefix user:

Wire

{"entries":[{"key":"dXNlcjox","value":"YQ=="},{"key":"dXNlcjoy","value":"Yg=="},{"key":"b3RoZXI=","value":"Yw=="}],"type":"kv_batch_put"}
{"prefix":"dXNlcjo=","type":"kv_list"}

Parameters

NameTypeRequiredDescription
as_ofintegernoOptional timestamp in microseconds.
cursorBytesnoOptional key cursor.
limitintegernoOptional item limit. Defaults to 100.
prefixBytesnoOptional key prefix.

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

Returns

Page<Bytes, Bytes>.

Errors

Invocation

  • CLI: strata kv list
  • Wire type: kv_list

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