From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

RIBASUSHI / DBIx-Class-0.082844 / lib / DBIx / Class / Cursor.pm 

            

              
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

              
package DBIx::Class::Cursor;
use strict;
use warnings;
use base qw/DBIx::Class/;
=head1 NAME
DBIx::Class::Cursor - Abstract object representing a query cursor on a
resultset.
=head1 SYNOPSIS
  my $cursor = $schema->resultset('CD')->cursor();
  # raw values off the database handle in resultset columns/select order
  my @next_cd_column_values = $cursor->next;
  # list of all raw values as arrayrefs
  my @all_cds_column_values = $cursor->all;
=head1 DESCRIPTION
A Cursor represents a query cursor on a L<DBIx::Class::ResultSet> object. It
allows for traversing the result set with L</next>, retrieving all results with
L</all> and resetting the cursor with L</reset>.
Usually, you would use the cursor methods built into L<DBIx::Class::ResultSet>
to traverse it. See L<DBIx::Class::ResultSet/next>,
L<DBIx::Class::ResultSet/reset> and L<DBIx::Class::ResultSet/all> for more
information.
=head1 METHODS
=head2 new
Virtual method. Returns a new L<DBIx::Class::Cursor> object.
=cut
sub new {
  die "Virtual method!";
}
=head2 next
Virtual method. Advances the cursor to the next row. Returns an array of
column values (the result of L<DBI/fetchrow_array> method).
=cut
sub next {
  die "Virtual method!";
}
=head2 reset
Virtual method. Resets the cursor to the beginning.
=cut
sub reset {
  die "Virtual method!";
}
=head2 all
Virtual method. Returns all rows in the L<DBIx::Class::ResultSet>.
=cut
sub all {
  my ($self) = @_;
  $self->reset;
  my @all;
  while (my @row = $self->next) {
    push(@all, \@row);
  }
  $self->reset;
  return @all;
}
=head1 FURTHER QUESTIONS?
Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
=head1 COPYRIGHT AND LICENSE
This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
redistribute it and/or modify it under the same terms as the
L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
=cut
1;