10.6. Local (non-replicating) Documents

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 /db/_all_docs view.

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 /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

10.6.1. /db/_local/id

GET /{db}/_local/{docid}

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

PUT /{db}/_local/{docid}

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

DELETE /{db}/_local/{docid}

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

COPY /{db}/_local/{docid}

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

Table Of Contents

Previous topic

10.5.11. /db/_design/design-doc/_rewrite/path

Next topic

11. Cluster Reference

More Help