Class JdbcIO.ReadWithPartitions<T,PartitionColumnT>
- All Implemented Interfaces:
Serializable
,HasDisplayData
- Enclosing class:
JdbcIO
JdbcIO.readWithPartitions(org.apache.beam.sdk.values.TypeDescriptor<PartitionColumnT>)
.- See Also:
-
Field Summary
Fields inherited from class org.apache.beam.sdk.transforms.PTransform
annotations, displayData, name, resourceHints
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionOverride this method to specify how thisPTransform
should be expanded on the givenInputT
.void
populateDisplayData
(DisplayData.Builder builder) Register display data for the given transform or component.Deprecated.withDataSourceProviderFn
(SerializableFunction<Void, DataSource> dataSourceProviderFn) withDisableAutoCommit
(boolean disableAutoCommit) Whether to disable auto commit on read.withFetchSize
(int fetchSize) The number of rows to fetch from the database in the sameResultSet
round-trip.withLowerBound
(PartitionColumnT lowerBound) withNumPartitions
(int numPartitions) The number of partitions.withPartitionColumn
(String partitionColumn) The name of a column of numeric type that will be used for partitioning.withRowMapper
(JdbcIO.RowMapper<T> rowMapper) Data output type isRow
, and schema is auto-inferred from the database.withSchema
(Schema schema) Name of the table in the external database.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
-
Constructor Details
-
ReadWithPartitions
public ReadWithPartitions()
-
-
Method Details
-
withDataSourceConfiguration
public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withDataSourceConfiguration(JdbcIO.DataSourceConfiguration config) -
withDataSourceProviderFn
public JdbcIO.ReadWithPartitions<T,PartitionColumnT> withDataSourceProviderFn(SerializableFunction<Void, DataSource> dataSourceProviderFn) -
withRowMapper
-
withCoder
Deprecated.JdbcIO
is able to infer appropriate coders from other parameters. -
withNumPartitions
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
The name of a column of numeric type that will be used for partitioning. -
withFetchSize
The number of rows to fetch from the database in the sameResultSet
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
Data output type isRow
, and schema is auto-inferred from the database. -
withLowerBound
-
withUpperBound
-
withTable
Name of the table in the external database. Can be used to pass a user-defined subqery. -
withSchema
-
expand
Description copied from class:PTransform
Override this method to specify how thisPTransform
should be expanded on the givenInputT
.NOTE: This method should not be called directly. Instead apply the
PTransform
should be applied to theInputT
using theapply
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 classPTransform<PBegin,
PCollection<T>>
-
populateDisplayData
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 viaDisplayData.from(HasDisplayData)
. Implementations may callsuper.populateDisplayData(builder)
in order to register display data in the current namespace, but should otherwise usesubcomponent.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 interfaceHasDisplayData
- Overrides:
populateDisplayData
in classPTransform<PBegin,
PCollection<T>> - Parameters:
builder
- The builder to populate with display data.- See Also:
-
JdbcIO
is able to infer appropriate coders from other parameters.