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

Class JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.jdbc.JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration

All Implemented Interfaces:

Serializable

Enclosing class:

JdbcReadSchemaTransformProvider

@DefaultSchema(AutoValueSchema.class)
public abstract static class JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
JdbcReadSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration.Builder	builder()
abstract List<@Nullable String>	getConnectionInitSql()
abstract String	getConnectionProperties()
abstract Boolean	getDisableAutoCommit()
abstract String	getDriverClassName()
abstract String	getDriverJars()
abstract Integer	getFetchSize()
abstract String	getJdbcType()
abstract String	getJdbcUrl()
abstract String	getLocation()
abstract Integer	getNumPartitions()
abstract Boolean	getOutputParallelization()
abstract String	getPartitionColumn()
abstract String	getPassword()
abstract String	getReadQuery()
abstract String	getUsername()
void	validate()
void	validate(String jdbcType)

Methods inherited from class java.lang.Object

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

Constructor Details

JdbcReadSchemaTransformConfiguration

public JdbcReadSchemaTransformConfiguration()

Method Details

getJdbcUrl

@SchemaFieldDescription("Connection URL for the JDBC source.")
public abstract String getJdbcUrl()

getConnectionInitSql

@SchemaFieldDescription("Sets the connection init sql statements used by the Driver. Only MySQL and MariaDB support this.")
@Nullable
public abstract List<@Nullable String> getConnectionInitSql()

getConnectionProperties

@SchemaFieldDescription("Used to set connection properties passed to the JDBC driver not already defined as standalone parameter (e.g. username and password can be set using parameters above accordingly). Format of the string must be \"key1=value1;key2=value2;\".")
@Nullable
public abstract String getConnectionProperties()

getDisableAutoCommit

@SchemaFieldDescription("Whether to disable auto commit on read. Defaults to true if not provided. The need for this config varies depending on the database platform. Informix requires this to be set to false while Postgres requires this to be set to true.")
@Nullable
public abstract Boolean getDisableAutoCommit()

getDriverClassName

@SchemaFieldDescription("Name of a Java Driver class to use to connect to the JDBC source. For example, \"com.mysql.jdbc.Driver\".")
@Nullable
public abstract String getDriverClassName()

getDriverJars

@SchemaFieldDescription("Comma separated path(s) for the JDBC driver jar(s). This can be a local path or GCS (gs://) path.")
@Nullable
public abstract String getDriverJars()

getFetchSize

@SchemaFieldDescription("This method is used to override the size of the data that is going to be fetched and loaded in memory per every database call. It should ONLY be used if the default value throws memory errors.")
@Nullable
public abstract Integer getFetchSize()

getJdbcType

@SchemaFieldDescription("Type of JDBC source. When specified, an appropriate default Driver will be packaged with the transform. One of mysql, postgres, oracle, or mssql.")
@Nullable
public abstract String getJdbcType()

getLocation

@SchemaFieldDescription("Name of the table to read from.")
@Nullable
public abstract String getLocation()

getPartitionColumn

@SchemaFieldDescription("Name of a column of numeric type that will be used for partitioning.")
@Nullable
public abstract String getPartitionColumn()

getNumPartitions

@SchemaFieldDescription("The number of partitions")
@Nullable
public abstract Integer getNumPartitions()

getOutputParallelization

@SchemaFieldDescription("Whether to reshuffle the resulting PCollection so results are distributed to all workers.")
@Nullable
public abstract Boolean getOutputParallelization()

getPassword

@SchemaFieldDescription("Password for the JDBC source.")
@Nullable
public abstract String getPassword()

getReadQuery

@SchemaFieldDescription("SQL query used to query the JDBC source.")
@Nullable
public abstract String getReadQuery()

getUsername

@SchemaFieldDescription("Username for the JDBC source.")
@Nullable
public abstract String getUsername()

validate

public void validate()

validate

public void validate(String jdbcType)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

builder

public static JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration.Builder builder()