org.rocksdb

Class AbstractWriteBatch

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.AbstractWriteBatch

All Implemented Interfaces:

java.lang.AutoCloseable, WriteBatchInterface

Direct Known Subclasses:

WriteBatch, WriteBatchWithIndex

public abstract class AbstractWriteBatch
extends RocksObject
implements WriteBatchInterface

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWriteBatch(long nativeHandle)

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all updates buffered in this batch
int	count() Returns the number of updates in the batch.
void	deleteRange(byte[] beginKey, byte[] endKey) Removes the database entries in the range ["beginKey", "endKey"), i.e., including "beginKey" and excluding "endKey".
void	deleteRange(ColumnFamilyHandle columnFamilyHandle, byte[] beginKey, byte[] endKey) Removes the database entries in the range ["beginKey", "endKey"), i.e., including "beginKey" and excluding "endKey".
void	merge(byte[] key, byte[] value) Merge "value" with the existing value of "key" in the database.
void	merge(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value) Merge "value" with the existing value of "key" in given column family.
void	put(byte[] key, byte[] value) Store the mapping "key->value" in the database.
void	put(ColumnFamilyHandle columnFamilyHandle, byte[] key, byte[] value) Store the mapping "key->value" within given column family.
void	putLogData(byte[] blob) Append a blob of arbitrary size to the records in this batch.
void	remove(byte[] key) If the database contains a mapping for "key", erase it.
void	remove(ColumnFamilyHandle columnFamilyHandle, byte[] key) If column family contains a mapping for "key", erase it.
void	rollbackToSavePoint() Remove all entries in this batch (Put, Merge, Delete, PutLogData) since the most recent call to SetSavePoint() and removes the most recent save point.
void	setSavePoint() Records the state of the batch for future calls to RollbackToSavePoint().

Methods inherited from class org.rocksdb.RocksObject

disposeInternal, 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

AbstractWriteBatch

protected AbstractWriteBatch(long nativeHandle)

Method Detail

count

public int count()

Description copied from interface: WriteBatchInterface

Returns the number of updates in the batch.

Specified by:

count in interface WriteBatchInterface

Returns:

number of items in WriteBatch

put

public void put(byte[] key,
                byte[] value)

Description copied from interface: WriteBatchInterface

Store the mapping "key->value" in the database.

Specified by:

put in interface WriteBatchInterface

Parameters:

key - the specified key to be inserted.

value - the value associated with the specified key.

put

public void put(ColumnFamilyHandle columnFamilyHandle,
                byte[] key,
                byte[] value)

Description copied from interface: WriteBatchInterface

Store the mapping "key->value" within given column family.

Specified by:

put in interface WriteBatchInterface

Parameters:

columnFamilyHandle - ColumnFamilyHandle instance

key - the specified key to be inserted.

value - the value associated with the specified key.

merge

public void merge(byte[] key,
                  byte[] value)

Description copied from interface: WriteBatchInterface

Merge "value" with the existing value of "key" in the database. "key->merge(existing, value)"

Specified by:

merge in interface WriteBatchInterface

Parameters:

key - the specified key to be merged.

value - the value to be merged with the current value for the specified key.

merge

public void merge(ColumnFamilyHandle columnFamilyHandle,
                  byte[] key,
                  byte[] value)

Description copied from interface: WriteBatchInterface

Merge "value" with the existing value of "key" in given column family. "key->merge(existing, value)"

Specified by:

merge in interface WriteBatchInterface

Parameters:

columnFamilyHandle - ColumnFamilyHandle instance

key - the specified key to be merged.

value - the value to be merged with the current value for the specified key.

remove

public void remove(byte[] key)

Description copied from interface: WriteBatchInterface

If the database contains a mapping for "key", erase it. Else do nothing.

Specified by:

remove in interface WriteBatchInterface

Parameters:

key - Key to delete within database

remove

public void remove(ColumnFamilyHandle columnFamilyHandle,
                   byte[] key)

Description copied from interface: WriteBatchInterface

If column family contains a mapping for "key", erase it. Else do nothing.

Specified by:

remove in interface WriteBatchInterface

Parameters:

columnFamilyHandle - ColumnFamilyHandle instance

key - Key to delete within database

deleteRange

public void deleteRange(byte[] beginKey,
                        byte[] endKey)

Description copied from interface: WriteBatchInterface

Removes the database entries in the range ["beginKey", "endKey"), i.e., including "beginKey" and excluding "endKey". a non-OK status on error. It is not an error if no keys exist in the range ["beginKey", "endKey"). Delete the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.

Specified by:

deleteRange in interface WriteBatchInterface

Parameters:

beginKey - First key to delete within database (included)

endKey - Last key to delete within database (excluded)

deleteRange

public void deleteRange(ColumnFamilyHandle columnFamilyHandle,
                        byte[] beginKey,
                        byte[] endKey)

Description copied from interface: WriteBatchInterface

Removes the database entries in the range ["beginKey", "endKey"), i.e., including "beginKey" and excluding "endKey". a non-OK status on error. It is not an error if no keys exist in the range ["beginKey", "endKey"). Delete the database entry (if any) for "key". Returns OK on success, and a non-OK status on error. It is not an error if "key" did not exist in the database.

Specified by:

deleteRange in interface WriteBatchInterface

Parameters:

columnFamilyHandle - ColumnFamilyHandle instance

beginKey - First key to delete within database (included)

endKey - Last key to delete within database (excluded)

putLogData

public void putLogData(byte[] blob)

Description copied from interface: WriteBatchInterface

Append a blob of arbitrary size to the records in this batch. The blob will be stored in the transaction log but not in any other file. In particular, it will not be persisted to the SST files. When iterating over this WriteBatch, WriteBatch::Handler::LogData will be called with the contents of the blob as it is encountered. Blobs, puts, deletes, and merges will be encountered in the same order in thich they were inserted. The blob will NOT consume sequence number(s) and will NOT increase the count of the batch Example application: add timestamps to the transaction log for use in replication.

Specified by:

putLogData in interface WriteBatchInterface

Parameters:

blob - binary object to be inserted

clear

public void clear()

Description copied from interface: WriteBatchInterface

Clear all updates buffered in this batch

Specified by:

clear in interface WriteBatchInterface

setSavePoint

public void setSavePoint()

Description copied from interface: WriteBatchInterface

Records the state of the batch for future calls to RollbackToSavePoint(). May be called multiple times to set multiple save points.

Specified by:

setSavePoint in interface WriteBatchInterface

rollbackToSavePoint

public void rollbackToSavePoint()
                         throws RocksDBException

Description copied from interface: WriteBatchInterface

Remove all entries in this batch (Put, Merge, Delete, PutLogData) since the most recent call to SetSavePoint() and removes the most recent save point.

Specified by:

rollbackToSavePoint in interface WriteBatchInterface

Throws:

RocksDBException - if there is no previous call to SetSavePoint()