Package org.apache.beam.io.debezium

Class DebeziumReadSchemaTransformProvider

java.lang.Object

org.apache.beam.sdk.schemas.transforms.TypedSchemaTransformProvider<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration>

org.apache.beam.io.debezium.DebeziumReadSchemaTransformProvider

All Implemented Interfaces:

SchemaTransformProvider

@AutoService(SchemaTransformProvider.class)
public class DebeziumReadSchemaTransformProvider
extends TypedSchemaTransformProvider<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration>

A schema-aware transform provider for DebeziumIO. This class provides a PTransform that returns a change stream for a relational database.

The transform needs to access the source database on expansion and at pipeline runtime. At expansion, the output PCollection schema is retrieved, while at runtime, the change stream is consumed.

This transform is tested against MySQL and Postgres, but it should work well for any data source supported by Debezium.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration

Constructor Summary

Constructors

Modifier	Constructor	Description
	DebeziumReadSchemaTransformProvider()
protected	DebeziumReadSchemaTransformProvider(Boolean isTest, Integer recordLimit, Long timeLimitMs)

Method Summary

Modifier and Type	Method	Description
protected @NonNull @Initialized Class<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration>	configurationClass()
protected @NonNull @Initialized SchemaTransform	from(DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration configuration)	Produce a SchemaTransform from ConfigT.
@NonNull @Initialized String	identifier()	Returns an id that uniquely represents this transform.
@NonNull @Initialized List<@NonNull @Initialized String>	inputCollectionNames()	Returns the input collection names of this transform.
@NonNull @Initialized List<@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

Methods inherited from interface org.apache.beam.sdk.schemas.transforms.SchemaTransformProvider

description

Constructor Details

DebeziumReadSchemaTransformProvider

public DebeziumReadSchemaTransformProvider()

DebeziumReadSchemaTransformProvider

protected DebeziumReadSchemaTransformProvider(Boolean isTest,
 Integer recordLimit,
 Long timeLimitMs)

Method Details

configurationClass

protected @NonNull @Initialized Class<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration> configurationClass()

Overrides:

configurationClass in class TypedSchemaTransformProvider<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration>

from

protected @NonNull @Initialized SchemaTransform from(DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration configuration)

Description copied from class: TypedSchemaTransformProvider

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

Specified by:

from in class TypedSchemaTransformProvider<DebeziumReadSchemaTransformProvider.DebeziumReadSchemaTransformConfiguration>

identifier

public @NonNull @Initialized String identifier()

Description copied from interface: SchemaTransformProvider

Returns an id that uniquely represents this transform.

inputCollectionNames

public @NonNull @Initialized List<@NonNull @Initialized String> inputCollectionNames()

Description copied from interface: SchemaTransformProvider

Returns the input collection names of this transform.

outputCollectionNames

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

Description copied from interface: SchemaTransformProvider

Returns the output collection names of this transform.