1.3.6. /{db}/_find — Apache CouchDB® 3.4 Documentation

# 1.3.6. `/{db}/_find`

POST /{db}/_find

  Find documents using a declarative JSON querying syntax. Queries will use custom indexes, specified using the _index endpoint, if available. Otherwise, when allowed, they use the built-in _all_docs index, which can be arbitrarily slow.

  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type –

      - application/json

  Request JSON Object:

    - selector (object) – JSON object describing criteria used to select documents. More information provided in the section on selector syntax. Required

    - limit (number) – Maximum number of results returned. Default is `25`. Optional

    - skip (number) – Skip the first ‘n’ results, where ‘n’ is the value specified. Optional

    - sort (array) – JSON array following sort syntax. Optional

    - fields (array) – JSON array specifying which fields of each object should be returned. If it is omitted, the entire object is returned. More information provided in the section on filtering fields. Optional

    - use_index (string|array) – Request a query to use a specific index. Specified either as `"<design_document>"` or `["<design_document>", "<index_name>"]`. It is not guaranteed that the index will be actually used because if the index is not valid for the selector, fallback to a valid index is attempted. Therefore that is more like a hint. When fallback occurs, the details are given in the `warning` field of the response. Optional

    - allow_fallback (boolean) – Tell if it is allowed to fall back to another valid index. This can happen on running a query with an index specified by `use_index` which is not deemed usable, or when only the built-in _all_docs index would be picked in lack of indexes available to support the query. Disabling this fallback logic causes the endpoint immediately return an error in such cases. Default is `true`. Optional

    - conflicts (boolean) – Include conflicted documents if `true`. Intended use is to easily find conflicted documents, without an index or view. Default is `false`. Optional

    - r (number) – Read quorum needed for the result. This defaults to 1, in which case the document found in the index is returned. If set to a higher value, each document is read from at least that many replicas before it is returned in the results. This is likely to take more time than using only the document stored locally with the index. Optional, default: 1

    - bookmark (string) – A string that enables you to specify which page of results you require. Used for paging through result sets. Every query returns an opaque string under the `bookmark` key that can then be passed back in a query to get the next page of results. If any part of the selector query changes between requests, the results are undefined. Optional, default: null

    - update (boolean) – Whether to update the index prior to returning the result. Default is `true`. Optional

    - stable (boolean) – Whether or not the view results should be returned from a “stable” set of shards. Optional

    - stale (string) – Combination of `update=false` and `stable=true` options. Possible options: `"ok"`, `false` (default). Optional Note that this parameter is deprecated. Use `stable` and `update` instead. See Views Generation for more details.

    - execution_stats (boolean) – Include execution statistics in the query response. Optional, default: `false`

  Response Headers:

    - Content-Type –

      - application/json

    - Transfer-Encoding – `chunked`

  Response JSON Object:

    - docs (object) – Array of documents matching the search. In each matching document, the fields specified in the `fields` part of the request body are listed, along with their values.

    - warning (string) – Execution warnings

    - execution_stats (object) – Execution statistics

    - bookmark (string) – An opaque string used for paging. See the `bookmark` field in the request (above) for usage details.

  Status Codes:

    - 200 OK – Request completed successfully

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Read permission required

    - 404 Not Found – Requested database not found

    - 500 Internal Server Error – Query execution error

The `limit` and `skip` values are exactly as you would expect. While `skip` exists, it is not intended to be used for paging. The reason is that the `bookmark` feature is more efficient.

> Request:

Example request body for finding documents using an index:

>     POST /movies/_find HTTP/1.1
>     Accept: application/json
>     Content-Type: application/json
>     Content-Length: 168
>     Host: localhost:5984

>     {
>         "selector": {
>             "year": {"$gt": 2010}
>         },
>         "fields": ["_id", "_rev", "year", "title"],
>         "sort": [{"year": "asc"}],
>         "limit": 2,
>         "skip": 0,
>         "execution_stats": true
>     }

> Response:

Example response when finding documents using an index:

>     HTTP/1.1 200 OK
>     Cache-Control: must-revalidate
>     Content-Type: application/json
>     Date: Thu, 01 Sep 2016 15:41:53 GMT
>     Server: CouchDB (Erlang OTP)
>     Transfer-Encoding: chunked

>     {
>         "docs": [
>             {
>                 "_id": "176694",
>                 "_rev": "1-54f8e950cc338d2385d9b0cda2fd918e",
>                 "year": 2011,
>                 "title": "The Tragedy of Man"
>             },
>             {
>                 "_id": "780504",
>                 "_rev": "1-5f14bab1a1e9ac3ebdf85905f47fb084",
>                 "year": 2011,
>                 "title": "Drive"
>             }
>         ],
>         "execution_stats": {
>             "total_keys_examined": 200,
>             "total_docs_examined": 200,
>             "total_quorum_docs_examined": 0,
>             "results_returned": 2,
>             "execution_time_ms": 5.52
>         }
>     }

