org.apache.beam.sdk.io.jdbc

Class JdbcIO.ReadRows

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<Row>>

org.apache.beam.sdk.io.jdbc.JdbcIO.ReadRows

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

JdbcIO

public abstract static class JdbcIO.ReadRows
extends PTransform<PBegin,PCollection<Row>>

Implementation of JdbcIO.readRows().

See Also:

Serialized Form

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
ReadRows()

Method Summary

Modifier and Type	Method and Description
PCollection<Row>	expand(PBegin input) Override this method to specify how this PTransform should be expanded on the given InputT.
static Schema	inferBeamSchema(javax.sql.DataSource ds, java.lang.String query)
void	populateDisplayData(DisplayData.Builder builder) Register display data for the given transform or component.
JdbcIO.ReadRows	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)
JdbcIO.ReadRows	withDataSourceProviderFn(SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)
JdbcIO.ReadRows	withDisableAutoCommit(boolean disableAutoCommit) Whether to disable auto commit on read.
JdbcIO.ReadRows	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.ReadRows	withOutputParallelization(boolean outputParallelization) Whether to reshuffle the resulting PCollection so results are distributed to all workers.
JdbcIO.ReadRows	withQuery(java.lang.String query)
JdbcIO.ReadRows	withQuery(ValueProvider<java.lang.String> query)
JdbcIO.ReadRows	withStatementPreparator(JdbcIO.StatementPreparator statementPreparator)

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 Detail

ReadRows

public ReadRows()

Method Detail

withDataSourceConfiguration

public JdbcIO.ReadRows withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)

withDataSourceProviderFn

public JdbcIO.ReadRows withDataSourceProviderFn(SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)

withQuery

public JdbcIO.ReadRows withQuery(java.lang.String query)

withQuery

public JdbcIO.ReadRows withQuery(ValueProvider<java.lang.String> query)

withStatementPreparator

public JdbcIO.ReadRows withStatementPreparator(JdbcIO.StatementPreparator statementPreparator)

withFetchSize

public JdbcIO.ReadRows 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.ReadRows 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.ReadRows 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<Row> expand(PBegin 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<PBegin,PCollection<Row>>

inferBeamSchema

public static Schema inferBeamSchema(javax.sql.DataSource ds,
                                     java.lang.String query)

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<PBegin,PCollection<Row>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData