com.aliyun.odps.table.write

Interface TableBatchWriteSession

All Superinterfaces:

Serializable, Session, TableWriteSession

All Known Implementing Classes:

TableBatchWriteSessionBase, TableBatchWriteSessionImpl

public interface TableBatchWriteSession
extends TableWriteSession

An interface that defines how to write the data to odps for batch processing.

Nested Class Summary

Nested classes/interfaces inherited from interface com.aliyun.odps.table.Session

Session.Provider

Method Summary

Modifier and Type	Method and Description
void	cleanup() Clean up this writing job because some data writers are failed and keep failing when retry,
void	commit(WriterCommitMessage[] messages) Commits this writing job with a list of commit messages.
default BatchWriter<org.apache.arrow.vector.VectorSchemaRoot>	createArrowWriter(long blockNumber, WriterAttemptId attemptId, WriterOptions options) Returns a arrow data writer to do the actual writing work.
default BatchWriter<ArrayRecord>	createRecordWriter(long blockNumber, WriterAttemptId attemptId, WriterOptions options) Returns a record data writer to do the actual writing work.
default SessionType	getType() Returns the type for table session.

Methods inherited from interface com.aliyun.odps.table.write.TableWriteSession

maxBlockNumber, requiredDistribution, requiredOrdering, requiredSchema, supportsDataFormat

Methods inherited from interface com.aliyun.odps.table.Session

description, getId, getStatus, getTableIdentifier

Method Detail

commit

void commit(WriterCommitMessage[] messages)
     throws IOException

Commits this writing job with a list of commit messages. The commit messages are collected from successful data writers and are produced by BatchWriter.commit(). TODO: commit with settings

Throws:

IOException

cleanup

void cleanup()

Clean up this writing job because some data writers are failed and keep failing when retry,

createRecordWriter

default BatchWriter<ArrayRecord> createRecordWriter(long blockNumber,
                                                    WriterAttemptId attemptId,
                                                    WriterOptions options)
                                             throws IOException

Returns a record data writer to do the actual writing work. Within the same table sink, no two writer will share the same writer id).

Throws:

IOException

createArrowWriter

default BatchWriter<org.apache.arrow.vector.VectorSchemaRoot> createArrowWriter(long blockNumber,
                                                                                WriterAttemptId attemptId,
                                                                                WriterOptions options)
                                                                         throws IOException

Returns a arrow data writer to do the actual writing work. Within the same table sink, no two writer will share the same writer id).

Throws:

IOException

getType

default SessionType getType()

Description copied from interface: Session

Returns the type for table session.

Specified by:

getType in interface Session