X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource.pm;h=f75f393a2cde87f3017b683e91fbc5d57789d45f;hb=d63c9e64;hp=cc865b4ebe10ec254b3c33ad5787a5ba63ba49bf;hpb=350e8d57bf21e4006e2a5e5c26648cb5ca4903ea;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index cc865b4..f75f393 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -10,6 +10,7 @@ use DBIx::Class::ResultSourceHandle; use DBIx::Class::Carp; use DBIx::Class::_Util 'UNRESOLVABLE_CONDITION'; +use SQL::Abstract 'is_literal_value'; use Devel::GlobalDestruction; use Try::Tiny; use List::Util 'first'; @@ -76,7 +77,7 @@ More specifically, the L base class pulls in the L component, which defines the L method. When called, C creates and stores an instance of -L. Luckily, to use tables as result +L. Luckily, to use tables as result sources, you don't need to remember any of this. Result sources representing select queries, or views, can also be @@ -85,7 +86,8 @@ created, see L for full details. =head2 Finding result source objects As mentioned above, a result source instance is created and stored for -you when you define a L. +you when you define a +L. You can retrieve the result source at runtime in the following ways: @@ -107,7 +109,13 @@ You can retrieve the result source at runtime in the following ways: =head1 METHODS -=pod +=head2 new + + $class->new(); + + $class->new({attribute_name => value}); + +Creates a new ResultSource object. Not normally called directly by end users. =cut @@ -142,6 +150,11 @@ sub new { $source->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...); + $source->add_columns( + 'col1' => { data_type => 'integer', is_nullable => 1, ... }, + 'col2' => { data_type => 'text', is_auto_increment => 1, ... }, + ); + Adds columns to the result source. If supplied colname => hashref pairs, uses the hashref as the L for that column. Repeated calls of this method will add more columns, not replace them. @@ -576,7 +589,7 @@ sub remove_column { shift->remove_columns(@_); } # DO NOT CHANGE THIS TO GLOB Defines one or more columns as primary key for this source. Must be called after L. -Additionally, defines a L +Additionally, defines a L named C. Note: you normally do want to define a primary key on your sources @@ -830,6 +843,7 @@ sub name_unique_constraint { my $name = $self->name; $name = $$name if (ref $name eq 'SCALAR'); + $name =~ s/ ^ [^\.]+ \. //x; # strip possible schema qualifier return join '_', $name, @$cols; } @@ -1173,6 +1187,17 @@ clause contents. sub from { die 'Virtual method!' } +=head2 source_info + +Stores a hashref of per-source metadata. No specific key names +have yet been standardized, the examples below are purely hypothetical +and don't actually accomplish anything on their own: + + __PACKAGE__->source_info({ + "_tablespace" => 'fast_disk_array_3', + "_engine" => 'InnoDB', + }); + =head2 schema =over 4 @@ -1314,10 +1339,11 @@ sub add_relationship { # Check foreign and self are right in cond if ( (ref $cond ||'') eq 'HASH') { - for (keys %$cond) { - $self->throw_exception("Keys of condition should be of form 'foreign.col', not '$_'") - if /\./ && !/^foreign\./; - } + $_ =~ /^foreign\./ or $self->throw_exception("Malformed relationship condition key '$_': must be prefixed with 'foreign.'") + for keys %$cond; + + $_ =~ /^self\./ or $self->throw_exception("Malformed relationship condition value '$_': must be prefixed with 'self.'") + for values %$cond; } my %rels = %{ $self->_relationships }; @@ -1546,6 +1572,67 @@ sub _identifying_column_set { return undef; } +sub _minimal_valueset_satisfying_constraint { + my $self = shift; + my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ }; + + $args->{columns_info} ||= $self->columns_info; + + my $vals = $self->storage->_extract_fixed_condition_columns( + $args->{values}, + ($args->{carp_on_nulls} ? 'consider_nulls' : undef ), + ); + + my $cols; + for my $col ($self->unique_constraint_columns($args->{constraint_name}) ) { + if( ! exists $vals->{$col} or ( $vals->{$col}||'' ) eq UNRESOLVABLE_CONDITION ) { + $cols->{missing}{$col} = undef; + } + elsif( ! defined $vals->{$col} ) { + $cols->{$args->{carp_on_nulls} ? 'undefined' : 'missing'}{$col} = undef; + } + else { + # we need to inject back the '=' as _extract_fixed_condition_columns + # will strip it from literals and values alike, resulting in an invalid + # condition in the end + $cols->{present}{$col} = { '=' => $vals->{$col} }; + } + + $cols->{fc}{$col} = 1 if ( + ( ! $cols->{missing} or ! exists $cols->{missing}{$col} ) + and + keys %{ $args->{columns_info}{$col}{_filter_info} || {} } + ); + } + + $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', missing values for column(s): %s", + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{missing}} ), + ) ) if $cols->{missing}; + + $self->throw_exception( sprintf ( + "Unable to satisfy requested constraint '%s', FilterColumn values not usable for column(s): %s", + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{fc}}), + )) if $cols->{fc}; + + if ( + $cols->{undefined} + and + !$ENV{DBIC_NULLABLE_KEY_NOWARN} + ) { + carp_unique ( sprintf ( + "NULL/undef values supplied for requested unique constraint '%s' (NULL " + . 'values in column(s): %s). This is almost certainly not what you wanted, ' + . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.', + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{undefined}}), + )); + } + + return { map { %{ $cols->{$_}||{} } } qw(present undefined) }; +} + # Returns the {from} structure used to express JOIN conditions sub _resolve_join { my ($self, $join, $alias, $seen, $jpath, $parent_force_left) = @_; @@ -1669,6 +1756,11 @@ sub _pk_depends_on { return 1; } +sub resolve_condition { + carp 'resolve_condition is a private method, stop calling it'; + shift->_resolve_condition (@_); +} + sub _resolve_condition { # carp_unique sprintf # '_resolve_condition is a private method, and moreover is about to go ' @@ -1711,17 +1803,14 @@ sub _resolve_condition { } } - $self->throw_exception('No practical way to resolve a relationship between two structures') - if $is_objlike[0] and $is_objlike[1]; - my $args = { condition => $cond, # where-is-waldo block guesses relname, then further down we override it if available ( - $is_objlike[1] ? ( rel_name => $res_args[0], self_alias => $res_args[0], foreign_alias => 'me', self_resultobj => $res_args[1] ) - : $is_objlike[0] ? ( rel_name => $res_args[1], self_alias => 'me', foreign_alias => $res_args[1], foreign_resultobj => $res_args[0] ) - : ( rel_name => $res_args[0], self_alias => $res_args[1], foreign_alias => $res_args[0] ) + $is_objlike[1] ? ( rel_name => $res_args[0], self_alias => $res_args[0], foreign_alias => 'me', self_result_object => $res_args[1] ) + : $is_objlike[0] ? ( rel_name => $res_args[1], self_alias => 'me', foreign_alias => $res_args[1], foreign_values => $res_args[0] ) + : ( rel_name => $res_args[0], self_alias => $res_args[1], foreign_alias => $res_args[0] ) ), ( $rel_name ? ( rel_name => $rel_name ) : () ), @@ -1738,7 +1827,7 @@ sub _resolve_condition { # _resolve_relationship_condition always returns qualified cols even in the # case of join_free_condition, but nothing downstream expects this - if (ref $res[0] eq 'HASH' and ($is_objlike[0] or $is_objlike[1]) ) { + if ($rc->{join_free_condition} and ref $res[0] eq 'HASH') { $res[0] = { map { ($_ =~ /\.(.+)/) => $res[0]{$_} } keys %{$res[0]} @@ -1762,19 +1851,23 @@ Internals::SvREADONLY($UNRESOLVABLE_CONDITION => 1); # metadata # ## self-explanatory API, modeled on the custom cond coderef: -# rel_name -# foreign_alias -# foreign_resultobj -# self_alias -# self_resultobj -# require_join_free_condition -# infer_values_based_on (optional, mandatory hashref argument) -# condition (optional, derived from $self->rel_info(rel_name)) +# rel_name => (scalar) +# foreign_alias => (scalar) +# foreign_values => (either not supplied, or a hashref, or a foreign ResultObject (to be ->get_columns()ed), or plain undef ) +# self_alias => (scalar) +# self_result_object => (either not supplied or a result object) +# require_join_free_condition => (boolean, throws on failure to construct a JF-cond) +# infer_values_based_on => (either not supplied or a hashref, implies require_join_free_condition) +# condition => (sqla cond struct, optional, defeaults to from $self->rel_info(rel_name)->{cond}) # ## returns a hash -# condition -# join_free_condition (maybe undef) -# inferred_values (maybe undef, always complete or empty) +# condition => (a valid *likely fully qualified* sqla cond structure) +# identity_map => (a hashref of foreign-to-self *unqualified* column equality names) +# join_free_condition => (a valid *fully qualified* sqla cond structure, maybe unset) +# inferred_values => (in case of an available join_free condition, this is a hashref of +# *unqualified* column/value *EQUALITY* pairs, representing an amalgamation +# of the JF-cond parse and infer_values_based_on +# always either complete or unset) # sub _resolve_relationship_condition { my $self = shift; @@ -1786,13 +1879,23 @@ sub _resolve_relationship_condition { if !defined $args->{$_} or length ref $args->{$_}; } + $self->throw_exception("Arguments 'self_alias' and 'foreign_alias' may not be identical") + if $args->{self_alias} eq $args->{foreign_alias}; + +# TEMP my $exception_rel_id = "relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}'"; - my $rel_info = $self->relationship_info($args->{rel_name}); - # or $self->throw_exception( "No such $exception_rel_id" ); + my $rel_info = $self->relationship_info($args->{rel_name}) +# TEMP +# or $self->throw_exception( "No such $exception_rel_id" ); + or carp_unique("Requesting resolution on non-existent relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}': fix your code *soon*, as it will break with the next major version"); + +# TEMP + $exception_rel_id = "relationship '$rel_info->{_original_name}' on source '@{[ $self->source_name ]}'" + if $rel_info and exists $rel_info->{_original_name}; - $self->throw_exception("No practical way to resolve $exception_rel_id between two objects") - if defined $args->{self_resultobj} and defined $args->{foreign_resultobj}; + $self->throw_exception("No practical way to resolve $exception_rel_id between two data structures") + if exists $args->{self_result_object} and exists $args->{foreign_values}; $self->throw_exception( "Argument to infer_values_based_on must be a hash" ) if exists $args->{infer_values_based_on} and ref $args->{infer_values_based_on} ne 'HASH'; @@ -1801,29 +1904,46 @@ sub _resolve_relationship_condition { $args->{condition} ||= $rel_info->{cond}; - if (exists $args->{self_resultobj}) { - if (defined blessed $args->{self_resultobj}) { -# $self->throw_exception( "Object '$args->{self_resultobj}' must be of class '@{[ $self->result_class ]}'" ) -# unless $args->{self_resultobj}->isa($self->result_class); - } - else { - $args->{self_resultobj} = DBIx::Class::Core->new({ - -result_source => $self, - %{ $args->{self_resultobj}||{} } - }); - } - } + $self->throw_exception( "Argument 'self_result_object' must be an object of class '@{[ $self->result_class ]}'" ) + if ( + exists $args->{self_result_object} + and + ( ! defined blessed $args->{self_result_object} or ! $args->{self_result_object}->isa($self->result_class) ) + ) + ; + +#TEMP + my $rel_rsrc;# = $self->related_source($args->{rel_name}); + + if (exists $args->{foreign_values}) { +# TEMP + $rel_rsrc ||= $self->related_source($args->{rel_name}); - if (exists $args->{foreign_resultobj}) { - if (defined blessed $args->{foreign_resultobj}) { -# $self->throw_exception( "Object '$args->{foreign_resultobj}' must be of class '$rel_info->{class}'" ) -# unless $args->{foreign_resultobj}->isa($rel_info->{class}); + if (defined blessed $args->{foreign_values}) { + + $self->throw_exception( "Objects supplied as 'foreign_values' ($args->{foreign_values}) must inherit from DBIx::Class::Row" ) + unless $args->{foreign_values}->isa('DBIx::Class::Row'); + + carp_unique( + "Objects supplied as 'foreign_values' ($args->{foreign_values}) " + . "usually should inherit from the related ResultClass ('@{[ $rel_rsrc->result_class ]}'), " + . "perhaps you've made a mistake invoking the condition resolver?" + ) unless $args->{foreign_values}->isa($rel_rsrc->result_class); + + $args->{foreign_values} = { $args->{foreign_values}->get_columns }; + } + elsif (! defined $args->{foreign_values} or ref $args->{foreign_values} eq 'HASH') { + my $ri = { map { $_ => 1 } $rel_rsrc->relationships }; + my $ci = $rel_rsrc->columns_info; + ! exists $ci->{$_} and ! exists $ri->{$_} and $self->throw_exception( + "Key '$_' supplied as 'foreign_values' is not a column on related source '@{[ $rel_rsrc->source_name ]}'" + ) for keys %{ $args->{foreign_values} ||= {} }; } else { - $args->{foreign_resultobj} = DBIx::Class::Core->new({ - -result_source => $self->related_source($args->{rel_name}), - %{ $args->{foreign_resultobj}||{} } - }); + $self->throw_exception( + "Argument 'foreign_values' must be either an object inheriting from '@{[ $rel_rsrc->result_class ]}', " + . "or a hash reference, or undef" + ); } } @@ -1838,20 +1958,20 @@ sub _resolve_relationship_condition { foreign_alias => $args->{foreign_alias}, ( map { (exists $args->{$_}) ? ( $_ => $args->{$_} ) : () } - qw( self_resultobj foreign_resultobj ) + qw( self_result_object foreign_values ) ), }; # legacy - never remove these!!! $cref_args->{foreign_relname} = $cref_args->{rel_name}; - $cref_args->{self_rowobj} = $cref_args->{self_resultobj} - if exists $cref_args->{self_resultobj}; + $cref_args->{self_rowobj} = $cref_args->{self_result_object} + if exists $cref_args->{self_result_object}; ($ret->{condition}, $ret->{join_free_condition}, my @extra) = $args->{condition}->($cref_args); - # FIXME sanity check - carp_unique('A custom condition coderef can return at most 2 conditions: extra return values discarded') + # sanity check + $self->throw_exception("A custom condition coderef can return at most 2 conditions, but $exception_rel_id returned extra values: @extra") if @extra; if (my $jfc = $ret->{join_free_condition}) { @@ -1860,12 +1980,15 @@ sub _resolve_relationship_condition { "The join-free condition returned for $exception_rel_id must be a hash reference" ) unless ref $jfc eq 'HASH'; +# TEMP + $rel_rsrc ||= $self->related_source($args->{rel_name}); + my ($joinfree_alias, $joinfree_source); - if (defined $args->{self_resultobj}) { + if (defined $args->{self_result_object}) { $joinfree_alias = $args->{foreign_alias}; - $joinfree_source = $self->related_source($args->{rel_name}); + $joinfree_source = $rel_rsrc; } - elsif (defined $args->{foreign_resultobj}) { + elsif (defined $args->{foreign_values}) { $joinfree_alias = $args->{self_alias}; $joinfree_source = $self; } @@ -1880,11 +2003,26 @@ sub _resolve_relationship_condition { $joinfree_source->columns }; - $fq_col_list->{$_} or $self->throw_exception ( + exists $fq_col_list->{$_} or $self->throw_exception ( "The join-free condition returned for $exception_rel_id may only " - . 'contain keys that are fully qualified column names of the corresponding source' + . 'contain keys that are fully qualified column names of the corresponding source ' + . "(it returned '$_')" ) for keys %$jfc; + ( + length ref $_ + and + defined blessed($_) + and + $_->isa('DBIx::Class::Row') + and + $self->throw_exception ( + "The join-free condition returned for $exception_rel_id may not " + . 'contain result objects as values - perhaps instead of invoking ' + . '->$something you meant to return ->get_column($something)' + ) + ) for values %$jfc; + } } elsif (ref $args->{condition} eq 'HASH') { @@ -1907,45 +2045,38 @@ sub _resolve_relationship_condition { push @l_cols, $lc; } - # construct the crosstable condition - $ret->{condition} = { map - {( "$args->{foreign_alias}.$f_cols[$_]" => { -ident => "$args->{self_alias}.$l_cols[$_]" } )} - (0..$#f_cols) + # construct the crosstable condition and the identity map + for (0..$#f_cols) { + $ret->{condition}{"$args->{foreign_alias}.$f_cols[$_]"} = { -ident => "$args->{self_alias}.$l_cols[$_]" }; + $ret->{identity_map}{$l_cols[$_]} = $f_cols[$_]; }; - if (exists $args->{self_resultobj} or exists $args->{foreign_resultobj}) { - - my ($obj, $obj_alias, $plain_alias, $obj_cols, $plain_cols) = defined $args->{self_resultobj} - ? ( @{$args}{qw( self_resultobj self_alias foreign_alias )}, \@l_cols, \@f_cols ) - : ( @{$args}{qw( foreign_resultobj foreign_alias self_alias )}, \@f_cols, \@l_cols ) - ; - - for my $i (0..$#$obj_cols) { - - if ( - defined $args->{self_resultobj} - and - ! $obj->has_column_loaded($obj_cols->[$i]) - ) { + if ($args->{foreign_values}) { + $ret->{join_free_condition}{"$args->{self_alias}.$l_cols[$_]"} = $args->{foreign_values}{$f_cols[$_]} + for 0..$#f_cols; + } + elsif (defined $args->{self_result_object}) { + for my $i (0..$#l_cols) { + if ( $args->{self_result_object}->has_column_loaded($l_cols[$i]) ) { + $ret->{join_free_condition}{"$args->{foreign_alias}.$f_cols[$i]"} = $args->{self_result_object}->get_column($l_cols[$i]); + } + else { $self->throw_exception(sprintf "Unable to resolve relationship '%s' from object '%s': column '%s' not " . 'loaded from storage (or not passed to new() prior to insert()). You ' . 'probably need to call ->discard_changes to get the server-side defaults ' . 'from the database.', $args->{rel_name}, - $obj, - $obj_cols->[$i], - ) if $obj->in_storage; + $args->{self_result_object}, + $l_cols[$i], + ) if $args->{self_result_object}->in_storage; # FIXME - temporarly force-override delete $args->{require_join_free_condition}; $ret->{join_free_condition} = UNRESOLVABLE_CONDITION; last; } - else { - $ret->{join_free_condition}{"$plain_alias.$plain_cols->[$i]"} = $obj->get_column($obj_cols->[$i]); - } } } } @@ -1969,8 +2100,8 @@ sub _resolve_relationship_condition { { $self->_resolve_relationship_condition({ %$args, condition => $_ }) } @{$args->{condition}} ) { - $self->throw_exception('Either all or none of the OR-condition members can resolve to a join-free condition') - if $ret->{join_free_condition} and ! $subcond->{join_free_condition}; + $self->throw_exception('Either all or none of the OR-condition members must resolve to a join-free condition') + if ( $ret and ( $ret->{join_free_condition} xor $subcond->{join_free_condition} ) ); $subcond->{$_} and push @{$ret->{$_}}, $subcond->{$_} for (qw(condition join_free_condition)); } @@ -1986,11 +2117,13 @@ sub _resolve_relationship_condition { ( ! $ret->{join_free_condition} or $ret->{join_free_condition} eq UNRESOLVABLE_CONDITION ) ); + my $storage = $self->schema->storage; + # we got something back - sanity check and infer values if we can my @nonvalues; if ( my $jfc = $ret->{join_free_condition} and $ret->{join_free_condition} ne UNRESOLVABLE_CONDITION ) { - my $jfc_eqs = $self->schema->storage->_extract_fixed_condition_columns($jfc, 'consider_nulls'); + my $jfc_eqs = $storage->_extract_fixed_condition_columns($jfc, 'consider_nulls'); if (keys %$jfc_eqs) { @@ -2026,7 +2159,65 @@ sub _resolve_relationship_condition { for keys %{$args->{infer_values_based_on}}; } - $ret + # add the identities based on the main condition + # (may already be there, since easy to calculate on the fly in the HASH case) + if ( ! $ret->{identity_map} ) { + + my $col_eqs = $storage->_extract_fixed_condition_columns($ret->{condition}); + + my $colinfos; + for my $lhs (keys %$col_eqs) { + + next if $col_eqs->{$lhs} eq UNRESOLVABLE_CONDITION; + +# TEMP + $rel_rsrc ||= $self->related_source($args->{rel_name}); + + # there is no way to know who is right and who is left in a cref + # therefore a full blown resolution call, and figure out the + # direction a bit further below + $colinfos ||= $storage->_resolve_column_info([ + { -alias => $args->{self_alias}, -rsrc => $self }, + { -alias => $args->{foreign_alias}, -rsrc => $rel_rsrc }, + ]); + + next unless $colinfos->{$lhs}; # someone is engaging in witchcraft + + if ( my $rhs_ref = is_literal_value( $col_eqs->{$lhs} ) ) { + + if ( + $colinfos->{$rhs_ref->[0]} + and + $colinfos->{$lhs}{-source_alias} ne $colinfos->{$rhs_ref->[0]}{-source_alias} + ) { + ( $colinfos->{$lhs}{-source_alias} eq $args->{self_alias} ) + ? ( $ret->{identity_map}{$colinfos->{$lhs}{-colname}} = $colinfos->{$rhs_ref->[0]}{-colname} ) + : ( $ret->{identity_map}{$colinfos->{$rhs_ref->[0]}{-colname}} = $colinfos->{$lhs}{-colname} ) + ; + } + } + elsif ( + $col_eqs->{$lhs} =~ /^ ( \Q$args->{self_alias}\E \. .+ ) /x + and + ($colinfos->{$1}||{})->{-result_source} == $rel_rsrc + ) { + my ($lcol, $rcol) = map + { $colinfos->{$_}{-colname} } + ( $lhs, $1 ) + ; + carp_unique( + "The $exception_rel_id specifies equality of column '$lcol' and the " + . "*VALUE* '$rcol' (you did not use the { -ident => ... } operator)" + ); + } + } + } + + # FIXME - temporary, to fool the idiotic check in SQLMaker::_join_condition + $ret->{condition} = { -and => [ $ret->{condition} ] } + unless $ret->{condition} eq UNRESOLVABLE_CONDITION; + + $ret; } =head2 related_source @@ -2115,6 +2306,9 @@ sub handle { my $global_phase_destroy; sub DESTROY { + ### NO detected_reinvoked_destructor check + ### This code very much relies on being called multuple times + return if $global_phase_destroy ||= in_global_destruction; ###### @@ -2182,25 +2376,6 @@ sub throw_exception { ; } -=head2 source_info - -Stores a hashref of per-source metadata. No specific key names -have yet been standardized, the examples below are purely hypothetical -and don't actually accomplish anything on their own: - - __PACKAGE__->source_info({ - "_tablespace" => 'fast_disk_array_3', - "_engine" => 'InnoDB', - }); - -=head2 new - - $class->new(); - - $class->new({attribute_name => value}); - -Creates a new ResultSource object. Not normally called directly by end users. - =head2 column_info_from_storage =over @@ -2217,14 +2392,16 @@ Enables the on-demand automatic loading of the above column metadata from storage as necessary. This is *deprecated*, and should not be used. It will be removed before 1.0. +=head1 FURTHER QUESTIONS? -=head1 AUTHOR AND CONTRIBUTORS - -See L and L in DBIx::Class +Check the list of L. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -You may distribute this code under the same terms as Perl itself. +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut