You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by va...@apache.org on 2017/04/19 02:25:11 UTC
[couchdb-documentation] 02/02: Add links to the detailed feed mode
descriptions.
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 ba51d5ed2743ac6749db0cfd83a8b44caaeea68d
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Tue Apr 18 20:32:31 2017 +0200
Add links to the detailed feed mode descriptions.
---
src/api/database/changes.rst | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/src/api/database/changes.rst b/src/api/database/changes.rst
index 67fd601..2a740f1 100644
--- a/src/api/database/changes.rst
+++ b/src/api/database/changes.rst
@@ -45,15 +45,20 @@
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: - **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
+ :query string feed: - **normal** Specifies :ref:`Normal Polling Mode
+ <changes/normal>`. All past changes are returned
+ immediately. *Default.*
+ - **longpoll** Specifies :ref:`Long Polling Mode
+ <changes/longpoll>`. Waits until at least one change
+ has occurred, sends the change, then closes the
+ connection. Most commonly used in conjunction with
+ ``since=now``, to wait for the next change.
+ - **continuous** Sets :ref:`Continuous Mode
+ <changes/continuous>`. Sends a line of JSON per
+ event. Keeps the socket open until ``timeout``.
+ - **eventsource** Sets :ref:`Event Source Mode
+ <changes/eventsource>`. Works the same as Continuous
+ Mode, 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
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.