org.apache.beam.sdk.io.jdbc

Class JdbcIO.Write<T>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.PDone>

org.apache.beam.sdk.io.jdbc.JdbcIO.Write<T>

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

JdbcIO

public static class JdbcIO.Write<T>
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.PDone>

This class is used as the default return value of JdbcIO.write().

All methods in this class delegate to the appropriate method of JdbcIO.WriteVoid.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name, resourceHints

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PDone	expand(org.apache.beam.sdk.values.PCollection<T> input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
JdbcIO.Write<T>	withBatchSize(long batchSize) See JdbcIO.WriteVoid.withBatchSize(long).
JdbcIO.Write<T>	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config) See WriteVoid#withDataSourceConfiguration(DataSourceConfiguration).
JdbcIO.Write<T>	withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn) See JdbcIO.WriteVoid.withDataSourceProviderFn(SerializableFunction).
JdbcIO.Write<T>	withPreparedStatementSetter(JdbcIO.PreparedStatementSetter<T> setter) See WriteVoid#withPreparedStatementSetter(PreparedStatementSetter).
JdbcIO.WriteVoid<T>	withResults() Returns JdbcIO.WriteVoid transform which can be used in Wait.on(PCollection[]) to wait until all data is written.
JdbcIO.Write<T>	withRetryConfiguration(JdbcIO.RetryConfiguration retryConfiguration) See WriteVoid#withRetryConfiguration(RetryConfiguration).
JdbcIO.Write<T>	withRetryStrategy(JdbcIO.RetryStrategy retryStrategy) See WriteVoid#withRetryStrategy(RetryStrategy).
JdbcIO.Write<T>	withStatement(java.lang.String statement) See JdbcIO.WriteVoid.withStatement(String).
JdbcIO.Write<T>	withTable(java.lang.String table) See JdbcIO.WriteVoid.withTable(String).

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate

Methods inherited from class java.lang.Object

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

Method Detail

withDataSourceConfiguration

public JdbcIO.Write<T> withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)

See WriteVoid#withDataSourceConfiguration(DataSourceConfiguration).

withDataSourceProviderFn

public JdbcIO.Write<T> withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)

See JdbcIO.WriteVoid.withDataSourceProviderFn(SerializableFunction).

withStatement

public JdbcIO.Write<T> withStatement(java.lang.String statement)

See JdbcIO.WriteVoid.withStatement(String).

withPreparedStatementSetter

public JdbcIO.Write<T> withPreparedStatementSetter(JdbcIO.PreparedStatementSetter<T> setter)

See WriteVoid#withPreparedStatementSetter(PreparedStatementSetter).

withBatchSize

public JdbcIO.Write<T> withBatchSize(long batchSize)

See JdbcIO.WriteVoid.withBatchSize(long).

withRetryStrategy

public JdbcIO.Write<T> withRetryStrategy(JdbcIO.RetryStrategy retryStrategy)

See WriteVoid#withRetryStrategy(RetryStrategy).

withRetryConfiguration

public JdbcIO.Write<T> withRetryConfiguration(JdbcIO.RetryConfiguration retryConfiguration)

See WriteVoid#withRetryConfiguration(RetryConfiguration).

withTable

public JdbcIO.Write<T> withTable(java.lang.String table)

See JdbcIO.WriteVoid.withTable(String).

withResults

public JdbcIO.WriteVoid<T> withResults()

Returns JdbcIO.WriteVoid transform which can be used in Wait.on(PCollection[]) to wait until all data is written.

Example: write a PCollection to one database and then to another database, making sure that writing a window of data to the second database starts only after the respective window has been fully written to the first database.

 PCollection<Void> firstWriteResults = data.apply(JdbcIO.write()
     .withDataSourceConfiguration(CONF_DB_1).withResults());
 data.apply(Wait.on(firstWriteResults))
     .apply(JdbcIO.write().withDataSourceConfiguration(CONF_DB_2));
 

populateDisplayData

public void populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)

Specified by:

populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

Overrides:

populateDisplayData in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.PDone>

expand

public org.apache.beam.sdk.values.PDone expand(org.apache.beam.sdk.values.PCollection<T> input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<T>,org.apache.beam.sdk.values.PDone>