org.apache.beam.sdk.io.jdbc

Class JdbcIO.DataSourceConfiguration

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

JdbcIO

public abstract static class JdbcIO.DataSourceConfiguration
extends java.lang.Object
implements java.io.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 and Description
DataSourceConfiguration()

Method Summary

Modifier and Type	Method and Description
javax.sql.DataSource	buildDatasource()
static JdbcIO.DataSourceConfiguration	create(javax.sql.DataSource dataSource)
static JdbcIO.DataSourceConfiguration	create(java.lang.String driverClassName, java.lang.String url)
static JdbcIO.DataSourceConfiguration	create(ValueProvider<java.lang.String> driverClassName, ValueProvider<java.lang.String> url)
JdbcIO.DataSourceConfiguration	withConnectionInitSqls(java.util.Collection<java.lang.String> connectionInitSqls) Sets the connection init sql statements to driver.connect(...).
JdbcIO.DataSourceConfiguration	withConnectionInitSqls(ValueProvider<java.util.Collection<java.lang.String>> connectionInitSqls) Same as withConnectionInitSqls(Collection) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withConnectionProperties(java.lang.String connectionProperties) Sets the connection properties passed to driver.connect(...).
JdbcIO.DataSourceConfiguration	withConnectionProperties(ValueProvider<java.lang.String> connectionProperties) Same as withConnectionProperties(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withDriverClassLoader(java.lang.ClassLoader driverClassLoader) Sets the class loader instance to be used to load the JDBC driver.
JdbcIO.DataSourceConfiguration	withDriverJars(java.lang.String driverJars) Comma separated paths for JDBC drivers.
JdbcIO.DataSourceConfiguration	withDriverJars(ValueProvider<java.lang.String> driverJars) Same as withDriverJars(String) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withMaxConnections(java.lang.Integer maxConnections) Sets the maximum total number of connections.
JdbcIO.DataSourceConfiguration	withMaxConnections(ValueProvider<java.lang.Integer> maxConnections) Same as withMaxConnections(Integer) but accepting a ValueProvider.
JdbcIO.DataSourceConfiguration	withPassword(@Nullable java.lang.String password)
JdbcIO.DataSourceConfiguration	withPassword(ValueProvider<java.lang.String> password)
JdbcIO.DataSourceConfiguration	withUsername(@Nullable java.lang.String username)
JdbcIO.DataSourceConfiguration	withUsername(ValueProvider<java.lang.String> username)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceConfiguration

public DataSourceConfiguration()

Method Detail

create

public static JdbcIO.DataSourceConfiguration create(javax.sql.DataSource dataSource)

create

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

create

public static JdbcIO.DataSourceConfiguration create(ValueProvider<java.lang.String> driverClassName,
                                                    ValueProvider<java.lang.String> url)

withUsername

public JdbcIO.DataSourceConfiguration withUsername(@Nullable java.lang.String username)

withUsername

public JdbcIO.DataSourceConfiguration withUsername(ValueProvider<java.lang.String> username)

withPassword

public JdbcIO.DataSourceConfiguration withPassword(@Nullable java.lang.String password)

withPassword

public JdbcIO.DataSourceConfiguration withPassword(ValueProvider<java.lang.String> password)

withConnectionProperties

public JdbcIO.DataSourceConfiguration withConnectionProperties(java.lang.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<java.lang.String> connectionProperties)

Same as withConnectionProperties(String) but accepting a ValueProvider.

withConnectionInitSqls

public JdbcIO.DataSourceConfiguration withConnectionInitSqls(java.util.Collection<java.lang.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<java.util.Collection<java.lang.String>> connectionInitSqls)

Same as withConnectionInitSqls(Collection) but accepting a ValueProvider.

withMaxConnections

public JdbcIO.DataSourceConfiguration withMaxConnections(java.lang.Integer maxConnections)

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

withMaxConnections

public JdbcIO.DataSourceConfiguration withMaxConnections(ValueProvider<java.lang.Integer> maxConnections)

Same as withMaxConnections(Integer) but accepting a ValueProvider.

withDriverClassLoader

public JdbcIO.DataSourceConfiguration withDriverClassLoader(java.lang.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(java.lang.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<java.lang.String> driverJars)

Same as withDriverJars(String) but accepting a ValueProvider.

buildDatasource

public javax.sql.DataSource buildDatasource()