1.3.2. /{db}/_all_docs — Apache CouchDB® 3.3 Documentation

# 1.3.2. `/{db}/_all_docs`

GET /{db}/_all_docs

  Executes the built-in _all_docs view, returning all of the documents in the database. With the exception of the URL parameters (described below), this endpoint works identically to any other view. Refer to the view endpoint documentation for a complete description of the available query parameters and the format of the returned data.

  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type – application/json

  Response Headers:

    - Content-Type –

      - application/json

  Status Codes:

    - 200 OK – Request completed successfully

    - 404 Not Found – Requested database not found

  Request:

      GET /db/_all_docs HTTP/1.1
      Accept: application/json
      Host: localhost:5984

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Type: application/json
      Date: Sat, 10 Aug 2013 16:22:56 GMT
      ETag: "1W2DJUZFZSZD9K78UFA3GZWB4"
      Server: CouchDB (Erlang/OTP)
      Transfer-Encoding: chunked

      {
          "offset": 0,
          "rows": [
              {
                  "id": "16e458537602f5ef2a710089dffd9453",
                  "key": "16e458537602f5ef2a710089dffd9453",
                  "value": {
                      "rev": "1-967a00dff5e02add41819138abb3284d"
                  }
              },
              {
                  "id": "a4c51cdfa2069f3e905c431114001aff",
                  "key": "a4c51cdfa2069f3e905c431114001aff",
                  "value": {
                      "rev": "1-967a00dff5e02add41819138abb3284d"
                  }
              },
              {
                  "id": "a4c51cdfa2069f3e905c4311140034aa",
                  "key": "a4c51cdfa2069f3e905c4311140034aa",
                  "value": {
                      "rev": "5-6182c9c954200ab5e3c6bd5e76a1549f"
                  }
              },
              {
                  "id": "a4c51cdfa2069f3e905c431114003597",
                  "key": "a4c51cdfa2069f3e905c431114003597",
                  "value": {
                      "rev": "2-7051cbe5c8faecd085a3fa619e6e6337"
                  }
              },
              {
                  "id": "f4ca7773ddea715afebc4b4b15d4f0b3",
                  "key": "f4ca7773ddea715afebc4b4b15d4f0b3",
                  "value": {
                      "rev": "2-7051cbe5c8faecd085a3fa619e6e6337"
                  }
              }
          ],
          "total_rows": 5
      }

POST /{db}/_all_docs

  POST _all_docs functionality supports identical parameters and behavior as specified in the `GET /{db}/_all_docs` API but allows for the query string parameters to be supplied as keys in a JSON object in the body of the POST request.

  Request:

      POST /db/_all_docs HTTP/1.1
      Accept: application/json
      Content-Length: 70
      Content-Type: application/json
      Host: localhost:5984

      {
          "keys" : [
              "Zingylemontart",
              "Yogurtraita"
          ]
      }

  Response:

      {
          "total_rows" : 2666,
          "rows" : [
              {
                  "value" : {
                      "rev" : "1-a3544d296de19e6f5b932ea77d886942"
                  },
                  "id" : "Zingylemontart",
                  "key" : "Zingylemontart"
              },
              {
                  "value" : {
                      "rev" : "1-91635098bfe7d40197a1b98d7ee085fc"
                  },
                  "id" : "Yogurtraita",
                  "key" : "Yogurtraita"
              }
          ],
          "offset" : 0
      }

# 1.3.3. `/{db}/_design_docs`

New in version 2.2.

