.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPAN::SQLite::Index 3pm"
.TH CPAN::SQLite::Index 3pm "2019-02-10" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CPAN::SQLite::Index \- set up or update database tables.
.SH "VERSION"
.IX Header "VERSION"
version 0.217
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& my $index = CPAN::SQLite::Index\->new(setup => 1);
\& $index\->index();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the main module used to set up or update the
database tables used to store information from the
\&\s-1CPAN\s0 and ppm indices. The creation of the object
.PP
.Vb 1
\& my $index = CPAN::SQLite::Index\->new(%args);
.Ve
.PP
accepts two possible arguments:
.IP "\(bu" 3
setup => 1
.Sp
This (optional) argument specifies that the database is being set up.
Any existing tables will be dropped.
.IP "\(bu" 3
reindex => value
.Sp
This (optional) argument specifies distribution names that
one would like to reindex in an existing database. These may
be specified as either a scalar, for a single distribution,
or as an array reference for a list of distributions.
.SH "DETAILS"
.IX Header "DETAILS"
Calling
.PP
.Vb 1
\& $index\->index();
.Ve
.PP
will start the indexing procedure. Various messages
detailing the progress will written to \fI\s-1STDOUT\s0\fR,
which by default will be captured into a file
\&\fIcpan_sqlite_log.dddddddddd\fR, where the extension
is the \f(CW\*(C`time\*(C'\fR that the method was invoked. Error messages
are not captured, and will appear in \fI\s-1STDERR\s0\fR.
.PP
The steps of the indexing procedure are as follows.
.IP "\(bu" 4
download existing pre-compiled index (optional)
.Sp
If \s-1CPAN_SQLITE_DOWNLOAD\s0 or \s-1CPAN_SQLITE_DOWNLOAD_URL\s0 variables are set, an
already existing and up-to-date cpandb.sql file will be downloaded from
either specified \s-1URL\s0 or http://cpansqlite.trouchelle.com/ where it's
updated every hour. This greatly increases performance and decreases \s-1CPU\s0
and memory consumption during the indexing process but if your \s-1CPAN\s0
mirror is out-of-sync or you're using DarkPAN, it obviously wouldn't
work. It also wouldn't work without an internet connection.
.Sp
See WWW::CPAN::SQLite if you want to setup your own service for
pre-compiling the database.
.Sp
If neither variable is set, this step is skipped.
.IP "\(bu" 4
fetch index data
.Sp
The necessary \s-1CPAN\s0 index files
\&\fI\f(CI$CPAN\fI/authors/01mailrc.txt.gz\fR and
\&\fI\f(CI$CPAN\fI/modules/02packages.details.txt.gz\fR will be fetched
from the \s-1CPAN\s0 mirror specified by the \f(CW$cpan\fR variable
at the beginning of CPAN::SQLite::Index. If you are
using this option, it is recommended to use the
same \s-1CPAN\s0 mirror with subsequent updates, to ensure consistency
of the database. As well, the information on the locations
of the \s-1CPAN\s0 mirrors used for Template-Toolkit and GeoIP
is written.
.IP "\(bu" 4
get index information
.Sp
Information from the \s-1CPAN\s0 indices is extracted through
CPAN::SQLite::Info.
.IP "\(bu" 4
get state information
.Sp
Unless the \f(CW\*(C`setup\*(C'\fR argument within the \f(CW\*(C`new\*(C'\fR
method of CPAN::SQLite::Index is specified,
this will get information on the state of the database
through CPAN::SQLite::State.
A comparison is then made between this information
and that gathered from the \s-1CPAN\s0 indices, and if there's
a discrepancy in some items, those items are marked
for either insertion, updating, or deletion, as appropriate.
.IP "\(bu" 4
populate the database
.Sp
At this stage the gathered information is used to populate
the database, through CPAN::SQLite::Populate,
either inserting new items, updating
existing ones, or deleting obsolete items.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
CPAN::SQLite::Info, CPAN::SQLite::State,
CPAN::SQLite::Populate,
and CPAN::SQLite::Util.
Development takes place on the CPAN-SQLite project
at .
.SH "AUTHORS"
.IX Header "AUTHORS"
Randy Kobes (passed away on September 18, 2010)
.PP
Serguei Trouchelle
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2006 by Randy Kobes .
.PP
Copyright 2011 by Serguei Trouchelle .
.PP
Use and redistribution are under the same terms as Perl itself.