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

NAME

ArangoDB2::Replication - ArangoDB replication API methods

DESCRIPTION

API METHODS

applierConfig

GET /_api/replication/applier-config PUT /_api/replication/applier-config

Returns the configuration of the replication applier or sets the configuration of the replication applier.

Parameters:

configuration
applierStart

PUT /_api/replication/applier-start

Starts the replication applier.

Parameters:

from
applierState

GET /_api/replication/applier-state

Returns the state of the replication applier, regardless of whether the applier is currently running or not.

applierStop

PUT /_api/replication/applier-stop

Stops the replication applier.

clusterInventory

GET /_api/replication/clusterInventory

Returns the list of collections and indexes available on the cluster.

Parameters:

includeSystem
dump

GET /_api/replication/dump

Returns the data from the collection for the requested range.

Parameters:

chunkSize
collection
from
ticks
to
inventory

GET /_api/replication/inventory

Returns the list of collections and indexes available on the server. This list can be used by replication clients to initiate an initial sync with the server.

Parameters:

includeSystem
loggerFollow

GET /_api/replication/logger-follow

Parameters:

chunkSize
from
to
loggerState

GET /_api/replication/logger-state

Returns the current state of the server's replication logger.

serverId

GET /_api/replication/server-id

Returns the servers id. The id is also returned by other replication API methods, and this method is an easy means of determining a server's id.

sync

PUT /_api/replication/sync

Starts a full data synchronization from a remote endpoint into the local ArangoDB database.

Parameters:

configuration

PROPERTY METHODS

chunkSize

Approximate maximum size of the returned result.

collection

The name or id of the collection to dump. Accepts string or ArangoDB2::COllection object.

configuration

JSON representation of the configuration

from

Lower bound tick value for results.

includeSystem

Include system collections in the result. The default value is false.

ticks

Whether or not to include tick values in the dump. Default value is true.

to

Upper bound tick value for results.

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.