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)>.
26 Copy all inboxes configured in ~/.public-inbox/config.
27 This is an alternative to specifying individual inboxes directories
32 In addition to performing the copy operation, run L<xapian-compact(1)>
33 on each Xapian shard after copying but before finalizing it.
34 Compared to the cost of copying a Xapian database, compacting a
35 Xapian database takes only around 5% of the time required to copy.
37 Compared to L<public-inbox-compact(1)>, use of this option is
38 preferable for gigantic inboxes where the coarse-grained lock
39 currently required for L<public-inbox-compact(1)> can cause
40 the compaction to take hours at-a-time.
42 =item --reshard=N / -R N
44 Reshard the Xapian database on a L<v2|public-inbox-v2-format(5)>
45 inbox to C<N> shards . Since L<xapian-compact(1)> is not suitable
46 for merging, users can rely on this switch to reshard the
47 existing Xapian database(s) to any positive value of C<N>.
49 This is useful in case the Xapian DB was created with too few or
50 too many shards given the capabilities of the current hardware.
52 =item --blocksize / --no-full / --fuller
54 These options are passed directly to L<xapian-compact(1)> when
55 used with C<--compact>.
59 Disable L<fsync(2)> and L<fdatasync(2)>.
61 Available in public-inbox 1.6.0 (PENDING).
63 =item --sequential-shard
65 Copy each shard sequentially, ignoring C<--jobs>. This also
66 affects indexing done at the end of a run.
68 =item --batch-size=BYTES
70 =item --max-size=BYTES
72 See L<public-inbox-index(1)> for a description of these options.
74 These indexing options indexing at the end of a run.
75 C<public-inbox-xcpdb> may run in parallel with with
76 L<public-inbox-index(1)>, and C<public-inbox-xcpdb> needs to
77 reindex changes made to the old Xapian DBs by
78 L<public-inbox-index(1)> while it was running.
88 The default config file, normally "~/.public-inbox/config".
89 See L<public-inbox-config(5)>
91 =item XAPIAN_FLUSH_THRESHOLD
93 The number of documents to update before committing changes to
94 disk. This environment is handled directly by Xapian, refer to
95 Xapian API documentation for more details.
103 This tool is intended for admins upgrading Xapian search databases
104 used by public-inbox, NOT users upgrading public-inbox itself.
106 In particular, it DOES NOT upgrade the schema used by the
107 PSGI search interface (see L<public-inbox-index(1)>).
111 Do not use L<public-inbox-purge(1)> or L<public-inbox-edit(1)>
112 while this is running; old (purged or edited data) may show up.
114 Normal invocations L<public-inbox-index(1)> can safely run
115 while this is running, too. However, reindexing via the
116 L<public-inbox-index(1)/--reindex> switch will be a waste of
121 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
123 The mail archives are hosted at L<https://public-inbox.org/meta/>
124 and L<http://hjrcffqmbrq6wope.onion/meta/>
128 Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>
130 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
134 L<copydatabase(1)>, L<xapian-compact(1)>, L<public-inbox-index(1)>