Package org.lightcouch
Class Replicator
java.lang.Object
org.lightcouch.Replicator
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate CouchDbClientBase
private URI
private String
private ReplicatorDocument
private String
private String[]
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconnectionTimeout
(long connectionTimeout) continuous
(boolean continuous) createTarget
(Boolean createTarget) find()
Finds a document in the replicator database.findAll()
Finds all documents in the replicator database.httpConnections
(int httpConnections) queryParams
(String queryParams) queryParams
(Map<String, Object> queryParams) remove()
Removes a document from the replicator database.replicatorDB
(String replicatorDB) replicatorDocId
(String replicatorDocId) replicatorDocRev
(String replicatorDocRev) retriesPerRequest
(int retriesPerRequest) save()
Adds a new document to the replicator database.userCtxName
(String userCtxName) userCtxRoles
(String... userCtxRoles) workerBatchSize
(int workerBatchSize) workerProcesses
(int workerProcesses)
-
Field Details
-
replicatorDB
-
userCtxName
-
userCtxRoles
-
dbc
-
replicatorDoc
-
dbURI
-
-
Constructor Details
-
Replicator
-
-
Method Details
-
save
Adds a new document to the replicator database.- Returns:
Response
-
find
Finds a document in the replicator database.- Returns:
ReplicatorDocument
-
findAll
Finds all documents in the replicator database.- Returns:
- a list of
ReplicatorDocument
-
remove
Removes a document from the replicator database.- Returns:
Response
-
source
-
target
-
continuous
-
filter
-
queryParams
-
queryParams
-
docIds
-
proxy
-
createTarget
-
replicatorDB
-
replicatorDocId
-
replicatorDocRev
-
workerProcesses
-
workerBatchSize
-
httpConnections
-
connectionTimeout
-
retriesPerRequest
-
userCtxName
-
userCtxRoles
-
sinceSeq
-