TableWriteSessionBuilder (ODPS SDK Table API 0.48.7-public API)

java.lang.Object
- com.aliyun.odps.table.write.TableWriteSessionBuilder

public class TableWriteSessionBuilder
extends Object

An interface for building the TableWriteSession.

Constructor Summary

Constructors
Constructor and Description

TableWriteSessionBuilder()

Constructors
Constructor and Description
`TableWriteSessionBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableBatchWriteSession`	`buildBatchWriteSession()` Returns a logical `TableBatchWriteSession`.
`TableStreamingWriteSession`	`buildStreamingWriteSession()` Returns a logical `TableStreamingWriteSession`.
`TableUpsertSession`	`buildUpsertSession()` Returns a logical `TableUpsertSession`.
`ArrowOptions`	`getArrowOptions()`
`DynamicPartitionOptions`	`getDynamicPartitionOptions()`
`TableIdentifier`	`getIdentifier()`
`long`	`getMaxFieldSize()`
`String`	`getSessionId()`
`EnvironmentSettings`	`getSettings()`
`PartitionSpec`	`getTargetPartitionSpec()`
`TableWriteCapabilities`	`getWriteCapabilities()`
`TableWriteSessionBuilder`	`identifier(TableIdentifier identifier)` Set the write target to a specific table by `TableIdentifier`.
`boolean`	`isOverwrite()`
`TableWriteSessionBuilder`	`overwrite(boolean overwrite)` Configures a write to replace all existing data with data committed in the write.
`TableWriteSessionBuilder`	`partition(PartitionSpec partitionSpec)` Set the write target to a specific/dynamic partition by `PartitionSpec`.
`TableWriteSessionBuilder`	`table(Table table)` Set the write target to a specific table by `Table`.
`TableWriteSessionBuilder`	`withArrowOptions(ArrowOptions options)` Set the arrow options `ArrowOptions`.
`TableWriteSessionBuilder`	`withCapabilities(TableWriteCapabilities capabilities)` Set the table write capabilities
`TableWriteSessionBuilder`	`withDynamicPartitionOptions(DynamicPartitionOptions options)` Set the dynamic partition options `DynamicPartitionOptions`.
`TableWriteSessionBuilder`	`withMaxFieldSize(long maxFieldSize)` Specify the maximum data size allowed to be written for the varchar/char/string/binary type.
`TableWriteSessionBuilder`	`withSessionId(String sessionId)` Set the table write session id.
`TableWriteSessionBuilder`	`withSessionProvider(String provider)` Set the table write session provider.
`TableWriteSessionBuilder`	`withSettings(EnvironmentSettings settings)` Set the table environment settings `EnvironmentSettings`.

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

Constructor Detail
- TableWriteSessionBuilder
```
public TableWriteSessionBuilder()
```

Method Detail

table

public TableWriteSessionBuilder table(Table table)

Set the write target to a specific table by Table.

identifier

public TableWriteSessionBuilder identifier(TableIdentifier identifier)

Set the write target to a specific table by TableIdentifier.

partition

public TableWriteSessionBuilder partition(PartitionSpec partitionSpec)

Set the write target to a specific/dynamic partition by PartitionSpec.

overwrite
```
public TableWriteSessionBuilder overwrite(boolean overwrite)
```
Configures a write to replace all existing data with data committed in the write.

withDynamicPartitionOptions

public TableWriteSessionBuilder withDynamicPartitionOptions(DynamicPartitionOptions options)

Set the dynamic partition options DynamicPartitionOptions.

withArrowOptions

public TableWriteSessionBuilder withArrowOptions(ArrowOptions options)

Set the arrow options ArrowOptions.

withCapabilities

public TableWriteSessionBuilder withCapabilities(TableWriteCapabilities capabilities)

Set the table write capabilities

withSettings

public TableWriteSessionBuilder withSettings(EnvironmentSettings settings)

Set the table environment settings EnvironmentSettings.

withSessionId

public TableWriteSessionBuilder withSessionId(String sessionId)

Set the table write session id.

withSessionProvider

public TableWriteSessionBuilder withSessionProvider(String provider)

Set the table write session provider.

withMaxFieldSize
```
public TableWriteSessionBuilder withMaxFieldSize(long maxFieldSize)
```
Specify the maximum data size allowed to be written for the varchar/char/string/binary type. The unit is Byte, and the possible value range is 8-256MB. If not set, the default is 8MB.
note: this size cannot be larger than the project setting: [odps.sql.cfile2.field.maxsize]

buildBatchWriteSession

public TableBatchWriteSession buildBatchWriteSession()
                                              throws IOException

Returns a logical TableBatchWriteSession.

Throws:: IOException

buildStreamingWriteSession

public TableStreamingWriteSession buildStreamingWriteSession()
                                                      throws IOException

Returns a logical TableStreamingWriteSession.

Throws:: IOException

buildUpsertSession

public TableUpsertSession buildUpsertSession()
                                      throws IOException

Returns a logical TableUpsertSession.

Throws:: IOException

getIdentifier

public TableIdentifier getIdentifier()

getTargetPartitionSpec

public PartitionSpec getTargetPartitionSpec()

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

isOverwrite
```
public boolean isOverwrite()
```

getSettings

public EnvironmentSettings getSettings()

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

getDynamicPartitionOptions

public DynamicPartitionOptions getDynamicPartitionOptions()

getWriteCapabilities

public TableWriteCapabilities getWriteCapabilities()

getMaxFieldSize
```
public long getMaxFieldSize()
```

Class TableWriteSessionBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableWriteSessionBuilder