couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From vatam...@apache.org
Subject [couchdb-documentation] 01/02: Update changes feed documentation
Date Wed, 19 Apr 2017 02:25:10 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

commit 661a7cb3418f17c83fae587617ea672c39d2e338
Author: Jonathan Hall <flimzy@flimzy.com>
AuthorDate: Sat Mar 18 21:16:23 2017 +0100

    Update changes feed documentation
---
 src/api/database/changes.rst | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/src/api/database/changes.rst b/src/api/database/changes.rst
index de79564..67fd601 100644
--- a/src/api/database/changes.rst
+++ b/src/api/database/changes.rst
@@ -45,7 +45,16 @@
         Ignored if `include_docs` isn't ``true``. Default is ``false``.
     :query boolean descending: Return the change results in descending sequence
         order (most recent change first). Default is ``false``.
-    :query string feed: see :ref:`changes`. Default is ``normal``.
+    :query string feed: - **normal** All past changes are returned immediately.
+                          *Default.*
+                        - **longpoll** In conjunction with ``since=now``, the
+                          request will remain open until a change is made and
+                          the event transmitted, then the connection will close.
+                        - **continuous** Sends a line of JSON per event. Keeps
+                          the socket open until ``timeout``.
+                        - **eventsource** Like, ``continuous``, but sends
+                          the events in `EventSource
+                          <http://dev.w3.org/html5/eventsource/>`_ format.
     :query string filter: Reference to a :ref:`filter function <filterfun>`
         from a design document that will filter whole stream emitting only
         filtered events. See the section `Change Notifications in the book
@@ -101,11 +110,12 @@
     :code 200: Request completed successfully
     :code 400: Bad request
 
-    The ``result`` field of database changes
+    The ``results`` field of database changes:
 
-    :json array changes: List of document`s leafs with single field ``rev``
-    :json string id: Document ID
-    :json json seq: Update sequence
+    :json array changes: List of document's leaves with single field ``rev``.
+    :json string id: Document ID.
+    :json json seq: Update sequence.
+    :json bool deleted: ``true`` if the document is deleted.
 
     **Request**:
 

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

Mime
View raw message