com.arangodb.model

Class StreamTransactionOptions

java.lang.Object

com.arangodb.model.StreamTransactionOptions

public class StreamTransactionOptions
extends Object

Since:

ArangoDB 3.5.0

Author:

Mark Vollmary, Michele Rastelli

See Also:

API Documentation

Constructor Summary

Constructors

Constructor and Description
StreamTransactionOptions()

Method Summary

Modifier and Type	Method and Description
StreamTransactionOptions	allowImplicit(Boolean allowImplicit)
StreamTransactionOptions	exclusiveCollections(String... exclusive)
Integer	getLockTimeout()
Long	getMaxTransactionSize()
Boolean	getWaitForSync()
StreamTransactionOptions	lockTimeout(Integer lockTimeout)
StreamTransactionOptions	maxTransactionSize(Long maxTransactionSize)
StreamTransactionOptions	readCollections(String... read)
StreamTransactionOptions	waitForSync(Boolean waitForSync)
StreamTransactionOptions	writeCollections(String... write)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamTransactionOptions

public StreamTransactionOptions()

Method Detail

getLockTimeout

public Integer getLockTimeout()

lockTimeout

public StreamTransactionOptions 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 StreamTransactionOptions 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 StreamTransactionOptions readCollections(String... read)

Parameters:

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

Returns:

options

writeCollections

public StreamTransactionOptions writeCollections(String... write)

Parameters:

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

Returns:

options

exclusiveCollections

public StreamTransactionOptions exclusiveCollections(String... exclusive)

Parameters:

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

Returns:

options

allowImplicit

public StreamTransactionOptions 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 StreamTransactionOptions maxTransactionSize(Long maxTransactionSize)

Parameters:

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

Returns:

options