X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet.pm;h=e69655590ac7e7ec615c03365c5ec2f6360d8502;hb=701da8c4d6f0b78ffc015085aa410a6cacfcdb40;hp=ff7d8e907675413341b97510319a8167d34beb6c;hpb=6ae63e1c2c4b4ab4fa56170a3c8a5a81bb1efe32;p=dbsrgits%2FDBIx-Class.git
diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm
index ff7d8e9..e696555 100644
--- a/lib/DBIx/Class/ResultSet.pm
+++ b/lib/DBIx/Class/ResultSet.pm
@@ -4,32 +4,61 @@ use strict;
use warnings;
use overload
'0+' => 'count',
+ 'bool' => sub { 1; },
fallback => 1;
use Data::Page;
use Storable;
+use base qw/DBIx::Class/;
+__PACKAGE__->load_components(qw/AccessorGroup/);
+__PACKAGE__->mk_group_accessors('simple' => 'result_source');
+
=head1 NAME
DBIx::Class::ResultSet - Responsible for fetching and creating resultset.
=head1 SYNOPSIS
-my $rs = MyApp::DB::Class->search(registered => 1);
-my @rows = MyApp::DB::Class->search(foo => 'bar');
+ my $rs = $schema->resultset('User')->search(registered => 1);
+ my @rows = $schema->resultset('Foo')->search(bar => 'baz');
=head1 DESCRIPTION
The resultset is also known as an iterator. It is responsible for handling
-queries that may return an arbitrary number of rows, e.g. via C
+queries that may return an arbitrary number of rows, e.g. via L
or a C relationship.
+In the examples below, the following table classes are used:
+
+ package MyApp::Schema::Artist;
+ use base qw/DBIx::Class/;
+ __PACKAGE__->table('artist');
+ __PACKAGE__->add_columns(qw/artistid name/);
+ __PACKAGE__->set_primary_key('artistid');
+ __PACKAGE__->has_many(cds => 'MyApp::Schema::CD');
+ 1;
+
+ package MyApp::Schema::CD;
+ use base qw/DBIx::Class/;
+ __PACKAGE__->table('artist');
+ __PACKAGE__->add_columns(qw/cdid artist title year/);
+ __PACKAGE__->set_primary_key('cdid');
+ __PACKAGE__->belongs_to(artist => 'MyApp::Schema::Artist');
+ 1;
+
=head1 METHODS
=head2 new($source, \%$attrs)
-The resultset constructor. Takes a source object (usually a DBIx::Class::Table)
-and an attribute hash (see below for more information on attributes). Does
-not perform any queries -- these are executed as needed by the other methods.
+The resultset constructor. Takes a source object (usually a
+L) and an attribute hash (see L
+below). Does not perform any queries -- these are executed as needed by the
+other methods.
+
+Generally you won't need to construct a resultset manually. You'll
+automatically get one from e.g. a L called in scalar context:
+
+ my $rs = $schema->resultset('CD')->search({ title => '100th Window' });
=cut
@@ -41,10 +70,11 @@ sub new {
$attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } };
my %seen;
my $alias = ($attrs->{alias} ||= 'me');
- if (!$attrs->{select}) {
+ if ($attrs->{cols} || !$attrs->{select}) {
+ delete $attrs->{as} if $attrs->{cols};
my @cols = ($attrs->{cols}
? @{delete $attrs->{cols}}
- : $source->result_class->_select_columns);
+ : $source->columns);
$attrs->{select} = [ map { m/\./ ? $_ : "${alias}.$_" } @cols ];
}
$attrs->{as} ||= [ map { m/^$alias\.(.*)$/ ? $1 : $_ } @{$attrs->{select}} ];
@@ -62,22 +92,35 @@ sub new {
push(@{$attrs->{from}}, $source->resolve_join($join, $attrs->{alias}));
}
$attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
- foreach my $pre (@{delete $attrs->{prefetch} || []}) {
- push(@{$attrs->{from}}, $source->resolve_join($pre, $attrs->{alias}))
- unless $seen{$pre};
- my @pre =
- map { "$pre.$_" }
- $source->related_source($pre)->columns;
- push(@{$attrs->{select}}, @pre);
- push(@{$attrs->{as}}, @pre);
+
+ if (my $prefetch = delete $attrs->{prefetch}) {
+ foreach my $p (ref $prefetch eq 'ARRAY'
+ ? (@{$prefetch}) : ($prefetch)) {
+ if( ref $p eq 'HASH' ) {
+ foreach my $key (keys %$p) {
+ push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias}))
+ unless $seen{$key};
+ }
+ }
+ else {
+ push(@{$attrs->{from}}, $source->resolve_join($p, $attrs->{alias}))
+ unless $seen{$p};
+ }
+ my @cols = ();
+ push @cols, $source->resolve_prefetch($p, $attrs->{alias});
+ #die Dumper \@cols;
+ push(@{$attrs->{select}}, @cols);
+ push(@{$attrs->{as}}, @cols);
+ }
}
+
if ($attrs->{page}) {
$attrs->{rows} ||= 10;
$attrs->{offset} ||= 0;
$attrs->{offset} += ($attrs->{rows} * ($attrs->{page} - 1));
}
my $new = {
- source => $source,
+ result_source => $source,
cond => $attrs->{where},
from => $attrs->{from},
count => undef,
@@ -90,13 +133,14 @@ sub new {
=head2 search
- my @obj = $rs->search({ foo => 3 }); # "... WHERE foo = 3"
- my $new_rs = $rs->search({ foo => 3 });
-
+ my @obj = $rs->search({ foo => 3 }); # "... WHERE foo = 3"
+ my $new_rs = $rs->search({ foo => 3 });
+
If you need to pass in additional attributes but no additional condition,
-call it as ->search(undef, \%attrs);
-
- my @all = $class->search({}, { cols => [qw/foo bar/] }); # "SELECT foo, bar FROM $class_table"
+call it as C.
+
+ # "SELECT foo, bar FROM $class_table"
+ my @all = $class->search({}, { cols => [qw/foo bar/] });
=cut
@@ -120,17 +164,18 @@ sub search {
$attrs->{where} = $where;
}
- my $rs = (ref $self)->new($self->{source}, $attrs);
+ my $rs = (ref $self)->new($self->result_source, $attrs);
return (wantarray ? $rs->all : $rs);
}
-=head2 search_literal
+=head2 search_literal
+
my @obj = $rs->search_literal($literal_where_cond, @bind);
my $new_rs = $rs->search_literal($literal_where_cond, @bind);
Pass a literal chunk of SQL to be added to the conditional part of the
-resultset
+resultset.
=cut
@@ -141,33 +186,52 @@ sub search_literal {
return $self->search(\$cond, $attrs);
}
-=head2 find(@colvalues), find(\%cols)
+=head2 find(@colvalues), find(\%cols, \%attrs?)
+
+Finds a row based on its primary key or unique constraint. For example:
+
+ my $cd = $schema->resultset('CD')->find(5);
+
+Also takes an optional C attribute, to search by a specific key or unique
+constraint. For example:
-Finds a row based on its primary key(s).
+ my $cd = $schema->resultset('CD')->find_or_create(
+ {
+ artist => 'Massive Attack',
+ title => 'Mezzanine',
+ },
+ { key => 'artist_title' }
+ );
-=cut
+See also L and L.
+
+=cut
sub find {
my ($self, @vals) = @_;
my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
- my @pk = $self->{source}->primary_columns;
- #use Data::Dumper; warn Dumper($attrs, @vals, @pk);
- $self->{source}->result_class->throw( "Can't find unless primary columns are defined" )
- unless @pk;
+
+ my @cols = $self->result_source->primary_columns;
+ if (exists $attrs->{key}) {
+ my %uniq = $self->result_source->unique_constraints;
+ $self->( "Unknown key " . $attrs->{key} . " on " . $self->name )
+ unless exists $uniq{$attrs->{key}};
+ @cols = @{ $uniq{$attrs->{key}} };
+ }
+ #use Data::Dumper; warn Dumper($attrs, @vals, @cols);
+ $self->throw_exception( "Can't find unless a primary key or unique constraint is defined" )
+ unless @cols;
+
my $query;
if (ref $vals[0] eq 'HASH') {
$query = $vals[0];
- } elsif (@pk == @vals) {
+ } elsif (@cols == @vals) {
$query = {};
- @{$query}{@pk} = @vals;
+ @{$query}{@cols} = @vals;
} else {
$query = {@vals};
}
#warn Dumper($query);
- # Useless -> disabled
- #$self->{source}->result_class->throw( "Can't find unless all primary keys are specified" )
- # unless (keys %$query >= @pk); # If we check 'em we run afoul of uc/lc
- # column names etc. Not sure what to do yet
return $self->search($query)->next;
}
@@ -175,16 +239,19 @@ sub find {
$rs->search_related('relname', $cond?, $attrs?);
+Search the specified relationship. Optionally specify a condition for matching
+records.
+
=cut
sub search_related {
my ($self, $rel, @rest) = @_;
- my $rel_obj = $self->{source}->relationship_info($rel);
- $self->{source}->result_class->throw(
+ my $rel_obj = $self->result_source->relationship_info($rel);
+ $self->throw_exception(
"No such relationship ${rel} in search_related")
unless $rel_obj;
my $rs = $self->search(undef, { join => $rel });
- return $self->{source}->schema->resultset($rel_obj->{class}
+ return $self->result_source->schema->resultset($rel_obj->{class}
)->search( undef,
{ %{$rs->{attrs}},
alias => $rel,
@@ -201,18 +268,22 @@ Returns a storage-driven cursor to the given resultset.
sub cursor {
my ($self) = @_;
- my ($source, $attrs) = @{$self}{qw/source attrs/};
+ my ($attrs) = $self->{attrs};
$attrs = { %$attrs };
return $self->{cursor}
- ||= $source->storage->select($self->{from}, $attrs->{select},
+ ||= $self->result_source->storage->select($self->{from}, $attrs->{select},
$attrs->{where},$attrs);
}
-=head2 search_like
-
-Identical to search except defaults to 'LIKE' instead of '=' in condition
-
-=cut
+=head2 search_like
+
+Perform a search, but use C instead of equality as the condition. Note
+that this is simply a convenience method; you most likely want to use
+L with specific operators.
+
+For more information, see L.
+
+=cut
sub search_like {
my $class = shift;
@@ -237,42 +308,60 @@ sub slice {
$attrs->{offset} ||= 0;
$attrs->{offset} += $min;
$attrs->{rows} = ($max ? ($max - $min + 1) : 1);
- my $slice = (ref $self)->new($self->{source}, $attrs);
+ my $slice = (ref $self)->new($self->result_source, $attrs);
return (wantarray ? $slice->all : $slice);
}
-=head2 next
+=head2 next
+
+Returns the next element in the resultset (C is there is none).
-Returns the next element in the resultset (undef is there is none).
+Can be used to efficiently iterate over records in the resultset:
+
+ my $rs = $schema->resultset('CD')->search({});
+ while (my $cd = $rs->next) {
+ print $cd->title;
+ }
=cut
sub next {
my ($self) = @_;
my @row = $self->cursor->next;
+# warn Dumper(\@row); use Data::Dumper;
return unless (@row);
return $self->_construct_object(@row);
}
sub _construct_object {
my ($self, @row) = @_;
- my @cols = @{ $self->{attrs}{as} };
+ my @as = @{ $self->{attrs}{as} };
#warn "@cols -> @row";
- my (%me, %pre);
- foreach my $col (@cols) {
- if ($col =~ /([^\.]+)\.([^\.]+)/) {
- $pre{$1}[0]{$2} = shift @row;
- } else {
- $me{$col} = shift @row;
+ my $info = [ {}, {} ];
+ foreach my $as (@as) {
+ my $target = $info;
+ my @parts = split(/\./, $as);
+ my $col = pop(@parts);
+ foreach my $p (@parts) {
+ $target = $target->[1]->{$p} ||= [];
}
+ $target->[0]->{$col} = shift @row;
}
- my $new = $self->{source}->result_class->inflate_result(
- $self->{source}, \%me, \%pre);
+ #use Data::Dumper; warn Dumper(\@as, $info);
+ my $new = $self->result_source->result_class->inflate_result(
+ $self->result_source, @$info);
$new = $self->{attrs}{record_filter}->($new)
if exists $self->{attrs}{record_filter};
return $new;
}
+=head2 result_source
+
+Returns a reference to the result source for this recordset.
+
+=cut
+
+
=head2 count
Performs an SQL C with the same query as the resultset was built
@@ -284,7 +373,9 @@ on the resultset and counts the results of that.
sub count {
my $self = shift;
return $self->search(@_)->count if @_ && defined $_[0];
- die "Unable to ->count with a GROUP BY" if defined $self->{attrs}{group_by};
+ $self->throw_exception(
+ "Unable to ->count with a GROUP BY"
+ ) if defined $self->{attrs}{group_by};
unless (defined $self->{count}) {
my $attrs = { %{ $self->{attrs} },
select => { 'count' => '*' },
@@ -292,7 +383,7 @@ sub count {
# offset, order by and page are not needed to count. record_filter is cdbi
delete $attrs->{$_} for qw/rows offset order_by page pager record_filter/;
- ($self->{count}) = (ref $self)->new($self->{source}, $attrs)->cursor->next;
+ ($self->{count}) = (ref $self)->new($self->result_source, $attrs)->cursor->next;
}
return 0 unless $self->{count};
my $count = $self->{count};
@@ -304,7 +395,7 @@ sub count {
=head2 count_literal
-Calls search_literal with the passed arguments, then count.
+Calls L with the passed arguments, then L.
=cut
@@ -347,27 +438,27 @@ sub first {
=head2 update(\%values)
-Sets the specified columns in the resultset to the supplied values
+Sets the specified columns in the resultset to the supplied values.
=cut
sub update {
my ($self, $values) = @_;
- die "Values for update must be a hash" unless ref $values eq 'HASH';
- return $self->{source}->storage->update(
- $self->{source}->from, $values, $self->{cond});
+ $self->throw_exception("Values for update must be a hash") unless ref $values eq 'HASH';
+ return $self->result_source->storage->update(
+ $self->result_source->from, $values, $self->{cond});
}
=head2 update_all(\%values)
-Fetches all objects and updates them one at a time. ->update_all will run
-cascade triggers, ->update will not.
+Fetches all objects and updates them one at a time. Note that C
+will run cascade triggers while L will not.
=cut
sub update_all {
my ($self, $values) = @_;
- die "Values for update must be a hash" unless ref $values eq 'HASH';
+ $self->throw_exception("Values for update must be a hash") unless ref $values eq 'HASH';
foreach my $obj ($self->all) {
$obj->set_columns($values)->update;
}
@@ -382,14 +473,14 @@ Deletes the contents of the resultset from its result source.
sub delete {
my ($self) = @_;
- $self->{source}->storage->delete($self->{source}->from, $self->{cond});
+ $self->result_source->storage->delete($self->result_source->from, $self->{cond});
return 1;
}
=head2 delete_all
-Fetches all objects and deletes them one at a time. ->delete_all will run
-cascade triggers, ->delete will not.
+Fetches all objects and deletes them one at a time. Note that C
+will run cascade triggers while L will not.
=cut
@@ -402,14 +493,14 @@ sub delete_all {
=head2 pager
Returns a L object for the current resultset. Only makes
-sense for queries with page turned on.
+sense for queries with a C attribute.
=cut
sub pager {
my ($self) = @_;
my $attrs = $self->{attrs};
- die "Can't create pager for non-paged rs" unless $self->{page};
+ $self->throw_exception("Can't create pager for non-paged rs") unless $self->{page};
$attrs->{rows} ||= 10;
$self->count;
return $self->{pager} ||= Data::Page->new(
@@ -426,131 +517,412 @@ sub page {
my ($self, $page) = @_;
my $attrs = { %{$self->{attrs}} };
$attrs->{page} = $page;
- return (ref $self)->new($self->{source}, $attrs);
+ return (ref $self)->new($self->result_source, $attrs);
}
=head2 new_result(\%vals)
-Creates a result in the resultset's result class
+Creates a result in the resultset's result class.
=cut
sub new_result {
my ($self, $values) = @_;
- $self->{source}->result_class->throw( "new_result needs a hash" )
+ $self->throw_exception( "new_result needs a hash" )
unless (ref $values eq 'HASH');
- $self->{source}->result_class->throw( "Can't abstract implicit construct, condition not a hash" )
+ $self->throw_exception( "Can't abstract implicit construct, condition not a hash" )
if ($self->{cond} && !(ref $self->{cond} eq 'HASH'));
my %new = %$values;
my $alias = $self->{attrs}{alias};
foreach my $key (keys %{$self->{cond}||{}}) {
$new{$1} = $self->{cond}{$key} if ($key =~ m/^(?:$alias\.)?([^\.]+)$/);
}
- my $obj = $self->{source}->result_class->new(\%new);
- $obj->result_source($self->{source}) if $obj->can('result_source');
+ my $obj = $self->result_source->result_class->new(\%new);
+ $obj->result_source($self->result_source) if $obj->can('result_source');
$obj;
}
=head2 create(\%vals)
-Inserts a record into the resultset and returns the object
+Inserts a record into the resultset and returns the object.
-Effectively a shortcut for ->new_result(\%vals)->insert
+Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
=cut
sub create {
my ($self, $attrs) = @_;
- $self->{source}->result_class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH';
+ $self->throw_exception( "create needs a hashref" ) unless ref $attrs eq 'HASH';
return $self->new_result($attrs)->insert;
}
-=head2 find_or_create(\%vals)
+=head2 find_or_create(\%vals, \%attrs?)
+
+ $class->find_or_create({ key => $val, ... });
- $class->find_or_create({ key => $val, ... });
-
Searches for a record matching the search condition; if it doesn't find one,
-creates one and returns that instead.
-
+creates one and returns that instead.
+
+ my $cd = $schema->resultset('CD')->find_or_create({
+ cdid => 5,
+ artist => 'Massive Attack',
+ title => 'Mezzanine',
+ year => 2005,
+ });
+
+Also takes an optional C attribute, to search by a specific key or unique
+constraint. For example:
+
+ my $cd = $schema->resultset('CD')->find_or_create(
+ {
+ artist => 'Massive Attack',
+ title => 'Mezzanine',
+ },
+ { key => 'artist_title' }
+ );
+
+See also L and L.
+
=cut
sub find_or_create {
my $self = shift;
- my $hash = ref $_[0] eq "HASH" ? shift: {@_};
- my $exists = $self->find($hash);
+ my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
+ my $hash = ref $_[0] eq "HASH" ? shift : {@_};
+ my $exists = $self->find($hash, $attrs);
return defined($exists) ? $exists : $self->create($hash);
}
+=head2 update_or_create
+
+ $class->update_or_create({ key => $val, ... });
+
+First, search for an existing row matching one of the unique constraints
+(including the primary key) on the source of this resultset. If a row is
+found, update it with the other given column values. Otherwise, create a new
+row.
+
+Takes an optional C attribute to search on a specific unique constraint.
+For example:
+
+ # In your application
+ my $cd = $schema->resultset('CD')->update_or_create(
+ {
+ artist => 'Massive Attack',
+ title => 'Mezzanine',
+ year => 1998,
+ },
+ { key => 'artist_title' }
+ );
+
+If no C is specified, it searches on all unique constraints defined on the
+source, including the primary key.
+
+If the C is specified as C, search only on the primary key.
+
+See also L and L.
+
+=cut
+
+sub update_or_create {
+ my $self = shift;
+
+ my $attrs = (@_ > 1 && ref $_[$#_] eq 'HASH' ? pop(@_) : {});
+ my $hash = ref $_[0] eq "HASH" ? shift : {@_};
+
+ my %unique_constraints = $self->result_source->unique_constraints;
+ my @constraint_names = (exists $attrs->{key}
+ ? ($attrs->{key})
+ : keys %unique_constraints);
+
+ my @unique_hashes;
+ foreach my $name (@constraint_names) {
+ my @unique_cols = @{ $unique_constraints{$name} };
+ my %unique_hash =
+ map { $_ => $hash->{$_} }
+ grep { exists $hash->{$_} }
+ @unique_cols;
+
+ push @unique_hashes, \%unique_hash
+ if (scalar keys %unique_hash == scalar @unique_cols);
+ }
+
+ my $row;
+ if (@unique_hashes) {
+ $row = $self->search(\@unique_hashes, { rows => 1 })->first;
+ if ($row) {
+ $row->set_columns($hash);
+ $row->update;
+ }
+ }
+
+ unless ($row) {
+ $row = $self->create($hash);
+ }
+
+ return $row;
+}
+
+=head2 throw_exception
+
+See Schema's throw_exception
+
+=cut
+
+sub throw_exception {
+ my $self=shift;
+ $self->result_source->schema->throw_exception(@_);
+}
+
=head1 ATTRIBUTES
-The resultset takes various attributes that modify its behavior.
-Here's an overview of them:
+The resultset takes various attributes that modify its behavior. Here's an
+overview of them:
=head2 order_by
-Which column(s) to order the results by. This is currently passed
-through directly to SQL, so you can give e.g. C for a
-descending order.
+Which column(s) to order the results by. This is currently passed through
+directly to SQL, so you can give e.g. C for a descending order.
=head2 cols (arrayref)
-Shortcut to request a particular set of columns to be retrieved - adds
-'me.' onto the start of any column without a '.' in it and sets 'select'
-from that, then auto-populates 'as' from 'select' as normal
+Shortcut to request a particular set of columns to be retrieved. Adds
+C onto the start of any column without a C<.> in it and sets C