NAME

       CPANDB::Module - CPANDB class for the module table

DESCRIPTION

       TO BE COMPLETED

METHODS

   base
         # Returns 'CPANDB'
         my $namespace = CPANDB::Module->base;

       Normally you will only need to work directly with a table class, and only with one ORLite
       package.

       However, if for some reason you need to work with multiple ORLite packages at the same
       time without hardcoding the root namespace all the time, you can determine the root
       namespace from an object or table class with the "base" method.

   table
         # Returns 'module'
         print CPANDB::Module->table;

       While you should not need the name of table for any simple operations, from time to time
       you may need it programatically. If you do need it, you can use the "table" method to get
       the table name.

   load
         my $object = CPANDB::Module->load( $module );

       If your table has single column primary key, a "load" method will be generated in the
       class. If there is no primary key, the method is not created.

       The "load" method provides a shortcut mechanism for fetching a single object based on the
       value of the primary key. However it should only be used for cases where your code trusts
       the record to already exists.

       It returns a "CPANDB::Module" object, or throws an exception if the object does not exist.

   select
         # Get all objects in list context
         my @list = CPANDB::Module->select;

         # Get a subset of objects in scalar context
         my $array_ref = CPANDB::Module->select(
             'where module > ? order by module',
             1000,
         );

       The "select" method executes a typical SQL "SELECT" query on the module table.

       It takes an optional argument of a SQL phrase to be added after the "FROM module" section
       of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any
       SQL that is compatible with SQLite can be used in the parameter.

       Returns a list of CPANDB::Module objects when called in list context, or a reference to an
       "ARRAY" of CPANDB::Module objects when called in scalar context.

       Throws an exception on error, typically directly from the DBI layer.

   iterate
         CPANDB::Module->iterate( sub {
             print $_->module . "\n";
         } );

       The "iterate" method enables the processing of large tables one record at a time without
       loading having to them all into memory in advance.

       This plays well to the strength of SQLite, allowing it to do the work of loading
       arbitrarily large stream of records from disk while retaining the full power of Perl when
       processing the records.

       The last argument to "iterate" must be a subroutine reference that will be called for each
       element in the list, with the object provided in the topic variable $_.

       This makes the "iterate" code fragment above functionally equivalent to the following,
       except with an O(1) memory cost instead of O(n).

         foreach ( CPANDB::Module->select ) {
             print $_->module . "\n";
         }

       You can filter the list via SQL in the same way you can with "select".

         CPANDB::Module->iterate(
             'order by ?', 'module',
             sub {
                 print $_->module . "\n";
             }
         );

       You can also use it in raw form from the root namespace for better control.  Using this
       form also allows for the use of arbitrarily complex queries, including joins. Instead of
       being objects, rows are provided as "ARRAY" references when used in this form.

         CPANDB->iterate(
             'select name from module order by module',
             sub {
                 print $_->[0] . "\n";
             }
         );

   count
         # How many objects are in the table
         my $rows = CPANDB::Module->count;

         # How many objects
         my $small = CPANDB::Module->count(
             'where module > ?',
             1000,
         );

       The "count" method executes a "SELECT COUNT(*)" query on the module table.

       It takes an optional argument of a SQL phrase to be added after the "FROM module" section
       of the query, followed by variables to be bound to the placeholders in the SQL phrase. Any
       SQL that is compatible with SQLite can be used in the parameter.

       Returns the number of objects that match the condition.

       Throws an exception on error, typically directly from the DBI layer.

ACCESSORS

   module
         if ( $object->module ) {
             print "Object has been inserted\n";
         } else {
             print "Object has not been inserted\n";
         }

       Returns true, or throws an exception on error.

       REMAINING ACCESSORS TO BE COMPLETED

SQL

       The module table was originally created with the following SQL command.

         CREATE TABLE module (
             module TEXT NOT NULL PRIMARY KEY,
             version TEXT NULL,
             distribution TEXT NOT NULL,
             FOREIGN KEY (distribution) REFERENCES distribution (distribution)
         )

SUPPORT

       CPANDB::Module is part of the CPANDB API.

       See the documentation for CPANDB for more information.

AUTHOR

       Adam Kennedy <adamk@cpan.org>

COPYRIGHT

       Copyright 2009 - 2012 Adam Kennedy.

       This program is free software; you can redistribute it and/or modify it under the same
       terms as Perl itself.

       The full text of the license can be found in the LICENSE file included with this module.