Provides access to the results of a collection export
The cursor might not contain all results in the beginning.
If the result set is too big to be transferred in one go, the cursor might issue additional HTTP requests to fetch the remaining results from the server.
| package | ArangoDBClient |
|---|---|
| since | 2.6 |
__construct(\ArangoDBClient\Connection $connection, array $data, array $options)
\ArangoDBClient\Connectionarrayarray\ArangoDBClient\ClientException |
|---|
delete() : boolean
This might issue an HTTP DELETE request to inform the server about the deletion.
\ArangoDBClient\Exception |
|---|
boolean- true if the server acknowledged the deletion request, false otherwisegetCount() : integer
integer- total number of resultsgetFetches() : integer
integergetId() : string
stringgetNextBatch() : mixed
This might issue additional HTTP requests to fetch any outstanding results from the server
\ArangoDBClient\Exception |
|---|
mixed- an array with the next results or false if the cursor is exhaustedsetDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassablefetchOutstanding() : void
\ArangoDBClient\Exception |
|---|
setData(array $data) : void
array\ArangoDBClient\ClientException |
|---|
url() : string
string$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_connection : \ArangoDBClient\Connection
$_fetches
1$_hasMore : boolean
$_id : mixed
$_result : array
ENTRY_BASEURL = 'baseurl'
ENTRY_COUNT = 'count'
ENTRY_FLAT = '_flat'
ENTRY_HASMORE = 'hasMore'
ENTRY_ID = 'id'
ENTRY_RESULT = 'result'
ENTRY_TYPE = 'type'