org.apache.hudi.internal.schema

Class InternalSchema

java.lang.Object

org.apache.hudi.internal.schema.InternalSchema

All Implemented Interfaces:

Serializable

public class InternalSchema
extends Object
implements Serializable

Internal schema for hudi table. used to support schema evolution.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARRAY_ELEMENT
static String	MAP_KEY
static String	MAP_VALUE

Constructor Summary

Constructors

Constructor and Description
InternalSchema(long versionId, int maxColumnId, Types.RecordType recordType)
InternalSchema(long versionId, Types.RecordType recordType)
InternalSchema(Types.RecordType recordType)

Method Summary

Modifier and Type	Method and Description
List<Types.Field>	columns() Returns a List of the columns in this Schema.
boolean	equals(Object o)
Types.Field	findField(int id) Returns the sub-field identified by the field id.
Types.Field	findField(String name) Returns a sub-field by name as a Types.Field.
String	findFullName(int id) Returns the fully qualified name of the field corresponding to the given id.
int	findIdByName(String name)
Type	findType(int id) Returns the Type of a sub-field identified by the field id.
Type	findType(String name) Returns the Type of a sub-field identified by the field name.
List<String>	getAllColsFullName() Get all columns full name.
Set<Integer>	getAllIds() Returns all field ids
static InternalSchema	getEmptyInternalSchema()
int	getMaxColumnId() Returns the max column id for this schema.
Map<String,Integer>	getNameToPosition() Returns the full name of the field and its position in the schema.
Types.RecordType	getRecord()
boolean	hasColumn(String colName, boolean caseSensitive) Whether colName exists in the current Schema
int	hashCode()
boolean	isEmptySchema()
long	schemaId() Returns the version ID for this schema.
void	setMaxColumnId(int maxColumnId) Set the version ID for this schema.
InternalSchema	setSchemaId(long versionId) Set the version ID for this schema.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ARRAY_ELEMENT

public static final String ARRAY_ELEMENT

See Also:

Constant Field Values

MAP_KEY

public static final String MAP_KEY

See Also:

Constant Field Values

MAP_VALUE

public static final String MAP_VALUE

See Also:

Constant Field Values

Constructor Detail

InternalSchema

public InternalSchema(Types.RecordType recordType)

InternalSchema

public InternalSchema(long versionId,
                      int maxColumnId,
                      Types.RecordType recordType)

InternalSchema

public InternalSchema(long versionId,
                      Types.RecordType recordType)

Method Detail

getEmptyInternalSchema

public static InternalSchema getEmptyInternalSchema()

isEmptySchema

public boolean isEmptySchema()

getRecord

public Types.RecordType getRecord()

getAllColsFullName

public List<String> getAllColsFullName()

Get all columns full name.

setSchemaId

public InternalSchema setSchemaId(long versionId)

Set the version ID for this schema.

schemaId

public long schemaId()

Returns the version ID for this schema.

setMaxColumnId

public void setMaxColumnId(int maxColumnId)

Set the version ID for this schema.

getMaxColumnId

public int getMaxColumnId()

Returns the max column id for this schema.

columns

public List<Types.Field> columns()

Returns a List of the columns in this Schema.

findFullName

public String findFullName(int id)

Returns the fully qualified name of the field corresponding to the given id.

Parameters:

id - a field id

Returns:

full name of field corresponding to id

findType

public Type findType(String name)

Returns the Type of a sub-field identified by the field name.

Parameters:

name - a field name

Returns:

a Type for the sub-field or null if it is not found

findType

public Type findType(int id)

Returns the Type of a sub-field identified by the field id.

Parameters:

id - a field id

Returns:

a Type for the sub-field or null if it is not found

getAllIds

public Set<Integer> getAllIds()

Returns all field ids

findField

public Types.Field findField(int id)

Returns the sub-field identified by the field id.

Parameters:

id - a field id

Returns:

the sub-field or null if it is not found

findField

public Types.Field findField(String name)

Returns a sub-field by name as a Types.Field. The result may be a top-level or a nested field.

Parameters:

name - a String name

Returns:

a Type for the sub-field or null if it is not found

hasColumn

public boolean hasColumn(String colName,
                         boolean caseSensitive)

Whether colName exists in the current Schema

Parameters:

colName - a column name

caseSensitive - whether columns names should be treated as case-sensitive

Returns:

whether schema contains column identified by colName

findIdByName

public int findIdByName(String name)

getNameToPosition

public Map<String,Integer> getNameToPosition()

Returns the full name of the field and its position in the schema. This differs from its ID in cases where new fields are not appended to the end of schemas. The output is used when reconciling the order of fields while ingesting.

Returns:

a mapping from full field name to a position

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