Skip navigation links
A B C E F G H I J L O P R S T U V W 

A

asOriginOrder() - Method in class org.apache.carbondata.sdk.file.Schema
Sort the schema order as original order
AvroCarbonWriter - Class in org.apache.carbondata.sdk.file
Writer Implementation to write Avro Record to carbondata file.

B

build() - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Build CarbonReader
build() - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
Build a CarbonWriter This writer is not thread safe, use withThreadSafe() configuration in multi thread environment
builder(String, String) - Static method in class org.apache.carbondata.sdk.file.CarbonReader
Return a new CarbonReaderBuilder instance
builder(String) - Static method in class org.apache.carbondata.sdk.file.CarbonReader
Return a new CarbonReaderBuilder instance Default value of table name is table + tablePath + time
builder() - Static method in class org.apache.carbondata.sdk.file.CarbonWriter
Create a CarbonWriterBuilder to build a CarbonWriter
buildLoadModel(Schema) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
 

C

CarbonReader<T> - Class in org.apache.carbondata.sdk.file
Reader for CarbonData file
CarbonReaderBuilder - Class in org.apache.carbondata.sdk.file
 
CarbonRowReadSupport - Class in org.apache.carbondata.store
ReadSupport that convert row object to CarbonRow
CarbonRowReadSupport() - Constructor for class org.apache.carbondata.store.CarbonRowReadSupport
 
CarbonSchemaReader - Class in org.apache.carbondata.sdk.file
Schema reader for carbon files, including carbondata file, carbonindex file, and schema file
CarbonSchemaReader() - Constructor for class org.apache.carbondata.sdk.file.CarbonSchemaReader
 
CarbonStore - Interface in org.apache.carbondata.store
User can use CarbonStore to query data
CarbonWriter - Class in org.apache.carbondata.sdk.file
Writer to write row data to carbondata file.
CarbonWriter() - Constructor for class org.apache.carbondata.sdk.file.CarbonWriter
 
CarbonWriterBuilder - Class in org.apache.carbondata.sdk.file
Builder for CarbonWriter
CarbonWriterBuilder() - Constructor for class org.apache.carbondata.sdk.file.CarbonWriterBuilder
 
cleanMdtFile() - Static method in class org.apache.carbondata.sdk.file.TestUtil
verify whether the file exists if delete the file success or file not exists, then return true; otherwise return false
close() - Method in class org.apache.carbondata.sdk.file.AvroCarbonWriter
Flush and close the writer
close() - Method in class org.apache.carbondata.sdk.file.CarbonReader
Close reader
close() - Method in class org.apache.carbondata.sdk.file.CarbonWriter
Flush and close the writer
close() - Method in class org.apache.carbondata.sdk.file.JsonCarbonWriter
Flush and close the writer
close() - Method in class org.apache.carbondata.store.CarbonRowReadSupport
 
configuration - Static variable in class org.apache.carbondata.sdk.file.TestUtil
 

E

enableLocalDictionary(boolean) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
 
equals(Object) - Method in class org.apache.carbondata.sdk.file.Field
 
equals(Object) - Method in class org.apache.carbondata.sdk.file.Schema
 

F

Field - Class in org.apache.carbondata.sdk.file
A field represent one column
Field(String, String) - Constructor for class org.apache.carbondata.sdk.file.Field
Field Constructor
Field(String, String, List<StructField>) - Constructor for class org.apache.carbondata.sdk.file.Field
 
Field(String, DataType, List<StructField>) - Constructor for class org.apache.carbondata.sdk.file.Field
 
Field(String, DataType) - Constructor for class org.apache.carbondata.sdk.file.Field
 
Field(ColumnSchema) - Constructor for class org.apache.carbondata.sdk.file.Field
Construct Field from ColumnSchema
filter(Expression) - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Configure the filter expression for carbon reader

G

