0d/0d8cd3e14049ed998c674c977a4e8fa915f6cd

   1 Return-Path: <aclements@csail.mit.edu>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id B5FED431FC0\r
   6         for <notmuch@notmuchmail.org>; Fri,  3 Oct 2014 07:19:38 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -2.3\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id MqKcR4g5aw01 for <notmuch@notmuchmail.org>;\r
  16         Fri,  3 Oct 2014 07:19:32 -0700 (PDT)\r
  17 Received: from dmz-mailsec-scanner-1.mit.edu (dmz-mailsec-scanner-1.mit.edu\r
  18         [18.9.25.12])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id D09B0431FCB\r
  22         for <notmuch@notmuchmail.org>; Fri,  3 Oct 2014 07:19:25 -0700 (PDT)\r
  23 X-AuditID: 1209190c-f795e6d000006c66-53-542eb06c3c9d\r
  24 Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
  25         (using TLS with cipher AES256-SHA (256/256 bits))\r
  26         (Client did not present a certificate)\r
  27         by dmz-mailsec-scanner-1.mit.edu (Symantec Messaging Gateway) with SMTP\r
  28         id 74.34.27750.C60BE245; Fri,  3 Oct 2014 10:19:24 -0400 (EDT)\r
  29 Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
  30         by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s93EJN9t018545; \r
  31         Fri, 3 Oct 2014 10:19:23 -0400\r
  32 Received: from drake.dyndns.org\r
  33         (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
  34         [216.15.114.40]) (authenticated bits=0)\r
  35         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  36         by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s93EJLIo023314\r
  37         (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT);\r
  38         Fri, 3 Oct 2014 10:19:22 -0400\r
  39 Received: from amthrax by drake.dyndns.org with local (Exim 4.84)\r
  40         (envelope-from <aclements@csail.mit.edu>)\r
  41         id 1Xa3hZ-0002Js-5M; Fri, 03 Oct 2014 10:19:21 -0400\r
  42 From: Austin Clements <aclements@csail.mit.edu>\r
  43 To: notmuch@notmuchmail.org\r
  44 Subject: [PATCH 05/11] lib: Update database schema doc for ghost messages\r
  45 Date: Fri,  3 Oct 2014 10:19:12 -0400\r
  46 Message-Id: <1412345958-8278-6-git-send-email-aclements@csail.mit.edu>\r
  47 X-Mailer: git-send-email 2.1.0\r
  48 In-Reply-To: <1412345958-8278-1-git-send-email-aclements@csail.mit.edu>\r
  49 References: <1412345958-8278-1-git-send-email-aclements@csail.mit.edu>\r
  50 X-Brightmail-Tracker:\r
  51  H4sIAAAAAAAAA+NgFtrEIsWRmVeSWpSXmKPExsUixCmqrZuzQS/EYNVZcYvrN2cyOzB6PFt1\r
  52         izmAMYrLJiU1J7MstUjfLoEr49/MjWwFM/krmvb8Z2xg/MvdxcjJISFgInFy00YWCFtM4sK9\r
  53         9WxdjFwcQgKzmSSmnvvEDJIQEtjAKDFhSQJE4jaTxL3W3YwQzhJGidm3jzKCVLEJ6EusWDuJ\r
  54         FcQWEZCW2Hl3NpDNwcEsoCbxp0sFJCws4Ckx99VhsG0sAqoSB7cfAGvlFXCTuL/hEBPEFXIS\r
  55         G3b/B4tzCrhLXLj7lA3iCDeJVce62SYw8i9gZFjFKJuSW6Wbm5iZU5yarFucnJiXl1qka6iX\r
  56         m1mil5pSuokRHDSSPDsY3xxUOsQowMGoxMP74YZuiBBrYllxZe4hRkkOJiVR3srFeiFCfEn5\r
  57         KZUZicUZ8UWlOanFhxglOJiVRHgXrATK8aYkVlalFuXDpKQ5WJTEeTf94AsREkhPLEnNTk0t\r
  58         SC2CycpwcChJ8LavB2oULEpNT61Iy8wpQUgzcXCCDOcBGg5Ww1tckJhbnJkOkT/FqCglzvtw\r
  59         HVBCACSRUZoH1wuL6leM4kCvCPN2gbTzABMCXPcroMFMQIPf2euCDC5JREhJNTCKMc7m6f56\r
  60         yr2YgWm9sNsuobtLo5r8d3eFFM9JW8V0TWh1xDZRIaU2zXueuUIe6dt1D8YGHv+ibPPB5phl\r
  61         myqXup4tV+vx1Fseq/5urdXI2hgoOz/pT+/E4PcPrj6/abHz+4Oli9kOFjQ8er1W0qyloahv\r
  62         iVjY9x/K52+Fenr1J9cuPh9lf0aJpTgj0VCLuag4EQBg99rnxQIAAA==\r
  63 X-BeenThere: notmuch@notmuchmail.org\r
  64 X-Mailman-Version: 2.1.13\r
  65 Precedence: list\r
  66 List-Id: "Use and development of the notmuch mail system."\r
  67         <notmuch.notmuchmail.org>\r
  68 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  69         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  70 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  71 List-Post: <mailto:notmuch@notmuchmail.org>\r
  72 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  73 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  74         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  75 X-List-Received-Date: Fri, 03 Oct 2014 14:19:38 -0000\r
  76 \r
  77 From: Austin Clements <amdragon@mit.edu>\r
  78 \r
  79 This describes the structure of ghost mail documents.  Ghost messages\r
  80 are not yet implemented.\r
  81 ---\r
  82  lib/database.cc | 20 ++++++++++++++++++--\r
  83  1 file changed, 18 insertions(+), 2 deletions(-)\r
  84 \r
  85 diff --git a/lib/database.cc b/lib/database.cc\r
  86 index 8fd7fad..c641bcd 100644\r
  87 --- a/lib/database.cc\r
  88 +++ b/lib/database.cc\r
  89 @@ -50,8 +50,8 @@ typedef struct {\r
  90  \r
  91  /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):\r
  92   *\r
  93 - * We currently have two different types of documents (mail and\r
  94 - * directory) and also some metadata.\r
  95 + * We currently have three different types of documents (mail, ghost,\r
  96 + * and directory) and also some metadata.\r
  97   *\r
  98   * Mail document\r
  99   * -------------\r
 100 @@ -109,6 +109,15 @@ typedef struct {\r
 101   *\r
 102   * The data portion of a mail document is empty.\r
 103   *\r
 104 + * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]\r
 105 + * -----------------------------------------------\r
 106 + * A ghost mail document is like a mail document, but where we don't\r
 107 + * have the message content.  These are used to track thread reference\r
 108 + * information for messages we haven't received.\r
 109 + *\r
 110 + * A ghost mail document has type: ghost; id and thread fields that\r
 111 + * are identical to the mail document fields; and a MESSAGE_ID value.\r
 112 + *\r
 113   * Directory document\r
 114   * ------------------\r
 115   * A directory document is used by a client of the notmuch library to\r
 116 @@ -172,6 +181,13 @@ typedef struct {\r
 117   *                     generated is 1 and the value will be\r
 118   *                     incremented for each thread ID.\r
 119   *\r
 120 + * Obsolete metadata\r
 121 + * -----------------\r
 122 + *\r
 123 + * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.\r
 124 + * Instead, the database has the following additional database\r
 125 + * metadata:\r
 126 + *\r
 127   *     thread_id_*     A pre-allocated thread ID for a particular\r
 128   *                     message. This is actually an arbitrarily large\r
 129   *                     family of metadata name. Any particular name is\r
 130 -- \r
 131 2.1.0\r
 132 \r