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 -not => '_expand_not',
191 -bool => '_expand_bool',
192 -and => '_expand_op_andor',
193 -or => '_expand_op_andor',
194 -nest => '_expand_nest',
198 'between' => '_expand_between',
199 'not between' => '_expand_between',
200 'in' => '_expand_in',
201 'not in' => '_expand_in',
202 'nest' => '_expand_nest',
203 (map +($_ => '_expand_op_andor'), ('and', 'or')),
204 (map +($_ => '_expand_op_is'), ('is', 'is not')),
207 # placeholder for _expand_unop system
209 my %unops = (-ident => '_expand_ident', -value => '_expand_value');
210 foreach my $name (keys %unops) {
211 $opt{expand}{$name} = $unops{$name};
212 my ($op) = $name =~ /^-(.*)$/;
213 $opt{expand_op}{$op} = sub {
214 my ($self, $op, $arg, $k) = @_;
217 $self->_expand_ident(-ident => $k),
218 $self->_expand_expr({ '-'.$op => $arg }),
225 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
230 (map +($_ => '_render_op_between'), 'between', 'not between'),
231 (map +($_ => '_render_op_in'), 'in', 'not in'),
232 (map +($_ => '_render_unop_postfix'),
233 'is null', 'is not null', 'asc', 'desc',
235 (not => '_render_op_not'),
236 (map +($_ => '_render_op_andor'), qw(and or)),
239 return bless \%opt, $class;
242 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
243 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
245 sub _assert_pass_injection_guard {
246 if ($_[1] =~ $_[0]->{injection_guard}) {
247 my $class = ref $_[0];
248 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
249 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
250 . "{injection_guard} attribute to ${class}->new()"
255 #======================================================================
257 #======================================================================
261 my $table = $self->_table(shift);
262 my $data = shift || return;
265 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
266 my ($sql, @bind) = $self->$method($data);
267 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
269 if ($options->{returning}) {
270 my ($s, @b) = $self->_insert_returning($options);
275 return wantarray ? ($sql, @bind) : $sql;
278 # So that subclasses can override INSERT ... RETURNING separately from
279 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
280 sub _insert_returning { shift->_returning(@_) }
283 my ($self, $options) = @_;
285 my $f = $options->{returning};
287 my ($sql, @bind) = $self->render_aqt(
288 $self->_expand_maybe_list_expr($f, undef, -ident)
291 ? $self->_sqlcase(' returning ') . $sql
292 : ($self->_sqlcase(' returning ').$sql, @bind);
295 sub _insert_HASHREF { # explicit list of fields and then values
296 my ($self, $data) = @_;
298 my @fields = sort keys %$data;
300 my ($sql, @bind) = $self->_insert_values($data);
303 $_ = $self->_quote($_) foreach @fields;
304 $sql = "( ".join(", ", @fields).") ".$sql;
306 return ($sql, @bind);
309 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
310 my ($self, $data) = @_;
312 # no names (arrayref) so can't generate bindtype
313 $self->{bindtype} ne 'columns'
314 or belch "can't do 'columns' bindtype when called with arrayref";
316 my (@values, @all_bind);
317 foreach my $value (@$data) {
318 my ($values, @bind) = $self->_insert_value(undef, $value);
319 push @values, $values;
320 push @all_bind, @bind;
322 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
323 return ($sql, @all_bind);
326 sub _insert_ARRAYREFREF { # literal SQL with bind
327 my ($self, $data) = @_;
329 my ($sql, @bind) = @${$data};
330 $self->_assert_bindval_matches_bindtype(@bind);
332 return ($sql, @bind);
336 sub _insert_SCALARREF { # literal SQL without bind
337 my ($self, $data) = @_;
343 my ($self, $data) = @_;
345 my (@values, @all_bind);
346 foreach my $column (sort keys %$data) {
347 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
348 push @values, $values;
349 push @all_bind, @bind;
351 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
352 return ($sql, @all_bind);
356 my ($self, $column, $v) = @_;
358 return $self->render_aqt(
359 $self->_expand_insert_value($column, $v)
363 sub _expand_insert_value {
364 my ($self, $column, $v) = @_;
366 if (ref($v) eq 'ARRAY') {
367 if ($self->{array_datatypes}) {
368 return +{ -bind => [ $column, $v ] };
370 my ($sql, @bind) = @$v;
371 $self->_assert_bindval_matches_bindtype(@bind);
372 return +{ -literal => $v };
374 if (ref($v) eq 'HASH') {
375 if (grep !/^-/, keys %$v) {
376 belch "HASH ref as bind value in insert is not supported";
377 return +{ -bind => [ $column, $v ] };
381 return +{ -bind => [ $column, undef ] };
383 local our $Cur_Col_Meta = $column;
384 return $self->expand_expr($v);
389 #======================================================================
391 #======================================================================
396 my $table = $self->_table(shift);
397 my $data = shift || return;
401 # first build the 'SET' part of the sql statement
402 puke "Unsupported data type specified to \$sql->update"
403 unless ref $data eq 'HASH';
405 my ($sql, @all_bind) = $self->_update_set_values($data);
406 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
410 my($where_sql, @where_bind) = $self->where($where);
412 push @all_bind, @where_bind;
415 if ($options->{returning}) {
416 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
417 $sql .= $returning_sql;
418 push @all_bind, @returning_bind;
421 return wantarray ? ($sql, @all_bind) : $sql;
424 sub _update_set_values {
425 my ($self, $data) = @_;
427 return $self->render_aqt(
428 $self->_expand_update_set_values($data),
432 sub _expand_update_set_values {
433 my ($self, $data) = @_;
434 $self->_expand_maybe_list_expr( [
437 $set = { -bind => $_ } unless defined $set;
438 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
444 ? ($self->{array_datatypes}
445 ? [ $k, +{ -bind => [ $k, $v ] } ]
446 : [ $k, +{ -literal => $v } ])
448 local our $Cur_Col_Meta = $k;
449 [ $k, $self->_expand_expr($v) ]
456 # So that subclasses can override UPDATE ... RETURNING separately from
458 sub _update_returning { shift->_returning(@_) }
462 #======================================================================
464 #======================================================================
469 my $table = $self->_table(shift);
470 my $fields = shift || '*';
474 my ($fields_sql, @bind) = $self->_select_fields($fields);
476 my ($where_sql, @where_bind) = $self->where($where, $order);
477 push @bind, @where_bind;
479 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
480 $self->_sqlcase('from'), $table)
483 return wantarray ? ($sql, @bind) : $sql;
487 my ($self, $fields) = @_;
488 return $fields unless ref($fields);
489 return $self->render_aqt(
490 $self->_expand_maybe_list_expr($fields, undef, '-ident')
494 #======================================================================
496 #======================================================================
501 my $table = $self->_table(shift);
505 my($where_sql, @bind) = $self->where($where);
506 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
508 if ($options->{returning}) {
509 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
510 $sql .= $returning_sql;
511 push @bind, @returning_bind;
514 return wantarray ? ($sql, @bind) : $sql;
517 # So that subclasses can override DELETE ... RETURNING separately from
519 sub _delete_returning { shift->_returning(@_) }
523 #======================================================================
525 #======================================================================
529 # Finally, a separate routine just to handle WHERE clauses
531 my ($self, $where, $order) = @_;
533 local $self->{convert_where} = $self->{convert};
536 my ($sql, @bind) = defined($where)
537 ? $self->_recurse_where($where)
539 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
543 my ($order_sql, @order_bind) = $self->_order_by($order);
545 push @bind, @order_bind;
548 return wantarray ? ($sql, @bind) : $sql;
552 my ($self, $expr, $default_scalar_to) = @_;
553 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
554 $self->_expand_expr($expr);
558 my ($self, $aqt) = @_;
559 my ($k, $v, @rest) = %$aqt;
561 if (my $meth = $self->{render}{$k}) {
562 return $self->$meth($v);
564 die "notreached: $k";
568 my ($self, $expr) = @_;
569 $self->render_aqt($self->expand_expr($expr));
573 my ($self, $expr) = @_;
574 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
575 return undef unless defined($expr);
576 if (ref($expr) eq 'HASH') {
577 return undef unless my $kc = keys %$expr;
579 return $self->_expand_op_andor(-and => $expr);
581 my ($key, $value) = %$expr;
582 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
583 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
584 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
586 if (my $exp = $self->{expand}{$key}) {
587 return $self->$exp($key, $value);
589 return $self->_expand_expr_hashpair($key, $value);
591 if (ref($expr) eq 'ARRAY') {
592 my $logic = '-'.lc($self->{logic});
593 return $self->_expand_op_andor($logic, $expr);
595 if (my $literal = is_literal_value($expr)) {
596 return +{ -literal => $literal };
598 if (!ref($expr) or Scalar::Util::blessed($expr)) {
599 if (my $d = our $Default_Scalar_To) {
600 return $self->_expand_expr({ $d => $expr });
602 return $self->_expand_value(-value => $expr);
607 sub _expand_expr_hashpair {
608 my ($self, $k, $v) = @_;
609 unless (defined($k) and length($k)) {
610 if (defined($k) and my $literal = is_literal_value($v)) {
611 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
612 return { -literal => $literal };
614 puke "Supplying an empty left hand side argument is not supported";
617 return $self->_expand_expr_hashpair_op($k, $v);
619 return $self->_expand_expr_hashpair_ident($k, $v);
622 sub _expand_expr_hashpair_ident {
623 my ($self, $k, $v) = @_;
625 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
631 and exists $v->{-value}
632 and not defined $v->{-value}
635 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
638 my $ik = $self->_expand_ident(-ident => $k);
640 # scalars and objects get expanded as whatever requested or values
642 if (!ref($v) or Scalar::Util::blessed($v)) {
643 my $d = our $Default_Scalar_To;
644 local our $Cur_Col_Meta = $k;
645 return $self->_expand_expr_hashpair_ident(
648 ? $self->_expand_expr($d => $v)
653 if (ref($v) eq 'HASH') {
655 return $self->_expand_op_andor(-and => $v, $k);
657 return undef unless keys %$v;
659 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
660 $self->_assert_pass_injection_guard($op);
661 if ($op =~ s/ [_\s]? \d+ $//x ) {
662 return $self->_expand_expr($k, $v);
664 if (my $x = $self->{expand_op}{$op}) {
665 local our $Cur_Col_Meta = $k;
666 return $self->$x($op, $vv, $k);
668 if ($op =~ /^is(?: not)?$/) {
669 puke "$op can only take undef as argument"
673 and exists($vv->{-value})
674 and !defined($vv->{-value})
676 return +{ -op => [ $op.' null', $ik ] };
678 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
679 return { -op => [ $op, $ik, $vv ] };
681 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
685 { -op => [ $op, $vv ] }
688 if (ref($vv) eq 'ARRAY') {
690 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
691 ? shift @raw : '-or';
692 my @values = map +{ $vk => $_ }, @raw;
694 $op =~ $self->{inequality_op}
695 or $op =~ $self->{not_like_op}
697 if (lc($logic) eq '-or' and @values > 1) {
698 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
699 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
700 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
705 # try to DWIM on equality operators
707 $op =~ $self->{equality_op} ? $self->sqlfalse
708 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
709 : $op =~ $self->{inequality_op} ? $self->sqltrue
710 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
711 : puke "operator '$op' applied on an empty array (field '$k')";
713 return $self->_expand_op_andor($logic => \@values, $k);
719 and exists $vv->{-value}
720 and not defined $vv->{-value}
724 $op =~ /^not$/i ? 'is not' # legacy
725 : $op =~ $self->{equality_op} ? 'is'
726 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
727 : $op =~ $self->{inequality_op} ? 'is not'
728 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
729 : puke "unexpected operator '$op' with undef operand";
730 return +{ -op => [ $is.' null', $ik ] };
732 local our $Cur_Col_Meta = $k;
736 $self->_expand_expr($vv)
739 if (ref($v) eq 'ARRAY') {
740 return $self->sqlfalse unless @$v;
741 $self->_debug("ARRAY($k) means distribute over elements");
743 $v->[0] =~ /^-(and|or)$/i
744 ? shift(@{$v = [ @$v ]})
745 : '-'.lc($self->{logic} || 'OR')
747 return $self->_expand_op_andor(
751 if (my $literal = is_literal_value($v)) {
753 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
756 my ($sql, @bind) = @$literal;
757 if ($self->{bindtype} eq 'columns') {
759 $self->_assert_bindval_matches_bindtype($_);
762 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
767 sub _expand_expr_hashpair_op {
768 my ($self, $k, $v) = @_;
771 $op =~ s/^-// if length($op) > 1;
772 $self->_assert_pass_injection_guard($op);
774 # Ops prefixed with -not_ get converted
776 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
779 $self->_expand_expr({ "-${rest}", $v })
783 # the old special op system requires illegality for top-level use
786 (our $Expand_Depth) == 1
787 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
789 puke "Illegal use of top-level '-$op'"
792 # the old unary op system means we should touch nothing and let it work
794 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
795 return { -op => [ $op, $v ] };
798 # an explicit node type is currently assumed to be expanded (this is almost
799 # certainly wrong and there should be expansion anyway)
801 if ($self->{render}{$k}) {
805 # hashref RHS values get expanded and used as op/func args
810 and (keys %$v)[0] =~ /^-/
812 my ($func) = $k =~ /^-(.*)$/;
813 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
814 return +{ -op => [ $func, $self->_expand_expr($v) ] };
816 return +{ -func => [ $func, $self->_expand_expr($v) ] };
819 # scalars and literals get simply expanded
821 if (!ref($v) or is_literal_value($v)) {
822 return +{ -op => [ $op, $self->_expand_expr($v) ] };
829 my ($self, $op, $body) = @_;
830 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
831 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
833 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
834 ref($body) ? @$body : $body;
835 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
836 unless ($self->{quote_char}) {
837 $self->_assert_pass_injection_guard($_) for @parts;
839 return +{ -ident => \@parts };
843 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
847 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
851 my ($self, undef, $v) = @_;
853 return $self->_expand_expr($v);
855 puke "-bool => undef not supported" unless defined($v);
856 return $self->_expand_ident(-ident => $v);
859 sub _expand_op_andor {
860 my ($self, $logic, $v, $k) = @_;
862 $v = [ map +{ $k, $_ },
864 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
868 my ($logop) = $logic =~ /^-?(.*)$/;
869 if (ref($v) eq 'HASH') {
872 map $self->_expand_expr({ $_ => $v->{$_} }),
876 if (ref($v) eq 'ARRAY') {
877 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
880 (ref($_) eq 'ARRAY' and @$_)
881 or (ref($_) eq 'HASH' and %$_)
887 while (my ($el) = splice @expr, 0, 1) {
888 puke "Supplying an empty left hand side argument is not supported in array-pairs"
889 unless defined($el) and length($el);
890 my $elref = ref($el);
892 local our $Expand_Depth = 0;
893 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
894 } elsif ($elref eq 'ARRAY') {
895 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
896 } elsif (my $l = is_literal_value($el)) {
897 push @res, { -literal => $l };
898 } elsif ($elref eq 'HASH') {
899 local our $Expand_Depth = 0;
900 push @res, grep defined, $self->_expand_expr($el) if %$el;
906 # return $res[0] if @res == 1;
907 return { -op => [ $logop, @res ] };
913 my ($self, $op, $vv, $k) = @_;
914 puke "$op can only take undef as argument"
918 and exists($vv->{-value})
919 and !defined($vv->{-value})
921 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
924 sub _expand_between {
925 my ($self, $op, $vv, $k) = @_;
926 local our $Cur_Col_Meta = $k;
927 my @rhs = map $self->_expand_expr($_),
928 ref($vv) eq 'ARRAY' ? @$vv : $vv;
930 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
932 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
934 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
938 $self->_expand_ident(-ident => $k),
944 my ($self, $op, $vv, $k) = @_;
945 if (my $literal = is_literal_value($vv)) {
946 my ($sql, @bind) = @$literal;
947 my $opened_sql = $self->_open_outer_paren($sql);
949 $op, $self->_expand_ident(-ident => $k),
950 [ { -literal => [ $opened_sql, @bind ] } ]
954 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
955 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
956 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
957 . 'will emit the logically correct SQL instead of raising this exception)'
959 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
961 my @rhs = map $self->_expand_expr($_),
962 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
963 map { defined($_) ? $_: puke($undef_err) }
964 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
965 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
969 $self->_expand_ident(-ident => $k),
975 my ($self, $op, $v) = @_;
976 # DBIx::Class requires a nest warning to be emitted once but the private
977 # method it overrode to do so no longer exists
978 if ($self->{is_dbic_sqlmaker}) {
979 unless (our $Nest_Warned) {
981 "-nest in search conditions is deprecated, you most probably wanted:\n"
982 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
987 return $self->_expand_expr($v);
991 my ($self, $where, $logic) = @_;
993 # Special case: top level simple string treated as literal
995 my $where_exp = (ref($where)
996 ? $self->_expand_expr($where, $logic)
997 : { -literal => [ $where ] });
999 # dispatch expanded expression
1001 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1002 # DBIx::Class used to call _recurse_where in scalar context
1003 # something else might too...
1005 return ($sql, @bind);
1008 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1014 my ($self, $ident) = @_;
1016 return $self->_convert($self->_quote($ident));
1020 my ($self, $list) = @_;
1021 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1022 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1026 my ($self, $rest) = @_;
1027 my ($func, @args) = @$rest;
1031 push @arg_sql, shift @x;
1033 } map [ $self->render_aqt($_) ], @args;
1034 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1038 my ($self, $bind) = @_;
1039 return ($self->_convert('?'), $self->_bindtype(@$bind));
1042 sub _render_literal {
1043 my ($self, $literal) = @_;
1044 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1048 sub _render_op_between {
1049 my ($self, $op, $args) = @_;
1050 my ($left, $low, $high) = @$args;
1051 my ($rhsql, @rhbind) = do {
1053 puke "Single arg to between must be a literal"
1054 unless $low->{-literal};
1057 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1058 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1059 @{$l}[1..$#$l], @{$h}[1..$#$h])
1062 my ($lhsql, @lhbind) = $self->render_aqt($left);
1064 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1070 my ($self, $op, $args) = @_;
1071 my ($lhs, $rhs) = @$args;
1074 my ($sql, @bind) = $self->render_aqt($_);
1075 push @in_bind, @bind;
1078 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1080 $lhsql.' '.$self->_sqlcase($op).' ( '
1081 .join(', ', @in_sql)
1087 sub _render_op_andor {
1088 my ($self, $op, $args) = @_;
1089 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1090 return '' unless @parts;
1091 return @{$parts[0]} if @parts == 1;
1092 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1093 return '( '.$sql.' )', @bind;
1096 sub _render_op_multop {
1097 my ($self, $op, $args) = @_;
1098 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1099 return '' unless @parts;
1100 return @{$parts[0]} if @parts == 1;
1101 my ($final_sql) = join(
1102 ' '.$self->_sqlcase($op).' ',
1107 map @{$_}[1..$#$_], @parts
1112 my ($self, $v) = @_;
1113 my ($op, @args) = @$v;
1114 if (my $r = $self->{render_op}{$op}) {
1115 return $self->$r($op, \@args);
1117 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1118 if ($us and @args > 1) {
1119 puke "Special op '${op}' requires first value to be identifier"
1120 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1121 my $k = join(($self->{name_sep}||'.'), @$ident);
1122 local our $Expand_Depth = 1;
1123 return $self->${\($us->{handler})}($k, $op, $args[1]);
1125 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1126 return $self->${\($us->{handler})}($op, $args[0]);
1129 return $self->_render_unop_prefix($op, \@args);
1131 return $self->_render_op_multop($op, \@args);
1136 sub _render_op_not {
1137 my ($self, $op, $v) = @_;
1138 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1139 return "(${sql})", @bind;
1142 sub _render_unop_prefix {
1143 my ($self, $op, $v) = @_;
1144 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1145 my $op_sql = $self->_sqlcase($op);
1146 return ("${op_sql} ${expr_sql}", @bind);
1149 sub _render_unop_postfix {
1150 my ($self, $op, $v) = @_;
1151 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1152 my $op_sql = $self->_sqlcase($op);
1153 return ($expr_sql.' '.$op_sql, @bind);
1156 # Some databases (SQLite) treat col IN (1, 2) different from
1157 # col IN ( (1, 2) ). Use this to strip all outer parens while
1158 # adding them back in the corresponding method
1159 sub _open_outer_paren {
1160 my ($self, $sql) = @_;
1162 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1164 # there are closing parens inside, need the heavy duty machinery
1165 # to reevaluate the extraction starting from $sql (full reevaluation)
1166 if ($inner =~ /\)/) {
1167 require Text::Balanced;
1169 my (undef, $remainder) = do {
1170 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1172 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1175 # the entire expression needs to be a balanced bracketed thing
1176 # (after an extract no remainder sans trailing space)
1177 last if defined $remainder and $remainder =~ /\S/;
1187 #======================================================================
1189 #======================================================================
1191 sub _expand_order_by {
1192 my ($self, $arg) = @_;
1194 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1196 my $expander = sub {
1197 my ($self, $dir, $expr) = @_;
1198 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1199 foreach my $arg (@to_expand) {
1203 and grep /^-(asc|desc)$/, keys %$arg
1205 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1209 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1211 map $self->expand_expr($_, -ident),
1212 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1213 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1216 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1218 return $self->$expander(undef, $arg);
1222 my ($self, $arg) = @_;
1224 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1226 my ($sql, @bind) = $self->render_aqt($expanded);
1228 return '' unless length($sql);
1230 my $final_sql = $self->_sqlcase(' order by ').$sql;
1232 return wantarray ? ($final_sql, @bind) : $final_sql;
1235 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1237 sub _order_by_chunks {
1238 my ($self, $arg) = @_;
1240 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1242 return $self->_chunkify_order_by($expanded);
1245 sub _chunkify_order_by {
1246 my ($self, $expanded) = @_;
1248 return grep length, $self->render_aqt($expanded)
1249 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1252 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1253 return map $self->_chunkify_order_by($_), @$l;
1255 return [ $self->render_aqt($_) ];
1259 #======================================================================
1260 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1261 #======================================================================
1267 $self->_expand_maybe_list_expr($from, undef, -ident)
1272 #======================================================================
1274 #======================================================================
1276 sub _expand_maybe_list_expr {
1277 my ($self, $expr, $logic, $default) = @_;
1279 if (ref($expr) eq 'ARRAY') {
1281 map $self->expand_expr($_, $default), @$expr
1288 return $self->expand_expr($e, $default);
1291 # highly optimized, as it's called way too often
1293 # my ($self, $label) = @_;
1295 return '' unless defined $_[1];
1296 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1297 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1299 unless ($_[0]->{quote_char}) {
1300 if (ref($_[1]) eq 'ARRAY') {
1301 return join($_[0]->{name_sep}||'.', @{$_[1]});
1303 $_[0]->_assert_pass_injection_guard($_[1]);
1308 my $qref = ref $_[0]->{quote_char};
1310 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1311 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1312 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1314 my $esc = $_[0]->{escape_char} || $r;
1316 # parts containing * are naturally unquoted
1318 $_[0]->{name_sep}||'',
1322 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1324 (ref($_[1]) eq 'ARRAY'
1328 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1336 # Conversion, if applicable
1338 #my ($self, $arg) = @_;
1339 if ($_[0]->{convert_where}) {
1340 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1347 #my ($self, $col, @vals) = @_;
1348 # called often - tighten code
1349 return $_[0]->{bindtype} eq 'columns'
1350 ? map {[$_[1], $_]} @_[2 .. $#_]
1355 # Dies if any element of @bind is not in [colname => value] format
1356 # if bindtype is 'columns'.
1357 sub _assert_bindval_matches_bindtype {
1358 # my ($self, @bind) = @_;
1360 if ($self->{bindtype} eq 'columns') {
1362 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1363 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1369 sub _join_sql_clauses {
1370 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1372 if (@$clauses_aref > 1) {
1373 my $join = " " . $self->_sqlcase($logic) . " ";
1374 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1375 return ($sql, @$bind_aref);
1377 elsif (@$clauses_aref) {
1378 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1381 return (); # if no SQL, ignore @$bind_aref
1386 # Fix SQL case, if so requested
1388 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1389 # don't touch the argument ... crooked logic, but let's not change it!
1390 return $_[0]->{case} ? $_[1] : uc($_[1]);
1394 #======================================================================
1395 # DISPATCHING FROM REFKIND
1396 #======================================================================
1399 my ($self, $data) = @_;
1401 return 'UNDEF' unless defined $data;
1403 # blessed objects are treated like scalars
1404 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1406 return 'SCALAR' unless $ref;
1409 while ($ref eq 'REF') {
1411 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1415 return ($ref||'SCALAR') . ('REF' x $n_steps);
1419 my ($self, $data) = @_;
1420 my @try = ($self->_refkind($data));
1421 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1422 push @try, 'FALLBACK';
1426 sub _METHOD_FOR_refkind {
1427 my ($self, $meth_prefix, $data) = @_;
1430 for (@{$self->_try_refkind($data)}) {
1431 $method = $self->can($meth_prefix."_".$_)
1435 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1439 sub _SWITCH_refkind {
1440 my ($self, $data, $dispatch_table) = @_;
1443 for (@{$self->_try_refkind($data)}) {
1444 $coderef = $dispatch_table->{$_}
1448 puke "no dispatch entry for ".$self->_refkind($data)
1457 #======================================================================
1458 # VALUES, GENERATE, AUTOLOAD
1459 #======================================================================
1461 # LDNOTE: original code from nwiger, didn't touch code in that section
1462 # I feel the AUTOLOAD stuff should not be the default, it should
1463 # only be activated on explicit demand by user.
1467 my $data = shift || return;
1468 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1469 unless ref $data eq 'HASH';
1472 foreach my $k (sort keys %$data) {
1473 my $v = $data->{$k};
1474 $self->_SWITCH_refkind($v, {
1476 if ($self->{array_datatypes}) { # array datatype
1477 push @all_bind, $self->_bindtype($k, $v);
1479 else { # literal SQL with bind
1480 my ($sql, @bind) = @$v;
1481 $self->_assert_bindval_matches_bindtype(@bind);
1482 push @all_bind, @bind;
1485 ARRAYREFREF => sub { # literal SQL with bind
1486 my ($sql, @bind) = @${$v};
1487 $self->_assert_bindval_matches_bindtype(@bind);
1488 push @all_bind, @bind;
1490 SCALARREF => sub { # literal SQL without bind
1492 SCALAR_or_UNDEF => sub {
1493 push @all_bind, $self->_bindtype($k, $v);
1504 my(@sql, @sqlq, @sqlv);
1508 if ($ref eq 'HASH') {
1509 for my $k (sort keys %$_) {
1512 my $label = $self->_quote($k);
1513 if ($r eq 'ARRAY') {
1514 # literal SQL with bind
1515 my ($sql, @bind) = @$v;
1516 $self->_assert_bindval_matches_bindtype(@bind);
1517 push @sqlq, "$label = $sql";
1519 } elsif ($r eq 'SCALAR') {
1520 # literal SQL without bind
1521 push @sqlq, "$label = $$v";
1523 push @sqlq, "$label = ?";
1524 push @sqlv, $self->_bindtype($k, $v);
1527 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1528 } elsif ($ref eq 'ARRAY') {
1529 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1532 if ($r eq 'ARRAY') { # literal SQL with bind
1533 my ($sql, @bind) = @$v;
1534 $self->_assert_bindval_matches_bindtype(@bind);
1537 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1538 # embedded literal SQL
1545 push @sql, '(' . join(', ', @sqlq) . ')';
1546 } elsif ($ref eq 'SCALAR') {
1550 # strings get case twiddled
1551 push @sql, $self->_sqlcase($_);
1555 my $sql = join ' ', @sql;
1557 # this is pretty tricky
1558 # if ask for an array, return ($stmt, @bind)
1559 # otherwise, s/?/shift @sqlv/ to put it inline
1561 return ($sql, @sqlv);
1563 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1564 ref $d ? $d->[1] : $d/e;
1573 # This allows us to check for a local, then _form, attr
1575 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1576 return $self->generate($name, @_);
1587 SQL::Abstract - Generate SQL from Perl data structures
1593 my $sql = SQL::Abstract->new;
1595 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1597 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1599 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1601 my($stmt, @bind) = $sql->delete($table, \%where);
1603 # Then, use these in your DBI statements
1604 my $sth = $dbh->prepare($stmt);
1605 $sth->execute(@bind);
1607 # Just generate the WHERE clause
1608 my($stmt, @bind) = $sql->where(\%where, $order);
1610 # Return values in the same order, for hashed queries
1611 # See PERFORMANCE section for more details
1612 my @bind = $sql->values(\%fieldvals);
1616 This module was inspired by the excellent L<DBIx::Abstract>.
1617 However, in using that module I found that what I really wanted
1618 to do was generate SQL, but still retain complete control over my
1619 statement handles and use the DBI interface. So, I set out to
1620 create an abstract SQL generation module.
1622 While based on the concepts used by L<DBIx::Abstract>, there are
1623 several important differences, especially when it comes to WHERE
1624 clauses. I have modified the concepts used to make the SQL easier
1625 to generate from Perl data structures and, IMO, more intuitive.
1626 The underlying idea is for this module to do what you mean, based
1627 on the data structures you provide it. The big advantage is that
1628 you don't have to modify your code every time your data changes,
1629 as this module figures it out.
1631 To begin with, an SQL INSERT is as easy as just specifying a hash
1632 of C<key=value> pairs:
1635 name => 'Jimbo Bobson',
1636 phone => '123-456-7890',
1637 address => '42 Sister Lane',
1638 city => 'St. Louis',
1639 state => 'Louisiana',
1642 The SQL can then be generated with this:
1644 my($stmt, @bind) = $sql->insert('people', \%data);
1646 Which would give you something like this:
1648 $stmt = "INSERT INTO people
1649 (address, city, name, phone, state)
1650 VALUES (?, ?, ?, ?, ?)";
1651 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1652 '123-456-7890', 'Louisiana');
1654 These are then used directly in your DBI code:
1656 my $sth = $dbh->prepare($stmt);
1657 $sth->execute(@bind);
1659 =head2 Inserting and Updating Arrays
1661 If your database has array types (like for example Postgres),
1662 activate the special option C<< array_datatypes => 1 >>
1663 when creating the C<SQL::Abstract> object.
1664 Then you may use an arrayref to insert and update database array types:
1666 my $sql = SQL::Abstract->new(array_datatypes => 1);
1668 planets => [qw/Mercury Venus Earth Mars/]
1671 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1675 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1677 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1680 =head2 Inserting and Updating SQL
1682 In order to apply SQL functions to elements of your C<%data> you may
1683 specify a reference to an arrayref for the given hash value. For example,
1684 if you need to execute the Oracle C<to_date> function on a value, you can
1685 say something like this:
1689 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1692 The first value in the array is the actual SQL. Any other values are
1693 optional and would be included in the bind values array. This gives
1696 my($stmt, @bind) = $sql->insert('people', \%data);
1698 $stmt = "INSERT INTO people (name, date_entered)
1699 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1700 @bind = ('Bill', '03/02/2003');
1702 An UPDATE is just as easy, all you change is the name of the function:
1704 my($stmt, @bind) = $sql->update('people', \%data);
1706 Notice that your C<%data> isn't touched; the module will generate
1707 the appropriately quirky SQL for you automatically. Usually you'll
1708 want to specify a WHERE clause for your UPDATE, though, which is
1709 where handling C<%where> hashes comes in handy...
1711 =head2 Complex where statements
1713 This module can generate pretty complicated WHERE statements
1714 easily. For example, simple C<key=value> pairs are taken to mean
1715 equality, and if you want to see if a field is within a set
1716 of values, you can use an arrayref. Let's say we wanted to
1717 SELECT some data based on this criteria:
1720 requestor => 'inna',
1721 worker => ['nwiger', 'rcwe', 'sfz'],
1722 status => { '!=', 'completed' }
1725 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1727 The above would give you something like this:
1729 $stmt = "SELECT * FROM tickets WHERE
1730 ( requestor = ? ) AND ( status != ? )
1731 AND ( worker = ? OR worker = ? OR worker = ? )";
1732 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1734 Which you could then use in DBI code like so:
1736 my $sth = $dbh->prepare($stmt);
1737 $sth->execute(@bind);
1743 The methods are simple. There's one for every major SQL operation,
1744 and a constructor you use first. The arguments are specified in a
1745 similar order for each method (table, then fields, then a where
1746 clause) to try and simplify things.
1748 =head2 new(option => 'value')
1750 The C<new()> function takes a list of options and values, and returns
1751 a new B<SQL::Abstract> object which can then be used to generate SQL
1752 through the methods below. The options accepted are:
1758 If set to 'lower', then SQL will be generated in all lowercase. By
1759 default SQL is generated in "textbook" case meaning something like:
1761 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1763 Any setting other than 'lower' is ignored.
1767 This determines what the default comparison operator is. By default
1768 it is C<=>, meaning that a hash like this:
1770 %where = (name => 'nwiger', email => 'nate@wiger.org');
1772 Will generate SQL like this:
1774 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1776 However, you may want loose comparisons by default, so if you set
1777 C<cmp> to C<like> you would get SQL such as:
1779 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1781 You can also override the comparison on an individual basis - see
1782 the huge section on L</"WHERE CLAUSES"> at the bottom.
1784 =item sqltrue, sqlfalse
1786 Expressions for inserting boolean values within SQL statements.
1787 By default these are C<1=1> and C<1=0>. They are used
1788 by the special operators C<-in> and C<-not_in> for generating
1789 correct SQL even when the argument is an empty array (see below).
1793 This determines the default logical operator for multiple WHERE
1794 statements in arrays or hashes. If absent, the default logic is "or"
1795 for arrays, and "and" for hashes. This means that a WHERE
1799 event_date => {'>=', '2/13/99'},
1800 event_date => {'<=', '4/24/03'},
1803 will generate SQL like this:
1805 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1807 This is probably not what you want given this query, though (look
1808 at the dates). To change the "OR" to an "AND", simply specify:
1810 my $sql = SQL::Abstract->new(logic => 'and');
1812 Which will change the above C<WHERE> to:
1814 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1816 The logic can also be changed locally by inserting
1817 a modifier in front of an arrayref:
1819 @where = (-and => [event_date => {'>=', '2/13/99'},
1820 event_date => {'<=', '4/24/03'} ]);
1822 See the L</"WHERE CLAUSES"> section for explanations.
1826 This will automatically convert comparisons using the specified SQL
1827 function for both column and value. This is mostly used with an argument
1828 of C<upper> or C<lower>, so that the SQL will have the effect of
1829 case-insensitive "searches". For example, this:
1831 $sql = SQL::Abstract->new(convert => 'upper');
1832 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1834 Will turn out the following SQL:
1836 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1838 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1839 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1840 not validate this option; it will just pass through what you specify verbatim).
1844 This is a kludge because many databases suck. For example, you can't
1845 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1846 Instead, you have to use C<bind_param()>:
1848 $sth->bind_param(1, 'reg data');
1849 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1851 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1852 which loses track of which field each slot refers to. Fear not.
1854 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1855 Currently, you can specify either C<normal> (default) or C<columns>. If you
1856 specify C<columns>, you will get an array that looks like this:
1858 my $sql = SQL::Abstract->new(bindtype => 'columns');
1859 my($stmt, @bind) = $sql->insert(...);
1862 [ 'column1', 'value1' ],
1863 [ 'column2', 'value2' ],
1864 [ 'column3', 'value3' ],
1867 You can then iterate through this manually, using DBI's C<bind_param()>.
1869 $sth->prepare($stmt);
1872 my($col, $data) = @$_;
1873 if ($col eq 'details' || $col eq 'comments') {
1874 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1875 } elsif ($col eq 'image') {
1876 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1878 $sth->bind_param($i, $data);
1882 $sth->execute; # execute without @bind now
1884 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1885 Basically, the advantage is still that you don't have to care which fields
1886 are or are not included. You could wrap that above C<for> loop in a simple
1887 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1888 get a layer of abstraction over manual SQL specification.
1890 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1891 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1892 will expect the bind values in this format.
1896 This is the character that a table or column name will be quoted
1897 with. By default this is an empty string, but you could set it to
1898 the character C<`>, to generate SQL like this:
1900 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1902 Alternatively, you can supply an array ref of two items, the first being the left
1903 hand quote character, and the second the right hand quote character. For
1904 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1905 that generates SQL like this:
1907 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1909 Quoting is useful if you have tables or columns names that are reserved
1910 words in your database's SQL dialect.
1914 This is the character that will be used to escape L</quote_char>s appearing
1915 in an identifier before it has been quoted.
1917 The parameter default in case of a single L</quote_char> character is the quote
1920 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1921 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1922 of the B<opening (left)> L</quote_char> within the identifier are currently left
1923 untouched. The default for opening-closing-style quotes may change in future
1924 versions, thus you are B<strongly encouraged> to specify the escape character
1929 This is the character that separates a table and column name. It is
1930 necessary to specify this when the C<quote_char> option is selected,
1931 so that tables and column names can be individually quoted like this:
1933 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1935 =item injection_guard
1937 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1938 column name specified in a query structure. This is a safety mechanism to avoid
1939 injection attacks when mishandling user input e.g.:
1941 my %condition_as_column_value_pairs = get_values_from_user();
1942 $sqla->select( ... , \%condition_as_column_value_pairs );
1944 If the expression matches an exception is thrown. Note that literal SQL
1945 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1947 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1949 =item array_datatypes
1951 When this option is true, arrayrefs in INSERT or UPDATE are
1952 interpreted as array datatypes and are passed directly
1954 When this option is false, arrayrefs are interpreted
1955 as literal SQL, just like refs to arrayrefs
1956 (but this behavior is for backwards compatibility; when writing
1957 new queries, use the "reference to arrayref" syntax
1963 Takes a reference to a list of "special operators"
1964 to extend the syntax understood by L<SQL::Abstract>.
1965 See section L</"SPECIAL OPERATORS"> for details.
1969 Takes a reference to a list of "unary operators"
1970 to extend the syntax understood by L<SQL::Abstract>.
1971 See section L</"UNARY OPERATORS"> for details.
1977 =head2 insert($table, \@values || \%fieldvals, \%options)
1979 This is the simplest function. You simply give it a table name
1980 and either an arrayref of values or hashref of field/value pairs.
1981 It returns an SQL INSERT statement and a list of bind values.
1982 See the sections on L</"Inserting and Updating Arrays"> and
1983 L</"Inserting and Updating SQL"> for information on how to insert
1984 with those data types.
1986 The optional C<\%options> hash reference may contain additional
1987 options to generate the insert SQL. Currently supported options
1994 Takes either a scalar of raw SQL fields, or an array reference of
1995 field names, and adds on an SQL C<RETURNING> statement at the end.
1996 This allows you to return data generated by the insert statement
1997 (such as row IDs) without performing another C<SELECT> statement.
1998 Note, however, this is not part of the SQL standard and may not
1999 be supported by all database engines.
2003 =head2 update($table, \%fieldvals, \%where, \%options)
2005 This takes a table, hashref of field/value pairs, and an optional
2006 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2008 See the sections on L</"Inserting and Updating Arrays"> and
2009 L</"Inserting and Updating SQL"> for information on how to insert
2010 with those data types.
2012 The optional C<\%options> hash reference may contain additional
2013 options to generate the update SQL. Currently supported options
2020 See the C<returning> option to
2021 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2025 =head2 select($source, $fields, $where, $order)
2027 This returns a SQL SELECT statement and associated list of bind values, as
2028 specified by the arguments:
2034 Specification of the 'FROM' part of the statement.
2035 The argument can be either a plain scalar (interpreted as a table
2036 name, will be quoted), or an arrayref (interpreted as a list
2037 of table names, joined by commas, quoted), or a scalarref
2038 (literal SQL, not quoted).
2042 Specification of the list of fields to retrieve from
2044 The argument can be either an arrayref (interpreted as a list
2045 of field names, will be joined by commas and quoted), or a
2046 plain scalar (literal SQL, not quoted).
2047 Please observe that this API is not as flexible as that of
2048 the first argument C<$source>, for backwards compatibility reasons.
2052 Optional argument to specify the WHERE part of the query.
2053 The argument is most often a hashref, but can also be
2054 an arrayref or plain scalar --
2055 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2059 Optional argument to specify the ORDER BY part of the query.
2060 The argument can be a scalar, a hashref or an arrayref
2061 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2067 =head2 delete($table, \%where, \%options)
2069 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2070 It returns an SQL DELETE statement and list of bind values.
2072 The optional C<\%options> hash reference may contain additional
2073 options to generate the delete SQL. Currently supported options
2080 See the C<returning> option to
2081 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2085 =head2 where(\%where, $order)
2087 This is used to generate just the WHERE clause. For example,
2088 if you have an arbitrary data structure and know what the
2089 rest of your SQL is going to look like, but want an easy way
2090 to produce a WHERE clause, use this. It returns an SQL WHERE
2091 clause and list of bind values.
2094 =head2 values(\%data)
2096 This just returns the values from the hash C<%data>, in the same
2097 order that would be returned from any of the other above queries.
2098 Using this allows you to markedly speed up your queries if you
2099 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2101 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2103 Warning: This is an experimental method and subject to change.
2105 This returns arbitrarily generated SQL. It's a really basic shortcut.
2106 It will return two different things, depending on return context:
2108 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2109 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2111 These would return the following:
2113 # First calling form
2114 $stmt = "CREATE TABLE test (?, ?)";
2115 @bind = (field1, field2);
2117 # Second calling form
2118 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2120 Depending on what you're trying to do, it's up to you to choose the correct
2121 format. In this example, the second form is what you would want.
2125 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2129 ALTER SESSION SET nls_date_format = 'MM/YY'
2131 You get the idea. Strings get their case twiddled, but everything
2132 else remains verbatim.
2134 =head1 EXPORTABLE FUNCTIONS
2136 =head2 is_plain_value
2138 Determines if the supplied argument is a plain value as understood by this
2143 =item * The value is C<undef>
2145 =item * The value is a non-reference
2147 =item * The value is an object with stringification overloading
2149 =item * The value is of the form C<< { -value => $anything } >>
2153 On failure returns C<undef>, on success returns a B<scalar> reference
2154 to the original supplied argument.
2160 The stringification overloading detection is rather advanced: it takes
2161 into consideration not only the presence of a C<""> overload, but if that
2162 fails also checks for enabled
2163 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2164 on either C<0+> or C<bool>.
2166 Unfortunately testing in the field indicates that this
2167 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2168 but only when very large numbers of stringifying objects are involved.
2169 At the time of writing ( Sep 2014 ) there is no clear explanation of
2170 the direct cause, nor is there a manageably small test case that reliably
2171 reproduces the problem.
2173 If you encounter any of the following exceptions in B<random places within
2174 your application stack> - this module may be to blame:
2176 Operation "ne": no method found,
2177 left argument in overloaded package <something>,
2178 right argument in overloaded package <something>
2182 Stub found while resolving method "???" overloading """" in package <something>
2184 If you fall victim to the above - please attempt to reduce the problem
2185 to something that could be sent to the L<SQL::Abstract developers
2186 |DBIx::Class/GETTING HELP/SUPPORT>
2187 (either publicly or privately). As a workaround in the meantime you can
2188 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2189 value, which will most likely eliminate your problem (at the expense of
2190 not being able to properly detect exotic forms of stringification).
2192 This notice and environment variable will be removed in a future version,
2193 as soon as the underlying problem is found and a reliable workaround is
2198 =head2 is_literal_value
2200 Determines if the supplied argument is a literal value as understood by this
2205 =item * C<\$sql_string>
2207 =item * C<\[ $sql_string, @bind_values ]>
2211 On failure returns C<undef>, on success returns an B<array> reference
2212 containing the unpacked version of the supplied literal SQL and bind values.
2214 =head1 WHERE CLAUSES
2218 This module uses a variation on the idea from L<DBIx::Abstract>. It
2219 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2220 module is that things in arrays are OR'ed, and things in hashes
2223 The easiest way to explain is to show lots of examples. After
2224 each C<%where> hash shown, it is assumed you used:
2226 my($stmt, @bind) = $sql->where(\%where);
2228 However, note that the C<%where> hash can be used directly in any
2229 of the other functions as well, as described above.
2231 =head2 Key-value pairs
2233 So, let's get started. To begin, a simple hash:
2237 status => 'completed'
2240 Is converted to SQL C<key = val> statements:
2242 $stmt = "WHERE user = ? AND status = ?";
2243 @bind = ('nwiger', 'completed');
2245 One common thing I end up doing is having a list of values that
2246 a field can be in. To do this, simply specify a list inside of
2251 status => ['assigned', 'in-progress', 'pending'];
2254 This simple code will create the following:
2256 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2257 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2259 A field associated to an empty arrayref will be considered a
2260 logical false and will generate 0=1.
2262 =head2 Tests for NULL values
2264 If the value part is C<undef> then this is converted to SQL <IS NULL>
2273 $stmt = "WHERE user = ? AND status IS NULL";
2276 To test if a column IS NOT NULL:
2280 status => { '!=', undef },
2283 =head2 Specific comparison operators
2285 If you want to specify a different type of operator for your comparison,
2286 you can use a hashref for a given column:
2290 status => { '!=', 'completed' }
2293 Which would generate:
2295 $stmt = "WHERE user = ? AND status != ?";
2296 @bind = ('nwiger', 'completed');
2298 To test against multiple values, just enclose the values in an arrayref:
2300 status => { '=', ['assigned', 'in-progress', 'pending'] };
2302 Which would give you:
2304 "WHERE status = ? OR status = ? OR status = ?"
2307 The hashref can also contain multiple pairs, in which case it is expanded
2308 into an C<AND> of its elements:
2312 status => { '!=', 'completed', -not_like => 'pending%' }
2315 # Or more dynamically, like from a form
2316 $where{user} = 'nwiger';
2317 $where{status}{'!='} = 'completed';
2318 $where{status}{'-not_like'} = 'pending%';
2320 # Both generate this
2321 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2322 @bind = ('nwiger', 'completed', 'pending%');
2325 To get an OR instead, you can combine it with the arrayref idea:
2329 priority => [ { '=', 2 }, { '>', 5 } ]
2332 Which would generate:
2334 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2335 @bind = ('2', '5', 'nwiger');
2337 If you want to include literal SQL (with or without bind values), just use a
2338 scalar reference or reference to an arrayref as the value:
2341 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2342 date_expires => { '<' => \"now()" }
2345 Which would generate:
2347 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2348 @bind = ('11/26/2008');
2351 =head2 Logic and nesting operators
2353 In the example above,
2354 there is a subtle trap if you want to say something like
2355 this (notice the C<AND>):
2357 WHERE priority != ? AND priority != ?
2359 Because, in Perl you I<can't> do this:
2361 priority => { '!=' => 2, '!=' => 1 }
2363 As the second C<!=> key will obliterate the first. The solution
2364 is to use the special C<-modifier> form inside an arrayref:
2366 priority => [ -and => {'!=', 2},
2370 Normally, these would be joined by C<OR>, but the modifier tells it
2371 to use C<AND> instead. (Hint: You can use this in conjunction with the
2372 C<logic> option to C<new()> in order to change the way your queries
2373 work by default.) B<Important:> Note that the C<-modifier> goes
2374 B<INSIDE> the arrayref, as an extra first element. This will
2375 B<NOT> do what you think it might:
2377 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2379 Here is a quick list of equivalencies, since there is some overlap:
2382 status => {'!=', 'completed', 'not like', 'pending%' }
2383 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2386 status => {'=', ['assigned', 'in-progress']}
2387 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2388 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2392 =head2 Special operators: IN, BETWEEN, etc.
2394 You can also use the hashref format to compare a list of fields using the
2395 C<IN> comparison operator, by specifying the list as an arrayref:
2398 status => 'completed',
2399 reportid => { -in => [567, 2335, 2] }
2402 Which would generate:
2404 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2405 @bind = ('completed', '567', '2335', '2');
2407 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2410 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2411 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2412 'sqltrue' (by default: C<1=1>).
2414 In addition to the array you can supply a chunk of literal sql or
2415 literal sql with bind:
2418 customer => { -in => \[
2419 'SELECT cust_id FROM cust WHERE balance > ?',
2422 status => { -in => \'SELECT status_codes FROM states' },
2428 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2429 AND status IN ( SELECT status_codes FROM states )
2433 Finally, if the argument to C<-in> is not a reference, it will be
2434 treated as a single-element array.
2436 Another pair of operators is C<-between> and C<-not_between>,
2437 used with an arrayref of two values:
2441 completion_date => {
2442 -not_between => ['2002-10-01', '2003-02-06']
2448 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2450 Just like with C<-in> all plausible combinations of literal SQL
2454 start0 => { -between => [ 1, 2 ] },
2455 start1 => { -between => \["? AND ?", 1, 2] },
2456 start2 => { -between => \"lower(x) AND upper(y)" },
2457 start3 => { -between => [
2459 \["upper(?)", 'stuff' ],
2466 ( start0 BETWEEN ? AND ? )
2467 AND ( start1 BETWEEN ? AND ? )
2468 AND ( start2 BETWEEN lower(x) AND upper(y) )
2469 AND ( start3 BETWEEN lower(x) AND upper(?) )
2471 @bind = (1, 2, 1, 2, 'stuff');
2474 These are the two builtin "special operators"; but the
2475 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2477 =head2 Unary operators: bool
2479 If you wish to test against boolean columns or functions within your
2480 database you can use the C<-bool> and C<-not_bool> operators. For
2481 example to test the column C<is_user> being true and the column
2482 C<is_enabled> being false you would use:-
2486 -not_bool => 'is_enabled',
2491 WHERE is_user AND NOT is_enabled
2493 If a more complex combination is required, testing more conditions,
2494 then you should use the and/or operators:-
2499 -not_bool => { two=> { -rlike => 'bar' } },
2500 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2511 (NOT ( three = ? OR three > ? ))
2514 =head2 Nested conditions, -and/-or prefixes
2516 So far, we've seen how multiple conditions are joined with a top-level
2517 C<AND>. We can change this by putting the different conditions we want in
2518 hashes and then putting those hashes in an array. For example:
2523 status => { -like => ['pending%', 'dispatched'] },
2527 status => 'unassigned',
2531 This data structure would create the following:
2533 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2534 OR ( user = ? AND status = ? ) )";
2535 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2538 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2539 to change the logic inside:
2545 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2546 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2553 $stmt = "WHERE ( user = ?
2554 AND ( ( workhrs > ? AND geo = ? )
2555 OR ( workhrs < ? OR geo = ? ) ) )";
2556 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2558 =head3 Algebraic inconsistency, for historical reasons
2560 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2561 operator goes C<outside> of the nested structure; whereas when connecting
2562 several constraints on one column, the C<-and> operator goes
2563 C<inside> the arrayref. Here is an example combining both features:
2566 -and => [a => 1, b => 2],
2567 -or => [c => 3, d => 4],
2568 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2573 WHERE ( ( ( a = ? AND b = ? )
2574 OR ( c = ? OR d = ? )
2575 OR ( e LIKE ? AND e LIKE ? ) ) )
2577 This difference in syntax is unfortunate but must be preserved for
2578 historical reasons. So be careful: the two examples below would
2579 seem algebraically equivalent, but they are not
2582 { -like => 'foo%' },
2583 { -like => '%bar' },
2585 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2588 { col => { -like => 'foo%' } },
2589 { col => { -like => '%bar' } },
2591 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2594 =head2 Literal SQL and value type operators
2596 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2597 side" is a column name and the "right side" is a value (normally rendered as
2598 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2599 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2600 alter this behavior. There are several ways of doing so.
2604 This is a virtual operator that signals the string to its right side is an
2605 identifier (a column name) and not a value. For example to compare two
2606 columns you would write:
2609 priority => { '<', 2 },
2610 requestor => { -ident => 'submitter' },
2615 $stmt = "WHERE priority < ? AND requestor = submitter";
2618 If you are maintaining legacy code you may see a different construct as
2619 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2624 This is a virtual operator that signals that the construct to its right side
2625 is a value to be passed to DBI. This is for example necessary when you want
2626 to write a where clause against an array (for RDBMS that support such
2627 datatypes). For example:
2630 array => { -value => [1, 2, 3] }
2635 $stmt = 'WHERE array = ?';
2636 @bind = ([1, 2, 3]);
2638 Note that if you were to simply say:
2644 the result would probably not be what you wanted:
2646 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2651 Finally, sometimes only literal SQL will do. To include a random snippet
2652 of SQL verbatim, you specify it as a scalar reference. Consider this only
2653 as a last resort. Usually there is a better way. For example:
2656 priority => { '<', 2 },
2657 requestor => { -in => \'(SELECT name FROM hitmen)' },
2662 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2665 Note that in this example, you only get one bind parameter back, since
2666 the verbatim SQL is passed as part of the statement.
2670 Never use untrusted input as a literal SQL argument - this is a massive
2671 security risk (there is no way to check literal snippets for SQL
2672 injections and other nastyness). If you need to deal with untrusted input
2673 use literal SQL with placeholders as described next.
2675 =head3 Literal SQL with placeholders and bind values (subqueries)
2677 If the literal SQL to be inserted has placeholders and bind values,
2678 use a reference to an arrayref (yes this is a double reference --
2679 not so common, but perfectly legal Perl). For example, to find a date
2680 in Postgres you can use something like this:
2683 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2688 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2691 Note that you must pass the bind values in the same format as they are returned
2692 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2693 to C<columns>, you must provide the bind values in the
2694 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2695 scalar value; most commonly the column name, but you can use any scalar value
2696 (including references and blessed references), L<SQL::Abstract> will simply
2697 pass it through intact. So if C<bindtype> is set to C<columns> the above
2698 example will look like:
2701 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2704 Literal SQL is especially useful for nesting parenthesized clauses in the
2705 main SQL query. Here is a first example:
2707 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2711 bar => \["IN ($sub_stmt)" => @sub_bind],
2716 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2717 WHERE c2 < ? AND c3 LIKE ?))";
2718 @bind = (1234, 100, "foo%");
2720 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2721 are expressed in the same way. Of course the C<$sub_stmt> and
2722 its associated bind values can be generated through a former call
2725 my ($sub_stmt, @sub_bind)
2726 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2727 c3 => {-like => "foo%"}});
2730 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2733 In the examples above, the subquery was used as an operator on a column;
2734 but the same principle also applies for a clause within the main C<%where>
2735 hash, like an EXISTS subquery:
2737 my ($sub_stmt, @sub_bind)
2738 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2739 my %where = ( -and => [
2741 \["EXISTS ($sub_stmt)" => @sub_bind],
2746 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2747 WHERE c1 = ? AND c2 > t0.c0))";
2751 Observe that the condition on C<c2> in the subquery refers to
2752 column C<t0.c0> of the main query: this is I<not> a bind
2753 value, so we have to express it through a scalar ref.
2754 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2755 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2756 what we wanted here.
2758 Finally, here is an example where a subquery is used
2759 for expressing unary negation:
2761 my ($sub_stmt, @sub_bind)
2762 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2763 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2765 lname => {like => '%son%'},
2766 \["NOT ($sub_stmt)" => @sub_bind],
2771 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2772 @bind = ('%son%', 10, 20)
2774 =head3 Deprecated usage of Literal SQL
2776 Below are some examples of archaic use of literal SQL. It is shown only as
2777 reference for those who deal with legacy code. Each example has a much
2778 better, cleaner and safer alternative that users should opt for in new code.
2784 my %where = ( requestor => \'IS NOT NULL' )
2786 $stmt = "WHERE requestor IS NOT NULL"
2788 This used to be the way of generating NULL comparisons, before the handling
2789 of C<undef> got formalized. For new code please use the superior syntax as
2790 described in L</Tests for NULL values>.
2794 my %where = ( requestor => \'= submitter' )
2796 $stmt = "WHERE requestor = submitter"
2798 This used to be the only way to compare columns. Use the superior L</-ident>
2799 method for all new code. For example an identifier declared in such a way
2800 will be properly quoted if L</quote_char> is properly set, while the legacy
2801 form will remain as supplied.
2805 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2807 $stmt = "WHERE completed > ? AND is_ready"
2808 @bind = ('2012-12-21')
2810 Using an empty string literal used to be the only way to express a boolean.
2811 For all new code please use the much more readable
2812 L<-bool|/Unary operators: bool> operator.
2818 These pages could go on for a while, since the nesting of the data
2819 structures this module can handle are pretty much unlimited (the
2820 module implements the C<WHERE> expansion as a recursive function
2821 internally). Your best bet is to "play around" with the module a
2822 little to see how the data structures behave, and choose the best
2823 format for your data based on that.
2825 And of course, all the values above will probably be replaced with
2826 variables gotten from forms or the command line. After all, if you
2827 knew everything ahead of time, you wouldn't have to worry about
2828 dynamically-generating SQL and could just hardwire it into your
2831 =head1 ORDER BY CLAUSES
2833 Some functions take an order by clause. This can either be a scalar (just a
2834 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2835 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2838 Given | Will Generate
2839 ---------------------------------------------------------------
2841 'colA' | ORDER BY colA
2843 [qw/colA colB/] | ORDER BY colA, colB
2845 {-asc => 'colA'} | ORDER BY colA ASC
2847 {-desc => 'colB'} | ORDER BY colB DESC
2849 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2851 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2853 \'colA DESC' | ORDER BY colA DESC
2855 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2856 | /* ...with $x bound to ? */
2859 { -asc => 'colA' }, | colA ASC,
2860 { -desc => [qw/colB/] }, | colB DESC,
2861 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2862 \'colE DESC', | colE DESC,
2863 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2864 ] | /* ...with $x bound to ? */
2865 ===============================================================
2869 =head1 SPECIAL OPERATORS
2871 my $sqlmaker = SQL::Abstract->new(special_ops => [
2875 my ($self, $field, $op, $arg) = @_;
2881 handler => 'method_name',
2885 A "special operator" is a SQL syntactic clause that can be
2886 applied to a field, instead of a usual binary operator.
2889 WHERE field IN (?, ?, ?)
2890 WHERE field BETWEEN ? AND ?
2891 WHERE MATCH(field) AGAINST (?, ?)
2893 Special operators IN and BETWEEN are fairly standard and therefore
2894 are builtin within C<SQL::Abstract> (as the overridable methods
2895 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2896 like the MATCH .. AGAINST example above which is specific to MySQL,
2897 you can write your own operator handlers - supply a C<special_ops>
2898 argument to the C<new> method. That argument takes an arrayref of
2899 operator definitions; each operator definition is a hashref with two
2906 the regular expression to match the operator
2910 Either a coderef or a plain scalar method name. In both cases
2911 the expected return is C<< ($sql, @bind) >>.
2913 When supplied with a method name, it is simply called on the
2914 L<SQL::Abstract> object as:
2916 $self->$method_name($field, $op, $arg)
2920 $field is the LHS of the operator
2921 $op is the part that matched the handler regex
2924 When supplied with a coderef, it is called as:
2926 $coderef->($self, $field, $op, $arg)
2931 For example, here is an implementation
2932 of the MATCH .. AGAINST syntax for MySQL
2934 my $sqlmaker = SQL::Abstract->new(special_ops => [
2936 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2937 {regex => qr/^match$/i,
2939 my ($self, $field, $op, $arg) = @_;
2940 $arg = [$arg] if not ref $arg;
2941 my $label = $self->_quote($field);
2942 my ($placeholder) = $self->_convert('?');
2943 my $placeholders = join ", ", (($placeholder) x @$arg);
2944 my $sql = $self->_sqlcase('match') . " ($label) "
2945 . $self->_sqlcase('against') . " ($placeholders) ";
2946 my @bind = $self->_bindtype($field, @$arg);
2947 return ($sql, @bind);
2954 =head1 UNARY OPERATORS
2956 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2960 my ($self, $op, $arg) = @_;
2966 handler => 'method_name',
2970 A "unary operator" is a SQL syntactic clause that can be
2971 applied to a field - the operator goes before the field
2973 You can write your own operator handlers - supply a C<unary_ops>
2974 argument to the C<new> method. That argument takes an arrayref of
2975 operator definitions; each operator definition is a hashref with two
2982 the regular expression to match the operator
2986 Either a coderef or a plain scalar method name. In both cases
2987 the expected return is C<< $sql >>.
2989 When supplied with a method name, it is simply called on the
2990 L<SQL::Abstract> object as:
2992 $self->$method_name($op, $arg)
2996 $op is the part that matched the handler regex
2997 $arg is the RHS or argument of the operator
2999 When supplied with a coderef, it is called as:
3001 $coderef->($self, $op, $arg)
3009 Thanks to some benchmarking by Mark Stosberg, it turns out that
3010 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3011 I must admit this wasn't an intentional design issue, but it's a
3012 byproduct of the fact that you get to control your C<DBI> handles
3015 To maximize performance, use a code snippet like the following:
3017 # prepare a statement handle using the first row
3018 # and then reuse it for the rest of the rows
3020 for my $href (@array_of_hashrefs) {
3021 $stmt ||= $sql->insert('table', $href);
3022 $sth ||= $dbh->prepare($stmt);
3023 $sth->execute($sql->values($href));
3026 The reason this works is because the keys in your C<$href> are sorted
3027 internally by B<SQL::Abstract>. Thus, as long as your data retains
3028 the same structure, you only have to generate the SQL the first time
3029 around. On subsequent queries, simply use the C<values> function provided
3030 by this module to return your values in the correct order.
3032 However this depends on the values having the same type - if, for
3033 example, the values of a where clause may either have values
3034 (resulting in sql of the form C<column = ?> with a single bind
3035 value), or alternatively the values might be C<undef> (resulting in
3036 sql of the form C<column IS NULL> with no bind value) then the
3037 caching technique suggested will not work.
3041 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3042 really like this part (I do, at least). Building up a complex query
3043 can be as simple as the following:
3050 use CGI::FormBuilder;
3053 my $form = CGI::FormBuilder->new(...);
3054 my $sql = SQL::Abstract->new;
3056 if ($form->submitted) {
3057 my $field = $form->field;
3058 my $id = delete $field->{id};
3059 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3062 Of course, you would still have to connect using C<DBI> to run the
3063 query, but the point is that if you make your form look like your
3064 table, the actual query script can be extremely simplistic.
3066 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3067 a fast interface to returning and formatting data. I frequently
3068 use these three modules together to write complex database query
3069 apps in under 50 lines.
3071 =head1 HOW TO CONTRIBUTE
3073 Contributions are always welcome, in all usable forms (we especially
3074 welcome documentation improvements). The delivery methods include git-
3075 or unified-diff formatted patches, GitHub pull requests, or plain bug
3076 reports either via RT or the Mailing list. Contributors are generally
3077 granted full access to the official repository after their first several
3078 patches pass successful review.
3080 This project is maintained in a git repository. The code and related tools are
3081 accessible at the following locations:
3085 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3087 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3089 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3091 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3097 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3098 Great care has been taken to preserve the I<published> behavior
3099 documented in previous versions in the 1.* family; however,
3100 some features that were previously undocumented, or behaved
3101 differently from the documentation, had to be changed in order
3102 to clarify the semantics. Hence, client code that was relying
3103 on some dark areas of C<SQL::Abstract> v1.*
3104 B<might behave differently> in v1.50.
3106 The main changes are:
3112 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3116 support for the { operator => \"..." } construct (to embed literal SQL)
3120 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3124 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3128 defensive programming: check arguments
3132 fixed bug with global logic, which was previously implemented
3133 through global variables yielding side-effects. Prior versions would
3134 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3135 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3136 Now this is interpreted
3137 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3142 fixed semantics of _bindtype on array args
3146 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3147 we just avoid shifting arrays within that tree.
3151 dropped the C<_modlogic> function
3155 =head1 ACKNOWLEDGEMENTS
3157 There are a number of individuals that have really helped out with
3158 this module. Unfortunately, most of them submitted bugs via CPAN
3159 so I have no idea who they are! But the people I do know are:
3161 Ash Berlin (order_by hash term support)
3162 Matt Trout (DBIx::Class support)
3163 Mark Stosberg (benchmarking)
3164 Chas Owens (initial "IN" operator support)
3165 Philip Collins (per-field SQL functions)
3166 Eric Kolve (hashref "AND" support)
3167 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3168 Dan Kubb (support for "quote_char" and "name_sep")
3169 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3170 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3171 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3172 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3173 Oliver Charles (support for "RETURNING" after "INSERT")
3179 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3183 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3185 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3187 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3188 While not an official support venue, C<DBIx::Class> makes heavy use of
3189 C<SQL::Abstract>, and as such list members there are very familiar with
3190 how to create queries.
3194 This module is free software; you may copy this under the same
3195 terms as perl itself (either the GNU General Public License or
3196 the Artistic License)