Location: PHPKode > projects > ArangoDB-PHP > ArangoDB-PHP-1.3.0/docs/classes/triagens.ArangoDb.CollectionHandler.html
<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>ArangoDB PHP client API » \triagens\ArangoDb\CollectionHandler</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">ArangoDB PHP client API</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/triagens.html"><i class="icon-th"></i> triagens</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/triagens.html"><i class="icon-folder-open"></i> triagens</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">9</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public inherited"><a href="#method___construct" title="__construct :: Construct a new handler"><span class="description">Construct a new handler</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_add" title="add :: Adds a new collection on the server"><span class="description">Adds a new collection on the server</span><pre>add()</pre></a></li>
<li class="method public "><a href="#method_any" title="any :: Get a random document from the collection."><span class="description">Get a random document from the collection.</span><pre>any()</pre></a></li>
<li class="method public "><a href="#method_byExample" title="byExample :: Get document(s) by specifying an example"><span class="description">Get document(s) by specifying an example</span><pre>byExample()</pre></a></li>
<li class="method public "><a href="#method_count" title="count :: Get the number of documents in a collection"><span class="description">Get the number of documents in a collection</span><pre>count()</pre></a></li>
<li class="method public "><a href="#method_create" title="create :: Creates a new collection on the server"><span class="description">Creates a new collection on the server</span><pre>create()</pre></a></li>
<li class="method public "><a href="#method_createCapConstraint" title="createCapConstraint :: Create a cap constraint"><span class="description">Create a cap constraint</span><pre>createCapConstraint()</pre></a></li>
<li class="method public "><a href="#method_createFulltextIndex" title="createFulltextIndex :: Create a fulltext index"><span class="description">Create a fulltext index</span><pre>createFulltextIndex()</pre></a></li>
<li class="method public "><a href="#method_createGeoIndex" title="createGeoIndex :: Create a geo index"><span class="description">Create a geo index</span><pre>createGeoIndex()</pre></a></li>
<li class="method public "><a href="#method_createHashIndex" title="createHashIndex :: Create a hash index"><span class="description">Create a hash index</span><pre>createHashIndex()</pre></a></li>
<li class="method public "><a href="#method_createSkipListIndex" title="createSkipListIndex :: Create a skip-list index"><span class="description">Create a skip-list index</span><pre>createSkipListIndex()</pre></a></li>
<li class="method public "><a href="#method_delete" title="delete :: Delete a collection"><span class="description">Delete a collection</span><pre>delete()</pre></a></li>
<li class="method public "><a href="#method_drop" title="drop :: Drop a collection"><span class="description">Drop a collection</span><pre>drop()</pre></a></li>
<li class="method public "><a href="#method_dropIndex" title="dropIndex :: Drop an index"><span class="description">Drop an index</span><pre>dropIndex()</pre></a></li>
<li class="method public "><a href="#method_figures" title="figures :: Get figures for a collection"><span class="description">Get figures for a collection</span><pre>figures()</pre></a></li>
<li class="method public "><a href="#method_firstExample" title="firstExample :: Get the first document matching a given example."><span class="description">Get the first document matching a given example.</span><pre>firstExample()</pre></a></li>
<li class="method public "><a href="#method_get" title="get :: Get information about a collection"><span class="description">Get information about a collection</span><pre>get()</pre></a></li>
<li class="method public "><a href="#method_getAllCollections" title="getAllCollections :: Get list of all available collections per default with the collection names as index."><span class="description">Get list of all available collections per default with the collection names as index.</span><pre>getAllCollections()</pre></a></li>
<li class="method public "><a href="#method_getAllIds" title="getAllIds :: Get the list of all documents' ids from a collection"><span class="description">Get the list of all documents' ids from a collection</span><pre>getAllIds()</pre></a></li>
<li class="method public "><a href="#method_getCollectionId" title="getCollectionId :: Gets the collectionId from the given collectionObject or string/integer"><span class="description">Gets the collectionId from the given collectionObject or string/integer</span><pre>getCollectionId()</pre></a></li>
<li class="method public "><a href="#method_getCollectionName" title="getCollectionName :: Gets the collectionId from the given collectionObject or string/integer"><span class="description">Gets the collectionId from the given collectionObject or string/integer</span><pre>getCollectionName()</pre></a></li>
<li class="method public "><a href="#method_getCount" title="getCount :: Get the number of documents in a collection"><span class="description">Get the number of documents in a collection</span><pre>getCount()</pre></a></li>
<li class="method public "><a href="#method_getFigures" title="getFigures :: Get figures for a collection"><span class="description">Get figures for a collection</span><pre>getFigures()</pre></a></li>
<li class="method public "><a href="#method_getIndex" title="getIndex :: Get the information about an index in a collection"><span class="description">Get the information about an index in a collection</span><pre>getIndex()</pre></a></li>
<li class="method public "><a href="#method_getIndexes" title="getIndexes :: Get indexes of a collection"><span class="description">Get indexes of a collection</span><pre>getIndexes()</pre></a></li>
<li class="method public "><a href="#method_getProperties" title="getProperties :: Get properties of a collection"><span class="description">Get properties of a collection</span><pre>getProperties()</pre></a></li>
<li class="method public "><a href="#method_import" title="import :: Import documents into a collection"><span class="description">Import documents into a collection</span><pre>import()</pre></a></li>
<li class="method public "><a href="#method_importFromFile" title="importFromFile :: Import documents from a file"><span class="description">Import documents from a file</span><pre>importFromFile()</pre></a></li>
<li class="method public "><a href="#method_index" title="index :: Creates an index on a collection on the server"><span class="description">Creates an index on a collection on the server</span><pre>index()</pre></a></li>
<li class="method public "><a href="#method_isValidCollectionId" title="isValidCollectionId :: Checks if the collectionId given, is valid."><span class="description">Checks if the collectionId given, is valid.</span><pre>isValidCollectionId()</pre></a></li>
<li class="method public "><a href="#method_load" title="load :: Load a collection into the server's memory"><span class="description">Load a collection into the server's memory</span><pre>load()</pre></a></li>
<li class="method public "><a href="#method_near" title="near :: Get document(s) by specifying near"><span class="description">Get document(s) by specifying near</span><pre>near()</pre></a></li>
<li class="method public "><a href="#method_range" title="range :: Get document(s) by specifying range"><span class="description">Get document(s) by specifying range</span><pre>range()</pre></a></li>
<li class="method public "><a href="#method_removeByExample" title="removeByExample :: Remove document(s) by specifying an example"><span class="description">Remove document(s) by specifying an example</span><pre>removeByExample()</pre></a></li>
<li class="method public "><a href="#method_rename" title="rename :: Rename a collection"><span class="description">Rename a collection</span><pre>rename()</pre></a></li>
<li class="method public "><a href="#method_replaceByExample" title="replaceByExample :: Replace document(s) matching a given example"><span class="description">Replace document(s) matching a given example</span><pre>replaceByExample()</pre></a></li>
<li class="method public "><a href="#method_truncate" title="truncate :: Truncate a collection"><span class="description">Truncate a collection</span><pre>truncate()</pre></a></li>
<li class="method public "><a href="#method_unload" title="unload :: Unload a collection from the server's memory"><span class="description">Unload a collection from the server's memory</span><pre>unload()</pre></a></li>
<li class="method public "><a href="#method_updateByExample" title="updateByExample :: Update document(s) matching a given example"><span class="description">Update document(s) matching a given example</span><pre>updateByExample()</pre></a></li>
<li class="method public "><a href="#method_within" title="within :: Get document(s) by specifying within"><span class="description">Get document(s) by specifying within</span><pre>within()</pre></a></li>
</ul>
</li>
<li class="nav-header protected">» Protected
                    <ul>
