public class MySQLParam extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
| MySQLParam() | 
| MySQLParam(MySQLParam source)NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy. | 
| Modifier and Type | Method and Description | 
|---|---|
| String | getDatabase()Get MySQL的数据库名称,"*"为全数据库 | 
| String | getDataSourceIncrementColumn()Get 传入需要监听的列名称 | 
| String | getDataSourceIncrementMode()Get "TIMESTAMP" 表示增量列为时间戳类型,"INCREMENT" 表示增量列为自增 id 类型 | 
| String | getDataSourceMonitorMode()Get "TABLE" 表示读取项为 table,"QUERY" 表示读取项为 query | 
| String | getDataSourceMonitorResource()Get 当 "DataMonitorMode"="TABLE" 时,传入需要读取的 Table;当 "DataMonitorMode"="QUERY" 时,传入需要读取的查询 sql 语句 | 
| String | getDataSourceStartFrom()Get "HEAD" 表示复制存量 + 增量数据,"TAIL" 表示只复制增量数据 | 
| String | getDataTargetInsertMode()Get "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入 | 
| String | getDataTargetPrimaryKeyField()Get 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键 | 
| RecordMapping[] | getDataTargetRecordMapping()Get 表与消息间的映射关系 | 
| String | getDateTimeZone()Get datetime 类型字段转换为时间戳的时区 | 
| String | getDdlTopic()Get 存放MySQL的Ddl信息的Topic,为空则默认不存放 | 
| DropCls | getDropCls()Get 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效 | 
| Boolean | getDropInvalidMessage()Get Mysql 是否抛弃解析失败的消息,默认为true | 
| String | getIncludeContentChanges()Get 如果该值为all,则DDL数据以及DML数据也会写入到选中的topic;若该值为dml,则只有DML数据写入到选中的topic | 
| Boolean | getIncludeQuery()Get 如果该值为true,且MySQL中"binlog_rows_query_log_events"配置项的值为"ON",则流入到topic的数据包含原SQL语句;若该值为false,流入到topic的数据不包含原SQL语句 | 
| Boolean | getIsTablePrefix()Get 当Table输入的是前缀时,该项值为true,否则为false | 
| Boolean | getIsTableRegular()Get 输入的table是否为正则表达式,如果该选项以及IsTablePrefix同时为true,该选项的判断优先级高于IsTablePrefix | 
| String | getKeyColumns()Get 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键 | 
| String | getOutputFormat()Get 输出格式,DEFAULT、CANAL_1、CANAL_2 | 
| Boolean | getRecordWithSchema()Get 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带 | 
| String | getResource()Get 该MySQL在连接管理内的Id | 
| Boolean | getSelfBuilt()Get 是否为自建集群 | 
| String | getSignalDatabase()Get 存放信令表的数据库名称 | 
| String | getSignalTable()Get 信号表
注意:此字段可能返回 null,表示取不到有效值。 | 
| String | getSnapshotMode()Get 复制存量信息(schema_only不复制, initial全量),默认值initial | 
| String | getTable()Get MySQL的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写,需要填入正则表达式时,格式为"数据库名\\.数据表名" | 
| String | getTopicRegex()Get 事件路由到特定主题的正则表达式,默认为(.*) | 
| String | getTopicReplacement()Get TopicRegex的引用组,指定$1、$2等 | 
| void | setDatabase(String Database)Set MySQL的数据库名称,"*"为全数据库 | 
| void | setDataSourceIncrementColumn(String DataSourceIncrementColumn)Set 传入需要监听的列名称 | 
| void | setDataSourceIncrementMode(String DataSourceIncrementMode)Set "TIMESTAMP" 表示增量列为时间戳类型,"INCREMENT" 表示增量列为自增 id 类型 | 
| void | setDataSourceMonitorMode(String DataSourceMonitorMode)Set "TABLE" 表示读取项为 table,"QUERY" 表示读取项为 query | 
| void | setDataSourceMonitorResource(String DataSourceMonitorResource)Set 当 "DataMonitorMode"="TABLE" 时,传入需要读取的 Table;当 "DataMonitorMode"="QUERY" 时,传入需要读取的查询 sql 语句 | 
| void | setDataSourceStartFrom(String DataSourceStartFrom)Set "HEAD" 表示复制存量 + 增量数据,"TAIL" 表示只复制增量数据 | 
| void | setDataTargetInsertMode(String DataTargetInsertMode)Set "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入 | 
| void | setDataTargetPrimaryKeyField(String DataTargetPrimaryKeyField)Set 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键 | 
| void | setDataTargetRecordMapping(RecordMapping[] DataTargetRecordMapping)Set 表与消息间的映射关系 | 
| void | setDateTimeZone(String DateTimeZone)Set datetime 类型字段转换为时间戳的时区 | 
| void | setDdlTopic(String DdlTopic)Set 存放MySQL的Ddl信息的Topic,为空则默认不存放 | 
| void | setDropCls(DropCls DropCls)Set 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效 | 
| void | setDropInvalidMessage(Boolean DropInvalidMessage)Set Mysql 是否抛弃解析失败的消息,默认为true | 
| void | setIncludeContentChanges(String IncludeContentChanges)Set 如果该值为all,则DDL数据以及DML数据也会写入到选中的topic;若该值为dml,则只有DML数据写入到选中的topic | 
| void | setIncludeQuery(Boolean IncludeQuery)Set 如果该值为true,且MySQL中"binlog_rows_query_log_events"配置项的值为"ON",则流入到topic的数据包含原SQL语句;若该值为false,流入到topic的数据不包含原SQL语句 | 
| void | setIsTablePrefix(Boolean IsTablePrefix)Set 当Table输入的是前缀时,该项值为true,否则为false | 
| void | setIsTableRegular(Boolean IsTableRegular)Set 输入的table是否为正则表达式,如果该选项以及IsTablePrefix同时为true,该选项的判断优先级高于IsTablePrefix | 
| void | setKeyColumns(String KeyColumns)Set 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键 | 
| void | setOutputFormat(String OutputFormat)Set 输出格式,DEFAULT、CANAL_1、CANAL_2 | 
| void | setRecordWithSchema(Boolean RecordWithSchema)Set 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带 | 
| void | setResource(String Resource)Set 该MySQL在连接管理内的Id | 
| void | setSelfBuilt(Boolean SelfBuilt)Set 是否为自建集群 | 
| void | setSignalDatabase(String SignalDatabase)Set 存放信令表的数据库名称 | 
| void | setSignalTable(String SignalTable)Set 信号表
注意:此字段可能返回 null,表示取不到有效值。 | 
| void | setSnapshotMode(String SnapshotMode)Set 复制存量信息(schema_only不复制, initial全量),默认值initial | 
| void | setTable(String Table)Set MySQL的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写,需要填入正则表达式时,格式为"数据库名\\.数据表名" | 
| void | setTopicRegex(String TopicRegex)Set 事件路由到特定主题的正则表达式,默认为(.*) | 
| void | setTopicReplacement(String TopicReplacement)Set TopicRegex的引用组,指定$1、$2等 | 
| void | toMap(HashMap<String,String> map,
     String prefix)Internal implementation, normal users should not use it. | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic MySQLParam()
