com.alicloud.openservices.tablestore

类 DefaultTableStoreWriter

java.lang.Object

com.alicloud.openservices.tablestore.DefaultTableStoreWriter

所有已实现的接口:

TableStoreWriter

public class DefaultTableStoreWriter
extends Object
implements TableStoreWriter

构造器概要

构造器

构造器和说明
DefaultTableStoreWriter(AsyncClientInterface ots, String tableName, WriterConfig config, TableStoreCallback<RowChange,ConsumedCapacity> callback, Executor executor)
DefaultTableStoreWriter(String endpoint, ServiceCredentials credentials, String instanceName, String tableName, WriterConfig config, ClientConfiguration cc, TableStoreCallback<RowChange,RowWriteResult> resultCallback)
DefaultTableStoreWriter(String endpoint, ServiceCredentials credentials, String instanceName, String tableName, WriterConfig config, TableStoreCallback<RowChange,RowWriteResult> resultCallback)

方法概要

限定符和类型	方法和说明
void	addRowChange(List<RowChange> rowChanges, List<RowChange> dirtyRows) Batch write rows to the local buffer.
void	addRowChange(RowChange rowChange) Add a row of data to the local buffer.
Future<WriterResult>	addRowChangeWithFuture(List<RowChange> rowChanges) Batch write rows to the local buffer.
Future<WriterResult>	addRowChangeWithFuture(RowChange rowChange) The interface function is the same as TableStoreWriter.addRowChange(com.alicloud.openservices.tablestore.model.RowChange), but it will return a Future of the write result, indicating the success or failure status of writing this row.
void	close() Closes the TableStoreWriter.
void	flush() Actively flush the data in the buffer.
TableStoreCallback<RowChange,ConsumedCapacity>	getCallback()
TableStoreCallback<RowChange,RowWriteResult>	getResultCallback() Get the set Callback.
WriterConfig	getWriterConfig() Get the configuration of the limit item.
WriterStatistics	getWriterStatistics() Get the statistical information during data import.
void	setCallback(TableStoreCallback<RowChange,ConsumedCapacity> callback)
void	setResultCallback(TableStoreCallback<RowChange,RowWriteResult> resultCallback) Set Callback, which will provide feedback when data writing succeeds or fails.
void	startFlushTimer(int flushInterval)
boolean	tryAddRowChange(RowChange rowChange) Same with TableStoreWriter.addRowChange(RowChange), but it won't be blocked if the buffer is full.

从类继承的方法 java.lang.Object

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

构造器详细资料

DefaultTableStoreWriter

public DefaultTableStoreWriter(AsyncClientInterface ots,
                               String tableName,
                               WriterConfig config,
                               TableStoreCallback<RowChange,ConsumedCapacity> callback,
                               Executor executor)

DefaultTableStoreWriter

public DefaultTableStoreWriter(String endpoint,
                               ServiceCredentials credentials,
                               String instanceName,
                               String tableName,
                               WriterConfig config,
                               TableStoreCallback<RowChange,RowWriteResult> resultCallback)

DefaultTableStoreWriter

public DefaultTableStoreWriter(String endpoint,
                               ServiceCredentials credentials,
                               String instanceName,
                               String tableName,
                               WriterConfig config,
                               ClientConfiguration cc,
                               TableStoreCallback<RowChange,RowWriteResult> resultCallback)

方法详细资料

addRowChange

public void addRowChange(RowChange rowChange)

从接口复制的说明: TableStoreWriter

Add a row of data to the local buffer. Before writing to the buffer, the following checks are performed on the row data: - Whether the schema of the primary key of this row matches the table definition. - Whether the size of the values in the primary key columns or attribute columns exceeds the limit; the value limits are configured in WriterConfig.maxPKColumnSize and WriterConfig.maxAttrColumnSize. - Whether the number of attribute columns in this row exceeds WriterConfig.maxColumnsCount. - Whether the size of this row exceeds WriterConfig.maxBatchSize. - Whether there are any column names in the attribute columns that are the same as those in the primary key columns. If the data is determined to be dirty before being written to the buffer, this portion of the data will not trigger a CallBack invocation. These checks introduce additional CPU consumption on the SDK side, but they are necessary to reduce unnecessary RPC overhead and prevent dirty data from contaminating rows in the same batch write operation. Note: If the buffer is full, this operation will be blocked. If the row is judged to be dirty data, this interface will throw a ClientException.

指定者:

addRowChange 在接口中 TableStoreWriter

参数:

rowChange - The row to be written

addRowChangeWithFuture

public Future<WriterResult> addRowChangeWithFuture(RowChange rowChange)

