NAME

JSAN::Index - JavaScript Archive Network (JSAN) SQLite/ORLite Index

DESCRIPTION

JSAN is the JavaScript Archive Network, a port of CPAN to JavaScript.

You can find the JSAN at http://openjsan.org.

As well as a flat text file index like CPAN, the JSAN index is also distributed as a DBD::SQLite database.

JSAN::Index is a ORLite wrapper built around the JSAN SQLite index.

It allow you to easily do all sorts of nifty things with the index in a simple and straight forward way.

Using The JSAN Index / Terminology

Once loaded, most of the functionality of the index is accessed through the classes that implement the various objects in the index.

These are:

JSAN::Index::Author: An author is a single human (or under certain very special circumstances a company or mailing list) that creates distributions and uploads them to the JSAN.
JSAN::Index::Distribution: A distribution is a single software component that may go through a number of releases
JSAN::Index::Release: A release is a compressed archive file containing a single version of a paricular distribution.
JSAN::Index::Library: A library is a single class, or rather a "pseudo-namespace", that defines an interface to provide some functionality. Distributions often contain a number of libraries, making up a complete "API".

METHODS

There are only a very limited number of utility methods available directly from the JSAN::Index class itself.

init param => $value, ...

The init method initializes the JSAN index adapter. It takes a set of parameters and initializes the JSAN::Index class. JSAN::Index is a singleton, so only it can initialized only once. Any further attempts to do so will result in an exception being thrown.

dependency param => $value

The dependency method creates and returns an dependency resolution object that is used by JSAN::Client to schedule which releases to install.

If the optional parameter 'build' is true, creates a build-time dependency resolve, which will additionally install releases only needed for testing.

Returns an Algorithm::Dependency object.

transport

This accessor return an instance of JSAN::Transport, which can be used for managing files of current mirror.

self

This accessor return a singleton instance of JSAN::Index, or undef is its not initialized yet.

dsn

my $string = JSAN::Index->dsn;

The dsn accessor returns the DBI connection string used to connect to the SQLite database as a string.

dbh

my $handle = JSAN::Index->dbh;

To reliably prevent potential SQLite deadlocks resulting from multiple connections in a single process, each ORLite package will only ever maintain a single connection to the database.

During a transaction, this will be the same (cached) database handle.

Although in most situations you should not need a direct DBI connection handle, the dbh method provides a method for getting a direct connection in a way that is compatible with connection management in ORLite.

Please note that these connections should be short-lived, you should never hold onto a connection beyond your immediate scope.

The transaction system in ORLite is specifically designed so that code using the database should never have to know whether or not it is in a transation.

Because of this, you should never call the ->disconnect method on the database handles yourself, as the handle may be that of a currently running transaction.

Further, you should do your own transaction management on a handle provided by the <dbh> method.

In cases where there are extreme needs, and you absolutely have to violate these connection handling rules, you should create your own completely manual DBI->connect call to the database, using the connect string provided by the dsn method.

The dbh method returns a DBI::db object, or throws an exception on error.

selectall_arrayref

The selectall_arrayref method is a direct wrapper around the equivalent DBI method, but applied to the appropriate locally-provided connection or transaction.