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.87';
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);
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 $self->_expand_ident(-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 ($k eq '-ident') {
666 return $self->_expand_ident(-ident => $v);
668 if (my $custom = $self->{expand_unary}{$k}) {
669 return $self->$custom($v);
671 if ($self->{render}{$k}) {
677 and (keys %$v)[0] =~ /^-/
679 my ($func) = $k =~ /^-(.*)$/;
680 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
681 return +{ -op => [ $func, $self->_expand_expr($v) ] };
683 return +{ -func => [ $func, $self->_expand_expr($v) ] };
685 if (!ref($v) or is_literal_value($v)) {
686 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
693 and exists $v->{-value}
694 and not defined $v->{-value}
697 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
699 if (!ref($v) or Scalar::Util::blessed($v)) {
700 my $d = our $Default_Scalar_To;
704 $self->_expand_ident(-ident => $k),
706 ? $self->_expand_expr($d => $v)
707 : { -bind => [ $k, $v ] }
712 if (ref($v) eq 'HASH') {
716 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
720 return undef unless keys %$v;
724 $self->_assert_pass_injection_guard($vk);
725 if ($vk =~ s/ [_\s]? \d+ $//x ) {
726 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
727 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
729 if ($vk =~ /^(?:not[ _])?between$/) {
730 local our $Cur_Col_Meta = $k;
731 my @rhs = map $self->_expand_expr($_),
732 ref($vv) eq 'ARRAY' ? @$vv : $vv;
734 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
736 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
738 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
741 join(' ', split '_', $vk),
742 $self->_expand_ident(-ident => $k),
746 if ($vk =~ /^(?:not[ _])?in$/) {
747 if (my $literal = is_literal_value($vv)) {
748 my ($sql, @bind) = @$literal;
749 my $opened_sql = $self->_open_outer_paren($sql);
751 $vk, $self->_expand_ident(-ident => $k),
752 [ { -literal => [ $opened_sql, @bind ] } ]
756 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
757 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
758 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
759 . 'will emit the logically correct SQL instead of raising this exception)'
761 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
763 my @rhs = map $self->_expand_expr($_),
764 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
765 map { defined($_) ? $_: puke($undef_err) }
766 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
767 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
770 join(' ', split '_', $vk),
771 $self->_expand_ident(-ident => $k),
775 if ($vk eq 'ident') {
776 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
777 puke "-$vk requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
781 $self->_expand_ident(-ident => $k),
782 $self->_expand_ident(-ident => $vv),
785 if ($vk eq 'value') {
786 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
789 $self->_expand_ident(-ident => $k),
790 { -bind => [ $k, $vv ] }
793 if ($vk =~ /^is(?:[ _]not)?$/) {
794 puke "$vk can only take undef as argument"
798 and exists($vv->{-value})
799 and !defined($vv->{-value})
802 return +{ -op => [ $vk.' null', $self->_expand_ident(-ident => $k) ] };
804 if ($vk =~ /^(and|or)$/) {
805 if (ref($vv) eq 'HASH') {
808 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
813 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{special_ops}}) {
814 return { -op => [ $vk, $self->_expand_ident(-ident => $k), $vv ] };
816 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{unary_ops}}) {
819 $self->_expand_ident(-ident => $k),
820 { -op => [ $vk, $vv ] }
823 if (ref($vv) eq 'ARRAY') {
824 my ($logic, @values) = (
825 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
830 $vk =~ $self->{inequality_op}
831 or join(' ', split '_', $vk) =~ $self->{not_like_op}
833 if (lc($logic) eq '-or' and @values > 1) {
834 my $op = uc join ' ', split '_', $vk;
835 belch "A multi-element arrayref as an argument to the inequality op '$op' "
836 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
837 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
842 # try to DWIM on equality operators
843 my $op = join ' ', split '_', $vk;
845 $op =~ $self->{equality_op} ? $self->sqlfalse
846 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
847 : $op =~ $self->{inequality_op} ? $self->sqltrue
848 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
849 : puke "operator '$op' applied on an empty array (field '$k')";
853 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
861 and exists $vv->{-value}
862 and not defined $vv->{-value}
865 my $op = join ' ', split '_', $vk;
867 $op =~ /^not$/i ? 'is not' # legacy
868 : $op =~ $self->{equality_op} ? 'is'
869 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
870 : $op =~ $self->{inequality_op} ? 'is not'
871 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
872 : puke "unexpected operator '$op' with undef operand";
873 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
875 local our $Cur_Col_Meta = $k;
878 $self->_expand_ident(-ident => $k),
879 $self->_expand_expr($vv)
882 if (ref($v) eq 'ARRAY') {
883 return $self->sqlfalse unless @$v;
884 $self->_debug("ARRAY($k) means distribute over elements");
886 $v->[0] =~ /^-((?:and|or))$/i
887 ? ($v = [ @{$v}[1..$#$v] ], $1)
888 : ($self->{logic} || 'or')
892 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
895 if (my $literal = is_literal_value($v)) {
897 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
900 my ($sql, @bind) = @$literal;
901 if ($self->{bindtype} eq 'columns') {
903 $self->_assert_bindval_matches_bindtype($_);
906 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
912 my ($self, undef, $body) = @_;
913 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
914 ref($body) ? @$body : $body;
915 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
916 unless ($self->{quote_char}) {
917 $self->_assert_pass_injection_guard($_) for @parts;
919 return +{ -ident => \@parts };
923 my ($self, $where, $logic) = @_;
925 # Special case: top level simple string treated as literal
927 my $where_exp = (ref($where)
928 ? $self->_expand_expr($where, $logic)
929 : { -literal => [ $where ] });
931 # dispatch expanded expression
933 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
934 # DBIx::Class used to call _recurse_where in scalar context
935 # something else might too...
937 return ($sql, @bind);
940 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
946 my ($self, $ident) = @_;
948 return $self->_convert($self->_quote($ident));
951 my %unop_postfix = map +($_ => 1),
952 'is null', 'is not null',
960 my ($self, $args) = @_;
961 my ($left, $low, $high) = @$args;
962 my ($rhsql, @rhbind) = do {
964 puke "Single arg to between must be a literal"
965 unless $low->{-literal};
968 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
969 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
970 @{$l}[1..$#$l], @{$h}[1..$#$h])
973 my ($lhsql, @lhbind) = $self->render_aqt($left);
975 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
979 }), 'between', 'not between'),
983 my ($self, $args) = @_;
984 my ($lhs, $rhs) = @$args;
987 my ($sql, @bind) = $self->render_aqt($_);
988 push @in_bind, @bind;
991 my ($lhsql, @lbind) = $self->render_aqt($lhs);
993 $lhsql.' '.$self->_sqlcase($op).' ( '
1003 my ($self, $v) = @_;
1004 my ($op, @args) = @$v;
1005 $op =~ s/^-// if length($op) > 1;
1007 if (my $h = $special{$op}) {
1008 return $self->$h(\@args);
1010 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1011 if ($us and @args > 1) {
1012 puke "Special op '${op}' requires first value to be identifier"
1013 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1014 my $k = join(($self->{name_sep}||'.'), @$ident);
1015 local our $Expand_Depth = 1;
1016 return $self->${\($us->{handler})}($k, $op, $args[1]);
1018 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1019 return $self->${\($us->{handler})}($op, $args[0]);
1021 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1022 if (@args == 1 and $op !~ /^(and|or)$/) {
1023 my ($expr_sql, @bind) = $self->render_aqt($args[0]);
1024 my $op_sql = $self->_sqlcase($final_op);
1026 $unop_postfix{lc($final_op)}
1027 ? "${expr_sql} ${op_sql}"
1028 : "${op_sql} ${expr_sql}"
1030 return (($op eq 'not' || $us ? '('.$final_sql.')' : $final_sql), @bind);
1032 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1033 return '' unless @parts;
1034 my $is_andor = !!($op =~ /^(and|or)$/);
1035 return @{$parts[0]} if $is_andor and @parts == 1;
1036 my ($final_sql) = map +($is_andor ? "( ${_} )" : $_), join(
1037 ' '.$self->_sqlcase($final_op).' ',
1042 map @{$_}[1..$#$_], @parts
1049 my ($self, $list) = @_;
1050 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1051 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1055 my ($self, $rest) = @_;
1056 my ($func, @args) = @$rest;
1060 push @arg_sql, shift @x;
1062 } map [ $self->render_aqt($_) ], @args;
1063 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1067 my ($self, $bind) = @_;
1068 return ($self->_convert('?'), $self->_bindtype(@$bind));
1071 sub _render_literal {
1072 my ($self, $literal) = @_;
1073 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1077 # Some databases (SQLite) treat col IN (1, 2) different from
1078 # col IN ( (1, 2) ). Use this to strip all outer parens while
1079 # adding them back in the corresponding method
1080 sub _open_outer_paren {
1081 my ($self, $sql) = @_;
1083 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1085 # there are closing parens inside, need the heavy duty machinery
1086 # to reevaluate the extraction starting from $sql (full reevaluation)
1087 if ($inner =~ /\)/) {
1088 require Text::Balanced;
1090 my (undef, $remainder) = do {
1091 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1093 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1096 # the entire expression needs to be a balanced bracketed thing
1097 # (after an extract no remainder sans trailing space)
1098 last if defined $remainder and $remainder =~ /\S/;
1108 #======================================================================
1110 #======================================================================
1112 sub _expand_order_by {
1113 my ($self, $arg) = @_;
1115 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1117 my $expander = sub {
1118 my ($self, $dir, $expr) = @_;
1119 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1120 foreach my $arg (@to_expand) {
1124 and grep /^-(asc|desc)$/, keys %$arg
1126 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1129 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1130 map $self->expand_expr($_, -ident),
1131 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1132 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1135 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1136 sub { shift->$expander(asc => @_) },
1137 sub { shift->$expander(desc => @_) },
1140 return $self->$expander(undef, $arg);
1144 my ($self, $arg) = @_;
1146 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1148 my ($sql, @bind) = $self->render_aqt($expanded);
1150 return '' unless length($sql);
1152 my $final_sql = $self->_sqlcase(' order by ').$sql;
1154 return wantarray ? ($final_sql, @bind) : $final_sql;
1157 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1159 sub _order_by_chunks {
1160 my ($self, $arg) = @_;
1162 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1164 return $self->_chunkify_order_by($expanded);
1167 sub _chunkify_order_by {
1168 my ($self, $expanded) = @_;
1170 return grep length, $self->render_aqt($expanded)
1171 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1174 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1175 return map $self->_chunkify_order_by($_), @$l;
1177 return [ $self->render_aqt($_) ];
1181 #======================================================================
1182 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1183 #======================================================================
1189 $self->_expand_maybe_list_expr($from, undef, -ident)
1194 #======================================================================
1196 #======================================================================
1198 sub _expand_maybe_list_expr {
1199 my ($self, $expr, $logic, $default) = @_;
1201 if (ref($expr) eq 'ARRAY') {
1203 map $self->expand_expr($_, $default), @$expr
1210 return $self->expand_expr($e, $default);
1213 # highly optimized, as it's called way too often
1215 # my ($self, $label) = @_;
1217 return '' unless defined $_[1];
1218 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1219 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1221 unless ($_[0]->{quote_char}) {
1222 if (ref($_[1]) eq 'ARRAY') {
1223 return join($_[0]->{name_sep}||'.', @{$_[1]});
1225 $_[0]->_assert_pass_injection_guard($_[1]);
1230 my $qref = ref $_[0]->{quote_char};
1232 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1233 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1234 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1236 my $esc = $_[0]->{escape_char} || $r;
1238 # parts containing * are naturally unquoted
1240 $_[0]->{name_sep}||'',
1244 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1246 (ref($_[1]) eq 'ARRAY'
1250 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1258 # Conversion, if applicable
1260 #my ($self, $arg) = @_;
1261 if ($_[0]->{convert_where}) {
1262 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1269 #my ($self, $col, @vals) = @_;
1270 # called often - tighten code
1271 return $_[0]->{bindtype} eq 'columns'
1272 ? map {[$_[1], $_]} @_[2 .. $#_]
1277 # Dies if any element of @bind is not in [colname => value] format
1278 # if bindtype is 'columns'.
1279 sub _assert_bindval_matches_bindtype {
1280 # my ($self, @bind) = @_;
1282 if ($self->{bindtype} eq 'columns') {
1284 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1285 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1291 sub _join_sql_clauses {
1292 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1294 if (@$clauses_aref > 1) {
1295 my $join = " " . $self->_sqlcase($logic) . " ";
1296 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1297 return ($sql, @$bind_aref);
1299 elsif (@$clauses_aref) {
1300 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1303 return (); # if no SQL, ignore @$bind_aref
1308 # Fix SQL case, if so requested
1310 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1311 # don't touch the argument ... crooked logic, but let's not change it!
1312 return $_[0]->{case} ? $_[1] : uc($_[1]);
1316 #======================================================================
1317 # DISPATCHING FROM REFKIND
1318 #======================================================================
1321 my ($self, $data) = @_;
1323 return 'UNDEF' unless defined $data;
1325 # blessed objects are treated like scalars
1326 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1328 return 'SCALAR' unless $ref;
1331 while ($ref eq 'REF') {
1333 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1337 return ($ref||'SCALAR') . ('REF' x $n_steps);
1341 my ($self, $data) = @_;
1342 my @try = ($self->_refkind($data));
1343 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1344 push @try, 'FALLBACK';
1348 sub _METHOD_FOR_refkind {
1349 my ($self, $meth_prefix, $data) = @_;
1352 for (@{$self->_try_refkind($data)}) {
1353 $method = $self->can($meth_prefix."_".$_)
1357 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1361 sub _SWITCH_refkind {
1362 my ($self, $data, $dispatch_table) = @_;
1365 for (@{$self->_try_refkind($data)}) {
1366 $coderef = $dispatch_table->{$_}
1370 puke "no dispatch entry for ".$self->_refkind($data)
1379 #======================================================================
1380 # VALUES, GENERATE, AUTOLOAD
1381 #======================================================================
1383 # LDNOTE: original code from nwiger, didn't touch code in that section
1384 # I feel the AUTOLOAD stuff should not be the default, it should
1385 # only be activated on explicit demand by user.
1389 my $data = shift || return;
1390 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1391 unless ref $data eq 'HASH';
1394 foreach my $k (sort keys %$data) {
1395 my $v = $data->{$k};
1396 $self->_SWITCH_refkind($v, {
1398 if ($self->{array_datatypes}) { # array datatype
1399 push @all_bind, $self->_bindtype($k, $v);
1401 else { # literal SQL with bind
1402 my ($sql, @bind) = @$v;
1403 $self->_assert_bindval_matches_bindtype(@bind);
1404 push @all_bind, @bind;
1407 ARRAYREFREF => sub { # literal SQL with bind
1408 my ($sql, @bind) = @${$v};
1409 $self->_assert_bindval_matches_bindtype(@bind);
1410 push @all_bind, @bind;
1412 SCALARREF => sub { # literal SQL without bind
1414 SCALAR_or_UNDEF => sub {
1415 push @all_bind, $self->_bindtype($k, $v);
1426 my(@sql, @sqlq, @sqlv);
1430 if ($ref eq 'HASH') {
1431 for my $k (sort keys %$_) {
1434 my $label = $self->_quote($k);
1435 if ($r eq 'ARRAY') {
1436 # literal SQL with bind
1437 my ($sql, @bind) = @$v;
1438 $self->_assert_bindval_matches_bindtype(@bind);
1439 push @sqlq, "$label = $sql";
1441 } elsif ($r eq 'SCALAR') {
1442 # literal SQL without bind
1443 push @sqlq, "$label = $$v";
1445 push @sqlq, "$label = ?";
1446 push @sqlv, $self->_bindtype($k, $v);
1449 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1450 } elsif ($ref eq 'ARRAY') {
1451 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1454 if ($r eq 'ARRAY') { # literal SQL with bind
1455 my ($sql, @bind) = @$v;
1456 $self->_assert_bindval_matches_bindtype(@bind);
1459 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1460 # embedded literal SQL
1467 push @sql, '(' . join(', ', @sqlq) . ')';
1468 } elsif ($ref eq 'SCALAR') {
1472 # strings get case twiddled
1473 push @sql, $self->_sqlcase($_);
1477 my $sql = join ' ', @sql;
1479 # this is pretty tricky
1480 # if ask for an array, return ($stmt, @bind)
1481 # otherwise, s/?/shift @sqlv/ to put it inline
1483 return ($sql, @sqlv);
1485 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1486 ref $d ? $d->[1] : $d/e;
1495 # This allows us to check for a local, then _form, attr
1497 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1498 return $self->generate($name, @_);
1509 SQL::Abstract - Generate SQL from Perl data structures
1515 my $sql = SQL::Abstract->new;
1517 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1519 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1521 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1523 my($stmt, @bind) = $sql->delete($table, \%where);
1525 # Then, use these in your DBI statements
1526 my $sth = $dbh->prepare($stmt);
1527 $sth->execute(@bind);
1529 # Just generate the WHERE clause
1530 my($stmt, @bind) = $sql->where(\%where, $order);
1532 # Return values in the same order, for hashed queries
1533 # See PERFORMANCE section for more details
1534 my @bind = $sql->values(\%fieldvals);
1538 This module was inspired by the excellent L<DBIx::Abstract>.
1539 However, in using that module I found that what I really wanted
1540 to do was generate SQL, but still retain complete control over my
1541 statement handles and use the DBI interface. So, I set out to
1542 create an abstract SQL generation module.
1544 While based on the concepts used by L<DBIx::Abstract>, there are
1545 several important differences, especially when it comes to WHERE
1546 clauses. I have modified the concepts used to make the SQL easier
1547 to generate from Perl data structures and, IMO, more intuitive.
1548 The underlying idea is for this module to do what you mean, based
1549 on the data structures you provide it. The big advantage is that
1550 you don't have to modify your code every time your data changes,
1551 as this module figures it out.
1553 To begin with, an SQL INSERT is as easy as just specifying a hash
1554 of C<key=value> pairs:
1557 name => 'Jimbo Bobson',
1558 phone => '123-456-7890',
1559 address => '42 Sister Lane',
1560 city => 'St. Louis',
1561 state => 'Louisiana',
1564 The SQL can then be generated with this:
1566 my($stmt, @bind) = $sql->insert('people', \%data);
1568 Which would give you something like this:
1570 $stmt = "INSERT INTO people
1571 (address, city, name, phone, state)
1572 VALUES (?, ?, ?, ?, ?)";
1573 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1574 '123-456-7890', 'Louisiana');
1576 These are then used directly in your DBI code:
1578 my $sth = $dbh->prepare($stmt);
1579 $sth->execute(@bind);
1581 =head2 Inserting and Updating Arrays
1583 If your database has array types (like for example Postgres),
1584 activate the special option C<< array_datatypes => 1 >>
1585 when creating the C<SQL::Abstract> object.
1586 Then you may use an arrayref to insert and update database array types:
1588 my $sql = SQL::Abstract->new(array_datatypes => 1);
1590 planets => [qw/Mercury Venus Earth Mars/]
1593 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1597 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1599 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1602 =head2 Inserting and Updating SQL
1604 In order to apply SQL functions to elements of your C<%data> you may
1605 specify a reference to an arrayref for the given hash value. For example,
1606 if you need to execute the Oracle C<to_date> function on a value, you can
1607 say something like this:
1611 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1614 The first value in the array is the actual SQL. Any other values are
1615 optional and would be included in the bind values array. This gives
1618 my($stmt, @bind) = $sql->insert('people', \%data);
1620 $stmt = "INSERT INTO people (name, date_entered)
1621 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1622 @bind = ('Bill', '03/02/2003');
1624 An UPDATE is just as easy, all you change is the name of the function:
1626 my($stmt, @bind) = $sql->update('people', \%data);
1628 Notice that your C<%data> isn't touched; the module will generate
1629 the appropriately quirky SQL for you automatically. Usually you'll
1630 want to specify a WHERE clause for your UPDATE, though, which is
1631 where handling C<%where> hashes comes in handy...
1633 =head2 Complex where statements
1635 This module can generate pretty complicated WHERE statements
1636 easily. For example, simple C<key=value> pairs are taken to mean
1637 equality, and if you want to see if a field is within a set
1638 of values, you can use an arrayref. Let's say we wanted to
1639 SELECT some data based on this criteria:
1642 requestor => 'inna',
1643 worker => ['nwiger', 'rcwe', 'sfz'],
1644 status => { '!=', 'completed' }
1647 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1649 The above would give you something like this:
1651 $stmt = "SELECT * FROM tickets WHERE
1652 ( requestor = ? ) AND ( status != ? )
1653 AND ( worker = ? OR worker = ? OR worker = ? )";
1654 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1656 Which you could then use in DBI code like so:
1658 my $sth = $dbh->prepare($stmt);
1659 $sth->execute(@bind);
1665 The methods are simple. There's one for every major SQL operation,
1666 and a constructor you use first. The arguments are specified in a
1667 similar order for each method (table, then fields, then a where
1668 clause) to try and simplify things.
1670 =head2 new(option => 'value')
1672 The C<new()> function takes a list of options and values, and returns
1673 a new B<SQL::Abstract> object which can then be used to generate SQL
1674 through the methods below. The options accepted are:
1680 If set to 'lower', then SQL will be generated in all lowercase. By
1681 default SQL is generated in "textbook" case meaning something like:
1683 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1685 Any setting other than 'lower' is ignored.
1689 This determines what the default comparison operator is. By default
1690 it is C<=>, meaning that a hash like this:
1692 %where = (name => 'nwiger', email => 'nate@wiger.org');
1694 Will generate SQL like this:
1696 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1698 However, you may want loose comparisons by default, so if you set
1699 C<cmp> to C<like> you would get SQL such as:
1701 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1703 You can also override the comparison on an individual basis - see
1704 the huge section on L</"WHERE CLAUSES"> at the bottom.
1706 =item sqltrue, sqlfalse
1708 Expressions for inserting boolean values within SQL statements.
1709 By default these are C<1=1> and C<1=0>. They are used
1710 by the special operators C<-in> and C<-not_in> for generating
1711 correct SQL even when the argument is an empty array (see below).
1715 This determines the default logical operator for multiple WHERE
1716 statements in arrays or hashes. If absent, the default logic is "or"
1717 for arrays, and "and" for hashes. This means that a WHERE
1721 event_date => {'>=', '2/13/99'},
1722 event_date => {'<=', '4/24/03'},
1725 will generate SQL like this:
1727 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1729 This is probably not what you want given this query, though (look
1730 at the dates). To change the "OR" to an "AND", simply specify:
1732 my $sql = SQL::Abstract->new(logic => 'and');
1734 Which will change the above C<WHERE> to:
1736 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1738 The logic can also be changed locally by inserting
1739 a modifier in front of an arrayref:
1741 @where = (-and => [event_date => {'>=', '2/13/99'},
1742 event_date => {'<=', '4/24/03'} ]);
1744 See the L</"WHERE CLAUSES"> section for explanations.
1748 This will automatically convert comparisons using the specified SQL
1749 function for both column and value. This is mostly used with an argument
1750 of C<upper> or C<lower>, so that the SQL will have the effect of
1751 case-insensitive "searches". For example, this:
1753 $sql = SQL::Abstract->new(convert => 'upper');
1754 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1756 Will turn out the following SQL:
1758 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1760 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1761 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1762 not validate this option; it will just pass through what you specify verbatim).
1766 This is a kludge because many databases suck. For example, you can't
1767 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1768 Instead, you have to use C<bind_param()>:
1770 $sth->bind_param(1, 'reg data');
1771 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1773 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1774 which loses track of which field each slot refers to. Fear not.
1776 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1777 Currently, you can specify either C<normal> (default) or C<columns>. If you
1778 specify C<columns>, you will get an array that looks like this:
1780 my $sql = SQL::Abstract->new(bindtype => 'columns');
1781 my($stmt, @bind) = $sql->insert(...);
1784 [ 'column1', 'value1' ],
1785 [ 'column2', 'value2' ],
1786 [ 'column3', 'value3' ],
1789 You can then iterate through this manually, using DBI's C<bind_param()>.
1791 $sth->prepare($stmt);
1794 my($col, $data) = @$_;
1795 if ($col eq 'details' || $col eq 'comments') {
1796 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1797 } elsif ($col eq 'image') {
1798 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1800 $sth->bind_param($i, $data);
1804 $sth->execute; # execute without @bind now
1806 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1807 Basically, the advantage is still that you don't have to care which fields
1808 are or are not included. You could wrap that above C<for> loop in a simple
1809 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1810 get a layer of abstraction over manual SQL specification.
1812 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1813 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1814 will expect the bind values in this format.
1818 This is the character that a table or column name will be quoted
1819 with. By default this is an empty string, but you could set it to
1820 the character C<`>, to generate SQL like this:
1822 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1824 Alternatively, you can supply an array ref of two items, the first being the left
1825 hand quote character, and the second the right hand quote character. For
1826 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1827 that generates SQL like this:
1829 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1831 Quoting is useful if you have tables or columns names that are reserved
1832 words in your database's SQL dialect.
1836 This is the character that will be used to escape L</quote_char>s appearing
1837 in an identifier before it has been quoted.
1839 The parameter default in case of a single L</quote_char> character is the quote
1842 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1843 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1844 of the B<opening (left)> L</quote_char> within the identifier are currently left
1845 untouched. The default for opening-closing-style quotes may change in future
1846 versions, thus you are B<strongly encouraged> to specify the escape character
1851 This is the character that separates a table and column name. It is
1852 necessary to specify this when the C<quote_char> option is selected,
1853 so that tables and column names can be individually quoted like this:
1855 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1857 =item injection_guard
1859 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1860 column name specified in a query structure. This is a safety mechanism to avoid
1861 injection attacks when mishandling user input e.g.:
1863 my %condition_as_column_value_pairs = get_values_from_user();
1864 $sqla->select( ... , \%condition_as_column_value_pairs );
1866 If the expression matches an exception is thrown. Note that literal SQL
1867 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1869 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1871 =item array_datatypes
1873 When this option is true, arrayrefs in INSERT or UPDATE are
1874 interpreted as array datatypes and are passed directly
1876 When this option is false, arrayrefs are interpreted
1877 as literal SQL, just like refs to arrayrefs
1878 (but this behavior is for backwards compatibility; when writing
1879 new queries, use the "reference to arrayref" syntax
1885 Takes a reference to a list of "special operators"
1886 to extend the syntax understood by L<SQL::Abstract>.
1887 See section L</"SPECIAL OPERATORS"> for details.
1891 Takes a reference to a list of "unary operators"
1892 to extend the syntax understood by L<SQL::Abstract>.
1893 See section L</"UNARY OPERATORS"> for details.
1899 =head2 insert($table, \@values || \%fieldvals, \%options)
1901 This is the simplest function. You simply give it a table name
1902 and either an arrayref of values or hashref of field/value pairs.
1903 It returns an SQL INSERT statement and a list of bind values.
1904 See the sections on L</"Inserting and Updating Arrays"> and
1905 L</"Inserting and Updating SQL"> for information on how to insert
1906 with those data types.
1908 The optional C<\%options> hash reference may contain additional
1909 options to generate the insert SQL. Currently supported options
1916 Takes either a scalar of raw SQL fields, or an array reference of
1917 field names, and adds on an SQL C<RETURNING> statement at the end.
1918 This allows you to return data generated by the insert statement
1919 (such as row IDs) without performing another C<SELECT> statement.
1920 Note, however, this is not part of the SQL standard and may not
1921 be supported by all database engines.
1925 =head2 update($table, \%fieldvals, \%where, \%options)
1927 This takes a table, hashref of field/value pairs, and an optional
1928 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1930 See the sections on L</"Inserting and Updating Arrays"> and
1931 L</"Inserting and Updating SQL"> for information on how to insert
1932 with those data types.
1934 The optional C<\%options> hash reference may contain additional
1935 options to generate the update SQL. Currently supported options
1942 See the C<returning> option to
1943 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1947 =head2 select($source, $fields, $where, $order)
1949 This returns a SQL SELECT statement and associated list of bind values, as
1950 specified by the arguments:
1956 Specification of the 'FROM' part of the statement.
1957 The argument can be either a plain scalar (interpreted as a table
1958 name, will be quoted), or an arrayref (interpreted as a list
1959 of table names, joined by commas, quoted), or a scalarref
1960 (literal SQL, not quoted).
1964 Specification of the list of fields to retrieve from
1966 The argument can be either an arrayref (interpreted as a list
1967 of field names, will be joined by commas and quoted), or a
1968 plain scalar (literal SQL, not quoted).
1969 Please observe that this API is not as flexible as that of
1970 the first argument C<$source>, for backwards compatibility reasons.
1974 Optional argument to specify the WHERE part of the query.
1975 The argument is most often a hashref, but can also be
1976 an arrayref or plain scalar --
1977 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1981 Optional argument to specify the ORDER BY part of the query.
1982 The argument can be a scalar, a hashref or an arrayref
1983 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1989 =head2 delete($table, \%where, \%options)
1991 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1992 It returns an SQL DELETE statement and list of bind values.
1994 The optional C<\%options> hash reference may contain additional
1995 options to generate the delete SQL. Currently supported options
2002 See the C<returning> option to
2003 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2007 =head2 where(\%where, $order)
2009 This is used to generate just the WHERE clause. For example,
2010 if you have an arbitrary data structure and know what the
2011 rest of your SQL is going to look like, but want an easy way
2012 to produce a WHERE clause, use this. It returns an SQL WHERE
2013 clause and list of bind values.
2016 =head2 values(\%data)
2018 This just returns the values from the hash C<%data>, in the same
2019 order that would be returned from any of the other above queries.
2020 Using this allows you to markedly speed up your queries if you
2021 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2023 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2025 Warning: This is an experimental method and subject to change.
2027 This returns arbitrarily generated SQL. It's a really basic shortcut.
2028 It will return two different things, depending on return context:
2030 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2031 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2033 These would return the following:
2035 # First calling form
2036 $stmt = "CREATE TABLE test (?, ?)";
2037 @bind = (field1, field2);
2039 # Second calling form
2040 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2042 Depending on what you're trying to do, it's up to you to choose the correct
2043 format. In this example, the second form is what you would want.
2047 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2051 ALTER SESSION SET nls_date_format = 'MM/YY'
2053 You get the idea. Strings get their case twiddled, but everything
2054 else remains verbatim.
2056 =head1 EXPORTABLE FUNCTIONS
2058 =head2 is_plain_value
2060 Determines if the supplied argument is a plain value as understood by this
2065 =item * The value is C<undef>
2067 =item * The value is a non-reference
2069 =item * The value is an object with stringification overloading
2071 =item * The value is of the form C<< { -value => $anything } >>
2075 On failure returns C<undef>, on success returns a B<scalar> reference
2076 to the original supplied argument.
2082 The stringification overloading detection is rather advanced: it takes
2083 into consideration not only the presence of a C<""> overload, but if that
2084 fails also checks for enabled
2085 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2086 on either C<0+> or C<bool>.
2088 Unfortunately testing in the field indicates that this
2089 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2090 but only when very large numbers of stringifying objects are involved.
2091 At the time of writing ( Sep 2014 ) there is no clear explanation of
2092 the direct cause, nor is there a manageably small test case that reliably
2093 reproduces the problem.
2095 If you encounter any of the following exceptions in B<random places within
2096 your application stack> - this module may be to blame:
2098 Operation "ne": no method found,
2099 left argument in overloaded package <something>,
2100 right argument in overloaded package <something>
2104 Stub found while resolving method "???" overloading """" in package <something>
2106 If you fall victim to the above - please attempt to reduce the problem
2107 to something that could be sent to the L<SQL::Abstract developers
2108 |DBIx::Class/GETTING HELP/SUPPORT>
2109 (either publicly or privately). As a workaround in the meantime you can
2110 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2111 value, which will most likely eliminate your problem (at the expense of
2112 not being able to properly detect exotic forms of stringification).
2114 This notice and environment variable will be removed in a future version,
2115 as soon as the underlying problem is found and a reliable workaround is
2120 =head2 is_literal_value
2122 Determines if the supplied argument is a literal value as understood by this
2127 =item * C<\$sql_string>
2129 =item * C<\[ $sql_string, @bind_values ]>
2133 On failure returns C<undef>, on success returns an B<array> reference
2134 containing the unpacked version of the supplied literal SQL and bind values.
2136 =head1 WHERE CLAUSES
2140 This module uses a variation on the idea from L<DBIx::Abstract>. It
2141 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2142 module is that things in arrays are OR'ed, and things in hashes
2145 The easiest way to explain is to show lots of examples. After
2146 each C<%where> hash shown, it is assumed you used:
2148 my($stmt, @bind) = $sql->where(\%where);
2150 However, note that the C<%where> hash can be used directly in any
2151 of the other functions as well, as described above.
2153 =head2 Key-value pairs
2155 So, let's get started. To begin, a simple hash:
2159 status => 'completed'
2162 Is converted to SQL C<key = val> statements:
2164 $stmt = "WHERE user = ? AND status = ?";
2165 @bind = ('nwiger', 'completed');
2167 One common thing I end up doing is having a list of values that
2168 a field can be in. To do this, simply specify a list inside of
2173 status => ['assigned', 'in-progress', 'pending'];
2176 This simple code will create the following:
2178 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2179 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2181 A field associated to an empty arrayref will be considered a
2182 logical false and will generate 0=1.
2184 =head2 Tests for NULL values
2186 If the value part is C<undef> then this is converted to SQL <IS NULL>
2195 $stmt = "WHERE user = ? AND status IS NULL";
2198 To test if a column IS NOT NULL:
2202 status => { '!=', undef },
2205 =head2 Specific comparison operators
2207 If you want to specify a different type of operator for your comparison,
2208 you can use a hashref for a given column:
2212 status => { '!=', 'completed' }
2215 Which would generate:
2217 $stmt = "WHERE user = ? AND status != ?";
2218 @bind = ('nwiger', 'completed');
2220 To test against multiple values, just enclose the values in an arrayref:
2222 status => { '=', ['assigned', 'in-progress', 'pending'] };
2224 Which would give you:
2226 "WHERE status = ? OR status = ? OR status = ?"
2229 The hashref can also contain multiple pairs, in which case it is expanded
2230 into an C<AND> of its elements:
2234 status => { '!=', 'completed', -not_like => 'pending%' }
2237 # Or more dynamically, like from a form
2238 $where{user} = 'nwiger';
2239 $where{status}{'!='} = 'completed';
2240 $where{status}{'-not_like'} = 'pending%';
2242 # Both generate this
2243 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2244 @bind = ('nwiger', 'completed', 'pending%');
2247 To get an OR instead, you can combine it with the arrayref idea:
2251 priority => [ { '=', 2 }, { '>', 5 } ]
2254 Which would generate:
2256 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2257 @bind = ('2', '5', 'nwiger');
2259 If you want to include literal SQL (with or without bind values), just use a
2260 scalar reference or reference to an arrayref as the value:
2263 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2264 date_expires => { '<' => \"now()" }
2267 Which would generate:
2269 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2270 @bind = ('11/26/2008');
2273 =head2 Logic and nesting operators
2275 In the example above,
2276 there is a subtle trap if you want to say something like
2277 this (notice the C<AND>):
2279 WHERE priority != ? AND priority != ?
2281 Because, in Perl you I<can't> do this:
2283 priority => { '!=' => 2, '!=' => 1 }
2285 As the second C<!=> key will obliterate the first. The solution
2286 is to use the special C<-modifier> form inside an arrayref:
2288 priority => [ -and => {'!=', 2},
2292 Normally, these would be joined by C<OR>, but the modifier tells it
2293 to use C<AND> instead. (Hint: You can use this in conjunction with the
2294 C<logic> option to C<new()> in order to change the way your queries
2295 work by default.) B<Important:> Note that the C<-modifier> goes
2296 B<INSIDE> the arrayref, as an extra first element. This will
2297 B<NOT> do what you think it might:
2299 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2301 Here is a quick list of equivalencies, since there is some overlap:
2304 status => {'!=', 'completed', 'not like', 'pending%' }
2305 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2308 status => {'=', ['assigned', 'in-progress']}
2309 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2310 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2314 =head2 Special operators: IN, BETWEEN, etc.
2316 You can also use the hashref format to compare a list of fields using the
2317 C<IN> comparison operator, by specifying the list as an arrayref:
2320 status => 'completed',
2321 reportid => { -in => [567, 2335, 2] }
2324 Which would generate:
2326 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2327 @bind = ('completed', '567', '2335', '2');
2329 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2332 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2333 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2334 'sqltrue' (by default: C<1=1>).
2336 In addition to the array you can supply a chunk of literal sql or
2337 literal sql with bind:
2340 customer => { -in => \[
2341 'SELECT cust_id FROM cust WHERE balance > ?',
2344 status => { -in => \'SELECT status_codes FROM states' },
2350 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2351 AND status IN ( SELECT status_codes FROM states )
2355 Finally, if the argument to C<-in> is not a reference, it will be
2356 treated as a single-element array.
2358 Another pair of operators is C<-between> and C<-not_between>,
2359 used with an arrayref of two values:
2363 completion_date => {
2364 -not_between => ['2002-10-01', '2003-02-06']
2370 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2372 Just like with C<-in> all plausible combinations of literal SQL
2376 start0 => { -between => [ 1, 2 ] },
2377 start1 => { -between => \["? AND ?", 1, 2] },
2378 start2 => { -between => \"lower(x) AND upper(y)" },
2379 start3 => { -between => [
2381 \["upper(?)", 'stuff' ],
2388 ( start0 BETWEEN ? AND ? )
2389 AND ( start1 BETWEEN ? AND ? )
2390 AND ( start2 BETWEEN lower(x) AND upper(y) )
2391 AND ( start3 BETWEEN lower(x) AND upper(?) )
2393 @bind = (1, 2, 1, 2, 'stuff');
2396 These are the two builtin "special operators"; but the
2397 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2399 =head2 Unary operators: bool
2401 If you wish to test against boolean columns or functions within your
2402 database you can use the C<-bool> and C<-not_bool> operators. For
2403 example to test the column C<is_user> being true and the column
2404 C<is_enabled> being false you would use:-
2408 -not_bool => 'is_enabled',
2413 WHERE is_user AND NOT is_enabled
2415 If a more complex combination is required, testing more conditions,
2416 then you should use the and/or operators:-
2421 -not_bool => { two=> { -rlike => 'bar' } },
2422 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2433 (NOT ( three = ? OR three > ? ))
2436 =head2 Nested conditions, -and/-or prefixes
2438 So far, we've seen how multiple conditions are joined with a top-level
2439 C<AND>. We can change this by putting the different conditions we want in
2440 hashes and then putting those hashes in an array. For example:
2445 status => { -like => ['pending%', 'dispatched'] },
2449 status => 'unassigned',
2453 This data structure would create the following:
2455 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2456 OR ( user = ? AND status = ? ) )";
2457 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2460 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2461 to change the logic inside:
2467 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2468 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2475 $stmt = "WHERE ( user = ?
2476 AND ( ( workhrs > ? AND geo = ? )
2477 OR ( workhrs < ? OR geo = ? ) ) )";
2478 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2480 =head3 Algebraic inconsistency, for historical reasons
2482 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2483 operator goes C<outside> of the nested structure; whereas when connecting
2484 several constraints on one column, the C<-and> operator goes
2485 C<inside> the arrayref. Here is an example combining both features:
2488 -and => [a => 1, b => 2],
2489 -or => [c => 3, d => 4],
2490 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2495 WHERE ( ( ( a = ? AND b = ? )
2496 OR ( c = ? OR d = ? )
2497 OR ( e LIKE ? AND e LIKE ? ) ) )
2499 This difference in syntax is unfortunate but must be preserved for
2500 historical reasons. So be careful: the two examples below would
2501 seem algebraically equivalent, but they are not
2504 { -like => 'foo%' },
2505 { -like => '%bar' },
2507 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2510 { col => { -like => 'foo%' } },
2511 { col => { -like => '%bar' } },
2513 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2516 =head2 Literal SQL and value type operators
2518 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2519 side" is a column name and the "right side" is a value (normally rendered as
2520 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2521 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2522 alter this behavior. There are several ways of doing so.
2526 This is a virtual operator that signals the string to its right side is an
2527 identifier (a column name) and not a value. For example to compare two
2528 columns you would write:
2531 priority => { '<', 2 },
2532 requestor => { -ident => 'submitter' },
2537 $stmt = "WHERE priority < ? AND requestor = submitter";
2540 If you are maintaining legacy code you may see a different construct as
2541 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2546 This is a virtual operator that signals that the construct to its right side
2547 is a value to be passed to DBI. This is for example necessary when you want
2548 to write a where clause against an array (for RDBMS that support such
2549 datatypes). For example:
2552 array => { -value => [1, 2, 3] }
2557 $stmt = 'WHERE array = ?';
2558 @bind = ([1, 2, 3]);
2560 Note that if you were to simply say:
2566 the result would probably not be what you wanted:
2568 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2573 Finally, sometimes only literal SQL will do. To include a random snippet
2574 of SQL verbatim, you specify it as a scalar reference. Consider this only
2575 as a last resort. Usually there is a better way. For example:
2578 priority => { '<', 2 },
2579 requestor => { -in => \'(SELECT name FROM hitmen)' },
2584 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2587 Note that in this example, you only get one bind parameter back, since
2588 the verbatim SQL is passed as part of the statement.
2592 Never use untrusted input as a literal SQL argument - this is a massive
2593 security risk (there is no way to check literal snippets for SQL
2594 injections and other nastyness). If you need to deal with untrusted input
2595 use literal SQL with placeholders as described next.
2597 =head3 Literal SQL with placeholders and bind values (subqueries)
2599 If the literal SQL to be inserted has placeholders and bind values,
2600 use a reference to an arrayref (yes this is a double reference --
2601 not so common, but perfectly legal Perl). For example, to find a date
2602 in Postgres you can use something like this:
2605 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2610 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2613 Note that you must pass the bind values in the same format as they are returned
2614 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2615 to C<columns>, you must provide the bind values in the
2616 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2617 scalar value; most commonly the column name, but you can use any scalar value
2618 (including references and blessed references), L<SQL::Abstract> will simply
2619 pass it through intact. So if C<bindtype> is set to C<columns> the above
2620 example will look like:
2623 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2626 Literal SQL is especially useful for nesting parenthesized clauses in the
2627 main SQL query. Here is a first example:
2629 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2633 bar => \["IN ($sub_stmt)" => @sub_bind],
2638 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2639 WHERE c2 < ? AND c3 LIKE ?))";
2640 @bind = (1234, 100, "foo%");
2642 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2643 are expressed in the same way. Of course the C<$sub_stmt> and
2644 its associated bind values can be generated through a former call
2647 my ($sub_stmt, @sub_bind)
2648 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2649 c3 => {-like => "foo%"}});
2652 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2655 In the examples above, the subquery was used as an operator on a column;
2656 but the same principle also applies for a clause within the main C<%where>
2657 hash, like an EXISTS subquery:
2659 my ($sub_stmt, @sub_bind)
2660 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2661 my %where = ( -and => [
2663 \["EXISTS ($sub_stmt)" => @sub_bind],
2668 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2669 WHERE c1 = ? AND c2 > t0.c0))";
2673 Observe that the condition on C<c2> in the subquery refers to
2674 column C<t0.c0> of the main query: this is I<not> a bind
2675 value, so we have to express it through a scalar ref.
2676 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2677 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2678 what we wanted here.
2680 Finally, here is an example where a subquery is used
2681 for expressing unary negation:
2683 my ($sub_stmt, @sub_bind)
2684 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2685 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2687 lname => {like => '%son%'},
2688 \["NOT ($sub_stmt)" => @sub_bind],
2693 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2694 @bind = ('%son%', 10, 20)
2696 =head3 Deprecated usage of Literal SQL
2698 Below are some examples of archaic use of literal SQL. It is shown only as
2699 reference for those who deal with legacy code. Each example has a much
2700 better, cleaner and safer alternative that users should opt for in new code.
2706 my %where = ( requestor => \'IS NOT NULL' )
2708 $stmt = "WHERE requestor IS NOT NULL"
2710 This used to be the way of generating NULL comparisons, before the handling
2711 of C<undef> got formalized. For new code please use the superior syntax as
2712 described in L</Tests for NULL values>.
2716 my %where = ( requestor => \'= submitter' )
2718 $stmt = "WHERE requestor = submitter"
2720 This used to be the only way to compare columns. Use the superior L</-ident>
2721 method for all new code. For example an identifier declared in such a way
2722 will be properly quoted if L</quote_char> is properly set, while the legacy
2723 form will remain as supplied.
2727 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2729 $stmt = "WHERE completed > ? AND is_ready"
2730 @bind = ('2012-12-21')
2732 Using an empty string literal used to be the only way to express a boolean.
2733 For all new code please use the much more readable
2734 L<-bool|/Unary operators: bool> operator.
2740 These pages could go on for a while, since the nesting of the data
2741 structures this module can handle are pretty much unlimited (the
2742 module implements the C<WHERE> expansion as a recursive function
2743 internally). Your best bet is to "play around" with the module a
2744 little to see how the data structures behave, and choose the best
2745 format for your data based on that.
2747 And of course, all the values above will probably be replaced with
2748 variables gotten from forms or the command line. After all, if you
2749 knew everything ahead of time, you wouldn't have to worry about
2750 dynamically-generating SQL and could just hardwire it into your
2753 =head1 ORDER BY CLAUSES
2755 Some functions take an order by clause. This can either be a scalar (just a
2756 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2757 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2760 Given | Will Generate
2761 ---------------------------------------------------------------
2763 'colA' | ORDER BY colA
2765 [qw/colA colB/] | ORDER BY colA, colB
2767 {-asc => 'colA'} | ORDER BY colA ASC
2769 {-desc => 'colB'} | ORDER BY colB DESC
2771 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2773 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2775 \'colA DESC' | ORDER BY colA DESC
2777 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2778 | /* ...with $x bound to ? */
2781 { -asc => 'colA' }, | colA ASC,
2782 { -desc => [qw/colB/] }, | colB DESC,
2783 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2784 \'colE DESC', | colE DESC,
2785 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2786 ] | /* ...with $x bound to ? */
2787 ===============================================================
2791 =head1 SPECIAL OPERATORS
2793 my $sqlmaker = SQL::Abstract->new(special_ops => [
2797 my ($self, $field, $op, $arg) = @_;
2803 handler => 'method_name',
2807 A "special operator" is a SQL syntactic clause that can be
2808 applied to a field, instead of a usual binary operator.
2811 WHERE field IN (?, ?, ?)
2812 WHERE field BETWEEN ? AND ?
2813 WHERE MATCH(field) AGAINST (?, ?)
2815 Special operators IN and BETWEEN are fairly standard and therefore
2816 are builtin within C<SQL::Abstract> (as the overridable methods
2817 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2818 like the MATCH .. AGAINST example above which is specific to MySQL,
2819 you can write your own operator handlers - supply a C<special_ops>
2820 argument to the C<new> method. That argument takes an arrayref of
2821 operator definitions; each operator definition is a hashref with two
2828 the regular expression to match the operator
2832 Either a coderef or a plain scalar method name. In both cases
2833 the expected return is C<< ($sql, @bind) >>.
2835 When supplied with a method name, it is simply called on the
2836 L<SQL::Abstract> object as:
2838 $self->$method_name($field, $op, $arg)
2842 $field is the LHS of the operator
2843 $op is the part that matched the handler regex
2846 When supplied with a coderef, it is called as:
2848 $coderef->($self, $field, $op, $arg)
2853 For example, here is an implementation
2854 of the MATCH .. AGAINST syntax for MySQL
2856 my $sqlmaker = SQL::Abstract->new(special_ops => [
2858 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2859 {regex => qr/^match$/i,
2861 my ($self, $field, $op, $arg) = @_;
2862 $arg = [$arg] if not ref $arg;
2863 my $label = $self->_quote($field);
2864 my ($placeholder) = $self->_convert('?');
2865 my $placeholders = join ", ", (($placeholder) x @$arg);
2866 my $sql = $self->_sqlcase('match') . " ($label) "
2867 . $self->_sqlcase('against') . " ($placeholders) ";
2868 my @bind = $self->_bindtype($field, @$arg);
2869 return ($sql, @bind);
2876 =head1 UNARY OPERATORS
2878 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2882 my ($self, $op, $arg) = @_;
2888 handler => 'method_name',
2892 A "unary operator" is a SQL syntactic clause that can be
2893 applied to a field - the operator goes before the field
2895 You can write your own operator handlers - supply a C<unary_ops>
2896 argument to the C<new> method. That argument takes an arrayref of
2897 operator definitions; each operator definition is a hashref with two
2904 the regular expression to match the operator
2908 Either a coderef or a plain scalar method name. In both cases
2909 the expected return is C<< $sql >>.
2911 When supplied with a method name, it is simply called on the
2912 L<SQL::Abstract> object as:
2914 $self->$method_name($op, $arg)
2918 $op is the part that matched the handler regex
2919 $arg is the RHS or argument of the operator
2921 When supplied with a coderef, it is called as:
2923 $coderef->($self, $op, $arg)
2931 Thanks to some benchmarking by Mark Stosberg, it turns out that
2932 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2933 I must admit this wasn't an intentional design issue, but it's a
2934 byproduct of the fact that you get to control your C<DBI> handles
2937 To maximize performance, use a code snippet like the following:
2939 # prepare a statement handle using the first row
2940 # and then reuse it for the rest of the rows
2942 for my $href (@array_of_hashrefs) {
2943 $stmt ||= $sql->insert('table', $href);
2944 $sth ||= $dbh->prepare($stmt);
2945 $sth->execute($sql->values($href));
2948 The reason this works is because the keys in your C<$href> are sorted
2949 internally by B<SQL::Abstract>. Thus, as long as your data retains
2950 the same structure, you only have to generate the SQL the first time
2951 around. On subsequent queries, simply use the C<values> function provided
2952 by this module to return your values in the correct order.
2954 However this depends on the values having the same type - if, for
2955 example, the values of a where clause may either have values
2956 (resulting in sql of the form C<column = ?> with a single bind
2957 value), or alternatively the values might be C<undef> (resulting in
2958 sql of the form C<column IS NULL> with no bind value) then the
2959 caching technique suggested will not work.
2963 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2964 really like this part (I do, at least). Building up a complex query
2965 can be as simple as the following:
2972 use CGI::FormBuilder;
2975 my $form = CGI::FormBuilder->new(...);
2976 my $sql = SQL::Abstract->new;
2978 if ($form->submitted) {
2979 my $field = $form->field;
2980 my $id = delete $field->{id};
2981 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2984 Of course, you would still have to connect using C<DBI> to run the
2985 query, but the point is that if you make your form look like your
2986 table, the actual query script can be extremely simplistic.
2988 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2989 a fast interface to returning and formatting data. I frequently
2990 use these three modules together to write complex database query
2991 apps in under 50 lines.
2993 =head1 HOW TO CONTRIBUTE
2995 Contributions are always welcome, in all usable forms (we especially
2996 welcome documentation improvements). The delivery methods include git-
2997 or unified-diff formatted patches, GitHub pull requests, or plain bug
2998 reports either via RT or the Mailing list. Contributors are generally
2999 granted full access to the official repository after their first several
3000 patches pass successful review.
3002 This project is maintained in a git repository. The code and related tools are
3003 accessible at the following locations:
3007 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3009 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3011 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3013 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3019 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3020 Great care has been taken to preserve the I<published> behavior
3021 documented in previous versions in the 1.* family; however,
3022 some features that were previously undocumented, or behaved
3023 differently from the documentation, had to be changed in order
3024 to clarify the semantics. Hence, client code that was relying
3025 on some dark areas of C<SQL::Abstract> v1.*
3026 B<might behave differently> in v1.50.
3028 The main changes are:
3034 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3038 support for the { operator => \"..." } construct (to embed literal SQL)
3042 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3046 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3050 defensive programming: check arguments
3054 fixed bug with global logic, which was previously implemented
3055 through global variables yielding side-effects. Prior versions would
3056 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3057 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3058 Now this is interpreted
3059 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3064 fixed semantics of _bindtype on array args
3068 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3069 we just avoid shifting arrays within that tree.
3073 dropped the C<_modlogic> function
3077 =head1 ACKNOWLEDGEMENTS
3079 There are a number of individuals that have really helped out with
3080 this module. Unfortunately, most of them submitted bugs via CPAN
3081 so I have no idea who they are! But the people I do know are:
3083 Ash Berlin (order_by hash term support)
3084 Matt Trout (DBIx::Class support)
3085 Mark Stosberg (benchmarking)
3086 Chas Owens (initial "IN" operator support)
3087 Philip Collins (per-field SQL functions)
3088 Eric Kolve (hashref "AND" support)
3089 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3090 Dan Kubb (support for "quote_char" and "name_sep")
3091 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3092 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3093 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3094 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3095 Oliver Charles (support for "RETURNING" after "INSERT")
3101 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3105 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3107 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3109 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3110 While not an official support venue, C<DBIx::Class> makes heavy use of
3111 C<SQL::Abstract>, and as such list members there are very familiar with
3112 how to create queries.
3116 This module is free software; you may copy this under the same
3117 terms as perl itself (either the GNU General Public License or
3118 the Artistic License)