MySqlSourceConfigFactory (flink-connector-mysql-cdc 2.2.1 API)

java.lang.Object
- com.ververica.cdc.connectors.mysql.source.config.MySqlSourceConfigFactory

All Implemented Interfaces:

Serializable
```
@Internal
public class MySqlSourceConfigFactory
extends Object
implements Serializable
```
A factory to construct MySqlSourceConfig.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MySqlSourceConfigFactory()

Constructors
Constructor and Description
`MySqlSourceConfigFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MySqlSourceConfigFactory`	`connectionPoolSize(int connectionPoolSize)` The connection pool size.
`MySqlSourceConfigFactory`	`connectMaxRetries(int connectMaxRetries)` The max retry times to get connection.
`MySqlSourceConfigFactory`	`connectTimeout(java.time.Duration connectTimeout)` The maximum time that the connector should wait after trying to connect to the MySQL database server before timing out.
`MySqlSourceConfig`	`createConfig(int subtaskId)` Creates a new `MySqlSourceConfig` for the given subtask `subtaskId`.
`MySqlSourceConfigFactory`	`databaseList(String... databaseList)` An optional list of regular expressions that match database names to be monitored; any database name not included in the whitelist will be excluded from monitoring.
`MySqlSourceConfigFactory`	`debeziumProperties(Properties properties)` The Debezium MySQL connector properties.
`MySqlSourceConfigFactory`	`distributionFactorLower(double distributionFactorLower)` The lower bound of split key evenly distribution factor, the factor is used to determine whether the table is evenly distribution or not.
`MySqlSourceConfigFactory`	`distributionFactorUpper(double distributionFactorUpper)` The upper bound of split key evenly distribution factor, the factor is used to determine whether the table is evenly distribution or not.
`MySqlSourceConfigFactory`	`fetchSize(int fetchSize)` The maximum fetch size for per poll when read table snapshot.
`MySqlSourceConfigFactory`	`heartbeatInterval(java.time.Duration heartbeatInterval)`
`MySqlSourceConfigFactory`	`hostname(String hostname)`
`MySqlSourceConfigFactory`	`includeSchemaChanges(boolean includeSchemaChanges)` Whether the `MySqlSource` should output the schema changes or not.
`MySqlSourceConfigFactory`	`jdbcProperties(Properties jdbcProperties)` Custom properties that will overwrite the default JDBC connection URL.
`MySqlSourceConfigFactory`	`password(String password)` Password to use when connecting to the MySQL database server.
`MySqlSourceConfigFactory`	`port(int port)` Integer port number of the MySQL database server.
`MySqlSourceConfigFactory`	`scanNewlyAddedTableEnabled(boolean scanNewlyAddedTableEnabled)` Whether the `MySqlSource` should scan the newly added tables or not.
`MySqlSourceConfigFactory`	`serverId(String serverId)` A numeric ID or a numeric ID range of this database client, The numeric ID syntax is like '5400', the numeric ID range syntax is like '5400-5408', The numeric ID range syntax is required when 'scan.incremental.snapshot.enabled' enabled.
`MySqlSourceConfigFactory`	`serverTimeZone(String timeZone)` The session time zone in database server, e.g.
`MySqlSourceConfigFactory`	`splitMetaGroupSize(int splitMetaGroupSize)` The group size of split meta, if the meta size exceeds the group size, the meta will be will be divided into multiple groups.
`MySqlSourceConfigFactory`	`splitSize(int splitSize)` The split size (number of rows) of table snapshot, captured tables are split into multiple splits when read the snapshot of table.
`MySqlSourceConfigFactory`	`startupOptions(StartupOptions startupOptions)` Specifies the startup options.
`MySqlSourceConfigFactory`	`tableList(String... tableList)` An optional list of regular expressions that match fully-qualified table identifiers for tables to be monitored; any table not included in the list will be excluded from monitoring.
`MySqlSourceConfigFactory`	`username(String username)` Name of the MySQL database to use when connecting to the MySQL database server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MySqlSourceConfigFactory
```
public MySqlSourceConfigFactory()
```
- Method Detail
  - hostname
```
public MySqlSourceConfigFactory hostname(String hostname)
```
  - port
```
public MySqlSourceConfigFactory port(int port)
```
    Integer port number of the MySQL database server.
  - databaseList
```
public MySqlSourceConfigFactory databaseList(String... databaseList)
```
    An optional list of regular expressions that match database names to be monitored; any database name not included in the whitelist will be excluded from monitoring. By default all databases will be monitored.
  - tableList
