couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vatam...@apache.org
Subject [couchdb-documentation] branch master updated: Update docs related to _scheduler/docs/{db}/{docid} endpoint
Date Wed, 10 May 2017 01:54:30 GMT
This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git

The following commit(s) were added to refs/heads/master by this push:
       new  3b4e1ba   Update docs related to _scheduler/docs/{db}/{docid} endpoint
3b4e1ba is described below

commit 3b4e1bade7bdc93739633e8dd02987ee708cbde8
Author: Nick Vatamaniuc <vatamane@apache.org>
AuthorDate: Tue May 9 21:24:30 2017 -0400

    Update docs related to _scheduler/docs/{db}/{docid} endpoint
    
    Document these endpoints:
     * _scheduler/docs/{replicator_db}
     * _scheduler/docs/{replicator_db}/{docid}
    
    Update replicator example due to the API change in how single replicator doc
    info is retrieved.
    
    Issue https://github.com/apache/couchdb/issues/506
---
 src/api/server/common.rst      | 152 ++++++++++++++++++++++++++++++++++++++++-
 src/replication/replicator.rst |   2 +-
 2 files changed, 152 insertions(+), 2 deletions(-)

diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index 9b51936..97f838a 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -777,7 +777,8 @@ error.
                     summary
 
 .. http:get:: /_scheduler/docs
-    :synopsis: Retrieve information about replication documents
+    :synopsis: Retrieve information about replication documents from the
+               ``_replicator`` database.
 
     List of replication document states. Includes information about all the
     documents, even in ``completed`` and ``failed`` states. For each document
@@ -869,6 +870,155 @@ error.
             "total_rows": 2
         }
 