GET /{db}/_design_docs

  Returns a JSON structure of all of the design documents in a given database. The information is returned as a JSON structure containing meta information about the return structure, including a list of all design documents and basic contents, consisting the ID, revision and key. The key is the design document’s `_id`.

  Parameters:

    - db – Database name

  Request Headers:

    - Accept –

      - application/json

      - text/plain

  Query Parameters:

    - conflicts (boolean) – Includes conflicts information in response. Ignored if include_docs isn’t `true`. Default is `false`.

    - descending (boolean) – Return the design documents in descending by key order. Default is `false`.

    - endkey (string) – Stop returning records when the specified key is reached. Optional.

    - end_key (string) – Alias for endkey param.

    - endkey_docid (string) – Stop returning records when the specified design document ID is reached. Optional.

    - end_key_doc_id (string) – Alias for endkey_docid param.

    - include_docs (boolean) – Include the full content of the design documents in the return. Default is `false`.

    - inclusive_end (boolean) – Specifies whether the specified end key should be included in the result. Default is `true`.

    - key (string) – Return only design documents that match the specified key. Optional.

    - keys (string) – Return only design documents that match the specified keys. Optional.

    - limit (number) – Limit the number of the returned design documents to the specified number. Optional.

    - skip (number) – Skip this number of records before starting to return the results. Default is `0`.

    - startkey (string) – Return records starting with the specified key. Optional.

    - start_key (string) – Alias for startkey param.

    - startkey_docid (string) – Return records starting with the specified design document ID. Optional.

    - start_key_doc_id (string) – Alias for startkey_docid param.

    - update_seq (boolean) – Response includes an `update_seq` value indicating which sequence id of the underlying database the view reflects. Default is `false`.

  Response Headers:

    - Content-Type –

      - application/json

      - text/plain; charset=utf-8

    - ETag – Response signature

  Response JSON Object:

    - offset (number) – Offset where the design document list started

    - rows (array) – Array of view row objects. By default the information returned contains only the design document ID and revision.

    - total_rows (number) – Number of design documents in the database. Note that this is not the number of rows returned in the actual query.

    - update_seq (number) – Current update sequence for the database

  Status Codes:

    - 200 OK – Request completed successfully

    - 404 Not Found – Requested database not found

  Request:

      GET /db/_design_docs HTTP/1.1
      Accept: application/json
      Host: localhost:5984

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Type: application/json
      Date: Sat, 23 Dec 2017 16:22:56 GMT
      ETag: "1W2DJUZFZSZD9K78UFA3GZWB4"
      Server: CouchDB (Erlang/OTP)
      Transfer-Encoding: chunked

      {
          "offset": 0,
          "rows": [
              {
                  "id": "_design/ddoc01",
                  "key": "_design/ddoc01",
                  "value": {
                      "rev": "1-7407569d54af5bc94c266e70cbf8a180"
                  }
              },
              {
                  "id": "_design/ddoc02",
                  "key": "_design/ddoc02",
                  "value": {
                      "rev": "1-d942f0ce01647aa0f46518b213b5628e"
                  }
              },
              {
                  "id": "_design/ddoc03",
                  "key": "_design/ddoc03",
                  "value": {
                      "rev": "1-721fead6e6c8d811a225d5a62d08dfd0"
                  }
              },
              {
                  "id": "_design/ddoc04",
                  "key": "_design/ddoc04",
                  "value": {
                      "rev": "1-32c76b46ca61351c75a84fbcbceece2f"
                  }
              },
              {
                  "id": "_design/ddoc05",
                  "key": "_design/ddoc05",
                  "value": {
                      "rev": "1-af856babf9cf746b48ae999645f9541e"
                  }
              }
          ],
          "total_rows": 5
      }

POST /{db}/_design_docs

  POST _design_docs functionality supports identical parameters and behavior as specified in the `GET /{db}/_design_docs` API but allows for the query string parameters to be supplied as keys in a JSON object in the body of the POST request.

  Request:

      POST /db/_design_docs HTTP/1.1
      Accept: application/json
      Content-Length: 70
      Content-Type: application/json
      Host: localhost:5984

      {
          "keys" : [
              "_design/ddoc02",
              "_design/ddoc05"
          ]
      }

  The returned JSON is the all documents structure, but with only the selected keys in the output:

      {
          "total_rows" : 5,
          "rows" : [
              {
                  "value" : {
                      "rev" : "1-d942f0ce01647aa0f46518b213b5628e"
                  },
                  "id" : "_design/ddoc02",
                  "key" : "_design/ddoc02"
              },
              {
                  "value" : {
                      "rev" : "1-af856babf9cf746b48ae999645f9541e"
                  },
                  "id" : "_design/ddoc05",
                  "key" : "_design/ddoc05"
              }
          ],
          "offset" : 0
      }

## 1.3.3.1. Sending multiple queries to a database

New in version 2.2.

