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 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 This is intended for upgrading the database format used by
  18 Xapian.  It DOES NOT upgrade the schema used by the
  19 public-inbox PSGI search interface (see
  20 L<public-inbox-index(1)>).
  21
  22 =head1 ENVIRONMENT
  23
  24 =over 8
  25
  26 =item PI_CONFIG
  27
  28 The default config file, normally "~/.public-inbox/config".
  29 See L<public-inbox-config(5)>
  30
  31 =item XAPIAN_FLUSH_THRESHOLD
  32
  33 The number of documents to update before committing changes to
  34 disk.  This environment is handled directly by Xapian, refer to
  35 Xapian API documentation for more details.
  36
  37 Default: 10000
  38
  39 =back
  40
  41 =head1 UPGRADING
  42
  43 =head1 CONTACT
  44
  45 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  46
  47 The mail archives are hosted at L<https://public-inbox.org/meta/>
  48 and L<http://hjrcffqmbrq6wope.onion/meta/>
  49
  50 =head1 COPYRIGHT
  51
  52 Copyright 2019 all contributors L<mailto:meta@public-inbox.org>
  53
  54 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  55
  56 =head1 SEE ALSO
  57
  58 L<copydatabase(1)>, L<public-inbox-index(1)>