package com.alibaba.otter.canal.protocol

Get desktop application:
View/edit binary Protocol Buffers messages

• oneof error_code_present

  [default = 0]

  • int32 error_code = 1

• string error_message = 2

  if something like compression is not supported, erorr_message will tell about it.

• string destination = 1

• string client_id = 2

• int64 batch_id = 3

client authentication

• string username = 1

• bytes password = 2

  hashed password with seeds from Handshake message

• oneof net_read_timeout_present

  [default = 0]

  • int32 net_read_timeout = 3

    in seconds

• oneof net_write_timeout_present

  [default = 0];

  • int32 net_write_timeout = 4

    in seconds

• string destination = 5

• string client_id = 6

• string filter = 7

• int64 start_timestamp = 8

• string destination = 1

• string client_id = 2

• int64 batch_id = 3

*每个字段的数据结构*

Used in: RowData

• int32 index = 1

  *字段下标*

• int32 sqlType = 2

  *字段java中类型*

• string name = 3

  *字段名称(忽略大小写)，在mysql中是没有的*

• bool isKey = 4

  *是否是主键*

• bool updated = 5

  *如果EventType=UPDATE,用于标识这个字段值是否有修改*

• oneof isNull_present

  [default = false]

  • bool isNull = 6

• repeated Pair props = 7

  *预留扩展*

• string value = 8

  * 字段值,timestamp,Datetime是一个时间格式的文本 *

• int32 length = 9

  * 对应数据对象原始长度 *

• string mysqlType = 10

  *字段mysql类型*

Used in: Handshake, Packet

• COMPRESSIONCOMPATIBLEPROTO2 = 0

• NONE = 1

• ZLIB = 2

• GZIP = 3

• LZF = 4

TBD when new packets are required

• string journal = 1

• int64 position = 2

• oneof timestamp_present

  [default = 0]

  • int64 timestamp = 3

*************************************************************** message model 如果要在Enum中新增类型，确保以前的类型的下标值不变. **************************************************************

• optional Header header = 1

  *协议头部信息*

• oneof entryType_present

  /**打散后的事件类型**/ [default = ROWDATA]

  • EntryType entryType = 2

• bytes storeValue = 3

  *传输的二进制数组*

*打散后的事件类型，主要用于标识事务的开始，变更数据，结束*

Used in: Entry

• ENTRYTYPECOMPATIBLEPROTO2 = 0

• TRANSACTIONBEGIN = 1

• ROWDATA = 2

• TRANSACTIONEND = 3

• HEARTBEAT = 4

  * 心跳类型，内部使用，外部暂不可见，可忽略 *

• GTIDLOG = 5

* 事件类型 *

Used in: Header, RowChange

• EVENTTYPECOMPATIBLEPROTO2 = 0

• INSERT = 1

• UPDATE = 2

• DELETE = 3

• CREATE = 4

• ALTER = 5

• ERASE = 6

• QUERY = 7

• TRUNCATE = 8

• RENAME = 9

• CINDEX = 10

  *CREATE INDEX*

• DINDEX = 11

• GTID = 12

• XACOMMIT = 13

  * XA *

• XAROLLBACK = 14

• MHEARTBEAT = 15

  * MASTER HEARTBEAT *

PullRequest

• string destination = 1

• string client_id = 2

• int32 fetch_size = 3

• oneof timeout_present

  [default = -1]

  • int64 timeout = 4

    默认-1时代表不控制

• oneof unit_present

  [default = 2]

  • int32 unit = 5

    数字类型，0:纳秒,1:毫秒,2:微秒,3:秒,4:分钟,5:小时,6:天

• oneof auto_ack_present

  [default = false]

  • bool auto_ack = 6

    是否自动ack

• oneof communication_encoding_present

  [default = "utf8"];

  • string communication_encoding = 1

• bytes seeds = 2

• Compression supported_compressions = 3

*message Header*

*协议的版本号*

Used in: Entry

• oneof version_present

  [default = 1]

  • int32 version = 1

• string logfileName = 2

  *binlog/redolog 文件名*

• int64 logfileOffset = 3

  *binlog/redolog 文件的偏移位置*

• int64 serverId = 4

  *服务端serverId*

• string serverenCode = 5

  * 变更数据的编码 *

• int64 executeTime = 6

  *变更数据的执行时间 *

• oneof sourceType_present

  [default = MYSQL]

  • Type sourceType = 7

• string schemaName = 8

  * 变更数据的schemaname*

• string tableName = 9

  *变更数据的tablename*

• int64 eventLength = 10

  *每个event的长度*

• oneof eventType_present

  [default = UPDATE]

  • EventType eventType = 11

• repeated Pair props = 12

  *预留扩展*

• string gtid = 13

  *当前事务的gitd*

• int64 send_timestamp = 1

• int64 start_timestamp = 2

• int64 batch_id = 1

• repeated bytes messages = 2

• oneof magic_number_present

  [default = 17];

  • int32 magic_number = 1

• oneof version_present

  [default = 1];

  • int32 version = 2

• PacketType type = 3

• oneof compression_present

  [default = NONE];

  • Compression compression = 4

• bytes body = 5

Used in: Packet

• PACKAGETYPECOMPATIBLEPROTO2 = 0

  compatible

• HANDSHAKE = 1

• CLIENTAUTHENTICATION = 2

• ACK = 3

• SUBSCRIPTION = 4

• UNSUBSCRIPTION = 5

• GET = 6

• MESSAGES = 7

• CLIENTACK = 8

• SHUTDOWN = 9

  management part

• DUMP = 10

  integration

• HEARTBEATS = 11

• CLIENTROLLBACK = 12

*预留扩展*

Used in: Column, Header, RowChange, RowData, TransactionBegin, TransactionEnd

• string key = 1

• string value = 2

*message row 每行变更数据的数据结构*

• int64 tableId = 1

  *tableId,由数据库产生*

• oneof eventType_present

  [default = UPDATE]

  • EventType eventType = 2

• oneof isDdl_present

  [default = false]

  • bool isDdl = 10

• string sql = 11

  * ddl/query的sql语句 *

• repeated RowData rowDatas = 12

  * 一次数据库变更可能存在多行 *

• repeated Pair props = 13

  *预留扩展*

• string ddlSchemaName = 14

  * ddl/query的schemaName，会存在跨库ddl，需要保留执行ddl的当前schemaName *

Used in: RowChange

• repeated Column beforeColumns = 1

  * 字段信息，增量数据(修改前,删除前) *

• repeated Column afterColumns = 2

  * 字段信息，增量数据(修改后,新增后) *

• repeated Pair props = 3

  *预留扩展*

subscription

• string destination = 1

• string client_id = 2

• string filter = 7

*开始事务的一些信息*

• int64 executeTime = 1

  *已废弃，请使用header里的executeTime*

• string transactionId = 2

  *已废弃，Begin里不提供事务id*

• repeated Pair props = 3

  *预留扩展*

• int64 threadId = 4

  *执行的thread Id*

*结束事务的一些信息*

• int64 executeTime = 1

  *已废弃，请使用header里的executeTime*

• string transactionId = 2

  *事务号*

• repeated Pair props = 3

  *预留扩展*

*数据库类型*

Used in: Header

• TYPECOMPATIBLEPROTO2 = 0

• ORACLE = 1

• MYSQL = 2

• PGSQL = 3

Unsubscription

• string destination = 1

• string client_id = 2

• string filter = 7