user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 10/11] overidx: document column uses
Date: Wed,  2 Sep 2020 11:04:20 +0000
Message-ID: <20200902110421.30905-11-e@80x24.org> (raw)
In-Reply-To: <20200902110421.30905-1-e@80x24.org>

This may be useful for keeping our heads on straight dealing
with IMAP, NNTP, JMAP, etc.
---
 lib/PublicInbox/OverIdx.pm | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/lib/PublicInbox/OverIdx.pm b/lib/PublicInbox/OverIdx.pm
index 6f0477f0..db4b7738 100644
--- a/lib/PublicInbox/OverIdx.pm
+++ b/lib/PublicInbox/OverIdx.pm
@@ -379,12 +379,12 @@ sub create_tables {
 
 	$dbh->do(<<'');
 CREATE TABLE IF NOT EXISTS over (
-	num INTEGER NOT NULL,
-	tid INTEGER NOT NULL,
-	sid INTEGER,
-	ts INTEGER,
-	ds INTEGER,
-	ddd VARBINARY, /* doc-data-deflated */
+	num INTEGER NOT NULL, /* NNTP article number == IMAP UID */
+	tid INTEGER NOT NULL, /* THREADID (IMAP REFERENCES threading, JMAP) */
+	sid INTEGER, /* Subject ID (IMAP ORDEREDSUBJECT "threading") */
+	ts INTEGER, /* IMAP INTERNALDATE (Received: header, git commit time) */
+	ds INTEGER, /* RFC-2822 sent Date: header, git author time */
+	ddd VARBINARY, /* doc-data-deflated (->to_doc_data, ->load_from_data) */
 	UNIQUE (num)
 )
 
@@ -406,13 +406,13 @@ CREATE TABLE IF NOT EXISTS counter (
 	$dbh->do(<<'');
 CREATE TABLE IF NOT EXISTS subject (
 	sid INTEGER PRIMARY KEY AUTOINCREMENT,
-	path VARCHAR(40) NOT NULL,
+	path VARCHAR(40) NOT NULL, /* SHA-1 of normalized subject */
 	UNIQUE (path)
 )
 
 	$dbh->do(<<'');
 CREATE TABLE IF NOT EXISTS id2num (
-	id INTEGER NOT NULL,
+	id INTEGER NOT NULL, /* <=> msgid.id */
 	num INTEGER NOT NULL,
 	UNIQUE (id, num)
 )
@@ -423,7 +423,7 @@ CREATE TABLE IF NOT EXISTS id2num (
 
 	$dbh->do(<<'');
 CREATE TABLE IF NOT EXISTS msgid (
-	id INTEGER PRIMARY KEY AUTOINCREMENT,
+	id INTEGER PRIMARY KEY AUTOINCREMENT, /* <=> id2num.id */
 	mid VARCHAR(244) NOT NULL,
 	UNIQUE (mid)
 )

  parent reply	other threads:[~2020-09-02 11:04 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-02 11:04 [PATCH 00/11] cleanups, mostly indexing related Eric Wong
2020-09-02 11:04 ` [PATCH 01/11] msgmap: note how we use ->created_at Eric Wong
2020-09-02 11:04 ` [PATCH 02/11] disambiguate OverIdx and Over by field name Eric Wong
2020-09-02 11:04 ` [PATCH 03/11] use more idiomatic internal API for ->over access Eric Wong
2020-09-02 11:04 ` [PATCH 04/11] search: remove special case for blank query Eric Wong
2020-09-02 11:04 ` [PATCH 05/11] tests: add "use strict" and declare v5.10.1 compatibility Eric Wong
2020-09-02 11:04 ` [PATCH 06/11] search: replace ->query with ->mset Eric Wong
2020-09-02 11:04 ` [PATCH 07/11] search: remove {over_ro} field Eric Wong
2020-09-02 11:04 ` [PATCH 08/11] imap: drop old, pre-Parse::RecDescent search parser Eric Wong
2020-09-02 11:04 ` [PATCH 09/11] wwwaltid: drop unused sqlite3_missing function Eric Wong
2020-09-02 11:04 ` Eric Wong [this message]
2020-09-02 11:04 ` [PATCH 11/11] v2writable: reuse read-only shard counting code Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200902110421.30905-11-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for the project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git