package tikvpb
Get desktop application:
View/edit binary Protocol Buffers messages
service Tikv
tikvpb.proto:22Key/value store API for TiKV.
rpc BatchCommands (stream , stream )
tikvpb.proto:97Batched commands.
message
tikvpb.proto:161repeated requests = 1
repeated uint64 request_ids = 2
uint64 client_send_time_ns = 3
Unix epoch timestamp in nanoseconds recorded by the client when this batch request is sent to TiKV.
message
tikvpb.proto:224repeated responses = 1
repeated uint64 request_ids = 2
uint64 transport_layer_load = 3
280 means TiKV gRPC cpu usage is 280%.
optional health_feedback = 4
uint64 tikv_send_time_ns = 5
Unix epoch timestamp in nanoseconds recorded by TiKV when this batch response is ready to be sent back to the client.
rpc BatchCoprocessor (, stream )
tikvpb.proto:73rpc BatchRaft (stream , )
tikvpb.proto:83message
tikvpb.proto:289repeated msgs = 1
uint64 last_observed_time = 13
Used for measure the send duration.
rpc BroadcastTxnStatus (, )
tikvpb.proto:149/ Broadcast the transaction status to all TiKV nodes
rpc CancelDisaggTask (, )
tikvpb.proto:140/ Cancel the disaggregated task on TiFlash write node
rpc CancelMPPTask (, )
tikvpb.proto:101rpc CheckLeader (, )
tikvpb.proto:111/ CheckLeader sends all information (includes region term and epoch) to other stores. / Once a store receives a request, it checks term and epoch for each region, and sends the regions whose / term and epoch match with local information in the store. / After the client collected all responses from all stores, it checks if got a quorum of responses from / other stores for every region, and decides to advance resolved ts from these regions.
rpc CheckLockObserver (, )
tikvpb.proto:65rpc Compact (, )
tikvpb.proto:123/ Compact a specified key range. This request is not restricted to raft leaders and will not be replicated. / It only compacts data on this node. / TODO: Currently this RPC is designed to be only compatible with TiFlash. / Shall be move out in https://github.com/pingcap/kvproto/issues/912
rpc Coprocessor (, )
tikvpb.proto:71Commands for executing SQL in the TiKV coprocessor (i.e., 'pushed down' to TiKV rather than executed in TiDB).
rpc CoprocessorStream (, stream )
tikvpb.proto:72rpc DelegateCoprocessor (, )
tikvpb.proto:76Command send by remote coprocessor to TiKV for executing coprocessor request.
rpc DispatchMPPTask (, )
tikvpb.proto:100These are for mpp execution.
rpc EstablishDisaggTask (, )
tikvpb.proto:138/ Build the disaggregated task on TiFlash write node
rpc EstablishMPPConnection (, stream )
tikvpb.proto:102rpc FetchDisaggPages (, stream )
tikvpb.proto:142/ Exchange page data between TiFlash write node and compute node
rpc GetDisaggConfig (, )
tikvpb.proto:144/ Compute node get configuration from Write node
rpc GetEstimateTiCICount (, )
tikvpb.proto:130/ Get estimate tici count from TiFlash
rpc GetHealthFeedback (, )
tikvpb.proto:147/ Get health feedback info from the TiKV node.
rpc GetLockWaitHistory (, )
tikvpb.proto:125/ Get the information about history lock waiting from TiKV.
rpc GetLockWaitInfo (, )
tikvpb.proto:117/ Get the information about lock waiting from TiKV.
rpc GetStoreSafeTS (, )
tikvpb.proto:114/ Get the minimal `safe_ts` from regions at the store
/ Get system table from TiFlash
rpc IsAlive (, )
tikvpb.proto:103rpc KVPessimisticRollback (, )
tikvpb.proto:28rpc KvBatchGet (, )
tikvpb.proto:35rpc KvBatchRollback (, )
tikvpb.proto:36rpc KvBufferBatchGet (, )
tikvpb.proto:44rpc KvCheckSecondaryLocks (, )
tikvpb.proto:31rpc KvCheckTxnStatus (, )
tikvpb.proto:30rpc KvCleanup (, )
tikvpb.proto:34rpc KvCommit (, )
tikvpb.proto:32rpc KvDeleteRange (, )
tikvpb.proto:40rpc KvFlashbackToVersion (, )
tikvpb.proto:42rpc KvFlush (, )
tikvpb.proto:43rpc KvGC (, )
tikvpb.proto:39rpc KvGet (, )
tikvpb.proto:24Commands using a transactional interface.
rpc KvImport (, )
tikvpb.proto:33rpc KvPessimisticLock (, )
tikvpb.proto:27rpc KvPrewrite (, )
tikvpb.proto:26rpc KvResolveLock (, )
tikvpb.proto:38rpc KvScan (, )
tikvpb.proto:25rpc KvScanLock (, )
tikvpb.proto:37rpc KvTxnHeartBeat (, )
tikvpb.proto:29rpc MvccGetByKey (, )
tikvpb.proto:93Commands for debugging transactions.
rpc MvccGetByStartTs (, )
tikvpb.proto:94rpc PhysicalScanLock (, )
tikvpb.proto:67rpc Raft (stream , )
tikvpb.proto:82Raft commands (sent between TiKV nodes).
rpc RawBatchDelete (, )
tikvpb.proto:52rpc RawBatchGet (, )
tikvpb.proto:48rpc RawBatchPut (, )
tikvpb.proto:50rpc RawBatchScan (, )
tikvpb.proto:55rpc RawChecksum (, )
tikvpb.proto:60rpc RawCompareAndSwap (, )
tikvpb.proto:59Compare if the value in database equals to `RawCASRequest.previous_value` before putting the new value. If not, this request will have no effect and the value in the database will be returned.
rpc RawCoprocessor (, )
tikvpb.proto:79Command for executing custom user requests in TiKV coprocessor_v2.
rpc RawDelete (, )
tikvpb.proto:51rpc RawDeleteRange (, )
tikvpb.proto:54rpc RawGet (, )
tikvpb.proto:47Raw commands; no transaction support.
rpc RawGetKeyTTL (, )
tikvpb.proto:57Get TTL of the key. Returns 0 if TTL is not set for the key.
rpc RawPut (, )
tikvpb.proto:49rpc RawScan (, )
tikvpb.proto:53rpc ReadIndex (, )
tikvpb.proto:90Sent from TiFlash or TiKV to a TiKV node.
rpc RegisterLockObserver (, )
tikvpb.proto:64rpc RemoveLockObserver (, )
tikvpb.proto:66rpc ReportMPPTaskStatus (, )
tikvpb.proto:104rpc Snapshot (stream , )
tikvpb.proto:84rpc SplitRegion (, )
tikvpb.proto:88Sent from PD or TiDB to a TiKV node.
rpc TabletSnapshot (stream , stream )
tikvpb.proto:85rpc UnsafeDestroyRange (, )
tikvpb.proto:63Store commands (sent to a each TiKV node in a cluster, rather than a certain region).
rpc tryAddLock (, )
tikvpb.proto:134These are for TiFlash disaggregated architecture / Try to lock a S3 object, atomically
rpc tryMarkDelete (, )
tikvpb.proto:136/ Try to delete a S3 object, atomically
service VersionedKv
tikvpb.proto:157VersionedKv provides versioned coprocessor APIs for TiCI lookup. Invariants: - For `VersionedCoprocessor`, callers should fill `coprocessor.Request.versioned_ranges` (each `VersionedKeyRange.range` must be a point range) and keep `coprocessor.Request.ranges` empty.
rpc VersionedCoprocessor (, )
tikvpb.proto:158
message
tikvpb.proto:295Used in:
uint64 test_id = 1
ID of the test request.
uint64 delay_time = 2
TiKV needs to delay at least such a time to response the client.
message
tikvpb.proto:302Used in:
uint64 test_id = 1
ID of the test request.
message
tikvpb.proto:168Used in:
oneof cmd
Get = 1
Scan = 2
Prewrite = 3
Commit = 4
Import = 5
Cleanup = 6
BatchGet = 7
BatchRollback = 8
ScanLock = 9
ResolveLock = 10
GC = 11
DeleteRange = 12
RawGet = 13
RawBatchGet = 14
RawPut = 15
RawBatchPut = 16
RawDelete = 17
RawBatchDelete = 18
RawScan = 19
RawDeleteRange = 20
RawBatchScan = 21
Coprocessor = 22
PessimisticLock = 23
PessimisticRollback = 24
CheckTxnStatus = 25
TxnHeartBeat = 26
CheckSecondaryLocks = 33
RawCoprocessor = 34
FlashbackToVersion = 35
PrepareFlashbackToVersion = 36
Flush = 37
BufferBatchGet = 38
GetHealthFeedback = 39
BroadcastTxnStatus = 40
Empty = 255
For some test cases.
message
tikvpb.proto:234Used in:
oneof cmd
Get = 1
Scan = 2
Prewrite = 3
Commit = 4
Import = 5
Cleanup = 6
BatchGet = 7
BatchRollback = 8
ScanLock = 9
ResolveLock = 10
GC = 11
DeleteRange = 12
RawGet = 13
RawBatchGet = 14
RawPut = 15
RawBatchPut = 16
RawDelete = 17
RawBatchDelete = 18
RawScan = 19
RawDeleteRange = 20
RawBatchScan = 21
Coprocessor = 22
PessimisticLock = 23
PessimisticRollback = 24
CheckTxnStatus = 25
TxnHeartBeat = 26
CheckSecondaryLocks = 33
RawCoprocessor = 34
FlashbackToVersion = 35
PrepareFlashbackToVersion = 36
Flush = 37
BufferBatchGet = 38
GetHealthFeedback = 39
BroadcastTxnStatus = 40
Empty = 255
For some test cases.