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

Class MongoDBDialect

java.lang.Object

org.apache.flink.cdc.connectors.mongodb.source.dialect.MongoDBDialect

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, DataSourceDialect<MongoDBSourceConfig>

@Experimental
public class MongoDBDialect
extends Object
implements DataSourceDialect<MongoDBSourceConfig>

The DataSourceDialect implementation for MongoDB datasource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MongoDBDialect()

Method Summary

Modifier and Type	Method	Description
static io.debezium.relational.history.TableChanges.TableChange	collectionSchema(io.debezium.relational.TableId tableId)
ChunkSplitter	createChunkSplitter(MongoDBSourceConfig sourceConfig)	Deprecated.
ChunkSplitter	createChunkSplitter(MongoDBSourceConfig sourceConfig, ChunkSplitterState chunkSplitterState)
FetchTask<SourceSplitBase>	createFetchTask(SourceSplitBase sourceSplitBase)	The fetch task used to fetch data of a snapshot split or stream split.
MongoDBFetchTaskContext	createFetchTaskContext(MongoDBSourceConfig sourceConfig)	The task context used for fetch task to fetch data from external systems.
List<io.debezium.relational.TableId>	discoverDataCollections(MongoDBSourceConfig sourceConfig)	Discovers the list of data collection to capture.
Map<io.debezium.relational.TableId,io.debezium.relational.history.TableChanges.TableChange>	discoverDataCollectionSchemas(MongoDBSourceConfig sourceConfig)	Discovers the captured data collections' schema by SourceConfig.
ChangeStreamOffset	displayCurrentOffset(MongoDBSourceConfig sourceConfig)	Displays current offset from the database e.g.
String	getName()	Get the name of dialect.
boolean	isDataCollectionIdCaseSensitive(MongoDBSourceConfig sourceConfig)	Check if the CollectionId is case-sensitive or not.
boolean	isIncludeDataCollection(MongoDBSourceConfig sourceConfig, io.debezium.relational.TableId tableId)	Check if the tableId is included in SourceConfig.

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

close, displayCommittedOffset, notifyCheckpointComplete

Constructor Detail

MongoDBDialect

public MongoDBDialect()

Method Detail

getName

public String getName()

Description copied from interface: DataSourceDialect

Get the name of dialect.

Specified by:

getName in interface DataSourceDialect<MongoDBSourceConfig>

discoverDataCollections

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

Description copied from interface: DataSourceDialect

Discovers the list of data collection to capture.

Specified by:

discoverDataCollections in interface DataSourceDialect<MongoDBSourceConfig>

discoverDataCollectionSchemas

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

Description copied from interface: DataSourceDialect

Discovers the captured data collections' schema by SourceConfig.

Specified by:

discoverDataCollectionSchemas in interface DataSourceDialect<MongoDBSourceConfig>

Parameters:

sourceConfig - a basic source configuration.

collectionSchema

public static io.debezium.relational.history.TableChanges.TableChange collectionSchema(io.debezium.relational.TableId tableId)

displayCurrentOffset

public ChangeStreamOffset displayCurrentOffset(MongoDBSourceConfig 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<MongoDBSourceConfig>

isDataCollectionIdCaseSensitive

public boolean isDataCollectionIdCaseSensitive(MongoDBSourceConfig sourceConfig)

Description copied from interface: DataSourceDialect

Check if the CollectionId is case-sensitive or not.

Specified by:

isDataCollectionIdCaseSensitive in interface DataSourceDialect<MongoDBSourceConfig>

createChunkSplitter

@Deprecated
public ChunkSplitter createChunkSplitter(MongoDBSourceConfig sourceConfig)

Deprecated.

Description copied from interface: DataSourceDialect

Returns the ChunkSplitter which used to split collection to splits.

Specified by:

createChunkSplitter in interface DataSourceDialect<MongoDBSourceConfig>

createChunkSplitter

public ChunkSplitter createChunkSplitter(MongoDBSourceConfig sourceConfig,
                                         ChunkSplitterState chunkSplitterState)

Specified by:

createChunkSplitter in interface DataSourceDialect<MongoDBSourceConfig>

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<MongoDBSourceConfig>

createFetchTaskContext

public MongoDBFetchTaskContext createFetchTaskContext(MongoDBSourceConfig sourceConfig)

Description copied from interface: DataSourceDialect

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

Specified by:

createFetchTaskContext in interface DataSourceDialect<MongoDBSourceConfig>

isIncludeDataCollection

public boolean isIncludeDataCollection(MongoDBSourceConfig 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<MongoDBSourceConfig>