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/
187 $opt{expand_unary} = {};
190 -not => '_expand_not',
191 -bool => '_expand_bool',
192 -and => '_expand_op_andor',
193 -or => '_expand_op_andor',
194 -nest => '_expand_nest',
198 'between' => '_expand_between',
199 'not between' => '_expand_between',
200 'in' => '_expand_in',
201 'not in' => '_expand_in',
202 'nest' => '_expand_nest',
203 (map +($_ => '_expand_op_andor'), ('and', 'or')),
204 (map +($_ => '_expand_op_is'), ('is', 'is not')),
207 # placeholder for _expand_unop system
209 my %unops = (-ident => '_expand_ident', -value => '_expand_value');
210 foreach my $name (keys %unops) {
211 $opt{expand}{$name} = $unops{$name};
212 my ($op) = $name =~ /^-(.*)$/;
213 $opt{expand_op}{$op} = sub {
214 my ($self, $op, $arg, $k) = @_;
217 $self->_expand_ident(-ident => $k),
218 $self->_expand_expr({ '-'.$op => $arg }),
225 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
230 (map +($_ => '_render_op_between'), 'between', 'not between'),
231 (map +($_ => '_render_op_in'), 'in', 'not in'),
232 (map +($_ => '_render_unop_postfix'),
233 'is null', 'is not null', 'asc', 'desc',
235 (not => '_render_op_not'),
236 (map +($_ => '_render_op_andor'), qw(and or)),
239 return bless \%opt, $class;
242 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
243 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
245 sub _assert_pass_injection_guard {
246 if ($_[1] =~ $_[0]->{injection_guard}) {
247 my $class = ref $_[0];
248 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
249 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
250 . "{injection_guard} attribute to ${class}->new()"
255 #======================================================================
257 #======================================================================
261 my $table = $self->_table(shift);
262 my $data = shift || return;
265 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
266 my ($sql, @bind) = $self->$method($data);
267 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
269 if ($options->{returning}) {
270 my ($s, @b) = $self->_insert_returning($options);
275 return wantarray ? ($sql, @bind) : $sql;
278 # So that subclasses can override INSERT ... RETURNING separately from
279 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
280 sub _insert_returning { shift->_returning(@_) }
283 my ($self, $options) = @_;
285 my $f = $options->{returning};
287 my ($sql, @bind) = $self->render_aqt(
288 $self->_expand_maybe_list_expr($f, undef, -ident)
291 ? $self->_sqlcase(' returning ') . $sql
292 : ($self->_sqlcase(' returning ').$sql, @bind);
295 sub _insert_HASHREF { # explicit list of fields and then values
296 my ($self, $data) = @_;
298 my @fields = sort keys %$data;
300 my ($sql, @bind) = $self->_insert_values($data);
303 $_ = $self->_quote($_) foreach @fields;
304 $sql = "( ".join(", ", @fields).") ".$sql;
306 return ($sql, @bind);
309 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
310 my ($self, $data) = @_;
312 # no names (arrayref) so can't generate bindtype
313 $self->{bindtype} ne 'columns'
314 or belch "can't do 'columns' bindtype when called with arrayref";
316 my (@values, @all_bind);
317 foreach my $value (@$data) {
318 my ($values, @bind) = $self->_insert_value(undef, $value);
319 push @values, $values;
320 push @all_bind, @bind;
322 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
323 return ($sql, @all_bind);
326 sub _insert_ARRAYREFREF { # literal SQL with bind
327 my ($self, $data) = @_;
329 my ($sql, @bind) = @${$data};
330 $self->_assert_bindval_matches_bindtype(@bind);
332 return ($sql, @bind);
336 sub _insert_SCALARREF { # literal SQL without bind
337 my ($self, $data) = @_;
343 my ($self, $data) = @_;
345 my (@values, @all_bind);
346 foreach my $column (sort keys %$data) {
347 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
348 push @values, $values;
349 push @all_bind, @bind;
351 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
352 return ($sql, @all_bind);
356 my ($self, $column, $v) = @_;
358 return $self->render_aqt(
359 $self->_expand_insert_value($column, $v)
363 sub _expand_insert_value {
364 my ($self, $column, $v) = @_;
366 if (ref($v) eq 'ARRAY') {
367 if ($self->{array_datatypes}) {
368 return +{ -bind => [ $column, $v ] };
370 my ($sql, @bind) = @$v;
371 $self->_assert_bindval_matches_bindtype(@bind);
372 return +{ -literal => $v };
374 if (ref($v) eq 'HASH') {
375 if (grep !/^-/, keys %$v) {
376 belch "HASH ref as bind value in insert is not supported";
377 return +{ -bind => [ $column, $v ] };
381 return +{ -bind => [ $column, undef ] };
383 local our $Cur_Col_Meta = $column;
384 return $self->expand_expr($v);
389 #======================================================================
391 #======================================================================
396 my $table = $self->_table(shift);
397 my $data = shift || return;
401 # first build the 'SET' part of the sql statement
402 puke "Unsupported data type specified to \$sql->update"
403 unless ref $data eq 'HASH';
405 my ($sql, @all_bind) = $self->_update_set_values($data);
406 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
410 my($where_sql, @where_bind) = $self->where($where);
412 push @all_bind, @where_bind;
415 if ($options->{returning}) {
416 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
417 $sql .= $returning_sql;
418 push @all_bind, @returning_bind;
421 return wantarray ? ($sql, @all_bind) : $sql;
424 sub _update_set_values {
425 my ($self, $data) = @_;
427 return $self->render_aqt(
428 $self->_expand_update_set_values($data),
432 sub _expand_update_set_values {
433 my ($self, $data) = @_;
434 $self->_expand_maybe_list_expr( [
437 $set = { -bind => $_ } unless defined $set;
438 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
444 ? ($self->{array_datatypes}
445 ? [ $k, +{ -bind => [ $k, $v ] } ]
446 : [ $k, +{ -literal => $v } ])
448 local our $Cur_Col_Meta = $k;
449 [ $k, $self->_expand_expr($v) ]
456 # So that subclasses can override UPDATE ... RETURNING separately from
458 sub _update_returning { shift->_returning(@_) }
462 #======================================================================
464 #======================================================================
469 my $table = $self->_table(shift);
470 my $fields = shift || '*';
474 my ($fields_sql, @bind) = $self->_select_fields($fields);
476 my ($where_sql, @where_bind) = $self->where($where, $order);
477 push @bind, @where_bind;
479 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
480 $self->_sqlcase('from'), $table)
483 return wantarray ? ($sql, @bind) : $sql;
487 my ($self, $fields) = @_;
488 return $fields unless ref($fields);
489 return $self->render_aqt(
490 $self->_expand_maybe_list_expr($fields, undef, '-ident')
494 #======================================================================
496 #======================================================================
501 my $table = $self->_table(shift);
505 my($where_sql, @bind) = $self->where($where);
506 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
508 if ($options->{returning}) {
509 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
510 $sql .= $returning_sql;
511 push @bind, @returning_bind;
514 return wantarray ? ($sql, @bind) : $sql;
517 # So that subclasses can override DELETE ... RETURNING separately from
519 sub _delete_returning { shift->_returning(@_) }
523 #======================================================================
525 #======================================================================
529 # Finally, a separate routine just to handle WHERE clauses
531 my ($self, $where, $order) = @_;
533 local $self->{convert_where} = $self->{convert};
536 my ($sql, @bind) = defined($where)
537 ? $self->_recurse_where($where)
539 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
543 my ($order_sql, @order_bind) = $self->_order_by($order);
545 push @bind, @order_bind;
548 return wantarray ? ($sql, @bind) : $sql;
552 my ($self, $expr, $default_scalar_to) = @_;
553 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
554 $self->_expand_expr($expr);
558 my ($self, $aqt) = @_;
559 my ($k, $v, @rest) = %$aqt;
561 if (my $meth = $self->{render}{$k}) {
562 return $self->$meth($v);
564 die "notreached: $k";
568 my ($self, $expr) = @_;
569 $self->render_aqt($self->expand_expr($expr));
573 my ($self, $expr) = @_;
574 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
575 return undef unless defined($expr);
576 if (ref($expr) eq 'HASH') {
577 return undef unless my $kc = keys %$expr;
579 return $self->_expand_op_andor(-and => $expr);
581 my ($key, $value) = %$expr;
582 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
583 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
584 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
586 if (my $exp = $self->{expand}{$key}) {
587 return $self->$exp($key, $value);
589 return $self->_expand_expr_hashpair($key, $value);
591 if (ref($expr) eq 'ARRAY') {
592 my $logic = '-'.lc($self->{logic});
593 return $self->_expand_op_andor($logic, $expr);
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 return $self->_expand_value(-value => $expr);
607 sub _expand_expr_hashpair {
608 my ($self, $k, $v) = @_;
609 unless (defined($k) and length($k)) {
610 if (defined($k) and my $literal = is_literal_value($v)) {
611 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
612 return { -literal => $literal };
614 puke "Supplying an empty left hand side argument is not supported";
617 return $self->_expand_expr_hashpair_op($k, $v);
619 return $self->_expand_expr_hashpair_ident($k, $v);
622 sub _expand_expr_hashpair_ident {
623 my ($self, $k, $v) = @_;
625 # hash with multiple or no elements is andor
627 if (ref($v) eq 'HASH' and keys %$v != 1) {
628 return $self->_expand_op_andor(-and => $v, $k);
631 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
637 and exists $v->{-value}
638 and not defined $v->{-value}
641 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
644 my $ik = $self->_expand_ident(-ident => $k);
646 # scalars and objects get expanded as whatever requested or values
648 if (!ref($v) or Scalar::Util::blessed($v)) {
649 my $d = our $Default_Scalar_To;
650 local our $Cur_Col_Meta = $k;
651 return $self->_expand_expr_hashpair_ident(
654 ? $self->_expand_expr($d => $v)
659 if (ref($v) eq 'HASH') {
661 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
662 $self->_assert_pass_injection_guard($op);
663 if ($op =~ s/ [_\s]? \d+ $//x ) {
664 return $self->_expand_expr($k, $v);
666 if (my $x = $self->{expand_op}{$op}) {
667 local our $Cur_Col_Meta = $k;
668 return $self->$x($op, $vv, $k);
670 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
671 return { -op => [ $op, $ik, $vv ] };
673 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
677 { -op => [ $op, $vv ] }
680 if (ref($vv) eq 'ARRAY') {
682 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
683 ? shift @raw : '-or';
684 my @values = map +{ $vk => $_ }, @raw;
686 $op =~ $self->{inequality_op}
687 or $op =~ $self->{not_like_op}
689 if (lc($logic) eq '-or' and @values > 1) {
690 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
691 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
692 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
697 # try to DWIM on equality operators
699 $op =~ $self->{equality_op} ? $self->sqlfalse
700 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
701 : $op =~ $self->{inequality_op} ? $self->sqltrue
702 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
703 : puke "operator '$op' applied on an empty array (field '$k')";
705 return $self->_expand_op_andor($logic => \@values, $k);
711 and exists $vv->{-value}
712 and not defined $vv->{-value}
716 $op =~ /^not$/i ? 'is not' # legacy
717 : $op =~ $self->{equality_op} ? 'is'
718 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
719 : $op =~ $self->{inequality_op} ? 'is not'
720 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
721 : puke "unexpected operator '$op' with undef operand";
723 return $self->_expand_expr_hashpair($k => { $is, undef });
725 local our $Cur_Col_Meta = $k;
729 $self->_expand_expr($vv)
732 if (ref($v) eq 'ARRAY') {
733 return $self->sqlfalse unless @$v;
734 $self->_debug("ARRAY($k) means distribute over elements");
736 $v->[0] =~ /^-(and|or)$/i
737 ? shift(@{$v = [ @$v ]})
738 : '-'.lc($self->{logic} || 'OR')
740 return $self->_expand_op_andor(
744 if (my $literal = is_literal_value($v)) {
746 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
749 my ($sql, @bind) = @$literal;
750 if ($self->{bindtype} eq 'columns') {
752 $self->_assert_bindval_matches_bindtype($_);
755 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
760 sub _expand_expr_hashpair_op {
761 my ($self, $k, $v) = @_;
764 $op =~ s/^-// if length($op) > 1;
765 $self->_assert_pass_injection_guard($op);
767 # Ops prefixed with -not_ get converted
769 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
772 $self->_expand_expr({ "-${rest}", $v })
776 # the old special op system requires illegality for top-level use
779 (our $Expand_Depth) == 1
780 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
782 puke "Illegal use of top-level '-$op'"
785 # the old unary op system means we should touch nothing and let it work
787 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
788 return { -op => [ $op, $v ] };
791 # an explicit node type is currently assumed to be expanded (this is almost
792 # certainly wrong and there should be expansion anyway)
794 if ($self->{render}{$k}) {
798 # hashref RHS values get expanded and used as op/func args
803 and (keys %$v)[0] =~ /^-/
805 my ($func) = $k =~ /^-(.*)$/;
806 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
807 return +{ -op => [ $func, $self->_expand_expr($v) ] };
809 return +{ -func => [ $func, $self->_expand_expr($v) ] };
812 # scalars and literals get simply expanded
814 if (!ref($v) or is_literal_value($v)) {
815 return +{ -op => [ $op, $self->_expand_expr($v) ] };
822 my ($self, $op, $body) = @_;
823 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
824 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
826 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
827 ref($body) ? @$body : $body;
828 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
829 unless ($self->{quote_char}) {
830 $self->_assert_pass_injection_guard($_) for @parts;
832 return +{ -ident => \@parts };
836 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
840 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
844 my ($self, undef, $v) = @_;
846 return $self->_expand_expr($v);
848 puke "-bool => undef not supported" unless defined($v);
849 return $self->_expand_ident(-ident => $v);
852 sub _expand_op_andor {
853 my ($self, $logic, $v, $k) = @_;
855 $v = [ map +{ $k, $_ },
857 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
861 my ($logop) = $logic =~ /^-?(.*)$/;
862 if (ref($v) eq 'HASH') {
863 return undef unless keys %$v;
866 map $self->_expand_expr({ $_ => $v->{$_} }),
870 if (ref($v) eq 'ARRAY') {
871 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
874 (ref($_) eq 'ARRAY' and @$_)
875 or (ref($_) eq 'HASH' and %$_)
881 while (my ($el) = splice @expr, 0, 1) {
882 puke "Supplying an empty left hand side argument is not supported in array-pairs"
883 unless defined($el) and length($el);
884 my $elref = ref($el);
886 local our $Expand_Depth = 0;
887 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
888 } elsif ($elref eq 'ARRAY') {
889 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
890 } elsif (my $l = is_literal_value($el)) {
891 push @res, { -literal => $l };
892 } elsif ($elref eq 'HASH') {
893 local our $Expand_Depth = 0;
894 push @res, grep defined, $self->_expand_expr($el) if %$el;
900 # return $res[0] if @res == 1;
901 return { -op => [ $logop, @res ] };
907 my ($self, $op, $vv, $k) = @_;
908 puke "$op can only take undef as argument"
912 and exists($vv->{-value})
913 and !defined($vv->{-value})
915 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
918 sub _expand_between {
919 my ($self, $op, $vv, $k) = @_;
920 local our $Cur_Col_Meta = $k;
921 my @rhs = map $self->_expand_expr($_),
922 ref($vv) eq 'ARRAY' ? @$vv : $vv;
924 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
926 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
928 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
932 $self->_expand_ident(-ident => $k),
938 my ($self, $op, $vv, $k) = @_;
939 if (my $literal = is_literal_value($vv)) {
940 my ($sql, @bind) = @$literal;
941 my $opened_sql = $self->_open_outer_paren($sql);
943 $op, $self->_expand_ident(-ident => $k),
944 [ { -literal => [ $opened_sql, @bind ] } ]
948 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
949 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
950 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
951 . 'will emit the logically correct SQL instead of raising this exception)'
953 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
955 my @rhs = map $self->_expand_expr($_),
956 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
957 map { defined($_) ? $_: puke($undef_err) }
958 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
959 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
963 $self->_expand_ident(-ident => $k),
969 my ($self, $op, $v) = @_;
970 # DBIx::Class requires a nest warning to be emitted once but the private
971 # method it overrode to do so no longer exists
972 if ($self->{is_dbic_sqlmaker}) {
973 unless (our $Nest_Warned) {
975 "-nest in search conditions is deprecated, you most probably wanted:\n"
976 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
981 return $self->_expand_expr($v);
985 my ($self, $where, $logic) = @_;
987 # Special case: top level simple string treated as literal
989 my $where_exp = (ref($where)
990 ? $self->_expand_expr($where, $logic)
991 : { -literal => [ $where ] });
993 # dispatch expanded expression
995 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
996 # DBIx::Class used to call _recurse_where in scalar context
997 # something else might too...
999 return ($sql, @bind);
1002 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1008 my ($self, $ident) = @_;
1010 return $self->_convert($self->_quote($ident));
1014 my ($self, $list) = @_;
1015 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1016 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1020 my ($self, $rest) = @_;
1021 my ($func, @args) = @$rest;
1025 push @arg_sql, shift @x;
1027 } map [ $self->render_aqt($_) ], @args;
1028 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1032 my ($self, $bind) = @_;
1033 return ($self->_convert('?'), $self->_bindtype(@$bind));
1036 sub _render_literal {
1037 my ($self, $literal) = @_;
1038 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1042 sub _render_op_between {
1043 my ($self, $op, $args) = @_;
1044 my ($left, $low, $high) = @$args;
1045 my ($rhsql, @rhbind) = do {
1047 puke "Single arg to between must be a literal"
1048 unless $low->{-literal};
1051 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1052 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1053 @{$l}[1..$#$l], @{$h}[1..$#$h])
1056 my ($lhsql, @lhbind) = $self->render_aqt($left);
1058 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1064 my ($self, $op, $args) = @_;
1065 my ($lhs, $rhs) = @$args;
1068 my ($sql, @bind) = $self->render_aqt($_);
1069 push @in_bind, @bind;
1072 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1074 $lhsql.' '.$self->_sqlcase($op).' ( '
1075 .join(', ', @in_sql)
1081 sub _render_op_andor {
1082 my ($self, $op, $args) = @_;
1083 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1084 return '' unless @parts;
1085 return @{$parts[0]} if @parts == 1;
1086 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1087 return '( '.$sql.' )', @bind;
1090 sub _render_op_multop {
1091 my ($self, $op, $args) = @_;
1092 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1093 return '' unless @parts;
1094 return @{$parts[0]} if @parts == 1;
1095 my ($final_sql) = join(
1096 ' '.$self->_sqlcase($op).' ',
1101 map @{$_}[1..$#$_], @parts
1106 my ($self, $v) = @_;
1107 my ($op, @args) = @$v;
1108 if (my $r = $self->{render_op}{$op}) {
1109 return $self->$r($op, \@args);
1111 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1112 if ($us and @args > 1) {
1113 puke "Special op '${op}' requires first value to be identifier"
1114 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1115 my $k = join(($self->{name_sep}||'.'), @$ident);
1116 local our $Expand_Depth = 1;
1117 return $self->${\($us->{handler})}($k, $op, $args[1]);
1119 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1120 return $self->${\($us->{handler})}($op, $args[0]);
1123 return $self->_render_unop_prefix($op, \@args);
1125 return $self->_render_op_multop($op, \@args);
1130 sub _render_op_not {
1131 my ($self, $op, $v) = @_;
1132 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1133 return "(${sql})", @bind;
1136 sub _render_unop_prefix {
1137 my ($self, $op, $v) = @_;
1138 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1139 my $op_sql = $self->_sqlcase($op);
1140 return ("${op_sql} ${expr_sql}", @bind);
1143 sub _render_unop_postfix {
1144 my ($self, $op, $v) = @_;
1145 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1146 my $op_sql = $self->_sqlcase($op);
1147 return ($expr_sql.' '.$op_sql, @bind);
1150 # Some databases (SQLite) treat col IN (1, 2) different from
1151 # col IN ( (1, 2) ). Use this to strip all outer parens while
1152 # adding them back in the corresponding method
1153 sub _open_outer_paren {
1154 my ($self, $sql) = @_;
1156 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1158 # there are closing parens inside, need the heavy duty machinery
1159 # to reevaluate the extraction starting from $sql (full reevaluation)
1160 if ($inner =~ /\)/) {
1161 require Text::Balanced;
1163 my (undef, $remainder) = do {
1164 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1166 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1169 # the entire expression needs to be a balanced bracketed thing
1170 # (after an extract no remainder sans trailing space)
1171 last if defined $remainder and $remainder =~ /\S/;
1181 #======================================================================
1183 #======================================================================
1185 sub _expand_order_by {
1186 my ($self, $arg) = @_;
1188 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1190 my $expander = sub {
1191 my ($self, $dir, $expr) = @_;
1192 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1193 foreach my $arg (@to_expand) {
1197 and grep /^-(asc|desc)$/, keys %$arg
1199 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1203 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1205 map $self->expand_expr($_, -ident),
1206 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1207 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1210 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1212 return $self->$expander(undef, $arg);
1216 my ($self, $arg) = @_;
1218 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1220 my ($sql, @bind) = $self->render_aqt($expanded);
1222 return '' unless length($sql);
1224 my $final_sql = $self->_sqlcase(' order by ').$sql;
1226 return wantarray ? ($final_sql, @bind) : $final_sql;
1229 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1231 sub _order_by_chunks {
1232 my ($self, $arg) = @_;
1234 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1236 return $self->_chunkify_order_by($expanded);
1239 sub _chunkify_order_by {
1240 my ($self, $expanded) = @_;
1242 return grep length, $self->render_aqt($expanded)
1243 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1246 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1247 return map $self->_chunkify_order_by($_), @$l;
1249 return [ $self->render_aqt($_) ];
1253 #======================================================================
1254 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1255 #======================================================================
1261 $self->_expand_maybe_list_expr($from, undef, -ident)
1266 #======================================================================
1268 #======================================================================
1270 sub _expand_maybe_list_expr {
1271 my ($self, $expr, $logic, $default) = @_;
1273 if (ref($expr) eq 'ARRAY') {
1275 map $self->expand_expr($_, $default), @$expr
1282 return $self->expand_expr($e, $default);
1285 # highly optimized, as it's called way too often
1287 # my ($self, $label) = @_;
1289 return '' unless defined $_[1];
1290 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1291 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1293 unless ($_[0]->{quote_char}) {
1294 if (ref($_[1]) eq 'ARRAY') {
1295 return join($_[0]->{name_sep}||'.', @{$_[1]});
1297 $_[0]->_assert_pass_injection_guard($_[1]);
1302 my $qref = ref $_[0]->{quote_char};
1304 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1305 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1306 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1308 my $esc = $_[0]->{escape_char} || $r;
1310 # parts containing * are naturally unquoted
1312 $_[0]->{name_sep}||'',
1316 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1318 (ref($_[1]) eq 'ARRAY'
1322 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1330 # Conversion, if applicable
1332 #my ($self, $arg) = @_;
1333 if ($_[0]->{convert_where}) {
1334 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1341 #my ($self, $col, @vals) = @_;
1342 # called often - tighten code
1343 return $_[0]->{bindtype} eq 'columns'
1344 ? map {[$_[1], $_]} @_[2 .. $#_]
1349 # Dies if any element of @bind is not in [colname => value] format
1350 # if bindtype is 'columns'.
1351 sub _assert_bindval_matches_bindtype {
1352 # my ($self, @bind) = @_;
1354 if ($self->{bindtype} eq 'columns') {
1356 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1357 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1363 sub _join_sql_clauses {
1364 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1366 if (@$clauses_aref > 1) {
1367 my $join = " " . $self->_sqlcase($logic) . " ";
1368 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1369 return ($sql, @$bind_aref);
1371 elsif (@$clauses_aref) {
1372 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1375 return (); # if no SQL, ignore @$bind_aref
1380 # Fix SQL case, if so requested
1382 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1383 # don't touch the argument ... crooked logic, but let's not change it!
1384 return $_[0]->{case} ? $_[1] : uc($_[1]);
1388 #======================================================================
1389 # DISPATCHING FROM REFKIND
1390 #======================================================================
1393 my ($self, $data) = @_;
1395 return 'UNDEF' unless defined $data;
1397 # blessed objects are treated like scalars
1398 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1400 return 'SCALAR' unless $ref;
1403 while ($ref eq 'REF') {
1405 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1409 return ($ref||'SCALAR') . ('REF' x $n_steps);
1413 my ($self, $data) = @_;
1414 my @try = ($self->_refkind($data));
1415 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1416 push @try, 'FALLBACK';
1420 sub _METHOD_FOR_refkind {
1421 my ($self, $meth_prefix, $data) = @_;
1424 for (@{$self->_try_refkind($data)}) {
1425 $method = $self->can($meth_prefix."_".$_)
1429 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1433 sub _SWITCH_refkind {
1434 my ($self, $data, $dispatch_table) = @_;
1437 for (@{$self->_try_refkind($data)}) {
1438 $coderef = $dispatch_table->{$_}
1442 puke "no dispatch entry for ".$self->_refkind($data)
1451 #======================================================================
1452 # VALUES, GENERATE, AUTOLOAD
1453 #======================================================================
1455 # LDNOTE: original code from nwiger, didn't touch code in that section
1456 # I feel the AUTOLOAD stuff should not be the default, it should
1457 # only be activated on explicit demand by user.
1461 my $data = shift || return;
1462 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1463 unless ref $data eq 'HASH';
1466 foreach my $k (sort keys %$data) {
1467 my $v = $data->{$k};
1468 $self->_SWITCH_refkind($v, {
1470 if ($self->{array_datatypes}) { # array datatype
1471 push @all_bind, $self->_bindtype($k, $v);
1473 else { # literal SQL with bind
1474 my ($sql, @bind) = @$v;
1475 $self->_assert_bindval_matches_bindtype(@bind);
1476 push @all_bind, @bind;
1479 ARRAYREFREF => sub { # literal SQL with bind
1480 my ($sql, @bind) = @${$v};
1481 $self->_assert_bindval_matches_bindtype(@bind);
1482 push @all_bind, @bind;
1484 SCALARREF => sub { # literal SQL without bind
1486 SCALAR_or_UNDEF => sub {
1487 push @all_bind, $self->_bindtype($k, $v);
1498 my(@sql, @sqlq, @sqlv);
1502 if ($ref eq 'HASH') {
1503 for my $k (sort keys %$_) {
1506 my $label = $self->_quote($k);
1507 if ($r eq 'ARRAY') {
1508 # literal SQL with bind
1509 my ($sql, @bind) = @$v;
1510 $self->_assert_bindval_matches_bindtype(@bind);
1511 push @sqlq, "$label = $sql";
1513 } elsif ($r eq 'SCALAR') {
1514 # literal SQL without bind
1515 push @sqlq, "$label = $$v";
1517 push @sqlq, "$label = ?";
1518 push @sqlv, $self->_bindtype($k, $v);
1521 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1522 } elsif ($ref eq 'ARRAY') {
1523 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1526 if ($r eq 'ARRAY') { # literal SQL with bind
1527 my ($sql, @bind) = @$v;
1528 $self->_assert_bindval_matches_bindtype(@bind);
1531 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1532 # embedded literal SQL
1539 push @sql, '(' . join(', ', @sqlq) . ')';
1540 } elsif ($ref eq 'SCALAR') {
1544 # strings get case twiddled
1545 push @sql, $self->_sqlcase($_);
1549 my $sql = join ' ', @sql;
1551 # this is pretty tricky
1552 # if ask for an array, return ($stmt, @bind)
1553 # otherwise, s/?/shift @sqlv/ to put it inline
1555 return ($sql, @sqlv);
1557 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1558 ref $d ? $d->[1] : $d/e;
1567 # This allows us to check for a local, then _form, attr
1569 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1570 return $self->generate($name, @_);
1581 SQL::Abstract - Generate SQL from Perl data structures
1587 my $sql = SQL::Abstract->new;
1589 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1591 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1593 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1595 my($stmt, @bind) = $sql->delete($table, \%where);
1597 # Then, use these in your DBI statements
1598 my $sth = $dbh->prepare($stmt);
1599 $sth->execute(@bind);
1601 # Just generate the WHERE clause
1602 my($stmt, @bind) = $sql->where(\%where, $order);
1604 # Return values in the same order, for hashed queries
1605 # See PERFORMANCE section for more details
1606 my @bind = $sql->values(\%fieldvals);
1610 This module was inspired by the excellent L<DBIx::Abstract>.
1611 However, in using that module I found that what I really wanted
1612 to do was generate SQL, but still retain complete control over my
1613 statement handles and use the DBI interface. So, I set out to
1614 create an abstract SQL generation module.
1616 While based on the concepts used by L<DBIx::Abstract>, there are
1617 several important differences, especially when it comes to WHERE
1618 clauses. I have modified the concepts used to make the SQL easier
1619 to generate from Perl data structures and, IMO, more intuitive.
1620 The underlying idea is for this module to do what you mean, based
1621 on the data structures you provide it. The big advantage is that
1622 you don't have to modify your code every time your data changes,
1623 as this module figures it out.
1625 To begin with, an SQL INSERT is as easy as just specifying a hash
1626 of C<key=value> pairs:
1629 name => 'Jimbo Bobson',
1630 phone => '123-456-7890',
1631 address => '42 Sister Lane',
1632 city => 'St. Louis',
1633 state => 'Louisiana',
1636 The SQL can then be generated with this:
1638 my($stmt, @bind) = $sql->insert('people', \%data);
1640 Which would give you something like this:
1642 $stmt = "INSERT INTO people
1643 (address, city, name, phone, state)
1644 VALUES (?, ?, ?, ?, ?)";
1645 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1646 '123-456-7890', 'Louisiana');
1648 These are then used directly in your DBI code:
1650 my $sth = $dbh->prepare($stmt);
1651 $sth->execute(@bind);
1653 =head2 Inserting and Updating Arrays
1655 If your database has array types (like for example Postgres),
1656 activate the special option C<< array_datatypes => 1 >>
1657 when creating the C<SQL::Abstract> object.
1658 Then you may use an arrayref to insert and update database array types:
1660 my $sql = SQL::Abstract->new(array_datatypes => 1);
1662 planets => [qw/Mercury Venus Earth Mars/]
1665 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1669 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1671 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1674 =head2 Inserting and Updating SQL
1676 In order to apply SQL functions to elements of your C<%data> you may
1677 specify a reference to an arrayref for the given hash value. For example,
1678 if you need to execute the Oracle C<to_date> function on a value, you can
1679 say something like this:
1683 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1686 The first value in the array is the actual SQL. Any other values are
1687 optional and would be included in the bind values array. This gives
1690 my($stmt, @bind) = $sql->insert('people', \%data);
1692 $stmt = "INSERT INTO people (name, date_entered)
1693 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1694 @bind = ('Bill', '03/02/2003');
1696 An UPDATE is just as easy, all you change is the name of the function:
1698 my($stmt, @bind) = $sql->update('people', \%data);
1700 Notice that your C<%data> isn't touched; the module will generate
1701 the appropriately quirky SQL for you automatically. Usually you'll
1702 want to specify a WHERE clause for your UPDATE, though, which is
1703 where handling C<%where> hashes comes in handy...
1705 =head2 Complex where statements
1707 This module can generate pretty complicated WHERE statements
1708 easily. For example, simple C<key=value> pairs are taken to mean
1709 equality, and if you want to see if a field is within a set
1710 of values, you can use an arrayref. Let's say we wanted to
1711 SELECT some data based on this criteria:
1714 requestor => 'inna',
1715 worker => ['nwiger', 'rcwe', 'sfz'],
1716 status => { '!=', 'completed' }
1719 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1721 The above would give you something like this:
1723 $stmt = "SELECT * FROM tickets WHERE
1724 ( requestor = ? ) AND ( status != ? )
1725 AND ( worker = ? OR worker = ? OR worker = ? )";
1726 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1728 Which you could then use in DBI code like so:
1730 my $sth = $dbh->prepare($stmt);
1731 $sth->execute(@bind);
1737 The methods are simple. There's one for every major SQL operation,
1738 and a constructor you use first. The arguments are specified in a
1739 similar order for each method (table, then fields, then a where
1740 clause) to try and simplify things.
1742 =head2 new(option => 'value')
1744 The C<new()> function takes a list of options and values, and returns
1745 a new B<SQL::Abstract> object which can then be used to generate SQL
1746 through the methods below. The options accepted are:
1752 If set to 'lower', then SQL will be generated in all lowercase. By
1753 default SQL is generated in "textbook" case meaning something like:
1755 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1757 Any setting other than 'lower' is ignored.
1761 This determines what the default comparison operator is. By default
1762 it is C<=>, meaning that a hash like this:
1764 %where = (name => 'nwiger', email => 'nate@wiger.org');
1766 Will generate SQL like this:
1768 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1770 However, you may want loose comparisons by default, so if you set
1771 C<cmp> to C<like> you would get SQL such as:
1773 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1775 You can also override the comparison on an individual basis - see
1776 the huge section on L</"WHERE CLAUSES"> at the bottom.
1778 =item sqltrue, sqlfalse
1780 Expressions for inserting boolean values within SQL statements.
1781 By default these are C<1=1> and C<1=0>. They are used
1782 by the special operators C<-in> and C<-not_in> for generating
1783 correct SQL even when the argument is an empty array (see below).
1787 This determines the default logical operator for multiple WHERE
1788 statements in arrays or hashes. If absent, the default logic is "or"
1789 for arrays, and "and" for hashes. This means that a WHERE
1793 event_date => {'>=', '2/13/99'},
1794 event_date => {'<=', '4/24/03'},
1797 will generate SQL like this:
1799 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1801 This is probably not what you want given this query, though (look
1802 at the dates). To change the "OR" to an "AND", simply specify:
1804 my $sql = SQL::Abstract->new(logic => 'and');
1806 Which will change the above C<WHERE> to:
1808 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1810 The logic can also be changed locally by inserting
1811 a modifier in front of an arrayref:
1813 @where = (-and => [event_date => {'>=', '2/13/99'},
1814 event_date => {'<=', '4/24/03'} ]);
1816 See the L</"WHERE CLAUSES"> section for explanations.
1820 This will automatically convert comparisons using the specified SQL
1821 function for both column and value. This is mostly used with an argument
1822 of C<upper> or C<lower>, so that the SQL will have the effect of
1823 case-insensitive "searches". For example, this:
1825 $sql = SQL::Abstract->new(convert => 'upper');
1826 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1828 Will turn out the following SQL:
1830 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1832 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1833 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1834 not validate this option; it will just pass through what you specify verbatim).
1838 This is a kludge because many databases suck. For example, you can't
1839 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1840 Instead, you have to use C<bind_param()>:
1842 $sth->bind_param(1, 'reg data');
1843 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1845 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1846 which loses track of which field each slot refers to. Fear not.
1848 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1849 Currently, you can specify either C<normal> (default) or C<columns>. If you
1850 specify C<columns>, you will get an array that looks like this:
1852 my $sql = SQL::Abstract->new(bindtype => 'columns');
1853 my($stmt, @bind) = $sql->insert(...);
1856 [ 'column1', 'value1' ],
1857 [ 'column2', 'value2' ],
1858 [ 'column3', 'value3' ],
1861 You can then iterate through this manually, using DBI's C<bind_param()>.
1863 $sth->prepare($stmt);
1866 my($col, $data) = @$_;
1867 if ($col eq 'details' || $col eq 'comments') {
1868 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1869 } elsif ($col eq 'image') {
1870 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1872 $sth->bind_param($i, $data);
1876 $sth->execute; # execute without @bind now
1878 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1879 Basically, the advantage is still that you don't have to care which fields
1880 are or are not included. You could wrap that above C<for> loop in a simple
1881 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1882 get a layer of abstraction over manual SQL specification.
1884 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1885 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1886 will expect the bind values in this format.
1890 This is the character that a table or column name will be quoted
1891 with. By default this is an empty string, but you could set it to
1892 the character C<`>, to generate SQL like this:
1894 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1896 Alternatively, you can supply an array ref of two items, the first being the left
1897 hand quote character, and the second the right hand quote character. For
1898 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1899 that generates SQL like this:
1901 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1903 Quoting is useful if you have tables or columns names that are reserved
1904 words in your database's SQL dialect.
1908 This is the character that will be used to escape L</quote_char>s appearing
1909 in an identifier before it has been quoted.
1911 The parameter default in case of a single L</quote_char> character is the quote
1914 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1915 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1916 of the B<opening (left)> L</quote_char> within the identifier are currently left
1917 untouched. The default for opening-closing-style quotes may change in future
1918 versions, thus you are B<strongly encouraged> to specify the escape character
1923 This is the character that separates a table and column name. It is
1924 necessary to specify this when the C<quote_char> option is selected,
1925 so that tables and column names can be individually quoted like this:
1927 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1929 =item injection_guard
1931 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1932 column name specified in a query structure. This is a safety mechanism to avoid
1933 injection attacks when mishandling user input e.g.:
1935 my %condition_as_column_value_pairs = get_values_from_user();
1936 $sqla->select( ... , \%condition_as_column_value_pairs );
1938 If the expression matches an exception is thrown. Note that literal SQL
1939 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1941 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1943 =item array_datatypes
1945 When this option is true, arrayrefs in INSERT or UPDATE are
1946 interpreted as array datatypes and are passed directly
1948 When this option is false, arrayrefs are interpreted
1949 as literal SQL, just like refs to arrayrefs
1950 (but this behavior is for backwards compatibility; when writing
1951 new queries, use the "reference to arrayref" syntax
1957 Takes a reference to a list of "special operators"
1958 to extend the syntax understood by L<SQL::Abstract>.
1959 See section L</"SPECIAL OPERATORS"> for details.
1963 Takes a reference to a list of "unary operators"
1964 to extend the syntax understood by L<SQL::Abstract>.
1965 See section L</"UNARY OPERATORS"> for details.
1971 =head2 insert($table, \@values || \%fieldvals, \%options)
1973 This is the simplest function. You simply give it a table name
1974 and either an arrayref of values or hashref of field/value pairs.
1975 It returns an SQL INSERT statement and a list of bind values.
1976 See the sections on L</"Inserting and Updating Arrays"> and
1977 L</"Inserting and Updating SQL"> for information on how to insert
1978 with those data types.
1980 The optional C<\%options> hash reference may contain additional
1981 options to generate the insert SQL. Currently supported options
1988 Takes either a scalar of raw SQL fields, or an array reference of
1989 field names, and adds on an SQL C<RETURNING> statement at the end.
1990 This allows you to return data generated by the insert statement
1991 (such as row IDs) without performing another C<SELECT> statement.
1992 Note, however, this is not part of the SQL standard and may not
1993 be supported by all database engines.
1997 =head2 update($table, \%fieldvals, \%where, \%options)
1999 This takes a table, hashref of field/value pairs, and an optional
2000 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2002 See the sections on L</"Inserting and Updating Arrays"> and
2003 L</"Inserting and Updating SQL"> for information on how to insert
2004 with those data types.
2006 The optional C<\%options> hash reference may contain additional
2007 options to generate the update SQL. Currently supported options
2014 See the C<returning> option to
2015 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2019 =head2 select($source, $fields, $where, $order)
2021 This returns a SQL SELECT statement and associated list of bind values, as
2022 specified by the arguments:
2028 Specification of the 'FROM' part of the statement.
2029 The argument can be either a plain scalar (interpreted as a table
2030 name, will be quoted), or an arrayref (interpreted as a list
2031 of table names, joined by commas, quoted), or a scalarref
2032 (literal SQL, not quoted).
2036 Specification of the list of fields to retrieve from
2038 The argument can be either an arrayref (interpreted as a list
2039 of field names, will be joined by commas and quoted), or a
2040 plain scalar (literal SQL, not quoted).
2041 Please observe that this API is not as flexible as that of
2042 the first argument C<$source>, for backwards compatibility reasons.
2046 Optional argument to specify the WHERE part of the query.
2047 The argument is most often a hashref, but can also be
2048 an arrayref or plain scalar --
2049 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2053 Optional argument to specify the ORDER BY part of the query.
2054 The argument can be a scalar, a hashref or an arrayref
2055 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2061 =head2 delete($table, \%where, \%options)
2063 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2064 It returns an SQL DELETE statement and list of bind values.
2066 The optional C<\%options> hash reference may contain additional
2067 options to generate the delete SQL. Currently supported options
2074 See the C<returning> option to
2075 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2079 =head2 where(\%where, $order)
2081 This is used to generate just the WHERE clause. For example,
2082 if you have an arbitrary data structure and know what the
2083 rest of your SQL is going to look like, but want an easy way
2084 to produce a WHERE clause, use this. It returns an SQL WHERE
2085 clause and list of bind values.
2088 =head2 values(\%data)
2090 This just returns the values from the hash C<%data>, in the same
2091 order that would be returned from any of the other above queries.
2092 Using this allows you to markedly speed up your queries if you
2093 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2095 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2097 Warning: This is an experimental method and subject to change.
2099 This returns arbitrarily generated SQL. It's a really basic shortcut.
2100 It will return two different things, depending on return context:
2102 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2103 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2105 These would return the following:
2107 # First calling form
2108 $stmt = "CREATE TABLE test (?, ?)";
2109 @bind = (field1, field2);
2111 # Second calling form
2112 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2114 Depending on what you're trying to do, it's up to you to choose the correct
2115 format. In this example, the second form is what you would want.
2119 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2123 ALTER SESSION SET nls_date_format = 'MM/YY'
2125 You get the idea. Strings get their case twiddled, but everything
2126 else remains verbatim.
2128 =head1 EXPORTABLE FUNCTIONS
2130 =head2 is_plain_value
2132 Determines if the supplied argument is a plain value as understood by this
2137 =item * The value is C<undef>
2139 =item * The value is a non-reference
2141 =item * The value is an object with stringification overloading
2143 =item * The value is of the form C<< { -value => $anything } >>
2147 On failure returns C<undef>, on success returns a B<scalar> reference
2148 to the original supplied argument.
2154 The stringification overloading detection is rather advanced: it takes
2155 into consideration not only the presence of a C<""> overload, but if that
2156 fails also checks for enabled
2157 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2158 on either C<0+> or C<bool>.
2160 Unfortunately testing in the field indicates that this
2161 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2162 but only when very large numbers of stringifying objects are involved.
2163 At the time of writing ( Sep 2014 ) there is no clear explanation of
2164 the direct cause, nor is there a manageably small test case that reliably
2165 reproduces the problem.
2167 If you encounter any of the following exceptions in B<random places within
2168 your application stack> - this module may be to blame:
2170 Operation "ne": no method found,
2171 left argument in overloaded package <something>,
2172 right argument in overloaded package <something>
2176 Stub found while resolving method "???" overloading """" in package <something>
2178 If you fall victim to the above - please attempt to reduce the problem
2179 to something that could be sent to the L<SQL::Abstract developers
2180 |DBIx::Class/GETTING HELP/SUPPORT>
2181 (either publicly or privately). As a workaround in the meantime you can
2182 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2183 value, which will most likely eliminate your problem (at the expense of
2184 not being able to properly detect exotic forms of stringification).
2186 This notice and environment variable will be removed in a future version,
2187 as soon as the underlying problem is found and a reliable workaround is
2192 =head2 is_literal_value
2194 Determines if the supplied argument is a literal value as understood by this
2199 =item * C<\$sql_string>
2201 =item * C<\[ $sql_string, @bind_values ]>
2205 On failure returns C<undef>, on success returns an B<array> reference
2206 containing the unpacked version of the supplied literal SQL and bind values.
2208 =head1 WHERE CLAUSES
2212 This module uses a variation on the idea from L<DBIx::Abstract>. It
2213 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2214 module is that things in arrays are OR'ed, and things in hashes
2217 The easiest way to explain is to show lots of examples. After
2218 each C<%where> hash shown, it is assumed you used:
2220 my($stmt, @bind) = $sql->where(\%where);
2222 However, note that the C<%where> hash can be used directly in any
2223 of the other functions as well, as described above.
2225 =head2 Key-value pairs
2227 So, let's get started. To begin, a simple hash:
2231 status => 'completed'
2234 Is converted to SQL C<key = val> statements:
2236 $stmt = "WHERE user = ? AND status = ?";
2237 @bind = ('nwiger', 'completed');
2239 One common thing I end up doing is having a list of values that
2240 a field can be in. To do this, simply specify a list inside of
2245 status => ['assigned', 'in-progress', 'pending'];
2248 This simple code will create the following:
2250 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2251 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2253 A field associated to an empty arrayref will be considered a
2254 logical false and will generate 0=1.
2256 =head2 Tests for NULL values
2258 If the value part is C<undef> then this is converted to SQL <IS NULL>
2267 $stmt = "WHERE user = ? AND status IS NULL";
2270 To test if a column IS NOT NULL:
2274 status => { '!=', undef },
2277 =head2 Specific comparison operators
2279 If you want to specify a different type of operator for your comparison,
2280 you can use a hashref for a given column:
2284 status => { '!=', 'completed' }
2287 Which would generate:
2289 $stmt = "WHERE user = ? AND status != ?";
2290 @bind = ('nwiger', 'completed');
2292 To test against multiple values, just enclose the values in an arrayref:
2294 status => { '=', ['assigned', 'in-progress', 'pending'] };
2296 Which would give you:
2298 "WHERE status = ? OR status = ? OR status = ?"
2301 The hashref can also contain multiple pairs, in which case it is expanded
2302 into an C<AND> of its elements:
2306 status => { '!=', 'completed', -not_like => 'pending%' }
2309 # Or more dynamically, like from a form
2310 $where{user} = 'nwiger';
2311 $where{status}{'!='} = 'completed';
2312 $where{status}{'-not_like'} = 'pending%';
2314 # Both generate this
2315 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2316 @bind = ('nwiger', 'completed', 'pending%');
2319 To get an OR instead, you can combine it with the arrayref idea:
2323 priority => [ { '=', 2 }, { '>', 5 } ]
2326 Which would generate:
2328 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2329 @bind = ('2', '5', 'nwiger');
2331 If you want to include literal SQL (with or without bind values), just use a
2332 scalar reference or reference to an arrayref as the value:
2335 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2336 date_expires => { '<' => \"now()" }
2339 Which would generate:
2341 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2342 @bind = ('11/26/2008');
2345 =head2 Logic and nesting operators
2347 In the example above,
2348 there is a subtle trap if you want to say something like
2349 this (notice the C<AND>):
2351 WHERE priority != ? AND priority != ?
2353 Because, in Perl you I<can't> do this:
2355 priority => { '!=' => 2, '!=' => 1 }
2357 As the second C<!=> key will obliterate the first. The solution
2358 is to use the special C<-modifier> form inside an arrayref:
2360 priority => [ -and => {'!=', 2},
2364 Normally, these would be joined by C<OR>, but the modifier tells it
2365 to use C<AND> instead. (Hint: You can use this in conjunction with the
2366 C<logic> option to C<new()> in order to change the way your queries
2367 work by default.) B<Important:> Note that the C<-modifier> goes
2368 B<INSIDE> the arrayref, as an extra first element. This will
2369 B<NOT> do what you think it might:
2371 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2373 Here is a quick list of equivalencies, since there is some overlap:
2376 status => {'!=', 'completed', 'not like', 'pending%' }
2377 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2380 status => {'=', ['assigned', 'in-progress']}
2381 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2382 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2386 =head2 Special operators: IN, BETWEEN, etc.
2388 You can also use the hashref format to compare a list of fields using the
2389 C<IN> comparison operator, by specifying the list as an arrayref:
2392 status => 'completed',
2393 reportid => { -in => [567, 2335, 2] }
2396 Which would generate:
2398 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2399 @bind = ('completed', '567', '2335', '2');
2401 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2404 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2405 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2406 'sqltrue' (by default: C<1=1>).
2408 In addition to the array you can supply a chunk of literal sql or
2409 literal sql with bind:
2412 customer => { -in => \[
2413 'SELECT cust_id FROM cust WHERE balance > ?',
2416 status => { -in => \'SELECT status_codes FROM states' },
2422 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2423 AND status IN ( SELECT status_codes FROM states )
2427 Finally, if the argument to C<-in> is not a reference, it will be
2428 treated as a single-element array.
2430 Another pair of operators is C<-between> and C<-not_between>,
2431 used with an arrayref of two values:
2435 completion_date => {
2436 -not_between => ['2002-10-01', '2003-02-06']
2442 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2444 Just like with C<-in> all plausible combinations of literal SQL
2448 start0 => { -between => [ 1, 2 ] },
2449 start1 => { -between => \["? AND ?", 1, 2] },
2450 start2 => { -between => \"lower(x) AND upper(y)" },
2451 start3 => { -between => [
2453 \["upper(?)", 'stuff' ],
2460 ( start0 BETWEEN ? AND ? )
2461 AND ( start1 BETWEEN ? AND ? )
2462 AND ( start2 BETWEEN lower(x) AND upper(y) )
2463 AND ( start3 BETWEEN lower(x) AND upper(?) )
2465 @bind = (1, 2, 1, 2, 'stuff');
2468 These are the two builtin "special operators"; but the
2469 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2471 =head2 Unary operators: bool
2473 If you wish to test against boolean columns or functions within your
2474 database you can use the C<-bool> and C<-not_bool> operators. For
2475 example to test the column C<is_user> being true and the column
2476 C<is_enabled> being false you would use:-
2480 -not_bool => 'is_enabled',
2485 WHERE is_user AND NOT is_enabled
2487 If a more complex combination is required, testing more conditions,
2488 then you should use the and/or operators:-
2493 -not_bool => { two=> { -rlike => 'bar' } },
2494 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2505 (NOT ( three = ? OR three > ? ))
2508 =head2 Nested conditions, -and/-or prefixes
2510 So far, we've seen how multiple conditions are joined with a top-level
2511 C<AND>. We can change this by putting the different conditions we want in
2512 hashes and then putting those hashes in an array. For example:
2517 status => { -like => ['pending%', 'dispatched'] },
2521 status => 'unassigned',
2525 This data structure would create the following:
2527 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2528 OR ( user = ? AND status = ? ) )";
2529 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2532 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2533 to change the logic inside:
2539 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2540 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2547 $stmt = "WHERE ( user = ?
2548 AND ( ( workhrs > ? AND geo = ? )
2549 OR ( workhrs < ? OR geo = ? ) ) )";
2550 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2552 =head3 Algebraic inconsistency, for historical reasons
2554 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2555 operator goes C<outside> of the nested structure; whereas when connecting
2556 several constraints on one column, the C<-and> operator goes
2557 C<inside> the arrayref. Here is an example combining both features:
2560 -and => [a => 1, b => 2],
2561 -or => [c => 3, d => 4],
2562 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2567 WHERE ( ( ( a = ? AND b = ? )
2568 OR ( c = ? OR d = ? )
2569 OR ( e LIKE ? AND e LIKE ? ) ) )
2571 This difference in syntax is unfortunate but must be preserved for
2572 historical reasons. So be careful: the two examples below would
2573 seem algebraically equivalent, but they are not
2576 { -like => 'foo%' },
2577 { -like => '%bar' },
2579 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2582 { col => { -like => 'foo%' } },
2583 { col => { -like => '%bar' } },
2585 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2588 =head2 Literal SQL and value type operators
2590 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2591 side" is a column name and the "right side" is a value (normally rendered as
2592 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2593 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2594 alter this behavior. There are several ways of doing so.
2598 This is a virtual operator that signals the string to its right side is an
2599 identifier (a column name) and not a value. For example to compare two
2600 columns you would write:
2603 priority => { '<', 2 },
2604 requestor => { -ident => 'submitter' },
2609 $stmt = "WHERE priority < ? AND requestor = submitter";
2612 If you are maintaining legacy code you may see a different construct as
2613 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2618 This is a virtual operator that signals that the construct to its right side
2619 is a value to be passed to DBI. This is for example necessary when you want
2620 to write a where clause against an array (for RDBMS that support such
2621 datatypes). For example:
2624 array => { -value => [1, 2, 3] }
2629 $stmt = 'WHERE array = ?';
2630 @bind = ([1, 2, 3]);
2632 Note that if you were to simply say:
2638 the result would probably not be what you wanted:
2640 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2645 Finally, sometimes only literal SQL will do. To include a random snippet
2646 of SQL verbatim, you specify it as a scalar reference. Consider this only
2647 as a last resort. Usually there is a better way. For example:
2650 priority => { '<', 2 },
2651 requestor => { -in => \'(SELECT name FROM hitmen)' },
2656 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2659 Note that in this example, you only get one bind parameter back, since
2660 the verbatim SQL is passed as part of the statement.
2664 Never use untrusted input as a literal SQL argument - this is a massive
2665 security risk (there is no way to check literal snippets for SQL
2666 injections and other nastyness). If you need to deal with untrusted input
2667 use literal SQL with placeholders as described next.
2669 =head3 Literal SQL with placeholders and bind values (subqueries)
2671 If the literal SQL to be inserted has placeholders and bind values,
2672 use a reference to an arrayref (yes this is a double reference --
2673 not so common, but perfectly legal Perl). For example, to find a date
2674 in Postgres you can use something like this:
2677 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2682 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2685 Note that you must pass the bind values in the same format as they are returned
2686 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2687 to C<columns>, you must provide the bind values in the
2688 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2689 scalar value; most commonly the column name, but you can use any scalar value
2690 (including references and blessed references), L<SQL::Abstract> will simply
2691 pass it through intact. So if C<bindtype> is set to C<columns> the above
2692 example will look like:
2695 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2698 Literal SQL is especially useful for nesting parenthesized clauses in the
2699 main SQL query. Here is a first example:
2701 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2705 bar => \["IN ($sub_stmt)" => @sub_bind],
2710 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2711 WHERE c2 < ? AND c3 LIKE ?))";
2712 @bind = (1234, 100, "foo%");
2714 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2715 are expressed in the same way. Of course the C<$sub_stmt> and
2716 its associated bind values can be generated through a former call
2719 my ($sub_stmt, @sub_bind)
2720 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2721 c3 => {-like => "foo%"}});
2724 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2727 In the examples above, the subquery was used as an operator on a column;
2728 but the same principle also applies for a clause within the main C<%where>
2729 hash, like an EXISTS subquery:
2731 my ($sub_stmt, @sub_bind)
2732 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2733 my %where = ( -and => [
2735 \["EXISTS ($sub_stmt)" => @sub_bind],
2740 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2741 WHERE c1 = ? AND c2 > t0.c0))";
2745 Observe that the condition on C<c2> in the subquery refers to
2746 column C<t0.c0> of the main query: this is I<not> a bind
2747 value, so we have to express it through a scalar ref.
2748 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2749 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2750 what we wanted here.
2752 Finally, here is an example where a subquery is used
2753 for expressing unary negation:
2755 my ($sub_stmt, @sub_bind)
2756 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2757 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2759 lname => {like => '%son%'},
2760 \["NOT ($sub_stmt)" => @sub_bind],
2765 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2766 @bind = ('%son%', 10, 20)
2768 =head3 Deprecated usage of Literal SQL
2770 Below are some examples of archaic use of literal SQL. It is shown only as
2771 reference for those who deal with legacy code. Each example has a much
2772 better, cleaner and safer alternative that users should opt for in new code.
2778 my %where = ( requestor => \'IS NOT NULL' )
2780 $stmt = "WHERE requestor IS NOT NULL"
2782 This used to be the way of generating NULL comparisons, before the handling
2783 of C<undef> got formalized. For new code please use the superior syntax as
2784 described in L</Tests for NULL values>.
2788 my %where = ( requestor => \'= submitter' )
2790 $stmt = "WHERE requestor = submitter"
2792 This used to be the only way to compare columns. Use the superior L</-ident>
2793 method for all new code. For example an identifier declared in such a way
2794 will be properly quoted if L</quote_char> is properly set, while the legacy
2795 form will remain as supplied.
2799 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2801 $stmt = "WHERE completed > ? AND is_ready"
2802 @bind = ('2012-12-21')
2804 Using an empty string literal used to be the only way to express a boolean.
2805 For all new code please use the much more readable
2806 L<-bool|/Unary operators: bool> operator.
2812 These pages could go on for a while, since the nesting of the data
2813 structures this module can handle are pretty much unlimited (the
2814 module implements the C<WHERE> expansion as a recursive function
2815 internally). Your best bet is to "play around" with the module a
2816 little to see how the data structures behave, and choose the best
2817 format for your data based on that.
2819 And of course, all the values above will probably be replaced with
2820 variables gotten from forms or the command line. After all, if you
2821 knew everything ahead of time, you wouldn't have to worry about
2822 dynamically-generating SQL and could just hardwire it into your
2825 =head1 ORDER BY CLAUSES
2827 Some functions take an order by clause. This can either be a scalar (just a
2828 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2829 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2832 Given | Will Generate
2833 ---------------------------------------------------------------
2835 'colA' | ORDER BY colA
2837 [qw/colA colB/] | ORDER BY colA, colB
2839 {-asc => 'colA'} | ORDER BY colA ASC
2841 {-desc => 'colB'} | ORDER BY colB DESC
2843 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2845 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2847 \'colA DESC' | ORDER BY colA DESC
2849 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2850 | /* ...with $x bound to ? */
2853 { -asc => 'colA' }, | colA ASC,
2854 { -desc => [qw/colB/] }, | colB DESC,
2855 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2856 \'colE DESC', | colE DESC,
2857 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2858 ] | /* ...with $x bound to ? */
2859 ===============================================================
2863 =head1 SPECIAL OPERATORS
2865 my $sqlmaker = SQL::Abstract->new(special_ops => [
2869 my ($self, $field, $op, $arg) = @_;
2875 handler => 'method_name',
2879 A "special operator" is a SQL syntactic clause that can be
2880 applied to a field, instead of a usual binary operator.
2883 WHERE field IN (?, ?, ?)
2884 WHERE field BETWEEN ? AND ?
2885 WHERE MATCH(field) AGAINST (?, ?)
2887 Special operators IN and BETWEEN are fairly standard and therefore
2888 are builtin within C<SQL::Abstract> (as the overridable methods
2889 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2890 like the MATCH .. AGAINST example above which is specific to MySQL,
2891 you can write your own operator handlers - supply a C<special_ops>
2892 argument to the C<new> method. That argument takes an arrayref of
2893 operator definitions; each operator definition is a hashref with two
2900 the regular expression to match the operator
2904 Either a coderef or a plain scalar method name. In both cases
2905 the expected return is C<< ($sql, @bind) >>.
2907 When supplied with a method name, it is simply called on the
2908 L<SQL::Abstract> object as:
2910 $self->$method_name($field, $op, $arg)
2914 $field is the LHS of the operator
2915 $op is the part that matched the handler regex
2918 When supplied with a coderef, it is called as:
2920 $coderef->($self, $field, $op, $arg)
2925 For example, here is an implementation
2926 of the MATCH .. AGAINST syntax for MySQL
2928 my $sqlmaker = SQL::Abstract->new(special_ops => [
2930 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2931 {regex => qr/^match$/i,
2933 my ($self, $field, $op, $arg) = @_;
2934 $arg = [$arg] if not ref $arg;
2935 my $label = $self->_quote($field);
2936 my ($placeholder) = $self->_convert('?');
2937 my $placeholders = join ", ", (($placeholder) x @$arg);
2938 my $sql = $self->_sqlcase('match') . " ($label) "
2939 . $self->_sqlcase('against') . " ($placeholders) ";
2940 my @bind = $self->_bindtype($field, @$arg);
2941 return ($sql, @bind);
2948 =head1 UNARY OPERATORS
2950 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2954 my ($self, $op, $arg) = @_;
2960 handler => 'method_name',
2964 A "unary operator" is a SQL syntactic clause that can be
2965 applied to a field - the operator goes before the field
2967 You can write your own operator handlers - supply a C<unary_ops>
2968 argument to the C<new> method. That argument takes an arrayref of
2969 operator definitions; each operator definition is a hashref with two
2976 the regular expression to match the operator
2980 Either a coderef or a plain scalar method name. In both cases
2981 the expected return is C<< $sql >>.
2983 When supplied with a method name, it is simply called on the
2984 L<SQL::Abstract> object as:
2986 $self->$method_name($op, $arg)
2990 $op is the part that matched the handler regex
2991 $arg is the RHS or argument of the operator
2993 When supplied with a coderef, it is called as:
2995 $coderef->($self, $op, $arg)
3003 Thanks to some benchmarking by Mark Stosberg, it turns out that
3004 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3005 I must admit this wasn't an intentional design issue, but it's a
3006 byproduct of the fact that you get to control your C<DBI> handles
3009 To maximize performance, use a code snippet like the following:
3011 # prepare a statement handle using the first row
3012 # and then reuse it for the rest of the rows
3014 for my $href (@array_of_hashrefs) {
3015 $stmt ||= $sql->insert('table', $href);
3016 $sth ||= $dbh->prepare($stmt);
3017 $sth->execute($sql->values($href));
3020 The reason this works is because the keys in your C<$href> are sorted
3021 internally by B<SQL::Abstract>. Thus, as long as your data retains
3022 the same structure, you only have to generate the SQL the first time
3023 around. On subsequent queries, simply use the C<values> function provided
3024 by this module to return your values in the correct order.
3026 However this depends on the values having the same type - if, for
3027 example, the values of a where clause may either have values
3028 (resulting in sql of the form C<column = ?> with a single bind
3029 value), or alternatively the values might be C<undef> (resulting in
3030 sql of the form C<column IS NULL> with no bind value) then the
3031 caching technique suggested will not work.
3035 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3036 really like this part (I do, at least). Building up a complex query
3037 can be as simple as the following:
3044 use CGI::FormBuilder;
3047 my $form = CGI::FormBuilder->new(...);
3048 my $sql = SQL::Abstract->new;
3050 if ($form->submitted) {
3051 my $field = $form->field;
3052 my $id = delete $field->{id};
3053 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3056 Of course, you would still have to connect using C<DBI> to run the
3057 query, but the point is that if you make your form look like your
3058 table, the actual query script can be extremely simplistic.
3060 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3061 a fast interface to returning and formatting data. I frequently
3062 use these three modules together to write complex database query
3063 apps in under 50 lines.
3065 =head1 HOW TO CONTRIBUTE
3067 Contributions are always welcome, in all usable forms (we especially
3068 welcome documentation improvements). The delivery methods include git-
3069 or unified-diff formatted patches, GitHub pull requests, or plain bug
3070 reports either via RT or the Mailing list. Contributors are generally
3071 granted full access to the official repository after their first several
3072 patches pass successful review.
3074 This project is maintained in a git repository. The code and related tools are
3075 accessible at the following locations:
3079 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3081 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3083 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3085 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3091 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3092 Great care has been taken to preserve the I<published> behavior
3093 documented in previous versions in the 1.* family; however,
3094 some features that were previously undocumented, or behaved
3095 differently from the documentation, had to be changed in order
3096 to clarify the semantics. Hence, client code that was relying
3097 on some dark areas of C<SQL::Abstract> v1.*
3098 B<might behave differently> in v1.50.
3100 The main changes are:
3106 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3110 support for the { operator => \"..." } construct (to embed literal SQL)
3114 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3118 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3122 defensive programming: check arguments
3126 fixed bug with global logic, which was previously implemented
3127 through global variables yielding side-effects. Prior versions would
3128 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3129 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3130 Now this is interpreted
3131 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3136 fixed semantics of _bindtype on array args
3140 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3141 we just avoid shifting arrays within that tree.
3145 dropped the C<_modlogic> function
3149 =head1 ACKNOWLEDGEMENTS
3151 There are a number of individuals that have really helped out with
3152 this module. Unfortunately, most of them submitted bugs via CPAN
3153 so I have no idea who they are! But the people I do know are:
3155 Ash Berlin (order_by hash term support)
3156 Matt Trout (DBIx::Class support)
3157 Mark Stosberg (benchmarking)
3158 Chas Owens (initial "IN" operator support)
3159 Philip Collins (per-field SQL functions)
3160 Eric Kolve (hashref "AND" support)
3161 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3162 Dan Kubb (support for "quote_char" and "name_sep")
3163 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3164 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3165 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3166 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3167 Oliver Charles (support for "RETURNING" after "INSERT")
3173 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3177 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3179 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3181 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3182 While not an official support venue, C<DBIx::Class> makes heavy use of
3183 C<SQL::Abstract>, and as such list members there are very familiar with
3184 how to create queries.
3188 This module is free software; you may copy this under the same
3189 terms as perl itself (either the GNU General Public License or
3190 the Artistic License)