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.
- Local documents are not output by views, or the
api/db/all_docsview.
From CouchDB 2.0, Local documents can be listed by using the /db/_local_docs endpoint.
Local documents can be used when you want to store configuration or other information for the current (local) instance of a given database.
A list of the available methods and URL paths are provided below:
| Method | Path | Description |
|---|---|---|
| GET, POST | /db/_local_docs | Returns a list of all the non-replicated documents in the database |
| GET | /db/_local/id | Returns the latest revision of the non-replicated document |
| PUT | /db/_local/id | Inserts a new version of the non-replicated document |
| DELETE | /db/_local/id | Deletes the non-replicated document |
| COPY | /db/_local/id | Copies the non-replicated document |