POST /{db}/_all_docs/queries

  Executes multiple specified built-in view queries of all documents in this database. This enables you to request multiple queries in a single request, in place of multiple `POST /{db}/_all_docs` requests.

  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type –

      - application/json

    - Accept –

      - application/json

  Request JSON Object:

    - queries – An array of query objects with fields for the parameters of each individual view query to be executed. The field names and their meaning are the same as the query parameters of a regular _all_docs request.

  Response Headers:

    - Content-Type –

      - application/json

      - text/plain; charset=utf-8

    - ETag – Response signature

    - Transfer-Encoding – `chunked`

  Response JSON Object:

    - results (array) – An array of result objects - one for each query. Each result object contains the same fields as the response to a regular _all_docs request.

  Status Codes:

    - 200 OK – Request completed successfully

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Read permission required

    - 404 Not Found – Specified database is missing

    - 500 Internal Server Error – Query execution error

Request:

    POST /db/_all_docs/queries HTTP/1.1
    Content-Type: application/json
    Accept: application/json
    Host: localhost:5984

    {
        "queries": [
            {
                "keys": [
                    "meatballs",
                    "spaghetti"
                ]
            },
            {
                "limit": 3,
                "skip": 2
            }
        ]
    }

Response:

    HTTP/1.1 200 OK
    Cache-Control: must-revalidate
    Content-Type: application/json
    Date: Wed, 20 Dec 2017 11:17:07 GMT
    ETag: "1H8RGBCK3ABY6ACDM7ZSC30QK"
    Server: CouchDB (Erlang/OTP)
    Transfer-Encoding: chunked

    {
        "results" : [
            {
                "rows": [
                    {
                        "id": "meatballs",
                        "key": "meatballs",
                        "value": 1
                    },
                    {
                        "id": "spaghetti",
                        "key": "spaghetti",
                        "value": 1
                    }
                ],
                "total_rows": 3
            },
            {
                "offset" : 2,
                "rows" : [
                    {
                        "id" : "Adukiandorangecasserole-microwave",
                        "key" : "Aduki and orange casserole - microwave",
                        "value" : [
                            null,
                            "Aduki and orange casserole - microwave"
                        ]
                    },
                    {
                        "id" : "Aioli-garlicmayonnaise",
                        "key" : "Aioli - garlic mayonnaise",
                        "value" : [
                            null,
                            "Aioli - garlic mayonnaise"
                        ]
                    },
                    {
                        "id" : "Alabamapeanutchicken",
                        "key" : "Alabama peanut chicken",
                        "value" : [
                            null,
                            "Alabama peanut chicken"
                        ]
                    }
                ],
                "total_rows" : 2667
            }
        ]
    }

Note

The multiple queries are also supported in /db/_local_docs/queries and /db/_design_docs/queries (similar to /db/_all_docs/queries).

# 1.3.4. `/{db}/_bulk_get`