<li class="method protected inherited"><a href="#method_getConnection" title="getConnection :: Return the connection object"><span class="description">Return the connection object</span><pre>getConnection()</pre></a></li>
<li class="method protected inherited"><a href="#method_getConnectionOption" title="getConnectionOption :: Return a connection option
This is a convenience function that calls json_encode_wrapper on the connection"><span class="description">Return a connection option
This is a convenience function that calls json_encode_wrapper on the connection</span><pre>getConnectionOption()</pre></a></li>
<li class="method protected inherited"><a href="#method_getCursorOptions" title="getCursorOptions :: Return an array of cursor options"><span class="description">Return an array of cursor options</span><pre>getCursorOptions()</pre></a></li>
<li class="method protected inherited"><a href="#method_includeOptionsInBody" title="includeOptionsInBody :: Helper function that runs through the options given and includes them into the parameters array given."><span class="description">Helper function that runs through the options given and includes them into the parameters array given.</span><pre>includeOptionsInBody()</pre></a></li>
<li class="method protected inherited"><a href="#method_includeOptionsInParams" title="includeOptionsInParams :: Helper function that runs through the options given and includes them into the parameters array given."><span class="description">Helper function that runs through the options given and includes them into the parameters array given.</span><pre>includeOptionsInParams()</pre></a></li>
<li class="method protected inherited"><a href="#method_json_encode_wrapper" title="json_encode_wrapper :: Return a json encoded string for the array passed."><span class="description">Return a json encoded string for the array passed.</span><pre>json_encode_wrapper()</pre></a></li>
<li class="method protected inherited"><a href="#method_validateAndIncludeOldSingleParameterInParams" title="validateAndIncludeOldSingleParameterInParams :: Helper function that validates and includes an old single method parameter setting into the parameters array given."><span class="description">Helper function that validates and includes an old single method parameter setting into the parameters array given.</span><pre>validateAndIncludeOldSingleParameterInParams()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul><li class="property private inherited"><a href="#property__connection" title="$_connection :: Connection object"><span class="description"></span><pre>$_connection</pre></a></li></ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
                    <ul>
<li class="constant  "><a href="#constant_ENTRY_DOCUMENTS" title="ENTRY_DOCUMENTS :: documents array index"><span class="description">documents array index</span><pre>ENTRY_DOCUMENTS</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_ATTRIBUTE" title="OPTION_ATTRIBUTE :: attribute parameter"><span class="description">attribute parameter</span><pre>OPTION_ATTRIBUTE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_CAP_CONSTRAINT" title="OPTION_CAP_CONSTRAINT :: cap constraint option"><span class="description">cap constraint option</span><pre>OPTION_CAP_CONSTRAINT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_CLOSED" title="OPTION_CLOSED :: closed parameter"><span class="description">closed parameter</span><pre>OPTION_CLOSED</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_COLLECTION" title="OPTION_COLLECTION :: collection parameter"><span class="description">collection parameter</span><pre>OPTION_COLLECTION</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_CONSTRAINT" title="OPTION_CONSTRAINT :: constraint option"><span class="description">constraint option</span><pre>OPTION_CONSTRAINT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_COUNT" title="OPTION_COUNT :: count option"><span class="description">count option</span><pre>OPTION_COUNT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_CREATE_COLLECTION" title="OPTION_CREATE_COLLECTION :: example parameter"><span class="description">example parameter</span><pre>OPTION_CREATE_COLLECTION</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_DISTANCE" title="OPTION_DISTANCE :: distance parameter"><span class="description">distance parameter</span><pre>OPTION_DISTANCE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_EXAMPLE" title="OPTION_EXAMPLE :: example parameter"><span class="description">example parameter</span><pre>OPTION_EXAMPLE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_EXCLUDE_SYSTEM" title="OPTION_EXCLUDE_SYSTEM :: exclude system collections"><span class="description">exclude system collections</span><pre>OPTION_EXCLUDE_SYSTEM</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_FIELDS" title="OPTION_FIELDS :: count fields"><span class="description">count fields</span><pre>OPTION_FIELDS</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_FIGURES" title="OPTION_FIGURES :: figures option"><span class="description">figures option</span><pre>OPTION_FIGURES</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_FULLTEXT_INDEX" title="OPTION_FULLTEXT_INDEX :: fulltext index option"><span class="description">fulltext index option</span><pre>OPTION_FULLTEXT_INDEX</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_GEOJSON" title="OPTION_GEOJSON :: geoJson option"><span class="description">geoJson option</span><pre>OPTION_GEOJSON</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_GEO_INDEX" title="OPTION_GEO_INDEX :: geo index option"><span class="description">geo index option</span><pre>OPTION_GEO_INDEX</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_HASH_INDEX" title="OPTION_HASH_INDEX :: hash index option"><span class="description">hash index option</span><pre>OPTION_HASH_INDEX</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_IGNORE_NULL" title="OPTION_IGNORE_NULL :: ignoreNull option"><span class="description">ignoreNull option</span><pre>OPTION_IGNORE_NULL</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_LATITUDE" title="OPTION_LATITUDE :: latitude parameter"><span class="description">latitude parameter</span><pre>OPTION_LATITUDE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_LEFT" title="OPTION_LEFT :: left parameter"><span class="description">left parameter</span><pre>OPTION_LEFT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_LIMIT" title="OPTION_LIMIT :: limit parameter"><span class="description">limit parameter</span><pre>OPTION_LIMIT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_LOAD" title="OPTION_LOAD :: load option"><span class="description">load option</span><pre>OPTION_LOAD</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_LONGITUDE" title="OPTION_LONGITUDE :: longitude parameter"><span class="description">longitude parameter</span><pre>OPTION_LONGITUDE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_MIN_LENGTH" title="OPTION_MIN_LENGTH :: minLength option"><span class="description">minLength option</span><pre>OPTION_MIN_LENGTH</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_NEW_VALUE" title="OPTION_NEW_VALUE :: example parameter"><span class="description">example parameter</span><pre>OPTION_NEW_VALUE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_PROPERTIES" title="OPTION_PROPERTIES :: properties option"><span class="description">properties option</span><pre>OPTION_PROPERTIES</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_RADIUS" title="OPTION_RADIUS :: radius parameter"><span class="description">radius parameter</span><pre>OPTION_RADIUS</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_RENAME" title="OPTION_RENAME :: rename option"><span class="description">rename option</span><pre>OPTION_RENAME</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_RIGHT" title="OPTION_RIGHT :: right parameter"><span class="description">right parameter</span><pre>OPTION_RIGHT</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_SIZE" title="OPTION_SIZE :: size option"><span class="description">size option</span><pre>OPTION_SIZE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_SKIP" title="OPTION_SKIP :: skip parameter"><span class="description">skip parameter</span><pre>OPTION_SKIP</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_SKIPLIST_INDEX" title="OPTION_SKIPLIST_INDEX :: skiplist index option"><span class="description">skiplist index option</span><pre>OPTION_SKIPLIST_INDEX</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_TRUNCATE" title="OPTION_TRUNCATE :: truncate option"><span class="description">truncate option</span><pre>OPTION_TRUNCATE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_TYPE" title="OPTION_TYPE :: count unique"><span class="description">count unique</span><pre>OPTION_TYPE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_UNIQUE" title="OPTION_UNIQUE :: count unique"><span class="description">count unique</span><pre>OPTION_UNIQUE</pre></a></li>
<li class="constant  "><a href="#constant_OPTION_UNLOAD" title="OPTION_UNLOAD :: unload option"><span class="description">unload option</span><pre>OPTION_UNLOAD</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\triagens\ArangoDb\CollectionHandler"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/triagens.html">triagens</a></li>
<li>
<span class="divider">\</span><a href="../namespaces/triagens.ArangoDb.html">ArangoDb</a>
</li>
<li class="active">
<span class="divider">\</span><a href="../classes/triagens.ArangoDb.CollectionHandler.html">CollectionHandler</a>
</li>
</ul>
<div class="element class">
<p class="short_description">A collection handler that fetches collection data from the server and
creates collections on the server.</p>
<div class="details">
<div class="long_description"><p>It does so by issuing the
appropriate HTTP requests to the server.</p></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/triagens.ArangoDb.html">triagens\ArangoDb</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Construct a new handler</h2>
<pre>__construct(\triagens\ArangoDb\Connection $connection) : <a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::__construct()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$connection</h4>
<code><a href="../classes/triagens.ArangoDb.Connection.html">\triagens\ArangoDb\Connection</a></code><ul>
<li>connection to be used</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/triagens.ArangoDb.Handler.html">\triagens\ArangoDb\Handler</a></code></div>
</div></div>
</div>
<a id="method_add"></a><div class="element clickable method public method_add" data-toggle="collapse" data-target=".method_add .collapse">
<h2>Adds a new collection on the server</h2>
<pre>add(\triagens\ArangoDb\Collection $collection) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will add the collection on the server and return its id</p>

