org.rocksdb

Class TransactionOptions

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.TransactionOptions

All Implemented Interfaces:

java.lang.AutoCloseable

public class TransactionOptions
extends RocksObject

Field Summary

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Constructor and Description
TransactionOptions()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	disposeInternal(long handle)
long	getDeadlockDetectDepth() Gets the number of traversals to make during deadlock detection.
long	getExpiration() Expiration duration in milliseconds.
long	getLockTimeout() The wait timeout in milliseconds when a transaction attempts to lock a key.
long	getMaxWriteBatchSize() Get the maximum number of bytes that may be used for the write batch.
boolean	isDeadlockDetect() True means that before acquiring locks, this transaction will check if doing so will cause a deadlock.
boolean	isSetSnapshot() True indicates snapshots will be set, just like if Transaction.setSnapshot() had been called
TransactionOptions	setDeadlockDetect(boolean deadlockDetect) Setting to true means that before acquiring locks, this transaction will check if doing so will cause a deadlock.
TransactionOptions	setDeadlockDetectDepth(long deadlockDetectDepth) Sets the number of traversals to make during deadlock detection.
TransactionOptions	setExpiration(long expiration) Expiration duration in milliseconds.
TransactionOptions	setLockTimeout(long lockTimeout) If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a key.
TransactionOptions	setMaxWriteBatchSize(long maxWriteBatchSize) Set the maximum number of bytes that may be used for the write batch.
TransactionOptions	setSetSnapshot(boolean setSnapshot) Setting the setSnapshot to true is the same as calling Transaction.setSnapshot().

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

TransactionOptions

public TransactionOptions()

Method Detail

isSetSnapshot

public boolean isSetSnapshot()

True indicates snapshots will be set, just like if Transaction.setSnapshot() had been called

Returns:

whether a snapshot will be set

setSetSnapshot

public TransactionOptions setSetSnapshot(boolean setSnapshot)

Setting the setSnapshot to true is the same as calling Transaction.setSnapshot(). Default: false

Parameters:

setSnapshot - Whether to set a snapshot

Returns:

this TransactionalOptions instance

isDeadlockDetect

public boolean isDeadlockDetect()

True means that before acquiring locks, this transaction will check if doing so will cause a deadlock. If so, it will return with Status.Code.Busy. The user should retry their transaction.

Returns:

true if a deadlock is detected.

setDeadlockDetect

public TransactionOptions setDeadlockDetect(boolean deadlockDetect)

Setting to true means that before acquiring locks, this transaction will check if doing so will cause a deadlock. If so, it will return with Status.Code.Busy. The user should retry their transaction.

Parameters:

deadlockDetect - true if we should detect deadlocks.

Returns:

this TransactionOptions instance

getLockTimeout

public long getLockTimeout()

The wait timeout in milliseconds when a transaction attempts to lock a key. If 0, no waiting is done if a lock cannot instantly be acquired. If negative, TransactionDBOptions.getTransactionLockTimeout(long) will be used

Returns:

the lock tiemout in milliseconds

setLockTimeout

public TransactionOptions setLockTimeout(long lockTimeout)

If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a key. If 0, no waiting is done if a lock cannot instantly be acquired. If negative, TransactionDBOptions.getTransactionLockTimeout(long) will be used Default: -1

Parameters:

lockTimeout - the lock tiemout in milliseconds

Returns:

this TransactionOptions instance

getExpiration

public long getExpiration()

Expiration duration in milliseconds. If non-negative, transactions that last longer than this many milliseconds will fail to commit. If not set, a forgotten transaction that is never committed, rolled back, or deleted will never relinquish any locks it holds. This could prevent keys from being written by other writers.

Returns:

expiration the expiration duration in milliseconds

setExpiration

public TransactionOptions setExpiration(long expiration)

Expiration duration in milliseconds. If non-negative, transactions that last longer than this many milliseconds will fail to commit. If not set, a forgotten transaction that is never committed, rolled back, or deleted will never relinquish any locks it holds. This could prevent keys from being written by other writers. Default: -1

Parameters:

expiration - the expiration duration in milliseconds

Returns:

this TransactionOptions instance

getDeadlockDetectDepth

public long getDeadlockDetectDepth()

Gets the number of traversals to make during deadlock detection.

Returns:

the number of traversals to make during deadlock detection

setDeadlockDetectDepth

public TransactionOptions setDeadlockDetectDepth(long deadlockDetectDepth)

Sets the number of traversals to make during deadlock detection. Default: 50

Parameters:

deadlockDetectDepth - the the number of traversals to make during deadlock detection

Returns:

this TransactionOptions instance

getMaxWriteBatchSize

public long getMaxWriteBatchSize()

Get the maximum number of bytes that may be used for the write batch.

Returns:

the maximum number of bytes, 0 means no limit.

setMaxWriteBatchSize

public TransactionOptions setMaxWriteBatchSize(long maxWriteBatchSize)

Set the maximum number of bytes that may be used for the write batch.

Parameters:

maxWriteBatchSize - the maximum number of bytes, 0 means no limit.

Returns:

this TransactionOptions instance

disposeInternal

protected final void disposeInternal(long handle)

Specified by:

disposeInternal in class RocksObject