VERSION

SYNOPSIS

my $obj = CPAN::SQLite->new(CPAN => '/path/to/CPAN');
$obj->index(setup => 1);
$obj->query(mode => 'dist', name => 'CPAN');
my $results = $obj->{results};

DESCRIPTION

One begins by creating the object as

  my $obj = CPAN::SQLite->new(%args);

which accepts the following arguments:

• "CPAN => '/path/to/CPAN'"

  This specifies the path to where the index files are to be stored. This could be a local CPAN mirror, defined here by the presence of a MIRRORED.BY file beneath this directory, or a local directory in which to store these files from a remote CPAN mirror. In the latter case, the index files are fetched from a remote CPAN mirror, using the same list that "CPAN.pm" uses, if this is configured, and are updated if they are more than one day old.

  If the "CPAN" option is not given, it will default to "cpan_home" of CPAN, if this is configured, with the index files found under "keep_source_where". A fatal error results if such a directory isn't found. Updates to these index files are assumed here to be handled by "CPAN.pm".

• "db_dir => '/path/to/db/dir'"

  This specifies the path to where the database file is found. If not given, it defaults to the "cpan_home" directory of "CPAN.pm", if present, or to the directory in which the script was invoked. The name of the database file is "cpandb.sql".

There are two main methods available.

$obj->index(%args);

• setup => 1

  This specifies that the database is to be created and populated from the CPAN indices; any existing database will be overwritten. Not specifying this option will assume that an existing database is to be updated.

• reindex => 'dist_name'

  This specifies that the CPAN distribution "dist_name" is to be reindexed.

$obj->query(%args);

• "mode => some_value"

  This specifies what type of query to perform, with "mode" being one of "dist", "module", or "author", for searching through, respectively, CPAN distribution names, module names, or author names and CPAN ids.

• "type => query_term"

  This specifies the query term for the search, with "type" being one of "name", to search for an exact match, or "search", for searching for partial matches. Perl regular expressions are supported in the "query_term" for the "search" option.

As well, an option of "max_results => some_number" will limit the number of results returned; if not specified, this defaults to 200.

CPAN.pm support

   perl -MCPAN -e shell
   cpan> o conf use_sqlite 1

Use

  cpan> o conf commit

to save this setting for future sessions.

Using CPAN::SQLite, what happens is that a request for information through CPAN.pm, such as

  cpan> a ANDK

will cause a query to the SQLite database to be made. If successful, this will place the relevant data for this request into the data structure CPAN.pm uses to store and retrieve such information. Thus, at any given time, the only information CPAN.pm stores in memory is that for packages, modules, and authors for which previous queries have been made. There are certain requests, such as

  cpan> r

to make a list of recommended packages for which upgrades on CPAN are available, which will result in loading information on all available packages into memory; if such a query is made, the subsequent memory footprint of CPAN.pm with and without CPAN::SQLite will be essentially the same.

The database itself, called cpandb.sql, will be stored in the location specified by "$CPAN::Config->{cpan_home}". When first started, this database will be created, and afterwards, it will be updated if the database is older than one day since the last update. A log file of the creation or update process, called cpan_search_log.dddddddddd, will be created in the same directory as the database file.

SUPPORT

    perldoc CPAN::SQLite

You can also look for information at:

• AnnoCPAN: Annotated CPAN documentation

  <http://annocpan.org/dist/CPAN-SQLite>

• CPAN::Forum: Discussion forum

  <http:///www.cpanforum.com/dist/CPAN-SQLite>

• CPAN Ratings

  <http://cpanratings.perl.org/d/CPAN-SQLite>

• RT: CPAN's request tracker

  <http://rt.cpan.org/NoAuth/Bugs.html?Dist=CPAN-SQLite>

• Search CPAN

  <http://search.cpan.org/dist/CPAN-SQLite>

AUTHORS

Serguei Trouchelle <[email protected]>

COPYRIGHT

Copyright 2011-2014 by Serguei Trouchelle <[email protected]>.

Use and redistribution are under the same terms as Perl itself.