<p>This will throw if the collection cannot be created</p></div>
<table class="table table-bordered"><tr>
<th>deprecated</th>
<td>to be removed in version 2.0 - This function is being replaced by create()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code><a href="../classes/triagens.ArangoDb.Collection.html">\triagens\ArangoDb\Collection</a></code><ul>
<li>collection object to be created on the server</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>- id of collection created</div>
</div></div>
</div>
<a id="method_any"></a><div class="element clickable method public method_any" data-toggle="collapse" data-target=".method_any .collapse">
<h2>Get a random document from the collection.</h2>
<pre>any(mixed $collectionId) : <a href="../classes/triagens.ArangoDb.Document.html">\triagens\ArangoDb\Document</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the document cannot be fetched from the server</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Document.html">\triagens\ArangoDb\Document</a></code>- the document fetched from the server</div>
</div></div>
</div>
<a id="method_byExample"></a><div class="element clickable method public method_byExample" data-toggle="collapse" data-target=".method_byExample .collapse">
<h2>Get document(s) by specifying an example</h2>
<pre>byExample(mixed $collectionId, mixed $document, bool | array $options) : \triagens\ArangoDb\cursor</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the list cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$document</h4>
<code>mixed</code><ul>
<li>the example document as a Document object or an array</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>bool</code><code>array</code><ul>
<li>optional, prior to v1.0.0 this was a boolean value for sanitize, since v1.0.0 it's an array of options.</li>
</ul>

<p>Options are :<br>
<li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
<li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
<li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
<li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
<p>
                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
                                The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
                                and the hidden attributes would not be applied to the attributes.<br>
</p>
</li>
<li>'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch</li>
<li>'skip'      - Optional, The number of documents to skip in the query.</li>
<li>'limit'     - Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>\triagens\ArangoDb\cursor</code>- Returns a cursor containing the result</div>
</div></div>
</div>
<a id="method_count"></a><div class="element clickable method public method_count" data-toggle="collapse" data-target=".method_count .collapse">
<h2>Get the number of documents in a collection</h2>
<pre>count(mixed $collectionId) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>- the number of documents in the collection</div>
</div></div>
</div>
<a id="method_create"></a><div class="element clickable method public method_create" data-toggle="collapse" data-target=".method_create .collapse">
<h2>Creates a new collection on the server</h2>
<pre>create(mixed $collection, array $options) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will add the collection on the server and return its id
The id is mainly returned for backwards compatibility, but you should use the collection name for any reference to the collection.   *
This will throw if the collection cannot be created</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection object to be created on the server or a string with the name</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>an array of options.</li>
</ul>

