Provides access to ArangoDB's administration interface
The admin handler utilizes ArangoDB's Admin API.
| package | ArangoDBClient |
|---|---|
| since | 1.2 |
| inherited_from | \ArangoDBClient\Handler |
__construct(\ArangoDBClient\Connection $connection)
\ArangoDBClient\ConnectiongetEngine() : mixed
This will throw if the engine data cannot be retrieved
| since | 3.2 |
|---|
\ArangoDBClient\Exception |
|---|
mixed- an object returning the engine informationgetServerLog(array $options = array()) : array
This will throw if the log cannot be retrieved
| since | 1.2 |
|---|
arrayOptions are :
\ArangoDBClient\Exception |
|---|
array- an array holding the various attributes of a log: lid, level, timestamp, text and the total amount of log entries before pagination.getServerRole() : string
This will throw if the role cannot be retrieved
| since | 2.0 |
|---|
\ArangoDBClient\Exception |
|---|
string- a string holding the server role (e.g. UNDEFINED, COORDINATOR, DBSERVER)getServerStatistics() : array
For instance, to access a figure userTime from the group system, you first select the sub-object describing the group stored in system and in that sub-object the value for userTime is stored in the attribute of the same name.In case of a distribution, the returned object contains the total count in count and the distribution list in counts. For more information on the statistics returned, please lookup the statistics interface description at
| link | This will throw if the statistics cannot be retrieved |
|---|---|
| see | |
| since | 1.3 |
\ArangoDBClient\Exception |
|---|
arraygetServerStatisticsDescription(array $options = array()) : array
The returned objects contains a list of statistics groups in the attribute groups and a list of statistics figures in the attribute figures. For more information on the statistics returned, please lookup the statistics interface description at
| link | This will throw if the statistics-description cannot be retrieved |
|---|---|
| see | |
| since | 1.3 |
arrayOptions are :
\ArangoDBClient\Exception |
|---|
arraygetServerTime() : double
This will throw if the time cannot be retrieved
| since | 1.2 |
|---|
\ArangoDBClient\Exception |
|---|
double- a double holding the timestampgetServerVersion(boolean $details = false) : string
This will throw if the version cannot be retrieved
| since | 1.2 |
|---|
boolean\ArangoDBClient\Exception |
|---|
string- a string holding the ArangoDB versionreloadServerRouting() : boolean
This will throw if the routing cannot be reloaded
| since | 1.2 |
|---|
\ArangoDBClient\Exception |
|---|
booleansetDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassableaddTransactionHeader(array $headers, mixed $collection)
arraymixedgetConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection objectgetConnectionOption($optionName) : mixed
\ArangoDBClient\ClientException |
|---|
mixed- the option's valueincludeOptionsInBody(array $options, array $body, array $includeArray = array()) : array
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...) .
arrayarrayarrayarray$params - array of parameters for use in a urljson_encode_wrapper(array $body) : string
This is a convenience function that calls json_encode_wrapper on the connection
array\ArangoDBClient\ClientException |
|---|
string- json string of the body that was passedmakeCollection(mixed $value) : string
mixed\ArangoDBClient\ClientException |
|---|
string- collection name$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_connection
| param |
|---|
OPTION_DETAILS = 'details'