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/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{special_ops} ||= [];
160 # regexes are applied in order, thus push after user-defines
161 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 if ($class->isa('DBIx::Class::SQLMaker')) {
164 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
165 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
167 $opt{is_dbic_sqlmaker} = 1;
171 $opt{unary_ops} ||= [];
173 # rudimentary sanity-check for user supplied bits treated as functions/operators
174 # If a purported function matches this regular expression, an exception is thrown.
175 # Literal SQL is *NOT* subject to this check, only functions (and column names
176 # when quoting is not in effect)
179 # need to guard against ()'s in column names too, but this will break tons of
180 # hacks... ideas anyone?
181 $opt{injection_guard} ||= qr/
188 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
192 $opt{expand_unary} = {};
194 return bless \%opt, $class;
197 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
198 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
200 sub _assert_pass_injection_guard {
201 if ($_[1] =~ $_[0]->{injection_guard}) {
202 my $class = ref $_[0];
203 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
204 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
205 . "{injection_guard} attribute to ${class}->new()"
210 #======================================================================
212 #======================================================================
216 my $table = $self->_table(shift);
217 my $data = shift || return;
220 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
221 my ($sql, @bind) = $self->$method($data);
222 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
224 if ($options->{returning}) {
225 my ($s, @b) = $self->_insert_returning($options);
230 return wantarray ? ($sql, @bind) : $sql;
233 # So that subclasses can override INSERT ... RETURNING separately from
234 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
235 sub _insert_returning { shift->_returning(@_) }
238 my ($self, $options) = @_;
240 my $f = $options->{returning};
242 my ($sql, @bind) = $self->render_aqt(
243 $self->_expand_maybe_list_expr($f, undef, -ident)
246 ? $self->_sqlcase(' returning ') . $sql
247 : ($self->_sqlcase(' returning ').$sql, @bind);
250 sub _insert_HASHREF { # explicit list of fields and then values
251 my ($self, $data) = @_;
253 my @fields = sort keys %$data;
255 my ($sql, @bind) = $self->_insert_values($data);
258 $_ = $self->_quote($_) foreach @fields;
259 $sql = "( ".join(", ", @fields).") ".$sql;
261 return ($sql, @bind);
264 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
265 my ($self, $data) = @_;
267 # no names (arrayref) so can't generate bindtype
268 $self->{bindtype} ne 'columns'
269 or belch "can't do 'columns' bindtype when called with arrayref";
271 my (@values, @all_bind);
272 foreach my $value (@$data) {
273 my ($values, @bind) = $self->_insert_value(undef, $value);
274 push @values, $values;
275 push @all_bind, @bind;
277 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
278 return ($sql, @all_bind);
281 sub _insert_ARRAYREFREF { # literal SQL with bind
282 my ($self, $data) = @_;
284 my ($sql, @bind) = @${$data};
285 $self->_assert_bindval_matches_bindtype(@bind);
287 return ($sql, @bind);
291 sub _insert_SCALARREF { # literal SQL without bind
292 my ($self, $data) = @_;
298 my ($self, $data) = @_;
300 my (@values, @all_bind);
301 foreach my $column (sort keys %$data) {
302 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
303 push @values, $values;
304 push @all_bind, @bind;
306 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
307 return ($sql, @all_bind);
311 my ($self, $column, $v) = @_;
313 return $self->render_aqt(
314 $self->_expand_insert_value($column, $v)
318 sub _expand_insert_value {
319 my ($self, $column, $v) = @_;
321 if (ref($v) eq 'ARRAY') {
322 if ($self->{array_datatypes}) {
323 return +{ -bind => [ $column, $v ] };
325 my ($sql, @bind) = @$v;
326 $self->_assert_bindval_matches_bindtype(@bind);
327 return +{ -literal => $v };
329 if (ref($v) eq 'HASH') {
330 if (grep !/^-/, keys %$v) {
331 belch "HASH ref as bind value in insert is not supported";
332 return +{ -bind => [ $column, $v ] };
336 return +{ -bind => [ $column, undef ] };
338 local our $Cur_Col_Meta = $column;
339 return $self->expand_expr($v);
344 #======================================================================
346 #======================================================================
351 my $table = $self->_table(shift);
352 my $data = shift || return;
356 # first build the 'SET' part of the sql statement
357 puke "Unsupported data type specified to \$sql->update"
358 unless ref $data eq 'HASH';
360 my ($sql, @all_bind) = $self->_update_set_values($data);
361 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
365 my($where_sql, @where_bind) = $self->where($where);
367 push @all_bind, @where_bind;
370 if ($options->{returning}) {
371 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
372 $sql .= $returning_sql;
373 push @all_bind, @returning_bind;
376 return wantarray ? ($sql, @all_bind) : $sql;
379 sub _update_set_values {
380 my ($self, $data) = @_;
382 return $self->render_aqt(
383 $self->_expand_update_set_values($data),
387 sub _expand_update_set_values {
388 my ($self, $data) = @_;
389 $self->_expand_maybe_list_expr( [
392 $set = { -bind => $_ } unless defined $set;
393 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
399 ? ($self->{array_datatypes}
400 ? [ $k, +{ -bind => [ $k, $v ] } ]
401 : [ $k, +{ -literal => $v } ])
403 local our $Cur_Col_Meta = $k;
404 [ $k, $self->_expand_expr($v) ]
411 # So that subclasses can override UPDATE ... RETURNING separately from
413 sub _update_returning { shift->_returning(@_) }
417 #======================================================================
419 #======================================================================
424 my $table = $self->_table(shift);
425 my $fields = shift || '*';
429 my ($fields_sql, @bind) = $self->_select_fields($fields);
431 my ($where_sql, @where_bind) = $self->where($where, $order);
432 push @bind, @where_bind;
434 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
435 $self->_sqlcase('from'), $table)
438 return wantarray ? ($sql, @bind) : $sql;
442 my ($self, $fields) = @_;
443 return $fields unless ref($fields);
444 return $self->render_aqt(
445 $self->_expand_maybe_list_expr($fields, undef, '-ident')
449 #======================================================================
451 #======================================================================
456 my $table = $self->_table(shift);
460 my($where_sql, @bind) = $self->where($where);
461 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
463 if ($options->{returning}) {
464 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
465 $sql .= $returning_sql;
466 push @bind, @returning_bind;
469 return wantarray ? ($sql, @bind) : $sql;
472 # So that subclasses can override DELETE ... RETURNING separately from
474 sub _delete_returning { shift->_returning(@_) }
478 #======================================================================
480 #======================================================================
484 # Finally, a separate routine just to handle WHERE clauses
486 my ($self, $where, $order) = @_;
488 local $self->{convert_where} = $self->{convert};
491 my ($sql, @bind) = defined($where)
492 ? $self->_recurse_where($where)
494 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
498 my ($order_sql, @order_bind) = $self->_order_by($order);
500 push @bind, @order_bind;
503 return wantarray ? ($sql, @bind) : $sql;
507 my ($self, $expr, $default_scalar_to) = @_;
508 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
509 $self->_expand_expr($expr, undef);
513 my ($self, $aqt) = @_;
514 my ($k, $v, @rest) = %$aqt;
516 if (my $meth = $self->{render}{$k}) {
517 return $self->$meth($v);
519 die "notreached: $k";
523 my ($self, $expr) = @_;
524 $self->render_aqt($self->expand_expr($expr));
528 my ($self, $expr, $logic, $default_scalar_to) = @_;
529 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
530 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
531 return undef unless defined($expr);
532 if (ref($expr) eq 'HASH') {
533 if (keys %$expr > 1) {
537 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
541 return undef unless keys %$expr;
542 return $self->_expand_expr_hashpair(%$expr, $logic);
544 if (ref($expr) eq 'ARRAY') {
545 my $logic = lc($logic || $self->{logic});
546 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
549 (ref($_) eq 'ARRAY' and @$_)
550 or (ref($_) eq 'HASH' and %$_)
556 while (my ($el) = splice @expr, 0, 1) {
557 puke "Supplying an empty left hand side argument is not supported in array-pairs"
558 unless defined($el) and length($el);
559 my $elref = ref($el);
561 local $Expand_Depth = 0;
562 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
563 } elsif ($elref eq 'ARRAY') {
564 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
565 } elsif (my $l = is_literal_value($el)) {
566 push @res, { -literal => $l };
567 } elsif ($elref eq 'HASH') {
568 local $Expand_Depth = 0;
569 push @res, grep defined, $self->_expand_expr($el) if %$el;
574 return { -op => [ $logic, @res ] };
576 if (my $literal = is_literal_value($expr)) {
577 return +{ -literal => $literal };
579 if (!ref($expr) or Scalar::Util::blessed($expr)) {
580 if (my $d = $Default_Scalar_To) {
581 return $self->_expand_expr({ $d => $expr });
583 if (my $m = our $Cur_Col_Meta) {
584 return +{ -bind => [ $m, $expr ] };
586 return +{ -bind => [ undef, $expr ] };
591 sub _expand_expr_hashpair {
592 my ($self, $k, $v, $logic) = @_;
593 unless (defined($k) and length($k)) {
594 if (defined($k) and my $literal = is_literal_value($v)) {
595 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
596 return { -literal => $literal };
598 puke "Supplying an empty left hand side argument is not supported";
601 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
602 if ($k =~ s/ [_\s]? \d+ $//x ) {
603 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
604 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
607 # DBIx::Class requires a nest warning to be emitted once but the private
608 # method it overrode to do so no longer exists
609 if ($self->{is_dbic_sqlmaker}) {
610 unless (our $Nest_Warned) {
612 "-nest in search conditions is deprecated, you most probably wanted:\n"
613 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
618 return $self->_expand_expr($v);
622 return $self->_expand_expr($v);
624 puke "-bool => undef not supported" unless defined($v);
625 return { -ident => $v };
628 return { -op => [ 'not', $self->_expand_expr($v) ] };
630 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
633 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
636 if (my ($logic) = $k =~ /^-(and|or)$/i) {
637 if (ref($v) eq 'HASH') {
638 return $self->_expand_expr($v, $logic);
640 if (ref($v) eq 'ARRAY') {
641 return $self->_expand_expr($v, $logic);
646 $op =~ s/^-// if length($op) > 1;
648 # top level special ops are illegal in general
649 # note that, arguably, if it makes no sense at top level, it also
650 # makes no sense on the other side of an = sign or similar but DBIC
651 # gets disappointingly upset if I disallow it
653 (our $Expand_Depth) == 1
654 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
656 puke "Illegal use of top-level '-$op'"
658 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
659 return { -op => [ $op, $v ] };
662 if ($k eq '-value') {
663 return +{ -bind => [ our $Cur_Col_Meta, $v ] };
665 if (my $custom = $self->{expand_unary}{$k}) {
666 return $self->$custom($v);
668 if ($self->{render}{$k}) {
674 and (keys %$v)[0] =~ /^-/
676 my ($func) = $k =~ /^-(.*)$/;
677 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
678 return +{ -op => [ $func, $self->_expand_expr($v) ] };
680 return +{ -func => [ $func, $self->_expand_expr($v) ] };
682 if (!ref($v) or is_literal_value($v)) {
683 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
690 and exists $v->{-value}
691 and not defined $v->{-value}
694 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
696 if (!ref($v) or Scalar::Util::blessed($v)) {
697 my $d = our $Default_Scalar_To;
702 ($d ? { $d => $v } : { -bind => [ $k, $v ] })
706 if (ref($v) eq 'HASH') {
710 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
714 return undef unless keys %$v;
718 $self->_assert_pass_injection_guard($vk);
719 if ($vk =~ s/ [_\s]? \d+ $//x ) {
720 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
721 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
723 if ($vk =~ /^(?:not[ _])?between$/) {
724 local our $Cur_Col_Meta = $k;
725 my @rhs = map $self->_expand_expr($_),
726 ref($vv) eq 'ARRAY' ? @$vv : $vv;
728 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
730 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
732 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
735 join(' ', split '_', $vk),
740 if ($vk =~ /^(?:not[ _])?in$/) {
741 if (my $literal = is_literal_value($vv)) {
742 my ($sql, @bind) = @$literal;
743 my $opened_sql = $self->_open_outer_paren($sql);
745 $vk, { -ident => $k },
746 [ { -literal => [ $opened_sql, @bind ] } ]
750 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
751 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
752 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
753 . 'will emit the logically correct SQL instead of raising this exception)'
755 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
757 my @rhs = map $self->_expand_expr($_),
758 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
759 map { defined($_) ? $_: puke($undef_err) }
760 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
761 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
764 join(' ', split '_', $vk),
769 if ($vk eq 'ident') {
770 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
771 puke "-$vk requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
779 if ($vk eq 'value') {
780 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
784 { -bind => [ $k, $vv ] }
787 if ($vk =~ /^is(?:[ _]not)?$/) {
788 puke "$vk can only take undef as argument"
792 and exists($vv->{-value})
793 and !defined($vv->{-value})
796 return +{ -op => [ $vk.' null', { -ident => $k } ] };
798 if ($vk =~ /^(and|or)$/) {
799 if (ref($vv) eq 'HASH') {
802 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
807 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{special_ops}}) {
808 return { -op => [ $vk, { -ident => $k }, $vv ] };
810 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{unary_ops}}) {
814 { -op => [ $vk, $vv ] }
817 if (ref($vv) eq 'ARRAY') {
818 my ($logic, @values) = (
819 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
824 $vk =~ $self->{inequality_op}
825 or join(' ', split '_', $vk) =~ $self->{not_like_op}
827 if (lc($logic) eq '-or' and @values > 1) {
828 my $op = uc join ' ', split '_', $vk;
829 belch "A multi-element arrayref as an argument to the inequality op '$op' "
830 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
831 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
836 # try to DWIM on equality operators
837 my $op = join ' ', split '_', $vk;
839 $op =~ $self->{equality_op} ? $self->sqlfalse
840 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
841 : $op =~ $self->{inequality_op} ? $self->sqltrue
842 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
843 : puke "operator '$op' applied on an empty array (field '$k')";
847 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
855 and exists $vv->{-value}
856 and not defined $vv->{-value}
859 my $op = join ' ', split '_', $vk;
861 $op =~ /^not$/i ? 'is not' # legacy
862 : $op =~ $self->{equality_op} ? 'is'
863 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
864 : $op =~ $self->{inequality_op} ? 'is not'
865 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
866 : puke "unexpected operator '$op' with undef operand";
867 return +{ -op => [ $is.' null', { -ident => $k } ] };
869 local our $Cur_Col_Meta = $k;
873 $self->_expand_expr($vv)
876 if (ref($v) eq 'ARRAY') {
877 return $self->sqlfalse unless @$v;
878 $self->_debug("ARRAY($k) means distribute over elements");
880 $v->[0] =~ /^-((?:and|or))$/i
881 ? ($v = [ @{$v}[1..$#$v] ], $1)
882 : ($self->{logic} || 'or')
886 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
889 if (my $literal = is_literal_value($v)) {
891 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
894 my ($sql, @bind) = @$literal;
895 if ($self->{bindtype} eq 'columns') {
897 $self->_assert_bindval_matches_bindtype($_);
900 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
906 my ($self, undef, $body) = @_;
907 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
908 ref($body) ? @$body : $body;
909 return +{ -ident => \@parts };
913 my ($self, $where, $logic) = @_;
915 # Special case: top level simple string treated as literal
917 my $where_exp = (ref($where)
918 ? $self->_expand_expr($where, $logic)
919 : { -literal => [ $where ] });
921 # dispatch expanded expression
923 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
924 # DBIx::Class used to call _recurse_where in scalar context
925 # something else might too...
927 return ($sql, @bind);
930 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
936 my ($self, $ident) = @_;
938 return $self->_convert($self->_quote($ident));
941 my %unop_postfix = map +($_ => 1),
942 'is null', 'is not null',
950 my ($self, $args) = @_;
951 my ($left, $low, $high) = @$args;
952 my ($rhsql, @rhbind) = do {
954 puke "Single arg to between must be a literal"
955 unless $low->{-literal};
958 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
959 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
960 @{$l}[1..$#$l], @{$h}[1..$#$h])
963 my ($lhsql, @lhbind) = $self->render_aqt($left);
965 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
969 }), 'between', 'not between'),
973 my ($self, $args) = @_;
974 my ($lhs, $rhs) = @$args;
977 my ($sql, @bind) = $self->render_aqt($_);
978 push @in_bind, @bind;
981 my ($lhsql, @lbind) = $self->render_aqt($lhs);
983 $lhsql.' '.$self->_sqlcase($op).' ( '
994 my ($op, @args) = @$v;
995 $op =~ s/^-// if length($op) > 1;
997 if (my $h = $special{$op}) {
998 return $self->$h(\@args);
1000 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1001 if ($us and @args > 1) {
1002 puke "Special op '${op}' requires first value to be identifier"
1003 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1004 local our $Expand_Depth = 1;
1005 return $self->${\($us->{handler})}($k, $op, $args[1]);
1007 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1008 return $self->${\($us->{handler})}($op, $args[0]);
1010 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1011 if (@args == 1 and $op !~ /^(and|or)$/) {
1012 my ($expr_sql, @bind) = $self->render_aqt($args[0]);
1013 my $op_sql = $self->_sqlcase($final_op);
1015 $unop_postfix{lc($final_op)}
1016 ? "${expr_sql} ${op_sql}"
1017 : "${op_sql} ${expr_sql}"
1019 return (($op eq 'not' || $us ? '('.$final_sql.')' : $final_sql), @bind);
1021 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1022 return '' unless @parts;
1023 my $is_andor = !!($op =~ /^(and|or)$/);
1024 return @{$parts[0]} if $is_andor and @parts == 1;
1025 my ($final_sql) = map +($is_andor ? "( ${_} )" : $_), join(
1026 ' '.$self->_sqlcase($final_op).' ',
1031 map @{$_}[1..$#$_], @parts
1038 my ($self, $list) = @_;
1039 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1040 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1044 my ($self, $rest) = @_;
1045 my ($func, @args) = @$rest;
1049 push @arg_sql, shift @x;
1051 } map [ $self->render_aqt($_) ], @args;
1052 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1056 my ($self, $bind) = @_;
1057 return ($self->_convert('?'), $self->_bindtype(@$bind));
1060 sub _render_literal {
1061 my ($self, $literal) = @_;
1062 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1066 # Some databases (SQLite) treat col IN (1, 2) different from
1067 # col IN ( (1, 2) ). Use this to strip all outer parens while
1068 # adding them back in the corresponding method
1069 sub _open_outer_paren {
1070 my ($self, $sql) = @_;
1072 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1074 # there are closing parens inside, need the heavy duty machinery
1075 # to reevaluate the extraction starting from $sql (full reevaluation)
1076 if ($inner =~ /\)/) {
1077 require Text::Balanced;
1079 my (undef, $remainder) = do {
1080 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1082 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1085 # the entire expression needs to be a balanced bracketed thing
1086 # (after an extract no remainder sans trailing space)
1087 last if defined $remainder and $remainder =~ /\S/;
1097 #======================================================================
1099 #======================================================================
1101 sub _expand_order_by {
1102 my ($self, $arg) = @_;
1104 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1106 my $expander = sub {
1107 my ($self, $dir, $expr) = @_;
1108 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1109 foreach my $arg (@to_expand) {
1113 and grep /^-(asc|desc)$/, keys %$arg
1115 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1118 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1119 map $self->expand_expr($_, -ident),
1120 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1121 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1124 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1125 sub { shift->$expander(asc => @_) },
1126 sub { shift->$expander(desc => @_) },
1129 return $self->$expander(undef, $arg);
1133 my ($self, $arg) = @_;
1135 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1137 my ($sql, @bind) = $self->render_aqt($expanded);
1139 return '' unless length($sql);
1141 my $final_sql = $self->_sqlcase(' order by ').$sql;
1143 return wantarray ? ($final_sql, @bind) : $final_sql;
1146 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1148 sub _order_by_chunks {
1149 my ($self, $arg) = @_;
1151 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1153 return $self->_chunkify_order_by($expanded);
1156 sub _chunkify_order_by {
1157 my ($self, $expanded) = @_;
1159 return grep length, $self->render_aqt($expanded)
1160 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1163 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1164 return map $self->_chunkify_order_by($_), @$l;
1166 return [ $self->render_aqt($_) ];
1170 #======================================================================
1171 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1172 #======================================================================
1178 $self->_expand_maybe_list_expr($from, undef, -ident)
1183 #======================================================================
1185 #======================================================================
1187 sub _expand_maybe_list_expr {
1188 my ($self, $expr, $logic, $default) = @_;
1190 if (ref($expr) eq 'ARRAY') {
1192 map $self->expand_expr($_, $default), @$expr
1199 return $self->expand_expr($e, $default);
1202 # highly optimized, as it's called way too often
1204 # my ($self, $label) = @_;
1206 return '' unless defined $_[1];
1207 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1208 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1210 unless ($_[0]->{quote_char}) {
1211 if (ref($_[1]) eq 'ARRAY') {
1212 return join($_[0]->{name_sep}||'.', @{$_[1]});
1214 $_[0]->_assert_pass_injection_guard($_[1]);
1219 my $qref = ref $_[0]->{quote_char};
1221 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1222 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1223 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1225 my $esc = $_[0]->{escape_char} || $r;
1227 # parts containing * are naturally unquoted
1229 $_[0]->{name_sep}||'',
1233 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1235 (ref($_[1]) eq 'ARRAY'
1239 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1247 # Conversion, if applicable
1249 #my ($self, $arg) = @_;
1250 if ($_[0]->{convert_where}) {
1251 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1258 #my ($self, $col, @vals) = @_;
1259 # called often - tighten code
1260 return $_[0]->{bindtype} eq 'columns'
1261 ? map {[$_[1], $_]} @_[2 .. $#_]
1266 # Dies if any element of @bind is not in [colname => value] format
1267 # if bindtype is 'columns'.
1268 sub _assert_bindval_matches_bindtype {
1269 # my ($self, @bind) = @_;
1271 if ($self->{bindtype} eq 'columns') {
1273 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1274 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1280 sub _join_sql_clauses {
1281 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1283 if (@$clauses_aref > 1) {
1284 my $join = " " . $self->_sqlcase($logic) . " ";
1285 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1286 return ($sql, @$bind_aref);
1288 elsif (@$clauses_aref) {
1289 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1292 return (); # if no SQL, ignore @$bind_aref
1297 # Fix SQL case, if so requested
1299 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1300 # don't touch the argument ... crooked logic, but let's not change it!
1301 return $_[0]->{case} ? $_[1] : uc($_[1]);
1305 #======================================================================
1306 # DISPATCHING FROM REFKIND
1307 #======================================================================
1310 my ($self, $data) = @_;
1312 return 'UNDEF' unless defined $data;
1314 # blessed objects are treated like scalars
1315 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1317 return 'SCALAR' unless $ref;
1320 while ($ref eq 'REF') {
1322 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1326 return ($ref||'SCALAR') . ('REF' x $n_steps);
1330 my ($self, $data) = @_;
1331 my @try = ($self->_refkind($data));
1332 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1333 push @try, 'FALLBACK';
1337 sub _METHOD_FOR_refkind {
1338 my ($self, $meth_prefix, $data) = @_;
1341 for (@{$self->_try_refkind($data)}) {
1342 $method = $self->can($meth_prefix."_".$_)
1346 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1350 sub _SWITCH_refkind {
1351 my ($self, $data, $dispatch_table) = @_;
1354 for (@{$self->_try_refkind($data)}) {
1355 $coderef = $dispatch_table->{$_}
1359 puke "no dispatch entry for ".$self->_refkind($data)
1368 #======================================================================
1369 # VALUES, GENERATE, AUTOLOAD
1370 #======================================================================
1372 # LDNOTE: original code from nwiger, didn't touch code in that section
1373 # I feel the AUTOLOAD stuff should not be the default, it should
1374 # only be activated on explicit demand by user.
1378 my $data = shift || return;
1379 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1380 unless ref $data eq 'HASH';
1383 foreach my $k (sort keys %$data) {
1384 my $v = $data->{$k};
1385 $self->_SWITCH_refkind($v, {
1387 if ($self->{array_datatypes}) { # array datatype
1388 push @all_bind, $self->_bindtype($k, $v);
1390 else { # literal SQL with bind
1391 my ($sql, @bind) = @$v;
1392 $self->_assert_bindval_matches_bindtype(@bind);
1393 push @all_bind, @bind;
1396 ARRAYREFREF => sub { # literal SQL with bind
1397 my ($sql, @bind) = @${$v};
1398 $self->_assert_bindval_matches_bindtype(@bind);
1399 push @all_bind, @bind;
1401 SCALARREF => sub { # literal SQL without bind
1403 SCALAR_or_UNDEF => sub {
1404 push @all_bind, $self->_bindtype($k, $v);
1415 my(@sql, @sqlq, @sqlv);
1419 if ($ref eq 'HASH') {
1420 for my $k (sort keys %$_) {
1423 my $label = $self->_quote($k);
1424 if ($r eq 'ARRAY') {
1425 # literal SQL with bind
1426 my ($sql, @bind) = @$v;
1427 $self->_assert_bindval_matches_bindtype(@bind);
1428 push @sqlq, "$label = $sql";
1430 } elsif ($r eq 'SCALAR') {
1431 # literal SQL without bind
1432 push @sqlq, "$label = $$v";
1434 push @sqlq, "$label = ?";
1435 push @sqlv, $self->_bindtype($k, $v);
1438 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1439 } elsif ($ref eq 'ARRAY') {
1440 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1443 if ($r eq 'ARRAY') { # literal SQL with bind
1444 my ($sql, @bind) = @$v;
1445 $self->_assert_bindval_matches_bindtype(@bind);
1448 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1449 # embedded literal SQL
1456 push @sql, '(' . join(', ', @sqlq) . ')';
1457 } elsif ($ref eq 'SCALAR') {
1461 # strings get case twiddled
1462 push @sql, $self->_sqlcase($_);
1466 my $sql = join ' ', @sql;
1468 # this is pretty tricky
1469 # if ask for an array, return ($stmt, @bind)
1470 # otherwise, s/?/shift @sqlv/ to put it inline
1472 return ($sql, @sqlv);
1474 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1475 ref $d ? $d->[1] : $d/e;
1484 # This allows us to check for a local, then _form, attr
1486 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1487 return $self->generate($name, @_);
1498 SQL::Abstract - Generate SQL from Perl data structures
1504 my $sql = SQL::Abstract->new;
1506 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1508 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1510 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1512 my($stmt, @bind) = $sql->delete($table, \%where);
1514 # Then, use these in your DBI statements
1515 my $sth = $dbh->prepare($stmt);
1516 $sth->execute(@bind);
1518 # Just generate the WHERE clause
1519 my($stmt, @bind) = $sql->where(\%where, $order);
1521 # Return values in the same order, for hashed queries
1522 # See PERFORMANCE section for more details
1523 my @bind = $sql->values(\%fieldvals);
1527 This module was inspired by the excellent L<DBIx::Abstract>.
1528 However, in using that module I found that what I really wanted
1529 to do was generate SQL, but still retain complete control over my
1530 statement handles and use the DBI interface. So, I set out to
1531 create an abstract SQL generation module.
1533 While based on the concepts used by L<DBIx::Abstract>, there are
1534 several important differences, especially when it comes to WHERE
1535 clauses. I have modified the concepts used to make the SQL easier
1536 to generate from Perl data structures and, IMO, more intuitive.
1537 The underlying idea is for this module to do what you mean, based
1538 on the data structures you provide it. The big advantage is that
1539 you don't have to modify your code every time your data changes,
1540 as this module figures it out.
1542 To begin with, an SQL INSERT is as easy as just specifying a hash
1543 of C<key=value> pairs:
1546 name => 'Jimbo Bobson',
1547 phone => '123-456-7890',
1548 address => '42 Sister Lane',
1549 city => 'St. Louis',
1550 state => 'Louisiana',
1553 The SQL can then be generated with this:
1555 my($stmt, @bind) = $sql->insert('people', \%data);
1557 Which would give you something like this:
1559 $stmt = "INSERT INTO people
1560 (address, city, name, phone, state)
1561 VALUES (?, ?, ?, ?, ?)";
1562 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1563 '123-456-7890', 'Louisiana');
1565 These are then used directly in your DBI code:
1567 my $sth = $dbh->prepare($stmt);
1568 $sth->execute(@bind);
1570 =head2 Inserting and Updating Arrays
1572 If your database has array types (like for example Postgres),
1573 activate the special option C<< array_datatypes => 1 >>
1574 when creating the C<SQL::Abstract> object.
1575 Then you may use an arrayref to insert and update database array types:
1577 my $sql = SQL::Abstract->new(array_datatypes => 1);
1579 planets => [qw/Mercury Venus Earth Mars/]
1582 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1586 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1588 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1591 =head2 Inserting and Updating SQL
1593 In order to apply SQL functions to elements of your C<%data> you may
1594 specify a reference to an arrayref for the given hash value. For example,
1595 if you need to execute the Oracle C<to_date> function on a value, you can
1596 say something like this:
1600 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1603 The first value in the array is the actual SQL. Any other values are
1604 optional and would be included in the bind values array. This gives
1607 my($stmt, @bind) = $sql->insert('people', \%data);
1609 $stmt = "INSERT INTO people (name, date_entered)
1610 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1611 @bind = ('Bill', '03/02/2003');
1613 An UPDATE is just as easy, all you change is the name of the function:
1615 my($stmt, @bind) = $sql->update('people', \%data);
1617 Notice that your C<%data> isn't touched; the module will generate
1618 the appropriately quirky SQL for you automatically. Usually you'll
1619 want to specify a WHERE clause for your UPDATE, though, which is
1620 where handling C<%where> hashes comes in handy...
1622 =head2 Complex where statements
1624 This module can generate pretty complicated WHERE statements
1625 easily. For example, simple C<key=value> pairs are taken to mean
1626 equality, and if you want to see if a field is within a set
1627 of values, you can use an arrayref. Let's say we wanted to
1628 SELECT some data based on this criteria:
1631 requestor => 'inna',
1632 worker => ['nwiger', 'rcwe', 'sfz'],
1633 status => { '!=', 'completed' }
1636 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1638 The above would give you something like this:
1640 $stmt = "SELECT * FROM tickets WHERE
1641 ( requestor = ? ) AND ( status != ? )
1642 AND ( worker = ? OR worker = ? OR worker = ? )";
1643 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1645 Which you could then use in DBI code like so:
1647 my $sth = $dbh->prepare($stmt);
1648 $sth->execute(@bind);
1654 The methods are simple. There's one for every major SQL operation,
1655 and a constructor you use first. The arguments are specified in a
1656 similar order for each method (table, then fields, then a where
1657 clause) to try and simplify things.
1659 =head2 new(option => 'value')
1661 The C<new()> function takes a list of options and values, and returns
1662 a new B<SQL::Abstract> object which can then be used to generate SQL
1663 through the methods below. The options accepted are:
1669 If set to 'lower', then SQL will be generated in all lowercase. By
1670 default SQL is generated in "textbook" case meaning something like:
1672 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1674 Any setting other than 'lower' is ignored.
1678 This determines what the default comparison operator is. By default
1679 it is C<=>, meaning that a hash like this:
1681 %where = (name => 'nwiger', email => 'nate@wiger.org');
1683 Will generate SQL like this:
1685 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1687 However, you may want loose comparisons by default, so if you set
1688 C<cmp> to C<like> you would get SQL such as:
1690 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1692 You can also override the comparison on an individual basis - see
1693 the huge section on L</"WHERE CLAUSES"> at the bottom.
1695 =item sqltrue, sqlfalse
1697 Expressions for inserting boolean values within SQL statements.
1698 By default these are C<1=1> and C<1=0>. They are used
1699 by the special operators C<-in> and C<-not_in> for generating
1700 correct SQL even when the argument is an empty array (see below).
1704 This determines the default logical operator for multiple WHERE
1705 statements in arrays or hashes. If absent, the default logic is "or"
1706 for arrays, and "and" for hashes. This means that a WHERE
1710 event_date => {'>=', '2/13/99'},
1711 event_date => {'<=', '4/24/03'},
1714 will generate SQL like this:
1716 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1718 This is probably not what you want given this query, though (look
1719 at the dates). To change the "OR" to an "AND", simply specify:
1721 my $sql = SQL::Abstract->new(logic => 'and');
1723 Which will change the above C<WHERE> to:
1725 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1727 The logic can also be changed locally by inserting
1728 a modifier in front of an arrayref:
1730 @where = (-and => [event_date => {'>=', '2/13/99'},
1731 event_date => {'<=', '4/24/03'} ]);
1733 See the L</"WHERE CLAUSES"> section for explanations.
1737 This will automatically convert comparisons using the specified SQL
1738 function for both column and value. This is mostly used with an argument
1739 of C<upper> or C<lower>, so that the SQL will have the effect of
1740 case-insensitive "searches". For example, this:
1742 $sql = SQL::Abstract->new(convert => 'upper');
1743 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1745 Will turn out the following SQL:
1747 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1749 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1750 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1751 not validate this option; it will just pass through what you specify verbatim).
1755 This is a kludge because many databases suck. For example, you can't
1756 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1757 Instead, you have to use C<bind_param()>:
1759 $sth->bind_param(1, 'reg data');
1760 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1762 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1763 which loses track of which field each slot refers to. Fear not.
1765 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1766 Currently, you can specify either C<normal> (default) or C<columns>. If you
1767 specify C<columns>, you will get an array that looks like this:
1769 my $sql = SQL::Abstract->new(bindtype => 'columns');
1770 my($stmt, @bind) = $sql->insert(...);
1773 [ 'column1', 'value1' ],
1774 [ 'column2', 'value2' ],
1775 [ 'column3', 'value3' ],
1778 You can then iterate through this manually, using DBI's C<bind_param()>.
1780 $sth->prepare($stmt);
1783 my($col, $data) = @$_;
1784 if ($col eq 'details' || $col eq 'comments') {
1785 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1786 } elsif ($col eq 'image') {
1787 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1789 $sth->bind_param($i, $data);
1793 $sth->execute; # execute without @bind now
1795 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1796 Basically, the advantage is still that you don't have to care which fields
1797 are or are not included. You could wrap that above C<for> loop in a simple
1798 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1799 get a layer of abstraction over manual SQL specification.
1801 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1802 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1803 will expect the bind values in this format.
1807 This is the character that a table or column name will be quoted
1808 with. By default this is an empty string, but you could set it to
1809 the character C<`>, to generate SQL like this:
1811 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1813 Alternatively, you can supply an array ref of two items, the first being the left
1814 hand quote character, and the second the right hand quote character. For
1815 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1816 that generates SQL like this:
1818 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1820 Quoting is useful if you have tables or columns names that are reserved
1821 words in your database's SQL dialect.
1825 This is the character that will be used to escape L</quote_char>s appearing
1826 in an identifier before it has been quoted.
1828 The parameter default in case of a single L</quote_char> character is the quote
1831 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1832 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1833 of the B<opening (left)> L</quote_char> within the identifier are currently left
1834 untouched. The default for opening-closing-style quotes may change in future
1835 versions, thus you are B<strongly encouraged> to specify the escape character
1840 This is the character that separates a table and column name. It is
1841 necessary to specify this when the C<quote_char> option is selected,
1842 so that tables and column names can be individually quoted like this:
1844 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1846 =item injection_guard
1848 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1849 column name specified in a query structure. This is a safety mechanism to avoid
1850 injection attacks when mishandling user input e.g.:
1852 my %condition_as_column_value_pairs = get_values_from_user();
1853 $sqla->select( ... , \%condition_as_column_value_pairs );
1855 If the expression matches an exception is thrown. Note that literal SQL
1856 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1858 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1860 =item array_datatypes
1862 When this option is true, arrayrefs in INSERT or UPDATE are
1863 interpreted as array datatypes and are passed directly
1865 When this option is false, arrayrefs are interpreted
1866 as literal SQL, just like refs to arrayrefs
1867 (but this behavior is for backwards compatibility; when writing
1868 new queries, use the "reference to arrayref" syntax
1874 Takes a reference to a list of "special operators"
1875 to extend the syntax understood by L<SQL::Abstract>.
1876 See section L</"SPECIAL OPERATORS"> for details.
1880 Takes a reference to a list of "unary operators"
1881 to extend the syntax understood by L<SQL::Abstract>.
1882 See section L</"UNARY OPERATORS"> for details.
1888 =head2 insert($table, \@values || \%fieldvals, \%options)
1890 This is the simplest function. You simply give it a table name
1891 and either an arrayref of values or hashref of field/value pairs.
1892 It returns an SQL INSERT statement and a list of bind values.
1893 See the sections on L</"Inserting and Updating Arrays"> and
1894 L</"Inserting and Updating SQL"> for information on how to insert
1895 with those data types.
1897 The optional C<\%options> hash reference may contain additional
1898 options to generate the insert SQL. Currently supported options
1905 Takes either a scalar of raw SQL fields, or an array reference of
1906 field names, and adds on an SQL C<RETURNING> statement at the end.
1907 This allows you to return data generated by the insert statement
1908 (such as row IDs) without performing another C<SELECT> statement.
1909 Note, however, this is not part of the SQL standard and may not
1910 be supported by all database engines.
1914 =head2 update($table, \%fieldvals, \%where, \%options)
1916 This takes a table, hashref of field/value pairs, and an optional
1917 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1919 See the sections on L</"Inserting and Updating Arrays"> and
1920 L</"Inserting and Updating SQL"> for information on how to insert
1921 with those data types.
1923 The optional C<\%options> hash reference may contain additional
1924 options to generate the update SQL. Currently supported options
1931 See the C<returning> option to
1932 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1936 =head2 select($source, $fields, $where, $order)
1938 This returns a SQL SELECT statement and associated list of bind values, as
1939 specified by the arguments:
1945 Specification of the 'FROM' part of the statement.
1946 The argument can be either a plain scalar (interpreted as a table
1947 name, will be quoted), or an arrayref (interpreted as a list
1948 of table names, joined by commas, quoted), or a scalarref
1949 (literal SQL, not quoted).
1953 Specification of the list of fields to retrieve from
1955 The argument can be either an arrayref (interpreted as a list
1956 of field names, will be joined by commas and quoted), or a
1957 plain scalar (literal SQL, not quoted).
1958 Please observe that this API is not as flexible as that of
1959 the first argument C<$source>, for backwards compatibility reasons.
1963 Optional argument to specify the WHERE part of the query.
1964 The argument is most often a hashref, but can also be
1965 an arrayref or plain scalar --
1966 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1970 Optional argument to specify the ORDER BY part of the query.
1971 The argument can be a scalar, a hashref or an arrayref
1972 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1978 =head2 delete($table, \%where, \%options)
1980 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1981 It returns an SQL DELETE statement and list of bind values.
1983 The optional C<\%options> hash reference may contain additional
1984 options to generate the delete SQL. Currently supported options
1991 See the C<returning> option to
1992 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1996 =head2 where(\%where, $order)
1998 This is used to generate just the WHERE clause. For example,
1999 if you have an arbitrary data structure and know what the
2000 rest of your SQL is going to look like, but want an easy way
2001 to produce a WHERE clause, use this. It returns an SQL WHERE
2002 clause and list of bind values.
2005 =head2 values(\%data)
2007 This just returns the values from the hash C<%data>, in the same
2008 order that would be returned from any of the other above queries.
2009 Using this allows you to markedly speed up your queries if you
2010 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2012 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2014 Warning: This is an experimental method and subject to change.
2016 This returns arbitrarily generated SQL. It's a really basic shortcut.
2017 It will return two different things, depending on return context:
2019 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2020 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2022 These would return the following:
2024 # First calling form
2025 $stmt = "CREATE TABLE test (?, ?)";
2026 @bind = (field1, field2);
2028 # Second calling form
2029 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2031 Depending on what you're trying to do, it's up to you to choose the correct
2032 format. In this example, the second form is what you would want.
2036 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2040 ALTER SESSION SET nls_date_format = 'MM/YY'
2042 You get the idea. Strings get their case twiddled, but everything
2043 else remains verbatim.
2045 =head1 EXPORTABLE FUNCTIONS
2047 =head2 is_plain_value
2049 Determines if the supplied argument is a plain value as understood by this
2054 =item * The value is C<undef>
2056 =item * The value is a non-reference
2058 =item * The value is an object with stringification overloading
2060 =item * The value is of the form C<< { -value => $anything } >>
2064 On failure returns C<undef>, on success returns a B<scalar> reference
2065 to the original supplied argument.
2071 The stringification overloading detection is rather advanced: it takes
2072 into consideration not only the presence of a C<""> overload, but if that
2073 fails also checks for enabled
2074 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2075 on either C<0+> or C<bool>.
2077 Unfortunately testing in the field indicates that this
2078 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2079 but only when very large numbers of stringifying objects are involved.
2080 At the time of writing ( Sep 2014 ) there is no clear explanation of
2081 the direct cause, nor is there a manageably small test case that reliably
2082 reproduces the problem.
2084 If you encounter any of the following exceptions in B<random places within
2085 your application stack> - this module may be to blame:
2087 Operation "ne": no method found,
2088 left argument in overloaded package <something>,
2089 right argument in overloaded package <something>
2093 Stub found while resolving method "???" overloading """" in package <something>
2095 If you fall victim to the above - please attempt to reduce the problem
2096 to something that could be sent to the L<SQL::Abstract developers
2097 |DBIx::Class/GETTING HELP/SUPPORT>
2098 (either publicly or privately). As a workaround in the meantime you can
2099 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2100 value, which will most likely eliminate your problem (at the expense of
2101 not being able to properly detect exotic forms of stringification).
2103 This notice and environment variable will be removed in a future version,
2104 as soon as the underlying problem is found and a reliable workaround is
2109 =head2 is_literal_value
2111 Determines if the supplied argument is a literal value as understood by this
2116 =item * C<\$sql_string>
2118 =item * C<\[ $sql_string, @bind_values ]>
2122 On failure returns C<undef>, on success returns an B<array> reference
2123 containing the unpacked version of the supplied literal SQL and bind values.
2125 =head1 WHERE CLAUSES
2129 This module uses a variation on the idea from L<DBIx::Abstract>. It
2130 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2131 module is that things in arrays are OR'ed, and things in hashes
2134 The easiest way to explain is to show lots of examples. After
2135 each C<%where> hash shown, it is assumed you used:
2137 my($stmt, @bind) = $sql->where(\%where);
2139 However, note that the C<%where> hash can be used directly in any
2140 of the other functions as well, as described above.
2142 =head2 Key-value pairs
2144 So, let's get started. To begin, a simple hash:
2148 status => 'completed'
2151 Is converted to SQL C<key = val> statements:
2153 $stmt = "WHERE user = ? AND status = ?";
2154 @bind = ('nwiger', 'completed');
2156 One common thing I end up doing is having a list of values that
2157 a field can be in. To do this, simply specify a list inside of
2162 status => ['assigned', 'in-progress', 'pending'];
2165 This simple code will create the following:
2167 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2168 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2170 A field associated to an empty arrayref will be considered a
2171 logical false and will generate 0=1.
2173 =head2 Tests for NULL values
2175 If the value part is C<undef> then this is converted to SQL <IS NULL>
2184 $stmt = "WHERE user = ? AND status IS NULL";
2187 To test if a column IS NOT NULL:
2191 status => { '!=', undef },
2194 =head2 Specific comparison operators
2196 If you want to specify a different type of operator for your comparison,
2197 you can use a hashref for a given column:
2201 status => { '!=', 'completed' }
2204 Which would generate:
2206 $stmt = "WHERE user = ? AND status != ?";
2207 @bind = ('nwiger', 'completed');
2209 To test against multiple values, just enclose the values in an arrayref:
2211 status => { '=', ['assigned', 'in-progress', 'pending'] };
2213 Which would give you:
2215 "WHERE status = ? OR status = ? OR status = ?"
2218 The hashref can also contain multiple pairs, in which case it is expanded
2219 into an C<AND> of its elements:
2223 status => { '!=', 'completed', -not_like => 'pending%' }
2226 # Or more dynamically, like from a form
2227 $where{user} = 'nwiger';
2228 $where{status}{'!='} = 'completed';
2229 $where{status}{'-not_like'} = 'pending%';
2231 # Both generate this
2232 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2233 @bind = ('nwiger', 'completed', 'pending%');
2236 To get an OR instead, you can combine it with the arrayref idea:
2240 priority => [ { '=', 2 }, { '>', 5 } ]
2243 Which would generate:
2245 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2246 @bind = ('2', '5', 'nwiger');
2248 If you want to include literal SQL (with or without bind values), just use a
2249 scalar reference or reference to an arrayref as the value:
2252 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2253 date_expires => { '<' => \"now()" }
2256 Which would generate:
2258 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2259 @bind = ('11/26/2008');
2262 =head2 Logic and nesting operators
2264 In the example above,
2265 there is a subtle trap if you want to say something like
2266 this (notice the C<AND>):
2268 WHERE priority != ? AND priority != ?
2270 Because, in Perl you I<can't> do this:
2272 priority => { '!=' => 2, '!=' => 1 }
2274 As the second C<!=> key will obliterate the first. The solution
2275 is to use the special C<-modifier> form inside an arrayref:
2277 priority => [ -and => {'!=', 2},
2281 Normally, these would be joined by C<OR>, but the modifier tells it
2282 to use C<AND> instead. (Hint: You can use this in conjunction with the
2283 C<logic> option to C<new()> in order to change the way your queries
2284 work by default.) B<Important:> Note that the C<-modifier> goes
2285 B<INSIDE> the arrayref, as an extra first element. This will
2286 B<NOT> do what you think it might:
2288 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2290 Here is a quick list of equivalencies, since there is some overlap:
2293 status => {'!=', 'completed', 'not like', 'pending%' }
2294 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2297 status => {'=', ['assigned', 'in-progress']}
2298 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2299 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2303 =head2 Special operators: IN, BETWEEN, etc.
2305 You can also use the hashref format to compare a list of fields using the
2306 C<IN> comparison operator, by specifying the list as an arrayref:
2309 status => 'completed',
2310 reportid => { -in => [567, 2335, 2] }
2313 Which would generate:
2315 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2316 @bind = ('completed', '567', '2335', '2');
2318 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2321 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2322 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2323 'sqltrue' (by default: C<1=1>).
2325 In addition to the array you can supply a chunk of literal sql or
2326 literal sql with bind:
2329 customer => { -in => \[
2330 'SELECT cust_id FROM cust WHERE balance > ?',
2333 status => { -in => \'SELECT status_codes FROM states' },
2339 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2340 AND status IN ( SELECT status_codes FROM states )
2344 Finally, if the argument to C<-in> is not a reference, it will be
2345 treated as a single-element array.
2347 Another pair of operators is C<-between> and C<-not_between>,
2348 used with an arrayref of two values:
2352 completion_date => {
2353 -not_between => ['2002-10-01', '2003-02-06']
2359 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2361 Just like with C<-in> all plausible combinations of literal SQL
2365 start0 => { -between => [ 1, 2 ] },
2366 start1 => { -between => \["? AND ?", 1, 2] },
2367 start2 => { -between => \"lower(x) AND upper(y)" },
2368 start3 => { -between => [
2370 \["upper(?)", 'stuff' ],
2377 ( start0 BETWEEN ? AND ? )
2378 AND ( start1 BETWEEN ? AND ? )
2379 AND ( start2 BETWEEN lower(x) AND upper(y) )
2380 AND ( start3 BETWEEN lower(x) AND upper(?) )
2382 @bind = (1, 2, 1, 2, 'stuff');
2385 These are the two builtin "special operators"; but the
2386 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2388 =head2 Unary operators: bool
2390 If you wish to test against boolean columns or functions within your
2391 database you can use the C<-bool> and C<-not_bool> operators. For
2392 example to test the column C<is_user> being true and the column
2393 C<is_enabled> being false you would use:-
2397 -not_bool => 'is_enabled',
2402 WHERE is_user AND NOT is_enabled
2404 If a more complex combination is required, testing more conditions,
2405 then you should use the and/or operators:-
2410 -not_bool => { two=> { -rlike => 'bar' } },
2411 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2422 (NOT ( three = ? OR three > ? ))
2425 =head2 Nested conditions, -and/-or prefixes
2427 So far, we've seen how multiple conditions are joined with a top-level
2428 C<AND>. We can change this by putting the different conditions we want in
2429 hashes and then putting those hashes in an array. For example:
2434 status => { -like => ['pending%', 'dispatched'] },
2438 status => 'unassigned',
2442 This data structure would create the following:
2444 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2445 OR ( user = ? AND status = ? ) )";
2446 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2449 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2450 to change the logic inside:
2456 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2457 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2464 $stmt = "WHERE ( user = ?
2465 AND ( ( workhrs > ? AND geo = ? )
2466 OR ( workhrs < ? OR geo = ? ) ) )";
2467 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2469 =head3 Algebraic inconsistency, for historical reasons
2471 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2472 operator goes C<outside> of the nested structure; whereas when connecting
2473 several constraints on one column, the C<-and> operator goes
2474 C<inside> the arrayref. Here is an example combining both features:
2477 -and => [a => 1, b => 2],
2478 -or => [c => 3, d => 4],
2479 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2484 WHERE ( ( ( a = ? AND b = ? )
2485 OR ( c = ? OR d = ? )
2486 OR ( e LIKE ? AND e LIKE ? ) ) )
2488 This difference in syntax is unfortunate but must be preserved for
2489 historical reasons. So be careful: the two examples below would
2490 seem algebraically equivalent, but they are not
2493 { -like => 'foo%' },
2494 { -like => '%bar' },
2496 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2499 { col => { -like => 'foo%' } },
2500 { col => { -like => '%bar' } },
2502 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2505 =head2 Literal SQL and value type operators
2507 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2508 side" is a column name and the "right side" is a value (normally rendered as
2509 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2510 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2511 alter this behavior. There are several ways of doing so.
2515 This is a virtual operator that signals the string to its right side is an
2516 identifier (a column name) and not a value. For example to compare two
2517 columns you would write:
2520 priority => { '<', 2 },
2521 requestor => { -ident => 'submitter' },
2526 $stmt = "WHERE priority < ? AND requestor = submitter";
2529 If you are maintaining legacy code you may see a different construct as
2530 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2535 This is a virtual operator that signals that the construct to its right side
2536 is a value to be passed to DBI. This is for example necessary when you want
2537 to write a where clause against an array (for RDBMS that support such
2538 datatypes). For example:
2541 array => { -value => [1, 2, 3] }
2546 $stmt = 'WHERE array = ?';
2547 @bind = ([1, 2, 3]);
2549 Note that if you were to simply say:
2555 the result would probably not be what you wanted:
2557 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2562 Finally, sometimes only literal SQL will do. To include a random snippet
2563 of SQL verbatim, you specify it as a scalar reference. Consider this only
2564 as a last resort. Usually there is a better way. For example:
2567 priority => { '<', 2 },
2568 requestor => { -in => \'(SELECT name FROM hitmen)' },
2573 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2576 Note that in this example, you only get one bind parameter back, since
2577 the verbatim SQL is passed as part of the statement.
2581 Never use untrusted input as a literal SQL argument - this is a massive
2582 security risk (there is no way to check literal snippets for SQL
2583 injections and other nastyness). If you need to deal with untrusted input
2584 use literal SQL with placeholders as described next.
2586 =head3 Literal SQL with placeholders and bind values (subqueries)
2588 If the literal SQL to be inserted has placeholders and bind values,
2589 use a reference to an arrayref (yes this is a double reference --
2590 not so common, but perfectly legal Perl). For example, to find a date
2591 in Postgres you can use something like this:
2594 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2599 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2602 Note that you must pass the bind values in the same format as they are returned
2603 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2604 to C<columns>, you must provide the bind values in the
2605 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2606 scalar value; most commonly the column name, but you can use any scalar value
2607 (including references and blessed references), L<SQL::Abstract> will simply
2608 pass it through intact. So if C<bindtype> is set to C<columns> the above
2609 example will look like:
2612 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2615 Literal SQL is especially useful for nesting parenthesized clauses in the
2616 main SQL query. Here is a first example:
2618 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2622 bar => \["IN ($sub_stmt)" => @sub_bind],
2627 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2628 WHERE c2 < ? AND c3 LIKE ?))";
2629 @bind = (1234, 100, "foo%");
2631 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2632 are expressed in the same way. Of course the C<$sub_stmt> and
2633 its associated bind values can be generated through a former call
2636 my ($sub_stmt, @sub_bind)
2637 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2638 c3 => {-like => "foo%"}});
2641 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2644 In the examples above, the subquery was used as an operator on a column;
2645 but the same principle also applies for a clause within the main C<%where>
2646 hash, like an EXISTS subquery:
2648 my ($sub_stmt, @sub_bind)
2649 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2650 my %where = ( -and => [
2652 \["EXISTS ($sub_stmt)" => @sub_bind],
2657 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2658 WHERE c1 = ? AND c2 > t0.c0))";
2662 Observe that the condition on C<c2> in the subquery refers to
2663 column C<t0.c0> of the main query: this is I<not> a bind
2664 value, so we have to express it through a scalar ref.
2665 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2666 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2667 what we wanted here.
2669 Finally, here is an example where a subquery is used
2670 for expressing unary negation:
2672 my ($sub_stmt, @sub_bind)
2673 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2674 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2676 lname => {like => '%son%'},
2677 \["NOT ($sub_stmt)" => @sub_bind],
2682 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2683 @bind = ('%son%', 10, 20)
2685 =head3 Deprecated usage of Literal SQL
2687 Below are some examples of archaic use of literal SQL. It is shown only as
2688 reference for those who deal with legacy code. Each example has a much
2689 better, cleaner and safer alternative that users should opt for in new code.
2695 my %where = ( requestor => \'IS NOT NULL' )
2697 $stmt = "WHERE requestor IS NOT NULL"
2699 This used to be the way of generating NULL comparisons, before the handling
2700 of C<undef> got formalized. For new code please use the superior syntax as
2701 described in L</Tests for NULL values>.
2705 my %where = ( requestor => \'= submitter' )
2707 $stmt = "WHERE requestor = submitter"
2709 This used to be the only way to compare columns. Use the superior L</-ident>
2710 method for all new code. For example an identifier declared in such a way
2711 will be properly quoted if L</quote_char> is properly set, while the legacy
2712 form will remain as supplied.
2716 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2718 $stmt = "WHERE completed > ? AND is_ready"
2719 @bind = ('2012-12-21')
2721 Using an empty string literal used to be the only way to express a boolean.
2722 For all new code please use the much more readable
2723 L<-bool|/Unary operators: bool> operator.
2729 These pages could go on for a while, since the nesting of the data
2730 structures this module can handle are pretty much unlimited (the
2731 module implements the C<WHERE> expansion as a recursive function
2732 internally). Your best bet is to "play around" with the module a
2733 little to see how the data structures behave, and choose the best
2734 format for your data based on that.
2736 And of course, all the values above will probably be replaced with
2737 variables gotten from forms or the command line. After all, if you
2738 knew everything ahead of time, you wouldn't have to worry about
2739 dynamically-generating SQL and could just hardwire it into your
2742 =head1 ORDER BY CLAUSES
2744 Some functions take an order by clause. This can either be a scalar (just a
2745 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2746 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2749 Given | Will Generate
2750 ---------------------------------------------------------------
2752 'colA' | ORDER BY colA
2754 [qw/colA colB/] | ORDER BY colA, colB
2756 {-asc => 'colA'} | ORDER BY colA ASC
2758 {-desc => 'colB'} | ORDER BY colB DESC
2760 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2762 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2764 \'colA DESC' | ORDER BY colA DESC
2766 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2767 | /* ...with $x bound to ? */
2770 { -asc => 'colA' }, | colA ASC,
2771 { -desc => [qw/colB/] }, | colB DESC,
2772 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2773 \'colE DESC', | colE DESC,
2774 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2775 ] | /* ...with $x bound to ? */
2776 ===============================================================
2780 =head1 SPECIAL OPERATORS
2782 my $sqlmaker = SQL::Abstract->new(special_ops => [
2786 my ($self, $field, $op, $arg) = @_;
2792 handler => 'method_name',
2796 A "special operator" is a SQL syntactic clause that can be
2797 applied to a field, instead of a usual binary operator.
2800 WHERE field IN (?, ?, ?)
2801 WHERE field BETWEEN ? AND ?
2802 WHERE MATCH(field) AGAINST (?, ?)
2804 Special operators IN and BETWEEN are fairly standard and therefore
2805 are builtin within C<SQL::Abstract> (as the overridable methods
2806 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2807 like the MATCH .. AGAINST example above which is specific to MySQL,
2808 you can write your own operator handlers - supply a C<special_ops>
2809 argument to the C<new> method. That argument takes an arrayref of
2810 operator definitions; each operator definition is a hashref with two
2817 the regular expression to match the operator
2821 Either a coderef or a plain scalar method name. In both cases
2822 the expected return is C<< ($sql, @bind) >>.
2824 When supplied with a method name, it is simply called on the
2825 L<SQL::Abstract> object as:
2827 $self->$method_name($field, $op, $arg)
2831 $field is the LHS of the operator
2832 $op is the part that matched the handler regex
2835 When supplied with a coderef, it is called as:
2837 $coderef->($self, $field, $op, $arg)
2842 For example, here is an implementation
2843 of the MATCH .. AGAINST syntax for MySQL
2845 my $sqlmaker = SQL::Abstract->new(special_ops => [
2847 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2848 {regex => qr/^match$/i,
2850 my ($self, $field, $op, $arg) = @_;
2851 $arg = [$arg] if not ref $arg;
2852 my $label = $self->_quote($field);
2853 my ($placeholder) = $self->_convert('?');
2854 my $placeholders = join ", ", (($placeholder) x @$arg);
2855 my $sql = $self->_sqlcase('match') . " ($label) "
2856 . $self->_sqlcase('against') . " ($placeholders) ";
2857 my @bind = $self->_bindtype($field, @$arg);
2858 return ($sql, @bind);
2865 =head1 UNARY OPERATORS
2867 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2871 my ($self, $op, $arg) = @_;
2877 handler => 'method_name',
2881 A "unary operator" is a SQL syntactic clause that can be
2882 applied to a field - the operator goes before the field
2884 You can write your own operator handlers - supply a C<unary_ops>
2885 argument to the C<new> method. That argument takes an arrayref of
2886 operator definitions; each operator definition is a hashref with two
2893 the regular expression to match the operator
2897 Either a coderef or a plain scalar method name. In both cases
2898 the expected return is C<< $sql >>.
2900 When supplied with a method name, it is simply called on the
2901 L<SQL::Abstract> object as:
2903 $self->$method_name($op, $arg)
2907 $op is the part that matched the handler regex
2908 $arg is the RHS or argument of the operator
2910 When supplied with a coderef, it is called as:
2912 $coderef->($self, $op, $arg)
2920 Thanks to some benchmarking by Mark Stosberg, it turns out that
2921 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2922 I must admit this wasn't an intentional design issue, but it's a
2923 byproduct of the fact that you get to control your C<DBI> handles
2926 To maximize performance, use a code snippet like the following:
2928 # prepare a statement handle using the first row
2929 # and then reuse it for the rest of the rows
2931 for my $href (@array_of_hashrefs) {
2932 $stmt ||= $sql->insert('table', $href);
2933 $sth ||= $dbh->prepare($stmt);
2934 $sth->execute($sql->values($href));
2937 The reason this works is because the keys in your C<$href> are sorted
2938 internally by B<SQL::Abstract>. Thus, as long as your data retains
2939 the same structure, you only have to generate the SQL the first time
2940 around. On subsequent queries, simply use the C<values> function provided
2941 by this module to return your values in the correct order.
2943 However this depends on the values having the same type - if, for
2944 example, the values of a where clause may either have values
2945 (resulting in sql of the form C<column = ?> with a single bind
2946 value), or alternatively the values might be C<undef> (resulting in
2947 sql of the form C<column IS NULL> with no bind value) then the
2948 caching technique suggested will not work.
2952 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2953 really like this part (I do, at least). Building up a complex query
2954 can be as simple as the following:
2961 use CGI::FormBuilder;
2964 my $form = CGI::FormBuilder->new(...);
2965 my $sql = SQL::Abstract->new;
2967 if ($form->submitted) {
2968 my $field = $form->field;
2969 my $id = delete $field->{id};
2970 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2973 Of course, you would still have to connect using C<DBI> to run the
2974 query, but the point is that if you make your form look like your
2975 table, the actual query script can be extremely simplistic.
2977 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2978 a fast interface to returning and formatting data. I frequently
2979 use these three modules together to write complex database query
2980 apps in under 50 lines.
2982 =head1 HOW TO CONTRIBUTE
2984 Contributions are always welcome, in all usable forms (we especially
2985 welcome documentation improvements). The delivery methods include git-
2986 or unified-diff formatted patches, GitHub pull requests, or plain bug
2987 reports either via RT or the Mailing list. Contributors are generally
2988 granted full access to the official repository after their first several
2989 patches pass successful review.
2991 This project is maintained in a git repository. The code and related tools are
2992 accessible at the following locations:
2996 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2998 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3000 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3002 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3008 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3009 Great care has been taken to preserve the I<published> behavior
3010 documented in previous versions in the 1.* family; however,
3011 some features that were previously undocumented, or behaved
3012 differently from the documentation, had to be changed in order
3013 to clarify the semantics. Hence, client code that was relying
3014 on some dark areas of C<SQL::Abstract> v1.*
3015 B<might behave differently> in v1.50.
3017 The main changes are:
3023 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3027 support for the { operator => \"..." } construct (to embed literal SQL)
3031 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3035 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3039 defensive programming: check arguments
3043 fixed bug with global logic, which was previously implemented
3044 through global variables yielding side-effects. Prior versions would
3045 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3046 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3047 Now this is interpreted
3048 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3053 fixed semantics of _bindtype on array args
3057 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3058 we just avoid shifting arrays within that tree.
3062 dropped the C<_modlogic> function
3066 =head1 ACKNOWLEDGEMENTS
3068 There are a number of individuals that have really helped out with
3069 this module. Unfortunately, most of them submitted bugs via CPAN
3070 so I have no idea who they are! But the people I do know are:
3072 Ash Berlin (order_by hash term support)
3073 Matt Trout (DBIx::Class support)
3074 Mark Stosberg (benchmarking)
3075 Chas Owens (initial "IN" operator support)
3076 Philip Collins (per-field SQL functions)
3077 Eric Kolve (hashref "AND" support)
3078 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3079 Dan Kubb (support for "quote_char" and "name_sep")
3080 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3081 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3082 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3083 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3084 Oliver Charles (support for "RETURNING" after "INSERT")
3090 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3094 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3096 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3098 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3099 While not an official support venue, C<DBIx::Class> makes heavy use of
3100 C<SQL::Abstract>, and as such list members there are very familiar with
3101 how to create queries.
3105 This module is free software; you may copy this under the same
3106 terms as perl itself (either the GNU General Public License or
3107 the Artistic License)