This file is indexed.

/usr/share/perl5/CPANDB/Requires.pod is in libcpandb-perl 0.18-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
=head1 NAME

CPANDB::Requires - CPANDB class for the requires table

=head1 DESCRIPTION

TO BE COMPLETED

=head1 METHODS

=head2 base

  # Returns 'CPANDB'
  my $namespace = CPANDB::Requires->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
C<base> method.

=head2 table

  # Returns 'requires'
  print CPANDB::Requires->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 C<table> method to get the table name.

=head2 load

  my $object = CPANDB::Requires->load( $distribution );

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

The C<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 C<CPANDB::Requires> object, or throws an exception if the
object does not exist.

=head2 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 C<select> method executes a typical SQL C<SELECT> query on the
requires table.

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

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

=head2 iterate

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

The C<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 C<iterate> must be a subroutine reference that will be
called for each element in the list, with the object provided in the topic
variable C<$_>.

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

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

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

  CPANDB::Requires->iterate(
      'order by ?', 'distribution',
      sub {
          print $_->distribution . "\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 C<ARRAY>
references when used in this form.

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

=head2 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 C<count> method executes a C<SELECT COUNT(*)> query on the
requires table.

It takes an optional argument of a SQL phrase to be added after the
C<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 L<DBI> layer.

=head1 ACCESSORS

=head2 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

=head1 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)
  )

=head1 SUPPORT

CPANDB::Requires is part of the L<CPANDB> API.

See the documentation for L<CPANDB> for more information.

=head1 AUTHOR

Adam Kennedy E<lt>adamk@cpan.orgE<gt>

=head1 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.