com.arangodb.model

Class TransactionOptions

java.lang.Object

com.arangodb.model.TransactionOptions

public class TransactionOptions
extends Object

Author:

Mark Vollmary

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionOptions.TransactionCollectionOptions

Constructor Summary

Constructors

Constructor and Description
TransactionOptions()

Method Summary

Modifier and Type	Method and Description
protected TransactionOptions	action(String action)
TransactionOptions	allowImplicit(Boolean allowImplicit)
TransactionOptions	exclusiveCollections(String... exclusive)
protected String	getAction()
Long	getIntermediateCommitCount()
Long	getIntermediateCommitSize()
Integer	getLockTimeout()
Long	getMaxTransactionSize()
Object	getParams()
Boolean	getWaitForSync()
TransactionOptions	intermediateCommitCount(Long intermediateCommitCount)
TransactionOptions	intermediateCommitSize(Long intermediateCommitSize)
TransactionOptions	lockTimeout(Integer lockTimeout)
TransactionOptions	maxTransactionSize(Long maxTransactionSize)
TransactionOptions	params(Object params)
TransactionOptions	readCollections(String... read)
TransactionOptions	waitForSync(Boolean waitForSync)
TransactionOptions	writeCollections(String... write)

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionOptions

public TransactionOptions()

Method Detail

getAction

protected String getAction()

action

protected TransactionOptions action(String action)

Parameters:

action - the actual transaction operations to be executed, in the form of stringified JavaScript code

Returns:

options

getParams

public Object getParams()

params

public TransactionOptions params(Object params)

Parameters:

params - optional arguments passed to action

Returns:

options

getLockTimeout

public Integer getLockTimeout()

lockTimeout

public TransactionOptions lockTimeout(Integer lockTimeout)

Parameters:

lockTimeout - an optional numeric value that can be used to set a timeout for waiting on collection locks. If not specified, a default value will be used. Setting lockTimeout to 0 will make ArangoDB not time out waiting for a lock.

Returns:

options

getWaitForSync

public Boolean getWaitForSync()

waitForSync

public TransactionOptions waitForSync(Boolean waitForSync)

Parameters:

waitForSync - an optional boolean flag that, if set, will force the transaction to write all data to disk before returning

Returns:

options

readCollections

public TransactionOptions readCollections(String... read)

Parameters:

read - contains the array of collection-names to be used in the transaction (mandatory) for read

Returns:

options

writeCollections

public TransactionOptions writeCollections(String... write)

Parameters:

write - contains the array of collection-names to be used in the transaction (mandatory) for write

Returns:

options

exclusiveCollections

public TransactionOptions exclusiveCollections(String... exclusive)

Parameters:

exclusive - contains the array of collection-names to be used in the transaction (mandatory) for exclusive write

Returns:

options

Since:

ArangoDB 3.4.0

allowImplicit

public TransactionOptions allowImplicit(Boolean allowImplicit)

Parameters:

allowImplicit - Collections that will be written to in the transaction must be declared with the write attribute or it will fail, whereas non-declared collections from which is solely read will be added lazily. The optional attribute allowImplicit can be set to false to let transactions fail in case of undeclared collections for reading. Collections for reading should be fully declared if possible, to avoid deadlocks.

Returns:

options

getMaxTransactionSize

public Long getMaxTransactionSize()

maxTransactionSize

public TransactionOptions maxTransactionSize(Long maxTransactionSize)

Parameters:

maxTransactionSize - Transaction size limit in bytes. Honored by the RocksDB storage engine only.

Returns:

options

Since:

ArangoDB 3.2.0

getIntermediateCommitCount

public Long getIntermediateCommitCount()

intermediateCommitCount

public TransactionOptions intermediateCommitCount(Long intermediateCommitCount)

Parameters:

intermediateCommitCount - Maximum number of operations after which an intermediate commit is performed automatically. Honored by the RocksDB storage engine only.

Returns:

options

Since:

ArangoDB 3.2.0

getIntermediateCommitSize

public Long getIntermediateCommitSize()

intermediateCommitSize

public TransactionOptions intermediateCommitSize(Long intermediateCommitSize)

Parameters:

intermediateCommitSize - Maximum total size of operations after which an intermediate commit is performed automatically. Honored by the RocksDB storage engine only.

Returns:

options

Since:

ArangoDB 3.2.0