Package org.apache.flink.cdc.common.pipeline

Enum ExistingTableSchemaExpansionMode

java.lang.Object

java.lang.Enum<ExistingTableSchemaExpansionMode>

org.apache.flink.cdc.common.pipeline.ExistingTableSchemaExpansionMode

All Implemented Interfaces:

Serializable, Comparable<ExistingTableSchemaExpansionMode>

@Experimental
public enum ExistingTableSchemaExpansionMode
extends Enum<ExistingTableSchemaExpansionMode>

Strategy for handling an existing target table when the initial CreateTableEvent arrives.

CHECK guards the initial table state and is independent of SchemaChangeBehavior. TRY_EXPAND and EXPAND skip the framework-side initial handling when SchemaChangeBehavior is IGNORE or EXCEPTION; subsequent source schema changes are always controlled by SchemaChangeBehavior.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHECK	Validate that the existing target table can contain every upstream column without executing any DDL.
DISABLED	Do not check or expand the existing target table; keep the sink's original behavior.
EXPAND	Check and expand the existing target table with safe DDL.
TRY_EXPAND	Check and best-effort expand the existing target table with safe DDL.

Method Summary

Modifier and Type	Method	Description
static ExistingTableSchemaExpansionMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExistingTableSchemaExpansionMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final ExistingTableSchemaExpansionMode DISABLED

Do not check or expand the existing target table; keep the sink's original behavior.

CHECK

public static final ExistingTableSchemaExpansionMode CHECK

Validate that the existing target table can contain every upstream column without executing any DDL. Fails the job with an aggregated error (including suggested repair statements) if the target table is missing or incompatible. This mode guards the initial table state and runs regardless of SchemaChangeBehavior.

TRY_EXPAND

public static final ExistingTableSchemaExpansionMode TRY_EXPAND

Check and best-effort expand the existing target table with safe DDL. Failures of this mechanism are logged and delegated to the sink's original behavior.

A connector that does not implement ExistingTableSchemaExpansionSupport is a configuration error and fails the job rather than silently degrading.

EXPAND

public static final ExistingTableSchemaExpansionMode EXPAND

Check and expand the existing target table with safe DDL. Any incompatibility or failure of this mechanism fails the job.

Method Detail

values

public static ExistingTableSchemaExpansionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExistingTableSchemaExpansionMode c : ExistingTableSchemaExpansionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExistingTableSchemaExpansionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null