<p>Options are :<br>
<li>'type' - 2 -> normal collection, 3 -> edge-collection</li>
<li>'waitForSync' -  if set to true, then all removal operations will instantly be synchronised to disk / If this is not specified, then the collection's default sync behavior will be applied.</li>
<li>'journalSize' -  journalSize value.</li>
<li>'isSystem'    -  false->user collection(default), true->system collection .</li>
<li>'isVolatile'  -  false->persistent collection(default), true->volatile (in-memory) collection .</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>- id of collection created</div>
</div></div>
</div>
<a id="method_createCapConstraint"></a><div class="element clickable method public method_createCapConstraint" data-toggle="collapse" data-target=".method_createCapConstraint .collapse">
<h2>Create a cap constraint</h2>
<pre>createCapConstraint(string $collectionId, int $size) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>link</th>
<td><a href="http://www.arangodb.org/manuals/current/IndexCapHttp.html">http://www.arangodb.org/manuals/current/IndexCapHttp.html</a></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>string</code><ul>
<li>the collection id</li>
</ul>
</div>
<div class="subelement argument">
<h4>$size</h4>
<code>int</code><ul>
<li>the size of the cap constraint</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_createFulltextIndex"></a><div class="element clickable method public method_createFulltextIndex" data-toggle="collapse" data-target=".method_createFulltextIndex .collapse">
<h2>Create a fulltext index</h2>
<pre>createFulltextIndex(string $collectionId, array $fields, int $minLength) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>link</th>
<td><a href="http://www.arangodb.org/manuals/current/IndexFulltextHttp.html">http://www.arangodb.org/manuals/current/IndexFulltextHttp.html</a></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>string</code><ul>
<li>the collection id</li>
</ul>
</div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><ul>
<li>an array of fields</li>
</ul>
</div>
<div class="subelement argument">
<h4>$minLength</h4>
<code>int</code><ul>
<li>the minimum length of words to index</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_createGeoIndex"></a><div class="element clickable method public method_createGeoIndex" data-toggle="collapse" data-target=".method_createGeoIndex .collapse">
<h2>Create a geo index</h2>
<pre>createGeoIndex(string $collectionId, array $fields, boolean $geoJson, boolean $constraint, boolean $ignoreNull) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>link</th>
<td><a href="http://www.arangodb.org/manuals/current/IndexGeoHttp.html">http://www.arangodb.org/manuals/current/IndexGeoHttp.html</a></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>string</code><ul>
<li>the collection id</li>
</ul>
</div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><ul>
<li>an array of fields</li>
</ul>
</div>
<div class="subelement argument">
<h4>$geoJson</h4>
<code>boolean</code><ul>
<li>whether to use geoJson or not</li>
</ul>
</div>
<div class="subelement argument">
<h4>$constraint</h4>
<code>boolean</code><ul>
<li>whether this is a constraint or not</li>
</ul>
</div>
<div class="subelement argument">
<h4>$ignoreNull</h4>
<code>boolean</code><ul>
<li>whether to ignore null</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_createHashIndex"></a><div class="element clickable method public method_createHashIndex" data-toggle="collapse" data-target=".method_createHashIndex .collapse">
<h2>Create a hash index</h2>
<pre>createHashIndex(string $collectionId, array $fields, boolean $unique) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>link</th>
<td><a href="http://www.arangodb.org/manuals/current/IndexHashHttp.html">http://www.arangodb.org/manuals/current/IndexHashHttp.html</a></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>string</code><ul>
<li>the collection id</li>
</ul>
</div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><ul>
<li>an array of fields</li>
</ul>
</div>
<div class="subelement argument">
<h4>$unique</h4>
<code>boolean</code><ul>
<li>whether the values in the index should be unique or not</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_createSkipListIndex"></a><div class="element clickable method public method_createSkipListIndex" data-toggle="collapse" data-target=".method_createSkipListIndex .collapse">
<h2>Create a skip-list index</h2>
<pre>createSkipListIndex(string $collectionId, array $fields, bool $unique) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>link</th>
<td><a href="http://www.arangodb.org/manuals/current/IndexSkiplistHttp.html">http://www.arangodb.org/manuals/current/IndexSkiplistHttp.html</a></td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>string</code><ul>
<li>the collection id</li>
</ul>
</div>
<div class="subelement argument">
<h4>$fields</h4>
<code>array</code><ul>
<li>an array of fields</li>
</ul>
</div>
<div class="subelement argument">
<h4>$unique</h4>
<code>bool</code><ul>
<li>whether the index is unique or not</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_delete"></a><div class="element clickable method public method_delete" data-toggle="collapse" data-target=".method_delete .collapse">
<h2>Delete a collection</h2>
<pre>delete(mixed $collection) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>deprecated</th>
<td>to be removed in version 2.0 - This function is being replaced by drop()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_drop"></a><div class="element clickable method public method_drop" data-toggle="collapse" data-target=".method_drop .collapse">
<h2>Drop a collection</h2>
<pre>drop(mixed $collection) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_dropIndex"></a><div class="element clickable method public method_dropIndex" data-toggle="collapse" data-target=".method_dropIndex .collapse">
<h2>Drop an index</h2>
<pre>dropIndex(mixed $indexHandle) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$indexHandle</h4>
<code>mixed</code><ul>
<li>index handle (collection name / index id)</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_figures"></a><div class="element clickable method public method_figures" data-toggle="collapse" data-target=".method_figures .collapse">
<h2>Get figures for a collection</h2>
<pre>figures(mixed $collectionId) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- the figures for the collection</div>
</div></div>
</div>
<a id="method_firstExample"></a><div class="element clickable method public method_firstExample" data-toggle="collapse" data-target=".method_firstExample .collapse">
<h2>Get the first document matching a given example.</h2>
<pre>firstExample(mixed $collectionId, mixed $document, bool | array $options) : <a href="../classes/triagens.ArangoDb.Document.html">\triagens\ArangoDb\Document</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the document cannot be fetched from the server</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$document</h4>
<code>mixed</code><ul>
<li>the example document as a Document object or an array</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>bool</code><code>array</code><ul>
<li>optional, an array of options.</li>
</ul>

<p>Options are :<br>
<li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
<li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
<li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
<li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
<p>
                                This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
                                The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
                                and the hidden attributes would not be applied to the attributes.<br>
</p>
</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Document.html">\triagens\ArangoDb\Document</a></code>- the document fetched from the server</div>
</div></div>
</div>
<a id="method_get"></a><div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse">
<h2>Get information about a collection</h2>
<pre>get(mixed $collectionId) : <a href="../classes/triagens.ArangoDb.Collection.html">\triagens\ArangoDb\Collection</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Collection.html">\triagens\ArangoDb\Collection</a></code>- the collection fetched from the server</div>
</div></div>
</div>
<a id="method_getAllCollections"></a><div class="element clickable method public method_getAllCollections" data-toggle="collapse" data-target=".method_getAllCollections .collapse">
<h2>Get list of all available collections per default with the collection names as index.</h2>
<pre>getAllCollections(array $options) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Returns empty array if none are available.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional - an array of options.</li>
</ul>

<p>Options are :<br>
<li>'excludeSystem' -   With a value of true, all system collections will be excluded from the response.</li>
<li>'keys' -  With a value of "collections", the index of the resulting array is numerical,
                                 With a value of "names", the index of the resulting array are the collection names.</li>
</p>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_getAllIds"></a><div class="element clickable method public method_getAllIds" data-toggle="collapse" data-target=".method_getAllIds .collapse">
<h2>Get the list of all documents' ids from a collection</h2>
<pre>getAllIds(mixed $collectionId) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the list cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- ids of documents in the collection</div>
</div></div>
</div>
<a id="method_getCollectionId"></a><div class="element clickable method public method_getCollectionId" data-toggle="collapse" data-target=".method_getCollectionId .collapse">
<h2>Gets the collectionId from the given collectionObject or string/integer</h2>
<pre>getCollectionId(mixed $collection) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a id="method_getCollectionName"></a><div class="element clickable method public method_getCollectionName" data-toggle="collapse" data-target=".method_getCollectionName .collapse">
<h2>Gets the collectionId from the given collectionObject or string/integer</h2>
<pre>getCollectionName(mixed $collection) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<a id="method_getCount"></a><div class="element clickable method public method_getCount" data-toggle="collapse" data-target=".method_getCount .collapse">
<h2>Get the number of documents in a collection</h2>
<pre>getCount(mixed $collectionId) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<table class="table table-bordered"><tr>
<th>deprecated</th>
<td>to be removed in version 2.0 - This function is being replaced by count()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>- the number of documents in the collection</div>
</div></div>
</div>
<a id="method_getFigures"></a><div class="element clickable method public method_getFigures" data-toggle="collapse" data-target=".method_getFigures .collapse">
<h2>Get figures for a collection</h2>
<pre>getFigures(mixed $collectionId) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<table class="table table-bordered"><tr>
<th>deprecated</th>
<td>to be removed in version 2.0 - This function is being replaced by figures()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- the figures for the collection</div>
</div></div>
</div>
<a id="method_getIndex"></a><div class="element clickable method public method_getIndex" data-toggle="collapse" data-target=".method_getIndex .collapse">
<h2>Get the information about an index in a collection</h2>
<pre>getIndex(string $collection, string $indexId) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>string</code><ul>
<li>the id of the collection</li>
</ul>
</div>
<div class="subelement argument">
<h4>$indexId</h4>
<code>string</code><ul>
<li>the id of the index</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response"><code>array</code></div>
</div></div>
</div>
<a id="method_getIndexes"></a><div class="element clickable method public method_getIndexes" data-toggle="collapse" data-target=".method_getIndexes .collapse">
<h2>Get indexes of a collection</h2>
<pre>getIndexes(mixed $collectionId) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>$data - the indexes result-set from the server</div>
</div></div>
</div>
<a id="method_getProperties"></a><div class="element clickable method public method_getProperties" data-toggle="collapse" data-target=".method_getProperties .collapse">
<h2>Get properties of a collection</h2>
<pre>getProperties(mixed $collectionId) : <a href="../classes/triagens.ArangoDb.Collection.html">\triagens\ArangoDb\Collection</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the collection cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as a string or number</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Collection.html">\triagens\ArangoDb\Collection</a></code>- the collection fetched from the server</div>
</div></div>
</div>
<a id="method_import"></a><div class="element clickable method public method_import" data-toggle="collapse" data-target=".method_import .collapse">
<h2>Import documents into a collection</h2>
<pre>import(mixed $collectionId, mixed $importData, array $options) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw on all errors except insertion errors</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$importData</h4>
<code>mixed</code><ul>
<li>The data to import. This can be a string holding the data according to the type of import, or an array of documents</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional - an array of options.</li>
</ul>