POST /{db}/_bulk_get

  This method can be called to query several documents in bulk. It is well suited for fetching a specific revision of documents, as replicators do for example, or for getting revision history.

  Parameters:

    - db – Database name

  Request Headers:

    - Accept –

      - application/json

      - multipart/related

      - multipart/mixed

    - Content-Type – application/json

  Query Parameters:

    - revs (boolean) – Give the revisions history

  Request JSON Object:

    - docs (array) – List of document objects, with `id`, and optionally `rev` and `atts_since`

  Response Headers:

    - Content-Type –

      - application/json

  Response JSON Object:

    - results (object) – an array of results for each requested document/rev pair. `id` key lists the requested document ID, `docs` contains a single-item array of objects, each of which has either an `error` key and value describing the error, or `ok` key and associated value of the requested document, with the additional `_revisions` property that lists the parent revisions if `revs=true`.

  Status Codes:

    - 200 OK – Request completed successfully

    - 400 Bad Request – The request provided invalid JSON data or invalid query parameter

    - 401 Unauthorized – Read permission required

    - 404 Not Found – Invalid database name

    - 415 Unsupported Media Type – Bad Content-Type value

  Request:

      POST /db/_bulk_get HTTP/1.1
      Accept: application/json
      Content-Type:application/json
      Host: localhost:5984

      {
          "docs": [
              {
                  "id": "foo"
                  "rev": "4-753875d51501a6b1883a9d62b4d33f91",
              },
              {
                  "id": "foo"
                  "rev": "1-4a7e4ae49c4366eaed8edeaea8f784ad",
              },
              {
                  "id": "bar",
              }
              {
                  "id": "baz",
              }
          ]
      }

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Type: application/json
      Date: Mon, 19 Mar 2018 15:27:34 GMT
      Server: CouchDB (Erlang/OTP)

      {
        "results": [
          {
            "id": "foo",
            "docs": [
              {
                "ok": {
                  "_id": "foo",
                  "_rev": "4-753875d51501a6b1883a9d62b4d33f91",
                  "value": "this is foo",
                  "_revisions": {
                    "start": 4,
                    "ids": [
                      "753875d51501a6b1883a9d62b4d33f91",
                      "efc54218773c6acd910e2e97fea2a608",
                      "2ee767305024673cfb3f5af037cd2729",
                      "4a7e4ae49c4366eaed8edeaea8f784ad"
                    ]
                  }
                }
              }
            ]
          },
          {
            "id": "foo",
            "docs": [
              {
                "ok": {
                  "_id": "foo",
                  "_rev": "1-4a7e4ae49c4366eaed8edeaea8f784ad",
                  "value": "this is the first revision of foo",
                  "_revisions": {
                    "start": 1,
                    "ids": [
                      "4a7e4ae49c4366eaed8edeaea8f784ad"
                    ]
                  }
                }
              }
            ]
          },
          {
            "id": "bar",
            "docs": [
              {
                "ok": {
                  "_id": "bar",
                  "_rev": "2-9b71d36dfdd9b4815388eb91cc8fb61d",
                  "baz": true,
                  "_revisions": {
                    "start": 2,
                    "ids": [
                      "9b71d36dfdd9b4815388eb91cc8fb61d",
                      "309651b95df56d52658650fb64257b97"
                    ]
                  }
                }
              }
            ]
          },
          {
            "id": "baz",
            "docs": [
              {
                "error": {
                  "id": "baz",
                  "rev": "undefined",
                  "error": "not_found",
                  "reason": "missing"
                }
              }
            ]
          }
        ]
      }

  Example response with a conflicted document:

  Request:

      POST /db/_bulk_get HTTP/1.1
      Accept: application/json
      Content-Type:application/json
      Host: localhost:5984

      {
          "docs": [
              {
                  "id": "a"
              }
          ]
      }

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Type: application/json
      Date: Mon, 19 Mar 2018 15:27:34 GMT
      Server: CouchDB (Erlang/OTP)

      {
        "results": [
          {
            "id": "a",
            "docs": [
              {
                "ok": {
                  "_id": "a",
                  "_rev": "1-23202479633c2b380f79507a776743d5",
                  "a": 1
                }
              },
              {
                "ok": {
                  "_id": "a",
                  "_rev": "1-967a00dff5e02add41819138abb3284d"
                }
              }
            ]
          }
        ]
      }

# 1.3.5. `/{db}/_bulk_docs`

