package etcdserverpb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc DeleteRange (DeleteRangeRequest, DeleteRangeResponse)

  etcd.proto:9

• rpc Put (PutRequest, PutResponse)

  etcd.proto:7

• rpc Range (RangeRequest, RangeResponse)

  etcd.proto:8

CompactionRequest compacts the key-value store up to a given revision. All superseded keys with a revision less than the compaction revision will be removed.

• int64 revision = 1

  revision is the key-value store revision for the compaction operation.

• bool physical = 2

  physical is set so the RPC will wait until the compaction is physically applied to the local database such that compacted entries are totally removed from the backend database.

• optional ResponseHeader header = 1

Used in: TxnRequest

• Compare.CompareResult result = 1

  result is logical comparison operation for this comparison.

• Compare.CompareTarget target = 2

  target is the key-value field to inspect for the comparison.

• bytes key = 3

  key is the subject key for the comparison operation.

• oneof target_union

  • int64 version = 4

    version is the version of the given key

  • int64 create_revision = 5

    create_revision is the creation revision of the given key

  • int64 mod_revision = 6

    mod_revision is the last modified revision of the given key.

  • bytes value = 7

    value is the value of the given key, in bytes.

  • int64 lease = 8

    lease is the lease id of the given key.

    leave room for more target_union field tags, jump to 64

• bytes range_end = 64

  range_end compares the given target to all keys in the range [key, range_end). See RangeRequest for more details on key ranges.

  TODO: fill out with most of the rest of RangeRequest fields when needed.

Used in: Compare

• EQUAL = 0

• GREATER = 1

• LESS = 2

• NOT_EQUAL = 3

Used in: Compare

• VERSION = 0

• CREATE = 1

• MOD = 2

• VALUE = 3

• LEASE = 4

option (versionpb.etcd_version_msg) = "3.0";

Used as request type in: KV.DeleteRange

Used as field type in: RequestOp, lskvserverpb.ReceiptClaims

• bytes key = 1

  key is the first key to delete in the range.

• bytes range_end = 2

  range_end is the key following the last key to delete for the range [key, range_end). If range_end is not given, the range is defined to contain only the key argument. If range_end is one bit larger than the given key, then the range is all the keys with the prefix (the given key). If range_end is '\0', the range is all keys greater than or equal to the key argument.

• bool prev_kv = 3

  If prev_kv is set, etcd gets the previous key-value pairs before deleting it. The previous key-value pairs will be returned in the delete response.

  [(versionpb.etcd_version_field)="3.1"];

option (versionpb.etcd_version_msg) = "3.0";

Used as response type in: KV.DeleteRange

Used as field type in: ResponseOp, lskvserverpb.ReceiptClaims

• optional ResponseHeader header = 1

• int64 deleted = 2

  deleted is the number of keys deleted by the delete range request.

• repeated KeyValue prev_kvs = 3

  if prev_kv is set in the request, the previous key-value pairs will be returned.

  [(versionpb.etcd_version_field)="3.1"];

Used in: DeleteRangeResponse, PutResponse, RangeResponse

• bytes key = 1

  key is the key in bytes. An empty key is not allowed.

• int64 create_revision = 2

  create_revision is the revision of last creation on this key.

• int64 mod_revision = 3

  mod_revision is the revision of last modification on this key.

• int64 version = 4

  version is the version of the key. A deletion resets the version to zero and any modification of the key increases its version.

• bytes value = 5

  value is the value held by the key, in bytes.

• int64 lease = 6

  lease is the ID of the lease that attached to key. When the attached lease expires, the key will be deleted. If lease is 0, then no lease is attached to the key.

• int64 TTL = 1

  TTL is the advisory time-to-live in seconds. Expired lease will return -1.

• int64 ID = 2

  ID is the requested ID for the lease. If ID is set to 0, the lessor chooses an ID.

• optional ResponseHeader header = 1

• int64 ID = 2

  ID is the lease ID for the granted lease.

• int64 TTL = 3

  TTL is the server chosen lease time-to-live in seconds.

• string error = 4

• int64 ID = 1

  ID is the lease ID for the lease to keep alive.

• optional ResponseHeader header = 1

• int64 ID = 2

  ID is the lease ID from the keep alive request.

• int64 TTL = 3

  TTL is the new time-to-live for the lease.

(message has no fields)

• optional ResponseHeader header = 1

• repeated LeaseStatus leases = 2

• int64 ID = 1

  ID is the lease ID to revoke. When the ID is revoked, all associated keys will be deleted.

• optional ResponseHeader header = 1

Used in: LeaseLeasesResponse

• int64 ID = 1

  TODO: int64 TTL = 2;

• int64 ID = 1

  ID is the lease ID for the lease.

• bool keys = 2

  keys is true to query all the keys attached to this lease.

• optional ResponseHeader header = 1

• int64 ID = 2

  ID is the lease ID from the keep alive request.

• int64 TTL = 3

  TTL is the remaining TTL in seconds for the lease; the lease will expire in under TTL+1 seconds.