<p>Options are :<br>
<li>
'type' -  if type is not set or it's set to '' or null, the Header-Value format must be provided in the import file.<br>
<p>
<li>                       if set to 'documents', then the file's content must have its documents line by line. Each line will be interpreted as a document.</li>
<li>                       if set to 'array' then the file's content must provide the documents as a list of documents instead of the above line by line.</li>
<br>
                           More info on how the import functionality works: <a href ="https://github.com/triAGENS/ArangoDB/wiki/HttpImport">https://github.com/triAGENS/ArangoDB/wiki/HttpImport</a>
</p>
<br>
</li>
<li>'createCollection' - If true, create the collection if it doesn't exist. Defaults to false </li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>- number of documents that were deleted</div>
</div></div>
</div>
<a id="method_importFromFile"></a><div class="element clickable method public method_importFromFile" data-toggle="collapse" data-target=".method_importFromFile .collapse">
<h2>Import documents from a file</h2>
<pre>importFromFile(mixed $collectionId, mixed $importFileName, array $options) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw on all errors except insertion errors</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$importFileName</h4>
<code>mixed</code><ul>
<li>The filename that holds the import data.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional - an array of options.</li>
</ul>

<p>Options are :<br>
'type' -  if type is not set or it's set to '' or null, the Header-Value format must be provided in the import file.<br>
<p>
<li>                       if set to 'documents', then the file's content must have its documents line by line. Each line will be interpreted as a document.</li>
<li>                       if set to 'array' then the file's content must provide the documents as a list of documents instead of the above line by line.</li>
<br>
                             More info on how the import functionality works: <a href ="https://github.com/triAGENS/ArangoDB/wiki/HttpImport">https://github.com/triAGENS/ArangoDB/wiki/HttpImport</a>
</p>
<br>
</li>
<li>'createCollection' - If true, create the collection if it doesn't exist. Defaults to false </li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>- number of documents that were deleted</div>
</div></div>
</div>
<a id="method_index"></a><div class="element clickable method public method_index" data-toggle="collapse" data-target=".method_index .collapse">
<h2>Creates an index on a collection on the server</h2>
<pre>index(mixed $collectionId, string $type, array $attributes, bool $unique, array $indexOptions) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will create an index on the collection on the server and return its id</p>

<p>This will throw if the index cannot be created</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>The id of the collection where the index is to be created</li>
</ul>
</div>
<div class="subelement argument">
<h4>$type</h4>
<code>string</code><ul>
<li>index type: hash, skiplist or geo</li>
</ul>
</div>
<div class="subelement argument">
<h4>$attributes</h4>
<code>array</code><ul>
<li>an array of attributes that can be defined like array('a') or array('a', 'b.c')</li>
</ul>
</div>
<div class="subelement argument">
<h4>$unique</h4>
<code>bool</code><ul>
<li>true/false to create a unique index</li>
</ul>
</div>
<div class="subelement argument">
<h4>$indexOptions</h4>
<code>array</code><ul>
<li>an associative array of options for the index like array('geoJson' => true)</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- server response of the created index</div>
</div></div>
</div>
<a id="method_isValidCollectionId"></a><div class="element clickable method public method_isValidCollectionId" data-toggle="collapse" data-target=".method_isValidCollectionId .collapse">
<h2>Checks if the collectionId given, is valid.</h2>
<pre>isValidCollectionId($collectionId) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Returns true if it is, or false if it is not.</p></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$collectionId</h4></div>
<h3>Returns</h3>
<div class="subelement response"><code>bool</code></div>
</div></div>
</div>
<a id="method_load"></a><div class="element clickable method public method_load" data-toggle="collapse" data-target=".method_load .collapse">
<h2>Load a collection into the server's memory</h2>
<pre>load(mixed $collection) : <a href="../classes/triagens.ArangoDb.HttpResponse.html">\triagens\ArangoDb\HttpResponse</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will load the given collection into the server's memory.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.HttpResponse.html">\triagens\ArangoDb\HttpResponse</a></code>- HTTP response object</div>
</div></div>
</div>
<a id="method_near"></a><div class="element clickable method public method_near" data-toggle="collapse" data-target=".method_near .collapse">
<h2>Get document(s) by specifying near</h2>
<pre>near(mixed $collectionId, double $latitude, double $longitude, array $options) : <a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the list cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$latitude</h4>
<code>double</code><ul>
<li>The latitude of the coordinate.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$longitude</h4>
<code>double</code><ul>
<li>The longitude of the coordinate.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional array of options.</li>
</ul>

<p>Options are :<br>
<li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
<li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
<li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
<li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
<p>
                               This is actually the same as setting hidden attributes using setHiddenAttributes() on a document. <br>
                               The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
                               and the hidden attributes would not be applied to the attributes.<br>
</p>
<li>'distance'  - If given, the attribute key used to store the distance. (optional)
<li>'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch</li>
<li>'skip'      -  Optional, The number of documents to skip in the query.</li>
<li>'limit'     -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li>
</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></code>- documents matching the example [0...n]</div>
</div></div>
</div>
<a id="method_range"></a><div class="element clickable method public method_range" data-toggle="collapse" data-target=".method_range .collapse">
<h2>Get document(s) by specifying range</h2>
<pre>range(mixed $collectionId, string $attribute, mixed $left, mixed $right, array $options) : <a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the list cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$attribute</h4>
<code>string</code><ul>
<li>the attribute path , like 'a', 'a.b', etc...</li>
</ul>
</div>
<div class="subelement argument">
<h4>$left</h4>
<code>mixed</code><ul>
<li>The lower bound.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$right</h4>
<code>mixed</code><ul>
<li>The upper bound.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional array of options.</li>
</ul>

<p>Options are :<br>
<li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
<li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
<li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
<li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
<p>
                               This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
                               The difference is, that if you're returning a resultset of documents, the getAll() is already called<br>
                               and the hidden attributes would not be applied to the attributes.<br>
</p>
<li>'closed'    - If true, use interval including left and right, otherwise exclude right, but include left.
<li>'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch</li>
<li>'skip'      -  Optional, The number of documents to skip in the query.</li>
<li>'limit'     -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li>
</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></code>- documents matching the example [0...n]</div>
</div></div>
</div>
<a id="method_removeByExample"></a><div class="element clickable method public method_removeByExample" data-toggle="collapse" data-target=".method_removeByExample .collapse">
<h2>Remove document(s) by specifying an example</h2>
<pre>removeByExample(mixed $collectionId, mixed $document, bool | array $options) : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw on any error</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$document</h4>
<code>mixed</code><ul>
<li>the example document as a Document object or an array</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>bool</code><code>array</code><ul>
<li>optional - an array of options.</li>
</ul>

<p>Options are :<br>
<li>
'waitForSync' -  if set to true, then all removal operations will instantly be synchronised to disk.<br>
                                If this is not specified, then the collection's default sync behavior will be applied.
</li>
</p>

<p><li>'limit' -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li></p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>int</code>- number of documents that were deleted</div>
</div></div>
</div>
<a id="method_rename"></a><div class="element clickable method public method_rename" data-toggle="collapse" data-target=".method_rename .collapse">
<h2>Rename a collection</h2>
<pre>rename(mixed $collection, string $name) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code><ul>
<li>new name for collection</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_replaceByExample"></a><div class="element clickable method public method_replaceByExample" data-toggle="collapse" data-target=".method_replaceByExample .collapse">
<h2>Replace document(s) matching a given example</h2>
<pre>replaceByExample(mixed $collectionId, mixed $example, mixed $newValue, mixed $options) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will replace the document(s) on the server</p>

<p>This will throw if the document cannot be replaced</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$example</h4>
<code>mixed</code><ul>
<li>the example document as a Document object or an array</li>
</ul>
</div>
<div class="subelement argument">
<h4>$newValue</h4>
<code>mixed</code><ul>
<li>patch document or array which contains the attributes and values to be replaced</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>mixed</code><ul>
<li>optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)</li>
</ul>

<p>Options are :
<li>'keepNull'    - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)</li>
<li>'waitForSync' - can be used to force synchronisation of the document replace operation to disk even in case that the waitForSync flag had been disabled for the entire collection</li>
<li>'limit'       - can be used set a limit on how many documents to replace at most. If limit is specified but is less than the number of documents in the collection, it is undefined which of the documents will be replaced.</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_truncate"></a><div class="element clickable method public method_truncate" data-toggle="collapse" data-target=".method_truncate .collapse">
<h2>Truncate a collection</h2>
<pre>truncate(mixed $collection) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will remove all documents from the collection but will leave the metadata and indexes intact.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_unload"></a><div class="element clickable method public method_unload" data-toggle="collapse" data-target=".method_unload .collapse">
<h2>Unload a collection from the server's memory</h2>
<pre>unload(mixed $collection) : <a href="../classes/triagens.ArangoDb.HttpResponse.html">\triagens\ArangoDb\HttpResponse</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will unload the given collection from the server's memory.</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collection</h4>
<code>mixed</code><ul>
<li>collection id as string or number or collection object</li>
</ul>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.HttpResponse.html">\triagens\ArangoDb\HttpResponse</a></code>- HTTP response object</div>
</div></div>
</div>
<a id="method_updateByExample"></a><div class="element clickable method public method_updateByExample" data-toggle="collapse" data-target=".method_updateByExample .collapse">
<h2>Update document(s) matching a given example</h2>
<pre>updateByExample(mixed $collectionId, mixed $example, mixed $newValue, mixed $options) : bool</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will update the document(s) on the server</p>

<p>This will throw if the document cannot be updated</p></div>
<table class="table table-bordered"><tr>
<th>since</th>
<td>1.2</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$example</h4>
<code>mixed</code><ul>
<li>the example document as a Document object or an array</li>
</ul>
</div>
<div class="subelement argument">
<h4>$newValue</h4>
<code>mixed</code><ul>
<li>patch document or array which contains the attributes and values to be updated</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>mixed</code><ul>
<li>optional, array of options (see below) or the boolean value for $policy (for compatibility prior to version 1.1 of this method)</li>
</ul>

<p>Options are :
<li>'keepNull'    - can be used to instruct ArangoDB to delete existing attributes instead setting their values to null. Defaults to true (keep attributes when set to null)</li>
<li>'waitForSync' - can be used to force synchronisation of the document update operation to disk even in case that the waitForSync flag had been disabled for the entire collection</li>
<li>'limit'       - can be used set a limit on how many documents to update at most. If limit is specified but is less than the number of documents in the collection, it is undefined which of the documents will be updated.</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code>bool</code>- always true, will throw if there is an error</div>
</div></div>
</div>
<a id="method_within"></a><div class="element clickable method public method_within" data-toggle="collapse" data-target=".method_within .collapse">
<h2>Get document(s) by specifying within</h2>
<pre>within(mixed $collectionId, double $latitude, double $longitude, int $radius, array $options) : <a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This will throw if the list cannot be fetched from the server</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$collectionId</h4>
<code>mixed</code><ul>
<li>collection id as string or number</li>
</ul>
</div>
<div class="subelement argument">
<h4>$latitude</h4>
<code>double</code><ul>
<li>The latitude of the coordinate.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$longitude</h4>
<code>double</code><ul>
<li>The longitude of the coordinate.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$radius</h4>
<code>int</code><ul>
<li>The maximal radius (in meters).</li>
</ul>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>optional array of options.</li>
</ul>

<p>Options are :<br>
<li>'_sanitize'         - True to remove _id and _rev attributes from result documents. Defaults to false.</li>
<li>'sanitize'          - Deprecated, please use '_sanitize'.</li>
<li>'_hiddenAttributes' - Set an array of hidden attributes for created documents.
<li>'hiddenAttributes'  - Deprecated, please use '_hiddenAttributes'.</li>
<p>
                               This is actually the same as setting hidden attributes using setHiddenAttributes() on a document.<br>
                               The difference is, that if you're returning a resultset of documents, the getAll() is already called <br>
                               and the hidden attributes would not be applied to the attributes.<br>
