ArangoDB-PHP API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • triagens
    • ArangoDb

Classes

  • AdminHandler
  • AqlUserFunction
  • Autoloader
  • Batch
  • BatchPart
  • BindVars
  • Collection
  • CollectionHandler
  • Connection
  • ConnectionOptions
  • Cursor
  • Database
  • DefaultValues
  • Document
  • DocumentHandler
  • Edge
  • EdgeDefinition
  • EdgeHandler
  • Endpoint
  • Export
  • ExportCursor
  • Graph
  • GraphHandler
  • Handler
  • HttpHelper
  • HttpResponse
  • QueryCacheHandler
  • QueryHandler
  • Statement
  • TraceRequest
  • TraceResponse
  • Transaction
  • Traversal
  • UpdatePolicy
  • UrlHelper
  • Urls
  • User
  • UserHandler
  • ValueValidator
  • Vertex
  • VertexHandler

Exceptions

  • ClientException
  • ConnectException
  • Exception
  • ServerException

Class ExportCursor

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.

Namespace: triagens\ArangoDb
Package: triagens\ArangoDb
Since: 2.6
Located at ExportCursor.php

Methods summary

public
# __construct( triagens\ArangoDb\Connection $connection, array $data, array $options )

Initialize the cursor with the first results and some metadata

Initialize the cursor with the first results and some metadata

Parameters

$connection
  • connection to be used
$data
  • initial result data as returned by the server
$options
  • cursor options

Throws

triagens\ArangoDb\ClientException
public boolean
# delete( )

Explicitly delete the cursor

Explicitly delete the cursor

This might issue an HTTP DELETE request to inform the server about the deletion.

Returns

boolean
  • true if the server acknowledged the deletion request, false otherwise

Throws

triagens\ArangoDb\Exception
public integer
# getCount( )

Get the total number of results in the export

Get the total number of results in the export

Returns

integer
  • total number of results
public mixed
# getNextBatch( )

Get next results as an array

Get next results as an array

This might issue additional HTTP requests to fetch any outstanding results from the server

Returns

mixed
  • an array with the next results or false if the cursor is exhausted

Throws

triagens\ArangoDb\Exception
public integer
# getFetches( )

Return the number of HTTP calls that were made to build the cursor result

Return the number of HTTP calls that were made to build the cursor result

Returns

integer
public string
# getId( )

Return the cursor id, if any

Return the cursor id, if any

Returns

string

Constants summary

string ENTRY_ID

result entry for cursor id

result entry for cursor id

# 'id'
string ENTRY_HASMORE

result entry for "hasMore" flag

result entry for "hasMore" flag

# 'hasMore'
string ENTRY_RESULT

result entry for result documents

result entry for result documents

# 'result'
string ENTRY_FLAT

"flat" option entry (will treat the results as a simple array, not documents)

"flat" option entry (will treat the results as a simple array, not documents)

# '_flat'
string ENTRY_COUNT

result entry for document count

result entry for document count

# 'count'
string ENTRY_TYPE

"type" option entry (is used when converting the result into documents or edges objects)

"type" option entry (is used when converting the result into documents or edges objects)

# 'type'
string ENTRY_BASEURL

"baseurl" option entry.

"baseurl" option entry.

# 'baseurl'
ArangoDB-PHP API Documentation API documentation generated by ApiGen