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

java.lang.Object
- com.ververica.cdc.connectors.mysql.source.MySqlSourceBuilder<T>

@PublicEvolving
public class MySqlSourceBuilder<T>
extends Object

The builder class for MySqlSource to make it easier for the users to construct a MySqlSource.


 MySqlSource
     .<String>builder()
     .hostname("localhost")
     .port(3306)
     .databaseList("mydb")
     .tableList("mydb.users")
     .username(username)
     .password(password)
     .serverId(5400)
     .deserializer(new JsonDebeziumDeserializationSchema())
     .build();

Check the Java docs of each individual method to learn more about the settings to build a MySqlSource.

Constructor Summary

Constructors
Constructor and Description

MySqlSourceBuilder()

Constructors
Constructor and Description
`MySqlSourceBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MySqlSource<T>`	`build()` Build the `MySqlSource`.
`MySqlSourceBuilder<T>`	`connectionPoolSize(int connectionPoolSize)` The connection pool size.
`MySqlSourceBuilder<T>`	`connectMaxRetries(int connectMaxRetries)` The max retry times to get connection.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`databaseList(String... databaseList)` An required list of regular expressions that match database names to be monitored; any database name not included in the whitelist will be excluded from monitoring.
`MySqlSourceBuilder<T>`	`debeziumProperties(Properties properties)` The Debezium MySQL connector properties.
`MySqlSourceBuilder<T>`	`deserializer(com.ververica.cdc.debezium.DebeziumDeserializationSchema<T> deserializer)` The deserializer used to convert from consumed `SourceRecord`.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`fetchSize(int fetchSize)` The maximum fetch size for per poll when read table snapshot.
`MySqlSourceBuilder<T>`	`heartbeatInterval(java.time.Duration heartbeatInterval)` The interval of heartbeat event.
`MySqlSourceBuilder<T>`	`hostname(String hostname)`
`MySqlSourceBuilder<T>`	`includeSchemaChanges(boolean includeSchemaChanges)` Whether the `MySqlSource` should output the schema changes or not.
`MySqlSourceBuilder<T>`	`jdbcProperties(Properties jdbcProperties)` Custom properties that will overwrite the default JDBC connection URL.
`MySqlSourceBuilder<T>`	`password(String password)` Password to use when connecting to the MySQL database server.
`MySqlSourceBuilder<T>`	`port(int port)` Integer port number of the MySQL database server.
`MySqlSourceBuilder<T>`	`scanNewlyAddedTableEnabled(boolean scanNewlyAddedTableEnabled)` Whether the `MySqlSource` should scan the newly added tables or not.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`serverTimeZone(String timeZone)` The session time zone in database server, e.g.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`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.
`MySqlSourceBuilder<T>`	`startupOptions(StartupOptions startupOptions)` Specifies the startup options.
`MySqlSourceBuilder<T>`	`tableList(String... tableList)` An required 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.
`MySqlSourceBuilder<T>`	`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
  - MySqlSourceBuilder
```
public MySqlSourceBuilder()
```
- Method Detail
  - hostname
```
public MySqlSourceBuilder<T> hostname(String hostname)
```
  - port
```
public MySqlSourceBuilder<T> port(int port)
```
    Integer port number of the MySQL database server.
  - databaseList
```
public MySqlSourceBuilder<T> databaseList(String... databaseList)
```
    An required list of regular expressions that match database names to be monitored; any database name not included in the whitelist will be excluded from monitoring.
  - tableList
```
public MySqlSourceBuilder<T> tableList(String... tableList)
```
    An required 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>.
  - username
```
public MySqlSourceBuilder<T> username(String username)
```
    Name of the MySQL database to use when connecting to the MySQL database server.
  - password
```
public MySqlSourceBuilder<T> password(String password)
```
    Password to use when connecting to the MySQL database server.
  - serverId
```
public MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> 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 MySqlSourceBuilder<T> fetchSize(int fetchSize)
```
    The maximum fetch size for per poll when read table snapshot.
  - connectTimeout
```
public MySqlSourceBuilder<T> 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.
  - connectMaxRetries
```
public MySqlSourceBuilder<T> connectMaxRetries(int connectMaxRetries)
```
    The max retry times to get connection.
  - connectionPoolSize
```
public MySqlSourceBuilder<T> connectionPoolSize(int connectionPoolSize)
```
    The connection pool size.
  - includeSchemaChanges
```
public MySqlSourceBuilder<T> includeSchemaChanges(boolean includeSchemaChanges)
```
    Whether the MySqlSource should output the schema changes or not.
  - scanNewlyAddedTableEnabled
```
public MySqlSourceBuilder<T> scanNewlyAddedTableEnabled(boolean scanNewlyAddedTableEnabled)
```
    Whether the MySqlSource should scan the newly added tables or not.
  - startupOptions
```
public MySqlSourceBuilder<T> startupOptions(StartupOptions startupOptions)
```
    Specifies the startup options.
  - jdbcProperties
```
public MySqlSourceBuilder<T> jdbcProperties(Properties jdbcProperties)
```
    Custom properties that will overwrite the default JDBC connection URL.
  - debeziumProperties
```
public MySqlSourceBuilder<T> debeziumProperties(Properties properties)
```
    The Debezium MySQL connector properties. For example, "snapshot.mode".
  - deserializer
```
public MySqlSourceBuilder<T> deserializer(com.ververica.cdc.debezium.DebeziumDeserializationSchema<T> deserializer)
```
    The deserializer used to convert from consumed SourceRecord.
  - heartbeatInterval
```
public MySqlSourceBuilder<T> heartbeatInterval(java.time.Duration heartbeatInterval)
```
    The interval of heartbeat event.
  - build
```
public MySqlSource<T> build()
```
    Build the MySqlSource.
    
    Returns:
    
    a MySqlParallelSource with the settings made for this builder.

Class MySqlSourceBuilder<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MySqlSourceBuilder

Method Detail

hostname

port

databaseList

tableList

username

password

serverId

serverTimeZone

splitSize

splitMetaGroupSize

distributionFactorUpper

distributionFactorLower

fetchSize

connectTimeout

connectMaxRetries

connectionPoolSize

includeSchemaChanges

scanNewlyAddedTableEnabled

startupOptions

jdbcProperties

debeziumProperties

deserializer

heartbeatInterval

build