Class Replicator


  • public class Replicator
    extends java.lang.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:
    CouchDbClientBase.replicator(), Replication, ReplicatorDocument
    • Field Detail

      • replicatorDB

        private java.lang.String replicatorDB
      • userCtxName

        private java.lang.String userCtxName
      • userCtxRoles

        private java.lang.String[] userCtxRoles
      • dbURI

        private java.net.URI dbURI
    • Method Detail

      • save

        public Response save()
        Adds a new document to the replicator database.
        Returns:
        Response
      • remove

        public Response remove()
        Removes a document from the replicator database.
        Returns:
        Response
      • source

        public Replicator source​(java.lang.String source)
      • target

        public Replicator target​(java.lang.String target)
      • continuous

        public Replicator continuous​(boolean continuous)
      • filter

        public Replicator filter​(java.lang.String filter)
      • queryParams

        public Replicator queryParams​(java.lang.String queryParams)
      • queryParams

        public Replicator queryParams​(java.util.Map<java.lang.String,​java.lang.Object> queryParams)
      • docIds

        public Replicator docIds​(java.lang.String... docIds)
      • proxy

        public Replicator proxy​(java.lang.String proxy)
      • createTarget

        public Replicator createTarget​(java.lang.Boolean createTarget)
      • replicatorDB

        public Replicator replicatorDB​(java.lang.String replicatorDB)
      • replicatorDocId

        public Replicator replicatorDocId​(java.lang.String replicatorDocId)
      • replicatorDocRev

        public Replicator replicatorDocRev​(java.lang.String replicatorDocRev)
      • workerProcesses

        public Replicator workerProcesses​(int workerProcesses)
      • workerBatchSize

        public Replicator workerBatchSize​(int workerBatchSize)
      • httpConnections

        public Replicator httpConnections​(int httpConnections)
      • connectionTimeout

        public Replicator connectionTimeout​(long connectionTimeout)
      • retriesPerRequest

        public Replicator retriesPerRequest​(int retriesPerRequest)
      • userCtxName

        public Replicator userCtxName​(java.lang.String userCtxName)
      • userCtxRoles

        public Replicator userCtxRoles​(java.lang.String... userCtxRoles)
      • sinceSeq

        public Replicator sinceSeq​(java.lang.String sinceSeq)