## 1.3.6.1. Selector Syntax

Selectors are expressed as a JSON object describing documents of interest. Within this structure, you can apply conditional logic using specially named fields.

Whilst selectors have some similarities with MongoDB query documents, these arise from a similarity of purpose and do not necessarily extend to commonality of function or result.

### 1.3.6.1.1. Selector Basics

Elementary selector syntax requires you to specify one or more fields, and the corresponding values required for those fields. This selector matches all documents whose `"director"` field has the value `"Lars von Trier"`.

    {
        "director": "Lars von Trier"
    }

A simple selector, inspecting specific fields:

    "selector": {
        "title": "Live And Let Die"
    },
    "fields": [
        "title",
        "cast"
    ]

You can create more complex selector expressions by combining operators. For best performance, it is best to combine ‘combination’ or ‘array logical’ operators, such as `$regex`, with an operator that defines a contiguous range of keys such as `$eq`, `$gt`, `$gte`, `$lt`, `$lte`, and `$beginsWith` (but not `$ne`). For more information about creating complex selector expressions, see creating selector expressions.

### 1.3.6.1.2. Selector with 2 fields

This selector matches any document with a name field containing `"Paul"`, and that also has a location field with the value `"Boston"`.

    {
        "name": "Paul",
        "location": "Boston"
    }

### 1.3.6.1.3. Subfields

A more complex selector enables you to specify the values for field of nested objects, or subfields. For example, you might use a standard JSON structure for specifying a field and subfield.

Example of a field and subfield selector, using a standard JSON structure:

    {
        "imdb": {
            "rating": 8
        }
    }

An abbreviated equivalent uses a dot notation to combine the field and subfield names into a single name.

    {
        "imdb.rating": 8
    }

### 1.3.6.1.4. Operators

Operators are identified by the use of a dollar sign (`$`) prefix in the name field.

There are two core types of operators in the selector syntax:

- Combination operators

- Condition operators

In general, combination operators are applied at the topmost level of selection. They are used to combine conditions, or to create combinations of conditions, into one selector.

Every explicit operator has the form:

    {
        "$operator": argument
    }

A selector without an explicit operator is considered to have an implicit operator. The exact implicit operator is determined by the structure of the selector expression.

### 1.3.6.1.5. Implicit Operators

There are two implicit operators:

- Equality

- And

In a selector, any field containing a JSON value, but that has no operators in it, is considered to be an equality condition. The implicit equality test applies also for fields and subfields.

Any JSON object that is not the argument to a condition operator is an implicit `$and` operator on each field.

In the below example, we use an operator to match any document, where the `"year"` field has a value greater than `2010`:

    {
        "year": {
            "$gt": 2010
        }
    }

In this next example, there must be a field `"director"` in a matching document, and the field must have a value exactly equal to `"Lars von Trier"`.

    {
        "director": "Lars von Trier"
    }

You can also make the equality operator explicit.

    {
        "director": {
            "$eq": "Lars von Trier"
        }
    }

In the next example using subfields, the required field `"imdb"` in a matching document must also have a subfield `"rating"` and the subfield must have a value equal to `8`.

Example of implicit operator applied to a subfield test:

    {
        "imdb": {
            "rating": 8
        }
    }

Again, you can make the equality operator explicit.

    {
        "imdb": {
            "rating": { "$eq": 8 }
        }
    }

An example of the `$eq` operator used with full text indexing:

    {
      "selector": {
        "year": {
          "$eq": 2001
        }
      },
      "sort": [
        "title:string"
      ],
      "fields": [
        "title"
      ]
    }

An example of the `$eq` operator used with database indexed on the field `"year"`:

    {
      "selector": {
        "year": {
          "$eq": 2001
        }
      },
      "sort": [
        "year"
      ],
      "fields": [
        "year"
      ]
    }

In this example, the field `"director"` must be present and contain the value `"Lars von Trier"` and the field `"year"` must exist and have the value `2003`.

    {
        "director": "Lars von Trier",
        "year": 2003
    }

You can make both the `$and` operator and the equality operator explicit.

Example of using explicit `$and` and `$eq` operators:

    {
        "$and": [
            {
                "director": {
                    "$eq": "Lars von Trier"
                }
            },
            {
                "year": {
                    "$eq": 2003
                }
            }
        ]
    }

### 1.3.6.1.6. Explicit Operators

All operators, apart from ‘Equality’ and ‘And’, must be stated explicitly.

### 1.3.6.1.7. Combination Operators

Combination operators are used to combine selectors. In addition to the common boolean operators found in most programming languages, there are three combination operators (`$all`, `$elemMatch`, and `$allMatch`) that help you work with JSON arrays and one that works with JSON maps (`$keyMapMatch`).

