X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet.pm;h=ab96fffcc0f7ec3104462f5567bfdcabcf27be0c;hb=f4409169fe98a88a7802b96e8a75838e8a4756c6;hp=e52e17922b675e5a64996bbaab6e6558119976ee;hpb=54540863adce71e931685a37d33e37650e5feb5e;p=dbsrgits%2FDBIx-Class-Historic.git
diff --git a/lib/DBIx/Class/ResultSet.pm b/lib/DBIx/Class/ResultSet.pm
index e52e179..ab96fff 100644
--- a/lib/DBIx/Class/ResultSet.pm
+++ b/lib/DBIx/Class/ResultSet.pm
@@ -4,8 +4,14 @@ 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
@@ -13,82 +19,136 @@ 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__->load_components(qw/Core/);
+ __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__->load_components(qw/Core/);
+ __PACKAGE__->table('cd');
+ __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)
+=head2 new
+
+=head3 Arguments: ($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
sub new {
- my ($class, $source, $attrs) = @_;
- #use Data::Dumper; warn Dumper(@_);
- $class = ref $class if ref $class;
- $attrs = { %{ $attrs || {} } };
+ my $class = shift;
+ return $class->new_result(@_) if ref $class;
+ my ($source, $attrs) = @_;
+ #use Data::Dumper; warn Dumper($attrs);
+ $attrs = Storable::dclone($attrs || {}); # { %{ $attrs || {} } };
my %seen;
- if (!$attrs->{select}) {
+ my $alias = ($attrs->{alias} ||= 'me');
+ if ($attrs->{cols} || !$attrs->{select}) {
+ delete $attrs->{as} if $attrs->{cols};
my @cols = ($attrs->{cols}
? @{delete $attrs->{cols}}
- : $source->result_class->_select_columns);
- $attrs->{select} = [ map { m/\./ ? $_ : "me.$_" } @cols ];
+ : $source->columns);
+ $attrs->{select} = [ map { m/\./ ? $_ : "${alias}.$_" } @cols ];
+ }
+ $attrs->{as} ||= [ map { m/^$alias\.(.*)$/ ? $1 : $_ } @{$attrs->{select}} ];
+ if (my $include = delete $attrs->{include_columns}) {
+ push(@{$attrs->{select}}, @$include);
+ push(@{$attrs->{as}}, map { m/([^\.]+)$/; $1; } @$include);
}
- $attrs->{as} ||= [ map { m/^me\.(.*)$/ ? $1 : $_ } @{$attrs->{select}} ];
#use Data::Dumper; warn Dumper(@{$attrs}{qw/select as/});
- $attrs->{from} ||= [ { 'me' => $source->name } ];
- if ($attrs->{join}) {
- foreach my $j (ref $attrs->{join} eq 'ARRAY'
- ? (@{$attrs->{join}}) : ($attrs->{join})) {
+ $attrs->{from} ||= [ { $alias => $source->from } ];
+ $attrs->{seen_join} ||= {};
+ if (my $join = delete $attrs->{join}) {
+ foreach my $j (ref $join eq 'ARRAY'
+ ? (@{$join}) : ($join)) {
if (ref $j eq 'HASH') {
$seen{$_} = 1 foreach keys %$j;
} else {
$seen{$j} = 1;
}
}
- push(@{$attrs->{from}}, $source->result_class->_resolve_join($attrs->{join}, 'me'));
+ push(@{$attrs->{from}}, $source->resolve_join($join, $attrs->{alias}, $attrs->{seen_join}));
}
$attrs->{group_by} ||= $attrs->{select} if delete $attrs->{distinct};
- foreach my $pre (@{$attrs->{prefetch} || []}) {
- push(@{$attrs->{from}}, $source->result_class->_resolve_join($pre, 'me'))
- unless $seen{$pre};
- my @pre =
- map { "$pre.$_" }
- $source->result_class->_relationships->{$pre}->{class}->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 @prefetch = $source->resolve_prefetch($p, $attrs->{alias});
+ #die Dumper \@cols;
+ push(@{$attrs->{select}}, map { $_->[0] } @prefetch);
+ push(@{$attrs->{as}}, map { $_->[1] } @prefetch);
+ }
+ }
+
+ 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,
+ page => delete $attrs->{page},
pager => undef,
attrs => $attrs };
bless ($new, $class);
- $new->pager if $attrs->{page};
return $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
@@ -99,28 +159,31 @@ sub search {
my $attrs = { %{$self->{attrs}} };
if (@_ > 1 && ref $_[$#_] eq 'HASH') {
- $attrs = { %{ pop(@_) } };
+ $attrs = { %$attrs, %{ pop(@_) } };
}
- my $where = ((@_ == 1 || ref $_[0] eq "HASH") ? shift : {@_});
+ my $where = (@_ ? ((@_ == 1 || ref $_[0] eq "HASH") ? shift : {@_}) : undef());
if (defined $where) {
$where = (defined $attrs->{where}
- ? { '-and' => [ $where, $attrs->{where} ] }
+ ? { '-and' =>
+ [ map { ref $_ eq 'ARRAY' ? [ -or => $_ ] : $_ }
+ $where, $attrs->{where} ] }
: $where);
$attrs->{where} = $where;
}
- my $rs = $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
@@ -131,6 +194,89 @@ sub search_literal {
return $self->search(\$cond, $attrs);
}
+=head2 find
+
+=head3 Arguments: (@colvalues) | (\%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:
+
+ my $cd = $schema->resultset('CD')->find_or_create(
+ {
+ artist => 'Massive Attack',
+ title => 'Mezzanine',
+ },
+ { key => 'artist_title' }
+ );
+
+See also L and L.
+
+=cut
+
+sub find {
+ my ($self, @vals) = @_;
+ my $attrs = (@vals > 1 && ref $vals[$#vals] eq 'HASH' ? pop(@vals) : {});
+
+ 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 (@cols == @vals) {
+ $query = {};
+ @{$query}{@cols} = @vals;
+ } else {
+ $query = {@vals};
+ }
+ foreach (keys %$query) {
+ next if m/\./;
+ $query->{$self->{attrs}{alias}.'.'.$_} = delete $query->{$_};
+ }
+ #warn Dumper($query);
+ return $self->search($query,$attrs)->next;
+}
+
+=head2 search_related
+
+ $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->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 });
+ my $alias = ($rs->{attrs}{seen_join}{$rel} > 1
+ ? join('_', $rel, $rs->{attrs}{seen_join}{$rel})
+ : $rel);
+ return $self->result_source->schema->resultset($rel_obj->{class}
+ )->search( undef,
+ { %{$rs->{attrs}},
+ alias => $alias,
+ select => undef(),
+ as => undef() }
+ )->search(@rest);
+}
+
=head2 cursor
Returns a storage-driven cursor to the given resultset.
@@ -139,21 +285,22 @@ Returns a storage-driven cursor to the given resultset.
sub cursor {
my ($self) = @_;
- my ($source, $attrs) = @{$self}{qw/source attrs/};
- if ($attrs->{page}) {
- $attrs->{rows} = $self->pager->entries_per_page;
- $attrs->{offset} = $self->pager->skipped;
- }
+ 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;
@@ -166,7 +313,9 @@ sub search_like {
return $class->search($query, { %$attrs });
}
-=head2 slice($first, $last)
+=head2 slice
+
+=head3 Arguments: ($first, $last)
Returns a subset of elements from the resultset.
@@ -175,98 +324,123 @@ Returns a subset of elements from the resultset.
sub slice {
my ($self, $min, $max) = @_;
my $attrs = { %{ $self->{attrs} || {} } };
- $self->{source}->result_class->throw("Can't slice without where") unless $attrs->{where};
- $attrs->{offset} = $min;
+ $attrs->{offset} ||= 0;
+ $attrs->{offset} += $min;
$attrs->{rows} = ($max ? ($max - $min + 1) : 1);
- my $slice = $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";
- @cols = grep { /\(/ or ! /\./ } @cols;
- my $new;
- unless ($self->{attrs}{prefetch}) {
- $new = $self->{source}->result_class->_row_to_object(\@cols, \@row);
- } else {
- my @main = splice(@row, 0, scalar @cols);
- $new = $self->{source}->result_class->_row_to_object(\@cols, \@main);
- PRE: foreach my $pre (@{$self->{attrs}{prefetch}}) {
- my $rel_obj = $self->{source}->result_class->_relationships->{$pre};
- my $pre_class = $self->{source}->result_class->resolve_class($rel_obj->{class});
- my @pre_cols = $pre_class->_select_columns;
- my @vals = splice(@row, 0, scalar @pre_cols);
- my $fetched = $pre_class->_row_to_object(\@pre_cols, \@vals);
- $self->{source}->result_class->throw("No accessor for prefetched $pre")
- unless defined $rel_obj->{attrs}{accessor};
- if ($rel_obj->{attrs}{accessor} eq 'single') {
- foreach my $pri ($rel_obj->{class}->primary_columns) {
- unless (defined $fetched->get_column($pri)) {
- undef $fetched;
- last;
- }
- }
- $new->{_relationship_data}{$pre} = $fetched;
- } elsif ($rel_obj->{attrs}{accessor} eq 'filter') {
- $new->{_inflated_column}{$pre} = $fetched;
- } else {
- $self->{source}->result_class->throw("Don't know how to store prefetched $pre");
- }
+ 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;
}
+ #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
with to find the number of elements. If passed arguments, does a search
on the resultset and counts the results of that.
+Note: When using C with C, L emulates C
+using C. Some databases (notably SQLite) do
+not support C with multiple columns. If you are using such a
+database, you should only use columns from the main table in your C
+clause.
+
=cut
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};
- unless ($self->{count}) {
+ unless (defined $self->{count}) {
+ my $group_by;
+ my $select = { 'count' => '*' };
+ if( $group_by = delete $self->{attrs}{group_by} ) {
+ my @distinct = (ref $group_by ? @$group_by : ($group_by));
+ # todo: try CONCAT for multi-column pk
+ my @pk = $self->result_source->primary_columns;
+ if( scalar(@pk) == 1 ) {
+ my $pk = shift(@pk);
+ my $alias = $self->{attrs}{alias};
+ my $re = qr/^($alias\.)?$pk$/;
+ foreach my $column ( @distinct) {
+ if( $column =~ $re ) {
+ @distinct = ( $column );
+ last;
+ }
+ }
+ }
+
+ $select = { count => { 'distinct' => \@distinct } };
+ #use Data::Dumper; die Dumper $select;
+ }
+
my $attrs = { %{ $self->{attrs} },
- select => { 'count' => '*' },
+ select => $select,
as => [ 'count' ] };
- # offset and order by are not needed to count, page, join and prefetch
- # will get in the way (add themselves to from again ...)
- delete $attrs->{$_} for qw/offset order_by page join prefetch/;
+ # 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/;
- my @cols = 'COUNT(*)';
- ($self->{count}) = $self->search(undef, $attrs)->cursor->next;
+ ($self->{count}) = (ref $self)->new($self->result_source, $attrs)->cursor->next;
+ $self->{attrs}{group_by} = $group_by;
}
return 0 unless $self->{count};
- return $self->{pager}->entries_on_this_page if ($self->{pager});
- return ( $self->{attrs}->{rows} && $self->{attrs}->{rows} < $self->{count} )
- ? $self->{attrs}->{rows}
- : $self->{count};
+ my $count = $self->{count};
+ $count -= $self->{attrs}{offset} if $self->{attrs}{offset};
+ $count = $self->{attrs}{rows} if
+ ($self->{attrs}{rows} && $self->{attrs}{rows} < $count);
+ return $count;
}
=head2 count_literal
-Calls search_literal with the passed arguments, then count.
+Calls L with the passed arguments, then L.
=cut
@@ -307,39 +481,105 @@ sub first {
return $_[0]->reset->next;
}
+=head2 update
+
+=head3 Arguments: (\%values)
+
+Sets the specified columns in the resultset to the supplied values.
+
+=cut
+
+sub update {
+ my ($self, $values) = @_;
+ $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
+
+=head3 Arguments: (\%values)
+
+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) = @_;
+ $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;
+ }
+ return 1;
+}
+
=head2 delete
-Deletes all elements in the resultset.
+Deletes the contents of the resultset from its result source.
=cut
sub delete {
my ($self) = @_;
- $_->delete for $self->all;
+ my $del = {};
+ $self->throw_exception("Can't delete on resultset with condition unless hash or array")
+ unless (ref($self->{cond}) eq 'HASH' || ref($self->{cond}) eq 'ARRAY');
+ if (ref $self->{cond} eq 'ARRAY') {
+ $del = [ map { my %hash;
+ foreach my $key (keys %{$_}) {
+ $key =~ /([^\.]+)$/;
+ $hash{$1} = $_->{$key};
+ }; \%hash; } @{$self->{cond}} ];
+ } elsif ((keys %{$self->{cond}})[0] eq '-and') {
+ $del->{-and} = [ map { my %hash;
+ foreach my $key (keys %{$_}) {
+ $key =~ /([^\.]+)$/;
+ $hash{$1} = $_->{$key};
+ }; \%hash; } @{$self->{cond}{-and}} ];
+ } else {
+ foreach my $key (keys %{$self->{cond}}) {
+ $key =~ /([^\.]+)$/;
+ $del->{$1} = $self->{cond}{$key};
+ }
+ }
+ $self->result_source->storage->delete($self->result_source->from, $del);
return 1;
}
-*delete_all = \&delete; # Yeah, yeah, yeah ...
+=head2 delete_all
+
+Fetches all objects and deletes them one at a time. Note that C
+will run cascade triggers while L will not.
+
+=cut
+
+sub delete_all {
+ my ($self) = @_;
+ $_->delete for $self->all;
+ return 1;
+}
=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};
- delete $attrs->{offset};
- my $rows_per_page = delete $attrs->{rows} || 10;
- $self->{pager} ||= Data::Page->new(
- $self->count, $rows_per_page, $attrs->{page} || 1);
- $attrs->{rows} = $rows_per_page;
- return $self->{pager};
+ $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(
+ $self->{count}, $attrs->{rows}, $self->{page});
}
-=head2 page($page_num)
+=head2 page
+
+=head3 Arguments: ($page_num)
Returns a new resultset for the specified page.
@@ -347,79 +587,455 @@ Returns a new resultset for the specified page.
sub page {
my ($self, $page) = @_;
- my $attrs = $self->{attrs};
+ my $attrs = { %{$self->{attrs}} };
$attrs->{page} = $page;
- return $self->new($self->{source}, $attrs);
+ return (ref $self)->new($self->result_source, $attrs);
+}
+
+=head2 new_result
+
+=head3 Arguments: (\%vals)
+
+Creates a result in the resultset's result class.
+
+=cut
+
+sub new_result {
+ my ($self, $values) = @_;
+ $self->throw_exception( "new_result needs a hash" )
+ unless (ref $values eq '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->result_source->result_class->new(\%new);
+ $obj->result_source($self->result_source) if $obj->can('result_source');
+ $obj;
+}
+
+=head2 create
+
+=head3 Arguments: (\%vals)
+
+Inserts a record into the resultset and returns the object.
+
+Effectively a shortcut for C<< ->new_result(\%vals)->insert >>.
+
+=cut
+
+sub create {
+ my ($self, $attrs) = @_;
+ $self->throw_exception( "create needs a hashref" ) unless ref $attrs eq 'HASH';
+ return $self->new_result($attrs)->insert;
+}
+
+=head2 find_or_create
+
+=head3 Arguments: (\%vals, \%attrs?)
+
+ $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.
+
+ 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 $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);
}
-=head1 Attributes
+=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' }
+ );
-The resultset takes various attributes that modify its behavior.
-Here's an overview of them:
+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:
=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
+
+=head3 Arguments: (arrayref)
+
+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