11.6. Local (non-replicating) Documents

The Local (non-replicating) document interface allows you to create localdocuments that are not replicated to other databases. These documents can beused to hold configuration or other information that is required specificallyon the local CouchDB instance.

Local documents have the following limitations:

• Local documents are not replicated to other databases.
• Local documents are not output by views, or the /db/_all_docs view.
  From CouchDB 2.0, Local documents can be listed by using the /db/_local_docsendpoint.

Local documents can be used when you want to store configuration orother information for the current (local) instance of a given database.

A list of the available methods and URL paths are provided below:

11.7. /db/_local_docs

GET /{db}/local_docs

Returns a JSON structure of all of the local documents in a givendatabase. The information is returned as a JSON structure containing metainformation about the return structure, including a list of all localdocuments and basic contents, consisting the ID, revision and key. The keyis the from the local 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 bykey order. Default is false.
- endkey (string) – Stop returning records when the specified key isreached. Optional.
- end_key (string) – Alias for endkey param.
- endkey_docid (string) – Stop returning records when the specifieddesign document ID is reached. Optional.
- end_key_doc_id (string) – Alias for endkey_docid param.
- include_docs (boolean) – Include the full content of the designdocuments in the return. Default is false.
- inclusive_end (boolean) – Specifies whether the specified end keyshould be included in the result. Default is true.
- key (string) – Return only design documents that match the specifiedkey. Optional.
- keys (string) – Return only design documents that match the specifiedkeys. Optional.
- limit (number) – Limit the number of the returned design documents tothe specified number. Optional.
- skip (number) – Skip this number of records before starting to returnthe 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 specifieddesign document ID. Optional.
- start_key_doc_id (string) – Alias for startkey_docid param.
- update_seq (boolean) – Response includes an updateseq valueindicating which sequence id of the underlying database the viewreflects. Default is false.
|Response Headers:
|——-
| |
- Content-Type –
- _application/json
- text/plain; charset=utf-8
|Response JSON Object:
|——-
| |
- offset (number) – Offset where the design document list started
- rows (array) – Array of view row objects. By default the informationreturned contains only the design document ID and revision.
- total_rows (number) – Number of design documents in the database. Notethat 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


Request:

GET /db/_local_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
Server: CouchDB (Erlang/OTP)
Transfer-Encoding: chunked

{
    "offset": null,
    "rows": [
        {
            "id": "_local/localdoc01",
            "key": "_local/localdoc01",
            "value": {
                "rev": "0-1"
            }
        },
        {
            "id": "_local/localdoc02",
            "key": "_local/localdoc02",
            "value": {
                "rev": "0-1"
            }
        },
        {
            "id": "_local/localdoc03",
            "key": "_local/localdoc03",
            "value": {
                "rev": "0-1"
            }
        },
        {
            "id": "_local/localdoc04",
            "key": "_local/localdoc04",
            "value": {
                "rev": "0-1"
            }
        },
        {
            "id": "_local/localdoc05",
            "key": "_local/localdoc05",
            "value": {
                "rev": "0-1"
            }
        }
    ],
    "total_rows": null
}

POST /{db}/_local_docs

The POST to _local_docs allows to specify multiple keys to beselected from the database. This enables you to request multiplelocal documents in a single request, in place of multipleGET /{db}/_local/{docid} requests.

The request body should contain a list of the keys to be returned as anarray to a keys object. For example:

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

{
    "keys" : [
        "_local/localdoc02",
        "_local/localdoc05"
    ]
}

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

{
    "total_rows" : null,
    "rows" : [
        {
            "value" : {
                "rev" : "0-1"
            },
            "id" : "_local/localdoc02",
            "key" : "_local/localdoc02"
        },
        {
            "value" : {
                "rev" : "0-1"
            },
            "id" : "_local/localdoc05",
            "key" : "_local/localdoc05"
        }
    ],
    "offset" : null
}

11.7.1. /db/_local/id

GET /{db}/_local/{docid}

Gets the specified local document. The semantics are identical to accessinga standard document in the specified database, except that the document isnot replicated. See GET /{db}/{docid}.

PUT /{db}/_local/{docid}

Stores the specified local document. The semantics are identical to storinga standard document in the specified database, except that the document isnot replicated. See PUT /{db}/{docid}.

DELETE /{db}/_local/{docid}

Deletes the specified local document. The semantics are identical todeleting a standard document in the specified database, except that thedocument is not replicated. See DELETE /{db}/{docid}.

COPY /{db}/_local/{docid}

Copies the specified local document. The semantics are identical to copyinga standard document in the specified database, except that the document isnot replicated. See COPY /{db}/{docid}.

原文: http://docs.couchdb.org/en/stable/api/local.html#db-local-docs