package io.oxia.proto.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CreateDataServer (CreateDataServerRequest, CreateDataServerResponse)

  admin.proto:31

  message CreateDataServerRequest

  admin.proto:64

  • optional DataServer data_server = 1

  message CreateDataServerResponse

  admin.proto:68

  • optional DataServer data_server = 1

• rpc CreateNamespace (CreateNamespaceRequest, CreateNamespaceResponse)

  admin.proto:35

  message CreateNamespaceRequest

  admin.proto:88

  • optional Namespace namespace = 1

  message CreateNamespaceResponse

  admin.proto:92

  • optional Namespace namespace = 1

• rpc DeleteDataServer (DeleteDataServerRequest, DeleteDataServerResponse)

  admin.proto:33

  message DeleteDataServerRequest

  admin.proto:80

  • string data_server = 1

  message DeleteDataServerResponse

  admin.proto:84

  • optional DataServer data_server = 1

• rpc DeleteNamespace (DeleteNamespaceRequest, DeleteNamespaceResponse)

  admin.proto:37

  message DeleteNamespaceRequest

  admin.proto:104

  • string namespace = 1

  message DeleteNamespaceResponse

  admin.proto:108

  • optional Namespace namespace = 1

• rpc GetDataServer (GetDataServerRequest, GetDataServerResponse)

  admin.proto:30

  message GetDataServerRequest

  admin.proto:56

  • string data_server = 1

  message GetDataServerResponse

  admin.proto:60

  • optional DataServer data_server = 1

• rpc GetNamespace (GetNamespaceRequest, GetNamespaceResponse)

  admin.proto:38

  message GetNamespaceRequest

  admin.proto:119

  • string namespace = 1

  message GetNamespaceResponse

  admin.proto:123

  • optional Namespace namespace = 1

• rpc ListDataServers (ListDataServersRequest, ListDataServersResponse)

  admin.proto:29

  message ListDataServersRequest

  admin.proto:49

  (message has no fields)

  message ListDataServersResponse

  admin.proto:52

  • repeated DataServer data_servers = 1

• rpc ListNamespaces (ListNamespacesRequest, ListNamespacesResponse)

  admin.proto:39

  message ListNamespacesRequest

  admin.proto:112

  (message has no fields)

  message ListNamespacesResponse

  admin.proto:115

  • repeated Namespace namespaces = 1

• rpc PatchDataServer (PatchDataServerRequest, PatchDataServerResponse)

  admin.proto:32

  message PatchDataServerRequest

  admin.proto:72

  • optional DataServer data_server = 1

  message PatchDataServerResponse

  admin.proto:76

  • optional DataServer data_server = 1

• rpc PatchNamespace (PatchNamespaceRequest, PatchNamespaceResponse)

  admin.proto:36

  message PatchNamespaceRequest

  admin.proto:96

  • optional Namespace namespace = 1

  message PatchNamespaceResponse

  admin.proto:100

  • optional Namespace namespace = 1

• rpc SplitShard (SplitShardRequest, SplitShardResponse)

  admin.proto:45

  * Triggers a shard split. The specified shard is split into two child shards at the given split point (or midpoint if not specified).

  message SplitShardRequest

  admin.proto:127

  • string namespace = 1

  • int64 shard = 2

  • optional uint32 split_point = 3

    Optional: explicit split point. If omitted, split at midpoint.

  message SplitShardResponse

  admin.proto:134

  • int64 left_child_shard = 1

  • int64 right_child_shard = 2

* Oxia service that allows clients to discover shard-to-server assignments and submit batches of requests. Clients should connect to a random server to discover the shard-to-server assignments and then send the actual batched requests to the appropriate shard leader. In the future, this may be handled server-side in a proxy layer to allows clients to not be concerned with sharding.

• rpc CloseSession (CloseSessionRequest, CloseSessionResponse)

  client.proto:111

  Closes a session and removes all ephemeral values associated with it.

• rpc CreateSession (CreateSessionRequest, CreateSessionResponse)

  client.proto:101

  Creates a new client session. Sessions are kept alive by regularly sending heartbeats via the KeepAlive rpc.

