org.apache.carbondata.sdk.file

Class CarbonReader<T>

java.lang.Object

org.apache.carbondata.sdk.file.CarbonReader<T>

@InterfaceAudience.User
 @InterfaceStability.Evolving
public class CarbonReader<T>
extends Object

Reader for CarbonData file

Method Summary

Modifier and Type	Method and Description
static CarbonReaderBuilder	builder(String tablePath) Return a new CarbonReaderBuilder instance Default value of table name is table + tablePath + time
static CarbonReaderBuilder	builder(String tablePath, String tableName) Return a new CarbonReaderBuilder instance
void	close() Close reader
boolean	hasNext() Return true if has next row
Object[]	readNextBatchRow() Read and return next batch row objects
T	readNextRow() Read and return next row object
List<CarbonReader>	split(int maxSplits) 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.

Methods inherited from class java.lang.Object

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

Method Detail

hasNext

public boolean hasNext()
                throws IOException,
                       InterruptedException

Return true if has next row

Throws:

IOException

InterruptedException

readNextRow

public T readNextRow()
              throws IOException,
                     InterruptedException

Read and return next row object

Throws:

IOException

InterruptedException

readNextBatchRow

public Object[] readNextBatchRow()
                          throws Exception

Read and return next batch row objects

Throws:

Exception

builder

public static CarbonReaderBuilder builder(String tablePath,
                                          String tableName)

Return a new CarbonReaderBuilder instance

Parameters:

tablePath - table store path

tableName - table name

Returns:

CarbonReaderBuilder object

builder

public static CarbonReaderBuilder builder(String tablePath)

Return a new CarbonReaderBuilder instance Default value of table name is table + tablePath + time

Parameters:

tablePath - table path

Returns:

CarbonReaderBuilder object

split

public List<CarbonReader> split(int maxSplits)
                         throws IOException

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. of files is greater than maxSplits, then break the CarbonReader into maxSplits splits, with each split iterating through >= 1 file. If the no. of files is less than maxSplits, then return list of CarbonReader with size as the no. of files, with each CarbonReader iterating through exactly one file

Parameters:

maxSplits: - Int

Returns:

list of CarbonReader objects

Throws:

IOException

close

public void close()
           throws IOException

Close reader

Throws:

IOException