view release on metacpan or  search on metacpan

lib/ArangoDB2/Replication.pm  view on Meta::CPAN

=item clusterInventory

GET /_api/replication/clusterInventory

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

Parameters:

    includeSystem

=item dump

GET /_api/replication/dump

Returns the data from the collection for the requested range.

Parameters:

    chunkSize
    collection
    from
    ticks
    to

=item 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

=item loggerFollow

GET /_api/replication/logger-follow

Parameters:

    chunkSize
    from
    to

=item loggerState

GET /_api/replication/logger-state

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

=item 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.

=item sync

PUT /_api/replication/sync

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

Parameters:

    configuration

=back

=head1 PROPERTY METHODS

=over 4

=item chunkSize

Approximate maximum size of the returned result.

=item collection

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

=item configuration

JSON representation of the configuration

=item from

Lower bound tick value for results.

=item includeSystem

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

=item ticks

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

=item to

Upper bound tick value for results.

=back

=head1 AUTHOR

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

http://ersun.warnckes.com

=head1 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.

=cut