+.. http:get:: /_scheduler/docs/{replicator_db}
+    :synopsis: Retrieve information about replication documents from a specific
+               replicator database.
+
+    Get information about replication documents from a replicator database.
+    The default replicator database is ``_replicator`` but other replicator
+    databases can exist if their name ends with the suffix ``/_replicator``.
+
+    .. note:: As a convenience slashes (``/``) in replicator db names do not
+       have to be escaped. So ``/_scheduler/docs/other/_replicator`` is valid
+       and equivalent to ``/_scheduler/docs/other%2f_replicator``
+
+    :<header Accept: - :mimetype:`application/json`
+    :>header Content-Type: - :mimetype:`application/json`
+    :query number limit: How many results to return
+    :query number skip: How many result to skip starting at the beggining, if
+                        ordered by document ID
+    :>json number offset: How many results were skipped
+    :>json number total_rows: Total number of replication documents.
+    :>json string id: Replication ID, or ``null`` if state is ``completed`` or
+                      ``failed``
+    :>json string state: One of following states (see :ref:`replicator/states`
+                         for descriptions): ``initializing``, ``running``,
+                         ``completed``, ``pending``, ``crashing``, ``error``,
+                         ``failed``
+    :>json string database: Database where replication document came from
+    :>json string doc_id: Replication document ID
+    :>json string node: Cluster node where the job is running
+    :>json string source: Replication source
+    :>json string target: Replication target
+    :>json string start_time: Timestamp of when the replication was started
+    :>json string last_update: Timestamp of last state update
+    :>json string info: Additional information about the state, such as an
+                        error message for example
+    :>json number error_count: Consecutive errors count. Indicates how many
+                               times in a row this replication has crashed.
+                               Replication will be retried with an exponential
+                               backoff based on this number. As soon as the
+                               replication succeeds this count is reset to 0.
+                               To can be used to get an idea why a particular
+                               replication is not making progress.
+    :code 200: Request completed successfully
+    :code 401: CouchDB Server Administrator privileges required
+
+    **Request**:
+
+    .. code-block:: http
+
+        GET /_scheduler/docs/other/_replicator HTTP/1.1
+        Accept: application/json
+        Host: localhost:5984
+
+    **Response**:
+
+    .. code-block:: http
+
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+        Date: Sat, 29 Apr 2017 05:10:08 GMT
+        Server: Server: CouchDB (Erlang/OTP)
+        Transfer-Encoding: chunked
+
+        {
+            "docs": [
+                {
+                    "database": "other/_replicator",
+                    "doc_id": "cdyno-0000001-0000002",
+                    "error_count": 0,
+                    "id": "e327d79214831ca4c11550b4a453c9ba+continuous",
+                    "info": null,
+                    "last_updated": "2017-04-29T05:01:37Z",
+                    "node": "node2@127.0.0.1",
+                    "proxy": null,
+                    "source": "http://myserver.com/foo",
+                    "start_time": "2017-04-29T05:01:37Z",
+                    "state": "running",
+                    "target": "http://adm:*****@localhost:15984/cdyno-0000002/"
+                }
+            ],
+            "offset": 0,
+            "total_rows": 1
+        }
+
+.. http:get:: /_scheduler/docs/{replicator_db}/{docid}
+    :synopsis: Retrieve information about a particular replication document
+
+    .. note:: As a convenience slashes (``/``) in replicator db names do not
+       have to be escaped. So ``/_scheduler/docs/other/_replicator`` is valid
+       and equivalent to ``/_scheduler/docs/other%2f_replicator``
+
+    :<header Accept: - :mimetype:`application/json`
+    :>header Content-Type: - :mimetype:`application/json`
+    :>json string id: Replication ID, or ``null`` if state is ``completed`` or
+                      ``failed``
+    :>json string state: One of following states (see :ref:`replicator/states`
+                         for descriptions): ``initializing``, ``running``,
+                         ``completed``, ``pending``, ``crashing``, ``error``,
+                         ``failed``
+    :>json string database: Database where replication document came from
+    :>json string doc_id: Replication document ID
+    :>json string node: Cluster node where the job is running
+    :>json string source: Replication source
+    :>json string target: Replication target
+    :>json string start_time: Timestamp of when the replication was started
+    :>json string last_update: Timestamp of last state update
+    :>json string info: Additional information about the state, such as an
+                        error message for example
+    :>json number error_count: Consecutive errors count. Indicates how many
+                               times in a row this replication has crashed.
+                               Replication will be retried with an exponential
+                               backoff based on this number. As soon as the
+                               replication succeeds this count is reset to 0.
+                               To can be used to get an idea why a particular
+                               replication is not making progress.
+    :code 200: Request completed successfully
+
+     **Request**:
+
+    .. code-block:: http
+
+        GET /_scheduler/docs/other/_replicator/cdyno-0000001-0000002 HTTP/1.1
+        Accept: application/json
+        Host: localhost:5984
+
+    **Response**:
+
+    .. code-block:: http
+
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+        Date: Sat, 29 Apr 2017 05:10:08 GMT
+        Server: Server: CouchDB (Erlang/OTP)
+        Transfer-Encoding: chunked
+
+        {
+            "database": "other/_replicator",
+            "doc_id": "cdyno-0000001-0000002",
+            "error_count": 0,
+            "id": "e327d79214831ca4c11550b4a453c9ba+continuous",
+            "info": null,
+            "last_updated": "2017-04-29T05:01:37Z",
+            "node": "node2@127.0.0.1",
+            "proxy": null,
+            "source": "http://myserver.com/foo",
+            "start_time": "2017-04-29T05:01:37Z",
+            "state": "running",
+            "target": "http://adm:*****@localhost:15984/cdyno-0000002/"
+        }
+
 .. _api/server/restart:
 
 =============
diff --git a/src/replication/replicator.rst b/src/replication/replicator.rst
index aabede2..10079b4 100644
--- a/src/replication/replicator.rst
+++ b/src/replication/replicator.rst
@@ -68,7 +68,7 @@ In the couch log you'll see 2 entries like these:
     [notice] 2017-04-05T17:16:19.646759Z node1@127.0.0.1 <0.29432.0> -------- Document
`my_rep` triggered replication `a81a78e822837e66df423d54279c15fe+continuous+create_target`
 
 Replication state of this document can then be queried from
-``http://adm:pass@localhost:5984/_scheduler/docs/my_rep``
+``http://adm:pass@localhost:5984/_scheduler/docs/_replicator/my_rep``
 
 .. code-block:: json
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <commits@couchdb.apache.org>'].

Mime
View raw message