1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.86';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
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' },
59 { regex => qr/^ func $/xi, handler => '_where_op_FUNC' },
62 #======================================================================
63 # DEBUGGING AND ERROR REPORTING
64 #======================================================================
67 return unless $_[0]->{debug}; shift; # a little faster
68 my $func = (caller(1))[3];
69 warn "[$func] ", @_, "\n";
73 my($func) = (caller(1))[3];
74 Carp::carp "[$func] Warning: ", @_;
78 my($func) = (caller(1))[3];
79 Carp::croak "[$func] Fatal: ", @_;
82 sub is_literal_value ($) {
83 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
84 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
88 # FIXME XSify - this can be done so much more efficiently
89 sub is_plain_value ($) {
91 ! length ref $_[0] ? \($_[0])
93 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
95 exists $_[0]->{-value}
96 ) ? \($_[0]->{-value})
98 # reuse @_ for even moar speedz
99 defined ( $_[1] = Scalar::Util::blessed $_[0] )
101 # deliberately not using Devel::OverloadInfo - the checks we are
102 # intersted in are much more limited than the fullblown thing, and
103 # this is a very hot piece of code
105 # simply using ->can('(""') can leave behind stub methods that
106 # break actually using the overload later (see L<perldiag/Stub
107 # found while resolving method "%s" overloading "%s" in package
108 # "%s"> and the source of overload::mycan())
110 # either has stringification which DBI SHOULD prefer out of the box
111 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
113 # has nummification or boolification, AND fallback is *not* disabled
115 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
118 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
120 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
124 # no fallback specified at all
125 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
127 # fallback explicitly undef
128 ! defined ${"$_[3]::()"}
141 #======================================================================
143 #======================================================================
147 my $class = ref($self) || $self;
148 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
150 # choose our case by keeping an option around
151 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
153 # default logic for interpreting arrayrefs
154 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
156 # how to return bind vars
157 $opt{bindtype} ||= 'normal';
159 # default comparison is "=", but can be overridden
162 # try to recognize which are the 'equality' and 'inequality' ops
163 # (temporary quickfix (in 2007), should go through a more seasoned API)
164 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
165 $opt{inequality_op} = qr/^( != | <> )$/ix;
167 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
168 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
171 $opt{sqltrue} ||= '1=1';
172 $opt{sqlfalse} ||= '0=1';
175 $opt{user_special_ops} = [ @{$opt{special_ops} ||= []} ];
176 # regexes are applied in order, thus push after user-defines
177 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
180 $opt{unary_ops} ||= [];
181 push @{$opt{unary_ops}}, @BUILTIN_UNARY_OPS;
183 # rudimentary sanity-check for user supplied bits treated as functions/operators
184 # If a purported function matches this regular expression, an exception is thrown.
185 # Literal SQL is *NOT* subject to this check, only functions (and column names
186 # when quoting is not in effect)
189 # need to guard against ()'s in column names too, but this will break tons of
190 # hacks... ideas anyone?
191 $opt{injection_guard} ||= qr/
197 return bless \%opt, $class;
201 sub _assert_pass_injection_guard {
202 if ($_[1] =~ $_[0]->{injection_guard}) {
203 my $class = ref $_[0];
204 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
205 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
206 . "{injection_guard} attribute to ${class}->new()"
211 #======================================================================
213 #======================================================================
217 my $table = $self->_table(shift);
218 my $data = shift || return;
221 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
222 my ($sql, @bind) = $self->$method($data);
223 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
225 if ($options->{returning}) {
226 my ($s, @b) = $self->_insert_returning($options);
231 return wantarray ? ($sql, @bind) : $sql;
234 # So that subclasses can override INSERT ... RETURNING separately from
235 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
236 sub _insert_returning { shift->_returning(@_) }
239 my ($self, $options) = @_;
241 my $f = $options->{returning};
243 my $fieldlist = $self->_SWITCH_refkind($f, {
244 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$f;},
245 SCALAR => sub {$self->_quote($f)},
246 SCALARREF => sub {$$f},
248 return $self->_sqlcase(' returning ') . $fieldlist;
251 sub _insert_HASHREF { # explicit list of fields and then values
252 my ($self, $data) = @_;
254 my @fields = sort keys %$data;
256 my ($sql, @bind) = $self->_insert_values($data);
259 $_ = $self->_quote($_) foreach @fields;
260 $sql = "( ".join(", ", @fields).") ".$sql;
262 return ($sql, @bind);
265 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
266 my ($self, $data) = @_;
268 # no names (arrayref) so can't generate bindtype
269 $self->{bindtype} ne 'columns'
270 or belch "can't do 'columns' bindtype when called with arrayref";
272 my (@values, @all_bind);
273 foreach my $value (@$data) {
274 my ($values, @bind) = $self->_insert_value(undef, $value);
275 push @values, $values;
276 push @all_bind, @bind;
278 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
279 return ($sql, @all_bind);
282 sub _insert_ARRAYREFREF { # literal SQL with bind
283 my ($self, $data) = @_;
285 my ($sql, @bind) = @${$data};
286 $self->_assert_bindval_matches_bindtype(@bind);
288 return ($sql, @bind);
292 sub _insert_SCALARREF { # literal SQL without bind
293 my ($self, $data) = @_;
299 my ($self, $data) = @_;
301 my (@values, @all_bind);
302 foreach my $column (sort keys %$data) {
303 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
304 push @values, $values;
305 push @all_bind, @bind;
307 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
308 return ($sql, @all_bind);
312 my ($self, $column, $v) = @_;
314 my (@values, @all_bind);
315 $self->_SWITCH_refkind($v, {
318 if ($self->{array_datatypes}) { # if array datatype are activated
320 push @all_bind, $self->_bindtype($column, $v);
322 else { # else literal SQL with bind
323 my ($sql, @bind) = @$v;
324 $self->_assert_bindval_matches_bindtype(@bind);
326 push @all_bind, @bind;
330 ARRAYREFREF => sub { # literal SQL with bind
331 my ($sql, @bind) = @${$v};
332 $self->_assert_bindval_matches_bindtype(@bind);
334 push @all_bind, @bind;
337 # THINK: anything useful to do with a HASHREF ?
338 HASHREF => sub { # (nothing, but old SQLA passed it through)
339 #TODO in SQLA >= 2.0 it will die instead
340 belch "HASH ref as bind value in insert is not supported";
342 push @all_bind, $self->_bindtype($column, $v);
345 SCALARREF => sub { # literal SQL without bind
349 SCALAR_or_UNDEF => sub {
351 push @all_bind, $self->_bindtype($column, $v);
356 my $sql = join(", ", @values);
357 return ($sql, @all_bind);
362 #======================================================================
364 #======================================================================
369 my $table = $self->_table(shift);
370 my $data = shift || return;
374 # first build the 'SET' part of the sql statement
375 puke "Unsupported data type specified to \$sql->update"
376 unless ref $data eq 'HASH';
378 my ($sql, @all_bind) = $self->_update_set_values($data);
379 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
383 my($where_sql, @where_bind) = $self->where($where);
385 push @all_bind, @where_bind;
388 if ($options->{returning}) {
389 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
390 $sql .= $returning_sql;
391 push @all_bind, @returning_bind;
394 return wantarray ? ($sql, @all_bind) : $sql;
397 sub _update_set_values {
398 my ($self, $data) = @_;
400 my (@set, @all_bind);
401 for my $k (sort keys %$data) {
404 my $label = $self->_quote($k);
406 $self->_SWITCH_refkind($v, {
408 if ($self->{array_datatypes}) { # array datatype
409 push @set, "$label = ?";
410 push @all_bind, $self->_bindtype($k, $v);
412 else { # literal SQL with bind
413 my ($sql, @bind) = @$v;
414 $self->_assert_bindval_matches_bindtype(@bind);
415 push @set, "$label = $sql";
416 push @all_bind, @bind;
419 ARRAYREFREF => sub { # literal SQL with bind
420 my ($sql, @bind) = @${$v};
421 $self->_assert_bindval_matches_bindtype(@bind);
422 push @set, "$label = $sql";
423 push @all_bind, @bind;
425 SCALARREF => sub { # literal SQL without bind
426 push @set, "$label = $$v";
429 my ($op, $arg, @rest) = %$v;
431 puke 'Operator calls in update must be in the form { -op => $arg }'
432 if (@rest or not $op =~ /^\-(.+)/);
434 local $self->{_nested_func_lhs} = $k;
435 my ($sql, @bind) = $self->_where_unary_op($1, $arg);
437 push @set, "$label = $sql";
438 push @all_bind, @bind;
440 SCALAR_or_UNDEF => sub {
441 push @set, "$label = ?";
442 push @all_bind, $self->_bindtype($k, $v);
448 my $sql = join ', ', @set;
450 return ($sql, @all_bind);
453 # So that subclasses can override UPDATE ... RETURNING separately from
455 sub _update_returning { shift->_returning(@_) }
459 #======================================================================
461 #======================================================================
466 my $table = $self->_table(shift);
467 my $fields = shift || '*';
471 my ($fields_sql, @bind) = $self->_select_fields($fields);
473 my ($where_sql, @where_bind) = $self->where($where, $order);
474 push @bind, @where_bind;
476 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
477 $self->_sqlcase('from'), $table)
480 return wantarray ? ($sql, @bind) : $sql;
484 my ($self, $fields) = @_;
485 return ref $fields eq 'ARRAY' ? join ', ', map { $self->_quote($_) } @$fields
489 #======================================================================
491 #======================================================================
496 my $table = $self->_table(shift);
500 my($where_sql, @bind) = $self->where($where);
501 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
503 if ($options->{returning}) {
504 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
505 $sql .= $returning_sql;
506 push @bind, @returning_bind;
509 return wantarray ? ($sql, @bind) : $sql;
512 # So that subclasses can override DELETE ... RETURNING separately from
514 sub _delete_returning { shift->_returning(@_) }
518 #======================================================================
520 #======================================================================
524 # Finally, a separate routine just to handle WHERE clauses
526 my ($self, $where, $order) = @_;
529 my ($sql, @bind) = $self->_recurse_where($where);
530 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
534 my ($order_sql, @order_bind) = $self->_order_by($order);
536 push @bind, @order_bind;
539 return wantarray ? ($sql, @bind) : $sql;
543 my ($self, $expr, $logic) = @_;
544 return undef unless defined($expr);
545 if (ref($expr) eq 'HASH') {
546 if (keys %$expr > 1) {
548 return +{ "-${logic}" => [
549 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
553 return unless %$expr;
554 return $self->_expand_expr_hashpair(%$expr, $logic);
556 if (ref($expr) eq 'ARRAY') {
557 my $logic = lc($logic || $self->{logic});
558 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
564 while (my ($el) = splice @expr, 0, 1) {
565 puke "Supplying an empty left hand side argument is not supported in array-pairs"
566 unless defined($el) and length($el);
567 my $elref = ref($el);
569 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
570 } elsif ($elref eq 'ARRAY') {
571 push(@res, $self->_expand_expr($el)) if @$el;
572 } elsif (is_literal_value($el)) {
574 } elsif ($elref eq 'HASH') {
575 push @res, $self->_expand_expr($el);
580 return { '-'.$logic => \@res };
582 if (my $literal = is_literal_value($expr)) {
583 return +{ -literal => $literal };
585 if (!ref($expr) or Scalar::Util::blessed($expr)) {
586 if (my $m = our $Cur_Col_Meta) {
587 return +{ -bind => [ $m, $expr ] };
589 return +{ -value => $expr };
591 #::Ddie([ HUH => $expr ]);
595 sub _expand_expr_hashpair {
596 my ($self, $k, $v, $logic) = @_;
597 unless (defined($k) and length($k)) {
598 if (defined($k) and my $literal = is_literal_value($v)) {
599 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
600 return { -literal => $literal };
602 puke "Supplying an empty left hand side argument is not supported";
605 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
606 if ($k =~ s/ [_\s]? \d+ $//x ) {
607 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
608 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
611 return $self->_expand_expr($v);
615 return $self->_expand_expr($v);
617 puke "-bool => undef not supported" unless defined($v);
618 return { -ident => $v };
621 return { -not => $self->_expand_expr($v) };
623 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
625 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
628 if (my ($logic) = $k =~ /^-(and|or)$/i) {
629 if (ref($v) eq 'HASH') {
630 return $self->_expand_expr($v, $logic);
632 if (ref($v) eq 'ARRAY') {
633 return $self->_expand_expr($v, $logic);
638 $op =~ s/^-// if length($op) > 1;
640 # top level special ops are illegal in general
641 puke "Illegal use of top-level '-$op'"
642 if !(defined $self->{_nested_func_lhs})
643 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
644 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
646 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
647 return +{ -bind => [ $m, $v ] };
649 if ($k eq '-op' or $k eq '-ident' or $k eq '-value' or $k eq '-bind' or $k eq '-literal' or $k eq '-func') {
655 and (keys %$v)[0] =~ /^-/
657 my ($func) = $k =~ /^-(.*)$/;
658 return +{ -func => [ $func, $self->_expand_expr($v) ] };
660 if (!ref($v) or is_literal_value($v)) {
661 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
668 and exists $v->{-value}
669 and not defined $v->{-value}
672 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
674 if (!ref($v) or Scalar::Util::blessed($v)) {
679 { -bind => [ $k, $v ] }
683 if (ref($v) eq 'HASH') {
686 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
693 $self->_assert_pass_injection_guard($vk);
694 if ($vk =~ s/ [_\s]? \d+ $//x ) {
695 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
696 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
698 if ($vk =~ /^(?:not[ _])?between$/) {
699 local our $Cur_Col_Meta = $k;
700 my @rhs = map $self->_expand_expr($_),
701 ref($vv) eq 'ARRAY' ? @$vv : $vv;
703 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
705 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
707 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
710 join(' ', split '_', $vk),
715 if ($vk =~ /^(?:not[ _])?in$/) {
716 if (my $literal = is_literal_value($vv)) {
717 my ($sql, @bind) = @$literal;
718 my $opened_sql = $self->_open_outer_paren($sql);
720 $vk, { -ident => $k },
721 [ { -literal => [ $opened_sql, @bind ] } ]
725 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
726 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
727 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
728 . 'will emit the logically correct SQL instead of raising this exception)'
730 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
732 my @rhs = map $self->_expand_expr($_),
733 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
734 map { defined($_) ? $_: puke($undef_err) }
735 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
737 -literal => [ $self->{$vk =~ /^not/ ? 'sqltrue' : 'sqlfalse'} ]
741 join(' ', split '_', $vk),
746 if ($vk eq 'ident') {
747 if (! defined $vv or ref $vv) {
748 puke "-$vk requires a single plain scalar argument (a quotable identifier)";
756 if ($vk eq 'value') {
757 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
761 { -bind => [ $k, $vv ] }
764 if ($vk =~ /^is(?:[ _]not)?$/) {
765 puke "$vk can only take undef as argument"
769 and exists($vv->{-value})
770 and !defined($vv->{-value})
773 return +{ -op => [ $vk.' null', { -ident => $k } ] };
775 if ($vk =~ /^(and|or)$/) {
776 if (ref($vv) eq 'HASH') {
777 return +{ "-${vk}" => [
778 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
783 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{user_special_ops}}) {
784 return { -op => [ $vk, { -ident => $k }, $vv ] };
786 if (ref($vv) eq 'ARRAY') {
787 my ($logic, @values) = (
788 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
793 $vk =~ $self->{inequality_op}
794 or join(' ', split '_', $vk) =~ $self->{not_like_op}
796 if (lc($logic) eq '-or' and @values > 1) {
797 my $op = uc join ' ', split '_', $vk;
798 belch "A multi-element arrayref as an argument to the inequality op '$op' "
799 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
800 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
805 # try to DWIM on equality operators
806 my $op = join ' ', split '_', $vk;
808 $op =~ $self->{equality_op} ? $self->{sqlfalse}
809 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
810 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
811 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
812 : puke "operator '$op' applied on an empty array (field '$k')";
814 return +{ $logic => [
815 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
823 and exists $vv->{-value}
824 and not defined $vv->{-value}
827 my $op = join ' ', split '_', $vk;
829 $op =~ /^not$/i ? 'is not' # legacy
830 : $op =~ $self->{equality_op} ? 'is'
831 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
832 : $op =~ $self->{inequality_op} ? 'is not'
833 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
834 : puke "unexpected operator '$op' with undef operand";
835 return +{ -op => [ $is.' null', { -ident => $k } ] };
837 local our $Cur_Col_Meta = $k;
841 $self->_expand_expr($vv)
844 if (ref($v) eq 'ARRAY') {
845 return $self->{sqlfalse} unless @$v;
846 $self->_debug("ARRAY($k) means distribute over elements");
848 $v->[0] =~ /^-((?:and|or))$/i
849 ? ($v = [ @{$v}[1..$#$v] ], $1)
850 : ($self->{logic} || 'or')
852 return +{ "-${this_logic}" => [ map $self->_expand_expr({ $k => $_ }, $this_logic), @$v ] };
854 if (my $literal = is_literal_value($v)) {
856 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
859 my ($sql, @bind) = @$literal;
860 if ($self->{bindtype} eq 'columns') {
862 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
863 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
867 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
869 ::Ddie([ HUH => { $k => $v } ]);
875 my ($self, $where, $logic) = @_;
877 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
879 my $where_exp = $self->_expand_expr($where, $logic);
881 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
883 # dispatch on appropriate method according to refkind of $where
884 my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
886 my ($sql, @bind) = $self->$method($where_exp, $logic);
888 # DBIx::Class used to call _recurse_where in scalar context
889 # something else might too...
891 return ($sql, @bind);
894 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
901 #======================================================================
902 # WHERE: top-level ARRAYREF
903 #======================================================================
906 sub _where_ARRAYREF {
907 my ($self, $where, $logic) = @_;
909 $logic = uc($logic || $self->{logic});
910 $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
912 my @clauses = @$where;
914 my (@sql_clauses, @all_bind);
915 # need to use while() so can shift() for pairs
917 my $el = shift @clauses;
919 $el = undef if (defined $el and ! length $el);
921 # switch according to kind of $el and get corresponding ($sql, @bind)
922 my ($sql, @bind) = $self->_SWITCH_refkind($el, {
924 # skip empty elements, otherwise get invalid trailing AND stuff
925 ARRAYREF => sub {$self->_recurse_where($el) if @$el},
929 $self->_assert_bindval_matches_bindtype(@b);
933 HASHREF => sub {$self->_recurse_where($el, 'and') if %$el},
935 SCALARREF => sub { ($$el); },
938 # top-level arrayref with scalars, recurse in pairs
939 $self->_recurse_where({$el => shift(@clauses)})
942 UNDEF => sub {puke "Supplying an empty left hand side argument is not supported in array-pairs" },
946 push @sql_clauses, $sql;
947 push @all_bind, @bind;
951 return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
954 #======================================================================
955 # WHERE: top-level ARRAYREFREF
956 #======================================================================
958 sub _where_ARRAYREFREF {
959 my ($self, $where) = @_;
960 my ($sql, @bind) = @$$where;
961 $self->_assert_bindval_matches_bindtype(@bind);
962 return ($sql, @bind);
965 #======================================================================
966 # WHERE: top-level HASHREF
967 #======================================================================
970 my ($self, $where) = @_;
971 my (@sql_clauses, @all_bind);
973 for my $k (sort keys %$where) {
974 my $v = $where->{$k};
976 # ($k => $v) is either a special unary op or a regular hashpair
977 my ($sql, @bind) = do {
979 # put the operator in canonical form
981 $op = substr $op, 1; # remove initial dash
982 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
983 $op =~ s/\s+/ /g; # compress whitespace
985 # so that -not_foo works correctly
986 $op =~ s/^not_/NOT /i;
988 $self->_debug("Unary OP(-$op) within hashref, recursing...");
989 my ($s, @b) = $self->_where_unary_op($op, $v);
991 # top level vs nested
992 # we assume that handled unary ops will take care of their ()s
994 List::Util::first {$op =~ $_->{regex}} @{$self->{unary_ops}}
996 ( defined $self->{_nested_func_lhs} and $self->{_nested_func_lhs} eq $k )
1002 if (is_literal_value ($v) ) {
1003 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
1006 puke "Supplying an empty left hand side argument is not supported in hash-pairs";
1010 my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
1011 $self->$method($k, $v);
1015 push @sql_clauses, $sql;
1016 push @all_bind, @bind;
1019 return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
1022 sub _where_unary_op {
1023 my ($self, $op, $rhs) = @_;
1025 $op =~ s/^-// if length($op) > 1;
1027 # top level special ops are illegal in general
1028 puke "Illegal use of top-level '-$op'"
1029 if !(defined $self->{_nested_func_lhs})
1030 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
1031 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
1033 if (my $op_entry = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1034 my $handler = $op_entry->{handler};
1036 if (not ref $handler) {
1037 if ($op =~ s/ [_\s]? \d+ $//x ) {
1038 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
1039 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
1041 return $self->$handler($op, $rhs);
1043 elsif (ref $handler eq 'CODE') {
1044 return $handler->($self, $op, $rhs);
1047 puke "Illegal handler for operator $op - expecting a method name or a coderef";
1051 $self->_debug("Generic unary OP: $op - recursing as function");
1053 $self->_assert_pass_injection_guard($op);
1055 my ($sql, @bind) = $self->_SWITCH_refkind($rhs, {
1057 puke "Illegal use of top-level '-$op'"
1058 unless defined $self->{_nested_func_lhs};
1061 $self->_convert('?'),
1062 $self->_bindtype($self->{_nested_func_lhs}, $rhs)
1066 $self->_recurse_where($rhs)
1070 $sql = sprintf('%s %s',
1071 $self->_sqlcase($op),
1075 return ($sql, @bind);
1078 sub _where_op_ANDOR {
1079 my ($self, $op, $v) = @_;
1081 $self->_SWITCH_refkind($v, {
1083 return $self->_where_ARRAYREF($v, $op);
1087 return ($op =~ /^or/i)
1088 ? $self->_where_ARRAYREF([ map { $_ => $v->{$_} } (sort keys %$v) ], $op)
1089 : $self->_where_HASHREF($v);
1093 puke "-$op => \\\$scalar makes little sense, use " .
1095 ? '[ \$scalar, \%rest_of_conditions ] instead'
1096 : '-and => [ \$scalar, \%rest_of_conditions ] instead'
1100 ARRAYREFREF => sub {
1101 puke "-$op => \\[...] makes little sense, use " .
1103 ? '[ \[...], \%rest_of_conditions ] instead'
1104 : '-and => [ \[...], \%rest_of_conditions ] instead'
1108 SCALAR => sub { # permissively interpreted as SQL
1109 puke "-$op => \$value makes little sense, use -bool => \$value instead";
1113 puke "-$op => undef not supported";
1118 sub _where_op_NEST {
1119 my ($self, $op, $v) = @_;
1121 $self->_SWITCH_refkind($v, {
1123 SCALAR => sub { # permissively interpreted as SQL
1124 belch "literal SQL should be -nest => \\'scalar' "
1125 . "instead of -nest => 'scalar' ";
1130 puke "-$op => undef not supported";
1134 $self->_recurse_where($v);
1141 sub _where_op_BOOL {
1142 my ($self, $op, $v) = @_;
1144 my ($s, @b) = $self->_SWITCH_refkind($v, {
1145 SCALAR => sub { # interpreted as SQL column
1146 $self->_convert($self->_quote($v));
1150 puke "-$op => undef not supported";
1154 $self->_recurse_where($v);
1158 $s = "(NOT $s)" if $op =~ /^not/i;
1163 sub _where_op_IDENT {
1165 my ($op, $rhs) = splice @_, -2;
1166 if (! defined $rhs or length ref $rhs) {
1167 puke "-$op requires a single plain scalar argument (a quotable identifier)";
1170 # in case we are called as a top level special op (no '=')
1171 my $has_lhs = my $lhs = shift;
1173 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
1181 sub _where_op_VALUE {
1183 my ($op, $rhs) = splice @_, -2;
1185 # in case we are called as a top level special op (no '=')
1189 if (! defined $rhs) {
1191 ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
1198 (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
1205 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
1209 $self->_convert('?'),
1216 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
1222 my ($self, $args) = @_;
1223 my ($left, $low, $high) = @$args;
1224 my ($rhsql, @rhbind) = do {
1226 puke "Single arg to between must be a literal"
1227 unless $low->{-literal};
1230 local $self->{_nested_func_lhs} = $left->{-ident}
1231 if ref($left) eq 'HASH' and $left->{-ident};
1232 my ($l, $h) = map [ $self->_where_unary_op(%$_) ], $low, $high;
1233 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1234 @{$l}[1..$#$l], @{$h}[1..$#$h])
1237 my ($lhsql, @lhbind) = $self->_recurse_where($left);
1239 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1243 }), 'between', 'not between'),
1247 my ($self, $args) = @_;
1248 my ($lhs, $rhs) = @$args;
1251 local $self->{_nested_func_lhs} = $lhs->{-ident}
1252 if ref($lhs) eq 'HASH' and $lhs->{-ident};
1253 my ($sql, @bind) = $self->_where_unary_op(%$_);
1254 push @in_bind, @bind;
1257 my ($lhsql, @lbind) = $self->_recurse_where($lhs);
1259 $lhsql.' '.$self->_sqlcase($op).' ( '
1260 .join(', ', @in_sql)
1265 }), 'in', 'not in'),
1269 my ($self, undef, $v) = @_;
1270 my ($op, @args) = @$v;
1271 $op =~ s/^-// if length($op) > 1;
1272 local $self->{_nested_func_lhs};
1273 if (my $h = $special{$op}) {
1274 return $self->$h(\@args);
1276 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{user_special_ops}}) {
1277 puke "Special op '${op}' requires first value to be identifier"
1278 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1279 return $self->${\($us->{handler})}($k, $op, $args[1]);
1281 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1283 my ($expr_sql, @bind) = $self->_recurse_where($args[0]);
1284 my $op_sql = $self->_sqlcase($final_op);
1286 $unop_postfix{lc($final_op)}
1287 ? "${expr_sql} ${op_sql}"
1288 : "${op_sql} ${expr_sql}"
1290 return ($final_sql, @bind);
1291 } elsif (@args == 2) {
1292 my ($l, $r) = map [ $self->_recurse_where($_) ], @args;
1294 $l->[0].' '.$self->_sqlcase($final_op).' '.$r->[0],
1295 @{$l}[1..$#$l], @{$r}[1..$#$r]
1301 sub _where_op_FUNC {
1302 my ($self, undef, $rest) = @_;
1303 my ($func, @args) = @$rest;
1307 push @arg_sql, shift @x;
1309 } map [ $self->_recurse_where($_) ], @args;
1310 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1313 sub _where_op_BIND {
1314 my ($self, undef, $bind) = @_;
1315 return ($self->_convert('?'), $self->_bindtype(@$bind));
1318 sub _where_op_LITERAL {
1319 my ($self, undef, $literal) = @_;
1320 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1324 sub _where_hashpair_ARRAYREF {
1325 my ($self, $k, $v) = @_;
1328 my @v = @$v; # need copy because of shift below
1329 $self->_debug("ARRAY($k) means distribute over elements");
1331 # put apart first element if it is an operator (-and, -or)
1333 (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
1337 my @distributed = map { {$k => $_} } @v;
1340 $self->_debug("OP($op) reinjected into the distributed array");
1341 unshift @distributed, $op;
1344 my $logic = $op ? substr($op, 1) : '';
1346 return $self->_recurse_where(\@distributed, $logic);
1349 $self->_debug("empty ARRAY($k) means 0=1");
1350 return ($self->{sqlfalse});
1354 sub _where_hashpair_HASHREF {
1355 my ($self, $k, $v, $logic) = @_;
1358 local $self->{_nested_func_lhs} = defined $self->{_nested_func_lhs}
1359 ? $self->{_nested_func_lhs}
1363 my ($all_sql, @all_bind);
1365 for my $orig_op (sort keys %$v) {
1366 my $val = $v->{$orig_op};
1368 # put the operator in canonical form
1371 # FIXME - we need to phase out dash-less ops
1372 $op =~ s/^-//; # remove possible initial dash
1373 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
1374 $op =~ s/\s+/ /g; # compress whitespace
1376 $self->_assert_pass_injection_guard($op);
1379 $op =~ s/^is_not/IS NOT/i;
1381 # so that -not_foo works correctly
1382 $op =~ s/^not_/NOT /i;
1384 # another retarded special case: foo => { $op => { -value => undef } }
1385 if (ref $val eq 'HASH' and keys %$val == 1 and exists $val->{-value} and ! defined $val->{-value} ) {
1391 # CASE: col-value logic modifiers
1392 if ($orig_op =~ /^ \- (and|or) $/xi) {
1393 ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $1);
1395 # CASE: special operators like -in or -between
1396 elsif (my $special_op = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1397 my $handler = $special_op->{handler};
1399 puke "No handler supplied for special operator $orig_op";
1401 elsif (not ref $handler) {
1402 ($sql, @bind) = $self->$handler($k, $op, $val);
1404 elsif (ref $handler eq 'CODE') {
1405 ($sql, @bind) = $handler->($self, $k, $op, $val);
1408 puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
1412 $self->_SWITCH_refkind($val, {
1414 ARRAYREF => sub { # CASE: col => {op => \@vals}
1415 ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
1418 ARRAYREFREF => sub { # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
1419 my ($sub_sql, @sub_bind) = @$$val;
1420 $self->_assert_bindval_matches_bindtype(@sub_bind);
1421 $sql = join ' ', $self->_convert($self->_quote($k)),
1422 $self->_sqlcase($op),
1427 UNDEF => sub { # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
1429 $op =~ /^not$/i ? 'is not' # legacy
1430 : $op =~ $self->{equality_op} ? 'is'
1431 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
1432 : $op =~ $self->{inequality_op} ? 'is not'
1433 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
1434 : puke "unexpected operator '$orig_op' with undef operand";
1436 $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
1439 FALLBACK => sub { # CASE: col => {op/func => $stuff}
1440 ($sql, @bind) = $self->_where_unary_op($op, $val);
1443 $self->_convert($self->_quote($k)),
1444 $self->{_nested_func_lhs} eq $k ? $sql : "($sql)", # top level vs nested
1450 ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
1451 push @all_bind, @bind;
1453 return ($all_sql, @all_bind);
1456 sub _where_field_IS {
1457 my ($self, $k, $op, $v) = @_;
1459 my ($s) = $self->_SWITCH_refkind($v, {
1462 $self->_convert($self->_quote($k)),
1463 map { $self->_sqlcase($_)} ($op, 'null')
1466 puke "$op can only take undef as argument";
1473 sub _where_field_op_ARRAYREF {
1474 my ($self, $k, $op, $vals) = @_;
1476 my @vals = @$vals; #always work on a copy
1479 $self->_debug(sprintf '%s means multiple elements: [ %s ]',
1481 join(', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
1484 # see if the first element is an -and/-or op
1486 if (defined $vals[0] && $vals[0] =~ /^ - (AND|OR) $/ix) {
1491 # a long standing API wart - an attempt to change this behavior during
1492 # the 1.50 series failed *spectacularly*. Warn instead and leave the
1497 (!$logic or $logic eq 'OR')
1499 ($op =~ $self->{inequality_op} or $op =~ $self->{not_like_op})
1502 belch "A multi-element arrayref as an argument to the inequality op '$o' "
1503 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1504 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1508 # distribute $op over each remaining member of @vals, append logic if exists
1509 return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
1513 # try to DWIM on equality operators
1515 $op =~ $self->{equality_op} ? $self->{sqlfalse}
1516 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
1517 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
1518 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
1519 : puke "operator '$op' applied on an empty array (field '$k')";
1524 sub _where_hashpair_SCALARREF {
1525 my ($self, $k, $v) = @_;
1526 $self->_debug("SCALAR($k) means literal SQL: $$v");
1527 my $sql = $self->_quote($k) . " " . $$v;
1531 # literal SQL with bind
1532 sub _where_hashpair_ARRAYREFREF {
1533 my ($self, $k, $v) = @_;
1534 $self->_debug("REF($k) means literal SQL: @${$v}");
1535 my ($sql, @bind) = @$$v;
1536 $self->_assert_bindval_matches_bindtype(@bind);
1537 $sql = $self->_quote($k) . " " . $sql;
1538 return ($sql, @bind );
1541 # literal SQL without bind
1542 sub _where_hashpair_SCALAR {
1543 my ($self, $k, $v) = @_;
1544 $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
1545 return ($self->_where_hashpair_HASHREF($k, { $self->{cmp} => $v }));
1549 sub _where_hashpair_UNDEF {
1550 my ($self, $k, $v) = @_;
1551 $self->_debug("UNDEF($k) means IS NULL");
1552 return $self->_where_hashpair_HASHREF($k, { -is => undef });
1555 #======================================================================
1556 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
1557 #======================================================================
1560 sub _where_SCALARREF {
1561 my ($self, $where) = @_;
1564 $self->_debug("SCALAR(*top) means literal SQL: $$where");
1570 my ($self, $where) = @_;
1573 $self->_debug("NOREF(*top) means literal SQL: $where");
1584 #======================================================================
1585 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
1586 #======================================================================
1589 sub _where_field_BETWEEN {
1590 my ($self, $k, $op, $vals) = @_;
1592 my ($label, $and, $placeholder);
1593 $label = $self->_convert($self->_quote($k));
1594 $and = ' ' . $self->_sqlcase('and') . ' ';
1595 $placeholder = $self->_convert('?');
1596 $op = $self->_sqlcase($op);
1598 my $invalid_args = "Operator '$op' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1600 my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
1601 ARRAYREFREF => sub {
1602 my ($s, @b) = @$$vals;
1603 $self->_assert_bindval_matches_bindtype(@b);
1610 puke $invalid_args if @$vals != 2;
1612 my (@all_sql, @all_bind);
1613 foreach my $val (@$vals) {
1614 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1616 return ($placeholder, $self->_bindtype($k, $val) );
1621 ARRAYREFREF => sub {
1622 my ($sql, @bind) = @$$val;
1623 $self->_assert_bindval_matches_bindtype(@bind);
1624 return ($sql, @bind);
1627 my ($func, $arg, @rest) = %$val;
1628 puke "Only simple { -func => arg } functions accepted as sub-arguments to BETWEEN"
1629 if (@rest or $func !~ /^ \- (.+)/x);
1630 $self->_where_unary_op($1 => $arg);
1636 push @all_sql, $sql;
1637 push @all_bind, @bind;
1641 (join $and, @all_sql),
1650 my $sql = "( $label $op $clause )";
1651 return ($sql, @bind)
1655 sub _where_field_IN {
1656 my ($self, $k, $op, $vals) = @_;
1658 # backwards compatibility: if scalar, force into an arrayref
1659 $vals = [$vals] if defined $vals && ! ref $vals;
1661 my ($label) = $self->_convert($self->_quote($k));
1662 my ($placeholder) = $self->_convert('?');
1663 $op = $self->_sqlcase($op);
1665 my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
1666 ARRAYREF => sub { # list of choices
1667 if (@$vals) { # nonempty list
1668 my (@all_sql, @all_bind);
1670 for my $val (@$vals) {
1671 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1673 return ($placeholder, $val);
1678 ARRAYREFREF => sub {
1679 my ($sql, @bind) = @$$val;
1680 $self->_assert_bindval_matches_bindtype(@bind);
1681 return ($sql, @bind);
1684 my ($func, $arg, @rest) = %$val;
1685 puke "Only simple { -func => arg } functions accepted as sub-arguments to IN"
1686 if (@rest or $func !~ /^ \- (.+)/x);
1687 $self->_where_unary_op($1 => $arg);
1691 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1692 . "-$op operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1693 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1694 . 'will emit the logically correct SQL instead of raising this exception)'
1698 push @all_sql, $sql;
1699 push @all_bind, @bind;
1703 sprintf('%s %s ( %s )',
1706 join(', ', @all_sql)
1708 $self->_bindtype($k, @all_bind),
1711 else { # empty list: some databases won't understand "IN ()", so DWIM
1712 my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
1717 SCALARREF => sub { # literal SQL
1718 my $sql = $self->_open_outer_paren($$vals);
1719 return ("$label $op ( $sql )");
1721 ARRAYREFREF => sub { # literal SQL with bind
1722 my ($sql, @bind) = @$$vals;
1723 $self->_assert_bindval_matches_bindtype(@bind);
1724 $sql = $self->_open_outer_paren($sql);
1725 return ("$label $op ( $sql )", @bind);
1729 puke "Argument passed to the '$op' operator can not be undefined";
1733 puke "special op $op requires an arrayref (or scalarref/arrayref-ref)";
1737 return ($sql, @bind);
1740 # Some databases (SQLite) treat col IN (1, 2) different from
1741 # col IN ( (1, 2) ). Use this to strip all outer parens while
1742 # adding them back in the corresponding method
1743 sub _open_outer_paren {
1744 my ($self, $sql) = @_;
1746 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1748 # there are closing parens inside, need the heavy duty machinery
1749 # to reevaluate the extraction starting from $sql (full reevaluation)
1750 if ($inner =~ /\)/) {
1751 require Text::Balanced;
1753 my (undef, $remainder) = do {
1754 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1756 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1759 # the entire expression needs to be a balanced bracketed thing
1760 # (after an extract no remainder sans trailing space)
1761 last if defined $remainder and $remainder =~ /\S/;
1771 #======================================================================
1773 #======================================================================
1776 my ($self, $arg) = @_;
1779 for my $c ($self->_order_by_chunks($arg) ) {
1780 $self->_SWITCH_refkind($c, {
1781 SCALAR => sub { push @sql, $c },
1782 ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1788 $self->_sqlcase(' order by'),
1794 return wantarray ? ($sql, @bind) : $sql;
1797 sub _order_by_chunks {
1798 my ($self, $arg) = @_;
1800 return $self->_SWITCH_refkind($arg, {
1803 map { $self->_order_by_chunks($_ ) } @$arg;
1806 ARRAYREFREF => sub {
1807 my ($s, @b) = @$$arg;
1808 $self->_assert_bindval_matches_bindtype(@b);
1812 SCALAR => sub {$self->_quote($arg)},
1814 UNDEF => sub {return () },
1816 SCALARREF => sub {$$arg}, # literal SQL, no quoting
1819 # get first pair in hash
1820 my ($key, $val, @rest) = %$arg;
1822 return () unless $key;
1824 if (@rest or not $key =~ /^-(desc|asc)/i) {
1825 puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1831 for my $c ($self->_order_by_chunks($val)) {
1834 $self->_SWITCH_refkind($c, {
1839 ($sql, @bind) = @$c;
1843 $sql = $sql . ' ' . $self->_sqlcase($direction);
1845 push @ret, [ $sql, @bind];
1854 #======================================================================
1855 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1856 #======================================================================
1861 $self->_SWITCH_refkind($from, {
1862 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$from;},
1863 SCALAR => sub {$self->_quote($from)},
1864 SCALARREF => sub {$$from},
1869 #======================================================================
1871 #======================================================================
1873 # highly optimized, as it's called way too often
1875 # my ($self, $label) = @_;
1877 return '' unless defined $_[1];
1878 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1880 $_[0]->{quote_char} or
1881 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1883 my $qref = ref $_[0]->{quote_char};
1885 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1886 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1887 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1889 my $esc = $_[0]->{escape_char} || $r;
1891 # parts containing * are naturally unquoted
1892 return join($_[0]->{name_sep}||'', map
1893 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1894 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1899 # Conversion, if applicable
1901 #my ($self, $arg) = @_;
1902 if ($_[0]->{convert}) {
1903 return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1910 #my ($self, $col, @vals) = @_;
1911 # called often - tighten code
1912 return $_[0]->{bindtype} eq 'columns'
1913 ? map {[$_[1], $_]} @_[2 .. $#_]
1918 # Dies if any element of @bind is not in [colname => value] format
1919 # if bindtype is 'columns'.
1920 sub _assert_bindval_matches_bindtype {
1921 # my ($self, @bind) = @_;
1923 if ($self->{bindtype} eq 'columns') {
1925 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1926 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1932 sub _join_sql_clauses {
1933 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1935 if (@$clauses_aref > 1) {
1936 my $join = " " . $self->_sqlcase($logic) . " ";
1937 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1938 return ($sql, @$bind_aref);
1940 elsif (@$clauses_aref) {
1941 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1944 return (); # if no SQL, ignore @$bind_aref
1949 # Fix SQL case, if so requested
1951 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1952 # don't touch the argument ... crooked logic, but let's not change it!
1953 return $_[0]->{case} ? $_[1] : uc($_[1]);
1957 #======================================================================
1958 # DISPATCHING FROM REFKIND
1959 #======================================================================
1962 my ($self, $data) = @_;
1964 return 'UNDEF' unless defined $data;
1966 # blessed objects are treated like scalars
1967 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1969 return 'SCALAR' unless $ref;
1972 while ($ref eq 'REF') {
1974 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1978 return ($ref||'SCALAR') . ('REF' x $n_steps);
1982 my ($self, $data) = @_;
1983 my @try = ($self->_refkind($data));
1984 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1985 push @try, 'FALLBACK';
1989 sub _METHOD_FOR_refkind {
1990 my ($self, $meth_prefix, $data) = @_;
1993 for (@{$self->_try_refkind($data)}) {
1994 $method = $self->can($meth_prefix."_".$_)
1998 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
2002 sub _SWITCH_refkind {
2003 my ($self, $data, $dispatch_table) = @_;
2006 for (@{$self->_try_refkind($data)}) {
2007 $coderef = $dispatch_table->{$_}
2011 puke "no dispatch entry for ".$self->_refkind($data)
2020 #======================================================================
2021 # VALUES, GENERATE, AUTOLOAD
2022 #======================================================================
2024 # LDNOTE: original code from nwiger, didn't touch code in that section
2025 # I feel the AUTOLOAD stuff should not be the default, it should
2026 # only be activated on explicit demand by user.
2030 my $data = shift || return;
2031 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
2032 unless ref $data eq 'HASH';
2035 foreach my $k (sort keys %$data) {
2036 my $v = $data->{$k};
2037 $self->_SWITCH_refkind($v, {
2039 if ($self->{array_datatypes}) { # array datatype
2040 push @all_bind, $self->_bindtype($k, $v);
2042 else { # literal SQL with bind
2043 my ($sql, @bind) = @$v;
2044 $self->_assert_bindval_matches_bindtype(@bind);
2045 push @all_bind, @bind;
2048 ARRAYREFREF => sub { # literal SQL with bind
2049 my ($sql, @bind) = @${$v};
2050 $self->_assert_bindval_matches_bindtype(@bind);
2051 push @all_bind, @bind;
2053 SCALARREF => sub { # literal SQL without bind
2055 SCALAR_or_UNDEF => sub {
2056 push @all_bind, $self->_bindtype($k, $v);
2067 my(@sql, @sqlq, @sqlv);
2071 if ($ref eq 'HASH') {
2072 for my $k (sort keys %$_) {
2075 my $label = $self->_quote($k);
2076 if ($r eq 'ARRAY') {
2077 # literal SQL with bind
2078 my ($sql, @bind) = @$v;
2079 $self->_assert_bindval_matches_bindtype(@bind);
2080 push @sqlq, "$label = $sql";
2082 } elsif ($r eq 'SCALAR') {
2083 # literal SQL without bind
2084 push @sqlq, "$label = $$v";
2086 push @sqlq, "$label = ?";
2087 push @sqlv, $self->_bindtype($k, $v);
2090 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
2091 } elsif ($ref eq 'ARRAY') {
2092 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
2095 if ($r eq 'ARRAY') { # literal SQL with bind
2096 my ($sql, @bind) = @$v;
2097 $self->_assert_bindval_matches_bindtype(@bind);
2100 } elsif ($r eq 'SCALAR') { # literal SQL without bind
2101 # embedded literal SQL
2108 push @sql, '(' . join(', ', @sqlq) . ')';
2109 } elsif ($ref eq 'SCALAR') {
2113 # strings get case twiddled
2114 push @sql, $self->_sqlcase($_);
2118 my $sql = join ' ', @sql;
2120 # this is pretty tricky
2121 # if ask for an array, return ($stmt, @bind)
2122 # otherwise, s/?/shift @sqlv/ to put it inline
2124 return ($sql, @sqlv);
2126 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2127 ref $d ? $d->[1] : $d/e;
2136 # This allows us to check for a local, then _form, attr
2138 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2139 return $self->generate($name, @_);
2150 SQL::Abstract - Generate SQL from Perl data structures
2156 my $sql = SQL::Abstract->new;
2158 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2160 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2162 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2164 my($stmt, @bind) = $sql->delete($table, \%where);
2166 # Then, use these in your DBI statements
2167 my $sth = $dbh->prepare($stmt);
2168 $sth->execute(@bind);
2170 # Just generate the WHERE clause
2171 my($stmt, @bind) = $sql->where(\%where, $order);
2173 # Return values in the same order, for hashed queries
2174 # See PERFORMANCE section for more details
2175 my @bind = $sql->values(\%fieldvals);
2179 This module was inspired by the excellent L<DBIx::Abstract>.
2180 However, in using that module I found that what I really wanted
2181 to do was generate SQL, but still retain complete control over my
2182 statement handles and use the DBI interface. So, I set out to
2183 create an abstract SQL generation module.
2185 While based on the concepts used by L<DBIx::Abstract>, there are
2186 several important differences, especially when it comes to WHERE
2187 clauses. I have modified the concepts used to make the SQL easier
2188 to generate from Perl data structures and, IMO, more intuitive.
2189 The underlying idea is for this module to do what you mean, based
2190 on the data structures you provide it. The big advantage is that
2191 you don't have to modify your code every time your data changes,
2192 as this module figures it out.
2194 To begin with, an SQL INSERT is as easy as just specifying a hash
2195 of C<key=value> pairs:
2198 name => 'Jimbo Bobson',
2199 phone => '123-456-7890',
2200 address => '42 Sister Lane',
2201 city => 'St. Louis',
2202 state => 'Louisiana',
2205 The SQL can then be generated with this:
2207 my($stmt, @bind) = $sql->insert('people', \%data);
2209 Which would give you something like this:
2211 $stmt = "INSERT INTO people
2212 (address, city, name, phone, state)
2213 VALUES (?, ?, ?, ?, ?)";
2214 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2215 '123-456-7890', 'Louisiana');
2217 These are then used directly in your DBI code:
2219 my $sth = $dbh->prepare($stmt);
2220 $sth->execute(@bind);
2222 =head2 Inserting and Updating Arrays
2224 If your database has array types (like for example Postgres),
2225 activate the special option C<< array_datatypes => 1 >>
2226 when creating the C<SQL::Abstract> object.
2227 Then you may use an arrayref to insert and update database array types:
2229 my $sql = SQL::Abstract->new(array_datatypes => 1);
2231 planets => [qw/Mercury Venus Earth Mars/]
2234 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2238 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2240 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2243 =head2 Inserting and Updating SQL
2245 In order to apply SQL functions to elements of your C<%data> you may
2246 specify a reference to an arrayref for the given hash value. For example,
2247 if you need to execute the Oracle C<to_date> function on a value, you can
2248 say something like this:
2252 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2255 The first value in the array is the actual SQL. Any other values are
2256 optional and would be included in the bind values array. This gives
2259 my($stmt, @bind) = $sql->insert('people', \%data);
2261 $stmt = "INSERT INTO people (name, date_entered)
2262 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2263 @bind = ('Bill', '03/02/2003');
2265 An UPDATE is just as easy, all you change is the name of the function:
2267 my($stmt, @bind) = $sql->update('people', \%data);
2269 Notice that your C<%data> isn't touched; the module will generate
2270 the appropriately quirky SQL for you automatically. Usually you'll
2271 want to specify a WHERE clause for your UPDATE, though, which is
2272 where handling C<%where> hashes comes in handy...
2274 =head2 Complex where statements
2276 This module can generate pretty complicated WHERE statements
2277 easily. For example, simple C<key=value> pairs are taken to mean
2278 equality, and if you want to see if a field is within a set
2279 of values, you can use an arrayref. Let's say we wanted to
2280 SELECT some data based on this criteria:
2283 requestor => 'inna',
2284 worker => ['nwiger', 'rcwe', 'sfz'],
2285 status => { '!=', 'completed' }
2288 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2290 The above would give you something like this:
2292 $stmt = "SELECT * FROM tickets WHERE
2293 ( requestor = ? ) AND ( status != ? )
2294 AND ( worker = ? OR worker = ? OR worker = ? )";
2295 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2297 Which you could then use in DBI code like so:
2299 my $sth = $dbh->prepare($stmt);
2300 $sth->execute(@bind);
2306 The methods are simple. There's one for every major SQL operation,
2307 and a constructor you use first. The arguments are specified in a
2308 similar order for each method (table, then fields, then a where
2309 clause) to try and simplify things.
2311 =head2 new(option => 'value')
2313 The C<new()> function takes a list of options and values, and returns
2314 a new B<SQL::Abstract> object which can then be used to generate SQL
2315 through the methods below. The options accepted are:
2321 If set to 'lower', then SQL will be generated in all lowercase. By
2322 default SQL is generated in "textbook" case meaning something like:
2324 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2326 Any setting other than 'lower' is ignored.
2330 This determines what the default comparison operator is. By default
2331 it is C<=>, meaning that a hash like this:
2333 %where = (name => 'nwiger', email => 'nate@wiger.org');
2335 Will generate SQL like this:
2337 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2339 However, you may want loose comparisons by default, so if you set
2340 C<cmp> to C<like> you would get SQL such as:
2342 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2344 You can also override the comparison on an individual basis - see
2345 the huge section on L</"WHERE CLAUSES"> at the bottom.
2347 =item sqltrue, sqlfalse
2349 Expressions for inserting boolean values within SQL statements.
2350 By default these are C<1=1> and C<1=0>. They are used
2351 by the special operators C<-in> and C<-not_in> for generating
2352 correct SQL even when the argument is an empty array (see below).
2356 This determines the default logical operator for multiple WHERE
2357 statements in arrays or hashes. If absent, the default logic is "or"
2358 for arrays, and "and" for hashes. This means that a WHERE
2362 event_date => {'>=', '2/13/99'},
2363 event_date => {'<=', '4/24/03'},
2366 will generate SQL like this:
2368 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2370 This is probably not what you want given this query, though (look
2371 at the dates). To change the "OR" to an "AND", simply specify:
2373 my $sql = SQL::Abstract->new(logic => 'and');
2375 Which will change the above C<WHERE> to:
2377 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2379 The logic can also be changed locally by inserting
2380 a modifier in front of an arrayref:
2382 @where = (-and => [event_date => {'>=', '2/13/99'},
2383 event_date => {'<=', '4/24/03'} ]);
2385 See the L</"WHERE CLAUSES"> section for explanations.
2389 This will automatically convert comparisons using the specified SQL
2390 function for both column and value. This is mostly used with an argument
2391 of C<upper> or C<lower>, so that the SQL will have the effect of
2392 case-insensitive "searches". For example, this:
2394 $sql = SQL::Abstract->new(convert => 'upper');
2395 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2397 Will turn out the following SQL:
2399 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2401 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2402 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2403 not validate this option; it will just pass through what you specify verbatim).
2407 This is a kludge because many databases suck. For example, you can't
2408 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2409 Instead, you have to use C<bind_param()>:
2411 $sth->bind_param(1, 'reg data');
2412 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2414 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2415 which loses track of which field each slot refers to. Fear not.
2417 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2418 Currently, you can specify either C<normal> (default) or C<columns>. If you
2419 specify C<columns>, you will get an array that looks like this:
2421 my $sql = SQL::Abstract->new(bindtype => 'columns');
2422 my($stmt, @bind) = $sql->insert(...);
2425 [ 'column1', 'value1' ],
2426 [ 'column2', 'value2' ],
2427 [ 'column3', 'value3' ],
2430 You can then iterate through this manually, using DBI's C<bind_param()>.
2432 $sth->prepare($stmt);
2435 my($col, $data) = @$_;
2436 if ($col eq 'details' || $col eq 'comments') {
2437 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2438 } elsif ($col eq 'image') {
2439 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2441 $sth->bind_param($i, $data);
2445 $sth->execute; # execute without @bind now
2447 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2448 Basically, the advantage is still that you don't have to care which fields
2449 are or are not included. You could wrap that above C<for> loop in a simple
2450 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2451 get a layer of abstraction over manual SQL specification.
2453 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2454 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2455 will expect the bind values in this format.
2459 This is the character that a table or column name will be quoted
2460 with. By default this is an empty string, but you could set it to
2461 the character C<`>, to generate SQL like this:
2463 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2465 Alternatively, you can supply an array ref of two items, the first being the left
2466 hand quote character, and the second the right hand quote character. For
2467 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2468 that generates SQL like this:
2470 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2472 Quoting is useful if you have tables or columns names that are reserved
2473 words in your database's SQL dialect.
2477 This is the character that will be used to escape L</quote_char>s appearing
2478 in an identifier before it has been quoted.
2480 The parameter default in case of a single L</quote_char> character is the quote
2483 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2484 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2485 of the B<opening (left)> L</quote_char> within the identifier are currently left
2486 untouched. The default for opening-closing-style quotes may change in future
2487 versions, thus you are B<strongly encouraged> to specify the escape character
2492 This is the character that separates a table and column name. It is
2493 necessary to specify this when the C<quote_char> option is selected,
2494 so that tables and column names can be individually quoted like this:
2496 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2498 =item injection_guard
2500 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2501 column name specified in a query structure. This is a safety mechanism to avoid
2502 injection attacks when mishandling user input e.g.:
2504 my %condition_as_column_value_pairs = get_values_from_user();
2505 $sqla->select( ... , \%condition_as_column_value_pairs );
2507 If the expression matches an exception is thrown. Note that literal SQL
2508 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2510 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2512 =item array_datatypes
2514 When this option is true, arrayrefs in INSERT or UPDATE are
2515 interpreted as array datatypes and are passed directly
2517 When this option is false, arrayrefs are interpreted
2518 as literal SQL, just like refs to arrayrefs
2519 (but this behavior is for backwards compatibility; when writing
2520 new queries, use the "reference to arrayref" syntax
2526 Takes a reference to a list of "special operators"
2527 to extend the syntax understood by L<SQL::Abstract>.
2528 See section L</"SPECIAL OPERATORS"> for details.
2532 Takes a reference to a list of "unary operators"
2533 to extend the syntax understood by L<SQL::Abstract>.
2534 See section L</"UNARY OPERATORS"> for details.
2540 =head2 insert($table, \@values || \%fieldvals, \%options)
2542 This is the simplest function. You simply give it a table name
2543 and either an arrayref of values or hashref of field/value pairs.
2544 It returns an SQL INSERT statement and a list of bind values.
2545 See the sections on L</"Inserting and Updating Arrays"> and
2546 L</"Inserting and Updating SQL"> for information on how to insert
2547 with those data types.
2549 The optional C<\%options> hash reference may contain additional
2550 options to generate the insert SQL. Currently supported options
2557 Takes either a scalar of raw SQL fields, or an array reference of
2558 field names, and adds on an SQL C<RETURNING> statement at the end.
2559 This allows you to return data generated by the insert statement
2560 (such as row IDs) without performing another C<SELECT> statement.
2561 Note, however, this is not part of the SQL standard and may not
2562 be supported by all database engines.
2566 =head2 update($table, \%fieldvals, \%where, \%options)
2568 This takes a table, hashref of field/value pairs, and an optional
2569 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2571 See the sections on L</"Inserting and Updating Arrays"> and
2572 L</"Inserting and Updating SQL"> for information on how to insert
2573 with those data types.
2575 The optional C<\%options> hash reference may contain additional
2576 options to generate the update SQL. Currently supported options
2583 See the C<returning> option to
2584 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2588 =head2 select($source, $fields, $where, $order)
2590 This returns a SQL SELECT statement and associated list of bind values, as
2591 specified by the arguments:
2597 Specification of the 'FROM' part of the statement.
2598 The argument can be either a plain scalar (interpreted as a table
2599 name, will be quoted), or an arrayref (interpreted as a list
2600 of table names, joined by commas, quoted), or a scalarref
2601 (literal SQL, not quoted).
2605 Specification of the list of fields to retrieve from
2607 The argument can be either an arrayref (interpreted as a list
2608 of field names, will be joined by commas and quoted), or a
2609 plain scalar (literal SQL, not quoted).
2610 Please observe that this API is not as flexible as that of
2611 the first argument C<$source>, for backwards compatibility reasons.
2615 Optional argument to specify the WHERE part of the query.
2616 The argument is most often a hashref, but can also be
2617 an arrayref or plain scalar --
2618 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2622 Optional argument to specify the ORDER BY part of the query.
2623 The argument can be a scalar, a hashref or an arrayref
2624 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2630 =head2 delete($table, \%where, \%options)
2632 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2633 It returns an SQL DELETE statement and list of bind values.
2635 The optional C<\%options> hash reference may contain additional
2636 options to generate the delete SQL. Currently supported options
2643 See the C<returning> option to
2644 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2648 =head2 where(\%where, $order)
2650 This is used to generate just the WHERE clause. For example,
2651 if you have an arbitrary data structure and know what the
2652 rest of your SQL is going to look like, but want an easy way
2653 to produce a WHERE clause, use this. It returns an SQL WHERE
2654 clause and list of bind values.
2657 =head2 values(\%data)
2659 This just returns the values from the hash C<%data>, in the same
2660 order that would be returned from any of the other above queries.
2661 Using this allows you to markedly speed up your queries if you
2662 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2664 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2666 Warning: This is an experimental method and subject to change.
2668 This returns arbitrarily generated SQL. It's a really basic shortcut.
2669 It will return two different things, depending on return context:
2671 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2672 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2674 These would return the following:
2676 # First calling form
2677 $stmt = "CREATE TABLE test (?, ?)";
2678 @bind = (field1, field2);
2680 # Second calling form
2681 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2683 Depending on what you're trying to do, it's up to you to choose the correct
2684 format. In this example, the second form is what you would want.
2688 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2692 ALTER SESSION SET nls_date_format = 'MM/YY'
2694 You get the idea. Strings get their case twiddled, but everything
2695 else remains verbatim.
2697 =head1 EXPORTABLE FUNCTIONS
2699 =head2 is_plain_value
2701 Determines if the supplied argument is a plain value as understood by this
2706 =item * The value is C<undef>
2708 =item * The value is a non-reference
2710 =item * The value is an object with stringification overloading
2712 =item * The value is of the form C<< { -value => $anything } >>
2716 On failure returns C<undef>, on success returns a B<scalar> reference
2717 to the original supplied argument.
2723 The stringification overloading detection is rather advanced: it takes
2724 into consideration not only the presence of a C<""> overload, but if that
2725 fails also checks for enabled
2726 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2727 on either C<0+> or C<bool>.
2729 Unfortunately testing in the field indicates that this
2730 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2731 but only when very large numbers of stringifying objects are involved.
2732 At the time of writing ( Sep 2014 ) there is no clear explanation of
2733 the direct cause, nor is there a manageably small test case that reliably
2734 reproduces the problem.
2736 If you encounter any of the following exceptions in B<random places within
2737 your application stack> - this module may be to blame:
2739 Operation "ne": no method found,
2740 left argument in overloaded package <something>,
2741 right argument in overloaded package <something>
2745 Stub found while resolving method "???" overloading """" in package <something>
2747 If you fall victim to the above - please attempt to reduce the problem
2748 to something that could be sent to the L<SQL::Abstract developers
2749 |DBIx::Class/GETTING HELP/SUPPORT>
2750 (either publicly or privately). As a workaround in the meantime you can
2751 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2752 value, which will most likely eliminate your problem (at the expense of
2753 not being able to properly detect exotic forms of stringification).
2755 This notice and environment variable will be removed in a future version,
2756 as soon as the underlying problem is found and a reliable workaround is
2761 =head2 is_literal_value
2763 Determines if the supplied argument is a literal value as understood by this
2768 =item * C<\$sql_string>
2770 =item * C<\[ $sql_string, @bind_values ]>
2774 On failure returns C<undef>, on success returns an B<array> reference
2775 containing the unpacked version of the supplied literal SQL and bind values.
2777 =head1 WHERE CLAUSES
2781 This module uses a variation on the idea from L<DBIx::Abstract>. It
2782 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2783 module is that things in arrays are OR'ed, and things in hashes
2786 The easiest way to explain is to show lots of examples. After
2787 each C<%where> hash shown, it is assumed you used:
2789 my($stmt, @bind) = $sql->where(\%where);
2791 However, note that the C<%where> hash can be used directly in any
2792 of the other functions as well, as described above.
2794 =head2 Key-value pairs
2796 So, let's get started. To begin, a simple hash:
2800 status => 'completed'
2803 Is converted to SQL C<key = val> statements:
2805 $stmt = "WHERE user = ? AND status = ?";
2806 @bind = ('nwiger', 'completed');
2808 One common thing I end up doing is having a list of values that
2809 a field can be in. To do this, simply specify a list inside of
2814 status => ['assigned', 'in-progress', 'pending'];
2817 This simple code will create the following:
2819 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2820 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2822 A field associated to an empty arrayref will be considered a
2823 logical false and will generate 0=1.
2825 =head2 Tests for NULL values
2827 If the value part is C<undef> then this is converted to SQL <IS NULL>
2836 $stmt = "WHERE user = ? AND status IS NULL";
2839 To test if a column IS NOT NULL:
2843 status => { '!=', undef },
2846 =head2 Specific comparison operators
2848 If you want to specify a different type of operator for your comparison,
2849 you can use a hashref for a given column:
2853 status => { '!=', 'completed' }
2856 Which would generate:
2858 $stmt = "WHERE user = ? AND status != ?";
2859 @bind = ('nwiger', 'completed');
2861 To test against multiple values, just enclose the values in an arrayref:
2863 status => { '=', ['assigned', 'in-progress', 'pending'] };
2865 Which would give you:
2867 "WHERE status = ? OR status = ? OR status = ?"
2870 The hashref can also contain multiple pairs, in which case it is expanded
2871 into an C<AND> of its elements:
2875 status => { '!=', 'completed', -not_like => 'pending%' }
2878 # Or more dynamically, like from a form
2879 $where{user} = 'nwiger';
2880 $where{status}{'!='} = 'completed';
2881 $where{status}{'-not_like'} = 'pending%';
2883 # Both generate this
2884 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2885 @bind = ('nwiger', 'completed', 'pending%');
2888 To get an OR instead, you can combine it with the arrayref idea:
2892 priority => [ { '=', 2 }, { '>', 5 } ]
2895 Which would generate:
2897 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2898 @bind = ('2', '5', 'nwiger');
2900 If you want to include literal SQL (with or without bind values), just use a
2901 scalar reference or reference to an arrayref as the value:
2904 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2905 date_expires => { '<' => \"now()" }
2908 Which would generate:
2910 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2911 @bind = ('11/26/2008');
2914 =head2 Logic and nesting operators
2916 In the example above,
2917 there is a subtle trap if you want to say something like
2918 this (notice the C<AND>):
2920 WHERE priority != ? AND priority != ?
2922 Because, in Perl you I<can't> do this:
2924 priority => { '!=' => 2, '!=' => 1 }
2926 As the second C<!=> key will obliterate the first. The solution
2927 is to use the special C<-modifier> form inside an arrayref:
2929 priority => [ -and => {'!=', 2},
2933 Normally, these would be joined by C<OR>, but the modifier tells it
2934 to use C<AND> instead. (Hint: You can use this in conjunction with the
2935 C<logic> option to C<new()> in order to change the way your queries
2936 work by default.) B<Important:> Note that the C<-modifier> goes
2937 B<INSIDE> the arrayref, as an extra first element. This will
2938 B<NOT> do what you think it might:
2940 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2942 Here is a quick list of equivalencies, since there is some overlap:
2945 status => {'!=', 'completed', 'not like', 'pending%' }
2946 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2949 status => {'=', ['assigned', 'in-progress']}
2950 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2951 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2955 =head2 Special operators: IN, BETWEEN, etc.
2957 You can also use the hashref format to compare a list of fields using the
2958 C<IN> comparison operator, by specifying the list as an arrayref:
2961 status => 'completed',
2962 reportid => { -in => [567, 2335, 2] }
2965 Which would generate:
2967 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2968 @bind = ('completed', '567', '2335', '2');
2970 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2973 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2974 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2975 'sqltrue' (by default: C<1=1>).
2977 In addition to the array you can supply a chunk of literal sql or
2978 literal sql with bind:
2981 customer => { -in => \[
2982 'SELECT cust_id FROM cust WHERE balance > ?',
2985 status => { -in => \'SELECT status_codes FROM states' },
2991 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2992 AND status IN ( SELECT status_codes FROM states )
2996 Finally, if the argument to C<-in> is not a reference, it will be
2997 treated as a single-element array.
2999 Another pair of operators is C<-between> and C<-not_between>,
3000 used with an arrayref of two values:
3004 completion_date => {
3005 -not_between => ['2002-10-01', '2003-02-06']
3011 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
3013 Just like with C<-in> all plausible combinations of literal SQL
3017 start0 => { -between => [ 1, 2 ] },
3018 start1 => { -between => \["? AND ?", 1, 2] },
3019 start2 => { -between => \"lower(x) AND upper(y)" },
3020 start3 => { -between => [
3022 \["upper(?)", 'stuff' ],
3029 ( start0 BETWEEN ? AND ? )
3030 AND ( start1 BETWEEN ? AND ? )
3031 AND ( start2 BETWEEN lower(x) AND upper(y) )
3032 AND ( start3 BETWEEN lower(x) AND upper(?) )
3034 @bind = (1, 2, 1, 2, 'stuff');
3037 These are the two builtin "special operators"; but the
3038 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
3040 =head2 Unary operators: bool
3042 If you wish to test against boolean columns or functions within your
3043 database you can use the C<-bool> and C<-not_bool> operators. For
3044 example to test the column C<is_user> being true and the column
3045 C<is_enabled> being false you would use:-
3049 -not_bool => 'is_enabled',
3054 WHERE is_user AND NOT is_enabled
3056 If a more complex combination is required, testing more conditions,
3057 then you should use the and/or operators:-
3062 -not_bool => { two=> { -rlike => 'bar' } },
3063 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
3074 (NOT ( three = ? OR three > ? ))
3077 =head2 Nested conditions, -and/-or prefixes
3079 So far, we've seen how multiple conditions are joined with a top-level
3080 C<AND>. We can change this by putting the different conditions we want in
3081 hashes and then putting those hashes in an array. For example:
3086 status => { -like => ['pending%', 'dispatched'] },
3090 status => 'unassigned',
3094 This data structure would create the following:
3096 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
3097 OR ( user = ? AND status = ? ) )";
3098 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
3101 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
3102 to change the logic inside:
3108 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
3109 -or => { workhrs => {'<', 50}, geo => 'EURO' },
3116 $stmt = "WHERE ( user = ?
3117 AND ( ( workhrs > ? AND geo = ? )
3118 OR ( workhrs < ? OR geo = ? ) ) )";
3119 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
3121 =head3 Algebraic inconsistency, for historical reasons
3123 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
3124 operator goes C<outside> of the nested structure; whereas when connecting
3125 several constraints on one column, the C<-and> operator goes
3126 C<inside> the arrayref. Here is an example combining both features:
3129 -and => [a => 1, b => 2],
3130 -or => [c => 3, d => 4],
3131 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3136 WHERE ( ( ( a = ? AND b = ? )
3137 OR ( c = ? OR d = ? )
3138 OR ( e LIKE ? AND e LIKE ? ) ) )
3140 This difference in syntax is unfortunate but must be preserved for
3141 historical reasons. So be careful: the two examples below would
3142 seem algebraically equivalent, but they are not
3145 { -like => 'foo%' },
3146 { -like => '%bar' },
3148 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3151 { col => { -like => 'foo%' } },
3152 { col => { -like => '%bar' } },
3154 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3157 =head2 Literal SQL and value type operators
3159 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3160 side" is a column name and the "right side" is a value (normally rendered as
3161 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3162 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3163 alter this behavior. There are several ways of doing so.
3167 This is a virtual operator that signals the string to its right side is an
3168 identifier (a column name) and not a value. For example to compare two
3169 columns you would write:
3172 priority => { '<', 2 },
3173 requestor => { -ident => 'submitter' },
3178 $stmt = "WHERE priority < ? AND requestor = submitter";
3181 If you are maintaining legacy code you may see a different construct as
3182 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3187 This is a virtual operator that signals that the construct to its right side
3188 is a value to be passed to DBI. This is for example necessary when you want
3189 to write a where clause against an array (for RDBMS that support such
3190 datatypes). For example:
3193 array => { -value => [1, 2, 3] }
3198 $stmt = 'WHERE array = ?';
3199 @bind = ([1, 2, 3]);
3201 Note that if you were to simply say:
3207 the result would probably not be what you wanted:
3209 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3214 Finally, sometimes only literal SQL will do. To include a random snippet
3215 of SQL verbatim, you specify it as a scalar reference. Consider this only
3216 as a last resort. Usually there is a better way. For example:
3219 priority => { '<', 2 },
3220 requestor => { -in => \'(SELECT name FROM hitmen)' },
3225 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3228 Note that in this example, you only get one bind parameter back, since
3229 the verbatim SQL is passed as part of the statement.
3233 Never use untrusted input as a literal SQL argument - this is a massive
3234 security risk (there is no way to check literal snippets for SQL
3235 injections and other nastyness). If you need to deal with untrusted input
3236 use literal SQL with placeholders as described next.
3238 =head3 Literal SQL with placeholders and bind values (subqueries)
3240 If the literal SQL to be inserted has placeholders and bind values,
3241 use a reference to an arrayref (yes this is a double reference --
3242 not so common, but perfectly legal Perl). For example, to find a date
3243 in Postgres you can use something like this:
3246 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3251 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3254 Note that you must pass the bind values in the same format as they are returned
3255 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3256 to C<columns>, you must provide the bind values in the
3257 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3258 scalar value; most commonly the column name, but you can use any scalar value
3259 (including references and blessed references), L<SQL::Abstract> will simply
3260 pass it through intact. So if C<bindtype> is set to C<columns> the above
3261 example will look like:
3264 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3267 Literal SQL is especially useful for nesting parenthesized clauses in the
3268 main SQL query. Here is a first example:
3270 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3274 bar => \["IN ($sub_stmt)" => @sub_bind],
3279 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3280 WHERE c2 < ? AND c3 LIKE ?))";
3281 @bind = (1234, 100, "foo%");
3283 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3284 are expressed in the same way. Of course the C<$sub_stmt> and
3285 its associated bind values can be generated through a former call
3288 my ($sub_stmt, @sub_bind)
3289 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3290 c3 => {-like => "foo%"}});
3293 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3296 In the examples above, the subquery was used as an operator on a column;
3297 but the same principle also applies for a clause within the main C<%where>
3298 hash, like an EXISTS subquery:
3300 my ($sub_stmt, @sub_bind)
3301 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3302 my %where = ( -and => [
3304 \["EXISTS ($sub_stmt)" => @sub_bind],
3309 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3310 WHERE c1 = ? AND c2 > t0.c0))";
3314 Observe that the condition on C<c2> in the subquery refers to
3315 column C<t0.c0> of the main query: this is I<not> a bind
3316 value, so we have to express it through a scalar ref.
3317 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3318 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3319 what we wanted here.
3321 Finally, here is an example where a subquery is used
3322 for expressing unary negation:
3324 my ($sub_stmt, @sub_bind)
3325 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3326 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3328 lname => {like => '%son%'},
3329 \["NOT ($sub_stmt)" => @sub_bind],
3334 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3335 @bind = ('%son%', 10, 20)
3337 =head3 Deprecated usage of Literal SQL
3339 Below are some examples of archaic use of literal SQL. It is shown only as
3340 reference for those who deal with legacy code. Each example has a much
3341 better, cleaner and safer alternative that users should opt for in new code.
3347 my %where = ( requestor => \'IS NOT NULL' )
3349 $stmt = "WHERE requestor IS NOT NULL"
3351 This used to be the way of generating NULL comparisons, before the handling
3352 of C<undef> got formalized. For new code please use the superior syntax as
3353 described in L</Tests for NULL values>.
3357 my %where = ( requestor => \'= submitter' )
3359 $stmt = "WHERE requestor = submitter"
3361 This used to be the only way to compare columns. Use the superior L</-ident>
3362 method for all new code. For example an identifier declared in such a way
3363 will be properly quoted if L</quote_char> is properly set, while the legacy
3364 form will remain as supplied.
3368 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3370 $stmt = "WHERE completed > ? AND is_ready"
3371 @bind = ('2012-12-21')
3373 Using an empty string literal used to be the only way to express a boolean.
3374 For all new code please use the much more readable
3375 L<-bool|/Unary operators: bool> operator.
3381 These pages could go on for a while, since the nesting of the data
3382 structures this module can handle are pretty much unlimited (the
3383 module implements the C<WHERE> expansion as a recursive function
3384 internally). Your best bet is to "play around" with the module a
3385 little to see how the data structures behave, and choose the best
3386 format for your data based on that.
3388 And of course, all the values above will probably be replaced with
3389 variables gotten from forms or the command line. After all, if you
3390 knew everything ahead of time, you wouldn't have to worry about
3391 dynamically-generating SQL and could just hardwire it into your
3394 =head1 ORDER BY CLAUSES
3396 Some functions take an order by clause. This can either be a scalar (just a
3397 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3398 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3401 Given | Will Generate
3402 ---------------------------------------------------------------
3404 'colA' | ORDER BY colA
3406 [qw/colA colB/] | ORDER BY colA, colB
3408 {-asc => 'colA'} | ORDER BY colA ASC
3410 {-desc => 'colB'} | ORDER BY colB DESC
3412 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3414 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3416 \'colA DESC' | ORDER BY colA DESC
3418 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3419 | /* ...with $x bound to ? */
3422 { -asc => 'colA' }, | colA ASC,
3423 { -desc => [qw/colB/] }, | colB DESC,
3424 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3425 \'colE DESC', | colE DESC,
3426 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3427 ] | /* ...with $x bound to ? */
3428 ===============================================================
3432 =head1 SPECIAL OPERATORS
3434 my $sqlmaker = SQL::Abstract->new(special_ops => [
3438 my ($self, $field, $op, $arg) = @_;
3444 handler => 'method_name',
3448 A "special operator" is a SQL syntactic clause that can be
3449 applied to a field, instead of a usual binary operator.
3452 WHERE field IN (?, ?, ?)
3453 WHERE field BETWEEN ? AND ?
3454 WHERE MATCH(field) AGAINST (?, ?)
3456 Special operators IN and BETWEEN are fairly standard and therefore
3457 are builtin within C<SQL::Abstract> (as the overridable methods
3458 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3459 like the MATCH .. AGAINST example above which is specific to MySQL,
3460 you can write your own operator handlers - supply a C<special_ops>
3461 argument to the C<new> method. That argument takes an arrayref of
3462 operator definitions; each operator definition is a hashref with two
3469 the regular expression to match the operator
3473 Either a coderef or a plain scalar method name. In both cases
3474 the expected return is C<< ($sql, @bind) >>.
3476 When supplied with a method name, it is simply called on the
3477 L<SQL::Abstract> object as:
3479 $self->$method_name($field, $op, $arg)
3483 $field is the LHS of the operator
3484 $op is the part that matched the handler regex
3487 When supplied with a coderef, it is called as:
3489 $coderef->($self, $field, $op, $arg)
3494 For example, here is an implementation
3495 of the MATCH .. AGAINST syntax for MySQL
3497 my $sqlmaker = SQL::Abstract->new(special_ops => [
3499 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3500 {regex => qr/^match$/i,
3502 my ($self, $field, $op, $arg) = @_;
3503 $arg = [$arg] if not ref $arg;
3504 my $label = $self->_quote($field);
3505 my ($placeholder) = $self->_convert('?');
3506 my $placeholders = join ", ", (($placeholder) x @$arg);
3507 my $sql = $self->_sqlcase('match') . " ($label) "
3508 . $self->_sqlcase('against') . " ($placeholders) ";
3509 my @bind = $self->_bindtype($field, @$arg);
3510 return ($sql, @bind);
3517 =head1 UNARY OPERATORS
3519 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3523 my ($self, $op, $arg) = @_;
3529 handler => 'method_name',
3533 A "unary operator" is a SQL syntactic clause that can be
3534 applied to a field - the operator goes before the field
3536 You can write your own operator handlers - supply a C<unary_ops>
3537 argument to the C<new> method. That argument takes an arrayref of
3538 operator definitions; each operator definition is a hashref with two
3545 the regular expression to match the operator
3549 Either a coderef or a plain scalar method name. In both cases
3550 the expected return is C<< $sql >>.
3552 When supplied with a method name, it is simply called on the
3553 L<SQL::Abstract> object as:
3555 $self->$method_name($op, $arg)
3559 $op is the part that matched the handler regex
3560 $arg is the RHS or argument of the operator
3562 When supplied with a coderef, it is called as:
3564 $coderef->($self, $op, $arg)
3572 Thanks to some benchmarking by Mark Stosberg, it turns out that
3573 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3574 I must admit this wasn't an intentional design issue, but it's a
3575 byproduct of the fact that you get to control your C<DBI> handles
3578 To maximize performance, use a code snippet like the following:
3580 # prepare a statement handle using the first row
3581 # and then reuse it for the rest of the rows
3583 for my $href (@array_of_hashrefs) {
3584 $stmt ||= $sql->insert('table', $href);
3585 $sth ||= $dbh->prepare($stmt);
3586 $sth->execute($sql->values($href));
3589 The reason this works is because the keys in your C<$href> are sorted
3590 internally by B<SQL::Abstract>. Thus, as long as your data retains
3591 the same structure, you only have to generate the SQL the first time
3592 around. On subsequent queries, simply use the C<values> function provided
3593 by this module to return your values in the correct order.
3595 However this depends on the values having the same type - if, for
3596 example, the values of a where clause may either have values
3597 (resulting in sql of the form C<column = ?> with a single bind
3598 value), or alternatively the values might be C<undef> (resulting in
3599 sql of the form C<column IS NULL> with no bind value) then the
3600 caching technique suggested will not work.
3604 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3605 really like this part (I do, at least). Building up a complex query
3606 can be as simple as the following:
3613 use CGI::FormBuilder;
3616 my $form = CGI::FormBuilder->new(...);
3617 my $sql = SQL::Abstract->new;
3619 if ($form->submitted) {
3620 my $field = $form->field;
3621 my $id = delete $field->{id};
3622 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3625 Of course, you would still have to connect using C<DBI> to run the
3626 query, but the point is that if you make your form look like your
3627 table, the actual query script can be extremely simplistic.
3629 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3630 a fast interface to returning and formatting data. I frequently
3631 use these three modules together to write complex database query
3632 apps in under 50 lines.
3634 =head1 HOW TO CONTRIBUTE
3636 Contributions are always welcome, in all usable forms (we especially
3637 welcome documentation improvements). The delivery methods include git-
3638 or unified-diff formatted patches, GitHub pull requests, or plain bug
3639 reports either via RT or the Mailing list. Contributors are generally
3640 granted full access to the official repository after their first several
3641 patches pass successful review.
3643 This project is maintained in a git repository. The code and related tools are
3644 accessible at the following locations:
3648 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3650 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3652 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3654 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3660 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3661 Great care has been taken to preserve the I<published> behavior
3662 documented in previous versions in the 1.* family; however,
3663 some features that were previously undocumented, or behaved
3664 differently from the documentation, had to be changed in order
3665 to clarify the semantics. Hence, client code that was relying
3666 on some dark areas of C<SQL::Abstract> v1.*
3667 B<might behave differently> in v1.50.
3669 The main changes are:
3675 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3679 support for the { operator => \"..." } construct (to embed literal SQL)
3683 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3687 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3691 defensive programming: check arguments
3695 fixed bug with global logic, which was previously implemented
3696 through global variables yielding side-effects. Prior versions would
3697 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3698 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3699 Now this is interpreted
3700 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3705 fixed semantics of _bindtype on array args
3709 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3710 we just avoid shifting arrays within that tree.
3714 dropped the C<_modlogic> function
3718 =head1 ACKNOWLEDGEMENTS
3720 There are a number of individuals that have really helped out with
3721 this module. Unfortunately, most of them submitted bugs via CPAN
3722 so I have no idea who they are! But the people I do know are:
3724 Ash Berlin (order_by hash term support)
3725 Matt Trout (DBIx::Class support)
3726 Mark Stosberg (benchmarking)
3727 Chas Owens (initial "IN" operator support)
3728 Philip Collins (per-field SQL functions)
3729 Eric Kolve (hashref "AND" support)
3730 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3731 Dan Kubb (support for "quote_char" and "name_sep")
3732 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3733 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3734 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3735 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3736 Oliver Charles (support for "RETURNING" after "INSERT")
3742 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3746 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3748 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3750 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3751 While not an official support venue, C<DBIx::Class> makes heavy use of
3752 C<SQL::Abstract>, and as such list members there are very familiar with
3753 how to create queries.
3757 This module is free software; you may copy this under the same
3758 terms as perl itself (either the GNU General Public License or
3759 the Artistic License)