CouchDocs

• Overview
• Using CouchDB
• When Things Go Wrong
• Community
• Get Involved
• Books

• Reference
• FAQ

HTTP View API

An introduction to the CouchDB HTTP view API.

Basics

Views are the primary tool used for querying and reporting on CouchDB databases. They are defined in !JavaScript (although there are other query servers available). For a more detailed introduction to views see Introduction_to_CouchDB_views.

Creating Views

To create a permanent view, the functions must first be saved into special design documents (well, they are not really special, we just call them special but in reality, they are regular documents, just with a special ID). The IDs of design documents must begin with _design/ and have a special views attribute that have a map member and an optional reduce member to hold the view functions. All the views in one design document are indexed whenever any of them gets queried.

A design document that defines all, by_lastname, and total_purchases views might look like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "_id":"_design/company",
  "_rev":"12345",
  "language": "javascript",
  "views":
  {
    "all": {
      "map": "function(doc) { if (doc.Type == 'customer')  emit(null, doc) }"
    },
    "by_lastname": {
      "map": "function(doc) { if (doc.Type == 'customer')  emit(doc.LastName, doc) }"
    },
    "total_purchases": {
      "map": "function(doc) { if (doc.Type == 'purchase')  emit(doc.Customer, doc.Amount) }",
      "reduce": "function(keys, values) { return sum(values) }"
    }
  }
}

The language property tells CouchDB the language of the view functions, which it uses to select the appropriate ViewServer (as specified in your couch.ini file). The default is to assume Javascript, so this property can be omitted for Javascript views.

Altering/Changing Views

To change a view or multiple view just alter the design document (see HttpDocumentApi) they are stored in and save it as a new revision. This causes all the views in that design document to be rebuilt on the next access in case the view code has been changed.

Access/Query

Once this document is saved into a database, then the all view can be retrieved at the URL:

http://localhost:5984/database/_design/company/_view/all

Example:

GET /some_database/_design/company/_view/all HTTP/1.0
Date: Thu, 17 Aug 2006 05:39:28 +0000GMT

And will result in the following response:

 HTTP/1.1 200 OK
 Date: Thu, 17 Aug 2006 05:39:28 +0000GMT
 Content-Length: 318
 Connection: close

 {
    "total_rows": 3,
    "offset": 0,
    "rows": [{
        "id":"64ACF01B05F53ACFEC48C062A5D01D89",
        "key": null,
        "value": {
          "LastName":"Katz",
          "FirstName":"Damien",
          "Address":"2407 Sawyer drive, Charlotte NC",
          "Phone":012555754211
        }
      }, {
        "id":"5D01D8964ACF01B05F53ACFEC48C062A",
        "key": null,
        "value": {
          "LastName":"Kerr",
          "FirstName":"Wayne",
          "Address":"123 Fake st., such and such",
          "Phone":88721320939
        }
      }, {
        "id":"EC48C062A5D01D8964ACF01B05F53ACF",
        "key": null,
        "value":
        {
          "LastName":"McCracken",
          "FirstName":"Phil",
          "Address":"1234 Fake st., such and such",
          "Phone":7766552342
        }
      }
    ]
 }

Querying Options

Columns can be a list of values, there is no set limit to the number of values or amount of data that columns can hold.

The following URL query arguments for GET/HEAD requests are allowed:

Since 0.9 you can also issue POST requests to views where you can send the following JSON structure in the body:

{"keys": ["key1", "key2", ...]}

key, startkey, and endkey need to be properly JSON encoded values. For example, startkey="string" for a string value or startkey=["foo", 1, {}]. Be aware that you have to do proper URL encoding on complex values.

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.

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.

The skip option should only be used with small values, as skipping a large range of documents this way is inefficient (it scans the index from the startkey and then skips N elements, but still needs to read all the index values to do that). For efficient paging you'll need to use startkey and limit. If you expect to have multiple documents emit identical keys, you'll need to use startkey_docid in addition to startkey to paginate correctly. The reason is that startkey alone will no longer be sufficient to uniquely identify a row.

The stale option can be used for higher performance at the cost of possibly not seeing the all latest data. If you set the stale option to ok, CouchDB may not perform any refreshing on the view that may be necessary. Using this option essentially tells CouchDB that if a reference to the view index is available in memory (ie, if the view has been queried at least once since couch was started), go ahead and use it, even if it may be out of date. The result is that for a highly trafficked view, end users can see lower latency, although they may not get the latest data. However, if there is no view index pointer in memory, the behavior with this option is that same as the behavior without the option. If your application use stale=ok for end-user queries, you'll need either a cron or a notification process like the one described in Regenerating_views_on_update, which queries without stale=ok to ensure that the view is kept reasonably up to date.

View rows are sorted by the key; specifying descending=true will reverse their order. Note that the descending option is applied before any key filtering, so you may need to swap the values of the startkey and endkey options to get the expected results. The sorting itself is described in ViewCollation.

