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 "URI templates" by JensAlfke
Date Sun, 22 Feb 2009 18:02:38 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 JensAlfke:
http://wiki.apache.org/couchdb/URI_templates

The comment on the change is:
Added view, show and list URIs, and some formatting.

------------------------------------------------------------------------------
- A handy list of all the key CouchDB [http://bitworking.org/projects/URI-Templates/ URIs
templates].
+ A handy list of all the key CouchDB [http://bitworking.org/projects/URI-Templates/ URI templates].
+ 
+ === Databases and Documents ===
  
  To see a listing of databases:
  
-   http://localhost:5984/_all_dbs
+   /_all_dbs
  
  To see some basic information about a database:
  
-   http://localhost:5984/dbname/
+   /''dbname''/
  
  To see all a listing of the data documents in a database:
  
-   http://localhost:5984/dbname/_all_docs
+   /''dbname''/_all_docs
  
  To see a document:
  
-   http://localhost:5984/dbname/docid
+   /''dbname''/''docid''
  
  To download a file attachment:
  
-   http://localhost:5984/dbname/docid/filename
+   /''dbname''/''docid''/''filename''
+ 
+ === Design Documents and Views ===
  
  To see a design document:
  
-   http://localhost:5984/dbname/_design/designdocid
+   /''dbname''/_design/''designdocid''
  
+ To query a view:
+ 
+   /''dbname''/_view/''designdocid''/viewname?''query''
+ 
+ To query a temporary ("slow") view (with the custom view function in the body of the request):
+ 
+   /''dbname''/_slow_view?''query''
+ 
+ === Formatting ===
+ 
+ To format a document through a "show" template:
+ 
+   /''dbname''/_show/''designdocid''/''showname''/''docid''
+ 
+ To format a view through a "list" template:
+ 
+   /''dbname''/_list/''designdocid''/''listname''/''viewname''?''query''
+ 
+ === View Query Syntax ===
+ 
+ The most common query parameters for accessing views are:
+ 
+   * ?startkey=''keyvalue''
+   * ?endkey=''keyvalue''
+   * ?limit=''max rows to return''
+   * ?skip=''number of rows to skip''
+ 
+ For the full query syntax, see the ["HTTP view API"].
+ 

Mime
View raw message