• rpc GetNotifications (NotificationsRequest, stream NotificationBatch)

  client.proto:95

• rpc GetSequenceUpdates (GetSequenceUpdatesRequest, stream GetSequenceUpdatesResponse)

  client.proto:93

  * Requests all the records between a range of keys.

• rpc GetShardAssignments (ShardAssignmentsRequest, stream ShardAssignments)

  client.proto:45

  * Gets all shard-to-server assignments as a stream. Each set of assignments in the response stream will contain all the assignments to bring the client up to date. For example, if a shard is split, the stream will return a single response containing all the new shard assignments as opposed to multiple stream responses, each containing a single shard assignment. Clients should connect to a single random server which will stream the assignments for all shards on all servers.

• rpc KeepAlive (SessionHeartbeat, KeepAliveResponse)

  client.proto:106

  Sends a heartbeat to prevent the session from timing out.

• rpc List (ListRequest, stream ListResponse)

  client.proto:80

  * Requests all the keys between a range of keys. Clients should send an equivalent request to all respective shards, unless a particular partition key was specified.

• rpc RangeScan (RangeScanRequest, stream RangeScanResponse)

  client.proto:88

  * Requests all the records between a range of keys. Clients should send an equivalent request to all respective shards, unless a particular partition key was specified.

• rpc Read (ReadRequest, stream ReadResponse)

  client.proto:72

  * Batches get requests. Clients should send this request to the shard leader. In the future, this may be handled server-side in a proxy layer.

• rpc Write (WriteRequest, WriteResponse)

  client.proto:56

  * Batches put, delete and delete_range requests. Clients should send this request to the shard leader. In the future, this may be handled server-side in a proxy layer. Deprecated

• rpc WriteStream (stream WriteRequest, stream WriteResponse)

  client.proto:64

  * Batches put, delete and delete_range requests. Clients should send this request to the shard leader. In the future, this may be handled server-side in a proxy layer.

Used in: Namespace

• repeated string labels = 1

• string mode = 2

Used as request type in: OxiaClient.CloseSession, streamnative.oxia.proto.OxiaClient.CloseSession

• int64 shard = 1

• int64 session_id = 2

Used as response type in: OxiaClient.CloseSession, streamnative.oxia.proto.OxiaClient.CloseSession

(message has no fields)

• repeated Namespace namespaces = 1

• repeated DataServerIdentity servers = 2

• repeated string allow_extra_authorities = 3

• map<string, DataServerMetadata> server_metadata = 4

• optional LoadBalancer load_balancer = 5

• map<string, NamespaceStatus> namespaces = 1

• int64 shard_id_generator = 2

• uint32 server_idx = 3

• string instance_id = 4

• string identity = 1

• string public_address = 2

Used as request type in: OxiaClient.CreateSession, streamnative.oxia.proto.OxiaClient.CreateSession

• int64 shard = 1

• uint32 session_timeout_ms = 2

• string client_identity = 3

Used as response type in: OxiaClient.CreateSession, streamnative.oxia.proto.OxiaClient.CreateSession

• int64 session_id = 1

Used in: CreateDataServerRequest, CreateDataServerResponse, DeleteDataServerResponse, GetDataServerResponse, ListDataServersResponse, PatchDataServerRequest, PatchDataServerResponse

• optional DataServerIdentity identity = 1

• optional DataServerMetadata metadata = 2

Used in: ClusterConfiguration, DataServer, ShardMetadata

• optional string name = 1

• string public = 2

• string internal = 3

Used in: ClusterConfiguration, DataServer

• map<string, string> labels = 1

* Input to a delete range request. Key ranges assume a UTF-8 byte sort order.

Used in: WriteRequest

• string start_inclusive = 1

  The start of the range, inclusive

• string end_exclusive = 2

  The end of the range, exclusive

* The response for a delete range request.

Used in: WriteResponse

• Status status = 1

  Includes the error or OK

* A delete request. Deletes the specified key.

Used in: WriteRequest

