org.apache.beam.sdk.io.jdbc

Class JdbcIO.Read<T>

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

JdbcIO

public abstract static class JdbcIO.Read<T>
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<T>>

Implementation of JdbcIO.read().

See Also:

Serialized Form

Field Summary

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

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
Read()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<T>	expand(org.apache.beam.sdk.values.PBegin input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
JdbcIO.Read<T>	withCoder(org.apache.beam.sdk.coders.Coder<T> coder)
JdbcIO.Read<T>	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)
JdbcIO.Read<T>	withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)
JdbcIO.Read<T>	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.Read<T>	withOutputParallelization(boolean outputParallelization) Whether to reshuffle the resulting PCollection so results are distributed to all workers.
JdbcIO.Read<T>	withQuery(java.lang.String query)
JdbcIO.Read<T>	withQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)
JdbcIO.Read<T>	withRowMapper(JdbcIO.RowMapper<T> rowMapper)
JdbcIO.Read<T>	withStatementPreparator(JdbcIO.StatementPreparator statementPreparator)

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

Constructor Detail

Read

public Read()

Method Detail

withDataSourceConfiguration

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

withDataSourceProviderFn

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

withQuery

public JdbcIO.Read<T> withQuery(java.lang.String query)

withQuery

public JdbcIO.Read<T> withQuery(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)

withStatementPreparator

public JdbcIO.Read<T> withStatementPreparator(JdbcIO.StatementPreparator statementPreparator)

withRowMapper

public JdbcIO.Read<T> withRowMapper(JdbcIO.RowMapper<T> rowMapper)

withCoder

public JdbcIO.Read<T> withCoder(org.apache.beam.sdk.coders.Coder<T> coder)

withFetchSize

public JdbcIO.Read<T> 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.Read<T> 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.

expand

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

Specified by:

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

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.PBegin,org.apache.beam.sdk.values.PCollection<T>>