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.86';
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 -ident => '_expand_ident',
191 -value => '_expand_value',
192 -not => '_expand_not',
193 -bool => '_expand_bool',
194 -and => '_expand_andor',
195 -or => '_expand_andor',
196 -nest => '_expand_nest',
200 'between' => '_expand_between',
201 'not between' => '_expand_between',
202 'in' => '_expand_in',
203 'not in' => '_expand_in',
205 my ($self, $op, $arg, $k) = @_;
208 $self->_expand_ident(-ident => $k),
209 $self->_expand_expr({ '-'.$op => $arg }),
211 }), qw(ident value)),
212 'nest' => '_expand_nest',
216 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
220 $opt{render_op} = our $RENDER_OP;
222 return bless \%opt, $class;
225 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
226 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
228 sub _assert_pass_injection_guard {
229 if ($_[1] =~ $_[0]->{injection_guard}) {
230 my $class = ref $_[0];
231 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
232 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
233 . "{injection_guard} attribute to ${class}->new()"
238 #======================================================================
240 #======================================================================
244 my $table = $self->_table(shift);
245 my $data = shift || return;
248 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
249 my ($sql, @bind) = $self->$method($data);
250 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
252 if ($options->{returning}) {
253 my ($s, @b) = $self->_insert_returning($options);
258 return wantarray ? ($sql, @bind) : $sql;
261 # So that subclasses can override INSERT ... RETURNING separately from
262 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
263 sub _insert_returning { shift->_returning(@_) }
266 my ($self, $options) = @_;
268 my $f = $options->{returning};
270 my ($sql, @bind) = $self->render_aqt(
271 $self->_expand_maybe_list_expr($f, undef, -ident)
274 ? $self->_sqlcase(' returning ') . $sql
275 : ($self->_sqlcase(' returning ').$sql, @bind);
278 sub _insert_HASHREF { # explicit list of fields and then values
279 my ($self, $data) = @_;
281 my @fields = sort keys %$data;
283 my ($sql, @bind) = $self->_insert_values($data);
286 $_ = $self->_quote($_) foreach @fields;
287 $sql = "( ".join(", ", @fields).") ".$sql;
289 return ($sql, @bind);
292 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
293 my ($self, $data) = @_;
295 # no names (arrayref) so can't generate bindtype
296 $self->{bindtype} ne 'columns'
297 or belch "can't do 'columns' bindtype when called with arrayref";
299 my (@values, @all_bind);
300 foreach my $value (@$data) {
301 my ($values, @bind) = $self->_insert_value(undef, $value);
302 push @values, $values;
303 push @all_bind, @bind;
305 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
306 return ($sql, @all_bind);
309 sub _insert_ARRAYREFREF { # literal SQL with bind
310 my ($self, $data) = @_;
312 my ($sql, @bind) = @${$data};
313 $self->_assert_bindval_matches_bindtype(@bind);
315 return ($sql, @bind);
319 sub _insert_SCALARREF { # literal SQL without bind
320 my ($self, $data) = @_;
326 my ($self, $data) = @_;
328 my (@values, @all_bind);
329 foreach my $column (sort keys %$data) {
330 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
331 push @values, $values;
332 push @all_bind, @bind;
334 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
335 return ($sql, @all_bind);
339 my ($self, $column, $v) = @_;
341 return $self->render_aqt(
342 $self->_expand_insert_value($column, $v)
346 sub _expand_insert_value {
347 my ($self, $column, $v) = @_;
349 if (ref($v) eq 'ARRAY') {
350 if ($self->{array_datatypes}) {
351 return +{ -bind => [ $column, $v ] };
353 my ($sql, @bind) = @$v;
354 $self->_assert_bindval_matches_bindtype(@bind);
355 return +{ -literal => $v };
357 if (ref($v) eq 'HASH') {
358 if (grep !/^-/, keys %$v) {
359 belch "HASH ref as bind value in insert is not supported";
360 return +{ -bind => [ $column, $v ] };
364 return +{ -bind => [ $column, undef ] };
366 local our $Cur_Col_Meta = $column;
367 return $self->expand_expr($v);
372 #======================================================================
374 #======================================================================
379 my $table = $self->_table(shift);
380 my $data = shift || return;
384 # first build the 'SET' part of the sql statement
385 puke "Unsupported data type specified to \$sql->update"
386 unless ref $data eq 'HASH';
388 my ($sql, @all_bind) = $self->_update_set_values($data);
389 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
393 my($where_sql, @where_bind) = $self->where($where);
395 push @all_bind, @where_bind;
398 if ($options->{returning}) {
399 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
400 $sql .= $returning_sql;
401 push @all_bind, @returning_bind;
404 return wantarray ? ($sql, @all_bind) : $sql;
407 sub _update_set_values {
408 my ($self, $data) = @_;
410 return $self->render_aqt(
411 $self->_expand_update_set_values($data),
415 sub _expand_update_set_values {
416 my ($self, $data) = @_;
417 $self->_expand_maybe_list_expr( [
420 $set = { -bind => $_ } unless defined $set;
421 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
427 ? ($self->{array_datatypes}
428 ? [ $k, +{ -bind => [ $k, $v ] } ]
429 : [ $k, +{ -literal => $v } ])
431 local our $Cur_Col_Meta = $k;
432 [ $k, $self->_expand_expr($v) ]
439 # So that subclasses can override UPDATE ... RETURNING separately from
441 sub _update_returning { shift->_returning(@_) }
445 #======================================================================
447 #======================================================================
452 my $table = $self->_table(shift);
453 my $fields = shift || '*';
457 my ($fields_sql, @bind) = $self->_select_fields($fields);
459 my ($where_sql, @where_bind) = $self->where($where, $order);
460 push @bind, @where_bind;
462 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
463 $self->_sqlcase('from'), $table)
466 return wantarray ? ($sql, @bind) : $sql;
470 my ($self, $fields) = @_;
471 return $fields unless ref($fields);
472 return $self->render_aqt(
473 $self->_expand_maybe_list_expr($fields, undef, '-ident')
477 #======================================================================
479 #======================================================================
484 my $table = $self->_table(shift);
488 my($where_sql, @bind) = $self->where($where);
489 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
491 if ($options->{returning}) {
492 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
493 $sql .= $returning_sql;
494 push @bind, @returning_bind;
497 return wantarray ? ($sql, @bind) : $sql;
500 # So that subclasses can override DELETE ... RETURNING separately from
502 sub _delete_returning { shift->_returning(@_) }
506 #======================================================================
508 #======================================================================
512 # Finally, a separate routine just to handle WHERE clauses
514 my ($self, $where, $order) = @_;
516 local $self->{convert_where} = $self->{convert};
519 my ($sql, @bind) = defined($where)
520 ? $self->_recurse_where($where)
522 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
526 my ($order_sql, @order_bind) = $self->_order_by($order);
528 push @bind, @order_bind;
531 return wantarray ? ($sql, @bind) : $sql;
535 my ($self, $expr, $default_scalar_to) = @_;
536 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
537 $self->_expand_expr($expr);
541 my ($self, $aqt) = @_;
542 my ($k, $v, @rest) = %$aqt;
544 if (my $meth = $self->{render}{$k}) {
545 return $self->$meth($v);
547 die "notreached: $k";
551 my ($self, $expr) = @_;
552 $self->render_aqt($self->expand_expr($expr));
556 my ($self, $expr, $logic) = @_;
557 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
558 return undef unless defined($expr);
559 if (ref($expr) eq 'HASH') {
560 return undef unless my $kc = keys %$expr;
563 return $self->_expand_andor("-${logic}", $expr);
565 my ($key, $value) = %$expr;
566 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
567 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
568 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
570 if (my $exp = $self->{expand}{$key}) {
571 return $self->$exp($key, $value);
573 return $self->_expand_expr_hashpair($key, $value, $logic);
575 if (ref($expr) eq 'ARRAY') {
576 my $logic = lc($logic || $self->{logic});
577 return $self->_expand_andor("-${logic}", $expr);
579 if (my $literal = is_literal_value($expr)) {
580 return +{ -literal => $literal };
582 if (!ref($expr) or Scalar::Util::blessed($expr)) {
583 if (my $d = our $Default_Scalar_To) {
584 return $self->_expand_expr({ $d => $expr });
586 return $self->_expand_value(-value => $expr);
591 sub _expand_expr_hashpair {
592 my ($self, $k, $v, $logic) = @_;
593 unless (defined($k) and length($k)) {
594 if (defined($k) and my $literal = is_literal_value($v)) {
595 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
596 return { -literal => $literal };
598 puke "Supplying an empty left hand side argument is not supported";
601 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
602 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
605 $self->_expand_expr({ "-${rest}", $v }, $logic)
610 $op =~ s/^-// if length($op) > 1;
612 # top level special ops are illegal in general
613 # note that, arguably, if it makes no sense at top level, it also
614 # makes no sense on the other side of an = sign or similar but DBIC
615 # gets disappointingly upset if I disallow it
617 (our $Expand_Depth) == 1
618 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
620 puke "Illegal use of top-level '-$op'"
622 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
623 return { -op => [ $op, $v ] };
626 if ($self->{render}{$k}) {
632 and (keys %$v)[0] =~ /^-/
634 my ($func) = $k =~ /^-(.*)$/;
635 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
636 return +{ -op => [ $func, $self->_expand_expr($v) ] };
638 return +{ -func => [ $func, $self->_expand_expr($v) ] };
640 if (!ref($v) or is_literal_value($v)) {
641 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
648 and exists $v->{-value}
649 and not defined $v->{-value}
652 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
654 if (!ref($v) or Scalar::Util::blessed($v)) {
655 my $d = our $Default_Scalar_To;
659 $self->_expand_ident(-ident => $k),
661 ? $self->_expand_expr($d => $v)
662 : { -bind => [ $k, $v ] }
667 if (ref($v) eq 'HASH') {
669 return $self->_expand_andor(-and => [
670 map +{ $k => { $_ => $v->{$_} } },
674 return undef unless keys %$v;
676 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
677 $self->_assert_pass_injection_guard($op);
678 if ($op =~ s/ [_\s]? \d+ $//x ) {
679 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
680 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
682 if (my $x = $self->{expand_op}{$op}) {
683 local our $Cur_Col_Meta = $k;
684 return $self->$x($op, $vv, $k);
686 if ($op eq 'value' and not defined($vv)) {
687 return $self->_expand_expr({ $k, undef }) unless defined($vv);
689 if ($op =~ /^is(?: not)?$/) {
690 puke "$op can only take undef as argument"
694 and exists($vv->{-value})
695 and !defined($vv->{-value})
697 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
699 if ($op =~ /^(and|or)$/) {
700 return $self->_expand_andor('-'.$op, [
701 map +{ $k, { $_ => $vv->{$_} } },
705 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
706 return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
708 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
711 $self->_expand_ident(-ident => $k),
712 { -op => [ $op, $vv ] }
715 if (ref($vv) eq 'ARRAY') {
716 my ($logic, @values) = (
717 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
722 $op =~ $self->{inequality_op}
723 or $op =~ $self->{not_like_op}
725 if (lc($logic) eq '-or' and @values > 1) {
726 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
727 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
728 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
733 # try to DWIM on equality operators
735 $op =~ $self->{equality_op} ? $self->sqlfalse
736 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
737 : $op =~ $self->{inequality_op} ? $self->sqltrue
738 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
739 : puke "operator '$op' applied on an empty array (field '$k')";
741 return $self->_expand_andor($logic => [
742 map +{ $k => { $vk => $_ } },
750 and exists $vv->{-value}
751 and not defined $vv->{-value}
755 $op =~ /^not$/i ? 'is not' # legacy
756 : $op =~ $self->{equality_op} ? 'is'
757 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
758 : $op =~ $self->{inequality_op} ? 'is not'
759 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
760 : puke "unexpected operator '$op' with undef operand";
761 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
763 local our $Cur_Col_Meta = $k;
766 $self->_expand_ident(-ident => $k),
767 $self->_expand_expr($vv)
770 if (ref($v) eq 'ARRAY') {
771 return $self->sqlfalse unless @$v;
772 $self->_debug("ARRAY($k) means distribute over elements");
774 $v->[0] =~ /^-(and|or)$/i
775 ? shift(@{$v = [ @$v ]})
776 : '-'.($self->{logic} || 'or')
778 return $self->_expand_andor(
779 $this_logic => [ map +{ $k => $_ }, @$v ]
782 if (my $literal = is_literal_value($v)) {
784 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
787 my ($sql, @bind) = @$literal;
788 if ($self->{bindtype} eq 'columns') {
790 $self->_assert_bindval_matches_bindtype($_);
793 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
799 my ($self, $op, $body) = @_;
800 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
801 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
803 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
804 ref($body) ? @$body : $body;
805 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
806 unless ($self->{quote_char}) {
807 $self->_assert_pass_injection_guard($_) for @parts;
809 return +{ -ident => \@parts };
813 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
817 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
821 my ($self, undef, $v) = @_;
823 return $self->_expand_expr($v);
825 puke "-bool => undef not supported" unless defined($v);
826 return $self->_expand_ident(-ident => $v);
830 my ($self, $k, $v) = @_;
831 my ($logic) = $k =~ /^-(.*)$/;
832 if (ref($v) eq 'HASH') {
835 map $self->_expand_expr({ $_ => $v->{$_} }, $logic),
839 if (ref($v) eq 'ARRAY') {
840 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
843 (ref($_) eq 'ARRAY' and @$_)
844 or (ref($_) eq 'HASH' and %$_)
850 while (my ($el) = splice @expr, 0, 1) {
851 puke "Supplying an empty left hand side argument is not supported in array-pairs"
852 unless defined($el) and length($el);
853 my $elref = ref($el);
855 local our $Expand_Depth = 0;
856 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
857 } elsif ($elref eq 'ARRAY') {
858 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
859 } elsif (my $l = is_literal_value($el)) {
860 push @res, { -literal => $l };
861 } elsif ($elref eq 'HASH') {
862 local our $Expand_Depth = 0;
863 push @res, grep defined, $self->_expand_expr($el) if %$el;
869 # return $res[0] if @res == 1;
870 return { -op => [ $logic, @res ] };
875 sub _expand_between {
876 my ($self, $op, $vv, $k) = @_;
877 local our $Cur_Col_Meta = $k;
878 my @rhs = map $self->_expand_expr($_),
879 ref($vv) eq 'ARRAY' ? @$vv : $vv;
881 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
883 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
885 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
889 $self->_expand_ident(-ident => $k),
895 my ($self, $op, $vv, $k) = @_;
896 if (my $literal = is_literal_value($vv)) {
897 my ($sql, @bind) = @$literal;
898 my $opened_sql = $self->_open_outer_paren($sql);
900 $op, $self->_expand_ident(-ident => $k),
901 [ { -literal => [ $opened_sql, @bind ] } ]
905 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
906 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
907 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
908 . 'will emit the logically correct SQL instead of raising this exception)'
910 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
912 my @rhs = map $self->_expand_expr($_),
913 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
914 map { defined($_) ? $_: puke($undef_err) }
915 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
916 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
920 $self->_expand_ident(-ident => $k),
926 my ($self, $op, $v) = @_;
927 # DBIx::Class requires a nest warning to be emitted once but the private
928 # method it overrode to do so no longer exists
929 if ($self->{is_dbic_sqlmaker}) {
930 unless (our $Nest_Warned) {
932 "-nest in search conditions is deprecated, you most probably wanted:\n"
933 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
938 return $self->_expand_expr($v);
942 my ($self, $where, $logic) = @_;
944 # Special case: top level simple string treated as literal
946 my $where_exp = (ref($where)
947 ? $self->_expand_expr($where, $logic)
948 : { -literal => [ $where ] });
950 # dispatch expanded expression
952 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
953 # DBIx::Class used to call _recurse_where in scalar context
954 # something else might too...
956 return ($sql, @bind);
959 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
965 my ($self, $ident) = @_;
967 return $self->_convert($self->_quote($ident));
971 my ($self, $list) = @_;
972 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
973 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
977 my ($self, $rest) = @_;
978 my ($func, @args) = @$rest;
982 push @arg_sql, shift @x;
984 } map [ $self->render_aqt($_) ], @args;
985 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
989 my ($self, $bind) = @_;
990 return ($self->_convert('?'), $self->_bindtype(@$bind));
993 sub _render_literal {
994 my ($self, $literal) = @_;
995 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1001 my ($self, $op, $args) = @_;
1002 my ($left, $low, $high) = @$args;
1003 my ($rhsql, @rhbind) = do {
1005 puke "Single arg to between must be a literal"
1006 unless $low->{-literal};
1009 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1010 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1011 @{$l}[1..$#$l], @{$h}[1..$#$h])
1014 my ($lhsql, @lhbind) = $self->render_aqt($left);
1016 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1019 }), 'between', 'not between'),
1021 my ($self, $op, $args) = @_;
1022 my ($lhs, $rhs) = @$args;
1025 my ($sql, @bind) = $self->render_aqt($_);
1026 push @in_bind, @bind;
1029 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1031 $lhsql.' '.$self->_sqlcase($op).' ( '
1032 .join(', ', @in_sql)
1036 }), 'in', 'not in'),
1037 (map +($_ => '_render_unop_postfix'),
1038 'is null', 'is not null', 'asc', 'desc',
1040 (not => '_render_op_not'),
1042 my ($self, $op, $args) = @_;
1043 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1044 return '' unless @parts;
1045 return @{$parts[0]} if @parts == 1;
1046 my ($final_sql) = join(
1047 ' '.$self->_sqlcase($op).' ',
1052 map @{$_}[1..$#$_], @parts
1058 my ($self, $v) = @_;
1059 my ($op, @args) = @$v;
1060 if (my $r = $self->{render_op}{$op}) {
1061 return $self->$r($op, \@args);
1063 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1064 if ($us and @args > 1) {
1065 puke "Special op '${op}' requires first value to be identifier"
1066 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1067 my $k = join(($self->{name_sep}||'.'), @$ident);
1068 local our $Expand_Depth = 1;
1069 return $self->${\($us->{handler})}($k, $op, $args[1]);
1071 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1072 return $self->${\($us->{handler})}($op, $args[0]);
1075 return $self->_render_unop_prefix($op, \@args);
1077 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1078 return '' unless @parts;
1079 my ($final_sql) = join(
1080 ' '.$self->_sqlcase($op).' ',
1085 map @{$_}[1..$#$_], @parts
1091 sub _render_op_not {
1092 my ($self, $op, $v) = @_;
1093 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1094 return "(${sql})", @bind;
1097 sub _render_unop_prefix {
1098 my ($self, $op, $v) = @_;
1099 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1100 my $op_sql = $self->_sqlcase($op);
1101 return ("${op_sql} ${expr_sql}", @bind);
1104 sub _render_unop_postfix {
1105 my ($self, $op, $v) = @_;
1106 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1107 my $op_sql = $self->_sqlcase($op);
1108 return ($expr_sql.' '.$op_sql, @bind);
1111 # Some databases (SQLite) treat col IN (1, 2) different from
1112 # col IN ( (1, 2) ). Use this to strip all outer parens while
1113 # adding them back in the corresponding method
1114 sub _open_outer_paren {
1115 my ($self, $sql) = @_;
1117 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1119 # there are closing parens inside, need the heavy duty machinery
1120 # to reevaluate the extraction starting from $sql (full reevaluation)
1121 if ($inner =~ /\)/) {
1122 require Text::Balanced;
1124 my (undef, $remainder) = do {
1125 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1127 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1130 # the entire expression needs to be a balanced bracketed thing
1131 # (after an extract no remainder sans trailing space)
1132 last if defined $remainder and $remainder =~ /\S/;
1142 #======================================================================
1144 #======================================================================
1146 sub _expand_order_by {
1147 my ($self, $arg) = @_;
1149 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1151 my $expander = sub {
1152 my ($self, $dir, $expr) = @_;
1153 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1154 foreach my $arg (@to_expand) {
1158 and grep /^-(asc|desc)$/, keys %$arg
1160 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1164 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1166 map $self->expand_expr($_, -ident),
1167 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1168 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1171 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1173 return $self->$expander(undef, $arg);
1177 my ($self, $arg) = @_;
1179 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1181 my ($sql, @bind) = $self->render_aqt($expanded);
1183 return '' unless length($sql);
1185 my $final_sql = $self->_sqlcase(' order by ').$sql;
1187 return wantarray ? ($final_sql, @bind) : $final_sql;
1190 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1192 sub _order_by_chunks {
1193 my ($self, $arg) = @_;
1195 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1197 return $self->_chunkify_order_by($expanded);
1200 sub _chunkify_order_by {
1201 my ($self, $expanded) = @_;
1203 return grep length, $self->render_aqt($expanded)
1204 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1207 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1208 return map $self->_chunkify_order_by($_), @$l;
1210 return [ $self->render_aqt($_) ];
1214 #======================================================================
1215 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1216 #======================================================================
1222 $self->_expand_maybe_list_expr($from, undef, -ident)
1227 #======================================================================
1229 #======================================================================
1231 sub _expand_maybe_list_expr {
1232 my ($self, $expr, $logic, $default) = @_;
1234 if (ref($expr) eq 'ARRAY') {
1236 map $self->expand_expr($_, $default), @$expr
1243 return $self->expand_expr($e, $default);
1246 # highly optimized, as it's called way too often
1248 # my ($self, $label) = @_;
1250 return '' unless defined $_[1];
1251 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1252 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1254 unless ($_[0]->{quote_char}) {
1255 if (ref($_[1]) eq 'ARRAY') {
1256 return join($_[0]->{name_sep}||'.', @{$_[1]});
1258 $_[0]->_assert_pass_injection_guard($_[1]);
1263 my $qref = ref $_[0]->{quote_char};
1265 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1266 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1267 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1269 my $esc = $_[0]->{escape_char} || $r;
1271 # parts containing * are naturally unquoted
1273 $_[0]->{name_sep}||'',
1277 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1279 (ref($_[1]) eq 'ARRAY'
1283 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1291 # Conversion, if applicable
1293 #my ($self, $arg) = @_;
1294 if ($_[0]->{convert_where}) {
1295 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1302 #my ($self, $col, @vals) = @_;
1303 # called often - tighten code
1304 return $_[0]->{bindtype} eq 'columns'
1305 ? map {[$_[1], $_]} @_[2 .. $#_]
1310 # Dies if any element of @bind is not in [colname => value] format
1311 # if bindtype is 'columns'.
1312 sub _assert_bindval_matches_bindtype {
1313 # my ($self, @bind) = @_;
1315 if ($self->{bindtype} eq 'columns') {
1317 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1318 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1324 sub _join_sql_clauses {
1325 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1327 if (@$clauses_aref > 1) {
1328 my $join = " " . $self->_sqlcase($logic) . " ";
1329 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1330 return ($sql, @$bind_aref);
1332 elsif (@$clauses_aref) {
1333 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1336 return (); # if no SQL, ignore @$bind_aref
1341 # Fix SQL case, if so requested
1343 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1344 # don't touch the argument ... crooked logic, but let's not change it!
1345 return $_[0]->{case} ? $_[1] : uc($_[1]);
1349 #======================================================================
1350 # DISPATCHING FROM REFKIND
1351 #======================================================================
1354 my ($self, $data) = @_;
1356 return 'UNDEF' unless defined $data;
1358 # blessed objects are treated like scalars
1359 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1361 return 'SCALAR' unless $ref;
1364 while ($ref eq 'REF') {
1366 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1370 return ($ref||'SCALAR') . ('REF' x $n_steps);
1374 my ($self, $data) = @_;
1375 my @try = ($self->_refkind($data));
1376 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1377 push @try, 'FALLBACK';
1381 sub _METHOD_FOR_refkind {
1382 my ($self, $meth_prefix, $data) = @_;
1385 for (@{$self->_try_refkind($data)}) {
1386 $method = $self->can($meth_prefix."_".$_)
1390 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1394 sub _SWITCH_refkind {
1395 my ($self, $data, $dispatch_table) = @_;
1398 for (@{$self->_try_refkind($data)}) {
1399 $coderef = $dispatch_table->{$_}
1403 puke "no dispatch entry for ".$self->_refkind($data)
1412 #======================================================================
1413 # VALUES, GENERATE, AUTOLOAD
1414 #======================================================================
1416 # LDNOTE: original code from nwiger, didn't touch code in that section
1417 # I feel the AUTOLOAD stuff should not be the default, it should
1418 # only be activated on explicit demand by user.
1422 my $data = shift || return;
1423 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1424 unless ref $data eq 'HASH';
1427 foreach my $k (sort keys %$data) {
1428 my $v = $data->{$k};
1429 $self->_SWITCH_refkind($v, {
1431 if ($self->{array_datatypes}) { # array datatype
1432 push @all_bind, $self->_bindtype($k, $v);
1434 else { # literal SQL with bind
1435 my ($sql, @bind) = @$v;
1436 $self->_assert_bindval_matches_bindtype(@bind);
1437 push @all_bind, @bind;
1440 ARRAYREFREF => sub { # literal SQL with bind
1441 my ($sql, @bind) = @${$v};
1442 $self->_assert_bindval_matches_bindtype(@bind);
1443 push @all_bind, @bind;
1445 SCALARREF => sub { # literal SQL without bind
1447 SCALAR_or_UNDEF => sub {
1448 push @all_bind, $self->_bindtype($k, $v);
1459 my(@sql, @sqlq, @sqlv);
1463 if ($ref eq 'HASH') {
1464 for my $k (sort keys %$_) {
1467 my $label = $self->_quote($k);
1468 if ($r eq 'ARRAY') {
1469 # literal SQL with bind
1470 my ($sql, @bind) = @$v;
1471 $self->_assert_bindval_matches_bindtype(@bind);
1472 push @sqlq, "$label = $sql";
1474 } elsif ($r eq 'SCALAR') {
1475 # literal SQL without bind
1476 push @sqlq, "$label = $$v";
1478 push @sqlq, "$label = ?";
1479 push @sqlv, $self->_bindtype($k, $v);
1482 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1483 } elsif ($ref eq 'ARRAY') {
1484 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1487 if ($r eq 'ARRAY') { # literal SQL with bind
1488 my ($sql, @bind) = @$v;
1489 $self->_assert_bindval_matches_bindtype(@bind);
1492 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1493 # embedded literal SQL
1500 push @sql, '(' . join(', ', @sqlq) . ')';
1501 } elsif ($ref eq 'SCALAR') {
1505 # strings get case twiddled
1506 push @sql, $self->_sqlcase($_);
1510 my $sql = join ' ', @sql;
1512 # this is pretty tricky
1513 # if ask for an array, return ($stmt, @bind)
1514 # otherwise, s/?/shift @sqlv/ to put it inline
1516 return ($sql, @sqlv);
1518 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1519 ref $d ? $d->[1] : $d/e;
1528 # This allows us to check for a local, then _form, attr
1530 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1531 return $self->generate($name, @_);
1542 SQL::Abstract - Generate SQL from Perl data structures
1548 my $sql = SQL::Abstract->new;
1550 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1552 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1554 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1556 my($stmt, @bind) = $sql->delete($table, \%where);
1558 # Then, use these in your DBI statements
1559 my $sth = $dbh->prepare($stmt);
1560 $sth->execute(@bind);
1562 # Just generate the WHERE clause
1563 my($stmt, @bind) = $sql->where(\%where, $order);
1565 # Return values in the same order, for hashed queries
1566 # See PERFORMANCE section for more details
1567 my @bind = $sql->values(\%fieldvals);
1571 This module was inspired by the excellent L<DBIx::Abstract>.
1572 However, in using that module I found that what I really wanted
1573 to do was generate SQL, but still retain complete control over my
1574 statement handles and use the DBI interface. So, I set out to
1575 create an abstract SQL generation module.
1577 While based on the concepts used by L<DBIx::Abstract>, there are
1578 several important differences, especially when it comes to WHERE
1579 clauses. I have modified the concepts used to make the SQL easier
1580 to generate from Perl data structures and, IMO, more intuitive.
1581 The underlying idea is for this module to do what you mean, based
1582 on the data structures you provide it. The big advantage is that
1583 you don't have to modify your code every time your data changes,
1584 as this module figures it out.
1586 To begin with, an SQL INSERT is as easy as just specifying a hash
1587 of C<key=value> pairs:
1590 name => 'Jimbo Bobson',
1591 phone => '123-456-7890',
1592 address => '42 Sister Lane',
1593 city => 'St. Louis',
1594 state => 'Louisiana',
1597 The SQL can then be generated with this:
1599 my($stmt, @bind) = $sql->insert('people', \%data);
1601 Which would give you something like this:
1603 $stmt = "INSERT INTO people
1604 (address, city, name, phone, state)
1605 VALUES (?, ?, ?, ?, ?)";
1606 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1607 '123-456-7890', 'Louisiana');
1609 These are then used directly in your DBI code:
1611 my $sth = $dbh->prepare($stmt);
1612 $sth->execute(@bind);
1614 =head2 Inserting and Updating Arrays
1616 If your database has array types (like for example Postgres),
1617 activate the special option C<< array_datatypes => 1 >>
1618 when creating the C<SQL::Abstract> object.
1619 Then you may use an arrayref to insert and update database array types:
1621 my $sql = SQL::Abstract->new(array_datatypes => 1);
1623 planets => [qw/Mercury Venus Earth Mars/]
1626 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1630 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1632 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1635 =head2 Inserting and Updating SQL
1637 In order to apply SQL functions to elements of your C<%data> you may
1638 specify a reference to an arrayref for the given hash value. For example,
1639 if you need to execute the Oracle C<to_date> function on a value, you can
1640 say something like this:
1644 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1647 The first value in the array is the actual SQL. Any other values are
1648 optional and would be included in the bind values array. This gives
1651 my($stmt, @bind) = $sql->insert('people', \%data);
1653 $stmt = "INSERT INTO people (name, date_entered)
1654 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1655 @bind = ('Bill', '03/02/2003');
1657 An UPDATE is just as easy, all you change is the name of the function:
1659 my($stmt, @bind) = $sql->update('people', \%data);
1661 Notice that your C<%data> isn't touched; the module will generate
1662 the appropriately quirky SQL for you automatically. Usually you'll
1663 want to specify a WHERE clause for your UPDATE, though, which is
1664 where handling C<%where> hashes comes in handy...
1666 =head2 Complex where statements
1668 This module can generate pretty complicated WHERE statements
1669 easily. For example, simple C<key=value> pairs are taken to mean
1670 equality, and if you want to see if a field is within a set
1671 of values, you can use an arrayref. Let's say we wanted to
1672 SELECT some data based on this criteria:
1675 requestor => 'inna',
1676 worker => ['nwiger', 'rcwe', 'sfz'],
1677 status => { '!=', 'completed' }
1680 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1682 The above would give you something like this:
1684 $stmt = "SELECT * FROM tickets WHERE
1685 ( requestor = ? ) AND ( status != ? )
1686 AND ( worker = ? OR worker = ? OR worker = ? )";
1687 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1689 Which you could then use in DBI code like so:
1691 my $sth = $dbh->prepare($stmt);
1692 $sth->execute(@bind);
1698 The methods are simple. There's one for every major SQL operation,
1699 and a constructor you use first. The arguments are specified in a
1700 similar order for each method (table, then fields, then a where
1701 clause) to try and simplify things.
1703 =head2 new(option => 'value')
1705 The C<new()> function takes a list of options and values, and returns
1706 a new B<SQL::Abstract> object which can then be used to generate SQL
1707 through the methods below. The options accepted are:
1713 If set to 'lower', then SQL will be generated in all lowercase. By
1714 default SQL is generated in "textbook" case meaning something like:
1716 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1718 Any setting other than 'lower' is ignored.
1722 This determines what the default comparison operator is. By default
1723 it is C<=>, meaning that a hash like this:
1725 %where = (name => 'nwiger', email => 'nate@wiger.org');
1727 Will generate SQL like this:
1729 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1731 However, you may want loose comparisons by default, so if you set
1732 C<cmp> to C<like> you would get SQL such as:
1734 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1736 You can also override the comparison on an individual basis - see
1737 the huge section on L</"WHERE CLAUSES"> at the bottom.
1739 =item sqltrue, sqlfalse
1741 Expressions for inserting boolean values within SQL statements.
1742 By default these are C<1=1> and C<1=0>. They are used
1743 by the special operators C<-in> and C<-not_in> for generating
1744 correct SQL even when the argument is an empty array (see below).
1748 This determines the default logical operator for multiple WHERE
1749 statements in arrays or hashes. If absent, the default logic is "or"
1750 for arrays, and "and" for hashes. This means that a WHERE
1754 event_date => {'>=', '2/13/99'},
1755 event_date => {'<=', '4/24/03'},
1758 will generate SQL like this:
1760 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1762 This is probably not what you want given this query, though (look
1763 at the dates). To change the "OR" to an "AND", simply specify:
1765 my $sql = SQL::Abstract->new(logic => 'and');
1767 Which will change the above C<WHERE> to:
1769 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1771 The logic can also be changed locally by inserting
1772 a modifier in front of an arrayref:
1774 @where = (-and => [event_date => {'>=', '2/13/99'},
1775 event_date => {'<=', '4/24/03'} ]);
1777 See the L</"WHERE CLAUSES"> section for explanations.
1781 This will automatically convert comparisons using the specified SQL
1782 function for both column and value. This is mostly used with an argument
1783 of C<upper> or C<lower>, so that the SQL will have the effect of
1784 case-insensitive "searches". For example, this:
1786 $sql = SQL::Abstract->new(convert => 'upper');
1787 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1789 Will turn out the following SQL:
1791 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1793 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1794 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1795 not validate this option; it will just pass through what you specify verbatim).
1799 This is a kludge because many databases suck. For example, you can't
1800 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1801 Instead, you have to use C<bind_param()>:
1803 $sth->bind_param(1, 'reg data');
1804 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1806 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1807 which loses track of which field each slot refers to. Fear not.
1809 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1810 Currently, you can specify either C<normal> (default) or C<columns>. If you
1811 specify C<columns>, you will get an array that looks like this:
1813 my $sql = SQL::Abstract->new(bindtype => 'columns');
1814 my($stmt, @bind) = $sql->insert(...);
1817 [ 'column1', 'value1' ],
1818 [ 'column2', 'value2' ],
1819 [ 'column3', 'value3' ],
1822 You can then iterate through this manually, using DBI's C<bind_param()>.
1824 $sth->prepare($stmt);
1827 my($col, $data) = @$_;
1828 if ($col eq 'details' || $col eq 'comments') {
1829 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1830 } elsif ($col eq 'image') {
1831 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1833 $sth->bind_param($i, $data);
1837 $sth->execute; # execute without @bind now
1839 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1840 Basically, the advantage is still that you don't have to care which fields
1841 are or are not included. You could wrap that above C<for> loop in a simple
1842 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1843 get a layer of abstraction over manual SQL specification.
1845 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1846 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1847 will expect the bind values in this format.
1851 This is the character that a table or column name will be quoted
1852 with. By default this is an empty string, but you could set it to
1853 the character C<`>, to generate SQL like this:
1855 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1857 Alternatively, you can supply an array ref of two items, the first being the left
1858 hand quote character, and the second the right hand quote character. For
1859 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1860 that generates SQL like this:
1862 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1864 Quoting is useful if you have tables or columns names that are reserved
1865 words in your database's SQL dialect.
1869 This is the character that will be used to escape L</quote_char>s appearing
1870 in an identifier before it has been quoted.
1872 The parameter default in case of a single L</quote_char> character is the quote
1875 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1876 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1877 of the B<opening (left)> L</quote_char> within the identifier are currently left
1878 untouched. The default for opening-closing-style quotes may change in future
1879 versions, thus you are B<strongly encouraged> to specify the escape character
1884 This is the character that separates a table and column name. It is
1885 necessary to specify this when the C<quote_char> option is selected,
1886 so that tables and column names can be individually quoted like this:
1888 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1890 =item injection_guard
1892 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1893 column name specified in a query structure. This is a safety mechanism to avoid
1894 injection attacks when mishandling user input e.g.:
1896 my %condition_as_column_value_pairs = get_values_from_user();
1897 $sqla->select( ... , \%condition_as_column_value_pairs );
1899 If the expression matches an exception is thrown. Note that literal SQL
1900 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1902 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1904 =item array_datatypes
1906 When this option is true, arrayrefs in INSERT or UPDATE are
1907 interpreted as array datatypes and are passed directly
1909 When this option is false, arrayrefs are interpreted
1910 as literal SQL, just like refs to arrayrefs
1911 (but this behavior is for backwards compatibility; when writing
1912 new queries, use the "reference to arrayref" syntax
1918 Takes a reference to a list of "special operators"
1919 to extend the syntax understood by L<SQL::Abstract>.
1920 See section L</"SPECIAL OPERATORS"> for details.
1924 Takes a reference to a list of "unary operators"
1925 to extend the syntax understood by L<SQL::Abstract>.
1926 See section L</"UNARY OPERATORS"> for details.
1932 =head2 insert($table, \@values || \%fieldvals, \%options)
1934 This is the simplest function. You simply give it a table name
1935 and either an arrayref of values or hashref of field/value pairs.
1936 It returns an SQL INSERT statement and a list of bind values.
1937 See the sections on L</"Inserting and Updating Arrays"> and
1938 L</"Inserting and Updating SQL"> for information on how to insert
1939 with those data types.
1941 The optional C<\%options> hash reference may contain additional
1942 options to generate the insert SQL. Currently supported options
1949 Takes either a scalar of raw SQL fields, or an array reference of
1950 field names, and adds on an SQL C<RETURNING> statement at the end.
1951 This allows you to return data generated by the insert statement
1952 (such as row IDs) without performing another C<SELECT> statement.
1953 Note, however, this is not part of the SQL standard and may not
1954 be supported by all database engines.
1958 =head2 update($table, \%fieldvals, \%where, \%options)
1960 This takes a table, hashref of field/value pairs, and an optional
1961 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1963 See the sections on L</"Inserting and Updating Arrays"> and
1964 L</"Inserting and Updating SQL"> for information on how to insert
1965 with those data types.
1967 The optional C<\%options> hash reference may contain additional
1968 options to generate the update SQL. Currently supported options
1975 See the C<returning> option to
1976 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1980 =head2 select($source, $fields, $where, $order)
1982 This returns a SQL SELECT statement and associated list of bind values, as
1983 specified by the arguments:
1989 Specification of the 'FROM' part of the statement.
1990 The argument can be either a plain scalar (interpreted as a table
1991 name, will be quoted), or an arrayref (interpreted as a list
1992 of table names, joined by commas, quoted), or a scalarref
1993 (literal SQL, not quoted).
1997 Specification of the list of fields to retrieve from
1999 The argument can be either an arrayref (interpreted as a list
2000 of field names, will be joined by commas and quoted), or a
2001 plain scalar (literal SQL, not quoted).
2002 Please observe that this API is not as flexible as that of
2003 the first argument C<$source>, for backwards compatibility reasons.
2007 Optional argument to specify the WHERE part of the query.
2008 The argument is most often a hashref, but can also be
2009 an arrayref or plain scalar --
2010 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2014 Optional argument to specify the ORDER BY part of the query.
2015 The argument can be a scalar, a hashref or an arrayref
2016 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2022 =head2 delete($table, \%where, \%options)
2024 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2025 It returns an SQL DELETE statement and list of bind values.
2027 The optional C<\%options> hash reference may contain additional
2028 options to generate the delete SQL. Currently supported options
2035 See the C<returning> option to
2036 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2040 =head2 where(\%where, $order)
2042 This is used to generate just the WHERE clause. For example,
2043 if you have an arbitrary data structure and know what the
2044 rest of your SQL is going to look like, but want an easy way
2045 to produce a WHERE clause, use this. It returns an SQL WHERE
2046 clause and list of bind values.
2049 =head2 values(\%data)
2051 This just returns the values from the hash C<%data>, in the same
2052 order that would be returned from any of the other above queries.
2053 Using this allows you to markedly speed up your queries if you
2054 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2056 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2058 Warning: This is an experimental method and subject to change.
2060 This returns arbitrarily generated SQL. It's a really basic shortcut.
2061 It will return two different things, depending on return context:
2063 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2064 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2066 These would return the following:
2068 # First calling form
2069 $stmt = "CREATE TABLE test (?, ?)";
2070 @bind = (field1, field2);
2072 # Second calling form
2073 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2075 Depending on what you're trying to do, it's up to you to choose the correct
2076 format. In this example, the second form is what you would want.
2080 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2084 ALTER SESSION SET nls_date_format = 'MM/YY'
2086 You get the idea. Strings get their case twiddled, but everything
2087 else remains verbatim.
2089 =head1 EXPORTABLE FUNCTIONS
2091 =head2 is_plain_value
2093 Determines if the supplied argument is a plain value as understood by this
2098 =item * The value is C<undef>
2100 =item * The value is a non-reference
2102 =item * The value is an object with stringification overloading
2104 =item * The value is of the form C<< { -value => $anything } >>
2108 On failure returns C<undef>, on success returns a B<scalar> reference
2109 to the original supplied argument.
2115 The stringification overloading detection is rather advanced: it takes
2116 into consideration not only the presence of a C<""> overload, but if that
2117 fails also checks for enabled
2118 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2119 on either C<0+> or C<bool>.
2121 Unfortunately testing in the field indicates that this
2122 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2123 but only when very large numbers of stringifying objects are involved.
2124 At the time of writing ( Sep 2014 ) there is no clear explanation of
2125 the direct cause, nor is there a manageably small test case that reliably
2126 reproduces the problem.
2128 If you encounter any of the following exceptions in B<random places within
2129 your application stack> - this module may be to blame:
2131 Operation "ne": no method found,
2132 left argument in overloaded package <something>,
2133 right argument in overloaded package <something>
2137 Stub found while resolving method "???" overloading """" in package <something>
2139 If you fall victim to the above - please attempt to reduce the problem
2140 to something that could be sent to the L<SQL::Abstract developers
2141 |DBIx::Class/GETTING HELP/SUPPORT>
2142 (either publicly or privately). As a workaround in the meantime you can
2143 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2144 value, which will most likely eliminate your problem (at the expense of
2145 not being able to properly detect exotic forms of stringification).
2147 This notice and environment variable will be removed in a future version,
2148 as soon as the underlying problem is found and a reliable workaround is
2153 =head2 is_literal_value
2155 Determines if the supplied argument is a literal value as understood by this
2160 =item * C<\$sql_string>
2162 =item * C<\[ $sql_string, @bind_values ]>
2166 On failure returns C<undef>, on success returns an B<array> reference
2167 containing the unpacked version of the supplied literal SQL and bind values.
2169 =head1 WHERE CLAUSES
2173 This module uses a variation on the idea from L<DBIx::Abstract>. It
2174 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2175 module is that things in arrays are OR'ed, and things in hashes
2178 The easiest way to explain is to show lots of examples. After
2179 each C<%where> hash shown, it is assumed you used:
2181 my($stmt, @bind) = $sql->where(\%where);
2183 However, note that the C<%where> hash can be used directly in any
2184 of the other functions as well, as described above.
2186 =head2 Key-value pairs
2188 So, let's get started. To begin, a simple hash:
2192 status => 'completed'
2195 Is converted to SQL C<key = val> statements:
2197 $stmt = "WHERE user = ? AND status = ?";
2198 @bind = ('nwiger', 'completed');
2200 One common thing I end up doing is having a list of values that
2201 a field can be in. To do this, simply specify a list inside of
2206 status => ['assigned', 'in-progress', 'pending'];
2209 This simple code will create the following:
2211 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2212 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2214 A field associated to an empty arrayref will be considered a
2215 logical false and will generate 0=1.
2217 =head2 Tests for NULL values
2219 If the value part is C<undef> then this is converted to SQL <IS NULL>
2228 $stmt = "WHERE user = ? AND status IS NULL";
2231 To test if a column IS NOT NULL:
2235 status => { '!=', undef },
2238 =head2 Specific comparison operators
2240 If you want to specify a different type of operator for your comparison,
2241 you can use a hashref for a given column:
2245 status => { '!=', 'completed' }
2248 Which would generate:
2250 $stmt = "WHERE user = ? AND status != ?";
2251 @bind = ('nwiger', 'completed');
2253 To test against multiple values, just enclose the values in an arrayref:
2255 status => { '=', ['assigned', 'in-progress', 'pending'] };
2257 Which would give you:
2259 "WHERE status = ? OR status = ? OR status = ?"
2262 The hashref can also contain multiple pairs, in which case it is expanded
2263 into an C<AND> of its elements:
2267 status => { '!=', 'completed', -not_like => 'pending%' }
2270 # Or more dynamically, like from a form
2271 $where{user} = 'nwiger';
2272 $where{status}{'!='} = 'completed';
2273 $where{status}{'-not_like'} = 'pending%';
2275 # Both generate this
2276 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2277 @bind = ('nwiger', 'completed', 'pending%');
2280 To get an OR instead, you can combine it with the arrayref idea:
2284 priority => [ { '=', 2 }, { '>', 5 } ]
2287 Which would generate:
2289 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2290 @bind = ('2', '5', 'nwiger');
2292 If you want to include literal SQL (with or without bind values), just use a
2293 scalar reference or reference to an arrayref as the value:
2296 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2297 date_expires => { '<' => \"now()" }
2300 Which would generate:
2302 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2303 @bind = ('11/26/2008');
2306 =head2 Logic and nesting operators
2308 In the example above,
2309 there is a subtle trap if you want to say something like
2310 this (notice the C<AND>):
2312 WHERE priority != ? AND priority != ?
2314 Because, in Perl you I<can't> do this:
2316 priority => { '!=' => 2, '!=' => 1 }
2318 As the second C<!=> key will obliterate the first. The solution
2319 is to use the special C<-modifier> form inside an arrayref:
2321 priority => [ -and => {'!=', 2},
2325 Normally, these would be joined by C<OR>, but the modifier tells it
2326 to use C<AND> instead. (Hint: You can use this in conjunction with the
2327 C<logic> option to C<new()> in order to change the way your queries
2328 work by default.) B<Important:> Note that the C<-modifier> goes
2329 B<INSIDE> the arrayref, as an extra first element. This will
2330 B<NOT> do what you think it might:
2332 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2334 Here is a quick list of equivalencies, since there is some overlap:
2337 status => {'!=', 'completed', 'not like', 'pending%' }
2338 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2341 status => {'=', ['assigned', 'in-progress']}
2342 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2343 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2347 =head2 Special operators: IN, BETWEEN, etc.
2349 You can also use the hashref format to compare a list of fields using the
2350 C<IN> comparison operator, by specifying the list as an arrayref:
2353 status => 'completed',
2354 reportid => { -in => [567, 2335, 2] }
2357 Which would generate:
2359 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2360 @bind = ('completed', '567', '2335', '2');
2362 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2365 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2366 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2367 'sqltrue' (by default: C<1=1>).
2369 In addition to the array you can supply a chunk of literal sql or
2370 literal sql with bind:
2373 customer => { -in => \[
2374 'SELECT cust_id FROM cust WHERE balance > ?',
2377 status => { -in => \'SELECT status_codes FROM states' },
2383 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2384 AND status IN ( SELECT status_codes FROM states )
2388 Finally, if the argument to C<-in> is not a reference, it will be
2389 treated as a single-element array.
2391 Another pair of operators is C<-between> and C<-not_between>,
2392 used with an arrayref of two values:
2396 completion_date => {
2397 -not_between => ['2002-10-01', '2003-02-06']
2403 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2405 Just like with C<-in> all plausible combinations of literal SQL
2409 start0 => { -between => [ 1, 2 ] },
2410 start1 => { -between => \["? AND ?", 1, 2] },
2411 start2 => { -between => \"lower(x) AND upper(y)" },
2412 start3 => { -between => [
2414 \["upper(?)", 'stuff' ],
2421 ( start0 BETWEEN ? AND ? )
2422 AND ( start1 BETWEEN ? AND ? )
2423 AND ( start2 BETWEEN lower(x) AND upper(y) )
2424 AND ( start3 BETWEEN lower(x) AND upper(?) )
2426 @bind = (1, 2, 1, 2, 'stuff');
2429 These are the two builtin "special operators"; but the
2430 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2432 =head2 Unary operators: bool
2434 If you wish to test against boolean columns or functions within your
2435 database you can use the C<-bool> and C<-not_bool> operators. For
2436 example to test the column C<is_user> being true and the column
2437 C<is_enabled> being false you would use:-
2441 -not_bool => 'is_enabled',
2446 WHERE is_user AND NOT is_enabled
2448 If a more complex combination is required, testing more conditions,
2449 then you should use the and/or operators:-
2454 -not_bool => { two=> { -rlike => 'bar' } },
2455 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2466 (NOT ( three = ? OR three > ? ))
2469 =head2 Nested conditions, -and/-or prefixes
2471 So far, we've seen how multiple conditions are joined with a top-level
2472 C<AND>. We can change this by putting the different conditions we want in
2473 hashes and then putting those hashes in an array. For example:
2478 status => { -like => ['pending%', 'dispatched'] },
2482 status => 'unassigned',
2486 This data structure would create the following:
2488 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2489 OR ( user = ? AND status = ? ) )";
2490 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2493 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2494 to change the logic inside:
2500 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2501 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2508 $stmt = "WHERE ( user = ?
2509 AND ( ( workhrs > ? AND geo = ? )
2510 OR ( workhrs < ? OR geo = ? ) ) )";
2511 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2513 =head3 Algebraic inconsistency, for historical reasons
2515 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2516 operator goes C<outside> of the nested structure; whereas when connecting
2517 several constraints on one column, the C<-and> operator goes
2518 C<inside> the arrayref. Here is an example combining both features:
2521 -and => [a => 1, b => 2],
2522 -or => [c => 3, d => 4],
2523 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2528 WHERE ( ( ( a = ? AND b = ? )
2529 OR ( c = ? OR d = ? )
2530 OR ( e LIKE ? AND e LIKE ? ) ) )
2532 This difference in syntax is unfortunate but must be preserved for
2533 historical reasons. So be careful: the two examples below would
2534 seem algebraically equivalent, but they are not
2537 { -like => 'foo%' },
2538 { -like => '%bar' },
2540 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2543 { col => { -like => 'foo%' } },
2544 { col => { -like => '%bar' } },
2546 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2549 =head2 Literal SQL and value type operators
2551 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2552 side" is a column name and the "right side" is a value (normally rendered as
2553 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2554 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2555 alter this behavior. There are several ways of doing so.
2559 This is a virtual operator that signals the string to its right side is an
2560 identifier (a column name) and not a value. For example to compare two
2561 columns you would write:
2564 priority => { '<', 2 },
2565 requestor => { -ident => 'submitter' },
2570 $stmt = "WHERE priority < ? AND requestor = submitter";
2573 If you are maintaining legacy code you may see a different construct as
2574 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2579 This is a virtual operator that signals that the construct to its right side
2580 is a value to be passed to DBI. This is for example necessary when you want
2581 to write a where clause against an array (for RDBMS that support such
2582 datatypes). For example:
2585 array => { -value => [1, 2, 3] }
2590 $stmt = 'WHERE array = ?';
2591 @bind = ([1, 2, 3]);
2593 Note that if you were to simply say:
2599 the result would probably not be what you wanted:
2601 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2606 Finally, sometimes only literal SQL will do. To include a random snippet
2607 of SQL verbatim, you specify it as a scalar reference. Consider this only
2608 as a last resort. Usually there is a better way. For example:
2611 priority => { '<', 2 },
2612 requestor => { -in => \'(SELECT name FROM hitmen)' },
2617 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2620 Note that in this example, you only get one bind parameter back, since
2621 the verbatim SQL is passed as part of the statement.
2625 Never use untrusted input as a literal SQL argument - this is a massive
2626 security risk (there is no way to check literal snippets for SQL
2627 injections and other nastyness). If you need to deal with untrusted input
2628 use literal SQL with placeholders as described next.
2630 =head3 Literal SQL with placeholders and bind values (subqueries)
2632 If the literal SQL to be inserted has placeholders and bind values,
2633 use a reference to an arrayref (yes this is a double reference --
2634 not so common, but perfectly legal Perl). For example, to find a date
2635 in Postgres you can use something like this:
2638 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2643 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2646 Note that you must pass the bind values in the same format as they are returned
2647 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2648 to C<columns>, you must provide the bind values in the
2649 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2650 scalar value; most commonly the column name, but you can use any scalar value
2651 (including references and blessed references), L<SQL::Abstract> will simply
2652 pass it through intact. So if C<bindtype> is set to C<columns> the above
2653 example will look like:
2656 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2659 Literal SQL is especially useful for nesting parenthesized clauses in the
2660 main SQL query. Here is a first example:
2662 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2666 bar => \["IN ($sub_stmt)" => @sub_bind],
2671 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2672 WHERE c2 < ? AND c3 LIKE ?))";
2673 @bind = (1234, 100, "foo%");
2675 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2676 are expressed in the same way. Of course the C<$sub_stmt> and
2677 its associated bind values can be generated through a former call
2680 my ($sub_stmt, @sub_bind)
2681 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2682 c3 => {-like => "foo%"}});
2685 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2688 In the examples above, the subquery was used as an operator on a column;
2689 but the same principle also applies for a clause within the main C<%where>
2690 hash, like an EXISTS subquery:
2692 my ($sub_stmt, @sub_bind)
2693 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2694 my %where = ( -and => [
2696 \["EXISTS ($sub_stmt)" => @sub_bind],
2701 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2702 WHERE c1 = ? AND c2 > t0.c0))";
2706 Observe that the condition on C<c2> in the subquery refers to
2707 column C<t0.c0> of the main query: this is I<not> a bind
2708 value, so we have to express it through a scalar ref.
2709 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2710 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2711 what we wanted here.
2713 Finally, here is an example where a subquery is used
2714 for expressing unary negation:
2716 my ($sub_stmt, @sub_bind)
2717 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2718 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2720 lname => {like => '%son%'},
2721 \["NOT ($sub_stmt)" => @sub_bind],
2726 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2727 @bind = ('%son%', 10, 20)
2729 =head3 Deprecated usage of Literal SQL
2731 Below are some examples of archaic use of literal SQL. It is shown only as
2732 reference for those who deal with legacy code. Each example has a much
2733 better, cleaner and safer alternative that users should opt for in new code.
2739 my %where = ( requestor => \'IS NOT NULL' )
2741 $stmt = "WHERE requestor IS NOT NULL"
2743 This used to be the way of generating NULL comparisons, before the handling
2744 of C<undef> got formalized. For new code please use the superior syntax as
2745 described in L</Tests for NULL values>.
2749 my %where = ( requestor => \'= submitter' )
2751 $stmt = "WHERE requestor = submitter"
2753 This used to be the only way to compare columns. Use the superior L</-ident>
2754 method for all new code. For example an identifier declared in such a way
2755 will be properly quoted if L</quote_char> is properly set, while the legacy
2756 form will remain as supplied.
2760 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2762 $stmt = "WHERE completed > ? AND is_ready"
2763 @bind = ('2012-12-21')
2765 Using an empty string literal used to be the only way to express a boolean.
2766 For all new code please use the much more readable
2767 L<-bool|/Unary operators: bool> operator.
2773 These pages could go on for a while, since the nesting of the data
2774 structures this module can handle are pretty much unlimited (the
2775 module implements the C<WHERE> expansion as a recursive function
2776 internally). Your best bet is to "play around" with the module a
2777 little to see how the data structures behave, and choose the best
2778 format for your data based on that.
2780 And of course, all the values above will probably be replaced with
2781 variables gotten from forms or the command line. After all, if you
2782 knew everything ahead of time, you wouldn't have to worry about
2783 dynamically-generating SQL and could just hardwire it into your
2786 =head1 ORDER BY CLAUSES
2788 Some functions take an order by clause. This can either be a scalar (just a
2789 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2790 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2793 Given | Will Generate
2794 ---------------------------------------------------------------
2796 'colA' | ORDER BY colA
2798 [qw/colA colB/] | ORDER BY colA, colB
2800 {-asc => 'colA'} | ORDER BY colA ASC
2802 {-desc => 'colB'} | ORDER BY colB DESC
2804 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2806 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2808 \'colA DESC' | ORDER BY colA DESC
2810 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2811 | /* ...with $x bound to ? */
2814 { -asc => 'colA' }, | colA ASC,
2815 { -desc => [qw/colB/] }, | colB DESC,
2816 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2817 \'colE DESC', | colE DESC,
2818 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2819 ] | /* ...with $x bound to ? */
2820 ===============================================================
2824 =head1 SPECIAL OPERATORS
2826 my $sqlmaker = SQL::Abstract->new(special_ops => [
2830 my ($self, $field, $op, $arg) = @_;
2836 handler => 'method_name',
2840 A "special operator" is a SQL syntactic clause that can be
2841 applied to a field, instead of a usual binary operator.
2844 WHERE field IN (?, ?, ?)
2845 WHERE field BETWEEN ? AND ?
2846 WHERE MATCH(field) AGAINST (?, ?)
2848 Special operators IN and BETWEEN are fairly standard and therefore
2849 are builtin within C<SQL::Abstract> (as the overridable methods
2850 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2851 like the MATCH .. AGAINST example above which is specific to MySQL,
2852 you can write your own operator handlers - supply a C<special_ops>
2853 argument to the C<new> method. That argument takes an arrayref of
2854 operator definitions; each operator definition is a hashref with two
2861 the regular expression to match the operator
2865 Either a coderef or a plain scalar method name. In both cases
2866 the expected return is C<< ($sql, @bind) >>.
2868 When supplied with a method name, it is simply called on the
2869 L<SQL::Abstract> object as:
2871 $self->$method_name($field, $op, $arg)
2875 $field is the LHS of the operator
2876 $op is the part that matched the handler regex
2879 When supplied with a coderef, it is called as:
2881 $coderef->($self, $field, $op, $arg)
2886 For example, here is an implementation
2887 of the MATCH .. AGAINST syntax for MySQL
2889 my $sqlmaker = SQL::Abstract->new(special_ops => [
2891 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2892 {regex => qr/^match$/i,
2894 my ($self, $field, $op, $arg) = @_;
2895 $arg = [$arg] if not ref $arg;
2896 my $label = $self->_quote($field);
2897 my ($placeholder) = $self->_convert('?');
2898 my $placeholders = join ", ", (($placeholder) x @$arg);
2899 my $sql = $self->_sqlcase('match') . " ($label) "
2900 . $self->_sqlcase('against') . " ($placeholders) ";
2901 my @bind = $self->_bindtype($field, @$arg);
2902 return ($sql, @bind);
2909 =head1 UNARY OPERATORS
2911 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2915 my ($self, $op, $arg) = @_;
2921 handler => 'method_name',
2925 A "unary operator" is a SQL syntactic clause that can be
2926 applied to a field - the operator goes before the field
2928 You can write your own operator handlers - supply a C<unary_ops>
2929 argument to the C<new> method. That argument takes an arrayref of
2930 operator definitions; each operator definition is a hashref with two
2937 the regular expression to match the operator
2941 Either a coderef or a plain scalar method name. In both cases
2942 the expected return is C<< $sql >>.
2944 When supplied with a method name, it is simply called on the
2945 L<SQL::Abstract> object as:
2947 $self->$method_name($op, $arg)
2951 $op is the part that matched the handler regex
2952 $arg is the RHS or argument of the operator
2954 When supplied with a coderef, it is called as:
2956 $coderef->($self, $op, $arg)
2964 Thanks to some benchmarking by Mark Stosberg, it turns out that
2965 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2966 I must admit this wasn't an intentional design issue, but it's a
2967 byproduct of the fact that you get to control your C<DBI> handles
2970 To maximize performance, use a code snippet like the following:
2972 # prepare a statement handle using the first row
2973 # and then reuse it for the rest of the rows
2975 for my $href (@array_of_hashrefs) {
2976 $stmt ||= $sql->insert('table', $href);
2977 $sth ||= $dbh->prepare($stmt);
2978 $sth->execute($sql->values($href));
2981 The reason this works is because the keys in your C<$href> are sorted
2982 internally by B<SQL::Abstract>. Thus, as long as your data retains
2983 the same structure, you only have to generate the SQL the first time
2984 around. On subsequent queries, simply use the C<values> function provided
2985 by this module to return your values in the correct order.
2987 However this depends on the values having the same type - if, for
2988 example, the values of a where clause may either have values
2989 (resulting in sql of the form C<column = ?> with a single bind
2990 value), or alternatively the values might be C<undef> (resulting in
2991 sql of the form C<column IS NULL> with no bind value) then the
2992 caching technique suggested will not work.
2996 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2997 really like this part (I do, at least). Building up a complex query
2998 can be as simple as the following:
3005 use CGI::FormBuilder;
3008 my $form = CGI::FormBuilder->new(...);
3009 my $sql = SQL::Abstract->new;
3011 if ($form->submitted) {
3012 my $field = $form->field;
3013 my $id = delete $field->{id};
3014 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3017 Of course, you would still have to connect using C<DBI> to run the
3018 query, but the point is that if you make your form look like your
3019 table, the actual query script can be extremely simplistic.
3021 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3022 a fast interface to returning and formatting data. I frequently
3023 use these three modules together to write complex database query
3024 apps in under 50 lines.
3026 =head1 HOW TO CONTRIBUTE
3028 Contributions are always welcome, in all usable forms (we especially
3029 welcome documentation improvements). The delivery methods include git-
3030 or unified-diff formatted patches, GitHub pull requests, or plain bug
3031 reports either via RT or the Mailing list. Contributors are generally
3032 granted full access to the official repository after their first several
3033 patches pass successful review.
3035 This project is maintained in a git repository. The code and related tools are
3036 accessible at the following locations:
3040 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3042 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3044 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3046 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3052 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3053 Great care has been taken to preserve the I<published> behavior
3054 documented in previous versions in the 1.* family; however,
3055 some features that were previously undocumented, or behaved
3056 differently from the documentation, had to be changed in order
3057 to clarify the semantics. Hence, client code that was relying
3058 on some dark areas of C<SQL::Abstract> v1.*
3059 B<might behave differently> in v1.50.
3061 The main changes are:
3067 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3071 support for the { operator => \"..." } construct (to embed literal SQL)
3075 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3079 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3083 defensive programming: check arguments
3087 fixed bug with global logic, which was previously implemented
3088 through global variables yielding side-effects. Prior versions would
3089 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3090 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3091 Now this is interpreted
3092 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3097 fixed semantics of _bindtype on array args
3101 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3102 we just avoid shifting arrays within that tree.
3106 dropped the C<_modlogic> function
3110 =head1 ACKNOWLEDGEMENTS
3112 There are a number of individuals that have really helped out with
3113 this module. Unfortunately, most of them submitted bugs via CPAN
3114 so I have no idea who they are! But the people I do know are:
3116 Ash Berlin (order_by hash term support)
3117 Matt Trout (DBIx::Class support)
3118 Mark Stosberg (benchmarking)
3119 Chas Owens (initial "IN" operator support)
3120 Philip Collins (per-field SQL functions)
3121 Eric Kolve (hashref "AND" support)
3122 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3123 Dan Kubb (support for "quote_char" and "name_sep")
3124 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3125 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3126 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3127 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3128 Oliver Charles (support for "RETURNING" after "INSERT")
3134 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3138 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3140 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3142 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3143 While not an official support venue, C<DBIx::Class> makes heavy use of
3144 C<SQL::Abstract>, and as such list members there are very familiar with
3145 how to create queries.
3149 This module is free software; you may copy this under the same
3150 terms as perl itself (either the GNU General Public License or
3151 the Artistic License)