org.apache.carbondata.sdk.file

Class Schema

java.lang.Object

org.apache.carbondata.sdk.file.Schema

@InterfaceAudience.User
 @InterfaceStability.Unstable
public class Schema
extends Object

A schema used to write and read data files

Constructor Summary

Constructors

Constructor and Description
Schema(Field[] fields) construct a schema with fields
Schema(List<org.apache.carbondata.core.metadata.schema.table.column.ColumnSchema> columnSchemaList) construct a schema with List

Method Summary

Modifier and Type	Method and Description
Schema	asOriginOrder() Sort the schema order as original order
boolean	equals(Object obj)
String	getArrayElementTypeName(int ordinal) get array child element data type name by ordinal
String	getFieldDataTypeName(int ordinal) get field data type name by ordinal
String	getFieldName(int ordinal) get field name by ordinal
Field[]	getFields()
int	getFieldsLength() get fields length of schema
int	hashCode()
static Schema	parseJson(String json) Create a Schema using JSON string, for example: [ {"name":"string"}, {"age":"int"} ]

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

public Schema(Field[] fields)

construct a schema with fields

Parameters:

fields -

Schema

public Schema(List<org.apache.carbondata.core.metadata.schema.table.column.ColumnSchema> columnSchemaList)

construct a schema with List

Parameters:

columnSchemaList - column schema list

Method Detail

parseJson

public static Schema parseJson(String json)

Create a Schema using JSON string, for example: [ {"name":"string"}, {"age":"int"} ]

Parameters:

json - specified as string

Returns:

Schema

getFields

public Field[] getFields()

getFieldsLength

public int getFieldsLength()

get fields length of schema

Returns:

fields length

getFieldName

public String getFieldName(int ordinal)

get field name by ordinal

Parameters:

ordinal - the data index of carbon schema

Returns:

ordinal field name

getFieldDataTypeName

public String getFieldDataTypeName(int ordinal)

get field data type name by ordinal

Parameters:

ordinal - the data index of carbon schema

Returns:

ordinal field data type name

getArrayElementTypeName

public String getArrayElementTypeName(int ordinal)

get array child element data type name by ordinal

Parameters:

ordinal - the data index of carbon schema

Returns:

ordinal array child element data type name

asOriginOrder

public Schema asOriginOrder()

Sort the schema order as original order

Returns:

Schema object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object