package kvrpcpb

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: CheckTxnStatusResponse

• NoAction = 0

• TTLExpireRollback = 1

  The lock is rolled back because it has expired.

• LockNotExistRollback = 2

  The lock does not exist, TinyKV left a record of the rollback, but did not have to delete a lock.

Rollback an un-committed transaction. Will fail if the transaction has already been committed or keys are locked by a different transaction. If the keys were never locked, no action is needed but it is not an error. If successful all keys will be unlocked and all uncommitted values removed.

Used as request type in: tinykvpb.TinyKv.KvBatchRollback

• optional Context context = 1

• uint64 start_version = 2

• repeated bytes keys = 3

Empty if the rollback is successful.

Used as response type in: tinykvpb.TinyKv.KvBatchRollback

• optional errorpb.Error region_error = 1

• optional KeyError error = 2

CheckTxnStatus reports on the status of a transaction and may take action to rollback expired locks. If the transaction has previously been rolled back or committed, return that information. If the TTL of the transaction is exhausted, abort that transaction and roll back the primary lock. Otherwise, returns the TTL information.

Used as request type in: tinykvpb.TinyKv.KvCheckTxnStatus

• optional Context context = 1

• bytes primary_key = 2

• uint64 lock_ts = 3

  primary key and lock ts together to locate the primary lock of a transaction.

• uint64 current_ts = 4

  current_ts is used to check TTL timeout, it may be inaccurate.

Used as response type in: tinykvpb.TinyKv.KvCheckTxnStatus

• optional errorpb.Error region_error = 1

• uint64 lock_ttl = 2

  Three kinds of txn status: locked: lock_ttl > 0 committed: commit_version > 0 rolled back: lock_ttl == 0 && commit_version == 0

• uint64 commit_version = 3

• Action action = 4

  The action performed by TinyKV in response to the CheckTxnStatus request.

Commit is the second phase of 2pc. The client must have successfully prewritten the transaction to all nodes. If all keys are locked by the given transaction, then the commit should succeed. If any keys are locked by a different transaction or are not locked at all (rolled back or expired), the commit fails.

Used as request type in: tinykvpb.TinyKv.KvCommit

• optional Context context = 1

• uint64 start_version = 2

  Identifies the transaction, must match the start_version in the transaction's prewrite request.

• repeated bytes keys = 3

  Must match the keys mutated by the transaction's prewrite request.

• uint64 commit_version = 4

  Must be greater than start_version.

Empty if the commit is successful.

Used as response type in: tinykvpb.TinyKv.KvCommit

• optional errorpb.Error region_error = 1

• optional KeyError error = 2

Miscellaneous data present in each request.

Used in: coprocessor.Request, BatchRollbackRequest, CheckTxnStatusRequest, CommitRequest, GetRequest, PrewriteRequest, RawDeleteRequest, RawGetRequest, RawPutRequest, RawScanRequest, ResolveLockRequest, ScanRequest

• uint64 region_id = 1

• optional metapb.RegionEpoch region_epoch = 2

• optional metapb.Peer peer = 3

• uint64 term = 5

Read the value of a key at the given time.

Used as request type in: tinykvpb.TinyKv.KvGet

• optional Context context = 1

• bytes key = 2

• uint64 version = 3

Used as response type in: tinykvpb.TinyKv.KvGet

• optional errorpb.Error region_error = 1

• optional KeyError error = 2

• bytes value = 3

• bool not_found = 4

  True if the requested key doesn't exist; another error will not be signalled.

Many responses can include a KeyError for some problem with one of the requested key. Only one field is set and it indicates what the client should do in response.

Used in: BatchRollbackResponse, CommitResponse, GetResponse, KvPair, PrewriteResponse, ResolveLockResponse

• optional LockInfo locked = 1

  Client should backoff or cleanup the lock then retry.

• string retryable = 2

  Client may restart the txn. e.g write conflict.

• string abort = 3

  Client should abort the txn.

