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

Class Schema

java.lang.Object

org.apache.flink.cdc.common.schema.Schema

All Implemented Interfaces:

Serializable

@PublicEvolving
public class Schema
extends Object
implements Serializable

Schema of a table or data collection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Schema.Builder	A builder for constructing an immutable but still unresolved Schema.

Method Summary

Modifier and Type	Method	Description
String	comment()	Returns the comment of the table or data collection.
Schema	copy(String comment)	Returns a copy of the schema with a replaced comment.
Schema	copy(List<Column> columns)	Returns a copy of the schema with a replaced list of Column.
String	describeOptions()
boolean	equals(Object o)
Optional<Column>	getColumn(String columnName)	Returns the Column instance for the given column name.
int	getColumnCount()	Returns the number of columns of this schema.
List<DataType>	getColumnDataTypes()	Returns all column data types.
List<String>	getColumnNames()	Returns all column names.
List<Column>	getColumns()	Returns all Columns of this schema.
int	hashCode()
static Schema.Builder	newBuilder()	Builder for configuring and creating instances of Schema.
Map<String,String>	options()	Returns the options of the table or data collection.
List<String>	partitionKeys()	Returns the partition keys of the table or data collection.
List<String>	primaryKeys()	Returns the primary keys of the table or data collection.
DataType	toRowDataType()	Converts all columns of this schema into a (possibly nested) row data type.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getColumnCount

public int getColumnCount()

Returns the number of columns of this schema.

getColumns

public List<Column> getColumns()

Returns all Columns of this schema.

getColumnNames

public List<String> getColumnNames()

Returns all column names. It does not distinguish between different kinds of columns.

getColumnDataTypes

public List<DataType> getColumnDataTypes()

Returns all column data types. It does not distinguish between different kinds of columns.

primaryKeys

public List<String> primaryKeys()

Returns the primary keys of the table or data collection.

partitionKeys

public List<String> partitionKeys()

Returns the partition keys of the table or data collection.

options

public Map<String,String> options()

Returns the options of the table or data collection.

describeOptions

public String describeOptions()

comment

public String comment()

Returns the comment of the table or data collection.

getColumn

public Optional<Column> getColumn(String columnName)

Returns the Column instance for the given column name.

Parameters:

columnName - the name of the column

toRowDataType

public DataType toRowDataType()

Converts all columns of this schema into a (possibly nested) row data type.

See Also:

DataTypes.ROW(DataField...)

copy

public Schema copy(List<Column> columns)

Returns a copy of the schema with a replaced list of Column.

copy

public Schema copy(String comment)

Returns a copy of the schema with a replaced comment.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

newBuilder

public static Schema.Builder newBuilder()

Builder for configuring and creating instances of Schema.

toString

public String toString()

Overrides:

toString in class Object