1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.86';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ value $/ix, handler => '_where_op_VALUE'},
44 {regex => qr/^ is (?: \s+ not )? $/ix, handler => '_where_field_IS'},
47 # unaryish operators - key maps to handler
48 my @BUILTIN_UNARY_OPS = (
49 # the digits are backcompat stuff
50 { regex => qr/^ and (?: [_\s]? \d+ )? $/xi, handler => '_where_op_ANDOR' },
51 { regex => qr/^ or (?: [_\s]? \d+ )? $/xi, handler => '_where_op_ANDOR' },
52 { regex => qr/^ nest (?: [_\s]? \d+ )? $/xi, handler => '_where_op_NEST' },
53 { regex => qr/^ (?: not \s )? bool $/xi, handler => '_where_op_BOOL' },
54 { regex => qr/^ ident $/xi, handler => '_where_op_IDENT' },
55 { regex => qr/^ value $/xi, handler => '_where_op_VALUE' },
56 { regex => qr/^ op $/xi, handler => '_where_op_OP' },
57 { regex => qr/^ bind $/xi, handler => '_where_op_BIND' },
58 { regex => qr/^ literal $/xi, handler => '_where_op_LITERAL' },
61 #======================================================================
62 # DEBUGGING AND ERROR REPORTING
63 #======================================================================
66 return unless $_[0]->{debug}; shift; # a little faster
67 my $func = (caller(1))[3];
68 warn "[$func] ", @_, "\n";
72 my($func) = (caller(1))[3];
73 Carp::carp "[$func] Warning: ", @_;
77 my($func) = (caller(1))[3];
78 Carp::croak "[$func] Fatal: ", @_;
81 sub is_literal_value ($) {
82 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
83 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
87 # FIXME XSify - this can be done so much more efficiently
88 sub is_plain_value ($) {
90 ! length ref $_[0] ? \($_[0])
92 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
94 exists $_[0]->{-value}
95 ) ? \($_[0]->{-value})
97 # reuse @_ for even moar speedz
98 defined ( $_[1] = Scalar::Util::blessed $_[0] )
100 # deliberately not using Devel::OverloadInfo - the checks we are
101 # intersted in are much more limited than the fullblown thing, and
102 # this is a very hot piece of code
104 # simply using ->can('(""') can leave behind stub methods that
105 # break actually using the overload later (see L<perldiag/Stub
106 # found while resolving method "%s" overloading "%s" in package
107 # "%s"> and the source of overload::mycan())
109 # either has stringification which DBI SHOULD prefer out of the box
110 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
112 # has nummification or boolification, AND fallback is *not* disabled
114 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
117 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
119 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
123 # no fallback specified at all
124 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
126 # fallback explicitly undef
127 ! defined ${"$_[3]::()"}
140 #======================================================================
142 #======================================================================
146 my $class = ref($self) || $self;
147 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
149 # choose our case by keeping an option around
150 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
152 # default logic for interpreting arrayrefs
153 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
155 # how to return bind vars
156 $opt{bindtype} ||= 'normal';
158 # default comparison is "=", but can be overridden
161 # try to recognize which are the 'equality' and 'inequality' ops
162 # (temporary quickfix (in 2007), should go through a more seasoned API)
163 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
164 $opt{inequality_op} = qr/^( != | <> )$/ix;
166 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
167 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
170 $opt{sqltrue} ||= '1=1';
171 $opt{sqlfalse} ||= '0=1';
174 $opt{special_ops} ||= [];
175 # regexes are applied in order, thus push after user-defines
176 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
179 $opt{unary_ops} ||= [];
180 push @{$opt{unary_ops}}, @BUILTIN_UNARY_OPS;
182 # rudimentary sanity-check for user supplied bits treated as functions/operators
183 # If a purported function matches this regular expression, an exception is thrown.
184 # Literal SQL is *NOT* subject to this check, only functions (and column names
185 # when quoting is not in effect)
188 # need to guard against ()'s in column names too, but this will break tons of
189 # hacks... ideas anyone?
190 $opt{injection_guard} ||= qr/
196 return bless \%opt, $class;
200 sub _assert_pass_injection_guard {
201 if ($_[1] =~ $_[0]->{injection_guard}) {
202 my $class = ref $_[0];
203 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
204 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
205 . "{injection_guard} attribute to ${class}->new()"
210 #======================================================================
212 #======================================================================
216 my $table = $self->_table(shift);
217 my $data = shift || return;
220 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
221 my ($sql, @bind) = $self->$method($data);
222 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
224 if ($options->{returning}) {
225 my ($s, @b) = $self->_insert_returning($options);
230 return wantarray ? ($sql, @bind) : $sql;
233 # So that subclasses can override INSERT ... RETURNING separately from
234 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
235 sub _insert_returning { shift->_returning(@_) }
238 my ($self, $options) = @_;
240 my $f = $options->{returning};
242 my $fieldlist = $self->_SWITCH_refkind($f, {
243 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$f;},
244 SCALAR => sub {$self->_quote($f)},
245 SCALARREF => sub {$$f},
247 return $self->_sqlcase(' returning ') . $fieldlist;
250 sub _insert_HASHREF { # explicit list of fields and then values
251 my ($self, $data) = @_;
253 my @fields = sort keys %$data;
255 my ($sql, @bind) = $self->_insert_values($data);
258 $_ = $self->_quote($_) foreach @fields;
259 $sql = "( ".join(", ", @fields).") ".$sql;
261 return ($sql, @bind);
264 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
265 my ($self, $data) = @_;
267 # no names (arrayref) so can't generate bindtype
268 $self->{bindtype} ne 'columns'
269 or belch "can't do 'columns' bindtype when called with arrayref";
271 my (@values, @all_bind);
272 foreach my $value (@$data) {
273 my ($values, @bind) = $self->_insert_value(undef, $value);
274 push @values, $values;
275 push @all_bind, @bind;
277 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
278 return ($sql, @all_bind);
281 sub _insert_ARRAYREFREF { # literal SQL with bind
282 my ($self, $data) = @_;
284 my ($sql, @bind) = @${$data};
285 $self->_assert_bindval_matches_bindtype(@bind);
287 return ($sql, @bind);
291 sub _insert_SCALARREF { # literal SQL without bind
292 my ($self, $data) = @_;
298 my ($self, $data) = @_;
300 my (@values, @all_bind);
301 foreach my $column (sort keys %$data) {
302 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
303 push @values, $values;
304 push @all_bind, @bind;
306 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
307 return ($sql, @all_bind);
311 my ($self, $column, $v) = @_;
313 my (@values, @all_bind);
314 $self->_SWITCH_refkind($v, {
317 if ($self->{array_datatypes}) { # if array datatype are activated
319 push @all_bind, $self->_bindtype($column, $v);
321 else { # else literal SQL with bind
322 my ($sql, @bind) = @$v;
323 $self->_assert_bindval_matches_bindtype(@bind);
325 push @all_bind, @bind;
329 ARRAYREFREF => sub { # literal SQL with bind
330 my ($sql, @bind) = @${$v};
331 $self->_assert_bindval_matches_bindtype(@bind);
333 push @all_bind, @bind;
336 # THINK: anything useful to do with a HASHREF ?
337 HASHREF => sub { # (nothing, but old SQLA passed it through)
338 #TODO in SQLA >= 2.0 it will die instead
339 belch "HASH ref as bind value in insert is not supported";
341 push @all_bind, $self->_bindtype($column, $v);
344 SCALARREF => sub { # literal SQL without bind
348 SCALAR_or_UNDEF => sub {
350 push @all_bind, $self->_bindtype($column, $v);
355 my $sql = join(", ", @values);
356 return ($sql, @all_bind);
361 #======================================================================
363 #======================================================================
368 my $table = $self->_table(shift);
369 my $data = shift || return;
373 # first build the 'SET' part of the sql statement
374 puke "Unsupported data type specified to \$sql->update"
375 unless ref $data eq 'HASH';
377 my ($sql, @all_bind) = $self->_update_set_values($data);
378 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
382 my($where_sql, @where_bind) = $self->where($where);
384 push @all_bind, @where_bind;
387 if ($options->{returning}) {
388 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
389 $sql .= $returning_sql;
390 push @all_bind, @returning_bind;
393 return wantarray ? ($sql, @all_bind) : $sql;
396 sub _update_set_values {
397 my ($self, $data) = @_;
399 my (@set, @all_bind);
400 for my $k (sort keys %$data) {
403 my $label = $self->_quote($k);
405 $self->_SWITCH_refkind($v, {
407 if ($self->{array_datatypes}) { # array datatype
408 push @set, "$label = ?";
409 push @all_bind, $self->_bindtype($k, $v);
411 else { # literal SQL with bind
412 my ($sql, @bind) = @$v;
413 $self->_assert_bindval_matches_bindtype(@bind);
414 push @set, "$label = $sql";
415 push @all_bind, @bind;
418 ARRAYREFREF => sub { # literal SQL with bind
419 my ($sql, @bind) = @${$v};
420 $self->_assert_bindval_matches_bindtype(@bind);
421 push @set, "$label = $sql";
422 push @all_bind, @bind;
424 SCALARREF => sub { # literal SQL without bind
425 push @set, "$label = $$v";
428 my ($op, $arg, @rest) = %$v;
430 puke 'Operator calls in update must be in the form { -op => $arg }'
431 if (@rest or not $op =~ /^\-(.+)/);
433 local $self->{_nested_func_lhs} = $k;
434 my ($sql, @bind) = $self->_where_unary_op($1, $arg);
436 push @set, "$label = $sql";
437 push @all_bind, @bind;
439 SCALAR_or_UNDEF => sub {
440 push @set, "$label = ?";
441 push @all_bind, $self->_bindtype($k, $v);
447 my $sql = join ', ', @set;
449 return ($sql, @all_bind);
452 # So that subclasses can override UPDATE ... RETURNING separately from
454 sub _update_returning { shift->_returning(@_) }
458 #======================================================================
460 #======================================================================
465 my $table = $self->_table(shift);
466 my $fields = shift || '*';
470 my ($fields_sql, @bind) = $self->_select_fields($fields);
472 my ($where_sql, @where_bind) = $self->where($where, $order);
473 push @bind, @where_bind;
475 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
476 $self->_sqlcase('from'), $table)
479 return wantarray ? ($sql, @bind) : $sql;
483 my ($self, $fields) = @_;
484 return ref $fields eq 'ARRAY' ? join ', ', map { $self->_quote($_) } @$fields
488 #======================================================================
490 #======================================================================
495 my $table = $self->_table(shift);
499 my($where_sql, @bind) = $self->where($where);
500 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
502 if ($options->{returning}) {
503 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
504 $sql .= $returning_sql;
505 push @bind, @returning_bind;
508 return wantarray ? ($sql, @bind) : $sql;
511 # So that subclasses can override DELETE ... RETURNING separately from
513 sub _delete_returning { shift->_returning(@_) }
517 #======================================================================
519 #======================================================================
523 # Finally, a separate routine just to handle WHERE clauses
525 my ($self, $where, $order) = @_;
528 my ($sql, @bind) = $self->_recurse_where($where);
529 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
533 my ($order_sql, @order_bind) = $self->_order_by($order);
535 push @bind, @order_bind;
538 return wantarray ? ($sql, @bind) : $sql;
542 my ($self, $expr, $logic) = @_;
543 if (ref($expr) eq 'HASH') {
544 if (keys %$expr > 1) {
546 return +{ "-${logic}" => [
547 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
551 return $self->_expand_expr_hashpair(%$expr, $logic);
553 if (ref($expr) eq 'ARRAY') {
554 $logic = lc($logic || $self->{logic});
555 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
561 while (my ($el) = splice @expr, 0, 1) {
562 puke "Supplying an empty left hand side argument is not supported in array-pairs"
563 unless defined($el) and length($el);
564 my $elref = ref($el);
566 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
567 } elsif ($elref eq 'ARRAY') {
568 push(@res, $self->_expand_expr($el)) if @$el;
569 } elsif (is_literal_value($el)) {
571 } elsif ($elref eq 'HASH') {
572 push @res, $self->_expand_expr($el);
577 return { '-'.$logic => \@res };
579 if (my $literal = is_literal_value($expr)) {
580 return +{ -literal => $literal };
585 sub _expand_expr_hashpair {
586 my ($self, $k, $v, $logic) = @_;
587 unless (defined($k) and length($k)) {
588 if (defined($k) and my $literal = is_literal_value($v)) {
589 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
590 return { -literal => $literal };
592 puke "Supplying an empty left hand side argument is not supported";
596 return $self->_expand_expr($v);
600 return $self->_expand_expr($v);
602 puke "-bool => undef not supported" unless defined($v);
603 return { -ident => $v };
605 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
606 return $self->_expand_expr({ -not => { "-${rest}", $v } }, $logic);
608 if (my ($logic) = $k =~ /^-(and|or)$/) {
609 if (ref($v) eq 'HASH') {
610 return $self->_expand_expr($v, $logic);
614 unless (defined($v)) {
615 my $orig_op = my $op = $self->{cmp};
617 $op =~ /^not$/i ? 'is not' # legacy
618 : $op =~ $self->{equality_op} ? 'is'
619 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
620 : $op =~ $self->{inequality_op} ? 'is not'
621 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
622 : puke "unexpected operator '$orig_op' with undef operand";
623 return +{ -op => [ $is.' null', { -ident => $k } ] };
630 { -bind => [ $k, $v ] }
634 if (ref($v) eq 'HASH') {
637 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
644 if ($vk =~ /^(?:not[ _])?between$/) {
645 my @rhs = map $self->_expand_expr($_),
646 ref($vv) eq 'ARRAY' ? @$vv : $vv;
648 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
650 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
652 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
655 join(' ', split '_', $vk),
658 my $v = ref($_) ? $_->{-value} :$_;
659 ($v ? { -bind => [ $k, $v ] } : $_)
663 if ($vk =~ /^(?:not[ _])?in$/) {
664 if (my $literal = is_literal_value($vv)) {
665 my ($sql, @bind) = @$literal;
666 my $opened_sql = $self->_open_outer_paren($sql);
668 $vk, { -ident => $k },
669 [ { -literal => [ $opened_sql, @bind ] } ]
673 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
674 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
675 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
676 . 'will emit the logically correct SQL instead of raising this exception)'
678 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
680 my @rhs = map $self->_expand_expr($_),
681 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
682 map { defined($_) ? $_: puke($undef_err) }
683 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
685 -literal => [ $self->{$vk =~ /^not/ ? 'sqltrue' : 'sqlfalse'} ]
689 join(' ', split '_', $vk),
694 if ($vk eq 'ident') {
695 if (! defined $vv or ref $vv) {
696 puke "-$vk requires a single plain scalar argument (a quotable identifier)";
705 if (ref($v) eq 'ARRAY') {
706 return $self->{sqlfalse} unless @$v;
707 $self->_debug("ARRAY($k) means distribute over elements");
709 $v->[0] =~ /^-((?:and|or))$/i
710 ? ($v = [ @{$v}[1..$#$v] ], $1)
711 : ($self->{logic} || 'or')
713 return +{ "-${this_logic}" => [ map $self->_expand_expr({ $k => $_ }, $this_logic), @$v ] };
715 if (my $literal = is_literal_value($v)) {
717 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
720 my ($sql, @bind) = @$literal;
721 if ($self->{bindtype} eq 'columns') {
723 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
724 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
728 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
735 my ($self, $where, $logic) = @_;
737 my $where_exp = $self->_expand_expr($where, $logic);
739 # dispatch on appropriate method according to refkind of $where
740 my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
742 my ($sql, @bind) = $self->$method($where_exp, $logic);
744 # DBIx::Class used to call _recurse_where in scalar context
745 # something else might too...
747 return ($sql, @bind);
750 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
757 #======================================================================
758 # WHERE: top-level ARRAYREF
759 #======================================================================
762 sub _where_ARRAYREF {
763 my ($self, $where, $logic) = @_;
765 $logic = uc($logic || $self->{logic});
766 $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
768 my @clauses = @$where;
770 my (@sql_clauses, @all_bind);
771 # need to use while() so can shift() for pairs
773 my $el = shift @clauses;
775 $el = undef if (defined $el and ! length $el);
777 # switch according to kind of $el and get corresponding ($sql, @bind)
778 my ($sql, @bind) = $self->_SWITCH_refkind($el, {
780 # skip empty elements, otherwise get invalid trailing AND stuff
781 ARRAYREF => sub {$self->_recurse_where($el) if @$el},
785 $self->_assert_bindval_matches_bindtype(@b);
789 HASHREF => sub {$self->_recurse_where($el, 'and') if %$el},
791 SCALARREF => sub { ($$el); },
794 # top-level arrayref with scalars, recurse in pairs
795 $self->_recurse_where({$el => shift(@clauses)})
798 UNDEF => sub {puke "Supplying an empty left hand side argument is not supported in array-pairs" },
802 push @sql_clauses, $sql;
803 push @all_bind, @bind;
807 return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
810 #======================================================================
811 # WHERE: top-level ARRAYREFREF
812 #======================================================================
814 sub _where_ARRAYREFREF {
815 my ($self, $where) = @_;
816 my ($sql, @bind) = @$$where;
817 $self->_assert_bindval_matches_bindtype(@bind);
818 return ($sql, @bind);
821 #======================================================================
822 # WHERE: top-level HASHREF
823 #======================================================================
826 my ($self, $where) = @_;
827 my (@sql_clauses, @all_bind);
829 for my $k (sort keys %$where) {
830 my $v = $where->{$k};
832 # ($k => $v) is either a special unary op or a regular hashpair
833 my ($sql, @bind) = do {
835 # put the operator in canonical form
837 $op = substr $op, 1; # remove initial dash
838 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
839 $op =~ s/\s+/ /g; # compress whitespace
841 # so that -not_foo works correctly
842 $op =~ s/^not_/NOT /i;
844 $self->_debug("Unary OP(-$op) within hashref, recursing...");
845 my ($s, @b) = $self->_where_unary_op($op, $v);
847 # top level vs nested
848 # we assume that handled unary ops will take care of their ()s
850 List::Util::first {$op =~ $_->{regex}} @{$self->{unary_ops}}
852 ( defined $self->{_nested_func_lhs} and $self->{_nested_func_lhs} eq $k )
858 if (is_literal_value ($v) ) {
859 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
862 puke "Supplying an empty left hand side argument is not supported in hash-pairs";
866 my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
867 $self->$method($k, $v);
871 push @sql_clauses, $sql;
872 push @all_bind, @bind;
875 return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
878 sub _where_unary_op {
879 my ($self, $op, $rhs) = @_;
881 $op =~ s/^-// if length($op) > 1;
883 # top level special ops are illegal in general
884 puke "Illegal use of top-level '-$op'"
885 if !(defined $self->{_nested_func_lhs})
886 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
887 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
889 if (my $op_entry = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
890 my $handler = $op_entry->{handler};
892 if (not ref $handler) {
893 if ($op =~ s/ [_\s]? \d+ $//x ) {
894 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
895 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
897 return $self->$handler($op, $rhs);
899 elsif (ref $handler eq 'CODE') {
900 return $handler->($self, $op, $rhs);
903 puke "Illegal handler for operator $op - expecting a method name or a coderef";
907 $self->_debug("Generic unary OP: $op - recursing as function");
909 $self->_assert_pass_injection_guard($op);
911 my ($sql, @bind) = $self->_SWITCH_refkind($rhs, {
913 puke "Illegal use of top-level '-$op'"
914 unless defined $self->{_nested_func_lhs};
917 $self->_convert('?'),
918 $self->_bindtype($self->{_nested_func_lhs}, $rhs)
922 $self->_recurse_where($rhs)
926 $sql = sprintf('%s %s',
927 $self->_sqlcase($op),
931 return ($sql, @bind);
934 sub _where_op_ANDOR {
935 my ($self, $op, $v) = @_;
937 $self->_SWITCH_refkind($v, {
939 return $self->_where_ARRAYREF($v, $op);
943 return ($op =~ /^or/i)
944 ? $self->_where_ARRAYREF([ map { $_ => $v->{$_} } (sort keys %$v) ], $op)
945 : $self->_where_HASHREF($v);
949 puke "-$op => \\\$scalar makes little sense, use " .
951 ? '[ \$scalar, \%rest_of_conditions ] instead'
952 : '-and => [ \$scalar, \%rest_of_conditions ] instead'
957 puke "-$op => \\[...] makes little sense, use " .
959 ? '[ \[...], \%rest_of_conditions ] instead'
960 : '-and => [ \[...], \%rest_of_conditions ] instead'
964 SCALAR => sub { # permissively interpreted as SQL
965 puke "-$op => \$value makes little sense, use -bool => \$value instead";
969 puke "-$op => undef not supported";
975 my ($self, $op, $v) = @_;
977 $self->_SWITCH_refkind($v, {
979 SCALAR => sub { # permissively interpreted as SQL
980 belch "literal SQL should be -nest => \\'scalar' "
981 . "instead of -nest => 'scalar' ";
986 puke "-$op => undef not supported";
990 $self->_recurse_where($v);
998 my ($self, $op, $v) = @_;
1000 my ($s, @b) = $self->_SWITCH_refkind($v, {
1001 SCALAR => sub { # interpreted as SQL column
1002 $self->_convert($self->_quote($v));
1006 puke "-$op => undef not supported";
1010 $self->_recurse_where($v);
1014 $s = "(NOT $s)" if $op =~ /^not/i;
1019 sub _where_op_IDENT {
1021 my ($op, $rhs) = splice @_, -2;
1022 if (! defined $rhs or length ref $rhs) {
1023 puke "-$op requires a single plain scalar argument (a quotable identifier)";
1026 # in case we are called as a top level special op (no '=')
1027 my $has_lhs = my $lhs = shift;
1029 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
1037 sub _where_op_VALUE {
1039 my ($op, $rhs) = splice @_, -2;
1041 # in case we are called as a top level special op (no '=')
1045 if (! defined $rhs) {
1047 ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
1054 (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
1061 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
1065 $self->_convert('?'),
1072 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
1078 my ($self, $args) = @_;
1079 my ($left, $low, $high) = @$args;
1080 my ($rhsql, @rhbind) = do {
1082 puke "Single arg to between must be a literal"
1083 unless $low->{-literal};
1086 local $self->{_nested_func_lhs} = $left->{-ident}
1087 if ref($left) eq 'HASH' and $left->{-ident};
1088 my ($l, $h) = map [ $self->_where_unary_op(%$_) ], $low, $high;
1089 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1090 @{$l}[1..$#$l], @{$h}[1..$#$h])
1093 my ($lhsql, @lhbind) = $self->_recurse_where($left);
1095 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1099 }), 'between', 'not between'),
1103 my ($self, $args) = @_;
1104 my ($lhs, $rhs) = @$args;
1107 local $self->{_nested_func_lhs} = $lhs->{-ident}
1108 if ref($lhs) eq 'HASH' and $lhs->{-ident};
1109 my ($sql, @bind) = $self->_where_unary_op(%$_);
1110 push @in_bind, @bind;
1113 my ($lhsql, @lbind) = $self->_recurse_where($lhs);
1115 $lhsql.' '.$self->_sqlcase($op).' ( '
1116 .join(', ', @in_sql)
1121 }), 'in', 'not in'),
1125 my ($self, undef, $v) = @_;
1126 my ($op, @args) = @$v;
1127 $op =~ s/^-// if length($op) > 1;
1128 local $self->{_nested_func_lhs};
1129 if (my $h = $special{$op}) {
1130 return $self->$h(\@args);
1133 my ($expr_sql, @bind) = $self->_recurse_where($args[0]);
1134 my $final_op = join ' ', split '_', $op;
1135 my $op_sql = $self->_sqlcase($final_op);
1137 $unop_postfix{lc($final_op)}
1138 ? "${expr_sql} ${op_sql}"
1139 : "${op_sql} ${expr_sql}"
1141 return ($final_sql, @bind);
1142 } elsif (@args == 2) {
1143 my ($l, $r) = map [ $self->_recurse_where($_) ], @args;
1144 return ( $l->[0].' '.$self->_sqlcase(join ' ', split '_', $op).' '.$r->[0], @{$l}[1..$#$l], @{$r}[1..$#$r] );
1149 sub _where_op_BIND {
1150 my ($self, undef, $bind) = @_;
1151 return ($self->_convert('?'), $self->_bindtype(@$bind));
1154 sub _where_op_LITERAL {
1155 my ($self, undef, $literal) = @_;
1156 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1160 sub _where_hashpair_ARRAYREF {
1161 my ($self, $k, $v) = @_;
1164 my @v = @$v; # need copy because of shift below
1165 $self->_debug("ARRAY($k) means distribute over elements");
1167 # put apart first element if it is an operator (-and, -or)
1169 (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
1173 my @distributed = map { {$k => $_} } @v;
1176 $self->_debug("OP($op) reinjected into the distributed array");
1177 unshift @distributed, $op;
1180 my $logic = $op ? substr($op, 1) : '';
1182 return $self->_recurse_where(\@distributed, $logic);
1185 $self->_debug("empty ARRAY($k) means 0=1");
1186 return ($self->{sqlfalse});
1190 sub _where_hashpair_HASHREF {
1191 my ($self, $k, $v, $logic) = @_;
1194 local $self->{_nested_func_lhs} = defined $self->{_nested_func_lhs}
1195 ? $self->{_nested_func_lhs}
1199 my ($all_sql, @all_bind);
1201 for my $orig_op (sort keys %$v) {
1202 my $val = $v->{$orig_op};
1204 # put the operator in canonical form
1207 # FIXME - we need to phase out dash-less ops
1208 $op =~ s/^-//; # remove possible initial dash
1209 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
1210 $op =~ s/\s+/ /g; # compress whitespace
1212 $self->_assert_pass_injection_guard($op);
1215 $op =~ s/^is_not/IS NOT/i;
1217 # so that -not_foo works correctly
1218 $op =~ s/^not_/NOT /i;
1220 # another retarded special case: foo => { $op => { -value => undef } }
1221 if (ref $val eq 'HASH' and keys %$val == 1 and exists $val->{-value} and ! defined $val->{-value} ) {
1227 # CASE: col-value logic modifiers
1228 if ($orig_op =~ /^ \- (and|or) $/xi) {
1229 ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $1);
1231 # CASE: special operators like -in or -between
1232 elsif (my $special_op = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1233 my $handler = $special_op->{handler};
1235 puke "No handler supplied for special operator $orig_op";
1237 elsif (not ref $handler) {
1238 ($sql, @bind) = $self->$handler($k, $op, $val);
1240 elsif (ref $handler eq 'CODE') {
1241 ($sql, @bind) = $handler->($self, $k, $op, $val);
1244 puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
1248 $self->_SWITCH_refkind($val, {
1250 ARRAYREF => sub { # CASE: col => {op => \@vals}
1251 ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
1254 ARRAYREFREF => sub { # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
1255 my ($sub_sql, @sub_bind) = @$$val;
1256 $self->_assert_bindval_matches_bindtype(@sub_bind);
1257 $sql = join ' ', $self->_convert($self->_quote($k)),
1258 $self->_sqlcase($op),
1263 UNDEF => sub { # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
1265 $op =~ /^not$/i ? 'is not' # legacy
1266 : $op =~ $self->{equality_op} ? 'is'
1267 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
1268 : $op =~ $self->{inequality_op} ? 'is not'
1269 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
1270 : puke "unexpected operator '$orig_op' with undef operand";
1272 $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
1275 FALLBACK => sub { # CASE: col => {op/func => $stuff}
1276 ($sql, @bind) = $self->_where_unary_op($op, $val);
1279 $self->_convert($self->_quote($k)),
1280 $self->{_nested_func_lhs} eq $k ? $sql : "($sql)", # top level vs nested
1286 ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
1287 push @all_bind, @bind;
1289 return ($all_sql, @all_bind);
1292 sub _where_field_IS {
1293 my ($self, $k, $op, $v) = @_;
1295 my ($s) = $self->_SWITCH_refkind($v, {
1298 $self->_convert($self->_quote($k)),
1299 map { $self->_sqlcase($_)} ($op, 'null')
1302 puke "$op can only take undef as argument";
1309 sub _where_field_op_ARRAYREF {
1310 my ($self, $k, $op, $vals) = @_;
1312 my @vals = @$vals; #always work on a copy
1315 $self->_debug(sprintf '%s means multiple elements: [ %s ]',
1317 join(', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
1320 # see if the first element is an -and/-or op
1322 if (defined $vals[0] && $vals[0] =~ /^ - (AND|OR) $/ix) {
1327 # a long standing API wart - an attempt to change this behavior during
1328 # the 1.50 series failed *spectacularly*. Warn instead and leave the
1333 (!$logic or $logic eq 'OR')
1335 ($op =~ $self->{inequality_op} or $op =~ $self->{not_like_op})
1338 belch "A multi-element arrayref as an argument to the inequality op '$o' "
1339 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1340 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1344 # distribute $op over each remaining member of @vals, append logic if exists
1345 return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
1349 # try to DWIM on equality operators
1351 $op =~ $self->{equality_op} ? $self->{sqlfalse}
1352 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
1353 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
1354 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
1355 : puke "operator '$op' applied on an empty array (field '$k')";
1360 sub _where_hashpair_SCALARREF {
1361 my ($self, $k, $v) = @_;
1362 $self->_debug("SCALAR($k) means literal SQL: $$v");
1363 my $sql = $self->_quote($k) . " " . $$v;
1367 # literal SQL with bind
1368 sub _where_hashpair_ARRAYREFREF {
1369 my ($self, $k, $v) = @_;
1370 $self->_debug("REF($k) means literal SQL: @${$v}");
1371 my ($sql, @bind) = @$$v;
1372 $self->_assert_bindval_matches_bindtype(@bind);
1373 $sql = $self->_quote($k) . " " . $sql;
1374 return ($sql, @bind );
1377 # literal SQL without bind
1378 sub _where_hashpair_SCALAR {
1379 my ($self, $k, $v) = @_;
1380 $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
1381 return ($self->_where_hashpair_HASHREF($k, { $self->{cmp} => $v }));
1385 sub _where_hashpair_UNDEF {
1386 my ($self, $k, $v) = @_;
1387 $self->_debug("UNDEF($k) means IS NULL");
1388 return $self->_where_hashpair_HASHREF($k, { -is => undef });
1391 #======================================================================
1392 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
1393 #======================================================================
1396 sub _where_SCALARREF {
1397 my ($self, $where) = @_;
1400 $self->_debug("SCALAR(*top) means literal SQL: $$where");
1406 my ($self, $where) = @_;
1409 $self->_debug("NOREF(*top) means literal SQL: $where");
1420 #======================================================================
1421 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
1422 #======================================================================
1425 sub _where_field_BETWEEN {
1426 my ($self, $k, $op, $vals) = @_;
1428 my ($label, $and, $placeholder);
1429 $label = $self->_convert($self->_quote($k));
1430 $and = ' ' . $self->_sqlcase('and') . ' ';
1431 $placeholder = $self->_convert('?');
1432 $op = $self->_sqlcase($op);
1434 my $invalid_args = "Operator '$op' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1436 my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
1437 ARRAYREFREF => sub {
1438 my ($s, @b) = @$$vals;
1439 $self->_assert_bindval_matches_bindtype(@b);
1446 puke $invalid_args if @$vals != 2;
1448 my (@all_sql, @all_bind);
1449 foreach my $val (@$vals) {
1450 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1452 return ($placeholder, $self->_bindtype($k, $val) );
1457 ARRAYREFREF => sub {
1458 my ($sql, @bind) = @$$val;
1459 $self->_assert_bindval_matches_bindtype(@bind);
1460 return ($sql, @bind);
1463 my ($func, $arg, @rest) = %$val;
1464 puke "Only simple { -func => arg } functions accepted as sub-arguments to BETWEEN"
1465 if (@rest or $func !~ /^ \- (.+)/x);
1466 $self->_where_unary_op($1 => $arg);
1472 push @all_sql, $sql;
1473 push @all_bind, @bind;
1477 (join $and, @all_sql),
1486 my $sql = "( $label $op $clause )";
1487 return ($sql, @bind)
1491 sub _where_field_IN {
1492 my ($self, $k, $op, $vals) = @_;
1494 # backwards compatibility: if scalar, force into an arrayref
1495 $vals = [$vals] if defined $vals && ! ref $vals;
1497 my ($label) = $self->_convert($self->_quote($k));
1498 my ($placeholder) = $self->_convert('?');
1499 $op = $self->_sqlcase($op);
1501 my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
1502 ARRAYREF => sub { # list of choices
1503 if (@$vals) { # nonempty list
1504 my (@all_sql, @all_bind);
1506 for my $val (@$vals) {
1507 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1509 return ($placeholder, $val);
1514 ARRAYREFREF => sub {
1515 my ($sql, @bind) = @$$val;
1516 $self->_assert_bindval_matches_bindtype(@bind);
1517 return ($sql, @bind);
1520 my ($func, $arg, @rest) = %$val;
1521 puke "Only simple { -func => arg } functions accepted as sub-arguments to IN"
1522 if (@rest or $func !~ /^ \- (.+)/x);
1523 $self->_where_unary_op($1 => $arg);
1527 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1528 . "-$op operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1529 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1530 . 'will emit the logically correct SQL instead of raising this exception)'
1534 push @all_sql, $sql;
1535 push @all_bind, @bind;
1539 sprintf('%s %s ( %s )',
1542 join(', ', @all_sql)
1544 $self->_bindtype($k, @all_bind),
1547 else { # empty list: some databases won't understand "IN ()", so DWIM
1548 my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
1553 SCALARREF => sub { # literal SQL
1554 my $sql = $self->_open_outer_paren($$vals);
1555 return ("$label $op ( $sql )");
1557 ARRAYREFREF => sub { # literal SQL with bind
1558 my ($sql, @bind) = @$$vals;
1559 $self->_assert_bindval_matches_bindtype(@bind);
1560 $sql = $self->_open_outer_paren($sql);
1561 return ("$label $op ( $sql )", @bind);
1565 puke "Argument passed to the '$op' operator can not be undefined";
1569 puke "special op $op requires an arrayref (or scalarref/arrayref-ref)";
1573 return ($sql, @bind);
1576 # Some databases (SQLite) treat col IN (1, 2) different from
1577 # col IN ( (1, 2) ). Use this to strip all outer parens while
1578 # adding them back in the corresponding method
1579 sub _open_outer_paren {
1580 my ($self, $sql) = @_;
1582 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1584 # there are closing parens inside, need the heavy duty machinery
1585 # to reevaluate the extraction starting from $sql (full reevaluation)
1586 if ($inner =~ /\)/) {
1587 require Text::Balanced;
1589 my (undef, $remainder) = do {
1590 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1592 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1595 # the entire expression needs to be a balanced bracketed thing
1596 # (after an extract no remainder sans trailing space)
1597 last if defined $remainder and $remainder =~ /\S/;
1607 #======================================================================
1609 #======================================================================
1612 my ($self, $arg) = @_;
1615 for my $c ($self->_order_by_chunks($arg) ) {
1616 $self->_SWITCH_refkind($c, {
1617 SCALAR => sub { push @sql, $c },
1618 ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1624 $self->_sqlcase(' order by'),
1630 return wantarray ? ($sql, @bind) : $sql;
1633 sub _order_by_chunks {
1634 my ($self, $arg) = @_;
1636 return $self->_SWITCH_refkind($arg, {
1639 map { $self->_order_by_chunks($_ ) } @$arg;
1642 ARRAYREFREF => sub {
1643 my ($s, @b) = @$$arg;
1644 $self->_assert_bindval_matches_bindtype(@b);
1648 SCALAR => sub {$self->_quote($arg)},
1650 UNDEF => sub {return () },
1652 SCALARREF => sub {$$arg}, # literal SQL, no quoting
1655 # get first pair in hash
1656 my ($key, $val, @rest) = %$arg;
1658 return () unless $key;
1660 if (@rest or not $key =~ /^-(desc|asc)/i) {
1661 puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1667 for my $c ($self->_order_by_chunks($val)) {
1670 $self->_SWITCH_refkind($c, {
1675 ($sql, @bind) = @$c;
1679 $sql = $sql . ' ' . $self->_sqlcase($direction);
1681 push @ret, [ $sql, @bind];
1690 #======================================================================
1691 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1692 #======================================================================
1697 $self->_SWITCH_refkind($from, {
1698 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$from;},
1699 SCALAR => sub {$self->_quote($from)},
1700 SCALARREF => sub {$$from},
1705 #======================================================================
1707 #======================================================================
1709 # highly optimized, as it's called way too often
1711 # my ($self, $label) = @_;
1713 return '' unless defined $_[1];
1714 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1716 $_[0]->{quote_char} or
1717 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1719 my $qref = ref $_[0]->{quote_char};
1721 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1722 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1723 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1725 my $esc = $_[0]->{escape_char} || $r;
1727 # parts containing * are naturally unquoted
1728 return join($_[0]->{name_sep}||'', map
1729 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1730 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1735 # Conversion, if applicable
1737 #my ($self, $arg) = @_;
1738 if ($_[0]->{convert}) {
1739 return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1746 #my ($self, $col, @vals) = @_;
1747 # called often - tighten code
1748 return $_[0]->{bindtype} eq 'columns'
1749 ? map {[$_[1], $_]} @_[2 .. $#_]
1754 # Dies if any element of @bind is not in [colname => value] format
1755 # if bindtype is 'columns'.
1756 sub _assert_bindval_matches_bindtype {
1757 # my ($self, @bind) = @_;
1759 if ($self->{bindtype} eq 'columns') {
1761 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1762 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1768 sub _join_sql_clauses {
1769 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1771 if (@$clauses_aref > 1) {
1772 my $join = " " . $self->_sqlcase($logic) . " ";
1773 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1774 return ($sql, @$bind_aref);
1776 elsif (@$clauses_aref) {
1777 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1780 return (); # if no SQL, ignore @$bind_aref
1785 # Fix SQL case, if so requested
1787 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1788 # don't touch the argument ... crooked logic, but let's not change it!
1789 return $_[0]->{case} ? $_[1] : uc($_[1]);
1793 #======================================================================
1794 # DISPATCHING FROM REFKIND
1795 #======================================================================
1798 my ($self, $data) = @_;
1800 return 'UNDEF' unless defined $data;
1802 # blessed objects are treated like scalars
1803 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1805 return 'SCALAR' unless $ref;
1808 while ($ref eq 'REF') {
1810 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1814 return ($ref||'SCALAR') . ('REF' x $n_steps);
1818 my ($self, $data) = @_;
1819 my @try = ($self->_refkind($data));
1820 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1821 push @try, 'FALLBACK';
1825 sub _METHOD_FOR_refkind {
1826 my ($self, $meth_prefix, $data) = @_;
1829 for (@{$self->_try_refkind($data)}) {
1830 $method = $self->can($meth_prefix."_".$_)
1834 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1838 sub _SWITCH_refkind {
1839 my ($self, $data, $dispatch_table) = @_;
1842 for (@{$self->_try_refkind($data)}) {
1843 $coderef = $dispatch_table->{$_}
1847 puke "no dispatch entry for ".$self->_refkind($data)
1856 #======================================================================
1857 # VALUES, GENERATE, AUTOLOAD
1858 #======================================================================
1860 # LDNOTE: original code from nwiger, didn't touch code in that section
1861 # I feel the AUTOLOAD stuff should not be the default, it should
1862 # only be activated on explicit demand by user.
1866 my $data = shift || return;
1867 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1868 unless ref $data eq 'HASH';
1871 foreach my $k (sort keys %$data) {
1872 my $v = $data->{$k};
1873 $self->_SWITCH_refkind($v, {
1875 if ($self->{array_datatypes}) { # array datatype
1876 push @all_bind, $self->_bindtype($k, $v);
1878 else { # literal SQL with bind
1879 my ($sql, @bind) = @$v;
1880 $self->_assert_bindval_matches_bindtype(@bind);
1881 push @all_bind, @bind;
1884 ARRAYREFREF => sub { # literal SQL with bind
1885 my ($sql, @bind) = @${$v};
1886 $self->_assert_bindval_matches_bindtype(@bind);
1887 push @all_bind, @bind;
1889 SCALARREF => sub { # literal SQL without bind
1891 SCALAR_or_UNDEF => sub {
1892 push @all_bind, $self->_bindtype($k, $v);
1903 my(@sql, @sqlq, @sqlv);
1907 if ($ref eq 'HASH') {
1908 for my $k (sort keys %$_) {
1911 my $label = $self->_quote($k);
1912 if ($r eq 'ARRAY') {
1913 # literal SQL with bind
1914 my ($sql, @bind) = @$v;
1915 $self->_assert_bindval_matches_bindtype(@bind);
1916 push @sqlq, "$label = $sql";
1918 } elsif ($r eq 'SCALAR') {
1919 # literal SQL without bind
1920 push @sqlq, "$label = $$v";
1922 push @sqlq, "$label = ?";
1923 push @sqlv, $self->_bindtype($k, $v);
1926 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1927 } elsif ($ref eq 'ARRAY') {
1928 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1931 if ($r eq 'ARRAY') { # literal SQL with bind
1932 my ($sql, @bind) = @$v;
1933 $self->_assert_bindval_matches_bindtype(@bind);
1936 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1937 # embedded literal SQL
1944 push @sql, '(' . join(', ', @sqlq) . ')';
1945 } elsif ($ref eq 'SCALAR') {
1949 # strings get case twiddled
1950 push @sql, $self->_sqlcase($_);
1954 my $sql = join ' ', @sql;
1956 # this is pretty tricky
1957 # if ask for an array, return ($stmt, @bind)
1958 # otherwise, s/?/shift @sqlv/ to put it inline
1960 return ($sql, @sqlv);
1962 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1963 ref $d ? $d->[1] : $d/e;
1972 # This allows us to check for a local, then _form, attr
1974 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1975 return $self->generate($name, @_);
1986 SQL::Abstract - Generate SQL from Perl data structures
1992 my $sql = SQL::Abstract->new;
1994 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1996 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1998 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2000 my($stmt, @bind) = $sql->delete($table, \%where);
2002 # Then, use these in your DBI statements
2003 my $sth = $dbh->prepare($stmt);
2004 $sth->execute(@bind);
2006 # Just generate the WHERE clause
2007 my($stmt, @bind) = $sql->where(\%where, $order);
2009 # Return values in the same order, for hashed queries
2010 # See PERFORMANCE section for more details
2011 my @bind = $sql->values(\%fieldvals);
2015 This module was inspired by the excellent L<DBIx::Abstract>.
2016 However, in using that module I found that what I really wanted
2017 to do was generate SQL, but still retain complete control over my
2018 statement handles and use the DBI interface. So, I set out to
2019 create an abstract SQL generation module.
2021 While based on the concepts used by L<DBIx::Abstract>, there are
2022 several important differences, especially when it comes to WHERE
2023 clauses. I have modified the concepts used to make the SQL easier
2024 to generate from Perl data structures and, IMO, more intuitive.
2025 The underlying idea is for this module to do what you mean, based
2026 on the data structures you provide it. The big advantage is that
2027 you don't have to modify your code every time your data changes,
2028 as this module figures it out.
2030 To begin with, an SQL INSERT is as easy as just specifying a hash
2031 of C<key=value> pairs:
2034 name => 'Jimbo Bobson',
2035 phone => '123-456-7890',
2036 address => '42 Sister Lane',
2037 city => 'St. Louis',
2038 state => 'Louisiana',
2041 The SQL can then be generated with this:
2043 my($stmt, @bind) = $sql->insert('people', \%data);
2045 Which would give you something like this:
2047 $stmt = "INSERT INTO people
2048 (address, city, name, phone, state)
2049 VALUES (?, ?, ?, ?, ?)";
2050 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2051 '123-456-7890', 'Louisiana');
2053 These are then used directly in your DBI code:
2055 my $sth = $dbh->prepare($stmt);
2056 $sth->execute(@bind);
2058 =head2 Inserting and Updating Arrays
2060 If your database has array types (like for example Postgres),
2061 activate the special option C<< array_datatypes => 1 >>
2062 when creating the C<SQL::Abstract> object.
2063 Then you may use an arrayref to insert and update database array types:
2065 my $sql = SQL::Abstract->new(array_datatypes => 1);
2067 planets => [qw/Mercury Venus Earth Mars/]
2070 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2074 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2076 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2079 =head2 Inserting and Updating SQL
2081 In order to apply SQL functions to elements of your C<%data> you may
2082 specify a reference to an arrayref for the given hash value. For example,
2083 if you need to execute the Oracle C<to_date> function on a value, you can
2084 say something like this:
2088 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2091 The first value in the array is the actual SQL. Any other values are
2092 optional and would be included in the bind values array. This gives
2095 my($stmt, @bind) = $sql->insert('people', \%data);
2097 $stmt = "INSERT INTO people (name, date_entered)
2098 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2099 @bind = ('Bill', '03/02/2003');
2101 An UPDATE is just as easy, all you change is the name of the function:
2103 my($stmt, @bind) = $sql->update('people', \%data);
2105 Notice that your C<%data> isn't touched; the module will generate
2106 the appropriately quirky SQL for you automatically. Usually you'll
2107 want to specify a WHERE clause for your UPDATE, though, which is
2108 where handling C<%where> hashes comes in handy...
2110 =head2 Complex where statements
2112 This module can generate pretty complicated WHERE statements
2113 easily. For example, simple C<key=value> pairs are taken to mean
2114 equality, and if you want to see if a field is within a set
2115 of values, you can use an arrayref. Let's say we wanted to
2116 SELECT some data based on this criteria:
2119 requestor => 'inna',
2120 worker => ['nwiger', 'rcwe', 'sfz'],
2121 status => { '!=', 'completed' }
2124 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2126 The above would give you something like this:
2128 $stmt = "SELECT * FROM tickets WHERE
2129 ( requestor = ? ) AND ( status != ? )
2130 AND ( worker = ? OR worker = ? OR worker = ? )";
2131 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2133 Which you could then use in DBI code like so:
2135 my $sth = $dbh->prepare($stmt);
2136 $sth->execute(@bind);
2142 The methods are simple. There's one for every major SQL operation,
2143 and a constructor you use first. The arguments are specified in a
2144 similar order for each method (table, then fields, then a where
2145 clause) to try and simplify things.
2147 =head2 new(option => 'value')
2149 The C<new()> function takes a list of options and values, and returns
2150 a new B<SQL::Abstract> object which can then be used to generate SQL
2151 through the methods below. The options accepted are:
2157 If set to 'lower', then SQL will be generated in all lowercase. By
2158 default SQL is generated in "textbook" case meaning something like:
2160 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2162 Any setting other than 'lower' is ignored.
2166 This determines what the default comparison operator is. By default
2167 it is C<=>, meaning that a hash like this:
2169 %where = (name => 'nwiger', email => 'nate@wiger.org');
2171 Will generate SQL like this:
2173 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2175 However, you may want loose comparisons by default, so if you set
2176 C<cmp> to C<like> you would get SQL such as:
2178 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2180 You can also override the comparison on an individual basis - see
2181 the huge section on L</"WHERE CLAUSES"> at the bottom.
2183 =item sqltrue, sqlfalse
2185 Expressions for inserting boolean values within SQL statements.
2186 By default these are C<1=1> and C<1=0>. They are used
2187 by the special operators C<-in> and C<-not_in> for generating
2188 correct SQL even when the argument is an empty array (see below).
2192 This determines the default logical operator for multiple WHERE
2193 statements in arrays or hashes. If absent, the default logic is "or"
2194 for arrays, and "and" for hashes. This means that a WHERE
2198 event_date => {'>=', '2/13/99'},
2199 event_date => {'<=', '4/24/03'},
2202 will generate SQL like this:
2204 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2206 This is probably not what you want given this query, though (look
2207 at the dates). To change the "OR" to an "AND", simply specify:
2209 my $sql = SQL::Abstract->new(logic => 'and');
2211 Which will change the above C<WHERE> to:
2213 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2215 The logic can also be changed locally by inserting
2216 a modifier in front of an arrayref:
2218 @where = (-and => [event_date => {'>=', '2/13/99'},
2219 event_date => {'<=', '4/24/03'} ]);
2221 See the L</"WHERE CLAUSES"> section for explanations.
2225 This will automatically convert comparisons using the specified SQL
2226 function for both column and value. This is mostly used with an argument
2227 of C<upper> or C<lower>, so that the SQL will have the effect of
2228 case-insensitive "searches". For example, this:
2230 $sql = SQL::Abstract->new(convert => 'upper');
2231 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2233 Will turn out the following SQL:
2235 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2237 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2238 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2239 not validate this option; it will just pass through what you specify verbatim).
2243 This is a kludge because many databases suck. For example, you can't
2244 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2245 Instead, you have to use C<bind_param()>:
2247 $sth->bind_param(1, 'reg data');
2248 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2250 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2251 which loses track of which field each slot refers to. Fear not.
2253 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2254 Currently, you can specify either C<normal> (default) or C<columns>. If you
2255 specify C<columns>, you will get an array that looks like this:
2257 my $sql = SQL::Abstract->new(bindtype => 'columns');
2258 my($stmt, @bind) = $sql->insert(...);
2261 [ 'column1', 'value1' ],
2262 [ 'column2', 'value2' ],
2263 [ 'column3', 'value3' ],
2266 You can then iterate through this manually, using DBI's C<bind_param()>.
2268 $sth->prepare($stmt);
2271 my($col, $data) = @$_;
2272 if ($col eq 'details' || $col eq 'comments') {
2273 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2274 } elsif ($col eq 'image') {
2275 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2277 $sth->bind_param($i, $data);
2281 $sth->execute; # execute without @bind now
2283 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2284 Basically, the advantage is still that you don't have to care which fields
2285 are or are not included. You could wrap that above C<for> loop in a simple
2286 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2287 get a layer of abstraction over manual SQL specification.
2289 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2290 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2291 will expect the bind values in this format.
2295 This is the character that a table or column name will be quoted
2296 with. By default this is an empty string, but you could set it to
2297 the character C<`>, to generate SQL like this:
2299 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2301 Alternatively, you can supply an array ref of two items, the first being the left
2302 hand quote character, and the second the right hand quote character. For
2303 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2304 that generates SQL like this:
2306 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2308 Quoting is useful if you have tables or columns names that are reserved
2309 words in your database's SQL dialect.
2313 This is the character that will be used to escape L</quote_char>s appearing
2314 in an identifier before it has been quoted.
2316 The parameter default in case of a single L</quote_char> character is the quote
2319 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2320 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2321 of the B<opening (left)> L</quote_char> within the identifier are currently left
2322 untouched. The default for opening-closing-style quotes may change in future
2323 versions, thus you are B<strongly encouraged> to specify the escape character
2328 This is the character that separates a table and column name. It is
2329 necessary to specify this when the C<quote_char> option is selected,
2330 so that tables and column names can be individually quoted like this:
2332 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2334 =item injection_guard
2336 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2337 column name specified in a query structure. This is a safety mechanism to avoid
2338 injection attacks when mishandling user input e.g.:
2340 my %condition_as_column_value_pairs = get_values_from_user();
2341 $sqla->select( ... , \%condition_as_column_value_pairs );
2343 If the expression matches an exception is thrown. Note that literal SQL
2344 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2346 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2348 =item array_datatypes
2350 When this option is true, arrayrefs in INSERT or UPDATE are
2351 interpreted as array datatypes and are passed directly
2353 When this option is false, arrayrefs are interpreted
2354 as literal SQL, just like refs to arrayrefs
2355 (but this behavior is for backwards compatibility; when writing
2356 new queries, use the "reference to arrayref" syntax
2362 Takes a reference to a list of "special operators"
2363 to extend the syntax understood by L<SQL::Abstract>.
2364 See section L</"SPECIAL OPERATORS"> for details.
2368 Takes a reference to a list of "unary operators"
2369 to extend the syntax understood by L<SQL::Abstract>.
2370 See section L</"UNARY OPERATORS"> for details.
2376 =head2 insert($table, \@values || \%fieldvals, \%options)
2378 This is the simplest function. You simply give it a table name
2379 and either an arrayref of values or hashref of field/value pairs.
2380 It returns an SQL INSERT statement and a list of bind values.
2381 See the sections on L</"Inserting and Updating Arrays"> and
2382 L</"Inserting and Updating SQL"> for information on how to insert
2383 with those data types.
2385 The optional C<\%options> hash reference may contain additional
2386 options to generate the insert SQL. Currently supported options
2393 Takes either a scalar of raw SQL fields, or an array reference of
2394 field names, and adds on an SQL C<RETURNING> statement at the end.
2395 This allows you to return data generated by the insert statement
2396 (such as row IDs) without performing another C<SELECT> statement.
2397 Note, however, this is not part of the SQL standard and may not
2398 be supported by all database engines.
2402 =head2 update($table, \%fieldvals, \%where, \%options)
2404 This takes a table, hashref of field/value pairs, and an optional
2405 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2407 See the sections on L</"Inserting and Updating Arrays"> and
2408 L</"Inserting and Updating SQL"> for information on how to insert
2409 with those data types.
2411 The optional C<\%options> hash reference may contain additional
2412 options to generate the update SQL. Currently supported options
2419 See the C<returning> option to
2420 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2424 =head2 select($source, $fields, $where, $order)
2426 This returns a SQL SELECT statement and associated list of bind values, as
2427 specified by the arguments:
2433 Specification of the 'FROM' part of the statement.
2434 The argument can be either a plain scalar (interpreted as a table
2435 name, will be quoted), or an arrayref (interpreted as a list
2436 of table names, joined by commas, quoted), or a scalarref
2437 (literal SQL, not quoted).
2441 Specification of the list of fields to retrieve from
2443 The argument can be either an arrayref (interpreted as a list
2444 of field names, will be joined by commas and quoted), or a
2445 plain scalar (literal SQL, not quoted).
2446 Please observe that this API is not as flexible as that of
2447 the first argument C<$source>, for backwards compatibility reasons.
2451 Optional argument to specify the WHERE part of the query.
2452 The argument is most often a hashref, but can also be
2453 an arrayref or plain scalar --
2454 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2458 Optional argument to specify the ORDER BY part of the query.
2459 The argument can be a scalar, a hashref or an arrayref
2460 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2466 =head2 delete($table, \%where, \%options)
2468 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2469 It returns an SQL DELETE statement and list of bind values.
2471 The optional C<\%options> hash reference may contain additional
2472 options to generate the delete SQL. Currently supported options
2479 See the C<returning> option to
2480 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2484 =head2 where(\%where, $order)
2486 This is used to generate just the WHERE clause. For example,
2487 if you have an arbitrary data structure and know what the
2488 rest of your SQL is going to look like, but want an easy way
2489 to produce a WHERE clause, use this. It returns an SQL WHERE
2490 clause and list of bind values.
2493 =head2 values(\%data)
2495 This just returns the values from the hash C<%data>, in the same
2496 order that would be returned from any of the other above queries.
2497 Using this allows you to markedly speed up your queries if you
2498 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2500 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2502 Warning: This is an experimental method and subject to change.
2504 This returns arbitrarily generated SQL. It's a really basic shortcut.
2505 It will return two different things, depending on return context:
2507 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2508 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2510 These would return the following:
2512 # First calling form
2513 $stmt = "CREATE TABLE test (?, ?)";
2514 @bind = (field1, field2);
2516 # Second calling form
2517 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2519 Depending on what you're trying to do, it's up to you to choose the correct
2520 format. In this example, the second form is what you would want.
2524 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2528 ALTER SESSION SET nls_date_format = 'MM/YY'
2530 You get the idea. Strings get their case twiddled, but everything
2531 else remains verbatim.
2533 =head1 EXPORTABLE FUNCTIONS
2535 =head2 is_plain_value
2537 Determines if the supplied argument is a plain value as understood by this
2542 =item * The value is C<undef>
2544 =item * The value is a non-reference
2546 =item * The value is an object with stringification overloading
2548 =item * The value is of the form C<< { -value => $anything } >>
2552 On failure returns C<undef>, on success returns a B<scalar> reference
2553 to the original supplied argument.
2559 The stringification overloading detection is rather advanced: it takes
2560 into consideration not only the presence of a C<""> overload, but if that
2561 fails also checks for enabled
2562 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2563 on either C<0+> or C<bool>.
2565 Unfortunately testing in the field indicates that this
2566 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2567 but only when very large numbers of stringifying objects are involved.
2568 At the time of writing ( Sep 2014 ) there is no clear explanation of
2569 the direct cause, nor is there a manageably small test case that reliably
2570 reproduces the problem.
2572 If you encounter any of the following exceptions in B<random places within
2573 your application stack> - this module may be to blame:
2575 Operation "ne": no method found,
2576 left argument in overloaded package <something>,
2577 right argument in overloaded package <something>
2581 Stub found while resolving method "???" overloading """" in package <something>
2583 If you fall victim to the above - please attempt to reduce the problem
2584 to something that could be sent to the L<SQL::Abstract developers
2585 |DBIx::Class/GETTING HELP/SUPPORT>
2586 (either publicly or privately). As a workaround in the meantime you can
2587 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2588 value, which will most likely eliminate your problem (at the expense of
2589 not being able to properly detect exotic forms of stringification).
2591 This notice and environment variable will be removed in a future version,
2592 as soon as the underlying problem is found and a reliable workaround is
2597 =head2 is_literal_value
2599 Determines if the supplied argument is a literal value as understood by this
2604 =item * C<\$sql_string>
2606 =item * C<\[ $sql_string, @bind_values ]>
2610 On failure returns C<undef>, on success returns an B<array> reference
2611 containing the unpacked version of the supplied literal SQL and bind values.
2613 =head1 WHERE CLAUSES
2617 This module uses a variation on the idea from L<DBIx::Abstract>. It
2618 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2619 module is that things in arrays are OR'ed, and things in hashes
2622 The easiest way to explain is to show lots of examples. After
2623 each C<%where> hash shown, it is assumed you used:
2625 my($stmt, @bind) = $sql->where(\%where);
2627 However, note that the C<%where> hash can be used directly in any
2628 of the other functions as well, as described above.
2630 =head2 Key-value pairs
2632 So, let's get started. To begin, a simple hash:
2636 status => 'completed'
2639 Is converted to SQL C<key = val> statements:
2641 $stmt = "WHERE user = ? AND status = ?";
2642 @bind = ('nwiger', 'completed');
2644 One common thing I end up doing is having a list of values that
2645 a field can be in. To do this, simply specify a list inside of
2650 status => ['assigned', 'in-progress', 'pending'];
2653 This simple code will create the following:
2655 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2656 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2658 A field associated to an empty arrayref will be considered a
2659 logical false and will generate 0=1.
2661 =head2 Tests for NULL values
2663 If the value part is C<undef> then this is converted to SQL <IS NULL>
2672 $stmt = "WHERE user = ? AND status IS NULL";
2675 To test if a column IS NOT NULL:
2679 status => { '!=', undef },
2682 =head2 Specific comparison operators
2684 If you want to specify a different type of operator for your comparison,
2685 you can use a hashref for a given column:
2689 status => { '!=', 'completed' }
2692 Which would generate:
2694 $stmt = "WHERE user = ? AND status != ?";
2695 @bind = ('nwiger', 'completed');
2697 To test against multiple values, just enclose the values in an arrayref:
2699 status => { '=', ['assigned', 'in-progress', 'pending'] };
2701 Which would give you:
2703 "WHERE status = ? OR status = ? OR status = ?"
2706 The hashref can also contain multiple pairs, in which case it is expanded
2707 into an C<AND> of its elements:
2711 status => { '!=', 'completed', -not_like => 'pending%' }
2714 # Or more dynamically, like from a form
2715 $where{user} = 'nwiger';
2716 $where{status}{'!='} = 'completed';
2717 $where{status}{'-not_like'} = 'pending%';
2719 # Both generate this
2720 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2721 @bind = ('nwiger', 'completed', 'pending%');
2724 To get an OR instead, you can combine it with the arrayref idea:
2728 priority => [ { '=', 2 }, { '>', 5 } ]
2731 Which would generate:
2733 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2734 @bind = ('2', '5', 'nwiger');
2736 If you want to include literal SQL (with or without bind values), just use a
2737 scalar reference or reference to an arrayref as the value:
2740 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2741 date_expires => { '<' => \"now()" }
2744 Which would generate:
2746 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2747 @bind = ('11/26/2008');
2750 =head2 Logic and nesting operators
2752 In the example above,
2753 there is a subtle trap if you want to say something like
2754 this (notice the C<AND>):
2756 WHERE priority != ? AND priority != ?
2758 Because, in Perl you I<can't> do this:
2760 priority => { '!=' => 2, '!=' => 1 }
2762 As the second C<!=> key will obliterate the first. The solution
2763 is to use the special C<-modifier> form inside an arrayref:
2765 priority => [ -and => {'!=', 2},
2769 Normally, these would be joined by C<OR>, but the modifier tells it
2770 to use C<AND> instead. (Hint: You can use this in conjunction with the
2771 C<logic> option to C<new()> in order to change the way your queries
2772 work by default.) B<Important:> Note that the C<-modifier> goes
2773 B<INSIDE> the arrayref, as an extra first element. This will
2774 B<NOT> do what you think it might:
2776 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2778 Here is a quick list of equivalencies, since there is some overlap:
2781 status => {'!=', 'completed', 'not like', 'pending%' }
2782 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2785 status => {'=', ['assigned', 'in-progress']}
2786 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2787 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2791 =head2 Special operators: IN, BETWEEN, etc.
2793 You can also use the hashref format to compare a list of fields using the
2794 C<IN> comparison operator, by specifying the list as an arrayref:
2797 status => 'completed',
2798 reportid => { -in => [567, 2335, 2] }
2801 Which would generate:
2803 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2804 @bind = ('completed', '567', '2335', '2');
2806 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2809 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2810 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2811 'sqltrue' (by default: C<1=1>).
2813 In addition to the array you can supply a chunk of literal sql or
2814 literal sql with bind:
2817 customer => { -in => \[
2818 'SELECT cust_id FROM cust WHERE balance > ?',
2821 status => { -in => \'SELECT status_codes FROM states' },
2827 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2828 AND status IN ( SELECT status_codes FROM states )
2832 Finally, if the argument to C<-in> is not a reference, it will be
2833 treated as a single-element array.
2835 Another pair of operators is C<-between> and C<-not_between>,
2836 used with an arrayref of two values:
2840 completion_date => {
2841 -not_between => ['2002-10-01', '2003-02-06']
2847 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2849 Just like with C<-in> all plausible combinations of literal SQL
2853 start0 => { -between => [ 1, 2 ] },
2854 start1 => { -between => \["? AND ?", 1, 2] },
2855 start2 => { -between => \"lower(x) AND upper(y)" },
2856 start3 => { -between => [
2858 \["upper(?)", 'stuff' ],
2865 ( start0 BETWEEN ? AND ? )
2866 AND ( start1 BETWEEN ? AND ? )
2867 AND ( start2 BETWEEN lower(x) AND upper(y) )
2868 AND ( start3 BETWEEN lower(x) AND upper(?) )
2870 @bind = (1, 2, 1, 2, 'stuff');
2873 These are the two builtin "special operators"; but the
2874 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2876 =head2 Unary operators: bool
2878 If you wish to test against boolean columns or functions within your
2879 database you can use the C<-bool> and C<-not_bool> operators. For
2880 example to test the column C<is_user> being true and the column
2881 C<is_enabled> being false you would use:-
2885 -not_bool => 'is_enabled',
2890 WHERE is_user AND NOT is_enabled
2892 If a more complex combination is required, testing more conditions,
2893 then you should use the and/or operators:-
2898 -not_bool => { two=> { -rlike => 'bar' } },
2899 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2910 (NOT ( three = ? OR three > ? ))
2913 =head2 Nested conditions, -and/-or prefixes
2915 So far, we've seen how multiple conditions are joined with a top-level
2916 C<AND>. We can change this by putting the different conditions we want in
2917 hashes and then putting those hashes in an array. For example:
2922 status => { -like => ['pending%', 'dispatched'] },
2926 status => 'unassigned',
2930 This data structure would create the following:
2932 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2933 OR ( user = ? AND status = ? ) )";
2934 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2937 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2938 to change the logic inside:
2944 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2945 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2952 $stmt = "WHERE ( user = ?
2953 AND ( ( workhrs > ? AND geo = ? )
2954 OR ( workhrs < ? OR geo = ? ) ) )";
2955 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2957 =head3 Algebraic inconsistency, for historical reasons
2959 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2960 operator goes C<outside> of the nested structure; whereas when connecting
2961 several constraints on one column, the C<-and> operator goes
2962 C<inside> the arrayref. Here is an example combining both features:
2965 -and => [a => 1, b => 2],
2966 -or => [c => 3, d => 4],
2967 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2972 WHERE ( ( ( a = ? AND b = ? )
2973 OR ( c = ? OR d = ? )
2974 OR ( e LIKE ? AND e LIKE ? ) ) )
2976 This difference in syntax is unfortunate but must be preserved for
2977 historical reasons. So be careful: the two examples below would
2978 seem algebraically equivalent, but they are not
2981 { -like => 'foo%' },
2982 { -like => '%bar' },
2984 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2987 { col => { -like => 'foo%' } },
2988 { col => { -like => '%bar' } },
2990 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2993 =head2 Literal SQL and value type operators
2995 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2996 side" is a column name and the "right side" is a value (normally rendered as
2997 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2998 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2999 alter this behavior. There are several ways of doing so.
3003 This is a virtual operator that signals the string to its right side is an
3004 identifier (a column name) and not a value. For example to compare two
3005 columns you would write:
3008 priority => { '<', 2 },
3009 requestor => { -ident => 'submitter' },
3014 $stmt = "WHERE priority < ? AND requestor = submitter";
3017 If you are maintaining legacy code you may see a different construct as
3018 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3023 This is a virtual operator that signals that the construct to its right side
3024 is a value to be passed to DBI. This is for example necessary when you want
3025 to write a where clause against an array (for RDBMS that support such
3026 datatypes). For example:
3029 array => { -value => [1, 2, 3] }
3034 $stmt = 'WHERE array = ?';
3035 @bind = ([1, 2, 3]);
3037 Note that if you were to simply say:
3043 the result would probably not be what you wanted:
3045 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3050 Finally, sometimes only literal SQL will do. To include a random snippet
3051 of SQL verbatim, you specify it as a scalar reference. Consider this only
3052 as a last resort. Usually there is a better way. For example:
3055 priority => { '<', 2 },
3056 requestor => { -in => \'(SELECT name FROM hitmen)' },
3061 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3064 Note that in this example, you only get one bind parameter back, since
3065 the verbatim SQL is passed as part of the statement.
3069 Never use untrusted input as a literal SQL argument - this is a massive
3070 security risk (there is no way to check literal snippets for SQL
3071 injections and other nastyness). If you need to deal with untrusted input
3072 use literal SQL with placeholders as described next.
3074 =head3 Literal SQL with placeholders and bind values (subqueries)
3076 If the literal SQL to be inserted has placeholders and bind values,
3077 use a reference to an arrayref (yes this is a double reference --
3078 not so common, but perfectly legal Perl). For example, to find a date
3079 in Postgres you can use something like this:
3082 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3087 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3090 Note that you must pass the bind values in the same format as they are returned
3091 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3092 to C<columns>, you must provide the bind values in the
3093 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3094 scalar value; most commonly the column name, but you can use any scalar value
3095 (including references and blessed references), L<SQL::Abstract> will simply
3096 pass it through intact. So if C<bindtype> is set to C<columns> the above
3097 example will look like:
3100 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3103 Literal SQL is especially useful for nesting parenthesized clauses in the
3104 main SQL query. Here is a first example:
3106 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3110 bar => \["IN ($sub_stmt)" => @sub_bind],
3115 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3116 WHERE c2 < ? AND c3 LIKE ?))";
3117 @bind = (1234, 100, "foo%");
3119 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3120 are expressed in the same way. Of course the C<$sub_stmt> and
3121 its associated bind values can be generated through a former call
3124 my ($sub_stmt, @sub_bind)
3125 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3126 c3 => {-like => "foo%"}});
3129 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3132 In the examples above, the subquery was used as an operator on a column;
3133 but the same principle also applies for a clause within the main C<%where>
3134 hash, like an EXISTS subquery:
3136 my ($sub_stmt, @sub_bind)
3137 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3138 my %where = ( -and => [
3140 \["EXISTS ($sub_stmt)" => @sub_bind],
3145 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3146 WHERE c1 = ? AND c2 > t0.c0))";
3150 Observe that the condition on C<c2> in the subquery refers to
3151 column C<t0.c0> of the main query: this is I<not> a bind
3152 value, so we have to express it through a scalar ref.
3153 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3154 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3155 what we wanted here.
3157 Finally, here is an example where a subquery is used
3158 for expressing unary negation:
3160 my ($sub_stmt, @sub_bind)
3161 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3162 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3164 lname => {like => '%son%'},
3165 \["NOT ($sub_stmt)" => @sub_bind],
3170 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3171 @bind = ('%son%', 10, 20)
3173 =head3 Deprecated usage of Literal SQL
3175 Below are some examples of archaic use of literal SQL. It is shown only as
3176 reference for those who deal with legacy code. Each example has a much
3177 better, cleaner and safer alternative that users should opt for in new code.
3183 my %where = ( requestor => \'IS NOT NULL' )
3185 $stmt = "WHERE requestor IS NOT NULL"
3187 This used to be the way of generating NULL comparisons, before the handling
3188 of C<undef> got formalized. For new code please use the superior syntax as
3189 described in L</Tests for NULL values>.
3193 my %where = ( requestor => \'= submitter' )
3195 $stmt = "WHERE requestor = submitter"
3197 This used to be the only way to compare columns. Use the superior L</-ident>
3198 method for all new code. For example an identifier declared in such a way
3199 will be properly quoted if L</quote_char> is properly set, while the legacy
3200 form will remain as supplied.
3204 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3206 $stmt = "WHERE completed > ? AND is_ready"
3207 @bind = ('2012-12-21')
3209 Using an empty string literal used to be the only way to express a boolean.
3210 For all new code please use the much more readable
3211 L<-bool|/Unary operators: bool> operator.
3217 These pages could go on for a while, since the nesting of the data
3218 structures this module can handle are pretty much unlimited (the
3219 module implements the C<WHERE> expansion as a recursive function
3220 internally). Your best bet is to "play around" with the module a
3221 little to see how the data structures behave, and choose the best
3222 format for your data based on that.
3224 And of course, all the values above will probably be replaced with
3225 variables gotten from forms or the command line. After all, if you
3226 knew everything ahead of time, you wouldn't have to worry about
3227 dynamically-generating SQL and could just hardwire it into your
3230 =head1 ORDER BY CLAUSES
3232 Some functions take an order by clause. This can either be a scalar (just a
3233 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3234 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3237 Given | Will Generate
3238 ---------------------------------------------------------------
3240 'colA' | ORDER BY colA
3242 [qw/colA colB/] | ORDER BY colA, colB
3244 {-asc => 'colA'} | ORDER BY colA ASC
3246 {-desc => 'colB'} | ORDER BY colB DESC
3248 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3250 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3252 \'colA DESC' | ORDER BY colA DESC
3254 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3255 | /* ...with $x bound to ? */
3258 { -asc => 'colA' }, | colA ASC,
3259 { -desc => [qw/colB/] }, | colB DESC,
3260 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3261 \'colE DESC', | colE DESC,
3262 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3263 ] | /* ...with $x bound to ? */
3264 ===============================================================
3268 =head1 SPECIAL OPERATORS
3270 my $sqlmaker = SQL::Abstract->new(special_ops => [
3274 my ($self, $field, $op, $arg) = @_;
3280 handler => 'method_name',
3284 A "special operator" is a SQL syntactic clause that can be
3285 applied to a field, instead of a usual binary operator.
3288 WHERE field IN (?, ?, ?)
3289 WHERE field BETWEEN ? AND ?
3290 WHERE MATCH(field) AGAINST (?, ?)
3292 Special operators IN and BETWEEN are fairly standard and therefore
3293 are builtin within C<SQL::Abstract> (as the overridable methods
3294 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3295 like the MATCH .. AGAINST example above which is specific to MySQL,
3296 you can write your own operator handlers - supply a C<special_ops>
3297 argument to the C<new> method. That argument takes an arrayref of
3298 operator definitions; each operator definition is a hashref with two
3305 the regular expression to match the operator
3309 Either a coderef or a plain scalar method name. In both cases
3310 the expected return is C<< ($sql, @bind) >>.
3312 When supplied with a method name, it is simply called on the
3313 L<SQL::Abstract> object as:
3315 $self->$method_name($field, $op, $arg)
3319 $field is the LHS of the operator
3320 $op is the part that matched the handler regex
3323 When supplied with a coderef, it is called as:
3325 $coderef->($self, $field, $op, $arg)
3330 For example, here is an implementation
3331 of the MATCH .. AGAINST syntax for MySQL
3333 my $sqlmaker = SQL::Abstract->new(special_ops => [
3335 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3336 {regex => qr/^match$/i,
3338 my ($self, $field, $op, $arg) = @_;
3339 $arg = [$arg] if not ref $arg;
3340 my $label = $self->_quote($field);
3341 my ($placeholder) = $self->_convert('?');
3342 my $placeholders = join ", ", (($placeholder) x @$arg);
3343 my $sql = $self->_sqlcase('match') . " ($label) "
3344 . $self->_sqlcase('against') . " ($placeholders) ";
3345 my @bind = $self->_bindtype($field, @$arg);
3346 return ($sql, @bind);
3353 =head1 UNARY OPERATORS
3355 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3359 my ($self, $op, $arg) = @_;
3365 handler => 'method_name',
3369 A "unary operator" is a SQL syntactic clause that can be
3370 applied to a field - the operator goes before the field
3372 You can write your own operator handlers - supply a C<unary_ops>
3373 argument to the C<new> method. That argument takes an arrayref of
3374 operator definitions; each operator definition is a hashref with two
3381 the regular expression to match the operator
3385 Either a coderef or a plain scalar method name. In both cases
3386 the expected return is C<< $sql >>.
3388 When supplied with a method name, it is simply called on the
3389 L<SQL::Abstract> object as:
3391 $self->$method_name($op, $arg)
3395 $op is the part that matched the handler regex
3396 $arg is the RHS or argument of the operator
3398 When supplied with a coderef, it is called as:
3400 $coderef->($self, $op, $arg)
3408 Thanks to some benchmarking by Mark Stosberg, it turns out that
3409 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3410 I must admit this wasn't an intentional design issue, but it's a
3411 byproduct of the fact that you get to control your C<DBI> handles
3414 To maximize performance, use a code snippet like the following:
3416 # prepare a statement handle using the first row
3417 # and then reuse it for the rest of the rows
3419 for my $href (@array_of_hashrefs) {
3420 $stmt ||= $sql->insert('table', $href);
3421 $sth ||= $dbh->prepare($stmt);
3422 $sth->execute($sql->values($href));
3425 The reason this works is because the keys in your C<$href> are sorted
3426 internally by B<SQL::Abstract>. Thus, as long as your data retains
3427 the same structure, you only have to generate the SQL the first time
3428 around. On subsequent queries, simply use the C<values> function provided
3429 by this module to return your values in the correct order.
3431 However this depends on the values having the same type - if, for
3432 example, the values of a where clause may either have values
3433 (resulting in sql of the form C<column = ?> with a single bind
3434 value), or alternatively the values might be C<undef> (resulting in
3435 sql of the form C<column IS NULL> with no bind value) then the
3436 caching technique suggested will not work.
3440 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3441 really like this part (I do, at least). Building up a complex query
3442 can be as simple as the following:
3449 use CGI::FormBuilder;
3452 my $form = CGI::FormBuilder->new(...);
3453 my $sql = SQL::Abstract->new;
3455 if ($form->submitted) {
3456 my $field = $form->field;
3457 my $id = delete $field->{id};
3458 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3461 Of course, you would still have to connect using C<DBI> to run the
3462 query, but the point is that if you make your form look like your
3463 table, the actual query script can be extremely simplistic.
3465 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3466 a fast interface to returning and formatting data. I frequently
3467 use these three modules together to write complex database query
3468 apps in under 50 lines.
3470 =head1 HOW TO CONTRIBUTE
3472 Contributions are always welcome, in all usable forms (we especially
3473 welcome documentation improvements). The delivery methods include git-
3474 or unified-diff formatted patches, GitHub pull requests, or plain bug
3475 reports either via RT or the Mailing list. Contributors are generally
3476 granted full access to the official repository after their first several
3477 patches pass successful review.
3479 This project is maintained in a git repository. The code and related tools are
3480 accessible at the following locations:
3484 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3486 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3488 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3490 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3496 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3497 Great care has been taken to preserve the I<published> behavior
3498 documented in previous versions in the 1.* family; however,
3499 some features that were previously undocumented, or behaved
3500 differently from the documentation, had to be changed in order
3501 to clarify the semantics. Hence, client code that was relying
3502 on some dark areas of C<SQL::Abstract> v1.*
3503 B<might behave differently> in v1.50.
3505 The main changes are:
3511 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3515 support for the { operator => \"..." } construct (to embed literal SQL)
3519 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3523 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3527 defensive programming: check arguments
3531 fixed bug with global logic, which was previously implemented
3532 through global variables yielding side-effects. Prior versions would
3533 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3534 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3535 Now this is interpreted
3536 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3541 fixed semantics of _bindtype on array args
3545 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3546 we just avoid shifting arrays within that tree.
3550 dropped the C<_modlogic> function
3554 =head1 ACKNOWLEDGEMENTS
3556 There are a number of individuals that have really helped out with
3557 this module. Unfortunately, most of them submitted bugs via CPAN
3558 so I have no idea who they are! But the people I do know are:
3560 Ash Berlin (order_by hash term support)
3561 Matt Trout (DBIx::Class support)
3562 Mark Stosberg (benchmarking)
3563 Chas Owens (initial "IN" operator support)
3564 Philip Collins (per-field SQL functions)
3565 Eric Kolve (hashref "AND" support)
3566 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3567 Dan Kubb (support for "quote_char" and "name_sep")
3568 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3569 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3570 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3571 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3572 Oliver Charles (support for "RETURNING" after "INSERT")
3578 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3582 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3584 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3586 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3587 While not an official support venue, C<DBIx::Class> makes heavy use of
3588 C<SQL::Abstract>, and as such list members there are very familiar with
3589 how to create queries.
3593 This module is free software; you may copy this under the same
3594 terms as perl itself (either the GNU General Public License or
3595 the Artistic License)