package com.deno.kv.datapath

Get desktop application:
View/edit binary Protocol Buffers messages

A request to write some data.

• repeated Check checks = 1

  The checks to perform before writing.

• repeated Mutation mutations = 2

  The mutations to perform.

• repeated Enqueue enqueues = 3

  The enqueues to perform.

• AtomicWriteStatus status = 1

  The status of the write.

• bytes versionstamp = 2

  The versionstamp of the commit that wrote the data.

• repeated uint32 failed_checks = 4

  The indexes to checks that failed their check condition.

The status of an atomic write.

Used in: AtomicWriteOutput

• AW_UNSPECIFIED = 0

  The write failed, but the exact status is unspecified or unknown. The request should not be retried.

• AW_SUCCESS = 1

  The write succeeded.

• AW_CHECK_FAILURE = 2

  The write failed because a check failed.

• AW_WRITE_DISABLED = 5

  The write failed because the region is unable to serve writes right now.

A mutation to perform.

Used in: AtomicWrite

• bytes key = 1

  The key to check.

• bytes versionstamp = 2

  The expected versionstamp of the value. If the value does not have this versionstamp, the check fails. A 0-length versionstamp means "check that the value does not exist".

  10-byte raw versionstamp

A request to enqueue a message.

Used in: AtomicWrite

• bytes payload = 1

  The payload of the message, encoded as a V8 ValueSerializer value.

• int64 deadline_ms = 2

  The time at which the message should be delivered, in milliseconds since the Unix epoch (UTC). If the deadline is in the past, the message will be scheduled for delivered immediately.

• repeated bytes keys_if_undelivered = 3

  The keys to write the value to if the maximum number of re-deliveries according to the backoff schedule has been reached.

• repeated uint32 backoff_schedule = 4

  The backoff schedule to use if delivery fails. This is a list of delays in milliseconds. The first delay is the delay before the first retry, the second delay is the delay before the second retry, and so on. If the list is empty, the message will not be retried.

A key-value entry.

Used in: ReadRangeOutput, WatchKeyOutput

• bytes key = 1

  The key.

• bytes value = 2

  The encoded value bytes.

• ValueEncoding encoding = 3

  The encoding of the value.

• bytes versionstamp = 4

  The versionstamp of the commit that last wrote this value.

Used in: Mutation

• bytes data = 1

• ValueEncoding encoding = 2

A mutation to perform.

Used in: AtomicWrite

• bytes key = 1

  The key to mutate.

• optional KvValue value = 2

  The mutation value. This is ignored for clear mutations.

• MutationType mutation_type = 3

  The type of mutation to perform.

• int64 expire_at_ms = 4

  An expiry time for the value, in milliseconds since the Unix epoch (UTC). If this is set to 0, the value will never expire.

• bytes sum_min = 5

  A V8-encoded value that represents the minimum allowed value of the result of a `sum` operation. Only valid if `mutation_type` is `M_SUM` and `value.encoding` is `VE_V8`.

• bytes sum_max = 6

  A V8-encoded value that represents the maximum allowed value of the result of a `sum` operation. Only valid if `mutation_type` is `M_SUM` and `value.encoding` is `VE_V8`.

• bool sum_clamp = 7

  If true, a result outside sum_min..=sum_max will be clamped. Otherwise, an error is returned and the atomic operation is not applied. Only valid if `mutation_type` is `M_SUM` and `value.encoding` is `VE_V8`.

The type of a mutation.

Used in: Mutation

• M_UNSPECIFIED = 0

  The mutation type is unspecified or unknown.

• M_SET = 1

  Set the value.

• M_DELETE = 2

  Delete the value.

• M_SUM = 3

  Sum the stored value with the new value. Both values must be LE64 encoded.

• M_MAX = 4

  Min the stored value with the new value. Both values must be LE64 encoded.

• M_MIN = 5

  Max the stored value with the new value. Both values must be LE64 encoded.

• M_SET_SUFFIX_VERSIONSTAMPED_KEY = 9

  Set the value, with the versionstamp appended to the end of the key as a string.

A key range to read. The range is inclusive of the start and exclusive of the end.

Used in: SnapshotRead

• bytes start = 1

  The first key to read.

• bytes end = 2

  The key after the last key to read.

• int32 limit = 3

  How many values to read. The backend may return fewer values than this if there are not enough values in the range.

• bool reverse = 4

  If true, the values are returned in reverse order (from end to start). This does not change inclusive/exclusive semantics.

The response to a read range request.

Used in: SnapshotReadOutput

• repeated KvEntry values = 1

  The values read in the range. The values are in key order.

A request to read some data.

• repeated ReadRange ranges = 1

  The key ranges to read.

The response to a read request. The request is considered successful if the length of the ranges in the input and output match.

• repeated ReadRangeOutput ranges = 1

  The read ranges. The ranges are in the same order as the read ranges in the request.

• bool read_disabled = 2

  The request failed because this region does not support reading data. This is equivalent to status being SR_READ_DISABLED.

• bool read_is_strongly_consistent = 4

  Whether the read was strongly consistent.

• SnapshotReadStatus status = 8

  The status of the read.

The status of a read request.

Used in: SnapshotReadOutput, WatchOutput

• SR_UNSPECIFIED = 0

  The read status is unspecified or unknown.

• SR_SUCCESS = 1

  The read succeeded.

• SR_READ_DISABLED = 2

  The read failed because the region is unable to serve reads right now.

The encoding of a value.

Used in: KvEntry, KvValue

• VE_UNSPECIFIED = 0

  The encoding is unspecified or unknown.

• VE_V8 = 1

  The value is encoded using V8 ValueSerializer encoding.

• VE_LE64 = 2

  The value is encoded using little-endian 64-bit integer encoding.

• VE_BYTES = 3

  The value is a literal byte array.

A request to watch some keys for updates.

• repeated WatchKey keys = 1

  The keys to watch.

A key to watch.

Used in: Watch

• bytes key = 1

  The key to watch.

The response to a watch request for a single key.

Used in: WatchOutput

• bool changed = 1

  Whether the value changed since the last watch delivery.

• optional KvEntry entry_if_changed = 2

  The new value, if changed is true.

The response to a watch request.

• SnapshotReadStatus status = 1

  The status of the watch.

• repeated WatchKeyOutput keys = 2

  For each watched key, whether the value changed since the last watch request, and if so, the new value.