package disaggregated

Get desktop application:
View/edit binary Protocol Buffers messages

Used as request type in: tikvpb.Tikv.CancelDisaggTask

• optional DisaggTaskMeta meta = 1

Used as response type in: tikvpb.Tikv.CancelDisaggTask

(message has no fields)

Error caused by concurrency conflict, request cancel

Used in: S3LockResult

• string reason = 1

Used in: PagesPacket

• int32 code = 1

• string msg = 2

Used in: GetDisaggConfigResponse

• string bucket = 1

• string root = 2

• string endpoint = 3

Used in: CancelDisaggTaskRequest, EstablishDisaggTaskRequest, EstablishDisaggTaskResponse, FetchDisaggPagesRequest

• uint64 start_ts = 1

  start ts of a query

• int64 gather_id = 9

  gather_id + query_ts + server_id + local_query_id to represent a global unique query.

  used to distinguish different gathers in the mpp query

• uint64 query_ts = 2

  timestamp when start to execute query, used for TiFlash miniTSO schedule.

• uint64 server_id = 3

  TiDB server id

• uint64 local_query_id = 4

  unique local query_id if tidb don't restart.

• int64 task_id = 5

  if task id is -1 , it indicates a tidb task.

• string executor_id = 6

  the exectuor id

• uint32 keyspace_id = 7

  keyspace id of the request

• kvrpcpb.APIVersion api_version = 8

  API version of the request

• uint64 connection_id = 10

  This is the session id between a client and tidb

• string connection_alias = 11

  This is the session alias between a client and tidb

Used in: EstablishDisaggTaskError

• string msg = 1

• repeated kvrpcpb.LockInfo locked = 2

  The read node needs to resolve these locks.

Used in: EstablishDisaggTaskError

• int32 code = 1

• string msg = 2

Used in: EstablishDisaggTaskError

• string msg = 1

• repeated uint64 region_ids = 2

  The read node needs to update its region cache about these regions.

Used in: EstablishDisaggTaskResponse

• oneof errors

  • ErrorRegion error_region = 1

  • ErrorLocked error_locked = 2

  • ErrorOther error_other = 99

Used as request type in: tikvpb.Tikv.EstablishDisaggTask

• optional DisaggTaskMeta meta = 1

• string address = 2

  target address of this task.

• int64 timeout_s = 3

  The write node needs to ensure that subsequent FetchDisaggPagesRequest can be processed within timeout_s. unit: seconds

• repeated coprocessor.RegionInfo regions = 4

  The key ranges, Region meta that read node need to execute TableScan

• int64 schema_ver = 5

• repeated coprocessor.TableRegions table_regions = 6

  Used for PartitionTableScan

• bytes encoded_plan = 7

  The encoded TableScan/PartitionTableScan + Selection.

Used as response type in: tikvpb.Tikv.EstablishDisaggTask

• optional EstablishDisaggTaskError error = 1

• uint64 store_id = 3

  Write node maintains a snapshot with a lease time. Read node should read the delta pages (ColumnFileInMemory and ColumnFileTiny) along with this store_id and snapshot_id.

  metapb.Store.id

• optional DisaggTaskMeta snapshot_id = 4

• repeated bytes tables = 5

  Serialized disaggregated tasks (per physical table)

Used as request type in: tikvpb.Tikv.FetchDisaggPages

• optional DisaggTaskMeta snapshot_id = 1

  The snapshot id to fetch pages

• int64 table_id = 2

• uint64 segment_id = 3

• repeated uint64 page_ids = 4

  It must be a subset of the delta pages ids returned in EstablishDisaggTaskResponse.segments

Used as request type in: tikvpb.Tikv.GetDisaggConfig

(message has no fields)

Used as response type in: tikvpb.Tikv.GetDisaggConfig

• optional DisaggS3Config s3_config = 1

Error caused by S3GC owner changed client should retry

Used in: S3LockResult

(message has no fields)

Used as response type in: tikvpb.Tikv.FetchDisaggPages

• optional DisaggReadError error = 1

• repeated bytes pages = 2

  Serialized column file data * ColumnFilePersisted alone with its schema, page data, field offsets

• repeated bytes chunks = 3

  * ColumnFileInMemory alone with its serialized block

• repeated bytes summaries = 4

  Return tipb.SelectResponse.execution_summaries in the last packet

Used in: TryAddLockResponse, TryMarkDeleteResponse

• oneof error

  • Success success = 1

  • NotOwner not_owner = 2

  • Conflict conflict = 3

Used in: S3LockResult

(message has no fields)

Used as request type in: tikvpb.Tikv.tryAddLock

• bytes data_file_key = 1

  The data file key to add lock

• uint64 lock_store_id = 3

  The lock store id

• uint64 lock_seq = 4

  The upload sequence number of lock store

Used as response type in: tikvpb.Tikv.tryAddLock

• optional S3LockResult result = 1

Used as request type in: tikvpb.Tikv.tryMarkDelete

• bytes data_file_key = 1

  The data file key to be marked as deleted

Used as response type in: tikvpb.Tikv.tryMarkDelete

• optional S3LockResult result = 1