Package org.apache.flink.cdc.connectors.base.config

Class BaseSourceConfig

java.lang.Object

org.apache.flink.cdc.connectors.base.config.BaseSourceConfig

All Implemented Interfaces:

Serializable, SourceConfig

Direct Known Subclasses:

JdbcSourceConfig

public abstract class BaseSourceConfig
extends Object
implements SourceConfig

A basic Source configuration which is used by IncrementalSource.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.cdc.connectors.base.config.SourceConfig

SourceConfig.Factory<C extends SourceConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	assignUnboundedChunkFirst
protected boolean	closeIdleReaders
protected io.debezium.config.Configuration	dbzConfiguration
protected Properties	dbzProperties
protected double	distributionFactorLower
protected double	distributionFactorUpper
protected boolean	includeSchemaChanges
protected boolean	isScanNewlyAddedTableEnabled
protected boolean	releaseSnapshotMetadataEnabled
protected boolean	skipSnapshotBackfill
protected int	splitMetaGroupSize
protected int	splitSize
protected StartupOptions	startupOptions

Constructor Summary

Constructors

Constructor

Description

BaseSourceConfig(StartupOptions startupOptions, int splitSize, int splitMetaGroupSize, double distributionFactorUpper, double distributionFactorLower, boolean includeSchemaChanges, boolean closeIdleReaders, boolean skipSnapshotBackfill, boolean isScanNewlyAddedTableEnabled, Properties dbzProperties, io.debezium.config.Configuration dbzConfiguration, boolean assignUnboundedChunkFirst, boolean releaseSnapshotMetadataEnabled)

Method Summary

Modifier and Type	Method	Description
io.debezium.config.Configuration	getDbzConfiguration()
Properties	getDbzProperties()
double	getDistributionFactorLower()
double	getDistributionFactorUpper()
int	getSplitMetaGroupSize()
int	getSplitSize()
StartupOptions	getStartupOptions()
boolean	isAssignUnboundedChunkFirst()
boolean	isCloseIdleReaders()
boolean	isIncludeSchemaChanges()
boolean	isReleaseSnapshotMetadataEnabled()	Whether releasing the snapshot split metadata held by the source coordinator once the stream split is assembled and checkpoint-covered is enabled.
boolean	isSkipSnapshotBackfill()

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.config.SourceConfig

isScanNewlyAddedTableEnabled

Field Detail

startupOptions

protected final StartupOptions startupOptions

splitSize

protected final int splitSize

splitMetaGroupSize

protected final int splitMetaGroupSize

distributionFactorUpper

protected final double distributionFactorUpper

distributionFactorLower

protected final double distributionFactorLower

includeSchemaChanges

protected final boolean includeSchemaChanges

closeIdleReaders

protected final boolean closeIdleReaders

skipSnapshotBackfill

protected final boolean skipSnapshotBackfill

isScanNewlyAddedTableEnabled

protected final boolean isScanNewlyAddedTableEnabled

assignUnboundedChunkFirst

protected final boolean assignUnboundedChunkFirst

releaseSnapshotMetadataEnabled

protected final boolean releaseSnapshotMetadataEnabled

dbzProperties

protected final Properties dbzProperties

dbzConfiguration

protected transient io.debezium.config.Configuration dbzConfiguration

Constructor Detail

BaseSourceConfig

public BaseSourceConfig(StartupOptions startupOptions,
                        int splitSize,
                        int splitMetaGroupSize,
                        double distributionFactorUpper,
                        double distributionFactorLower,
                        boolean includeSchemaChanges,
                        boolean closeIdleReaders,
                        boolean skipSnapshotBackfill,
                        boolean isScanNewlyAddedTableEnabled,
                        Properties dbzProperties,
                        io.debezium.config.Configuration dbzConfiguration,
                        boolean assignUnboundedChunkFirst,
                        boolean releaseSnapshotMetadataEnabled)

Method Detail

getStartupOptions

public StartupOptions getStartupOptions()

Specified by:

getStartupOptions in interface SourceConfig

getSplitSize

public int getSplitSize()

Specified by:

getSplitSize in interface SourceConfig

getSplitMetaGroupSize

public int getSplitMetaGroupSize()

Specified by:

getSplitMetaGroupSize in interface SourceConfig

getDistributionFactorUpper

public double getDistributionFactorUpper()

getDistributionFactorLower

public double getDistributionFactorLower()

isIncludeSchemaChanges

public boolean isIncludeSchemaChanges()

Specified by:

isIncludeSchemaChanges in interface SourceConfig

isCloseIdleReaders

public boolean isCloseIdleReaders()

Specified by:

isCloseIdleReaders in interface SourceConfig

getDbzProperties

public Properties getDbzProperties()

getDbzConfiguration

public io.debezium.config.Configuration getDbzConfiguration()

isSkipSnapshotBackfill

public boolean isSkipSnapshotBackfill()

Specified by:

isSkipSnapshotBackfill in interface SourceConfig

isAssignUnboundedChunkFirst

public boolean isAssignUnboundedChunkFirst()

Specified by:

isAssignUnboundedChunkFirst in interface SourceConfig

isReleaseSnapshotMetadataEnabled

public boolean isReleaseSnapshotMetadataEnabled()

Description copied from interface: SourceConfig

Whether releasing the snapshot split metadata held by the source coordinator once the stream split is assembled and checkpoint-covered is enabled. Default false so existing jobs and configs that do not set the option are unaffected.

Specified by:

isReleaseSnapshotMetadataEnabled in interface SourceConfig