Package org.apache.flink.table.catalog

Class Column.MetadataColumn

java.lang.Object

org.apache.flink.table.catalog.Column

org.apache.flink.table.catalog.Column.MetadataColumn

Enclosing class:

Column

@PublicEvolving
public static final class Column.MetadataColumn
extends Column

Representation of a metadata column.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.table.catalog.Column

Column.ComputedColumn, Column.MetadataColumn, Column.PhysicalColumn

Field Summary

Fields inherited from class org.apache.flink.table.catalog.Column

comment, dataType, name

Method Summary

Modifier and Type	Method	Description
Column	copy(DataType newDataType)	Returns a copy of the column with a replaced DataType.
boolean	equals(Object o)
Optional<String>	explainExtras()	Returns an explanation of specific column extras next to name and type.
Optional<String>	getMetadataKey()
int	hashCode()
boolean	isPersisted()	Returns whether the given column is persisted in a sink operation.
boolean	isPhysical()	Returns whether the given column is a physical column of a table; neither computed nor metadata.
boolean	isVirtual()
Column.MetadataColumn	withComment(String comment)	Add the comment to the column and return the new object.

Methods inherited from class org.apache.flink.table.catalog.Column

asSummaryString, computed, getComment, getDataType, getName, metadata, physical, toString

Methods inherited from class java.lang.Object

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

Method Detail

isVirtual

public boolean isVirtual()

getMetadataKey

public Optional<String> getMetadataKey()

withComment

public Column.MetadataColumn withComment(@Nullable
                                         String comment)

Description copied from class: Column

Add the comment to the column and return the new object.

Specified by:

withComment in class Column

isPhysical

public boolean isPhysical()

Description copied from class: Column

Returns whether the given column is a physical column of a table; neither computed nor metadata.

Specified by:

isPhysical in class Column

isPersisted

public boolean isPersisted()

Description copied from class: Column

Returns whether the given column is persisted in a sink operation.

Specified by:

isPersisted in class Column

explainExtras

public Optional<String> explainExtras()

Description copied from class: Column

Returns an explanation of specific column extras next to name and type.

Specified by:

explainExtras in class Column

copy

public Column copy(DataType newDataType)

Description copied from class: Column

Returns a copy of the column with a replaced DataType.

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