3 public-inbox-xcpdb - upgrade Xapian DB formats
7 public-inbox-xcpdb [OPTIONS] INBOX_DIR
9 public-inbox-xcpdb [OPTIONS] --all
13 public-inbox-xcpdb is similar to L<copydatabase(1)> for
14 upgrading to the latest database format supported by Xapian
15 (e.g. "glass" or "honey"), but is designed to tolerate and
16 accept parallel Xapian database modifications from
17 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>,
18 L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
20 This command is rarely used, as Xapian DB formats rarely
29 Copy all inboxes configured in ~/.public-inbox/config.
30 This is an alternative to specifying individual inboxes directories
35 In addition to performing the copy operation, run L<xapian-compact(1)>
36 on each Xapian shard after copying but before finalizing it.
37 Compared to the cost of copying a Xapian database, compacting a
38 Xapian database takes only around 5% of the time required to copy.
40 Compared to L<public-inbox-compact(1)>, use of this option is
41 preferable for gigantic inboxes where the coarse-grained lock
42 currently required for L<public-inbox-compact(1)> can cause
43 the compaction to take hours at-a-time.
45 =item --reshard=N / -R N
47 Reshard the Xapian database on a L<v2|public-inbox-v2-format(5)>
48 inbox to C<N> shards . Since L<xapian-compact(1)> is not suitable
49 for merging, users can rely on this switch to reshard the
50 existing Xapian database(s) to any positive value of C<N>.
52 This is useful in case the Xapian DB was created with too few or
53 too many shards given the capabilities of the current hardware.
55 =item --blocksize / --no-full / --fuller
57 These options are passed directly to L<xapian-compact(1)> when
58 used with C<--compact>.
62 Disable L<fsync(2)> and L<fdatasync(2)>.
64 Available in public-inbox 1.6.0 (PENDING).
66 =item --sequential-shard
68 Copy each shard sequentially, ignoring C<--jobs>. This also
69 affects indexing done at the end of a run.
71 =item --batch-size=BYTES
73 =item --max-size=BYTES
75 See L<public-inbox-index(1)> for a description of these options.
77 These indexing options indexing at the end of a run.
78 C<public-inbox-xcpdb> may run in parallel with with
79 L<public-inbox-index(1)>, and C<public-inbox-xcpdb> needs to
80 reindex changes made to the old Xapian DBs by
81 L<public-inbox-index(1)> while it was running.
91 The default config file, normally "~/.public-inbox/config".
92 See L<public-inbox-config(5)>
94 =item XAPIAN_FLUSH_THRESHOLD
96 The number of documents to update before committing changes to
97 disk. This environment is handled directly by Xapian, refer to
98 Xapian API documentation for more details.
106 This tool is intended for admins upgrading Xapian search databases
107 used by public-inbox, NOT users upgrading public-inbox itself.
109 In particular, it DOES NOT upgrade the schema used by the
110 PSGI search interface (see L<public-inbox-index(1)>).
114 Do not use L<public-inbox-purge(1)> or L<public-inbox-edit(1)>
115 while this is running; old (purged or edited data) may show up.
117 Normal invocations L<public-inbox-index(1)> can safely run
118 while this is running, too. However, reindexing via the
119 L<public-inbox-index(1)/--reindex> switch will be a waste of
124 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
126 The mail archives are hosted at L<https://public-inbox.org/meta/>
127 and L<http://hjrcffqmbrq6wope.onion/meta/>
131 Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>
133 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
137 L<copydatabase(1)>, L<xapian-compact(1)>, L<public-inbox-index(1)>