[PATCH v2 05/12] lib: Update database schema doc for ghost messages

diff --git a/e1/410e3670021ed9b7b02b62092a216f0bb526e6 b/e1/410e3670021ed9b7b02b62092a216f0bb526e6
new file mode 100644 (file)
index 0000000..fecc79a
--- /dev/null
+++ b/e1/410e3670021ed9b7b02b62092a216f0bb526e6
@@ -0,0 +1,130 @@
+Return-Path: <aclements@csail.mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 18B53431FD6\r
+       for <notmuch@notmuchmail.org>; Mon,  6 Oct 2014 16:17:34 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id HY3q7skp5BQI for <notmuch@notmuchmail.org>;\r
+       Mon,  6 Oct 2014 16:17:30 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-2.mit.edu (dmz-mailsec-scanner-2.mit.edu\r
+       [18.9.25.13])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id EF57B431FB6\r
+       for <notmuch@notmuchmail.org>; Mon,  6 Oct 2014 16:17:26 -0700 (PDT)\r
+X-AuditID: 1209190d-f79c06d000006f95-00-543323066424\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id F3.74.28565.60323345; Mon,  6 Oct 2014 19:17:26 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id s96NHPuX032088; \r
+       Mon, 6 Oct 2014 19:17:25 -0400\r
+Received: from drake.dyndns.org ([12.185.136.2]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s96NHMGb014463\r
+       (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT);\r
+       Mon, 6 Oct 2014 19:17:24 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.84)\r
+       (envelope-from <aclements@csail.mit.edu>)\r
+       id 1XbHWr-0001JZ-S9; Mon, 06 Oct 2014 17:17:21 -0600\r
+From: Austin Clements <aclements@csail.mit.edu>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 05/12] lib: Update database schema doc for ghost messages\r
+Date: Mon,  6 Oct 2014 17:17:11 -0600\r
+Message-Id: <1412637438-4821-6-git-send-email-aclements@csail.mit.edu>\r
+X-Mailer: git-send-email 2.1.0\r
+In-Reply-To: <1412637438-4821-1-git-send-email-aclements@csail.mit.edu>\r
+References: <1412637438-4821-1-git-send-email-aclements@csail.mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrLIsWRmVeSWpSXmKPExsUixG6nrsumbBxisOUWv8WN1m5Gi+s3ZzI7\r
+       MHk8W3WL2WPLoffMAUxRXDYpqTmZZalF+nYJXBn/Zm5kK5jJX9G05z9jA+Nf7i5GTg4JAROJ\r
+       0z/3MELYYhIX7q1nA7GFBGYzSax7INPFyAVkb2CU2DChiRnCWcok8e/wfyYIZwmjxNx5H5hA\r
+       WtgE9CVWrJ3ECmKLCEhL7Lw7G8xmFrCUuPq1HaxGWMBHonPyA7AVLAKqEgs2bgKzeQXcJI69\r
+       esQKcYacxIbd/8FO4hRwl1hzZTIrxEluEs9/PmWZwMi/gJFhFaNsSm6Vbm5iZk5xarJucXJi\r
+       Xl5qka6RXm5miV5qSukmRlAocUry7mB8d1DpEKMAB6MSD2/EDsMQIdbEsuLK3EOMkhxMSqK8\r
+       c9iNQ4T4kvJTKjMSizPii0pzUosPMUpwMCuJ8HL9NgoR4k1JrKxKLcqHSUlzsCiJ8276wRci\r
+       JJCeWJKanZpakFoEk5Xh4FCS4DVWAhoqWJSanlqRlplTgpBm4uAEGc4DNPyfIlANb3FBYm5x\r
+       ZjpE/hSjopQ4bzBIQgAkkVGaB9cLi/VXjOJArwjzBoGs4AGmCbjuV0CDmYAGm87RBxlckoiQ\r
+       kmpgDN2j9bdnTWet2dnO+PeCMo8ZAowFxJVqNZ//XnTZJbTsrt4dpf/P3dtL5dyq1xtON+E1\r
+       Zz+wsdVlRqvvQdVbInuvpNQ8aRGqOHdh4eX+uFv7rqnP6fbduvbey5cnuRefDX3P7HrCNM8u\r
+       Piz3jPhFE8Xiw9+4mSLuyrp7KIkLyc8+fsPa/1+/EktxRqKhFnNRcSIA0tlvAdACAAA=\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 06 Oct 2014 23:17:34 -0000\r
+\r
+From: Austin Clements <amdragon@mit.edu>\r
+\r
+This describes the structure of ghost mail documents.  Ghost messages\r
+are not yet implemented.\r
+---\r
+ lib/database.cc | 20 ++++++++++++++++++--\r
+ 1 file changed, 18 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index 8fd7fad..c641bcd 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -50,8 +50,8 @@ typedef struct {\r
+ \r
+ /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):\r
+  *\r
+- * We currently have two different types of documents (mail and\r
+- * directory) and also some metadata.\r
++ * We currently have three different types of documents (mail, ghost,\r
++ * and directory) and also some metadata.\r
+  *\r
+  * Mail document\r
+  * -------------\r
+@@ -109,6 +109,15 @@ typedef struct {\r
+  *\r
+  * The data portion of a mail document is empty.\r
+  *\r
++ * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]\r
++ * -----------------------------------------------\r
++ * A ghost mail document is like a mail document, but where we don't\r
++ * have the message content.  These are used to track thread reference\r
++ * information for messages we haven't received.\r
++ *\r
++ * A ghost mail document has type: ghost; id and thread fields that\r
++ * are identical to the mail document fields; and a MESSAGE_ID value.\r
++ *\r
+  * Directory document\r
+  * ------------------\r
+  * A directory document is used by a client of the notmuch library to\r
+@@ -172,6 +181,13 @@ typedef struct {\r
+  *                    generated is 1 and the value will be\r
+  *                    incremented for each thread ID.\r
+  *\r
++ * Obsolete metadata\r
++ * -----------------\r
++ *\r
++ * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.\r
++ * Instead, the database has the following additional database\r
++ * metadata:\r
++ *\r
+  *    thread_id_*     A pre-allocated thread ID for a particular\r
+  *                    message. This is actually an arbitrarily large\r
+  *                    family of metadata name. Any particular name is\r
+-- \r
+2.1.0\r
+\r