1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.87';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{special_ops} ||= [];
160 # regexes are applied in order, thus push after user-defines
161 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 if ($class->isa('DBIx::Class::SQLMaker')) {
164 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
165 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
167 $opt{is_dbic_sqlmaker} = 1;
171 $opt{unary_ops} ||= [];
173 # rudimentary sanity-check for user supplied bits treated as functions/operators
174 # If a purported function matches this regular expression, an exception is thrown.
175 # Literal SQL is *NOT* subject to this check, only functions (and column names
176 # when quoting is not in effect)
179 # need to guard against ()'s in column names too, but this will break tons of
180 # hacks... ideas anyone?
181 $opt{injection_guard} ||= qr/
187 $opt{expand_unary} = {};
190 -ident => '_expand_ident',
191 -value => '_expand_value',
192 -not => '_expand_not',
193 -bool => '_expand_bool',
194 -and => '_expand_andor',
195 -or => '_expand_andor',
199 'between' => '_expand_between',
200 'not between' => '_expand_between',
201 'in' => '_expand_in',
202 'not in' => '_expand_in',
206 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
210 $opt{render_op} = our $RENDER_OP;
212 return bless \%opt, $class;
215 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
216 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
218 sub _assert_pass_injection_guard {
219 if ($_[1] =~ $_[0]->{injection_guard}) {
220 my $class = ref $_[0];
221 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
222 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
223 . "{injection_guard} attribute to ${class}->new()"
228 #======================================================================
230 #======================================================================
234 my $table = $self->_table(shift);
235 my $data = shift || return;
238 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
239 my ($sql, @bind) = $self->$method($data);
240 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
242 if ($options->{returning}) {
243 my ($s, @b) = $self->_insert_returning($options);
248 return wantarray ? ($sql, @bind) : $sql;
251 # So that subclasses can override INSERT ... RETURNING separately from
252 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
253 sub _insert_returning { shift->_returning(@_) }
256 my ($self, $options) = @_;
258 my $f = $options->{returning};
260 my ($sql, @bind) = $self->render_aqt(
261 $self->_expand_maybe_list_expr($f, undef, -ident)
264 ? $self->_sqlcase(' returning ') . $sql
265 : ($self->_sqlcase(' returning ').$sql, @bind);
268 sub _insert_HASHREF { # explicit list of fields and then values
269 my ($self, $data) = @_;
271 my @fields = sort keys %$data;
273 my ($sql, @bind) = $self->_insert_values($data);
276 $_ = $self->_quote($_) foreach @fields;
277 $sql = "( ".join(", ", @fields).") ".$sql;
279 return ($sql, @bind);
282 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
283 my ($self, $data) = @_;
285 # no names (arrayref) so can't generate bindtype
286 $self->{bindtype} ne 'columns'
287 or belch "can't do 'columns' bindtype when called with arrayref";
289 my (@values, @all_bind);
290 foreach my $value (@$data) {
291 my ($values, @bind) = $self->_insert_value(undef, $value);
292 push @values, $values;
293 push @all_bind, @bind;
295 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
296 return ($sql, @all_bind);
299 sub _insert_ARRAYREFREF { # literal SQL with bind
300 my ($self, $data) = @_;
302 my ($sql, @bind) = @${$data};
303 $self->_assert_bindval_matches_bindtype(@bind);
305 return ($sql, @bind);
309 sub _insert_SCALARREF { # literal SQL without bind
310 my ($self, $data) = @_;
316 my ($self, $data) = @_;
318 my (@values, @all_bind);
319 foreach my $column (sort keys %$data) {
320 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
321 push @values, $values;
322 push @all_bind, @bind;
324 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
325 return ($sql, @all_bind);
329 my ($self, $column, $v) = @_;
331 return $self->render_aqt(
332 $self->_expand_insert_value($column, $v)
336 sub _expand_insert_value {
337 my ($self, $column, $v) = @_;
339 if (ref($v) eq 'ARRAY') {
340 if ($self->{array_datatypes}) {
341 return +{ -bind => [ $column, $v ] };
343 my ($sql, @bind) = @$v;
344 $self->_assert_bindval_matches_bindtype(@bind);
345 return +{ -literal => $v };
347 if (ref($v) eq 'HASH') {
348 if (grep !/^-/, keys %$v) {
349 belch "HASH ref as bind value in insert is not supported";
350 return +{ -bind => [ $column, $v ] };
354 return +{ -bind => [ $column, undef ] };
356 local our $Cur_Col_Meta = $column;
357 return $self->expand_expr($v);
362 #======================================================================
364 #======================================================================
369 my $table = $self->_table(shift);
370 my $data = shift || return;
374 # first build the 'SET' part of the sql statement
375 puke "Unsupported data type specified to \$sql->update"
376 unless ref $data eq 'HASH';
378 my ($sql, @all_bind) = $self->_update_set_values($data);
379 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
383 my($where_sql, @where_bind) = $self->where($where);
385 push @all_bind, @where_bind;
388 if ($options->{returning}) {
389 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
390 $sql .= $returning_sql;
391 push @all_bind, @returning_bind;
394 return wantarray ? ($sql, @all_bind) : $sql;
397 sub _update_set_values {
398 my ($self, $data) = @_;
400 return $self->render_aqt(
401 $self->_expand_update_set_values($data),
405 sub _expand_update_set_values {
406 my ($self, $data) = @_;
407 $self->_expand_maybe_list_expr( [
410 $set = { -bind => $_ } unless defined $set;
411 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
417 ? ($self->{array_datatypes}
418 ? [ $k, +{ -bind => [ $k, $v ] } ]
419 : [ $k, +{ -literal => $v } ])
421 local our $Cur_Col_Meta = $k;
422 [ $k, $self->_expand_expr($v) ]
429 # So that subclasses can override UPDATE ... RETURNING separately from
431 sub _update_returning { shift->_returning(@_) }
435 #======================================================================
437 #======================================================================
442 my $table = $self->_table(shift);
443 my $fields = shift || '*';
447 my ($fields_sql, @bind) = $self->_select_fields($fields);
449 my ($where_sql, @where_bind) = $self->where($where, $order);
450 push @bind, @where_bind;
452 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
453 $self->_sqlcase('from'), $table)
456 return wantarray ? ($sql, @bind) : $sql;
460 my ($self, $fields) = @_;
461 return $fields unless ref($fields);
462 return $self->render_aqt(
463 $self->_expand_maybe_list_expr($fields, undef, '-ident')
467 #======================================================================
469 #======================================================================
474 my $table = $self->_table(shift);
478 my($where_sql, @bind) = $self->where($where);
479 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
481 if ($options->{returning}) {
482 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
483 $sql .= $returning_sql;
484 push @bind, @returning_bind;
487 return wantarray ? ($sql, @bind) : $sql;
490 # So that subclasses can override DELETE ... RETURNING separately from
492 sub _delete_returning { shift->_returning(@_) }
496 #======================================================================
498 #======================================================================
502 # Finally, a separate routine just to handle WHERE clauses
504 my ($self, $where, $order) = @_;
506 local $self->{convert_where} = $self->{convert};
509 my ($sql, @bind) = defined($where)
510 ? $self->_recurse_where($where)
512 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
516 my ($order_sql, @order_bind) = $self->_order_by($order);
518 push @bind, @order_bind;
521 return wantarray ? ($sql, @bind) : $sql;
525 my ($self, $expr, $default_scalar_to) = @_;
526 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
527 $self->_expand_expr($expr);
531 my ($self, $aqt) = @_;
532 my ($k, $v, @rest) = %$aqt;
534 if (my $meth = $self->{render}{$k}) {
535 return $self->$meth($v);
537 die "notreached: $k";
541 my ($self, $expr) = @_;
542 $self->render_aqt($self->expand_expr($expr));
546 my ($self, $expr, $logic) = @_;
547 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
548 return undef unless defined($expr);
549 if (ref($expr) eq 'HASH') {
550 return undef unless my $kc = keys %$expr;
553 return $self->_expand_andor("-${logic}", $expr);
555 my ($key, $value) = %$expr;
556 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
557 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
558 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
560 if (my $exp = $self->{expand}{$key}) {
561 return $self->$exp($key, $value);
563 return $self->_expand_expr_hashpair($key, $value, $logic);
565 if (ref($expr) eq 'ARRAY') {
566 my $logic = lc($logic || $self->{logic});
567 return $self->_expand_andor("-${logic}", $expr);
569 if (my $literal = is_literal_value($expr)) {
570 return +{ -literal => $literal };
572 if (!ref($expr) or Scalar::Util::blessed($expr)) {
573 if (my $d = our $Default_Scalar_To) {
574 return $self->_expand_expr({ $d => $expr });
576 return $self->_expand_value(-value => $expr);
581 sub _expand_expr_hashpair {
582 my ($self, $k, $v, $logic) = @_;
583 unless (defined($k) and length($k)) {
584 if (defined($k) and my $literal = is_literal_value($v)) {
585 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
586 return { -literal => $literal };
588 puke "Supplying an empty left hand side argument is not supported";
591 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
593 # DBIx::Class requires a nest warning to be emitted once but the private
594 # method it overrode to do so no longer exists
595 if ($self->{is_dbic_sqlmaker}) {
596 unless (our $Nest_Warned) {
598 "-nest in search conditions is deprecated, you most probably wanted:\n"
599 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
604 return $self->_expand_expr($v);
606 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
609 $self->_expand_expr({ "-${rest}", $v }, $logic)
614 $op =~ s/^-// if length($op) > 1;
616 # top level special ops are illegal in general
617 # note that, arguably, if it makes no sense at top level, it also
618 # makes no sense on the other side of an = sign or similar but DBIC
619 # gets disappointingly upset if I disallow it
621 (our $Expand_Depth) == 1
622 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
624 puke "Illegal use of top-level '-$op'"
626 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
627 return { -op => [ $op, $v ] };
630 if ($self->{render}{$k}) {
636 and (keys %$v)[0] =~ /^-/
638 my ($func) = $k =~ /^-(.*)$/;
639 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
640 return +{ -op => [ $func, $self->_expand_expr($v) ] };
642 return +{ -func => [ $func, $self->_expand_expr($v) ] };
644 if (!ref($v) or is_literal_value($v)) {
645 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
652 and exists $v->{-value}
653 and not defined $v->{-value}
656 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
658 if (!ref($v) or Scalar::Util::blessed($v)) {
659 my $d = our $Default_Scalar_To;
663 $self->_expand_ident(-ident => $k),
665 ? $self->_expand_expr($d => $v)
666 : { -bind => [ $k, $v ] }
671 if (ref($v) eq 'HASH') {
675 map $self->_expand_expr({ $k => { $_ => $v->{$_} } }),
679 return undef unless keys %$v;
681 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
682 $self->_assert_pass_injection_guard($op);
683 if ($op =~ s/ [_\s]? \d+ $//x ) {
684 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
685 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
687 if (my $x = $self->{expand_op}{$op}) {
688 return $self->$x($op, $vv, $k);
690 if ($op eq 'ident') {
691 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
692 puke "-$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
696 $self->_expand_ident(-ident => $k),
697 $self->_expand_ident(-ident => $vv),
700 if ($op eq 'value') {
701 return $self->_expand_expr({ $k, undef }) unless defined($vv);
704 $self->_expand_ident(-ident => $k),
705 { -bind => [ $k, $vv ] }
708 if ($op =~ /^is(?: not)?$/) {
709 puke "$op can only take undef as argument"
713 and exists($vv->{-value})
714 and !defined($vv->{-value})
716 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
718 if ($op =~ /^(and|or)$/) {
719 if (ref($vv) eq 'HASH') {
722 map $self->_expand_expr({ $k, { $_ => $vv->{$_} } }),
727 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
728 return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
730 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
733 $self->_expand_ident(-ident => $k),
734 { -op => [ $op, $vv ] }
737 if (ref($vv) eq 'ARRAY') {
738 my ($logic, @values) = (
739 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
744 $op =~ $self->{inequality_op}
745 or $op =~ $self->{not_like_op}
747 if (lc($logic) eq '-or' and @values > 1) {
748 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
749 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
750 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
755 # try to DWIM on equality operators
757 $op =~ $self->{equality_op} ? $self->sqlfalse
758 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
759 : $op =~ $self->{inequality_op} ? $self->sqltrue
760 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
761 : puke "operator '$op' applied on an empty array (field '$k')";
765 map $self->_expand_expr({ $k => { $vk => $_ } }),
773 and exists $vv->{-value}
774 and not defined $vv->{-value}
778 $op =~ /^not$/i ? 'is not' # legacy
779 : $op =~ $self->{equality_op} ? 'is'
780 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
781 : $op =~ $self->{inequality_op} ? 'is not'
782 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
783 : puke "unexpected operator '$op' with undef operand";
784 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
786 local our $Cur_Col_Meta = $k;
789 $self->_expand_ident(-ident => $k),
790 $self->_expand_expr($vv)
793 if (ref($v) eq 'ARRAY') {
794 return $self->sqlfalse unless @$v;
795 $self->_debug("ARRAY($k) means distribute over elements");
797 $v->[0] =~ /^-(and|or)$/i
798 ? shift(@{$v = [ @$v ]})
799 : '-'.($self->{logic} || 'or')
801 return $self->_expand_expr({
802 $this_logic => [ map +{ $k => $_ }, @$v ]
805 if (my $literal = is_literal_value($v)) {
807 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
810 my ($sql, @bind) = @$literal;
811 if ($self->{bindtype} eq 'columns') {
813 $self->_assert_bindval_matches_bindtype($_);
816 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
822 my ($self, undef, $body) = @_;
823 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
824 ref($body) ? @$body : $body;
825 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
826 unless ($self->{quote_char}) {
827 $self->_assert_pass_injection_guard($_) for @parts;
829 return +{ -ident => \@parts };
833 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
837 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
841 my ($self, undef, $v) = @_;
843 return $self->_expand_expr($v);
845 puke "-bool => undef not supported" unless defined($v);
846 return $self->_expand_ident(-ident => $v);
850 my ($self, $k, $v) = @_;
851 my ($logic) = $k =~ /^-(.*)$/;
852 if (ref($v) eq 'HASH') {
855 map $self->_expand_expr({ $_ => $v->{$_} }, $logic),
859 if (ref($v) eq 'ARRAY') {
860 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
863 (ref($_) eq 'ARRAY' and @$_)
864 or (ref($_) eq 'HASH' and %$_)
870 while (my ($el) = splice @expr, 0, 1) {
871 puke "Supplying an empty left hand side argument is not supported in array-pairs"
872 unless defined($el) and length($el);
873 my $elref = ref($el);
875 local our $Expand_Depth = 0;
876 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
877 } elsif ($elref eq 'ARRAY') {
878 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
879 } elsif (my $l = is_literal_value($el)) {
880 push @res, { -literal => $l };
881 } elsif ($elref eq 'HASH') {
882 local our $Expand_Depth = 0;
883 push @res, grep defined, $self->_expand_expr($el) if %$el;
889 # return $res[0] if @res == 1;
890 return { -op => [ $logic, @res ] };
895 sub _expand_between {
896 my ($self, $op, $vv, $k) = @_;
897 local our $Cur_Col_Meta = $k;
898 my @rhs = map $self->_expand_expr($_),
899 ref($vv) eq 'ARRAY' ? @$vv : $vv;
901 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
903 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
905 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
909 $self->_expand_ident(-ident => $k),
915 my ($self, $op, $vv, $k) = @_;
916 if (my $literal = is_literal_value($vv)) {
917 my ($sql, @bind) = @$literal;
918 my $opened_sql = $self->_open_outer_paren($sql);
920 $op, $self->_expand_ident(-ident => $k),
921 [ { -literal => [ $opened_sql, @bind ] } ]
925 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
926 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
927 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
928 . 'will emit the logically correct SQL instead of raising this exception)'
930 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
932 my @rhs = map $self->_expand_expr($_),
933 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
934 map { defined($_) ? $_: puke($undef_err) }
935 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
936 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
940 $self->_expand_ident(-ident => $k),
946 my ($self, $where, $logic) = @_;
948 # Special case: top level simple string treated as literal
950 my $where_exp = (ref($where)
951 ? $self->_expand_expr($where, $logic)
952 : { -literal => [ $where ] });
954 # dispatch expanded expression
956 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
957 # DBIx::Class used to call _recurse_where in scalar context
958 # something else might too...
960 return ($sql, @bind);
963 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
969 my ($self, $ident) = @_;
971 return $self->_convert($self->_quote($ident));
975 my ($self, $list) = @_;
976 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
977 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
981 my ($self, $rest) = @_;
982 my ($func, @args) = @$rest;
986 push @arg_sql, shift @x;
988 } map [ $self->render_aqt($_) ], @args;
989 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
993 my ($self, $bind) = @_;
994 return ($self->_convert('?'), $self->_bindtype(@$bind));
997 sub _render_literal {
998 my ($self, $literal) = @_;
999 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1005 my ($self, $op, $args) = @_;
1006 my ($left, $low, $high) = @$args;
1007 my ($rhsql, @rhbind) = do {
1009 puke "Single arg to between must be a literal"
1010 unless $low->{-literal};
1013 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1014 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1015 @{$l}[1..$#$l], @{$h}[1..$#$h])
1018 my ($lhsql, @lhbind) = $self->render_aqt($left);
1020 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1023 }), 'between', 'not between'),
1025 my ($self, $op, $args) = @_;
1026 my ($lhs, $rhs) = @$args;
1029 my ($sql, @bind) = $self->render_aqt($_);
1030 push @in_bind, @bind;
1033 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1035 $lhsql.' '.$self->_sqlcase($op).' ( '
1036 .join(', ', @in_sql)
1040 }), 'in', 'not in'),
1041 (map +($_ => '_render_unop_postfix'),
1042 'is null', 'is not null', 'asc', 'desc',
1044 (not => '_render_op_not'),
1046 my ($self, $op, $args) = @_;
1047 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1048 return '' unless @parts;
1049 return @{$parts[0]} if @parts == 1;
1050 my ($final_sql) = join(
1051 ' '.$self->_sqlcase($op).' ',
1056 map @{$_}[1..$#$_], @parts
1062 my ($self, $v) = @_;
1063 my ($op, @args) = @$v;
1064 if (my $r = $self->{render_op}{$op}) {
1065 return $self->$r($op, \@args);
1067 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1068 if ($us and @args > 1) {
1069 puke "Special op '${op}' requires first value to be identifier"
1070 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1071 my $k = join(($self->{name_sep}||'.'), @$ident);
1072 local our $Expand_Depth = 1;
1073 return $self->${\($us->{handler})}($k, $op, $args[1]);
1075 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1076 return $self->${\($us->{handler})}($op, $args[0]);
1079 return $self->_render_unop_prefix($op, \@args);
1081 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1082 return '' unless @parts;
1083 my ($final_sql) = join(
1084 ' '.$self->_sqlcase($op).' ',
1089 map @{$_}[1..$#$_], @parts
1095 sub _render_op_not {
1096 my ($self, $op, $v) = @_;
1097 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1098 return "(${sql})", @bind;
1101 sub _render_unop_prefix {
1102 my ($self, $op, $v) = @_;
1103 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1104 my $op_sql = $self->_sqlcase($op);
1105 return ("${op_sql} ${expr_sql}", @bind);
1108 sub _render_unop_postfix {
1109 my ($self, $op, $v) = @_;
1110 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1111 my $op_sql = $self->_sqlcase($op);
1112 return ($expr_sql.' '.$op_sql, @bind);
1115 # Some databases (SQLite) treat col IN (1, 2) different from
1116 # col IN ( (1, 2) ). Use this to strip all outer parens while
1117 # adding them back in the corresponding method
1118 sub _open_outer_paren {
1119 my ($self, $sql) = @_;
1121 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1123 # there are closing parens inside, need the heavy duty machinery
1124 # to reevaluate the extraction starting from $sql (full reevaluation)
1125 if ($inner =~ /\)/) {
1126 require Text::Balanced;
1128 my (undef, $remainder) = do {
1129 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1131 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1134 # the entire expression needs to be a balanced bracketed thing
1135 # (after an extract no remainder sans trailing space)
1136 last if defined $remainder and $remainder =~ /\S/;
1146 #======================================================================
1148 #======================================================================
1150 sub _expand_order_by {
1151 my ($self, $arg) = @_;
1153 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1155 my $expander = sub {
1156 my ($self, $dir, $expr) = @_;
1157 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1158 foreach my $arg (@to_expand) {
1162 and grep /^-(asc|desc)$/, keys %$arg
1164 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1168 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1170 map $self->expand_expr($_, -ident),
1171 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1172 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1175 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1177 return $self->$expander(undef, $arg);
1181 my ($self, $arg) = @_;
1183 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1185 my ($sql, @bind) = $self->render_aqt($expanded);
1187 return '' unless length($sql);
1189 my $final_sql = $self->_sqlcase(' order by ').$sql;
1191 return wantarray ? ($final_sql, @bind) : $final_sql;
1194 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1196 sub _order_by_chunks {
1197 my ($self, $arg) = @_;
1199 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1201 return $self->_chunkify_order_by($expanded);
1204 sub _chunkify_order_by {
1205 my ($self, $expanded) = @_;
1207 return grep length, $self->render_aqt($expanded)
1208 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1211 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1212 return map $self->_chunkify_order_by($_), @$l;
1214 return [ $self->render_aqt($_) ];
1218 #======================================================================
1219 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1220 #======================================================================
1226 $self->_expand_maybe_list_expr($from, undef, -ident)
1231 #======================================================================
1233 #======================================================================
1235 sub _expand_maybe_list_expr {
1236 my ($self, $expr, $logic, $default) = @_;
1238 if (ref($expr) eq 'ARRAY') {
1240 map $self->expand_expr($_, $default), @$expr
1247 return $self->expand_expr($e, $default);
1250 # highly optimized, as it's called way too often
1252 # my ($self, $label) = @_;
1254 return '' unless defined $_[1];
1255 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1256 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1258 unless ($_[0]->{quote_char}) {
1259 if (ref($_[1]) eq 'ARRAY') {
1260 return join($_[0]->{name_sep}||'.', @{$_[1]});
1262 $_[0]->_assert_pass_injection_guard($_[1]);
1267 my $qref = ref $_[0]->{quote_char};
1269 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1270 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1271 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1273 my $esc = $_[0]->{escape_char} || $r;
1275 # parts containing * are naturally unquoted
1277 $_[0]->{name_sep}||'',
1281 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1283 (ref($_[1]) eq 'ARRAY'
1287 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1295 # Conversion, if applicable
1297 #my ($self, $arg) = @_;
1298 if ($_[0]->{convert_where}) {
1299 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1306 #my ($self, $col, @vals) = @_;
1307 # called often - tighten code
1308 return $_[0]->{bindtype} eq 'columns'
1309 ? map {[$_[1], $_]} @_[2 .. $#_]
1314 # Dies if any element of @bind is not in [colname => value] format
1315 # if bindtype is 'columns'.
1316 sub _assert_bindval_matches_bindtype {
1317 # my ($self, @bind) = @_;
1319 if ($self->{bindtype} eq 'columns') {
1321 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1322 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1328 sub _join_sql_clauses {
1329 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1331 if (@$clauses_aref > 1) {
1332 my $join = " " . $self->_sqlcase($logic) . " ";
1333 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1334 return ($sql, @$bind_aref);
1336 elsif (@$clauses_aref) {
1337 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1340 return (); # if no SQL, ignore @$bind_aref
1345 # Fix SQL case, if so requested
1347 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1348 # don't touch the argument ... crooked logic, but let's not change it!
1349 return $_[0]->{case} ? $_[1] : uc($_[1]);
1353 #======================================================================
1354 # DISPATCHING FROM REFKIND
1355 #======================================================================
1358 my ($self, $data) = @_;
1360 return 'UNDEF' unless defined $data;
1362 # blessed objects are treated like scalars
1363 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1365 return 'SCALAR' unless $ref;
1368 while ($ref eq 'REF') {
1370 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1374 return ($ref||'SCALAR') . ('REF' x $n_steps);
1378 my ($self, $data) = @_;
1379 my @try = ($self->_refkind($data));
1380 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1381 push @try, 'FALLBACK';
1385 sub _METHOD_FOR_refkind {
1386 my ($self, $meth_prefix, $data) = @_;
1389 for (@{$self->_try_refkind($data)}) {
1390 $method = $self->can($meth_prefix."_".$_)
1394 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1398 sub _SWITCH_refkind {
1399 my ($self, $data, $dispatch_table) = @_;
1402 for (@{$self->_try_refkind($data)}) {
1403 $coderef = $dispatch_table->{$_}
1407 puke "no dispatch entry for ".$self->_refkind($data)
1416 #======================================================================
1417 # VALUES, GENERATE, AUTOLOAD
1418 #======================================================================
1420 # LDNOTE: original code from nwiger, didn't touch code in that section
1421 # I feel the AUTOLOAD stuff should not be the default, it should
1422 # only be activated on explicit demand by user.
1426 my $data = shift || return;
1427 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1428 unless ref $data eq 'HASH';
1431 foreach my $k (sort keys %$data) {
1432 my $v = $data->{$k};
1433 $self->_SWITCH_refkind($v, {
1435 if ($self->{array_datatypes}) { # array datatype
1436 push @all_bind, $self->_bindtype($k, $v);
1438 else { # literal SQL with bind
1439 my ($sql, @bind) = @$v;
1440 $self->_assert_bindval_matches_bindtype(@bind);
1441 push @all_bind, @bind;
1444 ARRAYREFREF => sub { # literal SQL with bind
1445 my ($sql, @bind) = @${$v};
1446 $self->_assert_bindval_matches_bindtype(@bind);
1447 push @all_bind, @bind;
1449 SCALARREF => sub { # literal SQL without bind
1451 SCALAR_or_UNDEF => sub {
1452 push @all_bind, $self->_bindtype($k, $v);
1463 my(@sql, @sqlq, @sqlv);
1467 if ($ref eq 'HASH') {
1468 for my $k (sort keys %$_) {
1471 my $label = $self->_quote($k);
1472 if ($r eq 'ARRAY') {
1473 # literal SQL with bind
1474 my ($sql, @bind) = @$v;
1475 $self->_assert_bindval_matches_bindtype(@bind);
1476 push @sqlq, "$label = $sql";
1478 } elsif ($r eq 'SCALAR') {
1479 # literal SQL without bind
1480 push @sqlq, "$label = $$v";
1482 push @sqlq, "$label = ?";
1483 push @sqlv, $self->_bindtype($k, $v);
1486 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1487 } elsif ($ref eq 'ARRAY') {
1488 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1491 if ($r eq 'ARRAY') { # literal SQL with bind
1492 my ($sql, @bind) = @$v;
1493 $self->_assert_bindval_matches_bindtype(@bind);
1496 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1497 # embedded literal SQL
1504 push @sql, '(' . join(', ', @sqlq) . ')';
1505 } elsif ($ref eq 'SCALAR') {
1509 # strings get case twiddled
1510 push @sql, $self->_sqlcase($_);
1514 my $sql = join ' ', @sql;
1516 # this is pretty tricky
1517 # if ask for an array, return ($stmt, @bind)
1518 # otherwise, s/?/shift @sqlv/ to put it inline
1520 return ($sql, @sqlv);
1522 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1523 ref $d ? $d->[1] : $d/e;
1532 # This allows us to check for a local, then _form, attr
1534 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1535 return $self->generate($name, @_);
1546 SQL::Abstract - Generate SQL from Perl data structures
1552 my $sql = SQL::Abstract->new;
1554 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1556 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1558 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1560 my($stmt, @bind) = $sql->delete($table, \%where);
1562 # Then, use these in your DBI statements
1563 my $sth = $dbh->prepare($stmt);
1564 $sth->execute(@bind);
1566 # Just generate the WHERE clause
1567 my($stmt, @bind) = $sql->where(\%where, $order);
1569 # Return values in the same order, for hashed queries
1570 # See PERFORMANCE section for more details
1571 my @bind = $sql->values(\%fieldvals);
1575 This module was inspired by the excellent L<DBIx::Abstract>.
1576 However, in using that module I found that what I really wanted
1577 to do was generate SQL, but still retain complete control over my
1578 statement handles and use the DBI interface. So, I set out to
1579 create an abstract SQL generation module.
1581 While based on the concepts used by L<DBIx::Abstract>, there are
1582 several important differences, especially when it comes to WHERE
1583 clauses. I have modified the concepts used to make the SQL easier
1584 to generate from Perl data structures and, IMO, more intuitive.
1585 The underlying idea is for this module to do what you mean, based
1586 on the data structures you provide it. The big advantage is that
1587 you don't have to modify your code every time your data changes,
1588 as this module figures it out.
1590 To begin with, an SQL INSERT is as easy as just specifying a hash
1591 of C<key=value> pairs:
1594 name => 'Jimbo Bobson',
1595 phone => '123-456-7890',
1596 address => '42 Sister Lane',
1597 city => 'St. Louis',
1598 state => 'Louisiana',
1601 The SQL can then be generated with this:
1603 my($stmt, @bind) = $sql->insert('people', \%data);
1605 Which would give you something like this:
1607 $stmt = "INSERT INTO people
1608 (address, city, name, phone, state)
1609 VALUES (?, ?, ?, ?, ?)";
1610 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1611 '123-456-7890', 'Louisiana');
1613 These are then used directly in your DBI code:
1615 my $sth = $dbh->prepare($stmt);
1616 $sth->execute(@bind);
1618 =head2 Inserting and Updating Arrays
1620 If your database has array types (like for example Postgres),
1621 activate the special option C<< array_datatypes => 1 >>
1622 when creating the C<SQL::Abstract> object.
1623 Then you may use an arrayref to insert and update database array types:
1625 my $sql = SQL::Abstract->new(array_datatypes => 1);
1627 planets => [qw/Mercury Venus Earth Mars/]
1630 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1634 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1636 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1639 =head2 Inserting and Updating SQL
1641 In order to apply SQL functions to elements of your C<%data> you may
1642 specify a reference to an arrayref for the given hash value. For example,
1643 if you need to execute the Oracle C<to_date> function on a value, you can
1644 say something like this:
1648 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1651 The first value in the array is the actual SQL. Any other values are
1652 optional and would be included in the bind values array. This gives
1655 my($stmt, @bind) = $sql->insert('people', \%data);
1657 $stmt = "INSERT INTO people (name, date_entered)
1658 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1659 @bind = ('Bill', '03/02/2003');
1661 An UPDATE is just as easy, all you change is the name of the function:
1663 my($stmt, @bind) = $sql->update('people', \%data);
1665 Notice that your C<%data> isn't touched; the module will generate
1666 the appropriately quirky SQL for you automatically. Usually you'll
1667 want to specify a WHERE clause for your UPDATE, though, which is
1668 where handling C<%where> hashes comes in handy...
1670 =head2 Complex where statements
1672 This module can generate pretty complicated WHERE statements
1673 easily. For example, simple C<key=value> pairs are taken to mean
1674 equality, and if you want to see if a field is within a set
1675 of values, you can use an arrayref. Let's say we wanted to
1676 SELECT some data based on this criteria:
1679 requestor => 'inna',
1680 worker => ['nwiger', 'rcwe', 'sfz'],
1681 status => { '!=', 'completed' }
1684 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1686 The above would give you something like this:
1688 $stmt = "SELECT * FROM tickets WHERE
1689 ( requestor = ? ) AND ( status != ? )
1690 AND ( worker = ? OR worker = ? OR worker = ? )";
1691 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1693 Which you could then use in DBI code like so:
1695 my $sth = $dbh->prepare($stmt);
1696 $sth->execute(@bind);
1702 The methods are simple. There's one for every major SQL operation,
1703 and a constructor you use first. The arguments are specified in a
1704 similar order for each method (table, then fields, then a where
1705 clause) to try and simplify things.
1707 =head2 new(option => 'value')
1709 The C<new()> function takes a list of options and values, and returns
1710 a new B<SQL::Abstract> object which can then be used to generate SQL
1711 through the methods below. The options accepted are:
1717 If set to 'lower', then SQL will be generated in all lowercase. By
1718 default SQL is generated in "textbook" case meaning something like:
1720 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1722 Any setting other than 'lower' is ignored.
1726 This determines what the default comparison operator is. By default
1727 it is C<=>, meaning that a hash like this:
1729 %where = (name => 'nwiger', email => 'nate@wiger.org');
1731 Will generate SQL like this:
1733 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1735 However, you may want loose comparisons by default, so if you set
1736 C<cmp> to C<like> you would get SQL such as:
1738 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1740 You can also override the comparison on an individual basis - see
1741 the huge section on L</"WHERE CLAUSES"> at the bottom.
1743 =item sqltrue, sqlfalse
1745 Expressions for inserting boolean values within SQL statements.
1746 By default these are C<1=1> and C<1=0>. They are used
1747 by the special operators C<-in> and C<-not_in> for generating
1748 correct SQL even when the argument is an empty array (see below).
1752 This determines the default logical operator for multiple WHERE
1753 statements in arrays or hashes. If absent, the default logic is "or"
1754 for arrays, and "and" for hashes. This means that a WHERE
1758 event_date => {'>=', '2/13/99'},
1759 event_date => {'<=', '4/24/03'},
1762 will generate SQL like this:
1764 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1766 This is probably not what you want given this query, though (look
1767 at the dates). To change the "OR" to an "AND", simply specify:
1769 my $sql = SQL::Abstract->new(logic => 'and');
1771 Which will change the above C<WHERE> to:
1773 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1775 The logic can also be changed locally by inserting
1776 a modifier in front of an arrayref:
1778 @where = (-and => [event_date => {'>=', '2/13/99'},
1779 event_date => {'<=', '4/24/03'} ]);
1781 See the L</"WHERE CLAUSES"> section for explanations.
1785 This will automatically convert comparisons using the specified SQL
1786 function for both column and value. This is mostly used with an argument
1787 of C<upper> or C<lower>, so that the SQL will have the effect of
1788 case-insensitive "searches". For example, this:
1790 $sql = SQL::Abstract->new(convert => 'upper');
1791 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1793 Will turn out the following SQL:
1795 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1797 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1798 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1799 not validate this option; it will just pass through what you specify verbatim).
1803 This is a kludge because many databases suck. For example, you can't
1804 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1805 Instead, you have to use C<bind_param()>:
1807 $sth->bind_param(1, 'reg data');
1808 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1810 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1811 which loses track of which field each slot refers to. Fear not.
1813 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1814 Currently, you can specify either C<normal> (default) or C<columns>. If you
1815 specify C<columns>, you will get an array that looks like this:
1817 my $sql = SQL::Abstract->new(bindtype => 'columns');
1818 my($stmt, @bind) = $sql->insert(...);
1821 [ 'column1', 'value1' ],
1822 [ 'column2', 'value2' ],
1823 [ 'column3', 'value3' ],
1826 You can then iterate through this manually, using DBI's C<bind_param()>.
1828 $sth->prepare($stmt);
1831 my($col, $data) = @$_;
1832 if ($col eq 'details' || $col eq 'comments') {
1833 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1834 } elsif ($col eq 'image') {
1835 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1837 $sth->bind_param($i, $data);
1841 $sth->execute; # execute without @bind now
1843 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1844 Basically, the advantage is still that you don't have to care which fields
1845 are or are not included. You could wrap that above C<for> loop in a simple
1846 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1847 get a layer of abstraction over manual SQL specification.
1849 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1850 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1851 will expect the bind values in this format.
1855 This is the character that a table or column name will be quoted
1856 with. By default this is an empty string, but you could set it to
1857 the character C<`>, to generate SQL like this:
1859 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1861 Alternatively, you can supply an array ref of two items, the first being the left
1862 hand quote character, and the second the right hand quote character. For
1863 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1864 that generates SQL like this:
1866 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1868 Quoting is useful if you have tables or columns names that are reserved
1869 words in your database's SQL dialect.
1873 This is the character that will be used to escape L</quote_char>s appearing
1874 in an identifier before it has been quoted.
1876 The parameter default in case of a single L</quote_char> character is the quote
1879 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1880 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1881 of the B<opening (left)> L</quote_char> within the identifier are currently left
1882 untouched. The default for opening-closing-style quotes may change in future
1883 versions, thus you are B<strongly encouraged> to specify the escape character
1888 This is the character that separates a table and column name. It is
1889 necessary to specify this when the C<quote_char> option is selected,
1890 so that tables and column names can be individually quoted like this:
1892 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1894 =item injection_guard
1896 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1897 column name specified in a query structure. This is a safety mechanism to avoid
1898 injection attacks when mishandling user input e.g.:
1900 my %condition_as_column_value_pairs = get_values_from_user();
1901 $sqla->select( ... , \%condition_as_column_value_pairs );
1903 If the expression matches an exception is thrown. Note that literal SQL
1904 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1906 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1908 =item array_datatypes
1910 When this option is true, arrayrefs in INSERT or UPDATE are
1911 interpreted as array datatypes and are passed directly
1913 When this option is false, arrayrefs are interpreted
1914 as literal SQL, just like refs to arrayrefs
1915 (but this behavior is for backwards compatibility; when writing
1916 new queries, use the "reference to arrayref" syntax
1922 Takes a reference to a list of "special operators"
1923 to extend the syntax understood by L<SQL::Abstract>.
1924 See section L</"SPECIAL OPERATORS"> for details.
1928 Takes a reference to a list of "unary operators"
1929 to extend the syntax understood by L<SQL::Abstract>.
1930 See section L</"UNARY OPERATORS"> for details.
1936 =head2 insert($table, \@values || \%fieldvals, \%options)
1938 This is the simplest function. You simply give it a table name
1939 and either an arrayref of values or hashref of field/value pairs.
1940 It returns an SQL INSERT statement and a list of bind values.
1941 See the sections on L</"Inserting and Updating Arrays"> and
1942 L</"Inserting and Updating SQL"> for information on how to insert
1943 with those data types.
1945 The optional C<\%options> hash reference may contain additional
1946 options to generate the insert SQL. Currently supported options
1953 Takes either a scalar of raw SQL fields, or an array reference of
1954 field names, and adds on an SQL C<RETURNING> statement at the end.
1955 This allows you to return data generated by the insert statement
1956 (such as row IDs) without performing another C<SELECT> statement.
1957 Note, however, this is not part of the SQL standard and may not
1958 be supported by all database engines.
1962 =head2 update($table, \%fieldvals, \%where, \%options)
1964 This takes a table, hashref of field/value pairs, and an optional
1965 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1967 See the sections on L</"Inserting and Updating Arrays"> and
1968 L</"Inserting and Updating SQL"> for information on how to insert
1969 with those data types.
1971 The optional C<\%options> hash reference may contain additional
1972 options to generate the update SQL. Currently supported options
1979 See the C<returning> option to
1980 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1984 =head2 select($source, $fields, $where, $order)
1986 This returns a SQL SELECT statement and associated list of bind values, as
1987 specified by the arguments:
1993 Specification of the 'FROM' part of the statement.
1994 The argument can be either a plain scalar (interpreted as a table
1995 name, will be quoted), or an arrayref (interpreted as a list
1996 of table names, joined by commas, quoted), or a scalarref
1997 (literal SQL, not quoted).
2001 Specification of the list of fields to retrieve from
2003 The argument can be either an arrayref (interpreted as a list
2004 of field names, will be joined by commas and quoted), or a
2005 plain scalar (literal SQL, not quoted).
2006 Please observe that this API is not as flexible as that of
2007 the first argument C<$source>, for backwards compatibility reasons.
2011 Optional argument to specify the WHERE part of the query.
2012 The argument is most often a hashref, but can also be
2013 an arrayref or plain scalar --
2014 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2018 Optional argument to specify the ORDER BY part of the query.
2019 The argument can be a scalar, a hashref or an arrayref
2020 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2026 =head2 delete($table, \%where, \%options)
2028 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2029 It returns an SQL DELETE statement and list of bind values.
2031 The optional C<\%options> hash reference may contain additional
2032 options to generate the delete SQL. Currently supported options
2039 See the C<returning> option to
2040 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2044 =head2 where(\%where, $order)
2046 This is used to generate just the WHERE clause. For example,
2047 if you have an arbitrary data structure and know what the
2048 rest of your SQL is going to look like, but want an easy way
2049 to produce a WHERE clause, use this. It returns an SQL WHERE
2050 clause and list of bind values.
2053 =head2 values(\%data)
2055 This just returns the values from the hash C<%data>, in the same
2056 order that would be returned from any of the other above queries.
2057 Using this allows you to markedly speed up your queries if you
2058 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2060 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2062 Warning: This is an experimental method and subject to change.
2064 This returns arbitrarily generated SQL. It's a really basic shortcut.
2065 It will return two different things, depending on return context:
2067 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2068 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2070 These would return the following:
2072 # First calling form
2073 $stmt = "CREATE TABLE test (?, ?)";
2074 @bind = (field1, field2);
2076 # Second calling form
2077 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2079 Depending on what you're trying to do, it's up to you to choose the correct
2080 format. In this example, the second form is what you would want.
2084 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2088 ALTER SESSION SET nls_date_format = 'MM/YY'
2090 You get the idea. Strings get their case twiddled, but everything
2091 else remains verbatim.
2093 =head1 EXPORTABLE FUNCTIONS
2095 =head2 is_plain_value
2097 Determines if the supplied argument is a plain value as understood by this
2102 =item * The value is C<undef>
2104 =item * The value is a non-reference
2106 =item * The value is an object with stringification overloading
2108 =item * The value is of the form C<< { -value => $anything } >>
2112 On failure returns C<undef>, on success returns a B<scalar> reference
2113 to the original supplied argument.
2119 The stringification overloading detection is rather advanced: it takes
2120 into consideration not only the presence of a C<""> overload, but if that
2121 fails also checks for enabled
2122 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2123 on either C<0+> or C<bool>.
2125 Unfortunately testing in the field indicates that this
2126 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2127 but only when very large numbers of stringifying objects are involved.
2128 At the time of writing ( Sep 2014 ) there is no clear explanation of
2129 the direct cause, nor is there a manageably small test case that reliably
2130 reproduces the problem.
2132 If you encounter any of the following exceptions in B<random places within
2133 your application stack> - this module may be to blame:
2135 Operation "ne": no method found,
2136 left argument in overloaded package <something>,
2137 right argument in overloaded package <something>
2141 Stub found while resolving method "???" overloading """" in package <something>
2143 If you fall victim to the above - please attempt to reduce the problem
2144 to something that could be sent to the L<SQL::Abstract developers
2145 |DBIx::Class/GETTING HELP/SUPPORT>
2146 (either publicly or privately). As a workaround in the meantime you can
2147 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2148 value, which will most likely eliminate your problem (at the expense of
2149 not being able to properly detect exotic forms of stringification).
2151 This notice and environment variable will be removed in a future version,
2152 as soon as the underlying problem is found and a reliable workaround is
2157 =head2 is_literal_value
2159 Determines if the supplied argument is a literal value as understood by this
2164 =item * C<\$sql_string>
2166 =item * C<\[ $sql_string, @bind_values ]>
2170 On failure returns C<undef>, on success returns an B<array> reference
2171 containing the unpacked version of the supplied literal SQL and bind values.
2173 =head1 WHERE CLAUSES
2177 This module uses a variation on the idea from L<DBIx::Abstract>. It
2178 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2179 module is that things in arrays are OR'ed, and things in hashes
2182 The easiest way to explain is to show lots of examples. After
2183 each C<%where> hash shown, it is assumed you used:
2185 my($stmt, @bind) = $sql->where(\%where);
2187 However, note that the C<%where> hash can be used directly in any
2188 of the other functions as well, as described above.
2190 =head2 Key-value pairs
2192 So, let's get started. To begin, a simple hash:
2196 status => 'completed'
2199 Is converted to SQL C<key = val> statements:
2201 $stmt = "WHERE user = ? AND status = ?";
2202 @bind = ('nwiger', 'completed');
2204 One common thing I end up doing is having a list of values that
2205 a field can be in. To do this, simply specify a list inside of
2210 status => ['assigned', 'in-progress', 'pending'];
2213 This simple code will create the following:
2215 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2216 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2218 A field associated to an empty arrayref will be considered a
2219 logical false and will generate 0=1.
2221 =head2 Tests for NULL values
2223 If the value part is C<undef> then this is converted to SQL <IS NULL>
2232 $stmt = "WHERE user = ? AND status IS NULL";
2235 To test if a column IS NOT NULL:
2239 status => { '!=', undef },
2242 =head2 Specific comparison operators
2244 If you want to specify a different type of operator for your comparison,
2245 you can use a hashref for a given column:
2249 status => { '!=', 'completed' }
2252 Which would generate:
2254 $stmt = "WHERE user = ? AND status != ?";
2255 @bind = ('nwiger', 'completed');
2257 To test against multiple values, just enclose the values in an arrayref:
2259 status => { '=', ['assigned', 'in-progress', 'pending'] };
2261 Which would give you:
2263 "WHERE status = ? OR status = ? OR status = ?"
2266 The hashref can also contain multiple pairs, in which case it is expanded
2267 into an C<AND> of its elements:
2271 status => { '!=', 'completed', -not_like => 'pending%' }
2274 # Or more dynamically, like from a form
2275 $where{user} = 'nwiger';
2276 $where{status}{'!='} = 'completed';
2277 $where{status}{'-not_like'} = 'pending%';
2279 # Both generate this
2280 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2281 @bind = ('nwiger', 'completed', 'pending%');
2284 To get an OR instead, you can combine it with the arrayref idea:
2288 priority => [ { '=', 2 }, { '>', 5 } ]
2291 Which would generate:
2293 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2294 @bind = ('2', '5', 'nwiger');
2296 If you want to include literal SQL (with or without bind values), just use a
2297 scalar reference or reference to an arrayref as the value:
2300 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2301 date_expires => { '<' => \"now()" }
2304 Which would generate:
2306 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2307 @bind = ('11/26/2008');
2310 =head2 Logic and nesting operators
2312 In the example above,
2313 there is a subtle trap if you want to say something like
2314 this (notice the C<AND>):
2316 WHERE priority != ? AND priority != ?
2318 Because, in Perl you I<can't> do this:
2320 priority => { '!=' => 2, '!=' => 1 }
2322 As the second C<!=> key will obliterate the first. The solution
2323 is to use the special C<-modifier> form inside an arrayref:
2325 priority => [ -and => {'!=', 2},
2329 Normally, these would be joined by C<OR>, but the modifier tells it
2330 to use C<AND> instead. (Hint: You can use this in conjunction with the
2331 C<logic> option to C<new()> in order to change the way your queries
2332 work by default.) B<Important:> Note that the C<-modifier> goes
2333 B<INSIDE> the arrayref, as an extra first element. This will
2334 B<NOT> do what you think it might:
2336 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2338 Here is a quick list of equivalencies, since there is some overlap:
2341 status => {'!=', 'completed', 'not like', 'pending%' }
2342 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2345 status => {'=', ['assigned', 'in-progress']}
2346 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2347 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2351 =head2 Special operators: IN, BETWEEN, etc.
2353 You can also use the hashref format to compare a list of fields using the
2354 C<IN> comparison operator, by specifying the list as an arrayref:
2357 status => 'completed',
2358 reportid => { -in => [567, 2335, 2] }
2361 Which would generate:
2363 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2364 @bind = ('completed', '567', '2335', '2');
2366 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2369 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2370 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2371 'sqltrue' (by default: C<1=1>).
2373 In addition to the array you can supply a chunk of literal sql or
2374 literal sql with bind:
2377 customer => { -in => \[
2378 'SELECT cust_id FROM cust WHERE balance > ?',
2381 status => { -in => \'SELECT status_codes FROM states' },
2387 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2388 AND status IN ( SELECT status_codes FROM states )
2392 Finally, if the argument to C<-in> is not a reference, it will be
2393 treated as a single-element array.
2395 Another pair of operators is C<-between> and C<-not_between>,
2396 used with an arrayref of two values:
2400 completion_date => {
2401 -not_between => ['2002-10-01', '2003-02-06']
2407 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2409 Just like with C<-in> all plausible combinations of literal SQL
2413 start0 => { -between => [ 1, 2 ] },
2414 start1 => { -between => \["? AND ?", 1, 2] },
2415 start2 => { -between => \"lower(x) AND upper(y)" },
2416 start3 => { -between => [
2418 \["upper(?)", 'stuff' ],
2425 ( start0 BETWEEN ? AND ? )
2426 AND ( start1 BETWEEN ? AND ? )
2427 AND ( start2 BETWEEN lower(x) AND upper(y) )
2428 AND ( start3 BETWEEN lower(x) AND upper(?) )
2430 @bind = (1, 2, 1, 2, 'stuff');
2433 These are the two builtin "special operators"; but the
2434 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2436 =head2 Unary operators: bool
2438 If you wish to test against boolean columns or functions within your
2439 database you can use the C<-bool> and C<-not_bool> operators. For
2440 example to test the column C<is_user> being true and the column
2441 C<is_enabled> being false you would use:-
2445 -not_bool => 'is_enabled',
2450 WHERE is_user AND NOT is_enabled
2452 If a more complex combination is required, testing more conditions,
2453 then you should use the and/or operators:-
2458 -not_bool => { two=> { -rlike => 'bar' } },
2459 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2470 (NOT ( three = ? OR three > ? ))
2473 =head2 Nested conditions, -and/-or prefixes
2475 So far, we've seen how multiple conditions are joined with a top-level
2476 C<AND>. We can change this by putting the different conditions we want in
2477 hashes and then putting those hashes in an array. For example:
2482 status => { -like => ['pending%', 'dispatched'] },
2486 status => 'unassigned',
2490 This data structure would create the following:
2492 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2493 OR ( user = ? AND status = ? ) )";
2494 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2497 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2498 to change the logic inside:
2504 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2505 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2512 $stmt = "WHERE ( user = ?
2513 AND ( ( workhrs > ? AND geo = ? )
2514 OR ( workhrs < ? OR geo = ? ) ) )";
2515 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2517 =head3 Algebraic inconsistency, for historical reasons
2519 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2520 operator goes C<outside> of the nested structure; whereas when connecting
2521 several constraints on one column, the C<-and> operator goes
2522 C<inside> the arrayref. Here is an example combining both features:
2525 -and => [a => 1, b => 2],
2526 -or => [c => 3, d => 4],
2527 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2532 WHERE ( ( ( a = ? AND b = ? )
2533 OR ( c = ? OR d = ? )
2534 OR ( e LIKE ? AND e LIKE ? ) ) )
2536 This difference in syntax is unfortunate but must be preserved for
2537 historical reasons. So be careful: the two examples below would
2538 seem algebraically equivalent, but they are not
2541 { -like => 'foo%' },
2542 { -like => '%bar' },
2544 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2547 { col => { -like => 'foo%' } },
2548 { col => { -like => '%bar' } },
2550 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2553 =head2 Literal SQL and value type operators
2555 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2556 side" is a column name and the "right side" is a value (normally rendered as
2557 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2558 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2559 alter this behavior. There are several ways of doing so.
2563 This is a virtual operator that signals the string to its right side is an
2564 identifier (a column name) and not a value. For example to compare two
2565 columns you would write:
2568 priority => { '<', 2 },
2569 requestor => { -ident => 'submitter' },
2574 $stmt = "WHERE priority < ? AND requestor = submitter";
2577 If you are maintaining legacy code you may see a different construct as
2578 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2583 This is a virtual operator that signals that the construct to its right side
2584 is a value to be passed to DBI. This is for example necessary when you want
2585 to write a where clause against an array (for RDBMS that support such
2586 datatypes). For example:
2589 array => { -value => [1, 2, 3] }
2594 $stmt = 'WHERE array = ?';
2595 @bind = ([1, 2, 3]);
2597 Note that if you were to simply say:
2603 the result would probably not be what you wanted:
2605 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2610 Finally, sometimes only literal SQL will do. To include a random snippet
2611 of SQL verbatim, you specify it as a scalar reference. Consider this only
2612 as a last resort. Usually there is a better way. For example:
2615 priority => { '<', 2 },
2616 requestor => { -in => \'(SELECT name FROM hitmen)' },
2621 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2624 Note that in this example, you only get one bind parameter back, since
2625 the verbatim SQL is passed as part of the statement.
2629 Never use untrusted input as a literal SQL argument - this is a massive
2630 security risk (there is no way to check literal snippets for SQL
2631 injections and other nastyness). If you need to deal with untrusted input
2632 use literal SQL with placeholders as described next.
2634 =head3 Literal SQL with placeholders and bind values (subqueries)
2636 If the literal SQL to be inserted has placeholders and bind values,
2637 use a reference to an arrayref (yes this is a double reference --
2638 not so common, but perfectly legal Perl). For example, to find a date
2639 in Postgres you can use something like this:
2642 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2647 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2650 Note that you must pass the bind values in the same format as they are returned
2651 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2652 to C<columns>, you must provide the bind values in the
2653 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2654 scalar value; most commonly the column name, but you can use any scalar value
2655 (including references and blessed references), L<SQL::Abstract> will simply
2656 pass it through intact. So if C<bindtype> is set to C<columns> the above
2657 example will look like:
2660 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2663 Literal SQL is especially useful for nesting parenthesized clauses in the
2664 main SQL query. Here is a first example:
2666 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2670 bar => \["IN ($sub_stmt)" => @sub_bind],
2675 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2676 WHERE c2 < ? AND c3 LIKE ?))";
2677 @bind = (1234, 100, "foo%");
2679 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2680 are expressed in the same way. Of course the C<$sub_stmt> and
2681 its associated bind values can be generated through a former call
2684 my ($sub_stmt, @sub_bind)
2685 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2686 c3 => {-like => "foo%"}});
2689 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2692 In the examples above, the subquery was used as an operator on a column;
2693 but the same principle also applies for a clause within the main C<%where>
2694 hash, like an EXISTS subquery:
2696 my ($sub_stmt, @sub_bind)
2697 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2698 my %where = ( -and => [
2700 \["EXISTS ($sub_stmt)" => @sub_bind],
2705 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2706 WHERE c1 = ? AND c2 > t0.c0))";
2710 Observe that the condition on C<c2> in the subquery refers to
2711 column C<t0.c0> of the main query: this is I<not> a bind
2712 value, so we have to express it through a scalar ref.
2713 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2714 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2715 what we wanted here.
2717 Finally, here is an example where a subquery is used
2718 for expressing unary negation:
2720 my ($sub_stmt, @sub_bind)
2721 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2722 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2724 lname => {like => '%son%'},
2725 \["NOT ($sub_stmt)" => @sub_bind],
2730 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2731 @bind = ('%son%', 10, 20)
2733 =head3 Deprecated usage of Literal SQL
2735 Below are some examples of archaic use of literal SQL. It is shown only as
2736 reference for those who deal with legacy code. Each example has a much
2737 better, cleaner and safer alternative that users should opt for in new code.
2743 my %where = ( requestor => \'IS NOT NULL' )
2745 $stmt = "WHERE requestor IS NOT NULL"
2747 This used to be the way of generating NULL comparisons, before the handling
2748 of C<undef> got formalized. For new code please use the superior syntax as
2749 described in L</Tests for NULL values>.
2753 my %where = ( requestor => \'= submitter' )
2755 $stmt = "WHERE requestor = submitter"
2757 This used to be the only way to compare columns. Use the superior L</-ident>
2758 method for all new code. For example an identifier declared in such a way
2759 will be properly quoted if L</quote_char> is properly set, while the legacy
2760 form will remain as supplied.
2764 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2766 $stmt = "WHERE completed > ? AND is_ready"
2767 @bind = ('2012-12-21')
2769 Using an empty string literal used to be the only way to express a boolean.
2770 For all new code please use the much more readable
2771 L<-bool|/Unary operators: bool> operator.
2777 These pages could go on for a while, since the nesting of the data
2778 structures this module can handle are pretty much unlimited (the
2779 module implements the C<WHERE> expansion as a recursive function
2780 internally). Your best bet is to "play around" with the module a
2781 little to see how the data structures behave, and choose the best
2782 format for your data based on that.
2784 And of course, all the values above will probably be replaced with
2785 variables gotten from forms or the command line. After all, if you
2786 knew everything ahead of time, you wouldn't have to worry about
2787 dynamically-generating SQL and could just hardwire it into your
2790 =head1 ORDER BY CLAUSES
2792 Some functions take an order by clause. This can either be a scalar (just a
2793 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2794 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2797 Given | Will Generate
2798 ---------------------------------------------------------------
2800 'colA' | ORDER BY colA
2802 [qw/colA colB/] | ORDER BY colA, colB
2804 {-asc => 'colA'} | ORDER BY colA ASC
2806 {-desc => 'colB'} | ORDER BY colB DESC
2808 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2810 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2812 \'colA DESC' | ORDER BY colA DESC
2814 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2815 | /* ...with $x bound to ? */
2818 { -asc => 'colA' }, | colA ASC,
2819 { -desc => [qw/colB/] }, | colB DESC,
2820 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2821 \'colE DESC', | colE DESC,
2822 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2823 ] | /* ...with $x bound to ? */
2824 ===============================================================
2828 =head1 SPECIAL OPERATORS
2830 my $sqlmaker = SQL::Abstract->new(special_ops => [
2834 my ($self, $field, $op, $arg) = @_;
2840 handler => 'method_name',
2844 A "special operator" is a SQL syntactic clause that can be
2845 applied to a field, instead of a usual binary operator.
2848 WHERE field IN (?, ?, ?)
2849 WHERE field BETWEEN ? AND ?
2850 WHERE MATCH(field) AGAINST (?, ?)
2852 Special operators IN and BETWEEN are fairly standard and therefore
2853 are builtin within C<SQL::Abstract> (as the overridable methods
2854 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2855 like the MATCH .. AGAINST example above which is specific to MySQL,
2856 you can write your own operator handlers - supply a C<special_ops>
2857 argument to the C<new> method. That argument takes an arrayref of
2858 operator definitions; each operator definition is a hashref with two
2865 the regular expression to match the operator
2869 Either a coderef or a plain scalar method name. In both cases
2870 the expected return is C<< ($sql, @bind) >>.
2872 When supplied with a method name, it is simply called on the
2873 L<SQL::Abstract> object as:
2875 $self->$method_name($field, $op, $arg)
2879 $field is the LHS of the operator
2880 $op is the part that matched the handler regex
2883 When supplied with a coderef, it is called as:
2885 $coderef->($self, $field, $op, $arg)
2890 For example, here is an implementation
2891 of the MATCH .. AGAINST syntax for MySQL
2893 my $sqlmaker = SQL::Abstract->new(special_ops => [
2895 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2896 {regex => qr/^match$/i,
2898 my ($self, $field, $op, $arg) = @_;
2899 $arg = [$arg] if not ref $arg;
2900 my $label = $self->_quote($field);
2901 my ($placeholder) = $self->_convert('?');
2902 my $placeholders = join ", ", (($placeholder) x @$arg);
2903 my $sql = $self->_sqlcase('match') . " ($label) "
2904 . $self->_sqlcase('against') . " ($placeholders) ";
2905 my @bind = $self->_bindtype($field, @$arg);
2906 return ($sql, @bind);
2913 =head1 UNARY OPERATORS
2915 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2919 my ($self, $op, $arg) = @_;
2925 handler => 'method_name',
2929 A "unary operator" is a SQL syntactic clause that can be
2930 applied to a field - the operator goes before the field
2932 You can write your own operator handlers - supply a C<unary_ops>
2933 argument to the C<new> method. That argument takes an arrayref of
2934 operator definitions; each operator definition is a hashref with two
2941 the regular expression to match the operator
2945 Either a coderef or a plain scalar method name. In both cases
2946 the expected return is C<< $sql >>.
2948 When supplied with a method name, it is simply called on the
2949 L<SQL::Abstract> object as:
2951 $self->$method_name($op, $arg)
2955 $op is the part that matched the handler regex
2956 $arg is the RHS or argument of the operator
2958 When supplied with a coderef, it is called as:
2960 $coderef->($self, $op, $arg)
2968 Thanks to some benchmarking by Mark Stosberg, it turns out that
2969 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2970 I must admit this wasn't an intentional design issue, but it's a
2971 byproduct of the fact that you get to control your C<DBI> handles
2974 To maximize performance, use a code snippet like the following:
2976 # prepare a statement handle using the first row
2977 # and then reuse it for the rest of the rows
2979 for my $href (@array_of_hashrefs) {
2980 $stmt ||= $sql->insert('table', $href);
2981 $sth ||= $dbh->prepare($stmt);
2982 $sth->execute($sql->values($href));
2985 The reason this works is because the keys in your C<$href> are sorted
2986 internally by B<SQL::Abstract>. Thus, as long as your data retains
2987 the same structure, you only have to generate the SQL the first time
2988 around. On subsequent queries, simply use the C<values> function provided
2989 by this module to return your values in the correct order.
2991 However this depends on the values having the same type - if, for
2992 example, the values of a where clause may either have values
2993 (resulting in sql of the form C<column = ?> with a single bind
2994 value), or alternatively the values might be C<undef> (resulting in
2995 sql of the form C<column IS NULL> with no bind value) then the
2996 caching technique suggested will not work.
3000 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3001 really like this part (I do, at least). Building up a complex query
3002 can be as simple as the following:
3009 use CGI::FormBuilder;
3012 my $form = CGI::FormBuilder->new(...);
3013 my $sql = SQL::Abstract->new;
3015 if ($form->submitted) {
3016 my $field = $form->field;
3017 my $id = delete $field->{id};
3018 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3021 Of course, you would still have to connect using C<DBI> to run the
3022 query, but the point is that if you make your form look like your
3023 table, the actual query script can be extremely simplistic.
3025 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3026 a fast interface to returning and formatting data. I frequently
3027 use these three modules together to write complex database query
3028 apps in under 50 lines.
3030 =head1 HOW TO CONTRIBUTE
3032 Contributions are always welcome, in all usable forms (we especially
3033 welcome documentation improvements). The delivery methods include git-
3034 or unified-diff formatted patches, GitHub pull requests, or plain bug
3035 reports either via RT or the Mailing list. Contributors are generally
3036 granted full access to the official repository after their first several
3037 patches pass successful review.
3039 This project is maintained in a git repository. The code and related tools are
3040 accessible at the following locations:
3044 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3046 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3048 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3050 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3056 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3057 Great care has been taken to preserve the I<published> behavior
3058 documented in previous versions in the 1.* family; however,
3059 some features that were previously undocumented, or behaved
3060 differently from the documentation, had to be changed in order
3061 to clarify the semantics. Hence, client code that was relying
3062 on some dark areas of C<SQL::Abstract> v1.*
3063 B<might behave differently> in v1.50.
3065 The main changes are:
3071 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3075 support for the { operator => \"..." } construct (to embed literal SQL)
3079 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3083 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3087 defensive programming: check arguments
3091 fixed bug with global logic, which was previously implemented
3092 through global variables yielding side-effects. Prior versions would
3093 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3094 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3095 Now this is interpreted
3096 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3101 fixed semantics of _bindtype on array args
3105 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3106 we just avoid shifting arrays within that tree.
3110 dropped the C<_modlogic> function
3114 =head1 ACKNOWLEDGEMENTS
3116 There are a number of individuals that have really helped out with
3117 this module. Unfortunately, most of them submitted bugs via CPAN
3118 so I have no idea who they are! But the people I do know are:
3120 Ash Berlin (order_by hash term support)
3121 Matt Trout (DBIx::Class support)
3122 Mark Stosberg (benchmarking)
3123 Chas Owens (initial "IN" operator support)
3124 Philip Collins (per-field SQL functions)
3125 Eric Kolve (hashref "AND" support)
3126 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3127 Dan Kubb (support for "quote_char" and "name_sep")
3128 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3129 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3130 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3131 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3132 Oliver Charles (support for "RETURNING" after "INSERT")
3138 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3142 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3144 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3146 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3147 While not an official support venue, C<DBIx::Class> makes heavy use of
3148 C<SQL::Abstract>, and as such list members there are very familiar with
3149 how to create queries.
3153 This module is free software; you may copy this under the same
3154 terms as perl itself (either the GNU General Public License or
3155 the Artistic License)