org.apache.paimon.schema

Class Schema.Builder

java.lang.Object

org.apache.paimon.schema.Schema.Builder

Enclosing class:

Schema

public static final class Schema.Builder
extends Object

A builder for constructing an immutable but still unresolved Schema.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Schema	build() Returns an instance of an unresolved Schema.
Schema.Builder	column(String columnName, DataType dataType) Declares a column that is appended to this schema.
Schema.Builder	column(String columnName, DataType dataType, String description) Declares a column that is appended to this schema.
Schema.Builder	comment(String comment) Declares table comment.
int	getHighestFieldId()
Schema.Builder	option(String key, String value) Declares an option.
Schema.Builder	options(Map<String,String> options) Declares options.
Schema.Builder	partitionKeys(List<String> columnNames) Declares partition keys.
Schema.Builder	partitionKeys(String... columnNames) Declares partition keys.
Schema.Builder	primaryKey(List<String> columnNames) Declares a primary key constraint for a set of given columns.
Schema.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 Schema.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 Schema.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

partitionKeys

public Schema.Builder partitionKeys(String... columnNames)

Declares partition keys.

partitionKeys

public Schema.Builder partitionKeys(List<String> columnNames)

Declares partition keys.

primaryKey

public Schema.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 Schema.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

options

public Schema.Builder options(Map<String,String> options)

Declares options.

option

public Schema.Builder option(String key,
                             String value)

Declares an option.

comment

public Schema.Builder comment(@Nullable
                              String comment)

Declares table comment.

build

public Schema build()

Returns an instance of an unresolved Schema.