2 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
3 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # Basic tool to create a Xapian search index for a public-inbox.
7 use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
8 my $help = <<EOF; # the following should fit w/o scrolling in 80x24 term:
9 usage: public-inbox-extindex [options] EXTINDEX_DIR [INBOX_DIR]
11 Create and update external (detached) search indices
13 --no-fsync speed up indexing, risk corruption on power outage
14 -L LEVEL `medium', or `full' (default: full)
15 --all index all configured inboxes
16 --jobs=NUM set or disable parallelization (NUM=0)
17 --batch-size=BYTES flush changes to OS after a given number of bytes
18 --max-size=BYTES do not index messages larger than the given size
19 --gc perform garbage collection instead of indexing
20 --verbose | -v increase verbosity (may be repeated)
22 BYTES may use `k', `m', and `g' suffixes (e.g. `10m' for 10 megabytes)
23 See public-inbox-extindex(1) man page for full documentation.
25 my $opt = { quiet => -1, compact => 0, max_size => undef, fsync => 1 };
26 GetOptions($opt, qw(verbose|v+ reindex rethread compact|c+ jobs|j=i
28 indexlevel|index-level|L=s max_size|max-size=s
29 batch_size|batch-size=s
33 if ($opt->{help}) { print $help; exit 0 };
34 die "--jobs must be >= 0\n" if defined $opt->{jobs} && $opt->{jobs} < 0;
36 # require lazily to speed up --help
37 my $eidx_dir = shift(@ARGV) // die "E: $help";
38 local $SIG{USR1} = 'IGNORE'; # to be overridden in eidx_sync
39 require PublicInbox::Admin;
40 my $cfg = PublicInbox::Config->new;
43 die "E: inbox paths must not be specified with --gc\n" if @ARGV;
44 die "E: --all not compatible --gc\n" if $opt->{all};
46 @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, $opt, $cfg);
48 PublicInbox::Admin::require_or_die(qw(-search));
49 PublicInbox::Config::json() or die "Cpanel::JSON::XS or similar missing\n";
50 PublicInbox::Admin::progress_prepare($opt);
51 my $env = PublicInbox::Admin::index_prepare($opt, $cfg);
52 local %ENV = (%ENV, %$env) if $env;
53 require PublicInbox::ExtSearchIdx;
54 my $eidx = PublicInbox::ExtSearchIdx->new($eidx_dir, $opt);
56 $eidx->attach_config($cfg);
59 $eidx->attach_inbox($_) for @ibxs;
60 $eidx->eidx_sync($opt);