1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.87';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{special_ops} ||= [];
160 # regexes are applied in order, thus push after user-defines
161 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 if ($class->isa('DBIx::Class::SQLMaker')) {
164 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
165 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
167 $opt{is_dbic_sqlmaker} = 1;
171 $opt{unary_ops} ||= [];
173 # rudimentary sanity-check for user supplied bits treated as functions/operators
174 # If a purported function matches this regular expression, an exception is thrown.
175 # Literal SQL is *NOT* subject to this check, only functions (and column names
176 # when quoting is not in effect)
179 # need to guard against ()'s in column names too, but this will break tons of
180 # hacks... ideas anyone?
181 $opt{injection_guard} ||= qr/
187 $opt{expand_unary} = {};
190 -not => '_expand_not',
191 -bool => '_expand_bool',
192 -and => '_expand_op_andor',
193 -or => '_expand_op_andor',
194 -nest => '_expand_nest',
198 'between' => '_expand_between',
199 'not between' => '_expand_between',
200 'in' => '_expand_in',
201 'not in' => '_expand_in',
202 'nest' => '_expand_nest',
203 (map +($_ => '_expand_op_andor'),
207 # placeholder for _expand_unop system
209 my %unops = (-ident => '_expand_ident', -value => '_expand_value');
210 foreach my $name (keys %unops) {
211 $opt{expand}{$name} = $unops{$name};
212 my ($op) = $name =~ /^-(.*)$/;
213 $opt{expand_op}{$op} = sub {
214 my ($self, $op, $arg, $k) = @_;
217 $self->_expand_ident(-ident => $k),
218 $self->_expand_expr({ '-'.$op => $arg }),
225 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
229 $opt{render_op} = our $RENDER_OP;
231 return bless \%opt, $class;
234 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
235 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
237 sub _assert_pass_injection_guard {
238 if ($_[1] =~ $_[0]->{injection_guard}) {
239 my $class = ref $_[0];
240 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
241 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
242 . "{injection_guard} attribute to ${class}->new()"
247 #======================================================================
249 #======================================================================
253 my $table = $self->_table(shift);
254 my $data = shift || return;
257 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
258 my ($sql, @bind) = $self->$method($data);
259 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
261 if ($options->{returning}) {
262 my ($s, @b) = $self->_insert_returning($options);
267 return wantarray ? ($sql, @bind) : $sql;
270 # So that subclasses can override INSERT ... RETURNING separately from
271 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
272 sub _insert_returning { shift->_returning(@_) }
275 my ($self, $options) = @_;
277 my $f = $options->{returning};
279 my ($sql, @bind) = $self->render_aqt(
280 $self->_expand_maybe_list_expr($f, undef, -ident)
283 ? $self->_sqlcase(' returning ') . $sql
284 : ($self->_sqlcase(' returning ').$sql, @bind);
287 sub _insert_HASHREF { # explicit list of fields and then values
288 my ($self, $data) = @_;
290 my @fields = sort keys %$data;
292 my ($sql, @bind) = $self->_insert_values($data);
295 $_ = $self->_quote($_) foreach @fields;
296 $sql = "( ".join(", ", @fields).") ".$sql;
298 return ($sql, @bind);
301 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
302 my ($self, $data) = @_;
304 # no names (arrayref) so can't generate bindtype
305 $self->{bindtype} ne 'columns'
306 or belch "can't do 'columns' bindtype when called with arrayref";
308 my (@values, @all_bind);
309 foreach my $value (@$data) {
310 my ($values, @bind) = $self->_insert_value(undef, $value);
311 push @values, $values;
312 push @all_bind, @bind;
314 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
315 return ($sql, @all_bind);
318 sub _insert_ARRAYREFREF { # literal SQL with bind
319 my ($self, $data) = @_;
321 my ($sql, @bind) = @${$data};
322 $self->_assert_bindval_matches_bindtype(@bind);
324 return ($sql, @bind);
328 sub _insert_SCALARREF { # literal SQL without bind
329 my ($self, $data) = @_;
335 my ($self, $data) = @_;
337 my (@values, @all_bind);
338 foreach my $column (sort keys %$data) {
339 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
340 push @values, $values;
341 push @all_bind, @bind;
343 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
344 return ($sql, @all_bind);
348 my ($self, $column, $v) = @_;
350 return $self->render_aqt(
351 $self->_expand_insert_value($column, $v)
355 sub _expand_insert_value {
356 my ($self, $column, $v) = @_;
358 if (ref($v) eq 'ARRAY') {
359 if ($self->{array_datatypes}) {
360 return +{ -bind => [ $column, $v ] };
362 my ($sql, @bind) = @$v;
363 $self->_assert_bindval_matches_bindtype(@bind);
364 return +{ -literal => $v };
366 if (ref($v) eq 'HASH') {
367 if (grep !/^-/, keys %$v) {
368 belch "HASH ref as bind value in insert is not supported";
369 return +{ -bind => [ $column, $v ] };
373 return +{ -bind => [ $column, undef ] };
375 local our $Cur_Col_Meta = $column;
376 return $self->expand_expr($v);
381 #======================================================================
383 #======================================================================
388 my $table = $self->_table(shift);
389 my $data = shift || return;
393 # first build the 'SET' part of the sql statement
394 puke "Unsupported data type specified to \$sql->update"
395 unless ref $data eq 'HASH';
397 my ($sql, @all_bind) = $self->_update_set_values($data);
398 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
402 my($where_sql, @where_bind) = $self->where($where);
404 push @all_bind, @where_bind;
407 if ($options->{returning}) {
408 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
409 $sql .= $returning_sql;
410 push @all_bind, @returning_bind;
413 return wantarray ? ($sql, @all_bind) : $sql;
416 sub _update_set_values {
417 my ($self, $data) = @_;
419 return $self->render_aqt(
420 $self->_expand_update_set_values($data),
424 sub _expand_update_set_values {
425 my ($self, $data) = @_;
426 $self->_expand_maybe_list_expr( [
429 $set = { -bind => $_ } unless defined $set;
430 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
436 ? ($self->{array_datatypes}
437 ? [ $k, +{ -bind => [ $k, $v ] } ]
438 : [ $k, +{ -literal => $v } ])
440 local our $Cur_Col_Meta = $k;
441 [ $k, $self->_expand_expr($v) ]
448 # So that subclasses can override UPDATE ... RETURNING separately from
450 sub _update_returning { shift->_returning(@_) }
454 #======================================================================
456 #======================================================================
461 my $table = $self->_table(shift);
462 my $fields = shift || '*';
466 my ($fields_sql, @bind) = $self->_select_fields($fields);
468 my ($where_sql, @where_bind) = $self->where($where, $order);
469 push @bind, @where_bind;
471 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
472 $self->_sqlcase('from'), $table)
475 return wantarray ? ($sql, @bind) : $sql;
479 my ($self, $fields) = @_;
480 return $fields unless ref($fields);
481 return $self->render_aqt(
482 $self->_expand_maybe_list_expr($fields, undef, '-ident')
486 #======================================================================
488 #======================================================================
493 my $table = $self->_table(shift);
497 my($where_sql, @bind) = $self->where($where);
498 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
500 if ($options->{returning}) {
501 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
502 $sql .= $returning_sql;
503 push @bind, @returning_bind;
506 return wantarray ? ($sql, @bind) : $sql;
509 # So that subclasses can override DELETE ... RETURNING separately from
511 sub _delete_returning { shift->_returning(@_) }
515 #======================================================================
517 #======================================================================
521 # Finally, a separate routine just to handle WHERE clauses
523 my ($self, $where, $order) = @_;
525 local $self->{convert_where} = $self->{convert};
528 my ($sql, @bind) = defined($where)
529 ? $self->_recurse_where($where)
531 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
535 my ($order_sql, @order_bind) = $self->_order_by($order);
537 push @bind, @order_bind;
540 return wantarray ? ($sql, @bind) : $sql;
544 my ($self, $expr, $default_scalar_to) = @_;
545 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
546 $self->_expand_expr($expr);
550 my ($self, $aqt) = @_;
551 my ($k, $v, @rest) = %$aqt;
553 if (my $meth = $self->{render}{$k}) {
554 return $self->$meth($v);
556 die "notreached: $k";
560 my ($self, $expr) = @_;
561 $self->render_aqt($self->expand_expr($expr));
565 my ($self, $expr) = @_;
566 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
567 return undef unless defined($expr);
568 if (ref($expr) eq 'HASH') {
569 return undef unless my $kc = keys %$expr;
571 return $self->_expand_op_andor(-and => $expr);
573 my ($key, $value) = %$expr;
574 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
575 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
576 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
578 if (my $exp = $self->{expand}{$key}) {
579 return $self->$exp($key, $value);
581 return $self->_expand_expr_hashpair($key, $value);
583 if (ref($expr) eq 'ARRAY') {
584 my $logic = '-'.lc($self->{logic});
585 return $self->_expand_op_andor($logic, $expr);
587 if (my $literal = is_literal_value($expr)) {
588 return +{ -literal => $literal };
590 if (!ref($expr) or Scalar::Util::blessed($expr)) {
591 if (my $d = our $Default_Scalar_To) {
592 return $self->_expand_expr({ $d => $expr });
594 return $self->_expand_value(-value => $expr);
599 sub _expand_expr_hashpair {
600 my ($self, $k, $v) = @_;
601 unless (defined($k) and length($k)) {
602 if (defined($k) and my $literal = is_literal_value($v)) {
603 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
604 return { -literal => $literal };
606 puke "Supplying an empty left hand side argument is not supported";
608 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s) if $k =~ /^-/;
610 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
613 $self->_expand_expr({ "-${rest}", $v })
618 $op =~ s/^-// if length($op) > 1;
620 # top level special ops are illegal in general
621 # note that, arguably, if it makes no sense at top level, it also
622 # makes no sense on the other side of an = sign or similar but DBIC
623 # gets disappointingly upset if I disallow it
625 (our $Expand_Depth) == 1
626 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
628 puke "Illegal use of top-level '-$op'"
630 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
631 return { -op => [ $op, $v ] };
634 if ($self->{render}{$k}) {
640 and (keys %$v)[0] =~ /^-/
642 my ($func) = $k =~ /^-(.*)$/;
643 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
644 return +{ -op => [ $func, $self->_expand_expr($v) ] };
646 return +{ -func => [ $func, $self->_expand_expr($v) ] };
648 if (!ref($v) or is_literal_value($v)) {
649 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
656 and exists $v->{-value}
657 and not defined $v->{-value}
660 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
662 if (!ref($v) or Scalar::Util::blessed($v)) {
663 my $d = our $Default_Scalar_To;
667 $self->_expand_ident(-ident => $k),
669 ? $self->_expand_expr($d => $v)
670 : { -bind => [ $k, $v ] }
675 if (ref($v) eq 'HASH') {
677 return $self->_expand_op_andor(-and => [
678 map +{ $k => { $_ => $v->{$_} } },
682 return undef unless keys %$v;
684 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
685 $self->_assert_pass_injection_guard($op);
686 if ($op =~ s/ [_\s]? \d+ $//x ) {
687 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
688 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
690 if (my $x = $self->{expand_op}{$op}) {
691 local our $Cur_Col_Meta = $k;
692 return $self->$x($op, $vv, $k);
694 if ($op =~ /^is(?: not)?$/) {
695 puke "$op can only take undef as argument"
699 and exists($vv->{-value})
700 and !defined($vv->{-value})
702 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
704 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
705 return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
707 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
710 $self->_expand_ident(-ident => $k),
711 { -op => [ $op, $vv ] }
714 if (ref($vv) eq 'ARRAY') {
715 my ($logic, @values) = (
716 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
721 $op =~ $self->{inequality_op}
722 or $op =~ $self->{not_like_op}
724 if (lc($logic) eq '-or' and @values > 1) {
725 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
726 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
727 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
732 # try to DWIM on equality operators
734 $op =~ $self->{equality_op} ? $self->sqlfalse
735 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
736 : $op =~ $self->{inequality_op} ? $self->sqltrue
737 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
738 : puke "operator '$op' applied on an empty array (field '$k')";
740 return $self->_expand_op_andor($logic => [
741 map +{ $k => { $vk => $_ } },
749 and exists $vv->{-value}
750 and not defined $vv->{-value}
754 $op =~ /^not$/i ? 'is not' # legacy
755 : $op =~ $self->{equality_op} ? 'is'
756 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
757 : $op =~ $self->{inequality_op} ? 'is not'
758 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
759 : puke "unexpected operator '$op' with undef operand";
760 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
762 local our $Cur_Col_Meta = $k;
765 $self->_expand_ident(-ident => $k),
766 $self->_expand_expr($vv)
769 if (ref($v) eq 'ARRAY') {
770 return $self->sqlfalse unless @$v;
771 $self->_debug("ARRAY($k) means distribute over elements");
773 $v->[0] =~ /^-(and|or)$/i
774 ? shift(@{$v = [ @$v ]})
775 : '-'.lc($self->{logic} || 'OR')
777 return $self->_expand_op_andor(
778 $logic => [ map +{ $k => $_ }, @$v ]
781 if (my $literal = is_literal_value($v)) {
783 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
786 my ($sql, @bind) = @$literal;
787 if ($self->{bindtype} eq 'columns') {
789 $self->_assert_bindval_matches_bindtype($_);
792 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
798 my ($self, $op, $body) = @_;
799 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
800 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
802 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
803 ref($body) ? @$body : $body;
804 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
805 unless ($self->{quote_char}) {
806 $self->_assert_pass_injection_guard($_) for @parts;
808 return +{ -ident => \@parts };
812 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
816 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
820 my ($self, undef, $v) = @_;
822 return $self->_expand_expr($v);
824 puke "-bool => undef not supported" unless defined($v);
825 return $self->_expand_ident(-ident => $v);
828 sub _expand_op_andor {
829 my ($self, $logic, $v, $k) = @_;
831 $v = [ map +{ $k, { $_ => $v->{$_} } },
834 my ($logop) = $logic =~ /^-?(.*)$/;
835 if (ref($v) eq 'HASH') {
838 map $self->_expand_expr({ $_ => $v->{$_} }),
842 if (ref($v) eq 'ARRAY') {
843 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
846 (ref($_) eq 'ARRAY' and @$_)
847 or (ref($_) eq 'HASH' and %$_)
853 while (my ($el) = splice @expr, 0, 1) {
854 puke "Supplying an empty left hand side argument is not supported in array-pairs"
855 unless defined($el) and length($el);
856 my $elref = ref($el);
858 local our $Expand_Depth = 0;
859 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
860 } elsif ($elref eq 'ARRAY') {
861 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
862 } elsif (my $l = is_literal_value($el)) {
863 push @res, { -literal => $l };
864 } elsif ($elref eq 'HASH') {
865 local our $Expand_Depth = 0;
866 push @res, grep defined, $self->_expand_expr($el) if %$el;
872 # return $res[0] if @res == 1;
873 return { -op => [ $logop, @res ] };
878 sub _expand_between {
879 my ($self, $op, $vv, $k) = @_;
880 local our $Cur_Col_Meta = $k;
881 my @rhs = map $self->_expand_expr($_),
882 ref($vv) eq 'ARRAY' ? @$vv : $vv;
884 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
886 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
888 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
892 $self->_expand_ident(-ident => $k),
898 my ($self, $op, $vv, $k) = @_;
899 if (my $literal = is_literal_value($vv)) {
900 my ($sql, @bind) = @$literal;
901 my $opened_sql = $self->_open_outer_paren($sql);
903 $op, $self->_expand_ident(-ident => $k),
904 [ { -literal => [ $opened_sql, @bind ] } ]
908 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
909 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
910 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
911 . 'will emit the logically correct SQL instead of raising this exception)'
913 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
915 my @rhs = map $self->_expand_expr($_),
916 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
917 map { defined($_) ? $_: puke($undef_err) }
918 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
919 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
923 $self->_expand_ident(-ident => $k),
929 my ($self, $op, $v) = @_;
930 # DBIx::Class requires a nest warning to be emitted once but the private
931 # method it overrode to do so no longer exists
932 if ($self->{is_dbic_sqlmaker}) {
933 unless (our $Nest_Warned) {
935 "-nest in search conditions is deprecated, you most probably wanted:\n"
936 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
941 return $self->_expand_expr($v);
945 my ($self, $where, $logic) = @_;
947 # Special case: top level simple string treated as literal
949 my $where_exp = (ref($where)
950 ? $self->_expand_expr($where, $logic)
951 : { -literal => [ $where ] });
953 # dispatch expanded expression
955 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
956 # DBIx::Class used to call _recurse_where in scalar context
957 # something else might too...
959 return ($sql, @bind);
962 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
968 my ($self, $ident) = @_;
970 return $self->_convert($self->_quote($ident));
974 my ($self, $list) = @_;
975 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
976 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
980 my ($self, $rest) = @_;
981 my ($func, @args) = @$rest;
985 push @arg_sql, shift @x;
987 } map [ $self->render_aqt($_) ], @args;
988 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
992 my ($self, $bind) = @_;
993 return ($self->_convert('?'), $self->_bindtype(@$bind));
996 sub _render_literal {
997 my ($self, $literal) = @_;
998 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1004 my ($self, $op, $args) = @_;
1005 my ($left, $low, $high) = @$args;
1006 my ($rhsql, @rhbind) = do {
1008 puke "Single arg to between must be a literal"
1009 unless $low->{-literal};
1012 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1013 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1014 @{$l}[1..$#$l], @{$h}[1..$#$h])
1017 my ($lhsql, @lhbind) = $self->render_aqt($left);
1019 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1022 }), 'between', 'not between'),
1024 my ($self, $op, $args) = @_;
1025 my ($lhs, $rhs) = @$args;
1028 my ($sql, @bind) = $self->render_aqt($_);
1029 push @in_bind, @bind;
1032 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1034 $lhsql.' '.$self->_sqlcase($op).' ( '
1035 .join(', ', @in_sql)
1039 }), 'in', 'not in'),
1040 (map +($_ => '_render_unop_postfix'),
1041 'is null', 'is not null', 'asc', 'desc',
1043 (not => '_render_op_not'),
1045 my ($self, $op, $args) = @_;
1046 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1047 return '' unless @parts;
1048 return @{$parts[0]} if @parts == 1;
1049 my ($final_sql) = join(
1050 ' '.$self->_sqlcase($op).' ',
1055 map @{$_}[1..$#$_], @parts
1061 my ($self, $v) = @_;
1062 my ($op, @args) = @$v;
1063 if (my $r = $self->{render_op}{$op}) {
1064 return $self->$r($op, \@args);
1066 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1067 if ($us and @args > 1) {
1068 puke "Special op '${op}' requires first value to be identifier"
1069 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1070 my $k = join(($self->{name_sep}||'.'), @$ident);
1071 local our $Expand_Depth = 1;
1072 return $self->${\($us->{handler})}($k, $op, $args[1]);
1074 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1075 return $self->${\($us->{handler})}($op, $args[0]);
1078 return $self->_render_unop_prefix($op, \@args);
1080 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1081 return '' unless @parts;
1082 my ($final_sql) = join(
1083 ' '.$self->_sqlcase($op).' ',
1088 map @{$_}[1..$#$_], @parts
1094 sub _render_op_not {
1095 my ($self, $op, $v) = @_;
1096 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1097 return "(${sql})", @bind;
1100 sub _render_unop_prefix {
1101 my ($self, $op, $v) = @_;
1102 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1103 my $op_sql = $self->_sqlcase($op);
1104 return ("${op_sql} ${expr_sql}", @bind);
1107 sub _render_unop_postfix {
1108 my ($self, $op, $v) = @_;
1109 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1110 my $op_sql = $self->_sqlcase($op);
1111 return ($expr_sql.' '.$op_sql, @bind);
1114 # Some databases (SQLite) treat col IN (1, 2) different from
1115 # col IN ( (1, 2) ). Use this to strip all outer parens while
1116 # adding them back in the corresponding method
1117 sub _open_outer_paren {
1118 my ($self, $sql) = @_;
1120 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1122 # there are closing parens inside, need the heavy duty machinery
1123 # to reevaluate the extraction starting from $sql (full reevaluation)
1124 if ($inner =~ /\)/) {
1125 require Text::Balanced;
1127 my (undef, $remainder) = do {
1128 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1130 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1133 # the entire expression needs to be a balanced bracketed thing
1134 # (after an extract no remainder sans trailing space)
1135 last if defined $remainder and $remainder =~ /\S/;
1145 #======================================================================
1147 #======================================================================
1149 sub _expand_order_by {
1150 my ($self, $arg) = @_;
1152 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1154 my $expander = sub {
1155 my ($self, $dir, $expr) = @_;
1156 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1157 foreach my $arg (@to_expand) {
1161 and grep /^-(asc|desc)$/, keys %$arg
1163 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1167 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1169 map $self->expand_expr($_, -ident),
1170 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1171 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1174 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1176 return $self->$expander(undef, $arg);
1180 my ($self, $arg) = @_;
1182 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1184 my ($sql, @bind) = $self->render_aqt($expanded);
1186 return '' unless length($sql);
1188 my $final_sql = $self->_sqlcase(' order by ').$sql;
1190 return wantarray ? ($final_sql, @bind) : $final_sql;
1193 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1195 sub _order_by_chunks {
1196 my ($self, $arg) = @_;
1198 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1200 return $self->_chunkify_order_by($expanded);
1203 sub _chunkify_order_by {
1204 my ($self, $expanded) = @_;
1206 return grep length, $self->render_aqt($expanded)
1207 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1210 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1211 return map $self->_chunkify_order_by($_), @$l;
1213 return [ $self->render_aqt($_) ];
1217 #======================================================================
1218 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1219 #======================================================================
1225 $self->_expand_maybe_list_expr($from, undef, -ident)
1230 #======================================================================
1232 #======================================================================
1234 sub _expand_maybe_list_expr {
1235 my ($self, $expr, $logic, $default) = @_;
1237 if (ref($expr) eq 'ARRAY') {
1239 map $self->expand_expr($_, $default), @$expr
1246 return $self->expand_expr($e, $default);
1249 # highly optimized, as it's called way too often
1251 # my ($self, $label) = @_;
1253 return '' unless defined $_[1];
1254 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1255 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1257 unless ($_[0]->{quote_char}) {
1258 if (ref($_[1]) eq 'ARRAY') {
1259 return join($_[0]->{name_sep}||'.', @{$_[1]});
1261 $_[0]->_assert_pass_injection_guard($_[1]);
1266 my $qref = ref $_[0]->{quote_char};
1268 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1269 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1270 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1272 my $esc = $_[0]->{escape_char} || $r;
1274 # parts containing * are naturally unquoted
1276 $_[0]->{name_sep}||'',
1280 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1282 (ref($_[1]) eq 'ARRAY'
1286 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1294 # Conversion, if applicable
1296 #my ($self, $arg) = @_;
1297 if ($_[0]->{convert_where}) {
1298 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1305 #my ($self, $col, @vals) = @_;
1306 # called often - tighten code
1307 return $_[0]->{bindtype} eq 'columns'
1308 ? map {[$_[1], $_]} @_[2 .. $#_]
1313 # Dies if any element of @bind is not in [colname => value] format
1314 # if bindtype is 'columns'.
1315 sub _assert_bindval_matches_bindtype {
1316 # my ($self, @bind) = @_;
1318 if ($self->{bindtype} eq 'columns') {
1320 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1321 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1327 sub _join_sql_clauses {
1328 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1330 if (@$clauses_aref > 1) {
1331 my $join = " " . $self->_sqlcase($logic) . " ";
1332 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1333 return ($sql, @$bind_aref);
1335 elsif (@$clauses_aref) {
1336 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1339 return (); # if no SQL, ignore @$bind_aref
1344 # Fix SQL case, if so requested
1346 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1347 # don't touch the argument ... crooked logic, but let's not change it!
1348 return $_[0]->{case} ? $_[1] : uc($_[1]);
1352 #======================================================================
1353 # DISPATCHING FROM REFKIND
1354 #======================================================================
1357 my ($self, $data) = @_;
1359 return 'UNDEF' unless defined $data;
1361 # blessed objects are treated like scalars
1362 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1364 return 'SCALAR' unless $ref;
1367 while ($ref eq 'REF') {
1369 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1373 return ($ref||'SCALAR') . ('REF' x $n_steps);
1377 my ($self, $data) = @_;
1378 my @try = ($self->_refkind($data));
1379 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1380 push @try, 'FALLBACK';
1384 sub _METHOD_FOR_refkind {
1385 my ($self, $meth_prefix, $data) = @_;
1388 for (@{$self->_try_refkind($data)}) {
1389 $method = $self->can($meth_prefix."_".$_)
1393 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1397 sub _SWITCH_refkind {
1398 my ($self, $data, $dispatch_table) = @_;
1401 for (@{$self->_try_refkind($data)}) {
1402 $coderef = $dispatch_table->{$_}
1406 puke "no dispatch entry for ".$self->_refkind($data)
1415 #======================================================================
1416 # VALUES, GENERATE, AUTOLOAD
1417 #======================================================================
1419 # LDNOTE: original code from nwiger, didn't touch code in that section
1420 # I feel the AUTOLOAD stuff should not be the default, it should
1421 # only be activated on explicit demand by user.
1425 my $data = shift || return;
1426 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1427 unless ref $data eq 'HASH';
1430 foreach my $k (sort keys %$data) {
1431 my $v = $data->{$k};
1432 $self->_SWITCH_refkind($v, {
1434 if ($self->{array_datatypes}) { # array datatype
1435 push @all_bind, $self->_bindtype($k, $v);
1437 else { # literal SQL with bind
1438 my ($sql, @bind) = @$v;
1439 $self->_assert_bindval_matches_bindtype(@bind);
1440 push @all_bind, @bind;
1443 ARRAYREFREF => sub { # literal SQL with bind
1444 my ($sql, @bind) = @${$v};
1445 $self->_assert_bindval_matches_bindtype(@bind);
1446 push @all_bind, @bind;
1448 SCALARREF => sub { # literal SQL without bind
1450 SCALAR_or_UNDEF => sub {
1451 push @all_bind, $self->_bindtype($k, $v);
1462 my(@sql, @sqlq, @sqlv);
1466 if ($ref eq 'HASH') {
1467 for my $k (sort keys %$_) {
1470 my $label = $self->_quote($k);
1471 if ($r eq 'ARRAY') {
1472 # literal SQL with bind
1473 my ($sql, @bind) = @$v;
1474 $self->_assert_bindval_matches_bindtype(@bind);
1475 push @sqlq, "$label = $sql";
1477 } elsif ($r eq 'SCALAR') {
1478 # literal SQL without bind
1479 push @sqlq, "$label = $$v";
1481 push @sqlq, "$label = ?";
1482 push @sqlv, $self->_bindtype($k, $v);
1485 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1486 } elsif ($ref eq 'ARRAY') {
1487 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1490 if ($r eq 'ARRAY') { # literal SQL with bind
1491 my ($sql, @bind) = @$v;
1492 $self->_assert_bindval_matches_bindtype(@bind);
1495 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1496 # embedded literal SQL
1503 push @sql, '(' . join(', ', @sqlq) . ')';
1504 } elsif ($ref eq 'SCALAR') {
1508 # strings get case twiddled
1509 push @sql, $self->_sqlcase($_);
1513 my $sql = join ' ', @sql;
1515 # this is pretty tricky
1516 # if ask for an array, return ($stmt, @bind)
1517 # otherwise, s/?/shift @sqlv/ to put it inline
1519 return ($sql, @sqlv);
1521 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1522 ref $d ? $d->[1] : $d/e;
1531 # This allows us to check for a local, then _form, attr
1533 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1534 return $self->generate($name, @_);
1545 SQL::Abstract - Generate SQL from Perl data structures
1551 my $sql = SQL::Abstract->new;
1553 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1555 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1557 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1559 my($stmt, @bind) = $sql->delete($table, \%where);
1561 # Then, use these in your DBI statements
1562 my $sth = $dbh->prepare($stmt);
1563 $sth->execute(@bind);
1565 # Just generate the WHERE clause
1566 my($stmt, @bind) = $sql->where(\%where, $order);
1568 # Return values in the same order, for hashed queries
1569 # See PERFORMANCE section for more details
1570 my @bind = $sql->values(\%fieldvals);
1574 This module was inspired by the excellent L<DBIx::Abstract>.
1575 However, in using that module I found that what I really wanted
1576 to do was generate SQL, but still retain complete control over my
1577 statement handles and use the DBI interface. So, I set out to
1578 create an abstract SQL generation module.
1580 While based on the concepts used by L<DBIx::Abstract>, there are
1581 several important differences, especially when it comes to WHERE
1582 clauses. I have modified the concepts used to make the SQL easier
1583 to generate from Perl data structures and, IMO, more intuitive.
1584 The underlying idea is for this module to do what you mean, based
1585 on the data structures you provide it. The big advantage is that
1586 you don't have to modify your code every time your data changes,
1587 as this module figures it out.
1589 To begin with, an SQL INSERT is as easy as just specifying a hash
1590 of C<key=value> pairs:
1593 name => 'Jimbo Bobson',
1594 phone => '123-456-7890',
1595 address => '42 Sister Lane',
1596 city => 'St. Louis',
1597 state => 'Louisiana',
1600 The SQL can then be generated with this:
1602 my($stmt, @bind) = $sql->insert('people', \%data);
1604 Which would give you something like this:
1606 $stmt = "INSERT INTO people
1607 (address, city, name, phone, state)
1608 VALUES (?, ?, ?, ?, ?)";
1609 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1610 '123-456-7890', 'Louisiana');
1612 These are then used directly in your DBI code:
1614 my $sth = $dbh->prepare($stmt);
1615 $sth->execute(@bind);
1617 =head2 Inserting and Updating Arrays
1619 If your database has array types (like for example Postgres),
1620 activate the special option C<< array_datatypes => 1 >>
1621 when creating the C<SQL::Abstract> object.
1622 Then you may use an arrayref to insert and update database array types:
1624 my $sql = SQL::Abstract->new(array_datatypes => 1);
1626 planets => [qw/Mercury Venus Earth Mars/]
1629 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1633 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1635 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1638 =head2 Inserting and Updating SQL
1640 In order to apply SQL functions to elements of your C<%data> you may
1641 specify a reference to an arrayref for the given hash value. For example,
1642 if you need to execute the Oracle C<to_date> function on a value, you can
1643 say something like this:
1647 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1650 The first value in the array is the actual SQL. Any other values are
1651 optional and would be included in the bind values array. This gives
1654 my($stmt, @bind) = $sql->insert('people', \%data);
1656 $stmt = "INSERT INTO people (name, date_entered)
1657 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1658 @bind = ('Bill', '03/02/2003');
1660 An UPDATE is just as easy, all you change is the name of the function:
1662 my($stmt, @bind) = $sql->update('people', \%data);
1664 Notice that your C<%data> isn't touched; the module will generate
1665 the appropriately quirky SQL for you automatically. Usually you'll
1666 want to specify a WHERE clause for your UPDATE, though, which is
1667 where handling C<%where> hashes comes in handy...
1669 =head2 Complex where statements
1671 This module can generate pretty complicated WHERE statements
1672 easily. For example, simple C<key=value> pairs are taken to mean
1673 equality, and if you want to see if a field is within a set
1674 of values, you can use an arrayref. Let's say we wanted to
1675 SELECT some data based on this criteria:
1678 requestor => 'inna',
1679 worker => ['nwiger', 'rcwe', 'sfz'],
1680 status => { '!=', 'completed' }
1683 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1685 The above would give you something like this:
1687 $stmt = "SELECT * FROM tickets WHERE
1688 ( requestor = ? ) AND ( status != ? )
1689 AND ( worker = ? OR worker = ? OR worker = ? )";
1690 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1692 Which you could then use in DBI code like so:
1694 my $sth = $dbh->prepare($stmt);
1695 $sth->execute(@bind);
1701 The methods are simple. There's one for every major SQL operation,
1702 and a constructor you use first. The arguments are specified in a
1703 similar order for each method (table, then fields, then a where
1704 clause) to try and simplify things.
1706 =head2 new(option => 'value')
1708 The C<new()> function takes a list of options and values, and returns
1709 a new B<SQL::Abstract> object which can then be used to generate SQL
1710 through the methods below. The options accepted are:
1716 If set to 'lower', then SQL will be generated in all lowercase. By
1717 default SQL is generated in "textbook" case meaning something like:
1719 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1721 Any setting other than 'lower' is ignored.
1725 This determines what the default comparison operator is. By default
1726 it is C<=>, meaning that a hash like this:
1728 %where = (name => 'nwiger', email => 'nate@wiger.org');
1730 Will generate SQL like this:
1732 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1734 However, you may want loose comparisons by default, so if you set
1735 C<cmp> to C<like> you would get SQL such as:
1737 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1739 You can also override the comparison on an individual basis - see
1740 the huge section on L</"WHERE CLAUSES"> at the bottom.
1742 =item sqltrue, sqlfalse
1744 Expressions for inserting boolean values within SQL statements.
1745 By default these are C<1=1> and C<1=0>. They are used
1746 by the special operators C<-in> and C<-not_in> for generating
1747 correct SQL even when the argument is an empty array (see below).
1751 This determines the default logical operator for multiple WHERE
1752 statements in arrays or hashes. If absent, the default logic is "or"
1753 for arrays, and "and" for hashes. This means that a WHERE
1757 event_date => {'>=', '2/13/99'},
1758 event_date => {'<=', '4/24/03'},
1761 will generate SQL like this:
1763 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1765 This is probably not what you want given this query, though (look
1766 at the dates). To change the "OR" to an "AND", simply specify:
1768 my $sql = SQL::Abstract->new(logic => 'and');
1770 Which will change the above C<WHERE> to:
1772 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1774 The logic can also be changed locally by inserting
1775 a modifier in front of an arrayref:
1777 @where = (-and => [event_date => {'>=', '2/13/99'},
1778 event_date => {'<=', '4/24/03'} ]);
1780 See the L</"WHERE CLAUSES"> section for explanations.
1784 This will automatically convert comparisons using the specified SQL
1785 function for both column and value. This is mostly used with an argument
1786 of C<upper> or C<lower>, so that the SQL will have the effect of
1787 case-insensitive "searches". For example, this:
1789 $sql = SQL::Abstract->new(convert => 'upper');
1790 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1792 Will turn out the following SQL:
1794 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1796 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1797 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1798 not validate this option; it will just pass through what you specify verbatim).
1802 This is a kludge because many databases suck. For example, you can't
1803 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1804 Instead, you have to use C<bind_param()>:
1806 $sth->bind_param(1, 'reg data');
1807 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1809 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1810 which loses track of which field each slot refers to. Fear not.
1812 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1813 Currently, you can specify either C<normal> (default) or C<columns>. If you
1814 specify C<columns>, you will get an array that looks like this:
1816 my $sql = SQL::Abstract->new(bindtype => 'columns');
1817 my($stmt, @bind) = $sql->insert(...);
1820 [ 'column1', 'value1' ],
1821 [ 'column2', 'value2' ],
1822 [ 'column3', 'value3' ],
1825 You can then iterate through this manually, using DBI's C<bind_param()>.
1827 $sth->prepare($stmt);
1830 my($col, $data) = @$_;
1831 if ($col eq 'details' || $col eq 'comments') {
1832 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1833 } elsif ($col eq 'image') {
1834 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1836 $sth->bind_param($i, $data);
1840 $sth->execute; # execute without @bind now
1842 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1843 Basically, the advantage is still that you don't have to care which fields
1844 are or are not included. You could wrap that above C<for> loop in a simple
1845 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1846 get a layer of abstraction over manual SQL specification.
1848 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1849 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1850 will expect the bind values in this format.
1854 This is the character that a table or column name will be quoted
1855 with. By default this is an empty string, but you could set it to
1856 the character C<`>, to generate SQL like this:
1858 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1860 Alternatively, you can supply an array ref of two items, the first being the left
1861 hand quote character, and the second the right hand quote character. For
1862 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1863 that generates SQL like this:
1865 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1867 Quoting is useful if you have tables or columns names that are reserved
1868 words in your database's SQL dialect.
1872 This is the character that will be used to escape L</quote_char>s appearing
1873 in an identifier before it has been quoted.
1875 The parameter default in case of a single L</quote_char> character is the quote
1878 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1879 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1880 of the B<opening (left)> L</quote_char> within the identifier are currently left
1881 untouched. The default for opening-closing-style quotes may change in future
1882 versions, thus you are B<strongly encouraged> to specify the escape character
1887 This is the character that separates a table and column name. It is
1888 necessary to specify this when the C<quote_char> option is selected,
1889 so that tables and column names can be individually quoted like this:
1891 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1893 =item injection_guard
1895 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1896 column name specified in a query structure. This is a safety mechanism to avoid
1897 injection attacks when mishandling user input e.g.:
1899 my %condition_as_column_value_pairs = get_values_from_user();
1900 $sqla->select( ... , \%condition_as_column_value_pairs );
1902 If the expression matches an exception is thrown. Note that literal SQL
1903 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1905 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1907 =item array_datatypes
1909 When this option is true, arrayrefs in INSERT or UPDATE are
1910 interpreted as array datatypes and are passed directly
1912 When this option is false, arrayrefs are interpreted
1913 as literal SQL, just like refs to arrayrefs
1914 (but this behavior is for backwards compatibility; when writing
1915 new queries, use the "reference to arrayref" syntax
1921 Takes a reference to a list of "special operators"
1922 to extend the syntax understood by L<SQL::Abstract>.
1923 See section L</"SPECIAL OPERATORS"> for details.
1927 Takes a reference to a list of "unary operators"
1928 to extend the syntax understood by L<SQL::Abstract>.
1929 See section L</"UNARY OPERATORS"> for details.
1935 =head2 insert($table, \@values || \%fieldvals, \%options)
1937 This is the simplest function. You simply give it a table name
1938 and either an arrayref of values or hashref of field/value pairs.
1939 It returns an SQL INSERT statement and a list of bind values.
1940 See the sections on L</"Inserting and Updating Arrays"> and
1941 L</"Inserting and Updating SQL"> for information on how to insert
1942 with those data types.
1944 The optional C<\%options> hash reference may contain additional
1945 options to generate the insert SQL. Currently supported options
1952 Takes either a scalar of raw SQL fields, or an array reference of
1953 field names, and adds on an SQL C<RETURNING> statement at the end.
1954 This allows you to return data generated by the insert statement
1955 (such as row IDs) without performing another C<SELECT> statement.
1956 Note, however, this is not part of the SQL standard and may not
1957 be supported by all database engines.
1961 =head2 update($table, \%fieldvals, \%where, \%options)
1963 This takes a table, hashref of field/value pairs, and an optional
1964 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1966 See the sections on L</"Inserting and Updating Arrays"> and
1967 L</"Inserting and Updating SQL"> for information on how to insert
1968 with those data types.
1970 The optional C<\%options> hash reference may contain additional
1971 options to generate the update SQL. Currently supported options
1978 See the C<returning> option to
1979 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1983 =head2 select($source, $fields, $where, $order)
1985 This returns a SQL SELECT statement and associated list of bind values, as
1986 specified by the arguments:
1992 Specification of the 'FROM' part of the statement.
1993 The argument can be either a plain scalar (interpreted as a table
1994 name, will be quoted), or an arrayref (interpreted as a list
1995 of table names, joined by commas, quoted), or a scalarref
1996 (literal SQL, not quoted).
2000 Specification of the list of fields to retrieve from
2002 The argument can be either an arrayref (interpreted as a list
2003 of field names, will be joined by commas and quoted), or a
2004 plain scalar (literal SQL, not quoted).
2005 Please observe that this API is not as flexible as that of
2006 the first argument C<$source>, for backwards compatibility reasons.
2010 Optional argument to specify the WHERE part of the query.
2011 The argument is most often a hashref, but can also be
2012 an arrayref or plain scalar --
2013 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2017 Optional argument to specify the ORDER BY part of the query.
2018 The argument can be a scalar, a hashref or an arrayref
2019 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2025 =head2 delete($table, \%where, \%options)
2027 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2028 It returns an SQL DELETE statement and list of bind values.
2030 The optional C<\%options> hash reference may contain additional
2031 options to generate the delete SQL. Currently supported options
2038 See the C<returning> option to
2039 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2043 =head2 where(\%where, $order)
2045 This is used to generate just the WHERE clause. For example,
2046 if you have an arbitrary data structure and know what the
2047 rest of your SQL is going to look like, but want an easy way
2048 to produce a WHERE clause, use this. It returns an SQL WHERE
2049 clause and list of bind values.
2052 =head2 values(\%data)
2054 This just returns the values from the hash C<%data>, in the same
2055 order that would be returned from any of the other above queries.
2056 Using this allows you to markedly speed up your queries if you
2057 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2059 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2061 Warning: This is an experimental method and subject to change.
2063 This returns arbitrarily generated SQL. It's a really basic shortcut.
2064 It will return two different things, depending on return context:
2066 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2067 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2069 These would return the following:
2071 # First calling form
2072 $stmt = "CREATE TABLE test (?, ?)";
2073 @bind = (field1, field2);
2075 # Second calling form
2076 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2078 Depending on what you're trying to do, it's up to you to choose the correct
2079 format. In this example, the second form is what you would want.
2083 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2087 ALTER SESSION SET nls_date_format = 'MM/YY'
2089 You get the idea. Strings get their case twiddled, but everything
2090 else remains verbatim.
2092 =head1 EXPORTABLE FUNCTIONS
2094 =head2 is_plain_value
2096 Determines if the supplied argument is a plain value as understood by this
2101 =item * The value is C<undef>
2103 =item * The value is a non-reference
2105 =item * The value is an object with stringification overloading
2107 =item * The value is of the form C<< { -value => $anything } >>
2111 On failure returns C<undef>, on success returns a B<scalar> reference
2112 to the original supplied argument.
2118 The stringification overloading detection is rather advanced: it takes
2119 into consideration not only the presence of a C<""> overload, but if that
2120 fails also checks for enabled
2121 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2122 on either C<0+> or C<bool>.
2124 Unfortunately testing in the field indicates that this
2125 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2126 but only when very large numbers of stringifying objects are involved.
2127 At the time of writing ( Sep 2014 ) there is no clear explanation of
2128 the direct cause, nor is there a manageably small test case that reliably
2129 reproduces the problem.
2131 If you encounter any of the following exceptions in B<random places within
2132 your application stack> - this module may be to blame:
2134 Operation "ne": no method found,
2135 left argument in overloaded package <something>,
2136 right argument in overloaded package <something>
2140 Stub found while resolving method "???" overloading """" in package <something>
2142 If you fall victim to the above - please attempt to reduce the problem
2143 to something that could be sent to the L<SQL::Abstract developers
2144 |DBIx::Class/GETTING HELP/SUPPORT>
2145 (either publicly or privately). As a workaround in the meantime you can
2146 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2147 value, which will most likely eliminate your problem (at the expense of
2148 not being able to properly detect exotic forms of stringification).
2150 This notice and environment variable will be removed in a future version,
2151 as soon as the underlying problem is found and a reliable workaround is
2156 =head2 is_literal_value
2158 Determines if the supplied argument is a literal value as understood by this
2163 =item * C<\$sql_string>
2165 =item * C<\[ $sql_string, @bind_values ]>
2169 On failure returns C<undef>, on success returns an B<array> reference
2170 containing the unpacked version of the supplied literal SQL and bind values.
2172 =head1 WHERE CLAUSES
2176 This module uses a variation on the idea from L<DBIx::Abstract>. It
2177 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2178 module is that things in arrays are OR'ed, and things in hashes
2181 The easiest way to explain is to show lots of examples. After
2182 each C<%where> hash shown, it is assumed you used:
2184 my($stmt, @bind) = $sql->where(\%where);
2186 However, note that the C<%where> hash can be used directly in any
2187 of the other functions as well, as described above.
2189 =head2 Key-value pairs
2191 So, let's get started. To begin, a simple hash:
2195 status => 'completed'
2198 Is converted to SQL C<key = val> statements:
2200 $stmt = "WHERE user = ? AND status = ?";
2201 @bind = ('nwiger', 'completed');
2203 One common thing I end up doing is having a list of values that
2204 a field can be in. To do this, simply specify a list inside of
2209 status => ['assigned', 'in-progress', 'pending'];
2212 This simple code will create the following:
2214 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2215 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2217 A field associated to an empty arrayref will be considered a
2218 logical false and will generate 0=1.
2220 =head2 Tests for NULL values
2222 If the value part is C<undef> then this is converted to SQL <IS NULL>
2231 $stmt = "WHERE user = ? AND status IS NULL";
2234 To test if a column IS NOT NULL:
2238 status => { '!=', undef },
2241 =head2 Specific comparison operators
2243 If you want to specify a different type of operator for your comparison,
2244 you can use a hashref for a given column:
2248 status => { '!=', 'completed' }
2251 Which would generate:
2253 $stmt = "WHERE user = ? AND status != ?";
2254 @bind = ('nwiger', 'completed');
2256 To test against multiple values, just enclose the values in an arrayref:
2258 status => { '=', ['assigned', 'in-progress', 'pending'] };
2260 Which would give you:
2262 "WHERE status = ? OR status = ? OR status = ?"
2265 The hashref can also contain multiple pairs, in which case it is expanded
2266 into an C<AND> of its elements:
2270 status => { '!=', 'completed', -not_like => 'pending%' }
2273 # Or more dynamically, like from a form
2274 $where{user} = 'nwiger';
2275 $where{status}{'!='} = 'completed';
2276 $where{status}{'-not_like'} = 'pending%';
2278 # Both generate this
2279 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2280 @bind = ('nwiger', 'completed', 'pending%');
2283 To get an OR instead, you can combine it with the arrayref idea:
2287 priority => [ { '=', 2 }, { '>', 5 } ]
2290 Which would generate:
2292 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2293 @bind = ('2', '5', 'nwiger');
2295 If you want to include literal SQL (with or without bind values), just use a
2296 scalar reference or reference to an arrayref as the value:
2299 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2300 date_expires => { '<' => \"now()" }
2303 Which would generate:
2305 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2306 @bind = ('11/26/2008');
2309 =head2 Logic and nesting operators
2311 In the example above,
2312 there is a subtle trap if you want to say something like
2313 this (notice the C<AND>):
2315 WHERE priority != ? AND priority != ?
2317 Because, in Perl you I<can't> do this:
2319 priority => { '!=' => 2, '!=' => 1 }
2321 As the second C<!=> key will obliterate the first. The solution
2322 is to use the special C<-modifier> form inside an arrayref:
2324 priority => [ -and => {'!=', 2},
2328 Normally, these would be joined by C<OR>, but the modifier tells it
2329 to use C<AND> instead. (Hint: You can use this in conjunction with the
2330 C<logic> option to C<new()> in order to change the way your queries
2331 work by default.) B<Important:> Note that the C<-modifier> goes
2332 B<INSIDE> the arrayref, as an extra first element. This will
2333 B<NOT> do what you think it might:
2335 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2337 Here is a quick list of equivalencies, since there is some overlap:
2340 status => {'!=', 'completed', 'not like', 'pending%' }
2341 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2344 status => {'=', ['assigned', 'in-progress']}
2345 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2346 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2350 =head2 Special operators: IN, BETWEEN, etc.
2352 You can also use the hashref format to compare a list of fields using the
2353 C<IN> comparison operator, by specifying the list as an arrayref:
2356 status => 'completed',
2357 reportid => { -in => [567, 2335, 2] }
2360 Which would generate:
2362 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2363 @bind = ('completed', '567', '2335', '2');
2365 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2368 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2369 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2370 'sqltrue' (by default: C<1=1>).
2372 In addition to the array you can supply a chunk of literal sql or
2373 literal sql with bind:
2376 customer => { -in => \[
2377 'SELECT cust_id FROM cust WHERE balance > ?',
2380 status => { -in => \'SELECT status_codes FROM states' },
2386 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2387 AND status IN ( SELECT status_codes FROM states )
2391 Finally, if the argument to C<-in> is not a reference, it will be
2392 treated as a single-element array.
2394 Another pair of operators is C<-between> and C<-not_between>,
2395 used with an arrayref of two values:
2399 completion_date => {
2400 -not_between => ['2002-10-01', '2003-02-06']
2406 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2408 Just like with C<-in> all plausible combinations of literal SQL
2412 start0 => { -between => [ 1, 2 ] },
2413 start1 => { -between => \["? AND ?", 1, 2] },
2414 start2 => { -between => \"lower(x) AND upper(y)" },
2415 start3 => { -between => [
2417 \["upper(?)", 'stuff' ],
2424 ( start0 BETWEEN ? AND ? )
2425 AND ( start1 BETWEEN ? AND ? )
2426 AND ( start2 BETWEEN lower(x) AND upper(y) )
2427 AND ( start3 BETWEEN lower(x) AND upper(?) )
2429 @bind = (1, 2, 1, 2, 'stuff');
2432 These are the two builtin "special operators"; but the
2433 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2435 =head2 Unary operators: bool
2437 If you wish to test against boolean columns or functions within your
2438 database you can use the C<-bool> and C<-not_bool> operators. For
2439 example to test the column C<is_user> being true and the column
2440 C<is_enabled> being false you would use:-
2444 -not_bool => 'is_enabled',
2449 WHERE is_user AND NOT is_enabled
2451 If a more complex combination is required, testing more conditions,
2452 then you should use the and/or operators:-
2457 -not_bool => { two=> { -rlike => 'bar' } },
2458 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2469 (NOT ( three = ? OR three > ? ))
2472 =head2 Nested conditions, -and/-or prefixes
2474 So far, we've seen how multiple conditions are joined with a top-level
2475 C<AND>. We can change this by putting the different conditions we want in
2476 hashes and then putting those hashes in an array. For example:
2481 status => { -like => ['pending%', 'dispatched'] },
2485 status => 'unassigned',
2489 This data structure would create the following:
2491 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2492 OR ( user = ? AND status = ? ) )";
2493 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2496 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2497 to change the logic inside:
2503 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2504 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2511 $stmt = "WHERE ( user = ?
2512 AND ( ( workhrs > ? AND geo = ? )
2513 OR ( workhrs < ? OR geo = ? ) ) )";
2514 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2516 =head3 Algebraic inconsistency, for historical reasons
2518 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2519 operator goes C<outside> of the nested structure; whereas when connecting
2520 several constraints on one column, the C<-and> operator goes
2521 C<inside> the arrayref. Here is an example combining both features:
2524 -and => [a => 1, b => 2],
2525 -or => [c => 3, d => 4],
2526 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2531 WHERE ( ( ( a = ? AND b = ? )
2532 OR ( c = ? OR d = ? )
2533 OR ( e LIKE ? AND e LIKE ? ) ) )
2535 This difference in syntax is unfortunate but must be preserved for
2536 historical reasons. So be careful: the two examples below would
2537 seem algebraically equivalent, but they are not
2540 { -like => 'foo%' },
2541 { -like => '%bar' },
2543 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2546 { col => { -like => 'foo%' } },
2547 { col => { -like => '%bar' } },
2549 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2552 =head2 Literal SQL and value type operators
2554 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2555 side" is a column name and the "right side" is a value (normally rendered as
2556 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2557 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2558 alter this behavior. There are several ways of doing so.
2562 This is a virtual operator that signals the string to its right side is an
2563 identifier (a column name) and not a value. For example to compare two
2564 columns you would write:
2567 priority => { '<', 2 },
2568 requestor => { -ident => 'submitter' },
2573 $stmt = "WHERE priority < ? AND requestor = submitter";
2576 If you are maintaining legacy code you may see a different construct as
2577 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2582 This is a virtual operator that signals that the construct to its right side
2583 is a value to be passed to DBI. This is for example necessary when you want
2584 to write a where clause against an array (for RDBMS that support such
2585 datatypes). For example:
2588 array => { -value => [1, 2, 3] }
2593 $stmt = 'WHERE array = ?';
2594 @bind = ([1, 2, 3]);
2596 Note that if you were to simply say:
2602 the result would probably not be what you wanted:
2604 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2609 Finally, sometimes only literal SQL will do. To include a random snippet
2610 of SQL verbatim, you specify it as a scalar reference. Consider this only
2611 as a last resort. Usually there is a better way. For example:
2614 priority => { '<', 2 },
2615 requestor => { -in => \'(SELECT name FROM hitmen)' },
2620 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2623 Note that in this example, you only get one bind parameter back, since
2624 the verbatim SQL is passed as part of the statement.
2628 Never use untrusted input as a literal SQL argument - this is a massive
2629 security risk (there is no way to check literal snippets for SQL
2630 injections and other nastyness). If you need to deal with untrusted input
2631 use literal SQL with placeholders as described next.
2633 =head3 Literal SQL with placeholders and bind values (subqueries)
2635 If the literal SQL to be inserted has placeholders and bind values,
2636 use a reference to an arrayref (yes this is a double reference --
2637 not so common, but perfectly legal Perl). For example, to find a date
2638 in Postgres you can use something like this:
2641 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2646 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2649 Note that you must pass the bind values in the same format as they are returned
2650 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2651 to C<columns>, you must provide the bind values in the
2652 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2653 scalar value; most commonly the column name, but you can use any scalar value
2654 (including references and blessed references), L<SQL::Abstract> will simply
2655 pass it through intact. So if C<bindtype> is set to C<columns> the above
2656 example will look like:
2659 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2662 Literal SQL is especially useful for nesting parenthesized clauses in the
2663 main SQL query. Here is a first example:
2665 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2669 bar => \["IN ($sub_stmt)" => @sub_bind],
2674 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2675 WHERE c2 < ? AND c3 LIKE ?))";
2676 @bind = (1234, 100, "foo%");
2678 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2679 are expressed in the same way. Of course the C<$sub_stmt> and
2680 its associated bind values can be generated through a former call
2683 my ($sub_stmt, @sub_bind)
2684 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2685 c3 => {-like => "foo%"}});
2688 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2691 In the examples above, the subquery was used as an operator on a column;
2692 but the same principle also applies for a clause within the main C<%where>
2693 hash, like an EXISTS subquery:
2695 my ($sub_stmt, @sub_bind)
2696 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2697 my %where = ( -and => [
2699 \["EXISTS ($sub_stmt)" => @sub_bind],
2704 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2705 WHERE c1 = ? AND c2 > t0.c0))";
2709 Observe that the condition on C<c2> in the subquery refers to
2710 column C<t0.c0> of the main query: this is I<not> a bind
2711 value, so we have to express it through a scalar ref.
2712 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2713 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2714 what we wanted here.
2716 Finally, here is an example where a subquery is used
2717 for expressing unary negation:
2719 my ($sub_stmt, @sub_bind)
2720 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2721 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2723 lname => {like => '%son%'},
2724 \["NOT ($sub_stmt)" => @sub_bind],
2729 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2730 @bind = ('%son%', 10, 20)
2732 =head3 Deprecated usage of Literal SQL
2734 Below are some examples of archaic use of literal SQL. It is shown only as
2735 reference for those who deal with legacy code. Each example has a much
2736 better, cleaner and safer alternative that users should opt for in new code.
2742 my %where = ( requestor => \'IS NOT NULL' )
2744 $stmt = "WHERE requestor IS NOT NULL"
2746 This used to be the way of generating NULL comparisons, before the handling
2747 of C<undef> got formalized. For new code please use the superior syntax as
2748 described in L</Tests for NULL values>.
2752 my %where = ( requestor => \'= submitter' )
2754 $stmt = "WHERE requestor = submitter"
2756 This used to be the only way to compare columns. Use the superior L</-ident>
2757 method for all new code. For example an identifier declared in such a way
2758 will be properly quoted if L</quote_char> is properly set, while the legacy
2759 form will remain as supplied.
2763 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2765 $stmt = "WHERE completed > ? AND is_ready"
2766 @bind = ('2012-12-21')
2768 Using an empty string literal used to be the only way to express a boolean.
2769 For all new code please use the much more readable
2770 L<-bool|/Unary operators: bool> operator.
2776 These pages could go on for a while, since the nesting of the data
2777 structures this module can handle are pretty much unlimited (the
2778 module implements the C<WHERE> expansion as a recursive function
2779 internally). Your best bet is to "play around" with the module a
2780 little to see how the data structures behave, and choose the best
2781 format for your data based on that.
2783 And of course, all the values above will probably be replaced with
2784 variables gotten from forms or the command line. After all, if you
2785 knew everything ahead of time, you wouldn't have to worry about
2786 dynamically-generating SQL and could just hardwire it into your
2789 =head1 ORDER BY CLAUSES
2791 Some functions take an order by clause. This can either be a scalar (just a
2792 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2793 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2796 Given | Will Generate
2797 ---------------------------------------------------------------
2799 'colA' | ORDER BY colA
2801 [qw/colA colB/] | ORDER BY colA, colB
2803 {-asc => 'colA'} | ORDER BY colA ASC
2805 {-desc => 'colB'} | ORDER BY colB DESC
2807 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2809 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2811 \'colA DESC' | ORDER BY colA DESC
2813 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2814 | /* ...with $x bound to ? */
2817 { -asc => 'colA' }, | colA ASC,
2818 { -desc => [qw/colB/] }, | colB DESC,
2819 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2820 \'colE DESC', | colE DESC,
2821 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2822 ] | /* ...with $x bound to ? */
2823 ===============================================================
2827 =head1 SPECIAL OPERATORS
2829 my $sqlmaker = SQL::Abstract->new(special_ops => [
2833 my ($self, $field, $op, $arg) = @_;
2839 handler => 'method_name',
2843 A "special operator" is a SQL syntactic clause that can be
2844 applied to a field, instead of a usual binary operator.
2847 WHERE field IN (?, ?, ?)
2848 WHERE field BETWEEN ? AND ?
2849 WHERE MATCH(field) AGAINST (?, ?)
2851 Special operators IN and BETWEEN are fairly standard and therefore
2852 are builtin within C<SQL::Abstract> (as the overridable methods
2853 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2854 like the MATCH .. AGAINST example above which is specific to MySQL,
2855 you can write your own operator handlers - supply a C<special_ops>
2856 argument to the C<new> method. That argument takes an arrayref of
2857 operator definitions; each operator definition is a hashref with two
2864 the regular expression to match the operator
2868 Either a coderef or a plain scalar method name. In both cases
2869 the expected return is C<< ($sql, @bind) >>.
2871 When supplied with a method name, it is simply called on the
2872 L<SQL::Abstract> object as:
2874 $self->$method_name($field, $op, $arg)
2878 $field is the LHS of the operator
2879 $op is the part that matched the handler regex
2882 When supplied with a coderef, it is called as:
2884 $coderef->($self, $field, $op, $arg)
2889 For example, here is an implementation
2890 of the MATCH .. AGAINST syntax for MySQL
2892 my $sqlmaker = SQL::Abstract->new(special_ops => [
2894 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2895 {regex => qr/^match$/i,
2897 my ($self, $field, $op, $arg) = @_;
2898 $arg = [$arg] if not ref $arg;
2899 my $label = $self->_quote($field);
2900 my ($placeholder) = $self->_convert('?');
2901 my $placeholders = join ", ", (($placeholder) x @$arg);
2902 my $sql = $self->_sqlcase('match') . " ($label) "
2903 . $self->_sqlcase('against') . " ($placeholders) ";
2904 my @bind = $self->_bindtype($field, @$arg);
2905 return ($sql, @bind);
2912 =head1 UNARY OPERATORS
2914 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2918 my ($self, $op, $arg) = @_;
2924 handler => 'method_name',
2928 A "unary operator" is a SQL syntactic clause that can be
2929 applied to a field - the operator goes before the field
2931 You can write your own operator handlers - supply a C<unary_ops>
2932 argument to the C<new> method. That argument takes an arrayref of
2933 operator definitions; each operator definition is a hashref with two
2940 the regular expression to match the operator
2944 Either a coderef or a plain scalar method name. In both cases
2945 the expected return is C<< $sql >>.
2947 When supplied with a method name, it is simply called on the
2948 L<SQL::Abstract> object as:
2950 $self->$method_name($op, $arg)
2954 $op is the part that matched the handler regex
2955 $arg is the RHS or argument of the operator
2957 When supplied with a coderef, it is called as:
2959 $coderef->($self, $op, $arg)
2967 Thanks to some benchmarking by Mark Stosberg, it turns out that
2968 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2969 I must admit this wasn't an intentional design issue, but it's a
2970 byproduct of the fact that you get to control your C<DBI> handles
2973 To maximize performance, use a code snippet like the following:
2975 # prepare a statement handle using the first row
2976 # and then reuse it for the rest of the rows
2978 for my $href (@array_of_hashrefs) {
2979 $stmt ||= $sql->insert('table', $href);
2980 $sth ||= $dbh->prepare($stmt);
2981 $sth->execute($sql->values($href));
2984 The reason this works is because the keys in your C<$href> are sorted
2985 internally by B<SQL::Abstract>. Thus, as long as your data retains
2986 the same structure, you only have to generate the SQL the first time
2987 around. On subsequent queries, simply use the C<values> function provided
2988 by this module to return your values in the correct order.
2990 However this depends on the values having the same type - if, for
2991 example, the values of a where clause may either have values
2992 (resulting in sql of the form C<column = ?> with a single bind
2993 value), or alternatively the values might be C<undef> (resulting in
2994 sql of the form C<column IS NULL> with no bind value) then the
2995 caching technique suggested will not work.
2999 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3000 really like this part (I do, at least). Building up a complex query
3001 can be as simple as the following:
3008 use CGI::FormBuilder;
3011 my $form = CGI::FormBuilder->new(...);
3012 my $sql = SQL::Abstract->new;
3014 if ($form->submitted) {
3015 my $field = $form->field;
3016 my $id = delete $field->{id};
3017 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3020 Of course, you would still have to connect using C<DBI> to run the
3021 query, but the point is that if you make your form look like your
3022 table, the actual query script can be extremely simplistic.
3024 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3025 a fast interface to returning and formatting data. I frequently
3026 use these three modules together to write complex database query
3027 apps in under 50 lines.
3029 =head1 HOW TO CONTRIBUTE
3031 Contributions are always welcome, in all usable forms (we especially
3032 welcome documentation improvements). The delivery methods include git-
3033 or unified-diff formatted patches, GitHub pull requests, or plain bug
3034 reports either via RT or the Mailing list. Contributors are generally
3035 granted full access to the official repository after their first several
3036 patches pass successful review.
3038 This project is maintained in a git repository. The code and related tools are
3039 accessible at the following locations:
3043 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3045 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3047 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3049 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3055 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3056 Great care has been taken to preserve the I<published> behavior
3057 documented in previous versions in the 1.* family; however,
3058 some features that were previously undocumented, or behaved
3059 differently from the documentation, had to be changed in order
3060 to clarify the semantics. Hence, client code that was relying
3061 on some dark areas of C<SQL::Abstract> v1.*
3062 B<might behave differently> in v1.50.
3064 The main changes are:
3070 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3074 support for the { operator => \"..." } construct (to embed literal SQL)
3078 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3082 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3086 defensive programming: check arguments
3090 fixed bug with global logic, which was previously implemented
3091 through global variables yielding side-effects. Prior versions would
3092 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3093 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3094 Now this is interpreted
3095 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3100 fixed semantics of _bindtype on array args
3104 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3105 we just avoid shifting arrays within that tree.
3109 dropped the C<_modlogic> function
3113 =head1 ACKNOWLEDGEMENTS
3115 There are a number of individuals that have really helped out with
3116 this module. Unfortunately, most of them submitted bugs via CPAN
3117 so I have no idea who they are! But the people I do know are:
3119 Ash Berlin (order_by hash term support)
3120 Matt Trout (DBIx::Class support)
3121 Mark Stosberg (benchmarking)
3122 Chas Owens (initial "IN" operator support)
3123 Philip Collins (per-field SQL functions)
3124 Eric Kolve (hashref "AND" support)
3125 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3126 Dan Kubb (support for "quote_char" and "name_sep")
3127 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3128 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3129 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3130 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3131 Oliver Charles (support for "RETURNING" after "INSERT")
3137 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3141 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3143 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3145 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3146 While not an official support venue, C<DBIx::Class> makes heavy use of
3147 C<SQL::Abstract>, and as such list members there are very familiar with
3148 how to create queries.
3152 This module is free software; you may copy this under the same
3153 terms as perl itself (either the GNU General Public License or
3154 the Artistic License)