A combination operator takes a single argument. The argument is either another selector, or an array of selectors.

The list of combination operators:

Operator | Argument | Purpose
--- | --- | ---
`$and` | Array | Matches if all the selectors in the array match.
`$or` | Array | Matches if any of the selectors in the array match. All selectors must use the same index.
`$not` | Selector | Matches if the given selector does not match.
`$nor` | Array | Matches if none of the selectors in the array match.
`$all` | Array | Matches an array value if it contains all the elements of the argument array.
`$elemMatch` | Selector | Matches and returns all documents that contain an array field with at least one element that matches all the specified query criteria.
`$allMatch` | Selector | Matches and returns all documents that contain an array field with all its elements matching all the specified query criteria.
`$keyMapMatch` | Selector | Matches and returns all documents that contain a map that contains at least one key that matches all the specified query criteria.

The `$and` operator

`$and` operator used with two fields:

    {
      "selector": {
        "$and": [
          {
            "title": "Total Recall"
          },
          {
            "year": {
              "$in": [1984, 1991]
            }
          }
        ]
      },
      "fields": [
          "year",
          "title",
          "cast"
      ]
    }

The `$and` operator matches if all the selectors in the array match. Below is an example using the primary index (`_all_docs`):

    {
        "$and": [
            {
                "_id": { "$gt": null }
            },
            {
                "year": {
                    "$in": [2014, 2015]
                }
            }
        ]
    }

The `$or` operator

The `$or` operator matches if any of the selectors in the array match. Below is an example used with an index on the field `"year"`:

    {
        "year": 1977,
        "$or": [
            { "director": "George Lucas" },
            { "director": "Steven Spielberg" }
        ]
    }

The `$not` operator

The `$not` operator matches if the given selector does not match. Below is an example used with an index on the field `"year"`:

    {
        "year": {
            "$gte": 1900,
            "$lte": 1903
        },
        "$not": {
            "year": 1901
        }
    }

The `$nor` operator

The `$nor` operator matches if the given selector does not match. Below is an example used with an index on the field `"year"`:

    {
        "year": {
            "$gte": 1900.
            "$lte": 1910
        },
        "$nor": [
            { "year": 1901 },
            { "year": 1905 },
            { "year": 1907 }
        ]
    }

The `$all` operator

The `$all` operator matches an array value if it contains all the elements of the argument array. Below is an example used with the primary index (`_all_docs`):

    {
        "_id": {
            "$gt": null
        },
        "genre": {
            "$all": ["Comedy","Short"]
        }
    }

The `$elemMatch` operator

The `$elemMatch` operator matches and returns all documents that contain an array field with at least one element matching the supplied query criteria. Below is an example used with the primary index (`_all_docs`):

    {
        "_id": { "$gt": null },
        "genre": {
            "$elemMatch": {
                "$eq": "Horror"
            }
        }
    }

The `$allMatch` operator

The `$allMatch` operator matches and returns all documents that contain an array field with all its elements matching the supplied query criteria. Below is an example used with the primary index (`_all_docs`):

    {
        "_id": { "$gt": null },
        "genre": {
            "$allMatch": {
                "$eq": "Horror"
            }
        }
    }

The `$keyMapMatch` operator

The `$keyMapMatch` operator matches and returns all documents that contain a map that contains at least one key that matches all the specified query criteria. Below is an example used with the primary index (`_all_docs`):

    {
        "_id": { "$gt": null },
        "cameras": {
            "$keyMapMatch": {
                "$eq": "secondary"
            }
        }
    }

### 1.3.6.1.8. Condition Operators

Condition operators are specific to a field, and are used to evaluate the value stored in that field. For instance, the basic `$eq` operator matches when the specified field contains a value that is equal to the supplied argument.

Note

For a condition operator to function correctly, the field must exist in the document for the selector to match. As an example, `$ne` means the specified field must exist, and is not equal to the value of the argument.

The basic equality and inequality operators common to most programming languages are supported. Strict type matching is used.

In addition, some ‘meta’ condition operators are available. Some condition operators accept any valid JSON content as the argument. Other condition operators require the argument to be in a specific JSON format.

