org.rocksdb

Class WriteBatch

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.AbstractWriteBatch

org.rocksdb.WriteBatch

All Implemented Interfaces:

java.lang.AutoCloseable, WriteBatchInterface

public class WriteBatch
extends AbstractWriteBatch

WriteBatch holds a collection of updates to apply atomically to a DB. The updates are applied in the order in which they are added to the WriteBatch. For example, the value of "key" will be "v3" after the following batch is written: batch.put("key", "v1"); batch.remove("key"); batch.put("key", "v2"); batch.put("key", "v3"); Multiple threads can invoke const methods on a WriteBatch without external synchronization, but if any of the threads may call a non-const method, all threads accessing the same WriteBatch must use external synchronization.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteBatch.Handler Handler callback for iterating over the contents of a batch.

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Constructor and Description
WriteBatch() Constructs a WriteBatch instance.
WriteBatch(int reserved_bytes) Constructs a WriteBatch instance with a given size.

Method Summary

Modifier and Type	Method and Description
protected void	disposeInternal(long handle)
void	iterate(WriteBatch.Handler handler) Support for iterating over the contents of a batch.

Methods inherited from class org.rocksdb.AbstractWriteBatch

clear, count, deleteRange, deleteRange, merge, merge, put, put, putLogData, remove, remove, rollbackToSavePoint, setSavePoint

Methods inherited from class org.rocksdb.RocksObject

disposeInternal

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

close, disOwnNativeHandle, isOwningHandle

Methods inherited from class org.rocksdb.AbstractNativeReference

dispose, finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

WriteBatch

public WriteBatch()

Constructs a WriteBatch instance.

WriteBatch

public WriteBatch(int reserved_bytes)

Constructs a WriteBatch instance with a given size.

Parameters:

reserved_bytes - reserved size for WriteBatch

Method Detail

iterate

public void iterate(WriteBatch.Handler handler)
             throws RocksDBException

Support for iterating over the contents of a batch.

Parameters:

handler - A handler that is called back for each update present in the batch

Throws:

RocksDBException - If we cannot iterate over the batch

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject