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 Export

Collection export

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

Methods summary

public
# __construct( triagens\ArangoDb\Connection $connection, string $collection, array $data = [] )

Initialize the export

Initialize the export

Parameters

$connection
  • the connection to be used
$collection
  • the collection to export
$data
  • export options

Throws

triagens\ArangoDb\Exception
protected triagens\ArangoDb\Connection
# getConnection( )

Return the connection object

Return the connection object

Returns

triagens\ArangoDb\Connection
  • the connection object
public triagens\ArangoDb\ExportCursor
# execute( )

Execute the export

Execute the export

This will return the results as a Cursor. The cursor can then be used to iterate the results.

Returns

triagens\ArangoDb\ExportCursor

Throws

triagens\ArangoDb\Exception
public
# setBatchSize( integer $value )

Set the batch size for the export

Set the batch size for the export

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.

Parameters

$value
  • batch size value

Throws

triagens\ArangoDb\ClientException
public integer
# getBatchSize( )

Get the batch size for the export

Get the batch size for the export

Returns

integer
  • current batch size value

Constants summary

string ENTRY_COUNT

Count option index

Count option index

# 'count'
string ENTRY_BATCHSIZE

Batch size option index

Batch size option index

# 'batchSize'
string ENTRY_FLUSH

Flush option index

Flush option index

# 'flush'
string ENTRY_RESTRICT

Export restrictions

Export restrictions

# 'restrict'
string ENTRY_LIMIT

Optional limit for the number of documents

Optional limit for the number of documents

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