1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.86';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
44 #======================================================================
45 # DEBUGGING AND ERROR REPORTING
46 #======================================================================
49 return unless $_[0]->{debug}; shift; # a little faster
50 my $func = (caller(1))[3];
51 warn "[$func] ", @_, "\n";
55 my($func) = (caller(1))[3];
56 Carp::carp "[$func] Warning: ", @_;
60 my($func) = (caller(1))[3];
61 Carp::croak "[$func] Fatal: ", @_;
64 sub is_literal_value ($) {
65 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
66 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
70 sub is_undef_value ($) {
74 and exists $_[0]->{-value}
75 and not defined $_[0]->{-value}
79 # FIXME XSify - this can be done so much more efficiently
80 sub is_plain_value ($) {
82 ! length ref $_[0] ? \($_[0])
84 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
86 exists $_[0]->{-value}
87 ) ? \($_[0]->{-value})
89 # reuse @_ for even moar speedz
90 defined ( $_[1] = Scalar::Util::blessed $_[0] )
92 # deliberately not using Devel::OverloadInfo - the checks we are
93 # intersted in are much more limited than the fullblown thing, and
94 # this is a very hot piece of code
96 # simply using ->can('(""') can leave behind stub methods that
97 # break actually using the overload later (see L<perldiag/Stub
98 # found while resolving method "%s" overloading "%s" in package
99 # "%s"> and the source of overload::mycan())
101 # either has stringification which DBI SHOULD prefer out of the box
102 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
104 # has nummification or boolification, AND fallback is *not* disabled
106 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
109 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
111 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
115 # no fallback specified at all
116 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
118 # fallback explicitly undef
119 ! defined ${"$_[3]::()"}
132 #======================================================================
134 #======================================================================
138 my $class = ref($self) || $self;
139 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
141 # choose our case by keeping an option around
142 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
144 # default logic for interpreting arrayrefs
145 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
147 # how to return bind vars
148 $opt{bindtype} ||= 'normal';
150 # default comparison is "=", but can be overridden
153 # try to recognize which are the 'equality' and 'inequality' ops
154 # (temporary quickfix (in 2007), should go through a more seasoned API)
155 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
156 $opt{inequality_op} = qr/^( != | <> )$/ix;
158 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
159 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
162 $opt{sqltrue} ||= '1=1';
163 $opt{sqlfalse} ||= '0=1';
166 $opt{special_ops} ||= [];
168 # regexes are applied in order, thus push after user-defines
169 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
171 if ($class->isa('DBIx::Class::SQLMaker')) {
172 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
173 regex => qr/^(?:ident|value|(?:not\s)?in)$/i, handler => sub { die "NOPE" }
175 $opt{is_dbic_sqlmaker} = 1;
179 $opt{unary_ops} ||= [];
181 # rudimentary sanity-check for user supplied bits treated as functions/operators
182 # If a purported function matches this regular expression, an exception is thrown.
183 # Literal SQL is *NOT* subject to this check, only functions (and column names
184 # when quoting is not in effect)
187 # need to guard against ()'s in column names too, but this will break tons of
188 # hacks... ideas anyone?
189 $opt{injection_guard} ||= qr/
195 $opt{expand_unary} = {};
198 -not => '_expand_not',
199 -bool => '_expand_bool',
200 -and => '_expand_op_andor',
201 -or => '_expand_op_andor',
202 -nest => '_expand_nest',
203 -bind => sub { shift; +{ @_ } },
207 'between' => '_expand_between',
208 'not between' => '_expand_between',
209 'in' => '_expand_in',
210 'not in' => '_expand_in',
211 'nest' => '_expand_nest',
212 (map +($_ => '_expand_op_andor'), ('and', 'or')),
213 (map +($_ => '_expand_op_is'), ('is', 'is not')),
216 # placeholder for _expand_unop system
218 my %unops = (-ident => '_expand_ident', -value => '_expand_value');
219 foreach my $name (keys %unops) {
220 $opt{expand}{$name} = $unops{$name};
221 my ($op) = $name =~ /^-(.*)$/;
222 $opt{expand_op}{$op} = sub {
223 my ($self, $op, $arg, $k) = @_;
224 return $self->_expand_expr_hashpair_cmp(
225 $k, { "-${op}" => $arg }
232 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
237 (map +($_ => '_render_op_between'), 'between', 'not between'),
238 (map +($_ => '_render_op_in'), 'in', 'not in'),
239 (map +($_ => '_render_unop_postfix'),
240 'is null', 'is not null', 'asc', 'desc',
242 (not => '_render_op_not'),
243 (map +($_ => '_render_op_andor'), qw(and or)),
246 return bless \%opt, $class;
249 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
250 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
252 sub _assert_pass_injection_guard {
253 if ($_[1] =~ $_[0]->{injection_guard}) {
254 my $class = ref $_[0];
255 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
256 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
257 . "{injection_guard} attribute to ${class}->new()"
262 #======================================================================
264 #======================================================================
268 my $table = $self->_table(shift);
269 my $data = shift || return;
272 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
273 my ($sql, @bind) = $self->$method($data);
274 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
276 if ($options->{returning}) {
277 my ($s, @b) = $self->_insert_returning($options);
282 return wantarray ? ($sql, @bind) : $sql;
285 # So that subclasses can override INSERT ... RETURNING separately from
286 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
287 sub _insert_returning { shift->_returning(@_) }
290 my ($self, $options) = @_;
292 my $f = $options->{returning};
294 my ($sql, @bind) = $self->render_aqt(
295 $self->_expand_maybe_list_expr($f, undef, -ident)
298 ? $self->_sqlcase(' returning ') . $sql
299 : ($self->_sqlcase(' returning ').$sql, @bind);
302 sub _insert_HASHREF { # explicit list of fields and then values
303 my ($self, $data) = @_;
305 my @fields = sort keys %$data;
307 my ($sql, @bind) = $self->_insert_values($data);
310 $_ = $self->_quote($_) foreach @fields;
311 $sql = "( ".join(", ", @fields).") ".$sql;
313 return ($sql, @bind);
316 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
317 my ($self, $data) = @_;
319 # no names (arrayref) so can't generate bindtype
320 $self->{bindtype} ne 'columns'
321 or belch "can't do 'columns' bindtype when called with arrayref";
323 my (@values, @all_bind);
324 foreach my $value (@$data) {
325 my ($values, @bind) = $self->_insert_value(undef, $value);
326 push @values, $values;
327 push @all_bind, @bind;
329 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
330 return ($sql, @all_bind);
333 sub _insert_ARRAYREFREF { # literal SQL with bind
334 my ($self, $data) = @_;
336 my ($sql, @bind) = @${$data};
337 $self->_assert_bindval_matches_bindtype(@bind);
339 return ($sql, @bind);
343 sub _insert_SCALARREF { # literal SQL without bind
344 my ($self, $data) = @_;
350 my ($self, $data) = @_;
352 my (@values, @all_bind);
353 foreach my $column (sort keys %$data) {
354 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
355 push @values, $values;
356 push @all_bind, @bind;
358 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
359 return ($sql, @all_bind);
363 my ($self, $column, $v) = @_;
365 return $self->render_aqt(
366 $self->_expand_insert_value($column, $v)
370 sub _expand_insert_value {
371 my ($self, $column, $v) = @_;
373 if (ref($v) eq 'ARRAY') {
374 if ($self->{array_datatypes}) {
375 return +{ -bind => [ $column, $v ] };
377 my ($sql, @bind) = @$v;
378 $self->_assert_bindval_matches_bindtype(@bind);
379 return +{ -literal => $v };
381 if (ref($v) eq 'HASH') {
382 if (grep !/^-/, keys %$v) {
383 belch "HASH ref as bind value in insert is not supported";
384 return +{ -bind => [ $column, $v ] };
388 return +{ -bind => [ $column, undef ] };
390 local our $Cur_Col_Meta = $column;
391 return $self->expand_expr($v);
396 #======================================================================
398 #======================================================================
403 my $table = $self->_table(shift);
404 my $data = shift || return;
408 # first build the 'SET' part of the sql statement
409 puke "Unsupported data type specified to \$sql->update"
410 unless ref $data eq 'HASH';
412 my ($sql, @all_bind) = $self->_update_set_values($data);
413 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
417 my($where_sql, @where_bind) = $self->where($where);
419 push @all_bind, @where_bind;
422 if ($options->{returning}) {
423 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
424 $sql .= $returning_sql;
425 push @all_bind, @returning_bind;
428 return wantarray ? ($sql, @all_bind) : $sql;
431 sub _update_set_values {
432 my ($self, $data) = @_;
434 return $self->render_aqt(
435 $self->_expand_update_set_values($data),
439 sub _expand_update_set_values {
440 my ($self, $data) = @_;
441 $self->_expand_maybe_list_expr( [
444 $set = { -bind => $_ } unless defined $set;
445 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
451 ? ($self->{array_datatypes}
452 ? [ $k, +{ -bind => [ $k, $v ] } ]
453 : [ $k, +{ -literal => $v } ])
455 local our $Cur_Col_Meta = $k;
456 [ $k, $self->_expand_expr($v) ]
463 # So that subclasses can override UPDATE ... RETURNING separately from
465 sub _update_returning { shift->_returning(@_) }
469 #======================================================================
471 #======================================================================
476 my $table = $self->_table(shift);
477 my $fields = shift || '*';
481 my ($fields_sql, @bind) = $self->_select_fields($fields);
483 my ($where_sql, @where_bind) = $self->where($where, $order);
484 push @bind, @where_bind;
486 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
487 $self->_sqlcase('from'), $table)
490 return wantarray ? ($sql, @bind) : $sql;
494 my ($self, $fields) = @_;
495 return $fields unless ref($fields);
496 return $self->render_aqt(
497 $self->_expand_maybe_list_expr($fields, undef, '-ident')
501 #======================================================================
503 #======================================================================
508 my $table = $self->_table(shift);
512 my($where_sql, @bind) = $self->where($where);
513 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
515 if ($options->{returning}) {
516 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
517 $sql .= $returning_sql;
518 push @bind, @returning_bind;
521 return wantarray ? ($sql, @bind) : $sql;
524 # So that subclasses can override DELETE ... RETURNING separately from
526 sub _delete_returning { shift->_returning(@_) }
530 #======================================================================
532 #======================================================================
536 # Finally, a separate routine just to handle WHERE clauses
538 my ($self, $where, $order) = @_;
540 local $self->{convert_where} = $self->{convert};
543 my ($sql, @bind) = defined($where)
544 ? $self->_recurse_where($where)
546 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
550 my ($order_sql, @order_bind) = $self->_order_by($order);
552 push @bind, @order_bind;
555 return wantarray ? ($sql, @bind) : $sql;
558 { our $Default_Scalar_To = -value }
561 my ($self, $expr, $default_scalar_to) = @_;
562 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
563 $self->_expand_expr($expr);
567 my ($self, $aqt) = @_;
568 my ($k, $v, @rest) = %$aqt;
570 if (my $meth = $self->{render}{$k}) {
571 return $self->$meth($v);
573 die "notreached: $k";
577 my ($self, $expr) = @_;
578 $self->render_aqt($self->expand_expr($expr));
582 my ($self, $expr) = @_;
583 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
584 return undef unless defined($expr);
585 if (ref($expr) eq 'HASH') {
586 return undef unless my $kc = keys %$expr;
588 return $self->_expand_op_andor(-and => $expr);
590 my ($key, $value) = %$expr;
591 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
592 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
593 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
595 if (my $exp = $self->{expand}{$key}) {
596 return $self->$exp($key, $value);
598 return $self->_expand_expr_hashpair($key, $value);
600 if (ref($expr) eq 'ARRAY') {
601 my $logic = '-'.lc($self->{logic});
602 return $self->_expand_op_andor($logic, $expr);
604 if (my $literal = is_literal_value($expr)) {
605 return +{ -literal => $literal };
607 if (!ref($expr) or Scalar::Util::blessed($expr)) {
608 return $self->_expand_expr_scalar($expr);
613 sub _expand_expr_hashpair {
614 my ($self, $k, $v) = @_;
615 unless (defined($k) and length($k)) {
616 if (defined($k) and my $literal = is_literal_value($v)) {
617 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
618 return { -literal => $literal };
620 puke "Supplying an empty left hand side argument is not supported";
623 return $self->_expand_expr_hashpair_op($k, $v);
625 return $self->_expand_expr_hashpair_ident($k, $v);
628 sub _expand_expr_hashpair_ident {
629 my ($self, $k, $v) = @_;
631 local our $Cur_Col_Meta = $k;
633 # hash with multiple or no elements is andor
635 if (ref($v) eq 'HASH' and keys %$v != 1) {
636 return $self->_expand_op_andor(-and => $v, $k);
639 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
641 if (is_undef_value($v)) {
642 return $self->_expand_expr_hashpair_cmp($k => undef);
645 # scalars and objects get expanded as whatever requested or values
647 if (!ref($v) or Scalar::Util::blessed($v)) {
648 return $self->_expand_expr_hashpair_scalar($k, $v);
651 # single key hashref is a hashtriple
653 if (ref($v) eq 'HASH') {
654 return $self->_expand_expr_hashtriple($k, %$v);
657 # arrayref needs re-engineering over the elements
659 if (ref($v) eq 'ARRAY') {
660 return $self->sqlfalse unless @$v;
661 $self->_debug("ARRAY($k) means distribute over elements");
663 $v->[0] =~ /^-(and|or)$/i
664 ? shift(@{$v = [ @$v ]})
665 : '-'.lc($self->{logic} || 'OR')
667 return $self->_expand_op_andor(
672 if (my $literal = is_literal_value($v)) {
674 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
677 my ($sql, @bind) = @$literal;
678 if ($self->{bindtype} eq 'columns') {
680 $self->_assert_bindval_matches_bindtype($_);
683 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
688 sub _expand_expr_scalar {
689 my ($self, $expr) = @_;
691 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
694 sub _expand_expr_hashpair_scalar {
695 my ($self, $k, $v) = @_;
697 return $self->_expand_expr_hashpair_cmp(
698 $k, $self->_expand_expr_scalar($v),
702 sub _expand_expr_hashpair_op {
703 my ($self, $k, $v) = @_;
705 (my $op = $k) =~ s/^-(?=\w)//;
706 $self->_assert_pass_injection_guard($op);
708 # Ops prefixed with -not_ get converted
710 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
713 $self->_expand_expr({ "-${rest}", $v })
720 # the old special op system requires illegality for top-level use
723 (our $Expand_Depth) == 1
724 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
726 puke "Illegal use of top-level '-$op'"
729 # the old unary op system means we should touch nothing and let it work
731 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
732 return { -op => [ $op, $v ] };
736 # an explicit node type is currently assumed to be expanded (this is almost
737 # certainly wrong and there should be expansion anyway)
739 if ($self->{render}{$k}) {
743 # hashref RHS values get expanded and used as op/func args
748 and (keys %$v)[0] =~ /^-/
750 my ($func) = $k =~ /^-(.*)$/;
752 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
753 return +{ -op => [ $func, $self->_expand_expr($v) ] };
756 return +{ -func => [ $func, $self->_expand_expr($v) ] };
759 # scalars and literals get simply expanded
761 if (!ref($v) or is_literal_value($v)) {
762 return +{ -op => [ $op, $self->_expand_expr($v) ] };
768 sub _expand_expr_hashpair_cmp {
769 my ($self, $k, $v) = @_;
770 $self->_expand_expr_hashtriple($k, $self->{cmp}, $v);
773 sub _expand_expr_hashtriple {
774 my ($self, $k, $vk, $vv) = @_;
776 my $ik = $self->_expand_ident(-ident => $k);
778 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
779 $self->_assert_pass_injection_guard($op);
780 if ($op =~ s/ [_\s]? \d+ $//x ) {
781 return $self->_expand_expr($k, { $vk, $vv });
783 if (my $x = $self->{expand_op}{$op}) {
784 local our $Cur_Col_Meta = $k;
785 return $self->$x($op, $vv, $k);
788 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
789 return { -op => [ $op, $ik, $vv ] };
791 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
795 { -op => [ $op, $vv ] }
799 if (ref($vv) eq 'ARRAY') {
801 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
802 ? shift @raw : '-or';
803 my @values = map +{ $vk => $_ }, @raw;
805 $op =~ $self->{inequality_op}
806 or $op =~ $self->{not_like_op}
808 if (lc($logic) eq '-or' and @values > 1) {
809 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
810 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
811 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
816 # try to DWIM on equality operators
817 return ($self->_dwim_op_to_is($op,
818 "Supplying an empty arrayref to '%s' is deprecated",
819 "operator '%s' applied on an empty array (field '$k')"
820 ) ? $self->sqlfalse : $self->sqltrue);
822 return $self->_expand_op_andor($logic => \@values, $k);
824 if (is_undef_value($vv)) {
825 my $is = ($self->_dwim_op_to_is($op,
826 "Supplying an undefined argument to '%s' is deprecated",
827 "unexpected operator '%s' with undef operand",
828 ) ? 'is' : 'is not');
830 return $self->_expand_expr_hashpair($k => { $is, undef });
832 local our $Cur_Col_Meta = $k;
836 $self->_expand_expr($vv)
841 my ($self, $op, $empty, $fail) = @_;
842 if ($op =~ /^not$/i) {
845 if ($op =~ $self->{equality_op}) {
848 if ($op =~ $self->{like_op}) {
849 belch(sprintf $empty, uc($op));
852 if ($op =~ $self->{inequality_op}) {
855 if ($op =~ $self->{not_like_op}) {
856 belch(sprintf $empty, uc($op));
859 puke(sprintf $fail, $op);
863 my ($self, $op, $body) = @_;
864 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
865 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
867 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
868 ref($body) ? @$body : $body;
869 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
870 unless ($self->{quote_char}) {
871 $self->_assert_pass_injection_guard($_) for @parts;
873 return +{ -ident => \@parts };
877 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
881 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
885 my ($self, undef, $v) = @_;
887 return $self->_expand_expr($v);
889 puke "-bool => undef not supported" unless defined($v);
890 return $self->_expand_ident(-ident => $v);
893 sub _expand_op_andor {
894 my ($self, $logic, $v, $k) = @_;
896 $v = [ map +{ $k, $_ },
898 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
902 my ($logop) = $logic =~ /^-?(.*)$/;
903 if (ref($v) eq 'HASH') {
904 return undef unless keys %$v;
907 map $self->_expand_expr({ $_ => $v->{$_} }),
911 if (ref($v) eq 'ARRAY') {
912 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
915 (ref($_) eq 'ARRAY' and @$_)
916 or (ref($_) eq 'HASH' and %$_)
922 while (my ($el) = splice @expr, 0, 1) {
923 puke "Supplying an empty left hand side argument is not supported in array-pairs"
924 unless defined($el) and length($el);
925 my $elref = ref($el);
927 local our $Expand_Depth = 0;
928 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
929 } elsif ($elref eq 'ARRAY') {
930 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
931 } elsif (my $l = is_literal_value($el)) {
932 push @res, { -literal => $l };
933 } elsif ($elref eq 'HASH') {
934 local our $Expand_Depth = 0;
935 push @res, grep defined, $self->_expand_expr($el) if %$el;
941 # return $res[0] if @res == 1;
942 return { -op => [ $logop, @res ] };
948 my ($self, $op, $vv, $k) = @_;
949 puke "$op can only take undef as argument"
953 and exists($vv->{-value})
954 and !defined($vv->{-value})
956 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
959 sub _expand_between {
960 my ($self, $op, $vv, $k) = @_;
961 local our $Cur_Col_Meta = $k;
962 my @rhs = map $self->_expand_expr($_),
963 ref($vv) eq 'ARRAY' ? @$vv : $vv;
965 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
967 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
969 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
973 $self->_expand_ident(-ident => $k),
979 my ($self, $op, $vv, $k) = @_;
980 if (my $literal = is_literal_value($vv)) {
981 my ($sql, @bind) = @$literal;
982 my $opened_sql = $self->_open_outer_paren($sql);
984 $op, $self->_expand_ident(-ident => $k),
985 [ { -literal => [ $opened_sql, @bind ] } ]
989 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
990 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
991 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
992 . 'will emit the logically correct SQL instead of raising this exception)'
994 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
996 my @rhs = map $self->_expand_expr($_),
997 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
998 map { defined($_) ? $_: puke($undef_err) }
999 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1000 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1004 $self->_expand_ident(-ident => $k),
1010 my ($self, $op, $v) = @_;
1011 # DBIx::Class requires a nest warning to be emitted once but the private
1012 # method it overrode to do so no longer exists
1013 if ($self->{is_dbic_sqlmaker}) {
1014 unless (our $Nest_Warned) {
1016 "-nest in search conditions is deprecated, you most probably wanted:\n"
1017 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1022 return $self->_expand_expr($v);
1025 sub _recurse_where {
1026 my ($self, $where, $logic) = @_;
1028 # Special case: top level simple string treated as literal
1030 my $where_exp = (ref($where)
1031 ? $self->_expand_expr($where, $logic)
1032 : { -literal => [ $where ] });
1034 # dispatch expanded expression
1036 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1037 # DBIx::Class used to call _recurse_where in scalar context
1038 # something else might too...
1040 return ($sql, @bind);
1043 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1049 my ($self, $ident) = @_;
1051 return $self->_convert($self->_quote($ident));
1055 my ($self, $list) = @_;
1056 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1057 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1061 my ($self, $rest) = @_;
1062 my ($func, @args) = @$rest;
1066 push @arg_sql, shift @x;
1068 } map [ $self->render_aqt($_) ], @args;
1069 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1073 my ($self, $bind) = @_;
1074 return ($self->_convert('?'), $self->_bindtype(@$bind));
1077 sub _render_literal {
1078 my ($self, $literal) = @_;
1079 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1084 my ($self, $v) = @_;
1085 my ($op, @args) = @$v;
1086 if (my $r = $self->{render_op}{$op}) {
1087 return $self->$r($op, \@args);
1092 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1093 if ($us and @args > 1) {
1094 puke "Special op '${op}' requires first value to be identifier"
1095 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1096 my $k = join(($self->{name_sep}||'.'), @$ident);
1097 local our $Expand_Depth = 1;
1098 return $self->${\($us->{handler})}($k, $op, $args[1]);
1100 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1101 return $self->${\($us->{handler})}($op, $args[0]);
1106 return $self->_render_unop_prefix($op, \@args);
1108 return $self->_render_op_multop($op, \@args);
1114 sub _render_op_between {
1115 my ($self, $op, $args) = @_;
1116 my ($left, $low, $high) = @$args;
1117 my ($rhsql, @rhbind) = do {
1119 puke "Single arg to between must be a literal"
1120 unless $low->{-literal};
1123 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1124 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1125 @{$l}[1..$#$l], @{$h}[1..$#$h])
1128 my ($lhsql, @lhbind) = $self->render_aqt($left);
1130 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1136 my ($self, $op, $args) = @_;
1137 my ($lhs, $rhs) = @$args;
1140 my ($sql, @bind) = $self->render_aqt($_);
1141 push @in_bind, @bind;
1144 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1146 $lhsql.' '.$self->_sqlcase($op).' ( '
1147 .join(', ', @in_sql)
1153 sub _render_op_andor {
1154 my ($self, $op, $args) = @_;
1155 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1156 return '' unless @parts;
1157 return @{$parts[0]} if @parts == 1;
1158 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1159 return '( '.$sql.' )', @bind;
1162 sub _render_op_multop {
1163 my ($self, $op, $args) = @_;
1164 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1165 return '' unless @parts;
1166 return @{$parts[0]} if @parts == 1;
1167 my ($final_sql) = join(
1168 ' '.$self->_sqlcase($op).' ',
1173 map @{$_}[1..$#$_], @parts
1176 sub _render_op_not {
1177 my ($self, $op, $v) = @_;
1178 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1179 return "(${sql})", @bind;
1182 sub _render_unop_prefix {
1183 my ($self, $op, $v) = @_;
1184 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1185 my $op_sql = $self->_sqlcase($op);
1186 return ("${op_sql} ${expr_sql}", @bind);
1189 sub _render_unop_postfix {
1190 my ($self, $op, $v) = @_;
1191 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1192 my $op_sql = $self->_sqlcase($op);
1193 return ($expr_sql.' '.$op_sql, @bind);
1196 # Some databases (SQLite) treat col IN (1, 2) different from
1197 # col IN ( (1, 2) ). Use this to strip all outer parens while
1198 # adding them back in the corresponding method
1199 sub _open_outer_paren {
1200 my ($self, $sql) = @_;
1202 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1204 # there are closing parens inside, need the heavy duty machinery
1205 # to reevaluate the extraction starting from $sql (full reevaluation)
1206 if ($inner =~ /\)/) {
1207 require Text::Balanced;
1209 my (undef, $remainder) = do {
1210 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1212 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1215 # the entire expression needs to be a balanced bracketed thing
1216 # (after an extract no remainder sans trailing space)
1217 last if defined $remainder and $remainder =~ /\S/;
1227 #======================================================================
1229 #======================================================================
1231 sub _expand_order_by {
1232 my ($self, $arg) = @_;
1234 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1236 my $expander = sub {
1237 my ($self, $dir, $expr) = @_;
1238 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1239 foreach my $arg (@to_expand) {
1243 and grep /^-(asc|desc)$/, keys %$arg
1245 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1249 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1251 map $self->expand_expr($_, -ident),
1252 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1253 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1256 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1258 return $self->$expander(undef, $arg);
1262 my ($self, $arg) = @_;
1264 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1266 my ($sql, @bind) = $self->render_aqt($expanded);
1268 return '' unless length($sql);
1270 my $final_sql = $self->_sqlcase(' order by ').$sql;
1272 return wantarray ? ($final_sql, @bind) : $final_sql;
1275 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1277 sub _order_by_chunks {
1278 my ($self, $arg) = @_;
1280 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1282 return $self->_chunkify_order_by($expanded);
1285 sub _chunkify_order_by {
1286 my ($self, $expanded) = @_;
1288 return grep length, $self->render_aqt($expanded)
1289 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1292 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1293 return map $self->_chunkify_order_by($_), @$l;
1295 return [ $self->render_aqt($_) ];
1299 #======================================================================
1300 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1301 #======================================================================
1307 $self->_expand_maybe_list_expr($from, undef, -ident)
1312 #======================================================================
1314 #======================================================================
1316 sub _expand_maybe_list_expr {
1317 my ($self, $expr, $logic, $default) = @_;
1319 if (ref($expr) eq 'ARRAY') {
1321 map $self->expand_expr($_, $default), @$expr
1328 return $self->expand_expr($e, $default);
1331 # highly optimized, as it's called way too often
1333 # my ($self, $label) = @_;
1335 return '' unless defined $_[1];
1336 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1337 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1339 unless ($_[0]->{quote_char}) {
1340 if (ref($_[1]) eq 'ARRAY') {
1341 return join($_[0]->{name_sep}||'.', @{$_[1]});
1343 $_[0]->_assert_pass_injection_guard($_[1]);
1348 my $qref = ref $_[0]->{quote_char};
1350 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1351 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1352 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1354 my $esc = $_[0]->{escape_char} || $r;
1356 # parts containing * are naturally unquoted
1358 $_[0]->{name_sep}||'',
1362 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1364 (ref($_[1]) eq 'ARRAY'
1368 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1376 # Conversion, if applicable
1378 #my ($self, $arg) = @_;
1379 if ($_[0]->{convert_where}) {
1380 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1387 #my ($self, $col, @vals) = @_;
1388 # called often - tighten code
1389 return $_[0]->{bindtype} eq 'columns'
1390 ? map {[$_[1], $_]} @_[2 .. $#_]
1395 # Dies if any element of @bind is not in [colname => value] format
1396 # if bindtype is 'columns'.
1397 sub _assert_bindval_matches_bindtype {
1398 # my ($self, @bind) = @_;
1400 if ($self->{bindtype} eq 'columns') {
1402 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1403 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1409 sub _join_sql_clauses {
1410 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1412 if (@$clauses_aref > 1) {
1413 my $join = " " . $self->_sqlcase($logic) . " ";
1414 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1415 return ($sql, @$bind_aref);
1417 elsif (@$clauses_aref) {
1418 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1421 return (); # if no SQL, ignore @$bind_aref
1426 # Fix SQL case, if so requested
1428 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1429 # don't touch the argument ... crooked logic, but let's not change it!
1430 return $_[0]->{case} ? $_[1] : uc($_[1]);
1434 #======================================================================
1435 # DISPATCHING FROM REFKIND
1436 #======================================================================
1439 my ($self, $data) = @_;
1441 return 'UNDEF' unless defined $data;
1443 # blessed objects are treated like scalars
1444 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1446 return 'SCALAR' unless $ref;
1449 while ($ref eq 'REF') {
1451 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1455 return ($ref||'SCALAR') . ('REF' x $n_steps);
1459 my ($self, $data) = @_;
1460 my @try = ($self->_refkind($data));
1461 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1462 push @try, 'FALLBACK';
1466 sub _METHOD_FOR_refkind {
1467 my ($self, $meth_prefix, $data) = @_;
1470 for (@{$self->_try_refkind($data)}) {
1471 $method = $self->can($meth_prefix."_".$_)
1475 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1479 sub _SWITCH_refkind {
1480 my ($self, $data, $dispatch_table) = @_;
1483 for (@{$self->_try_refkind($data)}) {
1484 $coderef = $dispatch_table->{$_}
1488 puke "no dispatch entry for ".$self->_refkind($data)
1497 #======================================================================
1498 # VALUES, GENERATE, AUTOLOAD
1499 #======================================================================
1501 # LDNOTE: original code from nwiger, didn't touch code in that section
1502 # I feel the AUTOLOAD stuff should not be the default, it should
1503 # only be activated on explicit demand by user.
1507 my $data = shift || return;
1508 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1509 unless ref $data eq 'HASH';
1512 foreach my $k (sort keys %$data) {
1513 my $v = $data->{$k};
1514 $self->_SWITCH_refkind($v, {
1516 if ($self->{array_datatypes}) { # array datatype
1517 push @all_bind, $self->_bindtype($k, $v);
1519 else { # literal SQL with bind
1520 my ($sql, @bind) = @$v;
1521 $self->_assert_bindval_matches_bindtype(@bind);
1522 push @all_bind, @bind;
1525 ARRAYREFREF => sub { # literal SQL with bind
1526 my ($sql, @bind) = @${$v};
1527 $self->_assert_bindval_matches_bindtype(@bind);
1528 push @all_bind, @bind;
1530 SCALARREF => sub { # literal SQL without bind
1532 SCALAR_or_UNDEF => sub {
1533 push @all_bind, $self->_bindtype($k, $v);
1544 my(@sql, @sqlq, @sqlv);
1548 if ($ref eq 'HASH') {
1549 for my $k (sort keys %$_) {
1552 my $label = $self->_quote($k);
1553 if ($r eq 'ARRAY') {
1554 # literal SQL with bind
1555 my ($sql, @bind) = @$v;
1556 $self->_assert_bindval_matches_bindtype(@bind);
1557 push @sqlq, "$label = $sql";
1559 } elsif ($r eq 'SCALAR') {
1560 # literal SQL without bind
1561 push @sqlq, "$label = $$v";
1563 push @sqlq, "$label = ?";
1564 push @sqlv, $self->_bindtype($k, $v);
1567 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1568 } elsif ($ref eq 'ARRAY') {
1569 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1572 if ($r eq 'ARRAY') { # literal SQL with bind
1573 my ($sql, @bind) = @$v;
1574 $self->_assert_bindval_matches_bindtype(@bind);
1577 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1578 # embedded literal SQL
1585 push @sql, '(' . join(', ', @sqlq) . ')';
1586 } elsif ($ref eq 'SCALAR') {
1590 # strings get case twiddled
1591 push @sql, $self->_sqlcase($_);
1595 my $sql = join ' ', @sql;
1597 # this is pretty tricky
1598 # if ask for an array, return ($stmt, @bind)
1599 # otherwise, s/?/shift @sqlv/ to put it inline
1601 return ($sql, @sqlv);
1603 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1604 ref $d ? $d->[1] : $d/e;
1613 # This allows us to check for a local, then _form, attr
1615 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1616 return $self->generate($name, @_);
1627 SQL::Abstract - Generate SQL from Perl data structures
1633 my $sql = SQL::Abstract->new;
1635 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1637 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1639 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1641 my($stmt, @bind) = $sql->delete($table, \%where);
1643 # Then, use these in your DBI statements
1644 my $sth = $dbh->prepare($stmt);
1645 $sth->execute(@bind);
1647 # Just generate the WHERE clause
1648 my($stmt, @bind) = $sql->where(\%where, $order);
1650 # Return values in the same order, for hashed queries
1651 # See PERFORMANCE section for more details
1652 my @bind = $sql->values(\%fieldvals);
1656 This module was inspired by the excellent L<DBIx::Abstract>.
1657 However, in using that module I found that what I really wanted
1658 to do was generate SQL, but still retain complete control over my
1659 statement handles and use the DBI interface. So, I set out to
1660 create an abstract SQL generation module.
1662 While based on the concepts used by L<DBIx::Abstract>, there are
1663 several important differences, especially when it comes to WHERE
1664 clauses. I have modified the concepts used to make the SQL easier
1665 to generate from Perl data structures and, IMO, more intuitive.
1666 The underlying idea is for this module to do what you mean, based
1667 on the data structures you provide it. The big advantage is that
1668 you don't have to modify your code every time your data changes,
1669 as this module figures it out.
1671 To begin with, an SQL INSERT is as easy as just specifying a hash
1672 of C<key=value> pairs:
1675 name => 'Jimbo Bobson',
1676 phone => '123-456-7890',
1677 address => '42 Sister Lane',
1678 city => 'St. Louis',
1679 state => 'Louisiana',
1682 The SQL can then be generated with this:
1684 my($stmt, @bind) = $sql->insert('people', \%data);
1686 Which would give you something like this:
1688 $stmt = "INSERT INTO people
1689 (address, city, name, phone, state)
1690 VALUES (?, ?, ?, ?, ?)";
1691 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1692 '123-456-7890', 'Louisiana');
1694 These are then used directly in your DBI code:
1696 my $sth = $dbh->prepare($stmt);
1697 $sth->execute(@bind);
1699 =head2 Inserting and Updating Arrays
1701 If your database has array types (like for example Postgres),
1702 activate the special option C<< array_datatypes => 1 >>
1703 when creating the C<SQL::Abstract> object.
1704 Then you may use an arrayref to insert and update database array types:
1706 my $sql = SQL::Abstract->new(array_datatypes => 1);
1708 planets => [qw/Mercury Venus Earth Mars/]
1711 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1715 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1717 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1720 =head2 Inserting and Updating SQL
1722 In order to apply SQL functions to elements of your C<%data> you may
1723 specify a reference to an arrayref for the given hash value. For example,
1724 if you need to execute the Oracle C<to_date> function on a value, you can
1725 say something like this:
1729 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1732 The first value in the array is the actual SQL. Any other values are
1733 optional and would be included in the bind values array. This gives
1736 my($stmt, @bind) = $sql->insert('people', \%data);
1738 $stmt = "INSERT INTO people (name, date_entered)
1739 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1740 @bind = ('Bill', '03/02/2003');
1742 An UPDATE is just as easy, all you change is the name of the function:
1744 my($stmt, @bind) = $sql->update('people', \%data);
1746 Notice that your C<%data> isn't touched; the module will generate
1747 the appropriately quirky SQL for you automatically. Usually you'll
1748 want to specify a WHERE clause for your UPDATE, though, which is
1749 where handling C<%where> hashes comes in handy...
1751 =head2 Complex where statements
1753 This module can generate pretty complicated WHERE statements
1754 easily. For example, simple C<key=value> pairs are taken to mean
1755 equality, and if you want to see if a field is within a set
1756 of values, you can use an arrayref. Let's say we wanted to
1757 SELECT some data based on this criteria:
1760 requestor => 'inna',
1761 worker => ['nwiger', 'rcwe', 'sfz'],
1762 status => { '!=', 'completed' }
1765 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1767 The above would give you something like this:
1769 $stmt = "SELECT * FROM tickets WHERE
1770 ( requestor = ? ) AND ( status != ? )
1771 AND ( worker = ? OR worker = ? OR worker = ? )";
1772 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1774 Which you could then use in DBI code like so:
1776 my $sth = $dbh->prepare($stmt);
1777 $sth->execute(@bind);
1783 The methods are simple. There's one for every major SQL operation,
1784 and a constructor you use first. The arguments are specified in a
1785 similar order for each method (table, then fields, then a where
1786 clause) to try and simplify things.
1788 =head2 new(option => 'value')
1790 The C<new()> function takes a list of options and values, and returns
1791 a new B<SQL::Abstract> object which can then be used to generate SQL
1792 through the methods below. The options accepted are:
1798 If set to 'lower', then SQL will be generated in all lowercase. By
1799 default SQL is generated in "textbook" case meaning something like:
1801 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1803 Any setting other than 'lower' is ignored.
1807 This determines what the default comparison operator is. By default
1808 it is C<=>, meaning that a hash like this:
1810 %where = (name => 'nwiger', email => 'nate@wiger.org');
1812 Will generate SQL like this:
1814 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1816 However, you may want loose comparisons by default, so if you set
1817 C<cmp> to C<like> you would get SQL such as:
1819 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1821 You can also override the comparison on an individual basis - see
1822 the huge section on L</"WHERE CLAUSES"> at the bottom.
1824 =item sqltrue, sqlfalse
1826 Expressions for inserting boolean values within SQL statements.
1827 By default these are C<1=1> and C<1=0>. They are used
1828 by the special operators C<-in> and C<-not_in> for generating
1829 correct SQL even when the argument is an empty array (see below).
1833 This determines the default logical operator for multiple WHERE
1834 statements in arrays or hashes. If absent, the default logic is "or"
1835 for arrays, and "and" for hashes. This means that a WHERE
1839 event_date => {'>=', '2/13/99'},
1840 event_date => {'<=', '4/24/03'},
1843 will generate SQL like this:
1845 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1847 This is probably not what you want given this query, though (look
1848 at the dates). To change the "OR" to an "AND", simply specify:
1850 my $sql = SQL::Abstract->new(logic => 'and');
1852 Which will change the above C<WHERE> to:
1854 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1856 The logic can also be changed locally by inserting
1857 a modifier in front of an arrayref:
1859 @where = (-and => [event_date => {'>=', '2/13/99'},
1860 event_date => {'<=', '4/24/03'} ]);
1862 See the L</"WHERE CLAUSES"> section for explanations.
1866 This will automatically convert comparisons using the specified SQL
1867 function for both column and value. This is mostly used with an argument
1868 of C<upper> or C<lower>, so that the SQL will have the effect of
1869 case-insensitive "searches". For example, this:
1871 $sql = SQL::Abstract->new(convert => 'upper');
1872 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1874 Will turn out the following SQL:
1876 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1878 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1879 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1880 not validate this option; it will just pass through what you specify verbatim).
1884 This is a kludge because many databases suck. For example, you can't
1885 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1886 Instead, you have to use C<bind_param()>:
1888 $sth->bind_param(1, 'reg data');
1889 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1891 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1892 which loses track of which field each slot refers to. Fear not.
1894 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1895 Currently, you can specify either C<normal> (default) or C<columns>. If you
1896 specify C<columns>, you will get an array that looks like this:
1898 my $sql = SQL::Abstract->new(bindtype => 'columns');
1899 my($stmt, @bind) = $sql->insert(...);
1902 [ 'column1', 'value1' ],
1903 [ 'column2', 'value2' ],
1904 [ 'column3', 'value3' ],
1907 You can then iterate through this manually, using DBI's C<bind_param()>.
1909 $sth->prepare($stmt);
1912 my($col, $data) = @$_;
1913 if ($col eq 'details' || $col eq 'comments') {
1914 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1915 } elsif ($col eq 'image') {
1916 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1918 $sth->bind_param($i, $data);
1922 $sth->execute; # execute without @bind now
1924 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1925 Basically, the advantage is still that you don't have to care which fields
1926 are or are not included. You could wrap that above C<for> loop in a simple
1927 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1928 get a layer of abstraction over manual SQL specification.
1930 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1931 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1932 will expect the bind values in this format.
1936 This is the character that a table or column name will be quoted
1937 with. By default this is an empty string, but you could set it to
1938 the character C<`>, to generate SQL like this:
1940 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1942 Alternatively, you can supply an array ref of two items, the first being the left
1943 hand quote character, and the second the right hand quote character. For
1944 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1945 that generates SQL like this:
1947 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1949 Quoting is useful if you have tables or columns names that are reserved
1950 words in your database's SQL dialect.
1954 This is the character that will be used to escape L</quote_char>s appearing
1955 in an identifier before it has been quoted.
1957 The parameter default in case of a single L</quote_char> character is the quote
1960 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1961 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1962 of the B<opening (left)> L</quote_char> within the identifier are currently left
1963 untouched. The default for opening-closing-style quotes may change in future
1964 versions, thus you are B<strongly encouraged> to specify the escape character
1969 This is the character that separates a table and column name. It is
1970 necessary to specify this when the C<quote_char> option is selected,
1971 so that tables and column names can be individually quoted like this:
1973 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1975 =item injection_guard
1977 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1978 column name specified in a query structure. This is a safety mechanism to avoid
1979 injection attacks when mishandling user input e.g.:
1981 my %condition_as_column_value_pairs = get_values_from_user();
1982 $sqla->select( ... , \%condition_as_column_value_pairs );
1984 If the expression matches an exception is thrown. Note that literal SQL
1985 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1987 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1989 =item array_datatypes
1991 When this option is true, arrayrefs in INSERT or UPDATE are
1992 interpreted as array datatypes and are passed directly
1994 When this option is false, arrayrefs are interpreted
1995 as literal SQL, just like refs to arrayrefs
1996 (but this behavior is for backwards compatibility; when writing
1997 new queries, use the "reference to arrayref" syntax
2003 Takes a reference to a list of "special operators"
2004 to extend the syntax understood by L<SQL::Abstract>.
2005 See section L</"SPECIAL OPERATORS"> for details.
2009 Takes a reference to a list of "unary operators"
2010 to extend the syntax understood by L<SQL::Abstract>.
2011 See section L</"UNARY OPERATORS"> for details.
2017 =head2 insert($table, \@values || \%fieldvals, \%options)
2019 This is the simplest function. You simply give it a table name
2020 and either an arrayref of values or hashref of field/value pairs.
2021 It returns an SQL INSERT statement and a list of bind values.
2022 See the sections on L</"Inserting and Updating Arrays"> and
2023 L</"Inserting and Updating SQL"> for information on how to insert
2024 with those data types.
2026 The optional C<\%options> hash reference may contain additional
2027 options to generate the insert SQL. Currently supported options
2034 Takes either a scalar of raw SQL fields, or an array reference of
2035 field names, and adds on an SQL C<RETURNING> statement at the end.
2036 This allows you to return data generated by the insert statement
2037 (such as row IDs) without performing another C<SELECT> statement.
2038 Note, however, this is not part of the SQL standard and may not
2039 be supported by all database engines.
2043 =head2 update($table, \%fieldvals, \%where, \%options)
2045 This takes a table, hashref of field/value pairs, and an optional
2046 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2048 See the sections on L</"Inserting and Updating Arrays"> and
2049 L</"Inserting and Updating SQL"> for information on how to insert
2050 with those data types.
2052 The optional C<\%options> hash reference may contain additional
2053 options to generate the update SQL. Currently supported options
2060 See the C<returning> option to
2061 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2065 =head2 select($source, $fields, $where, $order)
2067 This returns a SQL SELECT statement and associated list of bind values, as
2068 specified by the arguments:
2074 Specification of the 'FROM' part of the statement.
2075 The argument can be either a plain scalar (interpreted as a table
2076 name, will be quoted), or an arrayref (interpreted as a list
2077 of table names, joined by commas, quoted), or a scalarref
2078 (literal SQL, not quoted).
2082 Specification of the list of fields to retrieve from
2084 The argument can be either an arrayref (interpreted as a list
2085 of field names, will be joined by commas and quoted), or a
2086 plain scalar (literal SQL, not quoted).
2087 Please observe that this API is not as flexible as that of
2088 the first argument C<$source>, for backwards compatibility reasons.
2092 Optional argument to specify the WHERE part of the query.
2093 The argument is most often a hashref, but can also be
2094 an arrayref or plain scalar --
2095 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2099 Optional argument to specify the ORDER BY part of the query.
2100 The argument can be a scalar, a hashref or an arrayref
2101 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2107 =head2 delete($table, \%where, \%options)
2109 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2110 It returns an SQL DELETE statement and list of bind values.
2112 The optional C<\%options> hash reference may contain additional
2113 options to generate the delete SQL. Currently supported options
2120 See the C<returning> option to
2121 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2125 =head2 where(\%where, $order)
2127 This is used to generate just the WHERE clause. For example,
2128 if you have an arbitrary data structure and know what the
2129 rest of your SQL is going to look like, but want an easy way
2130 to produce a WHERE clause, use this. It returns an SQL WHERE
2131 clause and list of bind values.
2134 =head2 values(\%data)
2136 This just returns the values from the hash C<%data>, in the same
2137 order that would be returned from any of the other above queries.
2138 Using this allows you to markedly speed up your queries if you
2139 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2141 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2143 Warning: This is an experimental method and subject to change.
2145 This returns arbitrarily generated SQL. It's a really basic shortcut.
2146 It will return two different things, depending on return context:
2148 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2149 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2151 These would return the following:
2153 # First calling form
2154 $stmt = "CREATE TABLE test (?, ?)";
2155 @bind = (field1, field2);
2157 # Second calling form
2158 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2160 Depending on what you're trying to do, it's up to you to choose the correct
2161 format. In this example, the second form is what you would want.
2165 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2169 ALTER SESSION SET nls_date_format = 'MM/YY'
2171 You get the idea. Strings get their case twiddled, but everything
2172 else remains verbatim.
2174 =head1 EXPORTABLE FUNCTIONS
2176 =head2 is_plain_value
2178 Determines if the supplied argument is a plain value as understood by this
2183 =item * The value is C<undef>
2185 =item * The value is a non-reference
2187 =item * The value is an object with stringification overloading
2189 =item * The value is of the form C<< { -value => $anything } >>
2193 On failure returns C<undef>, on success returns a B<scalar> reference
2194 to the original supplied argument.
2200 The stringification overloading detection is rather advanced: it takes
2201 into consideration not only the presence of a C<""> overload, but if that
2202 fails also checks for enabled
2203 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2204 on either C<0+> or C<bool>.
2206 Unfortunately testing in the field indicates that this
2207 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2208 but only when very large numbers of stringifying objects are involved.
2209 At the time of writing ( Sep 2014 ) there is no clear explanation of
2210 the direct cause, nor is there a manageably small test case that reliably
2211 reproduces the problem.
2213 If you encounter any of the following exceptions in B<random places within
2214 your application stack> - this module may be to blame:
2216 Operation "ne": no method found,
2217 left argument in overloaded package <something>,
2218 right argument in overloaded package <something>
2222 Stub found while resolving method "???" overloading """" in package <something>
2224 If you fall victim to the above - please attempt to reduce the problem
2225 to something that could be sent to the L<SQL::Abstract developers
2226 |DBIx::Class/GETTING HELP/SUPPORT>
2227 (either publicly or privately). As a workaround in the meantime you can
2228 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2229 value, which will most likely eliminate your problem (at the expense of
2230 not being able to properly detect exotic forms of stringification).
2232 This notice and environment variable will be removed in a future version,
2233 as soon as the underlying problem is found and a reliable workaround is
2238 =head2 is_literal_value
2240 Determines if the supplied argument is a literal value as understood by this
2245 =item * C<\$sql_string>
2247 =item * C<\[ $sql_string, @bind_values ]>
2251 On failure returns C<undef>, on success returns an B<array> reference
2252 containing the unpacked version of the supplied literal SQL and bind values.
2254 =head1 WHERE CLAUSES
2258 This module uses a variation on the idea from L<DBIx::Abstract>. It
2259 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2260 module is that things in arrays are OR'ed, and things in hashes
2263 The easiest way to explain is to show lots of examples. After
2264 each C<%where> hash shown, it is assumed you used:
2266 my($stmt, @bind) = $sql->where(\%where);
2268 However, note that the C<%where> hash can be used directly in any
2269 of the other functions as well, as described above.
2271 =head2 Key-value pairs
2273 So, let's get started. To begin, a simple hash:
2277 status => 'completed'
2280 Is converted to SQL C<key = val> statements:
2282 $stmt = "WHERE user = ? AND status = ?";
2283 @bind = ('nwiger', 'completed');
2285 One common thing I end up doing is having a list of values that
2286 a field can be in. To do this, simply specify a list inside of
2291 status => ['assigned', 'in-progress', 'pending'];
2294 This simple code will create the following:
2296 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2297 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2299 A field associated to an empty arrayref will be considered a
2300 logical false and will generate 0=1.
2302 =head2 Tests for NULL values
2304 If the value part is C<undef> then this is converted to SQL <IS NULL>
2313 $stmt = "WHERE user = ? AND status IS NULL";
2316 To test if a column IS NOT NULL:
2320 status => { '!=', undef },
2323 =head2 Specific comparison operators
2325 If you want to specify a different type of operator for your comparison,
2326 you can use a hashref for a given column:
2330 status => { '!=', 'completed' }
2333 Which would generate:
2335 $stmt = "WHERE user = ? AND status != ?";
2336 @bind = ('nwiger', 'completed');
2338 To test against multiple values, just enclose the values in an arrayref:
2340 status => { '=', ['assigned', 'in-progress', 'pending'] };
2342 Which would give you:
2344 "WHERE status = ? OR status = ? OR status = ?"
2347 The hashref can also contain multiple pairs, in which case it is expanded
2348 into an C<AND> of its elements:
2352 status => { '!=', 'completed', -not_like => 'pending%' }
2355 # Or more dynamically, like from a form
2356 $where{user} = 'nwiger';
2357 $where{status}{'!='} = 'completed';
2358 $where{status}{'-not_like'} = 'pending%';
2360 # Both generate this
2361 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2362 @bind = ('nwiger', 'completed', 'pending%');
2365 To get an OR instead, you can combine it with the arrayref idea:
2369 priority => [ { '=', 2 }, { '>', 5 } ]
2372 Which would generate:
2374 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2375 @bind = ('2', '5', 'nwiger');
2377 If you want to include literal SQL (with or without bind values), just use a
2378 scalar reference or reference to an arrayref as the value:
2381 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2382 date_expires => { '<' => \"now()" }
2385 Which would generate:
2387 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2388 @bind = ('11/26/2008');
2391 =head2 Logic and nesting operators
2393 In the example above,
2394 there is a subtle trap if you want to say something like
2395 this (notice the C<AND>):
2397 WHERE priority != ? AND priority != ?
2399 Because, in Perl you I<can't> do this:
2401 priority => { '!=' => 2, '!=' => 1 }
2403 As the second C<!=> key will obliterate the first. The solution
2404 is to use the special C<-modifier> form inside an arrayref:
2406 priority => [ -and => {'!=', 2},
2410 Normally, these would be joined by C<OR>, but the modifier tells it
2411 to use C<AND> instead. (Hint: You can use this in conjunction with the
2412 C<logic> option to C<new()> in order to change the way your queries
2413 work by default.) B<Important:> Note that the C<-modifier> goes
2414 B<INSIDE> the arrayref, as an extra first element. This will
2415 B<NOT> do what you think it might:
2417 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2419 Here is a quick list of equivalencies, since there is some overlap:
2422 status => {'!=', 'completed', 'not like', 'pending%' }
2423 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2426 status => {'=', ['assigned', 'in-progress']}
2427 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2428 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2432 =head2 Special operators: IN, BETWEEN, etc.
2434 You can also use the hashref format to compare a list of fields using the
2435 C<IN> comparison operator, by specifying the list as an arrayref:
2438 status => 'completed',
2439 reportid => { -in => [567, 2335, 2] }
2442 Which would generate:
2444 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2445 @bind = ('completed', '567', '2335', '2');
2447 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2450 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2451 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2452 'sqltrue' (by default: C<1=1>).
2454 In addition to the array you can supply a chunk of literal sql or
2455 literal sql with bind:
2458 customer => { -in => \[
2459 'SELECT cust_id FROM cust WHERE balance > ?',
2462 status => { -in => \'SELECT status_codes FROM states' },
2468 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2469 AND status IN ( SELECT status_codes FROM states )
2473 Finally, if the argument to C<-in> is not a reference, it will be
2474 treated as a single-element array.
2476 Another pair of operators is C<-between> and C<-not_between>,
2477 used with an arrayref of two values:
2481 completion_date => {
2482 -not_between => ['2002-10-01', '2003-02-06']
2488 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2490 Just like with C<-in> all plausible combinations of literal SQL
2494 start0 => { -between => [ 1, 2 ] },
2495 start1 => { -between => \["? AND ?", 1, 2] },
2496 start2 => { -between => \"lower(x) AND upper(y)" },
2497 start3 => { -between => [
2499 \["upper(?)", 'stuff' ],
2506 ( start0 BETWEEN ? AND ? )
2507 AND ( start1 BETWEEN ? AND ? )
2508 AND ( start2 BETWEEN lower(x) AND upper(y) )
2509 AND ( start3 BETWEEN lower(x) AND upper(?) )
2511 @bind = (1, 2, 1, 2, 'stuff');
2514 These are the two builtin "special operators"; but the
2515 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2517 =head2 Unary operators: bool
2519 If you wish to test against boolean columns or functions within your
2520 database you can use the C<-bool> and C<-not_bool> operators. For
2521 example to test the column C<is_user> being true and the column
2522 C<is_enabled> being false you would use:-
2526 -not_bool => 'is_enabled',
2531 WHERE is_user AND NOT is_enabled
2533 If a more complex combination is required, testing more conditions,
2534 then you should use the and/or operators:-
2539 -not_bool => { two=> { -rlike => 'bar' } },
2540 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2551 (NOT ( three = ? OR three > ? ))
2554 =head2 Nested conditions, -and/-or prefixes
2556 So far, we've seen how multiple conditions are joined with a top-level
2557 C<AND>. We can change this by putting the different conditions we want in
2558 hashes and then putting those hashes in an array. For example:
2563 status => { -like => ['pending%', 'dispatched'] },
2567 status => 'unassigned',
2571 This data structure would create the following:
2573 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2574 OR ( user = ? AND status = ? ) )";
2575 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2578 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2579 to change the logic inside:
2585 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2586 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2593 $stmt = "WHERE ( user = ?
2594 AND ( ( workhrs > ? AND geo = ? )
2595 OR ( workhrs < ? OR geo = ? ) ) )";
2596 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2598 =head3 Algebraic inconsistency, for historical reasons
2600 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2601 operator goes C<outside> of the nested structure; whereas when connecting
2602 several constraints on one column, the C<-and> operator goes
2603 C<inside> the arrayref. Here is an example combining both features:
2606 -and => [a => 1, b => 2],
2607 -or => [c => 3, d => 4],
2608 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2613 WHERE ( ( ( a = ? AND b = ? )
2614 OR ( c = ? OR d = ? )
2615 OR ( e LIKE ? AND e LIKE ? ) ) )
2617 This difference in syntax is unfortunate but must be preserved for
2618 historical reasons. So be careful: the two examples below would
2619 seem algebraically equivalent, but they are not
2622 { -like => 'foo%' },
2623 { -like => '%bar' },
2625 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2628 { col => { -like => 'foo%' } },
2629 { col => { -like => '%bar' } },
2631 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2634 =head2 Literal SQL and value type operators
2636 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2637 side" is a column name and the "right side" is a value (normally rendered as
2638 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2639 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2640 alter this behavior. There are several ways of doing so.
2644 This is a virtual operator that signals the string to its right side is an
2645 identifier (a column name) and not a value. For example to compare two
2646 columns you would write:
2649 priority => { '<', 2 },
2650 requestor => { -ident => 'submitter' },
2655 $stmt = "WHERE priority < ? AND requestor = submitter";
2658 If you are maintaining legacy code you may see a different construct as
2659 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2664 This is a virtual operator that signals that the construct to its right side
2665 is a value to be passed to DBI. This is for example necessary when you want
2666 to write a where clause against an array (for RDBMS that support such
2667 datatypes). For example:
2670 array => { -value => [1, 2, 3] }
2675 $stmt = 'WHERE array = ?';
2676 @bind = ([1, 2, 3]);
2678 Note that if you were to simply say:
2684 the result would probably not be what you wanted:
2686 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2691 Finally, sometimes only literal SQL will do. To include a random snippet
2692 of SQL verbatim, you specify it as a scalar reference. Consider this only
2693 as a last resort. Usually there is a better way. For example:
2696 priority => { '<', 2 },
2697 requestor => { -in => \'(SELECT name FROM hitmen)' },
2702 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2705 Note that in this example, you only get one bind parameter back, since
2706 the verbatim SQL is passed as part of the statement.
2710 Never use untrusted input as a literal SQL argument - this is a massive
2711 security risk (there is no way to check literal snippets for SQL
2712 injections and other nastyness). If you need to deal with untrusted input
2713 use literal SQL with placeholders as described next.
2715 =head3 Literal SQL with placeholders and bind values (subqueries)
2717 If the literal SQL to be inserted has placeholders and bind values,
2718 use a reference to an arrayref (yes this is a double reference --
2719 not so common, but perfectly legal Perl). For example, to find a date
2720 in Postgres you can use something like this:
2723 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2728 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2731 Note that you must pass the bind values in the same format as they are returned
2732 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2733 to C<columns>, you must provide the bind values in the
2734 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2735 scalar value; most commonly the column name, but you can use any scalar value
2736 (including references and blessed references), L<SQL::Abstract> will simply
2737 pass it through intact. So if C<bindtype> is set to C<columns> the above
2738 example will look like:
2741 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2744 Literal SQL is especially useful for nesting parenthesized clauses in the
2745 main SQL query. Here is a first example:
2747 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2751 bar => \["IN ($sub_stmt)" => @sub_bind],
2756 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2757 WHERE c2 < ? AND c3 LIKE ?))";
2758 @bind = (1234, 100, "foo%");
2760 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2761 are expressed in the same way. Of course the C<$sub_stmt> and
2762 its associated bind values can be generated through a former call
2765 my ($sub_stmt, @sub_bind)
2766 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2767 c3 => {-like => "foo%"}});
2770 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2773 In the examples above, the subquery was used as an operator on a column;
2774 but the same principle also applies for a clause within the main C<%where>
2775 hash, like an EXISTS subquery:
2777 my ($sub_stmt, @sub_bind)
2778 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2779 my %where = ( -and => [
2781 \["EXISTS ($sub_stmt)" => @sub_bind],
2786 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2787 WHERE c1 = ? AND c2 > t0.c0))";
2791 Observe that the condition on C<c2> in the subquery refers to
2792 column C<t0.c0> of the main query: this is I<not> a bind
2793 value, so we have to express it through a scalar ref.
2794 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2795 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2796 what we wanted here.
2798 Finally, here is an example where a subquery is used
2799 for expressing unary negation:
2801 my ($sub_stmt, @sub_bind)
2802 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2803 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2805 lname => {like => '%son%'},
2806 \["NOT ($sub_stmt)" => @sub_bind],
2811 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2812 @bind = ('%son%', 10, 20)
2814 =head3 Deprecated usage of Literal SQL
2816 Below are some examples of archaic use of literal SQL. It is shown only as
2817 reference for those who deal with legacy code. Each example has a much
2818 better, cleaner and safer alternative that users should opt for in new code.
2824 my %where = ( requestor => \'IS NOT NULL' )
2826 $stmt = "WHERE requestor IS NOT NULL"
2828 This used to be the way of generating NULL comparisons, before the handling
2829 of C<undef> got formalized. For new code please use the superior syntax as
2830 described in L</Tests for NULL values>.
2834 my %where = ( requestor => \'= submitter' )
2836 $stmt = "WHERE requestor = submitter"
2838 This used to be the only way to compare columns. Use the superior L</-ident>
2839 method for all new code. For example an identifier declared in such a way
2840 will be properly quoted if L</quote_char> is properly set, while the legacy
2841 form will remain as supplied.
2845 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2847 $stmt = "WHERE completed > ? AND is_ready"
2848 @bind = ('2012-12-21')
2850 Using an empty string literal used to be the only way to express a boolean.
2851 For all new code please use the much more readable
2852 L<-bool|/Unary operators: bool> operator.
2858 These pages could go on for a while, since the nesting of the data
2859 structures this module can handle are pretty much unlimited (the
2860 module implements the C<WHERE> expansion as a recursive function
2861 internally). Your best bet is to "play around" with the module a
2862 little to see how the data structures behave, and choose the best
2863 format for your data based on that.
2865 And of course, all the values above will probably be replaced with
2866 variables gotten from forms or the command line. After all, if you
2867 knew everything ahead of time, you wouldn't have to worry about
2868 dynamically-generating SQL and could just hardwire it into your
2871 =head1 ORDER BY CLAUSES
2873 Some functions take an order by clause. This can either be a scalar (just a
2874 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2875 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2878 Given | Will Generate
2879 ---------------------------------------------------------------
2881 'colA' | ORDER BY colA
2883 [qw/colA colB/] | ORDER BY colA, colB
2885 {-asc => 'colA'} | ORDER BY colA ASC
2887 {-desc => 'colB'} | ORDER BY colB DESC
2889 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2891 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2893 \'colA DESC' | ORDER BY colA DESC
2895 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2896 | /* ...with $x bound to ? */
2899 { -asc => 'colA' }, | colA ASC,
2900 { -desc => [qw/colB/] }, | colB DESC,
2901 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2902 \'colE DESC', | colE DESC,
2903 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2904 ] | /* ...with $x bound to ? */
2905 ===============================================================
2909 =head1 SPECIAL OPERATORS
2911 my $sqlmaker = SQL::Abstract->new(special_ops => [
2915 my ($self, $field, $op, $arg) = @_;
2921 handler => 'method_name',
2925 A "special operator" is a SQL syntactic clause that can be
2926 applied to a field, instead of a usual binary operator.
2929 WHERE field IN (?, ?, ?)
2930 WHERE field BETWEEN ? AND ?
2931 WHERE MATCH(field) AGAINST (?, ?)
2933 Special operators IN and BETWEEN are fairly standard and therefore
2934 are builtin within C<SQL::Abstract> (as the overridable methods
2935 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2936 like the MATCH .. AGAINST example above which is specific to MySQL,
2937 you can write your own operator handlers - supply a C<special_ops>
2938 argument to the C<new> method. That argument takes an arrayref of
2939 operator definitions; each operator definition is a hashref with two
2946 the regular expression to match the operator
2950 Either a coderef or a plain scalar method name. In both cases
2951 the expected return is C<< ($sql, @bind) >>.
2953 When supplied with a method name, it is simply called on the
2954 L<SQL::Abstract> object as:
2956 $self->$method_name($field, $op, $arg)
2960 $field is the LHS of the operator
2961 $op is the part that matched the handler regex
2964 When supplied with a coderef, it is called as:
2966 $coderef->($self, $field, $op, $arg)
2971 For example, here is an implementation
2972 of the MATCH .. AGAINST syntax for MySQL
2974 my $sqlmaker = SQL::Abstract->new(special_ops => [
2976 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2977 {regex => qr/^match$/i,
2979 my ($self, $field, $op, $arg) = @_;
2980 $arg = [$arg] if not ref $arg;
2981 my $label = $self->_quote($field);
2982 my ($placeholder) = $self->_convert('?');
2983 my $placeholders = join ", ", (($placeholder) x @$arg);
2984 my $sql = $self->_sqlcase('match') . " ($label) "
2985 . $self->_sqlcase('against') . " ($placeholders) ";
2986 my @bind = $self->_bindtype($field, @$arg);
2987 return ($sql, @bind);
2994 =head1 UNARY OPERATORS
2996 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3000 my ($self, $op, $arg) = @_;
3006 handler => 'method_name',
3010 A "unary operator" is a SQL syntactic clause that can be
3011 applied to a field - the operator goes before the field
3013 You can write your own operator handlers - supply a C<unary_ops>
3014 argument to the C<new> method. That argument takes an arrayref of
3015 operator definitions; each operator definition is a hashref with two
3022 the regular expression to match the operator
3026 Either a coderef or a plain scalar method name. In both cases
3027 the expected return is C<< $sql >>.
3029 When supplied with a method name, it is simply called on the
3030 L<SQL::Abstract> object as:
3032 $self->$method_name($op, $arg)
3036 $op is the part that matched the handler regex
3037 $arg is the RHS or argument of the operator
3039 When supplied with a coderef, it is called as:
3041 $coderef->($self, $op, $arg)
3049 Thanks to some benchmarking by Mark Stosberg, it turns out that
3050 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3051 I must admit this wasn't an intentional design issue, but it's a
3052 byproduct of the fact that you get to control your C<DBI> handles
3055 To maximize performance, use a code snippet like the following:
3057 # prepare a statement handle using the first row
3058 # and then reuse it for the rest of the rows
3060 for my $href (@array_of_hashrefs) {
3061 $stmt ||= $sql->insert('table', $href);
3062 $sth ||= $dbh->prepare($stmt);
3063 $sth->execute($sql->values($href));
3066 The reason this works is because the keys in your C<$href> are sorted
3067 internally by B<SQL::Abstract>. Thus, as long as your data retains
3068 the same structure, you only have to generate the SQL the first time
3069 around. On subsequent queries, simply use the C<values> function provided
3070 by this module to return your values in the correct order.
3072 However this depends on the values having the same type - if, for
3073 example, the values of a where clause may either have values
3074 (resulting in sql of the form C<column = ?> with a single bind
3075 value), or alternatively the values might be C<undef> (resulting in
3076 sql of the form C<column IS NULL> with no bind value) then the
3077 caching technique suggested will not work.
3081 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3082 really like this part (I do, at least). Building up a complex query
3083 can be as simple as the following:
3090 use CGI::FormBuilder;
3093 my $form = CGI::FormBuilder->new(...);
3094 my $sql = SQL::Abstract->new;
3096 if ($form->submitted) {
3097 my $field = $form->field;
3098 my $id = delete $field->{id};
3099 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3102 Of course, you would still have to connect using C<DBI> to run the
3103 query, but the point is that if you make your form look like your
3104 table, the actual query script can be extremely simplistic.
3106 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3107 a fast interface to returning and formatting data. I frequently
3108 use these three modules together to write complex database query
3109 apps in under 50 lines.
3111 =head1 HOW TO CONTRIBUTE
3113 Contributions are always welcome, in all usable forms (we especially
3114 welcome documentation improvements). The delivery methods include git-
3115 or unified-diff formatted patches, GitHub pull requests, or plain bug
3116 reports either via RT or the Mailing list. Contributors are generally
3117 granted full access to the official repository after their first several
3118 patches pass successful review.
3120 This project is maintained in a git repository. The code and related tools are
3121 accessible at the following locations:
3125 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3127 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3129 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3131 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3137 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3138 Great care has been taken to preserve the I<published> behavior
3139 documented in previous versions in the 1.* family; however,
3140 some features that were previously undocumented, or behaved
3141 differently from the documentation, had to be changed in order
3142 to clarify the semantics. Hence, client code that was relying
3143 on some dark areas of C<SQL::Abstract> v1.*
3144 B<might behave differently> in v1.50.
3146 The main changes are:
3152 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3156 support for the { operator => \"..." } construct (to embed literal SQL)
3160 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3164 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3168 defensive programming: check arguments
3172 fixed bug with global logic, which was previously implemented
3173 through global variables yielding side-effects. Prior versions would
3174 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3175 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3176 Now this is interpreted
3177 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3182 fixed semantics of _bindtype on array args
3186 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3187 we just avoid shifting arrays within that tree.
3191 dropped the C<_modlogic> function
3195 =head1 ACKNOWLEDGEMENTS
3197 There are a number of individuals that have really helped out with
3198 this module. Unfortunately, most of them submitted bugs via CPAN
3199 so I have no idea who they are! But the people I do know are:
3201 Ash Berlin (order_by hash term support)
3202 Matt Trout (DBIx::Class support)
3203 Mark Stosberg (benchmarking)
3204 Chas Owens (initial "IN" operator support)
3205 Philip Collins (per-field SQL functions)
3206 Eric Kolve (hashref "AND" support)
3207 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3208 Dan Kubb (support for "quote_char" and "name_sep")
3209 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3210 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3211 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3212 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3213 Oliver Charles (support for "RETURNING" after "INSERT")
3219 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3223 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3225 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3227 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3228 While not an official support venue, C<DBIx::Class> makes heavy use of
3229 C<SQL::Abstract>, and as such list members there are very familiar with
3230 how to create queries.
3234 This module is free software; you may copy this under the same
3235 terms as perl itself (either the GNU General Public License or
3236 the Artistic License)