/ 
ArangoDB2-0.10
River stage zero No dependents
/ ArangoDB2::Admin

NAME

ArangoDB2::Admin - ArangoDB admin API methods

API METHODS

echo

GET /_admin/echo

Returns current request info.

execute

POST /_admin/execute

Executes the javascript code in the body on the server.

Parameters:

program
log

GET /_admin/log

Returns the log files.

Parameters:

upto
level
start
size
offset
search
sort
returnAsJSON

When executing program set to true to get a JSON object result.

routingReload

POST /_admin/routing/reload

Reloads the routing information from the collection routing.

statistics

GET /_admin/statistics

Returns the statistics information.

statisticsDescription

GET /_admin/statistics-description

Returns a description of the statistics returned by /_admin/statistics.

serverRole

GET /_admin/server/role

Returns the role of a server in a cluster.

shutdown

GET /_admin/shutdown

This call initiates a clean shutdown sequence.

test

POST /_admin/test

Executes the specified tests on the server and returns an object with the test results.

Parameters:

tests
time

GET /_admin/time

The call returns an object with the attribute time.

walFlush

PUT /_admin/wal/flush

Flushes the write-ahead log.

Parameters:

waitForSync
waitForCollector
walProperties

GET /_admin/wal/properties PUT /_admin/wal/properties

Configures the behavior of the write-ahead log.

Parameters:

allowOversizeEntries
logfileSize
historicLogfiles
reserveLogfiles
throttleWait
throttleWhenPending

PROPERTY METHODS

allowOversizeEntries

Whether or not operations that are bigger than a single logfile can be executed and stored.

level

Returns all log entries of log level level. Note that the URL parameters upto and level are mutually exclusive.

logfileSize

The size of each write-ahead logfile.

historicLogfiles

The maximum number of historic logfiles to keep.

offset

Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination.

program

Code of javascript program to be executed.

reserveLogfiles

The maximum number of reserve logfiles that ArangoDB allocates in the background.

Only return the log entries containing the text specified in search.

size

Restricts the result to at most size log entries.

sort

Sort the log entries either ascending (if sort is asc) or descending (if sort is desc) according to their lid values. Note that the lid imposes a chronological order. The default value is asc.

start

Returns all log entries such that their log entry identifier (lid value) is greater or equal to start.

tests

A list of files containing the test suites to run.

throttleWait

The maximum wait time that operations will wait before they get aborted if case of write-throttling (in milliseconds).

throttleWhenPending

The number of unprocessed garbage-collection operations that, when reached, will activate write-throttling. A value of 0 means that write-throttling will not be triggered.

upto

Returns all log entries up to log level upto. Note that upto must be:

fatal or 0
error or 1
warning or 2
info or 3
debug or 4

The default value is info.

waitForCollector

Whether or not the operation should block until the data in the flushed log has been collected.

waitForSync

Whether or not the operation should block until the not-yet synchronized data in the write-ahead log was synchronized to disk.

AUTHOR

Ersun Warncke, <ersun.warncke at outlook.com>

http://ersun.warnckes.com

COPYRIGHT

Copyright (C) 2014 Ersun Warncke

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.