Provides management of streaming transactions
| package | ArangoDBClient |
|---|---|
| since | 3.5 |
| inherited_from | \ArangoDBClient\Handler |
__construct(\ArangoDBClient\Connection $connection)
| inherited_from | \ArangoDBClient\Handler::__construct() |
|---|
\ArangoDBClient\Connection__construct(\ArangoDBClient\Connection $connection)
\ArangoDBClient\Connectionabort(mixed $trx) : boolean
mixed\ArangoDBClient\ServerException |
|---|
boolean- true if abort succeeds, throws an exception otherwiseclosePendingTransactions()
commit(mixed $trx) : boolean
mixed\ArangoDBClient\ServerException |
|---|
boolean- true if commit succeeds, throws an exception otherwisecreate(\ArangoDBClient\StreamingTransaction $trx = null)
\ArangoDBClient\StreamingTransaction\ArangoDBClient\ServerException |
|---|
getRunning() : array
\ArangoDBClient\ServerException |
|---|
array- array of currently running transactions, each transaction is an array with attributes 'id' and 'status'getStatus(mixed $trx) : array
mixed\ArangoDBClient\ServerException |
|---|
array- returns an array with attributes 'id' and 'status'setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassablestealTransaction(string $id)
stringaddTransactionHeader(array $headers, mixed $collection)
arraymixedgetConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection objectgetConnectionOption($optionName) : mixed
\ArangoDBClient\ClientException |
|---|
mixed- the option's valueincludeOptionsInBody(array $options, array $body, array $includeArray = array()) : array
Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .
arrayarrayarrayarray$params - array of parameters for use in a urljson_encode_wrapper(array $body) : string
This is a convenience function that calls json_encode_wrapper on the connection
array\ArangoDBClient\ClientException |
|---|
string- json string of the body that was passedmakeCollection(mixed $value) : string
mixed\ArangoDBClient\ClientException |
|---|
string- collection name$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_connection
| param |
|---|
$_pendingTransactions
array()