POST /{db}/_bulk_docs

  The bulk document API allows you to create and update multiple documents at the same time within a single request. The basic operation is similar to creating or updating a single document, except that you batch the document structure and information.

  When creating new documents the document ID (`_id`) is optional.

  For updating existing documents, you must provide the document ID, revision information (`_rev`), and new document values.

  In case of batch deleting documents all fields as document ID, revision information and deletion status (`_deleted`) are required.

  Parameters:

    - db – Database name

  Request Headers:

    - Accept –

      - application/json

      - text/plain

    - Content-Type – application/json

  Request JSON Object:

    - docs (array) – List of documents objects

    - new_edits (boolean) – If `false`, prevents the database from assigning them new revision IDs. Default is `true`. Optional

  Response Headers:

    - Content-Type –

      - application/json

      - text/plain; charset=utf-8

  Response JSON Array of Objects:

    - id (string) – Document ID

    - rev (string) – New document revision token. Available if document has saved without errors. Optional

    - error (string) – Error type. Optional

    - reason (string) – Error reason. Optional

  Status Codes:

    - 201 Created – Document(s) have been created or updated

    - 400 Bad Request – The request provided invalid JSON data

    - 404 Not Found – Requested database not found

  Request:

      POST /db/_bulk_docs HTTP/1.1
      Accept: application/json
      Content-Length: 109
      Content-Type:application/json
      Host: localhost:5984

      {
          "docs": [
              {
                  "_id": "FishStew"
              },
              {
                  "_id": "LambStew",
                  "_rev": "2-0786321986194c92dd3b57dfbfc741ce",
                  "_deleted": true
              }
          ]
      }

  Response:

      HTTP/1.1 201 Created
      Cache-Control: must-revalidate
      Content-Length: 144
      Content-Type: application/json
      Date: Mon, 12 Aug 2013 00:15:05 GMT
      Server: CouchDB (Erlang/OTP)

      [
          {
              "ok": true,
              "id": "FishStew",
              "rev":" 1-967a00dff5e02add41819138abb3284d"
          },
          {
              "ok": true,
              "id": "LambStew",
              "rev": "3-f9c62b2169d0999103e9f41949090807"
          }
      ]

## 1.3.5.1. Inserting Documents in Bulk

Each time a document is stored or updated in CouchDB, the internal B-tree is updated. Bulk insertion provides efficiency gains in both storage space, and time, by consolidating many of the updates to intermediate B-tree nodes.

It is not intended as a way to perform `ACID`-like transactions in CouchDB, the only transaction boundary within CouchDB is a single update to a single database. The constraints are detailed in Bulk Documents Transaction Semantics.

To insert documents in bulk into a database you need to supply a JSON structure with the array of documents that you want to add to the database. You can either include a document ID, or allow the document ID to be automatically generated.

For example, the following update inserts three new documents, two with the supplied document IDs, and one which will have a document ID generated:

    POST /source/_bulk_docs HTTP/1.1
    Accept: application/json
    Content-Length: 323
    Content-Type: application/json
    Host: localhost:5984

    {
        "docs": [
            {
                "_id": "FishStew",
                "servings": 4,
                "subtitle": "Delicious with freshly baked bread",
                "title": "FishStew"
            },
            {
                "_id": "LambStew",
                "servings": 6,
                "subtitle": "Serve with a whole meal scone topping",
                "title": "LambStew"
            },
            {
                "servings": 8,
                "subtitle": "Hand-made dumplings make a great accompaniment",
                "title": "BeefStew"
            }
        ]
    }

The return type from a bulk insertion will be 201 Created, with the content of the returned structure indicating specific success or otherwise messages on a per-document basis.

The return structure from the example above contains a list of the documents created, here with the combination and their revision IDs:

    HTTP/1.1 201 Created
    Cache-Control: must-revalidate
    Content-Length: 215
    Content-Type: application/json
    Date: Sat, 26 Oct 2013 00:10:39 GMT
    Server: CouchDB (Erlang OTP)

    [
        {
            "id": "FishStew",
            "ok": true,
            "rev": "1-6a466d5dfda05e613ba97bd737829d67"
        },
        {
            "id": "LambStew",
            "ok": true,
            "rev": "1-648f1b989d52b8e43f05aa877092cc7c"
        },
        {
            "id": "00a271787f89c0ef2e10e88a0c0003f0",
            "ok": true,
            "rev": "1-e4602845fc4c99674f50b1d5a804fdfa"
        }
    ]

For details of the semantic content and structure of the returned JSON see Bulk Documents Transaction Semantics. Conflicts and validation errors when updating documents in bulk must be handled separately; see Bulk Document Validation and Conflict Errors.

## 1.3.5.2. Updating Documents in Bulk

The bulk document update procedure is similar to the insertion procedure, except that you must specify the document ID and current revision for every document in the bulk update JSON string.