public MySQLParam(MySQLParam source)
public String getDatabase()
public void setDatabase(String Database)
Database - MySQL的数据库名称,"*"为全数据库public String getTable()
public void setTable(String Table)
Table - MySQL的数据表名称,"*"为所监听的所有数据库中的非系统表,可以","间隔,监听多个数据表,但数据表需要以"数据库名.数据表名"的格式进行填写,需要填入正则表达式时,格式为"数据库名\\.数据表名"public String getResource()
public void setResource(String Resource)
Resource - 该MySQL在连接管理内的Idpublic String getSnapshotMode()
public void setSnapshotMode(String SnapshotMode)
SnapshotMode - 复制存量信息(schema_only不复制, initial全量),默认值initialpublic String getDdlTopic()
public void setDdlTopic(String DdlTopic)
DdlTopic - 存放MySQL的Ddl信息的Topic,为空则默认不存放public String getDataSourceMonitorMode()
public void setDataSourceMonitorMode(String DataSourceMonitorMode)
DataSourceMonitorMode - "TABLE" 表示读取项为 table,"QUERY" 表示读取项为 querypublic String getDataSourceMonitorResource()
public void setDataSourceMonitorResource(String DataSourceMonitorResource)
DataSourceMonitorResource - 当 "DataMonitorMode"="TABLE" 时,传入需要读取的 Table;当 "DataMonitorMode"="QUERY" 时,传入需要读取的查询 sql 语句public String getDataSourceIncrementMode()
public void setDataSourceIncrementMode(String DataSourceIncrementMode)
DataSourceIncrementMode - "TIMESTAMP" 表示增量列为时间戳类型,"INCREMENT" 表示增量列为自增 id 类型public String getDataSourceIncrementColumn()
public void setDataSourceIncrementColumn(String DataSourceIncrementColumn)
DataSourceIncrementColumn - 传入需要监听的列名称public String getDataSourceStartFrom()
public void setDataSourceStartFrom(String DataSourceStartFrom)
DataSourceStartFrom - "HEAD" 表示复制存量 + 增量数据,"TAIL" 表示只复制增量数据public String getDataTargetInsertMode()
public void setDataTargetInsertMode(String DataTargetInsertMode)
DataTargetInsertMode - "INSERT" 表示使用 Insert 模式插入,"UPSERT" 表示使用 Upsert 模式插入public String getDataTargetPrimaryKeyField()
public void setDataTargetPrimaryKeyField(String DataTargetPrimaryKeyField)
DataTargetPrimaryKeyField - 当 "DataInsertMode"="UPSERT" 时,传入当前 upsert 时依赖的主键public RecordMapping[] getDataTargetRecordMapping()
public void setDataTargetRecordMapping(RecordMapping[] DataTargetRecordMapping)
DataTargetRecordMapping - 表与消息间的映射关系public String getTopicRegex()
public void setTopicRegex(String TopicRegex)
TopicRegex - 事件路由到特定主题的正则表达式,默认为(.*)public String getTopicReplacement()
public void setTopicReplacement(String TopicReplacement)
TopicReplacement - TopicRegex的引用组,指定$1、$2等public String getKeyColumns()
public void setKeyColumns(String KeyColumns)
KeyColumns - 格式:库1.表1:字段1,字段2;库2.表2:字段2,表之间;(分号)隔开,字段之间,(逗号)隔开。不指定的表默认取表的主键public Boolean getDropInvalidMessage()
public void setDropInvalidMessage(Boolean DropInvalidMessage)
DropInvalidMessage - Mysql 是否抛弃解析失败的消息,默认为truepublic DropCls getDropCls()
public void setDropCls(DropCls DropCls)
DropCls - 当设置成员参数DropInvalidMessageToCls设置为true时,DropInvalidMessage参数失效public String getOutputFormat()
public void setOutputFormat(String OutputFormat)
OutputFormat - 输出格式,DEFAULT、CANAL_1、CANAL_2public Boolean getIsTablePrefix()
public void setIsTablePrefix(Boolean IsTablePrefix)
IsTablePrefix - 当Table输入的是前缀时,该项值为true,否则为falsepublic String getIncludeContentChanges()
public void setIncludeContentChanges(String IncludeContentChanges)
IncludeContentChanges - 如果该值为all,则DDL数据以及DML数据也会写入到选中的topic;若该值为dml,则只有DML数据写入到选中的topicpublic Boolean getIncludeQuery()
public void setIncludeQuery(Boolean IncludeQuery)
IncludeQuery - 如果该值为true,且MySQL中"binlog_rows_query_log_events"配置项的值为"ON",则流入到topic的数据包含原SQL语句;若该值为false,流入到topic的数据不包含原SQL语句public Boolean getRecordWithSchema()
public void setRecordWithSchema(Boolean RecordWithSchema)
RecordWithSchema - 如果该值为 true,则消息中会携带消息结构体对应的schema,如果该值为false则不会携带public String getSignalDatabase()
public void setSignalDatabase(String SignalDatabase)
SignalDatabase - 存放信令表的数据库名称public Boolean getIsTableRegular()
public void setIsTableRegular(Boolean IsTableRegular)
IsTableRegular - 输入的table是否为正则表达式,如果该选项以及IsTablePrefix同时为true,该选项的判断优先级高于IsTablePrefixpublic String getSignalTable()
public void setSignalTable(String SignalTable)
SignalTable - 信号表
注意:此字段可能返回 null,表示取不到有效值。public String getDateTimeZone()
public void setDateTimeZone(String DateTimeZone)
DateTimeZone - datetime 类型字段转换为时间戳的时区public Boolean getSelfBuilt()
public void setSelfBuilt(Boolean SelfBuilt)
SelfBuilt - 是否为自建集群Copyright © 2025. All rights reserved.