Class Replication

java.lang.Object

org.lightcouch.Replication

public class Replication
extends Object

This class provides access to the database replication API; a replication request is sent via HTTP POST to _replicate URI.

Usage Example:

ReplicationResult replication = dbClient.replication()
        .source("source-db")
        .target("target-db")
        .createTarget(true)
.filter("example/filter1")
        .trigger();


List<ReplicationHistory> histories = replication.getHistories();

Since:

0.0.2

Author:

Ahmed Yehia

See Also:

• CouchDbClientBase.replication()
• ReplicationResult
• ReplicationResult.ReplicationHistory
• Replicator

Constructor Summary

Constructors

Constructor	Description
Replication(CouchDbClientBase dbc)

Method Summary

Modifier and Type	Method	Description
Replication	cancel(Boolean cancel)
Replication	continuous(Boolean continuous)
Replication	createTarget(Boolean createTarget)
Replication	docIds(String... docIds)
Replication	filter(String filter)
Replication	proxy(String proxy)
Replication	queryParams(String queryParams)
Replication	queryParams(Map<String,Object> queryParams)
Replication	sinceSeq(String sinceSeq)	Starts a replication since an update sequence.
Replication	source(String source)
Replication	target(String target)
Replication	targetOauth(String consumerSecret, String consumerKey, String tokenSecret, String token)
ReplicationResult	trigger()	Triggers a replication request.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Replication

public Replication(CouchDbClientBase dbc)

Method Details

trigger

public ReplicationResult trigger()

Triggers a replication request.

Returns:

ReplicationResult

source

public Replication source(String source)

target

public Replication target(String target)

continuous

public Replication continuous(Boolean continuous)

filter

public Replication filter(String filter)

queryParams

public Replication queryParams(String queryParams)

queryParams

public Replication queryParams(Map<String,Object> queryParams)

docIds

public Replication docIds(String... docIds)

proxy

public Replication proxy(String proxy)

cancel

public Replication cancel(Boolean cancel)

createTarget

public Replication createTarget(Boolean createTarget)

sinceSeq

public Replication sinceSeq(String sinceSeq)

Starts a replication since an update sequence.

Parameters:

sinceSeq - The update sequence

Returns:

Replication

targetOauth

public Replication targetOauth(String consumerSecret,
 String consumerKey,
 String tokenSecret,
 String token)