couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "HTTP_database_API" by SebastianCohnen
Date Wed, 17 Mar 2010 16:45:32 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "HTTP_database_API" page has been changed by SebastianCohnen.
The comment on this change is: added a nice table for the changes parameters.
http://wiki.apache.org/couchdb/HTTP_database_API?action=diff&rev1=19&rev2=20

--------------------------------------------------

  
  === Changes ===
  
- A list of changes made to documents in the database, in the order they were made, can be
obtained from the database's ''_changes'' resource.
+ A list of changes made to documents in the database, in the order they were made, can be
obtained from the database's ''_changes'' resource. You can query the ''_changes'' resource
by issuing a GET-Request with the following (optional) parameters:
  
-   * GET
+ ||'''Parameter'''||'''Value'''||'''Default value'''||'''Description'''||
-     * since=seqnum (default=0). Start the results from the change immediately after the
given sequence number.
+ ||''since''||seqnum||''0''||Start the results from the change immediately after the given
sequence number.||
-     * feed=normal|longpoll|continuous (default=normal). Select the type of feed.
+ ||''feed''||normal | longpoll | continuous||''normal''||Select the type of feed.||
-     * heartbeat=time (milliseconds, default=60000). Period in milliseconds after which a
empty line is sent in the results. Only applicable for ''longpoll'' or ''continuous'' feeds.
Overrides any ''timeout''.
+ ||''heartbeat''||milliseconds||''60000''||Period in milliseconds after which a empty line
is sent in the results. Only applicable for ''longpoll'' or ''continuous'' feeds. Overrides
any ''timeout''.||
-     * timeout=time (milliseconds, default=60000). Maximum period in milliseconds to wait
for a change before the response is sent, even if there are no results. Only applicable for
''longpoll'' or ''continuous'' feeds.
+ ||''timeout''||milliseconds||''60000''||Maximum period in milliseconds to wait for a change
before the response is sent, even if there are no results. Only applicable for ''longpoll''
or ''continuous'' feeds.||
-     * filter=designdoc/filtername. Reference a filter function from a design document to
selectively get updates. See the [[http://books.couchdb.org/relax/reference/change-notifications|section
in the book]] for more information.
+ ||''filter''||designdoc/filtername||''none''||Reference a filter function from a design
document to selectively get updates. See the [[http://books.couchdb.org/relax/reference/change-notifications|section
in the book]] for more information.||
-     * include_docs=true|false (default=false). Include the associated document with each
result. (New in version 0.11)
+ ||''include_docs''||boolean||''false''||Include the associated document with each result.
(New in version 0.11)||
  
  By default all changes are immediately returned as a JSON object:
  

Mime
View raw message