1 package # Hide from PAUSE
2 DBIx::Class::SQLAHacks;
4 use base qw/SQL::Abstract::Limit/;
7 use Carp::Clan qw/^DBIx::Class/;
10 my $self = shift->SUPER::new(@_);
12 # This prevents the caching of $dbh in S::A::L, I believe
13 # If limit_dialect is a ref (like a $dbh), go ahead and replace
14 # it with what it resolves to:
15 $self->{limit_dialect} = $self->_find_syntax($self->{limit_dialect})
16 if ref $self->{limit_dialect};
22 # Some databases (sqlite) do not handle multiple parenthesis
23 # around in/between arguments. A tentative x IN ( ( 1, 2 ,3) )
24 # is interpreted as x IN 1 or something similar.
26 # Since we currently do not have access to the SQLA AST, resort
27 # to barbaric mutilation of any SQL supplied in literal form
29 sub _strip_outer_paren {
30 my ($self, $arg) = @_;
32 return $self->_SWITCH_refkind ($arg, {
34 $$arg->[0] = __strip_outer_paren ($$arg->[0]);
38 return \__strip_outer_paren( $$arg );
46 sub __strip_outer_paren {
49 if ($sql and not ref $sql) {
50 while ($sql =~ /^ \s* \( (.*) \) \s* $/x ) {
59 my ($self, $lhs, $op, $rhs) = @_;
60 $rhs = $self->_strip_outer_paren ($rhs);
61 return $self->SUPER::_where_field_IN ($lhs, $op, $rhs);
64 sub _where_field_BETWEEN {
65 my ($self, $lhs, $op, $rhs) = @_;
66 $rhs = $self->_strip_outer_paren ($rhs);
67 return $self->SUPER::_where_field_BETWEEN ($lhs, $op, $rhs);
72 # DB2 is the only remaining DB using this. Even though we are not sure if
73 # RowNumberOver is still needed here (should be part of SQLA) leave the
76 my ($self, $sql, $order, $rows, $offset ) = @_;
79 my $last = $rows + $offset - 1;
80 my ( $order_by ) = $self->_order_by( $order );
85 SELECT Q1.*, ROW_NUMBER() OVER( ) AS ROW_NUM FROM (
90 WHERE ROW_NUM BETWEEN $offset AND $last
98 # While we're at it, this should make LIMIT queries more efficient,
99 # without digging into things too deeply
100 use Scalar::Util 'blessed';
102 my ($self, $syntax) = @_;
104 # DB2 is the only remaining DB using this. Even though we are not sure if
105 # RowNumberOver is still needed here (should be part of SQLA) leave the
107 my $dbhname = blessed($syntax) ? $syntax->{Driver}{Name} : $syntax;
108 if(ref($self) && $dbhname) {
109 if ($dbhname eq 'DB2') {
110 return 'RowNumberOver';
114 $self->{_cached_syntax} ||= $self->SUPER::_find_syntax($syntax);
118 my ($self, $table, $fields, $where, $order, @rest) = @_;
119 local $self->{having_bind} = [];
120 local $self->{from_bind} = [];
122 if (ref $table eq 'SCALAR') {
125 elsif (not ref $table) {
126 $table = $self->_quote($table);
128 local $self->{rownum_hack_count} = 1
129 if (defined $rest[0] && $self->{limit_dialect} eq 'RowNum');
130 @rest = (-1) unless defined $rest[0];
131 croak "LIMIT 0 Does Not Compute" if $rest[0] == 0;
132 # and anyway, SQL::Abstract::Limit will cause a barf if we don't first
133 my ($sql, @where_bind) = $self->SUPER::select(
134 $table, $self->_recurse_fields($fields), $where, $order, @rest
139 $self->{for} eq 'update' ? ' FOR UPDATE' :
140 $self->{for} eq 'shared' ? ' FOR SHARE' :
145 return wantarray ? ($sql, @{$self->{from_bind}}, @where_bind, @{$self->{having_bind}}) : $sql;
151 $table = $self->_quote($table) unless ref($table);
152 $self->SUPER::insert($table, @_);
158 $table = $self->_quote($table) unless ref($table);
159 $self->SUPER::update($table, @_);
165 $table = $self->_quote($table) unless ref($table);
166 $self->SUPER::delete($table, @_);
172 return $_[1].$self->_order_by($_[2]);
174 return $self->SUPER::_emulate_limit(@_);
178 sub _recurse_fields {
179 my ($self, $fields, $params) = @_;
180 my $ref = ref $fields;
181 return $self->_quote($fields) unless $ref;
182 return $$fields if $ref eq 'SCALAR';
184 if ($ref eq 'ARRAY') {
185 return join(', ', map {
186 $self->_recurse_fields($_)
187 .(exists $self->{rownum_hack_count} && !($params && $params->{no_rownum_hack})
188 ? ' AS col'.$self->{rownum_hack_count}++
191 } elsif ($ref eq 'HASH') {
192 foreach my $func (keys %$fields) {
193 if ($func eq 'distinct') {
194 my $_fields = $fields->{$func};
195 if (ref $_fields eq 'ARRAY' && @{$_fields} > 1) {
197 'The select => { distinct => ... } syntax is not supported for multiple columns.'
198 .' Instead please use { group_by => [ qw/' . (join ' ', @$_fields) . '/ ] }'
199 .' or { select => [ qw/' . (join ' ', @$_fields) . '/ ], distinct => 1 }'
203 $_fields = @{$_fields}[0] if ref $_fields eq 'ARRAY';
205 'The select => { distinct => ... } syntax will be deprecated in DBIC version 0.09,'
206 ." please use { group_by => '${_fields}' } or { select => '${_fields}', distinct => 1 }"
210 return $self->_sqlcase($func)
211 .'( '.$self->_recurse_fields($fields->{$func}).' )';
214 # Is the second check absolutely necessary?
215 elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
216 return $self->_fold_sqlbind( $fields );
219 croak($ref . qq{ unexpected in _recurse_fields()})
227 if (ref $_[0] eq 'HASH') {
228 if (defined $_[0]->{group_by}) {
229 $ret = $self->_sqlcase(' group by ')
230 .$self->_recurse_fields($_[0]->{group_by}, { no_rownum_hack => 1 });
232 if (defined $_[0]->{having}) {
234 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
235 push(@{$self->{having_bind}}, @extra);
236 $ret .= $self->_sqlcase(' having ').$frag;
238 if (defined $_[0]->{order_by}) {
239 $ret .= $self->_order_by($_[0]->{order_by});
241 if (grep { $_ =~ /^-(desc|asc)/i } keys %{$_[0]}) {
242 return $self->SUPER::_order_by($_[0]);
244 } elsif (ref $_[0] eq 'SCALAR') {
245 $ret = $self->_sqlcase(' order by ').${ $_[0] };
246 } elsif (ref $_[0] eq 'ARRAY' && @{$_[0]}) {
247 my @order = @{+shift};
248 $ret = $self->_sqlcase(' order by ')
250 my $r = $self->_order_by($_, @_);
251 $r =~ s/^ ?ORDER BY //i;
255 $ret = $self->SUPER::_order_by(@_);
260 sub _order_directions {
261 my ($self, $order) = @_;
262 $order = $order->{order_by} if ref $order eq 'HASH';
263 if (ref $order eq 'HASH') {
264 $order = [$self->_order_directions_hash($order)];
265 } elsif (ref $order eq 'ARRAY') {
267 if (ref $_ eq 'HASH') {
268 $self->_order_directions_hash($_);
274 return $self->SUPER::_order_directions($order);
277 sub _order_directions_hash {
278 my ($self, $order) = @_;
280 foreach my $key (keys %{ $order }) {
281 if ($key =~ /^-(desc|asc)/i ) {
283 my $type = ref $order->{ $key };
284 if ($type eq 'ARRAY') {
285 push @new_order, map( "$_ $direction", @{ $order->{ $key } } );
287 push @new_order, "$order->{$key} $direction";
289 croak "hash order_by can only contain Scalar or Array, not $type";
292 croak "$key is not a valid direction, use -asc or -desc";
299 my ($self, $from) = @_;
300 if (ref $from eq 'ARRAY') {
301 return $self->_recurse_from(@$from);
302 } elsif (ref $from eq 'HASH') {
303 return $self->_make_as($from);
305 return $from; # would love to quote here but _table ends up getting called
306 # twice during an ->select without a limit clause due to
307 # the way S::A::Limit->select works. should maybe consider
308 # bypassing this and doing S::A::select($self, ...) in
309 # our select method above. meantime, quoting shims have
310 # been added to select/insert/update/delete here
315 my ($self, $from, @join) = @_;
317 push(@sqlf, $self->_make_as($from));
318 foreach my $j (@join) {
321 # check whether a join type exists
322 my $join_clause = '';
323 my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
324 if (ref($to_jt) eq 'HASH' and exists($to_jt->{-join_type})) {
325 $join_clause = ' '.uc($to_jt->{-join_type}).' JOIN ';
327 $join_clause = ' JOIN ';
329 push(@sqlf, $join_clause);
331 if (ref $to eq 'ARRAY') {
332 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
334 push(@sqlf, $self->_make_as($to));
336 push(@sqlf, ' ON ', $self->_join_condition($on));
338 return join('', @sqlf);
342 my ($self, $sqlbind) = @_;
343 my $sql = shift @$$sqlbind;
344 push @{$self->{from_bind}}, @$$sqlbind;
349 my ($self, $from) = @_;
350 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_
351 : ref $_ eq 'REF' ? $self->_fold_sqlbind($_)
353 } reverse each %{$self->_skip_options($from)});
357 my ($self, $hash) = @_;
359 $clean_hash->{$_} = $hash->{$_}
360 for grep {!/^-/} keys %$hash;
364 sub _join_condition {
365 my ($self, $cond) = @_;
366 if (ref $cond eq 'HASH') {
371 croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
372 if ref($v) ne 'SCALAR';
376 my $x = '= '.$self->_quote($v); $j{$_} = \$x;
379 return scalar($self->_recurse_where(\%j));
380 } elsif (ref $cond eq 'ARRAY') {
381 return join(' OR ', map { $self->_join_condition($_) } @$cond);
383 die "Can't handle this yet!";
388 my ($self, $label) = @_;
389 return '' unless defined $label;
390 return "*" if $label eq '*';
391 return $label unless $self->{quote_char};
392 if(ref $self->{quote_char} eq "ARRAY"){
393 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
394 if !defined $self->{name_sep};
395 my $sep = $self->{name_sep};
396 return join($self->{name_sep},
397 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
398 split(/\Q$sep\E/,$label));
400 return $self->SUPER::_quote($label);
405 $self->{limit_dialect} = shift if @_;
406 return $self->{limit_dialect};
411 $self->{quote_char} = shift if @_;
412 return $self->{quote_char};
417 $self->{name_sep} = shift if @_;
418 return $self->{name_sep};
429 DBIx::Class::SQLAHacks - This module is a subclass of SQL::Abstract::Limit
430 and includes a number of DBIC-specific workarounds, not yet suitable for
431 inclusion into SQLA proper.
437 Tries to determine limit dialect.
441 Quotes table names, handles "limit" dialects (e.g. where rownum between x and
442 y), supports SELECT ... FOR UPDATE and SELECT ... FOR SHARE.
444 =head2 insert update delete
446 Just quotes table names.
450 Specifies the dialect of used for implementing an SQL "limit" clause for
451 restricting the number of query results returned. Valid values are: RowNum.
453 See L<DBIx::Class::Storage::DBI/connect_info> for details.
457 Character separating quoted table names.
459 See L<DBIx::Class::Storage::DBI/connect_info> for details.
463 Set to an array-ref to specify separate left and right quotes for table names.
465 See L<DBIx::Class::Storage::DBI/connect_info> for details.