Class Replicator

java.lang.Object
org.lightcouch.Replicator

public class Replicator extends Object
This class provides access to the _replicator database introduced in CouchDB version 1.1.0

A replication is triggered by persisting a document, and cancelled by removing the document that triggered the replication.

Usage Example:

 Response response = dbClient.replicator()
        .source("source-db")
        .target("target-db")
        .continuous(true)
        .createTarget(true)
        .replicatorDB("replicator-db-name") // optional, defaults to _replicator
        .replicatorDocId("doc-id")          // optional, defaults to UUID 
        .save(); // trigger replication
 
 ReplicatorDocument replicatorDoc = dbClient.replicator()
        .replicatorDocId("doc-id")
        .replicatorDocRev("doc-rev") // optional
        .find();
 
 
 List<ReplicatorDocument> replicatorDocs = dbClient.replicator().findAll();
 
 
 Response response = dbClient.replicator()
        .replicatorDocId("doc-id")
        .replicatorDocRev("doc-rev")
        .remove(); // cancels a replication
 
Since:
0.0.2
See Also: