Collection export
| package | ArangoDBClient |
|---|---|
| since | 2.6 |
__construct(\ArangoDBClient\Connection $connection, string $collection, array $data = array())
\ArangoDBClient\Connectionstringarray\ArangoDBClient\Exception |
|---|
execute() : \ArangoDBClient\ExportCursor
This will return the results as a Cursor. The cursor can then be used to iterate the results.
\ArangoDBClient\Exception |
|---|
\ArangoDBClient\ExportCursorgetBatchSize() : integer
integer- current batch size valuesetBatchSize(integer $value) : void
The batch size is the number of results to be transferred in one server round-trip. If an export produces more documents than the batch size, it creates a server-side cursor that provides the additional results.
The server-side cursor can be accessed by the client with subsequent HTTP requests.
integer\ArangoDBClient\ClientException |
|---|
setDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassablegetConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection objectgetCursorOptions() : array
array- array of options$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_batchSize : mixed
$_collection : mixed
$_connection : \ArangoDBClient\Connection
$_flat : boolean
false$_flush : boolean
true$_limit : integer
0$_restrictions : mixed
$_type
ENTRY_BATCHSIZE = 'batchSize'
ENTRY_COUNT = 'count'
ENTRY_FLUSH = 'flush'
ENTRY_LIMIT = 'limit'
ENTRY_RESTRICT = 'restrict'