• string key = 1

  The key

• optional int64 expected_version_id = 2

  An optional expected version_id. The delete will fail if the server's current version_id does not match

* The response to a delete request or an item in a response to the delete range request.

Used in: WriteResponse

• Status status = 1

  Includes the error or OK

* A get request. Gets the stat and optionally the value for the specified key.

Used in: ReadRequest

• string key = 1

  The key

• bool include_value = 2

  Specifies whether the response should include the value

• KeyComparisonType comparison_type = 3

• optional string secondary_index_name = 4

* The response to a get request.

Used in: RangeScanResponse, ReadResponse

• Status status = 1

  Includes the error or OK

• optional Version version = 2

  The version of the record

• optional bytes value = 3

  The value, if it was requested and there was no error

• optional string key = 4

  In case of non-exact queries (eg. floor, ceiling) the found key will be returned in the GetResponse.

• optional string secondary_index_key = 5

Used as request type in: OxiaClient.GetSequenceUpdates, streamnative.oxia.proto.OxiaClient.GetSequenceUpdates

• int64 shard = 1

• string key = 2

Used as response type in: OxiaClient.GetSequenceUpdates, streamnative.oxia.proto.OxiaClient.GetSequenceUpdates

• string highest_sequence_key = 1

Used in: ShardMetadata

• uint32 min = 1

• uint32 max = 2

* Represents a range of hash values [min, max)

Used in: ShardAssignment, replication.AddFollowerRequest

• fixed32 min_hash_inclusive = 1

  The minimum inclusive hash that the shard can contain

• fixed32 max_hash_inclusive = 2

  The maximum inclusive hash that the shard can contain

Used as response type in: OxiaClient.KeepAlive, streamnative.oxia.proto.OxiaClient.KeepAlive

(message has no fields)

* The type of key comparison to apply in a get() request

Used in: GetRequest

• EQUAL = 0

  The stored key must be equal to the requested key

• FLOOR = 1

  Search for a key that is the highest key that is <= to the requested key

• CEILING = 2

  Search for a key that is the lowest key that is >= to the requested key

• LOWER = 3

  Search for a key that is the highest key that is < to the requested key

• HIGHER = 4

  Search for a key that is the lowest key that is > to the requested key

* Input to a list request. Key ranges assume a UTF-8 byte sort order.

Used as request type in: OxiaClient.List, streamnative.oxia.proto.OxiaClient.List

• optional int64 shard = 1

  The shard id. This is optional allow for support for server-side hashing and proxying in the future.

• string start_inclusive = 2

  The start of the range, inclusive

• string end_exclusive = 3

  The end of the range, exclusive

• optional string secondary_index_name = 4

• bool include_internal_keys = 5

* The response to a list request.

Used as response type in: OxiaClient.List, streamnative.oxia.proto.OxiaClient.List

• repeated string keys = 1

  A portion of the keys found within the specified range

Used in: ClusterConfiguration

• string schedule_interval = 1

• string quarantine_time = 2

Used in: ClusterConfiguration, CreateNamespaceRequest, CreateNamespaceResponse, DeleteNamespaceResponse, GetNamespaceResponse, ListNamespacesResponse, PatchNamespaceRequest, PatchNamespaceResponse

• string name = 1

• uint32 initial_shard_count = 2

• uint32 replication_factor = 3

• optional bool notifications_enabled = 4

• string key_sorting = 5

• repeated AntiAffinity anti_affinities = 6

* The shards assignments for a given namespace

Used in: ShardAssignments

• repeated ShardAssignment assignments = 1

  All assignments in the response stream will contain all the assignments to bring the client up to date. For example, if a shard is split, the stream will return a single response containing all the new shard assignments as opposed to multiple stream responses, each containing a single shard assignment.

• ShardKeyRouter shard_key_router = 2

  Indicates the mechanism by which the keys are assigned to the individual shards.

Used in: ClusterStatus

• uint32 replication_factor = 1

• map<int64, ShardMetadata> shards = 2

Used in: NotificationEntry

• NotificationType type = 1

