Adam Kennedy > ORDB-CPANUploads-1.08 > ORDB::CPANUploads::Uploads

Download:
ORDB-CPANUploads-1.08.tar.gz

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Source  

NAME ^

ORDB::CPANUploads::Uploads - ORDB::CPANUploads class for the uploads table

DESCRIPTION ^

TO BE COMPLETED

METHODS ^

base

  # Returns 'ORDB::CPANUploads'
  my $namespace = ORDB::CPANUploads::Uploads->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 'uploads'
  print ORDB::CPANUploads::Uploads->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.

select

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

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

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

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

iterate

  ORDB::CPANUploads::Uploads->iterate( sub {
      print $_-> . "\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 ( ORDB::CPANUploads::Uploads->select ) {
      print $_-> . "\n";
  }

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

  ORDB::CPANUploads::Uploads->iterate(
      'order by ?', '',
      sub {
          print $_-> . "\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.

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

count

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

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

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

REMAINING ACCESSORS TO BE COMPLETED

SQL ^

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

  CREATE TABLE uploads (
      type text,
      author text,
      dist text,
      version text,
      filename text,
      released int
  )

SUPPORT ^

ORDB::CPANUploads::Uploads is part of the ORDB::CPANUploads API.

See the documentation for ORDB::CPANUploads for more information.

AUTHOR ^

Adam Kennedy <adamk@cpan.org>

COPYRIGHT ^

Copyright 2009 - 2011 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: