org.apache.beam.sdk.io.jdbc

Class JdbcIO.ReadRows

java.lang.Object

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

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

All Implemented Interfaces:

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

Enclosing class:

JdbcIO

@Experimental(value=SCHEMAS)
public abstract static class JdbcIO.ReadRows
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PBegin,org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.Row>>

Implementation of JdbcIO.readRows().

See Also:

Serialized Form

Field Summary

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

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
ReadRows()

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.Row>	expand(org.apache.beam.sdk.values.PBegin input)
void	populateDisplayData(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
JdbcIO.ReadRows	withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)
JdbcIO.ReadRows	withDataSourceProviderFn(org.apache.beam.sdk.transforms.SerializableFunction<java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)
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(org.apache.beam.sdk.options.ValueProvider<java.lang.String> query)
JdbcIO.ReadRows	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

ReadRows

public ReadRows()

Method Detail

withDataSourceConfiguration

public JdbcIO.ReadRows withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config)

withDataSourceProviderFn

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

withQuery

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

withQuery

public JdbcIO.ReadRows withQuery(org.apache.beam.sdk.options.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.

expand

public org.apache.beam.sdk.values.PCollection<org.apache.beam.sdk.values.Row> 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<org.apache.beam.sdk.values.Row>>

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<org.apache.beam.sdk.values.Row>>