.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPANDB::Requires 3pm"
.TH CPANDB::Requires 3pm "2022-12-06" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
CPANDB::Requires \- CPANDB class for the requires table
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1TO BE COMPLETED\s0
.SH "METHODS"
.IX Header "METHODS"
.SS "base"
.IX Subsection "base"
.Vb 2
\&  # Returns \*(AqCPANDB\*(Aq
\&  my $namespace = CPANDB::Requires\->base;
.Ve
.PP
Normally you will only need to work directly with a table class,
and only with one ORLite package.
.PP
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
\&\f(CW\*(C`base\*(C'\fR method.
.SS "table"
.IX Subsection "table"
.Vb 2
\&  # Returns \*(Aqrequires\*(Aq
\&  print CPANDB::Requires\->table;
.Ve
.PP
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 \f(CW\*(C`table\*(C'\fR method to get the table name.
.SS "load"
.IX Subsection "load"
.Vb 1
\&  my $object = CPANDB::Requires\->load( $distribution );
.Ve
.PP
If your table has single column primary key, a \f(CW\*(C`load\*(C'\fR method will be
generated in the class. If there is no primary key, the method is not
created.
.PP
The \f(CW\*(C`load\*(C'\fR 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.
.PP
It returns a \f(CW\*(C`CPANDB::Requires\*(C'\fR object, or throws an exception if the
object does not exist.
.SS "select"
.IX Subsection "select"
.Vb 2
\&  # 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(
\&      \*(Aqwhere distribution > ? order by distribution\*(Aq,
\&      1000,
\&  );
.Ve
.PP
The \f(CW\*(C`select\*(C'\fR method executes a typical \s-1SQL\s0 \f(CW\*(C`SELECT\*(C'\fR query on the
requires table.
.PP
It takes an optional argument of a \s-1SQL\s0 phrase to be added after the
\&\f(CW\*(C`FROM requires\*(C'\fR section of the query, followed by variables
to be bound to the placeholders in the \s-1SQL\s0 phrase. Any \s-1SQL\s0 that is
compatible with SQLite can be used in the parameter.
.PP
Returns a list of \fBCPANDB::Requires\fR objects when called in list context, or a
reference to an \f(CW\*(C`ARRAY\*(C'\fR of \fBCPANDB::Requires\fR objects when called in scalar
context.
.PP
Throws an exception on error, typically directly from the \s-1DBI\s0 layer.
.SS "iterate"
.IX Subsection "iterate"
.Vb 3
\&  CPANDB::Requires\->iterate( sub {
\&      print $_\->distribution . "\en";
\&  } );
.Ve
.PP
The \f(CW\*(C`iterate\*(C'\fR method enables the processing of large tables one record at
a time without loading having to them all into memory in advance.
.PP
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.
.PP
The last argument to \f(CW\*(C`iterate\*(C'\fR must be a subroutine reference that will be
called for each element in the list, with the object provided in the topic
variable \f(CW$_\fR.
.PP
This makes the \f(CW\*(C`iterate\*(C'\fR code fragment above functionally equivalent to the
following, except with an O(1) memory cost instead of O(n).
.PP
.Vb 3
\&  foreach ( CPANDB::Requires\->select ) {
\&      print $_\->distribution . "\en";
\&  }
.Ve
.PP
You can filter the list via \s-1SQL\s0 in the same way you can with \f(CW\*(C`select\*(C'\fR.
.PP
.Vb 6
\&  CPANDB::Requires\->iterate(
\&      \*(Aqorder by ?\*(Aq, \*(Aqdistribution\*(Aq,
\&      sub {
\&          print $_\->distribution . "\en";
\&      }
\&  );
.Ve
.PP
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 \f(CW\*(C`ARRAY\*(C'\fR
references when used in this form.
.PP
.Vb 6
\&  CPANDB\->iterate(
\&      \*(Aqselect name from requires order by distribution\*(Aq,
\&      sub {
\&          print $_\->[0] . "\en";
\&      }
\&  );
.Ve
.SS "count"
.IX Subsection "count"
.Vb 2
\&  # How many objects are in the table
\&  my $rows = CPANDB::Requires\->count;
\&  
\&  # How many objects 
\&  my $small = CPANDB::Requires\->count(
\&      \*(Aqwhere distribution > ?\*(Aq,
\&      1000,
\&  );
.Ve
.PP
The \f(CW\*(C`count\*(C'\fR method executes a \f(CW\*(C`SELECT COUNT(*)\*(C'\fR query on the
requires table.
.PP
It takes an optional argument of a \s-1SQL\s0 phrase to be added after the
\&\f(CW\*(C`FROM requires\*(C'\fR section of the query, followed by variables
to be bound to the placeholders in the \s-1SQL\s0 phrase. Any \s-1SQL\s0 that is
compatible with SQLite can be used in the parameter.
.PP
Returns the number of objects that match the condition.
.PP
Throws an exception on error, typically directly from the \s-1DBI\s0 layer.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.SS "distribution"
.IX Subsection "distribution"
.Vb 5
\&  if ( $object\->distribution ) {
\&      print "Object has been inserted\en";
\&  } else {
\&      print "Object has not been inserted\en";
\&  }
.Ve
.PP
Returns true, or throws an exception on error.
.PP
\&\s-1REMAINING ACCESSORS TO BE COMPLETED\s0
.SH "SQL"
.IX Header "SQL"
The requires table was originally created with the
following \s-1SQL\s0 command.
.PP
.Vb 11
\&  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)
\&  )
.Ve
.SH "SUPPORT"
.IX Header "SUPPORT"
CPANDB::Requires is part of the \s-1CPANDB\s0 \s-1API.\s0
.PP
See the documentation for \s-1CPANDB\s0 for more information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2009 \- 2012 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.