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/^ 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 s/^-(?=\w)//, s/ +/_/g for my $op = lc $k;
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 my $op = join(' ', split '_', $op);
722 # the old special op system requires illegality for top-level use
725 (our $Expand_Depth) == 1
726 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
728 puke "Illegal use of top-level '-$op'"
731 # the old unary op system means we should touch nothing and let it work
733 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
734 return { -op => [ $op, $v ] };
738 # an explicit node type is currently assumed to be expanded (this is almost
739 # certainly wrong and there should be expansion anyway)
741 if ($self->{render}{$k}) {
745 # hashref RHS values get expanded and used as op/func args
750 and (keys %$v)[0] =~ /^-/
752 my ($func) = $k =~ /^-(.*)$/;
754 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
755 return +{ -op => [ $func, $self->_expand_expr($v) ] };
758 return +{ -func => [ $func, $self->_expand_expr($v) ] };
761 # scalars and literals get simply expanded
763 if (!ref($v) or is_literal_value($v)) {
764 return +{ -op => [ $op, $self->_expand_expr($v) ] };
770 sub _expand_expr_hashpair_cmp {
771 my ($self, $k, $v) = @_;
772 $self->_expand_expr_hashtriple($k, $self->{cmp}, $v);
775 sub _expand_expr_hashtriple {
776 my ($self, $k, $vk, $vv) = @_;
778 my $ik = $self->_expand_ident(-ident => $k);
780 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
781 $self->_assert_pass_injection_guard($op);
782 if ($op =~ s/ [_\s]? \d+ $//x ) {
783 return $self->_expand_expr($k, { $vk, $vv });
785 if (my $x = $self->{expand_op}{$op}) {
786 local our $Cur_Col_Meta = $k;
787 return $self->$x($op, $vv, $k);
790 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
791 return { -op => [ $op, $ik, $vv ] };
793 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
797 { -op => [ $op, $vv ] }
801 if (ref($vv) eq 'ARRAY') {
803 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
804 ? shift @raw : '-or';
805 my @values = map +{ $vk => $_ }, @raw;
807 $op =~ $self->{inequality_op}
808 or $op =~ $self->{not_like_op}
810 if (lc($logic) eq '-or' and @values > 1) {
811 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
812 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
813 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
818 # try to DWIM on equality operators
819 return ($self->_dwim_op_to_is($op,
820 "Supplying an empty arrayref to '%s' is deprecated",
821 "operator '%s' applied on an empty array (field '$k')"
822 ) ? $self->sqlfalse : $self->sqltrue);
824 return $self->_expand_op_andor($logic => \@values, $k);
826 if (is_undef_value($vv)) {
827 my $is = ($self->_dwim_op_to_is($op,
828 "Supplying an undefined argument to '%s' is deprecated",
829 "unexpected operator '%s' with undef operand",
830 ) ? 'is' : 'is not');
832 return $self->_expand_expr_hashpair($k => { $is, undef });
834 local our $Cur_Col_Meta = $k;
838 $self->_expand_expr($vv)
843 my ($self, $op, $empty, $fail) = @_;
844 if ($op =~ /^not$/i) {
847 if ($op =~ $self->{equality_op}) {
850 if ($op =~ $self->{like_op}) {
851 belch(sprintf $empty, uc($op));
854 if ($op =~ $self->{inequality_op}) {
857 if ($op =~ $self->{not_like_op}) {
858 belch(sprintf $empty, uc($op));
861 puke(sprintf $fail, $op);
865 my ($self, $op, $body) = @_;
866 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
867 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
869 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
870 ref($body) ? @$body : $body;
871 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
872 unless ($self->{quote_char}) {
873 $self->_assert_pass_injection_guard($_) for @parts;
875 return +{ -ident => \@parts };
879 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
883 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
887 my ($self, undef, $v) = @_;
889 return $self->_expand_expr($v);
891 puke "-bool => undef not supported" unless defined($v);
892 return $self->_expand_ident(-ident => $v);
895 sub _expand_op_andor {
896 my ($self, $logic, $v, $k) = @_;
898 $v = [ map +{ $k, $_ },
900 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
904 my ($logop) = $logic =~ /^-?(.*)$/;
905 if (ref($v) eq 'HASH') {
906 return undef unless keys %$v;
909 map $self->_expand_expr({ $_ => $v->{$_} }),
913 if (ref($v) eq 'ARRAY') {
914 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
917 (ref($_) eq 'ARRAY' and @$_)
918 or (ref($_) eq 'HASH' and %$_)
924 while (my ($el) = splice @expr, 0, 1) {
925 puke "Supplying an empty left hand side argument is not supported in array-pairs"
926 unless defined($el) and length($el);
927 my $elref = ref($el);
929 local our $Expand_Depth = 0;
930 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
931 } elsif ($elref eq 'ARRAY') {
932 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
933 } elsif (my $l = is_literal_value($el)) {
934 push @res, { -literal => $l };
935 } elsif ($elref eq 'HASH') {
936 local our $Expand_Depth = 0;
937 push @res, grep defined, $self->_expand_expr($el) if %$el;
943 # return $res[0] if @res == 1;
944 return { -op => [ $logop, @res ] };
950 my ($self, $op, $vv, $k) = @_;
951 puke "$op can only take undef as argument"
955 and exists($vv->{-value})
956 and !defined($vv->{-value})
958 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
961 sub _expand_between {
962 my ($self, $op, $vv, $k) = @_;
963 local our $Cur_Col_Meta = $k;
964 my @rhs = map $self->_expand_expr($_),
965 ref($vv) eq 'ARRAY' ? @$vv : $vv;
967 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
969 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
971 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
975 $self->_expand_ident(-ident => $k),
981 my ($self, $op, $vv, $k) = @_;
982 if (my $literal = is_literal_value($vv)) {
983 my ($sql, @bind) = @$literal;
984 my $opened_sql = $self->_open_outer_paren($sql);
986 $op, $self->_expand_ident(-ident => $k),
987 [ { -literal => [ $opened_sql, @bind ] } ]
991 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
992 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
993 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
994 . 'will emit the logically correct SQL instead of raising this exception)'
996 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
998 my @rhs = map $self->_expand_expr($_),
999 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
1000 map { defined($_) ? $_: puke($undef_err) }
1001 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1002 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1006 $self->_expand_ident(-ident => $k),
1012 my ($self, $op, $v) = @_;
1013 # DBIx::Class requires a nest warning to be emitted once but the private
1014 # method it overrode to do so no longer exists
1015 if ($self->{is_dbic_sqlmaker}) {
1016 unless (our $Nest_Warned) {
1018 "-nest in search conditions is deprecated, you most probably wanted:\n"
1019 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1024 return $self->_expand_expr($v);
1027 sub _recurse_where {
1028 my ($self, $where, $logic) = @_;
1030 # Special case: top level simple string treated as literal
1032 my $where_exp = (ref($where)
1033 ? $self->_expand_expr($where, $logic)
1034 : { -literal => [ $where ] });
1036 # dispatch expanded expression
1038 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1039 # DBIx::Class used to call _recurse_where in scalar context
1040 # something else might too...
1042 return ($sql, @bind);
1045 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1051 my ($self, $ident) = @_;
1053 return $self->_convert($self->_quote($ident));
1057 my ($self, $list) = @_;
1058 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1059 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1063 my ($self, $rest) = @_;
1064 my ($func, @args) = @$rest;
1068 push @arg_sql, shift @x;
1070 } map [ $self->render_aqt($_) ], @args;
1071 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1075 my ($self, $bind) = @_;
1076 return ($self->_convert('?'), $self->_bindtype(@$bind));
1079 sub _render_literal {
1080 my ($self, $literal) = @_;
1081 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1086 my ($self, $v) = @_;
1087 my ($op, @args) = @$v;
1088 if (my $r = $self->{render_op}{$op}) {
1089 return $self->$r($op, \@args);
1094 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1095 if ($us and @args > 1) {
1096 puke "Special op '${op}' requires first value to be identifier"
1097 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1098 my $k = join(($self->{name_sep}||'.'), @$ident);
1099 local our $Expand_Depth = 1;
1100 return $self->${\($us->{handler})}($k, $op, $args[1]);
1102 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1103 return $self->${\($us->{handler})}($op, $args[0]);
1108 return $self->_render_unop_prefix($op, \@args);
1110 return $self->_render_op_multop($op, \@args);
1116 sub _render_op_between {
1117 my ($self, $op, $args) = @_;
1118 my ($left, $low, $high) = @$args;
1119 my ($rhsql, @rhbind) = do {
1121 puke "Single arg to between must be a literal"
1122 unless $low->{-literal};
1125 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1126 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1127 @{$l}[1..$#$l], @{$h}[1..$#$h])
1130 my ($lhsql, @lhbind) = $self->render_aqt($left);
1132 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1138 my ($self, $op, $args) = @_;
1139 my ($lhs, $rhs) = @$args;
1142 my ($sql, @bind) = $self->render_aqt($_);
1143 push @in_bind, @bind;
1146 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1148 $lhsql.' '.$self->_sqlcase($op).' ( '
1149 .join(', ', @in_sql)
1155 sub _render_op_andor {
1156 my ($self, $op, $args) = @_;
1157 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1158 return '' unless @parts;
1159 return @{$parts[0]} if @parts == 1;
1160 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1161 return '( '.$sql.' )', @bind;
1164 sub _render_op_multop {
1165 my ($self, $op, $args) = @_;
1166 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1167 return '' unless @parts;
1168 return @{$parts[0]} if @parts == 1;
1169 my ($final_sql) = join(
1170 ' '.$self->_sqlcase($op).' ',
1175 map @{$_}[1..$#$_], @parts
1178 sub _render_op_not {
1179 my ($self, $op, $v) = @_;
1180 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1181 return "(${sql})", @bind;
1184 sub _render_unop_prefix {
1185 my ($self, $op, $v) = @_;
1186 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1187 my $op_sql = $self->_sqlcase($op);
1188 return ("${op_sql} ${expr_sql}", @bind);
1191 sub _render_unop_postfix {
1192 my ($self, $op, $v) = @_;
1193 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1194 my $op_sql = $self->_sqlcase($op);
1195 return ($expr_sql.' '.$op_sql, @bind);
1198 # Some databases (SQLite) treat col IN (1, 2) different from
1199 # col IN ( (1, 2) ). Use this to strip all outer parens while
1200 # adding them back in the corresponding method
1201 sub _open_outer_paren {
1202 my ($self, $sql) = @_;
1204 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1206 # there are closing parens inside, need the heavy duty machinery
1207 # to reevaluate the extraction starting from $sql (full reevaluation)
1208 if ($inner =~ /\)/) {
1209 require Text::Balanced;
1211 my (undef, $remainder) = do {
1212 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1214 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1217 # the entire expression needs to be a balanced bracketed thing
1218 # (after an extract no remainder sans trailing space)
1219 last if defined $remainder and $remainder =~ /\S/;
1229 #======================================================================
1231 #======================================================================
1233 sub _expand_order_by {
1234 my ($self, $arg) = @_;
1236 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1238 my $expander = sub {
1239 my ($self, $dir, $expr) = @_;
1240 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1241 foreach my $arg (@to_expand) {
1245 and grep /^-(asc|desc)$/, keys %$arg
1247 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1251 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1253 map $self->expand_expr($_, -ident),
1254 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1255 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1258 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1260 return $self->$expander(undef, $arg);
1264 my ($self, $arg) = @_;
1266 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1268 my ($sql, @bind) = $self->render_aqt($expanded);
1270 return '' unless length($sql);
1272 my $final_sql = $self->_sqlcase(' order by ').$sql;
1274 return wantarray ? ($final_sql, @bind) : $final_sql;
1277 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1279 sub _order_by_chunks {
1280 my ($self, $arg) = @_;
1282 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1284 return $self->_chunkify_order_by($expanded);
1287 sub _chunkify_order_by {
1288 my ($self, $expanded) = @_;
1290 return grep length, $self->render_aqt($expanded)
1291 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1294 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1295 return map $self->_chunkify_order_by($_), @$l;
1297 return [ $self->render_aqt($_) ];
1301 #======================================================================
1302 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1303 #======================================================================
1309 $self->_expand_maybe_list_expr($from, undef, -ident)
1314 #======================================================================
1316 #======================================================================
1318 sub _expand_maybe_list_expr {
1319 my ($self, $expr, $logic, $default) = @_;
1321 if (ref($expr) eq 'ARRAY') {
1323 map $self->expand_expr($_, $default), @$expr
1330 return $self->expand_expr($e, $default);
1333 # highly optimized, as it's called way too often
1335 # my ($self, $label) = @_;
1337 return '' unless defined $_[1];
1338 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1339 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1341 unless ($_[0]->{quote_char}) {
1342 if (ref($_[1]) eq 'ARRAY') {
1343 return join($_[0]->{name_sep}||'.', @{$_[1]});
1345 $_[0]->_assert_pass_injection_guard($_[1]);
1350 my $qref = ref $_[0]->{quote_char};
1352 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1353 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1354 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1356 my $esc = $_[0]->{escape_char} || $r;
1358 # parts containing * are naturally unquoted
1360 $_[0]->{name_sep}||'',
1364 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1366 (ref($_[1]) eq 'ARRAY'
1370 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1378 # Conversion, if applicable
1380 #my ($self, $arg) = @_;
1381 if ($_[0]->{convert_where}) {
1382 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1389 #my ($self, $col, @vals) = @_;
1390 # called often - tighten code
1391 return $_[0]->{bindtype} eq 'columns'
1392 ? map {[$_[1], $_]} @_[2 .. $#_]
1397 # Dies if any element of @bind is not in [colname => value] format
1398 # if bindtype is 'columns'.
1399 sub _assert_bindval_matches_bindtype {
1400 # my ($self, @bind) = @_;
1402 if ($self->{bindtype} eq 'columns') {
1404 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1405 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1411 sub _join_sql_clauses {
1412 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1414 if (@$clauses_aref > 1) {
1415 my $join = " " . $self->_sqlcase($logic) . " ";
1416 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1417 return ($sql, @$bind_aref);
1419 elsif (@$clauses_aref) {
1420 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1423 return (); # if no SQL, ignore @$bind_aref
1428 # Fix SQL case, if so requested
1430 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1431 # don't touch the argument ... crooked logic, but let's not change it!
1432 return $_[0]->{case} ? $_[1] : uc($_[1]);
1436 #======================================================================
1437 # DISPATCHING FROM REFKIND
1438 #======================================================================
1441 my ($self, $data) = @_;
1443 return 'UNDEF' unless defined $data;
1445 # blessed objects are treated like scalars
1446 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1448 return 'SCALAR' unless $ref;
1451 while ($ref eq 'REF') {
1453 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1457 return ($ref||'SCALAR') . ('REF' x $n_steps);
1461 my ($self, $data) = @_;
1462 my @try = ($self->_refkind($data));
1463 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1464 push @try, 'FALLBACK';
1468 sub _METHOD_FOR_refkind {
1469 my ($self, $meth_prefix, $data) = @_;
1472 for (@{$self->_try_refkind($data)}) {
1473 $method = $self->can($meth_prefix."_".$_)
1477 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1481 sub _SWITCH_refkind {
1482 my ($self, $data, $dispatch_table) = @_;
1485 for (@{$self->_try_refkind($data)}) {
1486 $coderef = $dispatch_table->{$_}
1490 puke "no dispatch entry for ".$self->_refkind($data)
1499 #======================================================================
1500 # VALUES, GENERATE, AUTOLOAD
1501 #======================================================================
1503 # LDNOTE: original code from nwiger, didn't touch code in that section
1504 # I feel the AUTOLOAD stuff should not be the default, it should
1505 # only be activated on explicit demand by user.
1509 my $data = shift || return;
1510 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1511 unless ref $data eq 'HASH';
1514 foreach my $k (sort keys %$data) {
1515 my $v = $data->{$k};
1516 $self->_SWITCH_refkind($v, {
1518 if ($self->{array_datatypes}) { # array datatype
1519 push @all_bind, $self->_bindtype($k, $v);
1521 else { # literal SQL with bind
1522 my ($sql, @bind) = @$v;
1523 $self->_assert_bindval_matches_bindtype(@bind);
1524 push @all_bind, @bind;
1527 ARRAYREFREF => sub { # literal SQL with bind
1528 my ($sql, @bind) = @${$v};
1529 $self->_assert_bindval_matches_bindtype(@bind);
1530 push @all_bind, @bind;
1532 SCALARREF => sub { # literal SQL without bind
1534 SCALAR_or_UNDEF => sub {
1535 push @all_bind, $self->_bindtype($k, $v);
1546 my(@sql, @sqlq, @sqlv);
1550 if ($ref eq 'HASH') {
1551 for my $k (sort keys %$_) {
1554 my $label = $self->_quote($k);
1555 if ($r eq 'ARRAY') {
1556 # literal SQL with bind
1557 my ($sql, @bind) = @$v;
1558 $self->_assert_bindval_matches_bindtype(@bind);
1559 push @sqlq, "$label = $sql";
1561 } elsif ($r eq 'SCALAR') {
1562 # literal SQL without bind
1563 push @sqlq, "$label = $$v";
1565 push @sqlq, "$label = ?";
1566 push @sqlv, $self->_bindtype($k, $v);
1569 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1570 } elsif ($ref eq 'ARRAY') {
1571 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1574 if ($r eq 'ARRAY') { # literal SQL with bind
1575 my ($sql, @bind) = @$v;
1576 $self->_assert_bindval_matches_bindtype(@bind);
1579 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1580 # embedded literal SQL
1587 push @sql, '(' . join(', ', @sqlq) . ')';
1588 } elsif ($ref eq 'SCALAR') {
1592 # strings get case twiddled
1593 push @sql, $self->_sqlcase($_);
1597 my $sql = join ' ', @sql;
1599 # this is pretty tricky
1600 # if ask for an array, return ($stmt, @bind)
1601 # otherwise, s/?/shift @sqlv/ to put it inline
1603 return ($sql, @sqlv);
1605 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1606 ref $d ? $d->[1] : $d/e;
1615 # This allows us to check for a local, then _form, attr
1617 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1618 return $self->generate($name, @_);
1629 SQL::Abstract - Generate SQL from Perl data structures
1635 my $sql = SQL::Abstract->new;
1637 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1639 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1641 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1643 my($stmt, @bind) = $sql->delete($table, \%where);
1645 # Then, use these in your DBI statements
1646 my $sth = $dbh->prepare($stmt);
1647 $sth->execute(@bind);
1649 # Just generate the WHERE clause
1650 my($stmt, @bind) = $sql->where(\%where, $order);
1652 # Return values in the same order, for hashed queries
1653 # See PERFORMANCE section for more details
1654 my @bind = $sql->values(\%fieldvals);
1658 This module was inspired by the excellent L<DBIx::Abstract>.
1659 However, in using that module I found that what I really wanted
1660 to do was generate SQL, but still retain complete control over my
1661 statement handles and use the DBI interface. So, I set out to
1662 create an abstract SQL generation module.
1664 While based on the concepts used by L<DBIx::Abstract>, there are
1665 several important differences, especially when it comes to WHERE
1666 clauses. I have modified the concepts used to make the SQL easier
1667 to generate from Perl data structures and, IMO, more intuitive.
1668 The underlying idea is for this module to do what you mean, based
1669 on the data structures you provide it. The big advantage is that
1670 you don't have to modify your code every time your data changes,
1671 as this module figures it out.
1673 To begin with, an SQL INSERT is as easy as just specifying a hash
1674 of C<key=value> pairs:
1677 name => 'Jimbo Bobson',
1678 phone => '123-456-7890',
1679 address => '42 Sister Lane',
1680 city => 'St. Louis',
1681 state => 'Louisiana',
1684 The SQL can then be generated with this:
1686 my($stmt, @bind) = $sql->insert('people', \%data);
1688 Which would give you something like this:
1690 $stmt = "INSERT INTO people
1691 (address, city, name, phone, state)
1692 VALUES (?, ?, ?, ?, ?)";
1693 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1694 '123-456-7890', 'Louisiana');
1696 These are then used directly in your DBI code:
1698 my $sth = $dbh->prepare($stmt);
1699 $sth->execute(@bind);
1701 =head2 Inserting and Updating Arrays
1703 If your database has array types (like for example Postgres),
1704 activate the special option C<< array_datatypes => 1 >>
1705 when creating the C<SQL::Abstract> object.
1706 Then you may use an arrayref to insert and update database array types:
1708 my $sql = SQL::Abstract->new(array_datatypes => 1);
1710 planets => [qw/Mercury Venus Earth Mars/]
1713 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1717 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1719 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1722 =head2 Inserting and Updating SQL
1724 In order to apply SQL functions to elements of your C<%data> you may
1725 specify a reference to an arrayref for the given hash value. For example,
1726 if you need to execute the Oracle C<to_date> function on a value, you can
1727 say something like this:
1731 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1734 The first value in the array is the actual SQL. Any other values are
1735 optional and would be included in the bind values array. This gives
1738 my($stmt, @bind) = $sql->insert('people', \%data);
1740 $stmt = "INSERT INTO people (name, date_entered)
1741 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1742 @bind = ('Bill', '03/02/2003');
1744 An UPDATE is just as easy, all you change is the name of the function:
1746 my($stmt, @bind) = $sql->update('people', \%data);
1748 Notice that your C<%data> isn't touched; the module will generate
1749 the appropriately quirky SQL for you automatically. Usually you'll
1750 want to specify a WHERE clause for your UPDATE, though, which is
1751 where handling C<%where> hashes comes in handy...
1753 =head2 Complex where statements
1755 This module can generate pretty complicated WHERE statements
1756 easily. For example, simple C<key=value> pairs are taken to mean
1757 equality, and if you want to see if a field is within a set
1758 of values, you can use an arrayref. Let's say we wanted to
1759 SELECT some data based on this criteria:
1762 requestor => 'inna',
1763 worker => ['nwiger', 'rcwe', 'sfz'],
1764 status => { '!=', 'completed' }
1767 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1769 The above would give you something like this:
1771 $stmt = "SELECT * FROM tickets WHERE
1772 ( requestor = ? ) AND ( status != ? )
1773 AND ( worker = ? OR worker = ? OR worker = ? )";
1774 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1776 Which you could then use in DBI code like so:
1778 my $sth = $dbh->prepare($stmt);
1779 $sth->execute(@bind);
1785 The methods are simple. There's one for every major SQL operation,
1786 and a constructor you use first. The arguments are specified in a
1787 similar order for each method (table, then fields, then a where
1788 clause) to try and simplify things.
1790 =head2 new(option => 'value')
1792 The C<new()> function takes a list of options and values, and returns
1793 a new B<SQL::Abstract> object which can then be used to generate SQL
1794 through the methods below. The options accepted are:
1800 If set to 'lower', then SQL will be generated in all lowercase. By
1801 default SQL is generated in "textbook" case meaning something like:
1803 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1805 Any setting other than 'lower' is ignored.
1809 This determines what the default comparison operator is. By default
1810 it is C<=>, meaning that a hash like this:
1812 %where = (name => 'nwiger', email => 'nate@wiger.org');
1814 Will generate SQL like this:
1816 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1818 However, you may want loose comparisons by default, so if you set
1819 C<cmp> to C<like> you would get SQL such as:
1821 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1823 You can also override the comparison on an individual basis - see
1824 the huge section on L</"WHERE CLAUSES"> at the bottom.
1826 =item sqltrue, sqlfalse
1828 Expressions for inserting boolean values within SQL statements.
1829 By default these are C<1=1> and C<1=0>. They are used
1830 by the special operators C<-in> and C<-not_in> for generating
1831 correct SQL even when the argument is an empty array (see below).
1835 This determines the default logical operator for multiple WHERE
1836 statements in arrays or hashes. If absent, the default logic is "or"
1837 for arrays, and "and" for hashes. This means that a WHERE
1841 event_date => {'>=', '2/13/99'},
1842 event_date => {'<=', '4/24/03'},
1845 will generate SQL like this:
1847 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1849 This is probably not what you want given this query, though (look
1850 at the dates). To change the "OR" to an "AND", simply specify:
1852 my $sql = SQL::Abstract->new(logic => 'and');
1854 Which will change the above C<WHERE> to:
1856 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1858 The logic can also be changed locally by inserting
1859 a modifier in front of an arrayref:
1861 @where = (-and => [event_date => {'>=', '2/13/99'},
1862 event_date => {'<=', '4/24/03'} ]);
1864 See the L</"WHERE CLAUSES"> section for explanations.
1868 This will automatically convert comparisons using the specified SQL
1869 function for both column and value. This is mostly used with an argument
1870 of C<upper> or C<lower>, so that the SQL will have the effect of
1871 case-insensitive "searches". For example, this:
1873 $sql = SQL::Abstract->new(convert => 'upper');
1874 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1876 Will turn out the following SQL:
1878 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1880 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1881 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1882 not validate this option; it will just pass through what you specify verbatim).
1886 This is a kludge because many databases suck. For example, you can't
1887 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1888 Instead, you have to use C<bind_param()>:
1890 $sth->bind_param(1, 'reg data');
1891 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1893 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1894 which loses track of which field each slot refers to. Fear not.
1896 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1897 Currently, you can specify either C<normal> (default) or C<columns>. If you
1898 specify C<columns>, you will get an array that looks like this:
1900 my $sql = SQL::Abstract->new(bindtype => 'columns');
1901 my($stmt, @bind) = $sql->insert(...);
1904 [ 'column1', 'value1' ],
1905 [ 'column2', 'value2' ],
1906 [ 'column3', 'value3' ],
1909 You can then iterate through this manually, using DBI's C<bind_param()>.
1911 $sth->prepare($stmt);
1914 my($col, $data) = @$_;
1915 if ($col eq 'details' || $col eq 'comments') {
1916 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1917 } elsif ($col eq 'image') {
1918 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1920 $sth->bind_param($i, $data);
1924 $sth->execute; # execute without @bind now
1926 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1927 Basically, the advantage is still that you don't have to care which fields
1928 are or are not included. You could wrap that above C<for> loop in a simple
1929 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1930 get a layer of abstraction over manual SQL specification.
1932 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1933 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1934 will expect the bind values in this format.
1938 This is the character that a table or column name will be quoted
1939 with. By default this is an empty string, but you could set it to
1940 the character C<`>, to generate SQL like this:
1942 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1944 Alternatively, you can supply an array ref of two items, the first being the left
1945 hand quote character, and the second the right hand quote character. For
1946 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1947 that generates SQL like this:
1949 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1951 Quoting is useful if you have tables or columns names that are reserved
1952 words in your database's SQL dialect.
1956 This is the character that will be used to escape L</quote_char>s appearing
1957 in an identifier before it has been quoted.
1959 The parameter default in case of a single L</quote_char> character is the quote
1962 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1963 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1964 of the B<opening (left)> L</quote_char> within the identifier are currently left
1965 untouched. The default for opening-closing-style quotes may change in future
1966 versions, thus you are B<strongly encouraged> to specify the escape character
1971 This is the character that separates a table and column name. It is
1972 necessary to specify this when the C<quote_char> option is selected,
1973 so that tables and column names can be individually quoted like this:
1975 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1977 =item injection_guard
1979 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1980 column name specified in a query structure. This is a safety mechanism to avoid
1981 injection attacks when mishandling user input e.g.:
1983 my %condition_as_column_value_pairs = get_values_from_user();
1984 $sqla->select( ... , \%condition_as_column_value_pairs );
1986 If the expression matches an exception is thrown. Note that literal SQL
1987 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1989 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1991 =item array_datatypes
1993 When this option is true, arrayrefs in INSERT or UPDATE are
1994 interpreted as array datatypes and are passed directly
1996 When this option is false, arrayrefs are interpreted
1997 as literal SQL, just like refs to arrayrefs
1998 (but this behavior is for backwards compatibility; when writing
1999 new queries, use the "reference to arrayref" syntax
2005 Takes a reference to a list of "special operators"
2006 to extend the syntax understood by L<SQL::Abstract>.
2007 See section L</"SPECIAL OPERATORS"> for details.
2011 Takes a reference to a list of "unary operators"
2012 to extend the syntax understood by L<SQL::Abstract>.
2013 See section L</"UNARY OPERATORS"> for details.
2019 =head2 insert($table, \@values || \%fieldvals, \%options)
2021 This is the simplest function. You simply give it a table name
2022 and either an arrayref of values or hashref of field/value pairs.
2023 It returns an SQL INSERT statement and a list of bind values.
2024 See the sections on L</"Inserting and Updating Arrays"> and
2025 L</"Inserting and Updating SQL"> for information on how to insert
2026 with those data types.
2028 The optional C<\%options> hash reference may contain additional
2029 options to generate the insert SQL. Currently supported options
2036 Takes either a scalar of raw SQL fields, or an array reference of
2037 field names, and adds on an SQL C<RETURNING> statement at the end.
2038 This allows you to return data generated by the insert statement
2039 (such as row IDs) without performing another C<SELECT> statement.
2040 Note, however, this is not part of the SQL standard and may not
2041 be supported by all database engines.
2045 =head2 update($table, \%fieldvals, \%where, \%options)
2047 This takes a table, hashref of field/value pairs, and an optional
2048 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2050 See the sections on L</"Inserting and Updating Arrays"> and
2051 L</"Inserting and Updating SQL"> for information on how to insert
2052 with those data types.
2054 The optional C<\%options> hash reference may contain additional
2055 options to generate the update SQL. Currently supported options
2062 See the C<returning> option to
2063 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2067 =head2 select($source, $fields, $where, $order)
2069 This returns a SQL SELECT statement and associated list of bind values, as
2070 specified by the arguments:
2076 Specification of the 'FROM' part of the statement.
2077 The argument can be either a plain scalar (interpreted as a table
2078 name, will be quoted), or an arrayref (interpreted as a list
2079 of table names, joined by commas, quoted), or a scalarref
2080 (literal SQL, not quoted).
2084 Specification of the list of fields to retrieve from
2086 The argument can be either an arrayref (interpreted as a list
2087 of field names, will be joined by commas and quoted), or a
2088 plain scalar (literal SQL, not quoted).
2089 Please observe that this API is not as flexible as that of
2090 the first argument C<$source>, for backwards compatibility reasons.
2094 Optional argument to specify the WHERE part of the query.
2095 The argument is most often a hashref, but can also be
2096 an arrayref or plain scalar --
2097 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2101 Optional argument to specify the ORDER BY part of the query.
2102 The argument can be a scalar, a hashref or an arrayref
2103 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2109 =head2 delete($table, \%where, \%options)
2111 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2112 It returns an SQL DELETE statement and list of bind values.
2114 The optional C<\%options> hash reference may contain additional
2115 options to generate the delete SQL. Currently supported options
2122 See the C<returning> option to
2123 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2127 =head2 where(\%where, $order)
2129 This is used to generate just the WHERE clause. For example,
2130 if you have an arbitrary data structure and know what the
2131 rest of your SQL is going to look like, but want an easy way
2132 to produce a WHERE clause, use this. It returns an SQL WHERE
2133 clause and list of bind values.
2136 =head2 values(\%data)
2138 This just returns the values from the hash C<%data>, in the same
2139 order that would be returned from any of the other above queries.
2140 Using this allows you to markedly speed up your queries if you
2141 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2143 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2145 Warning: This is an experimental method and subject to change.
2147 This returns arbitrarily generated SQL. It's a really basic shortcut.
2148 It will return two different things, depending on return context:
2150 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2151 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2153 These would return the following:
2155 # First calling form
2156 $stmt = "CREATE TABLE test (?, ?)";
2157 @bind = (field1, field2);
2159 # Second calling form
2160 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2162 Depending on what you're trying to do, it's up to you to choose the correct
2163 format. In this example, the second form is what you would want.
2167 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2171 ALTER SESSION SET nls_date_format = 'MM/YY'
2173 You get the idea. Strings get their case twiddled, but everything
2174 else remains verbatim.
2176 =head1 EXPORTABLE FUNCTIONS
2178 =head2 is_plain_value
2180 Determines if the supplied argument is a plain value as understood by this
2185 =item * The value is C<undef>
2187 =item * The value is a non-reference
2189 =item * The value is an object with stringification overloading
2191 =item * The value is of the form C<< { -value => $anything } >>
2195 On failure returns C<undef>, on success returns a B<scalar> reference
2196 to the original supplied argument.
2202 The stringification overloading detection is rather advanced: it takes
2203 into consideration not only the presence of a C<""> overload, but if that
2204 fails also checks for enabled
2205 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2206 on either C<0+> or C<bool>.
2208 Unfortunately testing in the field indicates that this
2209 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2210 but only when very large numbers of stringifying objects are involved.
2211 At the time of writing ( Sep 2014 ) there is no clear explanation of
2212 the direct cause, nor is there a manageably small test case that reliably
2213 reproduces the problem.
2215 If you encounter any of the following exceptions in B<random places within
2216 your application stack> - this module may be to blame:
2218 Operation "ne": no method found,
2219 left argument in overloaded package <something>,
2220 right argument in overloaded package <something>
2224 Stub found while resolving method "???" overloading """" in package <something>
2226 If you fall victim to the above - please attempt to reduce the problem
2227 to something that could be sent to the L<SQL::Abstract developers
2228 |DBIx::Class/GETTING HELP/SUPPORT>
2229 (either publicly or privately). As a workaround in the meantime you can
2230 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2231 value, which will most likely eliminate your problem (at the expense of
2232 not being able to properly detect exotic forms of stringification).
2234 This notice and environment variable will be removed in a future version,
2235 as soon as the underlying problem is found and a reliable workaround is
2240 =head2 is_literal_value
2242 Determines if the supplied argument is a literal value as understood by this
2247 =item * C<\$sql_string>
2249 =item * C<\[ $sql_string, @bind_values ]>
2253 On failure returns C<undef>, on success returns an B<array> reference
2254 containing the unpacked version of the supplied literal SQL and bind values.
2256 =head1 WHERE CLAUSES
2260 This module uses a variation on the idea from L<DBIx::Abstract>. It
2261 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2262 module is that things in arrays are OR'ed, and things in hashes
2265 The easiest way to explain is to show lots of examples. After
2266 each C<%where> hash shown, it is assumed you used:
2268 my($stmt, @bind) = $sql->where(\%where);
2270 However, note that the C<%where> hash can be used directly in any
2271 of the other functions as well, as described above.
2273 =head2 Key-value pairs
2275 So, let's get started. To begin, a simple hash:
2279 status => 'completed'
2282 Is converted to SQL C<key = val> statements:
2284 $stmt = "WHERE user = ? AND status = ?";
2285 @bind = ('nwiger', 'completed');
2287 One common thing I end up doing is having a list of values that
2288 a field can be in. To do this, simply specify a list inside of
2293 status => ['assigned', 'in-progress', 'pending'];
2296 This simple code will create the following:
2298 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2299 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2301 A field associated to an empty arrayref will be considered a
2302 logical false and will generate 0=1.
2304 =head2 Tests for NULL values
2306 If the value part is C<undef> then this is converted to SQL <IS NULL>
2315 $stmt = "WHERE user = ? AND status IS NULL";
2318 To test if a column IS NOT NULL:
2322 status => { '!=', undef },
2325 =head2 Specific comparison operators
2327 If you want to specify a different type of operator for your comparison,
2328 you can use a hashref for a given column:
2332 status => { '!=', 'completed' }
2335 Which would generate:
2337 $stmt = "WHERE user = ? AND status != ?";
2338 @bind = ('nwiger', 'completed');
2340 To test against multiple values, just enclose the values in an arrayref:
2342 status => { '=', ['assigned', 'in-progress', 'pending'] };
2344 Which would give you:
2346 "WHERE status = ? OR status = ? OR status = ?"
2349 The hashref can also contain multiple pairs, in which case it is expanded
2350 into an C<AND> of its elements:
2354 status => { '!=', 'completed', -not_like => 'pending%' }
2357 # Or more dynamically, like from a form
2358 $where{user} = 'nwiger';
2359 $where{status}{'!='} = 'completed';
2360 $where{status}{'-not_like'} = 'pending%';
2362 # Both generate this
2363 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2364 @bind = ('nwiger', 'completed', 'pending%');
2367 To get an OR instead, you can combine it with the arrayref idea:
2371 priority => [ { '=', 2 }, { '>', 5 } ]
2374 Which would generate:
2376 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2377 @bind = ('2', '5', 'nwiger');
2379 If you want to include literal SQL (with or without bind values), just use a
2380 scalar reference or reference to an arrayref as the value:
2383 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2384 date_expires => { '<' => \"now()" }
2387 Which would generate:
2389 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2390 @bind = ('11/26/2008');
2393 =head2 Logic and nesting operators
2395 In the example above,
2396 there is a subtle trap if you want to say something like
2397 this (notice the C<AND>):
2399 WHERE priority != ? AND priority != ?
2401 Because, in Perl you I<can't> do this:
2403 priority => { '!=' => 2, '!=' => 1 }
2405 As the second C<!=> key will obliterate the first. The solution
2406 is to use the special C<-modifier> form inside an arrayref:
2408 priority => [ -and => {'!=', 2},
2412 Normally, these would be joined by C<OR>, but the modifier tells it
2413 to use C<AND> instead. (Hint: You can use this in conjunction with the
2414 C<logic> option to C<new()> in order to change the way your queries
2415 work by default.) B<Important:> Note that the C<-modifier> goes
2416 B<INSIDE> the arrayref, as an extra first element. This will
2417 B<NOT> do what you think it might:
2419 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2421 Here is a quick list of equivalencies, since there is some overlap:
2424 status => {'!=', 'completed', 'not like', 'pending%' }
2425 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2428 status => {'=', ['assigned', 'in-progress']}
2429 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2430 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2434 =head2 Special operators: IN, BETWEEN, etc.
2436 You can also use the hashref format to compare a list of fields using the
2437 C<IN> comparison operator, by specifying the list as an arrayref:
2440 status => 'completed',
2441 reportid => { -in => [567, 2335, 2] }
2444 Which would generate:
2446 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2447 @bind = ('completed', '567', '2335', '2');
2449 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2452 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2453 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2454 'sqltrue' (by default: C<1=1>).
2456 In addition to the array you can supply a chunk of literal sql or
2457 literal sql with bind:
2460 customer => { -in => \[
2461 'SELECT cust_id FROM cust WHERE balance > ?',
2464 status => { -in => \'SELECT status_codes FROM states' },
2470 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2471 AND status IN ( SELECT status_codes FROM states )
2475 Finally, if the argument to C<-in> is not a reference, it will be
2476 treated as a single-element array.
2478 Another pair of operators is C<-between> and C<-not_between>,
2479 used with an arrayref of two values:
2483 completion_date => {
2484 -not_between => ['2002-10-01', '2003-02-06']
2490 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2492 Just like with C<-in> all plausible combinations of literal SQL
2496 start0 => { -between => [ 1, 2 ] },
2497 start1 => { -between => \["? AND ?", 1, 2] },
2498 start2 => { -between => \"lower(x) AND upper(y)" },
2499 start3 => { -between => [
2501 \["upper(?)", 'stuff' ],
2508 ( start0 BETWEEN ? AND ? )
2509 AND ( start1 BETWEEN ? AND ? )
2510 AND ( start2 BETWEEN lower(x) AND upper(y) )
2511 AND ( start3 BETWEEN lower(x) AND upper(?) )
2513 @bind = (1, 2, 1, 2, 'stuff');
2516 These are the two builtin "special operators"; but the
2517 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2519 =head2 Unary operators: bool
2521 If you wish to test against boolean columns or functions within your
2522 database you can use the C<-bool> and C<-not_bool> operators. For
2523 example to test the column C<is_user> being true and the column
2524 C<is_enabled> being false you would use:-
2528 -not_bool => 'is_enabled',
2533 WHERE is_user AND NOT is_enabled
2535 If a more complex combination is required, testing more conditions,
2536 then you should use the and/or operators:-
2541 -not_bool => { two=> { -rlike => 'bar' } },
2542 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2553 (NOT ( three = ? OR three > ? ))
2556 =head2 Nested conditions, -and/-or prefixes
2558 So far, we've seen how multiple conditions are joined with a top-level
2559 C<AND>. We can change this by putting the different conditions we want in
2560 hashes and then putting those hashes in an array. For example:
2565 status => { -like => ['pending%', 'dispatched'] },
2569 status => 'unassigned',
2573 This data structure would create the following:
2575 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2576 OR ( user = ? AND status = ? ) )";
2577 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2580 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2581 to change the logic inside:
2587 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2588 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2595 $stmt = "WHERE ( user = ?
2596 AND ( ( workhrs > ? AND geo = ? )
2597 OR ( workhrs < ? OR geo = ? ) ) )";
2598 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2600 =head3 Algebraic inconsistency, for historical reasons
2602 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2603 operator goes C<outside> of the nested structure; whereas when connecting
2604 several constraints on one column, the C<-and> operator goes
2605 C<inside> the arrayref. Here is an example combining both features:
2608 -and => [a => 1, b => 2],
2609 -or => [c => 3, d => 4],
2610 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2615 WHERE ( ( ( a = ? AND b = ? )
2616 OR ( c = ? OR d = ? )
2617 OR ( e LIKE ? AND e LIKE ? ) ) )
2619 This difference in syntax is unfortunate but must be preserved for
2620 historical reasons. So be careful: the two examples below would
2621 seem algebraically equivalent, but they are not
2624 { -like => 'foo%' },
2625 { -like => '%bar' },
2627 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2630 { col => { -like => 'foo%' } },
2631 { col => { -like => '%bar' } },
2633 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2636 =head2 Literal SQL and value type operators
2638 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2639 side" is a column name and the "right side" is a value (normally rendered as
2640 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2641 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2642 alter this behavior. There are several ways of doing so.
2646 This is a virtual operator that signals the string to its right side is an
2647 identifier (a column name) and not a value. For example to compare two
2648 columns you would write:
2651 priority => { '<', 2 },
2652 requestor => { -ident => 'submitter' },
2657 $stmt = "WHERE priority < ? AND requestor = submitter";
2660 If you are maintaining legacy code you may see a different construct as
2661 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2666 This is a virtual operator that signals that the construct to its right side
2667 is a value to be passed to DBI. This is for example necessary when you want
2668 to write a where clause against an array (for RDBMS that support such
2669 datatypes). For example:
2672 array => { -value => [1, 2, 3] }
2677 $stmt = 'WHERE array = ?';
2678 @bind = ([1, 2, 3]);
2680 Note that if you were to simply say:
2686 the result would probably not be what you wanted:
2688 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2693 Finally, sometimes only literal SQL will do. To include a random snippet
2694 of SQL verbatim, you specify it as a scalar reference. Consider this only
2695 as a last resort. Usually there is a better way. For example:
2698 priority => { '<', 2 },
2699 requestor => { -in => \'(SELECT name FROM hitmen)' },
2704 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2707 Note that in this example, you only get one bind parameter back, since
2708 the verbatim SQL is passed as part of the statement.
2712 Never use untrusted input as a literal SQL argument - this is a massive
2713 security risk (there is no way to check literal snippets for SQL
2714 injections and other nastyness). If you need to deal with untrusted input
2715 use literal SQL with placeholders as described next.
2717 =head3 Literal SQL with placeholders and bind values (subqueries)
2719 If the literal SQL to be inserted has placeholders and bind values,
2720 use a reference to an arrayref (yes this is a double reference --
2721 not so common, but perfectly legal Perl). For example, to find a date
2722 in Postgres you can use something like this:
2725 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2730 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2733 Note that you must pass the bind values in the same format as they are returned
2734 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2735 to C<columns>, you must provide the bind values in the
2736 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2737 scalar value; most commonly the column name, but you can use any scalar value
2738 (including references and blessed references), L<SQL::Abstract> will simply
2739 pass it through intact. So if C<bindtype> is set to C<columns> the above
2740 example will look like:
2743 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2746 Literal SQL is especially useful for nesting parenthesized clauses in the
2747 main SQL query. Here is a first example:
2749 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2753 bar => \["IN ($sub_stmt)" => @sub_bind],
2758 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2759 WHERE c2 < ? AND c3 LIKE ?))";
2760 @bind = (1234, 100, "foo%");
2762 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2763 are expressed in the same way. Of course the C<$sub_stmt> and
2764 its associated bind values can be generated through a former call
2767 my ($sub_stmt, @sub_bind)
2768 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2769 c3 => {-like => "foo%"}});
2772 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2775 In the examples above, the subquery was used as an operator on a column;
2776 but the same principle also applies for a clause within the main C<%where>
2777 hash, like an EXISTS subquery:
2779 my ($sub_stmt, @sub_bind)
2780 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2781 my %where = ( -and => [
2783 \["EXISTS ($sub_stmt)" => @sub_bind],
2788 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2789 WHERE c1 = ? AND c2 > t0.c0))";
2793 Observe that the condition on C<c2> in the subquery refers to
2794 column C<t0.c0> of the main query: this is I<not> a bind
2795 value, so we have to express it through a scalar ref.
2796 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2797 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2798 what we wanted here.
2800 Finally, here is an example where a subquery is used
2801 for expressing unary negation:
2803 my ($sub_stmt, @sub_bind)
2804 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2805 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2807 lname => {like => '%son%'},
2808 \["NOT ($sub_stmt)" => @sub_bind],
2813 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2814 @bind = ('%son%', 10, 20)
2816 =head3 Deprecated usage of Literal SQL
2818 Below are some examples of archaic use of literal SQL. It is shown only as
2819 reference for those who deal with legacy code. Each example has a much
2820 better, cleaner and safer alternative that users should opt for in new code.
2826 my %where = ( requestor => \'IS NOT NULL' )
2828 $stmt = "WHERE requestor IS NOT NULL"
2830 This used to be the way of generating NULL comparisons, before the handling
2831 of C<undef> got formalized. For new code please use the superior syntax as
2832 described in L</Tests for NULL values>.
2836 my %where = ( requestor => \'= submitter' )
2838 $stmt = "WHERE requestor = submitter"
2840 This used to be the only way to compare columns. Use the superior L</-ident>
2841 method for all new code. For example an identifier declared in such a way
2842 will be properly quoted if L</quote_char> is properly set, while the legacy
2843 form will remain as supplied.
2847 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2849 $stmt = "WHERE completed > ? AND is_ready"
2850 @bind = ('2012-12-21')
2852 Using an empty string literal used to be the only way to express a boolean.
2853 For all new code please use the much more readable
2854 L<-bool|/Unary operators: bool> operator.
2860 These pages could go on for a while, since the nesting of the data
2861 structures this module can handle are pretty much unlimited (the
2862 module implements the C<WHERE> expansion as a recursive function
2863 internally). Your best bet is to "play around" with the module a
2864 little to see how the data structures behave, and choose the best
2865 format for your data based on that.
2867 And of course, all the values above will probably be replaced with
2868 variables gotten from forms or the command line. After all, if you
2869 knew everything ahead of time, you wouldn't have to worry about
2870 dynamically-generating SQL and could just hardwire it into your
2873 =head1 ORDER BY CLAUSES
2875 Some functions take an order by clause. This can either be a scalar (just a
2876 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2877 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2880 Given | Will Generate
2881 ---------------------------------------------------------------
2883 'colA' | ORDER BY colA
2885 [qw/colA colB/] | ORDER BY colA, colB
2887 {-asc => 'colA'} | ORDER BY colA ASC
2889 {-desc => 'colB'} | ORDER BY colB DESC
2891 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2893 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2895 \'colA DESC' | ORDER BY colA DESC
2897 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2898 | /* ...with $x bound to ? */
2901 { -asc => 'colA' }, | colA ASC,
2902 { -desc => [qw/colB/] }, | colB DESC,
2903 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2904 \'colE DESC', | colE DESC,
2905 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2906 ] | /* ...with $x bound to ? */
2907 ===============================================================
2911 =head1 SPECIAL OPERATORS
2913 my $sqlmaker = SQL::Abstract->new(special_ops => [
2917 my ($self, $field, $op, $arg) = @_;
2923 handler => 'method_name',
2927 A "special operator" is a SQL syntactic clause that can be
2928 applied to a field, instead of a usual binary operator.
2931 WHERE field IN (?, ?, ?)
2932 WHERE field BETWEEN ? AND ?
2933 WHERE MATCH(field) AGAINST (?, ?)
2935 Special operators IN and BETWEEN are fairly standard and therefore
2936 are builtin within C<SQL::Abstract> (as the overridable methods
2937 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2938 like the MATCH .. AGAINST example above which is specific to MySQL,
2939 you can write your own operator handlers - supply a C<special_ops>
2940 argument to the C<new> method. That argument takes an arrayref of
2941 operator definitions; each operator definition is a hashref with two
2948 the regular expression to match the operator
2952 Either a coderef or a plain scalar method name. In both cases
2953 the expected return is C<< ($sql, @bind) >>.
2955 When supplied with a method name, it is simply called on the
2956 L<SQL::Abstract> object as:
2958 $self->$method_name($field, $op, $arg)
2962 $field is the LHS of the operator
2963 $op is the part that matched the handler regex
2966 When supplied with a coderef, it is called as:
2968 $coderef->($self, $field, $op, $arg)
2973 For example, here is an implementation
2974 of the MATCH .. AGAINST syntax for MySQL
2976 my $sqlmaker = SQL::Abstract->new(special_ops => [
2978 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2979 {regex => qr/^match$/i,
2981 my ($self, $field, $op, $arg) = @_;
2982 $arg = [$arg] if not ref $arg;
2983 my $label = $self->_quote($field);
2984 my ($placeholder) = $self->_convert('?');
2985 my $placeholders = join ", ", (($placeholder) x @$arg);
2986 my $sql = $self->_sqlcase('match') . " ($label) "
2987 . $self->_sqlcase('against') . " ($placeholders) ";
2988 my @bind = $self->_bindtype($field, @$arg);
2989 return ($sql, @bind);
2996 =head1 UNARY OPERATORS
2998 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3002 my ($self, $op, $arg) = @_;
3008 handler => 'method_name',
3012 A "unary operator" is a SQL syntactic clause that can be
3013 applied to a field - the operator goes before the field
3015 You can write your own operator handlers - supply a C<unary_ops>
3016 argument to the C<new> method. That argument takes an arrayref of
3017 operator definitions; each operator definition is a hashref with two
3024 the regular expression to match the operator
3028 Either a coderef or a plain scalar method name. In both cases
3029 the expected return is C<< $sql >>.
3031 When supplied with a method name, it is simply called on the
3032 L<SQL::Abstract> object as:
3034 $self->$method_name($op, $arg)
3038 $op is the part that matched the handler regex
3039 $arg is the RHS or argument of the operator
3041 When supplied with a coderef, it is called as:
3043 $coderef->($self, $op, $arg)
3051 Thanks to some benchmarking by Mark Stosberg, it turns out that
3052 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3053 I must admit this wasn't an intentional design issue, but it's a
3054 byproduct of the fact that you get to control your C<DBI> handles
3057 To maximize performance, use a code snippet like the following:
3059 # prepare a statement handle using the first row
3060 # and then reuse it for the rest of the rows
3062 for my $href (@array_of_hashrefs) {
3063 $stmt ||= $sql->insert('table', $href);
3064 $sth ||= $dbh->prepare($stmt);
3065 $sth->execute($sql->values($href));
3068 The reason this works is because the keys in your C<$href> are sorted
3069 internally by B<SQL::Abstract>. Thus, as long as your data retains
3070 the same structure, you only have to generate the SQL the first time
3071 around. On subsequent queries, simply use the C<values> function provided
3072 by this module to return your values in the correct order.
3074 However this depends on the values having the same type - if, for
3075 example, the values of a where clause may either have values
3076 (resulting in sql of the form C<column = ?> with a single bind
3077 value), or alternatively the values might be C<undef> (resulting in
3078 sql of the form C<column IS NULL> with no bind value) then the
3079 caching technique suggested will not work.
3083 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3084 really like this part (I do, at least). Building up a complex query
3085 can be as simple as the following:
3092 use CGI::FormBuilder;
3095 my $form = CGI::FormBuilder->new(...);
3096 my $sql = SQL::Abstract->new;
3098 if ($form->submitted) {
3099 my $field = $form->field;
3100 my $id = delete $field->{id};
3101 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3104 Of course, you would still have to connect using C<DBI> to run the
3105 query, but the point is that if you make your form look like your
3106 table, the actual query script can be extremely simplistic.
3108 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3109 a fast interface to returning and formatting data. I frequently
3110 use these three modules together to write complex database query
3111 apps in under 50 lines.
3113 =head1 HOW TO CONTRIBUTE
3115 Contributions are always welcome, in all usable forms (we especially
3116 welcome documentation improvements). The delivery methods include git-
3117 or unified-diff formatted patches, GitHub pull requests, or plain bug
3118 reports either via RT or the Mailing list. Contributors are generally
3119 granted full access to the official repository after their first several
3120 patches pass successful review.
3122 This project is maintained in a git repository. The code and related tools are
3123 accessible at the following locations:
3127 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3129 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3131 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3133 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3139 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3140 Great care has been taken to preserve the I<published> behavior
3141 documented in previous versions in the 1.* family; however,
3142 some features that were previously undocumented, or behaved
3143 differently from the documentation, had to be changed in order
3144 to clarify the semantics. Hence, client code that was relying
3145 on some dark areas of C<SQL::Abstract> v1.*
3146 B<might behave differently> in v1.50.
3148 The main changes are:
3154 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3158 support for the { operator => \"..." } construct (to embed literal SQL)
3162 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3166 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3170 defensive programming: check arguments
3174 fixed bug with global logic, which was previously implemented
3175 through global variables yielding side-effects. Prior versions would
3176 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3177 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3178 Now this is interpreted
3179 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3184 fixed semantics of _bindtype on array args
3188 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3189 we just avoid shifting arrays within that tree.
3193 dropped the C<_modlogic> function
3197 =head1 ACKNOWLEDGEMENTS
3199 There are a number of individuals that have really helped out with
3200 this module. Unfortunately, most of them submitted bugs via CPAN
3201 so I have no idea who they are! But the people I do know are:
3203 Ash Berlin (order_by hash term support)
3204 Matt Trout (DBIx::Class support)
3205 Mark Stosberg (benchmarking)
3206 Chas Owens (initial "IN" operator support)
3207 Philip Collins (per-field SQL functions)
3208 Eric Kolve (hashref "AND" support)
3209 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3210 Dan Kubb (support for "quote_char" and "name_sep")
3211 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3212 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3213 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3214 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3215 Oliver Charles (support for "RETURNING" after "INSERT")
3221 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3225 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3227 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3229 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3230 While not an official support venue, C<DBIx::Class> makes heavy use of
3231 C<SQL::Abstract>, and as such list members there are very familiar with
3232 how to create queries.
3236 This module is free software; you may copy this under the same
3237 terms as perl itself (either the GNU General Public License or
3238 the Artistic License)