package cdcpb

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc EventFeed (stream ChangeDataRequest, stream ChangeDataEvent)

  cdcpb.proto:199

• rpc EventFeedV2 (stream ChangeDataRequest, stream ChangeDataEvent)

  cdcpb.proto:205

  EventFeedV2 is like EventFeed, with some new changes: * clients send requested features in HTTP/2 headers; * if servers meets unsupported feature request, it can fail the stream with an UNIMPLEMENTED error.

NOTE: events and resolved_ts won't appear simultaneously in one ChangeDataEvent.

Used as response type in: ChangeData.EventFeed, ChangeData.EventFeedV2

• repeated Event events = 1

• optional ResolvedTs resolved_ts = 2

  More store level events ...

Used as request type in: ChangeData.EventFeed, ChangeData.EventFeedV2

• optional Header header = 1

• uint64 region_id = 2

• optional metapb.RegionEpoch region_epoch = 3

• uint64 checkpoint_ts = 4

• bytes start_key = 5

• bytes end_key = 6

• uint64 request_id = 7

  Used for CDC to identify events corresponding to different requests. Generally in one call stream, a region can be subscribed multiple times with different `request_id`s.

• kvrpcpb.ExtraOp extra_op = 8

• oneof request

  • ChangeDataRequest.Register register = 9

    A normal request that trying to register change data feed on a region.

  • ChangeDataRequest.NotifyTxnStatus notify_txn_status = 10

    Notify the region that some of the running transactions on the region has a pushed min_commit_ts so that the resolved_ts can be advanced.

  • ChangeDataRequest.Deregister deregister = 13

• ChangeDataRequest.KvAPI kv_api = 11

• bool filter_loop = 12

  Whether to filter out the value write by cdc itself.

Used in: ChangeDataRequest

(message has no fields)

KvAPI specifies to capture data written by different KV API. See more details in https://github.com/tikv/rfcs/blob/master/text/0069-api-v2.md.

Used in: ChangeDataRequest

• TiDB = 0

• RawKV = 1

• TxnKV = 2

Used in: ChangeDataRequest

• repeated TxnStatus txn_status = 1

Used in: ChangeDataRequest

(message has no fields)

ClusterIDMismatch is an error variable that tells people that the cluster ID of the request does not match the TiKV cluster ID.

Used in: Error

• uint64 current = 1

  The current tikv cluster ID.

• uint64 request = 2

  The cluster ID of the TiCDC request.

Used in: Error

• string required_version = 1

Congested is an error variable that tells people that the TiKV-CDC is congested.

Used in: Error

• uint64 region_id = 1

  The region ID that triggers the congestion.

Used in: Error

• uint64 region_id = 1

Used in: Event

• optional errorpb.NotLeader not_leader = 1

• optional errorpb.RegionNotFound region_not_found = 2

• optional errorpb.EpochNotMatch epoch_not_match = 3

• optional DuplicateRequest duplicate_request = 4

• optional Compatibility compatibility = 5

• optional ClusterIDMismatch cluster_id_mismatch = 6

• optional errorpb.ServerIsBusy server_is_busy = 7

• optional Congested congested = 8

Used in: ChangeDataEvent

• uint64 region_id = 1

• uint64 index = 2

• uint64 request_id = 7

• oneof event

  • Event.Entries entries = 3

  • Event.Admin admin = 4

  • Error error = 5

  • uint64 resolved_ts = 6

  • Event.LongTxn long_txn = 8

    Note that field 7 is taken by request_id.

    More region level events ...

Used in: Event

• optional raft_cmdpb.AdminRequest admin_request = 1

• optional raft_cmdpb.AdminResponse admin_response = 2

Used in: Event

• repeated Row entries = 1

Used in: Row

• UNKNOWN = 0

• PREWRITE = 1

• COMMIT = 2

• ROLLBACK = 3

• COMMITTED = 4

• INITIALIZED = 5

Used in: Event

• repeated TxnInfo txn_info = 1

Used in: Entries

• uint64 start_ts = 1

• uint64 commit_ts = 2

• LogType type = 3

• uint64 generation = 10

  generation is for pipelined DML protocol. See kvrpcpb.FlushRequest.generation.

• Row.OpType op_type = 4

• bytes key = 5

• bytes value = 6

• bytes old_value = 7

• uint64 expire_ts_unix_secs = 8

  expire_ts_unix_secs is used for RawKV (see `ChangeDataRequest.KvApi`), and represents the expiration time of this row. Absolute time, seconds since Unix epoch.

• uint64 txn_source = 9

  The source of this row.

Used in: Row

• UNKNOWN = 0

• PUT = 1

• DELETE = 2

Used in: ChangeDataRequest

• uint64 cluster_id = 1

• string ticdc_version = 2

Used in: ChangeDataEvent

• repeated uint64 regions = 1

• uint64 ts = 2

• uint64 request_id = 3

Used in: Event.LongTxn

• uint64 start_ts = 1

• bytes primary = 2

Used in: ChangeDataRequest.NotifyTxnStatus

• uint64 start_ts = 1

• uint64 min_commit_ts = 2

• uint64 commit_ts = 3

• bool is_rolled_back = 4