Package org.apache.flink.table.types.logical

Class RowType

java.lang.Object

org.apache.flink.table.types.logical.LogicalType

org.apache.flink.table.types.logical.RowType

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class RowType
extends LogicalType

Logical type of a sequence of fields. A field consists of a field name, field type, and an optional description. The most specific type of a row of a table is a row type. In this case, each column of the row corresponds to the field of the row type that has the same ordinal position as the column. Compared to the SQL standard, an optional field description simplifies the handling with complex structures.

The serialized string representation is ROW<n0 t0 'd0', n1 t1 'd1', ...> where n is the unique name of a field, t is the logical type of a field, d is the description of a field. ROW(...) is a synonym for being closer to the SQL standard.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RowType.RowField	Describes a field of a RowType.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FORMAT

Constructor Summary

Constructors

Constructor	Description
RowType(boolean isNullable, List<RowType.RowField> fields)
RowType(List<RowType.RowField> fields)

Method Summary

Modifier and Type	Method	Description
<R> R	accept(LogicalTypeVisitor<R> visitor)
String	asSerializableString()	Returns a string that fully serializes this instance.
String	asSummaryString()	Returns a string that summarizes this type for printing to a console.
LogicalType	copy(boolean isNullable)	Returns a deep copy of this type with possibly different nullability.
boolean	equals(Object o)
List<LogicalType>	getChildren()
Class<?>	getDefaultConversion()	Returns the default conversion class.
int	getFieldCount()
int	getFieldIndex(String fieldName)
List<String>	getFieldNames()
List<RowType.RowField>	getFields()
LogicalType	getTypeAt(int i)
int	hashCode()
static RowType	of(boolean isNullable, LogicalType... types)
static RowType	of(boolean nullable, LogicalType[] types, String[] names)
static RowType	of(LogicalType... types)
static RowType	of(LogicalType[] types, String[] names)
boolean	supportsInputConversion(Class<?> clazz)	Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem.
boolean	supportsOutputConversion(Class<?> clazz)	Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem.

Methods inherited from class org.apache.flink.table.types.logical.LogicalType

conversionSet, copy, getTypeRoot, is, is, isAnyOf, isAnyOf, isNullable, toString, withNullability

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final String FORMAT

See Also:

Constant Field Values

Constructor Detail

RowType

public RowType(boolean isNullable,
               List<RowType.RowField> fields)

RowType

public RowType(List<RowType.RowField> fields)

Method Detail

getFields

public List<RowType.RowField> getFields()

getFieldNames

public List<String> getFieldNames()

getTypeAt

public LogicalType getTypeAt(int i)

getFieldCount

public int getFieldCount()

getFieldIndex

public int getFieldIndex(String fieldName)

copy

public LogicalType copy(boolean isNullable)

Description copied from class: LogicalType

Returns a deep copy of this type with possibly different nullability.

Specified by:

copy in class LogicalType

Parameters:

isNullable - the intended nullability of the copied type

Returns:

a deep copy

asSummaryString

public String asSummaryString()

Description copied from class: LogicalType

Returns a string that summarizes this type for printing to a console. An implementation might shorten long names or skips very specific properties.

Use LogicalType.asSerializableString() for a type string that fully serializes this instance.

Overrides:

asSummaryString in class LogicalType

Returns:

summary string of this type for debugging purposes

asSerializableString

public String asSerializableString()

Description copied from class: LogicalType

Returns a string that fully serializes this instance. The serialized string can be used for transmitting or persisting a type.

See LogicalTypeParser for the reverse operation.

Specified by:

asSerializableString in class LogicalType

Returns:

detailed string for transmission or persistence

supportsInputConversion

public boolean supportsInputConversion(Class<?> clazz)

Description copied from class: LogicalType

Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

A supported conversion directly maps an input class to a logical type without loss of precision or type widening.

For example, java.lang.Long or long can be used as input for BIGINT independent of the set nullability.

Specified by:

supportsInputConversion in class LogicalType

Parameters:

clazz - input class to be converted into this logical type

Returns:

flag that indicates if instances of this class can be used as input into the table ecosystem

See Also:

LogicalType.getDefaultConversion()

supportsOutputConversion

public boolean supportsOutputConversion(Class<?> clazz)

Description copied from class: LogicalType

Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

A supported conversion directly maps a logical type to an output class without loss of precision or type widening.

For example, java.lang.Long or long can be used as output for BIGINT if the type is not nullable. If the type is nullable, only java.lang.Long can represent this.

Specified by:

supportsOutputConversion in class LogicalType

Parameters:

clazz - output class to be converted from this logical type

Returns:

flag that indicates if instances of this class can be used as output from the table ecosystem

See Also:

LogicalType.getDefaultConversion()

getDefaultConversion

public Class<?> getDefaultConversion()

Description copied from class: LogicalType

Returns the default conversion class. A value of this logical type is expected to be an instance of the given class when entering or is represented as an instance of the given class when leaving the table ecosystem if no other conversion has been specified.

For example, java.lang.Long is the default input and output for BIGINT.

Specified by:

getDefaultConversion in class LogicalType

Returns:

default class to represent values of this logical type

See Also:

LogicalType.supportsInputConversion(Class), LogicalType.supportsOutputConversion(Class)

getChildren

public List<LogicalType> getChildren()

Specified by:

getChildren in class LogicalType

accept

public <R> R accept(LogicalTypeVisitor<R> visitor)

Specified by:

accept in class LogicalType

equals

public boolean equals(Object o)

Overrides:

equals in class LogicalType

hashCode

public int hashCode()

Overrides:

hashCode in class LogicalType

of

public static RowType of(LogicalType... types)

of

public static RowType of(boolean isNullable,
                         LogicalType... types)

of

public static RowType of(LogicalType[] types,
                         String[] names)

of

public static RowType of(boolean nullable,
                         LogicalType[] types,
                         String[] names)