Differences between revisions 1 and 34 (spanning 33 versions)
Revision 1 as of 2009-02-22 02:06:23
Size: 1538
Editor: c-76-115-0-4
Comment: documented show functions
Revision 34 as of 2018-04-13 05:53:17
Size: 0
Editor: JoanTouzet
Comment: We already ahve the documentation for show/list that we want...the rest is semi-deprecated.
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
The basics of formatting documents using `show` and `list` functions. These functions convert documents and views, respectively, into non-JSON formats. The rows of each view are processed individually, which keeps long lists from becoming memory hogs.

They are designed to be cacheable. CouchDB handles generating Etags for show and list responses.

Show and list functions are side effect free and idempotent. They can not make additional HTTP requests against CouchDB. Their purpose is to render JSON documents in other formats.

== Showing Documents ==

Show functions are stored in your design document, under the `shows` key. Here's an example set of show functions:

"_id" : "_design/examples",
"shows" : {
  "posts" : "function(doc, req) {... return responseObject;}",
  "people" : "function(doc, req) { ... }"

These functions could be queried like this:

GET /db/_show/examples/posts/somedocid

GET /db/_show/examples/people/otherdocid

GET /db/_show/examples/people/otherdocid?format=xml&details=true

The show function is run with two arguments, the first is the document corresponding to the requested docid. The second argument is the req object, which contains information about the query string, Accept headers, and other per-request information.

The show function returns a JSON object of the same format of the _external response. See ExternalProcesses for further explanation of the `req` object as well as documentation about the response.

== Listing Views ==