org.apache.beam.sdk.io.jdbc

Class JdbcIO.ReadWithPartitions<T,PartitionColumnT>

java.lang.Object

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

org.apache.beam.sdk.io.jdbc.JdbcIO.ReadWithPartitions<T,PartitionColumnT>

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

Enclosing class:

JdbcIO

public abstract static class JdbcIO.ReadWithPartitions<T,PartitionColumnT>
extends PTransform<PBegin,PCollection<T>>

Implementation of JdbcIO.readWithPartitions(org.apache.beam.sdk.values.TypeDescriptor<PartitionColumnT>).

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

Method Summary

Modifier and Type	Method and Description
PCollection<T>	expand(PBegin 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.ReadWithPartitions<T,PartitionColumnT>	withCoder(Coder<T> coder) Deprecated. JdbcIO is able to infer appropriate coders from other parameters.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withDataSourceProviderFn(SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withDisableAutoCommit(boolean disableAutoCommit) Whether to disable auto commit on read.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withFetchSize(int fetchSize) The number of rows to fetch from the database in the same ResultSet round-trip.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withLowerBound(PartitionColumnT lowerBound)
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withNumPartitions(int numPartitions) The number of partitions.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withPartitionColumn(java.lang.String partitionColumn) The name of a column of numeric type that will be used for partitioning.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withRowMapper(JdbcIO.RowMapper<T> rowMapper)
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withRowOutput() Data output type is Row, and schema is auto-inferred from the database.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withTable(java.lang.String tableName) Name of the table in the external database.
JdbcIO.ReadWithPartitions<T,PartitionColumnT>	withUpperBound(PartitionColumnT upperBound)

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

ReadWithPartitions

public ReadWithPartitions()

Method Detail

withDataSourceConfiguration

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)

withDataSourceProviderFn

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

withRowMapper

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withRowMapper(JdbcIO.RowMapper<T> rowMapper)

withCoder

@Deprecated
public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withCoder(Coder<T> coder)

Deprecated.

JdbcIO is able to infer appropriate coders from other parameters.

withNumPartitions

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withNumPartitions(int numPartitions)

The number of partitions. This, along with withLowerBound and withUpperBound, form partitions strides for generated WHERE clause expressions used to split the column withPartitionColumn evenly. When the input is less than 1, the number is set to 1.

withPartitionColumn

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withPartitionColumn(java.lang.String partitionColumn)

The name of a column of numeric type that will be used for partitioning.

withFetchSize

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withFetchSize(int fetchSize)

The number of rows to fetch from the database in the same ResultSet round-trip.

withDisableAutoCommit

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> 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.

withRowOutput

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withRowOutput()

Data output type is Row, and schema is auto-inferred from the database.

withLowerBound

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withLowerBound(PartitionColumnT lowerBound)

withUpperBound

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withUpperBound(PartitionColumnT upperBound)

withTable

public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withTable(java.lang.String tableName)

Name of the table in the external database. Can be used to pass a user-defined subqery.

expand

public PCollection<T> 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<T>>

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<T>>

Parameters:

builder - The builder to populate with display data.

See Also:

HasDisplayData