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);
650 # single key hashref is a hashtriple
652 if (ref($v) eq 'HASH') {
653 return $self->_expand_expr_hashtriple($k, %$v);
656 # arrayref needs re-engineering over the elements
658 if (ref($v) eq 'ARRAY') {
659 return $self->sqlfalse unless @$v;
660 $self->_debug("ARRAY($k) means distribute over elements");
662 $v->[0] =~ /^-(and|or)$/i
663 ? shift(@{$v = [ @$v ]})
664 : '-'.lc($self->{logic} || 'OR')
666 return $self->_expand_op_andor(
671 if (my $literal = is_literal_value($v)) {
673 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
676 my ($sql, @bind) = @$literal;
677 if ($self->{bindtype} eq 'columns') {
679 $self->_assert_bindval_matches_bindtype($_);
682 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
687 sub _expand_expr_scalar {
688 my ($self, $expr) = @_;
690 if (my $d = our $Default_Scalar_To) {
691 return $self->_expand_expr({ $d => $expr });
693 return $self->_expand_value(-value => $expr);
696 sub _expand_expr_hashpair_scalar {
697 my ($self, $k, $v) = @_;
699 return $self->_expand_expr_hashpair_cmp(
700 $k, $self->_expand_expr_scalar($v),
704 sub _expand_expr_hashpair_op {
705 my ($self, $k, $v) = @_;
708 $op =~ s/^-// if length($op) > 1;
709 $self->_assert_pass_injection_guard($op);
711 # Ops prefixed with -not_ get converted
713 if (my ($rest) = $op =~/^not[_ ](.*)$/) {
716 $self->_expand_expr({ "-${rest}", $v })
723 # the old special op system requires illegality for top-level use
726 (our $Expand_Depth) == 1
727 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
729 puke "Illegal use of top-level '-$op'"
732 # the old unary op system means we should touch nothing and let it work
734 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
735 return { -op => [ $op, $v ] };
739 # an explicit node type is currently assumed to be expanded (this is almost
740 # certainly wrong and there should be expansion anyway)
742 if ($self->{render}{$k}) {
746 # hashref RHS values get expanded and used as op/func args
751 and (keys %$v)[0] =~ /^-/
753 my ($func) = $k =~ /^-(.*)$/;
755 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
756 return +{ -op => [ $func, $self->_expand_expr($v) ] };
759 return +{ -func => [ $func, $self->_expand_expr($v) ] };
762 # scalars and literals get simply expanded
764 if (!ref($v) or is_literal_value($v)) {
765 return +{ -op => [ $op, $self->_expand_expr($v) ] };
771 sub _expand_expr_hashpair_cmp {
772 my ($self, $k, $v) = @_;
773 $self->_expand_expr_hashtriple($k, $self->{cmp}, $v);
776 sub _expand_expr_hashtriple {
777 my ($self, $k, $vk, $vv) = @_;
779 my $ik = $self->_expand_ident(-ident => $k);
781 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
782 $self->_assert_pass_injection_guard($op);
783 if ($op =~ s/ [_\s]? \d+ $//x ) {
784 return $self->_expand_expr($k, { $vk, $vv });
786 if (my $x = $self->{expand_op}{$op}) {
787 local our $Cur_Col_Meta = $k;
788 return $self->$x($op, $vv, $k);
791 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
792 return { -op => [ $op, $ik, $vv ] };
794 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
798 { -op => [ $op, $vv ] }
802 if (ref($vv) eq 'ARRAY') {
804 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
805 ? shift @raw : '-or';
806 my @values = map +{ $vk => $_ }, @raw;
808 $op =~ $self->{inequality_op}
809 or $op =~ $self->{not_like_op}
811 if (lc($logic) eq '-or' and @values > 1) {
812 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
813 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
814 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
819 # try to DWIM on equality operators
820 return ($self->_dwim_op_to_is($op,
821 "Supplying an empty arrayref to '%s' is deprecated",
822 "operator '%s' applied on an empty array (field '$k')"
823 ) ? $self->sqlfalse : $self->sqltrue);
825 return $self->_expand_op_andor($logic => \@values, $k);
827 if (is_undef_value($vv)) {
828 my $is = ($self->_dwim_op_to_is($op,
829 "Supplying an undefined argument to '%s' is deprecated",
830 "unexpected operator '%s' with undef operand",
831 ) ? 'is' : 'is not');
833 return $self->_expand_expr_hashpair($k => { $is, undef });
835 local our $Cur_Col_Meta = $k;
839 $self->_expand_expr($vv)
844 my ($self, $op, $empty, $fail) = @_;
845 if ($op =~ /^not$/i) {
848 if ($op =~ $self->{equality_op}) {
851 if ($op =~ $self->{like_op}) {
852 belch(sprintf $empty, uc($op));
855 if ($op =~ $self->{inequality_op}) {
858 if ($op =~ $self->{not_like_op}) {
859 belch(sprintf $empty, uc($op));
862 puke(sprintf $fail, $op);
866 my ($self, $op, $body) = @_;
867 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
868 puke "$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
870 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
871 ref($body) ? @$body : $body;
872 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
873 unless ($self->{quote_char}) {
874 $self->_assert_pass_injection_guard($_) for @parts;
876 return +{ -ident => \@parts };
880 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
884 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
888 my ($self, undef, $v) = @_;
890 return $self->_expand_expr($v);
892 puke "-bool => undef not supported" unless defined($v);
893 return $self->_expand_ident(-ident => $v);
896 sub _expand_op_andor {
897 my ($self, $logic, $v, $k) = @_;
899 $v = [ map +{ $k, $_ },
901 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
905 my ($logop) = $logic =~ /^-?(.*)$/;
906 if (ref($v) eq 'HASH') {
907 return undef unless keys %$v;
910 map $self->_expand_expr({ $_ => $v->{$_} }),
914 if (ref($v) eq 'ARRAY') {
915 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
918 (ref($_) eq 'ARRAY' and @$_)
919 or (ref($_) eq 'HASH' and %$_)
925 while (my ($el) = splice @expr, 0, 1) {
926 puke "Supplying an empty left hand side argument is not supported in array-pairs"
927 unless defined($el) and length($el);
928 my $elref = ref($el);
930 local our $Expand_Depth = 0;
931 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
932 } elsif ($elref eq 'ARRAY') {
933 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
934 } elsif (my $l = is_literal_value($el)) {
935 push @res, { -literal => $l };
936 } elsif ($elref eq 'HASH') {
937 local our $Expand_Depth = 0;
938 push @res, grep defined, $self->_expand_expr($el) if %$el;
944 # return $res[0] if @res == 1;
945 return { -op => [ $logop, @res ] };
951 my ($self, $op, $vv, $k) = @_;
952 puke "$op can only take undef as argument"
956 and exists($vv->{-value})
957 and !defined($vv->{-value})
959 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
962 sub _expand_between {
963 my ($self, $op, $vv, $k) = @_;
964 local our $Cur_Col_Meta = $k;
965 my @rhs = map $self->_expand_expr($_),
966 ref($vv) eq 'ARRAY' ? @$vv : $vv;
968 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
970 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
972 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
976 $self->_expand_ident(-ident => $k),
982 my ($self, $op, $vv, $k) = @_;
983 if (my $literal = is_literal_value($vv)) {
984 my ($sql, @bind) = @$literal;
985 my $opened_sql = $self->_open_outer_paren($sql);
987 $op, $self->_expand_ident(-ident => $k),
988 [ { -literal => [ $opened_sql, @bind ] } ]
992 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
993 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
994 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
995 . 'will emit the logically correct SQL instead of raising this exception)'
997 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
999 my @rhs = map $self->_expand_expr($_),
1000 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
1001 map { defined($_) ? $_: puke($undef_err) }
1002 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1003 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1007 $self->_expand_ident(-ident => $k),
1013 my ($self, $op, $v) = @_;
1014 # DBIx::Class requires a nest warning to be emitted once but the private
1015 # method it overrode to do so no longer exists
1016 if ($self->{is_dbic_sqlmaker}) {
1017 unless (our $Nest_Warned) {
1019 "-nest in search conditions is deprecated, you most probably wanted:\n"
1020 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1025 return $self->_expand_expr($v);
1028 sub _recurse_where {
1029 my ($self, $where, $logic) = @_;
1031 # Special case: top level simple string treated as literal
1033 my $where_exp = (ref($where)
1034 ? $self->_expand_expr($where, $logic)
1035 : { -literal => [ $where ] });
1037 # dispatch expanded expression
1039 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1040 # DBIx::Class used to call _recurse_where in scalar context
1041 # something else might too...
1043 return ($sql, @bind);
1046 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1052 my ($self, $ident) = @_;
1054 return $self->_convert($self->_quote($ident));
1058 my ($self, $list) = @_;
1059 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1060 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1064 my ($self, $rest) = @_;
1065 my ($func, @args) = @$rest;
1069 push @arg_sql, shift @x;
1071 } map [ $self->render_aqt($_) ], @args;
1072 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1076 my ($self, $bind) = @_;
1077 return ($self->_convert('?'), $self->_bindtype(@$bind));
1080 sub _render_literal {
1081 my ($self, $literal) = @_;
1082 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1087 my ($self, $v) = @_;
1088 my ($op, @args) = @$v;
1089 if (my $r = $self->{render_op}{$op}) {
1090 return $self->$r($op, \@args);
1095 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1096 if ($us and @args > 1) {
1097 puke "Special op '${op}' requires first value to be identifier"
1098 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1099 my $k = join(($self->{name_sep}||'.'), @$ident);
1100 local our $Expand_Depth = 1;
1101 return $self->${\($us->{handler})}($k, $op, $args[1]);
1103 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1104 return $self->${\($us->{handler})}($op, $args[0]);
1109 return $self->_render_unop_prefix($op, \@args);
1111 return $self->_render_op_multop($op, \@args);
1117 sub _render_op_between {
1118 my ($self, $op, $args) = @_;
1119 my ($left, $low, $high) = @$args;
1120 my ($rhsql, @rhbind) = do {
1122 puke "Single arg to between must be a literal"
1123 unless $low->{-literal};
1126 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1127 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1128 @{$l}[1..$#$l], @{$h}[1..$#$h])
1131 my ($lhsql, @lhbind) = $self->render_aqt($left);
1133 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1139 my ($self, $op, $args) = @_;
1140 my ($lhs, $rhs) = @$args;
1143 my ($sql, @bind) = $self->render_aqt($_);
1144 push @in_bind, @bind;
1147 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1149 $lhsql.' '.$self->_sqlcase($op).' ( '
1150 .join(', ', @in_sql)
1156 sub _render_op_andor {
1157 my ($self, $op, $args) = @_;
1158 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1159 return '' unless @parts;
1160 return @{$parts[0]} if @parts == 1;
1161 my ($sql, @bind) = $self->_render_op_multop($op, $args);
1162 return '( '.$sql.' )', @bind;
1165 sub _render_op_multop {
1166 my ($self, $op, $args) = @_;
1167 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1168 return '' unless @parts;
1169 return @{$parts[0]} if @parts == 1;
1170 my ($final_sql) = join(
1171 ' '.$self->_sqlcase($op).' ',
1176 map @{$_}[1..$#$_], @parts
1179 sub _render_op_not {
1180 my ($self, $op, $v) = @_;
1181 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1182 return "(${sql})", @bind;
1185 sub _render_unop_prefix {
1186 my ($self, $op, $v) = @_;
1187 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1188 my $op_sql = $self->_sqlcase($op);
1189 return ("${op_sql} ${expr_sql}", @bind);
1192 sub _render_unop_postfix {
1193 my ($self, $op, $v) = @_;
1194 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1195 my $op_sql = $self->_sqlcase($op);
1196 return ($expr_sql.' '.$op_sql, @bind);
1199 # Some databases (SQLite) treat col IN (1, 2) different from
1200 # col IN ( (1, 2) ). Use this to strip all outer parens while
1201 # adding them back in the corresponding method
1202 sub _open_outer_paren {
1203 my ($self, $sql) = @_;
1205 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1207 # there are closing parens inside, need the heavy duty machinery
1208 # to reevaluate the extraction starting from $sql (full reevaluation)
1209 if ($inner =~ /\)/) {
1210 require Text::Balanced;
1212 my (undef, $remainder) = do {
1213 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1215 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1218 # the entire expression needs to be a balanced bracketed thing
1219 # (after an extract no remainder sans trailing space)
1220 last if defined $remainder and $remainder =~ /\S/;
1230 #======================================================================
1232 #======================================================================
1234 sub _expand_order_by {
1235 my ($self, $arg) = @_;
1237 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1239 my $expander = sub {
1240 my ($self, $dir, $expr) = @_;
1241 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1242 foreach my $arg (@to_expand) {
1246 and grep /^-(asc|desc)$/, keys %$arg
1248 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1252 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1254 map $self->expand_expr($_, -ident),
1255 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1256 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1259 local @{$self->{expand}}{qw(-asc -desc)} = (($expander) x 2);
1261 return $self->$expander(undef, $arg);
1265 my ($self, $arg) = @_;
1267 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1269 my ($sql, @bind) = $self->render_aqt($expanded);
1271 return '' unless length($sql);
1273 my $final_sql = $self->_sqlcase(' order by ').$sql;
1275 return wantarray ? ($final_sql, @bind) : $final_sql;
1278 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1280 sub _order_by_chunks {
1281 my ($self, $arg) = @_;
1283 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1285 return $self->_chunkify_order_by($expanded);
1288 sub _chunkify_order_by {
1289 my ($self, $expanded) = @_;
1291 return grep length, $self->render_aqt($expanded)
1292 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1295 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1296 return map $self->_chunkify_order_by($_), @$l;
1298 return [ $self->render_aqt($_) ];
1302 #======================================================================
1303 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1304 #======================================================================
1310 $self->_expand_maybe_list_expr($from, undef, -ident)
1315 #======================================================================
1317 #======================================================================
1319 sub _expand_maybe_list_expr {
1320 my ($self, $expr, $logic, $default) = @_;
1322 if (ref($expr) eq 'ARRAY') {
1324 map $self->expand_expr($_, $default), @$expr
1331 return $self->expand_expr($e, $default);
1334 # highly optimized, as it's called way too often
1336 # my ($self, $label) = @_;
1338 return '' unless defined $_[1];
1339 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1340 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1342 unless ($_[0]->{quote_char}) {
1343 if (ref($_[1]) eq 'ARRAY') {
1344 return join($_[0]->{name_sep}||'.', @{$_[1]});
1346 $_[0]->_assert_pass_injection_guard($_[1]);
1351 my $qref = ref $_[0]->{quote_char};
1353 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1354 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1355 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1357 my $esc = $_[0]->{escape_char} || $r;
1359 # parts containing * are naturally unquoted
1361 $_[0]->{name_sep}||'',
1365 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1367 (ref($_[1]) eq 'ARRAY'
1371 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1379 # Conversion, if applicable
1381 #my ($self, $arg) = @_;
1382 if ($_[0]->{convert_where}) {
1383 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1390 #my ($self, $col, @vals) = @_;
1391 # called often - tighten code
1392 return $_[0]->{bindtype} eq 'columns'
1393 ? map {[$_[1], $_]} @_[2 .. $#_]
1398 # Dies if any element of @bind is not in [colname => value] format
1399 # if bindtype is 'columns'.
1400 sub _assert_bindval_matches_bindtype {
1401 # my ($self, @bind) = @_;
1403 if ($self->{bindtype} eq 'columns') {
1405 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1406 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1412 sub _join_sql_clauses {
1413 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1415 if (@$clauses_aref > 1) {
1416 my $join = " " . $self->_sqlcase($logic) . " ";
1417 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1418 return ($sql, @$bind_aref);
1420 elsif (@$clauses_aref) {
1421 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1424 return (); # if no SQL, ignore @$bind_aref
1429 # Fix SQL case, if so requested
1431 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1432 # don't touch the argument ... crooked logic, but let's not change it!
1433 return $_[0]->{case} ? $_[1] : uc($_[1]);
1437 #======================================================================
1438 # DISPATCHING FROM REFKIND
1439 #======================================================================
1442 my ($self, $data) = @_;
1444 return 'UNDEF' unless defined $data;
1446 # blessed objects are treated like scalars
1447 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1449 return 'SCALAR' unless $ref;
1452 while ($ref eq 'REF') {
1454 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1458 return ($ref||'SCALAR') . ('REF' x $n_steps);
1462 my ($self, $data) = @_;
1463 my @try = ($self->_refkind($data));
1464 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1465 push @try, 'FALLBACK';
1469 sub _METHOD_FOR_refkind {
1470 my ($self, $meth_prefix, $data) = @_;
1473 for (@{$self->_try_refkind($data)}) {
1474 $method = $self->can($meth_prefix."_".$_)
1478 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1482 sub _SWITCH_refkind {
1483 my ($self, $data, $dispatch_table) = @_;
1486 for (@{$self->_try_refkind($data)}) {
1487 $coderef = $dispatch_table->{$_}
1491 puke "no dispatch entry for ".$self->_refkind($data)
1500 #======================================================================
1501 # VALUES, GENERATE, AUTOLOAD
1502 #======================================================================
1504 # LDNOTE: original code from nwiger, didn't touch code in that section
1505 # I feel the AUTOLOAD stuff should not be the default, it should
1506 # only be activated on explicit demand by user.
1510 my $data = shift || return;
1511 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1512 unless ref $data eq 'HASH';
1515 foreach my $k (sort keys %$data) {
1516 my $v = $data->{$k};
1517 $self->_SWITCH_refkind($v, {
1519 if ($self->{array_datatypes}) { # array datatype
1520 push @all_bind, $self->_bindtype($k, $v);
1522 else { # literal SQL with bind
1523 my ($sql, @bind) = @$v;
1524 $self->_assert_bindval_matches_bindtype(@bind);
1525 push @all_bind, @bind;
1528 ARRAYREFREF => sub { # literal SQL with bind
1529 my ($sql, @bind) = @${$v};
1530 $self->_assert_bindval_matches_bindtype(@bind);
1531 push @all_bind, @bind;
1533 SCALARREF => sub { # literal SQL without bind
1535 SCALAR_or_UNDEF => sub {
1536 push @all_bind, $self->_bindtype($k, $v);
1547 my(@sql, @sqlq, @sqlv);
1551 if ($ref eq 'HASH') {
1552 for my $k (sort keys %$_) {
1555 my $label = $self->_quote($k);
1556 if ($r eq 'ARRAY') {
1557 # literal SQL with bind
1558 my ($sql, @bind) = @$v;
1559 $self->_assert_bindval_matches_bindtype(@bind);
1560 push @sqlq, "$label = $sql";
1562 } elsif ($r eq 'SCALAR') {
1563 # literal SQL without bind
1564 push @sqlq, "$label = $$v";
1566 push @sqlq, "$label = ?";
1567 push @sqlv, $self->_bindtype($k, $v);
1570 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1571 } elsif ($ref eq 'ARRAY') {
1572 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1575 if ($r eq 'ARRAY') { # literal SQL with bind
1576 my ($sql, @bind) = @$v;
1577 $self->_assert_bindval_matches_bindtype(@bind);
1580 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1581 # embedded literal SQL
1588 push @sql, '(' . join(', ', @sqlq) . ')';
1589 } elsif ($ref eq 'SCALAR') {
1593 # strings get case twiddled
1594 push @sql, $self->_sqlcase($_);
1598 my $sql = join ' ', @sql;
1600 # this is pretty tricky
1601 # if ask for an array, return ($stmt, @bind)
1602 # otherwise, s/?/shift @sqlv/ to put it inline
1604 return ($sql, @sqlv);
1606 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1607 ref $d ? $d->[1] : $d/e;
1616 # This allows us to check for a local, then _form, attr
1618 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1619 return $self->generate($name, @_);
1630 SQL::Abstract - Generate SQL from Perl data structures
1636 my $sql = SQL::Abstract->new;
1638 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1640 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1642 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1644 my($stmt, @bind) = $sql->delete($table, \%where);
1646 # Then, use these in your DBI statements
1647 my $sth = $dbh->prepare($stmt);
1648 $sth->execute(@bind);
1650 # Just generate the WHERE clause
1651 my($stmt, @bind) = $sql->where(\%where, $order);
1653 # Return values in the same order, for hashed queries
1654 # See PERFORMANCE section for more details
1655 my @bind = $sql->values(\%fieldvals);
1659 This module was inspired by the excellent L<DBIx::Abstract>.
1660 However, in using that module I found that what I really wanted
1661 to do was generate SQL, but still retain complete control over my
1662 statement handles and use the DBI interface. So, I set out to
1663 create an abstract SQL generation module.
1665 While based on the concepts used by L<DBIx::Abstract>, there are
1666 several important differences, especially when it comes to WHERE
1667 clauses. I have modified the concepts used to make the SQL easier
1668 to generate from Perl data structures and, IMO, more intuitive.
1669 The underlying idea is for this module to do what you mean, based
1670 on the data structures you provide it. The big advantage is that
1671 you don't have to modify your code every time your data changes,
1672 as this module figures it out.
1674 To begin with, an SQL INSERT is as easy as just specifying a hash
1675 of C<key=value> pairs:
1678 name => 'Jimbo Bobson',
1679 phone => '123-456-7890',
1680 address => '42 Sister Lane',
1681 city => 'St. Louis',
1682 state => 'Louisiana',
1685 The SQL can then be generated with this:
1687 my($stmt, @bind) = $sql->insert('people', \%data);
1689 Which would give you something like this:
1691 $stmt = "INSERT INTO people
1692 (address, city, name, phone, state)
1693 VALUES (?, ?, ?, ?, ?)";
1694 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1695 '123-456-7890', 'Louisiana');
1697 These are then used directly in your DBI code:
1699 my $sth = $dbh->prepare($stmt);
1700 $sth->execute(@bind);
1702 =head2 Inserting and Updating Arrays
1704 If your database has array types (like for example Postgres),
1705 activate the special option C<< array_datatypes => 1 >>
1706 when creating the C<SQL::Abstract> object.
1707 Then you may use an arrayref to insert and update database array types:
1709 my $sql = SQL::Abstract->new(array_datatypes => 1);
1711 planets => [qw/Mercury Venus Earth Mars/]
1714 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1718 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1720 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1723 =head2 Inserting and Updating SQL
1725 In order to apply SQL functions to elements of your C<%data> you may
1726 specify a reference to an arrayref for the given hash value. For example,
1727 if you need to execute the Oracle C<to_date> function on a value, you can
1728 say something like this:
1732 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1735 The first value in the array is the actual SQL. Any other values are
1736 optional and would be included in the bind values array. This gives
1739 my($stmt, @bind) = $sql->insert('people', \%data);
1741 $stmt = "INSERT INTO people (name, date_entered)
1742 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1743 @bind = ('Bill', '03/02/2003');
1745 An UPDATE is just as easy, all you change is the name of the function:
1747 my($stmt, @bind) = $sql->update('people', \%data);
1749 Notice that your C<%data> isn't touched; the module will generate
1750 the appropriately quirky SQL for you automatically. Usually you'll
1751 want to specify a WHERE clause for your UPDATE, though, which is
1752 where handling C<%where> hashes comes in handy...
1754 =head2 Complex where statements
1756 This module can generate pretty complicated WHERE statements
1757 easily. For example, simple C<key=value> pairs are taken to mean
1758 equality, and if you want to see if a field is within a set
1759 of values, you can use an arrayref. Let's say we wanted to
1760 SELECT some data based on this criteria:
1763 requestor => 'inna',
1764 worker => ['nwiger', 'rcwe', 'sfz'],
1765 status => { '!=', 'completed' }
1768 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1770 The above would give you something like this:
1772 $stmt = "SELECT * FROM tickets WHERE
1773 ( requestor = ? ) AND ( status != ? )
1774 AND ( worker = ? OR worker = ? OR worker = ? )";
1775 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1777 Which you could then use in DBI code like so:
1779 my $sth = $dbh->prepare($stmt);
1780 $sth->execute(@bind);
1786 The methods are simple. There's one for every major SQL operation,
1787 and a constructor you use first. The arguments are specified in a
1788 similar order for each method (table, then fields, then a where
1789 clause) to try and simplify things.
1791 =head2 new(option => 'value')
1793 The C<new()> function takes a list of options and values, and returns
1794 a new B<SQL::Abstract> object which can then be used to generate SQL
1795 through the methods below. The options accepted are:
1801 If set to 'lower', then SQL will be generated in all lowercase. By
1802 default SQL is generated in "textbook" case meaning something like:
1804 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1806 Any setting other than 'lower' is ignored.
1810 This determines what the default comparison operator is. By default
1811 it is C<=>, meaning that a hash like this:
1813 %where = (name => 'nwiger', email => 'nate@wiger.org');
1815 Will generate SQL like this:
1817 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1819 However, you may want loose comparisons by default, so if you set
1820 C<cmp> to C<like> you would get SQL such as:
1822 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1824 You can also override the comparison on an individual basis - see
1825 the huge section on L</"WHERE CLAUSES"> at the bottom.
1827 =item sqltrue, sqlfalse
1829 Expressions for inserting boolean values within SQL statements.
1830 By default these are C<1=1> and C<1=0>. They are used
1831 by the special operators C<-in> and C<-not_in> for generating
1832 correct SQL even when the argument is an empty array (see below).
1836 This determines the default logical operator for multiple WHERE
1837 statements in arrays or hashes. If absent, the default logic is "or"
1838 for arrays, and "and" for hashes. This means that a WHERE
1842 event_date => {'>=', '2/13/99'},
1843 event_date => {'<=', '4/24/03'},
1846 will generate SQL like this:
1848 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1850 This is probably not what you want given this query, though (look
1851 at the dates). To change the "OR" to an "AND", simply specify:
1853 my $sql = SQL::Abstract->new(logic => 'and');
1855 Which will change the above C<WHERE> to:
1857 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1859 The logic can also be changed locally by inserting
1860 a modifier in front of an arrayref:
1862 @where = (-and => [event_date => {'>=', '2/13/99'},
1863 event_date => {'<=', '4/24/03'} ]);
1865 See the L</"WHERE CLAUSES"> section for explanations.
1869 This will automatically convert comparisons using the specified SQL
1870 function for both column and value. This is mostly used with an argument
1871 of C<upper> or C<lower>, so that the SQL will have the effect of
1872 case-insensitive "searches". For example, this:
1874 $sql = SQL::Abstract->new(convert => 'upper');
1875 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1877 Will turn out the following SQL:
1879 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1881 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1882 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1883 not validate this option; it will just pass through what you specify verbatim).
1887 This is a kludge because many databases suck. For example, you can't
1888 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1889 Instead, you have to use C<bind_param()>:
1891 $sth->bind_param(1, 'reg data');
1892 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1894 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1895 which loses track of which field each slot refers to. Fear not.
1897 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1898 Currently, you can specify either C<normal> (default) or C<columns>. If you
1899 specify C<columns>, you will get an array that looks like this:
1901 my $sql = SQL::Abstract->new(bindtype => 'columns');
1902 my($stmt, @bind) = $sql->insert(...);
1905 [ 'column1', 'value1' ],
1906 [ 'column2', 'value2' ],
1907 [ 'column3', 'value3' ],
1910 You can then iterate through this manually, using DBI's C<bind_param()>.
1912 $sth->prepare($stmt);
1915 my($col, $data) = @$_;
1916 if ($col eq 'details' || $col eq 'comments') {
1917 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1918 } elsif ($col eq 'image') {
1919 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1921 $sth->bind_param($i, $data);
1925 $sth->execute; # execute without @bind now
1927 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1928 Basically, the advantage is still that you don't have to care which fields
1929 are or are not included. You could wrap that above C<for> loop in a simple
1930 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1931 get a layer of abstraction over manual SQL specification.
1933 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1934 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1935 will expect the bind values in this format.
1939 This is the character that a table or column name will be quoted
1940 with. By default this is an empty string, but you could set it to
1941 the character C<`>, to generate SQL like this:
1943 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1945 Alternatively, you can supply an array ref of two items, the first being the left
1946 hand quote character, and the second the right hand quote character. For
1947 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1948 that generates SQL like this:
1950 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1952 Quoting is useful if you have tables or columns names that are reserved
1953 words in your database's SQL dialect.
1957 This is the character that will be used to escape L</quote_char>s appearing
1958 in an identifier before it has been quoted.
1960 The parameter default in case of a single L</quote_char> character is the quote
1963 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1964 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1965 of the B<opening (left)> L</quote_char> within the identifier are currently left
1966 untouched. The default for opening-closing-style quotes may change in future
1967 versions, thus you are B<strongly encouraged> to specify the escape character
1972 This is the character that separates a table and column name. It is
1973 necessary to specify this when the C<quote_char> option is selected,
1974 so that tables and column names can be individually quoted like this:
1976 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1978 =item injection_guard
1980 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1981 column name specified in a query structure. This is a safety mechanism to avoid
1982 injection attacks when mishandling user input e.g.:
1984 my %condition_as_column_value_pairs = get_values_from_user();
1985 $sqla->select( ... , \%condition_as_column_value_pairs );
1987 If the expression matches an exception is thrown. Note that literal SQL
1988 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1990 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1992 =item array_datatypes
1994 When this option is true, arrayrefs in INSERT or UPDATE are
1995 interpreted as array datatypes and are passed directly
1997 When this option is false, arrayrefs are interpreted
1998 as literal SQL, just like refs to arrayrefs
1999 (but this behavior is for backwards compatibility; when writing
2000 new queries, use the "reference to arrayref" syntax
2006 Takes a reference to a list of "special operators"
2007 to extend the syntax understood by L<SQL::Abstract>.
2008 See section L</"SPECIAL OPERATORS"> for details.
2012 Takes a reference to a list of "unary operators"
2013 to extend the syntax understood by L<SQL::Abstract>.
2014 See section L</"UNARY OPERATORS"> for details.
2020 =head2 insert($table, \@values || \%fieldvals, \%options)
2022 This is the simplest function. You simply give it a table name
2023 and either an arrayref of values or hashref of field/value pairs.
2024 It returns an SQL INSERT statement and a list of bind values.
2025 See the sections on L</"Inserting and Updating Arrays"> and
2026 L</"Inserting and Updating SQL"> for information on how to insert
2027 with those data types.
2029 The optional C<\%options> hash reference may contain additional
2030 options to generate the insert SQL. Currently supported options
2037 Takes either a scalar of raw SQL fields, or an array reference of
2038 field names, and adds on an SQL C<RETURNING> statement at the end.
2039 This allows you to return data generated by the insert statement
2040 (such as row IDs) without performing another C<SELECT> statement.
2041 Note, however, this is not part of the SQL standard and may not
2042 be supported by all database engines.
2046 =head2 update($table, \%fieldvals, \%where, \%options)
2048 This takes a table, hashref of field/value pairs, and an optional
2049 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2051 See the sections on L</"Inserting and Updating Arrays"> and
2052 L</"Inserting and Updating SQL"> for information on how to insert
2053 with those data types.
2055 The optional C<\%options> hash reference may contain additional
2056 options to generate the update SQL. Currently supported options
2063 See the C<returning> option to
2064 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2068 =head2 select($source, $fields, $where, $order)
2070 This returns a SQL SELECT statement and associated list of bind values, as
2071 specified by the arguments:
2077 Specification of the 'FROM' part of the statement.
2078 The argument can be either a plain scalar (interpreted as a table
2079 name, will be quoted), or an arrayref (interpreted as a list
2080 of table names, joined by commas, quoted), or a scalarref
2081 (literal SQL, not quoted).
2085 Specification of the list of fields to retrieve from
2087 The argument can be either an arrayref (interpreted as a list
2088 of field names, will be joined by commas and quoted), or a
2089 plain scalar (literal SQL, not quoted).
2090 Please observe that this API is not as flexible as that of
2091 the first argument C<$source>, for backwards compatibility reasons.
2095 Optional argument to specify the WHERE part of the query.
2096 The argument is most often a hashref, but can also be
2097 an arrayref or plain scalar --
2098 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2102 Optional argument to specify the ORDER BY part of the query.
2103 The argument can be a scalar, a hashref or an arrayref
2104 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2110 =head2 delete($table, \%where, \%options)
2112 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2113 It returns an SQL DELETE statement and list of bind values.
2115 The optional C<\%options> hash reference may contain additional
2116 options to generate the delete SQL. Currently supported options
2123 See the C<returning> option to
2124 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2128 =head2 where(\%where, $order)
2130 This is used to generate just the WHERE clause. For example,
2131 if you have an arbitrary data structure and know what the
2132 rest of your SQL is going to look like, but want an easy way
2133 to produce a WHERE clause, use this. It returns an SQL WHERE
2134 clause and list of bind values.
2137 =head2 values(\%data)
2139 This just returns the values from the hash C<%data>, in the same
2140 order that would be returned from any of the other above queries.
2141 Using this allows you to markedly speed up your queries if you
2142 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2144 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2146 Warning: This is an experimental method and subject to change.
2148 This returns arbitrarily generated SQL. It's a really basic shortcut.
2149 It will return two different things, depending on return context:
2151 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2152 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2154 These would return the following:
2156 # First calling form
2157 $stmt = "CREATE TABLE test (?, ?)";
2158 @bind = (field1, field2);
2160 # Second calling form
2161 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2163 Depending on what you're trying to do, it's up to you to choose the correct
2164 format. In this example, the second form is what you would want.
2168 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2172 ALTER SESSION SET nls_date_format = 'MM/YY'
2174 You get the idea. Strings get their case twiddled, but everything
2175 else remains verbatim.
2177 =head1 EXPORTABLE FUNCTIONS
2179 =head2 is_plain_value
2181 Determines if the supplied argument is a plain value as understood by this
2186 =item * The value is C<undef>
2188 =item * The value is a non-reference
2190 =item * The value is an object with stringification overloading
2192 =item * The value is of the form C<< { -value => $anything } >>
2196 On failure returns C<undef>, on success returns a B<scalar> reference
2197 to the original supplied argument.
2203 The stringification overloading detection is rather advanced: it takes
2204 into consideration not only the presence of a C<""> overload, but if that
2205 fails also checks for enabled
2206 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2207 on either C<0+> or C<bool>.
2209 Unfortunately testing in the field indicates that this
2210 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2211 but only when very large numbers of stringifying objects are involved.
2212 At the time of writing ( Sep 2014 ) there is no clear explanation of
2213 the direct cause, nor is there a manageably small test case that reliably
2214 reproduces the problem.
2216 If you encounter any of the following exceptions in B<random places within
2217 your application stack> - this module may be to blame:
2219 Operation "ne": no method found,
2220 left argument in overloaded package <something>,
2221 right argument in overloaded package <something>
2225 Stub found while resolving method "???" overloading """" in package <something>
2227 If you fall victim to the above - please attempt to reduce the problem
2228 to something that could be sent to the L<SQL::Abstract developers
2229 |DBIx::Class/GETTING HELP/SUPPORT>
2230 (either publicly or privately). As a workaround in the meantime you can
2231 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2232 value, which will most likely eliminate your problem (at the expense of
2233 not being able to properly detect exotic forms of stringification).
2235 This notice and environment variable will be removed in a future version,
2236 as soon as the underlying problem is found and a reliable workaround is
2241 =head2 is_literal_value
2243 Determines if the supplied argument is a literal value as understood by this
2248 =item * C<\$sql_string>
2250 =item * C<\[ $sql_string, @bind_values ]>
2254 On failure returns C<undef>, on success returns an B<array> reference
2255 containing the unpacked version of the supplied literal SQL and bind values.
2257 =head1 WHERE CLAUSES
2261 This module uses a variation on the idea from L<DBIx::Abstract>. It
2262 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2263 module is that things in arrays are OR'ed, and things in hashes
2266 The easiest way to explain is to show lots of examples. After
2267 each C<%where> hash shown, it is assumed you used:
2269 my($stmt, @bind) = $sql->where(\%where);
2271 However, note that the C<%where> hash can be used directly in any
2272 of the other functions as well, as described above.
2274 =head2 Key-value pairs
2276 So, let's get started. To begin, a simple hash:
2280 status => 'completed'
2283 Is converted to SQL C<key = val> statements:
2285 $stmt = "WHERE user = ? AND status = ?";
2286 @bind = ('nwiger', 'completed');
2288 One common thing I end up doing is having a list of values that
2289 a field can be in. To do this, simply specify a list inside of
2294 status => ['assigned', 'in-progress', 'pending'];
2297 This simple code will create the following:
2299 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2300 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2302 A field associated to an empty arrayref will be considered a
2303 logical false and will generate 0=1.
2305 =head2 Tests for NULL values
2307 If the value part is C<undef> then this is converted to SQL <IS NULL>
2316 $stmt = "WHERE user = ? AND status IS NULL";
2319 To test if a column IS NOT NULL:
2323 status => { '!=', undef },
2326 =head2 Specific comparison operators
2328 If you want to specify a different type of operator for your comparison,
2329 you can use a hashref for a given column:
2333 status => { '!=', 'completed' }
2336 Which would generate:
2338 $stmt = "WHERE user = ? AND status != ?";
2339 @bind = ('nwiger', 'completed');
2341 To test against multiple values, just enclose the values in an arrayref:
2343 status => { '=', ['assigned', 'in-progress', 'pending'] };
2345 Which would give you:
2347 "WHERE status = ? OR status = ? OR status = ?"
2350 The hashref can also contain multiple pairs, in which case it is expanded
2351 into an C<AND> of its elements:
2355 status => { '!=', 'completed', -not_like => 'pending%' }
2358 # Or more dynamically, like from a form
2359 $where{user} = 'nwiger';
2360 $where{status}{'!='} = 'completed';
2361 $where{status}{'-not_like'} = 'pending%';
2363 # Both generate this
2364 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2365 @bind = ('nwiger', 'completed', 'pending%');
2368 To get an OR instead, you can combine it with the arrayref idea:
2372 priority => [ { '=', 2 }, { '>', 5 } ]
2375 Which would generate:
2377 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2378 @bind = ('2', '5', 'nwiger');
2380 If you want to include literal SQL (with or without bind values), just use a
2381 scalar reference or reference to an arrayref as the value:
2384 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2385 date_expires => { '<' => \"now()" }
2388 Which would generate:
2390 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2391 @bind = ('11/26/2008');
2394 =head2 Logic and nesting operators
2396 In the example above,
2397 there is a subtle trap if you want to say something like
2398 this (notice the C<AND>):
2400 WHERE priority != ? AND priority != ?
2402 Because, in Perl you I<can't> do this:
2404 priority => { '!=' => 2, '!=' => 1 }
2406 As the second C<!=> key will obliterate the first. The solution
2407 is to use the special C<-modifier> form inside an arrayref:
2409 priority => [ -and => {'!=', 2},
2413 Normally, these would be joined by C<OR>, but the modifier tells it
2414 to use C<AND> instead. (Hint: You can use this in conjunction with the
2415 C<logic> option to C<new()> in order to change the way your queries
2416 work by default.) B<Important:> Note that the C<-modifier> goes
2417 B<INSIDE> the arrayref, as an extra first element. This will
2418 B<NOT> do what you think it might:
2420 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2422 Here is a quick list of equivalencies, since there is some overlap:
2425 status => {'!=', 'completed', 'not like', 'pending%' }
2426 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2429 status => {'=', ['assigned', 'in-progress']}
2430 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2431 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2435 =head2 Special operators: IN, BETWEEN, etc.
2437 You can also use the hashref format to compare a list of fields using the
2438 C<IN> comparison operator, by specifying the list as an arrayref:
2441 status => 'completed',
2442 reportid => { -in => [567, 2335, 2] }
2445 Which would generate:
2447 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2448 @bind = ('completed', '567', '2335', '2');
2450 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2453 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2454 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2455 'sqltrue' (by default: C<1=1>).
2457 In addition to the array you can supply a chunk of literal sql or
2458 literal sql with bind:
2461 customer => { -in => \[
2462 'SELECT cust_id FROM cust WHERE balance > ?',
2465 status => { -in => \'SELECT status_codes FROM states' },
2471 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2472 AND status IN ( SELECT status_codes FROM states )
2476 Finally, if the argument to C<-in> is not a reference, it will be
2477 treated as a single-element array.
2479 Another pair of operators is C<-between> and C<-not_between>,
2480 used with an arrayref of two values:
2484 completion_date => {
2485 -not_between => ['2002-10-01', '2003-02-06']
2491 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2493 Just like with C<-in> all plausible combinations of literal SQL
2497 start0 => { -between => [ 1, 2 ] },
2498 start1 => { -between => \["? AND ?", 1, 2] },
2499 start2 => { -between => \"lower(x) AND upper(y)" },
2500 start3 => { -between => [
2502 \["upper(?)", 'stuff' ],
2509 ( start0 BETWEEN ? AND ? )
2510 AND ( start1 BETWEEN ? AND ? )
2511 AND ( start2 BETWEEN lower(x) AND upper(y) )
2512 AND ( start3 BETWEEN lower(x) AND upper(?) )
2514 @bind = (1, 2, 1, 2, 'stuff');
2517 These are the two builtin "special operators"; but the
2518 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2520 =head2 Unary operators: bool
2522 If you wish to test against boolean columns or functions within your
2523 database you can use the C<-bool> and C<-not_bool> operators. For
2524 example to test the column C<is_user> being true and the column
2525 C<is_enabled> being false you would use:-
2529 -not_bool => 'is_enabled',
2534 WHERE is_user AND NOT is_enabled
2536 If a more complex combination is required, testing more conditions,
2537 then you should use the and/or operators:-
2542 -not_bool => { two=> { -rlike => 'bar' } },
2543 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2554 (NOT ( three = ? OR three > ? ))
2557 =head2 Nested conditions, -and/-or prefixes
2559 So far, we've seen how multiple conditions are joined with a top-level
2560 C<AND>. We can change this by putting the different conditions we want in
2561 hashes and then putting those hashes in an array. For example:
2566 status => { -like => ['pending%', 'dispatched'] },
2570 status => 'unassigned',
2574 This data structure would create the following:
2576 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2577 OR ( user = ? AND status = ? ) )";
2578 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2581 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2582 to change the logic inside:
2588 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2589 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2596 $stmt = "WHERE ( user = ?
2597 AND ( ( workhrs > ? AND geo = ? )
2598 OR ( workhrs < ? OR geo = ? ) ) )";
2599 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2601 =head3 Algebraic inconsistency, for historical reasons
2603 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2604 operator goes C<outside> of the nested structure; whereas when connecting
2605 several constraints on one column, the C<-and> operator goes
2606 C<inside> the arrayref. Here is an example combining both features:
2609 -and => [a => 1, b => 2],
2610 -or => [c => 3, d => 4],
2611 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2616 WHERE ( ( ( a = ? AND b = ? )
2617 OR ( c = ? OR d = ? )
2618 OR ( e LIKE ? AND e LIKE ? ) ) )
2620 This difference in syntax is unfortunate but must be preserved for
2621 historical reasons. So be careful: the two examples below would
2622 seem algebraically equivalent, but they are not
2625 { -like => 'foo%' },
2626 { -like => '%bar' },
2628 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2631 { col => { -like => 'foo%' } },
2632 { col => { -like => '%bar' } },
2634 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2637 =head2 Literal SQL and value type operators
2639 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2640 side" is a column name and the "right side" is a value (normally rendered as
2641 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2642 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2643 alter this behavior. There are several ways of doing so.
2647 This is a virtual operator that signals the string to its right side is an
2648 identifier (a column name) and not a value. For example to compare two
2649 columns you would write:
2652 priority => { '<', 2 },
2653 requestor => { -ident => 'submitter' },
2658 $stmt = "WHERE priority < ? AND requestor = submitter";
2661 If you are maintaining legacy code you may see a different construct as
2662 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2667 This is a virtual operator that signals that the construct to its right side
2668 is a value to be passed to DBI. This is for example necessary when you want
2669 to write a where clause against an array (for RDBMS that support such
2670 datatypes). For example:
2673 array => { -value => [1, 2, 3] }
2678 $stmt = 'WHERE array = ?';
2679 @bind = ([1, 2, 3]);
2681 Note that if you were to simply say:
2687 the result would probably not be what you wanted:
2689 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2694 Finally, sometimes only literal SQL will do. To include a random snippet
2695 of SQL verbatim, you specify it as a scalar reference. Consider this only
2696 as a last resort. Usually there is a better way. For example:
2699 priority => { '<', 2 },
2700 requestor => { -in => \'(SELECT name FROM hitmen)' },
2705 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2708 Note that in this example, you only get one bind parameter back, since
2709 the verbatim SQL is passed as part of the statement.
2713 Never use untrusted input as a literal SQL argument - this is a massive
2714 security risk (there is no way to check literal snippets for SQL
2715 injections and other nastyness). If you need to deal with untrusted input
2716 use literal SQL with placeholders as described next.
2718 =head3 Literal SQL with placeholders and bind values (subqueries)
2720 If the literal SQL to be inserted has placeholders and bind values,
2721 use a reference to an arrayref (yes this is a double reference --
2722 not so common, but perfectly legal Perl). For example, to find a date
2723 in Postgres you can use something like this:
2726 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2731 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2734 Note that you must pass the bind values in the same format as they are returned
2735 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2736 to C<columns>, you must provide the bind values in the
2737 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2738 scalar value; most commonly the column name, but you can use any scalar value
2739 (including references and blessed references), L<SQL::Abstract> will simply
2740 pass it through intact. So if C<bindtype> is set to C<columns> the above
2741 example will look like:
2744 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2747 Literal SQL is especially useful for nesting parenthesized clauses in the
2748 main SQL query. Here is a first example:
2750 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2754 bar => \["IN ($sub_stmt)" => @sub_bind],
2759 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2760 WHERE c2 < ? AND c3 LIKE ?))";
2761 @bind = (1234, 100, "foo%");
2763 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2764 are expressed in the same way. Of course the C<$sub_stmt> and
2765 its associated bind values can be generated through a former call
2768 my ($sub_stmt, @sub_bind)
2769 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2770 c3 => {-like => "foo%"}});
2773 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2776 In the examples above, the subquery was used as an operator on a column;
2777 but the same principle also applies for a clause within the main C<%where>
2778 hash, like an EXISTS subquery:
2780 my ($sub_stmt, @sub_bind)
2781 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2782 my %where = ( -and => [
2784 \["EXISTS ($sub_stmt)" => @sub_bind],
2789 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2790 WHERE c1 = ? AND c2 > t0.c0))";
2794 Observe that the condition on C<c2> in the subquery refers to
2795 column C<t0.c0> of the main query: this is I<not> a bind
2796 value, so we have to express it through a scalar ref.
2797 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2798 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2799 what we wanted here.
2801 Finally, here is an example where a subquery is used
2802 for expressing unary negation:
2804 my ($sub_stmt, @sub_bind)
2805 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2806 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2808 lname => {like => '%son%'},
2809 \["NOT ($sub_stmt)" => @sub_bind],
2814 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2815 @bind = ('%son%', 10, 20)
2817 =head3 Deprecated usage of Literal SQL
2819 Below are some examples of archaic use of literal SQL. It is shown only as
2820 reference for those who deal with legacy code. Each example has a much
2821 better, cleaner and safer alternative that users should opt for in new code.
2827 my %where = ( requestor => \'IS NOT NULL' )
2829 $stmt = "WHERE requestor IS NOT NULL"
2831 This used to be the way of generating NULL comparisons, before the handling
2832 of C<undef> got formalized. For new code please use the superior syntax as
2833 described in L</Tests for NULL values>.
2837 my %where = ( requestor => \'= submitter' )
2839 $stmt = "WHERE requestor = submitter"
2841 This used to be the only way to compare columns. Use the superior L</-ident>
2842 method for all new code. For example an identifier declared in such a way
2843 will be properly quoted if L</quote_char> is properly set, while the legacy
2844 form will remain as supplied.
2848 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2850 $stmt = "WHERE completed > ? AND is_ready"
2851 @bind = ('2012-12-21')
2853 Using an empty string literal used to be the only way to express a boolean.
2854 For all new code please use the much more readable
2855 L<-bool|/Unary operators: bool> operator.
2861 These pages could go on for a while, since the nesting of the data
2862 structures this module can handle are pretty much unlimited (the
2863 module implements the C<WHERE> expansion as a recursive function
2864 internally). Your best bet is to "play around" with the module a
2865 little to see how the data structures behave, and choose the best
2866 format for your data based on that.
2868 And of course, all the values above will probably be replaced with
2869 variables gotten from forms or the command line. After all, if you
2870 knew everything ahead of time, you wouldn't have to worry about
2871 dynamically-generating SQL and could just hardwire it into your
2874 =head1 ORDER BY CLAUSES
2876 Some functions take an order by clause. This can either be a scalar (just a
2877 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2878 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2881 Given | Will Generate
2882 ---------------------------------------------------------------
2884 'colA' | ORDER BY colA
2886 [qw/colA colB/] | ORDER BY colA, colB
2888 {-asc => 'colA'} | ORDER BY colA ASC
2890 {-desc => 'colB'} | ORDER BY colB DESC
2892 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2894 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2896 \'colA DESC' | ORDER BY colA DESC
2898 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2899 | /* ...with $x bound to ? */
2902 { -asc => 'colA' }, | colA ASC,
2903 { -desc => [qw/colB/] }, | colB DESC,
2904 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2905 \'colE DESC', | colE DESC,
2906 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2907 ] | /* ...with $x bound to ? */
2908 ===============================================================
2912 =head1 SPECIAL OPERATORS
2914 my $sqlmaker = SQL::Abstract->new(special_ops => [
2918 my ($self, $field, $op, $arg) = @_;
2924 handler => 'method_name',
2928 A "special operator" is a SQL syntactic clause that can be
2929 applied to a field, instead of a usual binary operator.
2932 WHERE field IN (?, ?, ?)
2933 WHERE field BETWEEN ? AND ?
2934 WHERE MATCH(field) AGAINST (?, ?)
2936 Special operators IN and BETWEEN are fairly standard and therefore
2937 are builtin within C<SQL::Abstract> (as the overridable methods
2938 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2939 like the MATCH .. AGAINST example above which is specific to MySQL,
2940 you can write your own operator handlers - supply a C<special_ops>
2941 argument to the C<new> method. That argument takes an arrayref of
2942 operator definitions; each operator definition is a hashref with two
2949 the regular expression to match the operator
2953 Either a coderef or a plain scalar method name. In both cases
2954 the expected return is C<< ($sql, @bind) >>.
2956 When supplied with a method name, it is simply called on the
2957 L<SQL::Abstract> object as:
2959 $self->$method_name($field, $op, $arg)
2963 $field is the LHS of the operator
2964 $op is the part that matched the handler regex
2967 When supplied with a coderef, it is called as:
2969 $coderef->($self, $field, $op, $arg)
2974 For example, here is an implementation
2975 of the MATCH .. AGAINST syntax for MySQL
2977 my $sqlmaker = SQL::Abstract->new(special_ops => [
2979 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2980 {regex => qr/^match$/i,
2982 my ($self, $field, $op, $arg) = @_;
2983 $arg = [$arg] if not ref $arg;
2984 my $label = $self->_quote($field);
2985 my ($placeholder) = $self->_convert('?');
2986 my $placeholders = join ", ", (($placeholder) x @$arg);
2987 my $sql = $self->_sqlcase('match') . " ($label) "
2988 . $self->_sqlcase('against') . " ($placeholders) ";
2989 my @bind = $self->_bindtype($field, @$arg);
2990 return ($sql, @bind);
2997 =head1 UNARY OPERATORS
2999 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3003 my ($self, $op, $arg) = @_;
3009 handler => 'method_name',
3013 A "unary operator" is a SQL syntactic clause that can be
3014 applied to a field - the operator goes before the field
3016 You can write your own operator handlers - supply a C<unary_ops>
3017 argument to the C<new> method. That argument takes an arrayref of
3018 operator definitions; each operator definition is a hashref with two
3025 the regular expression to match the operator
3029 Either a coderef or a plain scalar method name. In both cases
3030 the expected return is C<< $sql >>.
3032 When supplied with a method name, it is simply called on the
3033 L<SQL::Abstract> object as:
3035 $self->$method_name($op, $arg)
3039 $op is the part that matched the handler regex
3040 $arg is the RHS or argument of the operator
3042 When supplied with a coderef, it is called as:
3044 $coderef->($self, $op, $arg)
3052 Thanks to some benchmarking by Mark Stosberg, it turns out that
3053 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3054 I must admit this wasn't an intentional design issue, but it's a
3055 byproduct of the fact that you get to control your C<DBI> handles
3058 To maximize performance, use a code snippet like the following:
3060 # prepare a statement handle using the first row
3061 # and then reuse it for the rest of the rows
3063 for my $href (@array_of_hashrefs) {
3064 $stmt ||= $sql->insert('table', $href);
3065 $sth ||= $dbh->prepare($stmt);
3066 $sth->execute($sql->values($href));
3069 The reason this works is because the keys in your C<$href> are sorted
3070 internally by B<SQL::Abstract>. Thus, as long as your data retains
3071 the same structure, you only have to generate the SQL the first time
3072 around. On subsequent queries, simply use the C<values> function provided
3073 by this module to return your values in the correct order.
3075 However this depends on the values having the same type - if, for
3076 example, the values of a where clause may either have values
3077 (resulting in sql of the form C<column = ?> with a single bind
3078 value), or alternatively the values might be C<undef> (resulting in
3079 sql of the form C<column IS NULL> with no bind value) then the
3080 caching technique suggested will not work.
3084 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3085 really like this part (I do, at least). Building up a complex query
3086 can be as simple as the following:
3093 use CGI::FormBuilder;
3096 my $form = CGI::FormBuilder->new(...);
3097 my $sql = SQL::Abstract->new;
3099 if ($form->submitted) {
3100 my $field = $form->field;
3101 my $id = delete $field->{id};
3102 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3105 Of course, you would still have to connect using C<DBI> to run the
3106 query, but the point is that if you make your form look like your
3107 table, the actual query script can be extremely simplistic.
3109 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3110 a fast interface to returning and formatting data. I frequently
3111 use these three modules together to write complex database query
3112 apps in under 50 lines.
3114 =head1 HOW TO CONTRIBUTE
3116 Contributions are always welcome, in all usable forms (we especially
3117 welcome documentation improvements). The delivery methods include git-
3118 or unified-diff formatted patches, GitHub pull requests, or plain bug
3119 reports either via RT or the Mailing list. Contributors are generally
3120 granted full access to the official repository after their first several
3121 patches pass successful review.
3123 This project is maintained in a git repository. The code and related tools are
3124 accessible at the following locations:
3128 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3130 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3132 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3134 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3140 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3141 Great care has been taken to preserve the I<published> behavior
3142 documented in previous versions in the 1.* family; however,
3143 some features that were previously undocumented, or behaved
3144 differently from the documentation, had to be changed in order
3145 to clarify the semantics. Hence, client code that was relying
3146 on some dark areas of C<SQL::Abstract> v1.*
3147 B<might behave differently> in v1.50.
3149 The main changes are:
3155 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3159 support for the { operator => \"..." } construct (to embed literal SQL)
3163 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3167 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3171 defensive programming: check arguments
3175 fixed bug with global logic, which was previously implemented
3176 through global variables yielding side-effects. Prior versions would
3177 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3178 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3179 Now this is interpreted
3180 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3185 fixed semantics of _bindtype on array args
3189 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3190 we just avoid shifting arrays within that tree.
3194 dropped the C<_modlogic> function
3198 =head1 ACKNOWLEDGEMENTS
3200 There are a number of individuals that have really helped out with
3201 this module. Unfortunately, most of them submitted bugs via CPAN
3202 so I have no idea who they are! But the people I do know are:
3204 Ash Berlin (order_by hash term support)
3205 Matt Trout (DBIx::Class support)
3206 Mark Stosberg (benchmarking)
3207 Chas Owens (initial "IN" operator support)
3208 Philip Collins (per-field SQL functions)
3209 Eric Kolve (hashref "AND" support)
3210 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3211 Dan Kubb (support for "quote_char" and "name_sep")
3212 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3213 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3214 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3215 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3216 Oliver Charles (support for "RETURNING" after "INSERT")
3222 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3226 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3228 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3230 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3231 While not an official support venue, C<DBIx::Class> makes heavy use of
3232 C<SQL::Abstract>, and as such list members there are very familiar with
3233 how to create queries.
3237 This module is free software; you may copy this under the same
3238 terms as perl itself (either the GNU General Public License or
3239 the Artistic License)