org.apache.beam.sdk.io.jdbc

Class JdbcReadSchemaTransformProvider

java.lang.Object

org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>

org.apache.beam.sdk.io.jdbc.JdbcReadSchemaTransformProvider

All Implemented Interfaces:

SchemaTransformProvider

Direct Known Subclasses:

ReadFromMySqlSchemaTransformProvider, ReadFromOracleSchemaTransformProvider, ReadFromPostgresSchemaTransformProvider, ReadFromSqlServerSchemaTransformProvider

@AutoService(value=SchemaTransformProvider.class)
public class JdbcReadSchemaTransformProvider
extends TypedSchemaTransformProvider<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>

An implementation of SchemaTransformProvider for reading from JDBC connections using JdbcIO.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	JdbcReadSchemaTransformProvider.JdbcReadSchemaTransform
static class	JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration

Constructor Summary

Constructors

Constructor and Description
JdbcReadSchemaTransformProvider()

Method Summary

Modifier and Type	Method and Description
protected @UnknownKeyFor @NonNull @Initialized java.lang.Class<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>	configurationClass()
java.lang.String	description() Returns a description regarding the SchemaTransform represented by the SchemaTransformProvider.
protected @UnknownKeyFor @NonNull @Initialized SchemaTransform	from(JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration configuration) Produce a SchemaTransform from ConfigT.
@UnknownKeyFor @NonNull @Initialized java.lang.String	identifier() Returns an id that uniquely represents this transform.
protected java.lang.String	inheritedDescription(java.lang.String prettyName, java.lang.String transformName, java.lang.String databaseSchema, int defaultJdbcPort)
@UnknownKeyFor @NonNull @Initialized java.util.List<java.lang.String>	inputCollectionNames() Returns the input collection names of this transform.
protected java.lang.String	jdbcType()
@UnknownKeyFor @NonNull @Initialized java.util.List<java.lang.String>	outputCollectionNames() Returns the output collection names of this transform.

Methods inherited from class org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider

configurationSchema, dependencies, from

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JdbcReadSchemaTransformProvider

public JdbcReadSchemaTransformProvider()

Method Detail

identifier

public @UnknownKeyFor @NonNull @Initialized java.lang.String identifier()

Description copied from interface: SchemaTransformProvider

Returns an id that uniquely represents this transform.

description

public java.lang.String description()

Description copied from interface: SchemaTransformProvider

Returns a description regarding the SchemaTransform represented by the SchemaTransformProvider. Please keep the language generic (i.e. not specific to any programming language). The description may be markdown formatted.

inheritedDescription

protected java.lang.String inheritedDescription(java.lang.String prettyName,
                                                java.lang.String transformName,
                                                java.lang.String databaseSchema,
                                                int defaultJdbcPort)

configurationClass

protected @UnknownKeyFor @NonNull @Initialized java.lang.Class<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration> configurationClass()

Overrides:

configurationClass in class TypedSchemaTransformProvider<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>

jdbcType

protected java.lang.String jdbcType()

from

protected @UnknownKeyFor @NonNull @Initialized SchemaTransform from(JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration configuration)

Description copied from class: TypedSchemaTransformProvider

Produce a SchemaTransform from ConfigT. Can throw a InvalidConfigurationException or a InvalidSchemaException.

Specified by:

from in class TypedSchemaTransformProvider<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>

inputCollectionNames

public @UnknownKeyFor @NonNull @Initialized java.util.List<java.lang.String> inputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the input collection names of this transform.

outputCollectionNames

public @UnknownKeyFor @NonNull @Initialized java.util.List<java.lang.String> outputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the output collection names of this transform.