database: Add "replyto" to the database schema documentation.
[notmuch] / lib / database.cc
index eaf526677f789a6939ae86adc3b530327289dcf0..5b677d42007fcae27e2632701d2c4073a664e44b 100644 (file)
@@ -42,7 +42,8 @@ typedef struct {
  * Mail document
  * -------------
  * A mail document is associated with a particular email message file
  * Mail document
  * -------------
  * A mail document is associated with a particular email message file
- * on disk. It is indexed with the following prefixed terms:
+ * on disk. It is indexed with the following prefixed terms which the
+ * database uses to construct threads, etc.:
  *
  *    Single terms of given prefix:
  *
  *
  *    Single terms of given prefix:
  *
@@ -53,6 +54,8 @@ typedef struct {
  *
  *     thread: The ID of the thread to which the mail belongs
  *
  *
  *     thread: The ID of the thread to which the mail belongs
  *
+ *     replyto: The ID from the In-Reply-To header of the mail (if any).
+ *
  *    Multiple terms of given prefix:
  *
  *     reference: All message IDs from In-Reply-To and Re ferences
  *    Multiple terms of given prefix:
  *
  *     reference: All message IDs from In-Reply-To and Re ferences
@@ -67,6 +70,11 @@ typedef struct {
  *
  *     MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
  *
  *
  *     MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
  *
+ * In addition, terms from the content of the message are added with
+ * "from", "to", "attachment", and "subject" prefixes for use by the
+ * user in searching. But the database doesn't really care itself
+ * about any of these.
+ *
  * Timestamp document
  * ------------------
  * A timestamp document is used by a client of the notmuch library to
  * Timestamp document
  * ------------------
  * A timestamp document is used by a client of the notmuch library to