Operator type | Operator | Argument | Purpose
--- | --- | --- | ---
(In)equality | `$lt` | Any JSON | The field is less than the argument.
| `$lte` | Any JSON | The field is less than or equal to the argument.
| `$eq` | Any JSON | The field is equal to the argument.
| `$ne` | Any JSON | The field is not equal to the argument.
| `$gte` | Any JSON | The field is greater than or equal to the argument.
| `$gt` | Any JSON | The field is greater than the argument.
Object | `$exists` | Boolean | Check whether the field exists or not, regardless of its value.
| `$type` | String | Check the document field’s type. Valid values are `"null"`, `"boolean"`, `"number"`, `"string"`, `"array"`, and `"object"`.
Array | `$in` | Array of JSON values | The document field must exist in the list provided.
| `$nin` | Array of JSON values | The document field not must exist in the list provided.
| `$size` | Integer | Special condition to match the length of an array field in a document. Non-array fields cannot match this condition.
Miscellaneous | `$mod` | [Divisor, Remainder] | Divisor is a non-zero integer, Remainder is any integer. Non-integer values result in a 404. Matches documents where `field % Divisor == Remainder` is true, and only when the document field is an integer.
| `$regex` | String | A regular expression pattern to match against the document field. Only matches when the field is a string value and matches the supplied regular expression. The matching algorithms are based on the Perl Compatible Regular Expression (PCRE) library. For more information about what is implemented, see the Erlang Regular Expression.
| `$beginsWith` | String | Matches where the document field begins with the specified prefix (case-sensitive). If the document field contains a non-string value, the document is not matched.

Warning

Regular expressions do not work with indexes, so they should not be used to filter large data sets. They can, however, be used to restrict a partial index.

### 1.3.6.1.9. Creating Selector Expressions

We have seen examples of combining selector expressions, such as using explicit $and and $eq operators.

In general, whenever you have an operator that takes an argument, that argument can itself be another operator with arguments of its own. This enables us to build up more complex selector expressions.

However, only operators that define a contiguous range of values such as `$eq`, `$gt`, `$gte`, `$lt`, `$lte`, and `$beginsWith` (but not `$ne`) can be used as the basis of a query that can make efficient use of a `json` index. You should include at least one of these in a selector, or consider using a `text` index if greater flexibility is required.

For example, if you try to perform a query that attempts to match all documents that have a field called afieldname containing a value that begins with the letter A, this will trigger a warning because no index could be used and the database performs a full scan of the primary index:

> Request

>     POST /movies/_find HTTP/1.1
>     Accept: application/json
>     Content-Type: application/json
>     Content-Length: 112
>     Host: localhost:5984

>     {
>         "selector": {
>             "afieldname": {"$regex": "^A"}
>         }
>     }

> Response:

>     HTTP/1.1 200 OK
>     Cache-Control: must-revalidate
>     Content-Type: application/json
>     Date: Thu, 01 Sep 2016 17:25:51 GMT
>     Server: CouchDB (Erlang OTP)
>     Transfer-Encoding: chunked

>     {
>         "warning":"no matching index found, create an index to optimize query time",
>         "docs":[
>         ]
>     }

Warning

It is always recommended that you create an appropriate index when deploying in production.

Most selector expressions work exactly as you would expect for the given operator. But it is not always the case: for example, comparison of strings is done with ICU and can can give surprising results if you were expecting ASCII ordering. See Views Collation for more details.

## 1.3.6.2. Sort Syntax

The `sort` field contains a list of field name and direction pairs, expressed as a basic array. The first field name and direction pair is the topmost level of sort. The second pair, if provided, is the next level of sort.

The field can be any field, using dotted notation if desired for sub-document fields.

The direction value is `"asc"` for ascending, and `"desc"` for descending. If you omit the direction value, the default `"asc"` is used.

Example, sorting by 2 fields:

>     [{"fieldName1": "desc"}, {"fieldName2": "desc"}]

Example, sorting by 2 fields, assuming default direction for both :

>     ["fieldNameA", "fieldNameB"]

A typical requirement is to search for some content using a selector, then to sort the results according to the specified field, in the required direction.

To use sorting, ensure that:

- At least one of the sort fields is included in the selector.

- There is an index already defined, with all the sort fields in the same order.

- Each object in the sort array has a single key.

If an object in the sort array does not have a single key, the resulting sort order is implementation specific and might change.

Find does not support multiple fields with different sort orders, so the directions must be either all ascending or all descending.

For field names in text search sorts, it is sometimes necessary for a field type to be specified, for example:

    {
        "<fieldname>:string": "asc"
    }

If possible, an attempt is made to discover the field type based on the selector. In ambiguous cases the field type must be provided explicitly.

The sorting order is undefined when fields contain different data types. This is an important difference between text and view indexes. Sorting behavior for fields with different data types might change in future versions.

A simple query, using sorting:

    {
        "selector": {"Actor_name": "Robert De Niro"},
        "sort": [{"Actor_name": "asc"}, {"Movie_runtime": "asc"}]
    }

## 1.3.6.3. Filtering Fields

It is possible to specify exactly which fields are returned for a document when selecting from a database. The two advantages are:

- Your results are limited to only those parts of the document that are required for your application.

- A reduction in the size of the response.

The fields returned are specified as an array.

Only the specified filter fields are included, in the response. There is no automatic inclusion of the `_id` or other metadata fields when a field list is included.

Example of selective retrieval of fields from matching documents:

    {
        "selector": { "Actor_name": "Robert De Niro" },
        "fields": ["Actor_name", "Movie_year", "_id", "_rev"]
    }

