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 => '_where_field_BETWEEN'},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => '_where_field_IN'},
42 {regex => qr/^ ident $/ix, handler => '_where_op_IDENT'},
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),
695 if (ref($v) eq 'ARRAY') {
696 return $self->{sqlfalse} unless @$v;
697 $self->_debug("ARRAY($k) means distribute over elements");
699 $v->[0] =~ /^-((?:and|or))$/i
700 ? ($v = [ @{$v}[1..$#$v] ], $1)
701 : ($self->{logic} || 'or')
703 return +{ "-${this_logic}" => [ map $self->_expand_expr({ $k => $_ }, $this_logic), @$v ] };
705 if (my $literal = is_literal_value($v)) {
707 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
710 my ($sql, @bind) = @$literal;
711 if ($self->{bindtype} eq 'columns') {
713 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
714 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
718 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
725 my ($self, $where, $logic) = @_;
727 my $where_exp = $self->_expand_expr($where, $logic);
729 # dispatch on appropriate method according to refkind of $where
730 my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
732 my ($sql, @bind) = $self->$method($where_exp, $logic);
734 # DBIx::Class used to call _recurse_where in scalar context
735 # something else might too...
737 return ($sql, @bind);
740 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
747 #======================================================================
748 # WHERE: top-level ARRAYREF
749 #======================================================================
752 sub _where_ARRAYREF {
753 my ($self, $where, $logic) = @_;
755 $logic = uc($logic || $self->{logic});
756 $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
758 my @clauses = @$where;
760 my (@sql_clauses, @all_bind);
761 # need to use while() so can shift() for pairs
763 my $el = shift @clauses;
765 $el = undef if (defined $el and ! length $el);
767 # switch according to kind of $el and get corresponding ($sql, @bind)
768 my ($sql, @bind) = $self->_SWITCH_refkind($el, {
770 # skip empty elements, otherwise get invalid trailing AND stuff
771 ARRAYREF => sub {$self->_recurse_where($el) if @$el},
775 $self->_assert_bindval_matches_bindtype(@b);
779 HASHREF => sub {$self->_recurse_where($el, 'and') if %$el},
781 SCALARREF => sub { ($$el); },
784 # top-level arrayref with scalars, recurse in pairs
785 $self->_recurse_where({$el => shift(@clauses)})
788 UNDEF => sub {puke "Supplying an empty left hand side argument is not supported in array-pairs" },
792 push @sql_clauses, $sql;
793 push @all_bind, @bind;
797 return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
800 #======================================================================
801 # WHERE: top-level ARRAYREFREF
802 #======================================================================
804 sub _where_ARRAYREFREF {
805 my ($self, $where) = @_;
806 my ($sql, @bind) = @$$where;
807 $self->_assert_bindval_matches_bindtype(@bind);
808 return ($sql, @bind);
811 #======================================================================
812 # WHERE: top-level HASHREF
813 #======================================================================
816 my ($self, $where) = @_;
817 my (@sql_clauses, @all_bind);
819 for my $k (sort keys %$where) {
820 my $v = $where->{$k};
822 # ($k => $v) is either a special unary op or a regular hashpair
823 my ($sql, @bind) = do {
825 # put the operator in canonical form
827 $op = substr $op, 1; # remove initial dash
828 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
829 $op =~ s/\s+/ /g; # compress whitespace
831 # so that -not_foo works correctly
832 $op =~ s/^not_/NOT /i;
834 $self->_debug("Unary OP(-$op) within hashref, recursing...");
835 my ($s, @b) = $self->_where_unary_op($op, $v);
837 # top level vs nested
838 # we assume that handled unary ops will take care of their ()s
840 List::Util::first {$op =~ $_->{regex}} @{$self->{unary_ops}}
842 ( defined $self->{_nested_func_lhs} and $self->{_nested_func_lhs} eq $k )
848 if (is_literal_value ($v) ) {
849 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
852 puke "Supplying an empty left hand side argument is not supported in hash-pairs";
856 my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
857 $self->$method($k, $v);
861 push @sql_clauses, $sql;
862 push @all_bind, @bind;
865 return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
868 sub _where_unary_op {
869 my ($self, $op, $rhs) = @_;
871 $op =~ s/^-// if length($op) > 1;
873 # top level special ops are illegal in general
874 puke "Illegal use of top-level '-$op'"
875 if !(defined $self->{_nested_func_lhs})
876 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
877 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
879 if (my $op_entry = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
880 my $handler = $op_entry->{handler};
882 if (not ref $handler) {
883 if ($op =~ s/ [_\s]? \d+ $//x ) {
884 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
885 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
887 return $self->$handler($op, $rhs);
889 elsif (ref $handler eq 'CODE') {
890 return $handler->($self, $op, $rhs);
893 puke "Illegal handler for operator $op - expecting a method name or a coderef";
897 $self->_debug("Generic unary OP: $op - recursing as function");
899 $self->_assert_pass_injection_guard($op);
901 my ($sql, @bind) = $self->_SWITCH_refkind($rhs, {
903 puke "Illegal use of top-level '-$op'"
904 unless defined $self->{_nested_func_lhs};
907 $self->_convert('?'),
908 $self->_bindtype($self->{_nested_func_lhs}, $rhs)
912 $self->_recurse_where($rhs)
916 $sql = sprintf('%s %s',
917 $self->_sqlcase($op),
921 return ($sql, @bind);
924 sub _where_op_ANDOR {
925 my ($self, $op, $v) = @_;
927 $self->_SWITCH_refkind($v, {
929 return $self->_where_ARRAYREF($v, $op);
933 return ($op =~ /^or/i)
934 ? $self->_where_ARRAYREF([ map { $_ => $v->{$_} } (sort keys %$v) ], $op)
935 : $self->_where_HASHREF($v);
939 puke "-$op => \\\$scalar makes little sense, use " .
941 ? '[ \$scalar, \%rest_of_conditions ] instead'
942 : '-and => [ \$scalar, \%rest_of_conditions ] instead'
947 puke "-$op => \\[...] makes little sense, use " .
949 ? '[ \[...], \%rest_of_conditions ] instead'
950 : '-and => [ \[...], \%rest_of_conditions ] instead'
954 SCALAR => sub { # permissively interpreted as SQL
955 puke "-$op => \$value makes little sense, use -bool => \$value instead";
959 puke "-$op => undef not supported";
965 my ($self, $op, $v) = @_;
967 $self->_SWITCH_refkind($v, {
969 SCALAR => sub { # permissively interpreted as SQL
970 belch "literal SQL should be -nest => \\'scalar' "
971 . "instead of -nest => 'scalar' ";
976 puke "-$op => undef not supported";
980 $self->_recurse_where($v);
988 my ($self, $op, $v) = @_;
990 my ($s, @b) = $self->_SWITCH_refkind($v, {
991 SCALAR => sub { # interpreted as SQL column
992 $self->_convert($self->_quote($v));
996 puke "-$op => undef not supported";
1000 $self->_recurse_where($v);
1004 $s = "(NOT $s)" if $op =~ /^not/i;
1009 sub _where_op_IDENT {
1011 my ($op, $rhs) = splice @_, -2;
1012 if (! defined $rhs or length ref $rhs) {
1013 puke "-$op requires a single plain scalar argument (a quotable identifier)";
1016 # in case we are called as a top level special op (no '=')
1017 my $has_lhs = my $lhs = shift;
1019 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
1027 sub _where_op_VALUE {
1029 my ($op, $rhs) = splice @_, -2;
1031 # in case we are called as a top level special op (no '=')
1035 if (! defined $rhs) {
1037 ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
1044 (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
1051 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
1055 $self->_convert('?'),
1062 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
1068 my ($self, $args) = @_;
1069 my ($left, $low, $high) = @$args;
1070 my ($rhsql, @rhbind) = do {
1072 puke "Single arg to between must be a literal"
1073 unless $low->{-literal};
1076 local $self->{_nested_func_lhs} = $left->{-ident}
1077 if ref($left) eq 'HASH' and $left->{-ident};
1078 my ($l, $h) = map [ $self->_where_unary_op(%$_) ], $low, $high;
1079 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1080 @{$l}[1..$#$l], @{$h}[1..$#$h])
1083 my ($lhsql, @lhbind) = $self->_recurse_where($left);
1085 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1089 }), 'between', 'not between'),
1093 my ($self, $args) = @_;
1094 my ($lhs, $rhs) = @$args;
1097 local $self->{_nested_func_lhs} = $lhs->{-ident}
1098 if ref($lhs) eq 'HASH' and $lhs->{-ident};
1099 my ($sql, @bind) = $self->_where_unary_op(%$_);
1100 push @in_bind, @bind;
1103 my ($lhsql, @lbind) = $self->_recurse_where($lhs);
1105 $lhsql.' '.$self->_sqlcase($op).' ( '
1106 .join(', ', @in_sql)
1111 }), 'in', 'not in'),
1115 my ($self, undef, $v) = @_;
1116 my ($op, @args) = @$v;
1117 $op =~ s/^-// if length($op) > 1;
1118 local $self->{_nested_func_lhs};
1119 if (my $h = $special{$op}) {
1120 return $self->$h(\@args);
1123 my ($expr_sql, @bind) = $self->_recurse_where($args[0]);
1124 my $final_op = join ' ', split '_', $op;
1125 my $op_sql = $self->_sqlcase($final_op);
1127 $unop_postfix{lc($final_op)}
1128 ? "${expr_sql} ${op_sql}"
1129 : "${op_sql} ${expr_sql}"
1131 return ($final_sql, @bind);
1132 } elsif (@args == 2) {
1133 my ($l, $r) = map [ $self->_recurse_where($_) ], @args;
1134 return ( $l->[0].' '.$self->_sqlcase(join ' ', split '_', $op).' '.$r->[0], @{$l}[1..$#$l], @{$r}[1..$#$r] );
1139 sub _where_op_BIND {
1140 my ($self, undef, $bind) = @_;
1141 return ($self->_convert('?'), $self->_bindtype(@$bind));
1144 sub _where_op_LITERAL {
1145 my ($self, undef, $literal) = @_;
1146 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1150 sub _where_hashpair_ARRAYREF {
1151 my ($self, $k, $v) = @_;
1154 my @v = @$v; # need copy because of shift below
1155 $self->_debug("ARRAY($k) means distribute over elements");
1157 # put apart first element if it is an operator (-and, -or)
1159 (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
1163 my @distributed = map { {$k => $_} } @v;
1166 $self->_debug("OP($op) reinjected into the distributed array");
1167 unshift @distributed, $op;
1170 my $logic = $op ? substr($op, 1) : '';
1172 return $self->_recurse_where(\@distributed, $logic);
1175 $self->_debug("empty ARRAY($k) means 0=1");
1176 return ($self->{sqlfalse});
1180 sub _where_hashpair_HASHREF {
1181 my ($self, $k, $v, $logic) = @_;
1184 local $self->{_nested_func_lhs} = defined $self->{_nested_func_lhs}
1185 ? $self->{_nested_func_lhs}
1189 my ($all_sql, @all_bind);
1191 for my $orig_op (sort keys %$v) {
1192 my $val = $v->{$orig_op};
1194 # put the operator in canonical form
1197 # FIXME - we need to phase out dash-less ops
1198 $op =~ s/^-//; # remove possible initial dash
1199 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
1200 $op =~ s/\s+/ /g; # compress whitespace
1202 $self->_assert_pass_injection_guard($op);
1205 $op =~ s/^is_not/IS NOT/i;
1207 # so that -not_foo works correctly
1208 $op =~ s/^not_/NOT /i;
1210 # another retarded special case: foo => { $op => { -value => undef } }
1211 if (ref $val eq 'HASH' and keys %$val == 1 and exists $val->{-value} and ! defined $val->{-value} ) {
1217 # CASE: col-value logic modifiers
1218 if ($orig_op =~ /^ \- (and|or) $/xi) {
1219 ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $1);
1221 # CASE: special operators like -in or -between
1222 elsif (my $special_op = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1223 my $handler = $special_op->{handler};
1225 puke "No handler supplied for special operator $orig_op";
1227 elsif (not ref $handler) {
1228 ($sql, @bind) = $self->$handler($k, $op, $val);
1230 elsif (ref $handler eq 'CODE') {
1231 ($sql, @bind) = $handler->($self, $k, $op, $val);
1234 puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
1238 $self->_SWITCH_refkind($val, {
1240 ARRAYREF => sub { # CASE: col => {op => \@vals}
1241 ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
1244 ARRAYREFREF => sub { # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
1245 my ($sub_sql, @sub_bind) = @$$val;
1246 $self->_assert_bindval_matches_bindtype(@sub_bind);
1247 $sql = join ' ', $self->_convert($self->_quote($k)),
1248 $self->_sqlcase($op),
1253 UNDEF => sub { # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
1255 $op =~ /^not$/i ? 'is not' # legacy
1256 : $op =~ $self->{equality_op} ? 'is'
1257 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
1258 : $op =~ $self->{inequality_op} ? 'is not'
1259 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
1260 : puke "unexpected operator '$orig_op' with undef operand";
1262 $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
1265 FALLBACK => sub { # CASE: col => {op/func => $stuff}
1266 ($sql, @bind) = $self->_where_unary_op($op, $val);
1269 $self->_convert($self->_quote($k)),
1270 $self->{_nested_func_lhs} eq $k ? $sql : "($sql)", # top level vs nested
1276 ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
1277 push @all_bind, @bind;
1279 return ($all_sql, @all_bind);
1282 sub _where_field_IS {
1283 my ($self, $k, $op, $v) = @_;
1285 my ($s) = $self->_SWITCH_refkind($v, {
1288 $self->_convert($self->_quote($k)),
1289 map { $self->_sqlcase($_)} ($op, 'null')
1292 puke "$op can only take undef as argument";
1299 sub _where_field_op_ARRAYREF {
1300 my ($self, $k, $op, $vals) = @_;
1302 my @vals = @$vals; #always work on a copy
1305 $self->_debug(sprintf '%s means multiple elements: [ %s ]',
1307 join(', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
1310 # see if the first element is an -and/-or op
1312 if (defined $vals[0] && $vals[0] =~ /^ - (AND|OR) $/ix) {
1317 # a long standing API wart - an attempt to change this behavior during
1318 # the 1.50 series failed *spectacularly*. Warn instead and leave the
1323 (!$logic or $logic eq 'OR')
1325 ($op =~ $self->{inequality_op} or $op =~ $self->{not_like_op})
1328 belch "A multi-element arrayref as an argument to the inequality op '$o' "
1329 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1330 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1334 # distribute $op over each remaining member of @vals, append logic if exists
1335 return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
1339 # try to DWIM on equality operators
1341 $op =~ $self->{equality_op} ? $self->{sqlfalse}
1342 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
1343 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
1344 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
1345 : puke "operator '$op' applied on an empty array (field '$k')";
1350 sub _where_hashpair_SCALARREF {
1351 my ($self, $k, $v) = @_;
1352 $self->_debug("SCALAR($k) means literal SQL: $$v");
1353 my $sql = $self->_quote($k) . " " . $$v;
1357 # literal SQL with bind
1358 sub _where_hashpair_ARRAYREFREF {
1359 my ($self, $k, $v) = @_;
1360 $self->_debug("REF($k) means literal SQL: @${$v}");
1361 my ($sql, @bind) = @$$v;
1362 $self->_assert_bindval_matches_bindtype(@bind);
1363 $sql = $self->_quote($k) . " " . $sql;
1364 return ($sql, @bind );
1367 # literal SQL without bind
1368 sub _where_hashpair_SCALAR {
1369 my ($self, $k, $v) = @_;
1370 $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
1371 return ($self->_where_hashpair_HASHREF($k, { $self->{cmp} => $v }));
1375 sub _where_hashpair_UNDEF {
1376 my ($self, $k, $v) = @_;
1377 $self->_debug("UNDEF($k) means IS NULL");
1378 return $self->_where_hashpair_HASHREF($k, { -is => undef });
1381 #======================================================================
1382 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
1383 #======================================================================
1386 sub _where_SCALARREF {
1387 my ($self, $where) = @_;
1390 $self->_debug("SCALAR(*top) means literal SQL: $$where");
1396 my ($self, $where) = @_;
1399 $self->_debug("NOREF(*top) means literal SQL: $where");
1410 #======================================================================
1411 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
1412 #======================================================================
1415 sub _where_field_BETWEEN {
1416 my ($self, $k, $op, $vals) = @_;
1418 my ($label, $and, $placeholder);
1419 $label = $self->_convert($self->_quote($k));
1420 $and = ' ' . $self->_sqlcase('and') . ' ';
1421 $placeholder = $self->_convert('?');
1422 $op = $self->_sqlcase($op);
1424 my $invalid_args = "Operator '$op' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1426 my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
1427 ARRAYREFREF => sub {
1428 my ($s, @b) = @$$vals;
1429 $self->_assert_bindval_matches_bindtype(@b);
1436 puke $invalid_args if @$vals != 2;
1438 my (@all_sql, @all_bind);
1439 foreach my $val (@$vals) {
1440 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1442 return ($placeholder, $self->_bindtype($k, $val) );
1447 ARRAYREFREF => sub {
1448 my ($sql, @bind) = @$$val;
1449 $self->_assert_bindval_matches_bindtype(@bind);
1450 return ($sql, @bind);
1453 my ($func, $arg, @rest) = %$val;
1454 puke "Only simple { -func => arg } functions accepted as sub-arguments to BETWEEN"
1455 if (@rest or $func !~ /^ \- (.+)/x);
1456 $self->_where_unary_op($1 => $arg);
1462 push @all_sql, $sql;
1463 push @all_bind, @bind;
1467 (join $and, @all_sql),
1476 my $sql = "( $label $op $clause )";
1477 return ($sql, @bind)
1481 sub _where_field_IN {
1482 my ($self, $k, $op, $vals) = @_;
1484 # backwards compatibility: if scalar, force into an arrayref
1485 $vals = [$vals] if defined $vals && ! ref $vals;
1487 my ($label) = $self->_convert($self->_quote($k));
1488 my ($placeholder) = $self->_convert('?');
1489 $op = $self->_sqlcase($op);
1491 my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
1492 ARRAYREF => sub { # list of choices
1493 if (@$vals) { # nonempty list
1494 my (@all_sql, @all_bind);
1496 for my $val (@$vals) {
1497 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1499 return ($placeholder, $val);
1504 ARRAYREFREF => sub {
1505 my ($sql, @bind) = @$$val;
1506 $self->_assert_bindval_matches_bindtype(@bind);
1507 return ($sql, @bind);
1510 my ($func, $arg, @rest) = %$val;
1511 puke "Only simple { -func => arg } functions accepted as sub-arguments to IN"
1512 if (@rest or $func !~ /^ \- (.+)/x);
1513 $self->_where_unary_op($1 => $arg);
1517 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1518 . "-$op operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1519 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1520 . 'will emit the logically correct SQL instead of raising this exception)'
1524 push @all_sql, $sql;
1525 push @all_bind, @bind;
1529 sprintf('%s %s ( %s )',
1532 join(', ', @all_sql)
1534 $self->_bindtype($k, @all_bind),
1537 else { # empty list: some databases won't understand "IN ()", so DWIM
1538 my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
1543 SCALARREF => sub { # literal SQL
1544 my $sql = $self->_open_outer_paren($$vals);
1545 return ("$label $op ( $sql )");
1547 ARRAYREFREF => sub { # literal SQL with bind
1548 my ($sql, @bind) = @$$vals;
1549 $self->_assert_bindval_matches_bindtype(@bind);
1550 $sql = $self->_open_outer_paren($sql);
1551 return ("$label $op ( $sql )", @bind);
1555 puke "Argument passed to the '$op' operator can not be undefined";
1559 puke "special op $op requires an arrayref (or scalarref/arrayref-ref)";
1563 return ($sql, @bind);
1566 # Some databases (SQLite) treat col IN (1, 2) different from
1567 # col IN ( (1, 2) ). Use this to strip all outer parens while
1568 # adding them back in the corresponding method
1569 sub _open_outer_paren {
1570 my ($self, $sql) = @_;
1572 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1574 # there are closing parens inside, need the heavy duty machinery
1575 # to reevaluate the extraction starting from $sql (full reevaluation)
1576 if ($inner =~ /\)/) {
1577 require Text::Balanced;
1579 my (undef, $remainder) = do {
1580 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1582 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1585 # the entire expression needs to be a balanced bracketed thing
1586 # (after an extract no remainder sans trailing space)
1587 last if defined $remainder and $remainder =~ /\S/;
1597 #======================================================================
1599 #======================================================================
1602 my ($self, $arg) = @_;
1605 for my $c ($self->_order_by_chunks($arg) ) {
1606 $self->_SWITCH_refkind($c, {
1607 SCALAR => sub { push @sql, $c },
1608 ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1614 $self->_sqlcase(' order by'),
1620 return wantarray ? ($sql, @bind) : $sql;
1623 sub _order_by_chunks {
1624 my ($self, $arg) = @_;
1626 return $self->_SWITCH_refkind($arg, {
1629 map { $self->_order_by_chunks($_ ) } @$arg;
1632 ARRAYREFREF => sub {
1633 my ($s, @b) = @$$arg;
1634 $self->_assert_bindval_matches_bindtype(@b);
1638 SCALAR => sub {$self->_quote($arg)},
1640 UNDEF => sub {return () },
1642 SCALARREF => sub {$$arg}, # literal SQL, no quoting
1645 # get first pair in hash
1646 my ($key, $val, @rest) = %$arg;
1648 return () unless $key;
1650 if (@rest or not $key =~ /^-(desc|asc)/i) {
1651 puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1657 for my $c ($self->_order_by_chunks($val)) {
1660 $self->_SWITCH_refkind($c, {
1665 ($sql, @bind) = @$c;
1669 $sql = $sql . ' ' . $self->_sqlcase($direction);
1671 push @ret, [ $sql, @bind];
1680 #======================================================================
1681 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1682 #======================================================================
1687 $self->_SWITCH_refkind($from, {
1688 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$from;},
1689 SCALAR => sub {$self->_quote($from)},
1690 SCALARREF => sub {$$from},
1695 #======================================================================
1697 #======================================================================
1699 # highly optimized, as it's called way too often
1701 # my ($self, $label) = @_;
1703 return '' unless defined $_[1];
1704 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1706 $_[0]->{quote_char} or
1707 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1709 my $qref = ref $_[0]->{quote_char};
1711 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1712 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1713 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1715 my $esc = $_[0]->{escape_char} || $r;
1717 # parts containing * are naturally unquoted
1718 return join($_[0]->{name_sep}||'', map
1719 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1720 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1725 # Conversion, if applicable
1727 #my ($self, $arg) = @_;
1728 if ($_[0]->{convert}) {
1729 return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1736 #my ($self, $col, @vals) = @_;
1737 # called often - tighten code
1738 return $_[0]->{bindtype} eq 'columns'
1739 ? map {[$_[1], $_]} @_[2 .. $#_]
1744 # Dies if any element of @bind is not in [colname => value] format
1745 # if bindtype is 'columns'.
1746 sub _assert_bindval_matches_bindtype {
1747 # my ($self, @bind) = @_;
1749 if ($self->{bindtype} eq 'columns') {
1751 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1752 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1758 sub _join_sql_clauses {
1759 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1761 if (@$clauses_aref > 1) {
1762 my $join = " " . $self->_sqlcase($logic) . " ";
1763 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1764 return ($sql, @$bind_aref);
1766 elsif (@$clauses_aref) {
1767 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1770 return (); # if no SQL, ignore @$bind_aref
1775 # Fix SQL case, if so requested
1777 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1778 # don't touch the argument ... crooked logic, but let's not change it!
1779 return $_[0]->{case} ? $_[1] : uc($_[1]);
1783 #======================================================================
1784 # DISPATCHING FROM REFKIND
1785 #======================================================================
1788 my ($self, $data) = @_;
1790 return 'UNDEF' unless defined $data;
1792 # blessed objects are treated like scalars
1793 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1795 return 'SCALAR' unless $ref;
1798 while ($ref eq 'REF') {
1800 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1804 return ($ref||'SCALAR') . ('REF' x $n_steps);
1808 my ($self, $data) = @_;
1809 my @try = ($self->_refkind($data));
1810 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1811 push @try, 'FALLBACK';
1815 sub _METHOD_FOR_refkind {
1816 my ($self, $meth_prefix, $data) = @_;
1819 for (@{$self->_try_refkind($data)}) {
1820 $method = $self->can($meth_prefix."_".$_)
1824 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1828 sub _SWITCH_refkind {
1829 my ($self, $data, $dispatch_table) = @_;
1832 for (@{$self->_try_refkind($data)}) {
1833 $coderef = $dispatch_table->{$_}
1837 puke "no dispatch entry for ".$self->_refkind($data)
1846 #======================================================================
1847 # VALUES, GENERATE, AUTOLOAD
1848 #======================================================================
1850 # LDNOTE: original code from nwiger, didn't touch code in that section
1851 # I feel the AUTOLOAD stuff should not be the default, it should
1852 # only be activated on explicit demand by user.
1856 my $data = shift || return;
1857 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1858 unless ref $data eq 'HASH';
1861 foreach my $k (sort keys %$data) {
1862 my $v = $data->{$k};
1863 $self->_SWITCH_refkind($v, {
1865 if ($self->{array_datatypes}) { # array datatype
1866 push @all_bind, $self->_bindtype($k, $v);
1868 else { # literal SQL with bind
1869 my ($sql, @bind) = @$v;
1870 $self->_assert_bindval_matches_bindtype(@bind);
1871 push @all_bind, @bind;
1874 ARRAYREFREF => sub { # literal SQL with bind
1875 my ($sql, @bind) = @${$v};
1876 $self->_assert_bindval_matches_bindtype(@bind);
1877 push @all_bind, @bind;
1879 SCALARREF => sub { # literal SQL without bind
1881 SCALAR_or_UNDEF => sub {
1882 push @all_bind, $self->_bindtype($k, $v);
1893 my(@sql, @sqlq, @sqlv);
1897 if ($ref eq 'HASH') {
1898 for my $k (sort keys %$_) {
1901 my $label = $self->_quote($k);
1902 if ($r eq 'ARRAY') {
1903 # literal SQL with bind
1904 my ($sql, @bind) = @$v;
1905 $self->_assert_bindval_matches_bindtype(@bind);
1906 push @sqlq, "$label = $sql";
1908 } elsif ($r eq 'SCALAR') {
1909 # literal SQL without bind
1910 push @sqlq, "$label = $$v";
1912 push @sqlq, "$label = ?";
1913 push @sqlv, $self->_bindtype($k, $v);
1916 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1917 } elsif ($ref eq 'ARRAY') {
1918 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1921 if ($r eq 'ARRAY') { # literal SQL with bind
1922 my ($sql, @bind) = @$v;
1923 $self->_assert_bindval_matches_bindtype(@bind);
1926 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1927 # embedded literal SQL
1934 push @sql, '(' . join(', ', @sqlq) . ')';
1935 } elsif ($ref eq 'SCALAR') {
1939 # strings get case twiddled
1940 push @sql, $self->_sqlcase($_);
1944 my $sql = join ' ', @sql;
1946 # this is pretty tricky
1947 # if ask for an array, return ($stmt, @bind)
1948 # otherwise, s/?/shift @sqlv/ to put it inline
1950 return ($sql, @sqlv);
1952 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1953 ref $d ? $d->[1] : $d/e;
1962 # This allows us to check for a local, then _form, attr
1964 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1965 return $self->generate($name, @_);
1976 SQL::Abstract - Generate SQL from Perl data structures
1982 my $sql = SQL::Abstract->new;
1984 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1986 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1988 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1990 my($stmt, @bind) = $sql->delete($table, \%where);
1992 # Then, use these in your DBI statements
1993 my $sth = $dbh->prepare($stmt);
1994 $sth->execute(@bind);
1996 # Just generate the WHERE clause
1997 my($stmt, @bind) = $sql->where(\%where, $order);
1999 # Return values in the same order, for hashed queries
2000 # See PERFORMANCE section for more details
2001 my @bind = $sql->values(\%fieldvals);
2005 This module was inspired by the excellent L<DBIx::Abstract>.
2006 However, in using that module I found that what I really wanted
2007 to do was generate SQL, but still retain complete control over my
2008 statement handles and use the DBI interface. So, I set out to
2009 create an abstract SQL generation module.
2011 While based on the concepts used by L<DBIx::Abstract>, there are
2012 several important differences, especially when it comes to WHERE
2013 clauses. I have modified the concepts used to make the SQL easier
2014 to generate from Perl data structures and, IMO, more intuitive.
2015 The underlying idea is for this module to do what you mean, based
2016 on the data structures you provide it. The big advantage is that
2017 you don't have to modify your code every time your data changes,
2018 as this module figures it out.
2020 To begin with, an SQL INSERT is as easy as just specifying a hash
2021 of C<key=value> pairs:
2024 name => 'Jimbo Bobson',
2025 phone => '123-456-7890',
2026 address => '42 Sister Lane',
2027 city => 'St. Louis',
2028 state => 'Louisiana',
2031 The SQL can then be generated with this:
2033 my($stmt, @bind) = $sql->insert('people', \%data);
2035 Which would give you something like this:
2037 $stmt = "INSERT INTO people
2038 (address, city, name, phone, state)
2039 VALUES (?, ?, ?, ?, ?)";
2040 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2041 '123-456-7890', 'Louisiana');
2043 These are then used directly in your DBI code:
2045 my $sth = $dbh->prepare($stmt);
2046 $sth->execute(@bind);
2048 =head2 Inserting and Updating Arrays
2050 If your database has array types (like for example Postgres),
2051 activate the special option C<< array_datatypes => 1 >>
2052 when creating the C<SQL::Abstract> object.
2053 Then you may use an arrayref to insert and update database array types:
2055 my $sql = SQL::Abstract->new(array_datatypes => 1);
2057 planets => [qw/Mercury Venus Earth Mars/]
2060 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2064 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2066 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2069 =head2 Inserting and Updating SQL
2071 In order to apply SQL functions to elements of your C<%data> you may
2072 specify a reference to an arrayref for the given hash value. For example,
2073 if you need to execute the Oracle C<to_date> function on a value, you can
2074 say something like this:
2078 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2081 The first value in the array is the actual SQL. Any other values are
2082 optional and would be included in the bind values array. This gives
2085 my($stmt, @bind) = $sql->insert('people', \%data);
2087 $stmt = "INSERT INTO people (name, date_entered)
2088 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2089 @bind = ('Bill', '03/02/2003');
2091 An UPDATE is just as easy, all you change is the name of the function:
2093 my($stmt, @bind) = $sql->update('people', \%data);
2095 Notice that your C<%data> isn't touched; the module will generate
2096 the appropriately quirky SQL for you automatically. Usually you'll
2097 want to specify a WHERE clause for your UPDATE, though, which is
2098 where handling C<%where> hashes comes in handy...
2100 =head2 Complex where statements
2102 This module can generate pretty complicated WHERE statements
2103 easily. For example, simple C<key=value> pairs are taken to mean
2104 equality, and if you want to see if a field is within a set
2105 of values, you can use an arrayref. Let's say we wanted to
2106 SELECT some data based on this criteria:
2109 requestor => 'inna',
2110 worker => ['nwiger', 'rcwe', 'sfz'],
2111 status => { '!=', 'completed' }
2114 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2116 The above would give you something like this:
2118 $stmt = "SELECT * FROM tickets WHERE
2119 ( requestor = ? ) AND ( status != ? )
2120 AND ( worker = ? OR worker = ? OR worker = ? )";
2121 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2123 Which you could then use in DBI code like so:
2125 my $sth = $dbh->prepare($stmt);
2126 $sth->execute(@bind);
2132 The methods are simple. There's one for every major SQL operation,
2133 and a constructor you use first. The arguments are specified in a
2134 similar order for each method (table, then fields, then a where
2135 clause) to try and simplify things.
2137 =head2 new(option => 'value')
2139 The C<new()> function takes a list of options and values, and returns
2140 a new B<SQL::Abstract> object which can then be used to generate SQL
2141 through the methods below. The options accepted are:
2147 If set to 'lower', then SQL will be generated in all lowercase. By
2148 default SQL is generated in "textbook" case meaning something like:
2150 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2152 Any setting other than 'lower' is ignored.
2156 This determines what the default comparison operator is. By default
2157 it is C<=>, meaning that a hash like this:
2159 %where = (name => 'nwiger', email => 'nate@wiger.org');
2161 Will generate SQL like this:
2163 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2165 However, you may want loose comparisons by default, so if you set
2166 C<cmp> to C<like> you would get SQL such as:
2168 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2170 You can also override the comparison on an individual basis - see
2171 the huge section on L</"WHERE CLAUSES"> at the bottom.
2173 =item sqltrue, sqlfalse
2175 Expressions for inserting boolean values within SQL statements.
2176 By default these are C<1=1> and C<1=0>. They are used
2177 by the special operators C<-in> and C<-not_in> for generating
2178 correct SQL even when the argument is an empty array (see below).
2182 This determines the default logical operator for multiple WHERE
2183 statements in arrays or hashes. If absent, the default logic is "or"
2184 for arrays, and "and" for hashes. This means that a WHERE
2188 event_date => {'>=', '2/13/99'},
2189 event_date => {'<=', '4/24/03'},
2192 will generate SQL like this:
2194 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2196 This is probably not what you want given this query, though (look
2197 at the dates). To change the "OR" to an "AND", simply specify:
2199 my $sql = SQL::Abstract->new(logic => 'and');
2201 Which will change the above C<WHERE> to:
2203 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2205 The logic can also be changed locally by inserting
2206 a modifier in front of an arrayref:
2208 @where = (-and => [event_date => {'>=', '2/13/99'},
2209 event_date => {'<=', '4/24/03'} ]);
2211 See the L</"WHERE CLAUSES"> section for explanations.
2215 This will automatically convert comparisons using the specified SQL
2216 function for both column and value. This is mostly used with an argument
2217 of C<upper> or C<lower>, so that the SQL will have the effect of
2218 case-insensitive "searches". For example, this:
2220 $sql = SQL::Abstract->new(convert => 'upper');
2221 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2223 Will turn out the following SQL:
2225 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2227 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2228 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2229 not validate this option; it will just pass through what you specify verbatim).
2233 This is a kludge because many databases suck. For example, you can't
2234 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2235 Instead, you have to use C<bind_param()>:
2237 $sth->bind_param(1, 'reg data');
2238 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2240 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2241 which loses track of which field each slot refers to. Fear not.
2243 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2244 Currently, you can specify either C<normal> (default) or C<columns>. If you
2245 specify C<columns>, you will get an array that looks like this:
2247 my $sql = SQL::Abstract->new(bindtype => 'columns');
2248 my($stmt, @bind) = $sql->insert(...);
2251 [ 'column1', 'value1' ],
2252 [ 'column2', 'value2' ],
2253 [ 'column3', 'value3' ],
2256 You can then iterate through this manually, using DBI's C<bind_param()>.
2258 $sth->prepare($stmt);
2261 my($col, $data) = @$_;
2262 if ($col eq 'details' || $col eq 'comments') {
2263 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2264 } elsif ($col eq 'image') {
2265 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2267 $sth->bind_param($i, $data);
2271 $sth->execute; # execute without @bind now
2273 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2274 Basically, the advantage is still that you don't have to care which fields
2275 are or are not included. You could wrap that above C<for> loop in a simple
2276 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2277 get a layer of abstraction over manual SQL specification.
2279 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2280 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2281 will expect the bind values in this format.
2285 This is the character that a table or column name will be quoted
2286 with. By default this is an empty string, but you could set it to
2287 the character C<`>, to generate SQL like this:
2289 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2291 Alternatively, you can supply an array ref of two items, the first being the left
2292 hand quote character, and the second the right hand quote character. For
2293 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2294 that generates SQL like this:
2296 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2298 Quoting is useful if you have tables or columns names that are reserved
2299 words in your database's SQL dialect.
2303 This is the character that will be used to escape L</quote_char>s appearing
2304 in an identifier before it has been quoted.
2306 The parameter default in case of a single L</quote_char> character is the quote
2309 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2310 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2311 of the B<opening (left)> L</quote_char> within the identifier are currently left
2312 untouched. The default for opening-closing-style quotes may change in future
2313 versions, thus you are B<strongly encouraged> to specify the escape character
2318 This is the character that separates a table and column name. It is
2319 necessary to specify this when the C<quote_char> option is selected,
2320 so that tables and column names can be individually quoted like this:
2322 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2324 =item injection_guard
2326 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2327 column name specified in a query structure. This is a safety mechanism to avoid
2328 injection attacks when mishandling user input e.g.:
2330 my %condition_as_column_value_pairs = get_values_from_user();
2331 $sqla->select( ... , \%condition_as_column_value_pairs );
2333 If the expression matches an exception is thrown. Note that literal SQL
2334 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2336 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2338 =item array_datatypes
2340 When this option is true, arrayrefs in INSERT or UPDATE are
2341 interpreted as array datatypes and are passed directly
2343 When this option is false, arrayrefs are interpreted
2344 as literal SQL, just like refs to arrayrefs
2345 (but this behavior is for backwards compatibility; when writing
2346 new queries, use the "reference to arrayref" syntax
2352 Takes a reference to a list of "special operators"
2353 to extend the syntax understood by L<SQL::Abstract>.
2354 See section L</"SPECIAL OPERATORS"> for details.
2358 Takes a reference to a list of "unary operators"
2359 to extend the syntax understood by L<SQL::Abstract>.
2360 See section L</"UNARY OPERATORS"> for details.
2366 =head2 insert($table, \@values || \%fieldvals, \%options)
2368 This is the simplest function. You simply give it a table name
2369 and either an arrayref of values or hashref of field/value pairs.
2370 It returns an SQL INSERT statement and a list of bind values.
2371 See the sections on L</"Inserting and Updating Arrays"> and
2372 L</"Inserting and Updating SQL"> for information on how to insert
2373 with those data types.
2375 The optional C<\%options> hash reference may contain additional
2376 options to generate the insert SQL. Currently supported options
2383 Takes either a scalar of raw SQL fields, or an array reference of
2384 field names, and adds on an SQL C<RETURNING> statement at the end.
2385 This allows you to return data generated by the insert statement
2386 (such as row IDs) without performing another C<SELECT> statement.
2387 Note, however, this is not part of the SQL standard and may not
2388 be supported by all database engines.
2392 =head2 update($table, \%fieldvals, \%where, \%options)
2394 This takes a table, hashref of field/value pairs, and an optional
2395 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2397 See the sections on L</"Inserting and Updating Arrays"> and
2398 L</"Inserting and Updating SQL"> for information on how to insert
2399 with those data types.
2401 The optional C<\%options> hash reference may contain additional
2402 options to generate the update SQL. Currently supported options
2409 See the C<returning> option to
2410 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2414 =head2 select($source, $fields, $where, $order)
2416 This returns a SQL SELECT statement and associated list of bind values, as
2417 specified by the arguments:
2423 Specification of the 'FROM' part of the statement.
2424 The argument can be either a plain scalar (interpreted as a table
2425 name, will be quoted), or an arrayref (interpreted as a list
2426 of table names, joined by commas, quoted), or a scalarref
2427 (literal SQL, not quoted).
2431 Specification of the list of fields to retrieve from
2433 The argument can be either an arrayref (interpreted as a list
2434 of field names, will be joined by commas and quoted), or a
2435 plain scalar (literal SQL, not quoted).
2436 Please observe that this API is not as flexible as that of
2437 the first argument C<$source>, for backwards compatibility reasons.
2441 Optional argument to specify the WHERE part of the query.
2442 The argument is most often a hashref, but can also be
2443 an arrayref or plain scalar --
2444 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2448 Optional argument to specify the ORDER BY part of the query.
2449 The argument can be a scalar, a hashref or an arrayref
2450 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2456 =head2 delete($table, \%where, \%options)
2458 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2459 It returns an SQL DELETE statement and list of bind values.
2461 The optional C<\%options> hash reference may contain additional
2462 options to generate the delete SQL. Currently supported options
2469 See the C<returning> option to
2470 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2474 =head2 where(\%where, $order)
2476 This is used to generate just the WHERE clause. For example,
2477 if you have an arbitrary data structure and know what the
2478 rest of your SQL is going to look like, but want an easy way
2479 to produce a WHERE clause, use this. It returns an SQL WHERE
2480 clause and list of bind values.
2483 =head2 values(\%data)
2485 This just returns the values from the hash C<%data>, in the same
2486 order that would be returned from any of the other above queries.
2487 Using this allows you to markedly speed up your queries if you
2488 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2490 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2492 Warning: This is an experimental method and subject to change.
2494 This returns arbitrarily generated SQL. It's a really basic shortcut.
2495 It will return two different things, depending on return context:
2497 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2498 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2500 These would return the following:
2502 # First calling form
2503 $stmt = "CREATE TABLE test (?, ?)";
2504 @bind = (field1, field2);
2506 # Second calling form
2507 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2509 Depending on what you're trying to do, it's up to you to choose the correct
2510 format. In this example, the second form is what you would want.
2514 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2518 ALTER SESSION SET nls_date_format = 'MM/YY'
2520 You get the idea. Strings get their case twiddled, but everything
2521 else remains verbatim.
2523 =head1 EXPORTABLE FUNCTIONS
2525 =head2 is_plain_value
2527 Determines if the supplied argument is a plain value as understood by this
2532 =item * The value is C<undef>
2534 =item * The value is a non-reference
2536 =item * The value is an object with stringification overloading
2538 =item * The value is of the form C<< { -value => $anything } >>
2542 On failure returns C<undef>, on success returns a B<scalar> reference
2543 to the original supplied argument.
2549 The stringification overloading detection is rather advanced: it takes
2550 into consideration not only the presence of a C<""> overload, but if that
2551 fails also checks for enabled
2552 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2553 on either C<0+> or C<bool>.
2555 Unfortunately testing in the field indicates that this
2556 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2557 but only when very large numbers of stringifying objects are involved.
2558 At the time of writing ( Sep 2014 ) there is no clear explanation of
2559 the direct cause, nor is there a manageably small test case that reliably
2560 reproduces the problem.
2562 If you encounter any of the following exceptions in B<random places within
2563 your application stack> - this module may be to blame:
2565 Operation "ne": no method found,
2566 left argument in overloaded package <something>,
2567 right argument in overloaded package <something>
2571 Stub found while resolving method "???" overloading """" in package <something>
2573 If you fall victim to the above - please attempt to reduce the problem
2574 to something that could be sent to the L<SQL::Abstract developers
2575 |DBIx::Class/GETTING HELP/SUPPORT>
2576 (either publicly or privately). As a workaround in the meantime you can
2577 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2578 value, which will most likely eliminate your problem (at the expense of
2579 not being able to properly detect exotic forms of stringification).
2581 This notice and environment variable will be removed in a future version,
2582 as soon as the underlying problem is found and a reliable workaround is
2587 =head2 is_literal_value
2589 Determines if the supplied argument is a literal value as understood by this
2594 =item * C<\$sql_string>
2596 =item * C<\[ $sql_string, @bind_values ]>
2600 On failure returns C<undef>, on success returns an B<array> reference
2601 containing the unpacked version of the supplied literal SQL and bind values.
2603 =head1 WHERE CLAUSES
2607 This module uses a variation on the idea from L<DBIx::Abstract>. It
2608 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2609 module is that things in arrays are OR'ed, and things in hashes
2612 The easiest way to explain is to show lots of examples. After
2613 each C<%where> hash shown, it is assumed you used:
2615 my($stmt, @bind) = $sql->where(\%where);
2617 However, note that the C<%where> hash can be used directly in any
2618 of the other functions as well, as described above.
2620 =head2 Key-value pairs
2622 So, let's get started. To begin, a simple hash:
2626 status => 'completed'
2629 Is converted to SQL C<key = val> statements:
2631 $stmt = "WHERE user = ? AND status = ?";
2632 @bind = ('nwiger', 'completed');
2634 One common thing I end up doing is having a list of values that
2635 a field can be in. To do this, simply specify a list inside of
2640 status => ['assigned', 'in-progress', 'pending'];
2643 This simple code will create the following:
2645 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2646 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2648 A field associated to an empty arrayref will be considered a
2649 logical false and will generate 0=1.
2651 =head2 Tests for NULL values
2653 If the value part is C<undef> then this is converted to SQL <IS NULL>
2662 $stmt = "WHERE user = ? AND status IS NULL";
2665 To test if a column IS NOT NULL:
2669 status => { '!=', undef },
2672 =head2 Specific comparison operators
2674 If you want to specify a different type of operator for your comparison,
2675 you can use a hashref for a given column:
2679 status => { '!=', 'completed' }
2682 Which would generate:
2684 $stmt = "WHERE user = ? AND status != ?";
2685 @bind = ('nwiger', 'completed');
2687 To test against multiple values, just enclose the values in an arrayref:
2689 status => { '=', ['assigned', 'in-progress', 'pending'] };
2691 Which would give you:
2693 "WHERE status = ? OR status = ? OR status = ?"
2696 The hashref can also contain multiple pairs, in which case it is expanded
2697 into an C<AND> of its elements:
2701 status => { '!=', 'completed', -not_like => 'pending%' }
2704 # Or more dynamically, like from a form
2705 $where{user} = 'nwiger';
2706 $where{status}{'!='} = 'completed';
2707 $where{status}{'-not_like'} = 'pending%';
2709 # Both generate this
2710 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2711 @bind = ('nwiger', 'completed', 'pending%');
2714 To get an OR instead, you can combine it with the arrayref idea:
2718 priority => [ { '=', 2 }, { '>', 5 } ]
2721 Which would generate:
2723 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2724 @bind = ('2', '5', 'nwiger');
2726 If you want to include literal SQL (with or without bind values), just use a
2727 scalar reference or reference to an arrayref as the value:
2730 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2731 date_expires => { '<' => \"now()" }
2734 Which would generate:
2736 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2737 @bind = ('11/26/2008');
2740 =head2 Logic and nesting operators
2742 In the example above,
2743 there is a subtle trap if you want to say something like
2744 this (notice the C<AND>):
2746 WHERE priority != ? AND priority != ?
2748 Because, in Perl you I<can't> do this:
2750 priority => { '!=' => 2, '!=' => 1 }
2752 As the second C<!=> key will obliterate the first. The solution
2753 is to use the special C<-modifier> form inside an arrayref:
2755 priority => [ -and => {'!=', 2},
2759 Normally, these would be joined by C<OR>, but the modifier tells it
2760 to use C<AND> instead. (Hint: You can use this in conjunction with the
2761 C<logic> option to C<new()> in order to change the way your queries
2762 work by default.) B<Important:> Note that the C<-modifier> goes
2763 B<INSIDE> the arrayref, as an extra first element. This will
2764 B<NOT> do what you think it might:
2766 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2768 Here is a quick list of equivalencies, since there is some overlap:
2771 status => {'!=', 'completed', 'not like', 'pending%' }
2772 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2775 status => {'=', ['assigned', 'in-progress']}
2776 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2777 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2781 =head2 Special operators: IN, BETWEEN, etc.
2783 You can also use the hashref format to compare a list of fields using the
2784 C<IN> comparison operator, by specifying the list as an arrayref:
2787 status => 'completed',
2788 reportid => { -in => [567, 2335, 2] }
2791 Which would generate:
2793 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2794 @bind = ('completed', '567', '2335', '2');
2796 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2799 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2800 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2801 'sqltrue' (by default: C<1=1>).
2803 In addition to the array you can supply a chunk of literal sql or
2804 literal sql with bind:
2807 customer => { -in => \[
2808 'SELECT cust_id FROM cust WHERE balance > ?',
2811 status => { -in => \'SELECT status_codes FROM states' },
2817 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2818 AND status IN ( SELECT status_codes FROM states )
2822 Finally, if the argument to C<-in> is not a reference, it will be
2823 treated as a single-element array.
2825 Another pair of operators is C<-between> and C<-not_between>,
2826 used with an arrayref of two values:
2830 completion_date => {
2831 -not_between => ['2002-10-01', '2003-02-06']
2837 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2839 Just like with C<-in> all plausible combinations of literal SQL
2843 start0 => { -between => [ 1, 2 ] },
2844 start1 => { -between => \["? AND ?", 1, 2] },
2845 start2 => { -between => \"lower(x) AND upper(y)" },
2846 start3 => { -between => [
2848 \["upper(?)", 'stuff' ],
2855 ( start0 BETWEEN ? AND ? )
2856 AND ( start1 BETWEEN ? AND ? )
2857 AND ( start2 BETWEEN lower(x) AND upper(y) )
2858 AND ( start3 BETWEEN lower(x) AND upper(?) )
2860 @bind = (1, 2, 1, 2, 'stuff');
2863 These are the two builtin "special operators"; but the
2864 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2866 =head2 Unary operators: bool
2868 If you wish to test against boolean columns or functions within your
2869 database you can use the C<-bool> and C<-not_bool> operators. For
2870 example to test the column C<is_user> being true and the column
2871 C<is_enabled> being false you would use:-
2875 -not_bool => 'is_enabled',
2880 WHERE is_user AND NOT is_enabled
2882 If a more complex combination is required, testing more conditions,
2883 then you should use the and/or operators:-
2888 -not_bool => { two=> { -rlike => 'bar' } },
2889 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2900 (NOT ( three = ? OR three > ? ))
2903 =head2 Nested conditions, -and/-or prefixes
2905 So far, we've seen how multiple conditions are joined with a top-level
2906 C<AND>. We can change this by putting the different conditions we want in
2907 hashes and then putting those hashes in an array. For example:
2912 status => { -like => ['pending%', 'dispatched'] },
2916 status => 'unassigned',
2920 This data structure would create the following:
2922 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2923 OR ( user = ? AND status = ? ) )";
2924 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2927 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2928 to change the logic inside:
2934 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2935 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2942 $stmt = "WHERE ( user = ?
2943 AND ( ( workhrs > ? AND geo = ? )
2944 OR ( workhrs < ? OR geo = ? ) ) )";
2945 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2947 =head3 Algebraic inconsistency, for historical reasons
2949 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2950 operator goes C<outside> of the nested structure; whereas when connecting
2951 several constraints on one column, the C<-and> operator goes
2952 C<inside> the arrayref. Here is an example combining both features:
2955 -and => [a => 1, b => 2],
2956 -or => [c => 3, d => 4],
2957 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2962 WHERE ( ( ( a = ? AND b = ? )
2963 OR ( c = ? OR d = ? )
2964 OR ( e LIKE ? AND e LIKE ? ) ) )
2966 This difference in syntax is unfortunate but must be preserved for
2967 historical reasons. So be careful: the two examples below would
2968 seem algebraically equivalent, but they are not
2971 { -like => 'foo%' },
2972 { -like => '%bar' },
2974 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2977 { col => { -like => 'foo%' } },
2978 { col => { -like => '%bar' } },
2980 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2983 =head2 Literal SQL and value type operators
2985 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2986 side" is a column name and the "right side" is a value (normally rendered as
2987 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2988 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2989 alter this behavior. There are several ways of doing so.
2993 This is a virtual operator that signals the string to its right side is an
2994 identifier (a column name) and not a value. For example to compare two
2995 columns you would write:
2998 priority => { '<', 2 },
2999 requestor => { -ident => 'submitter' },
3004 $stmt = "WHERE priority < ? AND requestor = submitter";
3007 If you are maintaining legacy code you may see a different construct as
3008 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3013 This is a virtual operator that signals that the construct to its right side
3014 is a value to be passed to DBI. This is for example necessary when you want
3015 to write a where clause against an array (for RDBMS that support such
3016 datatypes). For example:
3019 array => { -value => [1, 2, 3] }
3024 $stmt = 'WHERE array = ?';
3025 @bind = ([1, 2, 3]);
3027 Note that if you were to simply say:
3033 the result would probably not be what you wanted:
3035 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3040 Finally, sometimes only literal SQL will do. To include a random snippet
3041 of SQL verbatim, you specify it as a scalar reference. Consider this only
3042 as a last resort. Usually there is a better way. For example:
3045 priority => { '<', 2 },
3046 requestor => { -in => \'(SELECT name FROM hitmen)' },
3051 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3054 Note that in this example, you only get one bind parameter back, since
3055 the verbatim SQL is passed as part of the statement.
3059 Never use untrusted input as a literal SQL argument - this is a massive
3060 security risk (there is no way to check literal snippets for SQL
3061 injections and other nastyness). If you need to deal with untrusted input
3062 use literal SQL with placeholders as described next.
3064 =head3 Literal SQL with placeholders and bind values (subqueries)
3066 If the literal SQL to be inserted has placeholders and bind values,
3067 use a reference to an arrayref (yes this is a double reference --
3068 not so common, but perfectly legal Perl). For example, to find a date
3069 in Postgres you can use something like this:
3072 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3077 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3080 Note that you must pass the bind values in the same format as they are returned
3081 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3082 to C<columns>, you must provide the bind values in the
3083 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3084 scalar value; most commonly the column name, but you can use any scalar value
3085 (including references and blessed references), L<SQL::Abstract> will simply
3086 pass it through intact. So if C<bindtype> is set to C<columns> the above
3087 example will look like:
3090 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3093 Literal SQL is especially useful for nesting parenthesized clauses in the
3094 main SQL query. Here is a first example:
3096 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3100 bar => \["IN ($sub_stmt)" => @sub_bind],
3105 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3106 WHERE c2 < ? AND c3 LIKE ?))";
3107 @bind = (1234, 100, "foo%");
3109 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3110 are expressed in the same way. Of course the C<$sub_stmt> and
3111 its associated bind values can be generated through a former call
3114 my ($sub_stmt, @sub_bind)
3115 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3116 c3 => {-like => "foo%"}});
3119 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3122 In the examples above, the subquery was used as an operator on a column;
3123 but the same principle also applies for a clause within the main C<%where>
3124 hash, like an EXISTS subquery:
3126 my ($sub_stmt, @sub_bind)
3127 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3128 my %where = ( -and => [
3130 \["EXISTS ($sub_stmt)" => @sub_bind],
3135 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3136 WHERE c1 = ? AND c2 > t0.c0))";
3140 Observe that the condition on C<c2> in the subquery refers to
3141 column C<t0.c0> of the main query: this is I<not> a bind
3142 value, so we have to express it through a scalar ref.
3143 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3144 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3145 what we wanted here.
3147 Finally, here is an example where a subquery is used
3148 for expressing unary negation:
3150 my ($sub_stmt, @sub_bind)
3151 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3152 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3154 lname => {like => '%son%'},
3155 \["NOT ($sub_stmt)" => @sub_bind],
3160 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3161 @bind = ('%son%', 10, 20)
3163 =head3 Deprecated usage of Literal SQL
3165 Below are some examples of archaic use of literal SQL. It is shown only as
3166 reference for those who deal with legacy code. Each example has a much
3167 better, cleaner and safer alternative that users should opt for in new code.
3173 my %where = ( requestor => \'IS NOT NULL' )
3175 $stmt = "WHERE requestor IS NOT NULL"
3177 This used to be the way of generating NULL comparisons, before the handling
3178 of C<undef> got formalized. For new code please use the superior syntax as
3179 described in L</Tests for NULL values>.
3183 my %where = ( requestor => \'= submitter' )
3185 $stmt = "WHERE requestor = submitter"
3187 This used to be the only way to compare columns. Use the superior L</-ident>
3188 method for all new code. For example an identifier declared in such a way
3189 will be properly quoted if L</quote_char> is properly set, while the legacy
3190 form will remain as supplied.
3194 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3196 $stmt = "WHERE completed > ? AND is_ready"
3197 @bind = ('2012-12-21')
3199 Using an empty string literal used to be the only way to express a boolean.
3200 For all new code please use the much more readable
3201 L<-bool|/Unary operators: bool> operator.
3207 These pages could go on for a while, since the nesting of the data
3208 structures this module can handle are pretty much unlimited (the
3209 module implements the C<WHERE> expansion as a recursive function
3210 internally). Your best bet is to "play around" with the module a
3211 little to see how the data structures behave, and choose the best
3212 format for your data based on that.
3214 And of course, all the values above will probably be replaced with
3215 variables gotten from forms or the command line. After all, if you
3216 knew everything ahead of time, you wouldn't have to worry about
3217 dynamically-generating SQL and could just hardwire it into your
3220 =head1 ORDER BY CLAUSES
3222 Some functions take an order by clause. This can either be a scalar (just a
3223 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3224 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3227 Given | Will Generate
3228 ---------------------------------------------------------------
3230 'colA' | ORDER BY colA
3232 [qw/colA colB/] | ORDER BY colA, colB
3234 {-asc => 'colA'} | ORDER BY colA ASC
3236 {-desc => 'colB'} | ORDER BY colB DESC
3238 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3240 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3242 \'colA DESC' | ORDER BY colA DESC
3244 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3245 | /* ...with $x bound to ? */
3248 { -asc => 'colA' }, | colA ASC,
3249 { -desc => [qw/colB/] }, | colB DESC,
3250 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3251 \'colE DESC', | colE DESC,
3252 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3253 ] | /* ...with $x bound to ? */
3254 ===============================================================
3258 =head1 SPECIAL OPERATORS
3260 my $sqlmaker = SQL::Abstract->new(special_ops => [
3264 my ($self, $field, $op, $arg) = @_;
3270 handler => 'method_name',
3274 A "special operator" is a SQL syntactic clause that can be
3275 applied to a field, instead of a usual binary operator.
3278 WHERE field IN (?, ?, ?)
3279 WHERE field BETWEEN ? AND ?
3280 WHERE MATCH(field) AGAINST (?, ?)
3282 Special operators IN and BETWEEN are fairly standard and therefore
3283 are builtin within C<SQL::Abstract> (as the overridable methods
3284 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3285 like the MATCH .. AGAINST example above which is specific to MySQL,
3286 you can write your own operator handlers - supply a C<special_ops>
3287 argument to the C<new> method. That argument takes an arrayref of
3288 operator definitions; each operator definition is a hashref with two
3295 the regular expression to match the operator
3299 Either a coderef or a plain scalar method name. In both cases
3300 the expected return is C<< ($sql, @bind) >>.
3302 When supplied with a method name, it is simply called on the
3303 L<SQL::Abstract> object as:
3305 $self->$method_name($field, $op, $arg)
3309 $field is the LHS of the operator
3310 $op is the part that matched the handler regex
3313 When supplied with a coderef, it is called as:
3315 $coderef->($self, $field, $op, $arg)
3320 For example, here is an implementation
3321 of the MATCH .. AGAINST syntax for MySQL
3323 my $sqlmaker = SQL::Abstract->new(special_ops => [
3325 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3326 {regex => qr/^match$/i,
3328 my ($self, $field, $op, $arg) = @_;
3329 $arg = [$arg] if not ref $arg;
3330 my $label = $self->_quote($field);
3331 my ($placeholder) = $self->_convert('?');
3332 my $placeholders = join ", ", (($placeholder) x @$arg);
3333 my $sql = $self->_sqlcase('match') . " ($label) "
3334 . $self->_sqlcase('against') . " ($placeholders) ";
3335 my @bind = $self->_bindtype($field, @$arg);
3336 return ($sql, @bind);
3343 =head1 UNARY OPERATORS
3345 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3349 my ($self, $op, $arg) = @_;
3355 handler => 'method_name',
3359 A "unary operator" is a SQL syntactic clause that can be
3360 applied to a field - the operator goes before the field
3362 You can write your own operator handlers - supply a C<unary_ops>
3363 argument to the C<new> method. That argument takes an arrayref of
3364 operator definitions; each operator definition is a hashref with two
3371 the regular expression to match the operator
3375 Either a coderef or a plain scalar method name. In both cases
3376 the expected return is C<< $sql >>.
3378 When supplied with a method name, it is simply called on the
3379 L<SQL::Abstract> object as:
3381 $self->$method_name($op, $arg)
3385 $op is the part that matched the handler regex
3386 $arg is the RHS or argument of the operator
3388 When supplied with a coderef, it is called as:
3390 $coderef->($self, $op, $arg)
3398 Thanks to some benchmarking by Mark Stosberg, it turns out that
3399 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3400 I must admit this wasn't an intentional design issue, but it's a
3401 byproduct of the fact that you get to control your C<DBI> handles
3404 To maximize performance, use a code snippet like the following:
3406 # prepare a statement handle using the first row
3407 # and then reuse it for the rest of the rows
3409 for my $href (@array_of_hashrefs) {
3410 $stmt ||= $sql->insert('table', $href);
3411 $sth ||= $dbh->prepare($stmt);
3412 $sth->execute($sql->values($href));
3415 The reason this works is because the keys in your C<$href> are sorted
3416 internally by B<SQL::Abstract>. Thus, as long as your data retains
3417 the same structure, you only have to generate the SQL the first time
3418 around. On subsequent queries, simply use the C<values> function provided
3419 by this module to return your values in the correct order.
3421 However this depends on the values having the same type - if, for
3422 example, the values of a where clause may either have values
3423 (resulting in sql of the form C<column = ?> with a single bind
3424 value), or alternatively the values might be C<undef> (resulting in
3425 sql of the form C<column IS NULL> with no bind value) then the
3426 caching technique suggested will not work.
3430 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3431 really like this part (I do, at least). Building up a complex query
3432 can be as simple as the following:
3439 use CGI::FormBuilder;
3442 my $form = CGI::FormBuilder->new(...);
3443 my $sql = SQL::Abstract->new;
3445 if ($form->submitted) {
3446 my $field = $form->field;
3447 my $id = delete $field->{id};
3448 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3451 Of course, you would still have to connect using C<DBI> to run the
3452 query, but the point is that if you make your form look like your
3453 table, the actual query script can be extremely simplistic.
3455 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3456 a fast interface to returning and formatting data. I frequently
3457 use these three modules together to write complex database query
3458 apps in under 50 lines.
3460 =head1 HOW TO CONTRIBUTE
3462 Contributions are always welcome, in all usable forms (we especially
3463 welcome documentation improvements). The delivery methods include git-
3464 or unified-diff formatted patches, GitHub pull requests, or plain bug
3465 reports either via RT or the Mailing list. Contributors are generally
3466 granted full access to the official repository after their first several
3467 patches pass successful review.
3469 This project is maintained in a git repository. The code and related tools are
3470 accessible at the following locations:
3474 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3476 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3478 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3480 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3486 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3487 Great care has been taken to preserve the I<published> behavior
3488 documented in previous versions in the 1.* family; however,
3489 some features that were previously undocumented, or behaved
3490 differently from the documentation, had to be changed in order
3491 to clarify the semantics. Hence, client code that was relying
3492 on some dark areas of C<SQL::Abstract> v1.*
3493 B<might behave differently> in v1.50.
3495 The main changes are:
3501 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3505 support for the { operator => \"..." } construct (to embed literal SQL)
3509 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3513 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3517 defensive programming: check arguments
3521 fixed bug with global logic, which was previously implemented
3522 through global variables yielding side-effects. Prior versions would
3523 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3524 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3525 Now this is interpreted
3526 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3531 fixed semantics of _bindtype on array args
3535 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3536 we just avoid shifting arrays within that tree.
3540 dropped the C<_modlogic> function
3544 =head1 ACKNOWLEDGEMENTS
3546 There are a number of individuals that have really helped out with
3547 this module. Unfortunately, most of them submitted bugs via CPAN
3548 so I have no idea who they are! But the people I do know are:
3550 Ash Berlin (order_by hash term support)
3551 Matt Trout (DBIx::Class support)
3552 Mark Stosberg (benchmarking)
3553 Chas Owens (initial "IN" operator support)
3554 Philip Collins (per-field SQL functions)
3555 Eric Kolve (hashref "AND" support)
3556 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3557 Dan Kubb (support for "quote_char" and "name_sep")
3558 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3559 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3560 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3561 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3562 Oliver Charles (support for "RETURNING" after "INSERT")
3568 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3572 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3574 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3576 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3577 While not an official support venue, C<DBIx::Class> makes heavy use of
3578 C<SQL::Abstract>, and as such list members there are very familiar with
3579 how to create queries.
3583 This module is free software; you may copy this under the same
3584 terms as perl itself (either the GNU General Public License or
3585 the Artistic License)