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

Class JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration

java.lang.Object

org.apache.beam.sdk.io.jdbc.JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration

All Implemented Interfaces:

Serializable

Enclosing class:

JdbcWriteSchemaTransformProvider

@DefaultSchema(AutoValueSchema.class)
public abstract static class JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
JdbcWriteSchemaTransformConfiguration()

Method Summary

Modifier and Type	Method	Description
static JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration.Builder	builder()
abstract Boolean	getAutosharding()
abstract Long	getBatchSize()
abstract List<@Nullable String>	getConnectionInitSql()
abstract String	getConnectionProperties()
abstract String	getDriverClassName()
abstract String	getDriverJars()
abstract String	getJdbcType()
abstract String	getJdbcUrl()
abstract String	getLocation()
abstract String	getPassword()
abstract String	getUsername()
abstract String	getWriteStatement()
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

JdbcWriteSchemaTransformConfiguration

public JdbcWriteSchemaTransformConfiguration()

Method Details

getJdbcUrl

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

getAutosharding

@SchemaFieldDescription("If true, enables using a dynamically determined number of shards to write.")
@Nullable
public abstract Boolean getAutosharding()

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()

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()

getBatchSize

@Nullable
public abstract Long getBatchSize()

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 write to.")
@Nullable
public abstract String getLocation()

getPassword

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

getUsername

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

getWriteStatement

@SchemaFieldDescription("SQL query used to insert records into the JDBC sink.")
@Nullable
public abstract String getWriteStatement()

validate

public void validate()

validate

public void validate(String jdbcType)
              throws IllegalArgumentException

Throws:

IllegalArgumentException

builder

public static JdbcWriteSchemaTransformProvider.JdbcWriteSchemaTransformConfiguration.Builder builder()