diff options
author | Jan Lehnardt <jan@apache.org> | 2013-08-19 15:02:51 +0200 |
---|---|---|
committer | Jan Lehnardt <jan@apache.org> | 2013-08-19 15:02:51 +0200 |
commit | 01f395eb73cb3294f15773bc1f066b6dced689a2 (patch) | |
tree | 76a5aa3bfe47e2f3674c658de2916b9f9452d309 | |
parent | e874245f6ed0a7af554e8dbab24ad465d2abffa0 (diff) | |
download | couchdb-01f395eb73cb3294f15773bc1f066b6dced689a2.tar.gz |
[docs] clariy purpose of purge
-rw-r--r-- | share/doc/src/api/database.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/share/doc/src/api/database.rst b/share/doc/src/api/database.rst index ba2195cff..4ef330dec 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 |