org.rocksdb

Class OptimisticTransactionDB

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.RocksDB

org.rocksdb.OptimisticTransactionDB

All Implemented Interfaces:

AutoCloseable

public class OptimisticTransactionDB
extends RocksDB

Database with Transaction support.

Nested Class Summary

Nested classes/interfaces inherited from class org.rocksdb.RocksDB

RocksDB.CountAndSize, RocksDB.LiveFiles, RocksDB.Version

Field Summary

Fields inherited from class org.rocksdb.RocksDB

DEFAULT_COLUMN_FAMILY, NOT_FOUND, options_

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Fields inherited from class org.rocksdb.AbstractImmutableNativeReference

owningHandle_

Method Summary

Modifier and Type	Method and Description
Transaction	beginTransaction(WriteOptions writeOptions) Starts a new Transaction.
Transaction	beginTransaction(WriteOptions writeOptions, OptimisticTransactionOptions optimisticTransactionOptions) Starts a new Transaction.
Transaction	beginTransaction(WriteOptions writeOptions, OptimisticTransactionOptions optimisticTransactionOptions, Transaction oldTransaction) Starts a new Transaction.
Transaction	beginTransaction(WriteOptions writeOptions, Transaction oldTransaction) Starts a new Transaction.
void	close() This is similar to closeE() except that it silently ignores any errors.
void	closeE() This is similar to close() except that it throws an exception if any error occurs.
protected void	disposeInternal(long handle)
RocksDB	getBaseDB() Get the underlying database that was opened.
static OptimisticTransactionDB	open(DBOptions dbOptions, String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) Open an OptimisticTransactionDB similar to RocksDB.open(DBOptions, String, List, List).
protected static long	open(long optionsHandle, String path)
protected static long[]	open(long handle, String path, byte[][] columnFamilyNames, long[] columnFamilyOptions)
static OptimisticTransactionDB	open(Options options, String path) Open an OptimisticTransactionDB similar to RocksDB.open(Options, String).

Methods inherited from class org.rocksdb.RocksDB

cancelAllBackgroundWork, compactFiles, compactFiles, compactRange, compactRange, compactRange, compactRange, compactRange, continueBackgroundWork, createColumnFamilies, createColumnFamilies, createColumnFamily, delete, delete, delete, delete, delete, delete, delete, delete, delete, delete, deleteFile, deleteFilesInRanges, deleteRange, deleteRange, deleteRange, deleteRange, destroyColumnFamilyHandle, destroyDB, disableFileDeletions, dropColumnFamilies, dropColumnFamily, enableAutoCompaction, enableFileDeletions, endTrace, flush, flush, flush, flushWal, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getAggregatedLongProperty, getApproximateMemTableStats, getApproximateMemTableStats, getApproximateSizes, getApproximateSizes, getColumnFamilyMetaData, getColumnFamilyMetaData, getDBOptions, getDefaultColumnFamily, getEnv, getLatestSequenceNumber, getLiveFiles, getLiveFiles, getLiveFilesMetaData, getLongProperty, getLongProperty, getMapProperty, getMapProperty, getName, getOptions, getOptions, getPropertiesOfAllTables, getPropertiesOfAllTables, getPropertiesOfTablesInRange, getPropertiesOfTablesInRange, getProperty, getProperty, getSnapshot, getSortedWalFiles, getUpdatesSince, ingestExternalFile, ingestExternalFile, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, level0StopWriteTrigger, level0StopWriteTrigger, listColumnFamilies, loadLibrary, loadLibrary, maxMemCompactionLevel, maxMemCompactionLevel, merge, merge, merge, merge, merge, merge, merge, merge, multiGetAsList, multiGetAsList, multiGetAsList, multiGetAsList, multiGetByteBuffers, multiGetByteBuffers, multiGetByteBuffers, multiGetByteBuffers, newIterator, newIterator, newIterator, newIterator, newIterators, newIterators, numberLevels, numberLevels, open, open, openAsSecondary, openAsSecondary, openReadOnly, openReadOnly, openReadOnly, openReadOnly, openReadOnly, openReadOnly, pauseBackgroundWork, promoteL0, promoteL0, put, put, put, put, put, put, put, put, put, put, releaseSnapshot, resetStats, rocksdbVersion, setDBOptions, setOptions, setOptions, singleDelete, singleDelete, singleDelete, singleDelete, startTrace, storeOptionsInstance, suggestCompactRange, suggestCompactRange, syncWal, tryCatchUpWithPrimary, verifyChecksum, write, write

