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 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
631 and exists $v->{-value}
632 and not defined $v->{-value}
635 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
638 my $ik = $self->_expand_ident(-ident => $k);
640 # scalars and objects get expanded as whatever requested or values
642 if (!ref($v) or Scalar::Util::blessed($v)) {
643 my $d = our $Default_Scalar_To;
644 local our $Cur_Col_Meta = $k;
645 return $self->_expand_expr_hashpair_ident(
648 ? $self->_expand_expr($d => $v)
653 if (ref($v) eq 'HASH') {
655 return $self->_expand_op_andor(-and => $v, $k);
657 return undef unless keys %$v;
659 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
660 $self->_assert_pass_injection_guard($op);
661 if ($op =~ s/ [_\s]? \d+ $//x ) {
662 return $self->_expand_expr($k, $v);
664 if (my $x = $self->{expand_op}{$op}) {
665 local our $Cur_Col_Meta = $k;
666 return $self->$x($op, $vv, $k);
668 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
669 return { -op => [ $op, $ik, $vv ] };
671 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
675 { -op => [ $op, $vv ] }
678 if (ref($vv) eq 'ARRAY') {
680 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
681 ? shift @raw : '-or';
682 my @values = map +{ $vk => $_ }, @raw;
684 $op =~ $self->{inequality_op}
685 or $op =~ $self->{not_like_op}
687 if (lc($logic) eq '-or' and @values > 1) {
688 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
689 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
690 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
695 # try to DWIM on equality operators
697 $op =~ $self->{equality_op} ? $self->sqlfalse
698 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
699 : $op =~ $self->{inequality_op} ? $self->sqltrue
700 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
701 : puke "operator '$op' applied on an empty array (field '$k')";
703 return $self->_expand_op_andor($logic => \@values, $k);
709 and exists $vv->{-value}
710 and not defined $vv->{-value}
714 $op =~ /^not$/i ? 'is not' # legacy
715 : $op =~ $self->{equality_op} ? 'is'
716 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
717 : $op =~ $self->{inequality_op} ? 'is not'
718 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
719 : puke "unexpected operator '$op' with undef operand";
720 return +{ -op => [ $is.' null', $ik ] };
722 local our $Cur_Col_Meta = $k;
726 $self->_expand_expr($vv)
729 if (ref($v) eq 'ARRAY') {
730 return $self->sqlfalse unless @$v;
731 $self->_debug("ARRAY($k) means distribute over elements");
733 $v->[0] =~ /^-(and|or)$/i
734 ? shift(@{$v = [ @$v ]})
735 : '-'.lc($self->{logic} || 'OR')
737 return $self->_expand_op_andor(
741 if (my $literal = is_literal_value($v)) {
743 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
746 my ($sql, @bind) = @$literal;
747 if ($self->{bindtype} eq 'columns') {
749 $self->_assert_bindval_matches_bindtype($_);
752 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
757 sub _expand_expr_hashpair_op {
758 my ($self, $k, $v) = @_;
761 $op =~ s/^-// if length($op) > 1;
762 $self->_assert_pass_injection_guard($op);
764 # Ops prefixed with -not_ get converted
766 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
769 $self->_expand_expr({ "-${rest}", $v })
773 # the old special op system requires illegality for top-level use
776 (our $Expand_Depth) == 1
777 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
779 puke "Illegal use of top-level '-$op'"
782 # the old unary op system means we should touch nothing and let it work
784 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
785 return { -op => [ $op, $v ] };
788 # an explicit node type is currently assumed to be expanded (this is almost
789 # certainly wrong and there should be expansion anyway)
791 if ($self->{render}{$k}) {
795 # hashref RHS values get expanded and used as op/func args
800 and (keys %$v)[0] =~ /^-/
802 my ($func) = $k =~ /^-(.*)$/;
803 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
804 return +{ -op => [ $func, $self->_expand_expr($v) ] };
806 return +{ -func => [ $func, $self->_expand_expr($v) ] };
809 # scalars and literals get simply expanded
811 if (!ref($v) or is_literal_value($v)) {
812 return +{ -op => [ $op, $self->_expand_expr($v) ] };
819 my ($self, $op, $body) = @_;
820 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
821 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
823 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
824 ref($body) ? @$body : $body;
825 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
826 unless ($self->{quote_char}) {
827 $self->_assert_pass_injection_guard($_) for @parts;
829 return +{ -ident => \@parts };
833 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
837 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
841 my ($self, undef, $v) = @_;
843 return $self->_expand_expr($v);
845 puke "-bool => undef not supported" unless defined($v);
846 return $self->_expand_ident(-ident => $v);
849 sub _expand_op_andor {
850 my ($self, $logic, $v, $k) = @_;
852 $v = [ map +{ $k, $_ },
854 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
858 my ($logop) = $logic =~ /^-?(.*)$/;
859 if (ref($v) eq 'HASH') {
862 map $self->_expand_expr({ $_ => $v->{$_} }),
866 if (ref($v) eq 'ARRAY') {
867 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
870 (ref($_) eq 'ARRAY' and @$_)
871 or (ref($_) eq 'HASH' and %$_)
877 while (my ($el) = splice @expr, 0, 1) {
878 puke "Supplying an empty left hand side argument is not supported in array-pairs"
879 unless defined($el) and length($el);
880 my $elref = ref($el);
882 local our $Expand_Depth = 0;
883 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
884 } elsif ($elref eq 'ARRAY') {
885 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
886 } elsif (my $l = is_literal_value($el)) {
887 push @res, { -literal => $l };
888 } elsif ($elref eq 'HASH') {
889 local our $Expand_Depth = 0;
890 push @res, grep defined, $self->_expand_expr($el) if %$el;
896 # return $res[0] if @res == 1;
897 return { -op => [ $logop, @res ] };
903 my ($self, $op, $vv, $k) = @_;
904 puke "$op can only take undef as argument"
908 and exists($vv->{-value})
909 and !defined($vv->{-value})
911 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
914 sub _expand_between {
915 my ($self, $op, $vv, $k) = @_;
916 local our $Cur_Col_Meta = $k;
917 my @rhs = map $self->_expand_expr($_),
918 ref($vv) eq 'ARRAY' ? @$vv : $vv;
920 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
922 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
924 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
928 $self->_expand_ident(-ident => $k),
934 my ($self, $op, $vv, $k) = @_;
935 if (my $literal = is_literal_value($vv)) {
936 my ($sql, @bind) = @$literal;
937 my $opened_sql = $self->_open_outer_paren($sql);
939 $op, $self->_expand_ident(-ident => $k),
940 [ { -literal => [ $opened_sql, @bind ] } ]
944 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
945 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
946 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
947 . 'will emit the logically correct SQL instead of raising this exception)'
949 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
951 my @rhs = map $self->_expand_expr($_),
952 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
953 map { defined($_) ? $_: puke($undef_err) }
954 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
955 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
959 $self->_expand_ident(-ident => $k),
965 my ($self, $op, $v) = @_;
966 # DBIx::Class requires a nest warning to be emitted once but the private
967 # method it overrode to do so no longer exists
968 if ($self->{is_dbic_sqlmaker}) {
969 unless (our $Nest_Warned) {
971 "-nest in search conditions is deprecated, you most probably wanted:\n"
972 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
977 return $self->_expand_expr($v);
981 my ($self, $where, $logic) = @_;
983 # Special case: top level simple string treated as literal
985 my $where_exp = (ref($where)
986 ? $self->_expand_expr($where, $logic)
987 : { -literal => [ $where ] });
989 # dispatch expanded expression
991 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
992 # DBIx::Class used to call _recurse_where in scalar context
993 # something else might too...
995 return ($sql, @bind);
998 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1004 my ($self, $ident) = @_;
1006 return $self->_convert($self->_quote($ident));
1010 my ($self, $list) = @_;
1011 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1012 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1016 my ($self, $rest) = @_;
1017 my ($func, @args) = @$rest;
1021 push @arg_sql, shift @x;
1023 } map [ $self->render_aqt($_) ], @args;
1024 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1028 my ($self, $bind) = @_;
1029 return ($self->_convert('?'), $self->_bindtype(@$bind));
1032 sub _render_literal {
1033 my ($self, $literal) = @_;
1034 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1038 sub _render_op_between {
1039 my ($self, $op, $args) = @_;
1040 my ($left, $low, $high) = @$args;
1041 my ($rhsql, @rhbind) = do {
1043 puke "Single arg to between must be a literal"
1044 unless $low->{-literal};
1047 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1048 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1049 @{$l}[1..$#$l], @{$h}[1..$#$h])
1052 my ($lhsql, @lhbind) = $self->render_aqt($left);
1054 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1060 my ($self, $op, $args) = @_;
1061 my ($lhs, $rhs) = @$args;
1064 my ($sql, @bind) = $self->render_aqt($_);
1065 push @in_bind, @bind;
1068 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1070 $lhsql.' '.$self->_sqlcase($op).' ( '
1071 .join(', ', @in_sql)
1077 sub _render_op_andor {
1078 my ($self, $op, $args) = @_;
1079 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1080 return '' unless @parts;
1081 return @{$parts[0]} if @parts == 1;
1082 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1083 return '( '.$sql.' )', @bind;
1086 sub _render_op_multop {
1087 my ($self, $op, $args) = @_;
1088 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1089 return '' unless @parts;
1090 return @{$parts[0]} if @parts == 1;
1091 my ($final_sql) = join(
1092 ' '.$self->_sqlcase($op).' ',
1097 map @{$_}[1..$#$_], @parts
1102 my ($self, $v) = @_;
1103 my ($op, @args) = @$v;
1104 if (my $r = $self->{render_op}{$op}) {
1105 return $self->$r($op, \@args);
1107 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1108 if ($us and @args > 1) {
1109 puke "Special op '${op}' requires first value to be identifier"
1110 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1111 my $k = join(($self->{name_sep}||'.'), @$ident);
1112 local our $Expand_Depth = 1;
1113 return $self->${\($us->{handler})}($k, $op, $args[1]);
1115 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1116 return $self->${\($us->{handler})}($op, $args[0]);
1119 return $self->_render_unop_prefix($op, \@args);
1121 return $self->_render_op_multop($op, \@args);
1126 sub _render_op_not {
1127 my ($self, $op, $v) = @_;
1128 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1129 return "(${sql})", @bind;
1132 sub _render_unop_prefix {
1133 my ($self, $op, $v) = @_;
1134 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1135 my $op_sql = $self->_sqlcase($op);
1136 return ("${op_sql} ${expr_sql}", @bind);
1139 sub _render_unop_postfix {
1140 my ($self, $op, $v) = @_;
1141 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1142 my $op_sql = $self->_sqlcase($op);
1143 return ($expr_sql.' '.$op_sql, @bind);
1146 # Some databases (SQLite) treat col IN (1, 2) different from
1147 # col IN ( (1, 2) ). Use this to strip all outer parens while
1148 # adding them back in the corresponding method
1149 sub _open_outer_paren {
1150 my ($self, $sql) = @_;
1152 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1154 # there are closing parens inside, need the heavy duty machinery
1155 # to reevaluate the extraction starting from $sql (full reevaluation)
1156 if ($inner =~ /\)/) {
1157 require Text::Balanced;
1159 my (undef, $remainder) = do {
1160 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1162 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1165 # the entire expression needs to be a balanced bracketed thing
1166 # (after an extract no remainder sans trailing space)
1167 last if defined $remainder and $remainder =~ /\S/;
1177 #======================================================================
1179 #======================================================================
1181 sub _expand_order_by {
1182 my ($self, $arg) = @_;
1184 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1186 my $expander = sub {
1187 my ($self, $dir, $expr) = @_;
1188 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1189 foreach my $arg (@to_expand) {
1193 and grep /^-(asc|desc)$/, keys %$arg
1195 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1199 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1201 map $self->expand_expr($_, -ident),
1202 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1203 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1206 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1208 return $self->$expander(undef, $arg);
1212 my ($self, $arg) = @_;
1214 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1216 my ($sql, @bind) = $self->render_aqt($expanded);
1218 return '' unless length($sql);
1220 my $final_sql = $self->_sqlcase(' order by ').$sql;
1222 return wantarray ? ($final_sql, @bind) : $final_sql;
1225 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1227 sub _order_by_chunks {
1228 my ($self, $arg) = @_;
1230 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1232 return $self->_chunkify_order_by($expanded);
1235 sub _chunkify_order_by {
1236 my ($self, $expanded) = @_;
1238 return grep length, $self->render_aqt($expanded)
1239 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1242 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1243 return map $self->_chunkify_order_by($_), @$l;
1245 return [ $self->render_aqt($_) ];
1249 #======================================================================
1250 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1251 #======================================================================
1257 $self->_expand_maybe_list_expr($from, undef, -ident)
1262 #======================================================================
1264 #======================================================================
1266 sub _expand_maybe_list_expr {
1267 my ($self, $expr, $logic, $default) = @_;
1269 if (ref($expr) eq 'ARRAY') {
1271 map $self->expand_expr($_, $default), @$expr
1278 return $self->expand_expr($e, $default);
1281 # highly optimized, as it's called way too often
1283 # my ($self, $label) = @_;
1285 return '' unless defined $_[1];
1286 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1287 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1289 unless ($_[0]->{quote_char}) {
1290 if (ref($_[1]) eq 'ARRAY') {
1291 return join($_[0]->{name_sep}||'.', @{$_[1]});
1293 $_[0]->_assert_pass_injection_guard($_[1]);
1298 my $qref = ref $_[0]->{quote_char};
1300 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1301 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1302 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1304 my $esc = $_[0]->{escape_char} || $r;
1306 # parts containing * are naturally unquoted
1308 $_[0]->{name_sep}||'',
1312 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1314 (ref($_[1]) eq 'ARRAY'
1318 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1326 # Conversion, if applicable
1328 #my ($self, $arg) = @_;
1329 if ($_[0]->{convert_where}) {
1330 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1337 #my ($self, $col, @vals) = @_;
1338 # called often - tighten code
1339 return $_[0]->{bindtype} eq 'columns'
1340 ? map {[$_[1], $_]} @_[2 .. $#_]
1345 # Dies if any element of @bind is not in [colname => value] format
1346 # if bindtype is 'columns'.
1347 sub _assert_bindval_matches_bindtype {
1348 # my ($self, @bind) = @_;
1350 if ($self->{bindtype} eq 'columns') {
1352 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1353 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1359 sub _join_sql_clauses {
1360 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1362 if (@$clauses_aref > 1) {
1363 my $join = " " . $self->_sqlcase($logic) . " ";
1364 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1365 return ($sql, @$bind_aref);
1367 elsif (@$clauses_aref) {
1368 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1371 return (); # if no SQL, ignore @$bind_aref
1376 # Fix SQL case, if so requested
1378 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1379 # don't touch the argument ... crooked logic, but let's not change it!
1380 return $_[0]->{case} ? $_[1] : uc($_[1]);
1384 #======================================================================
1385 # DISPATCHING FROM REFKIND
1386 #======================================================================
1389 my ($self, $data) = @_;
1391 return 'UNDEF' unless defined $data;
1393 # blessed objects are treated like scalars
1394 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1396 return 'SCALAR' unless $ref;
1399 while ($ref eq 'REF') {
1401 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1405 return ($ref||'SCALAR') . ('REF' x $n_steps);
1409 my ($self, $data) = @_;
1410 my @try = ($self->_refkind($data));
1411 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1412 push @try, 'FALLBACK';
1416 sub _METHOD_FOR_refkind {
1417 my ($self, $meth_prefix, $data) = @_;
1420 for (@{$self->_try_refkind($data)}) {
1421 $method = $self->can($meth_prefix."_".$_)
1425 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1429 sub _SWITCH_refkind {
1430 my ($self, $data, $dispatch_table) = @_;
1433 for (@{$self->_try_refkind($data)}) {
1434 $coderef = $dispatch_table->{$_}
1438 puke "no dispatch entry for ".$self->_refkind($data)
1447 #======================================================================
1448 # VALUES, GENERATE, AUTOLOAD
1449 #======================================================================
1451 # LDNOTE: original code from nwiger, didn't touch code in that section
1452 # I feel the AUTOLOAD stuff should not be the default, it should
1453 # only be activated on explicit demand by user.
1457 my $data = shift || return;
1458 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1459 unless ref $data eq 'HASH';
1462 foreach my $k (sort keys %$data) {
1463 my $v = $data->{$k};
1464 $self->_SWITCH_refkind($v, {
1466 if ($self->{array_datatypes}) { # array datatype
1467 push @all_bind, $self->_bindtype($k, $v);
1469 else { # literal SQL with bind
1470 my ($sql, @bind) = @$v;
1471 $self->_assert_bindval_matches_bindtype(@bind);
1472 push @all_bind, @bind;
1475 ARRAYREFREF => sub { # literal SQL with bind
1476 my ($sql, @bind) = @${$v};
1477 $self->_assert_bindval_matches_bindtype(@bind);
1478 push @all_bind, @bind;
1480 SCALARREF => sub { # literal SQL without bind
1482 SCALAR_or_UNDEF => sub {
1483 push @all_bind, $self->_bindtype($k, $v);
1494 my(@sql, @sqlq, @sqlv);
1498 if ($ref eq 'HASH') {
1499 for my $k (sort keys %$_) {
1502 my $label = $self->_quote($k);
1503 if ($r eq 'ARRAY') {
1504 # literal SQL with bind
1505 my ($sql, @bind) = @$v;
1506 $self->_assert_bindval_matches_bindtype(@bind);
1507 push @sqlq, "$label = $sql";
1509 } elsif ($r eq 'SCALAR') {
1510 # literal SQL without bind
1511 push @sqlq, "$label = $$v";
1513 push @sqlq, "$label = ?";
1514 push @sqlv, $self->_bindtype($k, $v);
1517 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1518 } elsif ($ref eq 'ARRAY') {
1519 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1522 if ($r eq 'ARRAY') { # literal SQL with bind
1523 my ($sql, @bind) = @$v;
1524 $self->_assert_bindval_matches_bindtype(@bind);
1527 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1528 # embedded literal SQL
1535 push @sql, '(' . join(', ', @sqlq) . ')';
1536 } elsif ($ref eq 'SCALAR') {
1540 # strings get case twiddled
1541 push @sql, $self->_sqlcase($_);
1545 my $sql = join ' ', @sql;
1547 # this is pretty tricky
1548 # if ask for an array, return ($stmt, @bind)
1549 # otherwise, s/?/shift @sqlv/ to put it inline
1551 return ($sql, @sqlv);
1553 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1554 ref $d ? $d->[1] : $d/e;
1563 # This allows us to check for a local, then _form, attr
1565 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1566 return $self->generate($name, @_);
1577 SQL::Abstract - Generate SQL from Perl data structures
1583 my $sql = SQL::Abstract->new;
1585 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1587 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1589 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1591 my($stmt, @bind) = $sql->delete($table, \%where);
1593 # Then, use these in your DBI statements
1594 my $sth = $dbh->prepare($stmt);
1595 $sth->execute(@bind);
1597 # Just generate the WHERE clause
1598 my($stmt, @bind) = $sql->where(\%where, $order);
1600 # Return values in the same order, for hashed queries
1601 # See PERFORMANCE section for more details
1602 my @bind = $sql->values(\%fieldvals);
1606 This module was inspired by the excellent L<DBIx::Abstract>.
1607 However, in using that module I found that what I really wanted
1608 to do was generate SQL, but still retain complete control over my
1609 statement handles and use the DBI interface. So, I set out to
1610 create an abstract SQL generation module.
1612 While based on the concepts used by L<DBIx::Abstract>, there are
1613 several important differences, especially when it comes to WHERE
1614 clauses. I have modified the concepts used to make the SQL easier
1615 to generate from Perl data structures and, IMO, more intuitive.
1616 The underlying idea is for this module to do what you mean, based
1617 on the data structures you provide it. The big advantage is that
1618 you don't have to modify your code every time your data changes,
1619 as this module figures it out.
1621 To begin with, an SQL INSERT is as easy as just specifying a hash
1622 of C<key=value> pairs:
1625 name => 'Jimbo Bobson',
1626 phone => '123-456-7890',
1627 address => '42 Sister Lane',
1628 city => 'St. Louis',
1629 state => 'Louisiana',
1632 The SQL can then be generated with this:
1634 my($stmt, @bind) = $sql->insert('people', \%data);
1636 Which would give you something like this:
1638 $stmt = "INSERT INTO people
1639 (address, city, name, phone, state)
1640 VALUES (?, ?, ?, ?, ?)";
1641 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1642 '123-456-7890', 'Louisiana');
1644 These are then used directly in your DBI code:
1646 my $sth = $dbh->prepare($stmt);
1647 $sth->execute(@bind);
1649 =head2 Inserting and Updating Arrays
1651 If your database has array types (like for example Postgres),
1652 activate the special option C<< array_datatypes => 1 >>
1653 when creating the C<SQL::Abstract> object.
1654 Then you may use an arrayref to insert and update database array types:
1656 my $sql = SQL::Abstract->new(array_datatypes => 1);
1658 planets => [qw/Mercury Venus Earth Mars/]
1661 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1665 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1667 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1670 =head2 Inserting and Updating SQL
1672 In order to apply SQL functions to elements of your C<%data> you may
1673 specify a reference to an arrayref for the given hash value. For example,
1674 if you need to execute the Oracle C<to_date> function on a value, you can
1675 say something like this:
1679 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1682 The first value in the array is the actual SQL. Any other values are
1683 optional and would be included in the bind values array. This gives
1686 my($stmt, @bind) = $sql->insert('people', \%data);
1688 $stmt = "INSERT INTO people (name, date_entered)
1689 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1690 @bind = ('Bill', '03/02/2003');
1692 An UPDATE is just as easy, all you change is the name of the function:
1694 my($stmt, @bind) = $sql->update('people', \%data);
1696 Notice that your C<%data> isn't touched; the module will generate
1697 the appropriately quirky SQL for you automatically. Usually you'll
1698 want to specify a WHERE clause for your UPDATE, though, which is
1699 where handling C<%where> hashes comes in handy...
1701 =head2 Complex where statements
1703 This module can generate pretty complicated WHERE statements
1704 easily. For example, simple C<key=value> pairs are taken to mean
1705 equality, and if you want to see if a field is within a set
1706 of values, you can use an arrayref. Let's say we wanted to
1707 SELECT some data based on this criteria:
1710 requestor => 'inna',
1711 worker => ['nwiger', 'rcwe', 'sfz'],
1712 status => { '!=', 'completed' }
1715 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1717 The above would give you something like this:
1719 $stmt = "SELECT * FROM tickets WHERE
1720 ( requestor = ? ) AND ( status != ? )
1721 AND ( worker = ? OR worker = ? OR worker = ? )";
1722 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1724 Which you could then use in DBI code like so:
1726 my $sth = $dbh->prepare($stmt);
1727 $sth->execute(@bind);
1733 The methods are simple. There's one for every major SQL operation,
1734 and a constructor you use first. The arguments are specified in a
1735 similar order for each method (table, then fields, then a where
1736 clause) to try and simplify things.
1738 =head2 new(option => 'value')
1740 The C<new()> function takes a list of options and values, and returns
1741 a new B<SQL::Abstract> object which can then be used to generate SQL
1742 through the methods below. The options accepted are:
1748 If set to 'lower', then SQL will be generated in all lowercase. By
1749 default SQL is generated in "textbook" case meaning something like:
1751 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1753 Any setting other than 'lower' is ignored.
1757 This determines what the default comparison operator is. By default
1758 it is C<=>, meaning that a hash like this:
1760 %where = (name => 'nwiger', email => 'nate@wiger.org');
1762 Will generate SQL like this:
1764 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1766 However, you may want loose comparisons by default, so if you set
1767 C<cmp> to C<like> you would get SQL such as:
1769 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1771 You can also override the comparison on an individual basis - see
1772 the huge section on L</"WHERE CLAUSES"> at the bottom.
1774 =item sqltrue, sqlfalse
1776 Expressions for inserting boolean values within SQL statements.
1777 By default these are C<1=1> and C<1=0>. They are used
1778 by the special operators C<-in> and C<-not_in> for generating
1779 correct SQL even when the argument is an empty array (see below).
1783 This determines the default logical operator for multiple WHERE
1784 statements in arrays or hashes. If absent, the default logic is "or"
1785 for arrays, and "and" for hashes. This means that a WHERE
1789 event_date => {'>=', '2/13/99'},
1790 event_date => {'<=', '4/24/03'},
1793 will generate SQL like this:
1795 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1797 This is probably not what you want given this query, though (look
1798 at the dates). To change the "OR" to an "AND", simply specify:
1800 my $sql = SQL::Abstract->new(logic => 'and');
1802 Which will change the above C<WHERE> to:
1804 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1806 The logic can also be changed locally by inserting
1807 a modifier in front of an arrayref:
1809 @where = (-and => [event_date => {'>=', '2/13/99'},
1810 event_date => {'<=', '4/24/03'} ]);
1812 See the L</"WHERE CLAUSES"> section for explanations.
1816 This will automatically convert comparisons using the specified SQL
1817 function for both column and value. This is mostly used with an argument
1818 of C<upper> or C<lower>, so that the SQL will have the effect of
1819 case-insensitive "searches". For example, this:
1821 $sql = SQL::Abstract->new(convert => 'upper');
1822 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1824 Will turn out the following SQL:
1826 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1828 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1829 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1830 not validate this option; it will just pass through what you specify verbatim).
1834 This is a kludge because many databases suck. For example, you can't
1835 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1836 Instead, you have to use C<bind_param()>:
1838 $sth->bind_param(1, 'reg data');
1839 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1841 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1842 which loses track of which field each slot refers to. Fear not.
1844 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1845 Currently, you can specify either C<normal> (default) or C<columns>. If you
1846 specify C<columns>, you will get an array that looks like this:
1848 my $sql = SQL::Abstract->new(bindtype => 'columns');
1849 my($stmt, @bind) = $sql->insert(...);
1852 [ 'column1', 'value1' ],
1853 [ 'column2', 'value2' ],
1854 [ 'column3', 'value3' ],
1857 You can then iterate through this manually, using DBI's C<bind_param()>.
1859 $sth->prepare($stmt);
1862 my($col, $data) = @$_;
1863 if ($col eq 'details' || $col eq 'comments') {
1864 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1865 } elsif ($col eq 'image') {
1866 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1868 $sth->bind_param($i, $data);
1872 $sth->execute; # execute without @bind now
1874 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1875 Basically, the advantage is still that you don't have to care which fields
1876 are or are not included. You could wrap that above C<for> loop in a simple
1877 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1878 get a layer of abstraction over manual SQL specification.
1880 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1881 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1882 will expect the bind values in this format.
1886 This is the character that a table or column name will be quoted
1887 with. By default this is an empty string, but you could set it to
1888 the character C<`>, to generate SQL like this:
1890 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1892 Alternatively, you can supply an array ref of two items, the first being the left
1893 hand quote character, and the second the right hand quote character. For
1894 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1895 that generates SQL like this:
1897 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1899 Quoting is useful if you have tables or columns names that are reserved
1900 words in your database's SQL dialect.
1904 This is the character that will be used to escape L</quote_char>s appearing
1905 in an identifier before it has been quoted.
1907 The parameter default in case of a single L</quote_char> character is the quote
1910 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1911 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1912 of the B<opening (left)> L</quote_char> within the identifier are currently left
1913 untouched. The default for opening-closing-style quotes may change in future
1914 versions, thus you are B<strongly encouraged> to specify the escape character
1919 This is the character that separates a table and column name. It is
1920 necessary to specify this when the C<quote_char> option is selected,
1921 so that tables and column names can be individually quoted like this:
1923 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1925 =item injection_guard
1927 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1928 column name specified in a query structure. This is a safety mechanism to avoid
1929 injection attacks when mishandling user input e.g.:
1931 my %condition_as_column_value_pairs = get_values_from_user();
1932 $sqla->select( ... , \%condition_as_column_value_pairs );
1934 If the expression matches an exception is thrown. Note that literal SQL
1935 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1937 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1939 =item array_datatypes
1941 When this option is true, arrayrefs in INSERT or UPDATE are
1942 interpreted as array datatypes and are passed directly
1944 When this option is false, arrayrefs are interpreted
1945 as literal SQL, just like refs to arrayrefs
1946 (but this behavior is for backwards compatibility; when writing
1947 new queries, use the "reference to arrayref" syntax
1953 Takes a reference to a list of "special operators"
1954 to extend the syntax understood by L<SQL::Abstract>.
1955 See section L</"SPECIAL OPERATORS"> for details.
1959 Takes a reference to a list of "unary operators"
1960 to extend the syntax understood by L<SQL::Abstract>.
1961 See section L</"UNARY OPERATORS"> for details.
1967 =head2 insert($table, \@values || \%fieldvals, \%options)
1969 This is the simplest function. You simply give it a table name
1970 and either an arrayref of values or hashref of field/value pairs.
1971 It returns an SQL INSERT statement and a list of bind values.
1972 See the sections on L</"Inserting and Updating Arrays"> and
1973 L</"Inserting and Updating SQL"> for information on how to insert
1974 with those data types.
1976 The optional C<\%options> hash reference may contain additional
1977 options to generate the insert SQL. Currently supported options
1984 Takes either a scalar of raw SQL fields, or an array reference of
1985 field names, and adds on an SQL C<RETURNING> statement at the end.
1986 This allows you to return data generated by the insert statement
1987 (such as row IDs) without performing another C<SELECT> statement.
1988 Note, however, this is not part of the SQL standard and may not
1989 be supported by all database engines.
1993 =head2 update($table, \%fieldvals, \%where, \%options)
1995 This takes a table, hashref of field/value pairs, and an optional
1996 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1998 See the sections on L</"Inserting and Updating Arrays"> and
1999 L</"Inserting and Updating SQL"> for information on how to insert
2000 with those data types.
2002 The optional C<\%options> hash reference may contain additional
2003 options to generate the update SQL. Currently supported options
2010 See the C<returning> option to
2011 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2015 =head2 select($source, $fields, $where, $order)
2017 This returns a SQL SELECT statement and associated list of bind values, as
2018 specified by the arguments:
2024 Specification of the 'FROM' part of the statement.
2025 The argument can be either a plain scalar (interpreted as a table
2026 name, will be quoted), or an arrayref (interpreted as a list
2027 of table names, joined by commas, quoted), or a scalarref
2028 (literal SQL, not quoted).
2032 Specification of the list of fields to retrieve from
2034 The argument can be either an arrayref (interpreted as a list
2035 of field names, will be joined by commas and quoted), or a
2036 plain scalar (literal SQL, not quoted).
2037 Please observe that this API is not as flexible as that of
2038 the first argument C<$source>, for backwards compatibility reasons.
2042 Optional argument to specify the WHERE part of the query.
2043 The argument is most often a hashref, but can also be
2044 an arrayref or plain scalar --
2045 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2049 Optional argument to specify the ORDER BY part of the query.
2050 The argument can be a scalar, a hashref or an arrayref
2051 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2057 =head2 delete($table, \%where, \%options)
2059 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2060 It returns an SQL DELETE statement and list of bind values.
2062 The optional C<\%options> hash reference may contain additional
2063 options to generate the delete SQL. Currently supported options
2070 See the C<returning> option to
2071 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2075 =head2 where(\%where, $order)
2077 This is used to generate just the WHERE clause. For example,
2078 if you have an arbitrary data structure and know what the
2079 rest of your SQL is going to look like, but want an easy way
2080 to produce a WHERE clause, use this. It returns an SQL WHERE
2081 clause and list of bind values.
2084 =head2 values(\%data)
2086 This just returns the values from the hash C<%data>, in the same
2087 order that would be returned from any of the other above queries.
2088 Using this allows you to markedly speed up your queries if you
2089 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2091 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2093 Warning: This is an experimental method and subject to change.
2095 This returns arbitrarily generated SQL. It's a really basic shortcut.
2096 It will return two different things, depending on return context:
2098 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2099 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2101 These would return the following:
2103 # First calling form
2104 $stmt = "CREATE TABLE test (?, ?)";
2105 @bind = (field1, field2);
2107 # Second calling form
2108 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2110 Depending on what you're trying to do, it's up to you to choose the correct
2111 format. In this example, the second form is what you would want.
2115 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2119 ALTER SESSION SET nls_date_format = 'MM/YY'
2121 You get the idea. Strings get their case twiddled, but everything
2122 else remains verbatim.
2124 =head1 EXPORTABLE FUNCTIONS
2126 =head2 is_plain_value
2128 Determines if the supplied argument is a plain value as understood by this
2133 =item * The value is C<undef>
2135 =item * The value is a non-reference
2137 =item * The value is an object with stringification overloading
2139 =item * The value is of the form C<< { -value => $anything } >>
2143 On failure returns C<undef>, on success returns a B<scalar> reference
2144 to the original supplied argument.
2150 The stringification overloading detection is rather advanced: it takes
2151 into consideration not only the presence of a C<""> overload, but if that
2152 fails also checks for enabled
2153 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2154 on either C<0+> or C<bool>.
2156 Unfortunately testing in the field indicates that this
2157 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2158 but only when very large numbers of stringifying objects are involved.
2159 At the time of writing ( Sep 2014 ) there is no clear explanation of
2160 the direct cause, nor is there a manageably small test case that reliably
2161 reproduces the problem.
2163 If you encounter any of the following exceptions in B<random places within
2164 your application stack> - this module may be to blame:
2166 Operation "ne": no method found,
2167 left argument in overloaded package <something>,
2168 right argument in overloaded package <something>
2172 Stub found while resolving method "???" overloading """" in package <something>
2174 If you fall victim to the above - please attempt to reduce the problem
2175 to something that could be sent to the L<SQL::Abstract developers
2176 |DBIx::Class/GETTING HELP/SUPPORT>
2177 (either publicly or privately). As a workaround in the meantime you can
2178 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2179 value, which will most likely eliminate your problem (at the expense of
2180 not being able to properly detect exotic forms of stringification).
2182 This notice and environment variable will be removed in a future version,
2183 as soon as the underlying problem is found and a reliable workaround is
2188 =head2 is_literal_value
2190 Determines if the supplied argument is a literal value as understood by this
2195 =item * C<\$sql_string>
2197 =item * C<\[ $sql_string, @bind_values ]>
2201 On failure returns C<undef>, on success returns an B<array> reference
2202 containing the unpacked version of the supplied literal SQL and bind values.
2204 =head1 WHERE CLAUSES
2208 This module uses a variation on the idea from L<DBIx::Abstract>. It
2209 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2210 module is that things in arrays are OR'ed, and things in hashes
2213 The easiest way to explain is to show lots of examples. After
2214 each C<%where> hash shown, it is assumed you used:
2216 my($stmt, @bind) = $sql->where(\%where);
2218 However, note that the C<%where> hash can be used directly in any
2219 of the other functions as well, as described above.
2221 =head2 Key-value pairs
2223 So, let's get started. To begin, a simple hash:
2227 status => 'completed'
2230 Is converted to SQL C<key = val> statements:
2232 $stmt = "WHERE user = ? AND status = ?";
2233 @bind = ('nwiger', 'completed');
2235 One common thing I end up doing is having a list of values that
2236 a field can be in. To do this, simply specify a list inside of
2241 status => ['assigned', 'in-progress', 'pending'];
2244 This simple code will create the following:
2246 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2247 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2249 A field associated to an empty arrayref will be considered a
2250 logical false and will generate 0=1.
2252 =head2 Tests for NULL values
2254 If the value part is C<undef> then this is converted to SQL <IS NULL>
2263 $stmt = "WHERE user = ? AND status IS NULL";
2266 To test if a column IS NOT NULL:
2270 status => { '!=', undef },
2273 =head2 Specific comparison operators
2275 If you want to specify a different type of operator for your comparison,
2276 you can use a hashref for a given column:
2280 status => { '!=', 'completed' }
2283 Which would generate:
2285 $stmt = "WHERE user = ? AND status != ?";
2286 @bind = ('nwiger', 'completed');
2288 To test against multiple values, just enclose the values in an arrayref:
2290 status => { '=', ['assigned', 'in-progress', 'pending'] };
2292 Which would give you:
2294 "WHERE status = ? OR status = ? OR status = ?"
2297 The hashref can also contain multiple pairs, in which case it is expanded
2298 into an C<AND> of its elements:
2302 status => { '!=', 'completed', -not_like => 'pending%' }
2305 # Or more dynamically, like from a form
2306 $where{user} = 'nwiger';
2307 $where{status}{'!='} = 'completed';
2308 $where{status}{'-not_like'} = 'pending%';
2310 # Both generate this
2311 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2312 @bind = ('nwiger', 'completed', 'pending%');
2315 To get an OR instead, you can combine it with the arrayref idea:
2319 priority => [ { '=', 2 }, { '>', 5 } ]
2322 Which would generate:
2324 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2325 @bind = ('2', '5', 'nwiger');
2327 If you want to include literal SQL (with or without bind values), just use a
2328 scalar reference or reference to an arrayref as the value:
2331 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2332 date_expires => { '<' => \"now()" }
2335 Which would generate:
2337 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2338 @bind = ('11/26/2008');
2341 =head2 Logic and nesting operators
2343 In the example above,
2344 there is a subtle trap if you want to say something like
2345 this (notice the C<AND>):
2347 WHERE priority != ? AND priority != ?
2349 Because, in Perl you I<can't> do this:
2351 priority => { '!=' => 2, '!=' => 1 }
2353 As the second C<!=> key will obliterate the first. The solution
2354 is to use the special C<-modifier> form inside an arrayref:
2356 priority => [ -and => {'!=', 2},
2360 Normally, these would be joined by C<OR>, but the modifier tells it
2361 to use C<AND> instead. (Hint: You can use this in conjunction with the
2362 C<logic> option to C<new()> in order to change the way your queries
2363 work by default.) B<Important:> Note that the C<-modifier> goes
2364 B<INSIDE> the arrayref, as an extra first element. This will
2365 B<NOT> do what you think it might:
2367 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2369 Here is a quick list of equivalencies, since there is some overlap:
2372 status => {'!=', 'completed', 'not like', 'pending%' }
2373 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2376 status => {'=', ['assigned', 'in-progress']}
2377 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2378 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2382 =head2 Special operators: IN, BETWEEN, etc.
2384 You can also use the hashref format to compare a list of fields using the
2385 C<IN> comparison operator, by specifying the list as an arrayref:
2388 status => 'completed',
2389 reportid => { -in => [567, 2335, 2] }
2392 Which would generate:
2394 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2395 @bind = ('completed', '567', '2335', '2');
2397 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2400 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2401 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2402 'sqltrue' (by default: C<1=1>).
2404 In addition to the array you can supply a chunk of literal sql or
2405 literal sql with bind:
2408 customer => { -in => \[
2409 'SELECT cust_id FROM cust WHERE balance > ?',
2412 status => { -in => \'SELECT status_codes FROM states' },
2418 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2419 AND status IN ( SELECT status_codes FROM states )
2423 Finally, if the argument to C<-in> is not a reference, it will be
2424 treated as a single-element array.
2426 Another pair of operators is C<-between> and C<-not_between>,
2427 used with an arrayref of two values:
2431 completion_date => {
2432 -not_between => ['2002-10-01', '2003-02-06']
2438 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2440 Just like with C<-in> all plausible combinations of literal SQL
2444 start0 => { -between => [ 1, 2 ] },
2445 start1 => { -between => \["? AND ?", 1, 2] },
2446 start2 => { -between => \"lower(x) AND upper(y)" },
2447 start3 => { -between => [
2449 \["upper(?)", 'stuff' ],
2456 ( start0 BETWEEN ? AND ? )
2457 AND ( start1 BETWEEN ? AND ? )
2458 AND ( start2 BETWEEN lower(x) AND upper(y) )
2459 AND ( start3 BETWEEN lower(x) AND upper(?) )
2461 @bind = (1, 2, 1, 2, 'stuff');
2464 These are the two builtin "special operators"; but the
2465 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2467 =head2 Unary operators: bool
2469 If you wish to test against boolean columns or functions within your
2470 database you can use the C<-bool> and C<-not_bool> operators. For
2471 example to test the column C<is_user> being true and the column
2472 C<is_enabled> being false you would use:-
2476 -not_bool => 'is_enabled',
2481 WHERE is_user AND NOT is_enabled
2483 If a more complex combination is required, testing more conditions,
2484 then you should use the and/or operators:-
2489 -not_bool => { two=> { -rlike => 'bar' } },
2490 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2501 (NOT ( three = ? OR three > ? ))
2504 =head2 Nested conditions, -and/-or prefixes
2506 So far, we've seen how multiple conditions are joined with a top-level
2507 C<AND>. We can change this by putting the different conditions we want in
2508 hashes and then putting those hashes in an array. For example:
2513 status => { -like => ['pending%', 'dispatched'] },
2517 status => 'unassigned',
2521 This data structure would create the following:
2523 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2524 OR ( user = ? AND status = ? ) )";
2525 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2528 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2529 to change the logic inside:
2535 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2536 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2543 $stmt = "WHERE ( user = ?
2544 AND ( ( workhrs > ? AND geo = ? )
2545 OR ( workhrs < ? OR geo = ? ) ) )";
2546 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2548 =head3 Algebraic inconsistency, for historical reasons
2550 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2551 operator goes C<outside> of the nested structure; whereas when connecting
2552 several constraints on one column, the C<-and> operator goes
2553 C<inside> the arrayref. Here is an example combining both features:
2556 -and => [a => 1, b => 2],
2557 -or => [c => 3, d => 4],
2558 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2563 WHERE ( ( ( a = ? AND b = ? )
2564 OR ( c = ? OR d = ? )
2565 OR ( e LIKE ? AND e LIKE ? ) ) )
2567 This difference in syntax is unfortunate but must be preserved for
2568 historical reasons. So be careful: the two examples below would
2569 seem algebraically equivalent, but they are not
2572 { -like => 'foo%' },
2573 { -like => '%bar' },
2575 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2578 { col => { -like => 'foo%' } },
2579 { col => { -like => '%bar' } },
2581 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2584 =head2 Literal SQL and value type operators
2586 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2587 side" is a column name and the "right side" is a value (normally rendered as
2588 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2589 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2590 alter this behavior. There are several ways of doing so.
2594 This is a virtual operator that signals the string to its right side is an
2595 identifier (a column name) and not a value. For example to compare two
2596 columns you would write:
2599 priority => { '<', 2 },
2600 requestor => { -ident => 'submitter' },
2605 $stmt = "WHERE priority < ? AND requestor = submitter";
2608 If you are maintaining legacy code you may see a different construct as
2609 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2614 This is a virtual operator that signals that the construct to its right side
2615 is a value to be passed to DBI. This is for example necessary when you want
2616 to write a where clause against an array (for RDBMS that support such
2617 datatypes). For example:
2620 array => { -value => [1, 2, 3] }
2625 $stmt = 'WHERE array = ?';
2626 @bind = ([1, 2, 3]);
2628 Note that if you were to simply say:
2634 the result would probably not be what you wanted:
2636 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2641 Finally, sometimes only literal SQL will do. To include a random snippet
2642 of SQL verbatim, you specify it as a scalar reference. Consider this only
2643 as a last resort. Usually there is a better way. For example:
2646 priority => { '<', 2 },
2647 requestor => { -in => \'(SELECT name FROM hitmen)' },
2652 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2655 Note that in this example, you only get one bind parameter back, since
2656 the verbatim SQL is passed as part of the statement.
2660 Never use untrusted input as a literal SQL argument - this is a massive
2661 security risk (there is no way to check literal snippets for SQL
2662 injections and other nastyness). If you need to deal with untrusted input
2663 use literal SQL with placeholders as described next.
2665 =head3 Literal SQL with placeholders and bind values (subqueries)
2667 If the literal SQL to be inserted has placeholders and bind values,
2668 use a reference to an arrayref (yes this is a double reference --
2669 not so common, but perfectly legal Perl). For example, to find a date
2670 in Postgres you can use something like this:
2673 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2678 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2681 Note that you must pass the bind values in the same format as they are returned
2682 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2683 to C<columns>, you must provide the bind values in the
2684 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2685 scalar value; most commonly the column name, but you can use any scalar value
2686 (including references and blessed references), L<SQL::Abstract> will simply
2687 pass it through intact. So if C<bindtype> is set to C<columns> the above
2688 example will look like:
2691 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2694 Literal SQL is especially useful for nesting parenthesized clauses in the
2695 main SQL query. Here is a first example:
2697 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2701 bar => \["IN ($sub_stmt)" => @sub_bind],
2706 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2707 WHERE c2 < ? AND c3 LIKE ?))";
2708 @bind = (1234, 100, "foo%");
2710 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2711 are expressed in the same way. Of course the C<$sub_stmt> and
2712 its associated bind values can be generated through a former call
2715 my ($sub_stmt, @sub_bind)
2716 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2717 c3 => {-like => "foo%"}});
2720 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2723 In the examples above, the subquery was used as an operator on a column;
2724 but the same principle also applies for a clause within the main C<%where>
2725 hash, like an EXISTS subquery:
2727 my ($sub_stmt, @sub_bind)
2728 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2729 my %where = ( -and => [
2731 \["EXISTS ($sub_stmt)" => @sub_bind],
2736 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2737 WHERE c1 = ? AND c2 > t0.c0))";
2741 Observe that the condition on C<c2> in the subquery refers to
2742 column C<t0.c0> of the main query: this is I<not> a bind
2743 value, so we have to express it through a scalar ref.
2744 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2745 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2746 what we wanted here.
2748 Finally, here is an example where a subquery is used
2749 for expressing unary negation:
2751 my ($sub_stmt, @sub_bind)
2752 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2753 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2755 lname => {like => '%son%'},
2756 \["NOT ($sub_stmt)" => @sub_bind],
2761 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2762 @bind = ('%son%', 10, 20)
2764 =head3 Deprecated usage of Literal SQL
2766 Below are some examples of archaic use of literal SQL. It is shown only as
2767 reference for those who deal with legacy code. Each example has a much
2768 better, cleaner and safer alternative that users should opt for in new code.
2774 my %where = ( requestor => \'IS NOT NULL' )
2776 $stmt = "WHERE requestor IS NOT NULL"
2778 This used to be the way of generating NULL comparisons, before the handling
2779 of C<undef> got formalized. For new code please use the superior syntax as
2780 described in L</Tests for NULL values>.
2784 my %where = ( requestor => \'= submitter' )
2786 $stmt = "WHERE requestor = submitter"
2788 This used to be the only way to compare columns. Use the superior L</-ident>
2789 method for all new code. For example an identifier declared in such a way
2790 will be properly quoted if L</quote_char> is properly set, while the legacy
2791 form will remain as supplied.
2795 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2797 $stmt = "WHERE completed > ? AND is_ready"
2798 @bind = ('2012-12-21')
2800 Using an empty string literal used to be the only way to express a boolean.
2801 For all new code please use the much more readable
2802 L<-bool|/Unary operators: bool> operator.
2808 These pages could go on for a while, since the nesting of the data
2809 structures this module can handle are pretty much unlimited (the
2810 module implements the C<WHERE> expansion as a recursive function
2811 internally). Your best bet is to "play around" with the module a
2812 little to see how the data structures behave, and choose the best
2813 format for your data based on that.
2815 And of course, all the values above will probably be replaced with
2816 variables gotten from forms or the command line. After all, if you
2817 knew everything ahead of time, you wouldn't have to worry about
2818 dynamically-generating SQL and could just hardwire it into your
2821 =head1 ORDER BY CLAUSES
2823 Some functions take an order by clause. This can either be a scalar (just a
2824 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2825 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2828 Given | Will Generate
2829 ---------------------------------------------------------------
2831 'colA' | ORDER BY colA
2833 [qw/colA colB/] | ORDER BY colA, colB
2835 {-asc => 'colA'} | ORDER BY colA ASC
2837 {-desc => 'colB'} | ORDER BY colB DESC
2839 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2841 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2843 \'colA DESC' | ORDER BY colA DESC
2845 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2846 | /* ...with $x bound to ? */
2849 { -asc => 'colA' }, | colA ASC,
2850 { -desc => [qw/colB/] }, | colB DESC,
2851 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2852 \'colE DESC', | colE DESC,
2853 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2854 ] | /* ...with $x bound to ? */
2855 ===============================================================
2859 =head1 SPECIAL OPERATORS
2861 my $sqlmaker = SQL::Abstract->new(special_ops => [
2865 my ($self, $field, $op, $arg) = @_;
2871 handler => 'method_name',
2875 A "special operator" is a SQL syntactic clause that can be
2876 applied to a field, instead of a usual binary operator.
2879 WHERE field IN (?, ?, ?)
2880 WHERE field BETWEEN ? AND ?
2881 WHERE MATCH(field) AGAINST (?, ?)
2883 Special operators IN and BETWEEN are fairly standard and therefore
2884 are builtin within C<SQL::Abstract> (as the overridable methods
2885 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2886 like the MATCH .. AGAINST example above which is specific to MySQL,
2887 you can write your own operator handlers - supply a C<special_ops>
2888 argument to the C<new> method. That argument takes an arrayref of
2889 operator definitions; each operator definition is a hashref with two
2896 the regular expression to match the operator
2900 Either a coderef or a plain scalar method name. In both cases
2901 the expected return is C<< ($sql, @bind) >>.
2903 When supplied with a method name, it is simply called on the
2904 L<SQL::Abstract> object as:
2906 $self->$method_name($field, $op, $arg)
2910 $field is the LHS of the operator
2911 $op is the part that matched the handler regex
2914 When supplied with a coderef, it is called as:
2916 $coderef->($self, $field, $op, $arg)
2921 For example, here is an implementation
2922 of the MATCH .. AGAINST syntax for MySQL
2924 my $sqlmaker = SQL::Abstract->new(special_ops => [
2926 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2927 {regex => qr/^match$/i,
2929 my ($self, $field, $op, $arg) = @_;
2930 $arg = [$arg] if not ref $arg;
2931 my $label = $self->_quote($field);
2932 my ($placeholder) = $self->_convert('?');
2933 my $placeholders = join ", ", (($placeholder) x @$arg);
2934 my $sql = $self->_sqlcase('match') . " ($label) "
2935 . $self->_sqlcase('against') . " ($placeholders) ";
2936 my @bind = $self->_bindtype($field, @$arg);
2937 return ($sql, @bind);
2944 =head1 UNARY OPERATORS
2946 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2950 my ($self, $op, $arg) = @_;
2956 handler => 'method_name',
2960 A "unary operator" is a SQL syntactic clause that can be
2961 applied to a field - the operator goes before the field
2963 You can write your own operator handlers - supply a C<unary_ops>
2964 argument to the C<new> method. That argument takes an arrayref of
2965 operator definitions; each operator definition is a hashref with two
2972 the regular expression to match the operator
2976 Either a coderef or a plain scalar method name. In both cases
2977 the expected return is C<< $sql >>.
2979 When supplied with a method name, it is simply called on the
2980 L<SQL::Abstract> object as:
2982 $self->$method_name($op, $arg)
2986 $op is the part that matched the handler regex
2987 $arg is the RHS or argument of the operator
2989 When supplied with a coderef, it is called as:
2991 $coderef->($self, $op, $arg)
2999 Thanks to some benchmarking by Mark Stosberg, it turns out that
3000 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3001 I must admit this wasn't an intentional design issue, but it's a
3002 byproduct of the fact that you get to control your C<DBI> handles
3005 To maximize performance, use a code snippet like the following:
3007 # prepare a statement handle using the first row
3008 # and then reuse it for the rest of the rows
3010 for my $href (@array_of_hashrefs) {
3011 $stmt ||= $sql->insert('table', $href);
3012 $sth ||= $dbh->prepare($stmt);
3013 $sth->execute($sql->values($href));
3016 The reason this works is because the keys in your C<$href> are sorted
3017 internally by B<SQL::Abstract>. Thus, as long as your data retains
3018 the same structure, you only have to generate the SQL the first time
3019 around. On subsequent queries, simply use the C<values> function provided
3020 by this module to return your values in the correct order.
3022 However this depends on the values having the same type - if, for
3023 example, the values of a where clause may either have values
3024 (resulting in sql of the form C<column = ?> with a single bind
3025 value), or alternatively the values might be C<undef> (resulting in
3026 sql of the form C<column IS NULL> with no bind value) then the
3027 caching technique suggested will not work.
3031 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3032 really like this part (I do, at least). Building up a complex query
3033 can be as simple as the following:
3040 use CGI::FormBuilder;
3043 my $form = CGI::FormBuilder->new(...);
3044 my $sql = SQL::Abstract->new;
3046 if ($form->submitted) {
3047 my $field = $form->field;
3048 my $id = delete $field->{id};
3049 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3052 Of course, you would still have to connect using C<DBI> to run the
3053 query, but the point is that if you make your form look like your
3054 table, the actual query script can be extremely simplistic.
3056 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3057 a fast interface to returning and formatting data. I frequently
3058 use these three modules together to write complex database query
3059 apps in under 50 lines.
3061 =head1 HOW TO CONTRIBUTE
3063 Contributions are always welcome, in all usable forms (we especially
3064 welcome documentation improvements). The delivery methods include git-
3065 or unified-diff formatted patches, GitHub pull requests, or plain bug
3066 reports either via RT or the Mailing list. Contributors are generally
3067 granted full access to the official repository after their first several
3068 patches pass successful review.
3070 This project is maintained in a git repository. The code and related tools are
3071 accessible at the following locations:
3075 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3077 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3079 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3081 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3087 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3088 Great care has been taken to preserve the I<published> behavior
3089 documented in previous versions in the 1.* family; however,
3090 some features that were previously undocumented, or behaved
3091 differently from the documentation, had to be changed in order
3092 to clarify the semantics. Hence, client code that was relying
3093 on some dark areas of C<SQL::Abstract> v1.*
3094 B<might behave differently> in v1.50.
3096 The main changes are:
3102 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3106 support for the { operator => \"..." } construct (to embed literal SQL)
3110 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3114 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3118 defensive programming: check arguments
3122 fixed bug with global logic, which was previously implemented
3123 through global variables yielding side-effects. Prior versions would
3124 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3125 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3126 Now this is interpreted
3127 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3132 fixed semantics of _bindtype on array args
3136 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3137 we just avoid shifting arrays within that tree.
3141 dropped the C<_modlogic> function
3145 =head1 ACKNOWLEDGEMENTS
3147 There are a number of individuals that have really helped out with
3148 this module. Unfortunately, most of them submitted bugs via CPAN
3149 so I have no idea who they are! But the people I do know are:
3151 Ash Berlin (order_by hash term support)
3152 Matt Trout (DBIx::Class support)
3153 Mark Stosberg (benchmarking)
3154 Chas Owens (initial "IN" operator support)
3155 Philip Collins (per-field SQL functions)
3156 Eric Kolve (hashref "AND" support)
3157 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3158 Dan Kubb (support for "quote_char" and "name_sep")
3159 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3160 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3161 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3162 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3163 Oliver Charles (support for "RETURNING" after "INSERT")
3169 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3173 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3175 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3177 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3178 While not an official support venue, C<DBIx::Class> makes heavy use of
3179 C<SQL::Abstract>, and as such list members there are very familiar with
3180 how to create queries.
3184 This module is free software; you may copy this under the same
3185 terms as perl itself (either the GNU General Public License or
3186 the Artistic License)