• int64 grantedTTL = 4

  GrantedTTL is the initial granted time in seconds upon lease creation/renewal.

• repeated bytes keys = 5

  Keys is the list of keys attached to this lease.

Used in: MemberListResponse

• uint64 ID = 1

  ID is the member ID for this member.

• string name = 2

  name is the human-readable name of the member. If the member is not started, the name will be an empty string.

• repeated string peerURLs = 3

  peerURLs is the list of URLs the member exposes to the cluster for communication.

• repeated string clientURLs = 4

  clientURLs is the list of URLs the member exposes to clients for communication. If the member is not started, clientURLs will be empty.

• bool isLearner = 5

  isLearner indicates if the member is raft learner.

• bool linearizable = 1

• optional ResponseHeader header = 1

• repeated Member members = 2

  members is a list of all members associated with the cluster.

option (versionpb.etcd_version_msg) = "3.0";

Used as request type in: KV.Put

Used as field type in: RequestOp, lskvserverpb.ReceiptClaims

• bytes key = 1

  key is the key, in bytes, to put into the key-value store.

• bytes value = 2

  value is the value, in bytes, to associate with the key in the key-value store.

• int64 lease = 3

  lease is the lease ID to associate with the key in the key-value store. A lease value of 0 indicates no lease.

• bool prev_kv = 4

  If prev_kv is set, etcd gets the previous key-value pair before changing it. The previous key-value pair will be returned in the put response.

  [(versionpb.etcd_version_field)="3.1"];

• bool ignore_value = 5

  // If ignore_value is set, etcd updates the key using its current value. // Returns an error if the key does not exist.

  [(versionpb.etcd_version_field)="3.2"];

• bool ignore_lease = 6

  // If ignore_lease is set, etcd updates the key using its current lease. // Returns an error if the key does not exist.

  [(versionpb.etcd_version_field)="3.2"];

option (versionpb.etcd_version_msg) = "3.0";

Used as response type in: KV.Put

Used as field type in: ResponseOp, lskvserverpb.ReceiptClaims

• optional ResponseHeader header = 1

• optional KeyValue prev_kv = 2

  if prev_kv is set in the request, the previous key-value pair will be returned.

  [(versionpb.etcd_version_field)="3.1"]; // TODO: Move to new file

option (versionpb.etcd_version_msg) = "3.0";

Used as request type in: KV.Range

Used as field type in: RequestOp

• bytes key = 1

  key is the first key for the range. If range_end is not given, the request only looks up key.

• bytes range_end = 2

  range_end is the upper bound on the requested range [key, range_end). If range_end is '\0', the range is all keys >= key. If range_end is key plus one (e.g., "aa"+1 == "ab", "a\xff"+1 == "b"), then the range request gets all keys prefixed with key. If both key and range_end are '\0', then the range request returns all keys.

• int64 limit = 3

  limit is a limit on the number of keys returned for the request. When limit is set to 0, it is treated as no limit.

• int64 revision = 4

  revision is the point-in-time of the key-value store to use for the range. If revision is less or equal to zero, the range is over the newest key-value store. If the revision has been compacted, ErrCompacted is returned as a response.

• RangeRequest.SortOrder sort_order = 5

  sort_order is the order for returned sorted results.

• RangeRequest.SortTarget sort_target = 6

  sort_target is the key-value field to use for sorting.

• bool serializable = 7

  serializable sets the range request to use serializable member-local reads. Range requests are linearizable by default; linearizable requests have higher latency and lower throughput than serializable requests but reflect the current consensus of the cluster. For better performance, in exchange for possible stale reads, a serializable range request is served locally without needing to reach consensus with other nodes in the cluster.

• bool keys_only = 8

  keys_only when set returns only the keys and not the values.

• bool count_only = 9

  count_only when set returns only the count of the keys in the range.

• int64 min_mod_revision = 10

  min_mod_revision is the lower bound for returned key mod revisions; all keys with lesser mod revisions will be filtered away.

  [(versionpb.etcd_version_field)="3.1"];

• int64 max_mod_revision = 11

  // max_mod_revision is the upper bound for returned key mod revisions; all keys with // greater mod revisions will be filtered away.

  [(versionpb.etcd_version_field)="3.1"];

• int64 min_create_revision = 12

  // min_create_revision is the lower bound for returned key create revisions; all keys with // lesser create revisions will be filtered away.

  [(versionpb.etcd_version_field)="3.1"];

• int64 max_create_revision = 13

  // max_create_revision is the upper bound for returned key create revisions; all keys with // greater create revisions will be filtered away.

  [(versionpb.etcd_version_field)="3.1"];

Used in: RangeRequest

• NONE = 0

  option (versionpb.etcd_version_enum) = "3.0";

  default, no sorting

• ASCEND = 1

  lowest target value first

• DESCEND = 2

  highest target value first

Used in: RangeRequest

• KEY = 0

  option (versionpb.etcd_version_enum) = "3.0";

