com.aliyun.odps.storage.write

Class TableWriteSessionBuilder

java.lang.Object

com.aliyun.odps.storage.write.TableWriteSessionBuilder

public class TableWriteSessionBuilder
extends Object

This builder allows configuration of various write session settings including:

• Partition specifications for writing data to specific partitions
• Overwrite mode for replacing existing data
• Write mode (Batch or Streaming)

Example usage:

 TableIdentifier tableId = TableIdentifier.of("my_project", "my_table");
 TableWriteSessionBuilder builder = client.createWriteSessionBuilder(tableId)
     .withPartition(new PartitionSpec("pt='20250101'"))
     .withOverwrite(true);
 TableWriteSession session = builder.build();
 

Streaming mode example:

 TableIdentifier tableId = TableIdentifier.of("my_project", "my_table");
 TableWriteSessionBuilder builder = client.createWriteSessionBuilder(tableId)
     .withWriteMode(WriteMode.STREAMING);
 TableWriteSession session = builder.build();
 

Constructor Summary

Constructors

Constructor and Description
TableWriteSessionBuilder(StorageStub storageStub, org.apache.arrow.memory.BufferAllocator allocator, TableIdentifier table) Constructs a new TableWriteSessionBuilder with the provided parameters.

Method Summary

Modifier and Type	Method and Description
TableWriteSession	build() Builds and returns a new TableWriteSession instance with the configured settings.
TableWriteSessionBuilder	withOverwrite(boolean overwrite) Sets whether to overwrite existing data when writing to the table.
TableWriteSessionBuilder	withPartition(PartitionSpec partitionSpec) Sets the partition specification for writing data to a specific partition.
TableWriteSessionBuilder	withSessionId(String sessionId) Set the sessionId to reload write session.
TableWriteSessionBuilder	withWriteMode(WriteMode writeMode) Sets the write mode for the session.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableWriteSessionBuilder

public TableWriteSessionBuilder(StorageStub storageStub,
                                org.apache.arrow.memory.BufferAllocator allocator,
                                TableIdentifier table)

Constructs a new TableWriteSessionBuilder with the provided parameters.

Parameters:

storageStub - The storage stub for communicating with the MaxCompute service

allocator - The buffer allocator for Arrow memory management

table - The identifier of the table to write to

Throws:

IllegalArgumentException - if table is null

Method Detail

withSessionId

public TableWriteSessionBuilder withSessionId(String sessionId)

Set the sessionId to reload write session.

Parameters:

sessionId - The session id of write session already created.

Returns:

This builder instance for method chaining

withPartition

public TableWriteSessionBuilder withPartition(PartitionSpec partitionSpec)

Sets the partition specification for writing data to a specific partition.

This allows writing data to a specific partition value, which is useful for partitioned tables.

Parameters:

partitionSpec - The partition specification to write to

Returns:

This builder instance for method chaining

withOverwrite

public TableWriteSessionBuilder withOverwrite(boolean overwrite)

Sets whether to overwrite existing data when writing to the table.

When overwrite is enabled, existing data in the table or specified partitions will be replaced with the new data being written.

Parameters:

overwrite - Whether to overwrite existing data

Returns:

This builder instance for method chaining

withWriteMode

public TableWriteSessionBuilder withWriteMode(WriteMode writeMode)

Sets the write mode for the session.

In BATCH mode (default), data becomes visible only after the session is committed. In STREAMING mode, data becomes visible immediately after flush, without requiring explicit commit. Streaming mode uses a default session ID and does not require explicit session creation.

Parameters:

writeMode - The write mode to use (BATCH or STREAMING)

Returns:

This builder instance for method chaining

build

public TableWriteSession build()

Builds and returns a new TableWriteSession instance with the configured settings.

For BATCH mode, this method makes an API call to the MaxCompute service to create a write session with the specified configuration.

For STREAMING mode, no session creation API call is made. The session uses a default session ID ("default") and data becomes visible immediately after flush.

Returns:

A new TableWriteSession instance