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

Class Column

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MetadataColumn, PhysicalColumn

@PublicEvolving
public abstract class Column
extends Object
implements Serializable

Representation of a column in a Schema.

A table column describes either a PhysicalColumn or MetadataColumn.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	comment
protected String	defaultValueExpression	Save the literal value of the column's default value, For uncertain functions such as UUID(), the value is null, For the current time function such as CURRENT_TIMESTAMP(), the value is Unix Epoch time(1970-01-01 00:00:00).
protected static String	FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
protected static String	FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
protected static String	FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
protected static String	FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
protected String	name
protected DataType	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Column(String name, DataType type, String comment)
protected	Column(String name, DataType type, String comment, String defaultValueExpression)

Method Summary

Modifier and Type	Method	Description
String	asSummaryString()	Returns a string that summarizes this column for printing to a console.
abstract Column	copy(String newName)	Returns a copy of the column with a replaced name.
abstract Column	copy(DataType newType)	Returns a copy of the column with a replaced DataType.
boolean	equals(Object o)
String	getComment()
String	getDefaultValueExpression()
String	getName()	Returns the name of this column.
DataType	getType()	Returns the data type of this column.
int	hashCode()
abstract boolean	isPhysical()	Returns whether the given column is a physical column of a table or metadata column.
static MetadataColumn	metadataColumn(String name, DataType type)	Creates a metadata column.
static MetadataColumn	metadataColumn(String name, DataType type, String metadataKey)	Creates a metadata column.
static MetadataColumn	metadataColumn(String name, DataType type, String metadataKey, String comment)	Creates a metadata column.
static PhysicalColumn	physicalColumn(String name, DataType type)	Creates a physical column.
static PhysicalColumn	physicalColumn(String name, DataType type, String comment)	Creates a physical column.
static PhysicalColumn	physicalColumn(String name, DataType type, String comment, String defaultValueExpression)	Creates a physical column.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

protected static final String FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

See Also:

Constant Field Values

FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

protected static final String FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

See Also:

Constant Field Values

FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

protected static final String FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

See Also:

Constant Field Values

FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

protected static final String FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

See Also:

Constant Field Values

name

protected final String name

type

protected final DataType type

comment

@Nullable
protected final String comment

defaultValueExpression

@Nullable
protected final String defaultValueExpression

Save the literal value of the column's default value, For uncertain functions such as UUID(), the value is null, For the current time function such as CURRENT_TIMESTAMP(), the value is Unix Epoch time(1970-01-01 00:00:00).

Constructor Detail

Column

protected Column(String name,
                 DataType type,
                 @Nullable
                 String comment)

Column

protected Column(String name,
                 DataType type,
                 @Nullable
                 String comment,
                 @Nullable
                 String defaultValueExpression)

Method Detail

getName

public String getName()

Returns the name of this column.

getType

public DataType getType()

Returns the data type of this column.

getComment

@Nullable
public String getComment()

getDefaultValueExpression

@Nullable
public String getDefaultValueExpression()

asSummaryString

public String asSummaryString()

Returns a string that summarizes this column for printing to a console.

isPhysical

public abstract boolean isPhysical()

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

copy

public abstract Column copy(DataType newType)

Returns a copy of the column with a replaced DataType.

copy

public abstract Column copy(String newName)

Returns a copy of the column with a replaced name.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

physicalColumn

public static PhysicalColumn physicalColumn(String name,
                                            DataType type,
                                            @Nullable
                                            String comment,
                                            @Nullable
                                            String defaultValueExpression)

Creates a physical column.

physicalColumn

public static PhysicalColumn physicalColumn(String name,
                                            DataType type,
                                            @Nullable
                                            String comment)

Creates a physical column.

physicalColumn

public static PhysicalColumn physicalColumn(String name,
                                            DataType type)

Creates a physical column.

metadataColumn

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

Creates a metadata column.

metadataColumn

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

Creates a metadata column.

metadataColumn

public static MetadataColumn metadataColumn(String name,
                                            DataType type)

Creates a metadata column.