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 sub is_undef_value ($) {
75 and exists $_[0]->{-value}
76 and not defined $_[0]->{-value}
80 # FIXME XSify - this can be done so much more efficiently
81 sub is_plain_value ($) {
83 ! length ref $_[0] ? \($_[0])
85 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
87 exists $_[0]->{-value}
88 ) ? \($_[0]->{-value})
90 # reuse @_ for even moar speedz
91 defined ( $_[1] = Scalar::Util::blessed $_[0] )
93 # deliberately not using Devel::OverloadInfo - the checks we are
94 # intersted in are much more limited than the fullblown thing, and
95 # this is a very hot piece of code
97 # simply using ->can('(""') can leave behind stub methods that
98 # break actually using the overload later (see L<perldiag/Stub
99 # found while resolving method "%s" overloading "%s" in package
100 # "%s"> and the source of overload::mycan())
102 # either has stringification which DBI SHOULD prefer out of the box
103 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
105 # has nummification or boolification, AND fallback is *not* disabled
107 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
110 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
112 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
116 # no fallback specified at all
117 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
119 # fallback explicitly undef
120 ! defined ${"$_[3]::()"}
133 #======================================================================
135 #======================================================================
139 my $class = ref($self) || $self;
140 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
142 # choose our case by keeping an option around
143 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
145 # default logic for interpreting arrayrefs
146 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
148 # how to return bind vars
149 $opt{bindtype} ||= 'normal';
151 # default comparison is "=", but can be overridden
154 # try to recognize which are the 'equality' and 'inequality' ops
155 # (temporary quickfix (in 2007), should go through a more seasoned API)
156 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
157 $opt{inequality_op} = qr/^( != | <> )$/ix;
159 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
160 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
163 $opt{sqltrue} ||= '1=1';
164 $opt{sqlfalse} ||= '0=1';
167 $opt{special_ops} ||= [];
169 # regexes are applied in order, thus push after user-defines
170 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
172 if ($class->isa('DBIx::Class::SQLMaker')) {
173 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
174 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
176 $opt{is_dbic_sqlmaker} = 1;
180 $opt{unary_ops} ||= [];
182 # rudimentary sanity-check for user supplied bits treated as functions/operators
183 # If a purported function matches this regular expression, an exception is thrown.
184 # Literal SQL is *NOT* subject to this check, only functions (and column names
185 # when quoting is not in effect)
188 # need to guard against ()'s in column names too, but this will break tons of
189 # hacks... ideas anyone?
190 $opt{injection_guard} ||= qr/
196 $opt{expand_unary} = {};
199 -not => '_expand_not',
200 -bool => '_expand_bool',
201 -and => '_expand_op_andor',
202 -or => '_expand_op_andor',
203 -nest => '_expand_nest',
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;
559 my ($self, $expr, $default_scalar_to) = @_;
560 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
561 $self->_expand_expr($expr);
565 my ($self, $aqt) = @_;
566 my ($k, $v, @rest) = %$aqt;
568 if (my $meth = $self->{render}{$k}) {
569 return $self->$meth($v);
571 die "notreached: $k";
575 my ($self, $expr) = @_;
576 $self->render_aqt($self->expand_expr($expr));
580 my ($self, $expr) = @_;
581 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
582 return undef unless defined($expr);
583 if (ref($expr) eq 'HASH') {
584 return undef unless my $kc = keys %$expr;
586 return $self->_expand_op_andor(-and => $expr);
588 my ($key, $value) = %$expr;
589 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
590 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
591 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
593 if (my $exp = $self->{expand}{$key}) {
594 return $self->$exp($key, $value);
596 return $self->_expand_expr_hashpair($key, $value);
598 if (ref($expr) eq 'ARRAY') {
599 my $logic = '-'.lc($self->{logic});
600 return $self->_expand_op_andor($logic, $expr);
602 if (my $literal = is_literal_value($expr)) {
603 return +{ -literal => $literal };
605 if (!ref($expr) or Scalar::Util::blessed($expr)) {
606 if (my $d = our $Default_Scalar_To) {
607 return $self->_expand_expr({ $d => $expr });
609 return $self->_expand_value(-value => $expr);
614 sub _expand_expr_hashpair {
615 my ($self, $k, $v) = @_;
616 unless (defined($k) and length($k)) {
617 if (defined($k) and my $literal = is_literal_value($v)) {
618 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
619 return { -literal => $literal };
621 puke "Supplying an empty left hand side argument is not supported";
624 return $self->_expand_expr_hashpair_op($k, $v);
626 return $self->_expand_expr_hashpair_ident($k, $v);
629 sub _expand_expr_hashpair_ident {
630 my ($self, $k, $v) = @_;
632 # hash with multiple or no elements is andor
634 if (ref($v) eq 'HASH' and keys %$v != 1) {
635 return $self->_expand_op_andor(-and => $v, $k);
638 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
640 if (is_undef_value($v)) {
641 return $self->_expand_expr_hashpair_cmp($k => undef);
644 # scalars and objects get expanded as whatever requested or values
646 if (!ref($v) or Scalar::Util::blessed($v)) {
647 my $d = our $Default_Scalar_To;
648 local our $Cur_Col_Meta = $k;
649 return $self->_expand_expr_hashpair_ident(
652 ? $self->_expand_expr($d => $v)
657 if (ref($v) eq 'HASH') {
658 return $self->_expand_expr_hashtriple($k, %$v);
660 if (ref($v) eq 'ARRAY') {
661 return $self->sqlfalse unless @$v;
662 $self->_debug("ARRAY($k) means distribute over elements");
664 $v->[0] =~ /^-(and|or)$/i
665 ? shift(@{$v = [ @$v ]})
666 : '-'.lc($self->{logic} || 'OR')
668 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_hashpair_op {
689 my ($self, $k, $v) = @_;
692 $op =~ s/^-// if length($op) > 1;
693 $self->_assert_pass_injection_guard($op);
695 # Ops prefixed with -not_ get converted
697 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
700 $self->_expand_expr({ "-${rest}", $v })
707 # the old special op system requires illegality for top-level use
710 (our $Expand_Depth) == 1
711 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
713 puke "Illegal use of top-level '-$op'"
716 # the old unary op system means we should touch nothing and let it work
718 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
719 return { -op => [ $op, $v ] };
723 # an explicit node type is currently assumed to be expanded (this is almost
724 # certainly wrong and there should be expansion anyway)
726 if ($self->{render}{$k}) {
730 # hashref RHS values get expanded and used as op/func args
735 and (keys %$v)[0] =~ /^-/
737 my ($func) = $k =~ /^-(.*)$/;
739 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
740 return +{ -op => [ $func, $self->_expand_expr($v) ] };
743 return +{ -func => [ $func, $self->_expand_expr($v) ] };
746 # scalars and literals get simply expanded
748 if (!ref($v) or is_literal_value($v)) {
749 return +{ -op => [ $op, $self->_expand_expr($v) ] };
755 sub _expand_expr_hashpair_cmp {
756 my ($self, $k, $v) = @_;
757 $self->_expand_expr_hashtriple($k, $self->{cmp}, $v);
760 sub _expand_expr_hashtriple {
761 my ($self, $k, $vk, $vv) = @_;
763 my $ik = $self->_expand_ident(-ident => $k);
765 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
766 $self->_assert_pass_injection_guard($op);
767 if ($op =~ s/ [_\s]? \d+ $//x ) {
768 return $self->_expand_expr($k, { $vk, $vv });
770 if (my $x = $self->{expand_op}{$op}) {
771 local our $Cur_Col_Meta = $k;
772 return $self->$x($op, $vv, $k);
775 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
776 return { -op => [ $op, $ik, $vv ] };
778 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
782 { -op => [ $op, $vv ] }
786 if (ref($vv) eq 'ARRAY') {
788 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
789 ? shift @raw : '-or';
790 my @values = map +{ $vk => $_ }, @raw;
792 $op =~ $self->{inequality_op}
793 or $op =~ $self->{not_like_op}
795 if (lc($logic) eq '-or' and @values > 1) {
796 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
797 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
798 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
803 # try to DWIM on equality operators
804 return ($self->_dwim_op_to_is($op,
805 "Supplying an empty arrayref to '%s' is deprecated",
806 "operator '%s' applied on an empty array (field '$k')"
807 ) ? $self->sqlfalse : $self->sqltrue);
809 return $self->_expand_op_andor($logic => \@values, $k);
811 if (is_undef_value($vv)) {
812 my $is = ($self->_dwim_op_to_is($op,
813 "Supplying an undefined argument to '%s' is deprecated",
814 "unexpected operator '%s' with undef operand",
815 ) ? 'is' : 'is not');
817 return $self->_expand_expr_hashpair($k => { $is, undef });
819 local our $Cur_Col_Meta = $k;
823 $self->_expand_expr($vv)
828 my ($self, $op, $empty, $fail) = @_;
829 if ($op =~ /^not$/i) {
832 if ($op =~ $self->{equality_op}) {
835 if ($op =~ $self->{like_op}) {
836 belch(sprintf $empty, uc($op));
839 if ($op =~ $self->{inequality_op}) {
842 if ($op =~ $self->{not_like_op}) {
843 belch(sprintf $empty, uc($op));
846 puke(sprintf $fail, $op);
850 my ($self, $op, $body) = @_;
851 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
852 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
854 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
855 ref($body) ? @$body : $body;
856 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
857 unless ($self->{quote_char}) {
858 $self->_assert_pass_injection_guard($_) for @parts;
860 return +{ -ident => \@parts };
864 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
868 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
872 my ($self, undef, $v) = @_;
874 return $self->_expand_expr($v);
876 puke "-bool => undef not supported" unless defined($v);
877 return $self->_expand_ident(-ident => $v);
880 sub _expand_op_andor {
881 my ($self, $logic, $v, $k) = @_;
883 $v = [ map +{ $k, $_ },
885 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
889 my ($logop) = $logic =~ /^-?(.*)$/;
890 if (ref($v) eq 'HASH') {
891 return undef unless keys %$v;
894 map $self->_expand_expr({ $_ => $v->{$_} }),
898 if (ref($v) eq 'ARRAY') {
899 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
902 (ref($_) eq 'ARRAY' and @$_)
903 or (ref($_) eq 'HASH' and %$_)
909 while (my ($el) = splice @expr, 0, 1) {
910 puke "Supplying an empty left hand side argument is not supported in array-pairs"
911 unless defined($el) and length($el);
912 my $elref = ref($el);
914 local our $Expand_Depth = 0;
915 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
916 } elsif ($elref eq 'ARRAY') {
917 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
918 } elsif (my $l = is_literal_value($el)) {
919 push @res, { -literal => $l };
920 } elsif ($elref eq 'HASH') {
921 local our $Expand_Depth = 0;
922 push @res, grep defined, $self->_expand_expr($el) if %$el;
928 # return $res[0] if @res == 1;
929 return { -op => [ $logop, @res ] };
935 my ($self, $op, $vv, $k) = @_;
936 puke "$op can only take undef as argument"
940 and exists($vv->{-value})
941 and !defined($vv->{-value})
943 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
946 sub _expand_between {
947 my ($self, $op, $vv, $k) = @_;
948 local our $Cur_Col_Meta = $k;
949 my @rhs = map $self->_expand_expr($_),
950 ref($vv) eq 'ARRAY' ? @$vv : $vv;
952 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
954 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
956 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
960 $self->_expand_ident(-ident => $k),
966 my ($self, $op, $vv, $k) = @_;
967 if (my $literal = is_literal_value($vv)) {
968 my ($sql, @bind) = @$literal;
969 my $opened_sql = $self->_open_outer_paren($sql);
971 $op, $self->_expand_ident(-ident => $k),
972 [ { -literal => [ $opened_sql, @bind ] } ]
976 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
977 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
978 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
979 . 'will emit the logically correct SQL instead of raising this exception)'
981 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
983 my @rhs = map $self->_expand_expr($_),
984 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
985 map { defined($_) ? $_: puke($undef_err) }
986 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
987 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
991 $self->_expand_ident(-ident => $k),
997 my ($self, $op, $v) = @_;
998 # DBIx::Class requires a nest warning to be emitted once but the private
999 # method it overrode to do so no longer exists
1000 if ($self->{is_dbic_sqlmaker}) {
1001 unless (our $Nest_Warned) {
1003 "-nest in search conditions is deprecated, you most probably wanted:\n"
1004 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1009 return $self->_expand_expr($v);
1012 sub _recurse_where {
1013 my ($self, $where, $logic) = @_;
1015 # Special case: top level simple string treated as literal
1017 my $where_exp = (ref($where)
1018 ? $self->_expand_expr($where, $logic)
1019 : { -literal => [ $where ] });
1021 # dispatch expanded expression
1023 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1024 # DBIx::Class used to call _recurse_where in scalar context
1025 # something else might too...
1027 return ($sql, @bind);
1030 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1036 my ($self, $ident) = @_;
1038 return $self->_convert($self->_quote($ident));
1042 my ($self, $list) = @_;
1043 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1044 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1048 my ($self, $rest) = @_;
1049 my ($func, @args) = @$rest;
1053 push @arg_sql, shift @x;
1055 } map [ $self->render_aqt($_) ], @args;
1056 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1060 my ($self, $bind) = @_;
1061 return ($self->_convert('?'), $self->_bindtype(@$bind));
1064 sub _render_literal {
1065 my ($self, $literal) = @_;
1066 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1071 my ($self, $v) = @_;
1072 my ($op, @args) = @$v;
1073 if (my $r = $self->{render_op}{$op}) {
1074 return $self->$r($op, \@args);
1079 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1080 if ($us and @args > 1) {
1081 puke "Special op '${op}' requires first value to be identifier"
1082 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1083 my $k = join(($self->{name_sep}||'.'), @$ident);
1084 local our $Expand_Depth = 1;
1085 return $self->${\($us->{handler})}($k, $op, $args[1]);
1087 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1088 return $self->${\($us->{handler})}($op, $args[0]);
1093 return $self->_render_unop_prefix($op, \@args);
1095 return $self->_render_op_multop($op, \@args);
1101 sub _render_op_between {
1102 my ($self, $op, $args) = @_;
1103 my ($left, $low, $high) = @$args;
1104 my ($rhsql, @rhbind) = do {
1106 puke "Single arg to between must be a literal"
1107 unless $low->{-literal};
1110 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1111 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1112 @{$l}[1..$#$l], @{$h}[1..$#$h])
1115 my ($lhsql, @lhbind) = $self->render_aqt($left);
1117 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1123 my ($self, $op, $args) = @_;
1124 my ($lhs, $rhs) = @$args;
1127 my ($sql, @bind) = $self->render_aqt($_);
1128 push @in_bind, @bind;
1131 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1133 $lhsql.' '.$self->_sqlcase($op).' ( '
1134 .join(', ', @in_sql)
1140 sub _render_op_andor {
1141 my ($self, $op, $args) = @_;
1142 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1143 return '' unless @parts;
1144 return @{$parts[0]} if @parts == 1;
1145 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1146 return '( '.$sql.' )', @bind;
1149 sub _render_op_multop {
1150 my ($self, $op, $args) = @_;
1151 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1152 return '' unless @parts;
1153 return @{$parts[0]} if @parts == 1;
1154 my ($final_sql) = join(
1155 ' '.$self->_sqlcase($op).' ',
1160 map @{$_}[1..$#$_], @parts
1163 sub _render_op_not {
1164 my ($self, $op, $v) = @_;
1165 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1166 return "(${sql})", @bind;
1169 sub _render_unop_prefix {
1170 my ($self, $op, $v) = @_;
1171 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1172 my $op_sql = $self->_sqlcase($op);
1173 return ("${op_sql} ${expr_sql}", @bind);
1176 sub _render_unop_postfix {
1177 my ($self, $op, $v) = @_;
1178 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1179 my $op_sql = $self->_sqlcase($op);
1180 return ($expr_sql.' '.$op_sql, @bind);
1183 # Some databases (SQLite) treat col IN (1, 2) different from
1184 # col IN ( (1, 2) ). Use this to strip all outer parens while
1185 # adding them back in the corresponding method
1186 sub _open_outer_paren {
1187 my ($self, $sql) = @_;
1189 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1191 # there are closing parens inside, need the heavy duty machinery
1192 # to reevaluate the extraction starting from $sql (full reevaluation)
1193 if ($inner =~ /\)/) {
1194 require Text::Balanced;
1196 my (undef, $remainder) = do {
1197 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1199 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1202 # the entire expression needs to be a balanced bracketed thing
1203 # (after an extract no remainder sans trailing space)
1204 last if defined $remainder and $remainder =~ /\S/;
1214 #======================================================================
1216 #======================================================================
1218 sub _expand_order_by {
1219 my ($self, $arg) = @_;
1221 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1223 my $expander = sub {
1224 my ($self, $dir, $expr) = @_;
1225 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1226 foreach my $arg (@to_expand) {
1230 and grep /^-(asc|desc)$/, keys %$arg
1232 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1236 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1238 map $self->expand_expr($_, -ident),
1239 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1240 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1243 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1245 return $self->$expander(undef, $arg);
1249 my ($self, $arg) = @_;
1251 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1253 my ($sql, @bind) = $self->render_aqt($expanded);
1255 return '' unless length($sql);
1257 my $final_sql = $self->_sqlcase(' order by ').$sql;
1259 return wantarray ? ($final_sql, @bind) : $final_sql;
1262 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1264 sub _order_by_chunks {
1265 my ($self, $arg) = @_;
1267 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1269 return $self->_chunkify_order_by($expanded);
1272 sub _chunkify_order_by {
1273 my ($self, $expanded) = @_;
1275 return grep length, $self->render_aqt($expanded)
1276 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1279 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1280 return map $self->_chunkify_order_by($_), @$l;
1282 return [ $self->render_aqt($_) ];
1286 #======================================================================
1287 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1288 #======================================================================
1294 $self->_expand_maybe_list_expr($from, undef, -ident)
1299 #======================================================================
1301 #======================================================================
1303 sub _expand_maybe_list_expr {
1304 my ($self, $expr, $logic, $default) = @_;
1306 if (ref($expr) eq 'ARRAY') {
1308 map $self->expand_expr($_, $default), @$expr
1315 return $self->expand_expr($e, $default);
1318 # highly optimized, as it's called way too often
1320 # my ($self, $label) = @_;
1322 return '' unless defined $_[1];
1323 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1324 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1326 unless ($_[0]->{quote_char}) {
1327 if (ref($_[1]) eq 'ARRAY') {
1328 return join($_[0]->{name_sep}||'.', @{$_[1]});
1330 $_[0]->_assert_pass_injection_guard($_[1]);
1335 my $qref = ref $_[0]->{quote_char};
1337 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1338 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1339 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1341 my $esc = $_[0]->{escape_char} || $r;
1343 # parts containing * are naturally unquoted
1345 $_[0]->{name_sep}||'',
1349 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1351 (ref($_[1]) eq 'ARRAY'
1355 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1363 # Conversion, if applicable
1365 #my ($self, $arg) = @_;
1366 if ($_[0]->{convert_where}) {
1367 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1374 #my ($self, $col, @vals) = @_;
1375 # called often - tighten code
1376 return $_[0]->{bindtype} eq 'columns'
1377 ? map {[$_[1], $_]} @_[2 .. $#_]
1382 # Dies if any element of @bind is not in [colname => value] format
1383 # if bindtype is 'columns'.
1384 sub _assert_bindval_matches_bindtype {
1385 # my ($self, @bind) = @_;
1387 if ($self->{bindtype} eq 'columns') {
1389 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1390 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1396 sub _join_sql_clauses {
1397 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1399 if (@$clauses_aref > 1) {
1400 my $join = " " . $self->_sqlcase($logic) . " ";
1401 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1402 return ($sql, @$bind_aref);
1404 elsif (@$clauses_aref) {
1405 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1408 return (); # if no SQL, ignore @$bind_aref
1413 # Fix SQL case, if so requested
1415 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1416 # don't touch the argument ... crooked logic, but let's not change it!
1417 return $_[0]->{case} ? $_[1] : uc($_[1]);
1421 #======================================================================
1422 # DISPATCHING FROM REFKIND
1423 #======================================================================
1426 my ($self, $data) = @_;
1428 return 'UNDEF' unless defined $data;
1430 # blessed objects are treated like scalars
1431 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1433 return 'SCALAR' unless $ref;
1436 while ($ref eq 'REF') {
1438 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1442 return ($ref||'SCALAR') . ('REF' x $n_steps);
1446 my ($self, $data) = @_;
1447 my @try = ($self->_refkind($data));
1448 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1449 push @try, 'FALLBACK';
1453 sub _METHOD_FOR_refkind {
1454 my ($self, $meth_prefix, $data) = @_;
1457 for (@{$self->_try_refkind($data)}) {
1458 $method = $self->can($meth_prefix."_".$_)
1462 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1466 sub _SWITCH_refkind {
1467 my ($self, $data, $dispatch_table) = @_;
1470 for (@{$self->_try_refkind($data)}) {
1471 $coderef = $dispatch_table->{$_}
1475 puke "no dispatch entry for ".$self->_refkind($data)
1484 #======================================================================
1485 # VALUES, GENERATE, AUTOLOAD
1486 #======================================================================
1488 # LDNOTE: original code from nwiger, didn't touch code in that section
1489 # I feel the AUTOLOAD stuff should not be the default, it should
1490 # only be activated on explicit demand by user.
1494 my $data = shift || return;
1495 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1496 unless ref $data eq 'HASH';
1499 foreach my $k (sort keys %$data) {
1500 my $v = $data->{$k};
1501 $self->_SWITCH_refkind($v, {
1503 if ($self->{array_datatypes}) { # array datatype
1504 push @all_bind, $self->_bindtype($k, $v);
1506 else { # literal SQL with bind
1507 my ($sql, @bind) = @$v;
1508 $self->_assert_bindval_matches_bindtype(@bind);
1509 push @all_bind, @bind;
1512 ARRAYREFREF => sub { # literal SQL with bind
1513 my ($sql, @bind) = @${$v};
1514 $self->_assert_bindval_matches_bindtype(@bind);
1515 push @all_bind, @bind;
1517 SCALARREF => sub { # literal SQL without bind
1519 SCALAR_or_UNDEF => sub {
1520 push @all_bind, $self->_bindtype($k, $v);
1531 my(@sql, @sqlq, @sqlv);
1535 if ($ref eq 'HASH') {
1536 for my $k (sort keys %$_) {
1539 my $label = $self->_quote($k);
1540 if ($r eq 'ARRAY') {
1541 # literal SQL with bind
1542 my ($sql, @bind) = @$v;
1543 $self->_assert_bindval_matches_bindtype(@bind);
1544 push @sqlq, "$label = $sql";
1546 } elsif ($r eq 'SCALAR') {
1547 # literal SQL without bind
1548 push @sqlq, "$label = $$v";
1550 push @sqlq, "$label = ?";
1551 push @sqlv, $self->_bindtype($k, $v);
1554 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1555 } elsif ($ref eq 'ARRAY') {
1556 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1559 if ($r eq 'ARRAY') { # literal SQL with bind
1560 my ($sql, @bind) = @$v;
1561 $self->_assert_bindval_matches_bindtype(@bind);
1564 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1565 # embedded literal SQL
1572 push @sql, '(' . join(', ', @sqlq) . ')';
1573 } elsif ($ref eq 'SCALAR') {
1577 # strings get case twiddled
1578 push @sql, $self->_sqlcase($_);
1582 my $sql = join ' ', @sql;
1584 # this is pretty tricky
1585 # if ask for an array, return ($stmt, @bind)
1586 # otherwise, s/?/shift @sqlv/ to put it inline
1588 return ($sql, @sqlv);
1590 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1591 ref $d ? $d->[1] : $d/e;
1600 # This allows us to check for a local, then _form, attr
1602 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1603 return $self->generate($name, @_);
1614 SQL::Abstract - Generate SQL from Perl data structures
1620 my $sql = SQL::Abstract->new;
1622 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1624 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1626 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1628 my($stmt, @bind) = $sql->delete($table, \%where);
1630 # Then, use these in your DBI statements
1631 my $sth = $dbh->prepare($stmt);
1632 $sth->execute(@bind);
1634 # Just generate the WHERE clause
1635 my($stmt, @bind) = $sql->where(\%where, $order);
1637 # Return values in the same order, for hashed queries
1638 # See PERFORMANCE section for more details
1639 my @bind = $sql->values(\%fieldvals);
1643 This module was inspired by the excellent L<DBIx::Abstract>.
1644 However, in using that module I found that what I really wanted
1645 to do was generate SQL, but still retain complete control over my
1646 statement handles and use the DBI interface. So, I set out to
1647 create an abstract SQL generation module.
1649 While based on the concepts used by L<DBIx::Abstract>, there are
1650 several important differences, especially when it comes to WHERE
1651 clauses. I have modified the concepts used to make the SQL easier
1652 to generate from Perl data structures and, IMO, more intuitive.
1653 The underlying idea is for this module to do what you mean, based
1654 on the data structures you provide it. The big advantage is that
1655 you don't have to modify your code every time your data changes,
1656 as this module figures it out.
1658 To begin with, an SQL INSERT is as easy as just specifying a hash
1659 of C<key=value> pairs:
1662 name => 'Jimbo Bobson',
1663 phone => '123-456-7890',
1664 address => '42 Sister Lane',
1665 city => 'St. Louis',
1666 state => 'Louisiana',
1669 The SQL can then be generated with this:
1671 my($stmt, @bind) = $sql->insert('people', \%data);
1673 Which would give you something like this:
1675 $stmt = "INSERT INTO people
1676 (address, city, name, phone, state)
1677 VALUES (?, ?, ?, ?, ?)";
1678 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1679 '123-456-7890', 'Louisiana');
1681 These are then used directly in your DBI code:
1683 my $sth = $dbh->prepare($stmt);
1684 $sth->execute(@bind);
1686 =head2 Inserting and Updating Arrays
1688 If your database has array types (like for example Postgres),
1689 activate the special option C<< array_datatypes => 1 >>
1690 when creating the C<SQL::Abstract> object.
1691 Then you may use an arrayref to insert and update database array types:
1693 my $sql = SQL::Abstract->new(array_datatypes => 1);
1695 planets => [qw/Mercury Venus Earth Mars/]
1698 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1702 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1704 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1707 =head2 Inserting and Updating SQL
1709 In order to apply SQL functions to elements of your C<%data> you may
1710 specify a reference to an arrayref for the given hash value. For example,
1711 if you need to execute the Oracle C<to_date> function on a value, you can
1712 say something like this:
1716 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1719 The first value in the array is the actual SQL. Any other values are
1720 optional and would be included in the bind values array. This gives
1723 my($stmt, @bind) = $sql->insert('people', \%data);
1725 $stmt = "INSERT INTO people (name, date_entered)
1726 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1727 @bind = ('Bill', '03/02/2003');
1729 An UPDATE is just as easy, all you change is the name of the function:
1731 my($stmt, @bind) = $sql->update('people', \%data);
1733 Notice that your C<%data> isn't touched; the module will generate
1734 the appropriately quirky SQL for you automatically. Usually you'll
1735 want to specify a WHERE clause for your UPDATE, though, which is
1736 where handling C<%where> hashes comes in handy...
1738 =head2 Complex where statements
1740 This module can generate pretty complicated WHERE statements
1741 easily. For example, simple C<key=value> pairs are taken to mean
1742 equality, and if you want to see if a field is within a set
1743 of values, you can use an arrayref. Let's say we wanted to
1744 SELECT some data based on this criteria:
1747 requestor => 'inna',
1748 worker => ['nwiger', 'rcwe', 'sfz'],
1749 status => { '!=', 'completed' }
1752 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1754 The above would give you something like this:
1756 $stmt = "SELECT * FROM tickets WHERE
1757 ( requestor = ? ) AND ( status != ? )
1758 AND ( worker = ? OR worker = ? OR worker = ? )";
1759 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1761 Which you could then use in DBI code like so:
1763 my $sth = $dbh->prepare($stmt);
1764 $sth->execute(@bind);
1770 The methods are simple. There's one for every major SQL operation,
1771 and a constructor you use first. The arguments are specified in a
1772 similar order for each method (table, then fields, then a where
1773 clause) to try and simplify things.
1775 =head2 new(option => 'value')
1777 The C<new()> function takes a list of options and values, and returns
1778 a new B<SQL::Abstract> object which can then be used to generate SQL
1779 through the methods below. The options accepted are:
1785 If set to 'lower', then SQL will be generated in all lowercase. By
1786 default SQL is generated in "textbook" case meaning something like:
1788 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1790 Any setting other than 'lower' is ignored.
1794 This determines what the default comparison operator is. By default
1795 it is C<=>, meaning that a hash like this:
1797 %where = (name => 'nwiger', email => 'nate@wiger.org');
1799 Will generate SQL like this:
1801 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1803 However, you may want loose comparisons by default, so if you set
1804 C<cmp> to C<like> you would get SQL such as:
1806 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1808 You can also override the comparison on an individual basis - see
1809 the huge section on L</"WHERE CLAUSES"> at the bottom.
1811 =item sqltrue, sqlfalse
1813 Expressions for inserting boolean values within SQL statements.
1814 By default these are C<1=1> and C<1=0>. They are used
1815 by the special operators C<-in> and C<-not_in> for generating
1816 correct SQL even when the argument is an empty array (see below).
1820 This determines the default logical operator for multiple WHERE
1821 statements in arrays or hashes. If absent, the default logic is "or"
1822 for arrays, and "and" for hashes. This means that a WHERE
1826 event_date => {'>=', '2/13/99'},
1827 event_date => {'<=', '4/24/03'},
1830 will generate SQL like this:
1832 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1834 This is probably not what you want given this query, though (look
1835 at the dates). To change the "OR" to an "AND", simply specify:
1837 my $sql = SQL::Abstract->new(logic => 'and');
1839 Which will change the above C<WHERE> to:
1841 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1843 The logic can also be changed locally by inserting
1844 a modifier in front of an arrayref:
1846 @where = (-and => [event_date => {'>=', '2/13/99'},
1847 event_date => {'<=', '4/24/03'} ]);
1849 See the L</"WHERE CLAUSES"> section for explanations.
1853 This will automatically convert comparisons using the specified SQL
1854 function for both column and value. This is mostly used with an argument
1855 of C<upper> or C<lower>, so that the SQL will have the effect of
1856 case-insensitive "searches". For example, this:
1858 $sql = SQL::Abstract->new(convert => 'upper');
1859 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1861 Will turn out the following SQL:
1863 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1865 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1866 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1867 not validate this option; it will just pass through what you specify verbatim).
1871 This is a kludge because many databases suck. For example, you can't
1872 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1873 Instead, you have to use C<bind_param()>:
1875 $sth->bind_param(1, 'reg data');
1876 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1878 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1879 which loses track of which field each slot refers to. Fear not.
1881 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1882 Currently, you can specify either C<normal> (default) or C<columns>. If you
1883 specify C<columns>, you will get an array that looks like this:
1885 my $sql = SQL::Abstract->new(bindtype => 'columns');
1886 my($stmt, @bind) = $sql->insert(...);
1889 [ 'column1', 'value1' ],
1890 [ 'column2', 'value2' ],
1891 [ 'column3', 'value3' ],
1894 You can then iterate through this manually, using DBI's C<bind_param()>.
1896 $sth->prepare($stmt);
1899 my($col, $data) = @$_;
1900 if ($col eq 'details' || $col eq 'comments') {
1901 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1902 } elsif ($col eq 'image') {
1903 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1905 $sth->bind_param($i, $data);
1909 $sth->execute; # execute without @bind now
1911 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1912 Basically, the advantage is still that you don't have to care which fields
1913 are or are not included. You could wrap that above C<for> loop in a simple
1914 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1915 get a layer of abstraction over manual SQL specification.
1917 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1918 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1919 will expect the bind values in this format.
1923 This is the character that a table or column name will be quoted
1924 with. By default this is an empty string, but you could set it to
1925 the character C<`>, to generate SQL like this:
1927 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1929 Alternatively, you can supply an array ref of two items, the first being the left
1930 hand quote character, and the second the right hand quote character. For
1931 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1932 that generates SQL like this:
1934 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1936 Quoting is useful if you have tables or columns names that are reserved
1937 words in your database's SQL dialect.
1941 This is the character that will be used to escape L</quote_char>s appearing
1942 in an identifier before it has been quoted.
1944 The parameter default in case of a single L</quote_char> character is the quote
1947 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1948 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1949 of the B<opening (left)> L</quote_char> within the identifier are currently left
1950 untouched. The default for opening-closing-style quotes may change in future
1951 versions, thus you are B<strongly encouraged> to specify the escape character
1956 This is the character that separates a table and column name. It is
1957 necessary to specify this when the C<quote_char> option is selected,
1958 so that tables and column names can be individually quoted like this:
1960 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1962 =item injection_guard
1964 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1965 column name specified in a query structure. This is a safety mechanism to avoid
1966 injection attacks when mishandling user input e.g.:
1968 my %condition_as_column_value_pairs = get_values_from_user();
1969 $sqla->select( ... , \%condition_as_column_value_pairs );
1971 If the expression matches an exception is thrown. Note that literal SQL
1972 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1974 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1976 =item array_datatypes
1978 When this option is true, arrayrefs in INSERT or UPDATE are
1979 interpreted as array datatypes and are passed directly
1981 When this option is false, arrayrefs are interpreted
1982 as literal SQL, just like refs to arrayrefs
1983 (but this behavior is for backwards compatibility; when writing
1984 new queries, use the "reference to arrayref" syntax
1990 Takes a reference to a list of "special operators"
1991 to extend the syntax understood by L<SQL::Abstract>.
1992 See section L</"SPECIAL OPERATORS"> for details.
1996 Takes a reference to a list of "unary operators"
1997 to extend the syntax understood by L<SQL::Abstract>.
1998 See section L</"UNARY OPERATORS"> for details.
2004 =head2 insert($table, \@values || \%fieldvals, \%options)
2006 This is the simplest function. You simply give it a table name
2007 and either an arrayref of values or hashref of field/value pairs.
2008 It returns an SQL INSERT statement and a list of bind values.
2009 See the sections on L</"Inserting and Updating Arrays"> and
2010 L</"Inserting and Updating SQL"> for information on how to insert
2011 with those data types.
2013 The optional C<\%options> hash reference may contain additional
2014 options to generate the insert SQL. Currently supported options
2021 Takes either a scalar of raw SQL fields, or an array reference of
2022 field names, and adds on an SQL C<RETURNING> statement at the end.
2023 This allows you to return data generated by the insert statement
2024 (such as row IDs) without performing another C<SELECT> statement.
2025 Note, however, this is not part of the SQL standard and may not
2026 be supported by all database engines.
2030 =head2 update($table, \%fieldvals, \%where, \%options)
2032 This takes a table, hashref of field/value pairs, and an optional
2033 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2035 See the sections on L</"Inserting and Updating Arrays"> and
2036 L</"Inserting and Updating SQL"> for information on how to insert
2037 with those data types.
2039 The optional C<\%options> hash reference may contain additional
2040 options to generate the update SQL. Currently supported options
2047 See the C<returning> option to
2048 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2052 =head2 select($source, $fields, $where, $order)
2054 This returns a SQL SELECT statement and associated list of bind values, as
2055 specified by the arguments:
2061 Specification of the 'FROM' part of the statement.
2062 The argument can be either a plain scalar (interpreted as a table
2063 name, will be quoted), or an arrayref (interpreted as a list
2064 of table names, joined by commas, quoted), or a scalarref
2065 (literal SQL, not quoted).
2069 Specification of the list of fields to retrieve from
2071 The argument can be either an arrayref (interpreted as a list
2072 of field names, will be joined by commas and quoted), or a
2073 plain scalar (literal SQL, not quoted).
2074 Please observe that this API is not as flexible as that of
2075 the first argument C<$source>, for backwards compatibility reasons.
2079 Optional argument to specify the WHERE part of the query.
2080 The argument is most often a hashref, but can also be
2081 an arrayref or plain scalar --
2082 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2086 Optional argument to specify the ORDER BY part of the query.
2087 The argument can be a scalar, a hashref or an arrayref
2088 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2094 =head2 delete($table, \%where, \%options)
2096 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2097 It returns an SQL DELETE statement and list of bind values.
2099 The optional C<\%options> hash reference may contain additional
2100 options to generate the delete SQL. Currently supported options
2107 See the C<returning> option to
2108 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2112 =head2 where(\%where, $order)
2114 This is used to generate just the WHERE clause. For example,
2115 if you have an arbitrary data structure and know what the
2116 rest of your SQL is going to look like, but want an easy way
2117 to produce a WHERE clause, use this. It returns an SQL WHERE
2118 clause and list of bind values.
2121 =head2 values(\%data)
2123 This just returns the values from the hash C<%data>, in the same
2124 order that would be returned from any of the other above queries.
2125 Using this allows you to markedly speed up your queries if you
2126 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2128 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2130 Warning: This is an experimental method and subject to change.
2132 This returns arbitrarily generated SQL. It's a really basic shortcut.
2133 It will return two different things, depending on return context:
2135 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2136 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2138 These would return the following:
2140 # First calling form
2141 $stmt = "CREATE TABLE test (?, ?)";
2142 @bind = (field1, field2);
2144 # Second calling form
2145 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2147 Depending on what you're trying to do, it's up to you to choose the correct
2148 format. In this example, the second form is what you would want.
2152 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2156 ALTER SESSION SET nls_date_format = 'MM/YY'
2158 You get the idea. Strings get their case twiddled, but everything
2159 else remains verbatim.
2161 =head1 EXPORTABLE FUNCTIONS
2163 =head2 is_plain_value
2165 Determines if the supplied argument is a plain value as understood by this
2170 =item * The value is C<undef>
2172 =item * The value is a non-reference
2174 =item * The value is an object with stringification overloading
2176 =item * The value is of the form C<< { -value => $anything } >>
2180 On failure returns C<undef>, on success returns a B<scalar> reference
2181 to the original supplied argument.
2187 The stringification overloading detection is rather advanced: it takes
2188 into consideration not only the presence of a C<""> overload, but if that
2189 fails also checks for enabled
2190 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2191 on either C<0+> or C<bool>.
2193 Unfortunately testing in the field indicates that this
2194 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2195 but only when very large numbers of stringifying objects are involved.
2196 At the time of writing ( Sep 2014 ) there is no clear explanation of
2197 the direct cause, nor is there a manageably small test case that reliably
2198 reproduces the problem.
2200 If you encounter any of the following exceptions in B<random places within
2201 your application stack> - this module may be to blame:
2203 Operation "ne": no method found,
2204 left argument in overloaded package <something>,
2205 right argument in overloaded package <something>
2209 Stub found while resolving method "???" overloading """" in package <something>
2211 If you fall victim to the above - please attempt to reduce the problem
2212 to something that could be sent to the L<SQL::Abstract developers
2213 |DBIx::Class/GETTING HELP/SUPPORT>
2214 (either publicly or privately). As a workaround in the meantime you can
2215 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2216 value, which will most likely eliminate your problem (at the expense of
2217 not being able to properly detect exotic forms of stringification).
2219 This notice and environment variable will be removed in a future version,
2220 as soon as the underlying problem is found and a reliable workaround is
2225 =head2 is_literal_value
2227 Determines if the supplied argument is a literal value as understood by this
2232 =item * C<\$sql_string>
2234 =item * C<\[ $sql_string, @bind_values ]>
2238 On failure returns C<undef>, on success returns an B<array> reference
2239 containing the unpacked version of the supplied literal SQL and bind values.
2241 =head1 WHERE CLAUSES
2245 This module uses a variation on the idea from L<DBIx::Abstract>. It
2246 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2247 module is that things in arrays are OR'ed, and things in hashes
2250 The easiest way to explain is to show lots of examples. After
2251 each C<%where> hash shown, it is assumed you used:
2253 my($stmt, @bind) = $sql->where(\%where);
2255 However, note that the C<%where> hash can be used directly in any
2256 of the other functions as well, as described above.
2258 =head2 Key-value pairs
2260 So, let's get started. To begin, a simple hash:
2264 status => 'completed'
2267 Is converted to SQL C<key = val> statements:
2269 $stmt = "WHERE user = ? AND status = ?";
2270 @bind = ('nwiger', 'completed');
2272 One common thing I end up doing is having a list of values that
2273 a field can be in. To do this, simply specify a list inside of
2278 status => ['assigned', 'in-progress', 'pending'];
2281 This simple code will create the following:
2283 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2284 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2286 A field associated to an empty arrayref will be considered a
2287 logical false and will generate 0=1.
2289 =head2 Tests for NULL values
2291 If the value part is C<undef> then this is converted to SQL <IS NULL>
2300 $stmt = "WHERE user = ? AND status IS NULL";
2303 To test if a column IS NOT NULL:
2307 status => { '!=', undef },
2310 =head2 Specific comparison operators
2312 If you want to specify a different type of operator for your comparison,
2313 you can use a hashref for a given column:
2317 status => { '!=', 'completed' }
2320 Which would generate:
2322 $stmt = "WHERE user = ? AND status != ?";
2323 @bind = ('nwiger', 'completed');
2325 To test against multiple values, just enclose the values in an arrayref:
2327 status => { '=', ['assigned', 'in-progress', 'pending'] };
2329 Which would give you:
2331 "WHERE status = ? OR status = ? OR status = ?"
2334 The hashref can also contain multiple pairs, in which case it is expanded
2335 into an C<AND> of its elements:
2339 status => { '!=', 'completed', -not_like => 'pending%' }
2342 # Or more dynamically, like from a form
2343 $where{user} = 'nwiger';
2344 $where{status}{'!='} = 'completed';
2345 $where{status}{'-not_like'} = 'pending%';
2347 # Both generate this
2348 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2349 @bind = ('nwiger', 'completed', 'pending%');
2352 To get an OR instead, you can combine it with the arrayref idea:
2356 priority => [ { '=', 2 }, { '>', 5 } ]
2359 Which would generate:
2361 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2362 @bind = ('2', '5', 'nwiger');
2364 If you want to include literal SQL (with or without bind values), just use a
2365 scalar reference or reference to an arrayref as the value:
2368 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2369 date_expires => { '<' => \"now()" }
2372 Which would generate:
2374 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2375 @bind = ('11/26/2008');
2378 =head2 Logic and nesting operators
2380 In the example above,
2381 there is a subtle trap if you want to say something like
2382 this (notice the C<AND>):
2384 WHERE priority != ? AND priority != ?
2386 Because, in Perl you I<can't> do this:
2388 priority => { '!=' => 2, '!=' => 1 }
2390 As the second C<!=> key will obliterate the first. The solution
2391 is to use the special C<-modifier> form inside an arrayref:
2393 priority => [ -and => {'!=', 2},
2397 Normally, these would be joined by C<OR>, but the modifier tells it
2398 to use C<AND> instead. (Hint: You can use this in conjunction with the
2399 C<logic> option to C<new()> in order to change the way your queries
2400 work by default.) B<Important:> Note that the C<-modifier> goes
2401 B<INSIDE> the arrayref, as an extra first element. This will
2402 B<NOT> do what you think it might:
2404 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2406 Here is a quick list of equivalencies, since there is some overlap:
2409 status => {'!=', 'completed', 'not like', 'pending%' }
2410 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2413 status => {'=', ['assigned', 'in-progress']}
2414 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2415 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2419 =head2 Special operators: IN, BETWEEN, etc.
2421 You can also use the hashref format to compare a list of fields using the
2422 C<IN> comparison operator, by specifying the list as an arrayref:
2425 status => 'completed',
2426 reportid => { -in => [567, 2335, 2] }
2429 Which would generate:
2431 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2432 @bind = ('completed', '567', '2335', '2');
2434 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2437 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2438 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2439 'sqltrue' (by default: C<1=1>).
2441 In addition to the array you can supply a chunk of literal sql or
2442 literal sql with bind:
2445 customer => { -in => \[
2446 'SELECT cust_id FROM cust WHERE balance > ?',
2449 status => { -in => \'SELECT status_codes FROM states' },
2455 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2456 AND status IN ( SELECT status_codes FROM states )
2460 Finally, if the argument to C<-in> is not a reference, it will be
2461 treated as a single-element array.
2463 Another pair of operators is C<-between> and C<-not_between>,
2464 used with an arrayref of two values:
2468 completion_date => {
2469 -not_between => ['2002-10-01', '2003-02-06']
2475 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2477 Just like with C<-in> all plausible combinations of literal SQL
2481 start0 => { -between => [ 1, 2 ] },
2482 start1 => { -between => \["? AND ?", 1, 2] },
2483 start2 => { -between => \"lower(x) AND upper(y)" },
2484 start3 => { -between => [
2486 \["upper(?)", 'stuff' ],
2493 ( start0 BETWEEN ? AND ? )
2494 AND ( start1 BETWEEN ? AND ? )
2495 AND ( start2 BETWEEN lower(x) AND upper(y) )
2496 AND ( start3 BETWEEN lower(x) AND upper(?) )
2498 @bind = (1, 2, 1, 2, 'stuff');
2501 These are the two builtin "special operators"; but the
2502 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2504 =head2 Unary operators: bool
2506 If you wish to test against boolean columns or functions within your
2507 database you can use the C<-bool> and C<-not_bool> operators. For
2508 example to test the column C<is_user> being true and the column
2509 C<is_enabled> being false you would use:-
2513 -not_bool => 'is_enabled',
2518 WHERE is_user AND NOT is_enabled
2520 If a more complex combination is required, testing more conditions,
2521 then you should use the and/or operators:-
2526 -not_bool => { two=> { -rlike => 'bar' } },
2527 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2538 (NOT ( three = ? OR three > ? ))
2541 =head2 Nested conditions, -and/-or prefixes
2543 So far, we've seen how multiple conditions are joined with a top-level
2544 C<AND>. We can change this by putting the different conditions we want in
2545 hashes and then putting those hashes in an array. For example:
2550 status => { -like => ['pending%', 'dispatched'] },
2554 status => 'unassigned',
2558 This data structure would create the following:
2560 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2561 OR ( user = ? AND status = ? ) )";
2562 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2565 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2566 to change the logic inside:
2572 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2573 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2580 $stmt = "WHERE ( user = ?
2581 AND ( ( workhrs > ? AND geo = ? )
2582 OR ( workhrs < ? OR geo = ? ) ) )";
2583 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2585 =head3 Algebraic inconsistency, for historical reasons
2587 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2588 operator goes C<outside> of the nested structure; whereas when connecting
2589 several constraints on one column, the C<-and> operator goes
2590 C<inside> the arrayref. Here is an example combining both features:
2593 -and => [a => 1, b => 2],
2594 -or => [c => 3, d => 4],
2595 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2600 WHERE ( ( ( a = ? AND b = ? )
2601 OR ( c = ? OR d = ? )
2602 OR ( e LIKE ? AND e LIKE ? ) ) )
2604 This difference in syntax is unfortunate but must be preserved for
2605 historical reasons. So be careful: the two examples below would
2606 seem algebraically equivalent, but they are not
2609 { -like => 'foo%' },
2610 { -like => '%bar' },
2612 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2615 { col => { -like => 'foo%' } },
2616 { col => { -like => '%bar' } },
2618 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2621 =head2 Literal SQL and value type operators
2623 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2624 side" is a column name and the "right side" is a value (normally rendered as
2625 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2626 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2627 alter this behavior. There are several ways of doing so.
2631 This is a virtual operator that signals the string to its right side is an
2632 identifier (a column name) and not a value. For example to compare two
2633 columns you would write:
2636 priority => { '<', 2 },
2637 requestor => { -ident => 'submitter' },
2642 $stmt = "WHERE priority < ? AND requestor = submitter";
2645 If you are maintaining legacy code you may see a different construct as
2646 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2651 This is a virtual operator that signals that the construct to its right side
2652 is a value to be passed to DBI. This is for example necessary when you want
2653 to write a where clause against an array (for RDBMS that support such
2654 datatypes). For example:
2657 array => { -value => [1, 2, 3] }
2662 $stmt = 'WHERE array = ?';
2663 @bind = ([1, 2, 3]);
2665 Note that if you were to simply say:
2671 the result would probably not be what you wanted:
2673 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2678 Finally, sometimes only literal SQL will do. To include a random snippet
2679 of SQL verbatim, you specify it as a scalar reference. Consider this only
2680 as a last resort. Usually there is a better way. For example:
2683 priority => { '<', 2 },
2684 requestor => { -in => \'(SELECT name FROM hitmen)' },
2689 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2692 Note that in this example, you only get one bind parameter back, since
2693 the verbatim SQL is passed as part of the statement.
2697 Never use untrusted input as a literal SQL argument - this is a massive
2698 security risk (there is no way to check literal snippets for SQL
2699 injections and other nastyness). If you need to deal with untrusted input
2700 use literal SQL with placeholders as described next.
2702 =head3 Literal SQL with placeholders and bind values (subqueries)
2704 If the literal SQL to be inserted has placeholders and bind values,
2705 use a reference to an arrayref (yes this is a double reference --
2706 not so common, but perfectly legal Perl). For example, to find a date
2707 in Postgres you can use something like this:
2710 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2715 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2718 Note that you must pass the bind values in the same format as they are returned
2719 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2720 to C<columns>, you must provide the bind values in the
2721 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2722 scalar value; most commonly the column name, but you can use any scalar value
2723 (including references and blessed references), L<SQL::Abstract> will simply
2724 pass it through intact. So if C<bindtype> is set to C<columns> the above
2725 example will look like:
2728 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2731 Literal SQL is especially useful for nesting parenthesized clauses in the
2732 main SQL query. Here is a first example:
2734 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2738 bar => \["IN ($sub_stmt)" => @sub_bind],
2743 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2744 WHERE c2 < ? AND c3 LIKE ?))";
2745 @bind = (1234, 100, "foo%");
2747 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2748 are expressed in the same way. Of course the C<$sub_stmt> and
2749 its associated bind values can be generated through a former call
2752 my ($sub_stmt, @sub_bind)
2753 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2754 c3 => {-like => "foo%"}});
2757 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2760 In the examples above, the subquery was used as an operator on a column;
2761 but the same principle also applies for a clause within the main C<%where>
2762 hash, like an EXISTS subquery:
2764 my ($sub_stmt, @sub_bind)
2765 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2766 my %where = ( -and => [
2768 \["EXISTS ($sub_stmt)" => @sub_bind],
2773 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2774 WHERE c1 = ? AND c2 > t0.c0))";
2778 Observe that the condition on C<c2> in the subquery refers to
2779 column C<t0.c0> of the main query: this is I<not> a bind
2780 value, so we have to express it through a scalar ref.
2781 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2782 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2783 what we wanted here.
2785 Finally, here is an example where a subquery is used
2786 for expressing unary negation:
2788 my ($sub_stmt, @sub_bind)
2789 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2790 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2792 lname => {like => '%son%'},
2793 \["NOT ($sub_stmt)" => @sub_bind],
2798 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2799 @bind = ('%son%', 10, 20)
2801 =head3 Deprecated usage of Literal SQL
2803 Below are some examples of archaic use of literal SQL. It is shown only as
2804 reference for those who deal with legacy code. Each example has a much
2805 better, cleaner and safer alternative that users should opt for in new code.
2811 my %where = ( requestor => \'IS NOT NULL' )
2813 $stmt = "WHERE requestor IS NOT NULL"
2815 This used to be the way of generating NULL comparisons, before the handling
2816 of C<undef> got formalized. For new code please use the superior syntax as
2817 described in L</Tests for NULL values>.
2821 my %where = ( requestor => \'= submitter' )
2823 $stmt = "WHERE requestor = submitter"
2825 This used to be the only way to compare columns. Use the superior L</-ident>
2826 method for all new code. For example an identifier declared in such a way
2827 will be properly quoted if L</quote_char> is properly set, while the legacy
2828 form will remain as supplied.
2832 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2834 $stmt = "WHERE completed > ? AND is_ready"
2835 @bind = ('2012-12-21')
2837 Using an empty string literal used to be the only way to express a boolean.
2838 For all new code please use the much more readable
2839 L<-bool|/Unary operators: bool> operator.
2845 These pages could go on for a while, since the nesting of the data
2846 structures this module can handle are pretty much unlimited (the
2847 module implements the C<WHERE> expansion as a recursive function
2848 internally). Your best bet is to "play around" with the module a
2849 little to see how the data structures behave, and choose the best
2850 format for your data based on that.
2852 And of course, all the values above will probably be replaced with
2853 variables gotten from forms or the command line. After all, if you
2854 knew everything ahead of time, you wouldn't have to worry about
2855 dynamically-generating SQL and could just hardwire it into your
2858 =head1 ORDER BY CLAUSES
2860 Some functions take an order by clause. This can either be a scalar (just a
2861 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2862 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2865 Given | Will Generate
2866 ---------------------------------------------------------------
2868 'colA' | ORDER BY colA
2870 [qw/colA colB/] | ORDER BY colA, colB
2872 {-asc => 'colA'} | ORDER BY colA ASC
2874 {-desc => 'colB'} | ORDER BY colB DESC
2876 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2878 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2880 \'colA DESC' | ORDER BY colA DESC
2882 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2883 | /* ...with $x bound to ? */
2886 { -asc => 'colA' }, | colA ASC,
2887 { -desc => [qw/colB/] }, | colB DESC,
2888 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2889 \'colE DESC', | colE DESC,
2890 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2891 ] | /* ...with $x bound to ? */
2892 ===============================================================
2896 =head1 SPECIAL OPERATORS
2898 my $sqlmaker = SQL::Abstract->new(special_ops => [
2902 my ($self, $field, $op, $arg) = @_;
2908 handler => 'method_name',
2912 A "special operator" is a SQL syntactic clause that can be
2913 applied to a field, instead of a usual binary operator.
2916 WHERE field IN (?, ?, ?)
2917 WHERE field BETWEEN ? AND ?
2918 WHERE MATCH(field) AGAINST (?, ?)
2920 Special operators IN and BETWEEN are fairly standard and therefore
2921 are builtin within C<SQL::Abstract> (as the overridable methods
2922 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2923 like the MATCH .. AGAINST example above which is specific to MySQL,
2924 you can write your own operator handlers - supply a C<special_ops>
2925 argument to the C<new> method. That argument takes an arrayref of
2926 operator definitions; each operator definition is a hashref with two
2933 the regular expression to match the operator
2937 Either a coderef or a plain scalar method name. In both cases
2938 the expected return is C<< ($sql, @bind) >>.
2940 When supplied with a method name, it is simply called on the
2941 L<SQL::Abstract> object as:
2943 $self->$method_name($field, $op, $arg)
2947 $field is the LHS of the operator
2948 $op is the part that matched the handler regex
2951 When supplied with a coderef, it is called as:
2953 $coderef->($self, $field, $op, $arg)
2958 For example, here is an implementation
2959 of the MATCH .. AGAINST syntax for MySQL
2961 my $sqlmaker = SQL::Abstract->new(special_ops => [
2963 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2964 {regex => qr/^match$/i,
2966 my ($self, $field, $op, $arg) = @_;
2967 $arg = [$arg] if not ref $arg;
2968 my $label = $self->_quote($field);
2969 my ($placeholder) = $self->_convert('?');
2970 my $placeholders = join ", ", (($placeholder) x @$arg);
2971 my $sql = $self->_sqlcase('match') . " ($label) "
2972 . $self->_sqlcase('against') . " ($placeholders) ";
2973 my @bind = $self->_bindtype($field, @$arg);
2974 return ($sql, @bind);
2981 =head1 UNARY OPERATORS
2983 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2987 my ($self, $op, $arg) = @_;
2993 handler => 'method_name',
2997 A "unary operator" is a SQL syntactic clause that can be
2998 applied to a field - the operator goes before the field
3000 You can write your own operator handlers - supply a C<unary_ops>
3001 argument to the C<new> method. That argument takes an arrayref of
3002 operator definitions; each operator definition is a hashref with two
3009 the regular expression to match the operator
3013 Either a coderef or a plain scalar method name. In both cases
3014 the expected return is C<< $sql >>.
3016 When supplied with a method name, it is simply called on the
3017 L<SQL::Abstract> object as:
3019 $self->$method_name($op, $arg)
3023 $op is the part that matched the handler regex
3024 $arg is the RHS or argument of the operator
3026 When supplied with a coderef, it is called as:
3028 $coderef->($self, $op, $arg)
3036 Thanks to some benchmarking by Mark Stosberg, it turns out that
3037 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3038 I must admit this wasn't an intentional design issue, but it's a
3039 byproduct of the fact that you get to control your C<DBI> handles
3042 To maximize performance, use a code snippet like the following:
3044 # prepare a statement handle using the first row
3045 # and then reuse it for the rest of the rows
3047 for my $href (@array_of_hashrefs) {
3048 $stmt ||= $sql->insert('table', $href);
3049 $sth ||= $dbh->prepare($stmt);
3050 $sth->execute($sql->values($href));
3053 The reason this works is because the keys in your C<$href> are sorted
3054 internally by B<SQL::Abstract>. Thus, as long as your data retains
3055 the same structure, you only have to generate the SQL the first time
3056 around. On subsequent queries, simply use the C<values> function provided
3057 by this module to return your values in the correct order.
3059 However this depends on the values having the same type - if, for
3060 example, the values of a where clause may either have values
3061 (resulting in sql of the form C<column = ?> with a single bind
3062 value), or alternatively the values might be C<undef> (resulting in
3063 sql of the form C<column IS NULL> with no bind value) then the
3064 caching technique suggested will not work.
3068 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3069 really like this part (I do, at least). Building up a complex query
3070 can be as simple as the following:
3077 use CGI::FormBuilder;
3080 my $form = CGI::FormBuilder->new(...);
3081 my $sql = SQL::Abstract->new;
3083 if ($form->submitted) {
3084 my $field = $form->field;
3085 my $id = delete $field->{id};
3086 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3089 Of course, you would still have to connect using C<DBI> to run the
3090 query, but the point is that if you make your form look like your
3091 table, the actual query script can be extremely simplistic.
3093 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3094 a fast interface to returning and formatting data. I frequently
3095 use these three modules together to write complex database query
3096 apps in under 50 lines.
3098 =head1 HOW TO CONTRIBUTE
3100 Contributions are always welcome, in all usable forms (we especially
3101 welcome documentation improvements). The delivery methods include git-
3102 or unified-diff formatted patches, GitHub pull requests, or plain bug
3103 reports either via RT or the Mailing list. Contributors are generally
3104 granted full access to the official repository after their first several
3105 patches pass successful review.
3107 This project is maintained in a git repository. The code and related tools are
3108 accessible at the following locations:
3112 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3114 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3116 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3118 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3124 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3125 Great care has been taken to preserve the I<published> behavior
3126 documented in previous versions in the 1.* family; however,
3127 some features that were previously undocumented, or behaved
3128 differently from the documentation, had to be changed in order
3129 to clarify the semantics. Hence, client code that was relying
3130 on some dark areas of C<SQL::Abstract> v1.*
3131 B<might behave differently> in v1.50.
3133 The main changes are:
3139 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3143 support for the { operator => \"..." } construct (to embed literal SQL)
3147 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3151 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3155 defensive programming: check arguments
3159 fixed bug with global logic, which was previously implemented
3160 through global variables yielding side-effects. Prior versions would
3161 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3162 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3163 Now this is interpreted
3164 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3169 fixed semantics of _bindtype on array args
3173 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3174 we just avoid shifting arrays within that tree.
3178 dropped the C<_modlogic> function
3182 =head1 ACKNOWLEDGEMENTS
3184 There are a number of individuals that have really helped out with
3185 this module. Unfortunately, most of them submitted bugs via CPAN
3186 so I have no idea who they are! But the people I do know are:
3188 Ash Berlin (order_by hash term support)
3189 Matt Trout (DBIx::Class support)
3190 Mark Stosberg (benchmarking)
3191 Chas Owens (initial "IN" operator support)
3192 Philip Collins (per-field SQL functions)
3193 Eric Kolve (hashref "AND" support)
3194 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3195 Dan Kubb (support for "quote_char" and "name_sep")
3196 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3197 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3198 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3199 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3200 Oliver Charles (support for "RETURNING" after "INSERT")
3206 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3210 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3212 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3214 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3215 While not an official support venue, C<DBIx::Class> makes heavy use of
3216 C<SQL::Abstract>, and as such list members there are very familiar with
3217 how to create queries.
3221 This module is free software; you may copy this under the same
3222 terms as perl itself (either the GNU General Public License or
3223 the Artistic License)