use strict;
use warnings;
+use base qw/DBIx::Class::ResultSource::RowParser DBIx::Class/;
+
use DBIx::Class::ResultSet;
use DBIx::Class::ResultSourceHandle;
-use DBIx::Class::Exception;
use DBIx::Class::Carp;
+use DBIx::Class::_Util 'is_literal_value';
use Devel::GlobalDestruction;
use Try::Tiny;
use List::Util 'first';
use Scalar::Util qw/blessed weaken isweak/;
-use namespace::clean;
-use base qw/DBIx::Class/;
+use namespace::clean;
__PACKAGE__->mk_group_accessors(simple => qw/
source_name name source_info
=head2 Finding result source objects
As mentioned above, a result source instance is created and stored for
-you when you define a L<Result Class|DBIx::Class::Manual::Glossary/Result Class>.
+you when you define a L<result class|DBIx::Class::Manual::Glossary/Result class>.
You can retrieve the result source at runtime in the following ways:
=item From a Result object:
- $row->result_source;
+ $result->result_source;
=item From a ResultSet object:
{ is_nullable => 1 }
-Set this to a true value for a columns that is allowed to contain NULL
+Set this to a true value for a column that is allowed to contain NULL
values, default is false. This is currently only used to create tables
from your schema, see L<DBIx::Class::Schema/deploy>.
}
else {
$self->throw_exception( sprintf (
- "No such column '%s' on source %s",
+ "No such column '%s' on source '%s'",
$_,
- $self->source_name,
+ $self->source_name || $self->name || 'Unknown source...?',
));
}
}
sub set_primary_key {
my ($self, @cols) = @_;
- # check if primary key columns are valid columns
- foreach my $col (@cols) {
- $self->throw_exception("No such column $col on table " . $self->name)
- unless $self->has_column($col);
+
+ my $colinfo = $self->columns_info(\@cols);
+ for my $col (@cols) {
+ carp_unique(sprintf (
+ "Primary key of source '%s' includes the column '%s' which has its "
+ . "'is_nullable' attribute set to true. This is a mistake and will cause "
+ . 'various Result-object operations to fail',
+ $self->source_name || $self->name || 'Unknown source...?',
+ $col,
+ )) if $colinfo->{$col}{is_nullable};
}
+
$self->_primaries(\@cols);
$self->add_unique_constraint(primary => \@cols);
# a helper method that will automatically die with a descriptive message if
# no pk is defined on the source in question. For internal use to save
# on if @pks... boilerplate
-sub _pri_cols {
+sub _pri_cols_or_die {
my $self = shift;
my @pcols = $self->primary_columns
or $self->throw_exception (sprintf(
return @pcols;
}
+# same as above but mandating single-column PK (used by relationship condition
+# inference)
+sub _single_pri_col_or_die {
+ my $self = shift;
+ my ($pri, @too_many) = $self->_pri_cols_or_die;
+
+ $self->throw_exception( sprintf(
+ "Operation requires a single-column primary key declared on '%s'",
+ $self->source_name || $self->result_class || $self->name || 'Unknown source...?',
+ )) if @too_many;
+ return $pri;
+}
+
+
=head2 sequence
Manually define the correct sequence for your table, to avoid the overhead
=back
- my @relnames = $source->relationships();
+ my @rel_names = $source->relationships();
Returns all relationship names for this source.
=cut
sub relationship_info {
- my ($self, $rel) = @_;
- return $self->_relationships->{$rel};
+ #my ($self, $rel) = @_;
+ return shift->_relationships->{+shift};
}
=head2 has_relationship
=cut
sub has_relationship {
- my ($self, $rel) = @_;
- return exists $self->_relationships->{$rel};
+ #my ($self, $rel) = @_;
+ return exists shift->_relationships->{+shift};
}
=head2 reverse_relationship_info
my $stripped_cond = $self->__strip_relcond ($rel_info->{cond});
- my $rsrc_schema_moniker = $self->source_name
- if try { $self->schema };
+ my $registered_source_name = $self->source_name;
# this may be a partial schema or something else equally esoteric
- my $other_rsrc = try { $self->related_source($rel) }
- or return $ret;
+ my $other_rsrc = $self->related_source($rel);
# Get all the relationships for that source that related to this source
# whose foreign column set are our self columns on $rel and whose self
my $roundtrip_rsrc = try { $other_rsrc->related_source($other_rel) }
or next;
- if ($rsrc_schema_moniker and try { $roundtrip_rsrc->schema } ) {
- next unless $rsrc_schema_moniker eq $roundtrip_rsrc->source_name;
+ if ($registered_source_name) {
+ next if $registered_source_name ne ($roundtrip_rsrc->source_name || '')
}
else {
- next unless $self->result_class eq $roundtrip_rsrc->result_class;
+ next if $self->result_class ne $roundtrip_rsrc->result_class;
}
my $other_rel_info = $other_rsrc->relationship_info($other_rel);
,
-join_path => [@$jpath, { $join => $as } ],
-is_single => (
- $rel_info->{attrs}{accessor}
- &&
+ (! $rel_info->{attrs}{accessor})
+ or
first { $rel_info->{attrs}{accessor} eq $_ } (qw/single filter/)
),
-alias => $as,
- -relation_chain_depth => $seen->{-relation_chain_depth} || 0,
+ -relation_chain_depth => ( $seen->{-relation_chain_depth} || 0 ) + 1,
},
scalar $self->_resolve_condition($rel_info->{cond}, $as, $alias, $join)
];
return 1;
}
-sub resolve_condition {
- carp 'resolve_condition is a private method, stop calling it';
- my $self = shift;
- $self->_resolve_condition (@_);
+sub _resolve_condition {
+# carp_unique sprintf
+# '_resolve_condition is a private method, and moreover is about to go '
+# . 'away. Please contact the development team at %s if you believe you '
+# . 'have a genuine use for this method, in order to discuss alternatives.',
+# DBIx::Class::_ENV_::HELP_URL,
+# ;
+
+#######################
+### API Design? What's that...? (a backwards compatible shim, kill me now)
+
+ my ($self, $cond, @res_args, $rel_name);
+
+ # we *SIMPLY DON'T KNOW YET* which arg is which, yay
+ ($self, $cond, $res_args[0], $res_args[1], $rel_name) = @_;
+
+ # assume that an undef is an object-like unset (set_from_related(undef))
+ my @is_objlike = map { ! defined $_ or length ref $_ } (@res_args);
+
+ # turn objlike into proper objects for saner code further down
+ for (0,1) {
+ next unless $is_objlike[$_];
+
+ if ( defined blessed $res_args[$_] ) {
+
+ # but wait - there is more!!! WHAT THE FUCK?!?!?!?!
+ if ($res_args[$_]->isa('DBIx::Class::ResultSet')) {
+ carp('Passing a resultset for relationship resolution makes no sense - invoking __gremlins__');
+ $is_objlike[$_] = 0;
+ $res_args[$_] = '__gremlins__';
+ }
+ }
+ else {
+ $res_args[$_] ||= {};
+
+ $self->throw_exception("Unsupported object-like structure encountered: $res_args[$_]")
+ unless ref $res_args[$_] eq 'HASH';
+
+ # hate everywhere
+ $res_args[$_] = $self->relationship_info($rel_name)->{source}->result_class->new($res_args[$_]);
+ }
+ }
+
+ $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] )
+ ),
+
+ ( $rel_name ? ( rel_name => $rel_name ) : () ),
+ };
+#######################
+
+ # now it's fucking easy isn't it?!
+ my @res = $self->_resolve_relationship_condition( $args );
+
+ # FIXME - this is also insane, but just be consistent for now
+ # _resolve_relationship_condition always returns qualified cols
+ # even in the case of objects, but nothing downstream expects this
+ if (ref $res[0] eq 'HASH' and ($is_objlike[0] or $is_objlike[1]) ) {
+ $res[0] = { map
+ { ($_ =~ /\.(.+)/) => $res[0]{$_} }
+ keys %{$res[0]}
+ };
+ }
+
+ # more legacy
+ return wantarray ? @res : $res[0];
}
our $UNRESOLVABLE_CONDITION = \ '1 = 0';
# Resolves the passed condition to a concrete query fragment and a flag
# indicating whether this is a cross-table condition. Also an optional
-# list of non-triviail values (notmally conditions) returned as a part
+# list of non-trivial values (normally conditions) returned as a part
# of a joinfree condition hash
-sub _resolve_condition {
- my ($self, $cond, $as, $for, $rel_name) = @_;
+sub _resolve_relationship_condition {
+ my $self = shift;
+
+ # self-explanatory API, modeled on the custom cond coderef:
+ # condition
+ # rel_name
+ # foreign_alias
+ # foreign_resultobj
+ # self_alias
+ # self_resultobj
+ my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ };
+
+ for ( qw( rel_name self_alias foreign_alias ) ) {
+ $self->throw_exception("Mandatory attribute '$_' is not a plain string")
+ if !defined $args->{$_} or length ref $args->{$_};
+ }
+
+ $self->throw_exception('No practical way to resolve a relationship between two objects')
+ if defined $args->{self_resultobj} and defined $args->{foreign_resultobj};
- my $obj_rel = !!blessed $for;
+ $args->{condition} ||= $self->relationship_info($args->{rel_name})->{cond};
- if (ref $cond eq 'CODE') {
- my $relalias = $obj_rel ? 'me' : $as;
+ if (ref $args->{condition} eq 'CODE') {
- my ($crosstable_cond, $joinfree_cond) = $cond->({
- self_alias => $obj_rel ? $as : $for,
- foreign_alias => $relalias,
+ my $cref_args = {
+ rel_name => $args->{rel_name},
self_resultsource => $self,
- foreign_relname => $rel_name || ($obj_rel ? $as : $for),
- self_rowobj => $obj_rel ? $for : undef
- });
+ self_alias => $args->{self_alias},
+ foreign_alias => $args->{foreign_alias},
+ self_resultobj => $args->{self_resultobj},
+ foreign_resultobj => $args->{foreign_resultobj},
+ };
+
+ # legacy - never remove these!!!
+ $cref_args->{foreign_relname} = $cref_args->{rel_name};
+ $cref_args->{self_rowobj} = $cref_args->{self_resultobj};
+
+ my ($crosstable_cond, $joinfree_cond, @extra) = $args->{condition}->($cref_args);
- my $cond_cols;
+ # FIXME sanity check
+ carp_unique('A custom condition coderef can return at most 2 conditions: extra return values discarded')
+ if @extra;
+
+ my @nonvalue_cols;
if ($joinfree_cond) {
+ my ($joinfree_alias, $joinfree_source);
+ if (defined $args->{self_resultobj}) {
+ $joinfree_alias = $args->{foreign_alias};
+ $joinfree_source = $self->related_source($args->{rel_name});
+ }
+ elsif (defined $args->{foreign_resultobj}) {
+ $joinfree_alias = $args->{self_alias};
+ $joinfree_source = $self;
+ }
+
# FIXME sanity check until things stabilize, remove at some point
$self->throw_exception (
- "A join-free condition returned for relationship '$rel_name' without a row-object to chain from"
- ) unless $obj_rel;
+ "A join-free condition returned for relationship '$args->{rel_name}' without a result object to chain from"
+ ) unless $joinfree_alias;
+
+ my $fq_col_list = { map { ( "$joinfree_alias.$_" => 1 ) } $joinfree_source->columns };
# FIXME another sanity check
if (
ref $joinfree_cond ne 'HASH'
or
- first { $_ !~ /^\Q$relalias.\E.+/ } keys %$joinfree_cond
+ grep { ! $fq_col_list->{$_} } keys %$joinfree_cond
) {
$self->throw_exception (
- "The join-free condition returned for relationship '$rel_name' must be a hash "
- .'reference with all keys being valid columns on the related result source'
+ "The join-free condition returned for relationship '$args->{rel_name}' must be a hash "
+ .'reference with all keys being fully qualified column names of the corresponding source'
);
}
- # normalize
- for (values %$joinfree_cond) {
- $_ = $_->{'='} if (
- ref $_ eq 'HASH'
- and
- keys %$_ == 1
- and
- exists $_->{'='}
- );
- }
+ # see which parts of the joinfree cond are *NOT* foreign-source-column equalities
+ my $joinfree_cond_equality_columns = { map
+ {( $_ => 1 )}
+ @{ $self->schema->storage->_extract_fixed_condition_columns($joinfree_cond) }
+ };
+ @nonvalue_cols = map
+ { $_ =~ /^\Q$joinfree_alias.\E(.+)/ }
+ grep
+ { ! $joinfree_cond_equality_columns->{$_} }
+ keys %$joinfree_cond;
- # see which parts of the joinfree cond are conditionals
- my $relcol_list = { map { $_ => 1 } $self->related_source($rel_name)->columns };
+ return ($joinfree_cond, 0, (@nonvalue_cols ? \@nonvalue_cols : undef));
+ }
+ else {
+ return ($crosstable_cond, 1);
+ }
+ }
+ elsif (ref $args->{condition} eq 'HASH') {
- for my $c (keys %$joinfree_cond) {
- my ($colname) = $c =~ /^ (?: \Q$relalias.\E )? (.+)/x;
+ # the condition is static - use parallel arrays
+ # for a "pivot" depending on which side of the
+ # rel did we get as an object
+ my (@f_cols, @l_cols);
+ for my $fc (keys %{$args->{condition}}) {
+ my $lc = $args->{condition}{$fc};
- unless ($relcol_list->{$colname}) {
- push @$cond_cols, $colname;
- next;
- }
+ # FIXME STRICTMODE should probably check these are valid columns
+ $fc =~ s/^foreign\.// ||
+ $self->throw_exception("Invalid rel cond key '$fc'");
- if (
- ref $joinfree_cond->{$c}
- and
- ref $joinfree_cond->{$c} ne 'SCALAR'
- and
- ref $joinfree_cond->{$c} ne 'REF'
- ) {
- push @$cond_cols, $colname;
- next;
- }
- }
+ $lc =~ s/^self\.// ||
+ $self->throw_exception("Invalid rel cond val '$lc'");
- return wantarray ? ($joinfree_cond, 0, $cond_cols) : $joinfree_cond;
+ push @f_cols, $fc;
+ push @l_cols, $lc;
}
- else {
- return wantarray ? ($crosstable_cond, 1) : $crosstable_cond;
+
+ # plain values
+ if (! defined $args->{self_resultobj} and ! defined $args->{foreign_resultobj}) {
+ return ( { map
+ {( "$args->{foreign_alias}.$f_cols[$_]" => { -ident => "$args->{self_alias}.$l_cols[$_]" } )}
+ (0..$#f_cols)
+ }, 1 ); # is crosstable
}
- }
- elsif (ref $cond eq 'HASH') {
- my %ret;
- foreach my $k (keys %{$cond}) {
- my $v = $cond->{$k};
- # XXX should probably check these are valid columns
- $k =~ s/^foreign\.// ||
- $self->throw_exception("Invalid rel cond key ${k}");
- $v =~ s/^self\.// ||
- $self->throw_exception("Invalid rel cond val ${v}");
- if (ref $for) { # Object
- #warn "$self $k $for $v";
- unless ($for->has_column_loaded($v)) {
- if ($for->in_storage) {
- $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.',
- $as,
- $for,
- $v,
- );
- }
+ else {
+
+ my $cond;
+
+ 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])) {
+
+ $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;
+
return $UNRESOLVABLE_CONDITION;
}
- $ret{$k} = $for->get_column($v);
- #$ret{$k} = $for->get_column($v) if $for->has_column_loaded($v);
- #warn %ret;
- } elsif (!defined $for) { # undef, i.e. "no object"
- $ret{$k} = undef;
- } elsif (ref $as eq 'HASH') { # reverse hashref
- $ret{$v} = $as->{$k};
- } elsif (ref $as) { # reverse object
- $ret{$v} = $as->get_column($k);
- } elsif (!defined $as) { # undef, i.e. "no reverse object"
- $ret{$v} = undef;
- } else {
- $ret{"${as}.${k}"} = { -ident => "${for}.${v}" };
+ else {
+ $cond->{"$plain_alias.$plain_cols->[$i]"} = $obj->get_column($obj_cols->[$i]);
+ }
}
- }
- return wantarray
- ? ( \%ret, ($obj_rel || !defined $as || ref $as) ? 0 : 1 )
- : \%ret
- ;
+ return ($cond, 0); # joinfree
+ }
}
- elsif (ref $cond eq 'ARRAY') {
- my (@ret, $crosstable);
- for (@$cond) {
- my ($cond, $crosstab) = $self->_resolve_condition($_, $as, $for, $rel_name);
- push @ret, $cond;
- $crosstable ||= $crosstab;
+ elsif (ref $args->{condition} eq 'ARRAY') {
+ if (@{$args->{condition}} == 0) {
+ return $UNRESOLVABLE_CONDITION;
+ }
+ elsif (@{$args->{condition}} == 1) {
+ return $self->_resolve_relationship_condition({
+ %$args,
+ condition => $args->{condition}[0],
+ });
+ }
+ else {
+ # FIXME - we are discarding nonvalues here... likely incorrect...
+ # then again - the entire thing is an OR, so we *can't* use
+ # the values anyway
+ # Return a hard crosstable => 1 to ensure nothing tries to use
+ # the result in such manner
+ my @ret;
+ for (@{$args->{condition}}) {
+ my ($cond) = $self->_resolve_relationship_condition({
+ %$args,
+ condition => $_,
+ });
+ push @ret, $cond;
+ }
+ return (\@ret, 1); # forced cross-tab
}
- return wantarray ? (\@ret, $crosstable) : \@ret;
}
else {
- $self->throw_exception ("Can't handle condition $cond for relationship '$rel_name' yet :(");
- }
-}
-
-# Accepts one or more relationships for the current source and returns an
-# array of column names for each of those relationships. Column names are
-# prefixed relative to the current source, in accordance with where they appear
-# in the supplied relationships.
-sub _resolve_prefetch {
- my ($self, $pre, $alias, $alias_map, $order, $collapse, $pref_path) = @_;
- $pref_path ||= [];
-
- if (not defined $pre or not length $pre) {
- return ();
- }
- elsif( ref $pre eq 'ARRAY' ) {
- return
- map { $self->_resolve_prefetch( $_, $alias, $alias_map, $order, $collapse, [ @$pref_path ] ) }
- @$pre;
- }
- elsif( ref $pre eq 'HASH' ) {
- my @ret =
- map {
- $self->_resolve_prefetch($_, $alias, $alias_map, $order, $collapse, [ @$pref_path ] ),
- $self->related_source($_)->_resolve_prefetch(
- $pre->{$_}, "${alias}.$_", $alias_map, $order, $collapse, [ @$pref_path, $_] )
- } keys %$pre;
- return @ret;
+ $self->throw_exception ("Can't handle condition $args->{condition} for relationship '$args->{rel_name}' yet :(");
}
- elsif( ref $pre ) {
- $self->throw_exception(
- "don't know how to resolve prefetch reftype ".ref($pre));
- }
- else {
- my $p = $alias_map;
- $p = $p->{$_} for (@$pref_path, $pre);
-
- $self->throw_exception (
- "Unable to resolve prefetch '$pre' - join alias map does not contain an entry for path: "
- . join (' -> ', @$pref_path, $pre)
- ) if (ref $p->{-join_aliases} ne 'ARRAY' or not @{$p->{-join_aliases}} );
-
- my $as = shift @{$p->{-join_aliases}};
-
- my $rel_info = $self->relationship_info( $pre );
- $self->throw_exception( $self->source_name . " has no such relationship '$pre'" )
- unless $rel_info;
- my $as_prefix = ($alias =~ /^.*?\.(.+)$/ ? $1.'.' : '');
- my $rel_source = $self->related_source($pre);
-
- if ($rel_info->{attrs}{accessor} && $rel_info->{attrs}{accessor} eq 'multi') {
- $self->throw_exception(
- "Can't prefetch has_many ${pre} (join cond too complex)")
- unless ref($rel_info->{cond}) eq 'HASH';
- my $dots = @{[$as_prefix =~ m/\./g]} + 1; # +1 to match the ".${as_prefix}"
-
- if (my ($fail) = grep { @{[$_ =~ m/\./g]} == $dots }
- keys %{$collapse}) {
- my ($last) = ($fail =~ /([^\.]+)$/);
- carp (
- "Prefetching multiple has_many rels ${last} and ${pre} "
- .(length($as_prefix)
- ? "at the same level (${as_prefix}) "
- : "at top level "
- )
- . 'will explode the number of row objects retrievable via ->next or ->all. '
- . 'Use at your own risk.'
- );
- }
-
- #my @col = map { (/^self\.(.+)$/ ? ("${as_prefix}.$1") : ()); }
- # values %{$rel_info->{cond}};
- $collapse->{".${as_prefix}${pre}"} = [ $rel_source->_pri_cols ];
- # action at a distance. prepending the '.' allows simpler code
- # in ResultSet->_collapse_result
- my @key = map { (/^foreign\.(.+)$/ ? ($1) : ()); }
- keys %{$rel_info->{cond}};
- push @$order, map { "${as}.$_" } @key;
-
- if (my $rel_order = $rel_info->{attrs}{order_by}) {
- # this is kludgy and incomplete, I am well aware
- # but the parent method is going away entirely anyway
- # so sod it
- my $sql_maker = $self->storage->sql_maker;
- my ($orig_ql, $orig_qr) = $sql_maker->_quote_chars;
- my $sep = $sql_maker->name_sep;
-
- # install our own quoter, so we can catch unqualified stuff
- local $sql_maker->{quote_char} = ["\x00", "\xFF"];
-
- my $quoted_prefix = "\x00${as}\xFF";
-
- for my $chunk ( $sql_maker->_order_by_chunks ($rel_order) ) {
- my @bind;
- ($chunk, @bind) = @$chunk if ref $chunk;
-
- $chunk = "${quoted_prefix}${sep}${chunk}"
- unless $chunk =~ /\Q$sep/;
-
- $chunk =~ s/\x00/$orig_ql/g;
- $chunk =~ s/\xFF/$orig_qr/g;
- push @$order, \[$chunk, @bind];
- }
- }
- }
- return map { [ "${as}.$_", "${as_prefix}${pre}.$_", ] }
- $rel_source->columns;
- }
+ die "not supposed to get here - missing return()";
}
=head2 related_source