• VERSION = 1

• CREATE = 2

• MOD = 3

• VALUE = 4

option (versionpb.etcd_version_msg) = "3.0";

Used as response type in: KV.Range

Used as field type in: ResponseOp

• optional ResponseHeader header = 1

• repeated KeyValue kvs = 2

  kvs is the list of key-value pairs matched by the range request. kvs is empty when count is requested.

  TODO: Move to new file

• bool more = 3

  more indicates if there are more keys to return in the requested range.

• int64 count = 4

  count is set to the number of keys within the range when requested.

Used in: TxnRequest

• oneof request

  request is a union of request types accepted by a transaction.

  • RangeRequest request_range = 1

  • PutRequest request_put = 2

  • DeleteRangeRequest request_delete_range = 3

  • TxnRequest request_txn = 4

option (versionpb.etcd_version_msg) = "3.0";

Used in: CompactionResponse, DeleteRangeResponse, LeaseGrantResponse, LeaseKeepAliveResponse, LeaseLeasesResponse, LeaseRevokeResponse, LeaseTimeToLiveResponse, MemberListResponse, PutResponse, RangeResponse, StatusResponse, TxnResponse, lskvserverpb.GetReceiptResponse, lskvserverpb.TxStatusResponse

• uint64 cluster_id = 1

  cluster_id is the ID of the cluster which sent the response.

• uint64 member_id = 2

  member_id is the ID of the member which sent the response.

• int64 revision = 3

  revision is the key-value store revision when the request was applied, and it's unset (so 0) in case of calls not interacting with key-value store. For watch progress responses, the header.revision indicates progress. All future events received in this stream are guaranteed to have a higher revision number than the header.revision number.

• uint64 raft_term = 4

  raft_term is the raft term when the request was applied.

• int64 committed_revision = 5

  revision of the store that has most recently been committed (been through consensus).

• uint64 committed_raft_term = 6

  raft term that the last committed item was committed in.

Used in: TxnResponse

• oneof response

  response is a union of response types returned by a transaction.

  • RangeResponse response_range = 1

  • PutResponse response_put = 2

  • DeleteRangeResponse response_delete_range = 3

  • TxnResponse response_txn = 4

(message has no fields)

NOTE: This is mostly unimplemented, only returning the header and version currently.

• optional ResponseHeader header = 1

• string version = 2

  version is the cluster protocol version used by the responding member.

• int64 dbSize = 3

  dbSize is the size of the backend database physically allocated, in bytes, of the responding member.

• uint64 leader = 4

  leader is the member ID which the responding member believes is the current leader.

• uint64 raftIndex = 5

  raftIndex is the current raft committed index of the responding member.

• uint64 raftTerm = 6

  raftTerm is the current raft term of the responding member.

• uint64 raftAppliedIndex = 7

  raftAppliedIndex is the current raft applied index of the responding member.

• repeated string errors = 8

  errors contains alarm/health information and status.

• int64 dbSizeInUse = 9

  dbSizeInUse is the size of the backend database logically in use, in bytes, of the responding member.

• bool isLearner = 10

  isLearner indicates if the member is raft learner.

• string storageVersion = 11

  storageVersion is the version of the db file. It might be get updated with delay in relationship to the target cluster version.

From google paxosdb paper: Our implementation hinges around a powerful primitive which we call MultiOp. All other database operations except for iteration are implemented as a single call to MultiOp. A MultiOp is applied atomically and consists of three components: 1. A list of tests called guard. Each test in guard checks a single entry in the database. It may check for the absence or presence of a value, or compare with a given value. Two different tests in the guard may apply to the same or different entries in the database. All tests in the guard are applied and MultiOp returns the results. If all tests are true, MultiOp executes t op (see item 2 below), otherwise it executes f op (see item 3 below). 2. A list of database operations called t op. Each operation in the list is either an insert, delete, or lookup operation, and applies to a single database entry. Two different operations in the list may apply to the same or different entries in the database. These operations are executed if guard evaluates to true. 3. A list of database operations called f op. Like t op, but executed if guard evaluates to false.

Used in: RequestOp, lskvserverpb.ReceiptClaims

• repeated Compare compare = 1

  compare is a list of predicates representing a conjunction of terms. If the comparisons succeed, then the success requests will be processed in order, and the response will contain their respective responses in order. If the comparisons fail, then the failure requests will be processed in order, and the response will contain their respective responses in order.

• repeated RequestOp success = 2

  success is a list of requests which will be applied when compare evaluates to true.

• repeated RequestOp failure = 3

  failure is a list of requests which will be applied when compare evaluates to false.

Used in: ResponseOp, lskvserverpb.ReceiptClaims

• optional ResponseHeader header = 1

• bool succeeded = 2

  succeeded is set to true if the compare evaluated to true or false otherwise.

• repeated ResponseOp responses = 3

  responses is a list of responses corresponding to the results from applying success if succeeded is true or failure if succeeded is false.