Class: TencentCloud::Ckafka::V20190819::MySQLParam

Inherits:
TencentCloud::Common::AbstractModel
  • Object
show all
Defined in:
lib/v20190819/models.rb

Overview

MySQL类型入参

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(database = nil, table = nil, resource = nil, snapshotmode = nil, ddltopic = nil, datasourcemonitormode = nil, datasourcemonitorresource = nil, datasourceincrementmode = nil, datasourceincrementcolumn = nil, datasourcestartfrom = nil, datatargetinsertmode = nil, datatargetprimarykeyfield = nil, datatargetrecordmapping = nil, topicregex = nil, topicreplacement = nil, keycolumns = nil, dropinvalidmessage = nil, dropcls = nil, outputformat = nil, istableprefix = nil, includecontentchanges = nil, includequery = nil, recordwithschema = nil, signaldatabase = nil, istableregular = nil, signaltable = nil, datetimezone = nil, selfbuilt = nil) ⇒ MySQLParam

Returns a new instance of MySQLParam.



10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
 
# File 'lib/v20190819/models.rb', line 10150

def initialize(database=nil, table=nil, resource=nil, snapshotmode=nil, ddltopic=nil, datasourcemonitormode=nil, datasourcemonitorresource=nil, datasourceincrementmode=nil, datasourceincrementcolumn=nil, datasourcestartfrom=nil, datatargetinsertmode=nil, datatargetprimarykeyfield=nil, datatargetrecordmapping=nil, topicregex=nil, topicreplacement=nil, keycolumns=nil, dropinvalidmessage=nil, dropcls=nil, outputformat=nil, istableprefix=nil, includecontentchanges=nil, includequery=nil, recordwithschema=nil, signaldatabase=nil, istableregular=nil, signaltable=nil, datetimezone=nil, selfbuilt=nil)
  @Database = database
  @Table = table
  @Resource = resource
  @SnapshotMode = snapshotmode
  @DdlTopic = ddltopic
  @DataSourceMonitorMode = datasourcemonitormode
  @DataSourceMonitorResource = datasourcemonitorresource
  @DataSourceIncrementMode = datasourceincrementmode
  @DataSourceIncrementColumn = datasourceincrementcolumn
  @DataSourceStartFrom = datasourcestartfrom
  @DataTargetInsertMode = datatargetinsertmode
  @DataTargetPrimaryKeyField = datatargetprimarykeyfield
  @DataTargetRecordMapping = datatargetrecordmapping
  @TopicRegex = topicregex
  @TopicReplacement = topicreplacement
  @KeyColumns = keycolumns
  @DropInvalidMessage = dropinvalidmessage
  @DropCls = dropcls
  @OutputFormat = outputformat
  @IsTablePrefix = istableprefix
  @IncludeContentChanges = includecontentchanges
  @IncludeQuery = includequery
  @RecordWithSchema = recordwithschema
  @SignalDatabase = signaldatabase
  @IsTableRegular = istableregular
  @SignalTable = signaltable
  @DateTimeZone = datetimezone
  @SelfBuilt = selfbuilt
end

Instance Attribute Details

#Database ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def Database
  @Database
end

#DataSourceIncrementColumn ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataSourceIncrementColumn
  @DataSourceIncrementColumn
end

#DataSourceIncrementMode ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataSourceIncrementMode
  @DataSourceIncrementMode
end

#DataSourceMonitorMode ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataSourceMonitorMode
  @DataSourceMonitorMode
end

#DataSourceMonitorResource ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataSourceMonitorResource
  @DataSourceMonitorResource
end

#DataSourceStartFrom ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataSourceStartFrom
  @DataSourceStartFrom
end

#DataTargetInsertMode ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataTargetInsertMode
  @DataTargetInsertMode
end

#DataTargetPrimaryKeyField ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataTargetPrimaryKeyField
  @DataTargetPrimaryKeyField
end

#DataTargetRecordMapping ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DataTargetRecordMapping
  @DataTargetRecordMapping
end

#DateTimeZone ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DateTimeZone
  @DateTimeZone
end

#DdlTopic ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DdlTopic
  @DdlTopic
end

#DropCls ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DropCls
  @DropCls
end

#DropInvalidMessage ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def DropInvalidMessage
  @DropInvalidMessage
end

#IncludeContentChanges ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def IncludeContentChanges
  @IncludeContentChanges
end

#IncludeQuery ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def IncludeQuery
  @IncludeQuery
end

#IsTablePrefix ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def IsTablePrefix
  @IsTablePrefix
end

#IsTableRegular ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def IsTableRegular
  @IsTableRegular
end

#KeyColumns ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def KeyColumns
  @KeyColumns
end

#OutputFormat ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def OutputFormat
  @OutputFormat
end

#RecordWithSchema ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def RecordWithSchema
  @RecordWithSchema
end

#Resource ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def Resource
  @Resource
end

#SelfBuilt ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def SelfBuilt
  @SelfBuilt
end

#SignalDatabase ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def SignalDatabase
  @SignalDatabase
end

#SignalTable ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def SignalTable
  @SignalTable
end

#SnapshotMode ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def SnapshotMode
  @SnapshotMode
end

#Table ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def Table
  @Table
end

#TopicRegex ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def TopicRegex
  @TopicRegex
end

#TopicReplacement ⇒ Object

注意：此字段可能返回 null，表示取不到有效值。

