public-inbox-xcpdb(1)

1PUBLIC-INBOX-XCPDB(1)      public-inbox user manual      PUBLIC-INBOX-XCPDB(1)
2
3
4

NAME

6       public-inbox-xcpdb - upgrade Xapian DB formats
7

SYNOPSIS

9       public-inbox-xcpdb [OPTIONS] INBOX_DIR
10
11       public-inbox-xcpdb [OPTIONS] --all
12

DESCRIPTION

14       public-inbox-xcpdb is similar to copydatabase(1) for upgrading to the
15       latest database format supported by Xapian (e.g. "glass" or "honey"),
16       but is designed to tolerate and accept parallel Xapian database
17       modifications from public-inbox-watch(1), public-inbox-mda(1),
18       public-inbox-learn(1), and public-inbox-index(1).
19
20       This command is rarely used, as Xapian DB formats rarely change.
21

OPTIONS

23       --all
24           Copy all inboxes configured in ~/.public-inbox/config.  This is an
25           alternative to specifying individual inboxes directories on the
26           command-line.
27
28       -c
29       --compact
30           In addition to performing the copy operation, run xapian-compact(1)
31           on each Xapian shard after copying but before finalizing it.
32           Compared to the cost of copying a Xapian database, compacting a
33           Xapian database takes only around 5% of the time required to copy.
34
35           Compared to public-inbox-compact(1), use of this option is
36           preferable for gigantic inboxes where the coarse-grained lock
37           currently required for public-inbox-compact(1) can cause the
38           compaction to take hours at-a-time.
39
40       -R N
41       --reshard=N
42           Reshard the Xapian database on a v2 inbox to "N" shards .  Since
43           xapian-compact(1) is not suitable for merging, users can rely on
44           this switch to reshard the existing Xapian database(s) to any
45           positive value of "N".
46
47           This is useful in case the Xapian DB was created with too few or
48           too many shards given the capabilities of the current hardware.
49
50       --blocksize
51       --no-full
52       --fuller
53           These options are passed directly to xapian-compact(1) when used
54           with "--compact".
55
56       --no-fsync
57           Disable fsync(2) and fdatasync(2).  See "--no-fsync" in
58           public-inbox-index(1) for caveats.
59
60           Available in public-inbox 1.6.0+.
61
62       --sequential-shard
63           Copy each shard sequentially, ignoring "--jobs".  This also affects
64           indexing done at the end of a run.
65
66       --batch-size=BYTES
67       --max-size=BYTES
68           See public-inbox-index(1) for a description of these options.
69
70           These indexing options indexing at the end of a run.
71           "public-inbox-xcpdb" may run in parallel with with
72           public-inbox-index(1), and "public-inbox-xcpdb" needs to reindex
73           changes made to the old Xapian DBs by public-inbox-index(1) while
74           it was running.
75

ENVIRONMENT

77       PI_CONFIG
78               The default config file, normally "~/.public-inbox/config".
79               See public-inbox-config(5)
80
81       XAPIAN_FLUSH_THRESHOLD
82               The number of documents to update before committing changes to
83               disk.  This environment is handled directly by Xapian, refer to
84               Xapian API documentation for more details.
85
86               Default: 10000
87

UPGRADING

89       This tool is intended for admins upgrading Xapian search databases used
90       by public-inbox, NOT users upgrading public-inbox itself.
91
92       In particular, it DOES NOT upgrade the schema used by the PSGI search
93       interface (see public-inbox-index(1)).
94

LIMITATIONS

96       Do not use public-inbox-purge(1) or public-inbox-edit(1) while this is
97       running; old (purged or edited data) may show up.
98
99       Normal invocations public-inbox-index(1) can safely run while this is
100       running, too.  However, reindexing via the "--reindex" in
101       public-inbox-index(1) switch will be a waste of computing resources.
102

CONTACT

104       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
105
106       The mail archives are hosted at <https://public-inbox.org/meta/> and
107       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
108

COPYRIGHT

110       Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org>
111
112       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
113