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

Class JdbcIO.ReadAll<ParameterT,OutputT>

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<ParameterT>,PCollection<OutputT>>

org.apache.beam.sdk.io.jdbc.JdbcIO.ReadAll<ParameterT,OutputT>

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

JdbcIO

public abstract static class JdbcIO.ReadAll<ParameterT,OutputT>
extends PTransform<PCollection<ParameterT>,PCollection<OutputT>>

Implementation of JdbcIO.readAll().

See Also:

• Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
ReadAll()

Method Summary

Modifier and Type	Method	Description
PCollection<OutputT>	expand(PCollection<ParameterT> 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.ReadAll<ParameterT,OutputT>	withCoder(Coder<OutputT> coder)	Deprecated. JdbcIO is able to infer appropriate coders from other parameters.
JdbcIO.ReadAll<ParameterT,OutputT>	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)
JdbcIO.ReadAll<ParameterT,OutputT>	withDataSourceProviderFn(SerializableFunction<Void,DataSource> dataSourceProviderFn)
JdbcIO.ReadAll<ParameterT,OutputT>	withDisableAutoCommit(boolean disableAutoCommit)	Whether to disable auto commit on read.
JdbcIO.ReadAll<ParameterT,OutputT>	withFetchSize(int fetchSize)	This method is used to set the size of the data that is going to be fetched and loaded in memory per every database call.
JdbcIO.ReadAll<ParameterT,OutputT>	withOutputParallelization(boolean outputParallelization)	Whether to reshuffle the resulting PCollection so results are distributed to all workers.
JdbcIO.ReadAll<ParameterT,OutputT>	withParameterSetter(JdbcIO.PreparedStatementSetter<ParameterT> parameterSetter)
JdbcIO.ReadAll<ParameterT,OutputT>	withQuery(String query)
JdbcIO.ReadAll<ParameterT,OutputT>	withQuery(ValueProvider<String> query)
JdbcIO.ReadAll<ParameterT,OutputT>	withRowMapper(JdbcIO.RowMapper<OutputT> rowMapper)

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

Constructor Details

ReadAll

public ReadAll()

Method Details

withDataSourceConfiguration

public JdbcIO.ReadAll<ParameterT,OutputT> withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)

withDataSourceProviderFn

public JdbcIO.ReadAll<ParameterT,OutputT> withDataSourceProviderFn(SerializableFunction<Void,DataSource> dataSourceProviderFn)

withQuery

public JdbcIO.ReadAll<ParameterT,OutputT> withQuery(String query)

withQuery

public JdbcIO.ReadAll<ParameterT,OutputT> withQuery(ValueProvider<String> query)

withParameterSetter

public JdbcIO.ReadAll<ParameterT,OutputT> withParameterSetter(JdbcIO.PreparedStatementSetter<ParameterT> parameterSetter)

withRowMapper

public JdbcIO.ReadAll<ParameterT,OutputT> withRowMapper(JdbcIO.RowMapper<OutputT> rowMapper)

withCoder

@Deprecated
public JdbcIO.ReadAll<ParameterT,OutputT> withCoder(Coder<OutputT> coder)

Deprecated.

JdbcIO is able to infer appropriate coders from other parameters.

withFetchSize

public JdbcIO.ReadAll<ParameterT,OutputT> withFetchSize(int fetchSize)

This method is used to set the size of the data that is going to be fetched and loaded in memory per every database call. Please refer to: Statement.setFetchSize(int) It should ONLY be used if the default value throws memory errors.

withOutputParallelization

public JdbcIO.ReadAll<ParameterT,OutputT> withOutputParallelization(boolean outputParallelization)

Whether to reshuffle the resulting PCollection so results are distributed to all workers. The default is to parallelize and should only be changed if this is known to be unnecessary.

withDisableAutoCommit

public JdbcIO.ReadAll<ParameterT,OutputT> withDisableAutoCommit(boolean disableAutoCommit)

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.

expand

public PCollection<OutputT> expand(PCollection<ParameterT> 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<ParameterT>,PCollection<OutputT>>

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<ParameterT>,PCollection<OutputT>>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData