Transaction base class, used by Transaction and StreamingTransaction
| package | ArangoDBClient |
|---|---|
| since | 1.3 |
__construct(\ArangoDBClient\Connection $connection)
\ArangoDBClient\Connection\ArangoDBClient\ClientException |
|---|
__get(string $key) : mixed
This function is mapped to get() internally.
| magic |
|---|
stringmixed- value of attribute, NULL if attribute is not set__isset(string $key) : boolean
stringbooleanreturns true or false (set or not set)__set(string $key, mixed $value) : void
This is a magic method that allows the object to be used without declaring all document attributes first.
| magic |
|---|
stringmixed\ArangoDBClient\ClientException |
|---|
get(string $key) : mixed
stringmixed- value of attribute, NULL if attribute is not setgetCollections() : array
This holds the read and write collections of the transaction
array$valuegetExclusiveCollections() : array
arrayparamsgetLockTimeout() : integer
integerlockTimeoutgetReadCollections() : array
arrayparamsgetWaitForSync() : boolean
booleanwaitForSyncgetWriteCollections() : array
arrayparamsset($key, $value)
\ArangoDBClient\ClientException |
|---|
setCollections(array $value)
The array should have 2 sub-arrays, namely 'read' and 'write' which should hold the respective collections for the transaction
array
setExclusiveCollections(array $value)
array
setLockTimeout(integer $value)
integer
\ArangoDBClient\ClientException |
|---|
setReadCollections(array $value)
array
setWaitForSync(boolean $value)
boolean
\ArangoDBClient\ClientException |
|---|
setWriteCollections(array $value)
array
buildTransactionAttributesFromArray($options)
\ArangoDBClient\ClientException |
|---|
getConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection object$attributes : array
array()$_connection : \ArangoDBClient\Connection
ENTRY_COLLECTIONS = 'collections'
ENTRY_EXCLUSIVE = 'exclusive'
ENTRY_LOCK_TIMEOUT = 'lockTimeout'
ENTRY_READ = 'read'
ENTRY_WAIT_FOR_SYNC = 'waitForSync'
ENTRY_WRITE = 'write'