```
public MySqlSourceConfigFactory tableList(String... tableList)
```
    An optional list of regular expressions that match fully-qualified table identifiers for tables to be monitored; any table not included in the list will be excluded from monitoring. Each identifier is of the form databaseName.tableName. By default the connector will monitor every non-system table in each monitored database.
  - username
```
public MySqlSourceConfigFactory username(String username)
```
    Name of the MySQL database to use when connecting to the MySQL database server.
  - password
```
public MySqlSourceConfigFactory password(String password)
```
    Password to use when connecting to the MySQL database server.
  - serverId
```
public MySqlSourceConfigFactory serverId(String serverId)
```
    A numeric ID or a numeric ID range of this database client, The numeric ID syntax is like '5400', the numeric ID range syntax is like '5400-5408', The numeric ID range syntax is required when 'scan.incremental.snapshot.enabled' enabled. Every ID must be unique across all currently-running database processes in the MySQL cluster. This connector joins the MySQL cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400, though we recommend setting an explicit value."
  - serverTimeZone
```
public MySqlSourceConfigFactory serverTimeZone(String timeZone)
```
    The session time zone in database server, e.g. "America/Los_Angeles". It controls how the TIMESTAMP type in MYSQL converted to STRING. See more https://debezium.io/documentation/reference/1.5/connectors/mysql.html#mysql-temporal-types
  - splitSize
```
public MySqlSourceConfigFactory splitSize(int splitSize)
```
    The split size (number of rows) of table snapshot, captured tables are split into multiple splits when read the snapshot of table.
  - splitMetaGroupSize
```
public MySqlSourceConfigFactory splitMetaGroupSize(int splitMetaGroupSize)
```
    The group size of split meta, if the meta size exceeds the group size, the meta will be will be divided into multiple groups.
  - distributionFactorUpper
```
public MySqlSourceConfigFactory distributionFactorUpper(double distributionFactorUpper)
```
    The upper bound of split key evenly distribution factor, the factor is used to determine whether the table is evenly distribution or not.
  - distributionFactorLower
```
public MySqlSourceConfigFactory distributionFactorLower(double distributionFactorLower)
```
    The lower bound of split key evenly distribution factor, the factor is used to determine whether the table is evenly distribution or not.
  - fetchSize
```
public MySqlSourceConfigFactory fetchSize(int fetchSize)
```
    The maximum fetch size for per poll when read table snapshot.
  - connectTimeout
```
public MySqlSourceConfigFactory connectTimeout(java.time.Duration connectTimeout)
```
    The maximum time that the connector should wait after trying to connect to the MySQL database server before timing out.
  - connectionPoolSize
```
public MySqlSourceConfigFactory connectionPoolSize(int connectionPoolSize)
```
    The connection pool size.
  - connectMaxRetries
```
public MySqlSourceConfigFactory connectMaxRetries(int connectMaxRetries)
```
    The max retry times to get connection.
  - includeSchemaChanges
```
public MySqlSourceConfigFactory includeSchemaChanges(boolean includeSchemaChanges)
```
    Whether the MySqlSource should output the schema changes or not.
  - scanNewlyAddedTableEnabled
```
public MySqlSourceConfigFactory scanNewlyAddedTableEnabled(boolean scanNewlyAddedTableEnabled)
```
    Whether the MySqlSource should scan the newly added tables or not.
  - jdbcProperties
```
public MySqlSourceConfigFactory jdbcProperties(Properties jdbcProperties)
```
    Custom properties that will overwrite the default JDBC connection URL.
  - startupOptions
```
public MySqlSourceConfigFactory startupOptions(StartupOptions startupOptions)
```
    Specifies the startup options.
  - heartbeatInterval
```
public MySqlSourceConfigFactory heartbeatInterval(java.time.Duration heartbeatInterval)
```
  - debeziumProperties
```
public MySqlSourceConfigFactory debeziumProperties(Properties properties)
```
    The Debezium MySQL connector properties. For example, "snapshot.mode".
  - createConfig
```
public MySqlSourceConfig createConfig(int subtaskId)
```
    Creates a new MySqlSourceConfig for the given subtask subtaskId.

Class MySqlSourceConfigFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MySqlSourceConfigFactory

Method Detail

hostname

port

databaseList

tableList

username

password

serverId

serverTimeZone

splitSize

splitMetaGroupSize

distributionFactorUpper

distributionFactorLower

fetchSize

connectTimeout

connectionPoolSize

connectMaxRetries

includeSchemaChanges

scanNewlyAddedTableEnabled

jdbcProperties

startupOptions

heartbeatInterval

debeziumProperties

createConfig