kv

get

Read the current or historical value for one KV key.

strata kv get

wire kv_get

Reads one KV key from the selected branch and space. The optional timestamp reads the value visible at that point in time when history is retained.

Optional reads distinguish present data from missing data. When version or timestamp facts exist on the executor output, SDK mappings should preserve them.

To see the complete help for this command, run:

strata kv get --help

Example

Read a value back; a missing key returns nothing.

strata kv put greeting hellostrata kv get greetingstrata kv get absent

Parameters

NameTypeRequiredDescription
keyBytesyesKey bytes.
as_ofinteger or nullnoRead 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_timeinteger or nullnoRead 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`.
branchstring or nullnoTarget branch. Defaults to the executor handle branch.
spacestring or nullnoTarget product space. Defaults to `"default"`.

Returns

Maybe<VersionedValue>

  • dataMaybe
  • typestring

Errors

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

CodeRetryCommit outcome
failed_precondition.engine.runtime_closednevernot_started
not_found.engine.branchnevernot_applicable
invalid_argument.engine.product_spacenevernot_started
invalid_argument.engine.kv_keynevernot_started
history_unavailable.engine.persistence_historyafter_state_changenot_applicable
← All 13 Key-value commands

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