diff options
author | BigBlueHat <byoung@bigbluehat.com> | 2013-11-21 16:47:01 -0500 |
---|---|---|
committer | Alexander Shorin <kxepal@apache.org> | 2013-11-24 13:47:31 +0400 |
commit | 5ae6ebc157ea5d219bf382e1a59c6749708af982 (patch) | |
tree | b33b93d4dd44ab1752224e93a4974f3862a76fc4 | |
parent | 2804fc4e0a1f8b6192835069375ac33d9aa5307d (diff) | |
download | couchdb-5ae6ebc157ea5d219bf382e1a59c6749708af982.tar.gz |
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 <kxepal@apache.org>
-rw-r--r-- | share/doc/src/replication/replicator.rst | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/share/doc/src/replication/replicator.rst b/share/doc/src/replication/replicator.rst index 1a40c65fb..b4427faf6 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 |