package tsopb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc FindGroupByKeyspaceID (FindGroupByKeyspaceIDRequest, FindGroupByKeyspaceIDResponse)

  tsopb.proto:21

  Find the keyspace group that the keyspace belongs to.

  message FindGroupByKeyspaceIDRequest

  tsopb.proto:121

  • optional RequestHeader header = 1

  • oneof keyspace

    • uint32 keyspace_id = 2

      V1/V2 compatibility keyspace id. V3 should use keyspace_identity.

    • apipb.KeyspaceIdentity keyspace_identity = 4

      V3 keyspace identity.

  • uint64 mod_revision = 3

  message FindGroupByKeyspaceIDResponse

  tsopb.proto:132

  • optional ResponseHeader header = 1

  • optional KeyspaceGroup keyspace_group = 2

  • uint64 mod_revision = 3

• rpc GetMinTS (GetMinTSRequest, GetMinTSResponse)

  tsopb.proto:26

  Get the minimum timestamp across all keyspace groups served by the TSO server who receives and handle the request. If the TSO server/pod is not serving any keyspace group, return an empty timestamp, and the client needs to skip the empty timestamps when collecting the min timestamp from all TSO servers/pods.

  message GetMinTSRequest

  tsopb.proto:138

  • optional RequestHeader header = 1

  • string dc_location = 2

  message GetMinTSResponse

  tsopb.proto:143

  • optional ResponseHeader header = 1

  • optional pdpb.Timestamp timestamp = 2

  • uint32 keyspace_groups_serving = 3

    the count of keyspace group primaries that the TSO server/pod is serving

  • uint32 keyspace_groups_total = 4

    the total count of keyspace groups

• rpc Tso (stream TsoRequest, stream TsoResponse)

  tsopb.proto:19

  message TsoRequest

  tsopb.proto:81

  • optional RequestHeader header = 1

  • uint32 count = 2

  • string dc_location = 3

  message TsoResponse

  tsopb.proto:88

  • optional ResponseHeader header = 1

  • uint32 count = 2

  • optional pdpb.Timestamp timestamp = 3

Used in: ResponseHeader

• ErrorType type = 1

• string message = 2

Used in: Error

• OK = 0

• UNKNOWN = 1

• NOT_BOOTSTRAPPED = 2

• ALREADY_BOOTSTRAPPED = 3

• INVALID_VALUE = 4

• CLUSTER_MISMATCHED = 5

Used in: FindGroupByKeyspaceIDResponse

• uint32 id = 1

• string user_kind = 2

• optional SplitState split_state = 3

• repeated KeyspaceGroupMember members = 4

Used in: KeyspaceGroup

• string address = 1

• bool is_primary = 2

• string name = 1

  name is the unique name of the TSO participant.

• uint64 id = 2

  id is the unique id of the TSO participant.

• repeated string listen_urls = 3

  listen_urls is the serivce endpoint list in the url format. listen_urls[0] is primary service endpoint.

Used in: FindGroupByKeyspaceIDRequest, GetMinTSRequest, TsoRequest

• uint64 cluster_id = 1

  cluster_id is the ID of the cluster which be sent to.

• uint64 sender_id = 2

  sender_id is the ID of the sender server.

• oneof keyspace

  • uint32 keyspace_id = 3

    keyspace_id is the unique id of the tenant/keyspace in V1/V2. V3 should use keyspace_identity and must not read this legacy field as the full identity.

  • apipb.KeyspaceIdentity keyspace_identity = 6

    V3 keyspace identity of the request.

• uint32 keyspace_group_id = 4

  keyspace_group_id is the unique id of the keyspace group to which the tenant/keyspace belongs.

• string callee_id = 5

  callee_id is the ID of the server which the client expects to receive the request. such as tso-0, tso-1, pd-0, pd-1 etc. This field is used to check if the request is sent to the expected server. If it is not matched, the server will return an error.

Used in: FindGroupByKeyspaceIDResponse, GetMinTSResponse, TsoResponse

• uint64 cluster_id = 1

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

• optional Error error = 2

• oneof keyspace

  • uint32 keyspace_id = 3

    keyspace_id is the unique id of the tenant/keyspace as the response receiver in V1/V2. V3 should use keyspace_identity and must not read this legacy field as the full identity.

  • apipb.KeyspaceIdentity keyspace_identity = 5

    V3 keyspace identity served by this response.

• uint32 keyspace_group_id = 4

  keyspace_group_id is the unique id of the keyspace group to which the tenant/keyspace belongs.

Used in: KeyspaceGroup

• uint32 split_source = 1