org.apache.paimon.schema

Class TableSchema

java.lang.Object

org.apache.paimon.schema.TableSchema

All Implemented Interfaces:

Serializable

public class TableSchema
extends Object
implements Serializable

Schema of a table. Unlike schema, it has more information than Schema, including schemaId and fieldId.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENT_VERSION
static int	PAIMON_07_VERSION
static int	PAIMON_08_VERSION

Constructor Summary

Constructors

Constructor and Description
TableSchema(int version, long id, List<DataField> fields, int highestFieldId, List<String> partitionKeys, List<String> primaryKeys, Map<String,String> options, String comment, long timeMillis)
TableSchema(long id, List<DataField> fields, int highestFieldId, List<String> partitionKeys, List<String> primaryKeys, Map<String,String> options, String comment)

Method Summary

Modifier and Type	Method and Description
List<String>	bucketKeys()
String	comment()
TableSchema	copy(Map<String,String> newOptions)
boolean	crossPartitionUpdate()
boolean	equals(Object o)
List<String>	fieldNames()
List<DataField>	fields()
static TableSchema	fromJson(String json)
static TableSchema	fromPath(FileIO fileIO, Path path)
int	hashCode()
int	highestFieldId()
long	id()
RowType	logicalBucketKeyType()
RowType	logicalPartitionType()
RowType	logicalPrimaryKeysType()
RowType	logicalRowType()
RowType	logicalTrimmedPrimaryKeysType()
static List<DataField>	newFields(RowType rowType)
int	numBuckets()
Map<String,String>	options()
List<String>	partitionKeys()
List<String>	primaryKeys()
List<DataField>	primaryKeysFields()
RowType	projectedLogicalRowType(List<String> projectedFieldNames)
int[]	projection(List<String> projectedFieldNames)
long	timeMillis()
String	toString()
List<String>	trimmedPrimaryKeys()
List<DataField>	trimmedPrimaryKeysFields()
int	version()

Methods inherited from class java.lang.Object

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

Field Detail

PAIMON_07_VERSION

public static final int PAIMON_07_VERSION

See Also:

Constant Field Values

PAIMON_08_VERSION

public static final int PAIMON_08_VERSION

See Also:

Constant Field Values

CURRENT_VERSION

public static final int CURRENT_VERSION

See Also:

Constant Field Values

Constructor Detail

TableSchema

public TableSchema(long id,
                   List<DataField> fields,
                   int highestFieldId,
                   List<String> partitionKeys,
                   List<String> primaryKeys,
                   Map<String,String> options,
                   @Nullable
                   String comment)

TableSchema

public TableSchema(int version,
                   long id,
                   List<DataField> fields,
                   int highestFieldId,
                   List<String> partitionKeys,
                   List<String> primaryKeys,
                   Map<String,String> options,
                   @Nullable
                   String comment,
                   long timeMillis)

Method Detail

version

public int version()

id

public long id()

fields

public List<DataField> fields()

fieldNames

public List<String> fieldNames()

highestFieldId

public int highestFieldId()

partitionKeys

public List<String> partitionKeys()

primaryKeys

public List<String> primaryKeys()

trimmedPrimaryKeys

public List<String> trimmedPrimaryKeys()

options

public Map<String,String> options()

numBuckets

public int numBuckets()

bucketKeys

public List<String> bucketKeys()

crossPartitionUpdate

public boolean crossPartitionUpdate()

comment

@Nullable
public String comment()

timeMillis

public long timeMillis()

logicalRowType

public RowType logicalRowType()

logicalPartitionType

public RowType logicalPartitionType()

logicalBucketKeyType

public RowType logicalBucketKeyType()

logicalTrimmedPrimaryKeysType

public RowType logicalTrimmedPrimaryKeysType()

logicalPrimaryKeysType

public RowType logicalPrimaryKeysType()

primaryKeysFields

public List<DataField> primaryKeysFields()

trimmedPrimaryKeysFields

public List<DataField> trimmedPrimaryKeysFields()

projection

public int[] projection(List<String> projectedFieldNames)

projectedLogicalRowType

public RowType projectedLogicalRowType(List<String> projectedFieldNames)

copy

public TableSchema copy(Map<String,String> newOptions)

fromJson

public static TableSchema fromJson(String json)

fromPath

public static TableSchema fromPath(FileIO fileIO,
                                   Path path)

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

newFields

public static List<DataField> newFields(RowType rowType)