Methods inherited from class org.rocksdb.RocksObject

disposeInternal, getNativeHandle

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

disOwnNativeHandle, isOwningHandle

Methods inherited from class java.lang.Object

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

Method Detail

open

public static OptimisticTransactionDB open(Options options,
                                           String path)
                                    throws RocksDBException

Open an OptimisticTransactionDB similar to RocksDB.open(Options, String).

Parameters:

options - Options instance.

path - the path to the rocksdb.

Returns:

a OptimisticTransactionDB instance on success, null if the specified OptimisticTransactionDB can not be opened.

Throws:

RocksDBException - if an error occurs whilst opening the database.

open

public static OptimisticTransactionDB open(DBOptions dbOptions,
                                           String path,
                                           List<ColumnFamilyDescriptor> columnFamilyDescriptors,
                                           List<ColumnFamilyHandle> columnFamilyHandles)
                                    throws RocksDBException

Open an OptimisticTransactionDB similar to RocksDB.open(DBOptions, String, List, List).

Parameters:

dbOptions - DBOptions instance.

path - the path to the rocksdb.

columnFamilyDescriptors - list of column family descriptors

columnFamilyHandles - will be filled with ColumnFamilyHandle instances

Returns:

a OptimisticTransactionDB instance on success, null if the specified OptimisticTransactionDB can not be opened.

Throws:

RocksDBException - if an error occurs whilst opening the database.

closeE

public void closeE()
            throws RocksDBException

This is similar to close() except that it throws an exception if any error occurs. This will not fsync the WAL files. If syncing is required, the caller must first call RocksDB.syncWal() or RocksDB.write(WriteOptions, WriteBatch) using an empty write batch with WriteOptions.setSync(boolean) set to true. See also close().

Overrides:

closeE in class RocksDB

Throws:

RocksDBException - if an error occurs whilst closing.

close

public void close()

This is similar to closeE() except that it silently ignores any errors. This will not fsync the WAL files. If syncing is required, the caller must first call RocksDB.syncWal() or RocksDB.write(WriteOptions, WriteBatch) using an empty write batch with WriteOptions.setSync(boolean) set to true. See also close().

Specified by:

close in interface AutoCloseable

Overrides:

close in class RocksDB

beginTransaction

public Transaction beginTransaction(WriteOptions writeOptions)

Starts a new Transaction. Caller is responsible for calling AutoCloseable.close() on the returned transaction when it is no longer needed.

Parameters:

writeOptions - Any write options for the transaction

Returns:

a new transaction

beginTransaction

public Transaction beginTransaction(WriteOptions writeOptions,
                                    OptimisticTransactionOptions optimisticTransactionOptions)

Starts a new Transaction. Caller is responsible for calling AutoCloseable.close() on the returned transaction when it is no longer needed.

Parameters:

writeOptions - Any write options for the transaction

optimisticTransactionOptions - Any options for the transaction

Returns:

a new transaction

beginTransaction

public Transaction beginTransaction(WriteOptions writeOptions,
                                    Transaction oldTransaction)

Starts a new Transaction. Caller is responsible for calling AutoCloseable.close() on the returned transaction when it is no longer needed.

Parameters:

writeOptions - Any write options for the transaction

oldTransaction - this Transaction will be reused instead of allocating a new one. This is an optimization to avoid extra allocations when repeatedly creating transactions.

Returns:

The oldTransaction which has been reinitialized as a new transaction

beginTransaction

public Transaction beginTransaction(WriteOptions writeOptions,
                                    OptimisticTransactionOptions optimisticTransactionOptions,
                                    Transaction oldTransaction)

Starts a new Transaction. Caller is responsible for calling AutoCloseable.close() on the returned transaction when it is no longer needed.

Parameters:

writeOptions - Any write options for the transaction

optimisticTransactionOptions - Any options for the transaction

oldTransaction - this Transaction will be reused instead of allocating a new one. This is an optimization to avoid extra allocations when repeatedly creating transactions.

Returns:

The oldTransaction which has been reinitialized as a new transaction

getBaseDB

public RocksDB getBaseDB()

Get the underlying database that was opened.

Returns:

The underlying database that was opened.

disposeInternal

protected final void disposeInternal(long handle)

Overrides:

disposeInternal in class RocksDB

open

protected static long open(long optionsHandle,
                           String path)
                    throws RocksDBException

Throws:

RocksDBException

open

protected static long[] open(long handle,
                             String path,
                             byte[][] columnFamilyNames,
                             long[] columnFamilyOptions)