Package org.apache.flink.cdc.common.schema

Class MetadataColumn

java.lang.Object

org.apache.flink.cdc.common.schema.Column

org.apache.flink.cdc.common.schema.MetadataColumn

All Implemented Interfaces:

Serializable

@PublicEvolving
public class MetadataColumn
extends Column

Representation of a metadata column.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.cdc.common.schema.Column

comment, defaultValueExpression, FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION, FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION, FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION, FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION, name, type

Constructor Summary

Constructors

Constructor	Description
MetadataColumn(String name, DataType type, String metadataKey, String comment)

Method Summary

Modifier and Type	Method	Description
Column	copy(String newName)	Returns a copy of the column with a replaced name.
Column	copy(DataType newType)	Returns a copy of the column with a replaced DataType.
boolean	equals(Object o)
String	getMetadataKey()
int	hashCode()
boolean	isPhysical()	Returns whether the given column is a physical column of a table or metadata column.

Methods inherited from class org.apache.flink.cdc.common.schema.Column

asSummaryString, getComment, getDefaultValueExpression, getName, getType, metadataColumn, metadataColumn, metadataColumn, physicalColumn, physicalColumn, physicalColumn, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataColumn

public MetadataColumn(String name,
                      DataType type,
                      @Nullable
                      String metadataKey,
                      @Nullable
                      String comment)

Method Detail

isPhysical

public boolean isPhysical()

Description copied from class: Column

Returns whether the given column is a physical column of a table or metadata column.

Specified by:

isPhysical in class Column

getMetadataKey

@Nullable
public String getMetadataKey()

copy

public Column copy(DataType newType)

Description copied from class: Column

Returns a copy of the column with a replaced DataType.

Specified by:

copy in class Column

copy

public Column copy(String newName)

Description copied from class: Column

Returns a copy of the column with a replaced name.

Specified by:

copy in class Column

equals

public boolean equals(Object o)

Overrides:

equals in class Column

hashCode

public int hashCode()

Overrides:

hashCode in class Column