Parameters:

  • Database: —

    MySQL的数据库名称，"*"为全数据库

  • Table: —

    MySQL的数据表名称，"*"为所监听的所有数据库中的非系统表，可以","间隔，监听多个数据表，但数据表需要以"数据库名.数据表名"的格式进行填写，需要填入正则表达式时，格式为"数据库名\.数据表名"

  • Resource: —

    该MySQL在连接管理内的Id

  • SnapshotMode: —

    复制存量信息(schema_only不复制, initial全量)，默认值initial

  • DdlTopic: —

    存放MySQL的Ddl信息的Topic，为空则默认不存放

  • DataSourceMonitorMode:表示读取项为table，表示读取项为query ("TABLE""QUERY") —

    ataSourceMonitorMode: "TABLE" 表示读取项为 table，"QUERY" 表示读取项为 query

  • DataSourceMonitorResource: —

    当 "DataMonitorMode"="TABLE" 时，传入需要读取的 Table；当 "DataMonitorMode"="QUERY" 时，传入需要读取的查询 sql 语句

  • DataSourceIncrementMode:表示增量列为时间戳类型，表示增量列为自增id类型 ("TIMESTAMP""INCREMENT") —

    ataSourceIncrementMode: "TIMESTAMP" 表示增量列为时间戳类型，"INCREMENT" 表示增量列为自增 id 类型

  • DataSourceIncrementColumn: —

    传入需要监听的列名称

  • DataSourceStartFrom:表示复制存量+增量数据，表示只复制增量数据 ("HEAD""TAIL") —

    ataSourceStartFrom: "HEAD" 表示复制存量 + 增量数据，"TAIL" 表示只复制增量数据

  • DataTargetInsertMode:表示使用Insert模式插入，表示使用Upsert模式插入 ("INSERT""UPSERT") —

    ataTargetInsertMode: "INSERT" 表示使用 Insert 模式插入，"UPSERT" 表示使用 Upsert 模式插入

  • DataTargetPrimaryKeyField: —

    当 "DataInsertMode"="UPSERT" 时，传入当前 upsert 时依赖的主键

  • DataTargetRecordMapping: —

    表与消息间的映射关系

  • TopicRegex: —

    事件路由到特定主题的正则表达式，默认为(.*)

  • TopicReplacement: —

    TopicRegex的引用组，指定$1、$2等

  • KeyColumns: —

    格式：库1.表1:字段1,字段2;库2.表2:字段2，表之间;（分号）隔开，字段之间,（逗号）隔开。不指定的表默认取表的主键

  • DropInvalidMessage: —

    Mysql 是否抛弃解析失败的消息，默认为true

  • DropCls: —

    当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效

  • OutputFormat: —

    输出格式，DEFAULT、CANAL_1、CANAL_2

  • IsTablePrefix: —

    当Table输入的是前缀时，该项值为true，否则为false

  • IncludeContentChanges: —

    如果该值为all，则DDL数据以及DML数据也会写入到选中的topic；若该值为dml，则只有DML数据写入到选中的topic

  • IncludeQuery: —

    如果该值为true，且MySQL中"binlog_rows_query_log_events"配置项的值为"ON"，则流入到topic的数据包含原SQL语句；若该值为false，流入到topic的数据不包含原SQL语句

  • RecordWithSchema: —

    如果该值为 true，则消息中会携带消息结构体对应的schema，如果该值为false则不会携带

  • SignalDatabase: —

    存放信令表的数据库名称

  • IsTableRegular: —

    输入的table是否为正则表达式，如果该选项以及IsTablePrefix同时为true，该选项的判断优先级高于IsTablePrefix

  • SignalTable: —

    信号表

  • DateTimeZone: —

    datetime 类型字段转换为时间戳的时区

  • SelfBuilt: —

    是否为自建集群



10148
10149
10150
 
# File 'lib/v20190819/models.rb', line 10148

def TopicReplacement
  @TopicReplacement
end

Instance Method Details

#deserialize(params) ⇒ Object 



10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
 
# File 'lib/v20190819/models.rb', line 10181

def deserialize(params)
  @Database = params['Database']
  @Table = params['Table']
  @Resource = params['Resource']
  @SnapshotMode = params['SnapshotMode']
  @DdlTopic = params['DdlTopic']
  @DataSourceMonitorMode = params['DataSourceMonitorMode']
  @DataSourceMonitorResource = params['DataSourceMonitorResource']
  @DataSourceIncrementMode = params['DataSourceIncrementMode']
  @DataSourceIncrementColumn = params['DataSourceIncrementColumn']
  @DataSourceStartFrom = params['DataSourceStartFrom']
  @DataTargetInsertMode = params['DataTargetInsertMode']
  @DataTargetPrimaryKeyField = params['DataTargetPrimaryKeyField']
  unless params['DataTargetRecordMapping'].nil?
    @DataTargetRecordMapping = []
    params['DataTargetRecordMapping'].each do |i|
      recordmapping_tmp = RecordMapping.new
      recordmapping_tmp.deserialize(i)
      @DataTargetRecordMapping << recordmapping_tmp
    end
  end
  @TopicRegex = params['TopicRegex']
  @TopicReplacement = params['TopicReplacement']
  @KeyColumns = params['KeyColumns']
  @DropInvalidMessage = params['DropInvalidMessage']
  unless params['DropCls'].nil?
    @DropCls = DropCls.new
    @DropCls.deserialize(params['DropCls'])
  end
  @OutputFormat = params['OutputFormat']
  @IsTablePrefix = params['IsTablePrefix']
  @IncludeContentChanges = params['IncludeContentChanges']
  @IncludeQuery = params['IncludeQuery']
  @RecordWithSchema = params['RecordWithSchema']
  @SignalDatabase = params['SignalDatabase']
  @IsTableRegular = params['IsTableRegular']
  @SignalTable = params['SignalTable']
  @DateTimeZone = params['DateTimeZone']
  @SelfBuilt = params['SelfBuilt']
end