Package io.debezium.pipeline.source.snapshot.incremental

Interface ChunkQueryBuilder<T extends io.debezium.spi.schema.DataCollectionId>

All Known Implementing Classes:

AbstractChunkQueryBuilder, DefaultChunkQueryBuilder, PhysicalRowIdentifierChunkQueryBuilder, RowValueConstructorChunkQueryBuilder

public interface ChunkQueryBuilder<T extends io.debezium.spi.schema.DataCollectionId>

Builds queries for reading incremental snapshot chunks from a table.

Method Summary

Modifier and Type	Method	Description
String	buildChunkQuery(IncrementalSnapshotContext<T> context, Table table, int limit, Optional<String> additionalCondition)	Builds a query for reading the next incremental snapshot chunk from a table using the specified limit.
String	buildChunkQuery(IncrementalSnapshotContext<T> context, Table table, Optional<String> additionalCondition)	Builds a query for reading the next incremental snapshot chunk from a table using the chunk size configured by the connector.
String	buildMaxPrimaryKeyQuery(IncrementalSnapshotContext<T> context, Table table, Optional<String> additionalCondition)	Builds a query for reading the maximum primary key value from a table.
List<Column>	getQueryColumns(IncrementalSnapshotContext<T> context, Table table)	Returns the columns that are used for paginating the incremental snapshot chunks.
default Table	prepareTable(IncrementalSnapshotContext<T> context, Table table)	Allows builders to adjust the Table metadata before it is used for chunking.
PreparedStatement	readTableChunkStatement(IncrementalSnapshotContext<T> context, Table table, String sql)	Prepares a statement for reading the next incremental snapshot chunk from a table using the SQL statement returned by buildChunkQuery.

Method Details

buildChunkQuery

String buildChunkQuery(IncrementalSnapshotContext<T> context,
 Table table,
 Optional<String> additionalCondition)

Builds a query for reading the next incremental snapshot chunk from a table using the chunk size configured by the connector.

buildChunkQuery

String buildChunkQuery(IncrementalSnapshotContext<T> context,
 Table table,
 int limit,
 Optional<String> additionalCondition)

Builds a query for reading the next incremental snapshot chunk from a table using the specified limit.

readTableChunkStatement

PreparedStatement readTableChunkStatement(IncrementalSnapshotContext<T> context,
 Table table,
 String sql)
                                   throws SQLException

Prepares a statement for reading the next incremental snapshot chunk from a table using the SQL statement returned by buildChunkQuery.

Throws:

SQLException

buildMaxPrimaryKeyQuery

String buildMaxPrimaryKeyQuery(IncrementalSnapshotContext<T> context,
 Table table,
 Optional<String> additionalCondition)

Builds a query for reading the maximum primary key value from a table.

getQueryColumns

List<Column> getQueryColumns(IncrementalSnapshotContext<T> context,
 Table table)

Returns the columns that are used for paginating the incremental snapshot chunks.

prepareTable

default Table prepareTable(IncrementalSnapshotContext<T> context,
 Table table)

Allows builders to adjust the Table metadata before it is used for chunking.

Default implementation is a no-op, returning the provided table instance.