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)

方法概要

限定符和类型	方法和说明
void	addRowChange(List<RowChange> rowChanges, List<RowChange> dirtyRows) 向本地缓冲区批量写入行。
void	addRowChange(RowChange rowChange) 向本地缓冲区增加一行数据。
boolean	addRowChangeInternal(RowChange rowChange)
void	close() 关闭TableStoreWriter，在关闭之前，会先flush掉缓冲区内的所有数据。
void	flush() 主动flush缓冲区中的数据，该函数会等待缓冲区中的所有数据被flush完毕。
TableStoreCallback<RowChange,ConsumedCapacity>	getCallback()
TableStoreCallback<RowChange,RowWriteResult>	getResultCallback() 获取设置的Callback。
WriterConfig	getWriterConfig() 获取限制项配置。
WriterStatistics	getWriterStatistics() 获取数据导入期间的统计信息。
void	setCallback(TableStoreCallback<RowChange,ConsumedCapacity> callback)
void	setResultCallback(TableStoreCallback<RowChange,RowWriteResult> resultCallback) 设置Callback，数据写入成功或者失败均会通过Callback来反馈。
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)

方法详细资料

startFlushTimer

public void startFlushTimer(int flushInterval)

addRowChange

public void addRowChange(RowChange rowChange)

从接口复制的说明: TableStoreWriter

向本地缓冲区增加一行数据。 在写入缓冲区之前，会对该行数据做如下检查： - 该行的主键的Schema是否与表定义的相同。 - 该行的主键列或属性列的值大小是否超过限制，值的限制配置在WriterConfig.maxPKColumnSize和WriterConfig.maxAttrColumnSize。 - 该行的属性列的个数是否超过WriterConfig.maxColumnsCount。 - 该行的大小是否超过WriterConfig.maxBatchSize。 - 属性列中是否有列名与主键列相同。 若在写入缓冲区之前被判定为脏数据，该部分数据不会触发CallBack的调用。 以上检查会在SDK端带来额外的CPU消耗，但是这些检查是必要的，为了减少不必要的RPC开销，以及避免脏数据污染同一批次Batch写入的行。 注意：若缓冲区满，则该操作会被block。 若判断该行为脏数据，该接口会抛出ClientException。

指定者:

addRowChange 在接口中 TableStoreWriter

参数:

rowChange - 要写入的行

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.

addRowChangeInternal

public boolean addRowChangeInternal(RowChange rowChange)

addRowChange

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

从接口复制的说明: TableStoreWriter

向本地缓冲区批量写入行。 批量写入的每一行会做与TableStoreWriter.addRowChange(RowChange)一样的检查，若批量写入的行中存在脏数据，则该函数会抛ClientException， 且所有的脏数据会写入dirtyRows。

指定者:

addRowChange 在接口中 TableStoreWriter

参数:

rowChanges - 批量写入的行

dirtyRows - 用于传出脏数据的列表

抛出:

ClientException - 若存在脏数据

setCallback

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

指定者:

setCallback 在接口中 TableStoreWriter

另请参阅:

TableStoreWriter.setResultCallback(TableStoreCallback)

setResultCallback

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

从接口复制的说明: TableStoreWriter

设置Callback，数据写入成功或者失败均会通过Callback来反馈。 注意：callback会被写入TableStoreWriter的所有行共享，会被并发的调用。 这与AsyncClientInterface中每个接口的Callback不同，其callback会与每个请求一一对应，且可以是独立的。 但是这里的Callback是与RowChange对应，且所有RowChange都共享该callback。

指定者:

setResultCallback 在接口中 TableStoreWriter

getCallback

public TableStoreCallback<RowChange,ConsumedCapacity> getCallback()

指定者:

getCallback 在接口中 TableStoreWriter

另请参阅:

TableStoreWriter.getResultCallback()

getResultCallback

public TableStoreCallback<RowChange,RowWriteResult> getResultCallback()

从接口复制的说明: TableStoreWriter

获取设置的Callback。

指定者:

getResultCallback 在接口中 TableStoreWriter

返回:

callback

getWriterConfig

public WriterConfig getWriterConfig()

从接口复制的说明: TableStoreWriter

获取限制项配置。

指定者:

getWriterConfig 在接口中 TableStoreWriter

返回:

限制项配置

getWriterStatistics

public WriterStatistics getWriterStatistics()

从接口复制的说明: TableStoreWriter

获取数据导入期间的统计信息。

指定者:

getWriterStatistics 在接口中 TableStoreWriter

返回:

数据导入的统计信息

flush

public void flush()
           throws ClientException

从接口复制的说明: TableStoreWriter

主动flush缓冲区中的数据，该函数会等待缓冲区中的所有数据被flush完毕。 注意：若在调用flush之后继续向缓冲区中写入数据，flush不会等待这部分新数据的写入，新数据的flush需要重新调用一次flush。

指定者:

flush 在接口中 TableStoreWriter

抛出:

ClientException

close

public void close()

从接口复制的说明: TableStoreWriter

关闭TableStoreWriter，在关闭之前，会先flush掉缓冲区内的所有数据。 注意：若在close过程中或者close之后仍然调用TableStoreWriter.addRowChange(com.alicloud.openservices.tablestore.model.RowChange)向缓冲区写入数据，则该部分数据不保证会写入TableStore。 addRowChange和close两个操作之间的互斥由调用方来保证，请务必保证在调用close之前，没有任何其他线程会继续使用该writer，否则会有预期外的行为。

指定者:

close 在接口中 TableStoreWriter