• optional int64 version_id = 2

• optional string key_range_last = 3

Used as response type in: OxiaClient.GetNotifications, streamnative.oxia.proto.OxiaClient.GetNotifications

• int64 shard = 1

• int64 offset = 2

• fixed64 timestamp = 3

• repeated NotificationEntry notifications = 4

  Wire-compatible with the former `map<string, Notification>` field: a map entry encodes exactly as NotificationEntry{key = 1, value = 2}. The server emits entries sorted by key, because the serialized batch feeds the replicated checksum and must be byte-identical on every replica — generated marshalers emit repeated fields in slice order, which makes that determinism structural instead of requiring a special marshaler.

Used in: NotificationBatch

• optional string key = 1

  optional: presence-tracked, so the field is emitted even for an empty key, exactly as a map entry encodes it

• optional Notification value = 2

Used in: Notification

• KEY_CREATED = 0

• KEY_MODIFIED = 1

• KEY_DELETED = 2

• KEY_RANGE_DELETED = 3

Used as request type in: OxiaClient.GetNotifications, streamnative.oxia.proto.OxiaClient.GetNotifications

• int64 shard = 1

• optional int64 start_offset_exclusive = 2

* A put request. Persists the specified key and value

Used in: WriteRequest

• string key = 1

  The key

• bytes value = 2

  The value

• optional int64 expected_version_id = 3

  An optional expected version_id. The put will fail if the server's current version_id does not match

• optional int64 session_id = 4

  Optional. Associate the new record with the session (i.e. ephemeral record). When the session expires or is explicitly closed, the record will be automatically removed

• optional string client_identity = 5

  Client identifier used to track the client that last modified an ephemeral record.

• optional string partition_key = 6

  If a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard. It is passed to the server because it needs to be persisted as part of the record. We would need the partition_key if we're going to do a split of the shards.

• repeated uint64 sequence_key_delta = 7

  If one or more sequence key are specified. The key will get added suffixes based on adding the delta to the current highest key with the same prefix

• repeated SecondaryIndex secondary_indexes = 8

• optional int64 override_version_id = 9

  Optional overrides for version metadata, used during data migration. When set, the server will use these values instead of auto-generating them.

• optional int64 override_modifications_count = 10

* The response to a put request.

Used in: WriteResponse

• Status status = 1

  Includes the error or OK

• optional Version version = 2

  The version if the put was successful

• optional string key = 3

  If the key was generated by Oxia, it will be returned as part of the response

* Input to a range-scan request

Used as request type in: OxiaClient.RangeScan, streamnative.oxia.proto.OxiaClient.RangeScan

• optional int64 shard = 1

  The shard id. This is optional allow for support for server-side hashing and proxying in the future.

• string start_inclusive = 2

  The start of the range, inclusive

• string end_exclusive = 3

  The end of the range, exclusive

• optional string secondary_index_name = 4

• bool include_internal_keys = 5

* The response to a range-scan request.

Used as response type in: OxiaClient.RangeScan, streamnative.oxia.proto.OxiaClient.RangeScan

• repeated GetResponse records = 1

  A portion of the records found within the specified range

* A batch read request. Applies the batches of requests.

Used as request type in: OxiaClient.Read, streamnative.oxia.proto.OxiaClient.Read

• optional int64 shard = 1

  The shard id. This is optional allow for support for server-side hashing and proxying in the future.

• repeated GetRequest gets = 2

  The get requests

* The response to a batch read request. Responses of each type respect the order of the original requests.

Used as response type in: OxiaClient.Read, streamnative.oxia.proto.OxiaClient.Read

• repeated GetResponse gets = 1

  The get responses

Used in: PutRequest, proto.StorageEntry

• string index_name = 1

• string secondary_key = 2

Used as request type in: OxiaClient.KeepAlive, streamnative.oxia.proto.OxiaClient.KeepAlive

• int64 shard = 1

• int64 session_id = 2

* The assignment of a shard to a server.

Used in: NamespaceShardsAssignment

• int64 shard = 1

  The shard id

