Column (flink-cdc-common 3.3.0 API)

java.lang.Object
- org.apache.flink.cdc.common.schema.Column

所有已实现的接口:

Serializable

直接已知子类:

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.

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`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`

构造器概要

构造器
限定符	构造器和说明
`protected`	`Column(String name, DataType type, String comment)`
`protected`	`Column(String name, DataType type, String comment, String defaultValueExpression)`

方法概要

所有方法静态方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`String`	`asSummaryString()` Returns a string that summarizes this column for printing to a console.
`abstract Column`	`copy(DataType newType)` Returns a copy of the column with a replaced `DataType`.
`abstract Column`	`copy(String newName)` Returns a copy of the column with a replaced name.
`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()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料
- FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
```
protected static final String FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
```
  另请参阅:
  
  常量字段值
- FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
```
protected static final String FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
```
  另请参阅:
  
  常量字段值
- FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
```
protected static final String FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION
```
  另请参阅:
  
  常量字段值
- FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
```
protected static final String FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION
```
  另请参阅:
  
  常量字段值
- 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).

构造器详细资料

Column

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

Column

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

方法详细资料

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)
```
覆盖:

equals 在类中 Object

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

toString
```
public String toString()
```
覆盖:

toString 在类中 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.

类 Column

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

FIELD_FORMAT_WITH_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

FIELD_FORMAT_NO_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

FIELD_FORMAT_WITH_DESCRIPTION_WITH_DEFAULT_VALUE_EXPRESSION

FIELD_FORMAT_NO_DESCRIPTION_NO_DEFAULT_VALUE_EXPRESSION

name

type

comment

defaultValueExpression

构造器详细资料

Column

Column

方法详细资料

getName

getType

getComment

getDefaultValueExpression

asSummaryString

isPhysical

copy

copy

equals

hashCode

toString

physicalColumn

physicalColumn

physicalColumn

metadataColumn

metadataColumn

metadataColumn