Package org.apache.flink.cdc.connectors.mongodb.table

Class MongoDBTableSource

java.lang.Object

org.apache.flink.cdc.connectors.mongodb.table.MongoDBTableSource

All Implemented Interfaces:

org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata, org.apache.flink.table.connector.source.DynamicTableSource, org.apache.flink.table.connector.source.ScanTableSource

public class MongoDBTableSource
extends Object
implements org.apache.flink.table.connector.source.ScanTableSource, org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

A DynamicTableSource that describes how to create a MongoDB change stream events source from a logical description.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.DynamicTableSource

org.apache.flink.table.connector.source.DynamicTableSource.Context, org.apache.flink.table.connector.source.DynamicTableSource.DataStructureConverter

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.ScanTableSource

org.apache.flink.table.connector.source.ScanTableSource.ScanContext, org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	metadataKeys	Metadata that is appended at the end of a physical source row.
protected org.apache.flink.table.types.DataType	producedDataType	Data type that describes the final output of the source.

Constructor Summary

Constructors

Constructor

Description

MongoDBTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema, String scheme, String hosts, String username, String password, String database, String collection, String connectionOptions, StartupOptions startupOptions, Integer initialSnapshottingQueueSize, Integer initialSnapshottingMaxThreads, String initialSnapshottingPipeline, Integer batchSize, Integer pollMaxBatchSize, Integer pollAwaitTimeMillis, Integer heartbeatIntervalMillis, java.time.ZoneId localTimeZone, boolean enableParallelRead, Integer splitMetaGroupSize, Integer splitSizeMB, Integer samplesPerChunk, boolean closeIdlerReaders, boolean enableFullDocPrePostImage, boolean noCursorTimeout, boolean skipSnapshotBackfill, boolean scanNewlyAddedTableEnabled, boolean assignUnboundedChunkFirst, boolean releaseSnapshotMetadataEnabled, boolean sslEnabled, boolean sslInvalidHostnameAllowed, String sslKeyStore, String sslKeyStorePassword, String sslKeyStoreType, String sslTrustStore, String sslTrustStorePassword, String sslTrustStoreType)

Method Summary

Modifier and Type	Method	Description
void	applyReadableMetadata(List<String> metadataKeys, org.apache.flink.table.types.DataType producedDataType)
String	asSummaryString()
org.apache.flink.table.connector.source.DynamicTableSource	copy()
boolean	equals(Object o)
org.apache.flink.table.connector.ChangelogMode	getChangelogMode()
protected MetadataConverter[]	getMetadataConverters()
org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(org.apache.flink.table.connector.source.ScanTableSource.ScanContext scanContext)
int	hashCode()
Map<String,org.apache.flink.table.types.DataType>	listReadableMetadata()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

supportsMetadataProjection

Field Detail

producedDataType

protected org.apache.flink.table.types.DataType producedDataType

Data type that describes the final output of the source.

metadataKeys

protected List<String> metadataKeys

Metadata that is appended at the end of a physical source row.

Constructor Detail

MongoDBTableSource

public MongoDBTableSource(org.apache.flink.table.catalog.ResolvedSchema physicalSchema,
                          String scheme,
                          String hosts,
                          @Nullable
                          String username,
                          @Nullable
                          String password,
                          @Nullable
                          String database,
                          @Nullable
                          String collection,
                          @Nullable
                          String connectionOptions,
                          StartupOptions startupOptions,
                          @Nullable
                          Integer initialSnapshottingQueueSize,
                          @Nullable
                          Integer initialSnapshottingMaxThreads,
                          @Nullable
                          String initialSnapshottingPipeline,
                          @Nullable
                          Integer batchSize,
                          @Nullable
                          Integer pollMaxBatchSize,
                          @Nullable
                          Integer pollAwaitTimeMillis,
                          @Nullable
                          Integer heartbeatIntervalMillis,
                          java.time.ZoneId localTimeZone,
                          boolean enableParallelRead,
                          @Nullable
                          Integer splitMetaGroupSize,
                          @Nullable
                          Integer splitSizeMB,
                          @Nullable
                          Integer samplesPerChunk,
                          boolean closeIdlerReaders,
                          boolean enableFullDocPrePostImage,
                          boolean noCursorTimeout,
                          boolean skipSnapshotBackfill,
                          boolean scanNewlyAddedTableEnabled,
                          boolean assignUnboundedChunkFirst,
                          boolean releaseSnapshotMetadataEnabled,
                          boolean sslEnabled,
                          boolean sslInvalidHostnameAllowed,
                          @Nullable
                          String sslKeyStore,
                          @Nullable
                          String sslKeyStorePassword,
                          String sslKeyStoreType,
                          @Nullable
                          String sslTrustStore,
                          @Nullable
                          String sslTrustStorePassword,
                          String sslTrustStoreType)

Method Detail

getChangelogMode

public org.apache.flink.table.connector.ChangelogMode getChangelogMode()

Specified by:

getChangelogMode in interface org.apache.flink.table.connector.source.ScanTableSource

getScanRuntimeProvider

public org.apache.flink.table.connector.source.ScanTableSource.ScanRuntimeProvider getScanRuntimeProvider(org.apache.flink.table.connector.source.ScanTableSource.ScanContext scanContext)

Specified by:

getScanRuntimeProvider in interface org.apache.flink.table.connector.source.ScanTableSource

getMetadataConverters

protected MetadataConverter[] getMetadataConverters()

listReadableMetadata

public Map<String,org.apache.flink.table.types.DataType> listReadableMetadata()

Specified by:

listReadableMetadata in interface org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

applyReadableMetadata

public void applyReadableMetadata(List<String> metadataKeys,
                                  org.apache.flink.table.types.DataType producedDataType)

Specified by:

applyReadableMetadata in interface org.apache.flink.table.connector.source.abilities.SupportsReadingMetadata

copy

public org.apache.flink.table.connector.source.DynamicTableSource copy()

Specified by:

copy in interface org.apache.flink.table.connector.source.DynamicTableSource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

asSummaryString

public String asSummaryString()

Specified by:

asSummaryString in interface org.apache.flink.table.connector.source.DynamicTableSource