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 "HttpViewApi" by PaulDavis
Date Tue, 28 Oct 2008 14:58:03 GMT
Dear Wiki user,

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

The following page has been changed by PaulDavis:
http://wiki.apache.org/couchdb/HttpViewApi

------------------------------------------------------------------------------
  
  The following URL query arguments are allowed:
  
+   * GET
-   * key=keyvalue
+     * key=keyvalue
-   * keys=[keys]
-   * startkey=keyvalue
+     * startkey=keyvalue
-   * startkey_docid=docid
+     * startkey_docid=docid
-   * endkey=keyvalue
+     * endkey=keyvalue
-   * endkey_docid=docid
+     * endkey_docid=docid
-   * count=max rows to return
+     * count=max rows to return
-   * update=false
+     * update=false
-   * descending=true
+     * descending=true
-   * skip=number of rows to skip
+     * skip=number of rows to skip
-   * group=true ''Version 0.8.0 and forward''
+     * group=true ''Version 0.8.0 and forward''
-   * reduce=false ''Trunk only (0.9)''
+     * reduce=false ''Trunk only (0.9)''
-   * include_docs=true ''Trunk only (0.9)''
+     * include_docs=true ''Trunk only (0.9)''
+   * POST
+     * {"keys": ["key1", "key2", ...]} ''Trunk only (0.9)''
  
- ''key'', ''keys'', ''startkey'', and ''endkey'' need to be properly JSON encoded values
(for example, startkey="string" for a string value).
+ ''key'', ''startkey'', and ''endkey'' need to be properly JSON encoded values (for example,
startkey="string" for a string value).
+ 
+ A JSON structure of ''{"keys": ["key1", "key2", ...]}'' can be posted to any user defined
view for ''_all_docs'' to retrieve just the view rows matching that set of keys. Rows are
returned in the order of the keys specified. Combining this feature with ''include_docs=true''
results in the so called ''multi-document-fetch'' feature.
  
  If you specify ''?count=0'' you don't get any data, but all meta-data for this View. The
number of documents in this View for example. If ''count'' is specified as a negative number,
you will receive that many documents prior to the specified ''startkey''.
  

Mime
View raw message