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

Class JdbcIO.Read<T>

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PBegin,PCollection<T>>
org.apache.beam.sdk.io.jdbc.JdbcIO.Read<T>
All Implemented Interfaces:
Serializable, HasDisplayData
Enclosing class:
JdbcIO
public abstract static class JdbcIO.Read<T> extends PTransform<PBegin,PCollection<T>>
Implementation of JdbcIO.read().
See Also:

  • Constructor Details

    • Read

      public Read()

  • Method Details

    • withDataSourceConfiguration

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

    • withDataSourceProviderFn

      public JdbcIO.Read<T> withDataSourceProviderFn(SerializableFunction<Void,DataSource> dataSourceProviderFn)

    • withQuery

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

    • withQuery

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

    • withStatementPreparator

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

    • withRowMapper

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

    • withCoder

      @Deprecated public JdbcIO.Read<T> withCoder(Coder<T> coder)
      Deprecated.

      JdbcIO is able to infer appropriate coders from other parameters.

    • 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.

    • withDisableAutoCommit

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