diff options
| author | Eric Wong <e@80x24.org> | 2019-05-23 09:36:46 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2019-05-23 17:43:50 +0000 |
| commit | ac5a695030be64059fcb1ae826a0f3bfd2ca035b (patch) | |
| tree | 316fd6d6a1ece471b8e0a6996c8e1a9c6f73d162 /Documentation | |
| parent | f0cc8e6795077bc7a04e579655a1c5e90c80a4e8 (diff) | |
| download | public-inbox-ac5a695030be64059fcb1ae826a0f3bfd2ca035b.tar.gz | |
copydatabase(1) is an existing Xapian tool which is the recommended way to upgrade existing DBs to the latest Xapian database format (currently "glass" for stable/released versions). Our use of Xapian relies on preserving document IDs, so we'll wrap it like we do xapian-compact(1) and use the "--no-renumber" switch. I could not name the tool "public-inbox-copydatabase" since it would be ambiguous as to which DB it's actually copying. So, I abbreviated the suffix to "xcpdb" (Xapian CoPy DataBase), which I hope is acceptable and unambiguous.
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/include.mk | 6 | ||||
| -rw-r--r-- | Documentation/public-inbox-xcpdb.pod | 51 |
2 files changed, 55 insertions, 2 deletions
diff --git a/Documentation/include.mk b/Documentation/include.mk index 6415338b..27d6ea6e 100644 --- a/Documentation/include.mk +++ b/Documentation/include.mk @@ -26,11 +26,13 @@ podtext = $(PODTEXT) $(PODTEXT_OPTS) # MakeMaker only seems to support manpage sections 1 and 3... m1 = -m1 += public-inbox-mda +m1 += public-inbox-compact m1 += public-inbox-httpd +m1 += public-inbox-index +m1 += public-inbox-mda m1 += public-inbox-nntpd m1 += public-inbox-watch -m1 += public-inbox-index +m1 += public-inbox-xcpdb m5 = m5 += public-inbox-config m5 += public-inbox-v1-format diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod new file mode 100644 index 00000000..4ff51867 --- /dev/null +++ b/Documentation/public-inbox-xcpdb.pod @@ -0,0 +1,51 @@ +=head1 NAME + +public-inbox-xcpdb - copy Xapian DBs (for format upgrades) + +=head1 SYNOPSIS + + public-inbox-xcpdb INBOX_DIR + +=head1 DESCRIPTION + +public-inbox-xcpdb is a wrapper for L<copydatabase(1)> for +upgrading to the latest database format supported by Xapian +(e.g. "glass" or "honey"). + +It locks the inbox and prevents other processes such as +L<public-inbox-watch(1)> and L<public-inbox-mda(1)> from +writing while it operates. + +This is intended for upgrading the database format used by +Xapian. It DOES NOT upgrade the schema used by the +public-inbox search interface (see L<public-inbox-index(1)>). + +=head1 ENVIRONMENT + +=over 8 + +=item PI_CONFIG + +The default config file, normally "~/.public-inbox/config". +See L<public-inbox-config(5)> + +=back + +=head1 UPGRADING + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2019 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<copydatabase(1)>, L<public-inbox-index(1)> |