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 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{special_ops} ||= [];
160 # regexes are applied in order, thus push after user-defines
161 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 if ($class->isa('DBIx::Class::SQLMaker')) {
164 push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= {
165 regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" }
167 $opt{is_dbic_sqlmaker} = 1;
171 $opt{unary_ops} ||= [];
173 # rudimentary sanity-check for user supplied bits treated as functions/operators
174 # If a purported function matches this regular expression, an exception is thrown.
175 # Literal SQL is *NOT* subject to this check, only functions (and column names
176 # when quoting is not in effect)
179 # need to guard against ()'s in column names too, but this will break tons of
180 # hacks... ideas anyone?
181 $opt{injection_guard} ||= qr/
188 (map +("-$_", "_render_$_"), qw(op func bind ident literal list)),
192 $opt{expand_unary} = {};
195 '-ident' => '_expand_ident',
196 '-fffvalue' => sub { +{ -bind => [ our $Cur_Col_Meta, $_[2] ] } },
199 return bless \%opt, $class;
202 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
203 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
205 sub _assert_pass_injection_guard {
206 if ($_[1] =~ $_[0]->{injection_guard}) {
207 my $class = ref $_[0];
208 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
209 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
210 . "{injection_guard} attribute to ${class}->new()"
215 #======================================================================
217 #======================================================================
221 my $table = $self->_table(shift);
222 my $data = shift || return;
225 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
226 my ($sql, @bind) = $self->$method($data);
227 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
229 if ($options->{returning}) {
230 my ($s, @b) = $self->_insert_returning($options);
235 return wantarray ? ($sql, @bind) : $sql;
238 # So that subclasses can override INSERT ... RETURNING separately from
239 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
240 sub _insert_returning { shift->_returning(@_) }
243 my ($self, $options) = @_;
245 my $f = $options->{returning};
247 my ($sql, @bind) = $self->render_aqt(
248 $self->_expand_maybe_list_expr($f, undef, -ident)
251 ? $self->_sqlcase(' returning ') . $sql
252 : ($self->_sqlcase(' returning ').$sql, @bind);
255 sub _insert_HASHREF { # explicit list of fields and then values
256 my ($self, $data) = @_;
258 my @fields = sort keys %$data;
260 my ($sql, @bind) = $self->_insert_values($data);
263 $_ = $self->_quote($_) foreach @fields;
264 $sql = "( ".join(", ", @fields).") ".$sql;
266 return ($sql, @bind);
269 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
270 my ($self, $data) = @_;
272 # no names (arrayref) so can't generate bindtype
273 $self->{bindtype} ne 'columns'
274 or belch "can't do 'columns' bindtype when called with arrayref";
276 my (@values, @all_bind);
277 foreach my $value (@$data) {
278 my ($values, @bind) = $self->_insert_value(undef, $value);
279 push @values, $values;
280 push @all_bind, @bind;
282 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
283 return ($sql, @all_bind);
286 sub _insert_ARRAYREFREF { # literal SQL with bind
287 my ($self, $data) = @_;
289 my ($sql, @bind) = @${$data};
290 $self->_assert_bindval_matches_bindtype(@bind);
292 return ($sql, @bind);
296 sub _insert_SCALARREF { # literal SQL without bind
297 my ($self, $data) = @_;
303 my ($self, $data) = @_;
305 my (@values, @all_bind);
306 foreach my $column (sort keys %$data) {
307 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
308 push @values, $values;
309 push @all_bind, @bind;
311 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
312 return ($sql, @all_bind);
316 my ($self, $column, $v) = @_;
318 return $self->render_aqt(
319 $self->_expand_insert_value($column, $v)
323 sub _expand_insert_value {
324 my ($self, $column, $v) = @_;
326 if (ref($v) eq 'ARRAY') {
327 if ($self->{array_datatypes}) {
328 return +{ -bind => [ $column, $v ] };
330 my ($sql, @bind) = @$v;
331 $self->_assert_bindval_matches_bindtype(@bind);
332 return +{ -literal => $v };
334 if (ref($v) eq 'HASH') {
335 if (grep !/^-/, keys %$v) {
336 belch "HASH ref as bind value in insert is not supported";
337 return +{ -bind => [ $column, $v ] };
341 return +{ -bind => [ $column, undef ] };
343 local our $Cur_Col_Meta = $column;
344 return $self->expand_expr($v);
349 #======================================================================
351 #======================================================================
356 my $table = $self->_table(shift);
357 my $data = shift || return;
361 # first build the 'SET' part of the sql statement
362 puke "Unsupported data type specified to \$sql->update"
363 unless ref $data eq 'HASH';
365 my ($sql, @all_bind) = $self->_update_set_values($data);
366 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
370 my($where_sql, @where_bind) = $self->where($where);
372 push @all_bind, @where_bind;
375 if ($options->{returning}) {
376 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
377 $sql .= $returning_sql;
378 push @all_bind, @returning_bind;
381 return wantarray ? ($sql, @all_bind) : $sql;
384 sub _update_set_values {
385 my ($self, $data) = @_;
387 return $self->render_aqt(
388 $self->_expand_update_set_values($data),
392 sub _expand_update_set_values {
393 my ($self, $data) = @_;
394 $self->_expand_maybe_list_expr( [
397 $set = { -bind => $_ } unless defined $set;
398 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
404 ? ($self->{array_datatypes}
405 ? [ $k, +{ -bind => [ $k, $v ] } ]
406 : [ $k, +{ -literal => $v } ])
408 local our $Cur_Col_Meta = $k;
409 [ $k, $self->_expand_expr($v) ]
416 # So that subclasses can override UPDATE ... RETURNING separately from
418 sub _update_returning { shift->_returning(@_) }
422 #======================================================================
424 #======================================================================
429 my $table = $self->_table(shift);
430 my $fields = shift || '*';
434 my ($fields_sql, @bind) = $self->_select_fields($fields);
436 my ($where_sql, @where_bind) = $self->where($where, $order);
437 push @bind, @where_bind;
439 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
440 $self->_sqlcase('from'), $table)
443 return wantarray ? ($sql, @bind) : $sql;
447 my ($self, $fields) = @_;
448 return $fields unless ref($fields);
449 return $self->render_aqt(
450 $self->_expand_maybe_list_expr($fields, undef, '-ident')
454 #======================================================================
456 #======================================================================
461 my $table = $self->_table(shift);
465 my($where_sql, @bind) = $self->where($where);
466 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
468 if ($options->{returning}) {
469 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
470 $sql .= $returning_sql;
471 push @bind, @returning_bind;
474 return wantarray ? ($sql, @bind) : $sql;
477 # So that subclasses can override DELETE ... RETURNING separately from
479 sub _delete_returning { shift->_returning(@_) }
483 #======================================================================
485 #======================================================================
489 # Finally, a separate routine just to handle WHERE clauses
491 my ($self, $where, $order) = @_;
493 local $self->{convert_where} = $self->{convert};
496 my ($sql, @bind) = defined($where)
497 ? $self->_recurse_where($where)
499 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
503 my ($order_sql, @order_bind) = $self->_order_by($order);
505 push @bind, @order_bind;
508 return wantarray ? ($sql, @bind) : $sql;
512 my ($self, $expr, $default_scalar_to) = @_;
513 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
514 $self->_expand_expr($expr);
518 my ($self, $aqt) = @_;
519 my ($k, $v, @rest) = %$aqt;
521 if (my $meth = $self->{render}{$k}) {
522 return $self->$meth($v);
524 die "notreached: $k";
528 my ($self, $expr) = @_;
529 $self->render_aqt($self->expand_expr($expr));
533 my ($self, $expr, $logic) = @_;
534 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
535 return undef unless defined($expr);
536 if (ref($expr) eq 'HASH') {
537 return undef unless my $kc = keys %$expr;
542 map $self->_expand_expr({ $_ => $expr->{$_} }, $logic),
546 my ($key, $value) = %$expr;
547 if (my $exp = $self->{expand}{$key}) {
548 $self->$exp($key, $value);
550 return $self->_expand_expr_hashpair($key, $value, $logic);
552 if (ref($expr) eq 'ARRAY') {
553 my $logic = lc($logic || $self->{logic});
554 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
557 (ref($_) eq 'ARRAY' and @$_)
558 or (ref($_) eq 'HASH' and %$_)
564 while (my ($el) = splice @expr, 0, 1) {
565 puke "Supplying an empty left hand side argument is not supported in array-pairs"
566 unless defined($el) and length($el);
567 my $elref = ref($el);
569 local $Expand_Depth = 0;
570 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
571 } elsif ($elref eq 'ARRAY') {
572 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
573 } elsif (my $l = is_literal_value($el)) {
574 push @res, { -literal => $l };
575 } elsif ($elref eq 'HASH') {
576 local $Expand_Depth = 0;
577 push @res, grep defined, $self->_expand_expr($el) if %$el;
583 # return $res[0] if @res == 1;
584 return { -op => [ $logic, @res ] };
586 if (my $literal = is_literal_value($expr)) {
587 return +{ -literal => $literal };
589 if (!ref($expr) or Scalar::Util::blessed($expr)) {
590 if (my $d = our $Default_Scalar_To) {
591 return $self->_expand_expr({ $d => $expr });
593 if (my $m = our $Cur_Col_Meta) {
594 return +{ -bind => [ $m, $expr ] };
596 return +{ -bind => [ undef, $expr ] };
601 sub _expand_expr_hashpair {
602 my ($self, $k, $v, $logic) = @_;
603 unless (defined($k) and length($k)) {
604 if (defined($k) and my $literal = is_literal_value($v)) {
605 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
606 return { -literal => $literal };
608 puke "Supplying an empty left hand side argument is not supported";
611 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
612 if ($k =~ s/ [_\s]? \d+ $//x ) {
613 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
614 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
617 # DBIx::Class requires a nest warning to be emitted once but the private
618 # method it overrode to do so no longer exists
619 if ($self->{is_dbic_sqlmaker}) {
620 unless (our $Nest_Warned) {
622 "-nest in search conditions is deprecated, you most probably wanted:\n"
623 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
628 return $self->_expand_expr($v);
632 return $self->_expand_expr($v);
634 puke "-bool => undef not supported" unless defined($v);
635 return $self->_expand_ident(-ident => $v);
638 return { -op => [ 'not', $self->_expand_expr($v) ] };
640 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
643 $self->_expand_expr({ "-${rest}", $v }, $logic)
646 if (my ($logic) = $k =~ /^-(and|or)$/i) {
647 if (ref($v) eq 'HASH') {
648 return $self->_expand_expr($v, $logic);
650 if (ref($v) eq 'ARRAY') {
651 return $self->_expand_expr($v, $logic);
656 $op =~ s/^-// if length($op) > 1;
658 # top level special ops are illegal in general
659 # note that, arguably, if it makes no sense at top level, it also
660 # makes no sense on the other side of an = sign or similar but DBIC
661 # gets disappointingly upset if I disallow it
663 (our $Expand_Depth) == 1
664 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
666 puke "Illegal use of top-level '-$op'"
668 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
669 return { -op => [ $op, $v ] };
672 if ($k eq '-value') {
673 return +{ -bind => [ our $Cur_Col_Meta, $v ] };
675 # if ($k eq '-ident') {
676 # return $self->_expand_ident(-ident => $v);
678 if (my $custom = $self->{expand_unary}{$k}) {
679 return $self->$custom($v);
681 if ($self->{render}{$k}) {
687 and (keys %$v)[0] =~ /^-/
689 my ($func) = $k =~ /^-(.*)$/;
690 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
691 return +{ -op => [ $func, $self->_expand_expr($v) ] };
693 return +{ -func => [ $func, $self->_expand_expr($v) ] };
695 if (!ref($v) or is_literal_value($v)) {
696 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
703 and exists $v->{-value}
704 and not defined $v->{-value}
707 return $self->_expand_expr({ $k => { $self->{cmp} => undef } });
709 if (!ref($v) or Scalar::Util::blessed($v)) {
710 my $d = our $Default_Scalar_To;
714 $self->_expand_ident(-ident => $k),
716 ? $self->_expand_expr($d => $v)
717 : { -bind => [ $k, $v ] }
722 if (ref($v) eq 'HASH') {
726 map $self->_expand_expr({ $k => { $_ => $v->{$_} } }),
730 return undef unless keys %$v;
732 my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0];
733 $self->_assert_pass_injection_guard($op);
734 if ($op =~ s/ [_\s]? \d+ $//x ) {
735 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
736 . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
738 if ($op =~ /^(?:not )?between$/) {
739 local our $Cur_Col_Meta = $k;
740 my @rhs = map $self->_expand_expr($_),
741 ref($vv) eq 'ARRAY' ? @$vv : $vv;
743 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
745 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
747 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
751 $self->_expand_ident(-ident => $k),
755 if ($op =~ /^(?:not )?in$/) {
756 if (my $literal = is_literal_value($vv)) {
757 my ($sql, @bind) = @$literal;
758 my $opened_sql = $self->_open_outer_paren($sql);
760 $op, $self->_expand_ident(-ident => $k),
761 [ { -literal => [ $opened_sql, @bind ] } ]
765 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
766 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
767 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
768 . 'will emit the logically correct SQL instead of raising this exception)'
770 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
772 my @rhs = map $self->_expand_expr($_),
773 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
774 map { defined($_) ? $_: puke($undef_err) }
775 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
776 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
780 $self->_expand_ident(-ident => $k),
784 if ($op eq 'ident') {
785 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
786 puke "-$op requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
790 $self->_expand_ident(-ident => $k),
791 $self->_expand_ident(-ident => $vv),
794 if ($op eq 'value') {
795 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
798 $self->_expand_ident(-ident => $k),
799 { -bind => [ $k, $vv ] }
802 if ($op =~ /^is(?: not)?$/) {
803 puke "$op can only take undef as argument"
807 and exists($vv->{-value})
808 and !defined($vv->{-value})
810 return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] };
812 if ($op =~ /^(and|or)$/) {
813 if (ref($vv) eq 'HASH') {
816 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
821 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
822 return { -op => [ $op, $self->_expand_ident(-ident => $k), $vv ] };
824 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
827 $self->_expand_ident(-ident => $k),
828 { -op => [ $op, $vv ] }
831 if (ref($vv) eq 'ARRAY') {
832 my ($logic, @values) = (
833 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
838 $op =~ $self->{inequality_op}
839 or $op =~ $self->{not_like_op}
841 if (lc($logic) eq '-or' and @values > 1) {
842 belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' "
843 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
844 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
849 # try to DWIM on equality operators
851 $op =~ $self->{equality_op} ? $self->sqlfalse
852 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
853 : $op =~ $self->{inequality_op} ? $self->sqltrue
854 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
855 : puke "operator '$op' applied on an empty array (field '$k')";
859 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
867 and exists $vv->{-value}
868 and not defined $vv->{-value}
872 $op =~ /^not$/i ? 'is not' # legacy
873 : $op =~ $self->{equality_op} ? 'is'
874 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
875 : $op =~ $self->{inequality_op} ? 'is not'
876 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
877 : puke "unexpected operator '$op' with undef operand";
878 return +{ -op => [ $is.' null', $self->_expand_ident(-ident => $k) ] };
880 local our $Cur_Col_Meta = $k;
883 $self->_expand_ident(-ident => $k),
884 $self->_expand_expr($vv)
887 if (ref($v) eq 'ARRAY') {
888 return $self->sqlfalse unless @$v;
889 $self->_debug("ARRAY($k) means distribute over elements");
891 $v->[0] =~ /^-((?:and|or))$/i
892 ? ($v = [ @{$v}[1..$#$v] ], $1)
893 : ($self->{logic} || 'or')
897 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
900 if (my $literal = is_literal_value($v)) {
902 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
905 my ($sql, @bind) = @$literal;
906 if ($self->{bindtype} eq 'columns') {
908 $self->_assert_bindval_matches_bindtype($_);
911 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
917 my ($self, undef, $body) = @_;
918 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
919 ref($body) ? @$body : $body;
920 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
921 unless ($self->{quote_char}) {
922 $self->_assert_pass_injection_guard($_) for @parts;
924 return +{ -ident => \@parts };
928 my ($self, $where, $logic) = @_;
930 # Special case: top level simple string treated as literal
932 my $where_exp = (ref($where)
933 ? $self->_expand_expr($where, $logic)
934 : { -literal => [ $where ] });
936 # dispatch expanded expression
938 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
939 # DBIx::Class used to call _recurse_where in scalar context
940 # something else might too...
942 return ($sql, @bind);
945 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
951 my ($self, $ident) = @_;
953 return $self->_convert($self->_quote($ident));
956 my %unop_postfix = map +($_ => 1),
957 'is null', 'is not null',
965 my ($self, $args) = @_;
966 my ($left, $low, $high) = @$args;
967 my ($rhsql, @rhbind) = do {
969 puke "Single arg to between must be a literal"
970 unless $low->{-literal};
973 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
974 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
975 @{$l}[1..$#$l], @{$h}[1..$#$h])
978 my ($lhsql, @lhbind) = $self->render_aqt($left);
980 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
984 }), 'between', 'not between'),
988 my ($self, $args) = @_;
989 my ($lhs, $rhs) = @$args;
992 my ($sql, @bind) = $self->render_aqt($_);
993 push @in_bind, @bind;
996 my ($lhsql, @lbind) = $self->render_aqt($lhs);
998 $lhsql.' '.$self->_sqlcase($op).' ( '
1004 }), 'in', 'not in'),
1008 my ($self, $v) = @_;
1009 my ($op, @args) = @$v;
1010 $op =~ s/^-// if length($op) > 1;
1012 if (my $h = $special{$op}) {
1013 return $self->$h(\@args);
1015 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1016 if ($us and @args > 1) {
1017 puke "Special op '${op}' requires first value to be identifier"
1018 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1019 my $k = join(($self->{name_sep}||'.'), @$ident);
1020 local our $Expand_Depth = 1;
1021 return $self->${\($us->{handler})}($k, $op, $args[1]);
1023 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1024 return $self->${\($us->{handler})}($op, $args[0]);
1026 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1027 if (@args == 1 and $op !~ /^(and|or)$/) {
1028 my ($expr_sql, @bind) = $self->render_aqt($args[0]);
1029 my $op_sql = $self->_sqlcase($final_op);
1031 $unop_postfix{lc($final_op)}
1032 ? "${expr_sql} ${op_sql}"
1033 : "${op_sql} ${expr_sql}"
1035 return (($op eq 'not' || $us ? '('.$final_sql.')' : $final_sql), @bind);
1037 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args;
1038 return '' unless @parts;
1039 my $is_andor = !!($op =~ /^(and|or)$/);
1040 return @{$parts[0]} if $is_andor and @parts == 1;
1041 my ($final_sql) = map +($is_andor ? "( ${_} )" : $_), join(
1042 ' '.$self->_sqlcase($final_op).' ',
1047 map @{$_}[1..$#$_], @parts
1054 my ($self, $list) = @_;
1055 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$list;
1056 return join(', ', map $_->[0], @parts), map @{$_}[1..$#$_], @parts;
1060 my ($self, $rest) = @_;
1061 my ($func, @args) = @$rest;
1065 push @arg_sql, shift @x;
1067 } map [ $self->render_aqt($_) ], @args;
1068 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1072 my ($self, $bind) = @_;
1073 return ($self->_convert('?'), $self->_bindtype(@$bind));
1076 sub _render_literal {
1077 my ($self, $literal) = @_;
1078 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1082 # Some databases (SQLite) treat col IN (1, 2) different from
1083 # col IN ( (1, 2) ). Use this to strip all outer parens while
1084 # adding them back in the corresponding method
1085 sub _open_outer_paren {
1086 my ($self, $sql) = @_;
1088 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1090 # there are closing parens inside, need the heavy duty machinery
1091 # to reevaluate the extraction starting from $sql (full reevaluation)
1092 if ($inner =~ /\)/) {
1093 require Text::Balanced;
1095 my (undef, $remainder) = do {
1096 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1098 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1101 # the entire expression needs to be a balanced bracketed thing
1102 # (after an extract no remainder sans trailing space)
1103 last if defined $remainder and $remainder =~ /\S/;
1113 #======================================================================
1115 #======================================================================
1117 sub _expand_order_by {
1118 my ($self, $arg) = @_;
1120 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1122 my $expander = sub {
1123 my ($self, $dir, $expr) = @_;
1124 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1125 foreach my $arg (@to_expand) {
1129 and grep /^-(asc|desc)$/, keys %$arg
1131 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1134 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1135 map $self->expand_expr($_, -ident),
1136 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1137 return (@exp > 1 ? { -list => \@exp } : $exp[0]);
1140 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1141 sub { shift->$expander(asc => @_) },
1142 sub { shift->$expander(desc => @_) },
1145 return $self->$expander(undef, $arg);
1149 my ($self, $arg) = @_;
1151 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1153 my ($sql, @bind) = $self->render_aqt($expanded);
1155 return '' unless length($sql);
1157 my $final_sql = $self->_sqlcase(' order by ').$sql;
1159 return wantarray ? ($final_sql, @bind) : $final_sql;
1162 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1164 sub _order_by_chunks {
1165 my ($self, $arg) = @_;
1167 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1169 return $self->_chunkify_order_by($expanded);
1172 sub _chunkify_order_by {
1173 my ($self, $expanded) = @_;
1175 return grep length, $self->render_aqt($expanded)
1176 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1179 if (ref() eq 'HASH' and my $l = $_->{-list}) {
1180 return map $self->_chunkify_order_by($_), @$l;
1182 return [ $self->render_aqt($_) ];
1186 #======================================================================
1187 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1188 #======================================================================
1194 $self->_expand_maybe_list_expr($from, undef, -ident)
1199 #======================================================================
1201 #======================================================================
1203 sub _expand_maybe_list_expr {
1204 my ($self, $expr, $logic, $default) = @_;
1206 if (ref($expr) eq 'ARRAY') {
1208 map $self->expand_expr($_, $default), @$expr
1215 return $self->expand_expr($e, $default);
1218 # highly optimized, as it's called way too often
1220 # my ($self, $label) = @_;
1222 return '' unless defined $_[1];
1223 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1224 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1226 unless ($_[0]->{quote_char}) {
1227 if (ref($_[1]) eq 'ARRAY') {
1228 return join($_[0]->{name_sep}||'.', @{$_[1]});
1230 $_[0]->_assert_pass_injection_guard($_[1]);
1235 my $qref = ref $_[0]->{quote_char};
1237 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1238 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1239 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1241 my $esc = $_[0]->{escape_char} || $r;
1243 # parts containing * are naturally unquoted
1245 $_[0]->{name_sep}||'',
1249 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1251 (ref($_[1]) eq 'ARRAY'
1255 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1263 # Conversion, if applicable
1265 #my ($self, $arg) = @_;
1266 if ($_[0]->{convert_where}) {
1267 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1274 #my ($self, $col, @vals) = @_;
1275 # called often - tighten code
1276 return $_[0]->{bindtype} eq 'columns'
1277 ? map {[$_[1], $_]} @_[2 .. $#_]
1282 # Dies if any element of @bind is not in [colname => value] format
1283 # if bindtype is 'columns'.
1284 sub _assert_bindval_matches_bindtype {
1285 # my ($self, @bind) = @_;
1287 if ($self->{bindtype} eq 'columns') {
1289 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1290 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1296 sub _join_sql_clauses {
1297 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1299 if (@$clauses_aref > 1) {
1300 my $join = " " . $self->_sqlcase($logic) . " ";
1301 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1302 return ($sql, @$bind_aref);
1304 elsif (@$clauses_aref) {
1305 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1308 return (); # if no SQL, ignore @$bind_aref
1313 # Fix SQL case, if so requested
1315 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1316 # don't touch the argument ... crooked logic, but let's not change it!
1317 return $_[0]->{case} ? $_[1] : uc($_[1]);
1321 #======================================================================
1322 # DISPATCHING FROM REFKIND
1323 #======================================================================
1326 my ($self, $data) = @_;
1328 return 'UNDEF' unless defined $data;
1330 # blessed objects are treated like scalars
1331 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1333 return 'SCALAR' unless $ref;
1336 while ($ref eq 'REF') {
1338 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1342 return ($ref||'SCALAR') . ('REF' x $n_steps);
1346 my ($self, $data) = @_;
1347 my @try = ($self->_refkind($data));
1348 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1349 push @try, 'FALLBACK';
1353 sub _METHOD_FOR_refkind {
1354 my ($self, $meth_prefix, $data) = @_;
1357 for (@{$self->_try_refkind($data)}) {
1358 $method = $self->can($meth_prefix."_".$_)
1362 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1366 sub _SWITCH_refkind {
1367 my ($self, $data, $dispatch_table) = @_;
1370 for (@{$self->_try_refkind($data)}) {
1371 $coderef = $dispatch_table->{$_}
1375 puke "no dispatch entry for ".$self->_refkind($data)
1384 #======================================================================
1385 # VALUES, GENERATE, AUTOLOAD
1386 #======================================================================
1388 # LDNOTE: original code from nwiger, didn't touch code in that section
1389 # I feel the AUTOLOAD stuff should not be the default, it should
1390 # only be activated on explicit demand by user.
1394 my $data = shift || return;
1395 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1396 unless ref $data eq 'HASH';
1399 foreach my $k (sort keys %$data) {
1400 my $v = $data->{$k};
1401 $self->_SWITCH_refkind($v, {
1403 if ($self->{array_datatypes}) { # array datatype
1404 push @all_bind, $self->_bindtype($k, $v);
1406 else { # literal SQL with bind
1407 my ($sql, @bind) = @$v;
1408 $self->_assert_bindval_matches_bindtype(@bind);
1409 push @all_bind, @bind;
1412 ARRAYREFREF => sub { # literal SQL with bind
1413 my ($sql, @bind) = @${$v};
1414 $self->_assert_bindval_matches_bindtype(@bind);
1415 push @all_bind, @bind;
1417 SCALARREF => sub { # literal SQL without bind
1419 SCALAR_or_UNDEF => sub {
1420 push @all_bind, $self->_bindtype($k, $v);
1431 my(@sql, @sqlq, @sqlv);
1435 if ($ref eq 'HASH') {
1436 for my $k (sort keys %$_) {
1439 my $label = $self->_quote($k);
1440 if ($r eq 'ARRAY') {
1441 # literal SQL with bind
1442 my ($sql, @bind) = @$v;
1443 $self->_assert_bindval_matches_bindtype(@bind);
1444 push @sqlq, "$label = $sql";
1446 } elsif ($r eq 'SCALAR') {
1447 # literal SQL without bind
1448 push @sqlq, "$label = $$v";
1450 push @sqlq, "$label = ?";
1451 push @sqlv, $self->_bindtype($k, $v);
1454 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1455 } elsif ($ref eq 'ARRAY') {
1456 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1459 if ($r eq 'ARRAY') { # literal SQL with bind
1460 my ($sql, @bind) = @$v;
1461 $self->_assert_bindval_matches_bindtype(@bind);
1464 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1465 # embedded literal SQL
1472 push @sql, '(' . join(', ', @sqlq) . ')';
1473 } elsif ($ref eq 'SCALAR') {
1477 # strings get case twiddled
1478 push @sql, $self->_sqlcase($_);
1482 my $sql = join ' ', @sql;
1484 # this is pretty tricky
1485 # if ask for an array, return ($stmt, @bind)
1486 # otherwise, s/?/shift @sqlv/ to put it inline
1488 return ($sql, @sqlv);
1490 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1491 ref $d ? $d->[1] : $d/e;
1500 # This allows us to check for a local, then _form, attr
1502 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1503 return $self->generate($name, @_);
1514 SQL::Abstract - Generate SQL from Perl data structures
1520 my $sql = SQL::Abstract->new;
1522 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1524 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1526 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1528 my($stmt, @bind) = $sql->delete($table, \%where);
1530 # Then, use these in your DBI statements
1531 my $sth = $dbh->prepare($stmt);
1532 $sth->execute(@bind);
1534 # Just generate the WHERE clause
1535 my($stmt, @bind) = $sql->where(\%where, $order);
1537 # Return values in the same order, for hashed queries
1538 # See PERFORMANCE section for more details
1539 my @bind = $sql->values(\%fieldvals);
1543 This module was inspired by the excellent L<DBIx::Abstract>.
1544 However, in using that module I found that what I really wanted
1545 to do was generate SQL, but still retain complete control over my
1546 statement handles and use the DBI interface. So, I set out to
1547 create an abstract SQL generation module.
1549 While based on the concepts used by L<DBIx::Abstract>, there are
1550 several important differences, especially when it comes to WHERE
1551 clauses. I have modified the concepts used to make the SQL easier
1552 to generate from Perl data structures and, IMO, more intuitive.
1553 The underlying idea is for this module to do what you mean, based
1554 on the data structures you provide it. The big advantage is that
1555 you don't have to modify your code every time your data changes,
1556 as this module figures it out.
1558 To begin with, an SQL INSERT is as easy as just specifying a hash
1559 of C<key=value> pairs:
1562 name => 'Jimbo Bobson',
1563 phone => '123-456-7890',
1564 address => '42 Sister Lane',
1565 city => 'St. Louis',
1566 state => 'Louisiana',
1569 The SQL can then be generated with this:
1571 my($stmt, @bind) = $sql->insert('people', \%data);
1573 Which would give you something like this:
1575 $stmt = "INSERT INTO people
1576 (address, city, name, phone, state)
1577 VALUES (?, ?, ?, ?, ?)";
1578 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1579 '123-456-7890', 'Louisiana');
1581 These are then used directly in your DBI code:
1583 my $sth = $dbh->prepare($stmt);
1584 $sth->execute(@bind);
1586 =head2 Inserting and Updating Arrays
1588 If your database has array types (like for example Postgres),
1589 activate the special option C<< array_datatypes => 1 >>
1590 when creating the C<SQL::Abstract> object.
1591 Then you may use an arrayref to insert and update database array types:
1593 my $sql = SQL::Abstract->new(array_datatypes => 1);
1595 planets => [qw/Mercury Venus Earth Mars/]
1598 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1602 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1604 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1607 =head2 Inserting and Updating SQL
1609 In order to apply SQL functions to elements of your C<%data> you may
1610 specify a reference to an arrayref for the given hash value. For example,
1611 if you need to execute the Oracle C<to_date> function on a value, you can
1612 say something like this:
1616 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1619 The first value in the array is the actual SQL. Any other values are
1620 optional and would be included in the bind values array. This gives
1623 my($stmt, @bind) = $sql->insert('people', \%data);
1625 $stmt = "INSERT INTO people (name, date_entered)
1626 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1627 @bind = ('Bill', '03/02/2003');
1629 An UPDATE is just as easy, all you change is the name of the function:
1631 my($stmt, @bind) = $sql->update('people', \%data);
1633 Notice that your C<%data> isn't touched; the module will generate
1634 the appropriately quirky SQL for you automatically. Usually you'll
1635 want to specify a WHERE clause for your UPDATE, though, which is
1636 where handling C<%where> hashes comes in handy...
1638 =head2 Complex where statements
1640 This module can generate pretty complicated WHERE statements
1641 easily. For example, simple C<key=value> pairs are taken to mean
1642 equality, and if you want to see if a field is within a set
1643 of values, you can use an arrayref. Let's say we wanted to
1644 SELECT some data based on this criteria:
1647 requestor => 'inna',
1648 worker => ['nwiger', 'rcwe', 'sfz'],
1649 status => { '!=', 'completed' }
1652 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1654 The above would give you something like this:
1656 $stmt = "SELECT * FROM tickets WHERE
1657 ( requestor = ? ) AND ( status != ? )
1658 AND ( worker = ? OR worker = ? OR worker = ? )";
1659 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1661 Which you could then use in DBI code like so:
1663 my $sth = $dbh->prepare($stmt);
1664 $sth->execute(@bind);
1670 The methods are simple. There's one for every major SQL operation,
1671 and a constructor you use first. The arguments are specified in a
1672 similar order for each method (table, then fields, then a where
1673 clause) to try and simplify things.
1675 =head2 new(option => 'value')
1677 The C<new()> function takes a list of options and values, and returns
1678 a new B<SQL::Abstract> object which can then be used to generate SQL
1679 through the methods below. The options accepted are:
1685 If set to 'lower', then SQL will be generated in all lowercase. By
1686 default SQL is generated in "textbook" case meaning something like:
1688 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1690 Any setting other than 'lower' is ignored.
1694 This determines what the default comparison operator is. By default
1695 it is C<=>, meaning that a hash like this:
1697 %where = (name => 'nwiger', email => 'nate@wiger.org');
1699 Will generate SQL like this:
1701 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1703 However, you may want loose comparisons by default, so if you set
1704 C<cmp> to C<like> you would get SQL such as:
1706 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1708 You can also override the comparison on an individual basis - see
1709 the huge section on L</"WHERE CLAUSES"> at the bottom.
1711 =item sqltrue, sqlfalse
1713 Expressions for inserting boolean values within SQL statements.
1714 By default these are C<1=1> and C<1=0>. They are used
1715 by the special operators C<-in> and C<-not_in> for generating
1716 correct SQL even when the argument is an empty array (see below).
1720 This determines the default logical operator for multiple WHERE
1721 statements in arrays or hashes. If absent, the default logic is "or"
1722 for arrays, and "and" for hashes. This means that a WHERE
1726 event_date => {'>=', '2/13/99'},
1727 event_date => {'<=', '4/24/03'},
1730 will generate SQL like this:
1732 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1734 This is probably not what you want given this query, though (look
1735 at the dates). To change the "OR" to an "AND", simply specify:
1737 my $sql = SQL::Abstract->new(logic => 'and');
1739 Which will change the above C<WHERE> to:
1741 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1743 The logic can also be changed locally by inserting
1744 a modifier in front of an arrayref:
1746 @where = (-and => [event_date => {'>=', '2/13/99'},
1747 event_date => {'<=', '4/24/03'} ]);
1749 See the L</"WHERE CLAUSES"> section for explanations.
1753 This will automatically convert comparisons using the specified SQL
1754 function for both column and value. This is mostly used with an argument
1755 of C<upper> or C<lower>, so that the SQL will have the effect of
1756 case-insensitive "searches". For example, this:
1758 $sql = SQL::Abstract->new(convert => 'upper');
1759 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1761 Will turn out the following SQL:
1763 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1765 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1766 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1767 not validate this option; it will just pass through what you specify verbatim).
1771 This is a kludge because many databases suck. For example, you can't
1772 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1773 Instead, you have to use C<bind_param()>:
1775 $sth->bind_param(1, 'reg data');
1776 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1778 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1779 which loses track of which field each slot refers to. Fear not.
1781 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1782 Currently, you can specify either C<normal> (default) or C<columns>. If you
1783 specify C<columns>, you will get an array that looks like this:
1785 my $sql = SQL::Abstract->new(bindtype => 'columns');
1786 my($stmt, @bind) = $sql->insert(...);
1789 [ 'column1', 'value1' ],
1790 [ 'column2', 'value2' ],
1791 [ 'column3', 'value3' ],
1794 You can then iterate through this manually, using DBI's C<bind_param()>.
1796 $sth->prepare($stmt);
1799 my($col, $data) = @$_;
1800 if ($col eq 'details' || $col eq 'comments') {
1801 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1802 } elsif ($col eq 'image') {
1803 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1805 $sth->bind_param($i, $data);
1809 $sth->execute; # execute without @bind now
1811 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1812 Basically, the advantage is still that you don't have to care which fields
1813 are or are not included. You could wrap that above C<for> loop in a simple
1814 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1815 get a layer of abstraction over manual SQL specification.
1817 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1818 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1819 will expect the bind values in this format.
1823 This is the character that a table or column name will be quoted
1824 with. By default this is an empty string, but you could set it to
1825 the character C<`>, to generate SQL like this:
1827 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1829 Alternatively, you can supply an array ref of two items, the first being the left
1830 hand quote character, and the second the right hand quote character. For
1831 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1832 that generates SQL like this:
1834 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1836 Quoting is useful if you have tables or columns names that are reserved
1837 words in your database's SQL dialect.
1841 This is the character that will be used to escape L</quote_char>s appearing
1842 in an identifier before it has been quoted.
1844 The parameter default in case of a single L</quote_char> character is the quote
1847 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1848 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1849 of the B<opening (left)> L</quote_char> within the identifier are currently left
1850 untouched. The default for opening-closing-style quotes may change in future
1851 versions, thus you are B<strongly encouraged> to specify the escape character
1856 This is the character that separates a table and column name. It is
1857 necessary to specify this when the C<quote_char> option is selected,
1858 so that tables and column names can be individually quoted like this:
1860 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1862 =item injection_guard
1864 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1865 column name specified in a query structure. This is a safety mechanism to avoid
1866 injection attacks when mishandling user input e.g.:
1868 my %condition_as_column_value_pairs = get_values_from_user();
1869 $sqla->select( ... , \%condition_as_column_value_pairs );
1871 If the expression matches an exception is thrown. Note that literal SQL
1872 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1874 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1876 =item array_datatypes
1878 When this option is true, arrayrefs in INSERT or UPDATE are
1879 interpreted as array datatypes and are passed directly
1881 When this option is false, arrayrefs are interpreted
1882 as literal SQL, just like refs to arrayrefs
1883 (but this behavior is for backwards compatibility; when writing
1884 new queries, use the "reference to arrayref" syntax
1890 Takes a reference to a list of "special operators"
1891 to extend the syntax understood by L<SQL::Abstract>.
1892 See section L</"SPECIAL OPERATORS"> for details.
1896 Takes a reference to a list of "unary operators"
1897 to extend the syntax understood by L<SQL::Abstract>.
1898 See section L</"UNARY OPERATORS"> for details.
1904 =head2 insert($table, \@values || \%fieldvals, \%options)
1906 This is the simplest function. You simply give it a table name
1907 and either an arrayref of values or hashref of field/value pairs.
1908 It returns an SQL INSERT statement and a list of bind values.
1909 See the sections on L</"Inserting and Updating Arrays"> and
1910 L</"Inserting and Updating SQL"> for information on how to insert
1911 with those data types.
1913 The optional C<\%options> hash reference may contain additional
1914 options to generate the insert SQL. Currently supported options
1921 Takes either a scalar of raw SQL fields, or an array reference of
1922 field names, and adds on an SQL C<RETURNING> statement at the end.
1923 This allows you to return data generated by the insert statement
1924 (such as row IDs) without performing another C<SELECT> statement.
1925 Note, however, this is not part of the SQL standard and may not
1926 be supported by all database engines.
1930 =head2 update($table, \%fieldvals, \%where, \%options)
1932 This takes a table, hashref of field/value pairs, and an optional
1933 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1935 See the sections on L</"Inserting and Updating Arrays"> and
1936 L</"Inserting and Updating SQL"> for information on how to insert
1937 with those data types.
1939 The optional C<\%options> hash reference may contain additional
1940 options to generate the update SQL. Currently supported options
1947 See the C<returning> option to
1948 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1952 =head2 select($source, $fields, $where, $order)
1954 This returns a SQL SELECT statement and associated list of bind values, as
1955 specified by the arguments:
1961 Specification of the 'FROM' part of the statement.
1962 The argument can be either a plain scalar (interpreted as a table
1963 name, will be quoted), or an arrayref (interpreted as a list
1964 of table names, joined by commas, quoted), or a scalarref
1965 (literal SQL, not quoted).
1969 Specification of the list of fields to retrieve from
1971 The argument can be either an arrayref (interpreted as a list
1972 of field names, will be joined by commas and quoted), or a
1973 plain scalar (literal SQL, not quoted).
1974 Please observe that this API is not as flexible as that of
1975 the first argument C<$source>, for backwards compatibility reasons.
1979 Optional argument to specify the WHERE part of the query.
1980 The argument is most often a hashref, but can also be
1981 an arrayref or plain scalar --
1982 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1986 Optional argument to specify the ORDER BY part of the query.
1987 The argument can be a scalar, a hashref or an arrayref
1988 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1994 =head2 delete($table, \%where, \%options)
1996 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1997 It returns an SQL DELETE statement and list of bind values.
1999 The optional C<\%options> hash reference may contain additional
2000 options to generate the delete SQL. Currently supported options
2007 See the C<returning> option to
2008 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2012 =head2 where(\%where, $order)
2014 This is used to generate just the WHERE clause. For example,
2015 if you have an arbitrary data structure and know what the
2016 rest of your SQL is going to look like, but want an easy way
2017 to produce a WHERE clause, use this. It returns an SQL WHERE
2018 clause and list of bind values.
2021 =head2 values(\%data)
2023 This just returns the values from the hash C<%data>, in the same
2024 order that would be returned from any of the other above queries.
2025 Using this allows you to markedly speed up your queries if you
2026 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2028 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2030 Warning: This is an experimental method and subject to change.
2032 This returns arbitrarily generated SQL. It's a really basic shortcut.
2033 It will return two different things, depending on return context:
2035 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2036 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2038 These would return the following:
2040 # First calling form
2041 $stmt = "CREATE TABLE test (?, ?)";
2042 @bind = (field1, field2);
2044 # Second calling form
2045 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2047 Depending on what you're trying to do, it's up to you to choose the correct
2048 format. In this example, the second form is what you would want.
2052 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2056 ALTER SESSION SET nls_date_format = 'MM/YY'
2058 You get the idea. Strings get their case twiddled, but everything
2059 else remains verbatim.
2061 =head1 EXPORTABLE FUNCTIONS
2063 =head2 is_plain_value
2065 Determines if the supplied argument is a plain value as understood by this
2070 =item * The value is C<undef>
2072 =item * The value is a non-reference
2074 =item * The value is an object with stringification overloading
2076 =item * The value is of the form C<< { -value => $anything } >>
2080 On failure returns C<undef>, on success returns a B<scalar> reference
2081 to the original supplied argument.
2087 The stringification overloading detection is rather advanced: it takes
2088 into consideration not only the presence of a C<""> overload, but if that
2089 fails also checks for enabled
2090 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2091 on either C<0+> or C<bool>.
2093 Unfortunately testing in the field indicates that this
2094 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2095 but only when very large numbers of stringifying objects are involved.
2096 At the time of writing ( Sep 2014 ) there is no clear explanation of
2097 the direct cause, nor is there a manageably small test case that reliably
2098 reproduces the problem.
2100 If you encounter any of the following exceptions in B<random places within
2101 your application stack> - this module may be to blame:
2103 Operation "ne": no method found,
2104 left argument in overloaded package <something>,
2105 right argument in overloaded package <something>
2109 Stub found while resolving method "???" overloading """" in package <something>
2111 If you fall victim to the above - please attempt to reduce the problem
2112 to something that could be sent to the L<SQL::Abstract developers
2113 |DBIx::Class/GETTING HELP/SUPPORT>
2114 (either publicly or privately). As a workaround in the meantime you can
2115 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2116 value, which will most likely eliminate your problem (at the expense of
2117 not being able to properly detect exotic forms of stringification).
2119 This notice and environment variable will be removed in a future version,
2120 as soon as the underlying problem is found and a reliable workaround is
2125 =head2 is_literal_value
2127 Determines if the supplied argument is a literal value as understood by this
2132 =item * C<\$sql_string>
2134 =item * C<\[ $sql_string, @bind_values ]>
2138 On failure returns C<undef>, on success returns an B<array> reference
2139 containing the unpacked version of the supplied literal SQL and bind values.
2141 =head1 WHERE CLAUSES
2145 This module uses a variation on the idea from L<DBIx::Abstract>. It
2146 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2147 module is that things in arrays are OR'ed, and things in hashes
2150 The easiest way to explain is to show lots of examples. After
2151 each C<%where> hash shown, it is assumed you used:
2153 my($stmt, @bind) = $sql->where(\%where);
2155 However, note that the C<%where> hash can be used directly in any
2156 of the other functions as well, as described above.
2158 =head2 Key-value pairs
2160 So, let's get started. To begin, a simple hash:
2164 status => 'completed'
2167 Is converted to SQL C<key = val> statements:
2169 $stmt = "WHERE user = ? AND status = ?";
2170 @bind = ('nwiger', 'completed');
2172 One common thing I end up doing is having a list of values that
2173 a field can be in. To do this, simply specify a list inside of
2178 status => ['assigned', 'in-progress', 'pending'];
2181 This simple code will create the following:
2183 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2184 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2186 A field associated to an empty arrayref will be considered a
2187 logical false and will generate 0=1.
2189 =head2 Tests for NULL values
2191 If the value part is C<undef> then this is converted to SQL <IS NULL>
2200 $stmt = "WHERE user = ? AND status IS NULL";
2203 To test if a column IS NOT NULL:
2207 status => { '!=', undef },
2210 =head2 Specific comparison operators
2212 If you want to specify a different type of operator for your comparison,
2213 you can use a hashref for a given column:
2217 status => { '!=', 'completed' }
2220 Which would generate:
2222 $stmt = "WHERE user = ? AND status != ?";
2223 @bind = ('nwiger', 'completed');
2225 To test against multiple values, just enclose the values in an arrayref:
2227 status => { '=', ['assigned', 'in-progress', 'pending'] };
2229 Which would give you:
2231 "WHERE status = ? OR status = ? OR status = ?"
2234 The hashref can also contain multiple pairs, in which case it is expanded
2235 into an C<AND> of its elements:
2239 status => { '!=', 'completed', -not_like => 'pending%' }
2242 # Or more dynamically, like from a form
2243 $where{user} = 'nwiger';
2244 $where{status}{'!='} = 'completed';
2245 $where{status}{'-not_like'} = 'pending%';
2247 # Both generate this
2248 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2249 @bind = ('nwiger', 'completed', 'pending%');
2252 To get an OR instead, you can combine it with the arrayref idea:
2256 priority => [ { '=', 2 }, { '>', 5 } ]
2259 Which would generate:
2261 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2262 @bind = ('2', '5', 'nwiger');
2264 If you want to include literal SQL (with or without bind values), just use a
2265 scalar reference or reference to an arrayref as the value:
2268 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2269 date_expires => { '<' => \"now()" }
2272 Which would generate:
2274 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2275 @bind = ('11/26/2008');
2278 =head2 Logic and nesting operators
2280 In the example above,
2281 there is a subtle trap if you want to say something like
2282 this (notice the C<AND>):
2284 WHERE priority != ? AND priority != ?
2286 Because, in Perl you I<can't> do this:
2288 priority => { '!=' => 2, '!=' => 1 }
2290 As the second C<!=> key will obliterate the first. The solution
2291 is to use the special C<-modifier> form inside an arrayref:
2293 priority => [ -and => {'!=', 2},
2297 Normally, these would be joined by C<OR>, but the modifier tells it
2298 to use C<AND> instead. (Hint: You can use this in conjunction with the
2299 C<logic> option to C<new()> in order to change the way your queries
2300 work by default.) B<Important:> Note that the C<-modifier> goes
2301 B<INSIDE> the arrayref, as an extra first element. This will
2302 B<NOT> do what you think it might:
2304 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2306 Here is a quick list of equivalencies, since there is some overlap:
2309 status => {'!=', 'completed', 'not like', 'pending%' }
2310 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2313 status => {'=', ['assigned', 'in-progress']}
2314 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2315 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2319 =head2 Special operators: IN, BETWEEN, etc.
2321 You can also use the hashref format to compare a list of fields using the
2322 C<IN> comparison operator, by specifying the list as an arrayref:
2325 status => 'completed',
2326 reportid => { -in => [567, 2335, 2] }
2329 Which would generate:
2331 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2332 @bind = ('completed', '567', '2335', '2');
2334 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2337 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2338 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2339 'sqltrue' (by default: C<1=1>).
2341 In addition to the array you can supply a chunk of literal sql or
2342 literal sql with bind:
2345 customer => { -in => \[
2346 'SELECT cust_id FROM cust WHERE balance > ?',
2349 status => { -in => \'SELECT status_codes FROM states' },
2355 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2356 AND status IN ( SELECT status_codes FROM states )
2360 Finally, if the argument to C<-in> is not a reference, it will be
2361 treated as a single-element array.
2363 Another pair of operators is C<-between> and C<-not_between>,
2364 used with an arrayref of two values:
2368 completion_date => {
2369 -not_between => ['2002-10-01', '2003-02-06']
2375 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2377 Just like with C<-in> all plausible combinations of literal SQL
2381 start0 => { -between => [ 1, 2 ] },
2382 start1 => { -between => \["? AND ?", 1, 2] },
2383 start2 => { -between => \"lower(x) AND upper(y)" },
2384 start3 => { -between => [
2386 \["upper(?)", 'stuff' ],
2393 ( start0 BETWEEN ? AND ? )
2394 AND ( start1 BETWEEN ? AND ? )
2395 AND ( start2 BETWEEN lower(x) AND upper(y) )
2396 AND ( start3 BETWEEN lower(x) AND upper(?) )
2398 @bind = (1, 2, 1, 2, 'stuff');
2401 These are the two builtin "special operators"; but the
2402 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2404 =head2 Unary operators: bool
2406 If you wish to test against boolean columns or functions within your
2407 database you can use the C<-bool> and C<-not_bool> operators. For
2408 example to test the column C<is_user> being true and the column
2409 C<is_enabled> being false you would use:-
2413 -not_bool => 'is_enabled',
2418 WHERE is_user AND NOT is_enabled
2420 If a more complex combination is required, testing more conditions,
2421 then you should use the and/or operators:-
2426 -not_bool => { two=> { -rlike => 'bar' } },
2427 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2438 (NOT ( three = ? OR three > ? ))
2441 =head2 Nested conditions, -and/-or prefixes
2443 So far, we've seen how multiple conditions are joined with a top-level
2444 C<AND>. We can change this by putting the different conditions we want in
2445 hashes and then putting those hashes in an array. For example:
2450 status => { -like => ['pending%', 'dispatched'] },
2454 status => 'unassigned',
2458 This data structure would create the following:
2460 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2461 OR ( user = ? AND status = ? ) )";
2462 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2465 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2466 to change the logic inside:
2472 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2473 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2480 $stmt = "WHERE ( user = ?
2481 AND ( ( workhrs > ? AND geo = ? )
2482 OR ( workhrs < ? OR geo = ? ) ) )";
2483 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2485 =head3 Algebraic inconsistency, for historical reasons
2487 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2488 operator goes C<outside> of the nested structure; whereas when connecting
2489 several constraints on one column, the C<-and> operator goes
2490 C<inside> the arrayref. Here is an example combining both features:
2493 -and => [a => 1, b => 2],
2494 -or => [c => 3, d => 4],
2495 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2500 WHERE ( ( ( a = ? AND b = ? )
2501 OR ( c = ? OR d = ? )
2502 OR ( e LIKE ? AND e LIKE ? ) ) )
2504 This difference in syntax is unfortunate but must be preserved for
2505 historical reasons. So be careful: the two examples below would
2506 seem algebraically equivalent, but they are not
2509 { -like => 'foo%' },
2510 { -like => '%bar' },
2512 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2515 { col => { -like => 'foo%' } },
2516 { col => { -like => '%bar' } },
2518 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2521 =head2 Literal SQL and value type operators
2523 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2524 side" is a column name and the "right side" is a value (normally rendered as
2525 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2526 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2527 alter this behavior. There are several ways of doing so.
2531 This is a virtual operator that signals the string to its right side is an
2532 identifier (a column name) and not a value. For example to compare two
2533 columns you would write:
2536 priority => { '<', 2 },
2537 requestor => { -ident => 'submitter' },
2542 $stmt = "WHERE priority < ? AND requestor = submitter";
2545 If you are maintaining legacy code you may see a different construct as
2546 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2551 This is a virtual operator that signals that the construct to its right side
2552 is a value to be passed to DBI. This is for example necessary when you want
2553 to write a where clause against an array (for RDBMS that support such
2554 datatypes). For example:
2557 array => { -value => [1, 2, 3] }
2562 $stmt = 'WHERE array = ?';
2563 @bind = ([1, 2, 3]);
2565 Note that if you were to simply say:
2571 the result would probably not be what you wanted:
2573 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2578 Finally, sometimes only literal SQL will do. To include a random snippet
2579 of SQL verbatim, you specify it as a scalar reference. Consider this only
2580 as a last resort. Usually there is a better way. For example:
2583 priority => { '<', 2 },
2584 requestor => { -in => \'(SELECT name FROM hitmen)' },
2589 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2592 Note that in this example, you only get one bind parameter back, since
2593 the verbatim SQL is passed as part of the statement.
2597 Never use untrusted input as a literal SQL argument - this is a massive
2598 security risk (there is no way to check literal snippets for SQL
2599 injections and other nastyness). If you need to deal with untrusted input
2600 use literal SQL with placeholders as described next.
2602 =head3 Literal SQL with placeholders and bind values (subqueries)
2604 If the literal SQL to be inserted has placeholders and bind values,
2605 use a reference to an arrayref (yes this is a double reference --
2606 not so common, but perfectly legal Perl). For example, to find a date
2607 in Postgres you can use something like this:
2610 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2615 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2618 Note that you must pass the bind values in the same format as they are returned
2619 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2620 to C<columns>, you must provide the bind values in the
2621 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2622 scalar value; most commonly the column name, but you can use any scalar value
2623 (including references and blessed references), L<SQL::Abstract> will simply
2624 pass it through intact. So if C<bindtype> is set to C<columns> the above
2625 example will look like:
2628 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2631 Literal SQL is especially useful for nesting parenthesized clauses in the
2632 main SQL query. Here is a first example:
2634 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2638 bar => \["IN ($sub_stmt)" => @sub_bind],
2643 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2644 WHERE c2 < ? AND c3 LIKE ?))";
2645 @bind = (1234, 100, "foo%");
2647 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2648 are expressed in the same way. Of course the C<$sub_stmt> and
2649 its associated bind values can be generated through a former call
2652 my ($sub_stmt, @sub_bind)
2653 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2654 c3 => {-like => "foo%"}});
2657 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2660 In the examples above, the subquery was used as an operator on a column;
2661 but the same principle also applies for a clause within the main C<%where>
2662 hash, like an EXISTS subquery:
2664 my ($sub_stmt, @sub_bind)
2665 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2666 my %where = ( -and => [
2668 \["EXISTS ($sub_stmt)" => @sub_bind],
2673 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2674 WHERE c1 = ? AND c2 > t0.c0))";
2678 Observe that the condition on C<c2> in the subquery refers to
2679 column C<t0.c0> of the main query: this is I<not> a bind
2680 value, so we have to express it through a scalar ref.
2681 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2682 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2683 what we wanted here.
2685 Finally, here is an example where a subquery is used
2686 for expressing unary negation:
2688 my ($sub_stmt, @sub_bind)
2689 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2690 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2692 lname => {like => '%son%'},
2693 \["NOT ($sub_stmt)" => @sub_bind],
2698 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2699 @bind = ('%son%', 10, 20)
2701 =head3 Deprecated usage of Literal SQL
2703 Below are some examples of archaic use of literal SQL. It is shown only as
2704 reference for those who deal with legacy code. Each example has a much
2705 better, cleaner and safer alternative that users should opt for in new code.
2711 my %where = ( requestor => \'IS NOT NULL' )
2713 $stmt = "WHERE requestor IS NOT NULL"
2715 This used to be the way of generating NULL comparisons, before the handling
2716 of C<undef> got formalized. For new code please use the superior syntax as
2717 described in L</Tests for NULL values>.
2721 my %where = ( requestor => \'= submitter' )
2723 $stmt = "WHERE requestor = submitter"
2725 This used to be the only way to compare columns. Use the superior L</-ident>
2726 method for all new code. For example an identifier declared in such a way
2727 will be properly quoted if L</quote_char> is properly set, while the legacy
2728 form will remain as supplied.
2732 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2734 $stmt = "WHERE completed > ? AND is_ready"
2735 @bind = ('2012-12-21')
2737 Using an empty string literal used to be the only way to express a boolean.
2738 For all new code please use the much more readable
2739 L<-bool|/Unary operators: bool> operator.
2745 These pages could go on for a while, since the nesting of the data
2746 structures this module can handle are pretty much unlimited (the
2747 module implements the C<WHERE> expansion as a recursive function
2748 internally). Your best bet is to "play around" with the module a
2749 little to see how the data structures behave, and choose the best
2750 format for your data based on that.
2752 And of course, all the values above will probably be replaced with
2753 variables gotten from forms or the command line. After all, if you
2754 knew everything ahead of time, you wouldn't have to worry about
2755 dynamically-generating SQL and could just hardwire it into your
2758 =head1 ORDER BY CLAUSES
2760 Some functions take an order by clause. This can either be a scalar (just a
2761 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2762 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2765 Given | Will Generate
2766 ---------------------------------------------------------------
2768 'colA' | ORDER BY colA
2770 [qw/colA colB/] | ORDER BY colA, colB
2772 {-asc => 'colA'} | ORDER BY colA ASC
2774 {-desc => 'colB'} | ORDER BY colB DESC
2776 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2778 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2780 \'colA DESC' | ORDER BY colA DESC
2782 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2783 | /* ...with $x bound to ? */
2786 { -asc => 'colA' }, | colA ASC,
2787 { -desc => [qw/colB/] }, | colB DESC,
2788 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2789 \'colE DESC', | colE DESC,
2790 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2791 ] | /* ...with $x bound to ? */
2792 ===============================================================
2796 =head1 SPECIAL OPERATORS
2798 my $sqlmaker = SQL::Abstract->new(special_ops => [
2802 my ($self, $field, $op, $arg) = @_;
2808 handler => 'method_name',
2812 A "special operator" is a SQL syntactic clause that can be
2813 applied to a field, instead of a usual binary operator.
2816 WHERE field IN (?, ?, ?)
2817 WHERE field BETWEEN ? AND ?
2818 WHERE MATCH(field) AGAINST (?, ?)
2820 Special operators IN and BETWEEN are fairly standard and therefore
2821 are builtin within C<SQL::Abstract> (as the overridable methods
2822 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2823 like the MATCH .. AGAINST example above which is specific to MySQL,
2824 you can write your own operator handlers - supply a C<special_ops>
2825 argument to the C<new> method. That argument takes an arrayref of
2826 operator definitions; each operator definition is a hashref with two
2833 the regular expression to match the operator
2837 Either a coderef or a plain scalar method name. In both cases
2838 the expected return is C<< ($sql, @bind) >>.
2840 When supplied with a method name, it is simply called on the
2841 L<SQL::Abstract> object as:
2843 $self->$method_name($field, $op, $arg)
2847 $field is the LHS of the operator
2848 $op is the part that matched the handler regex
2851 When supplied with a coderef, it is called as:
2853 $coderef->($self, $field, $op, $arg)
2858 For example, here is an implementation
2859 of the MATCH .. AGAINST syntax for MySQL
2861 my $sqlmaker = SQL::Abstract->new(special_ops => [
2863 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2864 {regex => qr/^match$/i,
2866 my ($self, $field, $op, $arg) = @_;
2867 $arg = [$arg] if not ref $arg;
2868 my $label = $self->_quote($field);
2869 my ($placeholder) = $self->_convert('?');
2870 my $placeholders = join ", ", (($placeholder) x @$arg);
2871 my $sql = $self->_sqlcase('match') . " ($label) "
2872 . $self->_sqlcase('against') . " ($placeholders) ";
2873 my @bind = $self->_bindtype($field, @$arg);
2874 return ($sql, @bind);
2881 =head1 UNARY OPERATORS
2883 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2887 my ($self, $op, $arg) = @_;
2893 handler => 'method_name',
2897 A "unary operator" is a SQL syntactic clause that can be
2898 applied to a field - the operator goes before the field
2900 You can write your own operator handlers - supply a C<unary_ops>
2901 argument to the C<new> method. That argument takes an arrayref of
2902 operator definitions; each operator definition is a hashref with two
2909 the regular expression to match the operator
2913 Either a coderef or a plain scalar method name. In both cases
2914 the expected return is C<< $sql >>.
2916 When supplied with a method name, it is simply called on the
2917 L<SQL::Abstract> object as:
2919 $self->$method_name($op, $arg)
2923 $op is the part that matched the handler regex
2924 $arg is the RHS or argument of the operator
2926 When supplied with a coderef, it is called as:
2928 $coderef->($self, $op, $arg)
2936 Thanks to some benchmarking by Mark Stosberg, it turns out that
2937 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2938 I must admit this wasn't an intentional design issue, but it's a
2939 byproduct of the fact that you get to control your C<DBI> handles
2942 To maximize performance, use a code snippet like the following:
2944 # prepare a statement handle using the first row
2945 # and then reuse it for the rest of the rows
2947 for my $href (@array_of_hashrefs) {
2948 $stmt ||= $sql->insert('table', $href);
2949 $sth ||= $dbh->prepare($stmt);
2950 $sth->execute($sql->values($href));
2953 The reason this works is because the keys in your C<$href> are sorted
2954 internally by B<SQL::Abstract>. Thus, as long as your data retains
2955 the same structure, you only have to generate the SQL the first time
2956 around. On subsequent queries, simply use the C<values> function provided
2957 by this module to return your values in the correct order.
2959 However this depends on the values having the same type - if, for
2960 example, the values of a where clause may either have values
2961 (resulting in sql of the form C<column = ?> with a single bind
2962 value), or alternatively the values might be C<undef> (resulting in
2963 sql of the form C<column IS NULL> with no bind value) then the
2964 caching technique suggested will not work.
2968 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2969 really like this part (I do, at least). Building up a complex query
2970 can be as simple as the following:
2977 use CGI::FormBuilder;
2980 my $form = CGI::FormBuilder->new(...);
2981 my $sql = SQL::Abstract->new;
2983 if ($form->submitted) {
2984 my $field = $form->field;
2985 my $id = delete $field->{id};
2986 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2989 Of course, you would still have to connect using C<DBI> to run the
2990 query, but the point is that if you make your form look like your
2991 table, the actual query script can be extremely simplistic.
2993 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2994 a fast interface to returning and formatting data. I frequently
2995 use these three modules together to write complex database query
2996 apps in under 50 lines.
2998 =head1 HOW TO CONTRIBUTE
3000 Contributions are always welcome, in all usable forms (we especially
3001 welcome documentation improvements). The delivery methods include git-
3002 or unified-diff formatted patches, GitHub pull requests, or plain bug
3003 reports either via RT or the Mailing list. Contributors are generally
3004 granted full access to the official repository after their first several
3005 patches pass successful review.
3007 This project is maintained in a git repository. The code and related tools are
3008 accessible at the following locations:
3012 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3014 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3016 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3018 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3024 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3025 Great care has been taken to preserve the I<published> behavior
3026 documented in previous versions in the 1.* family; however,
3027 some features that were previously undocumented, or behaved
3028 differently from the documentation, had to be changed in order
3029 to clarify the semantics. Hence, client code that was relying
3030 on some dark areas of C<SQL::Abstract> v1.*
3031 B<might behave differently> in v1.50.
3033 The main changes are:
3039 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3043 support for the { operator => \"..." } construct (to embed literal SQL)
3047 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3051 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3055 defensive programming: check arguments
3059 fixed bug with global logic, which was previously implemented
3060 through global variables yielding side-effects. Prior versions would
3061 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3062 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3063 Now this is interpreted
3064 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3069 fixed semantics of _bindtype on array args
3073 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3074 we just avoid shifting arrays within that tree.
3078 dropped the C<_modlogic> function
3082 =head1 ACKNOWLEDGEMENTS
3084 There are a number of individuals that have really helped out with
3085 this module. Unfortunately, most of them submitted bugs via CPAN
3086 so I have no idea who they are! But the people I do know are:
3088 Ash Berlin (order_by hash term support)
3089 Matt Trout (DBIx::Class support)
3090 Mark Stosberg (benchmarking)
3091 Chas Owens (initial "IN" operator support)
3092 Philip Collins (per-field SQL functions)
3093 Eric Kolve (hashref "AND" support)
3094 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3095 Dan Kubb (support for "quote_char" and "name_sep")
3096 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3097 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3098 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3099 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3100 Oliver Charles (support for "RETURNING" after "INSERT")
3106 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3110 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3112 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3114 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3115 While not an official support venue, C<DBIx::Class> makes heavy use of
3116 C<SQL::Abstract>, and as such list members there are very familiar with
3117 how to create queries.
3121 This module is free software; you may copy this under the same
3122 terms as perl itself (either the GNU General Public License or
3123 the Artistic License)