org.apache.carbondata.sdk.file

Class CarbonReaderBuilder

java.lang.Object

org.apache.carbondata.sdk.file.CarbonReaderBuilder

@InterfaceAudience.User
 @InterfaceStability.Evolving
public class CarbonReaderBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
<T> CarbonReader<T>	build() Build CarbonReader
CarbonReaderBuilder	filter(org.apache.carbondata.core.scan.expression.Expression filterExpression) Configure the filter expression for carbon reader
CarbonReaderBuilder	projection(String[] projectionColumnNames) Configure the projection column names of carbon reader
CarbonReaderBuilder	withBatch(int batch) Sets the batch size of records to read
CarbonReaderBuilder	withHadoopConf(org.apache.hadoop.conf.Configuration conf) To support hadoop configuration
CarbonReaderBuilder	withHadoopConf(String key, String value) Updates the hadoop configuration with the given key value
CarbonReaderBuilder	withRowRecordReader() Configure Row Record Reader for reading.

Methods inherited from class java.lang.Object

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

Method Detail

projection

public CarbonReaderBuilder projection(String[] projectionColumnNames)

Configure the projection column names of carbon reader

Parameters:

projectionColumnNames - projection column names

Returns:

CarbonReaderBuilder object

filter

public CarbonReaderBuilder filter(org.apache.carbondata.core.scan.expression.Expression filterExpression)

Configure the filter expression for carbon reader

Parameters:

filterExpression - filter expression

Returns:

CarbonReaderBuilder object

withHadoopConf

public CarbonReaderBuilder withHadoopConf(org.apache.hadoop.conf.Configuration conf)

To support hadoop configuration

Parameters:

conf - hadoop configuration support, can set s3a AK,SK,end point and other conf with this

Returns:

updated CarbonReaderBuilder

withBatch

public CarbonReaderBuilder withBatch(int batch)

Sets the batch size of records to read

Parameters:

batch - batch size

Returns:

updated CarbonReaderBuilder

withHadoopConf

public CarbonReaderBuilder withHadoopConf(String key,
                                          String value)

Updates the hadoop configuration with the given key value

Parameters:

key - key word

value - value

Returns:

this object

withRowRecordReader

public CarbonReaderBuilder withRowRecordReader()

Configure Row Record Reader for reading.

build

public <T> CarbonReader<T> build()
                          throws IOException,
                                 InterruptedException

Build CarbonReader

Type Parameters:

T -

Returns:

CarbonReader

Throws:

IOException

InterruptedException