org.apache.paimon.flink.sink.cdc

Class CdcSchema.Builder

java.lang.Object

org.apache.paimon.flink.sink.cdc.CdcSchema.Builder

Enclosing class:

CdcSchema

public static final class CdcSchema.Builder
extends Object

A builder for constructing an immutable but still unresolved CdcSchema.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CdcSchema	build() Returns an instance of an unresolved CdcSchema.
CdcSchema.Builder	column(DataField dataField) Declares a column that is appended to this schema.
CdcSchema.Builder	column(String columnName, DataType dataType) Declares a column that is appended to this schema.
CdcSchema.Builder	column(String columnName, DataType dataType, String description) Declares a column that is appended to this schema.
CdcSchema.Builder	comment(String comment) Declares table comment.
int	getHighestFieldId()
CdcSchema.Builder	primaryKey(List<String> columnNames) Declares a primary key constraint for a set of given columns.
CdcSchema.Builder	primaryKey(String... columnNames) Declares a primary key constraint for a set of given columns.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

getHighestFieldId

public int getHighestFieldId()

column

public CdcSchema.Builder column(DataField dataField)

Declares a column that is appended to this schema.

Parameters:

dataField - data field

column

public CdcSchema.Builder column(String columnName,
                                DataType dataType)

Declares a column that is appended to this schema.

Parameters:

columnName - column name

dataType - data type of the column

column

public CdcSchema.Builder column(String columnName,
                                DataType dataType,
                                @Nullable
                                String description)

Declares a column that is appended to this schema.

Parameters:

columnName - column name

dataType - data type of the column

description - description of the column

primaryKey

public CdcSchema.Builder primaryKey(String... columnNames)

Declares a primary key constraint for a set of given columns. Primary key uniquely identify a row in a table. Neither of columns in a primary can be nullable.

Parameters:

columnNames - columns that form a unique primary key

primaryKey

public CdcSchema.Builder primaryKey(List<String> columnNames)

Declares a primary key constraint for a set of given columns. Primary key uniquely identify a row in a table. Neither of columns in a primary can be nullable.

Parameters:

columnNames - columns that form a unique primary key

comment

public CdcSchema.Builder comment(@Nullable
                                 String comment)

Declares table comment.

build

public CdcSchema build()

Returns an instance of an unresolved CdcSchema.