X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=script%2Fpublic-inbox-index;h=b1d29ec14546056759e813f84ae3ff93a96497ab;hb=6a7e3c6f870d0555184b68940eb373fa102d4102;hp=5adb6e741eff8f2578a780bd40738cd7c42ee7a6;hpb=65323f060a3db731bb9fafa004336eeb4bbb8f00;p=public-inbox.git diff --git a/script/public-inbox-index b/script/public-inbox-index index 5adb6e74..b1d29ec1 100755 --- a/script/public-inbox-index +++ b/script/public-inbox-index @@ -1,93 +1,125 @@ -#!/usr/bin/perl -w -# Copyright (C) 2015-2018 all contributors +#!perl -w +# Copyright (C) 2015-2020 all contributors # License: AGPL-3.0+ -# Basic tool to create a Xapian search index for a git repository -# configured for public-inbox. +# Basic tool to create a Xapian search index for a public-inbox. # Usage with libeatmydata -# highly recommended: eatmydata public-inbox-index REPO_DIR +# highly recommended: eatmydata public-inbox-index INBOX_DIR use strict; -use warnings; +use v5.10.1; use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev); -my $usage = "public-inbox-index REPO_DIR"; -use PublicInbox::Config; -use PublicInbox::Admin qw(resolve_repo_dir); +my $usage = 'public-inbox-index [options] INBOX_DIR'; +my $help = <new } || eval { - warn "public-inbox unconfigured for serving, indexing anyways...\n"; - undef; -}; -eval { require PublicInbox::SearchIdx }; -if ($@) { - print STDERR "Search::Xapian required for $0\n"; - exit 1; + Create and update search indices + +options: + + --no-fsync speed up indexing, risk corruption on power outage + -L LEVEL `basic', `medium', or `full' (default: full) + --compact | -c run public-inbox-compact(1) after indexing + --sequential-shard index Xapian shards sequentially for slow storage + --jobs=NUM set or disable parallelization (NUM=0) + --batch-size=BYTES flush changes to OS after a given number of bytes + --max-size=BYTES do not index messages larger than the given size + --reindex index previously indexed data (if upgrading) + --rethread regenerate thread IDs (if upgrading, use sparingly) + --prune prune git storage on discontiguous history + --verbose | -v increase verbosity (may be repeated) + --help | -? show this help + +BYTES may use `k', `m', and `g' suffixes (e.g. `10m' for 10 megabytes) +See public-inbox-index(1) man page for full documentation. +EOF +my $compact_opt; +my $opt = { quiet => -1, compact => 0, max_size => undef, fsync => 1 }; +GetOptions($opt, qw(verbose|v+ reindex rethread compact|c+ jobs|j=i prune + fsync|sync! xapian_only|xapian-only + indexlevel|index-level|L=s max_size|max-size=s + batch_size|batch-size=s + sequential_shard|seq-shard|sequential-shard + help|?)) + or die "bad command-line args\n$usage"; +if ($opt->{help}) { print $help; exit 0 }; +die "--jobs must be >= 0\n" if defined $opt->{jobs} && $opt->{jobs} < 0; +if ($opt->{xapian_only} && !$opt->{reindex}) { + die "--xapian-only requires --reindex\n"; +} + +# require lazily to speed up --help +require PublicInbox::Admin; +PublicInbox::Admin::require_or_die('-index'); + +if ($opt->{compact}) { + require PublicInbox::Xapcmd; + PublicInbox::Xapcmd::check_compact(); + $compact_opt = { -coarse_lock => 1, compact => 1 }; + if (defined(my $jobs = $opt->{jobs})) { + $compact_opt->{jobs} = $jobs; + } } -my $reindex; -my $prune; -my $jobs = undef; -my %opts = ( - '--reindex' => \$reindex, - '--jobs|j=i' => \$jobs, - '--prune' => \$prune, -); -GetOptions(%opts) or die "bad command-line args\n$usage"; -die "--jobs must be positive\n" if defined $jobs && $jobs < 0; +my $cfg = PublicInbox::Config->new; # Config is loaded by Admin +my @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, undef, $cfg); +PublicInbox::Admin::require_or_die('-index'); +unless (@ibxs) { print STDERR "Usage: $usage\n"; exit 1 } -my @dirs; +my $max_size = $opt->{max_size} // $cfg->{lc('publicInbox.indexMaxSize')}; +if (defined $max_size) { + PublicInbox::Admin::parse_unsigned(\$max_size) or + die "`publicInbox.indexMaxSize=$max_size' not parsed\n"; + $opt->{max_size} = $max_size; +} -if (@ARGV) { - @dirs = map { resolve_repo_dir($_) } @ARGV; -} else { - @dirs = (resolve_repo_dir()); +my $bs = $opt->{batch_size} // $cfg->{lc('publicInbox.indexBatchSize')}; +if (defined $bs) { + PublicInbox::Admin::parse_unsigned(\$bs) or + die "`publicInbox.indexBatchSize=$bs' not parsed\n"; + $opt->{batch_size} = $bs; } -sub usage { print STDERR "Usage: $usage\n"; exit 1 } -usage() unless @dirs; +# out-of-the-box builds of Xapian 1.4.x are still limited to 32-bit +# https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/limitations.html +local $ENV{XAPIAN_FLUSH_THRESHOLD} ||= '4294967295' if defined($bs); -defined($config) and $config->each_inbox(sub { - my ($ibx) = @_; +my $s = $opt->{sequential_shard} // + $cfg->{lc('publicInbox.indexSequentialShard')}; +if (defined $s) { + my $v = $cfg->git_bool($s); + defined($v) or + die "`publicInbox.indexSequentialShard=$s' not boolean\n"; + $opt->{sequential_shard} = $v; +} - for my $i (0..$#dirs) { - next if $dirs[$i] ne $ibx->{mainrepo}; - $dirs[$i] = $ibx; - } -}); +my $mods = {}; +foreach my $ibx (@ibxs) { + # XXX: users can shoot themselves in the foot, with opt->{indexlevel} + $ibx->{indexlevel} //= $opt->{indexlevel} // ($opt->{xapian_only} ? + 'full' : PublicInbox::Admin::detect_indexlevel($ibx)); + PublicInbox::Admin::scan_ibx_modules($mods, $ibx); +} -foreach my $dir (@dirs) { - if (!ref($dir) && -f "$dir/inbox.lock") { # v2 - my $ibx = { mainrepo => $dir, name => 'unnamed' }; - $dir = PublicInbox::Inbox->new($ibx); +PublicInbox::Admin::require_or_die(keys %$mods); +require PublicInbox::InboxWritable; +PublicInbox::Admin::progress_prepare($opt); +for my $ibx (@ibxs) { + $ibx = PublicInbox::InboxWritable->new($ibx); + if ($opt->{compact} >= 2) { + PublicInbox::Xapcmd::run($ibx, 'compact', $compact_opt); } - index_dir($dir); -} + $ibx->{-no_fsync} = 1 if !$opt->{fsync}; -sub index_dir { - my ($repo) = @_; - if (!ref $repo && ! -d $repo) { - die "$repo does not appear to be an inbox repository\n"; + my $ibx_opt = $opt; + if (defined(my $s = $ibx->{lc('indexSequentialShard')})) { + defined(my $v = $cfg->git_bool($s)) or die <{name}.indexSequentialShard not boolean +EOL + $ibx_opt = { %$opt, sequential_shard => $v }; } - if (ref($repo) && ($repo->{version} || 1) == 2) { - eval { require PublicInbox::V2Writable }; - die "v2 requirements not met: $@\n" if $@; - my $v2w = eval { - $jobs and local $ENV{NPROC} = $jobs; - PublicInbox::V2Writable->new($repo); - }; - if (defined $jobs) { - if ($jobs == 0) { - $v2w->{parallel} = 0; - } else { - my $n = $v2w->{partitions}; - if ($jobs != ($n + 1)) { - warn -"Unable to respect --jobs=$jobs, inbox was created with $n partitions\n"; - } - } - } - $v2w->index_sync({ reindex => $reindex, prune => $prune }); - } else { - my $s = PublicInbox::SearchIdx->new($repo, 1); - $s->index_sync({ reindex => $reindex }); + PublicInbox::Admin::index_inbox($ibx, undef, $ibx_opt); + if ($compact_opt) { + local $compact_opt->{jobs} = 0 if $ibx_opt->{sequential_shard}; + PublicInbox::Xapcmd::run($ibx, 'compact', $compact_opt); } }