Documentation/public-inbox-xcpdb.pod

   1 =head1 NAME
   2
   3 public-inbox-xcpdb - upgrade Xapian DB formats
   4
   5 =head1 SYNOPSIS
   6
   7         public-inbox-xcpdb [OPTIONS] INBOX_DIR
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-xcpdb is similar to L<copydatabase(1)> for
  12 upgrading to the latest database format supported by Xapian
  13 (e.g. "glass" or "honey"), but is designed to tolerate and
  14 recover from Xapian database modifications from
  15 L<public-inbox-watch(1)> or L<public-inbox-mda(1)>.
  16
  17 =head1 OPTIONS
  18
  19 =over
  20
  21 =item --compact
  22
  23 In addition to performing the copy operation, run L<xapian-compact(1)>
  24 on each Xapian partition after copying but before finalizing it.
  25 Compared to the cost of copying a Xapian database, compacting a
  26 Xapian database takes only around 5% of the time required to copy.
  27
  28 Compared to L<public-inbox-compact(1)>, use of this option is
  29 preferable for gigantic inboxes where the coarse-grained lock
  30 currently required for L<public-inbox-compact(1)> can cause
  31 the compaction to take hours at-a-time.
  32
  33 =item --blocksize / --no-full / --fuller
  34
  35 These options are passed directly to L<xapian-compact(1)> when
  36 used with C<--compact>.
  37
  38 =back
  39
  40 =head1 ENVIRONMENT
  41
  42 =over 8
  43
  44 =item PI_CONFIG
  45
  46 The default config file, normally "~/.public-inbox/config".
  47 See L<public-inbox-config(5)>
  48
  49 =item XAPIAN_FLUSH_THRESHOLD
  50
  51 The number of documents to update before committing changes to
  52 disk.  This environment is handled directly by Xapian, refer to
  53 Xapian API documentation for more details.
  54
  55 Default: 10000
  56
  57 =back
  58
  59 =head1 UPGRADING
  60
  61 This tool is intended for admins upgrading Xapian search databases
  62 used by public-inbox, NOT users upgrading public-inbox itself.
  63
  64 In particular, it DOES NOT upgrade the schema used by the
  65 PSGI search interface (see L<public-inbox-index(1)>).
  66
  67 =head1 CONTACT
  68
  69 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  70
  71 The mail archives are hosted at L<https://public-inbox.org/meta/>
  72 and L<http://hjrcffqmbrq6wope.onion/meta/>
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
  77
  78 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  79
  80 =head1 SEE ALSO
  81
  82 L<copydatabase(1)|https://public-inbox.org/.copydatabase.1.html>,
  83 L<xapian-compact(1)|https://public-inbox.org/.xapian-compact.1.html>,
  84 L<public-inbox-index(1)|https://public-inbox.org/public-inbox-index.html>