TableReadSessionBuilder (ODPS SDK Table API 0.48.7-public API)

java.lang.Object
- com.aliyun.odps.table.read.TableReadSessionBuilder

public class TableReadSessionBuilder
extends Object

An interface for building the TableReadSession.

Constructor Summary

Constructors
Constructor and Description

TableReadSessionBuilder()

Constructors
Constructor and Description
`TableReadSessionBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableBatchReadSession`	`buildBatchReadSession()` Returns a logical `TableBatchReadSession`.
`ArrowOptions`	`getArrowOptions()`
`Predicate`	`getFilterPredicate()`
`TableIdentifier`	`getIdentifier()`
`List<Integer>`	`getRequiredBucketIds()`
`List<String>`	`getRequiredDataColumns()`
`List<String>`	`getRequiredPartitionColumns()`
`List<PartitionSpec>`	`getRequiredPartitions()`
`String`	`getSessionId()`
`EnvironmentSettings`	`getSettings()`
`SplitOptions`	`getSplitOptions()`
`TableReadSessionBuilder`	`identifier(TableIdentifier identifier)` Set the read session target to a specific table by `TableIdentifier`.
`TableReadSessionBuilder`	`requiredBucketIds(List<Integer> requiredBucketIds)` Set read buckets for clustering table.
`TableReadSessionBuilder`	`requiredDataColumns(List<String> requiredDataColumns)` Set read schema by specifying top-level column names.
`TableReadSessionBuilder`	`requiredPartitionColumns(List<String> requiredPartitionColumns)` Set read schema by partition column names.
`TableReadSessionBuilder`	`requiredPartitions(List<PartitionSpec> requiredPartitions)` Specify input partitions by string.
`TableReadSessionBuilder`	`table(Table table)` Set the read session target to a specific table by `Table`.
`TableReadSessionBuilder`	`withArrowOptions(ArrowOptions arrowOptions)` Set the arrow options `ArrowOptions`.
`TableReadSessionBuilder`	`withFilterPredicate(Predicate filterPredicate)` predicate use to push down
`TableReadSessionBuilder`	`withSessionId(String sessionId)` Set the table read session id.
`TableReadSessionBuilder`	`withSessionProvider(String provider)` Set the table session provider
`TableReadSessionBuilder`	`withSettings(EnvironmentSettings settings)` Set the table environment settings `EnvironmentSettings`.
`TableReadSessionBuilder`	`withSplitOptions(SplitOptions splitOptions)` Set the split options `SplitOptions`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- TableReadSessionBuilder
```
public TableReadSessionBuilder()
```

Method Detail

table
```
public TableReadSessionBuilder table(Table table)
```
Set the read session target to a specific table by Table.

identifier

public TableReadSessionBuilder identifier(TableIdentifier identifier)

Set the read session target to a specific table by TableIdentifier.

requiredDataColumns
```
public TableReadSessionBuilder requiredDataColumns(List<String> requiredDataColumns)
```
Set read schema by specifying top-level column names. TODO: For nested column-pruning

requiredPartitionColumns

public TableReadSessionBuilder requiredPartitionColumns(List<String> requiredPartitionColumns)

Set read schema by partition column names.

requiredPartitions

public TableReadSessionBuilder requiredPartitions(List<PartitionSpec> requiredPartitions)

Specify input partitions by string. Part spec format: ds=1/pt=a.

requiredBucketIds

public TableReadSessionBuilder requiredBucketIds(List<Integer> requiredBucketIds)

Set read buckets for clustering table.

withSplitOptions

public TableReadSessionBuilder withSplitOptions(SplitOptions splitOptions)

Set the split options SplitOptions.

withArrowOptions

public TableReadSessionBuilder withArrowOptions(ArrowOptions arrowOptions)

Set the arrow options ArrowOptions.

withSettings

public TableReadSessionBuilder withSettings(EnvironmentSettings settings)

Set the table environment settings EnvironmentSettings.

withSessionId

public TableReadSessionBuilder withSessionId(String sessionId)

Set the table read session id.

withSessionProvider

public TableReadSessionBuilder withSessionProvider(String provider)

Set the table session provider

withFilterPredicate

public TableReadSessionBuilder withFilterPredicate(Predicate filterPredicate)

predicate use to push down

getSessionId
```
public String getSessionId()
```

getSplitOptions
```
public SplitOptions getSplitOptions()
```

getIdentifier

public TableIdentifier getIdentifier()

getRequiredBucketIds

public List<Integer> getRequiredBucketIds()

getRequiredDataColumns

public List<String> getRequiredDataColumns()

getArrowOptions
```
public ArrowOptions getArrowOptions()
```

getSettings

public EnvironmentSettings getSettings()

getRequiredPartitions

public List<PartitionSpec> getRequiredPartitions()

getRequiredPartitionColumns

public List<String> getRequiredPartitionColumns()

getFilterPredicate
```
public Predicate getFilterPredicate()
```

buildBatchReadSession

public TableBatchReadSession buildBatchReadSession()
                                            throws IOException

Returns a logical TableBatchReadSession.

Throws:: IOException

Class TableReadSessionBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableReadSessionBuilder