org.rocksdb

Class TransactionDB

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.RocksDB

org.rocksdb.TransactionDB

All Implemented Interfaces:

AutoCloseable

public class TransactionDB
extends RocksDB

Database with Transaction support

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionDB.DeadlockInfo
static class	TransactionDB.DeadlockPath
static class	TransactionDB.KeyLockInfo

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, Transaction oldTransaction) Starts a new Transaction.
Transaction	beginTransaction(WriteOptions writeOptions, TransactionOptions transactionOptions) Starts a new Transaction.
Transaction	beginTransaction(WriteOptions writeOptions, TransactionOptions transactionOptions, 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)
List<Transaction>	getAllPreparedTransactions()
TransactionDB.DeadlockPath[]	getDeadlockInfoBuffer()
Map<Long,TransactionDB.KeyLockInfo>	getLockStatusData() Returns map of all locks held.
Transaction	getTransactionByName(String transactionName)
static TransactionDB	open(DBOptions dbOptions, TransactionDBOptions transactionDbOptions, String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) Open a TransactionDB, similar to RocksDB.open(DBOptions, String, List, List).
static TransactionDB	open(Options options, TransactionDBOptions transactionDbOptions, String path) Open a TransactionDB, similar to RocksDB.open(Options, String).
void	setDeadlockInfoBufferSize(int targetSize)

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, 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 TransactionDB open(Options options,
                                 TransactionDBOptions transactionDbOptions,
                                 String path)
                          throws RocksDBException

Open a TransactionDB, similar to RocksDB.open(Options, String).

Parameters:

options - Options instance.

transactionDbOptions - TransactionDBOptions instance.

path - the path to the rocksdb.

Returns:

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

Throws:

RocksDBException - if an error occurs whilst opening the database.

open

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

Open a TransactionDB, similar to RocksDB.open(DBOptions, String, List, List).

Parameters:

dbOptions - DBOptions instance.

transactionDbOptions - TransactionDBOptions instance.

path - the path to the rocksdb.

columnFamilyDescriptors - list of column family descriptors

columnFamilyHandles - will be filled with ColumnFamilyHandle instances

Returns:

a TransactionDB instance on success, null if the specified TransactionDB 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,
                                    TransactionOptions transactionOptions)

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

transactionOptions - 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,
                                    TransactionOptions transactionOptions,
                                    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

transactionOptions - 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

getTransactionByName

public Transaction getTransactionByName(String transactionName)

getAllPreparedTransactions

public List<Transaction> getAllPreparedTransactions()

getLockStatusData

public Map<Long,TransactionDB.KeyLockInfo> getLockStatusData()

Returns map of all locks held.

Returns:

a map of all the locks held.

getDeadlockInfoBuffer

public TransactionDB.DeadlockPath[] getDeadlockInfoBuffer()

setDeadlockInfoBufferSize

public void setDeadlockInfoBufferSize(int targetSize)

disposeInternal

protected final void disposeInternal(long handle)

Overrides:

disposeInternal in class RocksDB