Package org.apache.beam.sdk.io.jdbc

Class JdbcIO.DataSourceConfiguration

java.lang.Object

org.apache.beam.sdk.io.jdbc.JdbcIO.DataSourceConfiguration

All Implemented Interfaces:

Serializable

Enclosing class:

JdbcIO

public abstract static class JdbcIO.DataSourceConfiguration
extends Object
implements Serializable

A POJO describing a DataSource, either providing directly a DataSource or all properties allowing to create a DataSource.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DataSourceConfiguration()

Method Summary

Modifier and Type	Method	Description
DataSource	buildDatasource()
static JdbcIO.DataSourceConfiguration	create(String driverClassName, String url)
static JdbcIO.DataSourceConfiguration	create(DataSource dataSource)
static JdbcIO.DataSourceConfiguration	create(ValueProvider<@Nullable String> driverClassName, ValueProvider<@Nullable String> url)
JdbcIO.DataSourceConfiguration	withConnectionInitSqls(Collection<@Nullable String> connectionInitSqls)	Sets the connection init sql statements to driver.connect(...).
JdbcIO.DataSourceConfiguration	withConnectionInitSqls(ValueProvider<Collection<@Nullable String>> connectionInitSqls)	Same as withConnectionInitSqls(Collection) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withConnectionProperties(String connectionProperties)	Sets the connection properties passed to driver.connect(...).
JdbcIO.DataSourceConfiguration	withConnectionProperties(ValueProvider<@Nullable String> connectionProperties)	Same as withConnectionProperties(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withDriverClassLoader(ClassLoader driverClassLoader)	Sets the class loader instance to be used to load the JDBC driver.
JdbcIO.DataSourceConfiguration	withDriverJars(String driverJars)	Comma separated paths for JDBC drivers.
JdbcIO.DataSourceConfiguration	withDriverJars(ValueProvider<String> driverJars)	Same as withDriverJars(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withMaxConnections(Integer maxConnections)	Sets the maximum total number of connections.
JdbcIO.DataSourceConfiguration	withMaxConnections(ValueProvider<@Nullable Integer> maxConnections)	Same as withMaxConnections(Integer) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withPassword(@Nullable String password)	Sets the database password.
JdbcIO.DataSourceConfiguration	withPassword(ValueProvider<@Nullable String> password)	Same as withPassword(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withQueryTimeout(Integer queryTimeout)	Sets the default query timeout that will be used for connections created by this source.
JdbcIO.DataSourceConfiguration	withQueryTimeout(ValueProvider<@Nullable Integer> queryTimeout)	Same as withQueryTimeout(Integer) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withSecretManager(@Nullable String secretManager)	Sets the secret manager provider.
JdbcIO.DataSourceConfiguration	withSecretManager(ValueProvider<@Nullable String> secretManager)	Same as withSecretManager(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withUsername(@Nullable String username)
JdbcIO.DataSourceConfiguration	withUsername(ValueProvider<@Nullable String> username)

Methods inherited from class java.lang.Object

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

Constructor Details

DataSourceConfiguration

public DataSourceConfiguration()

Method Details

create

public static JdbcIO.DataSourceConfiguration create(DataSource dataSource)

create

public static JdbcIO.DataSourceConfiguration create(String driverClassName,
 String url)

create

public static JdbcIO.DataSourceConfiguration create(ValueProvider<@Nullable String> driverClassName,
 ValueProvider<@Nullable String> url)

withUsername

public JdbcIO.DataSourceConfiguration withUsername(@Nullable String username)

withUsername

public JdbcIO.DataSourceConfiguration withUsername(ValueProvider<@Nullable String> username)

withPassword

public JdbcIO.DataSourceConfiguration withPassword(@Nullable String password)

Sets the database password.

You can specify a plain password string. Alternatively, if a secret manager is configured via withSecretManager(String), you can set this to a secret specification in JSON format (e.g. "{\"name\": \"my-db-secret\", \"project\": \"my-project\"}" for Google Cloud Secret Manager) that the secret manager uses to retrieve the password.

withPassword

public JdbcIO.DataSourceConfiguration withPassword(ValueProvider<@Nullable String> password)

Same as withPassword(String) but accepting a ValueProvider.

withConnectionProperties

public JdbcIO.DataSourceConfiguration withConnectionProperties(String connectionProperties)

Sets the connection properties passed to driver.connect(...). Format of the string must be [propertyName=property;]*

NOTE - The "user" and "password" properties can be add via withUsername(String), withPassword(String), so they do not need to be included here.

withConnectionProperties

public JdbcIO.DataSourceConfiguration withConnectionProperties(ValueProvider<@Nullable String> connectionProperties)

Same as withConnectionProperties(String) but accepting a ValueProvider.

withConnectionInitSqls

public JdbcIO.DataSourceConfiguration withConnectionInitSqls(Collection<@Nullable String> connectionInitSqls)

Sets the connection init sql statements to driver.connect(...).

NOTE - This property is not applicable across databases. Only MySQL and MariaDB support this. A Sql exception is thrown if your database does not support it.

withConnectionInitSqls

public JdbcIO.DataSourceConfiguration withConnectionInitSqls(ValueProvider<Collection<@Nullable String>> connectionInitSqls)

Same as withConnectionInitSqls(Collection) but accepting a ValueProvider.

withMaxConnections

public JdbcIO.DataSourceConfiguration withMaxConnections(Integer maxConnections)

Sets the maximum total number of connections. Use a negative value for no limit.

withMaxConnections

public JdbcIO.DataSourceConfiguration withMaxConnections(ValueProvider<@Nullable Integer> maxConnections)

Same as withMaxConnections(Integer) but accepting a ValueProvider.

withQueryTimeout

public JdbcIO.DataSourceConfiguration withQueryTimeout(Integer queryTimeout)

Sets the default query timeout that will be used for connections created by this source.

withQueryTimeout

public JdbcIO.DataSourceConfiguration withQueryTimeout(ValueProvider<@Nullable Integer> queryTimeout)

Same as withQueryTimeout(Integer) but accepting a ValueProvider.

withDriverClassLoader

public JdbcIO.DataSourceConfiguration withDriverClassLoader(ClassLoader driverClassLoader)

Sets the class loader instance to be used to load the JDBC driver. If not specified, the default class loader is used.

withDriverJars

public JdbcIO.DataSourceConfiguration withDriverJars(String driverJars)

Comma separated paths for JDBC drivers. This method is filesystem agnostic and can be used for all FileSystems supported by Beam If not specified, the default classloader is used to load the jars.

For example, gs://your-bucket/driver_jar1.jar,gs://your-bucket/driver_jar2.jar.

withDriverJars

public JdbcIO.DataSourceConfiguration withDriverJars(ValueProvider<String> driverJars)

Same as withDriverJars(String) but accepting a ValueProvider.

withSecretManager

public JdbcIO.DataSourceConfiguration withSecretManager(@Nullable String secretManager)

Sets the secret manager provider.

Currently supported options are:

• "GoogleCloudSecretManager"
• "GoogleCloudHsmGeneratedSecretManager"

If not set, no secret manager is used and the password is treated as a plain password.

withSecretManager

public JdbcIO.DataSourceConfiguration withSecretManager(ValueProvider<@Nullable String> secretManager)

Same as withSecretManager(String) but accepting a ValueProvider.

buildDatasource

public DataSource buildDatasource()