package errorpb

Get desktop application:
View/edit binary Protocol Buffers messages

BucketVersionNotMatch is the error variant that tells the request buckets version is not match. client should update the buckets version and retry.

Used in: Error

• uint64 version = 1

• repeated bytes keys = 2

Used in: Error

• uint64 region_id = 1

  The requested region ID

• uint64 peer_id = 2

• uint64 safe_ts = 3

Used in: Error

• repeated uint64 store_id = 1

  The requested store ID

• string reason = 2

  The detailed info

EpochNotMatch is the error variant that tells a region has been updated. (e.g. by splitting / merging, or raft Confchange.) Hence, a command is based on a stale version of a region.

Used in: cdcpb.Error, Error

• repeated metapb.Region current_regions = 1

  Available regions that may be siblings of the requested one.

Error wraps all region errors, indicates an error encountered by a request.

Used in: backup.Error, backup.PrepareSnapshotBackupResponse, coprocessor.DelegateResponse, coprocessor.Response, coprocessor.StoreBatchTaskResponse, import_sstpb.DuplicateDetectResponse, import_sstpb.Error, import_sstpb.IngestResponse, kvrpcpb.BatchGetResponse, kvrpcpb.BatchRollbackResponse, kvrpcpb.BufferBatchGetResponse, kvrpcpb.CheckSecondaryLocksResponse, kvrpcpb.CheckTxnStatusResponse, kvrpcpb.CleanupResponse, kvrpcpb.CommitResponse, kvrpcpb.DeleteRangeResponse, kvrpcpb.FlashbackToVersionResponse, kvrpcpb.FlushResponse, kvrpcpb.GCResponse, kvrpcpb.GetHealthFeedbackResponse, kvrpcpb.GetLockWaitHistoryResponse, kvrpcpb.GetLockWaitInfoResponse, kvrpcpb.GetResponse, kvrpcpb.ImportResponse, kvrpcpb.MvccGetByKeyResponse, kvrpcpb.MvccGetByStartTsResponse, kvrpcpb.PessimisticLockResponse, kvrpcpb.PessimisticRollbackResponse, kvrpcpb.PrepareFlashbackToVersionResponse, kvrpcpb.PrewriteResponse, kvrpcpb.RawBatchDeleteResponse, kvrpcpb.RawBatchGetResponse, kvrpcpb.RawBatchPutResponse, kvrpcpb.RawBatchScanResponse, kvrpcpb.RawCASResponse, kvrpcpb.RawChecksumResponse, kvrpcpb.RawCoprocessorResponse, kvrpcpb.RawDeleteRangeResponse, kvrpcpb.RawDeleteResponse, kvrpcpb.RawGetKeyTTLResponse, kvrpcpb.RawGetResponse, kvrpcpb.RawPutResponse, kvrpcpb.RawScanResponse, kvrpcpb.ReadIndexResponse, kvrpcpb.ResolveLockResponse, kvrpcpb.ScanLockResponse, kvrpcpb.ScanResponse, kvrpcpb.SplitRegionResponse, kvrpcpb.TxnHeartBeatResponse, kvrpcpb.UnsafeDestroyRangeResponse, logbackup.RegionCheckpoint, raft_cmdpb.RaftResponseHeader

• string message = 1

  The error message

• optional NotLeader not_leader = 2

• optional RegionNotFound region_not_found = 3

• optional KeyNotInRegion key_not_in_region = 4

• optional EpochNotMatch epoch_not_match = 5

• optional ServerIsBusy server_is_busy = 6

• optional StaleCommand stale_command = 7

• optional StoreNotMatch store_not_match = 8

• optional RaftEntryTooLarge raft_entry_too_large = 9

• optional MaxTimestampNotSynced max_timestamp_not_synced = 10

• optional ReadIndexNotReady read_index_not_ready = 11

• optional ProposalInMergingMode proposal_in_merging_mode = 12

• optional DataIsNotReady data_is_not_ready = 13

• optional RegionNotInitialized region_not_initialized = 14

• optional DiskFull disk_full = 15

• optional RecoveryInProgress RecoveryInProgress = 16

  Online recovery is still in performing, reject writes to avoid potential issues

• optional FlashbackInProgress FlashbackInProgress = 17

  Flashback is still in performing, reject any read or write to avoid potential issues. NOTICE: this error is non-retryable, the request should fail ASAP when it meets this error.

• optional FlashbackNotPrepared FlashbackNotPrepared = 18

  If the second phase flashback request is sent to a region that is not prepared for the flashback, this error will be returned. NOTICE: this error is non-retryable, the client should retry the first phase flashback request when it meets this error.

• optional IsWitness is_witness = 19

  IsWitness is the error variant that tells a request be handle by witness which should be forbidden and retry.

• optional MismatchPeerId mismatch_peer_id = 20

• optional BucketVersionNotMatch bucket_version_not_match = 21

  BucketVersionNotMatch is the error variant that tells the request buckets version is not match.

