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) {
550 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
554 return unless %$expr;
555 return $self->_expand_expr_hashpair(%$expr, $logic);
557 if (ref($expr) eq 'ARRAY') {
558 my $logic = lc($logic || $self->{logic});
559 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
565 while (my ($el) = splice @expr, 0, 1) {
566 puke "Supplying an empty left hand side argument is not supported in array-pairs"
567 unless defined($el) and length($el);
568 my $elref = ref($el);
570 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
571 } elsif ($elref eq 'ARRAY') {
572 push(@res, $self->_expand_expr($el)) if @$el;
573 } elsif (is_literal_value($el)) {
575 } elsif ($elref eq 'HASH') {
576 push @res, $self->_expand_expr($el);
581 return { -op => [ $logic, @res ] };
583 if (my $literal = is_literal_value($expr)) {
584 return +{ -literal => $literal };
586 if (!ref($expr) or Scalar::Util::blessed($expr)) {
587 if (my $m = our $Cur_Col_Meta) {
588 return +{ -bind => [ $m, $expr ] };
590 return +{ -value => $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 { -op => [ 'not', $self->_expand_expr($v) ] };
623 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
626 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
629 if (my ($logic) = $k =~ /^-(and|or)$/i) {
630 if (ref($v) eq 'HASH') {
631 return $self->_expand_expr($v, $logic);
633 if (ref($v) eq 'ARRAY') {
634 return $self->_expand_expr($v, $logic);
639 $op =~ s/^-// if length($op) > 1;
641 # top level special ops are illegal in general
642 puke "Illegal use of top-level '-$op'"
643 if !(defined $self->{_nested_func_lhs})
644 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
645 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
647 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
648 return +{ -bind => [ $m, $v ] };
650 if ($k eq '-op' or $k eq '-ident' or $k eq '-value' or $k eq '-bind' or $k eq '-literal' or $k eq '-func') {
656 and (keys %$v)[0] =~ /^-/
658 my ($func) = $k =~ /^-(.*)$/;
659 return +{ -func => [ $func, $self->_expand_expr($v) ] };
661 if (!ref($v) or is_literal_value($v)) {
662 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
669 and exists $v->{-value}
670 and not defined $v->{-value}
673 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
675 if (!ref($v) or Scalar::Util::blessed($v)) {
680 { -bind => [ $k, $v ] }
684 if (ref($v) eq 'HASH') {
687 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
694 $self->_assert_pass_injection_guard($vk);
695 if ($vk =~ s/ [_\s]? \d+ $//x ) {
696 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
697 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
699 if ($vk =~ /^(?:not[ _])?between$/) {
700 local our $Cur_Col_Meta = $k;
701 my @rhs = map $self->_expand_expr($_),
702 ref($vv) eq 'ARRAY' ? @$vv : $vv;
704 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
706 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
708 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
711 join(' ', split '_', $vk),
716 if ($vk =~ /^(?:not[ _])?in$/) {
717 if (my $literal = is_literal_value($vv)) {
718 my ($sql, @bind) = @$literal;
719 my $opened_sql = $self->_open_outer_paren($sql);
721 $vk, { -ident => $k },
722 [ { -literal => [ $opened_sql, @bind ] } ]
726 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
727 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
728 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
729 . 'will emit the logically correct SQL instead of raising this exception)'
731 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
733 my @rhs = map $self->_expand_expr($_),
734 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
735 map { defined($_) ? $_: puke($undef_err) }
736 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
738 -literal => [ $self->{$vk =~ /^not/ ? 'sqltrue' : 'sqlfalse'} ]
742 join(' ', split '_', $vk),
747 if ($vk eq 'ident') {
748 if (! defined $vv or ref $vv) {
749 puke "-$vk requires a single plain scalar argument (a quotable identifier)";
757 if ($vk eq 'value') {
758 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
762 { -bind => [ $k, $vv ] }
765 if ($vk =~ /^is(?:[ _]not)?$/) {
766 puke "$vk can only take undef as argument"
770 and exists($vv->{-value})
771 and !defined($vv->{-value})
774 return +{ -op => [ $vk.' null', { -ident => $k } ] };
776 if ($vk =~ /^(and|or)$/) {
777 if (ref($vv) eq 'HASH') {
780 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
785 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{user_special_ops}}) {
786 return { -op => [ $vk, { -ident => $k }, $vv ] };
788 if (ref($vv) eq 'ARRAY') {
789 my ($logic, @values) = (
790 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
795 $vk =~ $self->{inequality_op}
796 or join(' ', split '_', $vk) =~ $self->{not_like_op}
798 if (lc($logic) eq '-or' and @values > 1) {
799 my $op = uc join ' ', split '_', $vk;
800 belch "A multi-element arrayref as an argument to the inequality op '$op' "
801 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
802 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
807 # try to DWIM on equality operators
808 my $op = join ' ', split '_', $vk;
810 $op =~ $self->{equality_op} ? $self->{sqlfalse}
811 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
812 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
813 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
814 : puke "operator '$op' applied on an empty array (field '$k')";
818 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
826 and exists $vv->{-value}
827 and not defined $vv->{-value}
830 my $op = join ' ', split '_', $vk;
832 $op =~ /^not$/i ? 'is not' # legacy
833 : $op =~ $self->{equality_op} ? 'is'
834 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
835 : $op =~ $self->{inequality_op} ? 'is not'
836 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
837 : puke "unexpected operator '$op' with undef operand";
838 return +{ -op => [ $is.' null', { -ident => $k } ] };
840 local our $Cur_Col_Meta = $k;
844 $self->_expand_expr($vv)
847 if (ref($v) eq 'ARRAY') {
848 return $self->{sqlfalse} unless @$v;
849 $self->_debug("ARRAY($k) means distribute over elements");
851 $v->[0] =~ /^-((?:and|or))$/i
852 ? ($v = [ @{$v}[1..$#$v] ], $1)
853 : ($self->{logic} || 'or')
857 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
860 if (my $literal = is_literal_value($v)) {
862 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
865 my ($sql, @bind) = @$literal;
866 if ($self->{bindtype} eq 'columns') {
868 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
869 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
873 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
879 my ($self, $where, $logic) = @_;
881 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
883 my $where_exp = $self->_expand_expr($where, $logic);
885 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
887 # dispatch on appropriate method according to refkind of $where
888 my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
890 my ($sql, @bind) = $self->$method($where_exp, $logic);
892 # DBIx::Class used to call _recurse_where in scalar context
893 # something else might too...
895 return ($sql, @bind);
898 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
905 #======================================================================
906 # WHERE: top-level ARRAYREF
907 #======================================================================
910 sub _where_ARRAYREF {
911 my ($self, $where, $logic) = @_;
913 $logic = uc($logic || $self->{logic});
914 $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
916 my @clauses = @$where;
918 my (@sql_clauses, @all_bind);
919 # need to use while() so can shift() for pairs
921 my $el = shift @clauses;
923 $el = undef if (defined $el and ! length $el);
925 # switch according to kind of $el and get corresponding ($sql, @bind)
926 my ($sql, @bind) = $self->_SWITCH_refkind($el, {
928 # skip empty elements, otherwise get invalid trailing AND stuff
929 ARRAYREF => sub {$self->_recurse_where($el) if @$el},
933 $self->_assert_bindval_matches_bindtype(@b);
937 HASHREF => sub {$self->_recurse_where($el, 'and') if %$el},
939 SCALARREF => sub { ($$el); },
942 # top-level arrayref with scalars, recurse in pairs
943 $self->_recurse_where({$el => shift(@clauses)})
946 UNDEF => sub {puke "Supplying an empty left hand side argument is not supported in array-pairs" },
950 push @sql_clauses, $sql;
951 push @all_bind, @bind;
955 return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
958 #======================================================================
959 # WHERE: top-level ARRAYREFREF
960 #======================================================================
962 sub _where_ARRAYREFREF {
963 my ($self, $where) = @_;
964 my ($sql, @bind) = @$$where;
965 $self->_assert_bindval_matches_bindtype(@bind);
966 return ($sql, @bind);
969 #======================================================================
970 # WHERE: top-level HASHREF
971 #======================================================================
974 my ($self, $where) = @_;
975 my (@sql_clauses, @all_bind);
977 for my $k (sort keys %$where) {
978 my $v = $where->{$k};
980 # ($k => $v) is either a special unary op or a regular hashpair
981 my ($sql, @bind) = do {
983 # put the operator in canonical form
985 $op = substr $op, 1; # remove initial dash
986 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
987 $op =~ s/\s+/ /g; # compress whitespace
989 # so that -not_foo works correctly
990 $op =~ s/^not_/NOT /i;
992 $self->_debug("Unary OP(-$op) within hashref, recursing...");
993 my ($s, @b) = $self->_where_unary_op($op, $v);
995 # top level vs nested
996 # we assume that handled unary ops will take care of their ()s
998 List::Util::first {$op =~ $_->{regex}} @{$self->{unary_ops}}
1000 ( defined $self->{_nested_func_lhs} and $self->{_nested_func_lhs} eq $k )
1006 if (is_literal_value ($v) ) {
1007 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
1010 puke "Supplying an empty left hand side argument is not supported in hash-pairs";
1014 my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
1015 $self->$method($k, $v);
1019 push @sql_clauses, $sql;
1020 push @all_bind, @bind;
1023 return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
1026 sub _where_unary_op {
1027 my ($self, $op, $rhs) = @_;
1029 $op =~ s/^-// if length($op) > 1;
1031 # top level special ops are illegal in general
1032 puke "Illegal use of top-level '-$op'"
1033 if !(defined $self->{_nested_func_lhs})
1034 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
1035 and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
1037 if (my $op_entry = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1038 my $handler = $op_entry->{handler};
1040 if (not ref $handler) {
1041 if ($op =~ s/ [_\s]? \d+ $//x ) {
1042 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
1043 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
1045 return $self->$handler($op, $rhs);
1047 elsif (ref $handler eq 'CODE') {
1048 return $handler->($self, $op, $rhs);
1051 puke "Illegal handler for operator $op - expecting a method name or a coderef";
1055 $self->_debug("Generic unary OP: $op - recursing as function");
1057 $self->_assert_pass_injection_guard($op);
1059 my ($sql, @bind) = $self->_SWITCH_refkind($rhs, {
1061 puke "Illegal use of top-level '-$op'"
1062 unless defined $self->{_nested_func_lhs};
1065 $self->_convert('?'),
1066 $self->_bindtype($self->{_nested_func_lhs}, $rhs)
1070 $self->_recurse_where($rhs)
1074 $sql = sprintf('%s %s',
1075 $self->_sqlcase($op),
1079 return ($sql, @bind);
1082 sub _where_op_ANDOR {
1083 my ($self, $op, $v) = @_;
1085 $self->_SWITCH_refkind($v, {
1087 return $self->_where_ARRAYREF($v, $op);
1091 return ($op =~ /^or/i)
1092 ? $self->_where_ARRAYREF([ map { $_ => $v->{$_} } (sort keys %$v) ], $op)
1093 : $self->_where_HASHREF($v);
1097 puke "-$op => \\\$scalar makes little sense, use " .
1099 ? '[ \$scalar, \%rest_of_conditions ] instead'
1100 : '-and => [ \$scalar, \%rest_of_conditions ] instead'
1104 ARRAYREFREF => sub {
1105 puke "-$op => \\[...] makes little sense, use " .
1107 ? '[ \[...], \%rest_of_conditions ] instead'
1108 : '-and => [ \[...], \%rest_of_conditions ] instead'
1112 SCALAR => sub { # permissively interpreted as SQL
1113 puke "-$op => \$value makes little sense, use -bool => \$value instead";
1117 puke "-$op => undef not supported";
1122 sub _where_op_NEST {
1123 my ($self, $op, $v) = @_;
1125 $self->_SWITCH_refkind($v, {
1127 SCALAR => sub { # permissively interpreted as SQL
1128 belch "literal SQL should be -nest => \\'scalar' "
1129 . "instead of -nest => 'scalar' ";
1134 puke "-$op => undef not supported";
1138 $self->_recurse_where($v);
1145 sub _where_op_BOOL {
1146 my ($self, $op, $v) = @_;
1148 my ($s, @b) = $self->_SWITCH_refkind($v, {
1149 SCALAR => sub { # interpreted as SQL column
1150 $self->_convert($self->_quote($v));
1154 puke "-$op => undef not supported";
1158 $self->_recurse_where($v);
1162 $s = "(NOT $s)" if $op =~ /^not/i;
1167 sub _where_op_IDENT {
1169 my ($op, $rhs) = splice @_, -2;
1170 if (! defined $rhs or length ref $rhs) {
1171 puke "-$op requires a single plain scalar argument (a quotable identifier)";
1174 # in case we are called as a top level special op (no '=')
1175 my $has_lhs = my $lhs = shift;
1177 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
1185 sub _where_op_VALUE {
1187 my ($op, $rhs) = splice @_, -2;
1189 # in case we are called as a top level special op (no '=')
1193 if (! defined $rhs) {
1195 ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
1202 (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
1209 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
1213 $self->_convert('?'),
1220 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
1226 my ($self, $args) = @_;
1227 my ($left, $low, $high) = @$args;
1228 my ($rhsql, @rhbind) = do {
1230 puke "Single arg to between must be a literal"
1231 unless $low->{-literal};
1234 local $self->{_nested_func_lhs} = $left->{-ident}
1235 if ref($left) eq 'HASH' and $left->{-ident};
1236 my ($l, $h) = map [ $self->_where_unary_op(%$_) ], $low, $high;
1237 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1238 @{$l}[1..$#$l], @{$h}[1..$#$h])
1241 my ($lhsql, @lhbind) = $self->_recurse_where($left);
1243 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1247 }), 'between', 'not between'),
1251 my ($self, $args) = @_;
1252 my ($lhs, $rhs) = @$args;
1255 local $self->{_nested_func_lhs} = $lhs->{-ident}
1256 if ref($lhs) eq 'HASH' and $lhs->{-ident};
1257 my ($sql, @bind) = $self->_where_unary_op(%$_);
1258 push @in_bind, @bind;
1261 my ($lhsql, @lbind) = $self->_recurse_where($lhs);
1263 $lhsql.' '.$self->_sqlcase($op).' ( '
1264 .join(', ', @in_sql)
1269 }), 'in', 'not in'),
1273 my ($self, undef, $v) = @_;
1274 my ($op, @args) = @$v;
1275 $op =~ s/^-// if length($op) > 1;
1277 local $self->{_nested_func_lhs};
1278 if (my $h = $special{$op}) {
1279 return $self->$h(\@args);
1281 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{user_special_ops}}) {
1282 puke "Special op '${op}' requires first value to be identifier"
1283 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1284 return $self->${\($us->{handler})}($k, $op, $args[1]);
1286 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1287 if (@args == 1 and $op !~ /^(and|or)$/) {
1288 my ($expr_sql, @bind) = $self->_recurse_where($args[0]);
1289 my $op_sql = $self->_sqlcase($final_op);
1291 $unop_postfix{lc($final_op)}
1292 ? "${expr_sql} ${op_sql}"
1293 : "${op_sql} ${expr_sql}"
1295 return (($op eq 'not' ? '('.$final_sql.')' : $final_sql), @bind);
1297 my @parts = map [ $self->_recurse_where($_) ], @args;
1298 my ($final_sql) = map +($op =~ /^(and|or)$/ ? "(${_})" : $_), join(
1299 ' '.$self->_sqlcase($final_op).' ',
1304 map @{$_}[1..$#$_], @parts
1310 sub _where_op_FUNC {
1311 my ($self, undef, $rest) = @_;
1312 my ($func, @args) = @$rest;
1316 push @arg_sql, shift @x;
1318 } map [ $self->_recurse_where($_) ], @args;
1319 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1322 sub _where_op_BIND {
1323 my ($self, undef, $bind) = @_;
1324 return ($self->_convert('?'), $self->_bindtype(@$bind));
1327 sub _where_op_LITERAL {
1328 my ($self, undef, $literal) = @_;
1329 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1333 sub _where_hashpair_ARRAYREF {
1334 my ($self, $k, $v) = @_;
1337 my @v = @$v; # need copy because of shift below
1338 $self->_debug("ARRAY($k) means distribute over elements");
1340 # put apart first element if it is an operator (-and, -or)
1342 (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
1346 my @distributed = map { {$k => $_} } @v;
1349 $self->_debug("OP($op) reinjected into the distributed array");
1350 unshift @distributed, $op;
1353 my $logic = $op ? substr($op, 1) : '';
1355 return $self->_recurse_where(\@distributed, $logic);
1358 $self->_debug("empty ARRAY($k) means 0=1");
1359 return ($self->{sqlfalse});
1363 sub _where_hashpair_HASHREF {
1364 my ($self, $k, $v, $logic) = @_;
1367 local $self->{_nested_func_lhs} = defined $self->{_nested_func_lhs}
1368 ? $self->{_nested_func_lhs}
1372 my ($all_sql, @all_bind);
1374 for my $orig_op (sort keys %$v) {
1375 my $val = $v->{$orig_op};
1377 # put the operator in canonical form
1380 # FIXME - we need to phase out dash-less ops
1381 $op =~ s/^-//; # remove possible initial dash
1382 $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
1383 $op =~ s/\s+/ /g; # compress whitespace
1385 $self->_assert_pass_injection_guard($op);
1388 $op =~ s/^is_not/IS NOT/i;
1390 # so that -not_foo works correctly
1391 $op =~ s/^not_/NOT /i;
1393 # another retarded special case: foo => { $op => { -value => undef } }
1394 if (ref $val eq 'HASH' and keys %$val == 1 and exists $val->{-value} and ! defined $val->{-value} ) {
1400 # CASE: col-value logic modifiers
1401 if ($orig_op =~ /^ \- (and|or) $/xi) {
1402 ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $1);
1404 # CASE: special operators like -in or -between
1405 elsif (my $special_op = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1406 my $handler = $special_op->{handler};
1408 puke "No handler supplied for special operator $orig_op";
1410 elsif (not ref $handler) {
1411 ($sql, @bind) = $self->$handler($k, $op, $val);
1413 elsif (ref $handler eq 'CODE') {
1414 ($sql, @bind) = $handler->($self, $k, $op, $val);
1417 puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
1421 $self->_SWITCH_refkind($val, {
1423 ARRAYREF => sub { # CASE: col => {op => \@vals}
1424 ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
1427 ARRAYREFREF => sub { # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
1428 my ($sub_sql, @sub_bind) = @$$val;
1429 $self->_assert_bindval_matches_bindtype(@sub_bind);
1430 $sql = join ' ', $self->_convert($self->_quote($k)),
1431 $self->_sqlcase($op),
1436 UNDEF => sub { # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
1438 $op =~ /^not$/i ? 'is not' # legacy
1439 : $op =~ $self->{equality_op} ? 'is'
1440 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
1441 : $op =~ $self->{inequality_op} ? 'is not'
1442 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
1443 : puke "unexpected operator '$orig_op' with undef operand";
1445 $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
1448 FALLBACK => sub { # CASE: col => {op/func => $stuff}
1449 ($sql, @bind) = $self->_where_unary_op($op, $val);
1452 $self->_convert($self->_quote($k)),
1453 $self->{_nested_func_lhs} eq $k ? $sql : "($sql)", # top level vs nested
1459 ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
1460 push @all_bind, @bind;
1462 return ($all_sql, @all_bind);
1465 sub _where_field_IS {
1466 my ($self, $k, $op, $v) = @_;
1468 my ($s) = $self->_SWITCH_refkind($v, {
1471 $self->_convert($self->_quote($k)),
1472 map { $self->_sqlcase($_)} ($op, 'null')
1475 puke "$op can only take undef as argument";
1482 sub _where_field_op_ARRAYREF {
1483 my ($self, $k, $op, $vals) = @_;
1485 my @vals = @$vals; #always work on a copy
1488 $self->_debug(sprintf '%s means multiple elements: [ %s ]',
1490 join(', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
1493 # see if the first element is an -and/-or op
1495 if (defined $vals[0] && $vals[0] =~ /^ - (AND|OR) $/ix) {
1500 # a long standing API wart - an attempt to change this behavior during
1501 # the 1.50 series failed *spectacularly*. Warn instead and leave the
1506 (!$logic or $logic eq 'OR')
1508 ($op =~ $self->{inequality_op} or $op =~ $self->{not_like_op})
1511 belch "A multi-element arrayref as an argument to the inequality op '$o' "
1512 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1513 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1517 # distribute $op over each remaining member of @vals, append logic if exists
1518 return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
1522 # try to DWIM on equality operators
1524 $op =~ $self->{equality_op} ? $self->{sqlfalse}
1525 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
1526 : $op =~ $self->{inequality_op} ? $self->{sqltrue}
1527 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
1528 : puke "operator '$op' applied on an empty array (field '$k')";
1533 sub _where_hashpair_SCALARREF {
1534 my ($self, $k, $v) = @_;
1535 $self->_debug("SCALAR($k) means literal SQL: $$v");
1536 my $sql = $self->_quote($k) . " " . $$v;
1540 # literal SQL with bind
1541 sub _where_hashpair_ARRAYREFREF {
1542 my ($self, $k, $v) = @_;
1543 $self->_debug("REF($k) means literal SQL: @${$v}");
1544 my ($sql, @bind) = @$$v;
1545 $self->_assert_bindval_matches_bindtype(@bind);
1546 $sql = $self->_quote($k) . " " . $sql;
1547 return ($sql, @bind );
1550 # literal SQL without bind
1551 sub _where_hashpair_SCALAR {
1552 my ($self, $k, $v) = @_;
1553 $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
1554 return ($self->_where_hashpair_HASHREF($k, { $self->{cmp} => $v }));
1558 sub _where_hashpair_UNDEF {
1559 my ($self, $k, $v) = @_;
1560 $self->_debug("UNDEF($k) means IS NULL");
1561 return $self->_where_hashpair_HASHREF($k, { -is => undef });
1564 #======================================================================
1565 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
1566 #======================================================================
1569 sub _where_SCALARREF {
1570 my ($self, $where) = @_;
1573 $self->_debug("SCALAR(*top) means literal SQL: $$where");
1579 my ($self, $where) = @_;
1582 $self->_debug("NOREF(*top) means literal SQL: $where");
1593 #======================================================================
1594 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
1595 #======================================================================
1598 sub _where_field_BETWEEN {
1599 my ($self, $k, $op, $vals) = @_;
1601 my ($label, $and, $placeholder);
1602 $label = $self->_convert($self->_quote($k));
1603 $and = ' ' . $self->_sqlcase('and') . ' ';
1604 $placeholder = $self->_convert('?');
1605 $op = $self->_sqlcase($op);
1607 my $invalid_args = "Operator '$op' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1609 my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
1610 ARRAYREFREF => sub {
1611 my ($s, @b) = @$$vals;
1612 $self->_assert_bindval_matches_bindtype(@b);
1619 puke $invalid_args if @$vals != 2;
1621 my (@all_sql, @all_bind);
1622 foreach my $val (@$vals) {
1623 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1625 return ($placeholder, $self->_bindtype($k, $val) );
1630 ARRAYREFREF => sub {
1631 my ($sql, @bind) = @$$val;
1632 $self->_assert_bindval_matches_bindtype(@bind);
1633 return ($sql, @bind);
1636 my ($func, $arg, @rest) = %$val;
1637 puke "Only simple { -func => arg } functions accepted as sub-arguments to BETWEEN"
1638 if (@rest or $func !~ /^ \- (.+)/x);
1639 $self->_where_unary_op($1 => $arg);
1645 push @all_sql, $sql;
1646 push @all_bind, @bind;
1650 (join $and, @all_sql),
1659 my $sql = "( $label $op $clause )";
1660 return ($sql, @bind)
1664 sub _where_field_IN {
1665 my ($self, $k, $op, $vals) = @_;
1667 # backwards compatibility: if scalar, force into an arrayref
1668 $vals = [$vals] if defined $vals && ! ref $vals;
1670 my ($label) = $self->_convert($self->_quote($k));
1671 my ($placeholder) = $self->_convert('?');
1672 $op = $self->_sqlcase($op);
1674 my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
1675 ARRAYREF => sub { # list of choices
1676 if (@$vals) { # nonempty list
1677 my (@all_sql, @all_bind);
1679 for my $val (@$vals) {
1680 my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1682 return ($placeholder, $val);
1687 ARRAYREFREF => sub {
1688 my ($sql, @bind) = @$$val;
1689 $self->_assert_bindval_matches_bindtype(@bind);
1690 return ($sql, @bind);
1693 my ($func, $arg, @rest) = %$val;
1694 puke "Only simple { -func => arg } functions accepted as sub-arguments to IN"
1695 if (@rest or $func !~ /^ \- (.+)/x);
1696 $self->_where_unary_op($1 => $arg);
1700 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1701 . "-$op operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1702 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1703 . 'will emit the logically correct SQL instead of raising this exception)'
1707 push @all_sql, $sql;
1708 push @all_bind, @bind;
1712 sprintf('%s %s ( %s )',
1715 join(', ', @all_sql)
1717 $self->_bindtype($k, @all_bind),
1720 else { # empty list: some databases won't understand "IN ()", so DWIM
1721 my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
1726 SCALARREF => sub { # literal SQL
1727 my $sql = $self->_open_outer_paren($$vals);
1728 return ("$label $op ( $sql )");
1730 ARRAYREFREF => sub { # literal SQL with bind
1731 my ($sql, @bind) = @$$vals;
1732 $self->_assert_bindval_matches_bindtype(@bind);
1733 $sql = $self->_open_outer_paren($sql);
1734 return ("$label $op ( $sql )", @bind);
1738 puke "Argument passed to the '$op' operator can not be undefined";
1742 puke "special op $op requires an arrayref (or scalarref/arrayref-ref)";
1746 return ($sql, @bind);
1749 # Some databases (SQLite) treat col IN (1, 2) different from
1750 # col IN ( (1, 2) ). Use this to strip all outer parens while
1751 # adding them back in the corresponding method
1752 sub _open_outer_paren {
1753 my ($self, $sql) = @_;
1755 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1757 # there are closing parens inside, need the heavy duty machinery
1758 # to reevaluate the extraction starting from $sql (full reevaluation)
1759 if ($inner =~ /\)/) {
1760 require Text::Balanced;
1762 my (undef, $remainder) = do {
1763 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1765 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1768 # the entire expression needs to be a balanced bracketed thing
1769 # (after an extract no remainder sans trailing space)
1770 last if defined $remainder and $remainder =~ /\S/;
1780 #======================================================================
1782 #======================================================================
1785 my ($self, $arg) = @_;
1788 for my $c ($self->_order_by_chunks($arg) ) {
1789 $self->_SWITCH_refkind($c, {
1790 SCALAR => sub { push @sql, $c },
1791 ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1797 $self->_sqlcase(' order by'),
1803 return wantarray ? ($sql, @bind) : $sql;
1806 sub _order_by_chunks {
1807 my ($self, $arg) = @_;
1809 return $self->_SWITCH_refkind($arg, {
1812 map { $self->_order_by_chunks($_ ) } @$arg;
1815 ARRAYREFREF => sub {
1816 my ($s, @b) = @$$arg;
1817 $self->_assert_bindval_matches_bindtype(@b);
1821 SCALAR => sub {$self->_quote($arg)},
1823 UNDEF => sub {return () },
1825 SCALARREF => sub {$$arg}, # literal SQL, no quoting
1828 # get first pair in hash
1829 my ($key, $val, @rest) = %$arg;
1831 return () unless $key;
1833 if (@rest or not $key =~ /^-(desc|asc)/i) {
1834 puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1840 for my $c ($self->_order_by_chunks($val)) {
1843 $self->_SWITCH_refkind($c, {
1848 ($sql, @bind) = @$c;
1852 $sql = $sql . ' ' . $self->_sqlcase($direction);
1854 push @ret, [ $sql, @bind];
1863 #======================================================================
1864 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1865 #======================================================================
1870 $self->_SWITCH_refkind($from, {
1871 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$from;},
1872 SCALAR => sub {$self->_quote($from)},
1873 SCALARREF => sub {$$from},
1878 #======================================================================
1880 #======================================================================
1882 # highly optimized, as it's called way too often
1884 # my ($self, $label) = @_;
1886 return '' unless defined $_[1];
1887 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1889 $_[0]->{quote_char} or
1890 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1892 my $qref = ref $_[0]->{quote_char};
1894 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1895 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1896 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1898 my $esc = $_[0]->{escape_char} || $r;
1900 # parts containing * are naturally unquoted
1901 return join($_[0]->{name_sep}||'', map
1902 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1903 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1908 # Conversion, if applicable
1910 #my ($self, $arg) = @_;
1911 if ($_[0]->{convert}) {
1912 return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1919 #my ($self, $col, @vals) = @_;
1920 # called often - tighten code
1921 return $_[0]->{bindtype} eq 'columns'
1922 ? map {[$_[1], $_]} @_[2 .. $#_]
1927 # Dies if any element of @bind is not in [colname => value] format
1928 # if bindtype is 'columns'.
1929 sub _assert_bindval_matches_bindtype {
1930 # my ($self, @bind) = @_;
1932 if ($self->{bindtype} eq 'columns') {
1934 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1935 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1941 sub _join_sql_clauses {
1942 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1944 if (@$clauses_aref > 1) {
1945 my $join = " " . $self->_sqlcase($logic) . " ";
1946 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1947 return ($sql, @$bind_aref);
1949 elsif (@$clauses_aref) {
1950 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1953 return (); # if no SQL, ignore @$bind_aref
1958 # Fix SQL case, if so requested
1960 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1961 # don't touch the argument ... crooked logic, but let's not change it!
1962 return $_[0]->{case} ? $_[1] : uc($_[1]);
1966 #======================================================================
1967 # DISPATCHING FROM REFKIND
1968 #======================================================================
1971 my ($self, $data) = @_;
1973 return 'UNDEF' unless defined $data;
1975 # blessed objects are treated like scalars
1976 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1978 return 'SCALAR' unless $ref;
1981 while ($ref eq 'REF') {
1983 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1987 return ($ref||'SCALAR') . ('REF' x $n_steps);
1991 my ($self, $data) = @_;
1992 my @try = ($self->_refkind($data));
1993 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1994 push @try, 'FALLBACK';
1998 sub _METHOD_FOR_refkind {
1999 my ($self, $meth_prefix, $data) = @_;
2002 for (@{$self->_try_refkind($data)}) {
2003 $method = $self->can($meth_prefix."_".$_)
2007 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
2011 sub _SWITCH_refkind {
2012 my ($self, $data, $dispatch_table) = @_;
2015 for (@{$self->_try_refkind($data)}) {
2016 $coderef = $dispatch_table->{$_}
2020 puke "no dispatch entry for ".$self->_refkind($data)
2029 #======================================================================
2030 # VALUES, GENERATE, AUTOLOAD
2031 #======================================================================
2033 # LDNOTE: original code from nwiger, didn't touch code in that section
2034 # I feel the AUTOLOAD stuff should not be the default, it should
2035 # only be activated on explicit demand by user.
2039 my $data = shift || return;
2040 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
2041 unless ref $data eq 'HASH';
2044 foreach my $k (sort keys %$data) {
2045 my $v = $data->{$k};
2046 $self->_SWITCH_refkind($v, {
2048 if ($self->{array_datatypes}) { # array datatype
2049 push @all_bind, $self->_bindtype($k, $v);
2051 else { # literal SQL with bind
2052 my ($sql, @bind) = @$v;
2053 $self->_assert_bindval_matches_bindtype(@bind);
2054 push @all_bind, @bind;
2057 ARRAYREFREF => sub { # literal SQL with bind
2058 my ($sql, @bind) = @${$v};
2059 $self->_assert_bindval_matches_bindtype(@bind);
2060 push @all_bind, @bind;
2062 SCALARREF => sub { # literal SQL without bind
2064 SCALAR_or_UNDEF => sub {
2065 push @all_bind, $self->_bindtype($k, $v);
2076 my(@sql, @sqlq, @sqlv);
2080 if ($ref eq 'HASH') {
2081 for my $k (sort keys %$_) {
2084 my $label = $self->_quote($k);
2085 if ($r eq 'ARRAY') {
2086 # literal SQL with bind
2087 my ($sql, @bind) = @$v;
2088 $self->_assert_bindval_matches_bindtype(@bind);
2089 push @sqlq, "$label = $sql";
2091 } elsif ($r eq 'SCALAR') {
2092 # literal SQL without bind
2093 push @sqlq, "$label = $$v";
2095 push @sqlq, "$label = ?";
2096 push @sqlv, $self->_bindtype($k, $v);
2099 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
2100 } elsif ($ref eq 'ARRAY') {
2101 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
2104 if ($r eq 'ARRAY') { # literal SQL with bind
2105 my ($sql, @bind) = @$v;
2106 $self->_assert_bindval_matches_bindtype(@bind);
2109 } elsif ($r eq 'SCALAR') { # literal SQL without bind
2110 # embedded literal SQL
2117 push @sql, '(' . join(', ', @sqlq) . ')';
2118 } elsif ($ref eq 'SCALAR') {
2122 # strings get case twiddled
2123 push @sql, $self->_sqlcase($_);
2127 my $sql = join ' ', @sql;
2129 # this is pretty tricky
2130 # if ask for an array, return ($stmt, @bind)
2131 # otherwise, s/?/shift @sqlv/ to put it inline
2133 return ($sql, @sqlv);
2135 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2136 ref $d ? $d->[1] : $d/e;
2145 # This allows us to check for a local, then _form, attr
2147 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2148 return $self->generate($name, @_);
2159 SQL::Abstract - Generate SQL from Perl data structures
2165 my $sql = SQL::Abstract->new;
2167 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2169 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2171 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2173 my($stmt, @bind) = $sql->delete($table, \%where);
2175 # Then, use these in your DBI statements
2176 my $sth = $dbh->prepare($stmt);
2177 $sth->execute(@bind);
2179 # Just generate the WHERE clause
2180 my($stmt, @bind) = $sql->where(\%where, $order);
2182 # Return values in the same order, for hashed queries
2183 # See PERFORMANCE section for more details
2184 my @bind = $sql->values(\%fieldvals);
2188 This module was inspired by the excellent L<DBIx::Abstract>.
2189 However, in using that module I found that what I really wanted
2190 to do was generate SQL, but still retain complete control over my
2191 statement handles and use the DBI interface. So, I set out to
2192 create an abstract SQL generation module.
2194 While based on the concepts used by L<DBIx::Abstract>, there are
2195 several important differences, especially when it comes to WHERE
2196 clauses. I have modified the concepts used to make the SQL easier
2197 to generate from Perl data structures and, IMO, more intuitive.
2198 The underlying idea is for this module to do what you mean, based
2199 on the data structures you provide it. The big advantage is that
2200 you don't have to modify your code every time your data changes,
2201 as this module figures it out.
2203 To begin with, an SQL INSERT is as easy as just specifying a hash
2204 of C<key=value> pairs:
2207 name => 'Jimbo Bobson',
2208 phone => '123-456-7890',
2209 address => '42 Sister Lane',
2210 city => 'St. Louis',
2211 state => 'Louisiana',
2214 The SQL can then be generated with this:
2216 my($stmt, @bind) = $sql->insert('people', \%data);
2218 Which would give you something like this:
2220 $stmt = "INSERT INTO people
2221 (address, city, name, phone, state)
2222 VALUES (?, ?, ?, ?, ?)";
2223 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2224 '123-456-7890', 'Louisiana');
2226 These are then used directly in your DBI code:
2228 my $sth = $dbh->prepare($stmt);
2229 $sth->execute(@bind);
2231 =head2 Inserting and Updating Arrays
2233 If your database has array types (like for example Postgres),
2234 activate the special option C<< array_datatypes => 1 >>
2235 when creating the C<SQL::Abstract> object.
2236 Then you may use an arrayref to insert and update database array types:
2238 my $sql = SQL::Abstract->new(array_datatypes => 1);
2240 planets => [qw/Mercury Venus Earth Mars/]
2243 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2247 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2249 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2252 =head2 Inserting and Updating SQL
2254 In order to apply SQL functions to elements of your C<%data> you may
2255 specify a reference to an arrayref for the given hash value. For example,
2256 if you need to execute the Oracle C<to_date> function on a value, you can
2257 say something like this:
2261 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2264 The first value in the array is the actual SQL. Any other values are
2265 optional and would be included in the bind values array. This gives
2268 my($stmt, @bind) = $sql->insert('people', \%data);
2270 $stmt = "INSERT INTO people (name, date_entered)
2271 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2272 @bind = ('Bill', '03/02/2003');
2274 An UPDATE is just as easy, all you change is the name of the function:
2276 my($stmt, @bind) = $sql->update('people', \%data);
2278 Notice that your C<%data> isn't touched; the module will generate
2279 the appropriately quirky SQL for you automatically. Usually you'll
2280 want to specify a WHERE clause for your UPDATE, though, which is
2281 where handling C<%where> hashes comes in handy...
2283 =head2 Complex where statements
2285 This module can generate pretty complicated WHERE statements
2286 easily. For example, simple C<key=value> pairs are taken to mean
2287 equality, and if you want to see if a field is within a set
2288 of values, you can use an arrayref. Let's say we wanted to
2289 SELECT some data based on this criteria:
2292 requestor => 'inna',
2293 worker => ['nwiger', 'rcwe', 'sfz'],
2294 status => { '!=', 'completed' }
2297 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2299 The above would give you something like this:
2301 $stmt = "SELECT * FROM tickets WHERE
2302 ( requestor = ? ) AND ( status != ? )
2303 AND ( worker = ? OR worker = ? OR worker = ? )";
2304 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2306 Which you could then use in DBI code like so:
2308 my $sth = $dbh->prepare($stmt);
2309 $sth->execute(@bind);
2315 The methods are simple. There's one for every major SQL operation,
2316 and a constructor you use first. The arguments are specified in a
2317 similar order for each method (table, then fields, then a where
2318 clause) to try and simplify things.
2320 =head2 new(option => 'value')
2322 The C<new()> function takes a list of options and values, and returns
2323 a new B<SQL::Abstract> object which can then be used to generate SQL
2324 through the methods below. The options accepted are:
2330 If set to 'lower', then SQL will be generated in all lowercase. By
2331 default SQL is generated in "textbook" case meaning something like:
2333 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2335 Any setting other than 'lower' is ignored.
2339 This determines what the default comparison operator is. By default
2340 it is C<=>, meaning that a hash like this:
2342 %where = (name => 'nwiger', email => 'nate@wiger.org');
2344 Will generate SQL like this:
2346 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2348 However, you may want loose comparisons by default, so if you set
2349 C<cmp> to C<like> you would get SQL such as:
2351 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2353 You can also override the comparison on an individual basis - see
2354 the huge section on L</"WHERE CLAUSES"> at the bottom.
2356 =item sqltrue, sqlfalse
2358 Expressions for inserting boolean values within SQL statements.
2359 By default these are C<1=1> and C<1=0>. They are used
2360 by the special operators C<-in> and C<-not_in> for generating
2361 correct SQL even when the argument is an empty array (see below).
2365 This determines the default logical operator for multiple WHERE
2366 statements in arrays or hashes. If absent, the default logic is "or"
2367 for arrays, and "and" for hashes. This means that a WHERE
2371 event_date => {'>=', '2/13/99'},
2372 event_date => {'<=', '4/24/03'},
2375 will generate SQL like this:
2377 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2379 This is probably not what you want given this query, though (look
2380 at the dates). To change the "OR" to an "AND", simply specify:
2382 my $sql = SQL::Abstract->new(logic => 'and');
2384 Which will change the above C<WHERE> to:
2386 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2388 The logic can also be changed locally by inserting
2389 a modifier in front of an arrayref:
2391 @where = (-and => [event_date => {'>=', '2/13/99'},
2392 event_date => {'<=', '4/24/03'} ]);
2394 See the L</"WHERE CLAUSES"> section for explanations.
2398 This will automatically convert comparisons using the specified SQL
2399 function for both column and value. This is mostly used with an argument
2400 of C<upper> or C<lower>, so that the SQL will have the effect of
2401 case-insensitive "searches". For example, this:
2403 $sql = SQL::Abstract->new(convert => 'upper');
2404 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2406 Will turn out the following SQL:
2408 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2410 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2411 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2412 not validate this option; it will just pass through what you specify verbatim).
2416 This is a kludge because many databases suck. For example, you can't
2417 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2418 Instead, you have to use C<bind_param()>:
2420 $sth->bind_param(1, 'reg data');
2421 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2423 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2424 which loses track of which field each slot refers to. Fear not.
2426 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2427 Currently, you can specify either C<normal> (default) or C<columns>. If you
2428 specify C<columns>, you will get an array that looks like this:
2430 my $sql = SQL::Abstract->new(bindtype => 'columns');
2431 my($stmt, @bind) = $sql->insert(...);
2434 [ 'column1', 'value1' ],
2435 [ 'column2', 'value2' ],
2436 [ 'column3', 'value3' ],
2439 You can then iterate through this manually, using DBI's C<bind_param()>.
2441 $sth->prepare($stmt);
2444 my($col, $data) = @$_;
2445 if ($col eq 'details' || $col eq 'comments') {
2446 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2447 } elsif ($col eq 'image') {
2448 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2450 $sth->bind_param($i, $data);
2454 $sth->execute; # execute without @bind now
2456 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2457 Basically, the advantage is still that you don't have to care which fields
2458 are or are not included. You could wrap that above C<for> loop in a simple
2459 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2460 get a layer of abstraction over manual SQL specification.
2462 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2463 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2464 will expect the bind values in this format.
2468 This is the character that a table or column name will be quoted
2469 with. By default this is an empty string, but you could set it to
2470 the character C<`>, to generate SQL like this:
2472 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2474 Alternatively, you can supply an array ref of two items, the first being the left
2475 hand quote character, and the second the right hand quote character. For
2476 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2477 that generates SQL like this:
2479 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2481 Quoting is useful if you have tables or columns names that are reserved
2482 words in your database's SQL dialect.
2486 This is the character that will be used to escape L</quote_char>s appearing
2487 in an identifier before it has been quoted.
2489 The parameter default in case of a single L</quote_char> character is the quote
2492 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2493 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2494 of the B<opening (left)> L</quote_char> within the identifier are currently left
2495 untouched. The default for opening-closing-style quotes may change in future
2496 versions, thus you are B<strongly encouraged> to specify the escape character
2501 This is the character that separates a table and column name. It is
2502 necessary to specify this when the C<quote_char> option is selected,
2503 so that tables and column names can be individually quoted like this:
2505 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2507 =item injection_guard
2509 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2510 column name specified in a query structure. This is a safety mechanism to avoid
2511 injection attacks when mishandling user input e.g.:
2513 my %condition_as_column_value_pairs = get_values_from_user();
2514 $sqla->select( ... , \%condition_as_column_value_pairs );
2516 If the expression matches an exception is thrown. Note that literal SQL
2517 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2519 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2521 =item array_datatypes
2523 When this option is true, arrayrefs in INSERT or UPDATE are
2524 interpreted as array datatypes and are passed directly
2526 When this option is false, arrayrefs are interpreted
2527 as literal SQL, just like refs to arrayrefs
2528 (but this behavior is for backwards compatibility; when writing
2529 new queries, use the "reference to arrayref" syntax
2535 Takes a reference to a list of "special operators"
2536 to extend the syntax understood by L<SQL::Abstract>.
2537 See section L</"SPECIAL OPERATORS"> for details.
2541 Takes a reference to a list of "unary operators"
2542 to extend the syntax understood by L<SQL::Abstract>.
2543 See section L</"UNARY OPERATORS"> for details.
2549 =head2 insert($table, \@values || \%fieldvals, \%options)
2551 This is the simplest function. You simply give it a table name
2552 and either an arrayref of values or hashref of field/value pairs.
2553 It returns an SQL INSERT statement and a list of bind values.
2554 See the sections on L</"Inserting and Updating Arrays"> and
2555 L</"Inserting and Updating SQL"> for information on how to insert
2556 with those data types.
2558 The optional C<\%options> hash reference may contain additional
2559 options to generate the insert SQL. Currently supported options
2566 Takes either a scalar of raw SQL fields, or an array reference of
2567 field names, and adds on an SQL C<RETURNING> statement at the end.
2568 This allows you to return data generated by the insert statement
2569 (such as row IDs) without performing another C<SELECT> statement.
2570 Note, however, this is not part of the SQL standard and may not
2571 be supported by all database engines.
2575 =head2 update($table, \%fieldvals, \%where, \%options)
2577 This takes a table, hashref of field/value pairs, and an optional
2578 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2580 See the sections on L</"Inserting and Updating Arrays"> and
2581 L</"Inserting and Updating SQL"> for information on how to insert
2582 with those data types.
2584 The optional C<\%options> hash reference may contain additional
2585 options to generate the update SQL. Currently supported options
2592 See the C<returning> option to
2593 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2597 =head2 select($source, $fields, $where, $order)
2599 This returns a SQL SELECT statement and associated list of bind values, as
2600 specified by the arguments:
2606 Specification of the 'FROM' part of the statement.
2607 The argument can be either a plain scalar (interpreted as a table
2608 name, will be quoted), or an arrayref (interpreted as a list
2609 of table names, joined by commas, quoted), or a scalarref
2610 (literal SQL, not quoted).
2614 Specification of the list of fields to retrieve from
2616 The argument can be either an arrayref (interpreted as a list
2617 of field names, will be joined by commas and quoted), or a
2618 plain scalar (literal SQL, not quoted).
2619 Please observe that this API is not as flexible as that of
2620 the first argument C<$source>, for backwards compatibility reasons.
2624 Optional argument to specify the WHERE part of the query.
2625 The argument is most often a hashref, but can also be
2626 an arrayref or plain scalar --
2627 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2631 Optional argument to specify the ORDER BY part of the query.
2632 The argument can be a scalar, a hashref or an arrayref
2633 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2639 =head2 delete($table, \%where, \%options)
2641 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2642 It returns an SQL DELETE statement and list of bind values.
2644 The optional C<\%options> hash reference may contain additional
2645 options to generate the delete SQL. Currently supported options
2652 See the C<returning> option to
2653 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2657 =head2 where(\%where, $order)
2659 This is used to generate just the WHERE clause. For example,
2660 if you have an arbitrary data structure and know what the
2661 rest of your SQL is going to look like, but want an easy way
2662 to produce a WHERE clause, use this. It returns an SQL WHERE
2663 clause and list of bind values.
2666 =head2 values(\%data)
2668 This just returns the values from the hash C<%data>, in the same
2669 order that would be returned from any of the other above queries.
2670 Using this allows you to markedly speed up your queries if you
2671 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2673 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2675 Warning: This is an experimental method and subject to change.
2677 This returns arbitrarily generated SQL. It's a really basic shortcut.
2678 It will return two different things, depending on return context:
2680 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2681 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2683 These would return the following:
2685 # First calling form
2686 $stmt = "CREATE TABLE test (?, ?)";
2687 @bind = (field1, field2);
2689 # Second calling form
2690 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2692 Depending on what you're trying to do, it's up to you to choose the correct
2693 format. In this example, the second form is what you would want.
2697 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2701 ALTER SESSION SET nls_date_format = 'MM/YY'
2703 You get the idea. Strings get their case twiddled, but everything
2704 else remains verbatim.
2706 =head1 EXPORTABLE FUNCTIONS
2708 =head2 is_plain_value
2710 Determines if the supplied argument is a plain value as understood by this
2715 =item * The value is C<undef>
2717 =item * The value is a non-reference
2719 =item * The value is an object with stringification overloading
2721 =item * The value is of the form C<< { -value => $anything } >>
2725 On failure returns C<undef>, on success returns a B<scalar> reference
2726 to the original supplied argument.
2732 The stringification overloading detection is rather advanced: it takes
2733 into consideration not only the presence of a C<""> overload, but if that
2734 fails also checks for enabled
2735 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2736 on either C<0+> or C<bool>.
2738 Unfortunately testing in the field indicates that this
2739 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2740 but only when very large numbers of stringifying objects are involved.
2741 At the time of writing ( Sep 2014 ) there is no clear explanation of
2742 the direct cause, nor is there a manageably small test case that reliably
2743 reproduces the problem.
2745 If you encounter any of the following exceptions in B<random places within
2746 your application stack> - this module may be to blame:
2748 Operation "ne": no method found,
2749 left argument in overloaded package <something>,
2750 right argument in overloaded package <something>
2754 Stub found while resolving method "???" overloading """" in package <something>
2756 If you fall victim to the above - please attempt to reduce the problem
2757 to something that could be sent to the L<SQL::Abstract developers
2758 |DBIx::Class/GETTING HELP/SUPPORT>
2759 (either publicly or privately). As a workaround in the meantime you can
2760 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2761 value, which will most likely eliminate your problem (at the expense of
2762 not being able to properly detect exotic forms of stringification).
2764 This notice and environment variable will be removed in a future version,
2765 as soon as the underlying problem is found and a reliable workaround is
2770 =head2 is_literal_value
2772 Determines if the supplied argument is a literal value as understood by this
2777 =item * C<\$sql_string>
2779 =item * C<\[ $sql_string, @bind_values ]>
2783 On failure returns C<undef>, on success returns an B<array> reference
2784 containing the unpacked version of the supplied literal SQL and bind values.
2786 =head1 WHERE CLAUSES
2790 This module uses a variation on the idea from L<DBIx::Abstract>. It
2791 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2792 module is that things in arrays are OR'ed, and things in hashes
2795 The easiest way to explain is to show lots of examples. After
2796 each C<%where> hash shown, it is assumed you used:
2798 my($stmt, @bind) = $sql->where(\%where);
2800 However, note that the C<%where> hash can be used directly in any
2801 of the other functions as well, as described above.
2803 =head2 Key-value pairs
2805 So, let's get started. To begin, a simple hash:
2809 status => 'completed'
2812 Is converted to SQL C<key = val> statements:
2814 $stmt = "WHERE user = ? AND status = ?";
2815 @bind = ('nwiger', 'completed');
2817 One common thing I end up doing is having a list of values that
2818 a field can be in. To do this, simply specify a list inside of
2823 status => ['assigned', 'in-progress', 'pending'];
2826 This simple code will create the following:
2828 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2829 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2831 A field associated to an empty arrayref will be considered a
2832 logical false and will generate 0=1.
2834 =head2 Tests for NULL values
2836 If the value part is C<undef> then this is converted to SQL <IS NULL>
2845 $stmt = "WHERE user = ? AND status IS NULL";
2848 To test if a column IS NOT NULL:
2852 status => { '!=', undef },
2855 =head2 Specific comparison operators
2857 If you want to specify a different type of operator for your comparison,
2858 you can use a hashref for a given column:
2862 status => { '!=', 'completed' }
2865 Which would generate:
2867 $stmt = "WHERE user = ? AND status != ?";
2868 @bind = ('nwiger', 'completed');
2870 To test against multiple values, just enclose the values in an arrayref:
2872 status => { '=', ['assigned', 'in-progress', 'pending'] };
2874 Which would give you:
2876 "WHERE status = ? OR status = ? OR status = ?"
2879 The hashref can also contain multiple pairs, in which case it is expanded
2880 into an C<AND> of its elements:
2884 status => { '!=', 'completed', -not_like => 'pending%' }
2887 # Or more dynamically, like from a form
2888 $where{user} = 'nwiger';
2889 $where{status}{'!='} = 'completed';
2890 $where{status}{'-not_like'} = 'pending%';
2892 # Both generate this
2893 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2894 @bind = ('nwiger', 'completed', 'pending%');
2897 To get an OR instead, you can combine it with the arrayref idea:
2901 priority => [ { '=', 2 }, { '>', 5 } ]
2904 Which would generate:
2906 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2907 @bind = ('2', '5', 'nwiger');
2909 If you want to include literal SQL (with or without bind values), just use a
2910 scalar reference or reference to an arrayref as the value:
2913 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2914 date_expires => { '<' => \"now()" }
2917 Which would generate:
2919 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2920 @bind = ('11/26/2008');
2923 =head2 Logic and nesting operators
2925 In the example above,
2926 there is a subtle trap if you want to say something like
2927 this (notice the C<AND>):
2929 WHERE priority != ? AND priority != ?
2931 Because, in Perl you I<can't> do this:
2933 priority => { '!=' => 2, '!=' => 1 }
2935 As the second C<!=> key will obliterate the first. The solution
2936 is to use the special C<-modifier> form inside an arrayref:
2938 priority => [ -and => {'!=', 2},
2942 Normally, these would be joined by C<OR>, but the modifier tells it
2943 to use C<AND> instead. (Hint: You can use this in conjunction with the
2944 C<logic> option to C<new()> in order to change the way your queries
2945 work by default.) B<Important:> Note that the C<-modifier> goes
2946 B<INSIDE> the arrayref, as an extra first element. This will
2947 B<NOT> do what you think it might:
2949 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2951 Here is a quick list of equivalencies, since there is some overlap:
2954 status => {'!=', 'completed', 'not like', 'pending%' }
2955 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2958 status => {'=', ['assigned', 'in-progress']}
2959 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2960 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2964 =head2 Special operators: IN, BETWEEN, etc.
2966 You can also use the hashref format to compare a list of fields using the
2967 C<IN> comparison operator, by specifying the list as an arrayref:
2970 status => 'completed',
2971 reportid => { -in => [567, 2335, 2] }
2974 Which would generate:
2976 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2977 @bind = ('completed', '567', '2335', '2');
2979 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2982 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2983 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2984 'sqltrue' (by default: C<1=1>).
2986 In addition to the array you can supply a chunk of literal sql or
2987 literal sql with bind:
2990 customer => { -in => \[
2991 'SELECT cust_id FROM cust WHERE balance > ?',
2994 status => { -in => \'SELECT status_codes FROM states' },
3000 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
3001 AND status IN ( SELECT status_codes FROM states )
3005 Finally, if the argument to C<-in> is not a reference, it will be
3006 treated as a single-element array.
3008 Another pair of operators is C<-between> and C<-not_between>,
3009 used with an arrayref of two values:
3013 completion_date => {
3014 -not_between => ['2002-10-01', '2003-02-06']
3020 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
3022 Just like with C<-in> all plausible combinations of literal SQL
3026 start0 => { -between => [ 1, 2 ] },
3027 start1 => { -between => \["? AND ?", 1, 2] },
3028 start2 => { -between => \"lower(x) AND upper(y)" },
3029 start3 => { -between => [
3031 \["upper(?)", 'stuff' ],
3038 ( start0 BETWEEN ? AND ? )
3039 AND ( start1 BETWEEN ? AND ? )
3040 AND ( start2 BETWEEN lower(x) AND upper(y) )
3041 AND ( start3 BETWEEN lower(x) AND upper(?) )
3043 @bind = (1, 2, 1, 2, 'stuff');
3046 These are the two builtin "special operators"; but the
3047 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
3049 =head2 Unary operators: bool
3051 If you wish to test against boolean columns or functions within your
3052 database you can use the C<-bool> and C<-not_bool> operators. For
3053 example to test the column C<is_user> being true and the column
3054 C<is_enabled> being false you would use:-
3058 -not_bool => 'is_enabled',
3063 WHERE is_user AND NOT is_enabled
3065 If a more complex combination is required, testing more conditions,
3066 then you should use the and/or operators:-
3071 -not_bool => { two=> { -rlike => 'bar' } },
3072 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
3083 (NOT ( three = ? OR three > ? ))
3086 =head2 Nested conditions, -and/-or prefixes
3088 So far, we've seen how multiple conditions are joined with a top-level
3089 C<AND>. We can change this by putting the different conditions we want in
3090 hashes and then putting those hashes in an array. For example:
3095 status => { -like => ['pending%', 'dispatched'] },
3099 status => 'unassigned',
3103 This data structure would create the following:
3105 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
3106 OR ( user = ? AND status = ? ) )";
3107 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
3110 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
3111 to change the logic inside:
3117 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
3118 -or => { workhrs => {'<', 50}, geo => 'EURO' },
3125 $stmt = "WHERE ( user = ?
3126 AND ( ( workhrs > ? AND geo = ? )
3127 OR ( workhrs < ? OR geo = ? ) ) )";
3128 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
3130 =head3 Algebraic inconsistency, for historical reasons
3132 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
3133 operator goes C<outside> of the nested structure; whereas when connecting
3134 several constraints on one column, the C<-and> operator goes
3135 C<inside> the arrayref. Here is an example combining both features:
3138 -and => [a => 1, b => 2],
3139 -or => [c => 3, d => 4],
3140 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3145 WHERE ( ( ( a = ? AND b = ? )
3146 OR ( c = ? OR d = ? )
3147 OR ( e LIKE ? AND e LIKE ? ) ) )
3149 This difference in syntax is unfortunate but must be preserved for
3150 historical reasons. So be careful: the two examples below would
3151 seem algebraically equivalent, but they are not
3154 { -like => 'foo%' },
3155 { -like => '%bar' },
3157 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3160 { col => { -like => 'foo%' } },
3161 { col => { -like => '%bar' } },
3163 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3166 =head2 Literal SQL and value type operators
3168 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3169 side" is a column name and the "right side" is a value (normally rendered as
3170 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3171 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3172 alter this behavior. There are several ways of doing so.
3176 This is a virtual operator that signals the string to its right side is an
3177 identifier (a column name) and not a value. For example to compare two
3178 columns you would write:
3181 priority => { '<', 2 },
3182 requestor => { -ident => 'submitter' },
3187 $stmt = "WHERE priority < ? AND requestor = submitter";
3190 If you are maintaining legacy code you may see a different construct as
3191 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3196 This is a virtual operator that signals that the construct to its right side
3197 is a value to be passed to DBI. This is for example necessary when you want
3198 to write a where clause against an array (for RDBMS that support such
3199 datatypes). For example:
3202 array => { -value => [1, 2, 3] }
3207 $stmt = 'WHERE array = ?';
3208 @bind = ([1, 2, 3]);
3210 Note that if you were to simply say:
3216 the result would probably not be what you wanted:
3218 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3223 Finally, sometimes only literal SQL will do. To include a random snippet
3224 of SQL verbatim, you specify it as a scalar reference. Consider this only
3225 as a last resort. Usually there is a better way. For example:
3228 priority => { '<', 2 },
3229 requestor => { -in => \'(SELECT name FROM hitmen)' },
3234 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3237 Note that in this example, you only get one bind parameter back, since
3238 the verbatim SQL is passed as part of the statement.
3242 Never use untrusted input as a literal SQL argument - this is a massive
3243 security risk (there is no way to check literal snippets for SQL
3244 injections and other nastyness). If you need to deal with untrusted input
3245 use literal SQL with placeholders as described next.
3247 =head3 Literal SQL with placeholders and bind values (subqueries)
3249 If the literal SQL to be inserted has placeholders and bind values,
3250 use a reference to an arrayref (yes this is a double reference --
3251 not so common, but perfectly legal Perl). For example, to find a date
3252 in Postgres you can use something like this:
3255 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3260 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3263 Note that you must pass the bind values in the same format as they are returned
3264 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3265 to C<columns>, you must provide the bind values in the
3266 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3267 scalar value; most commonly the column name, but you can use any scalar value
3268 (including references and blessed references), L<SQL::Abstract> will simply
3269 pass it through intact. So if C<bindtype> is set to C<columns> the above
3270 example will look like:
3273 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3276 Literal SQL is especially useful for nesting parenthesized clauses in the
3277 main SQL query. Here is a first example:
3279 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3283 bar => \["IN ($sub_stmt)" => @sub_bind],
3288 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3289 WHERE c2 < ? AND c3 LIKE ?))";
3290 @bind = (1234, 100, "foo%");
3292 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3293 are expressed in the same way. Of course the C<$sub_stmt> and
3294 its associated bind values can be generated through a former call
3297 my ($sub_stmt, @sub_bind)
3298 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3299 c3 => {-like => "foo%"}});
3302 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3305 In the examples above, the subquery was used as an operator on a column;
3306 but the same principle also applies for a clause within the main C<%where>
3307 hash, like an EXISTS subquery:
3309 my ($sub_stmt, @sub_bind)
3310 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3311 my %where = ( -and => [
3313 \["EXISTS ($sub_stmt)" => @sub_bind],
3318 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3319 WHERE c1 = ? AND c2 > t0.c0))";
3323 Observe that the condition on C<c2> in the subquery refers to
3324 column C<t0.c0> of the main query: this is I<not> a bind
3325 value, so we have to express it through a scalar ref.
3326 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3327 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3328 what we wanted here.
3330 Finally, here is an example where a subquery is used
3331 for expressing unary negation:
3333 my ($sub_stmt, @sub_bind)
3334 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3335 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3337 lname => {like => '%son%'},
3338 \["NOT ($sub_stmt)" => @sub_bind],
3343 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3344 @bind = ('%son%', 10, 20)
3346 =head3 Deprecated usage of Literal SQL
3348 Below are some examples of archaic use of literal SQL. It is shown only as
3349 reference for those who deal with legacy code. Each example has a much
3350 better, cleaner and safer alternative that users should opt for in new code.
3356 my %where = ( requestor => \'IS NOT NULL' )
3358 $stmt = "WHERE requestor IS NOT NULL"
3360 This used to be the way of generating NULL comparisons, before the handling
3361 of C<undef> got formalized. For new code please use the superior syntax as
3362 described in L</Tests for NULL values>.
3366 my %where = ( requestor => \'= submitter' )
3368 $stmt = "WHERE requestor = submitter"
3370 This used to be the only way to compare columns. Use the superior L</-ident>
3371 method for all new code. For example an identifier declared in such a way
3372 will be properly quoted if L</quote_char> is properly set, while the legacy
3373 form will remain as supplied.
3377 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3379 $stmt = "WHERE completed > ? AND is_ready"
3380 @bind = ('2012-12-21')
3382 Using an empty string literal used to be the only way to express a boolean.
3383 For all new code please use the much more readable
3384 L<-bool|/Unary operators: bool> operator.
3390 These pages could go on for a while, since the nesting of the data
3391 structures this module can handle are pretty much unlimited (the
3392 module implements the C<WHERE> expansion as a recursive function
3393 internally). Your best bet is to "play around" with the module a
3394 little to see how the data structures behave, and choose the best
3395 format for your data based on that.
3397 And of course, all the values above will probably be replaced with
3398 variables gotten from forms or the command line. After all, if you
3399 knew everything ahead of time, you wouldn't have to worry about
3400 dynamically-generating SQL and could just hardwire it into your
3403 =head1 ORDER BY CLAUSES
3405 Some functions take an order by clause. This can either be a scalar (just a
3406 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3407 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3410 Given | Will Generate
3411 ---------------------------------------------------------------
3413 'colA' | ORDER BY colA
3415 [qw/colA colB/] | ORDER BY colA, colB
3417 {-asc => 'colA'} | ORDER BY colA ASC
3419 {-desc => 'colB'} | ORDER BY colB DESC
3421 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3423 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3425 \'colA DESC' | ORDER BY colA DESC
3427 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3428 | /* ...with $x bound to ? */
3431 { -asc => 'colA' }, | colA ASC,
3432 { -desc => [qw/colB/] }, | colB DESC,
3433 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3434 \'colE DESC', | colE DESC,
3435 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3436 ] | /* ...with $x bound to ? */
3437 ===============================================================
3441 =head1 SPECIAL OPERATORS
3443 my $sqlmaker = SQL::Abstract->new(special_ops => [
3447 my ($self, $field, $op, $arg) = @_;
3453 handler => 'method_name',
3457 A "special operator" is a SQL syntactic clause that can be
3458 applied to a field, instead of a usual binary operator.
3461 WHERE field IN (?, ?, ?)
3462 WHERE field BETWEEN ? AND ?
3463 WHERE MATCH(field) AGAINST (?, ?)
3465 Special operators IN and BETWEEN are fairly standard and therefore
3466 are builtin within C<SQL::Abstract> (as the overridable methods
3467 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3468 like the MATCH .. AGAINST example above which is specific to MySQL,
3469 you can write your own operator handlers - supply a C<special_ops>
3470 argument to the C<new> method. That argument takes an arrayref of
3471 operator definitions; each operator definition is a hashref with two
3478 the regular expression to match the operator
3482 Either a coderef or a plain scalar method name. In both cases
3483 the expected return is C<< ($sql, @bind) >>.
3485 When supplied with a method name, it is simply called on the
3486 L<SQL::Abstract> object as:
3488 $self->$method_name($field, $op, $arg)
3492 $field is the LHS of the operator
3493 $op is the part that matched the handler regex
3496 When supplied with a coderef, it is called as:
3498 $coderef->($self, $field, $op, $arg)
3503 For example, here is an implementation
3504 of the MATCH .. AGAINST syntax for MySQL
3506 my $sqlmaker = SQL::Abstract->new(special_ops => [
3508 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3509 {regex => qr/^match$/i,
3511 my ($self, $field, $op, $arg) = @_;
3512 $arg = [$arg] if not ref $arg;
3513 my $label = $self->_quote($field);
3514 my ($placeholder) = $self->_convert('?');
3515 my $placeholders = join ", ", (($placeholder) x @$arg);
3516 my $sql = $self->_sqlcase('match') . " ($label) "
3517 . $self->_sqlcase('against') . " ($placeholders) ";
3518 my @bind = $self->_bindtype($field, @$arg);
3519 return ($sql, @bind);
3526 =head1 UNARY OPERATORS
3528 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3532 my ($self, $op, $arg) = @_;
3538 handler => 'method_name',
3542 A "unary operator" is a SQL syntactic clause that can be
3543 applied to a field - the operator goes before the field
3545 You can write your own operator handlers - supply a C<unary_ops>
3546 argument to the C<new> method. That argument takes an arrayref of
3547 operator definitions; each operator definition is a hashref with two
3554 the regular expression to match the operator
3558 Either a coderef or a plain scalar method name. In both cases
3559 the expected return is C<< $sql >>.
3561 When supplied with a method name, it is simply called on the
3562 L<SQL::Abstract> object as:
3564 $self->$method_name($op, $arg)
3568 $op is the part that matched the handler regex
3569 $arg is the RHS or argument of the operator
3571 When supplied with a coderef, it is called as:
3573 $coderef->($self, $op, $arg)
3581 Thanks to some benchmarking by Mark Stosberg, it turns out that
3582 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3583 I must admit this wasn't an intentional design issue, but it's a
3584 byproduct of the fact that you get to control your C<DBI> handles
3587 To maximize performance, use a code snippet like the following:
3589 # prepare a statement handle using the first row
3590 # and then reuse it for the rest of the rows
3592 for my $href (@array_of_hashrefs) {
3593 $stmt ||= $sql->insert('table', $href);
3594 $sth ||= $dbh->prepare($stmt);
3595 $sth->execute($sql->values($href));
3598 The reason this works is because the keys in your C<$href> are sorted
3599 internally by B<SQL::Abstract>. Thus, as long as your data retains
3600 the same structure, you only have to generate the SQL the first time
3601 around. On subsequent queries, simply use the C<values> function provided
3602 by this module to return your values in the correct order.
3604 However this depends on the values having the same type - if, for
3605 example, the values of a where clause may either have values
3606 (resulting in sql of the form C<column = ?> with a single bind
3607 value), or alternatively the values might be C<undef> (resulting in
3608 sql of the form C<column IS NULL> with no bind value) then the
3609 caching technique suggested will not work.
3613 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3614 really like this part (I do, at least). Building up a complex query
3615 can be as simple as the following:
3622 use CGI::FormBuilder;
3625 my $form = CGI::FormBuilder->new(...);
3626 my $sql = SQL::Abstract->new;
3628 if ($form->submitted) {
3629 my $field = $form->field;
3630 my $id = delete $field->{id};
3631 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3634 Of course, you would still have to connect using C<DBI> to run the
3635 query, but the point is that if you make your form look like your
3636 table, the actual query script can be extremely simplistic.
3638 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3639 a fast interface to returning and formatting data. I frequently
3640 use these three modules together to write complex database query
3641 apps in under 50 lines.
3643 =head1 HOW TO CONTRIBUTE
3645 Contributions are always welcome, in all usable forms (we especially
3646 welcome documentation improvements). The delivery methods include git-
3647 or unified-diff formatted patches, GitHub pull requests, or plain bug
3648 reports either via RT or the Mailing list. Contributors are generally
3649 granted full access to the official repository after their first several
3650 patches pass successful review.
3652 This project is maintained in a git repository. The code and related tools are
3653 accessible at the following locations:
3657 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3659 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3661 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3663 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3669 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3670 Great care has been taken to preserve the I<published> behavior
3671 documented in previous versions in the 1.* family; however,
3672 some features that were previously undocumented, or behaved
3673 differently from the documentation, had to be changed in order
3674 to clarify the semantics. Hence, client code that was relying
3675 on some dark areas of C<SQL::Abstract> v1.*
3676 B<might behave differently> in v1.50.
3678 The main changes are:
3684 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3688 support for the { operator => \"..." } construct (to embed literal SQL)
3692 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3696 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3700 defensive programming: check arguments
3704 fixed bug with global logic, which was previously implemented
3705 through global variables yielding side-effects. Prior versions would
3706 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3707 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3708 Now this is interpreted
3709 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3714 fixed semantics of _bindtype on array args
3718 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3719 we just avoid shifting arrays within that tree.
3723 dropped the C<_modlogic> function
3727 =head1 ACKNOWLEDGEMENTS
3729 There are a number of individuals that have really helped out with
3730 this module. Unfortunately, most of them submitted bugs via CPAN
3731 so I have no idea who they are! But the people I do know are:
3733 Ash Berlin (order_by hash term support)
3734 Matt Trout (DBIx::Class support)
3735 Mark Stosberg (benchmarking)
3736 Chas Owens (initial "IN" operator support)
3737 Philip Collins (per-field SQL functions)
3738 Eric Kolve (hashref "AND" support)
3739 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3740 Dan Kubb (support for "quote_char" and "name_sep")
3741 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3742 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3743 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3744 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3745 Oliver Charles (support for "RETURNING" after "INSERT")
3751 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3755 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3757 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3759 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3760 While not an official support venue, C<DBIx::Class> makes heavy use of
3761 C<SQL::Abstract>, and as such list members there are very familiar with
3762 how to create queries.
3766 This module is free software; you may copy this under the same
3767 terms as perl itself (either the GNU General Public License or
3768 the Artistic License)