8.8. GET /db/_design/design-doc/_info

MethodGET /db/_design/design-doc/_info
Request None
Response JSON of the design document information
Admin Privileges Requiredno

Obtains information about a given design document, including the index, index size and current status of the design document and associated index information.

For example, to get the information for the recipes design document:

GET http://couchdb:5984/recipes/_design/recipes/_info
Content-Type: application/json

This returns the following JSON structure:

{
   "name" : "recipes"
   "view_index" : {
      "compact_running" : false,
      "updater_running" : false,
      "language" : "javascript",
      "purge_seq" : 10,
      "waiting_commit" : false,
      "waiting_clients" : 0,
      "signature" : "fc65594ee76087a3b8c726caf5b40687",
      "update_seq" : 375031,
      "disk_size" : 16491
   },
}

The individual fields in the returned JSON structure are detailed in Table 8.3, “Design Document Info JSON Contents”.

Table 8.3. Design Document Info JSON Contents

FieldDescription
name Name/ID of Design Document
view_index View Index
        compact_running Indicates whether a compaction routine is currently running on the view
        disk_size Size in bytes of the view as stored on disk
        language Language for the defined views
        purge_seq The purge sequence that has been processed
        signature MD5 signature of the views for the design document
        update_seq The update sequence of the corresponding database that has been indexed
        updater_running Indicates if the view is currently being updated
        waiting_clients Number of clients waiting on views from this design document
        waiting_commit Indicates if there are outstanding commits to the underlying database that need to processed