Add documentation for use_checkpoints replicator option
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/7299e71f Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/7299e71f Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/7299e71f Branch: refs/heads/1960-paginate-all_dbs Commit: 7299e71f33d1d09de9707d7f5a46c82290537876 Parents: 03bc164 Author: Volker Mische <[email protected]> Authored: Tue Jul 16 00:34:31 2013 +0200 Committer: Robert Newson <[email protected]> Committed: Sat Dec 14 11:34:09 2013 +0100 ---------------------------------------------------------------------- share/doc/src/json-structure.rst | 3 +++ share/doc/src/replication/replicator.rst | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/7299e71f/share/doc/src/json-structure.rst ---------------------------------------------------------------------- diff --git a/share/doc/src/json-structure.rst b/share/doc/src/json-structure.rst index c124e44..042df59 100644 --- a/share/doc/src/json-structure.rst +++ b/share/doc/src/json-structure.rst @@ -271,6 +271,9 @@ Replication Settings | | filter function; value should be a document | | | containing parameters as members | +--------------------------------+---------------------------------------------+ +| use_checkpoints (optional) | Whether to use replication checkpoints | +| | or not | ++--------------------------------+---------------------------------------------+ .. _replication-status: http://git-wip-us.apache.org/repos/asf/couchdb/blob/7299e71f/share/doc/src/replication/replicator.rst ---------------------------------------------------------------------- diff --git a/share/doc/src/replication/replicator.rst b/share/doc/src/replication/replicator.rst index 0413bce..6700186 100644 --- a/share/doc/src/replication/replicator.rst +++ b/share/doc/src/replication/replicator.rst @@ -22,7 +22,8 @@ cancel an ongoing replication. 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``). +``continuous``, ``doc_ids``, ``filter``, ``query_params``, +``use_checkpoints``). Replication documents can have a user defined ``_id`` (handy for finding a specific replication request later). Design Documents
