org.apache.paimon.types

Class RowType

java.lang.Object

org.apache.paimon.types.DataType

org.apache.paimon.types.RowType

All Implemented Interfaces:

Serializable

@Public
public final class RowType
extends DataType

Data 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.

Since:

0.4.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RowType.Builder Builder of RowType.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT

Constructor Summary

Constructors

Constructor and Description
RowType(boolean isNullable, List<DataField> fields)
RowType(List<DataField> fields)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(DataTypeVisitor<R> visitor)
RowType	appendDataField(String name, DataType type)
String	asSQLString() Returns a string that summarizes this type as SQL standard string for printing to a console.
static RowType.Builder	builder()
static RowType.Builder	builder(boolean isNullable, AtomicInteger fieldId)
void	collectFieldIds(Set<Integer> fieldIds)
boolean	containsField(String fieldName)
DataType	copy(boolean isNullable) Returns a deep copy of this type with possibly different nullability.
static int	currentHighestFieldId(List<DataField> fields)
boolean	equals(Object o)
InternalRow.FieldGetter[]	fieldGetters()
DataField	getField(String fieldName)
int	getFieldCount()
int	getFieldIndex(String fieldName)
int[]	getFieldIndices(List<String> projectFields)
List<String>	getFieldNames()
List<DataField>	getFields()
List<DataType>	getFieldTypes()
DataType	getTypeAt(int i)
int	hashCode()
boolean	notContainsField(String fieldName)
static RowType	of(DataType... types)
static RowType	of(DataType[] types, String[] names)
RowType	project(int[] mapping)
RowType	project(List<String> names)
void	serializeJson(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonGenerator generator)

Methods inherited from class org.apache.paimon.types.DataType

copy, equalsIgnoreNullable, getTypeRoot, is, is, isAnyOf, isAnyOf, isNullable, notNull, nullable, 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<DataField> fields)

RowType

public RowType(List<DataField> fields)

Method Detail

getFields

public List<DataField> getFields()

getFieldNames

public List<String> getFieldNames()

getFieldTypes

public List<DataType> getFieldTypes()

getTypeAt

public DataType getTypeAt(int i)

getFieldCount

public int getFieldCount()

getFieldIndex

public int getFieldIndex(String fieldName)

getFieldIndices

public int[] getFieldIndices(List<String> projectFields)

containsField

public boolean containsField(String fieldName)

notContainsField

public boolean notContainsField(String fieldName)

getField

public DataField getField(String fieldName)

copy

public DataType copy(boolean isNullable)

Description copied from class: DataType

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

Specified by:

copy in class DataType

Parameters:

isNullable - the intended nullability of the copied type

Returns:

a deep copy

asSQLString

public String asSQLString()

Description copied from class: DataType

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

Specified by:

asSQLString in class DataType

serializeJson

public void serializeJson(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.core.JsonGenerator generator)
                   throws IOException

Overrides:

serializeJson in class DataType

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class DataType

hashCode

public int hashCode()

Overrides:

hashCode in class DataType

accept

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

Specified by:

accept in class DataType

collectFieldIds

public void collectFieldIds(Set<Integer> fieldIds)

Overrides:

collectFieldIds in class DataType

appendDataField

public RowType appendDataField(String name,
                               DataType type)

project

public RowType project(int[] mapping)

project

public RowType project(List<String> names)

of

public static RowType of(DataType... types)

of

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

currentHighestFieldId

public static int currentHighestFieldId(List<DataField> fields)

builder

public static RowType.Builder builder()

builder

public static RowType.Builder builder(boolean isNullable,
                                      AtomicInteger fieldId)

fieldGetters

public InternalRow.FieldGetter[] fieldGetters()