getArray(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get array data type data by ordinal
getArrayElementTypeName(int) - Method in class org.apache.carbondata.sdk.file.Schema
get array child element data type name by ordinal
getBoolean(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get boolean data type data by ordinal
getByte(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get byte data type data by ordinal
getCarbonSchemaFromAvroSchema(Schema) - Static method in class org.apache.carbondata.sdk.file.AvroCarbonWriter
converts avro schema to carbon schema required by carbonWriter
getChildren() - Method in class org.apache.carbondata.sdk.file.Field
 
getColumnComment() - Method in class org.apache.carbondata.sdk.file.Field
 
getDataType() - Method in class org.apache.carbondata.sdk.file.Field
 
getDecimal(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get decimal data type data by ordinal This is for C++ SDK JNI don't support Decimal, so carbon convert decimal to string
getDouble(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get double data type data by ordinal
getFieldDataTypeName(int) - Method in class org.apache.carbondata.sdk.file.Schema
get field data type name by ordinal
getFieldName() - Method in class org.apache.carbondata.sdk.file.Field
 
getFieldName(int) - Method in class org.apache.carbondata.sdk.file.Schema
get field name by ordinal
getFields() - Method in class org.apache.carbondata.sdk.file.Schema
 
getFieldsLength() - Method in class org.apache.carbondata.sdk.file.Schema
get fields length of schema
getFloat(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get float data type data by ordinal
getInt(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get int data type data by ordinal
getLong(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get long data type data by ordinal
getParent() - Method in class org.apache.carbondata.sdk.file.Field
 
getPrecision() - Method in class org.apache.carbondata.sdk.file.Field
 
getRawSchema() - Method in class org.apache.carbondata.sdk.file.Field
 
getScale() - Method in class org.apache.carbondata.sdk.file.Field
 
getSchemaOrdinal() - Method in class org.apache.carbondata.sdk.file.Field
 
getShort(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get short type data by ordinal
getStoreType() - Method in class org.apache.carbondata.sdk.file.Field
 
getString(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
 
getVarchar(Object[], int) - Static method in class org.apache.carbondata.sdk.file.RowUtil
get varchar data type data by ordinal This is for C++ SDK JNI don't support varchar, so carbon convert decimal to string
getVersionDetails(String) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
This method return the version details in formatted string by reading from carbondata file

H

hashCode() - Method in class org.apache.carbondata.sdk.file.Field
 
hashCode() - Method in class org.apache.carbondata.sdk.file.Schema
 
hasNext() - Method in class org.apache.carbondata.sdk.file.CarbonReader
Return true if has next row

I

initialize(CarbonColumn[], CarbonTable) - Method in class org.apache.carbondata.store.CarbonRowReadSupport
 
invertedIndexFor(String[]) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
sets the list of columns for which inverted index needs to generated

J

JsonCarbonWriter - Class in org.apache.carbondata.sdk.file
Writer Implementation to write Json Record to carbondata file.
jsonToAvro(String, String) - Static method in class org.apache.carbondata.sdk.file.TestUtil
 

L

localDictionaryThreshold(int) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
 

O

org.apache.carbondata.sdk.file - package org.apache.carbondata.sdk.file
 
org.apache.carbondata.store - package org.apache.carbondata.store
 
outputPath(String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
Sets the output path of the writer builder

P

parseJson(String) - Static method in class org.apache.carbondata.sdk.file.Schema
Create a Schema using JSON string, for example: [ {"name":"string"}, {"age":"int"} ]
projection(String[]) - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Configure the projection column names of carbon reader

R

readNextBatchRow() - Method in class org.apache.carbondata.sdk.file.CarbonReader
Read and return next batch row objects
readNextRow() - Method in class org.apache.carbondata.sdk.file.CarbonReader
Read and return next row object
readRow(Object[]) - Method in class org.apache.carbondata.store.CarbonRowReadSupport
 
readSchema(String) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
read schema from path, path can be folder path, carbonindex file path, and carbondata file path and will not check all files schema
readSchema(String, Configuration) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
read schema from path, path can be folder path, carbonindex file path, and carbondata file path and will not check all files schema
readSchema(String, boolean, Configuration) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
read schema from path, path can be folder path, carbonindex file path, and carbondata file path and user can decide whether check all files schema
readSchema(String, boolean) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
read schema from path, path can be folder path, carbonindex file path, and carbondata file path and user can decide whether check all files schema
readSchemaInDataFile(String) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
Deprecated.
readSchemaInIndexFile(String) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
Deprecated.
readSchemaInSchemaFile(String) - Static method in class org.apache.carbondata.sdk.file.CarbonSchemaReader
Deprecated.
RowUtil - Class in org.apache.carbondata.sdk.file
This row class is used to transfer the row data from one step to other step
RowUtil() - Constructor for class org.apache.carbondata.sdk.file.RowUtil
 

S

scan(AbsoluteTableIdentifier, String[]) - Method in interface org.apache.carbondata.store.CarbonStore
Scan query on the data in the table path
scan(AbsoluteTableIdentifier, String[], Expression) - Method in interface org.apache.carbondata.store.CarbonStore
Scan query with filter, on the data in the table path
Schema - Class in org.apache.carbondata.sdk.file
A schema used to write and read data files
Schema(Field[]) - Constructor for class org.apache.carbondata.sdk.file.Schema
construct a schema with fields
Schema(List<ColumnSchema>) - Constructor for class org.apache.carbondata.sdk.file.Schema
construct a schema with List
setChildren(List<StructField>) - Method in class org.apache.carbondata.sdk.file.Field
 
setColumnComment(String) - Method in class org.apache.carbondata.sdk.file.Field
 
setParent(String) - Method in class org.apache.carbondata.sdk.file.Field
 
setPrecision(int) - Method in class org.apache.carbondata.sdk.file.Field
 
setRawSchema(String) - Method in class org.apache.carbondata.sdk.file.Field
 
setScale(int) - Method in class org.apache.carbondata.sdk.file.Field
 
setSchemaOrdinal(int) - Method in class org.apache.carbondata.sdk.file.Field
 
sortBy(String[]) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
sets the list of columns that needs to be in sorted order
split(int) - Method in class org.apache.carbondata.sdk.file.CarbonReader
Breaks the list of CarbonRecordReader in CarbonReader into multiple CarbonReader objects, each iterating through some 'carbondata' files and return that list of CarbonReader objects If the no.
sql(String) - Method in interface org.apache.carbondata.store.CarbonStore
SQL query, table should be created before calling this function

T

taskNo(long) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
sets the taskNo for the writer.
TestUtil - Class in org.apache.carbondata.sdk.file
 
TestUtil() - Constructor for class org.apache.carbondata.sdk.file.TestUtil
 
toString() - Method in class org.apache.carbondata.sdk.file.Field
 

U

uniqueIdentifier(long) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
to set the timestamp in the carbondata and carbonindex index files
updateDataTypeToVarchar() - Method in class org.apache.carbondata.sdk.file.Field
 

V

verifyMdtFile() - Static method in class org.apache.carbondata.sdk.file.TestUtil
verify whether the mdt file exists if the file exists, then return true; otherwise return false

W

withAvroInput(Schema) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
to build a CarbonWriter, which accepts Avro object
withBatch(int) - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Sets the batch size of records to read
withBlockletSize(int) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To set the blocklet size of CarbonData file
withBlockSize(int) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To set the carbondata file size in MB between 1MB-2048MB
withCsvInput(Schema) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
to build a CarbonWriter, which accepts row in CSV format
withCsvInput(String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
to build a CarbonWriter, which accepts row in CSV format
withHadoopConf(Configuration) - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
To support hadoop configuration
withHadoopConf(String, String) - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Updates the hadoop configuration with the given key value
withHadoopConf(Configuration) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To support hadoop configuration
withHadoopConf(String, String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
Updates the hadoop configuration with the given key value
withJsonInput(Schema) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
to build a CarbonWriter, which accepts Json object
withLoadOption(String, String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To support the load options for sdk writer
withLoadOptions(Map<String, String>) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To support the load options for sdk writer
withRowRecordReader() - Method in class org.apache.carbondata.sdk.file.CarbonReaderBuilder
Configure Row Record Reader for reading.
withTableProperties(Map<String, String>) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To support the table properties for sdk writer
withTableProperty(String, String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To support the table properties for sdk writer
withThreadSafe(short) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
To make sdk writer thread safe.
write(Object) - Method in class org.apache.carbondata.sdk.file.AvroCarbonWriter
Write single row data, input row is Avro Record
write(Object) - Method in class org.apache.carbondata.sdk.file.CarbonWriter
Write an object to the file, the format of the object depends on the implementation.
write(Object) - Method in class org.apache.carbondata.sdk.file.JsonCarbonWriter
Write single row data, accepts one row of data as json string
writeFilesAndVerify(Schema, String) - Static method in class org.apache.carbondata.sdk.file.TestUtil
 
writeFilesAndVerify(int, Schema, String) - Static method in class org.apache.carbondata.sdk.file.TestUtil
write file and verify
writeFilesAndVerify(int, Schema, String, String[], int, int) - Static method in class org.apache.carbondata.sdk.file.TestUtil
Invoke CarbonWriter API to write carbon files and assert the file is rewritten
writtenBy(String) - Method in class org.apache.carbondata.sdk.file.CarbonWriterBuilder
 
A B C E F G H I J L O P R S T U V W 
Skip navigation links

Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.