The group option controls whether the reduce function reduces to a set of distinct keys or to a single result row.

If a view contains both a map and reduce function, querying that view will by default return the result of the reduce function. The result of the map function only may be retrieved by passing reduce=false as a query parameter.

The include_docs option will include the associated document. Although, the user should keep in mind that there is a race condition when using this option. It is possible that between reading the view data and fetching the corresponding document that the document has changed. If you want to alleviate such concerns you should emit an object with a _rev attribute as in emit(key, {"_rev": doc._rev}). This alleviates the race condition but leaves the possiblity that the returned document has been deleted (in which case, it includes the "_deleted": true attribute).

The inclusive_end option controls whether the endkey is included in the result. It defaults to true.

Getting Information about Design Documents (and their Views)

You can query the design document (_design/test in this case) by GET for some information on the view:

curl -X GET http://localhost:5984/databasename/_design/test/_info

will produce something like this:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
    "name": "test", 
    "view_index": {
        "compact_running": false, 
        "disk_size": 4188, 
        "language": "javascript", 
        "purge_seq": 0, 
        "signature": "07ca32cf9b0de9c915c5d9ce653cdca3", 
        "update_seq": 4, 
        "updater_running": false, 
        "waiting_clients": 0, 
        "waiting_commit": false
    }
}

Meaning of the status hash

||Key||<-2>Description|| ||name||<-2>Name of the design document without the _design prefix (string)|| ||view_index||<-2>Contains information on the views (JSON object)|| || ||Subkeys of view_index||Description|| || ||signature||The MD5 representation of the views of a design document (string)|| || ||language||Language of the views used (string)|| || ||disk_size||Size in Bytes of the views on disk (int)|| || ||updater_running||Indicates if an update process is running (boolean)|| || ||compact_running||Indicates if view compaction is running (boolean)|| || ||waiting_commit||Indicates if this view is ahead of db commits or not (boolean)|| || ||waiting_clients||How many clients are waiting on views of this design document (int)|| || ||update_seq||The update sequence of the corresponding database that has been indexed (int)|| || ||purge_seq||The purge sequence that has been processed (int)||

Debugging Views

When creating views, CouchDB will check the syntax of the submitted JSON, but the view functions themselves will not be syntax checked by the Javascript interpreter. And if any one of the view functions has a syntax error, none of the view functions in that design document will execute. Perhaps test your functions in a temporary view before saving them in the database.

As of r660140 there is a log function available in the views, which logs to the couch.log. It can be helpful for debugging but hinders performance, so it should be used sparingly in production systems.

1
2
3

{
  "map": "function(doc) { log(doc); }"
}

Playing with (malformed) views is currently the best way to bring the couchdb server in an unstable state. Also the Futon Web-Client does not interact very well with errors in views. Some suggestions for view development:

• Develop views on a separate server instance, not on your production systems
• Keep an eye on the logfile: most errors are reported only there
• If your Futon Web-Client acts funny, clear the cookies futon created
• Work with temporary views. Store views only after you have verified that they work as intended.
• Work with only a few hundred documents for testing.
• Keep in mind that the the Futon Web-Client silently adds group=true to your views.

Sharing Code Between Views

There are no development plans to share code/functions between views. Each view function is stored according to a hash of their byte representation, so it is important that a function does not load any additional code, changing its behavior without changing its byte-string. Hence the use-case for CouchApp.

Since CouchDB 0.11 it is possible to share code in show, list, update, and validation functions. See CommonJS_Modules for details.

View Cleanup

Old view output remains on disk until you explicitly run cleanup. To run cleanup for a particular database;

POST /some_database/_view_cleanup

View Compaction

If you have very large views or are tight on space, you might consider Compaction as well. To run compact for a particular view on a particular database;

POST /some_database/_compact/designname

In my case, views that were 26G, 27G, 39G, and 40G, shrank to 2.8G, 2.8G, 3.4G, and 3.5G, respectively.

Temporary Views

One-off queries (eg. views you don't want to save in the CouchDB database) can be done via the special view _temp_view. Temporary views are only good during development. Final code should not rely on them as they are very expensive to compute each time they get called and they get increasingly slower the more data you have in a database. If you think you can't solve something in a permanent view that you can solve in an ad-hoc view, you might want to reconsider. (TODO: add typical examples and solutions).

POST /some_database/_temp_view  HTTP/1.0
Content-Length: 48
Date: Mon, 10 Sep 2007 17:11:10 +0200
Content-Type: application/json

{
  "map" : "function(doc) { if (doc.foo=='bar') { emit(null, doc.foo); } }"
}

Could result in the following response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "total_rows": 1,
  "offset": 0,
  "rows": [{
      "id": "AE1AD84316B903AD46EF396CAFE8E50F",
      "key": null,
      "foo": "bar"
    }
  ]
}

NOTE: couchdb 0.9.0 requires Content-Type: application/json on POSTs to _temp_view

Hosted on Github