## 1.3.6.4. Pagination

Mango queries support pagination via the bookmark field. Every `_find` response contains a bookmark - a token that CouchDB uses to determine where to resume from when subsequent queries are made. To get the next set of query results, add the bookmark that was received in the previous response to your next request. Remember to keep the selector the same, otherwise you will receive unexpected results. To paginate backwards, you can use a previous bookmark to return the previous set of results.

Note that the presence of a bookmark does not guarantee that there are more results. You can to test whether you have reached the end of the result set by comparing the number of results returned with the page size requested - if results returned < limit, there are no more.

## 1.3.6.5. Execution Statistics

Find can return basic execution statistics for a specific request. Combined with the _explain endpoint, this should provide some insight as to whether indexes are being used effectively.

The execution statistics currently include:

Field | Description
--- | ---
`total_keys_examined` | Number of index keys examined.
`total_docs_examined` | Number of documents fetched from the database / index, equivalent to using `include_docs=true` in a view. These may then be filtered in-memory to further narrow down the result set based on the selector.
`total_quorum_docs_examined` | Number of documents fetched from the database using an out-of-band document fetch. This is only non-zero when read quorum > 1 is specified in the query parameters.
`results_returned` | Number of results returned from the query. Ideally this should not be significantly lower than the total documents / keys examined.
`execution_time_ms` | Total execution time in milliseconds as measured by the database.

# 1.3.7. `/{db}/_index`

Mango is a declarative JSON querying language for CouchDB databases. Mango wraps several index types, starting with the Primary Index out-of-the-box. Mango indexes, with index type json, are built using MapReduce Views.

POST /{db}/_index

  Create a new index on a database

  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type –

      - application/json

  Query Parameters:

    - index (object) – JSON object describing the index to create.

    - ddoc (string) – Name of the design document in which the index will be created. By default, each index will be created in its own design document. Indexes can be grouped into design documents for efficiency. However, a change to one index in a design document will invalidate all other indexes in the same document (similar to views). Optional

    - name (string) – Name of the index. If no name is provided, a name will be generated automatically. Optional

    - type (string) – Can be `"json"`, `"text"` (for clouseau) or `"nouveau"`. Defaults to `"json"`. Optional

    - partitioned (boolean) – Determines whether a JSON index is partitioned or global. The default value of `partitioned` is the `partitioned` property of the database. To create a global index on a partitioned database, specify `false` for the `"partitioned"` field. If you specify `true` for the `"partitioned"` field on an unpartitioned database, an error occurs.

  Response Headers:

    - Content-Type –

      - application/json

    - Transfer-Encoding – `chunked`

  Response JSON Object:

    - result (string) – Flag to show whether the index was created or one already exists. Can be `"created"` or `"exists"`.

    - id (string) – Id of the design document the index was created in.

    - name (string) – Name of the index created.

  Status Codes:

    - 200 OK – Index created successfully or already exists

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Admin permission required

    - 404 Not Found – Database not found

    - 500 Internal Server Error – Execution error

  The index parameter is a JSON object with the following fields:

  - fields (array): Array of field names following the sort syntax. Nested fields are also allowed, e.g. “person.name”.

  - partial_filter_selector (object): A selector to apply to documents at indexing time, creating a partial index. Optional

  Example of creating a new index for a field called `foo`:

  Request:

      POST /db/_index HTTP/1.1
      Content-Type: application/json
      Content-Length: 116
      Host: localhost:5984

      {
          "index": {
              "fields": ["foo"]
          },
          "name" : "foo-index",
          "type" : "json"
      }

The returned JSON confirms the index has been created:

> Response:

>     HTTP/1.1 200 OK
>     Cache-Control: must-revalidate
>     Content-Length: 96
>     Content-Type: application/json
>     Date: Thu, 01 Sep 2016 18:17:48 GMT
>     Server: CouchDB (Erlang OTP/18)

>     {
>         "result":"created",
>         "id":"_design/a5f4711fc9448864a13c81dc71e660b524d7410c",
>         "name":"foo-index"
>     }

Example index creation using all available query parameters:

> Request:

>     POST /db/_index HTTP/1.1
>     Content-Type: application/json
>     Content-Length: 396
>     Host: localhost:5984

>     {
>         "index": {
>             "partial_filter_selector": {
>                 "year": {
>                     "$gt": 2010
>                 },
>                 "limit": 10,
>                 "skip": 0
>             },
>             "fields": [
>                 "_id",
>                 "_rev",
>                 "year",
>                 "title"
>             ]
>         },
>         "ddoc": "example-ddoc",
>         "name": "example-index",
>         "type": "json",
>         "partitioned": false
>     }

By default, a JSON index will include all documents that have the indexed fields present, including those which have `null` values.

## 1.3.7.1. Partial Indexes

