Package org.apache.flink.cdc.connectors.sqlserver.source.dialect

Class SqlServerDialect

java.lang.Object

org.apache.flink.cdc.connectors.sqlserver.source.dialect.SqlServerDialect

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, DataSourceDialect<JdbcSourceConfig>, JdbcDataSourceDialect

@Experimental
public class SqlServerDialect
extends Object
implements JdbcDataSourceDialect

The JdbcDataSourceDialect implementation for SqlServer datasource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SqlServerDialect(SqlServerSourceConfig sourceConfig)

Method Summary

Modifier and Type	Method	Description
ChunkSplitter	createChunkSplitter(JdbcSourceConfig sourceConfig)	Returns the ChunkSplitter which used to split collection to splits.
ChunkSplitter	createChunkSplitter(JdbcSourceConfig sourceConfig, ChunkSplitterState chunkSplitterState)
FetchTask<SourceSplitBase>	createFetchTask(SourceSplitBase sourceSplitBase)	The fetch task used to fetch data of a snapshot split or stream split.
SqlServerSourceFetchTaskContext	createFetchTaskContext(JdbcSourceConfig taskSourceConfig)	The task context used for fetch task to fetch data from external systems.
List<io.debezium.relational.TableId>	discoverDataCollections(JdbcSourceConfig sourceConfig)	Discovers the list of table to capture.
Map<io.debezium.relational.TableId,io.debezium.relational.history.TableChanges.TableChange>	discoverDataCollectionSchemas(JdbcSourceConfig sourceConfig)	Discovers the captured tables' schema by SourceConfig.
Offset	displayCurrentOffset(JdbcSourceConfig sourceConfig)	Displays current offset from the database e.g.
String	getName()	Get the name of dialect.
JdbcConnectionPoolFactory	getPooledDataSourceFactory()	Get a connection pool factory to create connection pool.
boolean	isDataCollectionIdCaseSensitive(JdbcSourceConfig sourceConfig)	Check if the CollectionId is case-sensitive or not.
boolean	isIncludeDataCollection(JdbcSourceConfig sourceConfig, io.debezium.relational.TableId tableId)	Check if the tableId is included in SourceConfig.
io.debezium.jdbc.JdbcConnection	openJdbcConnection(JdbcSourceConfig sourceConfig)	Creates and opens a new JdbcConnection backing connection pool.
io.debezium.relational.history.TableChanges.TableChange	queryTableSchema(io.debezium.jdbc.JdbcConnection jdbc, io.debezium.relational.TableId tableId)	Query and build the schema of table.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.cdc.connectors.base.dialect.DataSourceDialect

displayCommittedOffset, notifyCheckpointComplete

Methods inherited from interface org.apache.flink.cdc.connectors.base.dialect.JdbcDataSourceDialect

close

Constructor Detail

SqlServerDialect

public SqlServerDialect(SqlServerSourceConfig sourceConfig)

Method Detail

getName

public String getName()

Description copied from interface: DataSourceDialect

Get the name of dialect.

Specified by:

getName in interface DataSourceDialect<JdbcSourceConfig>

displayCurrentOffset

public Offset displayCurrentOffset(JdbcSourceConfig sourceConfig)

Description copied from interface: DataSourceDialect

Displays current offset from the database e.g. query Mysql binary logs by query SHOW MASTER STATUS.

Specified by:

displayCurrentOffset in interface DataSourceDialect<JdbcSourceConfig>

isDataCollectionIdCaseSensitive

public boolean isDataCollectionIdCaseSensitive(JdbcSourceConfig sourceConfig)

Description copied from interface: DataSourceDialect

Check if the CollectionId is case-sensitive or not.

Specified by:

isDataCollectionIdCaseSensitive in interface DataSourceDialect<JdbcSourceConfig>

openJdbcConnection

public io.debezium.jdbc.JdbcConnection openJdbcConnection(JdbcSourceConfig sourceConfig)

Description copied from interface: JdbcDataSourceDialect

Creates and opens a new JdbcConnection backing connection pool.

Specified by:

openJdbcConnection in interface JdbcDataSourceDialect

Parameters:

sourceConfig - a basic source configuration.

Returns:

a utility that simplifies using a JDBC connection.

createChunkSplitter

public ChunkSplitter createChunkSplitter(JdbcSourceConfig sourceConfig)

Description copied from interface: DataSourceDialect

Returns the ChunkSplitter which used to split collection to splits.

Specified by:

createChunkSplitter in interface DataSourceDialect<JdbcSourceConfig>

createChunkSplitter

public ChunkSplitter createChunkSplitter(JdbcSourceConfig sourceConfig,
                                         ChunkSplitterState chunkSplitterState)

Specified by:

createChunkSplitter in interface DataSourceDialect<JdbcSourceConfig>

getPooledDataSourceFactory

public JdbcConnectionPoolFactory getPooledDataSourceFactory()

Description copied from interface: JdbcDataSourceDialect

Get a connection pool factory to create connection pool.

Specified by:

getPooledDataSourceFactory in interface JdbcDataSourceDialect

discoverDataCollections

public List<io.debezium.relational.TableId> discoverDataCollections(JdbcSourceConfig sourceConfig)

Description copied from interface: JdbcDataSourceDialect

Discovers the list of table to capture.

Specified by:

discoverDataCollections in interface DataSourceDialect<JdbcSourceConfig>

Specified by:

discoverDataCollections in interface JdbcDataSourceDialect

discoverDataCollectionSchemas

public Map<io.debezium.relational.TableId,io.debezium.relational.history.TableChanges.TableChange> discoverDataCollectionSchemas(JdbcSourceConfig sourceConfig)

Description copied from interface: JdbcDataSourceDialect

Discovers the captured tables' schema by SourceConfig.

Specified by:

discoverDataCollectionSchemas in interface DataSourceDialect<JdbcSourceConfig>

Specified by:

discoverDataCollectionSchemas in interface JdbcDataSourceDialect

Parameters:

sourceConfig - a basic source configuration.

queryTableSchema

public io.debezium.relational.history.TableChanges.TableChange queryTableSchema(io.debezium.jdbc.JdbcConnection jdbc,
                                                                                io.debezium.relational.TableId tableId)

Description copied from interface: JdbcDataSourceDialect

Query and build the schema of table.

Specified by:

queryTableSchema in interface JdbcDataSourceDialect

createFetchTaskContext

public SqlServerSourceFetchTaskContext createFetchTaskContext(JdbcSourceConfig taskSourceConfig)

Description copied from interface: DataSourceDialect

The task context used for fetch task to fetch data from external systems.

Specified by:

createFetchTaskContext in interface DataSourceDialect<JdbcSourceConfig>

createFetchTask

public FetchTask<SourceSplitBase> createFetchTask(SourceSplitBase sourceSplitBase)

Description copied from interface: DataSourceDialect

The fetch task used to fetch data of a snapshot split or stream split.

Specified by:

createFetchTask in interface DataSourceDialect<JdbcSourceConfig>

Specified by:

createFetchTask in interface JdbcDataSourceDialect

isIncludeDataCollection

public boolean isIncludeDataCollection(JdbcSourceConfig sourceConfig,
                                       io.debezium.relational.TableId tableId)

Description copied from interface: DataSourceDialect

Check if the tableId is included in SourceConfig.

Specified by:

isIncludeDataCollection in interface DataSourceDialect<JdbcSourceConfig>