Updated Branches: refs/heads/master 2804fc4e0 -> 5ae6ebc15
fixed some miss communication about _replicator Was saying to `PUT` to `_replicator` directly. Which throws a "database exists" or similar error. Also tweaked intro copy to be clearer. Signed-off-by: Alexander Shorin <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/5ae6ebc1 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/5ae6ebc1 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/5ae6ebc1 Branch: refs/heads/master Commit: 5ae6ebc157ea5d219bf382e1a59c6749708af982 Parents: 2804fc4 Author: BigBlueHat <[email protected]> Authored: Thu Nov 21 16:47:01 2013 -0500 Committer: Alexander Shorin <[email protected]> Committed: Sun Nov 24 13:47:31 2013 +0400 ---------------------------------------------------------------------- share/doc/src/replication/replicator.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/5ae6ebc1/share/doc/src/replication/replicator.rst ---------------------------------------------------------------------- diff --git a/share/doc/src/replication/replicator.rst b/share/doc/src/replication/replicator.rst index 1a40c65..b4427fa 100644 --- a/share/doc/src/replication/replicator.rst +++ b/share/doc/src/replication/replicator.rst @@ -15,13 +15,17 @@ Replicator Database =================== -A database where you ``PUT``/``POST`` documents to trigger replications -and you ``DELETE`` to cancel ongoing replications. These documents have -exactly the same content as the JSON objects we used to ``POST`` to -``_replicate`` (fields ``source``, ``target``, ``create_target``, -``continuous``, ``doc_ids``, ``filter``, ``query_params``. +The ``_replicator`` database works like any other in CouchDB, but documents +added to it will trigger replications. Creating (``PUT`` or ``POST``) a +document to start a replication. ``DELETE`` a replicaiton document to +cancel an ongoing replication. -Replication documents can have a user defined ``_id``. Design documents +These documents have exactly the same content as the JSON objects we use to +``POST`` to ``_replicate`` (fields ``source``, ``target``, ``create_target``, +``continuous``, ``doc_ids``, ``filter``, ``query_params``). + +Replication documents can have a user defined ``_id`` (handy for finding a +specific replication request later). Design Documents (and ``_local`` documents) added to the replicator database are ignored. The default name of this database is ``_replicator``. The name can be @@ -31,7 +35,7 @@ parameter ``db``. Basics ------ -Let's say you PUT the following document into ``_replicator``: +Let's say you POST the following document into ``_replicator``: .. code-block:: javascript
