package gcpb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ListKeySpaces (ListKeySpacesRequest, ListKeySpacesResponse)

  gcpb.proto:18

  message ListKeySpacesRequest

  gcpb.proto:60

  • optional RequestHeader header = 1

  • bool with_gc_safe_point = 2

    set with_gc_safe_point to true to also receive gc safe point for each key space

  message ListKeySpacesResponse

  gcpb.proto:66

  • optional ResponseHeader header = 1

  • repeated KeySpace key_spaces = 2

• rpc GetMinServiceSafePoint (GetMinServiceSafePointRequest, GetMinServiceSafePointResponse)

  gcpb.proto:20

  message GetMinServiceSafePointRequest

  gcpb.proto:71

  • optional RequestHeader header = 1

  • bytes space_id = 2

  message GetMinServiceSafePointResponse

  gcpb.proto:76

  • optional ResponseHeader header = 1

  • uint64 safe_point = 2

  • int64 revision = 3

    revision here is to safeguard the validity of the obtained min, preventing cases where new services register their safe points after min is obtained by gc worker

• rpc UpdateGCSafePoint (UpdateGCSafePointRequest, UpdateGCSafePointResponse)

  gcpb.proto:22

  message UpdateGCSafePointRequest

  gcpb.proto:84

  • optional RequestHeader header = 1

  • bytes space_id = 2

  • uint64 safe_point = 3

  • int64 revision = 4

    here client need to provide the revision obtained from GetMinServiceSafePoint, so server can check if it's still valid

  message UpdateGCSafePointResponse

  gcpb.proto:93

  • optional ResponseHeader header = 1

  • bool succeeded = 2

    update will be successful if revision is valid and new safepoint > old safe point if failed, previously obtained min might be incorrect, should retry from GetMinServiceSafePoint

  • uint64 new_safe_point = 3

• rpc UpdateServiceSafePoint (UpdateServiceSafePointRequest, UpdateServiceSafePointResponse)

  gcpb.proto:24

  message UpdateServiceSafePointRequest

  gcpb.proto:101

  • optional RequestHeader header = 1

  • bytes space_id = 2

  • bytes service_id = 3

  • int64 TTL = 4

    safe point will be set to expire on (PD Server time + TTL) pass in a ttl < 0 to remove target safe point pass in MAX_INT64 to set a safe point that never expire

  • uint64 safe_point = 5

  message UpdateServiceSafePointResponse

  gcpb.proto:112

  • optional ResponseHeader header = 1

  • bool succeeded = 2

    update will be successful if ttl < 0 (a removal request) or if new safe point >= old safe point and new safe point >= gc safe point

  • uint64 gc_safe_point = 3

  • uint64 old_safe_point = 4

  • uint64 new_safe_point = 5

Used in: ResponseHeader

• ErrorType type = 1

• string message = 2

Used in: Error

• OK = 0

• UNKNOWN = 1

• NOT_BOOTSTRAPPED = 2

• REVISION_MISMATCH = 3

  revision supplied does not match the current etcd revision

• SAFEPOINT_ROLLBACK = 4

  if the proposed safe point is earlier than old safe point or gc safe point

Used in: ListKeySpacesResponse

• bytes space_id = 1

• uint64 gc_safe_point = 2

Used in: GetMinServiceSafePointRequest, ListKeySpacesRequest, UpdateGCSafePointRequest, UpdateServiceSafePointRequest

• 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, also member ID or etcd ID.

Used in: GetMinServiceSafePointResponse, ListKeySpacesResponse, UpdateGCSafePointResponse, UpdateServiceSafePointResponse

• uint64 cluster_id = 1

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

• optional Error error = 2