Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 206FBC7E2 for ; Mon, 9 Sep 2013 09:53:48 +0000 (UTC) Received: (qmail 20437 invoked by uid 500); 9 Sep 2013 09:53:26 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 20250 invoked by uid 500); 9 Sep 2013 09:53:25 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 19566 invoked by uid 99); 9 Sep 2013 09:53:22 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 09 Sep 2013 09:53:22 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id B643C903956; Mon, 9 Sep 2013 09:53:21 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jan@apache.org To: commits@couchdb.apache.org Date: Mon, 09 Sep 2013 09:53:33 -0000 Message-Id: <127da9cfc3764db59247c8082726d16a@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [13/50] [abbrv] git commit: updated refs/heads/1867-feature-plugins to 8aad450 [docs] clariy purpose of purge Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/d5c28f25 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/d5c28f25 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/d5c28f25 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(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/d5c28f25/share/doc/src/api/database.rst ---------------------------------------------------------------------- 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