• string leader = 2

  The shard leader, e.g. `host:port`

• oneof shard_boundaries

  There could be multiple ways to describe the boundaries of a shard

  • Int32HashRange int32_hash_range = 3

* The response to a shard assignments request.

Used as request type in: replication.OxiaCoordination.PushShardAssignments

Used as response type in: OxiaClient.GetShardAssignments, streamnative.oxia.proto.OxiaClient.GetShardAssignments

• map<string, NamespaceShardsAssignment> namespaces = 1

• repeated string allowed_authorities = 2

* A shard assignments request. Gets all shard-to-server assignments as a stream. Each set of assignments in the response stream will contain all the assignments to bring the client up to date. For example, if a shard is split, the stream will return a single response containing all the new shard assignments as opposed to multiple stream responses, each containing a single shard assignment.

Used as request type in: OxiaClient.GetShardAssignments, streamnative.oxia.proto.OxiaClient.GetShardAssignments

• string namespace = 1

Used in: NamespaceShardsAssignment

• UNKNOWN = 0

• XXHASH3 = 1

Used in: NamespaceStatus

• ShardStatus status = 1

• int64 term = 2

• optional DataServerIdentity leader = 3

• repeated DataServerIdentity ensemble = 4

• repeated DataServerIdentity removed_nodes = 5

• repeated DataServerIdentity pending_delete_shard_nodes = 6

• optional HashRange int32_hash_range = 7

• optional SplitMetadata split = 8

Used in: ShardMetadata

• ShardStatusUnknown = 0

• SteadyState = 1

• Election = 2

• Deleting = 3

Used in: ShardMetadata

• SplitPhase phase = 1

• int64 parent_shard_id = 2

• repeated int64 child_shard_ids = 3

• uint32 split_point = 4

• int64 snapshot_offset = 5

• int64 parent_term_at_bootstrap = 6

• map<int64, string> child_leaders_at_bootstrap = 7

Used in: SplitMetadata

• Bootstrap = 0

• CatchUp = 1

• Cutover = 2

* Represents all the possible status.

Used in: DeleteRangeResponse, DeleteResponse, GetResponse, PutResponse

• OK = 0

  Operation was successful

• KEY_NOT_FOUND = 1

  The key was not found

• UNEXPECTED_VERSION_ID = 2

  The existing version does not match the expected version

• SESSION_DOES_NOT_EXIST = 3

  The session that the put request referred to is not alive

* Version contains info about the state of a record.

Used in: GetResponse, PutResponse

• int64 version_id = 1

  The version identifier of the record

• int64 modifications_count = 2

  The number of modifications made to the record since it was created

• fixed64 created_timestamp = 3

  The creation timestamp of the first version of the record

• fixed64 modified_timestamp = 4

  The modified timestamp of the current version of the record

• optional int64 session_id = 5

  Identifier of the session if the record is ephemeral

• optional string client_identity = 6

* A batch write request. Applies the batches of requests. Requests are processed in positional order within batches and the batch types are processed in the following order: puts, deletes, delete_ranges.

Used as request type in: OxiaClient.Write, OxiaClient.WriteStream, streamnative.oxia.proto.OxiaClient.Write, streamnative.oxia.proto.OxiaClient.WriteStream

Used as field type in: proto.WriteRequests

• optional int64 shard = 1

  The shard id. This is optional allow for support for server-side hashing and proxying in the future.

• repeated PutRequest puts = 2

  The put requests

• repeated DeleteRequest deletes = 3

  The delete requests

• repeated DeleteRangeRequest delete_ranges = 4

  The delete range requests

* The response to a batch write request. Responses of each type respect the order of the original requests.

Used as response type in: OxiaClient.Write, OxiaClient.WriteStream, streamnative.oxia.proto.OxiaClient.Write, streamnative.oxia.proto.OxiaClient.WriteStream

• repeated PutResponse puts = 1

  The put responses

• repeated DeleteResponse deletes = 2

  The delete responses

• repeated DeleteRangeResponse delete_ranges = 3

  The delete range responses