com.arangodb.model

Class TransactionOptions

java.lang.Object

com.arangodb.model.TransactionOptions

public class TransactionOptions
extends Object

Author:

Mark - mark at arangodb.com

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)
protected String	getAction()
Integer	getLockTimeout()
Object	getParams()
Boolean	getWaitForSync()
TransactionOptions	lockTimeout(Integer lockTimeout)
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

allowImplicit

public TransactionOptions allowImplicit(Boolean allowImplicit)