You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by Apache Wiki <wi...@apache.org> on 2009/04/03 09:11:02 UTC

[Couchdb Wiki] Update of "HTTP view API" by MattLyon

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 MattLyon:
http://wiki.apache.org/couchdb/HTTP_view_API

------------------------------------------------------------------------------
    * POST
      * {"keys": ["key1", "key2", ...]} ''Trunk only (0.9)''
  
+ ''key'', ''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). You must emit a JSON object containing the property ''key'' in order to use this query parameter. For example:
- {{{
- function(doc) {
  
-   emit(doc._id, {
-     key: doc._id, // This can be whatever value you choose
-     data: doc.foo.bar
-   });
- }
- }}}
- 
- A JSON structure of ''{"keys": ["key1", "key2", ...]}'' can be posted to any user defined view or ''_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.
+ A JSON structure of ''{"keys": ["key1", "key2", ...]}'' can be posted to any user defined view or ''_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. Please note that if the view being called contains a reduce function, you CANNOT at this point do ''reduce=false'' to run only the map element, and therefore also cannot do ''include_docs=true''.
  
  If you specify ''?limit=0'' you don't get any data, but all meta-data for this View. The number of documents in this View for example.