org.apache.flink.connector.jdbc.internal.options

Class JdbcConnectorOptions.Builder

java.lang.Object

org.apache.flink.connector.jdbc.internal.options.JdbcConnectorOptions.Builder

Enclosing class:

JdbcConnectorOptions

public static class JdbcConnectorOptions.Builder
extends Object

Builder of JdbcConnectorOptions.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
JdbcConnectorOptions	build()
JdbcConnectorOptions.Builder	setClassLoader(ClassLoader classLoader) optional, specifies the classloader to use in the planner for load the class in user jar.
JdbcConnectorOptions.Builder	setConnectionCheckTimeoutSeconds(int connectionCheckTimeoutSeconds) optional, connectionCheckTimeoutSeconds.
JdbcConnectorOptions.Builder	setDBUrl(String dbURL) required, JDBC DB url.
JdbcConnectorOptions.Builder	setDialect(JdbcDialect dialect) optional, Handle the SQL dialect of jdbc driver.
JdbcConnectorOptions.Builder	setDriverName(String driverName) optional, driver name, dialect has a default driver name, See JdbcDialect.defaultDriverName().
JdbcConnectorOptions.Builder	setParallelism(Integer parallelism)
JdbcConnectorOptions.Builder	setPassword(String password) optional, password.
JdbcConnectorOptions.Builder	setTableName(String tableName) required, table name.
JdbcConnectorOptions.Builder	setUsername(String username) optional, user name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setClassLoader

public JdbcConnectorOptions.Builder setClassLoader(ClassLoader classLoader)

optional, specifies the classloader to use in the planner for load the class in user jar.

By default, this is configured using Thread.currentThread().getContextClassLoader().

Modify the ClassLoader only if you know what you're doing.

setTableName

public JdbcConnectorOptions.Builder setTableName(String tableName)

required, table name.

setUsername

public JdbcConnectorOptions.Builder setUsername(String username)

optional, user name.

setPassword

public JdbcConnectorOptions.Builder setPassword(String password)

optional, password.

setConnectionCheckTimeoutSeconds

public JdbcConnectorOptions.Builder setConnectionCheckTimeoutSeconds(int connectionCheckTimeoutSeconds)

optional, connectionCheckTimeoutSeconds.

setDriverName

public JdbcConnectorOptions.Builder setDriverName(String driverName)

optional, driver name, dialect has a default driver name, See JdbcDialect.defaultDriverName().

setDBUrl

public JdbcConnectorOptions.Builder setDBUrl(String dbURL)

required, JDBC DB url.

setDialect

public JdbcConnectorOptions.Builder setDialect(JdbcDialect dialect)

optional, Handle the SQL dialect of jdbc driver. If not set, it will be infer by JdbcDialectLoader.load(java.lang.String, java.lang.ClassLoader) from DB url.

setParallelism

public JdbcConnectorOptions.Builder setParallelism(Integer parallelism)

build

public JdbcConnectorOptions build()