1 package # Hide from PAUSE
2 DBIx::Class::SQLAHacks;
4 use base qw/SQL::Abstract::Limit/;
7 use Carp::Clan qw/^DBIx::Class|^SQL::Abstract/;
10 # reinstall the carp()/croak() functions imported into SQL::Abstract
11 # as Carp and Carp::Clan do not like each other much
12 no warnings qw/redefine/;
14 for my $f (qw/carp croak/) {
15 my $orig = \&{"SQL::Abstract::$f"};
16 *{"SQL::Abstract::$f"} = sub {
18 local $Carp::CarpLevel = 1; # even though Carp::Clan ignores this, $orig will not
20 if (Carp::longmess() =~ /DBIx::Class::SQLAHacks::[\w]+\(\) called/) {
21 __PACKAGE__->can($f)->(@_);
31 my $self = shift->SUPER::new(@_);
33 # This prevents the caching of $dbh in S::A::L, I believe
34 # If limit_dialect is a ref (like a $dbh), go ahead and replace
35 # it with what it resolves to:
36 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
37 if ref $self->{limit_dialect};
43 # Some databases (sqlite) do not handle multiple parenthesis
44 # around in/between arguments. A tentative x IN ( ( 1, 2 ,3) )
45 # is interpreted as x IN 1 or something similar.
47 # Since we currently do not have access to the SQLA AST, resort
48 # to barbaric mutilation of any SQL supplied in literal form
50 sub _strip_outer_paren {
51 my ($self, $arg) = @_;
53 return $self->_SWITCH_refkind ($arg, {
55 $$arg->[0] = __strip_outer_paren ($$arg->[0]);
59 return \__strip_outer_paren( $$arg );
67 sub __strip_outer_paren {
70 if ($sql and not ref $sql) {
71 while ($sql =~ /^ \s* \( (.*) \) \s* $/x ) {
80 my ($self, $lhs, $op, $rhs) = @_;
81 $rhs = $self->_strip_outer_paren ($rhs);
82 return $self->SUPER::_where_field_IN ($lhs, $op, $rhs);
85 sub _where_field_BETWEEN {
86 my ($self, $lhs, $op, $rhs) = @_;
87 $rhs = $self->_strip_outer_paren ($rhs);
88 return $self->SUPER::_where_field_BETWEEN ($lhs, $op, $rhs);
91 # Slow but ANSI standard Limit/Offset support. DB2 uses this
93 my ($self, $sql, $order, $rows, $offset ) = @_;
96 my $last = $rows + $offset - 1;
97 my ( $order_by ) = $self->_order_by( $order );
102 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
107 WHERE ROW_NUM BETWEEN $offset AND $last
114 # Crappy Top based Limit/Offset support. MSSQL uses this currently,
115 # but may have to switch to RowNumberOver one day
117 my ( $self, $sql, $order, $rows, $offset ) = @_;
119 croak '$order supplied to SQLAHacks limit emulators must be a hash'
120 if (ref $order ne 'HASH');
122 $order = { %$order }; #copy
124 my $last = $rows + $offset;
126 my $req_order = $self->_order_by ($order->{order_by});
128 my $limit_order = $req_order ? $order->{order_by} : $order->{_virtual_order_by};
130 delete $order->{$_} for qw/order_by _virtual_order_by/;
131 my $grpby_having = $self->_order_by ($order);
133 my ( $order_by_inner, $order_by_outer ) = $self->_order_directions($limit_order);
135 $sql =~ s/^\s*(SELECT|select)//;
140 SELECT TOP $rows * FROM
142 SELECT TOP $last $sql $grpby_having $order_by_inner
154 # While we're at it, this should make LIMIT queries more efficient,
155 # without digging into things too deeply
157 my ($self, $syntax) = @_;
158 return $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
162 my ($self, $table, $fields, $where, $order, @rest) = @_;
164 $self->{"${_}_bind"} = [] for (qw/having from order/);
166 if (not ref($table) or ref($table) eq 'SCALAR') {
167 $table = $self->_quote($table);
170 local $self->{rownum_hack_count} = 1
171 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
172 @rest = (-1) unless defined $rest[0];
173 croak "LIMIT 0 Does Not Compute" if $rest[0] == 0;
174 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
175 my ($sql, @where_bind) = $self->SUPER::select(
176 $table, $self->_recurse_fields($fields), $where, $order, @rest
181 $self->{for} eq 'update' ? ' FOR UPDATE' :
182 $self->{for} eq 'shared' ? ' FOR SHARE' :
187 return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}, @{$self->{order_bind}} ) : $sql;
193 $table = $self->_quote($table);
195 # SQLA will emit INSERT INTO $table ( ) VALUES ( )
196 # which is sadly understood only by MySQL. Change default behavior here,
197 # until SQLA2 comes with proper dialect support
198 if (! $_[0] or (ref $_[0] eq 'HASH' and !keys %{$_[0]} ) ) {
199 return "INSERT INTO ${table} DEFAULT VALUES"
202 $self->SUPER::insert($table, @_);
208 $table = $self->_quote($table);
209 $self->SUPER::update($table, @_);
215 $table = $self->_quote($table);
216 $self->SUPER::delete($table, @_);
222 return $_[1].$self->_order_by($_[2]);
224 return $self->SUPER::_emulate_limit(@_);
228 sub _recurse_fields {
229 my ($self, $fields, $params) = @_;
230 my $ref = ref $fields;
231 return $self->_quote($fields) unless $ref;
232 return $$fields if $ref eq 'SCALAR';
234 if ($ref eq 'ARRAY') {
235 return join(', ', map {
236 $self->_recurse_fields($_)
237 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
238 ? ' AS col'.$self->{rownum_hack_count}++
241 } elsif ($ref eq 'HASH') {
242 foreach my $func (keys %$fields) {
243 if ($func eq 'distinct') {
244 my $_fields = $fields->{$func};
245 if (ref $_fields eq 'ARRAY' && @{$_fields} > 1) {
247 'The select => { distinct => ... } syntax is not supported for multiple columns.'
248 .' Instead please use { group_by => [ qw/' . (join ' ', @$_fields) . '/ ] }'
249 .' or { select => [ qw/' . (join ' ', @$_fields) . '/ ], distinct => 1 }'
253 $_fields = @{$_fields}[0] if ref $_fields eq 'ARRAY';
255 'The select => { distinct => ... } syntax will be deprecated in DBIC version 0.09,'
256 ." please use { group_by => '${_fields}' } or { select => '${_fields}', distinct => 1 }"
260 return $self->_sqlcase($func)
261 .'( '.$self->_recurse_fields($fields->{$func}).' )';
264 # Is the second check absolutely necessary?
265 elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
266 return $self->_fold_sqlbind( $fields );
269 croak($ref . qq{ unexpected in _recurse_fields()})
274 my ($self, $arg) = @_;
276 if (ref $arg eq 'HASH' and keys %$arg and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) {
280 if (defined $arg->{group_by}) {
281 $ret = $self->_sqlcase(' group by ')
282 .$self->_recurse_fields($arg->{group_by}, { no_rownum_hack => 1 });
285 if (defined $arg->{having}) {
286 my ($frag, @bind) = $self->_recurse_where($arg->{having});
287 push(@{$self->{having_bind}}, @bind);
288 $ret .= $self->_sqlcase(' having ').$frag;
291 if (defined $arg->{order_by}) {
292 my ($frag, @bind) = $self->SUPER::_order_by($arg->{order_by});
293 push(@{$self->{order_bind}}, @bind);
300 my ($sql, @bind) = $self->SUPER::_order_by ($arg);
301 push(@{$self->{order_bind}}, @bind);
306 sub _order_directions {
307 my ($self, $order) = @_;
309 # strip bind values - none of the current _order_directions users support them
310 return $self->SUPER::_order_directions( [ map
311 { ref $_ ? $_->[0] : $_ }
312 $self->_order_by_chunks ($order)
317 my ($self, $from) = @_;
318 if (ref $from eq 'ARRAY') {
319 return $self->_recurse_from(@$from);
320 } elsif (ref $from eq 'HASH') {
321 return $self->_make_as($from);
323 return $from; # would love to quote here but _table ends up getting called
324 # twice during an ->select without a limit clause due to
325 # the way S::A::Limit->select works. should maybe consider
326 # bypassing this and doing S::A::select($self, ...) in
327 # our select method above. meantime, quoting shims have
328 # been added to select/insert/update/delete here
333 my ($self, $from, @join) = @_;
335 push(@sqlf, $self->_make_as($from));
336 foreach my $j (@join) {
339 # check whether a join type exists
340 my $join_clause = '';
341 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
342 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
343 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
345 $join_clause = ' JOIN ';
347 push(@sqlf, $join_clause);
349 if (ref $to eq 'ARRAY') {
350 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
352 push(@sqlf, $self->_make_as($to));
354 push(@sqlf, ' ON ', $self->_join_condition($on));
356 return join('', @sqlf);
360 my ($self, $sqlbind) = @_;
362 my @sqlbind = @$$sqlbind; # copy
363 my $sql = shift @sqlbind;
364 push @{$self->{from_bind}}, @sqlbind;
370 my ($self, $from) = @_;
371 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_
372 : ref $_ eq 'REF' ? $self->_fold_sqlbind($_)
374 } reverse each %{$self->_skip_options($from)});
378 my ($self, $hash) = @_;
380 $clean_hash->{$_} = $hash->{$_}
381 for grep {!/^-/} keys %$hash;
385 sub _join_condition {
386 my ($self, $cond) = @_;
387 if (ref $cond eq 'HASH') {
392 croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
393 if ref($v) ne 'SCALAR';
397 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
400 return scalar($self->_recurse_where(\%j));
401 } elsif (ref $cond eq 'ARRAY') {
402 return join(' OR ', map { $self->_join_condition($_) } @$cond);
404 die "Can't handle this yet!";
409 my ($self, $label) = @_;
410 return '' unless defined $label;
411 return $$label if ref($label) eq 'SCALAR';
412 return "*" if $label eq '*';
413 return $label unless $self->{quote_char};
414 if(ref $self->{quote_char} eq "ARRAY"){
415 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
416 if !defined $self->{name_sep};
417 my $sep = $self->{name_sep};
418 return join($self->{name_sep},
419 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
420 split(/\Q$sep\E/,$label));
422 return $self->SUPER::_quote($label);
427 $self->{limit_dialect} = shift if @_;
428 return $self->{limit_dialect};
433 $self->{quote_char} = shift if @_;
434 return $self->{quote_char};
439 $self->{name_sep} = shift if @_;
440 return $self->{name_sep};
451 DBIx::Class::SQLAHacks - This module is a subclass of SQL::Abstract::Limit
452 and includes a number of DBIC-specific workarounds, not yet suitable for
453 inclusion into SQLA proper.
459 Tries to determine limit dialect.
463 Quotes table names, handles "limit" dialects (e.g. where rownum between x and
464 y), supports SELECT ... FOR UPDATE and SELECT ... FOR SHARE.
466 =head2 insert update delete
468 Just quotes table names.
472 Specifies the dialect of used for implementing an SQL "limit" clause for
473 restricting the number of query results returned. Valid values are: RowNum.
475 See L<DBIx::Class::Storage::DBI/connect_info> for details.
479 Character separating quoted table names.
481 See L<DBIx::Class::Storage::DBI/connect_info> for details.
485 Set to an array-ref to specify separate left and right quotes for table names.
487 See L<DBIx::Class::Storage::DBI/connect_info> for details.