• optional UndeterminedResult undetermined_result = 22

  UndeterminedResult is the error variant that tells the result is not determined yet.

• optional IncompatibleRequest incompatible_request = 23

  A compatibility rejection with no usable business result. For a zero declaration, also set server_is_busy.reason to "txn_protocol_incompatible"; omit that fallback for nonzero declarations. Clients must handle this error before fallback or ordinary retry logic. Only client-c may reselect and resend when the reason is version out of range, the returned range is valid, and provided > max. The selected version must satisfy the request's requirements. Such admission rejections must have no transaction side effects. All other incompatibilities are terminal.

Used in: Error

• uint64 region_id = 1

  The requested region ID

• uint64 flashback_start_ts = 2

Used in: Error

• uint64 region_id = 1

  The requested region ID

A transaction protocol compatibility rejection. The compatible range is inclusive: admission reports the store's global range; feature checks report [required feature version, store's maximum version].

Used in: Error

• IncompatibleRequestReason reason = 1

• string message = 2

  Diagnostic text; clients must use structured fields for control flow.

• uint32 provided_txn_protocol_version = 3

  The request's declaration; missing and explicit zero both mean legacy.

• uint32 min_compatible_txn_protocol_version = 4

• uint32 max_compatible_txn_protocol_version = 5

Reasons for rejecting an incompatible transaction protocol request.

Used in: IncompatibleRequest

• IncompatibleRequestReasonUnknown = 0

• IncompatibleRequestReasonTxnProtocolVersionOutOfRange = 1

  The declared version is outside the compatible range returned in the error.

IsWitness is the error variant that tells a request be handle by witness which should be forbidden and retry.

Used in: Error

• uint64 region_id = 1

  The requested region ID

KeyNotInRegion is the error variant that tells the key the request requires isn't present in this region.

Used in: Error

• bytes key = 1

  The requested key

• uint64 region_id = 2

  The requested region ID

• bytes start_key = 3

  Start key of the requested region

• bytes end_key = 4

  Snd key of the requested region

MaxTimestampNotSynced is the error variant that tells the peer has just become a leader and updating the max timestamp in the concurrency manager from PD TSO is ongoing. In this case, the prewrite of an async commit transaction cannot succeed. The client can backoff and resend the request.

Used in: Error

(message has no fields)

MismatchPeerId is the error variant that tells the request is sent to wrong peer. Client receives this error should reload the region info and retry.

Used in: Error

• uint64 request_peer_id = 1

• uint64 store_peer_id = 2

NotLeader is the error variant that tells a request be handle by raft leader is sent to raft follower or learner.

Used in: cdcpb.Error, Error

• uint64 region_id = 1

  The requested region ID

• optional metapb.Peer leader = 2

  Region leader of the requested region

ProposalInMergingMode is the error variant that tells the proposal is rejected because raft is in the merging mode. This may happen when BR/Lightning try to ingest SST. This can be retried at most time.

Used in: Error

• uint64 region_id = 1

  The requested region ID

RaftEntryTooLarge is the error variant that tells the request is too large to be serialized to a reasonable small raft entry. (i.e. greater than the configured value `raft_entry_max_size` in `raftstore`)

Used in: Error

• uint64 region_id = 1

  The requested region ID

• uint64 entry_size = 2

  Size of the raft entry

ReadIndexNotReady is the error variant that tells the read index request is not ready, that is, the current region is in a status that not ready to serve the read index request. For example, region is in splitting or merging status. This can be retried at most time.

Used in: Error

• string reason = 1

  The reason why the region is not ready to serve read index request

• uint64 region_id = 2

  The requested region ID

Used in: Error

• uint64 region_id = 1

  The requested region ID

RegionNotFound is the error variant that tells there isn't any region in this TiKV matches the requested region ID.

Used in: cdcpb.Error, Error

• uint64 region_id = 1

  The requested region ID

RegionNotInitialized is the error variant that tells there isn't any initialized peer matchesthe request region ID.

Used in: Error

• uint64 region_id = 1

  The request region ID

ServerIsBusy is the error variant that tells the server is too busy to response.

Used in: cdcpb.Error, Error

• string reason = 1

  "txn_protocol_incompatible" is a legacy fallback for IncompatibleRequest, not an overload signal.

• uint64 backoff_ms = 2

  The suggested backoff time

• uint32 estimated_wait_ms = 3

• uint64 applied_index = 4

  Current applied_index at the leader, may be used in replica read.

StaleCommand is the error variant that tells the command is stale, that is, the current request term is lower than current raft term. This can be retried at most time.

Used in: Error

(message has no fields)

StoreNotMatch is the error variant that tells the request is sent to wrong store. (i.e. inconsistency of the store ID that request shows and the real store ID of this server.)

Used in: Error

• uint64 request_store_id = 1

  Store id in request

• uint64 actual_store_id = 2

  Actual store id

UndeterminedResult is the error variant that tells the result is not determined yet. For example, the raft protocol timed out and the apply result is unknown.

Used in: Error

• string message = 1