couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [13/50] [abbrv] git commit: updated refs/heads/1867-feature-plugins to 8aad450
Date Mon, 09 Sep 2013 09:53:33 GMT
[docs] clariy purpose of purge


Branch: refs/heads/1867-feature-plugins
Commit: d5c28f25e1832b36b60d1c9acde051fc75cc11c7
Parents: ce71976
Author: Jan Lehnardt <>
Authored: Mon Aug 19 15:02:51 2013 +0200
Committer: Jan Lehnardt <>
Committed: Mon Sep 9 11:16:42 2013 +0200

 share/doc/src/api/database.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
diff --git a/share/doc/src/api/database.rst b/share/doc/src/api/database.rst
index ba2195c..4ef330d 100644
--- a/share/doc/src/api/database.rst
+++ b/share/doc/src/api/database.rst
@@ -998,6 +998,9 @@ should use a defined view if you want to achieve the best performance.
 * **Response**: JSON structure with purged documents and purge sequence
 * **Admin Privileges Required**: no
+Occasionaly something into ends up in your database that should never have
+written to it, like a password or private key. Purge can help you here.
 A database purge permanently removes the references to deleted documents
 from the database. Deleting a document within CouchDB does not actually
 remove the document from the database, instead, the document is marked as
@@ -1006,6 +1009,12 @@ deleted documents are replicated to other databases as having been
 deleted. This also means that you can check the status of a document and
 identify that the document has been deleted.
+.. note::
+    Don't use purge as a regular operation, it is designed to be used
+    in exceptional cases.
 The purge operation removes the references to the deleted documents from
 the database. The purging of old documents is not replicated to other
 databases. If you are replicating between databases and have deleted a

View raw message