Adam Kennedy > ORDB-JSAN-0.01 > ORDB::JSAN::Distribution

Download:
ORDB-JSAN-0.01.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

ORDB::JSAN::Distribution - ORDB::JSAN class for the distribution table

SYNOPSIS ^

  TO BE COMPLETED

DESCRIPTION ^

TO BE COMPLETED

METHODS ^

select

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

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

It takes an optional argument of a SQL phrase to be added after the FROM distribution 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 ORDB::JSAN::Distribution objects when called in list context, or a reference to an ARRAY of ORDB::JSAN::Distribution 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 = ORDB::JSAN::Distribution->count;
  
  # How many objects 
  my $small = ORDB::JSAN::Distribution->count(
      'where name > ?',
      1000,
  );

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

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

name

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

  CREATE TABLE distribution (
      name varchar (
          100
      )
      NOT NULL,
      doc varchar (
          100
      )
      NOT NULL,
      PRIMARY KEY (
          name
      )
  )

SUPPORT ^

ORDB::JSAN::Distribution is part of the ORDB::JSAN API.

See the documentation for ORDB::JSAN 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.

syntax highlighting: