OPTION_DETAILS
OPTION_DETAILS
details for server version
Provides access to ArangoDB's administration interface
The admin handler utilizes ArangoDB's Admin API.
__construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
Construct a new handler
\triagens\ArangoDb\Connection | $connection |
|
getServerLog(array $options) : array
Get the server log
This will throw if the log cannot be retrieved
array | $options |
|
flushServerModuleCache() : array
Flush the server's modules cache The call triggers a flush of the modules cache on the server. See Modules Cache for details about this cache.
This will throw if the modules cache cannot be flushed
getServerStatistics() : array
Get the server statistics Returns the statistics information. The returned objects contains the statistics figures, grouped together according to the description returned by _admin/statistics-description.
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
getServerStatisticsDescription(array $options) : array
Returns a description of the statistics returned by getServerStatistics().
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
array | $options |
|
getConnection() : \triagens\ArangoDb\Connection
Return the connection object
json_encode_wrapper(array $body) : string
Return a json encoded string for the array passed.
This is a convenience function that calls json_encode_wrapper on the connection
array | $body |
|
validateAndIncludeOldSingleParameterInParams(array $options, array $params, mixed $parameter) : array
Helper function that validates and includes an old single method parameter setting into the parameters array given.
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.
array | $options |
|
array | $params |
|
mixed | $parameter |
|
$params - array of parameters for use in a url
includeOptionsInParams(array $options, array $params, array $includeArray) : array
Helper function that runs through the options given and includes them into the parameters array given.
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...) .
array | $options |
|
array | $params |
|
array | $includeArray |
|
$params - array of parameters for use in a url
includeOptionsInBody(array $options, array $body, array $includeArray) : array
Helper function that runs through the options given and includes them into the parameters array given.
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...) .
array | $options |
|
array | $body |
|
array | $includeArray |
|
$params - array of parameters for use in a url