Package 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(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	Description
protected static class	JdbcReadSchemaTransformProvider.JdbcReadSchemaTransform
static class	JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration

Constructor Summary

Constructors

Constructor	Description
JdbcReadSchemaTransformProvider()

Method Summary

Modifier and Type	Method	Description
protected @UnknownKeyFor @NonNull @Initialized Class<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>	configurationClass()
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 String	identifier()	Returns an id that uniquely represents this transform.
protected String	inheritedDescription(String prettyName, String transformName, String databaseSchema, int defaultJdbcPort)
@UnknownKeyFor @NonNull @Initialized List<@UnknownKeyFor @NonNull @Initialized String>	inputCollectionNames()	Returns the input collection names of this transform.
protected String	jdbcType()
@UnknownKeyFor @NonNull @Initialized List<@UnknownKeyFor @NonNull @Initialized 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 Details

JdbcReadSchemaTransformProvider

public JdbcReadSchemaTransformProvider()

Method Details

identifier

public @UnknownKeyFor @NonNull @Initialized String identifier()

Description copied from interface: SchemaTransformProvider

Returns an id that uniquely represents this transform.

description

public 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 String inheritedDescription(String prettyName,
 String transformName,
 String databaseSchema,
 int defaultJdbcPort)

configurationClass

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

Overrides:

configurationClass in class TypedSchemaTransformProvider<JdbcReadSchemaTransformProvider.JdbcReadSchemaTransformConfiguration>

jdbcType

protected 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 List<@UnknownKeyFor @NonNull @Initialized String> inputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the input collection names of this transform.

outputCollectionNames

public @UnknownKeyFor @NonNull @Initialized List<@UnknownKeyFor @NonNull @Initialized String> outputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the output collection names of this transform.