org.apache.flink.table.api

Class TableSchema

java.lang.Object

org.apache.flink.table.api.TableSchema

@PublicEvolving
public class TableSchema
extends Object

A table schema that represents a table's structure with field names and data types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableSchema.Builder Builder for creating a TableSchema.

Constructor Summary

Constructors

Constructor and Description
TableSchema(String[] fieldNames, TypeInformation<?>[] fieldTypes) Deprecated. Use the TableSchema.Builder instead.

Method Summary

Modifier and Type	Method and Description
static TableSchema.Builder	builder()
TableSchema	copy() Returns a deep copy of the table schema.
boolean	equals(Object o)
static TableSchema	fromTypeInfo(TypeInformation<?> typeInfo) Deprecated. This method will be removed soon. Use DataTypes to declare types.
int	getFieldCount() Returns the number of fields.
Optional<DataType>	getFieldDataType(int fieldIndex) Returns the specified data type for the given field index.
Optional<DataType>	getFieldDataType(String fieldName) Returns the specified data type for the given field name.
DataType[]	getFieldDataTypes() Returns all field data types as an array.
Optional<String>	getFieldName(int fieldIndex) Returns the specified name for the given field index.
String[]	getFieldNames() Returns all field names as an array.
Optional<TypeInformation<?>>	getFieldType(int fieldIndex) Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(int) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
Optional<TypeInformation<?>>	getFieldType(String fieldName) Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(String) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
TypeInformation<?>[]	getFieldTypes() Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataTypes() instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.
Optional<UniqueConstraint>	getPrimaryKey()
Optional<TableColumn>	getTableColumn(int fieldIndex) Returns the TableColumn instance for the given field index.
Optional<TableColumn>	getTableColumn(String fieldName) Returns the TableColumn instance for the given field name.
List<TableColumn>	getTableColumns() Returns all the TableColumns for this table schema.
List<WatermarkSpec>	getWatermarkSpecs() Returns a list of the watermark specification which contains rowtime attribute and watermark strategy expression.
int	hashCode()
DataType	toPhysicalRowDataType() Converts all physical columns of this schema into a (possibly nested) row data type.
DataType	toRowDataType() Converts all columns of this schema into a (possibly nested) row data type.
TypeInformation<Row>	toRowType() Deprecated. Use toRowDataType() instead.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSchema

@Deprecated
public TableSchema(String[] fieldNames,
                               TypeInformation<?>[] fieldTypes)

Deprecated. Use the TableSchema.Builder instead.

Method Detail

copy

public TableSchema copy()

Returns a deep copy of the table schema.

getFieldDataTypes

public DataType[] getFieldDataTypes()

Returns all field data types as an array.

getFieldTypes

@Deprecated
public TypeInformation<?>[] getFieldTypes()

Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataTypes() instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.

getFieldDataType

public Optional<DataType> getFieldDataType(int fieldIndex)

Returns the specified data type for the given field index.

Parameters:

fieldIndex - the index of the field

getFieldType

@Deprecated
public Optional<TypeInformation<?>> getFieldType(int fieldIndex)

Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(int) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.

getFieldDataType

public Optional<DataType> getFieldDataType(String fieldName)

Returns the specified data type for the given field name.

Parameters:

fieldName - the name of the field

getFieldType

@Deprecated
public Optional<TypeInformation<?>> getFieldType(String fieldName)

Deprecated. This method will be removed in future versions as it uses the old type system. It is recommended to use getFieldDataType(String) instead which uses the new type system based on DataTypes. Please make sure to use either the old or the new type system consistently to avoid unintended behavior. See the website documentation for more information.

getFieldCount

public int getFieldCount()

Returns the number of fields.

getFieldNames

public String[] getFieldNames()

Returns all field names as an array.

getFieldName

public Optional<String> getFieldName(int fieldIndex)

Returns the specified name for the given field index.

Parameters:

fieldIndex - the index of the field

getTableColumn

public Optional<TableColumn> getTableColumn(int fieldIndex)

Returns the TableColumn instance for the given field index.

Parameters:

fieldIndex - the index of the field

getTableColumn

public Optional<TableColumn> getTableColumn(String fieldName)

Returns the TableColumn instance for the given field name.

Parameters:

fieldName - the name of the field

getTableColumns

public List<TableColumn> getTableColumns()

Returns all the TableColumns for this table schema.

toRowDataType

public DataType toRowDataType()

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

Note: The returned row data type contains both physical and computed columns. Be careful when using this method in a table source or table sink. In many cases, toPhysicalRowDataType() might be more appropriate.

See Also:

DataTypes.ROW(Field...), toPhysicalRowDataType()

toPhysicalRowDataType

public DataType toPhysicalRowDataType()

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

Note: The returned row data type contains only physical columns. It does not include computed columns.

See Also:

DataTypes.ROW(Field...), toRowDataType()

toRowType

@Deprecated
public TypeInformation<Row> toRowType()

Deprecated. Use toRowDataType() instead.

getWatermarkSpecs

public List<WatermarkSpec> getWatermarkSpecs()

Returns a list of the watermark specification which contains rowtime attribute and watermark strategy expression.

NOTE: Currently, there is at most one WatermarkSpec in the list, because we don't support multiple watermarks definition yet. But in the future, we may support multiple watermarks.

getPrimaryKey

public Optional<UniqueConstraint> getPrimaryKey()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

fromTypeInfo

@Deprecated
public static TableSchema fromTypeInfo(TypeInformation<?> typeInfo)

Deprecated. This method will be removed soon. Use DataTypes to declare types.

Creates a table schema from a TypeInformation instance. If the type information is a CompositeType, the field names and types for the composite type are used to construct the TableSchema instance. Otherwise, a table schema with a single field is created. The field name is "f0" and the field type the provided type.

Parameters:

typeInfo - The TypeInformation from which the table schema is generated.

Returns:

The table schema that was generated from the given TypeInformation.

builder

public static TableSchema.Builder builder()