Partial indexes allow documents to be filtered at indexing time, potentially offering significant performance improvements for query selectors that do not map cleanly to a range query on an index.

Let’s look at an example query:

    {
        "selector": {
            "status": {
                "$ne": "archived"
            },
            "type": "user"
        }
    }

Without a partial index, this requires a full index scan to find all the documents of `"type":"user"` that do not have a status of `"archived"`. This is because a normal index can only be used to match contiguous rows, and the `"$ne"` operator cannot guarantee that.

To improve response times, we can create an index which excludes documents where `"status": { "$ne": "archived" }` at index time using the `"partial_filter_selector"` field:

    POST /db/_index HTTP/1.1
    Content-Type: application/json
    Content-Length: 144
    Host: localhost:5984

    {
      "index": {
        "partial_filter_selector": {
          "status": {
            "$ne": "archived"
          }
        },
        "fields": ["type"]
      },
      "ddoc" : "type-not-archived",
      "type" : "json"
    }

Partial indexes are not currently used by the query planner unless specified by a `"use_index"` field, so we need to modify the original query:

    {
        "selector": {
            "status": {
                "$ne": "archived"
            },
            "type": "user"
        },
        "use_index": "type-not-archived"
    }

Technically, we do not need to include the filter on the `"status"` field in the query selector - the partial index ensures this is always true - but including it makes the intent of the selector clearer and will make it easier to take advantage of future improvements to query planning (e.g. automatic selection of partial indexes).

Note

An index with fields is only used, when the selector includes all of the fields indexed. For instance, if an index contains `["a". "b"]` but the selector only requires field `["a"]` to exist in the matching documents, the index would not be valid for the query. All indexes, however, can be treated as if they include the special fields `_id` and `_rev`. They never need to be specified in the query selector.

GET /{db}/_index

  When you make a `GET` request to `/{db}/_index`, you get a list of all indexes in the database. In addition to the information available through this API, indexes are also stored in design documents as views. Design documents are regular documents that have an ID starting with `_design/`. Design documents can be retrieved and modified in the same way as any other document, although this is not necessary when using Mango.

  Parameters:

    - db – Database name.

  Response Headers:

    - Content-Type –

      - application/json

    - Transfer-Encoding – `chunked`

  Response JSON Object:

    - total_rows (number) – Number of indexes.

    - indexes (array) – Array of index definitions (see below).

  Status Codes:

    - 200 OK – Success

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Read permission required

    - 500 Internal Server Error – Execution error

  Index definitions are JSON objects with the following fields:

  - ddoc (string): ID of the design document the index belongs to. This ID can be used to retrieve the design document containing the index, by making a `GET` request to `/{db}/ddoc`, where `ddoc` is the value of this field.

  - name (string): Name of the index.

  - partitioned (boolean): Partitioned (`true`) or global (`false`) index.

  - type (string): Type of the index. Currently `"json"` is the only supported type.

  - def (object): Definition of the index, containing the indexed fields and the sort order: ascending or descending.

  Request:

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

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Length: 238
      Content-Type: application/json
      Date: Thu, 01 Sep 2016 18:17:48 GMT
      Server: CouchDB (Erlang OTP/18)

      {
          "total_rows": 2,
          "indexes": [
          {
              "ddoc": null,
              "name": "_all_docs",
              "type": "special",
              "def": {
                  "fields": [
                      {
                          "_id": "asc"
                      }
                  ]
              }
          },
          {
              "ddoc": "_design/a5f4711fc9448864a13c81dc71e660b524d7410c",
              "name": "foo-index",
              "partitioned": false,
              "type": "json",
              "def": {
                  "fields": [
                      {
                          "foo": "asc"
                      }
                  ]
              }
          }
        ]
      }

