$_batchResponse
$_batchResponse : \triagens\ArangoDb\HttpResponse
Batch Response Object
Provides batching functionality
$_batchResponse : \triagens\ArangoDb\HttpResponse
Batch Response Object
$_connection : \triagens\ArangoDb\Connection
The connection object
__construct(\triagens\ArangoDb\Connection $connection, array $options) : \triagens\ArangoDb\Batch
Constructor for Batch instance. Batch instance by default starts capturing request after initiated.
To disable this, pass startCapture=>false inside the options array parameter
\triagens\ArangoDb\Connection | $connection | that this batch class will monitor for requests in order to batch them. Connection parameter is mandatory. |
array | $options | An array of options for Batch construction. See below for options: Options are : |
setConnection(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Batch
Sets the connection for he current batch. (mostly internal function)
\triagens\ArangoDb\Connection | $connection |
startCapture(array $options) : \triagens\ArangoDb\Batch
Start capturing requests. To stop capturing, use stopCapture()
see triagens\ArangoDb\Batch::stopCapture()
array | $options |
stopCapture() : \triagens\ArangoDb\Batch
Stop capturing requests. If the batch has not been processed yet, more requests can be appended by calling startCapture() again.
see Batch::startCapture()
getActive(\triagens\ArangoDb\Connection $connection) : $this
Gets active batch in given connection.
\triagens\ArangoDb\Connection | $connection |
getConnectionCaptureMode(\triagens\ArangoDb\Connection $connection) : boolean
Returns true, if given connection is in batch-capture mode.
\triagens\ArangoDb\Connection | $connection |
nextBatchPartId(mixed $batchPartId) : \triagens\ArangoDb\Batch
Sets the id of the next batch-part. The id can later be used to retrieve the batch-part.
mixed | $batchPartId |
nextBatchPartCursorOptions(mixed $batchPartCursorOptions) : \triagens\ArangoDb\Batch
Set client side cursor options (for example: sanitize) for the next batch part.
mixed | $batchPartCursorOptions |
append(mixed $method, mixed $request) : \triagens\ArangoDb\HttpResponse
Append the request to the batch-part
mixed | $method |
|
mixed | $request |
|
process() : boolean
Processes this batch. This sends the captured requests to the server as one batch.
getPart(mixed $partId) : mixed
Get the batch part identified by the array key (0.
..n) or its id (if it was set with nextBatchPartId($id) )
mixed | $partId | the batch part id. Either it's numeric key or a given name. |
$batchPart
getConnection() : \triagens\ArangoDb\Connection
Return this batch's connection