从接口复制的说明: TableStoreWriter

The interface function is the same as TableStoreWriter.addRowChange(com.alicloud.openservices.tablestore.model.RowChange), but it will return a Future of the write result, indicating the success or failure status of writing this row.

指定者:

addRowChangeWithFuture 在接口中 TableStoreWriter

参数:

rowChange - The row to be written.

tryAddRowChange

public boolean tryAddRowChange(RowChange rowChange)

从接口复制的说明: TableStoreWriter

Same with TableStoreWriter.addRowChange(RowChange), but it won't be blocked if the buffer is full.

指定者:

tryAddRowChange 在接口中 TableStoreWriter

返回:

true if add succeed, return false if the buffer is full.

startFlushTimer

public void startFlushTimer(int flushInterval)

addRowChange

public void addRowChange(List<RowChange> rowChanges,
                         List<RowChange> dirtyRows)
                  throws ClientException

从接口复制的说明: TableStoreWriter

Batch write rows to the local buffer. Each row in the batch write will undergo the same checks as TableStoreWriter.addRowChange(RowChange). If there is any dirty data in the rows being written in the batch, this function will throw a ClientException, and all dirty data will be written to dirtyRows.

指定者:

addRowChange 在接口中 TableStoreWriter

参数:

rowChanges - Rows for batch writing

dirtyRows - List used to return the dirty data

抛出:

ClientException - if there is any dirty data

addRowChangeWithFuture

public Future<WriterResult> addRowChangeWithFuture(List<RowChange> rowChanges)
                                            throws ClientException

从接口复制的说明: TableStoreWriter

Batch write rows to the local buffer. Each row in the batch write will undergo the same checks as TableStoreWriter.addRowChange(RowChange); dirty data will be directly updated in the WriterResponse statistics.

指定者:

addRowChangeWithFuture 在接口中 TableStoreWriter

参数:

rowChanges - Rows for batch writing

抛出:

ClientException - If there is dirty data

setCallback

public void setCallback(TableStoreCallback<RowChange,ConsumedCapacity> callback)

指定者:

setCallback 在接口中 TableStoreWriter

另请参阅:

TableStoreWriter.setResultCallback(TableStoreCallback)

setResultCallback

public void setResultCallback(TableStoreCallback<RowChange,RowWriteResult> resultCallback)

从接口复制的说明: TableStoreWriter

Set Callback, which will provide feedback when data writing succeeds or fails. Note: The callback will be shared by all rows written by TableStoreWriter and may be called concurrently. This is different from the Callback in each interface of AsyncClientInterface, where the callback corresponds one-to-one with each request and can be independent. However, the Callback here corresponds to RowChange, and all RowChanges share this callback.

指定者:

setResultCallback 在接口中 TableStoreWriter

getCallback

public TableStoreCallback<RowChange,ConsumedCapacity> getCallback()

指定者:

getCallback 在接口中 TableStoreWriter

另请参阅:

TableStoreWriter.getResultCallback()

getResultCallback

public TableStoreCallback<RowChange,RowWriteResult> getResultCallback()

从接口复制的说明: TableStoreWriter

Get the set Callback.

指定者:

getResultCallback 在接口中 TableStoreWriter

返回:

callback

getWriterConfig

public WriterConfig getWriterConfig()

从接口复制的说明: TableStoreWriter

Get the configuration of the limit item.

指定者:

getWriterConfig 在接口中 TableStoreWriter

返回:

Configuration of the limit item

getWriterStatistics

public WriterStatistics getWriterStatistics()

从接口复制的说明: TableStoreWriter

Get the statistical information during data import.

指定者:

getWriterStatistics 在接口中 TableStoreWriter

返回:

Statistical information of data import

flush

public void flush()
           throws ClientException

从接口复制的说明: TableStoreWriter

Actively flush the data in the buffer. This function will wait until all data in the buffer has been flushed. Note: If data is written to the buffer after calling flush, the flush will not wait for this new data to be written. The flush of the new data requires a re-call of flush.

指定者:

flush 在接口中 TableStoreWriter

抛出:

ClientException

close

public void close()

从接口复制的说明: TableStoreWriter

Closes the TableStoreWriter. Before closing, it flushes all data in the buffer. Note: If TableStoreWriter.addRowChange(com.alicloud.openservices.tablestore.model.RowChange) is called to write data into the buffer during or after the close process, there is no guarantee that this part of the data will be written to TableStore. The mutual exclusion between addRowChange and close operations must be ensured by the caller. It is essential to ensure that no other threads continue to use this writer before calling close; otherwise, unexpected behavior may occur.

指定者:

close 在接口中 TableStoreWriter