• optional WriteConflict conflict = 4

  Another transaction is trying to write a key. The client can retry.

Either a key/value pair or an error for a particular key.

Used in: RawScanResponse, ScanResponse

• optional KeyError error = 1

• bytes key = 2

• bytes value = 3

Used in: coprocessor.Response, KeyError

• bytes primary_lock = 1

• uint64 lock_version = 2

• bytes key = 3

• uint64 lock_ttl = 4

Used in: PrewriteRequest

• Op op = 1

• bytes key = 2

• bytes value = 3

Used in: Mutation

• Put = 0

• Del = 1

• Rollback = 2

• Lock = 3

  Used by TinySQL but not TinyKV.

Prewrite is the first phase of two phase commit. A prewrite commit contains all the writes (mutations) which a client would like to make as part of a transaction. The request succeeds if none of the keys are locked. In that case all those keys will be locked. If the prewrite fails, no changes are made to the DB.

Used as request type in: tinykvpb.TinyKv.KvPrewrite

• optional Context context = 1

• repeated Mutation mutations = 2

• bytes primary_lock = 3

  Key of the primary lock.

• uint64 start_version = 4

• uint64 lock_ttl = 5

Empty if the prewrite is successful.

Used as response type in: tinykvpb.TinyKv.KvPrewrite

• optional errorpb.Error region_error = 1

• repeated KeyError errors = 2

Used as request type in: tinykvpb.TinyKv.RawDelete

• optional Context context = 1

• bytes key = 2

• string cf = 3

Used as response type in: tinykvpb.TinyKv.RawDelete

• optional errorpb.Error region_error = 1

• string error = 2

Raw commands.

Used as request type in: tinykvpb.TinyKv.RawGet

• optional Context context = 1

• bytes key = 2

• string cf = 3

Used as response type in: tinykvpb.TinyKv.RawGet

• optional errorpb.Error region_error = 1

• string error = 2

• bytes value = 3

• bool not_found = 4

  True if the requested key doesn't exist; another error will not be signalled.

Used as request type in: tinykvpb.TinyKv.RawPut

• optional Context context = 1

• bytes key = 2

• bytes value = 3

• string cf = 4

Used as response type in: tinykvpb.TinyKv.RawPut

• optional errorpb.Error region_error = 1

• string error = 2

Used as request type in: tinykvpb.TinyKv.RawScan

• optional Context context = 1

• bytes start_key = 2

• uint32 limit = 3

  The maximum number of values read.

• string cf = 4

Used as response type in: tinykvpb.TinyKv.RawScan

• optional errorpb.Error region_error = 1

• string error = 2

  An error which affects the whole scan. Per-key errors are included in kvs.

• repeated KvPair kvs = 3

Resolve lock will find all locks belonging to the transaction with the given start timestamp. If commit_version is 0, TinyKV will rollback all locks. If commit_version is greater than 0 it will commit those locks with the given commit timestamp. The client will make a resolve lock request for all secondary keys once it has successfully committed or rolled back the primary key.

Used as request type in: tinykvpb.TinyKv.KvResolveLock

• optional Context context = 1

• uint64 start_version = 2

• uint64 commit_version = 3

Empty if the lock is resolved successfully.

Used as response type in: tinykvpb.TinyKv.KvResolveLock

• optional errorpb.Error region_error = 1

• optional KeyError error = 2

Read multiple values from the DB.

Used as request type in: tinykvpb.TinyKv.KvScan

• optional Context context = 1

• bytes start_key = 2

• uint32 limit = 3

  The maximum number of values read.

• uint64 version = 4

Used as response type in: tinykvpb.TinyKv.KvScan

• optional errorpb.Error region_error = 1

• repeated KvPair pairs = 2

  Other errors are recorded for each key in pairs.

Used in: KeyError

• uint64 start_ts = 1

• uint64 conflict_ts = 2

• bytes key = 3

• bytes primary = 4