couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [03/11] couchdb commit: updated refs/heads/1824-replication-protocol to b41a7e4
Date Fri, 09 May 2014 22:56:16 GMT
Better intro


Branch: refs/heads/1824-replication-protocol
Commit: 962884db721026f09fe6331bed3b6ec12a90e52c
Parents: 12a066c
Author: Alexander Shorin <>
Authored: Fri May 9 17:34:51 2014 +0400
Committer: Alexander Shorin <>
Committed: Fri May 9 17:34:51 2014 +0400

 share/doc/src/replication/protocol.rst | 33 ++++++++++++-----------------
 1 file changed, 14 insertions(+), 19 deletions(-)
diff --git a/share/doc/src/replication/protocol.rst b/share/doc/src/replication/protocol.rst
index 574c84d..a376f78 100644
--- a/share/doc/src/replication/protocol.rst
+++ b/share/doc/src/replication/protocol.rst
@@ -136,25 +136,20 @@ Replication ID:
 Replication Protocol Algorithm
-`CouchDB Replication Protocol` is a quite complex set of HTTP requests and
-business logic that is used to effectively transfer changes from Source to
-Target endpoint. To make things easy, this protocol definition contains
-a step-by-step description on how the Replication Protocol works, illustrated
-by ASCII flow charts and request/response examples.
-.. note::
-  The `CouchDB Replication Protocol` is not something *magical*, but
-  an agreement on usage of the public :ref:`CouchDB HTTP API <api>` in specific
-  way. So, in global terms, a Replicator is just a CouchDB client application
-  with some business logic oriented towards synchronizing Documents between
-  Source and Target.
-  In this Protocol Specification we'll try to describe all the important
-  details, but if you're not sure how some HTTP endpoint works, please consult
-  with the :ref:`CouchDB HTTP API <api>` reference for complete information
-  about request parameters and expected responses.
+The `CouchDB Replication Protocol` is not something *magical*, but
+an agreement on usage of the public :ref:`CouchDB HTTP REST API <api>` in some
+specific way to effectively replicate Documents from Source to Target.
+The reference implementation, written in Erlang_, is provided by the
+couch_replicator_ module in Apache CouchDB.
+It is RECOMMENDED to follow this algorithm specification and use the same
+HTTP endpoints and run requests with the same parameters to provide completely
+compatible solution. Custom Replicator implementations MAY use different
+HTTP API endpoints and requests parameters depending on their local specifics
+as like as they MAY implement only part of Replication Protocol to run only Push
+or Pull Replication. However, while such solutions could also run Replication
+process, they looses compatibility with CouchDB Replicator.
 .. note::

View raw message