package io.streamnative.oxia.proto

Get desktop application:
View/edit binary Protocol Buffers messages

* 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 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.

  message ShardAssignmentsRequest

  client.proto:117

  * 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.

  • string namespace = 1

• 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.

• 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.

  message ReadRequest

  client.proto:210

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

  • 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

  message ReadResponse

  client.proto:222

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

  • repeated GetResponse gets = 1

    The get responses

• 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.

  message ListRequest

  client.proto:363

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

  • 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

  message ListResponse

  client.proto:378

  * The response to a list request.

  • repeated string keys = 1

    A portion of the keys found within the specified range

• 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.

  message RangeScanRequest

  client.proto:386

  * Input to a range-scan request

  • 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

  message RangeScanResponse

  client.proto:401

  * The response to a range-scan request.

  • repeated GetResponse records = 1

    A portion of the records found within the specified range

• rpc GetNotifications (NotificationsRequest, stream NotificationBatch)

  client.proto:90

  message NotificationsRequest

  client.proto:473

  • int64 shard = 1

  • optional int64 start_offset_exclusive = 2

  message NotificationBatch

  client.proto:479

  • int64 shard = 1

  • int64 offset = 2

  • fixed64 timestamp = 3

  • map<string, Notification> notifications = 4

• rpc CreateSession (CreateSessionRequest, CreateSessionResponse)

  client.proto:96

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

  message CreateSessionRequest

  client.proto:442

  • int64 shard = 1

  • uint32 session_timeout_ms = 2

  • string client_identity = 3

  message CreateSessionResponse

  client.proto:448

  • int64 session_id = 1

• rpc KeepAlive (SessionHeartbeat, KeepAliveResponse)

  client.proto:101

  Sends a heartbeat to prevent the session from timing out.

  message SessionHeartbeat

  client.proto:452

  • int64 shard = 1

  • int64 session_id = 2

  message KeepAliveResponse

  client.proto:457

  (message has no fields)

• rpc CloseSession (CloseSessionRequest, CloseSessionResponse)

  client.proto:106

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

  message CloseSessionRequest

  client.proto:459

  • int64 shard = 1

  • int64 session_id = 2

  message CloseSessionResponse

  client.proto:464

  (message has no fields)

* 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

* 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.

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

Used in: ShardAssignment

• 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

* 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

* 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: NotificationBatch

• NotificationType type = 1

• optional int64 version_id = 2

• optional string key_range_last = 3

Used in: Notification

• KEY_CREATED = 0

• KEY_MODIFIED = 1

• KEY_DELETED = 2

• KEY_RANGE_DELETED = 3

* 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

* 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

Used in: PutRequest, proto.StorageEntry

• string index_name = 1

• string secondary_key = 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

• map<string, NamespaceShardsAssignment> namespaces = 1

Used in: NamespaceShardsAssignment

• UNKNOWN = 0

• XXHASH3 = 1

* 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

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

• repeated PutResponse puts = 1

  The put responses

• repeated DeleteResponse deletes = 2

  The delete responses

• repeated DeleteRangeResponse delete_ranges = 3

  The delete range responses