1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.87';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{special_ops} ||= [];
160 # regexes are applied in order, thus push after user-defines
161 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 if ($class->isa('DBIx::Class::SQLMaker')) {
164 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
165 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
167 $opt{is_dbic_sqlmaker} = 1;
171 $opt{unary_ops} ||= [];
173 # rudimentary sanity-check for user supplied bits treated as functions/operators
174 # If a purported function matches this regular expression, an exception is thrown.
175 # Literal SQL is *NOT* subject to this check, only functions (and column names
176 # when quoting is not in effect)
179 # need to guard against ()'s in column names too, but this will break tons of
180 # hacks... ideas anyone?
181 $opt{injection_guard} ||= qr/
187 $opt{expand_unary} = {};
190 -not => '_expand_not',
191 -bool => '_expand_bool',
192 -and => '_expand_op_andor',
193 -or => '_expand_op_andor',
194 -nest => '_expand_nest',
198 'between' => '_expand_between',
199 'not between' => '_expand_between',
200 'in' => '_expand_in',
201 'not in' => '_expand_in',
202 'nest' => '_expand_nest',
203 (map +($_ => '_expand_op_andor'), ('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 # hash with multiple or no elements is andor
627 if (ref($v) eq 'HASH' and keys %$v != 1) {
628 return $self->_expand_op_andor(-and => $v, $k);
631 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
637 and exists $v->{-value}
638 and not defined $v->{-value}
641 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
644 # scalars and objects get expanded as whatever requested or values
646 if (!ref($v) or Scalar::Util::blessed($v)) {
647 my $d = our $Default_Scalar_To;
648 local our $Cur_Col_Meta = $k;
649 return $self->_expand_expr_hashpair_ident(
652 ? $self->_expand_expr($d => $v)
657 if (ref($v) eq 'HASH') {
658 return $self->_expand_expr_hashtriple($k, %$v);
660 if (ref($v) eq 'ARRAY') {
661 return $self->sqlfalse unless @$v;
662 $self->_debug("ARRAY($k) means distribute over elements");
664 $v->[0] =~ /^-(and|or)$/i
665 ? shift(@{$v = [ @$v ]})
666 : '-'.lc($self->{logic} || 'OR')
668 return $self->_expand_op_andor(
672 if (my $literal = is_literal_value($v)) {
674 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
677 my ($sql, @bind) = @$literal;
678 if ($self->{bindtype} eq 'columns') {
680 $self->_assert_bindval_matches_bindtype($_);
683 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
688 sub _expand_expr_hashpair_op {
689 my ($self, $k, $v) = @_;
692 $op =~ s/^-// if length($op) > 1;
693 $self->_assert_pass_injection_guard($op);
695 # Ops prefixed with -not_ get converted
697 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
700 $self->_expand_expr({ "-${rest}", $v })
704 # the old special op system requires illegality for top-level use
707 (our $Expand_Depth) == 1
708 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
710 puke "Illegal use of top-level '-$op'"
713 # the old unary op system means we should touch nothing and let it work
715 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
716 return { -op => [ $op, $v ] };
719 # an explicit node type is currently assumed to be expanded (this is almost
720 # certainly wrong and there should be expansion anyway)
722 if ($self->{render}{$k}) {
726 # hashref RHS values get expanded and used as op/func args
731 and (keys %$v)[0] =~ /^-/
733 my ($func) = $k =~ /^-(.*)$/;
734 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
735 return +{ -op => [ $func, $self->_expand_expr($v) ] };
737 return +{ -func => [ $func, $self->_expand_expr($v) ] };
740 # scalars and literals get simply expanded
742 if (!ref($v) or is_literal_value($v)) {
743 return +{ -op => [ $op, $self->_expand_expr($v) ] };
749 sub _expand_expr_hashtriple {
750 my ($self, $k, $vk, $vv) = @_;
752 my $ik = $self->_expand_ident(-ident => $k);
754 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
755 $self->_assert_pass_injection_guard($op);
756 if ($op =~ s/ [_\s]? \d+ $//x ) {
757 return $self->_expand_expr($k, { $vk, $vv });
759 if (my $x = $self->{expand_op}{$op}) {
760 local our $Cur_Col_Meta = $k;
761 return $self->$x($op, $vv, $k);
763 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
764 return { -op => [ $op, $ik, $vv ] };
766 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
770 { -op => [ $op, $vv ] }
773 if (ref($vv) eq 'ARRAY') {
775 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
776 ? shift @raw : '-or';
777 my @values = map +{ $vk => $_ }, @raw;
779 $op =~ $self->{inequality_op}
780 or $op =~ $self->{not_like_op}
782 if (lc($logic) eq '-or' and @values > 1) {
783 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
784 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
785 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
790 # try to DWIM on equality operators
792 $op =~ $self->{equality_op} ? $self->sqlfalse
793 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
794 : $op =~ $self->{inequality_op} ? $self->sqltrue
795 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
796 : puke "operator '$op' applied on an empty array (field '$k')";
798 return $self->_expand_op_andor($logic => \@values, $k);
804 and exists $vv->{-value}
805 and not defined $vv->{-value}
809 $op =~ /^not$/i ? 'is not' # legacy
810 : $op =~ $self->{equality_op} ? 'is'
811 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
812 : $op =~ $self->{inequality_op} ? 'is not'
813 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
814 : puke "unexpected operator '$op' with undef operand";
816 return $self->_expand_expr_hashpair($k => { $is, undef });
818 local our $Cur_Col_Meta = $k;
822 $self->_expand_expr($vv)
827 my ($self, $op, $body) = @_;
828 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
829 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
831 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
832 ref($body) ? @$body : $body;
833 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
834 unless ($self->{quote_char}) {
835 $self->_assert_pass_injection_guard($_) for @parts;
837 return +{ -ident => \@parts };
841 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
845 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
849 my ($self, undef, $v) = @_;
851 return $self->_expand_expr($v);
853 puke "-bool => undef not supported" unless defined($v);
854 return $self->_expand_ident(-ident => $v);
857 sub _expand_op_andor {
858 my ($self, $logic, $v, $k) = @_;
860 $v = [ map +{ $k, $_ },
862 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
866 my ($logop) = $logic =~ /^-?(.*)$/;
867 if (ref($v) eq 'HASH') {
868 return undef unless keys %$v;
871 map $self->_expand_expr({ $_ => $v->{$_} }),
875 if (ref($v) eq 'ARRAY') {
876 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
879 (ref($_) eq 'ARRAY' and @$_)
880 or (ref($_) eq 'HASH' and %$_)
886 while (my ($el) = splice @expr, 0, 1) {
887 puke "Supplying an empty left hand side argument is not supported in array-pairs"
888 unless defined($el) and length($el);
889 my $elref = ref($el);
891 local our $Expand_Depth = 0;
892 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
893 } elsif ($elref eq 'ARRAY') {
894 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
895 } elsif (my $l = is_literal_value($el)) {
896 push @res, { -literal => $l };
897 } elsif ($elref eq 'HASH') {
898 local our $Expand_Depth = 0;
899 push @res, grep defined, $self->_expand_expr($el) if %$el;
905 # return $res[0] if @res == 1;
906 return { -op => [ $logop, @res ] };
912 my ($self, $op, $vv, $k) = @_;
913 puke "$op can only take undef as argument"
917 and exists($vv->{-value})
918 and !defined($vv->{-value})
920 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
923 sub _expand_between {
924 my ($self, $op, $vv, $k) = @_;
925 local our $Cur_Col_Meta = $k;
926 my @rhs = map $self->_expand_expr($_),
927 ref($vv) eq 'ARRAY' ? @$vv : $vv;
929 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
931 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
933 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
937 $self->_expand_ident(-ident => $k),
943 my ($self, $op, $vv, $k) = @_;
944 if (my $literal = is_literal_value($vv)) {
945 my ($sql, @bind) = @$literal;
946 my $opened_sql = $self->_open_outer_paren($sql);
948 $op, $self->_expand_ident(-ident => $k),
949 [ { -literal => [ $opened_sql, @bind ] } ]
953 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
954 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
955 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
956 . 'will emit the logically correct SQL instead of raising this exception)'
958 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
960 my @rhs = map $self->_expand_expr($_),
961 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
962 map { defined($_) ? $_: puke($undef_err) }
963 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
964 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
968 $self->_expand_ident(-ident => $k),
974 my ($self, $op, $v) = @_;
975 # DBIx::Class requires a nest warning to be emitted once but the private
976 # method it overrode to do so no longer exists
977 if ($self->{is_dbic_sqlmaker}) {
978 unless (our $Nest_Warned) {
980 "-nest in search conditions is deprecated, you most probably wanted:\n"
981 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
986 return $self->_expand_expr($v);
990 my ($self, $where, $logic) = @_;
992 # Special case: top level simple string treated as literal
994 my $where_exp = (ref($where)
995 ? $self->_expand_expr($where, $logic)
996 : { -literal => [ $where ] });
998 # dispatch expanded expression
1000 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1001 # DBIx::Class used to call _recurse_where in scalar context
1002 # something else might too...
1004 return ($sql, @bind);
1007 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1013 my ($self, $ident) = @_;
1015 return $self->_convert($self->_quote($ident));
1019 my ($self, $list) = @_;
1020 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1021 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1025 my ($self, $rest) = @_;
1026 my ($func, @args) = @$rest;
1030 push @arg_sql, shift @x;
1032 } map [ $self->render_aqt($_) ], @args;
1033 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1037 my ($self, $bind) = @_;
1038 return ($self->_convert('?'), $self->_bindtype(@$bind));
1041 sub _render_literal {
1042 my ($self, $literal) = @_;
1043 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1047 sub _render_op_between {
1048 my ($self, $op, $args) = @_;
1049 my ($left, $low, $high) = @$args;
1050 my ($rhsql, @rhbind) = do {
1052 puke "Single arg to between must be a literal"
1053 unless $low->{-literal};
1056 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1057 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1058 @{$l}[1..$#$l], @{$h}[1..$#$h])
1061 my ($lhsql, @lhbind) = $self->render_aqt($left);
1063 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1069 my ($self, $op, $args) = @_;
1070 my ($lhs, $rhs) = @$args;
1073 my ($sql, @bind) = $self->render_aqt($_);
1074 push @in_bind, @bind;
1077 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1079 $lhsql.' '.$self->_sqlcase($op).' ( '
1080 .join(', ', @in_sql)
1086 sub _render_op_andor {
1087 my ($self, $op, $args) = @_;
1088 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1089 return '' unless @parts;
1090 return @{$parts[0]} if @parts == 1;
1091 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1092 return '( '.$sql.' )', @bind;
1095 sub _render_op_multop {
1096 my ($self, $op, $args) = @_;
1097 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1098 return '' unless @parts;
1099 return @{$parts[0]} if @parts == 1;
1100 my ($final_sql) = join(
1101 ' '.$self->_sqlcase($op).' ',
1106 map @{$_}[1..$#$_], @parts
1111 my ($self, $v) = @_;
1112 my ($op, @args) = @$v;
1113 if (my $r = $self->{render_op}{$op}) {
1114 return $self->$r($op, \@args);
1116 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1117 if ($us and @args > 1) {
1118 puke "Special op '${op}' requires first value to be identifier"
1119 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1120 my $k = join(($self->{name_sep}||'.'), @$ident);
1121 local our $Expand_Depth = 1;
1122 return $self->${\($us->{handler})}($k, $op, $args[1]);
1124 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1125 return $self->${\($us->{handler})}($op, $args[0]);
1128 return $self->_render_unop_prefix($op, \@args);
1130 return $self->_render_op_multop($op, \@args);
1135 sub _render_op_not {
1136 my ($self, $op, $v) = @_;
1137 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1138 return "(${sql})", @bind;
1141 sub _render_unop_prefix {
1142 my ($self, $op, $v) = @_;
1143 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1144 my $op_sql = $self->_sqlcase($op);
1145 return ("${op_sql} ${expr_sql}", @bind);
1148 sub _render_unop_postfix {
1149 my ($self, $op, $v) = @_;
1150 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1151 my $op_sql = $self->_sqlcase($op);
1152 return ($expr_sql.' '.$op_sql, @bind);
1155 # Some databases (SQLite) treat col IN (1, 2) different from
1156 # col IN ( (1, 2) ). Use this to strip all outer parens while
1157 # adding them back in the corresponding method
1158 sub _open_outer_paren {
1159 my ($self, $sql) = @_;
1161 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1163 # there are closing parens inside, need the heavy duty machinery
1164 # to reevaluate the extraction starting from $sql (full reevaluation)
1165 if ($inner =~ /\)/) {
1166 require Text::Balanced;
1168 my (undef, $remainder) = do {
1169 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1171 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1174 # the entire expression needs to be a balanced bracketed thing
1175 # (after an extract no remainder sans trailing space)
1176 last if defined $remainder and $remainder =~ /\S/;
1186 #======================================================================
1188 #======================================================================
1190 sub _expand_order_by {
1191 my ($self, $arg) = @_;
1193 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1195 my $expander = sub {
1196 my ($self, $dir, $expr) = @_;
1197 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1198 foreach my $arg (@to_expand) {
1202 and grep /^-(asc|desc)$/, keys %$arg
1204 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1208 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1210 map $self->expand_expr($_, -ident),
1211 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1212 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1215 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1217 return $self->$expander(undef, $arg);
1221 my ($self, $arg) = @_;
1223 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1225 my ($sql, @bind) = $self->render_aqt($expanded);
1227 return '' unless length($sql);
1229 my $final_sql = $self->_sqlcase(' order by ').$sql;
1231 return wantarray ? ($final_sql, @bind) : $final_sql;
1234 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1236 sub _order_by_chunks {
1237 my ($self, $arg) = @_;
1239 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1241 return $self->_chunkify_order_by($expanded);
1244 sub _chunkify_order_by {
1245 my ($self, $expanded) = @_;
1247 return grep length, $self->render_aqt($expanded)
1248 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1251 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1252 return map $self->_chunkify_order_by($_), @$l;
1254 return [ $self->render_aqt($_) ];
1258 #======================================================================
1259 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1260 #======================================================================
1266 $self->_expand_maybe_list_expr($from, undef, -ident)
1271 #======================================================================
1273 #======================================================================
1275 sub _expand_maybe_list_expr {
1276 my ($self, $expr, $logic, $default) = @_;
1278 if (ref($expr) eq 'ARRAY') {
1280 map $self->expand_expr($_, $default), @$expr
1287 return $self->expand_expr($e, $default);
1290 # highly optimized, as it's called way too often
1292 # my ($self, $label) = @_;
1294 return '' unless defined $_[1];
1295 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1296 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1298 unless ($_[0]->{quote_char}) {
1299 if (ref($_[1]) eq 'ARRAY') {
1300 return join($_[0]->{name_sep}||'.', @{$_[1]});
1302 $_[0]->_assert_pass_injection_guard($_[1]);
1307 my $qref = ref $_[0]->{quote_char};
1309 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1310 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1311 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1313 my $esc = $_[0]->{escape_char} || $r;
1315 # parts containing * are naturally unquoted
1317 $_[0]->{name_sep}||'',
1321 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1323 (ref($_[1]) eq 'ARRAY'
1327 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1335 # Conversion, if applicable
1337 #my ($self, $arg) = @_;
1338 if ($_[0]->{convert_where}) {
1339 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1346 #my ($self, $col, @vals) = @_;
1347 # called often - tighten code
1348 return $_[0]->{bindtype} eq 'columns'
1349 ? map {[$_[1], $_]} @_[2 .. $#_]
1354 # Dies if any element of @bind is not in [colname => value] format
1355 # if bindtype is 'columns'.
1356 sub _assert_bindval_matches_bindtype {
1357 # my ($self, @bind) = @_;
1359 if ($self->{bindtype} eq 'columns') {
1361 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1362 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1368 sub _join_sql_clauses {
1369 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1371 if (@$clauses_aref > 1) {
1372 my $join = " " . $self->_sqlcase($logic) . " ";
1373 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1374 return ($sql, @$bind_aref);
1376 elsif (@$clauses_aref) {
1377 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1380 return (); # if no SQL, ignore @$bind_aref
1385 # Fix SQL case, if so requested
1387 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1388 # don't touch the argument ... crooked logic, but let's not change it!
1389 return $_[0]->{case} ? $_[1] : uc($_[1]);
1393 #======================================================================
1394 # DISPATCHING FROM REFKIND
1395 #======================================================================
1398 my ($self, $data) = @_;
1400 return 'UNDEF' unless defined $data;
1402 # blessed objects are treated like scalars
1403 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1405 return 'SCALAR' unless $ref;
1408 while ($ref eq 'REF') {
1410 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1414 return ($ref||'SCALAR') . ('REF' x $n_steps);
1418 my ($self, $data) = @_;
1419 my @try = ($self->_refkind($data));
1420 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1421 push @try, 'FALLBACK';
1425 sub _METHOD_FOR_refkind {
1426 my ($self, $meth_prefix, $data) = @_;
1429 for (@{$self->_try_refkind($data)}) {
1430 $method = $self->can($meth_prefix."_".$_)
1434 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1438 sub _SWITCH_refkind {
1439 my ($self, $data, $dispatch_table) = @_;
1442 for (@{$self->_try_refkind($data)}) {
1443 $coderef = $dispatch_table->{$_}
1447 puke "no dispatch entry for ".$self->_refkind($data)
1456 #======================================================================
1457 # VALUES, GENERATE, AUTOLOAD
1458 #======================================================================
1460 # LDNOTE: original code from nwiger, didn't touch code in that section
1461 # I feel the AUTOLOAD stuff should not be the default, it should
1462 # only be activated on explicit demand by user.
1466 my $data = shift || return;
1467 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1468 unless ref $data eq 'HASH';
1471 foreach my $k (sort keys %$data) {
1472 my $v = $data->{$k};
1473 $self->_SWITCH_refkind($v, {
1475 if ($self->{array_datatypes}) { # array datatype
1476 push @all_bind, $self->_bindtype($k, $v);
1478 else { # literal SQL with bind
1479 my ($sql, @bind) = @$v;
1480 $self->_assert_bindval_matches_bindtype(@bind);
1481 push @all_bind, @bind;
1484 ARRAYREFREF => sub { # literal SQL with bind
1485 my ($sql, @bind) = @${$v};
1486 $self->_assert_bindval_matches_bindtype(@bind);
1487 push @all_bind, @bind;
1489 SCALARREF => sub { # literal SQL without bind
1491 SCALAR_or_UNDEF => sub {
1492 push @all_bind, $self->_bindtype($k, $v);
1503 my(@sql, @sqlq, @sqlv);
1507 if ($ref eq 'HASH') {
1508 for my $k (sort keys %$_) {
1511 my $label = $self->_quote($k);
1512 if ($r eq 'ARRAY') {
1513 # literal SQL with bind
1514 my ($sql, @bind) = @$v;
1515 $self->_assert_bindval_matches_bindtype(@bind);
1516 push @sqlq, "$label = $sql";
1518 } elsif ($r eq 'SCALAR') {
1519 # literal SQL without bind
1520 push @sqlq, "$label = $$v";
1522 push @sqlq, "$label = ?";
1523 push @sqlv, $self->_bindtype($k, $v);
1526 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1527 } elsif ($ref eq 'ARRAY') {
1528 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1531 if ($r eq 'ARRAY') { # literal SQL with bind
1532 my ($sql, @bind) = @$v;
1533 $self->_assert_bindval_matches_bindtype(@bind);
1536 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1537 # embedded literal SQL
1544 push @sql, '(' . join(', ', @sqlq) . ')';
1545 } elsif ($ref eq 'SCALAR') {
1549 # strings get case twiddled
1550 push @sql, $self->_sqlcase($_);
1554 my $sql = join ' ', @sql;
1556 # this is pretty tricky
1557 # if ask for an array, return ($stmt, @bind)
1558 # otherwise, s/?/shift @sqlv/ to put it inline
1560 return ($sql, @sqlv);
1562 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1563 ref $d ? $d->[1] : $d/e;
1572 # This allows us to check for a local, then _form, attr
1574 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1575 return $self->generate($name, @_);
1586 SQL::Abstract - Generate SQL from Perl data structures
1592 my $sql = SQL::Abstract->new;
1594 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1596 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1598 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1600 my($stmt, @bind) = $sql->delete($table, \%where);
1602 # Then, use these in your DBI statements
1603 my $sth = $dbh->prepare($stmt);
1604 $sth->execute(@bind);
1606 # Just generate the WHERE clause
1607 my($stmt, @bind) = $sql->where(\%where, $order);
1609 # Return values in the same order, for hashed queries
1610 # See PERFORMANCE section for more details
1611 my @bind = $sql->values(\%fieldvals);
1615 This module was inspired by the excellent L<DBIx::Abstract>.
1616 However, in using that module I found that what I really wanted
1617 to do was generate SQL, but still retain complete control over my
1618 statement handles and use the DBI interface. So, I set out to
1619 create an abstract SQL generation module.
1621 While based on the concepts used by L<DBIx::Abstract>, there are
1622 several important differences, especially when it comes to WHERE
1623 clauses. I have modified the concepts used to make the SQL easier
1624 to generate from Perl data structures and, IMO, more intuitive.
1625 The underlying idea is for this module to do what you mean, based
1626 on the data structures you provide it. The big advantage is that
1627 you don't have to modify your code every time your data changes,
1628 as this module figures it out.
1630 To begin with, an SQL INSERT is as easy as just specifying a hash
1631 of C<key=value> pairs:
1634 name => 'Jimbo Bobson',
1635 phone => '123-456-7890',
1636 address => '42 Sister Lane',
1637 city => 'St. Louis',
1638 state => 'Louisiana',
1641 The SQL can then be generated with this:
1643 my($stmt, @bind) = $sql->insert('people', \%data);
1645 Which would give you something like this:
1647 $stmt = "INSERT INTO people
1648 (address, city, name, phone, state)
1649 VALUES (?, ?, ?, ?, ?)";
1650 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1651 '123-456-7890', 'Louisiana');
1653 These are then used directly in your DBI code:
1655 my $sth = $dbh->prepare($stmt);
1656 $sth->execute(@bind);
1658 =head2 Inserting and Updating Arrays
1660 If your database has array types (like for example Postgres),
1661 activate the special option C<< array_datatypes => 1 >>
1662 when creating the C<SQL::Abstract> object.
1663 Then you may use an arrayref to insert and update database array types:
1665 my $sql = SQL::Abstract->new(array_datatypes => 1);
1667 planets => [qw/Mercury Venus Earth Mars/]
1670 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1674 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1676 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1679 =head2 Inserting and Updating SQL
1681 In order to apply SQL functions to elements of your C<%data> you may
1682 specify a reference to an arrayref for the given hash value. For example,
1683 if you need to execute the Oracle C<to_date> function on a value, you can
1684 say something like this:
1688 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1691 The first value in the array is the actual SQL. Any other values are
1692 optional and would be included in the bind values array. This gives
1695 my($stmt, @bind) = $sql->insert('people', \%data);
1697 $stmt = "INSERT INTO people (name, date_entered)
1698 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1699 @bind = ('Bill', '03/02/2003');
1701 An UPDATE is just as easy, all you change is the name of the function:
1703 my($stmt, @bind) = $sql->update('people', \%data);
1705 Notice that your C<%data> isn't touched; the module will generate
1706 the appropriately quirky SQL for you automatically. Usually you'll
1707 want to specify a WHERE clause for your UPDATE, though, which is
1708 where handling C<%where> hashes comes in handy...
1710 =head2 Complex where statements
1712 This module can generate pretty complicated WHERE statements
1713 easily. For example, simple C<key=value> pairs are taken to mean
1714 equality, and if you want to see if a field is within a set
1715 of values, you can use an arrayref. Let's say we wanted to
1716 SELECT some data based on this criteria:
1719 requestor => 'inna',
1720 worker => ['nwiger', 'rcwe', 'sfz'],
1721 status => { '!=', 'completed' }
1724 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1726 The above would give you something like this:
1728 $stmt = "SELECT * FROM tickets WHERE
1729 ( requestor = ? ) AND ( status != ? )
1730 AND ( worker = ? OR worker = ? OR worker = ? )";
1731 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1733 Which you could then use in DBI code like so:
1735 my $sth = $dbh->prepare($stmt);
1736 $sth->execute(@bind);
1742 The methods are simple. There's one for every major SQL operation,
1743 and a constructor you use first. The arguments are specified in a
1744 similar order for each method (table, then fields, then a where
1745 clause) to try and simplify things.
1747 =head2 new(option => 'value')
1749 The C<new()> function takes a list of options and values, and returns
1750 a new B<SQL::Abstract> object which can then be used to generate SQL
1751 through the methods below. The options accepted are:
1757 If set to 'lower', then SQL will be generated in all lowercase. By
1758 default SQL is generated in "textbook" case meaning something like:
1760 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1762 Any setting other than 'lower' is ignored.
1766 This determines what the default comparison operator is. By default
1767 it is C<=>, meaning that a hash like this:
1769 %where = (name => 'nwiger', email => 'nate@wiger.org');
1771 Will generate SQL like this:
1773 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1775 However, you may want loose comparisons by default, so if you set
1776 C<cmp> to C<like> you would get SQL such as:
1778 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1780 You can also override the comparison on an individual basis - see
1781 the huge section on L</"WHERE CLAUSES"> at the bottom.
1783 =item sqltrue, sqlfalse
1785 Expressions for inserting boolean values within SQL statements.
1786 By default these are C<1=1> and C<1=0>. They are used
1787 by the special operators C<-in> and C<-not_in> for generating
1788 correct SQL even when the argument is an empty array (see below).
1792 This determines the default logical operator for multiple WHERE
1793 statements in arrays or hashes. If absent, the default logic is "or"
1794 for arrays, and "and" for hashes. This means that a WHERE
1798 event_date => {'>=', '2/13/99'},
1799 event_date => {'<=', '4/24/03'},
1802 will generate SQL like this:
1804 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1806 This is probably not what you want given this query, though (look
1807 at the dates). To change the "OR" to an "AND", simply specify:
1809 my $sql = SQL::Abstract->new(logic => 'and');
1811 Which will change the above C<WHERE> to:
1813 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1815 The logic can also be changed locally by inserting
1816 a modifier in front of an arrayref:
1818 @where = (-and => [event_date => {'>=', '2/13/99'},
1819 event_date => {'<=', '4/24/03'} ]);
1821 See the L</"WHERE CLAUSES"> section for explanations.
1825 This will automatically convert comparisons using the specified SQL
1826 function for both column and value. This is mostly used with an argument
1827 of C<upper> or C<lower>, so that the SQL will have the effect of
1828 case-insensitive "searches". For example, this:
1830 $sql = SQL::Abstract->new(convert => 'upper');
1831 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1833 Will turn out the following SQL:
1835 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1837 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1838 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1839 not validate this option; it will just pass through what you specify verbatim).
1843 This is a kludge because many databases suck. For example, you can't
1844 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1845 Instead, you have to use C<bind_param()>:
1847 $sth->bind_param(1, 'reg data');
1848 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1850 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1851 which loses track of which field each slot refers to. Fear not.
1853 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1854 Currently, you can specify either C<normal> (default) or C<columns>. If you
1855 specify C<columns>, you will get an array that looks like this:
1857 my $sql = SQL::Abstract->new(bindtype => 'columns');
1858 my($stmt, @bind) = $sql->insert(...);
1861 [ 'column1', 'value1' ],
1862 [ 'column2', 'value2' ],
1863 [ 'column3', 'value3' ],
1866 You can then iterate through this manually, using DBI's C<bind_param()>.
1868 $sth->prepare($stmt);
1871 my($col, $data) = @$_;
1872 if ($col eq 'details' || $col eq 'comments') {
1873 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1874 } elsif ($col eq 'image') {
1875 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1877 $sth->bind_param($i, $data);
1881 $sth->execute; # execute without @bind now
1883 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1884 Basically, the advantage is still that you don't have to care which fields
1885 are or are not included. You could wrap that above C<for> loop in a simple
1886 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1887 get a layer of abstraction over manual SQL specification.
1889 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1890 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1891 will expect the bind values in this format.
1895 This is the character that a table or column name will be quoted
1896 with. By default this is an empty string, but you could set it to
1897 the character C<`>, to generate SQL like this:
1899 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1901 Alternatively, you can supply an array ref of two items, the first being the left
1902 hand quote character, and the second the right hand quote character. For
1903 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1904 that generates SQL like this:
1906 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1908 Quoting is useful if you have tables or columns names that are reserved
1909 words in your database's SQL dialect.
1913 This is the character that will be used to escape L</quote_char>s appearing
1914 in an identifier before it has been quoted.
1916 The parameter default in case of a single L</quote_char> character is the quote
1919 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1920 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1921 of the B<opening (left)> L</quote_char> within the identifier are currently left
1922 untouched. The default for opening-closing-style quotes may change in future
1923 versions, thus you are B<strongly encouraged> to specify the escape character
1928 This is the character that separates a table and column name. It is
1929 necessary to specify this when the C<quote_char> option is selected,
1930 so that tables and column names can be individually quoted like this:
1932 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1934 =item injection_guard
1936 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1937 column name specified in a query structure. This is a safety mechanism to avoid
1938 injection attacks when mishandling user input e.g.:
1940 my %condition_as_column_value_pairs = get_values_from_user();
1941 $sqla->select( ... , \%condition_as_column_value_pairs );
1943 If the expression matches an exception is thrown. Note that literal SQL
1944 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1946 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1948 =item array_datatypes
1950 When this option is true, arrayrefs in INSERT or UPDATE are
1951 interpreted as array datatypes and are passed directly
1953 When this option is false, arrayrefs are interpreted
1954 as literal SQL, just like refs to arrayrefs
1955 (but this behavior is for backwards compatibility; when writing
1956 new queries, use the "reference to arrayref" syntax
1962 Takes a reference to a list of "special operators"
1963 to extend the syntax understood by L<SQL::Abstract>.
1964 See section L</"SPECIAL OPERATORS"> for details.
1968 Takes a reference to a list of "unary operators"
1969 to extend the syntax understood by L<SQL::Abstract>.
1970 See section L</"UNARY OPERATORS"> for details.
1976 =head2 insert($table, \@values || \%fieldvals, \%options)
1978 This is the simplest function. You simply give it a table name
1979 and either an arrayref of values or hashref of field/value pairs.
1980 It returns an SQL INSERT statement and a list of bind values.
1981 See the sections on L</"Inserting and Updating Arrays"> and
1982 L</"Inserting and Updating SQL"> for information on how to insert
1983 with those data types.
1985 The optional C<\%options> hash reference may contain additional
1986 options to generate the insert SQL. Currently supported options
1993 Takes either a scalar of raw SQL fields, or an array reference of
1994 field names, and adds on an SQL C<RETURNING> statement at the end.
1995 This allows you to return data generated by the insert statement
1996 (such as row IDs) without performing another C<SELECT> statement.
1997 Note, however, this is not part of the SQL standard and may not
1998 be supported by all database engines.
2002 =head2 update($table, \%fieldvals, \%where, \%options)
2004 This takes a table, hashref of field/value pairs, and an optional
2005 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2007 See the sections on L</"Inserting and Updating Arrays"> and
2008 L</"Inserting and Updating SQL"> for information on how to insert
2009 with those data types.
2011 The optional C<\%options> hash reference may contain additional
2012 options to generate the update SQL. Currently supported options
2019 See the C<returning> option to
2020 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2024 =head2 select($source, $fields, $where, $order)
2026 This returns a SQL SELECT statement and associated list of bind values, as
2027 specified by the arguments:
2033 Specification of the 'FROM' part of the statement.
2034 The argument can be either a plain scalar (interpreted as a table
2035 name, will be quoted), or an arrayref (interpreted as a list
2036 of table names, joined by commas, quoted), or a scalarref
2037 (literal SQL, not quoted).
2041 Specification of the list of fields to retrieve from
2043 The argument can be either an arrayref (interpreted as a list
2044 of field names, will be joined by commas and quoted), or a
2045 plain scalar (literal SQL, not quoted).
2046 Please observe that this API is not as flexible as that of
2047 the first argument C<$source>, for backwards compatibility reasons.
2051 Optional argument to specify the WHERE part of the query.
2052 The argument is most often a hashref, but can also be
2053 an arrayref or plain scalar --
2054 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2058 Optional argument to specify the ORDER BY part of the query.
2059 The argument can be a scalar, a hashref or an arrayref
2060 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2066 =head2 delete($table, \%where, \%options)
2068 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2069 It returns an SQL DELETE statement and list of bind values.
2071 The optional C<\%options> hash reference may contain additional
2072 options to generate the delete SQL. Currently supported options
2079 See the C<returning> option to
2080 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2084 =head2 where(\%where, $order)
2086 This is used to generate just the WHERE clause. For example,
2087 if you have an arbitrary data structure and know what the
2088 rest of your SQL is going to look like, but want an easy way
2089 to produce a WHERE clause, use this. It returns an SQL WHERE
2090 clause and list of bind values.
2093 =head2 values(\%data)
2095 This just returns the values from the hash C<%data>, in the same
2096 order that would be returned from any of the other above queries.
2097 Using this allows you to markedly speed up your queries if you
2098 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2100 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2102 Warning: This is an experimental method and subject to change.
2104 This returns arbitrarily generated SQL. It's a really basic shortcut.
2105 It will return two different things, depending on return context:
2107 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2108 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2110 These would return the following:
2112 # First calling form
2113 $stmt = "CREATE TABLE test (?, ?)";
2114 @bind = (field1, field2);
2116 # Second calling form
2117 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2119 Depending on what you're trying to do, it's up to you to choose the correct
2120 format. In this example, the second form is what you would want.
2124 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2128 ALTER SESSION SET nls_date_format = 'MM/YY'
2130 You get the idea. Strings get their case twiddled, but everything
2131 else remains verbatim.
2133 =head1 EXPORTABLE FUNCTIONS
2135 =head2 is_plain_value
2137 Determines if the supplied argument is a plain value as understood by this
2142 =item * The value is C<undef>
2144 =item * The value is a non-reference
2146 =item * The value is an object with stringification overloading
2148 =item * The value is of the form C<< { -value => $anything } >>
2152 On failure returns C<undef>, on success returns a B<scalar> reference
2153 to the original supplied argument.
2159 The stringification overloading detection is rather advanced: it takes
2160 into consideration not only the presence of a C<""> overload, but if that
2161 fails also checks for enabled
2162 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2163 on either C<0+> or C<bool>.
2165 Unfortunately testing in the field indicates that this
2166 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2167 but only when very large numbers of stringifying objects are involved.
2168 At the time of writing ( Sep 2014 ) there is no clear explanation of
2169 the direct cause, nor is there a manageably small test case that reliably
2170 reproduces the problem.
2172 If you encounter any of the following exceptions in B<random places within
2173 your application stack> - this module may be to blame:
2175 Operation "ne": no method found,
2176 left argument in overloaded package <something>,
2177 right argument in overloaded package <something>
2181 Stub found while resolving method "???" overloading """" in package <something>
2183 If you fall victim to the above - please attempt to reduce the problem
2184 to something that could be sent to the L<SQL::Abstract developers
2185 |DBIx::Class/GETTING HELP/SUPPORT>
2186 (either publicly or privately). As a workaround in the meantime you can
2187 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2188 value, which will most likely eliminate your problem (at the expense of
2189 not being able to properly detect exotic forms of stringification).
2191 This notice and environment variable will be removed in a future version,
2192 as soon as the underlying problem is found and a reliable workaround is
2197 =head2 is_literal_value
2199 Determines if the supplied argument is a literal value as understood by this
2204 =item * C<\$sql_string>
2206 =item * C<\[ $sql_string, @bind_values ]>
2210 On failure returns C<undef>, on success returns an B<array> reference
2211 containing the unpacked version of the supplied literal SQL and bind values.
2213 =head1 WHERE CLAUSES
2217 This module uses a variation on the idea from L<DBIx::Abstract>. It
2218 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2219 module is that things in arrays are OR'ed, and things in hashes
2222 The easiest way to explain is to show lots of examples. After
2223 each C<%where> hash shown, it is assumed you used:
2225 my($stmt, @bind) = $sql->where(\%where);
2227 However, note that the C<%where> hash can be used directly in any
2228 of the other functions as well, as described above.
2230 =head2 Key-value pairs
2232 So, let's get started. To begin, a simple hash:
2236 status => 'completed'
2239 Is converted to SQL C<key = val> statements:
2241 $stmt = "WHERE user = ? AND status = ?";
2242 @bind = ('nwiger', 'completed');
2244 One common thing I end up doing is having a list of values that
2245 a field can be in. To do this, simply specify a list inside of
2250 status => ['assigned', 'in-progress', 'pending'];
2253 This simple code will create the following:
2255 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2256 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2258 A field associated to an empty arrayref will be considered a
2259 logical false and will generate 0=1.
2261 =head2 Tests for NULL values
2263 If the value part is C<undef> then this is converted to SQL <IS NULL>
2272 $stmt = "WHERE user = ? AND status IS NULL";
2275 To test if a column IS NOT NULL:
2279 status => { '!=', undef },
2282 =head2 Specific comparison operators
2284 If you want to specify a different type of operator for your comparison,
2285 you can use a hashref for a given column:
2289 status => { '!=', 'completed' }
2292 Which would generate:
2294 $stmt = "WHERE user = ? AND status != ?";
2295 @bind = ('nwiger', 'completed');
2297 To test against multiple values, just enclose the values in an arrayref:
2299 status => { '=', ['assigned', 'in-progress', 'pending'] };
2301 Which would give you:
2303 "WHERE status = ? OR status = ? OR status = ?"
2306 The hashref can also contain multiple pairs, in which case it is expanded
2307 into an C<AND> of its elements:
2311 status => { '!=', 'completed', -not_like => 'pending%' }
2314 # Or more dynamically, like from a form
2315 $where{user} = 'nwiger';
2316 $where{status}{'!='} = 'completed';
2317 $where{status}{'-not_like'} = 'pending%';
2319 # Both generate this
2320 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2321 @bind = ('nwiger', 'completed', 'pending%');
2324 To get an OR instead, you can combine it with the arrayref idea:
2328 priority => [ { '=', 2 }, { '>', 5 } ]
2331 Which would generate:
2333 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2334 @bind = ('2', '5', 'nwiger');
2336 If you want to include literal SQL (with or without bind values), just use a
2337 scalar reference or reference to an arrayref as the value:
2340 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2341 date_expires => { '<' => \"now()" }
2344 Which would generate:
2346 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2347 @bind = ('11/26/2008');
2350 =head2 Logic and nesting operators
2352 In the example above,
2353 there is a subtle trap if you want to say something like
2354 this (notice the C<AND>):
2356 WHERE priority != ? AND priority != ?
2358 Because, in Perl you I<can't> do this:
2360 priority => { '!=' => 2, '!=' => 1 }
2362 As the second C<!=> key will obliterate the first. The solution
2363 is to use the special C<-modifier> form inside an arrayref:
2365 priority => [ -and => {'!=', 2},
2369 Normally, these would be joined by C<OR>, but the modifier tells it
2370 to use C<AND> instead. (Hint: You can use this in conjunction with the
2371 C<logic> option to C<new()> in order to change the way your queries
2372 work by default.) B<Important:> Note that the C<-modifier> goes
2373 B<INSIDE> the arrayref, as an extra first element. This will
2374 B<NOT> do what you think it might:
2376 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2378 Here is a quick list of equivalencies, since there is some overlap:
2381 status => {'!=', 'completed', 'not like', 'pending%' }
2382 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2385 status => {'=', ['assigned', 'in-progress']}
2386 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2387 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2391 =head2 Special operators: IN, BETWEEN, etc.
2393 You can also use the hashref format to compare a list of fields using the
2394 C<IN> comparison operator, by specifying the list as an arrayref:
2397 status => 'completed',
2398 reportid => { -in => [567, 2335, 2] }
2401 Which would generate:
2403 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2404 @bind = ('completed', '567', '2335', '2');
2406 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2409 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2410 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2411 'sqltrue' (by default: C<1=1>).
2413 In addition to the array you can supply a chunk of literal sql or
2414 literal sql with bind:
2417 customer => { -in => \[
2418 'SELECT cust_id FROM cust WHERE balance > ?',
2421 status => { -in => \'SELECT status_codes FROM states' },
2427 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2428 AND status IN ( SELECT status_codes FROM states )
2432 Finally, if the argument to C<-in> is not a reference, it will be
2433 treated as a single-element array.
2435 Another pair of operators is C<-between> and C<-not_between>,
2436 used with an arrayref of two values:
2440 completion_date => {
2441 -not_between => ['2002-10-01', '2003-02-06']
2447 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2449 Just like with C<-in> all plausible combinations of literal SQL
2453 start0 => { -between => [ 1, 2 ] },
2454 start1 => { -between => \["? AND ?", 1, 2] },
2455 start2 => { -between => \"lower(x) AND upper(y)" },
2456 start3 => { -between => [
2458 \["upper(?)", 'stuff' ],
2465 ( start0 BETWEEN ? AND ? )
2466 AND ( start1 BETWEEN ? AND ? )
2467 AND ( start2 BETWEEN lower(x) AND upper(y) )
2468 AND ( start3 BETWEEN lower(x) AND upper(?) )
2470 @bind = (1, 2, 1, 2, 'stuff');
2473 These are the two builtin "special operators"; but the
2474 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2476 =head2 Unary operators: bool
2478 If you wish to test against boolean columns or functions within your
2479 database you can use the C<-bool> and C<-not_bool> operators. For
2480 example to test the column C<is_user> being true and the column
2481 C<is_enabled> being false you would use:-
2485 -not_bool => 'is_enabled',
2490 WHERE is_user AND NOT is_enabled
2492 If a more complex combination is required, testing more conditions,
2493 then you should use the and/or operators:-
2498 -not_bool => { two=> { -rlike => 'bar' } },
2499 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2510 (NOT ( three = ? OR three > ? ))
2513 =head2 Nested conditions, -and/-or prefixes
2515 So far, we've seen how multiple conditions are joined with a top-level
2516 C<AND>. We can change this by putting the different conditions we want in
2517 hashes and then putting those hashes in an array. For example:
2522 status => { -like => ['pending%', 'dispatched'] },
2526 status => 'unassigned',
2530 This data structure would create the following:
2532 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2533 OR ( user = ? AND status = ? ) )";
2534 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2537 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2538 to change the logic inside:
2544 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2545 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2552 $stmt = "WHERE ( user = ?
2553 AND ( ( workhrs > ? AND geo = ? )
2554 OR ( workhrs < ? OR geo = ? ) ) )";
2555 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2557 =head3 Algebraic inconsistency, for historical reasons
2559 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2560 operator goes C<outside> of the nested structure; whereas when connecting
2561 several constraints on one column, the C<-and> operator goes
2562 C<inside> the arrayref. Here is an example combining both features:
2565 -and => [a => 1, b => 2],
2566 -or => [c => 3, d => 4],
2567 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2572 WHERE ( ( ( a = ? AND b = ? )
2573 OR ( c = ? OR d = ? )
2574 OR ( e LIKE ? AND e LIKE ? ) ) )
2576 This difference in syntax is unfortunate but must be preserved for
2577 historical reasons. So be careful: the two examples below would
2578 seem algebraically equivalent, but they are not
2581 { -like => 'foo%' },
2582 { -like => '%bar' },
2584 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2587 { col => { -like => 'foo%' } },
2588 { col => { -like => '%bar' } },
2590 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2593 =head2 Literal SQL and value type operators
2595 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2596 side" is a column name and the "right side" is a value (normally rendered as
2597 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2598 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2599 alter this behavior. There are several ways of doing so.
2603 This is a virtual operator that signals the string to its right side is an
2604 identifier (a column name) and not a value. For example to compare two
2605 columns you would write:
2608 priority => { '<', 2 },
2609 requestor => { -ident => 'submitter' },
2614 $stmt = "WHERE priority < ? AND requestor = submitter";
2617 If you are maintaining legacy code you may see a different construct as
2618 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2623 This is a virtual operator that signals that the construct to its right side
2624 is a value to be passed to DBI. This is for example necessary when you want
2625 to write a where clause against an array (for RDBMS that support such
2626 datatypes). For example:
2629 array => { -value => [1, 2, 3] }
2634 $stmt = 'WHERE array = ?';
2635 @bind = ([1, 2, 3]);
2637 Note that if you were to simply say:
2643 the result would probably not be what you wanted:
2645 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2650 Finally, sometimes only literal SQL will do. To include a random snippet
2651 of SQL verbatim, you specify it as a scalar reference. Consider this only
2652 as a last resort. Usually there is a better way. For example:
2655 priority => { '<', 2 },
2656 requestor => { -in => \'(SELECT name FROM hitmen)' },
2661 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2664 Note that in this example, you only get one bind parameter back, since
2665 the verbatim SQL is passed as part of the statement.
2669 Never use untrusted input as a literal SQL argument - this is a massive
2670 security risk (there is no way to check literal snippets for SQL
2671 injections and other nastyness). If you need to deal with untrusted input
2672 use literal SQL with placeholders as described next.
2674 =head3 Literal SQL with placeholders and bind values (subqueries)
2676 If the literal SQL to be inserted has placeholders and bind values,
2677 use a reference to an arrayref (yes this is a double reference --
2678 not so common, but perfectly legal Perl). For example, to find a date
2679 in Postgres you can use something like this:
2682 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2687 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2690 Note that you must pass the bind values in the same format as they are returned
2691 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2692 to C<columns>, you must provide the bind values in the
2693 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2694 scalar value; most commonly the column name, but you can use any scalar value
2695 (including references and blessed references), L<SQL::Abstract> will simply
2696 pass it through intact. So if C<bindtype> is set to C<columns> the above
2697 example will look like:
2700 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2703 Literal SQL is especially useful for nesting parenthesized clauses in the
2704 main SQL query. Here is a first example:
2706 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2710 bar => \["IN ($sub_stmt)" => @sub_bind],
2715 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2716 WHERE c2 < ? AND c3 LIKE ?))";
2717 @bind = (1234, 100, "foo%");
2719 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2720 are expressed in the same way. Of course the C<$sub_stmt> and
2721 its associated bind values can be generated through a former call
2724 my ($sub_stmt, @sub_bind)
2725 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2726 c3 => {-like => "foo%"}});
2729 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2732 In the examples above, the subquery was used as an operator on a column;
2733 but the same principle also applies for a clause within the main C<%where>
2734 hash, like an EXISTS subquery:
2736 my ($sub_stmt, @sub_bind)
2737 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2738 my %where = ( -and => [
2740 \["EXISTS ($sub_stmt)" => @sub_bind],
2745 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2746 WHERE c1 = ? AND c2 > t0.c0))";
2750 Observe that the condition on C<c2> in the subquery refers to
2751 column C<t0.c0> of the main query: this is I<not> a bind
2752 value, so we have to express it through a scalar ref.
2753 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2754 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2755 what we wanted here.
2757 Finally, here is an example where a subquery is used
2758 for expressing unary negation:
2760 my ($sub_stmt, @sub_bind)
2761 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2762 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2764 lname => {like => '%son%'},
2765 \["NOT ($sub_stmt)" => @sub_bind],
2770 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2771 @bind = ('%son%', 10, 20)
2773 =head3 Deprecated usage of Literal SQL
2775 Below are some examples of archaic use of literal SQL. It is shown only as
2776 reference for those who deal with legacy code. Each example has a much
2777 better, cleaner and safer alternative that users should opt for in new code.
2783 my %where = ( requestor => \'IS NOT NULL' )
2785 $stmt = "WHERE requestor IS NOT NULL"
2787 This used to be the way of generating NULL comparisons, before the handling
2788 of C<undef> got formalized. For new code please use the superior syntax as
2789 described in L</Tests for NULL values>.
2793 my %where = ( requestor => \'= submitter' )
2795 $stmt = "WHERE requestor = submitter"
2797 This used to be the only way to compare columns. Use the superior L</-ident>
2798 method for all new code. For example an identifier declared in such a way
2799 will be properly quoted if L</quote_char> is properly set, while the legacy
2800 form will remain as supplied.
2804 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2806 $stmt = "WHERE completed > ? AND is_ready"
2807 @bind = ('2012-12-21')
2809 Using an empty string literal used to be the only way to express a boolean.
2810 For all new code please use the much more readable
2811 L<-bool|/Unary operators: bool> operator.
2817 These pages could go on for a while, since the nesting of the data
2818 structures this module can handle are pretty much unlimited (the
2819 module implements the C<WHERE> expansion as a recursive function
2820 internally). Your best bet is to "play around" with the module a
2821 little to see how the data structures behave, and choose the best
2822 format for your data based on that.
2824 And of course, all the values above will probably be replaced with
2825 variables gotten from forms or the command line. After all, if you
2826 knew everything ahead of time, you wouldn't have to worry about
2827 dynamically-generating SQL and could just hardwire it into your
2830 =head1 ORDER BY CLAUSES
2832 Some functions take an order by clause. This can either be a scalar (just a
2833 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2834 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2837 Given | Will Generate
2838 ---------------------------------------------------------------
2840 'colA' | ORDER BY colA
2842 [qw/colA colB/] | ORDER BY colA, colB
2844 {-asc => 'colA'} | ORDER BY colA ASC
2846 {-desc => 'colB'} | ORDER BY colB DESC
2848 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2850 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2852 \'colA DESC' | ORDER BY colA DESC
2854 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2855 | /* ...with $x bound to ? */
2858 { -asc => 'colA' }, | colA ASC,
2859 { -desc => [qw/colB/] }, | colB DESC,
2860 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2861 \'colE DESC', | colE DESC,
2862 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2863 ] | /* ...with $x bound to ? */
2864 ===============================================================
2868 =head1 SPECIAL OPERATORS
2870 my $sqlmaker = SQL::Abstract->new(special_ops => [
2874 my ($self, $field, $op, $arg) = @_;
2880 handler => 'method_name',
2884 A "special operator" is a SQL syntactic clause that can be
2885 applied to a field, instead of a usual binary operator.
2888 WHERE field IN (?, ?, ?)
2889 WHERE field BETWEEN ? AND ?
2890 WHERE MATCH(field) AGAINST (?, ?)
2892 Special operators IN and BETWEEN are fairly standard and therefore
2893 are builtin within C<SQL::Abstract> (as the overridable methods
2894 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2895 like the MATCH .. AGAINST example above which is specific to MySQL,
2896 you can write your own operator handlers - supply a C<special_ops>
2897 argument to the C<new> method. That argument takes an arrayref of
2898 operator definitions; each operator definition is a hashref with two
2905 the regular expression to match the operator
2909 Either a coderef or a plain scalar method name. In both cases
2910 the expected return is C<< ($sql, @bind) >>.
2912 When supplied with a method name, it is simply called on the
2913 L<SQL::Abstract> object as:
2915 $self->$method_name($field, $op, $arg)
2919 $field is the LHS of the operator
2920 $op is the part that matched the handler regex
2923 When supplied with a coderef, it is called as:
2925 $coderef->($self, $field, $op, $arg)
2930 For example, here is an implementation
2931 of the MATCH .. AGAINST syntax for MySQL
2933 my $sqlmaker = SQL::Abstract->new(special_ops => [
2935 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2936 {regex => qr/^match$/i,
2938 my ($self, $field, $op, $arg) = @_;
2939 $arg = [$arg] if not ref $arg;
2940 my $label = $self->_quote($field);
2941 my ($placeholder) = $self->_convert('?');
2942 my $placeholders = join ", ", (($placeholder) x @$arg);
2943 my $sql = $self->_sqlcase('match') . " ($label) "
2944 . $self->_sqlcase('against') . " ($placeholders) ";
2945 my @bind = $self->_bindtype($field, @$arg);
2946 return ($sql, @bind);
2953 =head1 UNARY OPERATORS
2955 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2959 my ($self, $op, $arg) = @_;
2965 handler => 'method_name',
2969 A "unary operator" is a SQL syntactic clause that can be
2970 applied to a field - the operator goes before the field
2972 You can write your own operator handlers - supply a C<unary_ops>
2973 argument to the C<new> method. That argument takes an arrayref of
2974 operator definitions; each operator definition is a hashref with two
2981 the regular expression to match the operator
2985 Either a coderef or a plain scalar method name. In both cases
2986 the expected return is C<< $sql >>.
2988 When supplied with a method name, it is simply called on the
2989 L<SQL::Abstract> object as:
2991 $self->$method_name($op, $arg)
2995 $op is the part that matched the handler regex
2996 $arg is the RHS or argument of the operator
2998 When supplied with a coderef, it is called as:
3000 $coderef->($self, $op, $arg)
3008 Thanks to some benchmarking by Mark Stosberg, it turns out that
3009 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3010 I must admit this wasn't an intentional design issue, but it's a
3011 byproduct of the fact that you get to control your C<DBI> handles
3014 To maximize performance, use a code snippet like the following:
3016 # prepare a statement handle using the first row
3017 # and then reuse it for the rest of the rows
3019 for my $href (@array_of_hashrefs) {
3020 $stmt ||= $sql->insert('table', $href);
3021 $sth ||= $dbh->prepare($stmt);
3022 $sth->execute($sql->values($href));
3025 The reason this works is because the keys in your C<$href> are sorted
3026 internally by B<SQL::Abstract>. Thus, as long as your data retains
3027 the same structure, you only have to generate the SQL the first time
3028 around. On subsequent queries, simply use the C<values> function provided
3029 by this module to return your values in the correct order.
3031 However this depends on the values having the same type - if, for
3032 example, the values of a where clause may either have values
3033 (resulting in sql of the form C<column = ?> with a single bind
3034 value), or alternatively the values might be C<undef> (resulting in
3035 sql of the form C<column IS NULL> with no bind value) then the
3036 caching technique suggested will not work.
3040 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3041 really like this part (I do, at least). Building up a complex query
3042 can be as simple as the following:
3049 use CGI::FormBuilder;
3052 my $form = CGI::FormBuilder->new(...);
3053 my $sql = SQL::Abstract->new;
3055 if ($form->submitted) {
3056 my $field = $form->field;
3057 my $id = delete $field->{id};
3058 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3061 Of course, you would still have to connect using C<DBI> to run the
3062 query, but the point is that if you make your form look like your
3063 table, the actual query script can be extremely simplistic.
3065 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3066 a fast interface to returning and formatting data. I frequently
3067 use these three modules together to write complex database query
3068 apps in under 50 lines.
3070 =head1 HOW TO CONTRIBUTE
3072 Contributions are always welcome, in all usable forms (we especially
3073 welcome documentation improvements). The delivery methods include git-
3074 or unified-diff formatted patches, GitHub pull requests, or plain bug
3075 reports either via RT or the Mailing list. Contributors are generally
3076 granted full access to the official repository after their first several
3077 patches pass successful review.
3079 This project is maintained in a git repository. The code and related tools are
3080 accessible at the following locations:
3084 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3086 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3088 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3090 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3096 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3097 Great care has been taken to preserve the I<published> behavior
3098 documented in previous versions in the 1.* family; however,
3099 some features that were previously undocumented, or behaved
3100 differently from the documentation, had to be changed in order
3101 to clarify the semantics. Hence, client code that was relying
3102 on some dark areas of C<SQL::Abstract> v1.*
3103 B<might behave differently> in v1.50.
3105 The main changes are:
3111 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3115 support for the { operator => \"..." } construct (to embed literal SQL)
3119 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3123 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3127 defensive programming: check arguments
3131 fixed bug with global logic, which was previously implemented
3132 through global variables yielding side-effects. Prior versions would
3133 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3134 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3135 Now this is interpreted
3136 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3141 fixed semantics of _bindtype on array args
3145 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3146 we just avoid shifting arrays within that tree.
3150 dropped the C<_modlogic> function
3154 =head1 ACKNOWLEDGEMENTS
3156 There are a number of individuals that have really helped out with
3157 this module. Unfortunately, most of them submitted bugs via CPAN
3158 so I have no idea who they are! But the people I do know are:
3160 Ash Berlin (order_by hash term support)
3161 Matt Trout (DBIx::Class support)
3162 Mark Stosberg (benchmarking)
3163 Chas Owens (initial "IN" operator support)
3164 Philip Collins (per-field SQL functions)
3165 Eric Kolve (hashref "AND" support)
3166 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3167 Dan Kubb (support for "quote_char" and "name_sep")
3168 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3169 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3170 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3171 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3172 Oliver Charles (support for "RETURNING" after "INSERT")
3178 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3182 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3184 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3186 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3187 While not an official support venue, C<DBIx::Class> makes heavy use of
3188 C<SQL::Abstract>, and as such list members there are very familiar with
3189 how to create queries.
3193 This module is free software; you may copy this under the same
3194 terms as perl itself (either the GNU General Public License or
3195 the Artistic License)