</p>
<li>'distance'  - If given, the attribute key used to store the distance. (optional)
<li>'batchSize' - can optionally be used to tell the server to limit the number of results to be transferred in one batch</li>
<li>'skip'      -  Optional, The number of documents to skip in the query.</li>
<li>'limit'     -  Optional, The maximal amount of documents to return. 'skip' is applied before the limit restriction.</li>
</li>
</p>
</div>
<h3>Exceptions</h3>
<table class="table table-bordered"><tr>
<th><code><a href="../classes/triagens.ArangoDb.Exception.html">\triagens\ArangoDb\Exception</a></code></th>
<td></td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Cursor.html">\triagens\ArangoDb\Cursor</a></code>- documents matching the example [0...n]</div>
</div></div>
</div>
<a id="method_getConnection"></a><div class="element clickable method protected method_getConnection" data-toggle="collapse" data-target=".method_getConnection .collapse">
<h2>Return the connection object</h2>
<pre>getConnection() : <a href="../classes/triagens.ArangoDb.Connection.html">\triagens\ArangoDb\Connection</a></pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::getConnection()</td>
</tr></table>
<h3>Returns</h3>
<div class="subelement response">
<code><a href="../classes/triagens.ArangoDb.Connection.html">\triagens\ArangoDb\Connection</a></code>- the connection object</div>
</div></div>
</div>
<a id="method_getConnectionOption"></a><div class="element clickable method protected method_getConnectionOption" data-toggle="collapse" data-target=".method_getConnectionOption .collapse">
<h2>Return a connection option
This is a convenience function that calls json_encode_wrapper on the connection</h2>
<pre>getConnectionOption($optionName) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::getConnectionOption()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$optionName</h4><ul>
<li>The option to return a value for</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>- the option's value</div>
</div></div>
</div>
<a id="method_getCursorOptions"></a><div class="element clickable method protected method_getCursorOptions" data-toggle="collapse" data-target=".method_getCursorOptions .collapse">
<h2>Return an array of cursor options</h2>
<pre>getCursorOptions(mixed $options) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::getCursorOptions()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>mixed</code><ul>
<li>$options might be a boolean sanitize value, or an array of options, with or without a '_sanitize' key.</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>- array of options</div>
</div></div>
</div>
<a id="method_includeOptionsInBody"></a><div class="element clickable method protected method_includeOptionsInBody" data-toggle="collapse" data-target=".method_includeOptionsInBody .collapse">
<h2>Helper function that runs through the options given and includes them into the parameters array given.</h2>
<pre>includeOptionsInBody(array $options, array $body, array $includeArray) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Only options that are set in $includeArray will be included.
This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .</p></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::includeOptionsInBody()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>The options array that holds the options to include in the parameters</li>
</ul>
</div>
<div class="subelement argument">
<h4>$body</h4>
<code>array</code><ul>
<li>The array into which the options will be included.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$includeArray</h4>
<code>array</code><ul>
<li>The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>$params - array of parameters for use in a url</div>
</div></div>
</div>
<a id="method_includeOptionsInParams"></a><div class="element clickable method protected method_includeOptionsInParams" data-toggle="collapse" data-target=".method_includeOptionsInParams .collapse">
<h2>Helper function that runs through the options given and includes them into the parameters array given.</h2>
<pre>includeOptionsInParams(array $options, array $params, array $includeArray) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>Only options that are set in $includeArray will be included.
This is only for options that are to be sent to the ArangoDB server in form of url parameters (like 'waitForSync', 'keepNull', etc...) .</p></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::includeOptionsInParams()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>The options array that holds the options to include in the parameters</li>
</ul>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><ul>
<li>The parameters into which the options will be included.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$includeArray</h4>
<code>array</code><ul>
<li>The array that defines which options are allowed to be included, and what their default value is. for example: 'waitForSync'=>true</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>$params - array of parameters for use in a url</div>
</div></div>
</div>
<a id="method_json_encode_wrapper"></a><div class="element clickable method protected method_json_encode_wrapper" data-toggle="collapse" data-target=".method_json_encode_wrapper .collapse">
<h2>Return a json encoded string for the array passed.</h2>
<pre>json_encode_wrapper(array $body) : string</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This is a convenience function that calls json_encode_wrapper on the connection</p></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::json_encode_wrapper()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$body</h4>
<code>array</code><ul>
<li>The body to encode into json</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>string</code>- json string of the body that was passed</div>
</div></div>
</div>
<a id="method_validateAndIncludeOldSingleParameterInParams"></a><div class="element clickable method protected method_validateAndIncludeOldSingleParameterInParams" data-toggle="collapse" data-target=".method_validateAndIncludeOldSingleParameterInParams .collapse">
<h2>Helper function that validates and includes an old single method parameter setting into the parameters array given.</h2>
<pre>validateAndIncludeOldSingleParameterInParams(array $options, array $params, mixed $parameter) : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>This is only for keeping backwards-compatibility where methods had for example a parameter which was called 'policy' and
which was later changed to being an array of options, so more than one options can be passed easily.
This is only for options that are to be sent to the ArangoDB server.</p></div>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::validateAndIncludeOldSingleParameterInParams()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code><ul>
<li>The options array that may hold the policy to include in the parameters. If it's not an array, then the value is the policy value.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$params</h4>
<code>array</code><ul>
<li>The parameters into which the options will be included.</li>
</ul>
</div>
<div class="subelement argument">
<h4>$parameter</h4>
<code>mixed</code><ul>
<li>the old single parameter key to use.</li>
</ul>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>$params - array of parameters for use in a url</div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property__connection"> </a><div class="element clickable property private property__connection" data-toggle="collapse" data-target=".property__connection .collapse">
<h2></h2>
<pre>$_connection </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>param</th>
<td></td>
</tr>
<tr>
<th>inherited_from</th>
<td>\triagens\ArangoDb\Handler::$$_connection</td>
</tr>
</table>
</div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_ENTRY_DOCUMENTS"> </a><div class="element clickable constant  constant_ENTRY_DOCUMENTS" data-toggle="collapse" data-target=".constant_ENTRY_DOCUMENTS .collapse">
<h2>documents array index</h2>
<pre>ENTRY_DOCUMENTS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_ATTRIBUTE"> </a><div class="element clickable constant  constant_OPTION_ATTRIBUTE" data-toggle="collapse" data-target=".constant_OPTION_ATTRIBUTE .collapse">
<h2>attribute parameter</h2>
<pre>OPTION_ATTRIBUTE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_CAP_CONSTRAINT"> </a><div class="element clickable constant  constant_OPTION_CAP_CONSTRAINT" data-toggle="collapse" data-target=".constant_OPTION_CAP_CONSTRAINT .collapse">
<h2>cap constraint option</h2>
<pre>OPTION_CAP_CONSTRAINT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_CLOSED"> </a><div class="element clickable constant  constant_OPTION_CLOSED" data-toggle="collapse" data-target=".constant_OPTION_CLOSED .collapse">
<h2>closed parameter</h2>
<pre>OPTION_CLOSED </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_COLLECTION"> </a><div class="element clickable constant  constant_OPTION_COLLECTION" data-toggle="collapse" data-target=".constant_OPTION_COLLECTION .collapse">
<h2>collection parameter</h2>
<pre>OPTION_COLLECTION </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_CONSTRAINT"> </a><div class="element clickable constant  constant_OPTION_CONSTRAINT" data-toggle="collapse" data-target=".constant_OPTION_CONSTRAINT .collapse">
<h2>constraint option</h2>
<pre>OPTION_CONSTRAINT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_COUNT"> </a><div class="element clickable constant  constant_OPTION_COUNT" data-toggle="collapse" data-target=".constant_OPTION_COUNT .collapse">
<h2>count option</h2>
<pre>OPTION_COUNT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_CREATE_COLLECTION"> </a><div class="element clickable constant  constant_OPTION_CREATE_COLLECTION" data-toggle="collapse" data-target=".constant_OPTION_CREATE_COLLECTION .collapse">
<h2>example parameter</h2>
<pre>OPTION_CREATE_COLLECTION </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_DISTANCE"> </a><div class="element clickable constant  constant_OPTION_DISTANCE" data-toggle="collapse" data-target=".constant_OPTION_DISTANCE .collapse">
<h2>distance parameter</h2>
<pre>OPTION_DISTANCE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_EXAMPLE"> </a><div class="element clickable constant  constant_OPTION_EXAMPLE" data-toggle="collapse" data-target=".constant_OPTION_EXAMPLE .collapse">
<h2>example parameter</h2>
<pre>OPTION_EXAMPLE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_EXCLUDE_SYSTEM"> </a><div class="element clickable constant  constant_OPTION_EXCLUDE_SYSTEM" data-toggle="collapse" data-target=".constant_OPTION_EXCLUDE_SYSTEM .collapse">
<h2>exclude system collections</h2>
<pre>OPTION_EXCLUDE_SYSTEM </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_FIELDS"> </a><div class="element clickable constant  constant_OPTION_FIELDS" data-toggle="collapse" data-target=".constant_OPTION_FIELDS .collapse">
<h2>count fields</h2>
<pre>OPTION_FIELDS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_FIGURES"> </a><div class="element clickable constant  constant_OPTION_FIGURES" data-toggle="collapse" data-target=".constant_OPTION_FIGURES .collapse">
<h2>figures option</h2>
<pre>OPTION_FIGURES </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_FULLTEXT_INDEX"> </a><div class="element clickable constant  constant_OPTION_FULLTEXT_INDEX" data-toggle="collapse" data-target=".constant_OPTION_FULLTEXT_INDEX .collapse">
<h2>fulltext index option</h2>
<pre>OPTION_FULLTEXT_INDEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_GEOJSON"> </a><div class="element clickable constant  constant_OPTION_GEOJSON" data-toggle="collapse" data-target=".constant_OPTION_GEOJSON .collapse">
<h2>geoJson option</h2>
<pre>OPTION_GEOJSON </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_GEO_INDEX"> </a><div class="element clickable constant  constant_OPTION_GEO_INDEX" data-toggle="collapse" data-target=".constant_OPTION_GEO_INDEX .collapse">
<h2>geo index option</h2>
<pre>OPTION_GEO_INDEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_HASH_INDEX"> </a><div class="element clickable constant  constant_OPTION_HASH_INDEX" data-toggle="collapse" data-target=".constant_OPTION_HASH_INDEX .collapse">
<h2>hash index option</h2>
<pre>OPTION_HASH_INDEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_IGNORE_NULL"> </a><div class="element clickable constant  constant_OPTION_IGNORE_NULL" data-toggle="collapse" data-target=".constant_OPTION_IGNORE_NULL .collapse">
<h2>ignoreNull option</h2>
<pre>OPTION_IGNORE_NULL </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_LATITUDE"> </a><div class="element clickable constant  constant_OPTION_LATITUDE" data-toggle="collapse" data-target=".constant_OPTION_LATITUDE .collapse">
<h2>latitude parameter</h2>
<pre>OPTION_LATITUDE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_LEFT"> </a><div class="element clickable constant  constant_OPTION_LEFT" data-toggle="collapse" data-target=".constant_OPTION_LEFT .collapse">
<h2>left parameter</h2>
<pre>OPTION_LEFT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_LIMIT"> </a><div class="element clickable constant  constant_OPTION_LIMIT" data-toggle="collapse" data-target=".constant_OPTION_LIMIT .collapse">
<h2>limit parameter</h2>
<pre>OPTION_LIMIT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_LOAD"> </a><div class="element clickable constant  constant_OPTION_LOAD" data-toggle="collapse" data-target=".constant_OPTION_LOAD .collapse">
<h2>load option</h2>
<pre>OPTION_LOAD </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_LONGITUDE"> </a><div class="element clickable constant  constant_OPTION_LONGITUDE" data-toggle="collapse" data-target=".constant_OPTION_LONGITUDE .collapse">
<h2>longitude parameter</h2>
<pre>OPTION_LONGITUDE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_MIN_LENGTH"> </a><div class="element clickable constant  constant_OPTION_MIN_LENGTH" data-toggle="collapse" data-target=".constant_OPTION_MIN_LENGTH .collapse">
<h2>minLength option</h2>
<pre>OPTION_MIN_LENGTH </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_NEW_VALUE"> </a><div class="element clickable constant  constant_OPTION_NEW_VALUE" data-toggle="collapse" data-target=".constant_OPTION_NEW_VALUE .collapse">
<h2>example parameter</h2>
<pre>OPTION_NEW_VALUE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_PROPERTIES"> </a><div class="element clickable constant  constant_OPTION_PROPERTIES" data-toggle="collapse" data-target=".constant_OPTION_PROPERTIES .collapse">
<h2>properties option</h2>
<pre>OPTION_PROPERTIES </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_RADIUS"> </a><div class="element clickable constant  constant_OPTION_RADIUS" data-toggle="collapse" data-target=".constant_OPTION_RADIUS .collapse">
<h2>radius parameter</h2>
<pre>OPTION_RADIUS </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_RENAME"> </a><div class="element clickable constant  constant_OPTION_RENAME" data-toggle="collapse" data-target=".constant_OPTION_RENAME .collapse">
<h2>rename option</h2>
<pre>OPTION_RENAME </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_RIGHT"> </a><div class="element clickable constant  constant_OPTION_RIGHT" data-toggle="collapse" data-target=".constant_OPTION_RIGHT .collapse">
<h2>right parameter</h2>
<pre>OPTION_RIGHT </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_SIZE"> </a><div class="element clickable constant  constant_OPTION_SIZE" data-toggle="collapse" data-target=".constant_OPTION_SIZE .collapse">
<h2>size option</h2>
<pre>OPTION_SIZE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_SKIP"> </a><div class="element clickable constant  constant_OPTION_SKIP" data-toggle="collapse" data-target=".constant_OPTION_SKIP .collapse">
<h2>skip parameter</h2>
<pre>OPTION_SKIP </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_SKIPLIST_INDEX"> </a><div class="element clickable constant  constant_OPTION_SKIPLIST_INDEX" data-toggle="collapse" data-target=".constant_OPTION_SKIPLIST_INDEX .collapse">
<h2>skiplist index option</h2>
<pre>OPTION_SKIPLIST_INDEX </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_TRUNCATE"> </a><div class="element clickable constant  constant_OPTION_TRUNCATE" data-toggle="collapse" data-target=".constant_OPTION_TRUNCATE .collapse">
<h2>truncate option</h2>
<pre>OPTION_TRUNCATE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_TYPE"> </a><div class="element clickable constant  constant_OPTION_TYPE" data-toggle="collapse" data-target=".constant_OPTION_TYPE .collapse">
<h2>count unique</h2>
<pre>OPTION_TYPE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_UNIQUE"> </a><div class="element clickable constant  constant_OPTION_UNIQUE" data-toggle="collapse" data-target=".constant_OPTION_UNIQUE .collapse">
<h2>count unique</h2>
<pre>OPTION_UNIQUE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_OPTION_UNLOAD"> </a><div class="element clickable constant  constant_OPTION_UNLOAD" data-toggle="collapse" data-target=".constant_OPTION_UNLOAD .collapse">
<h2>unload option</h2>
<pre>OPTION_UNLOAD </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-05-11T17:21:43+03:00.<br></footer></div>
</div>
</body>
</html>
Return current item: ArangoDB-PHP