NAME

CPANDB::Requires - CPANDB class for the requires table

SYNOPSIS

  TO BE COMPLETED

DESCRIPTION

TO BE COMPLETED

METHODS

select

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

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

It takes an optional argument of a SQL phrase to be added after the FROM requires 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::Requires objects when called in list context, or a reference to an ARRAY of CPANDB::Requires objects when called in scalar context.

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

count

  # How many objects are in the table
  my $rows = CPANDB::Requires->count;
  
  # How many objects 
  my $small = CPANDB::Requires->count(
      'where distribution > ?',
      1000,
  );

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

It takes an optional argument of a SQL phrase to be added after the FROM requires 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

distribution

  if ( $object->distribution ) {
      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 requires table was originally created with the following SQL command.

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

SUPPORT

CPANDB::Requires is part of the CPANDB API.

See the documentation for CPANDB for more information.

COPYRIGHT

Copyright 2009 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.

cpanm CPANDB

perl -MCPAN -e shell
install CPANDB