Table of Contents
The Local (non-replicating) document interface allows you to create local documents that are not replicated to other databases. These documents can be used to hold configuration or other information that is required specifically on the local CouchDB instance.
Local documents have the following limitations:
Local documents are not replicated to other databases.
The ID of the local document must be known for the document to accessed. You cannot obtain a list of local documents from the database.
Local documents are not output by views, or the
_all_docs view.
Local documents can be used when you want to store configuration or other information for the curent (local) instance of a given database.
A list of the available methods and URL paths are provided below:
Table 7.1. Local (non-replicating) Document API Calls
| Method | Path | Description |
|---|---|---|
GET | /db/_local/local-doc | Returns the latest revision of the non-replicated document |
PUT | /db/_local/local-doc | Inserts a new version of the non-replicated document |
DELETE | /db/_local/local-doc | Deletes the non-replicated document |
COPY | /db/_local/local-doc | Copies the non-replicated document |