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 -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) = @_;
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;
562 return $self->_expand_andor(-and => $expr);
564 my ($key, $value) = %$expr;
565 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
566 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
567 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
569 if (my $exp = $self->{expand}{$key}) {
570 return $self->$exp($key, $value);
572 return $self->_expand_expr_hashpair($key, $value);
574 if (ref($expr) eq 'ARRAY') {
575 my $logic = lc($self->{logic});
576 return $self->_expand_andor("-${logic}", $expr);
578 if (my $literal = is_literal_value($expr)) {
579 return +{ -literal => $literal };
581 if (!ref($expr) or Scalar::Util::blessed($expr)) {
582 if (my $d = our $Default_Scalar_To) {
583 return $self->_expand_expr({ $d => $expr });
585 return $self->_expand_value(-value => $expr);
590 sub _expand_expr_hashpair {
591 my ($self, $k, $v, $logic) = @_;
592 unless (defined($k) and length($k)) {
593 if (defined($k) and my $literal = is_literal_value($v)) {
594 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
595 return { -literal => $literal };
597 puke "Supplying an empty left hand side argument is not supported";
599 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s) if $k =~ /^-/;
601 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
604 $self->_expand_expr({ "-${rest}", $v }, $logic)
609 $op =~ s/^-// if length($op) > 1;
611 # top level special ops are illegal in general
612 # note that, arguably, if it makes no sense at top level, it also
613 # makes no sense on the other side of an = sign or similar but DBIC
614 # gets disappointingly upset if I disallow it
616 (our $Expand_Depth) == 1
617 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
619 puke "Illegal use of top-level '-$op'"
621 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
622 return { -op => [ $op, $v ] };
625 if ($self->{render}{$k}) {
631 and (keys %$v)[0] =~ /^-/
633 my ($func) = $k =~ /^-(.*)$/;
634 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
635 return +{ -op => [ $func, $self->_expand_expr($v) ] };
637 return +{ -func => [ $func, $self->_expand_expr($v) ] };
639 if (!ref($v) or is_literal_value($v)) {
640 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
647 and exists $v->{-value}
648 and not defined $v->{-value}
651 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
653 if (!ref($v) or Scalar::Util::blessed($v)) {
654 my $d = our $Default_Scalar_To;
658 $self->_expand_ident(-ident => $k),
660 ? $self->_expand_expr($d => $v)
661 : { -bind => [ $k, $v ] }
666 if (ref($v) eq 'HASH') {
668 return $self->_expand_andor(-and => [
669 map +{ $k => { $_ => $v->{$_} } },
673 return undef unless keys %$v;
675 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
676 $self->_assert_pass_injection_guard($op);
677 if ($op =~ s/ [_\s]? \d+ $//x ) {
678 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
679 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
681 if (my $x = $self->{expand_op}{$op}) {
682 local our $Cur_Col_Meta = $k;
683 return $self->$x($op, $vv, $k);
685 if ($op eq 'value' and not defined($vv)) {
686 return $self->_expand_expr({ $k, undef }) unless defined($vv);
688 if ($op =~ /^is(?: not)?$/) {
689 puke "$op can only take undef as argument"
693 and exists($vv->{-value})
694 and !defined($vv->{-value})
696 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
698 if ($op =~ /^(and|or)$/) {
699 return $self->_expand_andor('-'.$op, [
700 map +{ $k, { $_ => $vv->{$_} } },
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_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 : '-'.($self->{logic} || 'or')
777 return $self->_expand_andor(
778 $this_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);
829 my ($self, $k, $v) = @_;
830 my ($logic) = $k =~ /^-(.*)$/;
831 if (ref($v) eq 'HASH') {
834 map $self->_expand_expr({ $_ => $v->{$_} }, $logic),
838 if (ref($v) eq 'ARRAY') {
839 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
842 (ref($_) eq 'ARRAY' and @$_)
843 or (ref($_) eq 'HASH' and %$_)
849 while (my ($el) = splice @expr, 0, 1) {
850 puke "Supplying an empty left hand side argument is not supported in array-pairs"
851 unless defined($el) and length($el);
852 my $elref = ref($el);
854 local our $Expand_Depth = 0;
855 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
856 } elsif ($elref eq 'ARRAY') {
857 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
858 } elsif (my $l = is_literal_value($el)) {
859 push @res, { -literal => $l };
860 } elsif ($elref eq 'HASH') {
861 local our $Expand_Depth = 0;
862 push @res, grep defined, $self->_expand_expr($el) if %$el;
868 # return $res[0] if @res == 1;
869 return { -op => [ $logic, @res ] };
874 sub _expand_between {
875 my ($self, $op, $vv, $k) = @_;
876 local our $Cur_Col_Meta = $k;
877 my @rhs = map $self->_expand_expr($_),
878 ref($vv) eq 'ARRAY' ? @$vv : $vv;
880 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
882 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
884 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
888 $self->_expand_ident(-ident => $k),
894 my ($self, $op, $vv, $k) = @_;
895 if (my $literal = is_literal_value($vv)) {
896 my ($sql, @bind) = @$literal;
897 my $opened_sql = $self->_open_outer_paren($sql);
899 $op, $self->_expand_ident(-ident => $k),
900 [ { -literal => [ $opened_sql, @bind ] } ]
904 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
905 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
906 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
907 . 'will emit the logically correct SQL instead of raising this exception)'
909 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
911 my @rhs = map $self->_expand_expr($_),
912 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
913 map { defined($_) ? $_: puke($undef_err) }
914 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
915 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
919 $self->_expand_ident(-ident => $k),
925 my ($self, $op, $v) = @_;
926 # DBIx::Class requires a nest warning to be emitted once but the private
927 # method it overrode to do so no longer exists
928 if ($self->{is_dbic_sqlmaker}) {
929 unless (our $Nest_Warned) {
931 "-nest in search conditions is deprecated, you most probably wanted:\n"
932 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
937 return $self->_expand_expr($v);
941 my ($self, $where, $logic) = @_;
943 # Special case: top level simple string treated as literal
945 my $where_exp = (ref($where)
946 ? $self->_expand_expr($where, $logic)
947 : { -literal => [ $where ] });
949 # dispatch expanded expression
951 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
952 # DBIx::Class used to call _recurse_where in scalar context
953 # something else might too...
955 return ($sql, @bind);
958 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
964 my ($self, $ident) = @_;
966 return $self->_convert($self->_quote($ident));
970 my ($self, $list) = @_;
971 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
972 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
976 my ($self, $rest) = @_;
977 my ($func, @args) = @$rest;
981 push @arg_sql, shift @x;
983 } map [ $self->render_aqt($_) ], @args;
984 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
988 my ($self, $bind) = @_;
989 return ($self->_convert('?'), $self->_bindtype(@$bind));
992 sub _render_literal {
993 my ($self, $literal) = @_;
994 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1000 my ($self, $op, $args) = @_;
1001 my ($left, $low, $high) = @$args;
1002 my ($rhsql, @rhbind) = do {
1004 puke "Single arg to between must be a literal"
1005 unless $low->{-literal};
1008 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1009 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1010 @{$l}[1..$#$l], @{$h}[1..$#$h])
1013 my ($lhsql, @lhbind) = $self->render_aqt($left);
1015 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1018 }), 'between', 'not between'),
1020 my ($self, $op, $args) = @_;
1021 my ($lhs, $rhs) = @$args;
1024 my ($sql, @bind) = $self->render_aqt($_);
1025 push @in_bind, @bind;
1028 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1030 $lhsql.' '.$self->_sqlcase($op).' ( '
1031 .join(', ', @in_sql)
1035 }), 'in', 'not in'),
1036 (map +($_ => '_render_unop_postfix'),
1037 'is null', 'is not null', 'asc', 'desc',
1039 (not => '_render_op_not'),
1041 my ($self, $op, $args) = @_;
1042 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1043 return '' unless @parts;
1044 return @{$parts[0]} if @parts == 1;
1045 my ($final_sql) = join(
1046 ' '.$self->_sqlcase($op).' ',
1051 map @{$_}[1..$#$_], @parts
1057 my ($self, $v) = @_;
1058 my ($op, @args) = @$v;
1059 if (my $r = $self->{render_op}{$op}) {
1060 return $self->$r($op, \@args);
1062 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1063 if ($us and @args > 1) {
1064 puke "Special op '${op}' requires first value to be identifier"
1065 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1066 my $k = join(($self->{name_sep}||'.'), @$ident);
1067 local our $Expand_Depth = 1;
1068 return $self->${\($us->{handler})}($k, $op, $args[1]);
1070 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1071 return $self->${\($us->{handler})}($op, $args[0]);
1074 return $self->_render_unop_prefix($op, \@args);
1076 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1077 return '' unless @parts;
1078 my ($final_sql) = join(
1079 ' '.$self->_sqlcase($op).' ',
1084 map @{$_}[1..$#$_], @parts
1090 sub _render_op_not {
1091 my ($self, $op, $v) = @_;
1092 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1093 return "(${sql})", @bind;
1096 sub _render_unop_prefix {
1097 my ($self, $op, $v) = @_;
1098 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1099 my $op_sql = $self->_sqlcase($op);
1100 return ("${op_sql} ${expr_sql}", @bind);
1103 sub _render_unop_postfix {
1104 my ($self, $op, $v) = @_;
1105 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1106 my $op_sql = $self->_sqlcase($op);
1107 return ($expr_sql.' '.$op_sql, @bind);
1110 # Some databases (SQLite) treat col IN (1, 2) different from
1111 # col IN ( (1, 2) ). Use this to strip all outer parens while
1112 # adding them back in the corresponding method
1113 sub _open_outer_paren {
1114 my ($self, $sql) = @_;
1116 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1118 # there are closing parens inside, need the heavy duty machinery
1119 # to reevaluate the extraction starting from $sql (full reevaluation)
1120 if ($inner =~ /\)/) {
1121 require Text::Balanced;
1123 my (undef, $remainder) = do {
1124 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1126 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1129 # the entire expression needs to be a balanced bracketed thing
1130 # (after an extract no remainder sans trailing space)
1131 last if defined $remainder and $remainder =~ /\S/;
1141 #======================================================================
1143 #======================================================================
1145 sub _expand_order_by {
1146 my ($self, $arg) = @_;
1148 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1150 my $expander = sub {
1151 my ($self, $dir, $expr) = @_;
1152 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1153 foreach my $arg (@to_expand) {
1157 and grep /^-(asc|desc)$/, keys %$arg
1159 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1163 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1165 map $self->expand_expr($_, -ident),
1166 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1167 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1170 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1172 return $self->$expander(undef, $arg);
1176 my ($self, $arg) = @_;
1178 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1180 my ($sql, @bind) = $self->render_aqt($expanded);
1182 return '' unless length($sql);
1184 my $final_sql = $self->_sqlcase(' order by ').$sql;
1186 return wantarray ? ($final_sql, @bind) : $final_sql;
1189 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1191 sub _order_by_chunks {
1192 my ($self, $arg) = @_;
1194 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1196 return $self->_chunkify_order_by($expanded);
1199 sub _chunkify_order_by {
1200 my ($self, $expanded) = @_;
1202 return grep length, $self->render_aqt($expanded)
1203 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1206 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1207 return map $self->_chunkify_order_by($_), @$l;
1209 return [ $self->render_aqt($_) ];
1213 #======================================================================
1214 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1215 #======================================================================
1221 $self->_expand_maybe_list_expr($from, undef, -ident)
1226 #======================================================================
1228 #======================================================================
1230 sub _expand_maybe_list_expr {
1231 my ($self, $expr, $logic, $default) = @_;
1233 if (ref($expr) eq 'ARRAY') {
1235 map $self->expand_expr($_, $default), @$expr
1242 return $self->expand_expr($e, $default);
1245 # highly optimized, as it's called way too often
1247 # my ($self, $label) = @_;
1249 return '' unless defined $_[1];
1250 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1251 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1253 unless ($_[0]->{quote_char}) {
1254 if (ref($_[1]) eq 'ARRAY') {
1255 return join($_[0]->{name_sep}||'.', @{$_[1]});
1257 $_[0]->_assert_pass_injection_guard($_[1]);
1262 my $qref = ref $_[0]->{quote_char};
1264 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1265 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1266 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1268 my $esc = $_[0]->{escape_char} || $r;
1270 # parts containing * are naturally unquoted
1272 $_[0]->{name_sep}||'',
1276 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1278 (ref($_[1]) eq 'ARRAY'
1282 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1290 # Conversion, if applicable
1292 #my ($self, $arg) = @_;
1293 if ($_[0]->{convert_where}) {
1294 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1301 #my ($self, $col, @vals) = @_;
1302 # called often - tighten code
1303 return $_[0]->{bindtype} eq 'columns'
1304 ? map {[$_[1], $_]} @_[2 .. $#_]
1309 # Dies if any element of @bind is not in [colname => value] format
1310 # if bindtype is 'columns'.
1311 sub _assert_bindval_matches_bindtype {
1312 # my ($self, @bind) = @_;
1314 if ($self->{bindtype} eq 'columns') {
1316 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1317 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1323 sub _join_sql_clauses {
1324 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1326 if (@$clauses_aref > 1) {
1327 my $join = " " . $self->_sqlcase($logic) . " ";
1328 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1329 return ($sql, @$bind_aref);
1331 elsif (@$clauses_aref) {
1332 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1335 return (); # if no SQL, ignore @$bind_aref
1340 # Fix SQL case, if so requested
1342 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1343 # don't touch the argument ... crooked logic, but let's not change it!
1344 return $_[0]->{case} ? $_[1] : uc($_[1]);
1348 #======================================================================
1349 # DISPATCHING FROM REFKIND
1350 #======================================================================
1353 my ($self, $data) = @_;
1355 return 'UNDEF' unless defined $data;
1357 # blessed objects are treated like scalars
1358 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1360 return 'SCALAR' unless $ref;
1363 while ($ref eq 'REF') {
1365 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1369 return ($ref||'SCALAR') . ('REF' x $n_steps);
1373 my ($self, $data) = @_;
1374 my @try = ($self->_refkind($data));
1375 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1376 push @try, 'FALLBACK';
1380 sub _METHOD_FOR_refkind {
1381 my ($self, $meth_prefix, $data) = @_;
1384 for (@{$self->_try_refkind($data)}) {
1385 $method = $self->can($meth_prefix."_".$_)
1389 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1393 sub _SWITCH_refkind {
1394 my ($self, $data, $dispatch_table) = @_;
1397 for (@{$self->_try_refkind($data)}) {
1398 $coderef = $dispatch_table->{$_}
1402 puke "no dispatch entry for ".$self->_refkind($data)
1411 #======================================================================
1412 # VALUES, GENERATE, AUTOLOAD
1413 #======================================================================
1415 # LDNOTE: original code from nwiger, didn't touch code in that section
1416 # I feel the AUTOLOAD stuff should not be the default, it should
1417 # only be activated on explicit demand by user.
1421 my $data = shift || return;
1422 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1423 unless ref $data eq 'HASH';
1426 foreach my $k (sort keys %$data) {
1427 my $v = $data->{$k};
1428 $self->_SWITCH_refkind($v, {
1430 if ($self->{array_datatypes}) { # array datatype
1431 push @all_bind, $self->_bindtype($k, $v);
1433 else { # literal SQL with bind
1434 my ($sql, @bind) = @$v;
1435 $self->_assert_bindval_matches_bindtype(@bind);
1436 push @all_bind, @bind;
1439 ARRAYREFREF => sub { # literal SQL with bind
1440 my ($sql, @bind) = @${$v};
1441 $self->_assert_bindval_matches_bindtype(@bind);
1442 push @all_bind, @bind;
1444 SCALARREF => sub { # literal SQL without bind
1446 SCALAR_or_UNDEF => sub {
1447 push @all_bind, $self->_bindtype($k, $v);
1458 my(@sql, @sqlq, @sqlv);
1462 if ($ref eq 'HASH') {
1463 for my $k (sort keys %$_) {
1466 my $label = $self->_quote($k);
1467 if ($r eq 'ARRAY') {
1468 # literal SQL with bind
1469 my ($sql, @bind) = @$v;
1470 $self->_assert_bindval_matches_bindtype(@bind);
1471 push @sqlq, "$label = $sql";
1473 } elsif ($r eq 'SCALAR') {
1474 # literal SQL without bind
1475 push @sqlq, "$label = $$v";
1477 push @sqlq, "$label = ?";
1478 push @sqlv, $self->_bindtype($k, $v);
1481 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1482 } elsif ($ref eq 'ARRAY') {
1483 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1486 if ($r eq 'ARRAY') { # literal SQL with bind
1487 my ($sql, @bind) = @$v;
1488 $self->_assert_bindval_matches_bindtype(@bind);
1491 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1492 # embedded literal SQL
1499 push @sql, '(' . join(', ', @sqlq) . ')';
1500 } elsif ($ref eq 'SCALAR') {
1504 # strings get case twiddled
1505 push @sql, $self->_sqlcase($_);
1509 my $sql = join ' ', @sql;
1511 # this is pretty tricky
1512 # if ask for an array, return ($stmt, @bind)
1513 # otherwise, s/?/shift @sqlv/ to put it inline
1515 return ($sql, @sqlv);
1517 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1518 ref $d ? $d->[1] : $d/e;
1527 # This allows us to check for a local, then _form, attr
1529 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1530 return $self->generate($name, @_);
1541 SQL::Abstract - Generate SQL from Perl data structures
1547 my $sql = SQL::Abstract->new;
1549 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1551 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1553 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1555 my($stmt, @bind) = $sql->delete($table, \%where);
1557 # Then, use these in your DBI statements
1558 my $sth = $dbh->prepare($stmt);
1559 $sth->execute(@bind);
1561 # Just generate the WHERE clause
1562 my($stmt, @bind) = $sql->where(\%where, $order);
1564 # Return values in the same order, for hashed queries
1565 # See PERFORMANCE section for more details
1566 my @bind = $sql->values(\%fieldvals);
1570 This module was inspired by the excellent L<DBIx::Abstract>.
1571 However, in using that module I found that what I really wanted
1572 to do was generate SQL, but still retain complete control over my
1573 statement handles and use the DBI interface. So, I set out to
1574 create an abstract SQL generation module.
1576 While based on the concepts used by L<DBIx::Abstract>, there are
1577 several important differences, especially when it comes to WHERE
1578 clauses. I have modified the concepts used to make the SQL easier
1579 to generate from Perl data structures and, IMO, more intuitive.
1580 The underlying idea is for this module to do what you mean, based
1581 on the data structures you provide it. The big advantage is that
1582 you don't have to modify your code every time your data changes,
1583 as this module figures it out.
1585 To begin with, an SQL INSERT is as easy as just specifying a hash
1586 of C<key=value> pairs:
1589 name => 'Jimbo Bobson',
1590 phone => '123-456-7890',
1591 address => '42 Sister Lane',
1592 city => 'St. Louis',
1593 state => 'Louisiana',
1596 The SQL can then be generated with this:
1598 my($stmt, @bind) = $sql->insert('people', \%data);
1600 Which would give you something like this:
1602 $stmt = "INSERT INTO people
1603 (address, city, name, phone, state)
1604 VALUES (?, ?, ?, ?, ?)";
1605 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1606 '123-456-7890', 'Louisiana');
1608 These are then used directly in your DBI code:
1610 my $sth = $dbh->prepare($stmt);
1611 $sth->execute(@bind);
1613 =head2 Inserting and Updating Arrays
1615 If your database has array types (like for example Postgres),
1616 activate the special option C<< array_datatypes => 1 >>
1617 when creating the C<SQL::Abstract> object.
1618 Then you may use an arrayref to insert and update database array types:
1620 my $sql = SQL::Abstract->new(array_datatypes => 1);
1622 planets => [qw/Mercury Venus Earth Mars/]
1625 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1629 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1631 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1634 =head2 Inserting and Updating SQL
1636 In order to apply SQL functions to elements of your C<%data> you may
1637 specify a reference to an arrayref for the given hash value. For example,
1638 if you need to execute the Oracle C<to_date> function on a value, you can
1639 say something like this:
1643 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1646 The first value in the array is the actual SQL. Any other values are
1647 optional and would be included in the bind values array. This gives
1650 my($stmt, @bind) = $sql->insert('people', \%data);
1652 $stmt = "INSERT INTO people (name, date_entered)
1653 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1654 @bind = ('Bill', '03/02/2003');
1656 An UPDATE is just as easy, all you change is the name of the function:
1658 my($stmt, @bind) = $sql->update('people', \%data);
1660 Notice that your C<%data> isn't touched; the module will generate
1661 the appropriately quirky SQL for you automatically. Usually you'll
1662 want to specify a WHERE clause for your UPDATE, though, which is
1663 where handling C<%where> hashes comes in handy...
1665 =head2 Complex where statements
1667 This module can generate pretty complicated WHERE statements
1668 easily. For example, simple C<key=value> pairs are taken to mean
1669 equality, and if you want to see if a field is within a set
1670 of values, you can use an arrayref. Let's say we wanted to
1671 SELECT some data based on this criteria:
1674 requestor => 'inna',
1675 worker => ['nwiger', 'rcwe', 'sfz'],
1676 status => { '!=', 'completed' }
1679 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1681 The above would give you something like this:
1683 $stmt = "SELECT * FROM tickets WHERE
1684 ( requestor = ? ) AND ( status != ? )
1685 AND ( worker = ? OR worker = ? OR worker = ? )";
1686 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1688 Which you could then use in DBI code like so:
1690 my $sth = $dbh->prepare($stmt);
1691 $sth->execute(@bind);
1697 The methods are simple. There's one for every major SQL operation,
1698 and a constructor you use first. The arguments are specified in a
1699 similar order for each method (table, then fields, then a where
1700 clause) to try and simplify things.
1702 =head2 new(option => 'value')
1704 The C<new()> function takes a list of options and values, and returns
1705 a new B<SQL::Abstract> object which can then be used to generate SQL
1706 through the methods below. The options accepted are:
1712 If set to 'lower', then SQL will be generated in all lowercase. By
1713 default SQL is generated in "textbook" case meaning something like:
1715 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1717 Any setting other than 'lower' is ignored.
1721 This determines what the default comparison operator is. By default
1722 it is C<=>, meaning that a hash like this:
1724 %where = (name => 'nwiger', email => 'nate@wiger.org');
1726 Will generate SQL like this:
1728 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1730 However, you may want loose comparisons by default, so if you set
1731 C<cmp> to C<like> you would get SQL such as:
1733 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1735 You can also override the comparison on an individual basis - see
1736 the huge section on L</"WHERE CLAUSES"> at the bottom.
1738 =item sqltrue, sqlfalse
1740 Expressions for inserting boolean values within SQL statements.
1741 By default these are C<1=1> and C<1=0>. They are used
1742 by the special operators C<-in> and C<-not_in> for generating
1743 correct SQL even when the argument is an empty array (see below).
1747 This determines the default logical operator for multiple WHERE
1748 statements in arrays or hashes. If absent, the default logic is "or"
1749 for arrays, and "and" for hashes. This means that a WHERE
1753 event_date => {'>=', '2/13/99'},
1754 event_date => {'<=', '4/24/03'},
1757 will generate SQL like this:
1759 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1761 This is probably not what you want given this query, though (look
1762 at the dates). To change the "OR" to an "AND", simply specify:
1764 my $sql = SQL::Abstract->new(logic => 'and');
1766 Which will change the above C<WHERE> to:
1768 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1770 The logic can also be changed locally by inserting
1771 a modifier in front of an arrayref:
1773 @where = (-and => [event_date => {'>=', '2/13/99'},
1774 event_date => {'<=', '4/24/03'} ]);
1776 See the L</"WHERE CLAUSES"> section for explanations.
1780 This will automatically convert comparisons using the specified SQL
1781 function for both column and value. This is mostly used with an argument
1782 of C<upper> or C<lower>, so that the SQL will have the effect of
1783 case-insensitive "searches". For example, this:
1785 $sql = SQL::Abstract->new(convert => 'upper');
1786 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1788 Will turn out the following SQL:
1790 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1792 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1793 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1794 not validate this option; it will just pass through what you specify verbatim).
1798 This is a kludge because many databases suck. For example, you can't
1799 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1800 Instead, you have to use C<bind_param()>:
1802 $sth->bind_param(1, 'reg data');
1803 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1805 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1806 which loses track of which field each slot refers to. Fear not.
1808 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1809 Currently, you can specify either C<normal> (default) or C<columns>. If you
1810 specify C<columns>, you will get an array that looks like this:
1812 my $sql = SQL::Abstract->new(bindtype => 'columns');
1813 my($stmt, @bind) = $sql->insert(...);
1816 [ 'column1', 'value1' ],
1817 [ 'column2', 'value2' ],
1818 [ 'column3', 'value3' ],
1821 You can then iterate through this manually, using DBI's C<bind_param()>.
1823 $sth->prepare($stmt);
1826 my($col, $data) = @$_;
1827 if ($col eq 'details' || $col eq 'comments') {
1828 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1829 } elsif ($col eq 'image') {
1830 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1832 $sth->bind_param($i, $data);
1836 $sth->execute; # execute without @bind now
1838 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1839 Basically, the advantage is still that you don't have to care which fields
1840 are or are not included. You could wrap that above C<for> loop in a simple
1841 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1842 get a layer of abstraction over manual SQL specification.
1844 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1845 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1846 will expect the bind values in this format.
1850 This is the character that a table or column name will be quoted
1851 with. By default this is an empty string, but you could set it to
1852 the character C<`>, to generate SQL like this:
1854 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1856 Alternatively, you can supply an array ref of two items, the first being the left
1857 hand quote character, and the second the right hand quote character. For
1858 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1859 that generates SQL like this:
1861 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1863 Quoting is useful if you have tables or columns names that are reserved
1864 words in your database's SQL dialect.
1868 This is the character that will be used to escape L</quote_char>s appearing
1869 in an identifier before it has been quoted.
1871 The parameter default in case of a single L</quote_char> character is the quote
1874 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1875 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1876 of the B<opening (left)> L</quote_char> within the identifier are currently left
1877 untouched. The default for opening-closing-style quotes may change in future
1878 versions, thus you are B<strongly encouraged> to specify the escape character
1883 This is the character that separates a table and column name. It is
1884 necessary to specify this when the C<quote_char> option is selected,
1885 so that tables and column names can be individually quoted like this:
1887 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1889 =item injection_guard
1891 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1892 column name specified in a query structure. This is a safety mechanism to avoid
1893 injection attacks when mishandling user input e.g.:
1895 my %condition_as_column_value_pairs = get_values_from_user();
1896 $sqla->select( ... , \%condition_as_column_value_pairs );
1898 If the expression matches an exception is thrown. Note that literal SQL
1899 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1901 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1903 =item array_datatypes
1905 When this option is true, arrayrefs in INSERT or UPDATE are
1906 interpreted as array datatypes and are passed directly
1908 When this option is false, arrayrefs are interpreted
1909 as literal SQL, just like refs to arrayrefs
1910 (but this behavior is for backwards compatibility; when writing
1911 new queries, use the "reference to arrayref" syntax
1917 Takes a reference to a list of "special operators"
1918 to extend the syntax understood by L<SQL::Abstract>.
1919 See section L</"SPECIAL OPERATORS"> for details.
1923 Takes a reference to a list of "unary operators"
1924 to extend the syntax understood by L<SQL::Abstract>.
1925 See section L</"UNARY OPERATORS"> for details.
1931 =head2 insert($table, \@values || \%fieldvals, \%options)
1933 This is the simplest function. You simply give it a table name
1934 and either an arrayref of values or hashref of field/value pairs.
1935 It returns an SQL INSERT statement and a list of bind values.
1936 See the sections on L</"Inserting and Updating Arrays"> and
1937 L</"Inserting and Updating SQL"> for information on how to insert
1938 with those data types.
1940 The optional C<\%options> hash reference may contain additional
1941 options to generate the insert SQL. Currently supported options
1948 Takes either a scalar of raw SQL fields, or an array reference of
1949 field names, and adds on an SQL C<RETURNING> statement at the end.
1950 This allows you to return data generated by the insert statement
1951 (such as row IDs) without performing another C<SELECT> statement.
1952 Note, however, this is not part of the SQL standard and may not
1953 be supported by all database engines.
1957 =head2 update($table, \%fieldvals, \%where, \%options)
1959 This takes a table, hashref of field/value pairs, and an optional
1960 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1962 See the sections on L</"Inserting and Updating Arrays"> and
1963 L</"Inserting and Updating SQL"> for information on how to insert
1964 with those data types.
1966 The optional C<\%options> hash reference may contain additional
1967 options to generate the update SQL. Currently supported options
1974 See the C<returning> option to
1975 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1979 =head2 select($source, $fields, $where, $order)
1981 This returns a SQL SELECT statement and associated list of bind values, as
1982 specified by the arguments:
1988 Specification of the 'FROM' part of the statement.
1989 The argument can be either a plain scalar (interpreted as a table
1990 name, will be quoted), or an arrayref (interpreted as a list
1991 of table names, joined by commas, quoted), or a scalarref
1992 (literal SQL, not quoted).
1996 Specification of the list of fields to retrieve from
1998 The argument can be either an arrayref (interpreted as a list
1999 of field names, will be joined by commas and quoted), or a
2000 plain scalar (literal SQL, not quoted).
2001 Please observe that this API is not as flexible as that of
2002 the first argument C<$source>, for backwards compatibility reasons.
2006 Optional argument to specify the WHERE part of the query.
2007 The argument is most often a hashref, but can also be
2008 an arrayref or plain scalar --
2009 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2013 Optional argument to specify the ORDER BY part of the query.
2014 The argument can be a scalar, a hashref or an arrayref
2015 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2021 =head2 delete($table, \%where, \%options)
2023 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2024 It returns an SQL DELETE statement and list of bind values.
2026 The optional C<\%options> hash reference may contain additional
2027 options to generate the delete SQL. Currently supported options
2034 See the C<returning> option to
2035 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2039 =head2 where(\%where, $order)
2041 This is used to generate just the WHERE clause. For example,
2042 if you have an arbitrary data structure and know what the
2043 rest of your SQL is going to look like, but want an easy way
2044 to produce a WHERE clause, use this. It returns an SQL WHERE
2045 clause and list of bind values.
2048 =head2 values(\%data)
2050 This just returns the values from the hash C<%data>, in the same
2051 order that would be returned from any of the other above queries.
2052 Using this allows you to markedly speed up your queries if you
2053 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2055 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2057 Warning: This is an experimental method and subject to change.
2059 This returns arbitrarily generated SQL. It's a really basic shortcut.
2060 It will return two different things, depending on return context:
2062 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2063 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2065 These would return the following:
2067 # First calling form
2068 $stmt = "CREATE TABLE test (?, ?)";
2069 @bind = (field1, field2);
2071 # Second calling form
2072 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2074 Depending on what you're trying to do, it's up to you to choose the correct
2075 format. In this example, the second form is what you would want.
2079 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2083 ALTER SESSION SET nls_date_format = 'MM/YY'
2085 You get the idea. Strings get their case twiddled, but everything
2086 else remains verbatim.
2088 =head1 EXPORTABLE FUNCTIONS
2090 =head2 is_plain_value
2092 Determines if the supplied argument is a plain value as understood by this
2097 =item * The value is C<undef>
2099 =item * The value is a non-reference
2101 =item * The value is an object with stringification overloading
2103 =item * The value is of the form C<< { -value => $anything } >>
2107 On failure returns C<undef>, on success returns a B<scalar> reference
2108 to the original supplied argument.
2114 The stringification overloading detection is rather advanced: it takes
2115 into consideration not only the presence of a C<""> overload, but if that
2116 fails also checks for enabled
2117 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2118 on either C<0+> or C<bool>.
2120 Unfortunately testing in the field indicates that this
2121 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2122 but only when very large numbers of stringifying objects are involved.
2123 At the time of writing ( Sep 2014 ) there is no clear explanation of
2124 the direct cause, nor is there a manageably small test case that reliably
2125 reproduces the problem.
2127 If you encounter any of the following exceptions in B<random places within
2128 your application stack> - this module may be to blame:
2130 Operation "ne": no method found,
2131 left argument in overloaded package <something>,
2132 right argument in overloaded package <something>
2136 Stub found while resolving method "???" overloading """" in package <something>
2138 If you fall victim to the above - please attempt to reduce the problem
2139 to something that could be sent to the L<SQL::Abstract developers
2140 |DBIx::Class/GETTING HELP/SUPPORT>
2141 (either publicly or privately). As a workaround in the meantime you can
2142 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2143 value, which will most likely eliminate your problem (at the expense of
2144 not being able to properly detect exotic forms of stringification).
2146 This notice and environment variable will be removed in a future version,
2147 as soon as the underlying problem is found and a reliable workaround is
2152 =head2 is_literal_value
2154 Determines if the supplied argument is a literal value as understood by this
2159 =item * C<\$sql_string>
2161 =item * C<\[ $sql_string, @bind_values ]>
2165 On failure returns C<undef>, on success returns an B<array> reference
2166 containing the unpacked version of the supplied literal SQL and bind values.
2168 =head1 WHERE CLAUSES
2172 This module uses a variation on the idea from L<DBIx::Abstract>. It
2173 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2174 module is that things in arrays are OR'ed, and things in hashes
2177 The easiest way to explain is to show lots of examples. After
2178 each C<%where> hash shown, it is assumed you used:
2180 my($stmt, @bind) = $sql->where(\%where);
2182 However, note that the C<%where> hash can be used directly in any
2183 of the other functions as well, as described above.
2185 =head2 Key-value pairs
2187 So, let's get started. To begin, a simple hash:
2191 status => 'completed'
2194 Is converted to SQL C<key = val> statements:
2196 $stmt = "WHERE user = ? AND status = ?";
2197 @bind = ('nwiger', 'completed');
2199 One common thing I end up doing is having a list of values that
2200 a field can be in. To do this, simply specify a list inside of
2205 status => ['assigned', 'in-progress', 'pending'];
2208 This simple code will create the following:
2210 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2211 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2213 A field associated to an empty arrayref will be considered a
2214 logical false and will generate 0=1.
2216 =head2 Tests for NULL values
2218 If the value part is C<undef> then this is converted to SQL <IS NULL>
2227 $stmt = "WHERE user = ? AND status IS NULL";
2230 To test if a column IS NOT NULL:
2234 status => { '!=', undef },
2237 =head2 Specific comparison operators
2239 If you want to specify a different type of operator for your comparison,
2240 you can use a hashref for a given column:
2244 status => { '!=', 'completed' }
2247 Which would generate:
2249 $stmt = "WHERE user = ? AND status != ?";
2250 @bind = ('nwiger', 'completed');
2252 To test against multiple values, just enclose the values in an arrayref:
2254 status => { '=', ['assigned', 'in-progress', 'pending'] };
2256 Which would give you:
2258 "WHERE status = ? OR status = ? OR status = ?"
2261 The hashref can also contain multiple pairs, in which case it is expanded
2262 into an C<AND> of its elements:
2266 status => { '!=', 'completed', -not_like => 'pending%' }
2269 # Or more dynamically, like from a form
2270 $where{user} = 'nwiger';
2271 $where{status}{'!='} = 'completed';
2272 $where{status}{'-not_like'} = 'pending%';
2274 # Both generate this
2275 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2276 @bind = ('nwiger', 'completed', 'pending%');
2279 To get an OR instead, you can combine it with the arrayref idea:
2283 priority => [ { '=', 2 }, { '>', 5 } ]
2286 Which would generate:
2288 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2289 @bind = ('2', '5', 'nwiger');
2291 If you want to include literal SQL (with or without bind values), just use a
2292 scalar reference or reference to an arrayref as the value:
2295 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2296 date_expires => { '<' => \"now()" }
2299 Which would generate:
2301 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2302 @bind = ('11/26/2008');
2305 =head2 Logic and nesting operators
2307 In the example above,
2308 there is a subtle trap if you want to say something like
2309 this (notice the C<AND>):
2311 WHERE priority != ? AND priority != ?
2313 Because, in Perl you I<can't> do this:
2315 priority => { '!=' => 2, '!=' => 1 }
2317 As the second C<!=> key will obliterate the first. The solution
2318 is to use the special C<-modifier> form inside an arrayref:
2320 priority => [ -and => {'!=', 2},
2324 Normally, these would be joined by C<OR>, but the modifier tells it
2325 to use C<AND> instead. (Hint: You can use this in conjunction with the
2326 C<logic> option to C<new()> in order to change the way your queries
2327 work by default.) B<Important:> Note that the C<-modifier> goes
2328 B<INSIDE> the arrayref, as an extra first element. This will
2329 B<NOT> do what you think it might:
2331 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2333 Here is a quick list of equivalencies, since there is some overlap:
2336 status => {'!=', 'completed', 'not like', 'pending%' }
2337 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2340 status => {'=', ['assigned', 'in-progress']}
2341 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2342 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2346 =head2 Special operators: IN, BETWEEN, etc.
2348 You can also use the hashref format to compare a list of fields using the
2349 C<IN> comparison operator, by specifying the list as an arrayref:
2352 status => 'completed',
2353 reportid => { -in => [567, 2335, 2] }
2356 Which would generate:
2358 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2359 @bind = ('completed', '567', '2335', '2');
2361 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2364 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2365 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2366 'sqltrue' (by default: C<1=1>).
2368 In addition to the array you can supply a chunk of literal sql or
2369 literal sql with bind:
2372 customer => { -in => \[
2373 'SELECT cust_id FROM cust WHERE balance > ?',
2376 status => { -in => \'SELECT status_codes FROM states' },
2382 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2383 AND status IN ( SELECT status_codes FROM states )
2387 Finally, if the argument to C<-in> is not a reference, it will be
2388 treated as a single-element array.
2390 Another pair of operators is C<-between> and C<-not_between>,
2391 used with an arrayref of two values:
2395 completion_date => {
2396 -not_between => ['2002-10-01', '2003-02-06']
2402 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2404 Just like with C<-in> all plausible combinations of literal SQL
2408 start0 => { -between => [ 1, 2 ] },
2409 start1 => { -between => \["? AND ?", 1, 2] },
2410 start2 => { -between => \"lower(x) AND upper(y)" },
2411 start3 => { -between => [
2413 \["upper(?)", 'stuff' ],
2420 ( start0 BETWEEN ? AND ? )
2421 AND ( start1 BETWEEN ? AND ? )
2422 AND ( start2 BETWEEN lower(x) AND upper(y) )
2423 AND ( start3 BETWEEN lower(x) AND upper(?) )
2425 @bind = (1, 2, 1, 2, 'stuff');
2428 These are the two builtin "special operators"; but the
2429 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2431 =head2 Unary operators: bool
2433 If you wish to test against boolean columns or functions within your
2434 database you can use the C<-bool> and C<-not_bool> operators. For
2435 example to test the column C<is_user> being true and the column
2436 C<is_enabled> being false you would use:-
2440 -not_bool => 'is_enabled',
2445 WHERE is_user AND NOT is_enabled
2447 If a more complex combination is required, testing more conditions,
2448 then you should use the and/or operators:-
2453 -not_bool => { two=> { -rlike => 'bar' } },
2454 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2465 (NOT ( three = ? OR three > ? ))
2468 =head2 Nested conditions, -and/-or prefixes
2470 So far, we've seen how multiple conditions are joined with a top-level
2471 C<AND>. We can change this by putting the different conditions we want in
2472 hashes and then putting those hashes in an array. For example:
2477 status => { -like => ['pending%', 'dispatched'] },
2481 status => 'unassigned',
2485 This data structure would create the following:
2487 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2488 OR ( user = ? AND status = ? ) )";
2489 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2492 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2493 to change the logic inside:
2499 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2500 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2507 $stmt = "WHERE ( user = ?
2508 AND ( ( workhrs > ? AND geo = ? )
2509 OR ( workhrs < ? OR geo = ? ) ) )";
2510 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2512 =head3 Algebraic inconsistency, for historical reasons
2514 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2515 operator goes C<outside> of the nested structure; whereas when connecting
2516 several constraints on one column, the C<-and> operator goes
2517 C<inside> the arrayref. Here is an example combining both features:
2520 -and => [a => 1, b => 2],
2521 -or => [c => 3, d => 4],
2522 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2527 WHERE ( ( ( a = ? AND b = ? )
2528 OR ( c = ? OR d = ? )
2529 OR ( e LIKE ? AND e LIKE ? ) ) )
2531 This difference in syntax is unfortunate but must be preserved for
2532 historical reasons. So be careful: the two examples below would
2533 seem algebraically equivalent, but they are not
2536 { -like => 'foo%' },
2537 { -like => '%bar' },
2539 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2542 { col => { -like => 'foo%' } },
2543 { col => { -like => '%bar' } },
2545 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2548 =head2 Literal SQL and value type operators
2550 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2551 side" is a column name and the "right side" is a value (normally rendered as
2552 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2553 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2554 alter this behavior. There are several ways of doing so.
2558 This is a virtual operator that signals the string to its right side is an
2559 identifier (a column name) and not a value. For example to compare two
2560 columns you would write:
2563 priority => { '<', 2 },
2564 requestor => { -ident => 'submitter' },
2569 $stmt = "WHERE priority < ? AND requestor = submitter";
2572 If you are maintaining legacy code you may see a different construct as
2573 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2578 This is a virtual operator that signals that the construct to its right side
2579 is a value to be passed to DBI. This is for example necessary when you want
2580 to write a where clause against an array (for RDBMS that support such
2581 datatypes). For example:
2584 array => { -value => [1, 2, 3] }
2589 $stmt = 'WHERE array = ?';
2590 @bind = ([1, 2, 3]);
2592 Note that if you were to simply say:
2598 the result would probably not be what you wanted:
2600 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2605 Finally, sometimes only literal SQL will do. To include a random snippet
2606 of SQL verbatim, you specify it as a scalar reference. Consider this only
2607 as a last resort. Usually there is a better way. For example:
2610 priority => { '<', 2 },
2611 requestor => { -in => \'(SELECT name FROM hitmen)' },
2616 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2619 Note that in this example, you only get one bind parameter back, since
2620 the verbatim SQL is passed as part of the statement.
2624 Never use untrusted input as a literal SQL argument - this is a massive
2625 security risk (there is no way to check literal snippets for SQL
2626 injections and other nastyness). If you need to deal with untrusted input
2627 use literal SQL with placeholders as described next.
2629 =head3 Literal SQL with placeholders and bind values (subqueries)
2631 If the literal SQL to be inserted has placeholders and bind values,
2632 use a reference to an arrayref (yes this is a double reference --
2633 not so common, but perfectly legal Perl). For example, to find a date
2634 in Postgres you can use something like this:
2637 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2642 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2645 Note that you must pass the bind values in the same format as they are returned
2646 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2647 to C<columns>, you must provide the bind values in the
2648 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2649 scalar value; most commonly the column name, but you can use any scalar value
2650 (including references and blessed references), L<SQL::Abstract> will simply
2651 pass it through intact. So if C<bindtype> is set to C<columns> the above
2652 example will look like:
2655 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2658 Literal SQL is especially useful for nesting parenthesized clauses in the
2659 main SQL query. Here is a first example:
2661 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2665 bar => \["IN ($sub_stmt)" => @sub_bind],
2670 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2671 WHERE c2 < ? AND c3 LIKE ?))";
2672 @bind = (1234, 100, "foo%");
2674 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2675 are expressed in the same way. Of course the C<$sub_stmt> and
2676 its associated bind values can be generated through a former call
2679 my ($sub_stmt, @sub_bind)
2680 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2681 c3 => {-like => "foo%"}});
2684 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2687 In the examples above, the subquery was used as an operator on a column;
2688 but the same principle also applies for a clause within the main C<%where>
2689 hash, like an EXISTS subquery:
2691 my ($sub_stmt, @sub_bind)
2692 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2693 my %where = ( -and => [
2695 \["EXISTS ($sub_stmt)" => @sub_bind],
2700 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2701 WHERE c1 = ? AND c2 > t0.c0))";
2705 Observe that the condition on C<c2> in the subquery refers to
2706 column C<t0.c0> of the main query: this is I<not> a bind
2707 value, so we have to express it through a scalar ref.
2708 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2709 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2710 what we wanted here.
2712 Finally, here is an example where a subquery is used
2713 for expressing unary negation:
2715 my ($sub_stmt, @sub_bind)
2716 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2717 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2719 lname => {like => '%son%'},
2720 \["NOT ($sub_stmt)" => @sub_bind],
2725 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2726 @bind = ('%son%', 10, 20)
2728 =head3 Deprecated usage of Literal SQL
2730 Below are some examples of archaic use of literal SQL. It is shown only as
2731 reference for those who deal with legacy code. Each example has a much
2732 better, cleaner and safer alternative that users should opt for in new code.
2738 my %where = ( requestor => \'IS NOT NULL' )
2740 $stmt = "WHERE requestor IS NOT NULL"
2742 This used to be the way of generating NULL comparisons, before the handling
2743 of C<undef> got formalized. For new code please use the superior syntax as
2744 described in L</Tests for NULL values>.
2748 my %where = ( requestor => \'= submitter' )
2750 $stmt = "WHERE requestor = submitter"
2752 This used to be the only way to compare columns. Use the superior L</-ident>
2753 method for all new code. For example an identifier declared in such a way
2754 will be properly quoted if L</quote_char> is properly set, while the legacy
2755 form will remain as supplied.
2759 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2761 $stmt = "WHERE completed > ? AND is_ready"
2762 @bind = ('2012-12-21')
2764 Using an empty string literal used to be the only way to express a boolean.
2765 For all new code please use the much more readable
2766 L<-bool|/Unary operators: bool> operator.
2772 These pages could go on for a while, since the nesting of the data
2773 structures this module can handle are pretty much unlimited (the
2774 module implements the C<WHERE> expansion as a recursive function
2775 internally). Your best bet is to "play around" with the module a
2776 little to see how the data structures behave, and choose the best
2777 format for your data based on that.
2779 And of course, all the values above will probably be replaced with
2780 variables gotten from forms or the command line. After all, if you
2781 knew everything ahead of time, you wouldn't have to worry about
2782 dynamically-generating SQL and could just hardwire it into your
2785 =head1 ORDER BY CLAUSES
2787 Some functions take an order by clause. This can either be a scalar (just a
2788 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2789 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2792 Given | Will Generate
2793 ---------------------------------------------------------------
2795 'colA' | ORDER BY colA
2797 [qw/colA colB/] | ORDER BY colA, colB
2799 {-asc => 'colA'} | ORDER BY colA ASC
2801 {-desc => 'colB'} | ORDER BY colB DESC
2803 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2805 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2807 \'colA DESC' | ORDER BY colA DESC
2809 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2810 | /* ...with $x bound to ? */
2813 { -asc => 'colA' }, | colA ASC,
2814 { -desc => [qw/colB/] }, | colB DESC,
2815 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2816 \'colE DESC', | colE DESC,
2817 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2818 ] | /* ...with $x bound to ? */
2819 ===============================================================
2823 =head1 SPECIAL OPERATORS
2825 my $sqlmaker = SQL::Abstract->new(special_ops => [
2829 my ($self, $field, $op, $arg) = @_;
2835 handler => 'method_name',
2839 A "special operator" is a SQL syntactic clause that can be
2840 applied to a field, instead of a usual binary operator.
2843 WHERE field IN (?, ?, ?)
2844 WHERE field BETWEEN ? AND ?
2845 WHERE MATCH(field) AGAINST (?, ?)
2847 Special operators IN and BETWEEN are fairly standard and therefore
2848 are builtin within C<SQL::Abstract> (as the overridable methods
2849 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2850 like the MATCH .. AGAINST example above which is specific to MySQL,
2851 you can write your own operator handlers - supply a C<special_ops>
2852 argument to the C<new> method. That argument takes an arrayref of
2853 operator definitions; each operator definition is a hashref with two
2860 the regular expression to match the operator
2864 Either a coderef or a plain scalar method name. In both cases
2865 the expected return is C<< ($sql, @bind) >>.
2867 When supplied with a method name, it is simply called on the
2868 L<SQL::Abstract> object as:
2870 $self->$method_name($field, $op, $arg)
2874 $field is the LHS of the operator
2875 $op is the part that matched the handler regex
2878 When supplied with a coderef, it is called as:
2880 $coderef->($self, $field, $op, $arg)
2885 For example, here is an implementation
2886 of the MATCH .. AGAINST syntax for MySQL
2888 my $sqlmaker = SQL::Abstract->new(special_ops => [
2890 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2891 {regex => qr/^match$/i,
2893 my ($self, $field, $op, $arg) = @_;
2894 $arg = [$arg] if not ref $arg;
2895 my $label = $self->_quote($field);
2896 my ($placeholder) = $self->_convert('?');
2897 my $placeholders = join ", ", (($placeholder) x @$arg);
2898 my $sql = $self->_sqlcase('match') . " ($label) "
2899 . $self->_sqlcase('against') . " ($placeholders) ";
2900 my @bind = $self->_bindtype($field, @$arg);
2901 return ($sql, @bind);
2908 =head1 UNARY OPERATORS
2910 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2914 my ($self, $op, $arg) = @_;
2920 handler => 'method_name',
2924 A "unary operator" is a SQL syntactic clause that can be
2925 applied to a field - the operator goes before the field
2927 You can write your own operator handlers - supply a C<unary_ops>
2928 argument to the C<new> method. That argument takes an arrayref of
2929 operator definitions; each operator definition is a hashref with two
2936 the regular expression to match the operator
2940 Either a coderef or a plain scalar method name. In both cases
2941 the expected return is C<< $sql >>.
2943 When supplied with a method name, it is simply called on the
2944 L<SQL::Abstract> object as:
2946 $self->$method_name($op, $arg)
2950 $op is the part that matched the handler regex
2951 $arg is the RHS or argument of the operator
2953 When supplied with a coderef, it is called as:
2955 $coderef->($self, $op, $arg)
2963 Thanks to some benchmarking by Mark Stosberg, it turns out that
2964 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2965 I must admit this wasn't an intentional design issue, but it's a
2966 byproduct of the fact that you get to control your C<DBI> handles
2969 To maximize performance, use a code snippet like the following:
2971 # prepare a statement handle using the first row
2972 # and then reuse it for the rest of the rows
2974 for my $href (@array_of_hashrefs) {
2975 $stmt ||= $sql->insert('table', $href);
2976 $sth ||= $dbh->prepare($stmt);
2977 $sth->execute($sql->values($href));
2980 The reason this works is because the keys in your C<$href> are sorted
2981 internally by B<SQL::Abstract>. Thus, as long as your data retains
2982 the same structure, you only have to generate the SQL the first time
2983 around. On subsequent queries, simply use the C<values> function provided
2984 by this module to return your values in the correct order.
2986 However this depends on the values having the same type - if, for
2987 example, the values of a where clause may either have values
2988 (resulting in sql of the form C<column = ?> with a single bind
2989 value), or alternatively the values might be C<undef> (resulting in
2990 sql of the form C<column IS NULL> with no bind value) then the
2991 caching technique suggested will not work.
2995 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2996 really like this part (I do, at least). Building up a complex query
2997 can be as simple as the following:
3004 use CGI::FormBuilder;
3007 my $form = CGI::FormBuilder->new(...);
3008 my $sql = SQL::Abstract->new;
3010 if ($form->submitted) {
3011 my $field = $form->field;
3012 my $id = delete $field->{id};
3013 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3016 Of course, you would still have to connect using C<DBI> to run the
3017 query, but the point is that if you make your form look like your
3018 table, the actual query script can be extremely simplistic.
3020 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3021 a fast interface to returning and formatting data. I frequently
3022 use these three modules together to write complex database query
3023 apps in under 50 lines.
3025 =head1 HOW TO CONTRIBUTE
3027 Contributions are always welcome, in all usable forms (we especially
3028 welcome documentation improvements). The delivery methods include git-
3029 or unified-diff formatted patches, GitHub pull requests, or plain bug
3030 reports either via RT or the Mailing list. Contributors are generally
3031 granted full access to the official repository after their first several
3032 patches pass successful review.
3034 This project is maintained in a git repository. The code and related tools are
3035 accessible at the following locations:
3039 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3041 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3043 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3045 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3051 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3052 Great care has been taken to preserve the I<published> behavior
3053 documented in previous versions in the 1.* family; however,
3054 some features that were previously undocumented, or behaved
3055 differently from the documentation, had to be changed in order
3056 to clarify the semantics. Hence, client code that was relying
3057 on some dark areas of C<SQL::Abstract> v1.*
3058 B<might behave differently> in v1.50.
3060 The main changes are:
3066 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3070 support for the { operator => \"..." } construct (to embed literal SQL)
3074 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3078 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3082 defensive programming: check arguments
3086 fixed bug with global logic, which was previously implemented
3087 through global variables yielding side-effects. Prior versions would
3088 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3089 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3090 Now this is interpreted
3091 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3096 fixed semantics of _bindtype on array args
3100 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3101 we just avoid shifting arrays within that tree.
3105 dropped the C<_modlogic> function
3109 =head1 ACKNOWLEDGEMENTS
3111 There are a number of individuals that have really helped out with
3112 this module. Unfortunately, most of them submitted bugs via CPAN
3113 so I have no idea who they are! But the people I do know are:
3115 Ash Berlin (order_by hash term support)
3116 Matt Trout (DBIx::Class support)
3117 Mark Stosberg (benchmarking)
3118 Chas Owens (initial "IN" operator support)
3119 Philip Collins (per-field SQL functions)
3120 Eric Kolve (hashref "AND" support)
3121 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3122 Dan Kubb (support for "quote_char" and "name_sep")
3123 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3124 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3125 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3126 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3127 Oliver Charles (support for "RETURNING" after "INSERT")
3133 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3137 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3139 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3141 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3142 While not an official support venue, C<DBIx::Class> makes heavy use of
3143 C<SQL::Abstract>, and as such list members there are very familiar with
3144 how to create queries.
3148 This module is free software; you may copy this under the same
3149 terms as perl itself (either the GNU General Public License or
3150 the Artistic License)