1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.86';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: 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',
204 -bind => sub { shift; +{ @_ } },
208 'between' => '_expand_between',
209 'not between' => '_expand_between',
210 'in' => '_expand_in',
211 'not in' => '_expand_in',
212 'nest' => '_expand_nest',
213 (map +($_ => '_expand_op_andor'), ('and', 'or')),
214 (map +($_ => '_expand_op_is'), ('is', 'is not')),
217 # placeholder for _expand_unop system
219 my %unops = (-ident => '_expand_ident', -value => '_expand_value');
220 foreach my $name (keys %unops) {
221 $opt{expand}{$name} = $unops{$name};
222 my ($op) = $name =~ /^-(.*)$/;
223 $opt{expand_op}{$op} = sub {
224 my ($self, $op, $arg, $k) = @_;
225 return $self->_expand_expr_hashpair_cmp(
226 $k, { "-${op}" => $arg }
233 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
238 (map +($_ => '_render_op_between'), 'between', 'not between'),
239 (map +($_ => '_render_op_in'), 'in', 'not in'),
240 (map +($_ => '_render_unop_postfix'),
241 'is null', 'is not null', 'asc', 'desc',
243 (not => '_render_op_not'),
244 (map +($_ => '_render_op_andor'), qw(and or)),
247 return bless \%opt, $class;
250 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
251 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
253 sub _assert_pass_injection_guard {
254 if ($_[1] =~ $_[0]->{injection_guard}) {
255 my $class = ref $_[0];
256 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
257 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
258 . "{injection_guard} attribute to ${class}->new()"
263 #======================================================================
265 #======================================================================
269 my $table = $self->_table(shift);
270 my $data = shift || return;
273 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
274 my ($sql, @bind) = $self->$method($data);
275 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
277 if ($options->{returning}) {
278 my ($s, @b) = $self->_insert_returning($options);
283 return wantarray ? ($sql, @bind) : $sql;
286 # So that subclasses can override INSERT ... RETURNING separately from
287 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
288 sub _insert_returning { shift->_returning(@_) }
291 my ($self, $options) = @_;
293 my $f = $options->{returning};
295 my ($sql, @bind) = $self->render_aqt(
296 $self->_expand_maybe_list_expr($f, undef, -ident)
299 ? $self->_sqlcase(' returning ') . $sql
300 : ($self->_sqlcase(' returning ').$sql, @bind);
303 sub _insert_HASHREF { # explicit list of fields and then values
304 my ($self, $data) = @_;
306 my @fields = sort keys %$data;
308 my ($sql, @bind) = $self->_insert_values($data);
311 $_ = $self->_quote($_) foreach @fields;
312 $sql = "( ".join(", ", @fields).") ".$sql;
314 return ($sql, @bind);
317 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
318 my ($self, $data) = @_;
320 # no names (arrayref) so can't generate bindtype
321 $self->{bindtype} ne 'columns'
322 or belch "can't do 'columns' bindtype when called with arrayref";
324 my (@values, @all_bind);
325 foreach my $value (@$data) {
326 my ($values, @bind) = $self->_insert_value(undef, $value);
327 push @values, $values;
328 push @all_bind, @bind;
330 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
331 return ($sql, @all_bind);
334 sub _insert_ARRAYREFREF { # literal SQL with bind
335 my ($self, $data) = @_;
337 my ($sql, @bind) = @${$data};
338 $self->_assert_bindval_matches_bindtype(@bind);
340 return ($sql, @bind);
344 sub _insert_SCALARREF { # literal SQL without bind
345 my ($self, $data) = @_;
351 my ($self, $data) = @_;
353 my (@values, @all_bind);
354 foreach my $column (sort keys %$data) {
355 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
356 push @values, $values;
357 push @all_bind, @bind;
359 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
360 return ($sql, @all_bind);
364 my ($self, $column, $v) = @_;
366 return $self->render_aqt(
367 $self->_expand_insert_value($column, $v)
371 sub _expand_insert_value {
372 my ($self, $column, $v) = @_;
374 if (ref($v) eq 'ARRAY') {
375 if ($self->{array_datatypes}) {
376 return +{ -bind => [ $column, $v ] };
378 my ($sql, @bind) = @$v;
379 $self->_assert_bindval_matches_bindtype(@bind);
380 return +{ -literal => $v };
382 if (ref($v) eq 'HASH') {
383 if (grep !/^-/, keys %$v) {
384 belch "HASH ref as bind value in insert is not supported";
385 return +{ -bind => [ $column, $v ] };
389 return +{ -bind => [ $column, undef ] };
391 local our $Cur_Col_Meta = $column;
392 return $self->expand_expr($v);
397 #======================================================================
399 #======================================================================
404 my $table = $self->_table(shift);
405 my $data = shift || return;
409 # first build the 'SET' part of the sql statement
410 puke "Unsupported data type specified to \$sql->update"
411 unless ref $data eq 'HASH';
413 my ($sql, @all_bind) = $self->_update_set_values($data);
414 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
418 my($where_sql, @where_bind) = $self->where($where);
420 push @all_bind, @where_bind;
423 if ($options->{returning}) {
424 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
425 $sql .= $returning_sql;
426 push @all_bind, @returning_bind;
429 return wantarray ? ($sql, @all_bind) : $sql;
432 sub _update_set_values {
433 my ($self, $data) = @_;
435 return $self->render_aqt(
436 $self->_expand_update_set_values($data),
440 sub _expand_update_set_values {
441 my ($self, $data) = @_;
442 $self->_expand_maybe_list_expr( [
445 $set = { -bind => $_ } unless defined $set;
446 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
452 ? ($self->{array_datatypes}
453 ? [ $k, +{ -bind => [ $k, $v ] } ]
454 : [ $k, +{ -literal => $v } ])
456 local our $Cur_Col_Meta = $k;
457 [ $k, $self->_expand_expr($v) ]
464 # So that subclasses can override UPDATE ... RETURNING separately from
466 sub _update_returning { shift->_returning(@_) }
470 #======================================================================
472 #======================================================================
477 my $table = $self->_table(shift);
478 my $fields = shift || '*';
482 my ($fields_sql, @bind) = $self->_select_fields($fields);
484 my ($where_sql, @where_bind) = $self->where($where, $order);
485 push @bind, @where_bind;
487 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
488 $self->_sqlcase('from'), $table)
491 return wantarray ? ($sql, @bind) : $sql;
495 my ($self, $fields) = @_;
496 return $fields unless ref($fields);
497 return $self->render_aqt(
498 $self->_expand_maybe_list_expr($fields, undef, '-ident')
502 #======================================================================
504 #======================================================================
509 my $table = $self->_table(shift);
513 my($where_sql, @bind) = $self->where($where);
514 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
516 if ($options->{returning}) {
517 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
518 $sql .= $returning_sql;
519 push @bind, @returning_bind;
522 return wantarray ? ($sql, @bind) : $sql;
525 # So that subclasses can override DELETE ... RETURNING separately from
527 sub _delete_returning { shift->_returning(@_) }
531 #======================================================================
533 #======================================================================
537 # Finally, a separate routine just to handle WHERE clauses
539 my ($self, $where, $order) = @_;
541 local $self->{convert_where} = $self->{convert};
544 my ($sql, @bind) = defined($where)
545 ? $self->_recurse_where($where)
547 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
551 my ($order_sql, @order_bind) = $self->_order_by($order);
553 push @bind, @order_bind;
556 return wantarray ? ($sql, @bind) : $sql;
560 my ($self, $expr, $default_scalar_to) = @_;
561 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
562 $self->_expand_expr($expr);
566 my ($self, $aqt) = @_;
567 my ($k, $v, @rest) = %$aqt;
569 if (my $meth = $self->{render}{$k}) {
570 return $self->$meth($v);
572 die "notreached: $k";
576 my ($self, $expr) = @_;
577 $self->render_aqt($self->expand_expr($expr));
581 my ($self, $expr) = @_;
582 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
583 return undef unless defined($expr);
584 if (ref($expr) eq 'HASH') {
585 return undef unless my $kc = keys %$expr;
587 return $self->_expand_op_andor(-and => $expr);
589 my ($key, $value) = %$expr;
590 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
591 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
592 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
594 if (my $exp = $self->{expand}{$key}) {
595 return $self->$exp($key, $value);
597 return $self->_expand_expr_hashpair($key, $value);
599 if (ref($expr) eq 'ARRAY') {
600 my $logic = '-'.lc($self->{logic});
601 return $self->_expand_op_andor($logic, $expr);
603 if (my $literal = is_literal_value($expr)) {
604 return +{ -literal => $literal };
606 if (!ref($expr) or Scalar::Util::blessed($expr)) {
607 return $self->_expand_expr_scalar($expr);
612 sub _expand_expr_hashpair {
613 my ($self, $k, $v) = @_;
614 unless (defined($k) and length($k)) {
615 if (defined($k) and my $literal = is_literal_value($v)) {
616 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
617 return { -literal => $literal };
619 puke "Supplying an empty left hand side argument is not supported";
622 return $self->_expand_expr_hashpair_op($k, $v);
624 return $self->_expand_expr_hashpair_ident($k, $v);
627 sub _expand_expr_hashpair_ident {
628 my ($self, $k, $v) = @_;
630 local our $Cur_Col_Meta = $k;
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 return $self->_expand_expr_hashpair_scalar($k, $v);
649 if (ref($v) eq 'HASH') {
650 return $self->_expand_expr_hashtriple($k, %$v);
652 if (ref($v) eq 'ARRAY') {
653 return $self->sqlfalse unless @$v;
654 $self->_debug("ARRAY($k) means distribute over elements");
656 $v->[0] =~ /^-(and|or)$/i
657 ? shift(@{$v = [ @$v ]})
658 : '-'.lc($self->{logic} || 'OR')
660 return $self->_expand_op_andor(
664 if (my $literal = is_literal_value($v)) {
666 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
669 my ($sql, @bind) = @$literal;
670 if ($self->{bindtype} eq 'columns') {
672 $self->_assert_bindval_matches_bindtype($_);
675 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
680 sub _expand_expr_scalar {
681 my ($self, $expr) = @_;
683 if (my $d = our $Default_Scalar_To) {
684 return $self->_expand_expr({ $d => $expr });
686 return $self->_expand_value(-value => $expr);
689 sub _expand_expr_hashpair_scalar {
690 my ($self, $k, $v) = @_;
692 return $self->_expand_expr_hashpair_cmp(
693 $k, $self->_expand_expr_scalar($v),
697 sub _expand_expr_hashpair_op {
698 my ($self, $k, $v) = @_;
701 $op =~ s/^-// if length($op) > 1;
702 $self->_assert_pass_injection_guard($op);
704 # Ops prefixed with -not_ get converted
706 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
709 $self->_expand_expr({ "-${rest}", $v })
716 # the old special op system requires illegality for top-level use
719 (our $Expand_Depth) == 1
720 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
722 puke "Illegal use of top-level '-$op'"
725 # the old unary op system means we should touch nothing and let it work
727 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
728 return { -op => [ $op, $v ] };
732 # an explicit node type is currently assumed to be expanded (this is almost
733 # certainly wrong and there should be expansion anyway)
735 if ($self->{render}{$k}) {
739 # hashref RHS values get expanded and used as op/func args
744 and (keys %$v)[0] =~ /^-/
746 my ($func) = $k =~ /^-(.*)$/;
748 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
749 return +{ -op => [ $func, $self->_expand_expr($v) ] };
752 return +{ -func => [ $func, $self->_expand_expr($v) ] };
755 # scalars and literals get simply expanded
757 if (!ref($v) or is_literal_value($v)) {
758 return +{ -op => [ $op, $self->_expand_expr($v) ] };
764 sub _expand_expr_hashpair_cmp {
765 my ($self, $k, $v) = @_;
766 $self->_expand_expr_hashtriple($k, $self->{cmp}, $v);
769 sub _expand_expr_hashtriple {
770 my ($self, $k, $vk, $vv) = @_;
772 my $ik = $self->_expand_ident(-ident => $k);
774 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
775 $self->_assert_pass_injection_guard($op);
776 if ($op =~ s/ [_\s]? \d+ $//x ) {
777 return $self->_expand_expr($k, { $vk, $vv });
779 if (my $x = $self->{expand_op}{$op}) {
780 local our $Cur_Col_Meta = $k;
781 return $self->$x($op, $vv, $k);
784 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
785 return { -op => [ $op, $ik, $vv ] };
787 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
791 { -op => [ $op, $vv ] }
795 if (ref($vv) eq 'ARRAY') {
797 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
798 ? shift @raw : '-or';
799 my @values = map +{ $vk => $_ }, @raw;
801 $op =~ $self->{inequality_op}
802 or $op =~ $self->{not_like_op}
804 if (lc($logic) eq '-or' and @values > 1) {
805 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
806 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
807 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
812 # try to DWIM on equality operators
813 return ($self->_dwim_op_to_is($op,
814 "Supplying an empty arrayref to '%s' is deprecated",
815 "operator '%s' applied on an empty array (field '$k')"
816 ) ? $self->sqlfalse : $self->sqltrue);
818 return $self->_expand_op_andor($logic => \@values, $k);
820 if (is_undef_value($vv)) {
821 my $is = ($self->_dwim_op_to_is($op,
822 "Supplying an undefined argument to '%s' is deprecated",
823 "unexpected operator '%s' with undef operand",
824 ) ? 'is' : 'is not');
826 return $self->_expand_expr_hashpair($k => { $is, undef });
828 local our $Cur_Col_Meta = $k;
832 $self->_expand_expr($vv)
837 my ($self, $op, $empty, $fail) = @_;
838 if ($op =~ /^not$/i) {
841 if ($op =~ $self->{equality_op}) {
844 if ($op =~ $self->{like_op}) {
845 belch(sprintf $empty, uc($op));
848 if ($op =~ $self->{inequality_op}) {
851 if ($op =~ $self->{not_like_op}) {
852 belch(sprintf $empty, uc($op));
855 puke(sprintf $fail, $op);
859 my ($self, $op, $body) = @_;
860 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
861 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
863 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
864 ref($body) ? @$body : $body;
865 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
866 unless ($self->{quote_char}) {
867 $self->_assert_pass_injection_guard($_) for @parts;
869 return +{ -ident => \@parts };
873 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
877 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
881 my ($self, undef, $v) = @_;
883 return $self->_expand_expr($v);
885 puke "-bool => undef not supported" unless defined($v);
886 return $self->_expand_ident(-ident => $v);
889 sub _expand_op_andor {
890 my ($self, $logic, $v, $k) = @_;
892 $v = [ map +{ $k, $_ },
894 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
898 my ($logop) = $logic =~ /^-?(.*)$/;
899 if (ref($v) eq 'HASH') {
900 return undef unless keys %$v;
903 map $self->_expand_expr({ $_ => $v->{$_} }),
907 if (ref($v) eq 'ARRAY') {
908 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
911 (ref($_) eq 'ARRAY' and @$_)
912 or (ref($_) eq 'HASH' and %$_)
918 while (my ($el) = splice @expr, 0, 1) {
919 puke "Supplying an empty left hand side argument is not supported in array-pairs"
920 unless defined($el) and length($el);
921 my $elref = ref($el);
923 local our $Expand_Depth = 0;
924 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
925 } elsif ($elref eq 'ARRAY') {
926 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
927 } elsif (my $l = is_literal_value($el)) {
928 push @res, { -literal => $l };
929 } elsif ($elref eq 'HASH') {
930 local our $Expand_Depth = 0;
931 push @res, grep defined, $self->_expand_expr($el) if %$el;
937 # return $res[0] if @res == 1;
938 return { -op => [ $logop, @res ] };
944 my ($self, $op, $vv, $k) = @_;
945 puke "$op can only take undef as argument"
949 and exists($vv->{-value})
950 and !defined($vv->{-value})
952 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
955 sub _expand_between {
956 my ($self, $op, $vv, $k) = @_;
957 local our $Cur_Col_Meta = $k;
958 my @rhs = map $self->_expand_expr($_),
959 ref($vv) eq 'ARRAY' ? @$vv : $vv;
961 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
963 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
965 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
969 $self->_expand_ident(-ident => $k),
975 my ($self, $op, $vv, $k) = @_;
976 if (my $literal = is_literal_value($vv)) {
977 my ($sql, @bind) = @$literal;
978 my $opened_sql = $self->_open_outer_paren($sql);
980 $op, $self->_expand_ident(-ident => $k),
981 [ { -literal => [ $opened_sql, @bind ] } ]
985 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
986 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
987 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
988 . 'will emit the logically correct SQL instead of raising this exception)'
990 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
992 my @rhs = map $self->_expand_expr($_),
993 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
994 map { defined($_) ? $_: puke($undef_err) }
995 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
996 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1000 $self->_expand_ident(-ident => $k),
1006 my ($self, $op, $v) = @_;
1007 # DBIx::Class requires a nest warning to be emitted once but the private
1008 # method it overrode to do so no longer exists
1009 if ($self->{is_dbic_sqlmaker}) {
1010 unless (our $Nest_Warned) {
1012 "-nest in search conditions is deprecated, you most probably wanted:\n"
1013 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1018 return $self->_expand_expr($v);
1021 sub _recurse_where {
1022 my ($self, $where, $logic) = @_;
1024 # Special case: top level simple string treated as literal
1026 my $where_exp = (ref($where)
1027 ? $self->_expand_expr($where, $logic)
1028 : { -literal => [ $where ] });
1030 # dispatch expanded expression
1032 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1033 # DBIx::Class used to call _recurse_where in scalar context
1034 # something else might too...
1036 return ($sql, @bind);
1039 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1045 my ($self, $ident) = @_;
1047 return $self->_convert($self->_quote($ident));
1051 my ($self, $list) = @_;
1052 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1053 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1057 my ($self, $rest) = @_;
1058 my ($func, @args) = @$rest;
1062 push @arg_sql, shift @x;
1064 } map [ $self->render_aqt($_) ], @args;
1065 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1069 my ($self, $bind) = @_;
1070 return ($self->_convert('?'), $self->_bindtype(@$bind));
1073 sub _render_literal {
1074 my ($self, $literal) = @_;
1075 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1080 my ($self, $v) = @_;
1081 my ($op, @args) = @$v;
1082 if (my $r = $self->{render_op}{$op}) {
1083 return $self->$r($op, \@args);
1088 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1089 if ($us and @args > 1) {
1090 puke "Special op '${op}' requires first value to be identifier"
1091 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1092 my $k = join(($self->{name_sep}||'.'), @$ident);
1093 local our $Expand_Depth = 1;
1094 return $self->${\($us->{handler})}($k, $op, $args[1]);
1096 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1097 return $self->${\($us->{handler})}($op, $args[0]);
1102 return $self->_render_unop_prefix($op, \@args);
1104 return $self->_render_op_multop($op, \@args);
1110 sub _render_op_between {
1111 my ($self, $op, $args) = @_;
1112 my ($left, $low, $high) = @$args;
1113 my ($rhsql, @rhbind) = do {
1115 puke "Single arg to between must be a literal"
1116 unless $low->{-literal};
1119 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1120 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1121 @{$l}[1..$#$l], @{$h}[1..$#$h])
1124 my ($lhsql, @lhbind) = $self->render_aqt($left);
1126 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1132 my ($self, $op, $args) = @_;
1133 my ($lhs, $rhs) = @$args;
1136 my ($sql, @bind) = $self->render_aqt($_);
1137 push @in_bind, @bind;
1140 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1142 $lhsql.' '.$self->_sqlcase($op).' ( '
1143 .join(', ', @in_sql)
1149 sub _render_op_andor {
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 ($sql, @bind) = $self->_render_op_multop($op, $args);
1155 return '( '.$sql.' )', @bind;
1158 sub _render_op_multop {
1159 my ($self, $op, $args) = @_;
1160 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1161 return '' unless @parts;
1162 return @{$parts[0]} if @parts == 1;
1163 my ($final_sql) = join(
1164 ' '.$self->_sqlcase($op).' ',
1169 map @{$_}[1..$#$_], @parts
1172 sub _render_op_not {
1173 my ($self, $op, $v) = @_;
1174 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1175 return "(${sql})", @bind;
1178 sub _render_unop_prefix {
1179 my ($self, $op, $v) = @_;
1180 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1181 my $op_sql = $self->_sqlcase($op);
1182 return ("${op_sql} ${expr_sql}", @bind);
1185 sub _render_unop_postfix {
1186 my ($self, $op, $v) = @_;
1187 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1188 my $op_sql = $self->_sqlcase($op);
1189 return ($expr_sql.' '.$op_sql, @bind);
1192 # Some databases (SQLite) treat col IN (1, 2) different from
1193 # col IN ( (1, 2) ). Use this to strip all outer parens while
1194 # adding them back in the corresponding method
1195 sub _open_outer_paren {
1196 my ($self, $sql) = @_;
1198 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1200 # there are closing parens inside, need the heavy duty machinery
1201 # to reevaluate the extraction starting from $sql (full reevaluation)
1202 if ($inner =~ /\)/) {
1203 require Text::Balanced;
1205 my (undef, $remainder) = do {
1206 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1208 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1211 # the entire expression needs to be a balanced bracketed thing
1212 # (after an extract no remainder sans trailing space)
1213 last if defined $remainder and $remainder =~ /\S/;
1223 #======================================================================
1225 #======================================================================
1227 sub _expand_order_by {
1228 my ($self, $arg) = @_;
1230 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1232 my $expander = sub {
1233 my ($self, $dir, $expr) = @_;
1234 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1235 foreach my $arg (@to_expand) {
1239 and grep /^-(asc|desc)$/, keys %$arg
1241 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1245 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1247 map $self->expand_expr($_, -ident),
1248 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1249 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1252 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1254 return $self->$expander(undef, $arg);
1258 my ($self, $arg) = @_;
1260 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1262 my ($sql, @bind) = $self->render_aqt($expanded);
1264 return '' unless length($sql);
1266 my $final_sql = $self->_sqlcase(' order by ').$sql;
1268 return wantarray ? ($final_sql, @bind) : $final_sql;
1271 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1273 sub _order_by_chunks {
1274 my ($self, $arg) = @_;
1276 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1278 return $self->_chunkify_order_by($expanded);
1281 sub _chunkify_order_by {
1282 my ($self, $expanded) = @_;
1284 return grep length, $self->render_aqt($expanded)
1285 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1288 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1289 return map $self->_chunkify_order_by($_), @$l;
1291 return [ $self->render_aqt($_) ];
1295 #======================================================================
1296 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1297 #======================================================================
1303 $self->_expand_maybe_list_expr($from, undef, -ident)
1308 #======================================================================
1310 #======================================================================
1312 sub _expand_maybe_list_expr {
1313 my ($self, $expr, $logic, $default) = @_;
1315 if (ref($expr) eq 'ARRAY') {
1317 map $self->expand_expr($_, $default), @$expr
1324 return $self->expand_expr($e, $default);
1327 # highly optimized, as it's called way too often
1329 # my ($self, $label) = @_;
1331 return '' unless defined $_[1];
1332 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1333 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1335 unless ($_[0]->{quote_char}) {
1336 if (ref($_[1]) eq 'ARRAY') {
1337 return join($_[0]->{name_sep}||'.', @{$_[1]});
1339 $_[0]->_assert_pass_injection_guard($_[1]);
1344 my $qref = ref $_[0]->{quote_char};
1346 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1347 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1348 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1350 my $esc = $_[0]->{escape_char} || $r;
1352 # parts containing * are naturally unquoted
1354 $_[0]->{name_sep}||'',
1358 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1360 (ref($_[1]) eq 'ARRAY'
1364 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1372 # Conversion, if applicable
1374 #my ($self, $arg) = @_;
1375 if ($_[0]->{convert_where}) {
1376 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1383 #my ($self, $col, @vals) = @_;
1384 # called often - tighten code
1385 return $_[0]->{bindtype} eq 'columns'
1386 ? map {[$_[1], $_]} @_[2 .. $#_]
1391 # Dies if any element of @bind is not in [colname => value] format
1392 # if bindtype is 'columns'.
1393 sub _assert_bindval_matches_bindtype {
1394 # my ($self, @bind) = @_;
1396 if ($self->{bindtype} eq 'columns') {
1398 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1399 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1405 sub _join_sql_clauses {
1406 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1408 if (@$clauses_aref > 1) {
1409 my $join = " " . $self->_sqlcase($logic) . " ";
1410 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1411 return ($sql, @$bind_aref);
1413 elsif (@$clauses_aref) {
1414 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1417 return (); # if no SQL, ignore @$bind_aref
1422 # Fix SQL case, if so requested
1424 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1425 # don't touch the argument ... crooked logic, but let's not change it!
1426 return $_[0]->{case} ? $_[1] : uc($_[1]);
1430 #======================================================================
1431 # DISPATCHING FROM REFKIND
1432 #======================================================================
1435 my ($self, $data) = @_;
1437 return 'UNDEF' unless defined $data;
1439 # blessed objects are treated like scalars
1440 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1442 return 'SCALAR' unless $ref;
1445 while ($ref eq 'REF') {
1447 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1451 return ($ref||'SCALAR') . ('REF' x $n_steps);
1455 my ($self, $data) = @_;
1456 my @try = ($self->_refkind($data));
1457 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1458 push @try, 'FALLBACK';
1462 sub _METHOD_FOR_refkind {
1463 my ($self, $meth_prefix, $data) = @_;
1466 for (@{$self->_try_refkind($data)}) {
1467 $method = $self->can($meth_prefix."_".$_)
1471 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1475 sub _SWITCH_refkind {
1476 my ($self, $data, $dispatch_table) = @_;
1479 for (@{$self->_try_refkind($data)}) {
1480 $coderef = $dispatch_table->{$_}
1484 puke "no dispatch entry for ".$self->_refkind($data)
1493 #======================================================================
1494 # VALUES, GENERATE, AUTOLOAD
1495 #======================================================================
1497 # LDNOTE: original code from nwiger, didn't touch code in that section
1498 # I feel the AUTOLOAD stuff should not be the default, it should
1499 # only be activated on explicit demand by user.
1503 my $data = shift || return;
1504 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1505 unless ref $data eq 'HASH';
1508 foreach my $k (sort keys %$data) {
1509 my $v = $data->{$k};
1510 $self->_SWITCH_refkind($v, {
1512 if ($self->{array_datatypes}) { # array datatype
1513 push @all_bind, $self->_bindtype($k, $v);
1515 else { # literal SQL with bind
1516 my ($sql, @bind) = @$v;
1517 $self->_assert_bindval_matches_bindtype(@bind);
1518 push @all_bind, @bind;
1521 ARRAYREFREF => sub { # literal SQL with bind
1522 my ($sql, @bind) = @${$v};
1523 $self->_assert_bindval_matches_bindtype(@bind);
1524 push @all_bind, @bind;
1526 SCALARREF => sub { # literal SQL without bind
1528 SCALAR_or_UNDEF => sub {
1529 push @all_bind, $self->_bindtype($k, $v);
1540 my(@sql, @sqlq, @sqlv);
1544 if ($ref eq 'HASH') {
1545 for my $k (sort keys %$_) {
1548 my $label = $self->_quote($k);
1549 if ($r eq 'ARRAY') {
1550 # literal SQL with bind
1551 my ($sql, @bind) = @$v;
1552 $self->_assert_bindval_matches_bindtype(@bind);
1553 push @sqlq, "$label = $sql";
1555 } elsif ($r eq 'SCALAR') {
1556 # literal SQL without bind
1557 push @sqlq, "$label = $$v";
1559 push @sqlq, "$label = ?";
1560 push @sqlv, $self->_bindtype($k, $v);
1563 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1564 } elsif ($ref eq 'ARRAY') {
1565 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1568 if ($r eq 'ARRAY') { # literal SQL with bind
1569 my ($sql, @bind) = @$v;
1570 $self->_assert_bindval_matches_bindtype(@bind);
1573 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1574 # embedded literal SQL
1581 push @sql, '(' . join(', ', @sqlq) . ')';
1582 } elsif ($ref eq 'SCALAR') {
1586 # strings get case twiddled
1587 push @sql, $self->_sqlcase($_);
1591 my $sql = join ' ', @sql;
1593 # this is pretty tricky
1594 # if ask for an array, return ($stmt, @bind)
1595 # otherwise, s/?/shift @sqlv/ to put it inline
1597 return ($sql, @sqlv);
1599 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1600 ref $d ? $d->[1] : $d/e;
1609 # This allows us to check for a local, then _form, attr
1611 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1612 return $self->generate($name, @_);
1623 SQL::Abstract - Generate SQL from Perl data structures
1629 my $sql = SQL::Abstract->new;
1631 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1633 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1635 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1637 my($stmt, @bind) = $sql->delete($table, \%where);
1639 # Then, use these in your DBI statements
1640 my $sth = $dbh->prepare($stmt);
1641 $sth->execute(@bind);
1643 # Just generate the WHERE clause
1644 my($stmt, @bind) = $sql->where(\%where, $order);
1646 # Return values in the same order, for hashed queries
1647 # See PERFORMANCE section for more details
1648 my @bind = $sql->values(\%fieldvals);
1652 This module was inspired by the excellent L<DBIx::Abstract>.
1653 However, in using that module I found that what I really wanted
1654 to do was generate SQL, but still retain complete control over my
1655 statement handles and use the DBI interface. So, I set out to
1656 create an abstract SQL generation module.
1658 While based on the concepts used by L<DBIx::Abstract>, there are
1659 several important differences, especially when it comes to WHERE
1660 clauses. I have modified the concepts used to make the SQL easier
1661 to generate from Perl data structures and, IMO, more intuitive.
1662 The underlying idea is for this module to do what you mean, based
1663 on the data structures you provide it. The big advantage is that
1664 you don't have to modify your code every time your data changes,
1665 as this module figures it out.
1667 To begin with, an SQL INSERT is as easy as just specifying a hash
1668 of C<key=value> pairs:
1671 name => 'Jimbo Bobson',
1672 phone => '123-456-7890',
1673 address => '42 Sister Lane',
1674 city => 'St. Louis',
1675 state => 'Louisiana',
1678 The SQL can then be generated with this:
1680 my($stmt, @bind) = $sql->insert('people', \%data);
1682 Which would give you something like this:
1684 $stmt = "INSERT INTO people
1685 (address, city, name, phone, state)
1686 VALUES (?, ?, ?, ?, ?)";
1687 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1688 '123-456-7890', 'Louisiana');
1690 These are then used directly in your DBI code:
1692 my $sth = $dbh->prepare($stmt);
1693 $sth->execute(@bind);
1695 =head2 Inserting and Updating Arrays
1697 If your database has array types (like for example Postgres),
1698 activate the special option C<< array_datatypes => 1 >>
1699 when creating the C<SQL::Abstract> object.
1700 Then you may use an arrayref to insert and update database array types:
1702 my $sql = SQL::Abstract->new(array_datatypes => 1);
1704 planets => [qw/Mercury Venus Earth Mars/]
1707 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1711 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1713 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1716 =head2 Inserting and Updating SQL
1718 In order to apply SQL functions to elements of your C<%data> you may
1719 specify a reference to an arrayref for the given hash value. For example,
1720 if you need to execute the Oracle C<to_date> function on a value, you can
1721 say something like this:
1725 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1728 The first value in the array is the actual SQL. Any other values are
1729 optional and would be included in the bind values array. This gives
1732 my($stmt, @bind) = $sql->insert('people', \%data);
1734 $stmt = "INSERT INTO people (name, date_entered)
1735 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1736 @bind = ('Bill', '03/02/2003');
1738 An UPDATE is just as easy, all you change is the name of the function:
1740 my($stmt, @bind) = $sql->update('people', \%data);
1742 Notice that your C<%data> isn't touched; the module will generate
1743 the appropriately quirky SQL for you automatically. Usually you'll
1744 want to specify a WHERE clause for your UPDATE, though, which is
1745 where handling C<%where> hashes comes in handy...
1747 =head2 Complex where statements
1749 This module can generate pretty complicated WHERE statements
1750 easily. For example, simple C<key=value> pairs are taken to mean
1751 equality, and if you want to see if a field is within a set
1752 of values, you can use an arrayref. Let's say we wanted to
1753 SELECT some data based on this criteria:
1756 requestor => 'inna',
1757 worker => ['nwiger', 'rcwe', 'sfz'],
1758 status => { '!=', 'completed' }
1761 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1763 The above would give you something like this:
1765 $stmt = "SELECT * FROM tickets WHERE
1766 ( requestor = ? ) AND ( status != ? )
1767 AND ( worker = ? OR worker = ? OR worker = ? )";
1768 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1770 Which you could then use in DBI code like so:
1772 my $sth = $dbh->prepare($stmt);
1773 $sth->execute(@bind);
1779 The methods are simple. There's one for every major SQL operation,
1780 and a constructor you use first. The arguments are specified in a
1781 similar order for each method (table, then fields, then a where
1782 clause) to try and simplify things.
1784 =head2 new(option => 'value')
1786 The C<new()> function takes a list of options and values, and returns
1787 a new B<SQL::Abstract> object which can then be used to generate SQL
1788 through the methods below. The options accepted are:
1794 If set to 'lower', then SQL will be generated in all lowercase. By
1795 default SQL is generated in "textbook" case meaning something like:
1797 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1799 Any setting other than 'lower' is ignored.
1803 This determines what the default comparison operator is. By default
1804 it is C<=>, meaning that a hash like this:
1806 %where = (name => 'nwiger', email => 'nate@wiger.org');
1808 Will generate SQL like this:
1810 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1812 However, you may want loose comparisons by default, so if you set
1813 C<cmp> to C<like> you would get SQL such as:
1815 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1817 You can also override the comparison on an individual basis - see
1818 the huge section on L</"WHERE CLAUSES"> at the bottom.
1820 =item sqltrue, sqlfalse
1822 Expressions for inserting boolean values within SQL statements.
1823 By default these are C<1=1> and C<1=0>. They are used
1824 by the special operators C<-in> and C<-not_in> for generating
1825 correct SQL even when the argument is an empty array (see below).
1829 This determines the default logical operator for multiple WHERE
1830 statements in arrays or hashes. If absent, the default logic is "or"
1831 for arrays, and "and" for hashes. This means that a WHERE
1835 event_date => {'>=', '2/13/99'},
1836 event_date => {'<=', '4/24/03'},
1839 will generate SQL like this:
1841 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1843 This is probably not what you want given this query, though (look
1844 at the dates). To change the "OR" to an "AND", simply specify:
1846 my $sql = SQL::Abstract->new(logic => 'and');
1848 Which will change the above C<WHERE> to:
1850 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1852 The logic can also be changed locally by inserting
1853 a modifier in front of an arrayref:
1855 @where = (-and => [event_date => {'>=', '2/13/99'},
1856 event_date => {'<=', '4/24/03'} ]);
1858 See the L</"WHERE CLAUSES"> section for explanations.
1862 This will automatically convert comparisons using the specified SQL
1863 function for both column and value. This is mostly used with an argument
1864 of C<upper> or C<lower>, so that the SQL will have the effect of
1865 case-insensitive "searches". For example, this:
1867 $sql = SQL::Abstract->new(convert => 'upper');
1868 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1870 Will turn out the following SQL:
1872 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1874 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1875 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1876 not validate this option; it will just pass through what you specify verbatim).
1880 This is a kludge because many databases suck. For example, you can't
1881 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1882 Instead, you have to use C<bind_param()>:
1884 $sth->bind_param(1, 'reg data');
1885 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1887 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1888 which loses track of which field each slot refers to. Fear not.
1890 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1891 Currently, you can specify either C<normal> (default) or C<columns>. If you
1892 specify C<columns>, you will get an array that looks like this:
1894 my $sql = SQL::Abstract->new(bindtype => 'columns');
1895 my($stmt, @bind) = $sql->insert(...);
1898 [ 'column1', 'value1' ],
1899 [ 'column2', 'value2' ],
1900 [ 'column3', 'value3' ],
1903 You can then iterate through this manually, using DBI's C<bind_param()>.
1905 $sth->prepare($stmt);
1908 my($col, $data) = @$_;
1909 if ($col eq 'details' || $col eq 'comments') {
1910 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1911 } elsif ($col eq 'image') {
1912 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1914 $sth->bind_param($i, $data);
1918 $sth->execute; # execute without @bind now
1920 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1921 Basically, the advantage is still that you don't have to care which fields
1922 are or are not included. You could wrap that above C<for> loop in a simple
1923 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1924 get a layer of abstraction over manual SQL specification.
1926 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1927 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1928 will expect the bind values in this format.
1932 This is the character that a table or column name will be quoted
1933 with. By default this is an empty string, but you could set it to
1934 the character C<`>, to generate SQL like this:
1936 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1938 Alternatively, you can supply an array ref of two items, the first being the left
1939 hand quote character, and the second the right hand quote character. For
1940 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1941 that generates SQL like this:
1943 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1945 Quoting is useful if you have tables or columns names that are reserved
1946 words in your database's SQL dialect.
1950 This is the character that will be used to escape L</quote_char>s appearing
1951 in an identifier before it has been quoted.
1953 The parameter default in case of a single L</quote_char> character is the quote
1956 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1957 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1958 of the B<opening (left)> L</quote_char> within the identifier are currently left
1959 untouched. The default for opening-closing-style quotes may change in future
1960 versions, thus you are B<strongly encouraged> to specify the escape character
1965 This is the character that separates a table and column name. It is
1966 necessary to specify this when the C<quote_char> option is selected,
1967 so that tables and column names can be individually quoted like this:
1969 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1971 =item injection_guard
1973 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1974 column name specified in a query structure. This is a safety mechanism to avoid
1975 injection attacks when mishandling user input e.g.:
1977 my %condition_as_column_value_pairs = get_values_from_user();
1978 $sqla->select( ... , \%condition_as_column_value_pairs );
1980 If the expression matches an exception is thrown. Note that literal SQL
1981 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1983 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1985 =item array_datatypes
1987 When this option is true, arrayrefs in INSERT or UPDATE are
1988 interpreted as array datatypes and are passed directly
1990 When this option is false, arrayrefs are interpreted
1991 as literal SQL, just like refs to arrayrefs
1992 (but this behavior is for backwards compatibility; when writing
1993 new queries, use the "reference to arrayref" syntax
1999 Takes a reference to a list of "special operators"
2000 to extend the syntax understood by L<SQL::Abstract>.
2001 See section L</"SPECIAL OPERATORS"> for details.
2005 Takes a reference to a list of "unary operators"
2006 to extend the syntax understood by L<SQL::Abstract>.
2007 See section L</"UNARY OPERATORS"> for details.
2013 =head2 insert($table, \@values || \%fieldvals, \%options)
2015 This is the simplest function. You simply give it a table name
2016 and either an arrayref of values or hashref of field/value pairs.
2017 It returns an SQL INSERT statement and a list of bind values.
2018 See the sections on L</"Inserting and Updating Arrays"> and
2019 L</"Inserting and Updating SQL"> for information on how to insert
2020 with those data types.
2022 The optional C<\%options> hash reference may contain additional
2023 options to generate the insert SQL. Currently supported options
2030 Takes either a scalar of raw SQL fields, or an array reference of
2031 field names, and adds on an SQL C<RETURNING> statement at the end.
2032 This allows you to return data generated by the insert statement
2033 (such as row IDs) without performing another C<SELECT> statement.
2034 Note, however, this is not part of the SQL standard and may not
2035 be supported by all database engines.
2039 =head2 update($table, \%fieldvals, \%where, \%options)
2041 This takes a table, hashref of field/value pairs, and an optional
2042 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2044 See the sections on L</"Inserting and Updating Arrays"> and
2045 L</"Inserting and Updating SQL"> for information on how to insert
2046 with those data types.
2048 The optional C<\%options> hash reference may contain additional
2049 options to generate the update SQL. Currently supported options
2056 See the C<returning> option to
2057 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2061 =head2 select($source, $fields, $where, $order)
2063 This returns a SQL SELECT statement and associated list of bind values, as
2064 specified by the arguments:
2070 Specification of the 'FROM' part of the statement.
2071 The argument can be either a plain scalar (interpreted as a table
2072 name, will be quoted), or an arrayref (interpreted as a list
2073 of table names, joined by commas, quoted), or a scalarref
2074 (literal SQL, not quoted).
2078 Specification of the list of fields to retrieve from
2080 The argument can be either an arrayref (interpreted as a list
2081 of field names, will be joined by commas and quoted), or a
2082 plain scalar (literal SQL, not quoted).
2083 Please observe that this API is not as flexible as that of
2084 the first argument C<$source>, for backwards compatibility reasons.
2088 Optional argument to specify the WHERE part of the query.
2089 The argument is most often a hashref, but can also be
2090 an arrayref or plain scalar --
2091 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2095 Optional argument to specify the ORDER BY part of the query.
2096 The argument can be a scalar, a hashref or an arrayref
2097 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2103 =head2 delete($table, \%where, \%options)
2105 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2106 It returns an SQL DELETE statement and list of bind values.
2108 The optional C<\%options> hash reference may contain additional
2109 options to generate the delete SQL. Currently supported options
2116 See the C<returning> option to
2117 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2121 =head2 where(\%where, $order)
2123 This is used to generate just the WHERE clause. For example,
2124 if you have an arbitrary data structure and know what the
2125 rest of your SQL is going to look like, but want an easy way
2126 to produce a WHERE clause, use this. It returns an SQL WHERE
2127 clause and list of bind values.
2130 =head2 values(\%data)
2132 This just returns the values from the hash C<%data>, in the same
2133 order that would be returned from any of the other above queries.
2134 Using this allows you to markedly speed up your queries if you
2135 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2137 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2139 Warning: This is an experimental method and subject to change.
2141 This returns arbitrarily generated SQL. It's a really basic shortcut.
2142 It will return two different things, depending on return context:
2144 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2145 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2147 These would return the following:
2149 # First calling form
2150 $stmt = "CREATE TABLE test (?, ?)";
2151 @bind = (field1, field2);
2153 # Second calling form
2154 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2156 Depending on what you're trying to do, it's up to you to choose the correct
2157 format. In this example, the second form is what you would want.
2161 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2165 ALTER SESSION SET nls_date_format = 'MM/YY'
2167 You get the idea. Strings get their case twiddled, but everything
2168 else remains verbatim.
2170 =head1 EXPORTABLE FUNCTIONS
2172 =head2 is_plain_value
2174 Determines if the supplied argument is a plain value as understood by this
2179 =item * The value is C<undef>
2181 =item * The value is a non-reference
2183 =item * The value is an object with stringification overloading
2185 =item * The value is of the form C<< { -value => $anything } >>
2189 On failure returns C<undef>, on success returns a B<scalar> reference
2190 to the original supplied argument.
2196 The stringification overloading detection is rather advanced: it takes
2197 into consideration not only the presence of a C<""> overload, but if that
2198 fails also checks for enabled
2199 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2200 on either C<0+> or C<bool>.
2202 Unfortunately testing in the field indicates that this
2203 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2204 but only when very large numbers of stringifying objects are involved.
2205 At the time of writing ( Sep 2014 ) there is no clear explanation of
2206 the direct cause, nor is there a manageably small test case that reliably
2207 reproduces the problem.
2209 If you encounter any of the following exceptions in B<random places within
2210 your application stack> - this module may be to blame:
2212 Operation "ne": no method found,
2213 left argument in overloaded package <something>,
2214 right argument in overloaded package <something>
2218 Stub found while resolving method "???" overloading """" in package <something>
2220 If you fall victim to the above - please attempt to reduce the problem
2221 to something that could be sent to the L<SQL::Abstract developers
2222 |DBIx::Class/GETTING HELP/SUPPORT>
2223 (either publicly or privately). As a workaround in the meantime you can
2224 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2225 value, which will most likely eliminate your problem (at the expense of
2226 not being able to properly detect exotic forms of stringification).
2228 This notice and environment variable will be removed in a future version,
2229 as soon as the underlying problem is found and a reliable workaround is
2234 =head2 is_literal_value
2236 Determines if the supplied argument is a literal value as understood by this
2241 =item * C<\$sql_string>
2243 =item * C<\[ $sql_string, @bind_values ]>
2247 On failure returns C<undef>, on success returns an B<array> reference
2248 containing the unpacked version of the supplied literal SQL and bind values.
2250 =head1 WHERE CLAUSES
2254 This module uses a variation on the idea from L<DBIx::Abstract>. It
2255 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2256 module is that things in arrays are OR'ed, and things in hashes
2259 The easiest way to explain is to show lots of examples. After
2260 each C<%where> hash shown, it is assumed you used:
2262 my($stmt, @bind) = $sql->where(\%where);
2264 However, note that the C<%where> hash can be used directly in any
2265 of the other functions as well, as described above.
2267 =head2 Key-value pairs
2269 So, let's get started. To begin, a simple hash:
2273 status => 'completed'
2276 Is converted to SQL C<key = val> statements:
2278 $stmt = "WHERE user = ? AND status = ?";
2279 @bind = ('nwiger', 'completed');
2281 One common thing I end up doing is having a list of values that
2282 a field can be in. To do this, simply specify a list inside of
2287 status => ['assigned', 'in-progress', 'pending'];
2290 This simple code will create the following:
2292 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2293 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2295 A field associated to an empty arrayref will be considered a
2296 logical false and will generate 0=1.
2298 =head2 Tests for NULL values
2300 If the value part is C<undef> then this is converted to SQL <IS NULL>
2309 $stmt = "WHERE user = ? AND status IS NULL";
2312 To test if a column IS NOT NULL:
2316 status => { '!=', undef },
2319 =head2 Specific comparison operators
2321 If you want to specify a different type of operator for your comparison,
2322 you can use a hashref for a given column:
2326 status => { '!=', 'completed' }
2329 Which would generate:
2331 $stmt = "WHERE user = ? AND status != ?";
2332 @bind = ('nwiger', 'completed');
2334 To test against multiple values, just enclose the values in an arrayref:
2336 status => { '=', ['assigned', 'in-progress', 'pending'] };
2338 Which would give you:
2340 "WHERE status = ? OR status = ? OR status = ?"
2343 The hashref can also contain multiple pairs, in which case it is expanded
2344 into an C<AND> of its elements:
2348 status => { '!=', 'completed', -not_like => 'pending%' }
2351 # Or more dynamically, like from a form
2352 $where{user} = 'nwiger';
2353 $where{status}{'!='} = 'completed';
2354 $where{status}{'-not_like'} = 'pending%';
2356 # Both generate this
2357 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2358 @bind = ('nwiger', 'completed', 'pending%');
2361 To get an OR instead, you can combine it with the arrayref idea:
2365 priority => [ { '=', 2 }, { '>', 5 } ]
2368 Which would generate:
2370 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2371 @bind = ('2', '5', 'nwiger');
2373 If you want to include literal SQL (with or without bind values), just use a
2374 scalar reference or reference to an arrayref as the value:
2377 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2378 date_expires => { '<' => \"now()" }
2381 Which would generate:
2383 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2384 @bind = ('11/26/2008');
2387 =head2 Logic and nesting operators
2389 In the example above,
2390 there is a subtle trap if you want to say something like
2391 this (notice the C<AND>):
2393 WHERE priority != ? AND priority != ?
2395 Because, in Perl you I<can't> do this:
2397 priority => { '!=' => 2, '!=' => 1 }
2399 As the second C<!=> key will obliterate the first. The solution
2400 is to use the special C<-modifier> form inside an arrayref:
2402 priority => [ -and => {'!=', 2},
2406 Normally, these would be joined by C<OR>, but the modifier tells it
2407 to use C<AND> instead. (Hint: You can use this in conjunction with the
2408 C<logic> option to C<new()> in order to change the way your queries
2409 work by default.) B<Important:> Note that the C<-modifier> goes
2410 B<INSIDE> the arrayref, as an extra first element. This will
2411 B<NOT> do what you think it might:
2413 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2415 Here is a quick list of equivalencies, since there is some overlap:
2418 status => {'!=', 'completed', 'not like', 'pending%' }
2419 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2422 status => {'=', ['assigned', 'in-progress']}
2423 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2424 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2428 =head2 Special operators: IN, BETWEEN, etc.
2430 You can also use the hashref format to compare a list of fields using the
2431 C<IN> comparison operator, by specifying the list as an arrayref:
2434 status => 'completed',
2435 reportid => { -in => [567, 2335, 2] }
2438 Which would generate:
2440 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2441 @bind = ('completed', '567', '2335', '2');
2443 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2446 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2447 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2448 'sqltrue' (by default: C<1=1>).
2450 In addition to the array you can supply a chunk of literal sql or
2451 literal sql with bind:
2454 customer => { -in => \[
2455 'SELECT cust_id FROM cust WHERE balance > ?',
2458 status => { -in => \'SELECT status_codes FROM states' },
2464 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2465 AND status IN ( SELECT status_codes FROM states )
2469 Finally, if the argument to C<-in> is not a reference, it will be
2470 treated as a single-element array.
2472 Another pair of operators is C<-between> and C<-not_between>,
2473 used with an arrayref of two values:
2477 completion_date => {
2478 -not_between => ['2002-10-01', '2003-02-06']
2484 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2486 Just like with C<-in> all plausible combinations of literal SQL
2490 start0 => { -between => [ 1, 2 ] },
2491 start1 => { -between => \["? AND ?", 1, 2] },
2492 start2 => { -between => \"lower(x) AND upper(y)" },
2493 start3 => { -between => [
2495 \["upper(?)", 'stuff' ],
2502 ( start0 BETWEEN ? AND ? )
2503 AND ( start1 BETWEEN ? AND ? )
2504 AND ( start2 BETWEEN lower(x) AND upper(y) )
2505 AND ( start3 BETWEEN lower(x) AND upper(?) )
2507 @bind = (1, 2, 1, 2, 'stuff');
2510 These are the two builtin "special operators"; but the
2511 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2513 =head2 Unary operators: bool
2515 If you wish to test against boolean columns or functions within your
2516 database you can use the C<-bool> and C<-not_bool> operators. For
2517 example to test the column C<is_user> being true and the column
2518 C<is_enabled> being false you would use:-
2522 -not_bool => 'is_enabled',
2527 WHERE is_user AND NOT is_enabled
2529 If a more complex combination is required, testing more conditions,
2530 then you should use the and/or operators:-
2535 -not_bool => { two=> { -rlike => 'bar' } },
2536 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2547 (NOT ( three = ? OR three > ? ))
2550 =head2 Nested conditions, -and/-or prefixes
2552 So far, we've seen how multiple conditions are joined with a top-level
2553 C<AND>. We can change this by putting the different conditions we want in
2554 hashes and then putting those hashes in an array. For example:
2559 status => { -like => ['pending%', 'dispatched'] },
2563 status => 'unassigned',
2567 This data structure would create the following:
2569 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2570 OR ( user = ? AND status = ? ) )";
2571 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2574 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2575 to change the logic inside:
2581 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2582 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2589 $stmt = "WHERE ( user = ?
2590 AND ( ( workhrs > ? AND geo = ? )
2591 OR ( workhrs < ? OR geo = ? ) ) )";
2592 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2594 =head3 Algebraic inconsistency, for historical reasons
2596 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2597 operator goes C<outside> of the nested structure; whereas when connecting
2598 several constraints on one column, the C<-and> operator goes
2599 C<inside> the arrayref. Here is an example combining both features:
2602 -and => [a => 1, b => 2],
2603 -or => [c => 3, d => 4],
2604 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2609 WHERE ( ( ( a = ? AND b = ? )
2610 OR ( c = ? OR d = ? )
2611 OR ( e LIKE ? AND e LIKE ? ) ) )
2613 This difference in syntax is unfortunate but must be preserved for
2614 historical reasons. So be careful: the two examples below would
2615 seem algebraically equivalent, but they are not
2618 { -like => 'foo%' },
2619 { -like => '%bar' },
2621 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2624 { col => { -like => 'foo%' } },
2625 { col => { -like => '%bar' } },
2627 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2630 =head2 Literal SQL and value type operators
2632 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2633 side" is a column name and the "right side" is a value (normally rendered as
2634 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2635 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2636 alter this behavior. There are several ways of doing so.
2640 This is a virtual operator that signals the string to its right side is an
2641 identifier (a column name) and not a value. For example to compare two
2642 columns you would write:
2645 priority => { '<', 2 },
2646 requestor => { -ident => 'submitter' },
2651 $stmt = "WHERE priority < ? AND requestor = submitter";
2654 If you are maintaining legacy code you may see a different construct as
2655 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2660 This is a virtual operator that signals that the construct to its right side
2661 is a value to be passed to DBI. This is for example necessary when you want
2662 to write a where clause against an array (for RDBMS that support such
2663 datatypes). For example:
2666 array => { -value => [1, 2, 3] }
2671 $stmt = 'WHERE array = ?';
2672 @bind = ([1, 2, 3]);
2674 Note that if you were to simply say:
2680 the result would probably not be what you wanted:
2682 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2687 Finally, sometimes only literal SQL will do. To include a random snippet
2688 of SQL verbatim, you specify it as a scalar reference. Consider this only
2689 as a last resort. Usually there is a better way. For example:
2692 priority => { '<', 2 },
2693 requestor => { -in => \'(SELECT name FROM hitmen)' },
2698 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2701 Note that in this example, you only get one bind parameter back, since
2702 the verbatim SQL is passed as part of the statement.
2706 Never use untrusted input as a literal SQL argument - this is a massive
2707 security risk (there is no way to check literal snippets for SQL
2708 injections and other nastyness). If you need to deal with untrusted input
2709 use literal SQL with placeholders as described next.
2711 =head3 Literal SQL with placeholders and bind values (subqueries)
2713 If the literal SQL to be inserted has placeholders and bind values,
2714 use a reference to an arrayref (yes this is a double reference --
2715 not so common, but perfectly legal Perl). For example, to find a date
2716 in Postgres you can use something like this:
2719 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2724 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2727 Note that you must pass the bind values in the same format as they are returned
2728 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2729 to C<columns>, you must provide the bind values in the
2730 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2731 scalar value; most commonly the column name, but you can use any scalar value
2732 (including references and blessed references), L<SQL::Abstract> will simply
2733 pass it through intact. So if C<bindtype> is set to C<columns> the above
2734 example will look like:
2737 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2740 Literal SQL is especially useful for nesting parenthesized clauses in the
2741 main SQL query. Here is a first example:
2743 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2747 bar => \["IN ($sub_stmt)" => @sub_bind],
2752 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2753 WHERE c2 < ? AND c3 LIKE ?))";
2754 @bind = (1234, 100, "foo%");
2756 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2757 are expressed in the same way. Of course the C<$sub_stmt> and
2758 its associated bind values can be generated through a former call
2761 my ($sub_stmt, @sub_bind)
2762 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2763 c3 => {-like => "foo%"}});
2766 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2769 In the examples above, the subquery was used as an operator on a column;
2770 but the same principle also applies for a clause within the main C<%where>
2771 hash, like an EXISTS subquery:
2773 my ($sub_stmt, @sub_bind)
2774 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2775 my %where = ( -and => [
2777 \["EXISTS ($sub_stmt)" => @sub_bind],
2782 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2783 WHERE c1 = ? AND c2 > t0.c0))";
2787 Observe that the condition on C<c2> in the subquery refers to
2788 column C<t0.c0> of the main query: this is I<not> a bind
2789 value, so we have to express it through a scalar ref.
2790 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2791 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2792 what we wanted here.
2794 Finally, here is an example where a subquery is used
2795 for expressing unary negation:
2797 my ($sub_stmt, @sub_bind)
2798 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2799 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2801 lname => {like => '%son%'},
2802 \["NOT ($sub_stmt)" => @sub_bind],
2807 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2808 @bind = ('%son%', 10, 20)
2810 =head3 Deprecated usage of Literal SQL
2812 Below are some examples of archaic use of literal SQL. It is shown only as
2813 reference for those who deal with legacy code. Each example has a much
2814 better, cleaner and safer alternative that users should opt for in new code.
2820 my %where = ( requestor => \'IS NOT NULL' )
2822 $stmt = "WHERE requestor IS NOT NULL"
2824 This used to be the way of generating NULL comparisons, before the handling
2825 of C<undef> got formalized. For new code please use the superior syntax as
2826 described in L</Tests for NULL values>.
2830 my %where = ( requestor => \'= submitter' )
2832 $stmt = "WHERE requestor = submitter"
2834 This used to be the only way to compare columns. Use the superior L</-ident>
2835 method for all new code. For example an identifier declared in such a way
2836 will be properly quoted if L</quote_char> is properly set, while the legacy
2837 form will remain as supplied.
2841 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2843 $stmt = "WHERE completed > ? AND is_ready"
2844 @bind = ('2012-12-21')
2846 Using an empty string literal used to be the only way to express a boolean.
2847 For all new code please use the much more readable
2848 L<-bool|/Unary operators: bool> operator.
2854 These pages could go on for a while, since the nesting of the data
2855 structures this module can handle are pretty much unlimited (the
2856 module implements the C<WHERE> expansion as a recursive function
2857 internally). Your best bet is to "play around" with the module a
2858 little to see how the data structures behave, and choose the best
2859 format for your data based on that.
2861 And of course, all the values above will probably be replaced with
2862 variables gotten from forms or the command line. After all, if you
2863 knew everything ahead of time, you wouldn't have to worry about
2864 dynamically-generating SQL and could just hardwire it into your
2867 =head1 ORDER BY CLAUSES
2869 Some functions take an order by clause. This can either be a scalar (just a
2870 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2871 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2874 Given | Will Generate
2875 ---------------------------------------------------------------
2877 'colA' | ORDER BY colA
2879 [qw/colA colB/] | ORDER BY colA, colB
2881 {-asc => 'colA'} | ORDER BY colA ASC
2883 {-desc => 'colB'} | ORDER BY colB DESC
2885 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2887 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2889 \'colA DESC' | ORDER BY colA DESC
2891 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2892 | /* ...with $x bound to ? */
2895 { -asc => 'colA' }, | colA ASC,
2896 { -desc => [qw/colB/] }, | colB DESC,
2897 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2898 \'colE DESC', | colE DESC,
2899 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2900 ] | /* ...with $x bound to ? */
2901 ===============================================================
2905 =head1 SPECIAL OPERATORS
2907 my $sqlmaker = SQL::Abstract->new(special_ops => [
2911 my ($self, $field, $op, $arg) = @_;
2917 handler => 'method_name',
2921 A "special operator" is a SQL syntactic clause that can be
2922 applied to a field, instead of a usual binary operator.
2925 WHERE field IN (?, ?, ?)
2926 WHERE field BETWEEN ? AND ?
2927 WHERE MATCH(field) AGAINST (?, ?)
2929 Special operators IN and BETWEEN are fairly standard and therefore
2930 are builtin within C<SQL::Abstract> (as the overridable methods
2931 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2932 like the MATCH .. AGAINST example above which is specific to MySQL,
2933 you can write your own operator handlers - supply a C<special_ops>
2934 argument to the C<new> method. That argument takes an arrayref of
2935 operator definitions; each operator definition is a hashref with two
2942 the regular expression to match the operator
2946 Either a coderef or a plain scalar method name. In both cases
2947 the expected return is C<< ($sql, @bind) >>.
2949 When supplied with a method name, it is simply called on the
2950 L<SQL::Abstract> object as:
2952 $self->$method_name($field, $op, $arg)
2956 $field is the LHS of the operator
2957 $op is the part that matched the handler regex
2960 When supplied with a coderef, it is called as:
2962 $coderef->($self, $field, $op, $arg)
2967 For example, here is an implementation
2968 of the MATCH .. AGAINST syntax for MySQL
2970 my $sqlmaker = SQL::Abstract->new(special_ops => [
2972 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2973 {regex => qr/^match$/i,
2975 my ($self, $field, $op, $arg) = @_;
2976 $arg = [$arg] if not ref $arg;
2977 my $label = $self->_quote($field);
2978 my ($placeholder) = $self->_convert('?');
2979 my $placeholders = join ", ", (($placeholder) x @$arg);
2980 my $sql = $self->_sqlcase('match') . " ($label) "
2981 . $self->_sqlcase('against') . " ($placeholders) ";
2982 my @bind = $self->_bindtype($field, @$arg);
2983 return ($sql, @bind);
2990 =head1 UNARY OPERATORS
2992 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2996 my ($self, $op, $arg) = @_;
3002 handler => 'method_name',
3006 A "unary operator" is a SQL syntactic clause that can be
3007 applied to a field - the operator goes before the field
3009 You can write your own operator handlers - supply a C<unary_ops>
3010 argument to the C<new> method. That argument takes an arrayref of
3011 operator definitions; each operator definition is a hashref with two
3018 the regular expression to match the operator
3022 Either a coderef or a plain scalar method name. In both cases
3023 the expected return is C<< $sql >>.
3025 When supplied with a method name, it is simply called on the
3026 L<SQL::Abstract> object as:
3028 $self->$method_name($op, $arg)
3032 $op is the part that matched the handler regex
3033 $arg is the RHS or argument of the operator
3035 When supplied with a coderef, it is called as:
3037 $coderef->($self, $op, $arg)
3045 Thanks to some benchmarking by Mark Stosberg, it turns out that
3046 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3047 I must admit this wasn't an intentional design issue, but it's a
3048 byproduct of the fact that you get to control your C<DBI> handles
3051 To maximize performance, use a code snippet like the following:
3053 # prepare a statement handle using the first row
3054 # and then reuse it for the rest of the rows
3056 for my $href (@array_of_hashrefs) {
3057 $stmt ||= $sql->insert('table', $href);
3058 $sth ||= $dbh->prepare($stmt);
3059 $sth->execute($sql->values($href));
3062 The reason this works is because the keys in your C<$href> are sorted
3063 internally by B<SQL::Abstract>. Thus, as long as your data retains
3064 the same structure, you only have to generate the SQL the first time
3065 around. On subsequent queries, simply use the C<values> function provided
3066 by this module to return your values in the correct order.
3068 However this depends on the values having the same type - if, for
3069 example, the values of a where clause may either have values
3070 (resulting in sql of the form C<column = ?> with a single bind
3071 value), or alternatively the values might be C<undef> (resulting in
3072 sql of the form C<column IS NULL> with no bind value) then the
3073 caching technique suggested will not work.
3077 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3078 really like this part (I do, at least). Building up a complex query
3079 can be as simple as the following:
3086 use CGI::FormBuilder;
3089 my $form = CGI::FormBuilder->new(...);
3090 my $sql = SQL::Abstract->new;
3092 if ($form->submitted) {
3093 my $field = $form->field;
3094 my $id = delete $field->{id};
3095 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3098 Of course, you would still have to connect using C<DBI> to run the
3099 query, but the point is that if you make your form look like your
3100 table, the actual query script can be extremely simplistic.
3102 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3103 a fast interface to returning and formatting data. I frequently
3104 use these three modules together to write complex database query
3105 apps in under 50 lines.
3107 =head1 HOW TO CONTRIBUTE
3109 Contributions are always welcome, in all usable forms (we especially
3110 welcome documentation improvements). The delivery methods include git-
3111 or unified-diff formatted patches, GitHub pull requests, or plain bug
3112 reports either via RT or the Mailing list. Contributors are generally
3113 granted full access to the official repository after their first several
3114 patches pass successful review.
3116 This project is maintained in a git repository. The code and related tools are
3117 accessible at the following locations:
3121 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3123 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3125 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3127 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3133 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3134 Great care has been taken to preserve the I<published> behavior
3135 documented in previous versions in the 1.* family; however,
3136 some features that were previously undocumented, or behaved
3137 differently from the documentation, had to be changed in order
3138 to clarify the semantics. Hence, client code that was relying
3139 on some dark areas of C<SQL::Abstract> v1.*
3140 B<might behave differently> in v1.50.
3142 The main changes are:
3148 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3152 support for the { operator => \"..." } construct (to embed literal SQL)
3156 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3160 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3164 defensive programming: check arguments
3168 fixed bug with global logic, which was previously implemented
3169 through global variables yielding side-effects. Prior versions would
3170 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3171 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3172 Now this is interpreted
3173 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3178 fixed semantics of _bindtype on array args
3182 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3183 we just avoid shifting arrays within that tree.
3187 dropped the C<_modlogic> function
3191 =head1 ACKNOWLEDGEMENTS
3193 There are a number of individuals that have really helped out with
3194 this module. Unfortunately, most of them submitted bugs via CPAN
3195 so I have no idea who they are! But the people I do know are:
3197 Ash Berlin (order_by hash term support)
3198 Matt Trout (DBIx::Class support)
3199 Mark Stosberg (benchmarking)
3200 Chas Owens (initial "IN" operator support)
3201 Philip Collins (per-field SQL functions)
3202 Eric Kolve (hashref "AND" support)
3203 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3204 Dan Kubb (support for "quote_char" and "name_sep")
3205 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3206 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3207 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3208 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3209 Oliver Charles (support for "RETURNING" after "INSERT")
3215 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3219 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3221 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3223 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3224 While not an official support venue, C<DBIx::Class> makes heavy use of
3225 C<SQL::Abstract>, and as such list members there are very familiar with
3226 how to create queries.
3230 This module is free software; you may copy this under the same
3231 terms as perl itself (either the GNU General Public License or
3232 the Artistic License)