X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSQLMaker.pm;h=9b140c172c371776e1cd395126123ed64e545262;hb=02562a2092543488bba4ccd98c39abca72560555;hp=1340165a825f097b506b37ea01a1331af232268b;hpb=9c1700e39e6ee002d9294c0d988882d1f0d7d86f;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/SQLMaker.pm b/lib/DBIx/Class/SQLMaker.pm index 1340165..9b140c1 100644 --- a/lib/DBIx/Class/SQLMaker.pm +++ b/lib/DBIx/Class/SQLMaker.pm @@ -1,18 +1,21 @@ package DBIx::Class::SQLMaker; +use strict; +use warnings; + =head1 NAME DBIx::Class::SQLMaker - An SQL::Abstract-based SQL maker class =head1 DESCRIPTION -This module is a subclass of L and includes a number of -DBIC-specific workarounds, not yet suitable for inclusion into the +This module is currently a subclass of L and includes a number of +DBIC-specific extensions/workarounds, not suitable for inclusion into the L core. It also provides all (and more than) the functionality of L, see L for more info. -Currently the enhancements to L are: +Currently the enhancements over L are: =over @@ -22,140 +25,183 @@ Currently the enhancements to L are: =item * C/C support (via extensions to the order_by parameter) +=item * A rudimentary multicolumn IN operator + =item * Support of C<...FOR UPDATE> type of select statement modifiers -=item * The -ident operator +=back + +=head1 ROADMAP + +Some maintainer musings on the current state of SQL generation within DBIC as +of Oct 2015 + +=head2 Folding of most (or all) of L into DBIC + +The rise of complex prefetch use, and the general streamlining of result +parsing within DBIC ended up pushing the actual SQL generation to the forefront +of many casual performance profiles. While the idea behind SQLA's API is sound, +the actual implementation is terribly inefficient (once again bumping into the +ridiculously high overhead of perl function calls). + +Given that SQLA has a B distinct life on its own, and is used within an +order of magnitude more projects compared to DBIC, it is prudent to B +disturb the current call chains within SQLA itself. Instead in the near future +an effort will be undertaken to seek a more thorough decoupling of DBIC SQL +generation from reliance on SQLA, possibly to a point where B at all. + +B library itself will continue being maintained> although +it is not likely to gain many extra features, notably dialect support, at least +not within the base C namespace. + +This work (if undertaken) will take into consideration the following +constraints: + +=over + +=item Main API compatibility + +The object returned by C<< $schema->storage->sqlmaker >> needs to be able to +satisfy most of the basic tests found in the current-at-the-time SQLA dist. +While things like L or L +or even worse L will definitely remain +unsupported, the rest of the tests should pass (within reason). + +=item Ability to plug back an SQL::Abstract (or derivative) -=item * The -value operator +During the initial work on L the test suite of DBIC turned out to +be an invaluable asset to iron out hard-to-reason-about corner cases. In +addition the test suite is much more vast and intricate than the tests of SQLA +itself. This state of affairs is way too valuable to sacrifice in order to gain +faster SQL generation. Thus a compile-time-ENV-check will be introduced along +with an extra CI configuration to ensure that DBIC is used with an off-the-CPAN +SQLA and that it continues to flawlessly run its entire test suite. While this +will undoubtedly complicate the implementation of the better performing SQL +generator, it will preserve both the usability of the test suite for external +projects and will keep L from regressions in the future. =back +Aside from these constraints it is becoming more and more practical to simply +stop using SQLA in day-to-day production deployments of DBIC. The flexibility +of the internals is simply not worth the performance cost. + +=head2 Relationship to L + +When initial work on DQ was taking place, the tools in L<::Storage::DBIHacks +|http://github.com/dbsrgits/dbix-class/blob/master/lib/DBIx/Class/Storage/DBIHacks.pm> +were only beginning to take shape, and it wasn't clear how important they will +become further down the road. In fact the I was +considered an ugly stop-gap, and even a couple of highly entertaining talks +were given to that effect. As the use-cases of DBIC were progressing, and +evidence for the importance of supporting arbitrary SQL was mounting, it became +clearer that DBIC itself would not really benefit in any way from an +integration with DQ, but on the contrary is likely to lose functionality while +the corners of the brand new DQ codebase are sanded off. + +The current status of DBIC/DQ integration is that the only benefit is for DQ by +having access to the very extensive "early adopter" test suite, in the same +manner as early DBIC benefitted tremendously from usurping the Class::DBI test +suite. As far as the DBIC user-base - there are no immediate practical upsides +to DQ integration, neither in terms of API nor in performance. + +So (as described higher up) the DBIC development effort will in the foreseable +future ignore the existence of DQ, and will continue optimizing the preexisting +SQLA-based solution, potentially "organically growing" its own compatible +implementation. Also (again, as described higher up) the ability to plug a +separate SQLA-compatible class providing the necessary surface API will remain +possible, and will be protected at all costs in order to continue providing DQ +access to the test cases of DBIC. + +In the short term, after one more pass over the ResultSet internals is +undertaken I, and before the SQLA/SQLMaker integration +takes place, the preexisting DQ-based branches will be pulled/modified/rebased +to get up-to-date with the current state of the codebase, which changed very +substantially since the last migration effort, especially in the SQL +classification meta-parsing codepath. + =cut use base qw/ DBIx::Class::SQLMaker::LimitDialects SQL::Abstract - Class::Accessor::Grouped + DBIx::Class /; use mro 'c3'; -use strict; -use warnings; -use Sub::Name 'subname'; -use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/; + +use DBIx::Class::Carp; +use DBIx::Class::_Util 'set_subname'; +use SQL::Abstract 'is_literal_value'; use namespace::clean; __PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/); +sub _quoting_enabled { + ( defined $_[0]->{quote_char} and length $_[0]->{quote_char} ) ? 1 : 0 +} + # for when I need a normalized l/r pair sub _quote_chars { + + # in case we are called in the old !!$sm->_quote_chars fashion + return () if !wantarray and ( ! defined $_[0]->{quote_char} or ! length $_[0]->{quote_char} ); + map { defined $_ ? $_ : '' } ( ref $_[0]->{quote_char} ? (@{$_[0]->{quote_char}}) : ( ($_[0]->{quote_char}) x 2 ) ) ; } +# FIXME when we bring in the storage weaklink, check its schema +# weaklink and channel through $schema->throw_exception +sub throw_exception { DBIx::Class::Exception->throw($_[1]) } + BEGIN { - # reinstall the carp()/croak() functions imported into SQL::Abstract - # as Carp and Carp::Clan do not like each other much + # reinstall the belch()/puke() functions of SQL::Abstract with custom versions + # that use DBIx::Class::Carp/DBIx::Class::Exception instead of plain Carp no warnings qw/redefine/; - no strict qw/refs/; - for my $f (qw/carp croak/) { - - my $orig = \&{"SQL::Abstract::$f"}; - my $clan_import = \&{$f}; - *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" => - sub { - if (Carp::longmess() =~ /DBIx::Class::SQLMaker::[\w]+ .+? called \s at/x) { - goto $clan_import; - } - else { - goto $orig; - } - }; - } - # Current SQLA pollutes its namespace - clean for the time being - namespace::clean->clean_subroutines(qw/SQL::Abstract carp croak confess/); + *SQL::Abstract::belch = set_subname 'SQL::Abstract::belch' => sub (@) { + my($func) = (caller(1))[3]; + carp "[$func] Warning: ", @_; + }; + + *SQL::Abstract::puke = set_subname 'SQL::Abstract::puke' => sub (@) { + my($func) = (caller(1))[3]; + __PACKAGE__->throw_exception("[$func] Fatal: " . join ('', @_)); + }; } # the "oh noes offset/top without limit" constant -# limited to 32 bits for sanity (and consistency, -# since it is ultimately handed to sprintf %u) +# limited to 31 bits for sanity (and consistency, +# since it may be handed to the like of sprintf %u) +# +# Also *some* builds of SQLite fail the test +# some_column BETWEEN ? AND ?: 1, 4294967295 +# with the proper integer bind attrs +# # Implemented as a method, since ::Storage::DBI also # refers to it (i.e. for the case of software_limit or # as the value to abuse with MSSQL ordered subqueries) -sub __max_int { 0xFFFFFFFF }; +sub __max_int () { 0x7FFFFFFF }; -sub new { - my $self = shift->next::method(@_); +# we ne longer need to check this - DBIC has ways of dealing with it +# specifically ::Storage::DBI::_resolve_bindattrs() +sub _assert_bindval_matches_bindtype () { 1 }; - # use the same coderefs, they are prepared to handle both cases - my @extra_dbic_syntax = ( - { regex => qr/^ ident $/xi, handler => '_where_op_IDENT' }, - { regex => qr/^ value $/xi, handler => '_where_op_VALUE' }, +# poor man's de-qualifier +sub _quote { + $_[0]->next::method( ( $_[0]{_dequalify_idents} and defined $_[1] and ! ref $_[1] ) + ? $_[1] =~ / ([^\.]+) $ /x + : $_[1] ); - - push @{$self->{special_ops}}, @extra_dbic_syntax; - push @{$self->{unary_ops}}, @extra_dbic_syntax; - - $self; } -sub _where_op_IDENT { - my $self = shift; - my ($op, $rhs) = splice @_, -2; - if (ref $rhs) { - croak "-$op takes a single scalar argument (a quotable identifier)"; - } - - # in case we are called as a top level special op (no '=') - my $lhs = shift; - - $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs); - - return $lhs - ? "$lhs = $rhs" - : $rhs - ; -} - -sub _where_op_VALUE { - my $self = shift; - my ($op, $rhs) = splice @_, -2; - - # in case we are called as a top level special op (no '=') - my $lhs = shift; - - my @bind = [ - ($lhs || $self->{_nested_func_lhs} || croak "Unable to find bindtype for -value $rhs"), - $rhs - ]; - - return $lhs - ? ( - $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'), - @bind - ) - : ( - $self->_convert('?'), - @bind, - ) - ; -} - -my $callsites_warned; sub _where_op_NEST { - # determine callsite obeying Carp::Clan rules (fucking ugly but don't have better ideas) - my $callsite = do { - my $w; - local $SIG{__WARN__} = sub { $w = shift }; - carp; - $w - }; - - carp ("-nest in search conditions is deprecated, you most probably wanted:\n" + carp_unique ("-nest in search conditions is deprecated, you most probably wanted:\n" .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }| - ) unless $callsites_warned->{$callsite}++; + ); shift->next::method(@_); } @@ -164,18 +210,38 @@ sub _where_op_NEST { sub select { my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_; + ($fields, @{$self->{select_bind}}) = length ref $fields + ? $self->_recurse_fields( $fields ) + : $self->_quote( $fields ) + ; - $fields = $self->_recurse_fields($fields); + # Override the default behavior of SQL::Abstract - SELECT * makes + # no sense in the context of DBIC (and has resulted in several + # tricky debugging sessions in the past) + not length $fields + and +# FIXME - some day we need to enable this, but too many things break +# ( notably S::L ) +# # Random value selected by a fair roll of dice +# # In seriousness - this has to be a number, as it is much more +# # palatable to random engines in a SELECT list +# $fields = 42 +# and + carp_unique ( + "ResultSets with an empty selection are deprecated (you almost certainly " + . "did not mean to do that): if this is indeed your intent you must " + . "explicitly supply \\'*' to your search()" + ); if (defined $offset) { - croak ('A supplied offset must be a non-negative integer') - if ( $offset =~ /\D/ or $offset < 0 ); + $self->throw_exception('A supplied offset must be a non-negative integer') + if ( $offset =~ /[^0-9]/ or $offset < 0 ); } $offset ||= 0; if (defined $limit) { - croak ('A supplied limit must be a positive integer') - if ( $limit =~ /\D/ or $limit <= 0 ); + $self->throw_exception('A supplied limit must be a positive integer') + if ( $limit =~ /[^0-9]/ or $limit <= 0 ); } elsif ($offset) { $limit = $self->__max_int; @@ -188,18 +254,33 @@ sub select { ($sql, @bind) = $self->next::method ($table, $fields, $where); - my $limiter = - $self->can ('emulate_limit') # also backcompat hook from SQLA::Limit - || - do { - my $dialect = $self->limit_dialect - or croak "Unable to generate SQL-limit - no limit dialect specified on $self, and no emulate_limit method found"; - $self->can ("_$dialect") - or croak (__PACKAGE__ . " does not implement the requested dialect '$dialect'"); - } - ; + my $limiter; + + if( $limiter = $self->can ('emulate_limit') ) { + carp_unique( + 'Support for the legacy emulate_limit() mechanism inherited from ' + . 'SQL::Abstract::Limit has been deprecated, and will be removed at ' + . 'some future point, as it gets in the way of architectural and/or ' + . 'performance advances within DBIC. If your code uses this type of ' + . 'limit specification please file an RT and provide the source of ' + . 'your emulate_limit() implementation, so an acceptable upgrade-path ' + . 'can be devised' + ); + } + else { + my $dialect = $self->limit_dialect + or $self->throw_exception( "Unable to generate SQL-limit - no limit dialect specified on $self" ); - $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset); + $limiter = $self->can ("_$dialect") + or $self->throw_exception(__PACKAGE__ . " does not implement the requested dialect '$dialect'"); + } + + $sql = $self->$limiter ( + $sql, + { %{$rs_attrs||{}}, _selector_sql => $fields }, + $limit, + $offset + ); } else { ($sql, @bind) = $self->next::method ($table, $fields, $where, $rs_attrs); @@ -218,7 +299,7 @@ sub select { sub _assemble_binds { my $self = shift; - return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/select from where group having order/); + return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/pre_select select from where group having order limit/); } my $for_syntax = { @@ -227,7 +308,15 @@ my $for_syntax = { }; sub _lock_select { my ($self, $type) = @_; - my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested"; + + my $sql; + if (ref($type) eq 'SCALAR') { + $sql = "FOR $$type"; + } + else { + $sql = $for_syntax->{$type} || $self->throw_exception( "Unknown SELECT .. FOR type '$type' requested" ); + } + return " $sql"; } @@ -236,9 +325,9 @@ sub insert { # optimized due to hotttnesss # my ($self, $table, $data, $options) = @_; - # SQLA will emit INSERT INTO $table ( ) VALUES ( ) + # FIXME SQLA will emit INSERT INTO $table ( ) VALUES ( ) # which is sadly understood only by MySQL. Change default behavior here, - # until SQLA2 comes with proper dialect support + # until we fold the extra pieces into SQLMaker properly if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) { my @bind; my $sql = sprintf( @@ -259,50 +348,73 @@ sub insert { sub _recurse_fields { my ($self, $fields) = @_; - my $ref = ref $fields; - return $self->_quote($fields) unless $ref; - return $$fields if $ref eq 'SCALAR'; - if ($ref eq 'ARRAY') { - return join(', ', map { $self->_recurse_fields($_) } @$fields); + if( not length ref $fields ) { + return $self->_quote( $fields ); } - elsif ($ref eq 'HASH') { + + elsif( my $lit = is_literal_value( $fields ) ) { + return @$lit + } + + elsif( ref $fields eq 'ARRAY' ) { + my (@select, @bind, @bind_fragment); + + ( + ( $select[ $#select + 1 ], @bind_fragment ) = length ref $_ + ? $self->_recurse_fields( $_ ) + : $self->_quote( $_ ) + ), + ( push @bind, @bind_fragment ) + for @$fields; + + return (join(', ', @select), @bind); + } + + # FIXME - really crappy handling of functions + elsif ( ref $fields eq 'HASH') { my %hash = %$fields; # shallow copy my $as = delete $hash{-as}; # if supplied - my ($func, $args, @toomany) = %hash; + my ($func, $rhs, @toomany) = %hash; # there should be only one pair - if (@toomany) { - croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields ); - } + $self->throw_exception( + "Malformed select argument - too many keys in hash: " . join (',', keys %$fields ) + ) if @toomany; + + $self->throw_exception ( + 'The select => { distinct => ... } syntax is not supported for multiple columns.' + .' Instead please use { group_by => [ qw/' . (join ' ', @$rhs) . '/ ] }' + .' or { select => [ qw/' . (join ' ', @$rhs) . '/ ], distinct => 1 }' + ) if ( + lc ($func) eq 'distinct' + and + ref $rhs eq 'ARRAY' + and + @$rhs > 1 + ); - if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) { - croak ( - 'The select => { distinct => ... } syntax is not supported for multiple columns.' - .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }' - .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }' - ); - } + my ($rhs_sql, @rhs_bind) = length ref $rhs + ? $self->_recurse_fields($rhs) + : $self->_quote($rhs) + ; - my $select = sprintf ('%s( %s )%s', - $self->_sqlcase($func), - $self->_recurse_fields($args), - $as - ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) ) - : '' + return( + sprintf( '%s( %s )%s', + $self->_sqlcase($func), + $rhs_sql, + $as + ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) ) + : '' + ), + @rhs_bind ); - - return $select; - } - # Is the second check absolutely necessary? - elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) { - push @{$self->{select_bind}}, @{$$fields}[1..$#$$fields]; - return $$fields->[0]; } + else { - croak($ref . qq{ unexpected in _recurse_fields()}) + $self->throw_exception( ref($fields) . ' unexpected in _recurse_fields()' ); } } @@ -311,31 +423,39 @@ sub _recurse_fields { # What we have been doing forever is hijacking the $order arg of # SQLA::select to pass in arbitrary pieces of data (first the group_by, # then pretty much the entire resultset attr-hash, as more and more -# things in the SQLA space need to have mopre info about the $rs they +# things in the SQLA space need to have more info about the $rs they # create SQL for. The alternative would be to keep expanding the # signature of _select with more and more positional parameters, which -# is just gross. All hail SQLA2! +# is just gross. +# +# FIXME - this will have to transition out to a subclass when the effort +# of folding the SQLA machinery into SQLMaker takes place sub _parse_rs_attrs { my ($self, $arg) = @_; my $sql = ''; - - if ($arg->{group_by}) { - # horible horrible, waiting for refactor - local $self->{select_bind}; - if (my $g = $self->_recurse_fields($arg->{group_by}) ) { - $sql .= $self->_sqlcase(' group by ') . $g; - push @{$self->{group_bind} ||= []}, @{$self->{select_bind}||[]}; - } + my @sqlbind; + + if ( + $arg->{group_by} + and + @sqlbind = $self->_recurse_fields($arg->{group_by}) + ) { + $sql .= $self->_sqlcase(' group by ') . shift @sqlbind; + push @{$self->{group_bind}}, @sqlbind; } - if (defined $arg->{having}) { - my ($frag, @bind) = $self->_recurse_where($arg->{having}); - push(@{$self->{having_bind}}, @bind); - $sql .= $self->_sqlcase(' having ') . $frag; + if ( + $arg->{having} + and + @sqlbind = $self->_recurse_where($arg->{having}) + ) { + $sql .= $self->_sqlcase(' having ') . shift @sqlbind; + push(@{$self->{having_bind}}, @sqlbind); } - if (defined $arg->{order_by}) { + if ($arg->{order_by}) { + # unlike the 2 above, _order_by injects into @{...bind...} for us $sql .= $self->_order_by ($arg->{order_by}); } @@ -346,14 +466,30 @@ sub _order_by { my ($self, $arg) = @_; # check that we are not called in legacy mode (order_by as 4th argument) - if (ref $arg eq 'HASH' and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) { - return $self->_parse_rs_attrs ($arg); - } - else { - my ($sql, @bind) = $self->next::method($arg); - push @{$self->{order_bind}}, @bind; - return $sql; - } + ( + ref $arg eq 'HASH' + and + not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg + ) + ? $self->_parse_rs_attrs ($arg) + : do { + my ($sql, @bind) = $self->next::method($arg); + push @{$self->{order_bind}}, @bind; + $sql; # RV + } + ; +} + +sub _split_order_chunk { + my ($self, $chunk) = @_; + + # strip off sort modifiers, but always succeed, so $1 gets reset + $chunk =~ s/ (?: \s+ (ASC|DESC) )? \s* $//ix; + + return ( + $chunk, + ( $1 and uc($1) eq 'DESC' ) ? 1 : 0, + ); } sub _table { @@ -366,25 +502,37 @@ sub _table { elsif ($ref eq 'HASH') { return $_[0]->_recurse_from($_[1]); } + elsif ($ref eq 'REF' && ref ${$_[1]} eq 'ARRAY') { + my ($sql, @bind) = @{ ${$_[1]} }; + push @{$_[0]->{from_bind}}, @bind; + return $sql + } } - return $_[0]->next::method ($_[1]); } sub _generate_join_clause { my ($self, $join_type) = @_; + $join_type = $self->{_default_jointype} + if ! defined $join_type; + return sprintf ('%s JOIN ', - $join_type ? ' ' . $self->_sqlcase($join_type) : '' + $join_type ? $self->_sqlcase($join_type) : '' ); } sub _recurse_from { - my ($self, $from, @join) = @_; - my @sqlf; - push @sqlf, $self->_from_chunk_to_sql($from); + my $self = shift; + return join (' ', $self->_gen_from_blocks(@_) ); +} - for (@join) { +sub _gen_from_blocks { + my ($self, $from, @joins) = @_; + + my @fchunks = $self->_from_chunk_to_sql($from); + + for (@joins) { my ($to, $on) = @$_; # check whether a join type exists @@ -395,80 +543,158 @@ sub _recurse_from { $join_type =~ s/^\s+ | \s+$//xg; } - $join_type = $self->{_default_jointype} if not defined $join_type; - - push @sqlf, $self->_generate_join_clause( $join_type ); + my @j = $self->_generate_join_clause( $join_type ); if (ref $to eq 'ARRAY') { - push(@sqlf, '(', $self->_recurse_from(@$to), ')'); - } else { - push(@sqlf, $self->_from_chunk_to_sql($to)); + push(@j, '(', $self->_recurse_from(@$to), ')'); + } + else { + push(@j, $self->_from_chunk_to_sql($to)); } - push(@sqlf, ' ON ', $self->_join_condition($on)); + + my ($sql, @bind) = $self->_join_condition($on); + push(@j, ' ON ', $sql); + push @{$self->{from_bind}}, @bind; + + push @fchunks, join '', @j; } - return join('', @sqlf); + + return @fchunks; } sub _from_chunk_to_sql { my ($self, $fromspec) = @_; - return join (' ', $self->_SWITCH_refkind($fromspec, { - SCALARREF => sub { + return join (' ', do { + if (! ref $fromspec) { + $self->_quote($fromspec); + } + elsif (ref $fromspec eq 'SCALAR') { $$fromspec; - }, - ARRAYREFREF => sub { + } + elsif (ref $fromspec eq 'REF' and ref $$fromspec eq 'ARRAY') { push @{$self->{from_bind}}, @{$$fromspec}[1..$#$$fromspec]; $$fromspec->[0]; - }, - HASHREF => sub { + } + elsif (ref $fromspec eq 'HASH') { my ($as, $table, $toomuch) = ( map { $_ => $fromspec->{$_} } ( grep { $_ !~ /^\-/ } keys %$fromspec ) ); - croak "Only one table/as pair expected in from-spec but an exra '$toomuch' key present" + $self->throw_exception( "Only one table/as pair expected in from-spec but an exra '$toomuch' key present" ) if defined $toomuch; ($self->_from_chunk_to_sql($table), $self->_quote($as) ); - }, - SCALAR => sub { - $self->_quote($fromspec); - }, - })); + } + else { + $self->throw_exception('Unsupported from refkind: ' . ref $fromspec ); + } + }); } sub _join_condition { my ($self, $cond) = @_; - if (ref $cond eq 'HASH') { - my %j; - for (keys %$cond) { - my $v = $cond->{$_}; - if (ref $v) { - croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'}) - if ref($v) ne 'SCALAR'; - $j{$_} = $v; + # Backcompat for the old days when a plain hashref + # { 't1.col1' => 't2.col2' } meant ON t1.col1 = t2.col2 + if ( + ref $cond eq 'HASH' + and + keys %$cond == 1 + and + (keys %$cond)[0] =~ /\./ + and + ! ref ( (values %$cond)[0] ) + ) { + carp_unique( + "ResultSet {from} structures with conditions not conforming to the " + . "SQL::Abstract syntax are deprecated: you either need to stop abusing " + . "{from} altogether, or express the condition properly using the " + . "{ -ident => ... } operator" + ); + $cond = { keys %$cond => { -ident => values %$cond } } + } + elsif ( ref $cond eq 'ARRAY' ) { + # do our own ORing so that the hashref-shim above is invoked + my @parts; + my @binds; + foreach my $c (@$cond) { + my ($sql, @bind) = $self->_join_condition($c); + push @binds, @bind; + push @parts, $sql; + } + return join(' OR ', @parts), @binds; + } + + return $self->_recurse_where($cond); +} + +# !!! EXPERIMENTAL API !!! WILL CHANGE !!! +# +# This is rather odd, but vanilla SQLA does not have support for multicolumn IN +# expressions +# Currently has only one callsite in ResultSet, body moved into this subclass +# of SQLA to raise API questions like: +# - how do we convey a list of idents...? +# - can binds reside on lhs? +# +# !!! EXPERIMENTAL API !!! WILL CHANGE !!! +sub _where_op_multicolumn_in { + my ($self, $lhs, $rhs) = @_; + + if (! ref $lhs or ref $lhs eq 'ARRAY') { + my (@sql, @bind); + for (ref $lhs ? @$lhs : $lhs) { + if (! ref $_) { + push @sql, $self->_quote($_); + } + elsif (ref $_ eq 'SCALAR') { + push @sql, $$_; + } + elsif (ref $_ eq 'REF' and ref $$_ eq 'ARRAY') { + my ($s, @b) = @$$_; + push @sql, $s; + push @bind, @b; } else { - my $x = '= '.$self->_quote($v); $j{$_} = \$x; + $self->throw_exception("ARRAY of @{[ ref $_ ]}es unsupported for multicolumn IN lhs..."); } - }; - return scalar($self->_recurse_where(\%j)); - } elsif (ref $cond eq 'ARRAY') { - return join(' OR ', map { $self->_join_condition($_) } @$cond); - } else { - croak "Can't handle this yet!"; + } + $lhs = \[ join(', ', @sql), @bind]; + } + elsif (ref $lhs eq 'SCALAR') { + $lhs = \[ $$lhs ]; + } + elsif (ref $lhs eq 'REF' and ref $$lhs eq 'ARRAY' ) { + # noop + } + else { + $self->throw_exception( ref($lhs) . "es unsupported for multicolumn IN lhs..."); } -} -1; + # is this proper...? + $rhs = \[ $self->_recurse_where($rhs) ]; + + for ($lhs, $rhs) { + $$_->[0] = "( $$_->[0] )" + unless $$_->[0] =~ /^ \s* \( .* \) \s* $/xs; + } -=head1 AUTHORS + \[ join( ' IN ', shift @$$lhs, shift @$$rhs ), @$$lhs, @$$rhs ]; +} + +=head1 FURTHER QUESTIONS? -See L. +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 + +1;