For example, you could send the following request:

    POST /recipes/_bulk_docs HTTP/1.1
    Accept: application/json
    Content-Length: 464
    Content-Type: application/json
    Host: localhost:5984

    {
        "docs": [
            {
                "_id": "FishStew",
                "_rev": "1-6a466d5dfda05e613ba97bd737829d67",
                "servings": 4,
                "subtitle": "Delicious with freshly baked bread",
                "title": "FishStew"
            },
            {
                "_id": "LambStew",
                "_rev": "1-648f1b989d52b8e43f05aa877092cc7c",
                "servings": 6,
                "subtitle": "Serve with a whole meal scone topping",
                "title": "LambStew"
            },
            {
                "_id": "BeefStew",
                "_rev": "1-e4602845fc4c99674f50b1d5a804fdfa",
                "servings": 8,
                "subtitle": "Hand-made dumplings make a great accompaniment",
                "title": "BeefStew"
            }
        ]
    }

The return structure is the JSON of the updated documents, with the new revision and ID information:

    HTTP/1.1 201 Created
    Cache-Control: must-revalidate
    Content-Length: 215
    Content-Type: application/json
    Date: Sat, 26 Oct 2013 00:10:39 GMT
    Server: CouchDB (Erlang OTP)

    [
        {
            "id": "FishStew",
            "ok": true,
            "rev": "2-2bff94179917f1dec7cd7f0209066fb8"
        },
        {
            "id": "LambStew",
            "ok": true,
            "rev": "2-6a7aae7ac481aa98a2042718d09843c4"
        },
        {
            "id": "BeefStew",
            "ok": true,
            "rev": "2-9801936a42f06a16f16c30027980d96f"
        }
    ]

You can optionally delete documents during a bulk update by adding the `_deleted` field with a value of `true` to each document ID/revision combination within the submitted JSON structure.

The return type from a bulk insertion will be 201 Created, with the content of the returned structure indicating specific success or otherwise messages on a per-document basis.

The content and structure of the returned JSON will depend on the transaction semantics being used for the bulk update; see Bulk Documents Transaction Semantics for more information. Conflicts and validation errors when updating documents in bulk must be handled separately; see Bulk Document Validation and Conflict Errors.

## 1.3.5.3. Bulk Documents Transaction Semantics

Bulk document operations are non-atomic. This means that CouchDB does not guarantee that any individual document included in the bulk update (or insert) will be saved when you send the request. The response will contain the list of documents successfully inserted or updated during the process. In the event of a crash, some of the documents may have been successfully saved, while others lost.

The response structure will indicate whether the document was updated by supplying the new `_rev` parameter indicating a new document revision was created. If the update failed, you will get an `error` of type `conflict`. For example:

>     [
>         {
>             "id" : "FishStew",
>             "error" : "conflict",
>             "reason" : "Document update conflict."
>         },
>         {
>             "id" : "LambStew",
>             "error" : "conflict",
>             "reason" : "Document update conflict."
>         },
>         {
>             "id" : "BeefStew",
>             "error" : "conflict",
>             "reason" : "Document update conflict."
>         }
>     ]

In this case no new revision has been created and you will need to submit the document update, with the correct revision tag, to update the document.

Replication of documents is independent of the type of insert or update. The documents and revisions created during a bulk insert or update are replicated in the same way as any other document.

## 1.3.5.4. Bulk Document Validation and Conflict Errors

The JSON returned by the `_bulk_docs` operation consists of an array of JSON structures, one for each document in the original submission. The returned JSON structure should be examined to ensure that all of the documents submitted in the original request were successfully added to the database.

When a document (or document revision) is not correctly committed to the database because of an error, you should check the `error` field to determine error type and course of action. Errors will be one of the following type:

- conflict

  The document as submitted is in conflict. The new revision will not have been created and you will need to re-submit the document to the database.

  Conflict resolution of documents added using the bulk docs interface is identical to the resolution procedures used when resolving conflict errors during replication.

- forbidden

  Entries with this error type indicate that the validation routine applied to the document during submission has returned an error.

  For example, if your validation routine includes the following:

      throw({forbidden: 'invalid recipe ingredient'});

  The error response returned will be:

      HTTP/1.1 201 Created
      Cache-Control: must-revalidate
      Content-Length: 80
      Content-Type: application/json
      Date: Sat, 26 Oct 2013 00:05:17 GMT
      Server: CouchDB (Erlang OTP)

      [
          {
              "id": "LambStew",
              "error": "forbidden",
              "reason": "invalid recipe ingredient"
          }
      ]