Documentation/public-inbox-index.pod

   1 =head1 NAME
   2
   3 public-inbox-index - create and update search indices
   4
   5 =head1 SYNOPSIS
   6
   7 public-inbox-index [OPTIONS] INBOX_DIR...
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-index creates and updates the search, overview and
  12 NNTP article number database used by the read-only public-inbox
  13 HTTP and NNTP interfaces.  Currently, this requires
  14 L<DBD::SQLite> and L<DBI> Perl modules.  L<Search::Xapian>
  15 is optional, only to support the PSGI search interface.
  16
  17 Once the initial indices are created by public-inbox-index,
  18 L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will
  19 automatically maintain them.
  20
  21 Running this manually to update indices is only required if
  22 relying on L<git-fetch(1)> to mirror an existing public-inbox;
  23 or if upgrading to a new version of public-inbox using
  24 the C<--reindex> option.
  25
  26 Having the overview and article number database is essential to
  27 running the NNTP interface, and strongly recommended for the
  28 HTTP interface as it provides thread grouping in addition to
  29 normal search functionality.
  30
  31 =head1 OPTIONS
  32
  33 =over
  34
  35 =item --jobs=JOBS, -j
  36
  37 Influences the number of Xapian indexing shards in a
  38 (L<public-inbox-v2-format(5)>) inbox.
  39
  40 C<--jobs=0> is accepted as of public-inbox 1.6.0 (PENDING)
  41 to disable parallel indexing.
  42
  43 If the inbox has not been indexed or initialized, C<JOBS - 1>
  44 shards will be created (one job is always needed for indexing
  45 the overview and article number mapping).
  46
  47 Default: the number of existing Xapian shards
  48
  49 =item --compact / -c
  50
  51 Compacts the Xapian DBs after indexing.  This is recommended
  52 when using C<--reindex> to avoid running out of disk space
  53 while indexing multiple inboxes.
  54
  55 While option takes a negligible amount of time compared to
  56 C<--reindex>, it requires temporarily duplicating the entire
  57 contents of the Xapian DB.
  58
  59 This switch may be specified twice, in which case compaction
  60 happens both before and after indexing to minimize the temporal
  61 footprint of the (re)indexing operation.
  62
  63 Available since public-inbox 1.4.0.
  64
  65 =item --reindex
  66
  67 Forces a re-index of all messages in the inbox.
  68 This can be used for in-place upgrades and bugfixes while
  69 NNTP/HTTP server processes are utilizing the index.  Keep in
  70 mind this roughly doubles the size of the already-large
  71 Xapian database.  Using this with C<--compact> or running
  72 L<public-inbox-compact(1)> afterwards is recommended to
  73 release free space.
  74
  75 public-inbox protects writes to various indices with
  76 L<flock(2)>, so it is safe to reindex (and rethread) while
  77 L<public-inbox-watch(1)>, L<public-inbox-mda(1)> or
  78 L<public-inbox-learn(1)> run.
  79
  80 This does not touch the NNTP article number database.
  81 It does not affect threading unless C<--rethread> is
  82 used.
  83
  84 =item --rethread
  85
  86 Regenerate internal THREADID and message thread associations
  87 when reindexing.
  88
  89 This fixes some bugs in older versions of public-inbox.  While
  90 it is possible to use this without C<--reindex>, it makes little
  91 sense to do so.
  92
  93 Available in public-inbox 1.6.0 (PENDING).
  94
  95 =item --prune
  96
  97 Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
  98 is detected.  This is intended to be used in mirrors after running
  99 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
 100 is expunged from mirrors.
 101
 102 Available since public-inbox 1.2.0.
 103
 104 =item --max-size SIZE
 105
 106 Sets or overrides L</publicinbox.indexMaxSize> on a
 107 per-invocation basis.  See L</publicinbox.indexMaxSize>
 108 below.
 109
 110 Available since public-inbox 1.5.0.
 111
 112 =item --batch-size SIZE
 113
 114 Sets or overrides L</publicinbox.indexBatchSize> on a
 115 per-invocation basis.  See L</publicinbox.indexBatchSize>
 116 below.
 117
 118 When using rotational storage but abundant RAM, using a large
 119 value (e.g. C<500m>) with C<--sequential-shard> can
 120 significantly speed up the initial index and full C<--reindex>
 121 invocations (but not incremental updates).
 122
 123 Available in public-inbox 1.6.0 (PENDING).
 124
 125 =item --no-fsync
 126
 127 Disables L<fsync(2)> and L<fdatasync(2)> operations on SQLite
 128 and Xapian.  This is only effective with Xapian 1.4+.
 129
 130 Available in public-inbox 1.6.0 (PENDING).
 131
 132 =item --sequential-shard
 133
 134 Sets or overrides L</publicinbox.indexSequentialShard> on a
 135 per-invocation basis.  See L</publicinbox.indexSequentialShard>
 136 below.
 137
 138 Available in public-inbox 1.6.0 (PENDING).
 139
 140 =back
 141
 142 =head1 FILES
 143
 144 For v1 (ssoma) repositories described in L<public-inbox-v1-format(5)>.
 145 All public-inbox-specific files are contained within the
 146 C<$GIT_DIR/public-inbox/> directory.
 147
 148 v2 inboxes are described in L<public-inbox-v2-format(5)>.
 149
 150 =head1 CONFIGURATION
 151
 152 =over 8
 153
 154 =item publicinbox.indexMaxSize
 155
 156 Prevents indexing of messages larger than the specified size
 157 value.  A single suffix modifier of C<k>, C<m> or C<g> is
 158 supported, thus the value of C<1m> to prevents indexing of
 159 messages larger than one megabyte.
 160
 161 This is useful for avoiding memory exhaustion in mirrors.
 162 This option is only available in public-inbox 1.5 or later.
 163
 164 Default: none
 165
 166 =item publicinbox.indexBatchSize
 167
 168 Flushes changes to the filesystem and releases locks after
 169 indexing the given number of bytes.  The default value of C<1m>
 170 (one megabyte) is low to minimize memory use and reduce
 171 contention with parallel invocations of L<public-inbox-mda(1)>,
 172 L<public-inbox-learn(1)>, and L<public-inbox-watch(1)>.
 173
 174 Increase this value on powerful systems to improve throughput at
 175 the expense of memory use.  The reduction of lock granularity
 176 may not be noticeable on fast systems.  With SSDs, values above
 177 C<4m> have little benefit.
 178
 179 For L<public-inbox-v2-format(5)> inboxes, this value is
 180 multiplied by the number of Xapian shards.  Thus a typical v2
 181 inbox with 3 shards will flush every 3 megabytes by default
 182 unless parallelism is disabled via C<--sequential-shard>
 183 or C<--jobs=0>.
 184
 185 This influences memory usage of Xapian, but it is not exact.
 186 The actual memory used by Xapian and Perl has been observed
 187 in excess of 10x this value.
 188
 189 This option is available in public-inbox 1.6 or later.
 190 public-inbox 1.5 and earlier used the current default, C<1m>.
 191
 192 Default: 1m (one megabyte)
 193
 194 =item publicinbox.indexSequentialShard
 195
 196 For L<public-inbox-v2-format(5)> inboxes, setting this to C<true>
 197 allows indexing Xapian shards in multiple passes.  This speeds up
 198 indexing on rotational storage with high seek latency by allowing
 199 individual shards to fit into the kernel page cache.
 200
 201 Using a higher-than-normal number of C<--jobs> with
 202 L<public-inbox-init(1)> may be required to ensure individual
 203 shards are small enough to fit into cache.
 204
 205 Warning: interrupting C<public-inbox-index(1)> while this option
 206 is in use may leave the search indices out-of-date with respect
 207 to SQLite databases.  WWW and IMAP users may notice incomplete
 208 search results, but it is otherwise non-fatal.  Using C<--reindex>
 209 will bring everything back up-to-date.
 210
 211 Available in public-inbox 1.6.0 (PENDING).
 212
 213 This is ignored on L<public-inbox-v1-format(5)> inboxes.
 214
 215 Default: false, shards are indexed in parallel
 216
 217 =item publicinbox.<name>.indexSequentialShard
 218
 219 Identical to L</publicinbox.indexSequentialShard>,
 220 but only affect the inbox matching E<lt>nameE<gt>.
 221
 222 =back
 223
 224 =head1 ENVIRONMENT
 225
 226 =over 8
 227
 228 =item PI_CONFIG
 229
 230 Used to override the default "~/.public-inbox/config" value.
 231
 232 =item XAPIAN_FLUSH_THRESHOLD
 233
 234 The number of documents to update before committing changes to
 235 disk.  This environment is handled directly by Xapian, refer to
 236 Xapian API documentation for more details.
 237
 238 For public-inbox 1.6 and later, use C<publicinbox.indexBatchSize>
 239 instead.
 240
 241 Setting C<XAPIAN_FLUSH_THRESHOLD> or
 242 C<publicinbox.indexBatchSize> for a large C<--reindex> may cause
 243 L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
 244 L<public-inbox-watch(1)> tasks to wait long and unpredictable
 245 periods of time during C<--reindex>.
 246
 247 Default: none, uses C<publicinbox.indexBatchSize>
 248
 249 =back
 250
 251 =head1 UPGRADING
 252
 253 Occasionally, public-inbox will update it's schema version and
 254 require a full index by running this command.
 255
 256 =head1 CONTACT
 257
 258 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 259
 260 The mail archives are hosted at L<https://public-inbox.org/meta/>
 261 and L<http://hjrcffqmbrq6wope.onion/meta/>
 262
 263 =head1 COPYRIGHT
 264
 265 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 266
 267 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 268
 269 =head1 SEE ALSO
 270
 271 L<Search::Xapian>, L<DBD::SQLite>