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

Class JdbcIO.Write<T>

java.lang.Object

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

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

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

JdbcIO

public static class JdbcIO.Write<T>
extends PTransform<PCollection<T>,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

annotations, displayData, name, resourceHints

Method Summary

Modifier and Type	Method	Description
PDone	expand(PCollection<T> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
JdbcIO.Write<T>	withAutoSharding()	See JdbcIO.WriteVoid.withAutoSharding().
JdbcIO.Write<T>	withBatchSize(long batchSize)	See JdbcIO.WriteVoid.withBatchSize(long).
JdbcIO.Write<T>	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)	See JdbcIO.WriteVoid.withDataSourceConfiguration(DataSourceConfiguration).
JdbcIO.Write<T>	withDataSourceProviderFn(SerializableFunction<Void,DataSource> dataSourceProviderFn)	See JdbcIO.WriteVoid.withDataSourceProviderFn(SerializableFunction).
JdbcIO.Write<T>	withMaxBatchBufferingDuration(long maxBatchBufferingDuration)	See JdbcIO.WriteVoid.withMaxBatchBufferingDuration(long).
JdbcIO.Write<T>	withPreparedStatementSetter(JdbcIO.PreparedStatementSetter<T> setter)	See JdbcIO.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 JdbcIO.WriteVoid.withRetryConfiguration(RetryConfiguration).
JdbcIO.Write<T>	withRetryStrategy(JdbcIO.RetryStrategy retryStrategy)	See JdbcIO.WriteVoid.withRetryStrategy(RetryStrategy).
JdbcIO.Write<T>	withStatement(String statement)	See JdbcIO.WriteVoid.withStatement(String).
JdbcIO.Write<T>	withTable(String table)	See JdbcIO.WriteVoid.withTable(String).
<V extends JdbcWriteResult> JdbcIO.WriteWithResults<T,V>	withWriteResults(JdbcIO.RowMapper<V> rowMapper)	Returns JdbcIO.WriteWithResults transform that could return a specific result.

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

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Method Details

withAutoSharding

public JdbcIO.Write<T> withAutoSharding()

See JdbcIO.WriteVoid.withAutoSharding().

withDataSourceConfiguration

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

See JdbcIO.WriteVoid.withDataSourceConfiguration(DataSourceConfiguration).

withDataSourceProviderFn

public JdbcIO.Write<T> withDataSourceProviderFn(SerializableFunction<Void,DataSource> dataSourceProviderFn)

See JdbcIO.WriteVoid.withDataSourceProviderFn(SerializableFunction).

withStatement

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

See JdbcIO.WriteVoid.withStatement(String).

withPreparedStatementSetter

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

See JdbcIO.WriteVoid.withPreparedStatementSetter(PreparedStatementSetter).

withBatchSize

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

See JdbcIO.WriteVoid.withBatchSize(long).

withMaxBatchBufferingDuration

public JdbcIO.Write<T> withMaxBatchBufferingDuration(long maxBatchBufferingDuration)

See JdbcIO.WriteVoid.withMaxBatchBufferingDuration(long).

withRetryStrategy

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

See JdbcIO.WriteVoid.withRetryStrategy(RetryStrategy).

withRetryConfiguration

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

See JdbcIO.WriteVoid.withRetryConfiguration(RetryConfiguration).

withTable

public JdbcIO.Write<T> withTable(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));
 

withWriteResults

public <V extends JdbcWriteResult>
JdbcIO.WriteWithResults<T,V> withWriteResults(JdbcIO.RowMapper<V> rowMapper)

Returns JdbcIO.WriteWithResults transform that could return a specific result.

See JdbcIO.WriteWithResults

populateDisplayData

public void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<PCollection<T>,PDone>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData

expand

public PDone expand(PCollection<T> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

expand in class PTransform<PCollection<T>,PDone>