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} = {};
195 -ident => '_expand_ident',
196 -value => '_expand_value',
197 -not => '_expand_not',
199 my ($self, undef, $v) = @_;
201 return $self->_expand_expr($v);
203 puke "-bool => undef not supported" unless defined($v);
204 return $self->_expand_ident(-ident => $v);
208 return bless \%opt, $class;
211 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
212 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
214 sub _assert_pass_injection_guard {
215 if ($_[1] =~ $_[0]->{injection_guard}) {
216 my $class = ref $_[0];
217 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
218 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
219 . "{injection_guard} attribute to ${class}->new()"
224 #======================================================================
226 #======================================================================
230 my $table = $self->_table(shift);
231 my $data = shift || return;
234 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
235 my ($sql, @bind) = $self->$method($data);
236 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
238 if ($options->{returning}) {
239 my ($s, @b) = $self->_insert_returning($options);
244 return wantarray ? ($sql, @bind) : $sql;
247 # So that subclasses can override INSERT ... RETURNING separately from
248 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
249 sub _insert_returning { shift->_returning(@_) }
252 my ($self, $options) = @_;
254 my $f = $options->{returning};
256 my ($sql, @bind) = $self->render_aqt(
257 $self->_expand_maybe_list_expr($f, undef, -ident)
260 ? $self->_sqlcase(' returning ') . $sql
261 : ($self->_sqlcase(' returning ').$sql, @bind);
264 sub _insert_HASHREF { # explicit list of fields and then values
265 my ($self, $data) = @_;
267 my @fields = sort keys %$data;
269 my ($sql, @bind) = $self->_insert_values($data);
272 $_ = $self->_quote($_) foreach @fields;
273 $sql = "( ".join(", ", @fields).") ".$sql;
275 return ($sql, @bind);
278 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
279 my ($self, $data) = @_;
281 # no names (arrayref) so can't generate bindtype
282 $self->{bindtype} ne 'columns'
283 or belch "can't do 'columns' bindtype when called with arrayref";
285 my (@values, @all_bind);
286 foreach my $value (@$data) {
287 my ($values, @bind) = $self->_insert_value(undef, $value);
288 push @values, $values;
289 push @all_bind, @bind;
291 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
292 return ($sql, @all_bind);
295 sub _insert_ARRAYREFREF { # literal SQL with bind
296 my ($self, $data) = @_;
298 my ($sql, @bind) = @${$data};
299 $self->_assert_bindval_matches_bindtype(@bind);
301 return ($sql, @bind);
305 sub _insert_SCALARREF { # literal SQL without bind
306 my ($self, $data) = @_;
312 my ($self, $data) = @_;
314 my (@values, @all_bind);
315 foreach my $column (sort keys %$data) {
316 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
317 push @values, $values;
318 push @all_bind, @bind;
320 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
321 return ($sql, @all_bind);
325 my ($self, $column, $v) = @_;
327 return $self->render_aqt(
328 $self->_expand_insert_value($column, $v)
332 sub _expand_insert_value {
333 my ($self, $column, $v) = @_;
335 if (ref($v) eq 'ARRAY') {
336 if ($self->{array_datatypes}) {
337 return +{ -bind => [ $column, $v ] };
339 my ($sql, @bind) = @$v;
340 $self->_assert_bindval_matches_bindtype(@bind);
341 return +{ -literal => $v };
343 if (ref($v) eq 'HASH') {
344 if (grep !/^-/, keys %$v) {
345 belch "HASH ref as bind value in insert is not supported";
346 return +{ -bind => [ $column, $v ] };
350 return +{ -bind => [ $column, undef ] };
352 local our $Cur_Col_Meta = $column;
353 return $self->expand_expr($v);
358 #======================================================================
360 #======================================================================
365 my $table = $self->_table(shift);
366 my $data = shift || return;
370 # first build the 'SET' part of the sql statement
371 puke "Unsupported data type specified to \$sql->update"
372 unless ref $data eq 'HASH';
374 my ($sql, @all_bind) = $self->_update_set_values($data);
375 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
379 my($where_sql, @where_bind) = $self->where($where);
381 push @all_bind, @where_bind;
384 if ($options->{returning}) {
385 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
386 $sql .= $returning_sql;
387 push @all_bind, @returning_bind;
390 return wantarray ? ($sql, @all_bind) : $sql;
393 sub _update_set_values {
394 my ($self, $data) = @_;
396 return $self->render_aqt(
397 $self->_expand_update_set_values($data),
401 sub _expand_update_set_values {
402 my ($self, $data) = @_;
403 $self->_expand_maybe_list_expr( [
406 $set = { -bind => $_ } unless defined $set;
407 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
413 ? ($self->{array_datatypes}
414 ? [ $k, +{ -bind => [ $k, $v ] } ]
415 : [ $k, +{ -literal => $v } ])
417 local our $Cur_Col_Meta = $k;
418 [ $k, $self->_expand_expr($v) ]
425 # So that subclasses can override UPDATE ... RETURNING separately from
427 sub _update_returning { shift->_returning(@_) }
431 #======================================================================
433 #======================================================================
438 my $table = $self->_table(shift);
439 my $fields = shift || '*';
443 my ($fields_sql, @bind) = $self->_select_fields($fields);
445 my ($where_sql, @where_bind) = $self->where($where, $order);
446 push @bind, @where_bind;
448 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
449 $self->_sqlcase('from'), $table)
452 return wantarray ? ($sql, @bind) : $sql;
456 my ($self, $fields) = @_;
457 return $fields unless ref($fields);
458 return $self->render_aqt(
459 $self->_expand_maybe_list_expr($fields, undef, '-ident')
463 #======================================================================
465 #======================================================================
470 my $table = $self->_table(shift);
474 my($where_sql, @bind) = $self->where($where);
475 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
477 if ($options->{returning}) {
478 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
479 $sql .= $returning_sql;
480 push @bind, @returning_bind;
483 return wantarray ? ($sql, @bind) : $sql;
486 # So that subclasses can override DELETE ... RETURNING separately from
488 sub _delete_returning { shift->_returning(@_) }
492 #======================================================================
494 #======================================================================
498 # Finally, a separate routine just to handle WHERE clauses
500 my ($self, $where, $order) = @_;
502 local $self->{convert_where} = $self->{convert};
505 my ($sql, @bind) = defined($where)
506 ? $self->_recurse_where($where)
508 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
512 my ($order_sql, @order_bind) = $self->_order_by($order);
514 push @bind, @order_bind;
517 return wantarray ? ($sql, @bind) : $sql;
521 my ($self, $expr, $default_scalar_to) = @_;
522 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
523 $self->_expand_expr($expr);
527 my ($self, $aqt) = @_;
528 my ($k, $v, @rest) = %$aqt;
530 if (my $meth = $self->{render}{$k}) {
531 return $self->$meth($v);
533 die "notreached: $k";
537 my ($self, $expr) = @_;
538 $self->render_aqt($self->expand_expr($expr));
542 my ($self, $expr, $logic) = @_;
543 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
544 return undef unless defined($expr);
545 if (ref($expr) eq 'HASH') {
546 return undef unless my $kc = keys %$expr;
551 map $self->_expand_expr({ $_ => $expr->{$_} }, $logic),
555 my ($key, $value) = %$expr;
556 if (my $exp = $self->{expand}{$key}) {
557 return $self->$exp($key, $value);
559 return $self->_expand_expr_hashpair($key, $value, $logic);
561 if (ref($expr) eq 'ARRAY') {
562 my $logic = lc($logic || $self->{logic});
563 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
566 (ref($_) eq 'ARRAY' and @$_)
567 or (ref($_) eq 'HASH' and %$_)
573 while (my ($el) = splice @expr, 0, 1) {
574 puke "Supplying an empty left hand side argument is not supported in array-pairs"
575 unless defined($el) and length($el);
576 my $elref = ref($el);
578 local $Expand_Depth = 0;
579 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
580 } elsif ($elref eq 'ARRAY') {
581 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
582 } elsif (my $l = is_literal_value($el)) {
583 push @res, { -literal => $l };
584 } elsif ($elref eq 'HASH') {
585 local $Expand_Depth = 0;
586 push @res, grep defined, $self->_expand_expr($el) if %$el;
592 # return $res[0] if @res == 1;
593 return { -op => [ $logic, @res ] };
595 if (my $literal = is_literal_value($expr)) {
596 return +{ -literal => $literal };
598 if (!ref($expr) or Scalar::Util::blessed($expr)) {
599 if (my $d = our $Default_Scalar_To) {
600 return $self->_expand_expr({ $d => $expr });
602 if (my $m = our $Cur_Col_Meta) {
603 return +{ -bind => [ $m, $expr ] };
605 return +{ -bind => [ undef, $expr ] };
610 sub _expand_expr_hashpair {
611 my ($self, $k, $v, $logic) = @_;
612 unless (defined($k) and length($k)) {
613 if (defined($k) and my $literal = is_literal_value($v)) {
614 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
615 return { -literal => $literal };
617 puke "Supplying an empty left hand side argument is not supported";
620 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
621 if ($k =~ s/ [_\s]? \d+ $//x ) {
622 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
623 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
626 # DBIx::Class requires a nest warning to be emitted once but the private
627 # method it overrode to do so no longer exists
628 if ($self->{is_dbic_sqlmaker}) {
629 unless (our $Nest_Warned) {
631 "-nest in search conditions is deprecated, you most probably wanted:\n"
632 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
637 return $self->_expand_expr($v);
639 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
642 $self->_expand_expr({ "-${rest}", $v }, $logic)
645 if (my ($logic) = $k =~ /^-(and|or)$/i) {
646 if (ref($v) eq 'HASH') {
647 return $self->_expand_expr($v, $logic);
649 if (ref($v) eq 'ARRAY') {
650 return $self->_expand_expr($v, $logic);
655 $op =~ s/^-// if length($op) > 1;
657 # top level special ops are illegal in general
658 # note that, arguably, if it makes no sense at top level, it also
659 # makes no sense on the other side of an = sign or similar but DBIC
660 # gets disappointingly upset if I disallow it
662 (our $Expand_Depth) == 1
663 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
665 puke "Illegal use of top-level '-$op'"
667 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
668 return { -op => [ $op, $v ] };
671 if (my $custom = $self->{expand_unary}{$k}) {
672 return $self->$custom($v);
674 if ($self->{render}{$k}) {
680 and (keys %$v)[0] =~ /^-/
682 my ($func) = $k =~ /^-(.*)$/;
683 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
684 return +{ -op => [ $func, $self->_expand_expr($v) ] };
686 return +{ -func => [ $func, $self->_expand_expr($v) ] };
688 if (!ref($v) or is_literal_value($v)) {
689 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
696 and exists $v->{-value}
697 and not defined $v->{-value}
700 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
702 if (!ref($v) or Scalar::Util::blessed($v)) {
703 my $d = our $Default_Scalar_To;
707 $self->_expand_ident(-ident => $k),
709 ? $self->_expand_expr($d => $v)
710 : { -bind => [ $k, $v ] }
715 if (ref($v) eq 'HASH') {
719 map $self->_expand_expr({ $k => { $_ => $v->{$_} } }),
723 return undef unless keys %$v;
725 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
726 $self->_assert_pass_injection_guard($op);
727 if ($op =~ s/ [_\s]? \d+ $//x ) {
728 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
729 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
731 if ($op =~ /^(?:not )?between$/) {
732 local our $Cur_Col_Meta = $k;
733 my @rhs = map $self->_expand_expr($_),
734 ref($vv) eq 'ARRAY' ? @$vv : $vv;
736 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
738 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
740 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
744 $self->_expand_ident(-ident => $k),
748 if ($op =~ /^(?:not )?in$/) {
749 if (my $literal = is_literal_value($vv)) {
750 my ($sql, @bind) = @$literal;
751 my $opened_sql = $self->_open_outer_paren($sql);
753 $op, $self->_expand_ident(-ident => $k),
754 [ { -literal => [ $opened_sql, @bind ] } ]
758 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
759 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
760 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
761 . 'will emit the logically correct SQL instead of raising this exception)'
763 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
765 my @rhs = map $self->_expand_expr($_),
766 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
767 map { defined($_) ? $_: puke($undef_err) }
768 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
769 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
773 $self->_expand_ident(-ident => $k),
777 if ($op eq 'ident') {
778 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
779 puke "-$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
783 $self->_expand_ident(-ident => $k),
784 $self->_expand_ident(-ident => $vv),
787 if ($op eq 'value') {
788 return $self->_expand_expr({ $k, undef }) unless defined($vv);
791 $self->_expand_ident(-ident => $k),
792 { -bind => [ $k, $vv ] }
795 if ($op =~ /^is(?: not)?$/) {
796 puke "$op can only take undef as argument"
800 and exists($vv->{-value})
801 and !defined($vv->{-value})
803 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
805 if ($op =~ /^(and|or)$/) {
806 if (ref($vv) eq 'HASH') {
809 map $self->_expand_expr({ $k, { $_ => $vv->{$_} } }),
814 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
815 return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
817 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
820 $self->_expand_ident(-ident => $k),
821 { -op => [ $op, $vv ] }
824 if (ref($vv) eq 'ARRAY') {
825 my ($logic, @values) = (
826 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
831 $op =~ $self->{inequality_op}
832 or $op =~ $self->{not_like_op}
834 if (lc($logic) eq '-or' and @values > 1) {
835 belch "A multi-element arrayref as an argument to the inequality op '${\uc($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
844 $op =~ $self->{equality_op} ? $self->sqlfalse
845 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
846 : $op =~ $self->{inequality_op} ? $self->sqltrue
847 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
848 : puke "operator '$op' applied on an empty array (field '$k')";
852 map $self->_expand_expr({ $k => { $vk => $_ } }),
860 and exists $vv->{-value}
861 and not defined $vv->{-value}
865 $op =~ /^not$/i ? 'is not' # legacy
866 : $op =~ $self->{equality_op} ? 'is'
867 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
868 : $op =~ $self->{inequality_op} ? 'is not'
869 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
870 : puke "unexpected operator '$op' with undef operand";
871 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
873 local our $Cur_Col_Meta = $k;
876 $self->_expand_ident(-ident => $k),
877 $self->_expand_expr($vv)
880 if (ref($v) eq 'ARRAY') {
881 return $self->sqlfalse unless @$v;
882 $self->_debug("ARRAY($k) means distribute over elements");
884 $v->[0] =~ /^-((?:and|or))$/i
885 ? ($v = [ @{$v}[1..$#$v] ], $1)
886 : ($self->{logic} || 'or')
890 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
893 if (my $literal = is_literal_value($v)) {
895 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
898 my ($sql, @bind) = @$literal;
899 if ($self->{bindtype} eq 'columns') {
901 $self->_assert_bindval_matches_bindtype($_);
904 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
910 my ($self, undef, $body) = @_;
911 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
912 ref($body) ? @$body : $body;
913 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
914 unless ($self->{quote_char}) {
915 $self->_assert_pass_injection_guard($_) for @parts;
917 return +{ -ident => \@parts };
921 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
925 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
929 my ($self, $where, $logic) = @_;
931 # Special case: top level simple string treated as literal
933 my $where_exp = (ref($where)
934 ? $self->_expand_expr($where, $logic)
935 : { -literal => [ $where ] });
937 # dispatch expanded expression
939 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
940 # DBIx::Class used to call _recurse_where in scalar context
941 # something else might too...
943 return ($sql, @bind);
946 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
952 my ($self, $ident) = @_;
954 return $self->_convert($self->_quote($ident));
957 my %unop_postfix = map +($_ => 1),
958 'is null', 'is not null',
966 my ($self, $args) = @_;
967 my ($left, $low, $high) = @$args;
968 my ($rhsql, @rhbind) = do {
970 puke "Single arg to between must be a literal"
971 unless $low->{-literal};
974 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
975 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
976 @{$l}[1..$#$l], @{$h}[1..$#$h])
979 my ($lhsql, @lhbind) = $self->render_aqt($left);
981 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
985 }), 'between', 'not between'),
989 my ($self, $args) = @_;
990 my ($lhs, $rhs) = @$args;
993 my ($sql, @bind) = $self->render_aqt($_);
994 push @in_bind, @bind;
997 my ($lhsql, @lbind) = $self->render_aqt($lhs);
999 $lhsql.' '.$self->_sqlcase($op).' ( '
1000 .join(', ', @in_sql)
1005 }), 'in', 'not in'),
1009 my ($self, $v) = @_;
1010 my ($op, @args) = @$v;
1011 $op =~ s/^-// if length($op) > 1;
1013 if (my $h = $special{$op}) {
1014 return $self->$h(\@args);
1016 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1017 if ($us and @args > 1) {
1018 puke "Special op '${op}' requires first value to be identifier"
1019 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1020 my $k = join(($self->{name_sep}||'.'), @$ident);
1021 local our $Expand_Depth = 1;
1022 return $self->${\($us->{handler})}($k, $op, $args[1]);
1024 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1025 return $self->${\($us->{handler})}($op, $args[0]);
1027 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1028 if (@args == 1 and $op !~ /^(and|or)$/) {
1029 my ($expr_sql, @bind) = $self->render_aqt($args[0]);
1030 my $op_sql = $self->_sqlcase($final_op);
1032 $unop_postfix{lc($final_op)}
1033 ? "${expr_sql} ${op_sql}"
1034 : "${op_sql} ${expr_sql}"
1036 return (($op eq 'not' || $us ? '('.$final_sql.')' : $final_sql), @bind);
1038 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1039 return '' unless @parts;
1040 my $is_andor = !!($op =~ /^(and|or)$/);
1041 return @{$parts[0]} if $is_andor and @parts == 1;
1042 my ($final_sql) = map +($is_andor ? "( ${_} )" : $_), join(
1043 ' '.$self->_sqlcase($final_op).' ',
1048 map @{$_}[1..$#$_], @parts
1055 my ($self, $list) = @_;
1056 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1057 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1061 my ($self, $rest) = @_;
1062 my ($func, @args) = @$rest;
1066 push @arg_sql, shift @x;
1068 } map [ $self->render_aqt($_) ], @args;
1069 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1073 my ($self, $bind) = @_;
1074 return ($self->_convert('?'), $self->_bindtype(@$bind));
1077 sub _render_literal {
1078 my ($self, $literal) = @_;
1079 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1083 # Some databases (SQLite) treat col IN (1, 2) different from
1084 # col IN ( (1, 2) ). Use this to strip all outer parens while
1085 # adding them back in the corresponding method
1086 sub _open_outer_paren {
1087 my ($self, $sql) = @_;
1089 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1091 # there are closing parens inside, need the heavy duty machinery
1092 # to reevaluate the extraction starting from $sql (full reevaluation)
1093 if ($inner =~ /\)/) {
1094 require Text::Balanced;
1096 my (undef, $remainder) = do {
1097 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1099 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1102 # the entire expression needs to be a balanced bracketed thing
1103 # (after an extract no remainder sans trailing space)
1104 last if defined $remainder and $remainder =~ /\S/;
1114 #======================================================================
1116 #======================================================================
1118 sub _expand_order_by {
1119 my ($self, $arg) = @_;
1121 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1123 my $expander = sub {
1124 my ($self, $dir, $expr) = @_;
1125 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1126 foreach my $arg (@to_expand) {
1130 and grep /^-(asc|desc)$/, keys %$arg
1132 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1135 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1136 map $self->expand_expr($_, -ident),
1137 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1138 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1141 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1142 sub { shift->$expander(asc => @_) },
1143 sub { shift->$expander(desc => @_) },
1146 return $self->$expander(undef, $arg);
1150 my ($self, $arg) = @_;
1152 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1154 my ($sql, @bind) = $self->render_aqt($expanded);
1156 return '' unless length($sql);
1158 my $final_sql = $self->_sqlcase(' order by ').$sql;
1160 return wantarray ? ($final_sql, @bind) : $final_sql;
1163 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1165 sub _order_by_chunks {
1166 my ($self, $arg) = @_;
1168 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1170 return $self->_chunkify_order_by($expanded);
1173 sub _chunkify_order_by {
1174 my ($self, $expanded) = @_;
1176 return grep length, $self->render_aqt($expanded)
1177 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1180 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1181 return map $self->_chunkify_order_by($_), @$l;
1183 return [ $self->render_aqt($_) ];
1187 #======================================================================
1188 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1189 #======================================================================
1195 $self->_expand_maybe_list_expr($from, undef, -ident)
1200 #======================================================================
1202 #======================================================================
1204 sub _expand_maybe_list_expr {
1205 my ($self, $expr, $logic, $default) = @_;
1207 if (ref($expr) eq 'ARRAY') {
1209 map $self->expand_expr($_, $default), @$expr
1216 return $self->expand_expr($e, $default);
1219 # highly optimized, as it's called way too often
1221 # my ($self, $label) = @_;
1223 return '' unless defined $_[1];
1224 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1225 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1227 unless ($_[0]->{quote_char}) {
1228 if (ref($_[1]) eq 'ARRAY') {
1229 return join($_[0]->{name_sep}||'.', @{$_[1]});
1231 $_[0]->_assert_pass_injection_guard($_[1]);
1236 my $qref = ref $_[0]->{quote_char};
1238 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1239 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1240 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1242 my $esc = $_[0]->{escape_char} || $r;
1244 # parts containing * are naturally unquoted
1246 $_[0]->{name_sep}||'',
1250 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1252 (ref($_[1]) eq 'ARRAY'
1256 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1264 # Conversion, if applicable
1266 #my ($self, $arg) = @_;
1267 if ($_[0]->{convert_where}) {
1268 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1275 #my ($self, $col, @vals) = @_;
1276 # called often - tighten code
1277 return $_[0]->{bindtype} eq 'columns'
1278 ? map {[$_[1], $_]} @_[2 .. $#_]
1283 # Dies if any element of @bind is not in [colname => value] format
1284 # if bindtype is 'columns'.
1285 sub _assert_bindval_matches_bindtype {
1286 # my ($self, @bind) = @_;
1288 if ($self->{bindtype} eq 'columns') {
1290 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1291 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1297 sub _join_sql_clauses {
1298 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1300 if (@$clauses_aref > 1) {
1301 my $join = " " . $self->_sqlcase($logic) . " ";
1302 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1303 return ($sql, @$bind_aref);
1305 elsif (@$clauses_aref) {
1306 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1309 return (); # if no SQL, ignore @$bind_aref
1314 # Fix SQL case, if so requested
1316 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1317 # don't touch the argument ... crooked logic, but let's not change it!
1318 return $_[0]->{case} ? $_[1] : uc($_[1]);
1322 #======================================================================
1323 # DISPATCHING FROM REFKIND
1324 #======================================================================
1327 my ($self, $data) = @_;
1329 return 'UNDEF' unless defined $data;
1331 # blessed objects are treated like scalars
1332 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1334 return 'SCALAR' unless $ref;
1337 while ($ref eq 'REF') {
1339 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1343 return ($ref||'SCALAR') . ('REF' x $n_steps);
1347 my ($self, $data) = @_;
1348 my @try = ($self->_refkind($data));
1349 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1350 push @try, 'FALLBACK';
1354 sub _METHOD_FOR_refkind {
1355 my ($self, $meth_prefix, $data) = @_;
1358 for (@{$self->_try_refkind($data)}) {
1359 $method = $self->can($meth_prefix."_".$_)
1363 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1367 sub _SWITCH_refkind {
1368 my ($self, $data, $dispatch_table) = @_;
1371 for (@{$self->_try_refkind($data)}) {
1372 $coderef = $dispatch_table->{$_}
1376 puke "no dispatch entry for ".$self->_refkind($data)
1385 #======================================================================
1386 # VALUES, GENERATE, AUTOLOAD
1387 #======================================================================
1389 # LDNOTE: original code from nwiger, didn't touch code in that section
1390 # I feel the AUTOLOAD stuff should not be the default, it should
1391 # only be activated on explicit demand by user.
1395 my $data = shift || return;
1396 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1397 unless ref $data eq 'HASH';
1400 foreach my $k (sort keys %$data) {
1401 my $v = $data->{$k};
1402 $self->_SWITCH_refkind($v, {
1404 if ($self->{array_datatypes}) { # array datatype
1405 push @all_bind, $self->_bindtype($k, $v);
1407 else { # literal SQL with bind
1408 my ($sql, @bind) = @$v;
1409 $self->_assert_bindval_matches_bindtype(@bind);
1410 push @all_bind, @bind;
1413 ARRAYREFREF => sub { # literal SQL with bind
1414 my ($sql, @bind) = @${$v};
1415 $self->_assert_bindval_matches_bindtype(@bind);
1416 push @all_bind, @bind;
1418 SCALARREF => sub { # literal SQL without bind
1420 SCALAR_or_UNDEF => sub {
1421 push @all_bind, $self->_bindtype($k, $v);
1432 my(@sql, @sqlq, @sqlv);
1436 if ($ref eq 'HASH') {
1437 for my $k (sort keys %$_) {
1440 my $label = $self->_quote($k);
1441 if ($r eq 'ARRAY') {
1442 # literal SQL with bind
1443 my ($sql, @bind) = @$v;
1444 $self->_assert_bindval_matches_bindtype(@bind);
1445 push @sqlq, "$label = $sql";
1447 } elsif ($r eq 'SCALAR') {
1448 # literal SQL without bind
1449 push @sqlq, "$label = $$v";
1451 push @sqlq, "$label = ?";
1452 push @sqlv, $self->_bindtype($k, $v);
1455 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1456 } elsif ($ref eq 'ARRAY') {
1457 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1460 if ($r eq 'ARRAY') { # literal SQL with bind
1461 my ($sql, @bind) = @$v;
1462 $self->_assert_bindval_matches_bindtype(@bind);
1465 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1466 # embedded literal SQL
1473 push @sql, '(' . join(', ', @sqlq) . ')';
1474 } elsif ($ref eq 'SCALAR') {
1478 # strings get case twiddled
1479 push @sql, $self->_sqlcase($_);
1483 my $sql = join ' ', @sql;
1485 # this is pretty tricky
1486 # if ask for an array, return ($stmt, @bind)
1487 # otherwise, s/?/shift @sqlv/ to put it inline
1489 return ($sql, @sqlv);
1491 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1492 ref $d ? $d->[1] : $d/e;
1501 # This allows us to check for a local, then _form, attr
1503 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1504 return $self->generate($name, @_);
1515 SQL::Abstract - Generate SQL from Perl data structures
1521 my $sql = SQL::Abstract->new;
1523 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1525 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1527 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1529 my($stmt, @bind) = $sql->delete($table, \%where);
1531 # Then, use these in your DBI statements
1532 my $sth = $dbh->prepare($stmt);
1533 $sth->execute(@bind);
1535 # Just generate the WHERE clause
1536 my($stmt, @bind) = $sql->where(\%where, $order);
1538 # Return values in the same order, for hashed queries
1539 # See PERFORMANCE section for more details
1540 my @bind = $sql->values(\%fieldvals);
1544 This module was inspired by the excellent L<DBIx::Abstract>.
1545 However, in using that module I found that what I really wanted
1546 to do was generate SQL, but still retain complete control over my
1547 statement handles and use the DBI interface. So, I set out to
1548 create an abstract SQL generation module.
1550 While based on the concepts used by L<DBIx::Abstract>, there are
1551 several important differences, especially when it comes to WHERE
1552 clauses. I have modified the concepts used to make the SQL easier
1553 to generate from Perl data structures and, IMO, more intuitive.
1554 The underlying idea is for this module to do what you mean, based
1555 on the data structures you provide it. The big advantage is that
1556 you don't have to modify your code every time your data changes,
1557 as this module figures it out.
1559 To begin with, an SQL INSERT is as easy as just specifying a hash
1560 of C<key=value> pairs:
1563 name => 'Jimbo Bobson',
1564 phone => '123-456-7890',
1565 address => '42 Sister Lane',
1566 city => 'St. Louis',
1567 state => 'Louisiana',
1570 The SQL can then be generated with this:
1572 my($stmt, @bind) = $sql->insert('people', \%data);
1574 Which would give you something like this:
1576 $stmt = "INSERT INTO people
1577 (address, city, name, phone, state)
1578 VALUES (?, ?, ?, ?, ?)";
1579 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1580 '123-456-7890', 'Louisiana');
1582 These are then used directly in your DBI code:
1584 my $sth = $dbh->prepare($stmt);
1585 $sth->execute(@bind);
1587 =head2 Inserting and Updating Arrays
1589 If your database has array types (like for example Postgres),
1590 activate the special option C<< array_datatypes => 1 >>
1591 when creating the C<SQL::Abstract> object.
1592 Then you may use an arrayref to insert and update database array types:
1594 my $sql = SQL::Abstract->new(array_datatypes => 1);
1596 planets => [qw/Mercury Venus Earth Mars/]
1599 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1603 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1605 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1608 =head2 Inserting and Updating SQL
1610 In order to apply SQL functions to elements of your C<%data> you may
1611 specify a reference to an arrayref for the given hash value. For example,
1612 if you need to execute the Oracle C<to_date> function on a value, you can
1613 say something like this:
1617 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1620 The first value in the array is the actual SQL. Any other values are
1621 optional and would be included in the bind values array. This gives
1624 my($stmt, @bind) = $sql->insert('people', \%data);
1626 $stmt = "INSERT INTO people (name, date_entered)
1627 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1628 @bind = ('Bill', '03/02/2003');
1630 An UPDATE is just as easy, all you change is the name of the function:
1632 my($stmt, @bind) = $sql->update('people', \%data);
1634 Notice that your C<%data> isn't touched; the module will generate
1635 the appropriately quirky SQL for you automatically. Usually you'll
1636 want to specify a WHERE clause for your UPDATE, though, which is
1637 where handling C<%where> hashes comes in handy...
1639 =head2 Complex where statements
1641 This module can generate pretty complicated WHERE statements
1642 easily. For example, simple C<key=value> pairs are taken to mean
1643 equality, and if you want to see if a field is within a set
1644 of values, you can use an arrayref. Let's say we wanted to
1645 SELECT some data based on this criteria:
1648 requestor => 'inna',
1649 worker => ['nwiger', 'rcwe', 'sfz'],
1650 status => { '!=', 'completed' }
1653 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1655 The above would give you something like this:
1657 $stmt = "SELECT * FROM tickets WHERE
1658 ( requestor = ? ) AND ( status != ? )
1659 AND ( worker = ? OR worker = ? OR worker = ? )";
1660 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1662 Which you could then use in DBI code like so:
1664 my $sth = $dbh->prepare($stmt);
1665 $sth->execute(@bind);
1671 The methods are simple. There's one for every major SQL operation,
1672 and a constructor you use first. The arguments are specified in a
1673 similar order for each method (table, then fields, then a where
1674 clause) to try and simplify things.
1676 =head2 new(option => 'value')
1678 The C<new()> function takes a list of options and values, and returns
1679 a new B<SQL::Abstract> object which can then be used to generate SQL
1680 through the methods below. The options accepted are:
1686 If set to 'lower', then SQL will be generated in all lowercase. By
1687 default SQL is generated in "textbook" case meaning something like:
1689 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1691 Any setting other than 'lower' is ignored.
1695 This determines what the default comparison operator is. By default
1696 it is C<=>, meaning that a hash like this:
1698 %where = (name => 'nwiger', email => 'nate@wiger.org');
1700 Will generate SQL like this:
1702 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1704 However, you may want loose comparisons by default, so if you set
1705 C<cmp> to C<like> you would get SQL such as:
1707 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1709 You can also override the comparison on an individual basis - see
1710 the huge section on L</"WHERE CLAUSES"> at the bottom.
1712 =item sqltrue, sqlfalse
1714 Expressions for inserting boolean values within SQL statements.
1715 By default these are C<1=1> and C<1=0>. They are used
1716 by the special operators C<-in> and C<-not_in> for generating
1717 correct SQL even when the argument is an empty array (see below).
1721 This determines the default logical operator for multiple WHERE
1722 statements in arrays or hashes. If absent, the default logic is "or"
1723 for arrays, and "and" for hashes. This means that a WHERE
1727 event_date => {'>=', '2/13/99'},
1728 event_date => {'<=', '4/24/03'},
1731 will generate SQL like this:
1733 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1735 This is probably not what you want given this query, though (look
1736 at the dates). To change the "OR" to an "AND", simply specify:
1738 my $sql = SQL::Abstract->new(logic => 'and');
1740 Which will change the above C<WHERE> to:
1742 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1744 The logic can also be changed locally by inserting
1745 a modifier in front of an arrayref:
1747 @where = (-and => [event_date => {'>=', '2/13/99'},
1748 event_date => {'<=', '4/24/03'} ]);
1750 See the L</"WHERE CLAUSES"> section for explanations.
1754 This will automatically convert comparisons using the specified SQL
1755 function for both column and value. This is mostly used with an argument
1756 of C<upper> or C<lower>, so that the SQL will have the effect of
1757 case-insensitive "searches". For example, this:
1759 $sql = SQL::Abstract->new(convert => 'upper');
1760 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1762 Will turn out the following SQL:
1764 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1766 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1767 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1768 not validate this option; it will just pass through what you specify verbatim).
1772 This is a kludge because many databases suck. For example, you can't
1773 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1774 Instead, you have to use C<bind_param()>:
1776 $sth->bind_param(1, 'reg data');
1777 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1779 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1780 which loses track of which field each slot refers to. Fear not.
1782 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1783 Currently, you can specify either C<normal> (default) or C<columns>. If you
1784 specify C<columns>, you will get an array that looks like this:
1786 my $sql = SQL::Abstract->new(bindtype => 'columns');
1787 my($stmt, @bind) = $sql->insert(...);
1790 [ 'column1', 'value1' ],
1791 [ 'column2', 'value2' ],
1792 [ 'column3', 'value3' ],
1795 You can then iterate through this manually, using DBI's C<bind_param()>.
1797 $sth->prepare($stmt);
1800 my($col, $data) = @$_;
1801 if ($col eq 'details' || $col eq 'comments') {
1802 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1803 } elsif ($col eq 'image') {
1804 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1806 $sth->bind_param($i, $data);
1810 $sth->execute; # execute without @bind now
1812 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1813 Basically, the advantage is still that you don't have to care which fields
1814 are or are not included. You could wrap that above C<for> loop in a simple
1815 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1816 get a layer of abstraction over manual SQL specification.
1818 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1819 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1820 will expect the bind values in this format.
1824 This is the character that a table or column name will be quoted
1825 with. By default this is an empty string, but you could set it to
1826 the character C<`>, to generate SQL like this:
1828 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1830 Alternatively, you can supply an array ref of two items, the first being the left
1831 hand quote character, and the second the right hand quote character. For
1832 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1833 that generates SQL like this:
1835 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1837 Quoting is useful if you have tables or columns names that are reserved
1838 words in your database's SQL dialect.
1842 This is the character that will be used to escape L</quote_char>s appearing
1843 in an identifier before it has been quoted.
1845 The parameter default in case of a single L</quote_char> character is the quote
1848 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1849 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1850 of the B<opening (left)> L</quote_char> within the identifier are currently left
1851 untouched. The default for opening-closing-style quotes may change in future
1852 versions, thus you are B<strongly encouraged> to specify the escape character
1857 This is the character that separates a table and column name. It is
1858 necessary to specify this when the C<quote_char> option is selected,
1859 so that tables and column names can be individually quoted like this:
1861 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1863 =item injection_guard
1865 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1866 column name specified in a query structure. This is a safety mechanism to avoid
1867 injection attacks when mishandling user input e.g.:
1869 my %condition_as_column_value_pairs = get_values_from_user();
1870 $sqla->select( ... , \%condition_as_column_value_pairs );
1872 If the expression matches an exception is thrown. Note that literal SQL
1873 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1875 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1877 =item array_datatypes
1879 When this option is true, arrayrefs in INSERT or UPDATE are
1880 interpreted as array datatypes and are passed directly
1882 When this option is false, arrayrefs are interpreted
1883 as literal SQL, just like refs to arrayrefs
1884 (but this behavior is for backwards compatibility; when writing
1885 new queries, use the "reference to arrayref" syntax
1891 Takes a reference to a list of "special operators"
1892 to extend the syntax understood by L<SQL::Abstract>.
1893 See section L</"SPECIAL OPERATORS"> for details.
1897 Takes a reference to a list of "unary operators"
1898 to extend the syntax understood by L<SQL::Abstract>.
1899 See section L</"UNARY OPERATORS"> for details.
1905 =head2 insert($table, \@values || \%fieldvals, \%options)
1907 This is the simplest function. You simply give it a table name
1908 and either an arrayref of values or hashref of field/value pairs.
1909 It returns an SQL INSERT statement and a list of bind values.
1910 See the sections on L</"Inserting and Updating Arrays"> and
1911 L</"Inserting and Updating SQL"> for information on how to insert
1912 with those data types.
1914 The optional C<\%options> hash reference may contain additional
1915 options to generate the insert SQL. Currently supported options
1922 Takes either a scalar of raw SQL fields, or an array reference of
1923 field names, and adds on an SQL C<RETURNING> statement at the end.
1924 This allows you to return data generated by the insert statement
1925 (such as row IDs) without performing another C<SELECT> statement.
1926 Note, however, this is not part of the SQL standard and may not
1927 be supported by all database engines.
1931 =head2 update($table, \%fieldvals, \%where, \%options)
1933 This takes a table, hashref of field/value pairs, and an optional
1934 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1936 See the sections on L</"Inserting and Updating Arrays"> and
1937 L</"Inserting and Updating SQL"> for information on how to insert
1938 with those data types.
1940 The optional C<\%options> hash reference may contain additional
1941 options to generate the update SQL. Currently supported options
1948 See the C<returning> option to
1949 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1953 =head2 select($source, $fields, $where, $order)
1955 This returns a SQL SELECT statement and associated list of bind values, as
1956 specified by the arguments:
1962 Specification of the 'FROM' part of the statement.
1963 The argument can be either a plain scalar (interpreted as a table
1964 name, will be quoted), or an arrayref (interpreted as a list
1965 of table names, joined by commas, quoted), or a scalarref
1966 (literal SQL, not quoted).
1970 Specification of the list of fields to retrieve from
1972 The argument can be either an arrayref (interpreted as a list
1973 of field names, will be joined by commas and quoted), or a
1974 plain scalar (literal SQL, not quoted).
1975 Please observe that this API is not as flexible as that of
1976 the first argument C<$source>, for backwards compatibility reasons.
1980 Optional argument to specify the WHERE part of the query.
1981 The argument is most often a hashref, but can also be
1982 an arrayref or plain scalar --
1983 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1987 Optional argument to specify the ORDER BY part of the query.
1988 The argument can be a scalar, a hashref or an arrayref
1989 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1995 =head2 delete($table, \%where, \%options)
1997 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1998 It returns an SQL DELETE statement and list of bind values.
2000 The optional C<\%options> hash reference may contain additional
2001 options to generate the delete SQL. Currently supported options
2008 See the C<returning> option to
2009 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2013 =head2 where(\%where, $order)
2015 This is used to generate just the WHERE clause. For example,
2016 if you have an arbitrary data structure and know what the
2017 rest of your SQL is going to look like, but want an easy way
2018 to produce a WHERE clause, use this. It returns an SQL WHERE
2019 clause and list of bind values.
2022 =head2 values(\%data)
2024 This just returns the values from the hash C<%data>, in the same
2025 order that would be returned from any of the other above queries.
2026 Using this allows you to markedly speed up your queries if you
2027 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2029 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2031 Warning: This is an experimental method and subject to change.
2033 This returns arbitrarily generated SQL. It's a really basic shortcut.
2034 It will return two different things, depending on return context:
2036 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2037 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2039 These would return the following:
2041 # First calling form
2042 $stmt = "CREATE TABLE test (?, ?)";
2043 @bind = (field1, field2);
2045 # Second calling form
2046 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2048 Depending on what you're trying to do, it's up to you to choose the correct
2049 format. In this example, the second form is what you would want.
2053 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2057 ALTER SESSION SET nls_date_format = 'MM/YY'
2059 You get the idea. Strings get their case twiddled, but everything
2060 else remains verbatim.
2062 =head1 EXPORTABLE FUNCTIONS
2064 =head2 is_plain_value
2066 Determines if the supplied argument is a plain value as understood by this
2071 =item * The value is C<undef>
2073 =item * The value is a non-reference
2075 =item * The value is an object with stringification overloading
2077 =item * The value is of the form C<< { -value => $anything } >>
2081 On failure returns C<undef>, on success returns a B<scalar> reference
2082 to the original supplied argument.
2088 The stringification overloading detection is rather advanced: it takes
2089 into consideration not only the presence of a C<""> overload, but if that
2090 fails also checks for enabled
2091 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2092 on either C<0+> or C<bool>.
2094 Unfortunately testing in the field indicates that this
2095 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2096 but only when very large numbers of stringifying objects are involved.
2097 At the time of writing ( Sep 2014 ) there is no clear explanation of
2098 the direct cause, nor is there a manageably small test case that reliably
2099 reproduces the problem.
2101 If you encounter any of the following exceptions in B<random places within
2102 your application stack> - this module may be to blame:
2104 Operation "ne": no method found,
2105 left argument in overloaded package <something>,
2106 right argument in overloaded package <something>
2110 Stub found while resolving method "???" overloading """" in package <something>
2112 If you fall victim to the above - please attempt to reduce the problem
2113 to something that could be sent to the L<SQL::Abstract developers
2114 |DBIx::Class/GETTING HELP/SUPPORT>
2115 (either publicly or privately). As a workaround in the meantime you can
2116 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2117 value, which will most likely eliminate your problem (at the expense of
2118 not being able to properly detect exotic forms of stringification).
2120 This notice and environment variable will be removed in a future version,
2121 as soon as the underlying problem is found and a reliable workaround is
2126 =head2 is_literal_value
2128 Determines if the supplied argument is a literal value as understood by this
2133 =item * C<\$sql_string>
2135 =item * C<\[ $sql_string, @bind_values ]>
2139 On failure returns C<undef>, on success returns an B<array> reference
2140 containing the unpacked version of the supplied literal SQL and bind values.
2142 =head1 WHERE CLAUSES
2146 This module uses a variation on the idea from L<DBIx::Abstract>. It
2147 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2148 module is that things in arrays are OR'ed, and things in hashes
2151 The easiest way to explain is to show lots of examples. After
2152 each C<%where> hash shown, it is assumed you used:
2154 my($stmt, @bind) = $sql->where(\%where);
2156 However, note that the C<%where> hash can be used directly in any
2157 of the other functions as well, as described above.
2159 =head2 Key-value pairs
2161 So, let's get started. To begin, a simple hash:
2165 status => 'completed'
2168 Is converted to SQL C<key = val> statements:
2170 $stmt = "WHERE user = ? AND status = ?";
2171 @bind = ('nwiger', 'completed');
2173 One common thing I end up doing is having a list of values that
2174 a field can be in. To do this, simply specify a list inside of
2179 status => ['assigned', 'in-progress', 'pending'];
2182 This simple code will create the following:
2184 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2185 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2187 A field associated to an empty arrayref will be considered a
2188 logical false and will generate 0=1.
2190 =head2 Tests for NULL values
2192 If the value part is C<undef> then this is converted to SQL <IS NULL>
2201 $stmt = "WHERE user = ? AND status IS NULL";
2204 To test if a column IS NOT NULL:
2208 status => { '!=', undef },
2211 =head2 Specific comparison operators
2213 If you want to specify a different type of operator for your comparison,
2214 you can use a hashref for a given column:
2218 status => { '!=', 'completed' }
2221 Which would generate:
2223 $stmt = "WHERE user = ? AND status != ?";
2224 @bind = ('nwiger', 'completed');
2226 To test against multiple values, just enclose the values in an arrayref:
2228 status => { '=', ['assigned', 'in-progress', 'pending'] };
2230 Which would give you:
2232 "WHERE status = ? OR status = ? OR status = ?"
2235 The hashref can also contain multiple pairs, in which case it is expanded
2236 into an C<AND> of its elements:
2240 status => { '!=', 'completed', -not_like => 'pending%' }
2243 # Or more dynamically, like from a form
2244 $where{user} = 'nwiger';
2245 $where{status}{'!='} = 'completed';
2246 $where{status}{'-not_like'} = 'pending%';
2248 # Both generate this
2249 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2250 @bind = ('nwiger', 'completed', 'pending%');
2253 To get an OR instead, you can combine it with the arrayref idea:
2257 priority => [ { '=', 2 }, { '>', 5 } ]
2260 Which would generate:
2262 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2263 @bind = ('2', '5', 'nwiger');
2265 If you want to include literal SQL (with or without bind values), just use a
2266 scalar reference or reference to an arrayref as the value:
2269 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2270 date_expires => { '<' => \"now()" }
2273 Which would generate:
2275 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2276 @bind = ('11/26/2008');
2279 =head2 Logic and nesting operators
2281 In the example above,
2282 there is a subtle trap if you want to say something like
2283 this (notice the C<AND>):
2285 WHERE priority != ? AND priority != ?
2287 Because, in Perl you I<can't> do this:
2289 priority => { '!=' => 2, '!=' => 1 }
2291 As the second C<!=> key will obliterate the first. The solution
2292 is to use the special C<-modifier> form inside an arrayref:
2294 priority => [ -and => {'!=', 2},
2298 Normally, these would be joined by C<OR>, but the modifier tells it
2299 to use C<AND> instead. (Hint: You can use this in conjunction with the
2300 C<logic> option to C<new()> in order to change the way your queries
2301 work by default.) B<Important:> Note that the C<-modifier> goes
2302 B<INSIDE> the arrayref, as an extra first element. This will
2303 B<NOT> do what you think it might:
2305 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2307 Here is a quick list of equivalencies, since there is some overlap:
2310 status => {'!=', 'completed', 'not like', 'pending%' }
2311 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2314 status => {'=', ['assigned', 'in-progress']}
2315 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2316 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2320 =head2 Special operators: IN, BETWEEN, etc.
2322 You can also use the hashref format to compare a list of fields using the
2323 C<IN> comparison operator, by specifying the list as an arrayref:
2326 status => 'completed',
2327 reportid => { -in => [567, 2335, 2] }
2330 Which would generate:
2332 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2333 @bind = ('completed', '567', '2335', '2');
2335 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2338 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2339 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2340 'sqltrue' (by default: C<1=1>).
2342 In addition to the array you can supply a chunk of literal sql or
2343 literal sql with bind:
2346 customer => { -in => \[
2347 'SELECT cust_id FROM cust WHERE balance > ?',
2350 status => { -in => \'SELECT status_codes FROM states' },
2356 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2357 AND status IN ( SELECT status_codes FROM states )
2361 Finally, if the argument to C<-in> is not a reference, it will be
2362 treated as a single-element array.
2364 Another pair of operators is C<-between> and C<-not_between>,
2365 used with an arrayref of two values:
2369 completion_date => {
2370 -not_between => ['2002-10-01', '2003-02-06']
2376 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2378 Just like with C<-in> all plausible combinations of literal SQL
2382 start0 => { -between => [ 1, 2 ] },
2383 start1 => { -between => \["? AND ?", 1, 2] },
2384 start2 => { -between => \"lower(x) AND upper(y)" },
2385 start3 => { -between => [
2387 \["upper(?)", 'stuff' ],
2394 ( start0 BETWEEN ? AND ? )
2395 AND ( start1 BETWEEN ? AND ? )
2396 AND ( start2 BETWEEN lower(x) AND upper(y) )
2397 AND ( start3 BETWEEN lower(x) AND upper(?) )
2399 @bind = (1, 2, 1, 2, 'stuff');
2402 These are the two builtin "special operators"; but the
2403 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2405 =head2 Unary operators: bool
2407 If you wish to test against boolean columns or functions within your
2408 database you can use the C<-bool> and C<-not_bool> operators. For
2409 example to test the column C<is_user> being true and the column
2410 C<is_enabled> being false you would use:-
2414 -not_bool => 'is_enabled',
2419 WHERE is_user AND NOT is_enabled
2421 If a more complex combination is required, testing more conditions,
2422 then you should use the and/or operators:-
2427 -not_bool => { two=> { -rlike => 'bar' } },
2428 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2439 (NOT ( three = ? OR three > ? ))
2442 =head2 Nested conditions, -and/-or prefixes
2444 So far, we've seen how multiple conditions are joined with a top-level
2445 C<AND>. We can change this by putting the different conditions we want in
2446 hashes and then putting those hashes in an array. For example:
2451 status => { -like => ['pending%', 'dispatched'] },
2455 status => 'unassigned',
2459 This data structure would create the following:
2461 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2462 OR ( user = ? AND status = ? ) )";
2463 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2466 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2467 to change the logic inside:
2473 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2474 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2481 $stmt = "WHERE ( user = ?
2482 AND ( ( workhrs > ? AND geo = ? )
2483 OR ( workhrs < ? OR geo = ? ) ) )";
2484 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2486 =head3 Algebraic inconsistency, for historical reasons
2488 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2489 operator goes C<outside> of the nested structure; whereas when connecting
2490 several constraints on one column, the C<-and> operator goes
2491 C<inside> the arrayref. Here is an example combining both features:
2494 -and => [a => 1, b => 2],
2495 -or => [c => 3, d => 4],
2496 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2501 WHERE ( ( ( a = ? AND b = ? )
2502 OR ( c = ? OR d = ? )
2503 OR ( e LIKE ? AND e LIKE ? ) ) )
2505 This difference in syntax is unfortunate but must be preserved for
2506 historical reasons. So be careful: the two examples below would
2507 seem algebraically equivalent, but they are not
2510 { -like => 'foo%' },
2511 { -like => '%bar' },
2513 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2516 { col => { -like => 'foo%' } },
2517 { col => { -like => '%bar' } },
2519 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2522 =head2 Literal SQL and value type operators
2524 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2525 side" is a column name and the "right side" is a value (normally rendered as
2526 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2527 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2528 alter this behavior. There are several ways of doing so.
2532 This is a virtual operator that signals the string to its right side is an
2533 identifier (a column name) and not a value. For example to compare two
2534 columns you would write:
2537 priority => { '<', 2 },
2538 requestor => { -ident => 'submitter' },
2543 $stmt = "WHERE priority < ? AND requestor = submitter";
2546 If you are maintaining legacy code you may see a different construct as
2547 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2552 This is a virtual operator that signals that the construct to its right side
2553 is a value to be passed to DBI. This is for example necessary when you want
2554 to write a where clause against an array (for RDBMS that support such
2555 datatypes). For example:
2558 array => { -value => [1, 2, 3] }
2563 $stmt = 'WHERE array = ?';
2564 @bind = ([1, 2, 3]);
2566 Note that if you were to simply say:
2572 the result would probably not be what you wanted:
2574 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2579 Finally, sometimes only literal SQL will do. To include a random snippet
2580 of SQL verbatim, you specify it as a scalar reference. Consider this only
2581 as a last resort. Usually there is a better way. For example:
2584 priority => { '<', 2 },
2585 requestor => { -in => \'(SELECT name FROM hitmen)' },
2590 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2593 Note that in this example, you only get one bind parameter back, since
2594 the verbatim SQL is passed as part of the statement.
2598 Never use untrusted input as a literal SQL argument - this is a massive
2599 security risk (there is no way to check literal snippets for SQL
2600 injections and other nastyness). If you need to deal with untrusted input
2601 use literal SQL with placeholders as described next.
2603 =head3 Literal SQL with placeholders and bind values (subqueries)
2605 If the literal SQL to be inserted has placeholders and bind values,
2606 use a reference to an arrayref (yes this is a double reference --
2607 not so common, but perfectly legal Perl). For example, to find a date
2608 in Postgres you can use something like this:
2611 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2616 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2619 Note that you must pass the bind values in the same format as they are returned
2620 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2621 to C<columns>, you must provide the bind values in the
2622 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2623 scalar value; most commonly the column name, but you can use any scalar value
2624 (including references and blessed references), L<SQL::Abstract> will simply
2625 pass it through intact. So if C<bindtype> is set to C<columns> the above
2626 example will look like:
2629 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2632 Literal SQL is especially useful for nesting parenthesized clauses in the
2633 main SQL query. Here is a first example:
2635 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2639 bar => \["IN ($sub_stmt)" => @sub_bind],
2644 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2645 WHERE c2 < ? AND c3 LIKE ?))";
2646 @bind = (1234, 100, "foo%");
2648 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2649 are expressed in the same way. Of course the C<$sub_stmt> and
2650 its associated bind values can be generated through a former call
2653 my ($sub_stmt, @sub_bind)
2654 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2655 c3 => {-like => "foo%"}});
2658 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2661 In the examples above, the subquery was used as an operator on a column;
2662 but the same principle also applies for a clause within the main C<%where>
2663 hash, like an EXISTS subquery:
2665 my ($sub_stmt, @sub_bind)
2666 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2667 my %where = ( -and => [
2669 \["EXISTS ($sub_stmt)" => @sub_bind],
2674 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2675 WHERE c1 = ? AND c2 > t0.c0))";
2679 Observe that the condition on C<c2> in the subquery refers to
2680 column C<t0.c0> of the main query: this is I<not> a bind
2681 value, so we have to express it through a scalar ref.
2682 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2683 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2684 what we wanted here.
2686 Finally, here is an example where a subquery is used
2687 for expressing unary negation:
2689 my ($sub_stmt, @sub_bind)
2690 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2691 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2693 lname => {like => '%son%'},
2694 \["NOT ($sub_stmt)" => @sub_bind],
2699 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2700 @bind = ('%son%', 10, 20)
2702 =head3 Deprecated usage of Literal SQL
2704 Below are some examples of archaic use of literal SQL. It is shown only as
2705 reference for those who deal with legacy code. Each example has a much
2706 better, cleaner and safer alternative that users should opt for in new code.
2712 my %where = ( requestor => \'IS NOT NULL' )
2714 $stmt = "WHERE requestor IS NOT NULL"
2716 This used to be the way of generating NULL comparisons, before the handling
2717 of C<undef> got formalized. For new code please use the superior syntax as
2718 described in L</Tests for NULL values>.
2722 my %where = ( requestor => \'= submitter' )
2724 $stmt = "WHERE requestor = submitter"
2726 This used to be the only way to compare columns. Use the superior L</-ident>
2727 method for all new code. For example an identifier declared in such a way
2728 will be properly quoted if L</quote_char> is properly set, while the legacy
2729 form will remain as supplied.
2733 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2735 $stmt = "WHERE completed > ? AND is_ready"
2736 @bind = ('2012-12-21')
2738 Using an empty string literal used to be the only way to express a boolean.
2739 For all new code please use the much more readable
2740 L<-bool|/Unary operators: bool> operator.
2746 These pages could go on for a while, since the nesting of the data
2747 structures this module can handle are pretty much unlimited (the
2748 module implements the C<WHERE> expansion as a recursive function
2749 internally). Your best bet is to "play around" with the module a
2750 little to see how the data structures behave, and choose the best
2751 format for your data based on that.
2753 And of course, all the values above will probably be replaced with
2754 variables gotten from forms or the command line. After all, if you
2755 knew everything ahead of time, you wouldn't have to worry about
2756 dynamically-generating SQL and could just hardwire it into your
2759 =head1 ORDER BY CLAUSES
2761 Some functions take an order by clause. This can either be a scalar (just a
2762 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2763 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2766 Given | Will Generate
2767 ---------------------------------------------------------------
2769 'colA' | ORDER BY colA
2771 [qw/colA colB/] | ORDER BY colA, colB
2773 {-asc => 'colA'} | ORDER BY colA ASC
2775 {-desc => 'colB'} | ORDER BY colB DESC
2777 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2779 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2781 \'colA DESC' | ORDER BY colA DESC
2783 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2784 | /* ...with $x bound to ? */
2787 { -asc => 'colA' }, | colA ASC,
2788 { -desc => [qw/colB/] }, | colB DESC,
2789 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2790 \'colE DESC', | colE DESC,
2791 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2792 ] | /* ...with $x bound to ? */
2793 ===============================================================
2797 =head1 SPECIAL OPERATORS
2799 my $sqlmaker = SQL::Abstract->new(special_ops => [
2803 my ($self, $field, $op, $arg) = @_;
2809 handler => 'method_name',
2813 A "special operator" is a SQL syntactic clause that can be
2814 applied to a field, instead of a usual binary operator.
2817 WHERE field IN (?, ?, ?)
2818 WHERE field BETWEEN ? AND ?
2819 WHERE MATCH(field) AGAINST (?, ?)
2821 Special operators IN and BETWEEN are fairly standard and therefore
2822 are builtin within C<SQL::Abstract> (as the overridable methods
2823 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2824 like the MATCH .. AGAINST example above which is specific to MySQL,
2825 you can write your own operator handlers - supply a C<special_ops>
2826 argument to the C<new> method. That argument takes an arrayref of
2827 operator definitions; each operator definition is a hashref with two
2834 the regular expression to match the operator
2838 Either a coderef or a plain scalar method name. In both cases
2839 the expected return is C<< ($sql, @bind) >>.
2841 When supplied with a method name, it is simply called on the
2842 L<SQL::Abstract> object as:
2844 $self->$method_name($field, $op, $arg)
2848 $field is the LHS of the operator
2849 $op is the part that matched the handler regex
2852 When supplied with a coderef, it is called as:
2854 $coderef->($self, $field, $op, $arg)
2859 For example, here is an implementation
2860 of the MATCH .. AGAINST syntax for MySQL
2862 my $sqlmaker = SQL::Abstract->new(special_ops => [
2864 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2865 {regex => qr/^match$/i,
2867 my ($self, $field, $op, $arg) = @_;
2868 $arg = [$arg] if not ref $arg;
2869 my $label = $self->_quote($field);
2870 my ($placeholder) = $self->_convert('?');
2871 my $placeholders = join ", ", (($placeholder) x @$arg);
2872 my $sql = $self->_sqlcase('match') . " ($label) "
2873 . $self->_sqlcase('against') . " ($placeholders) ";
2874 my @bind = $self->_bindtype($field, @$arg);
2875 return ($sql, @bind);
2882 =head1 UNARY OPERATORS
2884 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2888 my ($self, $op, $arg) = @_;
2894 handler => 'method_name',
2898 A "unary operator" is a SQL syntactic clause that can be
2899 applied to a field - the operator goes before the field
2901 You can write your own operator handlers - supply a C<unary_ops>
2902 argument to the C<new> method. That argument takes an arrayref of
2903 operator definitions; each operator definition is a hashref with two
2910 the regular expression to match the operator
2914 Either a coderef or a plain scalar method name. In both cases
2915 the expected return is C<< $sql >>.
2917 When supplied with a method name, it is simply called on the
2918 L<SQL::Abstract> object as:
2920 $self->$method_name($op, $arg)
2924 $op is the part that matched the handler regex
2925 $arg is the RHS or argument of the operator
2927 When supplied with a coderef, it is called as:
2929 $coderef->($self, $op, $arg)
2937 Thanks to some benchmarking by Mark Stosberg, it turns out that
2938 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2939 I must admit this wasn't an intentional design issue, but it's a
2940 byproduct of the fact that you get to control your C<DBI> handles
2943 To maximize performance, use a code snippet like the following:
2945 # prepare a statement handle using the first row
2946 # and then reuse it for the rest of the rows
2948 for my $href (@array_of_hashrefs) {
2949 $stmt ||= $sql->insert('table', $href);
2950 $sth ||= $dbh->prepare($stmt);
2951 $sth->execute($sql->values($href));
2954 The reason this works is because the keys in your C<$href> are sorted
2955 internally by B<SQL::Abstract>. Thus, as long as your data retains
2956 the same structure, you only have to generate the SQL the first time
2957 around. On subsequent queries, simply use the C<values> function provided
2958 by this module to return your values in the correct order.
2960 However this depends on the values having the same type - if, for
2961 example, the values of a where clause may either have values
2962 (resulting in sql of the form C<column = ?> with a single bind
2963 value), or alternatively the values might be C<undef> (resulting in
2964 sql of the form C<column IS NULL> with no bind value) then the
2965 caching technique suggested will not work.
2969 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2970 really like this part (I do, at least). Building up a complex query
2971 can be as simple as the following:
2978 use CGI::FormBuilder;
2981 my $form = CGI::FormBuilder->new(...);
2982 my $sql = SQL::Abstract->new;
2984 if ($form->submitted) {
2985 my $field = $form->field;
2986 my $id = delete $field->{id};
2987 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2990 Of course, you would still have to connect using C<DBI> to run the
2991 query, but the point is that if you make your form look like your
2992 table, the actual query script can be extremely simplistic.
2994 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2995 a fast interface to returning and formatting data. I frequently
2996 use these three modules together to write complex database query
2997 apps in under 50 lines.
2999 =head1 HOW TO CONTRIBUTE
3001 Contributions are always welcome, in all usable forms (we especially
3002 welcome documentation improvements). The delivery methods include git-
3003 or unified-diff formatted patches, GitHub pull requests, or plain bug
3004 reports either via RT or the Mailing list. Contributors are generally
3005 granted full access to the official repository after their first several
3006 patches pass successful review.
3008 This project is maintained in a git repository. The code and related tools are
3009 accessible at the following locations:
3013 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3015 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3017 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3019 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3025 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3026 Great care has been taken to preserve the I<published> behavior
3027 documented in previous versions in the 1.* family; however,
3028 some features that were previously undocumented, or behaved
3029 differently from the documentation, had to be changed in order
3030 to clarify the semantics. Hence, client code that was relying
3031 on some dark areas of C<SQL::Abstract> v1.*
3032 B<might behave differently> in v1.50.
3034 The main changes are:
3040 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3044 support for the { operator => \"..." } construct (to embed literal SQL)
3048 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3052 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3056 defensive programming: check arguments
3060 fixed bug with global logic, which was previously implemented
3061 through global variables yielding side-effects. Prior versions would
3062 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3063 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3064 Now this is interpreted
3065 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3070 fixed semantics of _bindtype on array args
3074 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3075 we just avoid shifting arrays within that tree.
3079 dropped the C<_modlogic> function
3083 =head1 ACKNOWLEDGEMENTS
3085 There are a number of individuals that have really helped out with
3086 this module. Unfortunately, most of them submitted bugs via CPAN
3087 so I have no idea who they are! But the people I do know are:
3089 Ash Berlin (order_by hash term support)
3090 Matt Trout (DBIx::Class support)
3091 Mark Stosberg (benchmarking)
3092 Chas Owens (initial "IN" operator support)
3093 Philip Collins (per-field SQL functions)
3094 Eric Kolve (hashref "AND" support)
3095 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3096 Dan Kubb (support for "quote_char" and "name_sep")
3097 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3098 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3099 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3100 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3101 Oliver Charles (support for "RETURNING" after "INSERT")
3107 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3111 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3113 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3115 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3116 While not an official support venue, C<DBIx::Class> makes heavy use of
3117 C<SQL::Abstract>, and as such list members there are very familiar with
3118 how to create queries.
3122 This module is free software; you may copy this under the same
3123 terms as perl itself (either the GNU General Public License or
3124 the Artistic License)