user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
From: Eric Wong <e@yhbt.net>
To: meta@public-inbox.org
Subject: [PATCH 10/23] search: improve comments around constants
Date: Thu, 20 Aug 2020 20:24:44 +0000
Message-ID: <20200820202457.21042-11-e@yhbt.net> (raw)
In-Reply-To: <20200820202457.21042-1-e@yhbt.net>

We'll probably be adding more value columns like THREADID to sort
on.
---
 lib/PublicInbox/Search.pm | 63 +++++++++++++++++++++------------------
 1 file changed, 34 insertions(+), 29 deletions(-)

diff --git a/lib/PublicInbox/Search.pm b/lib/PublicInbox/Search.pm
index 4d02a7c1..593040a8 100644
--- a/lib/PublicInbox/Search.pm
+++ b/lib/PublicInbox/Search.pm
@@ -6,15 +6,47 @@
 package PublicInbox::Search;
 use strict;
 
-# values for searching
+# values for searching, changing the numeric value breaks
+# compatibility with old indices (so don't change them it)
 use constant {
 	TS => 0, # Received: header in Unix time (IMAP INTERNALDATE)
 	YYYYMMDD => 1, # Date: header for searching in the WWW UI
 	DT => 2, # Date: YYYYMMDDHHMMSS
+
+	# added for public-inbox 1.6.0+
 	BYTES => 3, # IMAP RFC822.SIZE
 	UID => 4, # IMAP UID == NNTP article number == Xapian docid
+
 	# TODO
-	# REPLYCNT => 4, # IMAP ANSWERED
+	# THREADID => ?
+	# REPLYCNT => ?, # IMAP ANSWERED
+
+	# SCHEMA_VERSION history
+	# 0 - initial
+	# 1 - subject_path is lower-cased
+	# 2 - subject_path is id_compress in the index, only
+	# 3 - message-ID is compressed if it includes '%' (hack!)
+	# 4 - change "Re: " normalization, avoid circular Reference ghosts
+	# 5 - subject_path drops trailing '.'
+	# 6 - preserve References: order in document data
+	# 7 - remove references and inreplyto terms
+	# 8 - remove redundant/unneeded document data
+	# 9 - disable Message-ID compression (SHA-1)
+	# 10 - optimize doc for NNTP overviews
+	# 11 - merge threads when vivifying ghosts
+	# 12 - change YYYYMMDD value column to numeric
+	# 13 - fix threading for empty References/In-Reply-To
+	#      (commit 83425ef12e4b65cdcecd11ddcb38175d4a91d5a0)
+	# 14 - fix ghost root vivification
+	# 15 - see public-inbox-v2-format(5)
+	#      further bumps likely unnecessary, we'll suggest in-place
+	#      "--reindex" use for further fixes and tweaks:
+	#
+	#      public-inbox v1.5.0 adds (still SCHEMA_VERSION=15):
+	#      * "lid:" and "l:" for List-Id searches
+	#
+	#      v1.6.0 adds BYTES and UID values
+	SCHEMA_VERSION => 15,
 };
 
 use PublicInbox::Smsg;
@@ -61,33 +93,6 @@ sub load_xapian () {
 # a prefix common in patch emails
 our $LANG = 'english';
 
-use constant {
-	# SCHEMA_VERSION history
-	# 0 - initial
-	# 1 - subject_path is lower-cased
-	# 2 - subject_path is id_compress in the index, only
-	# 3 - message-ID is compressed if it includes '%' (hack!)
-	# 4 - change "Re: " normalization, avoid circular Reference ghosts
-	# 5 - subject_path drops trailing '.'
-	# 6 - preserve References: order in document data
-	# 7 - remove references and inreplyto terms
-	# 8 - remove redundant/unneeded document data
-	# 9 - disable Message-ID compression (SHA-1)
-	# 10 - optimize doc for NNTP overviews
-	# 11 - merge threads when vivifying ghosts
-	# 12 - change YYYYMMDD value column to numeric
-	# 13 - fix threading for empty References/In-Reply-To
-	#      (commit 83425ef12e4b65cdcecd11ddcb38175d4a91d5a0)
-	# 14 - fix ghost root vivification
-	# 15 - see public-inbox-v2-format(5)
-	#      further bumps likely unnecessary, we'll suggest in-place
-	#      "--reindex" use for further fixes and tweaks
-	#
-	#      public-inbox v1.5.0 adds (still SCHEMA_VERSION=15):
-	#      * "lid:" and "l:" for List-Id searches
-	SCHEMA_VERSION => 15,
-};
-
 # note: the non-X term prefix allocations are shared with
 # Xapian omega, see xapian-applications/omega/docs/termprefixes.rst
 my %bool_pfx_external = (

  parent reply	other threads:[~2020-08-20 20:24 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-20 20:24 [PATCH 00/23] indexing: --skip-docdata + speedups Eric Wong
2020-08-20 20:24 ` [PATCH 01/23] doc: note -compact and -xcpdb are rarely used Eric Wong
2020-08-20 20:24 ` [PATCH 02/23] admin: progress shows the inbox being indexed Eric Wong
2020-08-20 20:24 ` [PATCH 03/23] compact: support --help/-? and perform lazy loading Eric Wong
2020-08-20 20:24 ` [PATCH 04/23] init: support --help and -? Eric Wong
2020-08-20 20:24 ` [PATCH 05/23] init: support --newsgroup option Eric Wong
2020-08-20 21:10   ` Eric Wong
2020-08-20 20:24 ` [PATCH 06/23] init: drop -N alias for --skip-artnum Eric Wong
2020-08-20 20:24 ` [PATCH 07/23] search: v2: ensure shards are numerically sorted Eric Wong
2020-08-20 20:24 ` [PATCH 08/23] xapcmd: simplify {reindex} parameter passing Eric Wong
2020-08-20 20:24 ` [PATCH 09/23] www: reduce long-lived PublicInbox::Search references Eric Wong
2020-08-20 20:24 ` Eric Wong [this message]
2020-08-20 20:24 ` [PATCH 11/23] search: export mdocid subroutine Eric Wong
2020-08-20 20:24 ` [PATCH 12/23] searchquery: split off from searchview Eric Wong
2020-08-20 20:24 ` [PATCH 13/23] search: make qparse_new an internal function Eric Wong
2020-08-20 20:24 ` [PATCH 14/23] smsg: reduce utf8::decode call sites Eric Wong
2020-08-20 20:24 ` [PATCH 15/23] searchview: use over.sqlite3 instead of Xapian docdata Eric Wong
2020-08-20 20:24 ` [PATCH 16/23] searchview: speed up search summary by ~10% Eric Wong
2020-08-20 20:24 ` [PATCH 17/23] searchview: convert nested and Atom display to over.sqlite3 Eric Wong
2020-08-20 20:24 ` [PATCH 18/23] extmsg: avoid using Xapian docdata Eric Wong
2020-08-20 20:24 ` [PATCH 19/23] mbox: avoid Xapian docdata in search results Eric Wong
2020-08-20 20:24 ` [PATCH 20/23] smsg: remove from_mitem Eric Wong
2020-08-20 20:24 ` [PATCH 21/23] t/nntpd-v2: set PI_TEST_VERSION=2 properly Eric Wong
2020-08-20 20:24 ` [PATCH 22/23] init+index: support --skip-docdata for Xapian Eric Wong
2020-08-20 20:24 ` [PATCH 23/23] search: add mset_to_artnums method 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=20200820202457.21042-11-e@yhbt.net \
    --to=e@yhbt.net \
    --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