DELETE /{db}/_index/{design_doc}/json/{name}
  Parameters:

    - db – Database name.

    - design_doc – Design document name. The `_design/` prefix is not required.

    - name – Index name.

  Response Headers:

    - Content-Type –

      - application/json

  Response JSON Object:

    - ok (string) – “true” if successful.

  Status Codes:

    - 200 OK – Success

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Writer permission required

    - 404 Not Found – Index not found

    - 500 Internal Server Error – Execution error

  Request:

      DELETE /db/_index/_design/a5f4711fc9448864a13c81dc71e660b524d7410c/json/foo-index HTTP/1.1
      Accept: */*
      Host: localhost:5984

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Length: 12
      Content-Type: application/json
      Date: Thu, 01 Sep 2016 19:21:40 GMT
      Server: CouchDB (Erlang OTP/18)

      {
          "ok": true
      }

POST /{db}/_index/_bulk_delete
  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type –

      - application/json

  Request JSON Object:

    - docids (array) – List of names for indexes to be deleted.

    - w (number) – Write quorum for each of the deletions. Default is `2`. Optional

  Response Headers:

    - Content-Type –

      - application/json

  Response JSON Object:

    - success (array) – An array of objects that represent successful deletions per index. The `id` key contains the name of the index, and `ok` reports if the operation has completed

    - fail (array) – An array of object that describe failed deletions per index. The `id` key names the corresponding index, and `error` describes the reason for the failure

  Status Codes:

    - 200 OK – Success

    - 400 Bad Request – Invalid request

    - 404 Not Found – Requested database not found

    - 500 Internal Server Error – Execution error

  Request:

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

      {
          "docids": [
              "_design/example-ddoc",
              "foo-index",
              "nonexistent-index"
          ]
      }

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Length: 94
      Content-Type: application/json
      Date: Thu, 01 Sep 2016 19:26:59 GMT
      Server: CouchDB (Erlang OTP/18)

      {
          "success": [
              {
                  "id": "_design/example-ddoc",
                  "ok": true
              },
              {
                  "id": "foo-index",
                  "ok": true
              }
          ],
          "fail": [
              {
                  "id": "nonexistent-index",
                  "error": "not_found"
              }
          ]
      }

# 1.3.8. `/{db}/_explain`

POST /{db}/_explain

  Shows which index is being used by the query. Parameters are the same as _find.

  Parameters:

    - db – Database name

  Request Headers:

    - Content-Type –

      - application/json

  Response Headers:

    - Content-Type –

      - application/json

    - Transfer-Encoding – `chunked`

  Response JSON Object:

    - covering (boolean) – Tell if the query could be answered only by relying on the data stored in the index. When `true`, no documents are fetched, which results in a faster response.

    - dbname (string) – Name of database.

    - index (object) – Index used to fulfill the query.

    - selector (object) – Query selector used.

    - opts (object) – Query options used.

    - mrargs (object) – Arguments passed to the underlying view.

    - limit (number) – Limit parameter used.

    - skip (number) – Skip parameter used.

    - fields (array) – Fields to be returned by the query. The [] value here means all the fields, since there is no projection happening in that case.

    - partitioned (boolean) – The database is partitioned or not.

    - index_candidates (array) – The list of all indexes that were found but not selected for serving the query. See the section on index selection below for the details.

    - selector_hints (object) – Extra information on the selector to provide insights about its usability.

  Status Codes:

    - 200 OK – Request completed successfully

    - 400 Bad Request – Invalid request

    - 401 Unauthorized – Read permission required

    - 500 Internal Server Error – Execution error

  Request:

      POST /movies/_explain HTTP/1.1
      Accept: application/json
      Content-Type: application/json
      Content-Length: 168
      Host: localhost:5984

      {
          "selector": {
              "year": {"$gt": 2010}
          },
          "fields": ["_id", "_rev", "year", "title"],
          "sort": [{"year": "asc"}],
          "limit": 2,
          "skip": 0
      }

  Response:

      HTTP/1.1 200 OK
      Cache-Control: must-revalidate
      Content-Type: application/json
      Date: Thu, 01 Sep 2016 15:41:53 GMT
      Server: CouchDB (Erlang OTP)
      Transfer-Encoding: chunked

      {
          "dbname": "movies",
          "index": {
              "ddoc": "_design/0d61d9177426b1e2aa8d0fe732ec6e506f5d443c",
              "name": "0d61d9177426b1e2aa8d0fe732ec6e506f5d443c",
              "type": "json",
              "partitioned": false,
              "def": {
                  "fields": [
                      {
                          "year": "asc"
                      }
                  ]
              }
          },
          "partitioned": false,
          "selector": {
              "year": {
                  "$gt": 2010
              }
          },
          "opts": {
              "use_index": [],
              "bookmark": "nil",
              "limit": 2,
              "skip": 0,
              "sort": {},
              "fields": [
                  "_id",
                  "_rev",
                  "year",
                  "title"
              ],
              "partition": "",
              "r": 1,
              "conflicts": false,
              "stale": false,
              "update": true,
              "stable": false,
              "execution_stats": false,
              "allow_fallback": true
          },
          "limit": 2,
          "skip": 0,
          "fields": [
              "_id",
              "_rev",
              "year",
              "title"
          ],
          "mrargs": {
              "include_docs": true,
              "view_type": "map",
              "reduce": false,
              "partition": null,
              "start_key": [
                  2010
              ],
              "end_key": [
                  "<MAX>"
              ],
              "direction": "fwd",
              "stable": false,
              "update": true,
              "conflicts": "undefined"
          },
          "covering": false
          "index_candidates": [
              {
                  "index": {
                      "ddoc": null,
                      "name": "_all_docs",
                      "type": "special",
                      "def": {
                          "fields": [
                              {
                                  "_id": "asc"
                              }
                          ]
                      }
                  },
                  "analysis": {
                      "usable": true,
                      "reasons": [
                          {
                              "name": "unfavored_type"
                          }
                      ],
                      "ranking": 1,
                      "covering": null
                  }
              }
          ],
          "selector_hints": [
              {
                  "type": "json",
                  "indexable_fields": [
                      "year"
                  ],
                  "unindexable_fields": []
              }
          ]
      }

## 1.3.8.1. Index selection

_find chooses which index to use for responding to a query, unless you specify an index at query time. In this section, a brief overview of the index selection process is presented.

Note

It is good practice to specify indexes explicitly in your queries. This prevents existing queries being affected by new indexes that might get added in a production environment.

Note

Both the _explain and _find endpoints rely on the same index selection logic. But _explain is a bit more elaborate, therefore it could be used for simulation and exploration. In the output, details for discarding indexes are placed in the `analysis` field of the JSON objects under `index_candidates`. Under `analysis` the exact reason is listed in the `reasons` field. Each reason has a specific code, which will be mentioned at the relevant subsections below.

The index selection happens in multiple rounds.

Steps of index selection

First, all the indexes for the database are collected. The result always includes the special entity called all docs which is the primary index on the `_id` field. This is reserved as a catch-all answer when no other suitable indexes could be found, but its use of discouraged for performance reasons.

In the next round, partial indexes are eliminated unless specified in the `use_index` field of the query object.

After that, indexes are filtered according whether a global or partitioned query was issued. Indexes that do not match the query scope are assigned a `scope_mismatch` reason code.

The remaining indexes are filtered by a series of usability checks.

Each usability check is supplied with its own reason code. That is `field_mismatch` for the cases when the fields in the index do not match with that of the selector. The code `sort_order_mismatch` means that the requested sorting does not align with the index. These checks depend on the type of index.

- `"special"`: Usable if no `sort` is specified in the query or `sort` is specified on `_id` only.

- `"json"`: The selector must not request a free-form text search via the `$text` operator. The `needs_text_search` reason code is returned otherwise.

  All the fields in the index must be referenced by the `selector` or `sort` in the query.

  Any `sort` specified in the query must match the order of the fields in the index.

- `"text"`: The index must contain fields that are referenced by the query `"selector"` or `"sort"`.

  The `"text"` indexes do not work empty selectors, and they return a `empty_selector` reason code in response to that.

After the usable indexes having gathered, the user-specified index is verified next. If this is a valid, usable index, then every other usable index is excluded with the `excluded_by_user` code. Otherwise, it is ignored an the process continues with the rest of the usable indexes.

There is a natural order of preference among the various index types: `"json"`, `"text"`, and then `"special"`. The usable indexes are grouped by their types in this order and the search is narrowed down to the elements of the first group. That is, even if there is a `"text"` index present that could match with the selector, it might be discarded if a `"json"` index with the suitable fields could be identified. Indexes dropped in this round are all tagged with the `unfavored_type` reason code.

There could be only a single `"text"` and `"special"` index per database, hence the selection ends in this phase for thoses cases. For `"json"` indexes, an additional round is run to find the ideal index.

The query planner looks at the selector section and finds the index with the closest match to operators and fields used in the query. This is described by the `less_overlap` reason code. If there are two or more `"json"`-type indexes that match, the index with the least number of fields in the index is preferred. This is marked by the `too_many_fields` reason code. If there are still two or more candidate indexes, the index with the first alphabetical name is chosen. This is reflected by the `alphabetically_comes_after` reason code.

Reason Code | Index Type | Description
--- | --- | ---
`alphabetically_comes_after` | json | There is another suitable index whose name comes before that of this index.
`empty_selector` | text | `"text"` indexes do not support queries with empty selectors.
`excluded_by_user` | any | `use_index` was used to manually specify the index.
`field_mismatch` | any | Fields in `"selector"` of the query do not match with the fields available in the index.
`is_partial` | json, text | Partial indexes can be selected only manually.
`less_overlap` | json | There is a better match of fields available within the indexes for the query.
`needs_text_search` | json | The use of the `$text` operator requires a `"text"` index.
`scope_mismatch` | json | The scope of the query and the index is not the same.
`sort_order_mismatch` | json, special | Fields in `"sort"` of the query do not match with the fields available in the index.
`too_many_fields` | json | The index has more fields than the chosen one.
`unfavored_type` | any | The type of the index is not preferred.

In the _explain output, some additional information on the candidate indexes could be found too as part of the `analysis` object.

- The `ranking` (number) attribute defines a loose ordering on the items of the list, which might be used to order them. This is a positive integer which is the greater the index is farther down in the queue. Virtually, the selected index is of rank `0` always, everything else must come after that one. The rank reflects the final position of the given index candidate in the tournament described above.

- The `usable` (Boolean) attribute tells if the index is usable at all. This could be used to partition the index candidates by their usability in relation to the selector.

- The `covering` (Boolean) attribute tells if the index is a covering index or not. This property is calculated for `"json"` indexes only and it is `null` in every other case.