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

Class 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

    • Constructor Detail

      • Read

        public Read()

    • Method Detail

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

      • withCoder

        @Deprecated
public JdbcIO.Read<T> withCoder​(org.apache.beam.sdk.coders.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 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>>