1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.87';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # 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;
164 $opt{unary_ops} ||= [];
166 # rudimentary sanity-check for user supplied bits treated as functions/operators
167 # If a purported function matches this regular expression, an exception is thrown.
168 # Literal SQL is *NOT* subject to this check, only functions (and column names
169 # when quoting is not in effect)
172 # need to guard against ()'s in column names too, but this will break tons of
173 # hacks... ideas anyone?
174 $opt{injection_guard} ||= qr/
180 $opt{node_types} = +{
181 map +("-$_" => '_render_'.$_),
182 qw(op func value bind ident literal)
185 $opt{expand_unary} = {};
187 return bless \%opt, $class;
190 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
191 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
193 sub _assert_pass_injection_guard {
194 if ($_[1] =~ $_[0]->{injection_guard}) {
195 my $class = ref $_[0];
196 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
197 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
198 . "{injection_guard} attribute to ${class}->new()"
203 #======================================================================
205 #======================================================================
209 my $table = $self->_table(shift);
210 my $data = shift || return;
213 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
214 my ($sql, @bind) = $self->$method($data);
215 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
217 if ($options->{returning}) {
218 my ($s, @b) = $self->_insert_returning($options);
223 return wantarray ? ($sql, @bind) : $sql;
226 # So that subclasses can override INSERT ... RETURNING separately from
227 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
228 sub _insert_returning { shift->_returning(@_) }
231 my ($self, $options) = @_;
233 my $f = $options->{returning};
235 my ($sql, @bind) = $self->_render_expr(
236 $self->_expand_maybe_list_expr($f, undef, -ident)
239 ? $self->_sqlcase(' returning ') . $sql
240 : ($self->_sqlcase(' returning ').$sql, @bind);
243 sub _insert_HASHREF { # explicit list of fields and then values
244 my ($self, $data) = @_;
246 my @fields = sort keys %$data;
248 my ($sql, @bind) = $self->_insert_values($data);
251 $_ = $self->_quote($_) foreach @fields;
252 $sql = "( ".join(", ", @fields).") ".$sql;
254 return ($sql, @bind);
257 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
258 my ($self, $data) = @_;
260 # no names (arrayref) so can't generate bindtype
261 $self->{bindtype} ne 'columns'
262 or belch "can't do 'columns' bindtype when called with arrayref";
264 my (@values, @all_bind);
265 foreach my $value (@$data) {
266 my ($values, @bind) = $self->_insert_value(undef, $value);
267 push @values, $values;
268 push @all_bind, @bind;
270 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
271 return ($sql, @all_bind);
274 sub _insert_ARRAYREFREF { # literal SQL with bind
275 my ($self, $data) = @_;
277 my ($sql, @bind) = @${$data};
278 $self->_assert_bindval_matches_bindtype(@bind);
280 return ($sql, @bind);
284 sub _insert_SCALARREF { # literal SQL without bind
285 my ($self, $data) = @_;
291 my ($self, $data) = @_;
293 my (@values, @all_bind);
294 foreach my $column (sort keys %$data) {
295 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
296 push @values, $values;
297 push @all_bind, @bind;
299 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
300 return ($sql, @all_bind);
304 my ($self, $column, $v) = @_;
306 return $self->_render_expr(
307 $self->_expand_insert_value($column, $v)
311 sub _expand_insert_value {
312 my ($self, $column, $v) = @_;
314 if (ref($v) eq 'ARRAY') {
315 if ($self->{array_datatypes}) {
316 return +{ -bind => [ $column, $v ] };
318 my ($sql, @bind) = @$v;
319 $self->_assert_bindval_matches_bindtype(@bind);
320 return +{ -literal => $v };
322 if (ref($v) eq 'HASH') {
323 if (grep !/^-/, keys %$v) {
324 belch "HASH ref as bind value in insert is not supported";
325 return +{ -bind => [ $column, $v ] };
329 return +{ -bind => [ $column, undef ] };
331 local our $Cur_Col_Meta = $column;
332 return $self->_expand_expr($v);
337 #======================================================================
339 #======================================================================
344 my $table = $self->_table(shift);
345 my $data = shift || return;
349 # first build the 'SET' part of the sql statement
350 puke "Unsupported data type specified to \$sql->update"
351 unless ref $data eq 'HASH';
353 my ($sql, @all_bind) = $self->_update_set_values($data);
354 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
358 my($where_sql, @where_bind) = $self->where($where);
360 push @all_bind, @where_bind;
363 if ($options->{returning}) {
364 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
365 $sql .= $returning_sql;
366 push @all_bind, @returning_bind;
369 return wantarray ? ($sql, @all_bind) : $sql;
372 sub _update_set_values {
373 my ($self, $data) = @_;
375 return $self->_render_expr(
376 $self->_expand_update_set_values($data),
380 sub _expand_update_set_values {
381 my ($self, $data) = @_;
382 $self->_expand_maybe_list_expr( [
385 $set = { -bind => $_ } unless defined $set;
386 +{ -op => [ '=', { -ident => $k }, $set ] };
392 ? ($self->{array_datatypes}
393 ? [ $k, +{ -bind => [ $k, $v ] } ]
394 : [ $k, +{ -literal => $v } ])
396 local our $Cur_Col_Meta = $k;
397 [ $k, $self->_expand_expr($v) ]
404 # So that subclasses can override UPDATE ... RETURNING separately from
406 sub _update_returning { shift->_returning(@_) }
410 #======================================================================
412 #======================================================================
417 my $table = $self->_table(shift);
418 my $fields = shift || '*';
422 my ($fields_sql, @bind) = $self->_select_fields($fields);
424 my ($where_sql, @where_bind) = $self->where($where, $order);
425 push @bind, @where_bind;
427 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
428 $self->_sqlcase('from'), $table)
431 return wantarray ? ($sql, @bind) : $sql;
435 my ($self, $fields) = @_;
436 return $fields unless ref($fields);
437 return $self->_render_expr(
438 $self->_expand_maybe_list_expr($fields, undef, '-ident')
442 #======================================================================
444 #======================================================================
449 my $table = $self->_table(shift);
453 my($where_sql, @bind) = $self->where($where);
454 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
456 if ($options->{returning}) {
457 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
458 $sql .= $returning_sql;
459 push @bind, @returning_bind;
462 return wantarray ? ($sql, @bind) : $sql;
465 # So that subclasses can override DELETE ... RETURNING separately from
467 sub _delete_returning { shift->_returning(@_) }
471 #======================================================================
473 #======================================================================
477 # Finally, a separate routine just to handle WHERE clauses
479 my ($self, $where, $order) = @_;
481 local $self->{convert_where} = $self->{convert};
484 my ($sql, @bind) = defined($where)
485 ? $self->_recurse_where($where)
487 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
491 my ($order_sql, @order_bind) = $self->_order_by($order);
493 push @bind, @order_bind;
496 return wantarray ? ($sql, @bind) : $sql;
500 my ($self, $expr, $logic, $default_scalar_to) = @_;
501 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
502 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
503 return undef unless defined($expr);
504 if (ref($expr) eq 'HASH') {
505 if (keys %$expr > 1) {
509 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
513 return { -literal => [ '' ] } unless keys %$expr;
514 return $self->_expand_expr_hashpair(%$expr, $logic);
516 if (ref($expr) eq 'ARRAY') {
517 my $logic = lc($logic || $self->{logic});
518 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
522 (ref($_) eq 'ARRAY' and @$_)
523 or (ref($_) eq 'HASH' and %$_)
529 while (my ($el) = splice @expr, 0, 1) {
530 puke "Supplying an empty left hand side argument is not supported in array-pairs"
531 unless defined($el) and length($el);
532 my $elref = ref($el);
534 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
535 } elsif ($elref eq 'ARRAY') {
536 push(@res, $self->_expand_expr($el)) if @$el;
537 } elsif (my $l = is_literal_value($el)) {
538 push @res, { -literal => $l };
539 } elsif ($elref eq 'HASH') {
540 push @res, $self->_expand_expr($el);
545 return { -op => [ $logic, @res ] };
547 if (my $literal = is_literal_value($expr)) {
548 return +{ -literal => $literal };
550 if (!ref($expr) or Scalar::Util::blessed($expr)) {
551 if (my $d = $Default_Scalar_To) {
552 return +{ $d => $expr };
554 if (my $m = our $Cur_Col_Meta) {
555 return +{ -bind => [ $m, $expr ] };
557 return +{ -value => $expr };
564 sub _expand_expr_hashpair {
565 my ($self, $k, $v, $logic) = @_;
566 unless (defined($k) and length($k)) {
567 if (defined($k) and my $literal = is_literal_value($v)) {
568 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
569 return { -literal => $literal };
571 puke "Supplying an empty left hand side argument is not supported";
574 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
575 if ($k =~ s/ [_\s]? \d+ $//x ) {
576 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
577 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
580 # DBIx::Class requires a nest warning to be emitted once but the private
581 # method it overrode to do so no longer exists
582 if (ref($self) =~ /^DBIx::Class::SQLMaker/) {
583 unless ($Nest_Warned) {
585 "-nest in search conditions is deprecated, you most probably wanted:\n"
586 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
591 return $self->_expand_expr($v);
595 return $self->_expand_expr($v);
597 puke "-bool => undef not supported" unless defined($v);
598 return { -ident => $v };
601 return { -op => [ 'not', $self->_expand_expr($v) ] };
603 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
606 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
609 if (my ($logic) = $k =~ /^-(and|or)$/i) {
610 if (ref($v) eq 'HASH') {
611 return $self->_expand_expr($v, $logic);
613 if (ref($v) eq 'ARRAY') {
614 return $self->_expand_expr($v, $logic);
619 $op =~ s/^-// if length($op) > 1;
621 # top level special ops are illegal in general
622 # note that, arguably, if it makes no sense at top level, it also
623 # makes no sense on the other side of an = sign or similar but DBIC
624 # gets disappointingly upset if I disallow it
626 (our $Expand_Depth) == 1
627 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
629 puke "Illegal use of top-level '-$op'"
631 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
632 return { -op => [ $op, $v ] };
635 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
636 return +{ -bind => [ $m, $v ] };
638 if (my $custom = $self->{expand_unary}{$k}) {
639 return $self->$custom($v);
641 if ($self->{node_types}{$k}) {
647 and (keys %$v)[0] =~ /^-/
649 my ($func) = $k =~ /^-(.*)$/;
650 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
651 return +{ -op => [ $func, $self->_expand_expr($v) ] };
653 return +{ -func => [ $func, $self->_expand_expr($v) ] };
655 if (!ref($v) or is_literal_value($v)) {
656 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
663 and exists $v->{-value}
664 and not defined $v->{-value}
667 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
669 if (!ref($v) or Scalar::Util::blessed($v)) {
670 my $d = our $Default_Scalar_To;
675 ($d ? { $d => $v } : { -bind => [ $k, $v ] })
679 if (ref($v) eq 'HASH') {
683 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
690 $self->_assert_pass_injection_guard($vk);
691 if ($vk =~ s/ [_\s]? \d+ $//x ) {
692 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
693 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
695 if ($vk =~ /^(?:not[ _])?between$/) {
696 local our $Cur_Col_Meta = $k;
697 my @rhs = map $self->_expand_expr($_),
698 ref($vv) eq 'ARRAY' ? @$vv : $vv;
700 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
702 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
704 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
707 join(' ', split '_', $vk),
712 if ($vk =~ /^(?:not[ _])?in$/) {
713 if (my $literal = is_literal_value($vv)) {
714 my ($sql, @bind) = @$literal;
715 my $opened_sql = $self->_open_outer_paren($sql);
717 $vk, { -ident => $k },
718 [ { -literal => [ $opened_sql, @bind ] } ]
722 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
723 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
724 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
725 . 'will emit the logically correct SQL instead of raising this exception)'
727 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
729 my @rhs = map $self->_expand_expr($_),
730 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
731 map { defined($_) ? $_: puke($undef_err) }
732 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
733 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
736 join(' ', split '_', $vk),
741 if ($vk eq 'ident') {
742 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
743 puke "-$vk requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
751 if ($vk eq 'value') {
752 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
756 { -bind => [ $k, $vv ] }
759 if ($vk =~ /^is(?:[ _]not)?$/) {
760 puke "$vk can only take undef as argument"
764 and exists($vv->{-value})
765 and !defined($vv->{-value})
768 return +{ -op => [ $vk.' null', { -ident => $k } ] };
770 if ($vk =~ /^(and|or)$/) {
771 if (ref($vv) eq 'HASH') {
774 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
779 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{special_ops}}) {
780 return { -op => [ $vk, { -ident => $k }, $vv ] };
782 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{unary_ops}}) {
786 { -op => [ $vk, $vv ] }
789 if (ref($vv) eq 'ARRAY') {
790 my ($logic, @values) = (
791 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
796 $vk =~ $self->{inequality_op}
797 or join(' ', split '_', $vk) =~ $self->{not_like_op}
799 if (lc($logic) eq '-or' and @values > 1) {
800 my $op = uc join ' ', split '_', $vk;
801 belch "A multi-element arrayref as an argument to the inequality op '$op' "
802 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
803 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
808 # try to DWIM on equality operators
809 my $op = join ' ', split '_', $vk;
811 $op =~ $self->{equality_op} ? $self->sqlfalse
812 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
813 : $op =~ $self->{inequality_op} ? $self->sqltrue
814 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
815 : puke "operator '$op' applied on an empty array (field '$k')";
819 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
827 and exists $vv->{-value}
828 and not defined $vv->{-value}
831 my $op = join ' ', split '_', $vk;
833 $op =~ /^not$/i ? 'is not' # legacy
834 : $op =~ $self->{equality_op} ? 'is'
835 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
836 : $op =~ $self->{inequality_op} ? 'is not'
837 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
838 : puke "unexpected operator '$op' with undef operand";
839 return +{ -op => [ $is.' null', { -ident => $k } ] };
841 local our $Cur_Col_Meta = $k;
845 $self->_expand_expr($vv)
848 if (ref($v) eq 'ARRAY') {
849 return $self->sqlfalse unless @$v;
850 $self->_debug("ARRAY($k) means distribute over elements");
852 $v->[0] =~ /^-((?:and|or))$/i
853 ? ($v = [ @{$v}[1..$#$v] ], $1)
854 : ($self->{logic} || 'or')
858 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
861 if (my $literal = is_literal_value($v)) {
863 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
866 my ($sql, @bind) = @$literal;
867 if ($self->{bindtype} eq 'columns') {
869 $self->_assert_bindval_matches_bindtype($_);
872 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
878 my ($self, $expr) = @_;
879 my ($k, $v, @rest) = %$expr;
881 if (my $meth = $self->{node_types}{$k}) {
882 return $self->$meth($v);
884 die "notreached: $k";
888 my ($self, $where, $logic) = @_;
890 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
892 # Special case: top level simple string treated as literal
894 my $where_exp = (ref($where)
895 ? $self->_expand_expr($where, $logic)
896 : { -literal => [ $where ] });
897 #::Dwarn([ EXPANDED => $where_exp ]);
899 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
901 # dispatch on appropriate method according to refkind of $where
902 # my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
904 # my ($sql, @bind) = $self->$method($where_exp, $logic);
906 my ($sql, @bind) = defined($where_exp) ? $self->_render_expr($where_exp) : (undef);
907 # DBIx::Class used to call _recurse_where in scalar context
908 # something else might too...
910 return ($sql, @bind);
913 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
919 my ($self, $ident) = @_;
921 return $self->_convert($self->_quote($ident));
925 my ($self, $value) = @_;
927 return ($self->_convert('?'), $self->_bindtype(undef, $value));
930 my %unop_postfix = map +($_ => 1),
931 'is null', 'is not null',
939 my ($self, $args) = @_;
940 my ($left, $low, $high) = @$args;
941 my ($rhsql, @rhbind) = do {
943 puke "Single arg to between must be a literal"
944 unless $low->{-literal};
947 my ($l, $h) = map [ $self->_render_expr($_) ], $low, $high;
948 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
949 @{$l}[1..$#$l], @{$h}[1..$#$h])
952 my ($lhsql, @lhbind) = $self->_render_expr($left);
954 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
958 }), 'between', 'not between'),
962 my ($self, $args) = @_;
963 my ($lhs, $rhs) = @$args;
966 my ($sql, @bind) = $self->_render_expr($_);
967 push @in_bind, @bind;
970 my ($lhsql, @lbind) = $self->_render_expr($lhs);
972 $lhsql.' '.$self->_sqlcase($op).' ( '
983 my ($op, @args) = @$v;
984 $op =~ s/^-// if length($op) > 1;
986 if (my $h = $special{$op}) {
987 return $self->$h(\@args);
989 my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
990 if ($us and @args > 1) {
991 puke "Special op '${op}' requires first value to be identifier"
992 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
993 return $self->${\($us->{handler})}($k, $op, $args[1]);
995 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
996 return $self->${\($us->{handler})}($op, $args[0]);
998 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
999 if (@args == 1 and $op !~ /^(and|or)$/) {
1000 my ($expr_sql, @bind) = $self->_render_expr($args[0]);
1001 my $op_sql = $self->_sqlcase($final_op);
1003 $unop_postfix{lc($final_op)}
1004 ? "${expr_sql} ${op_sql}"
1005 : "${op_sql} ${expr_sql}"
1007 return (($op eq 'not' || $us ? '('.$final_sql.')' : $final_sql), @bind);
1008 #} elsif (@args == 0) {
1011 my @parts = grep length($_->[0]), map [ $self->_render_expr($_) ], @args;
1012 return '' unless @parts;
1013 my $is_andor = !!($op =~ /^(and|or)$/);
1014 return @{$parts[0]} if $is_andor and @parts == 1;
1015 my ($final_sql) = map +($is_andor ? "( ${_} )" : $_), join(
1016 ($final_op eq ',' ? '' : ' ').$self->_sqlcase($final_op).' ',
1021 map @{$_}[1..$#$_], @parts
1028 my ($self, $rest) = @_;
1029 my ($func, @args) = @$rest;
1033 push @arg_sql, shift @x;
1035 } map [ $self->_render_expr($_) ], @args;
1036 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1040 my ($self, $bind) = @_;
1041 return ($self->_convert('?'), $self->_bindtype(@$bind));
1044 sub _render_literal {
1045 my ($self, $literal) = @_;
1046 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1050 # Some databases (SQLite) treat col IN (1, 2) different from
1051 # col IN ( (1, 2) ). Use this to strip all outer parens while
1052 # adding them back in the corresponding method
1053 sub _open_outer_paren {
1054 my ($self, $sql) = @_;
1056 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1058 # there are closing parens inside, need the heavy duty machinery
1059 # to reevaluate the extraction starting from $sql (full reevaluation)
1060 if ($inner =~ /\)/) {
1061 require Text::Balanced;
1063 my (undef, $remainder) = do {
1064 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1066 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1069 # the entire expression needs to be a balanced bracketed thing
1070 # (after an extract no remainder sans trailing space)
1071 last if defined $remainder and $remainder =~ /\S/;
1081 #======================================================================
1083 #======================================================================
1085 sub _expand_order_by {
1086 my ($self, $arg) = @_;
1088 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1090 my $expander = sub {
1091 my ($self, $dir, $expr) = @_;
1092 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1093 foreach my $arg (@to_expand) {
1097 and grep /^-(asc|desc)$/, keys %$arg
1099 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1102 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1103 map $self->_expand_expr($_, undef, -ident),
1104 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1105 return (@exp > 1 ? { -op => [ ',', @exp ] } : $exp[0]);
1108 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1109 sub { shift->$expander(asc => @_) },
1110 sub { shift->$expander(desc => @_) },
1113 return $self->$expander(undef, $arg);
1117 my ($self, $arg) = @_;
1119 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1121 my ($sql, @bind) = $self->_render_expr($expanded);
1123 my $final_sql = $self->_sqlcase(' order by ').$sql;
1125 return wantarray ? ($final_sql, @bind) : $final_sql;
1128 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1130 sub _order_by_chunks {
1131 my ($self, $arg) = @_;
1133 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1135 return $self->_chunkify_order_by($expanded);
1138 sub _chunkify_order_by {
1139 my ($self, $expanded) = @_;
1141 if (ref() eq 'HASH' and my $op = $_->{-op}) {
1142 if ($op->[0] eq ',') {
1143 return map $self->_chunkify_order_by($_), @{$op}[1..$#$op];
1146 return [ $self->_render_expr($_) ];
1150 #======================================================================
1151 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1152 #======================================================================
1157 ($self->_render_expr(
1158 $self->_expand_maybe_list_expr($from, undef, -ident)
1163 #======================================================================
1165 #======================================================================
1167 sub _expand_maybe_list_expr {
1168 my ($self, $expr, $logic, $default) = @_;
1170 if (ref($expr) eq 'ARRAY') {
1172 ',', map $self->_expand_expr($_, $logic, $default), @$expr
1179 return $self->_expand_expr($e, $logic, $default);
1182 # highly optimized, as it's called way too often
1184 # my ($self, $label) = @_;
1186 return '' unless defined $_[1];
1187 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1188 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1190 unless ($_[0]->{quote_char}) {
1191 if (ref($_[1]) eq 'ARRAY') {
1192 return join($_[0]->{name_sep}||'.', @{$_[1]});
1194 $_[0]->_assert_pass_injection_guard($_[1]);
1199 my $qref = ref $_[0]->{quote_char};
1201 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1202 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1203 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1205 my $esc = $_[0]->{escape_char} || $r;
1207 # parts containing * are naturally unquoted
1209 $_[0]->{name_sep}||'',
1213 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1215 (ref($_[1]) eq 'ARRAY'
1219 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1227 # Conversion, if applicable
1229 #my ($self, $arg) = @_;
1230 if ($_[0]->{convert_where}) {
1231 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1238 #my ($self, $col, @vals) = @_;
1239 # called often - tighten code
1240 return $_[0]->{bindtype} eq 'columns'
1241 ? map {[$_[1], $_]} @_[2 .. $#_]
1246 # Dies if any element of @bind is not in [colname => value] format
1247 # if bindtype is 'columns'.
1248 sub _assert_bindval_matches_bindtype {
1249 # my ($self, @bind) = @_;
1251 if ($self->{bindtype} eq 'columns') {
1253 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1254 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1260 sub _join_sql_clauses {
1261 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1263 if (@$clauses_aref > 1) {
1264 my $join = " " . $self->_sqlcase($logic) . " ";
1265 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1266 return ($sql, @$bind_aref);
1268 elsif (@$clauses_aref) {
1269 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1272 return (); # if no SQL, ignore @$bind_aref
1277 # Fix SQL case, if so requested
1279 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1280 # don't touch the argument ... crooked logic, but let's not change it!
1281 return $_[0]->{case} ? $_[1] : uc($_[1]);
1285 #======================================================================
1286 # DISPATCHING FROM REFKIND
1287 #======================================================================
1290 my ($self, $data) = @_;
1292 return 'UNDEF' unless defined $data;
1294 # blessed objects are treated like scalars
1295 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1297 return 'SCALAR' unless $ref;
1300 while ($ref eq 'REF') {
1302 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1306 return ($ref||'SCALAR') . ('REF' x $n_steps);
1310 my ($self, $data) = @_;
1311 my @try = ($self->_refkind($data));
1312 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1313 push @try, 'FALLBACK';
1317 sub _METHOD_FOR_refkind {
1318 my ($self, $meth_prefix, $data) = @_;
1321 for (@{$self->_try_refkind($data)}) {
1322 $method = $self->can($meth_prefix."_".$_)
1326 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1330 sub _SWITCH_refkind {
1331 my ($self, $data, $dispatch_table) = @_;
1334 for (@{$self->_try_refkind($data)}) {
1335 $coderef = $dispatch_table->{$_}
1339 puke "no dispatch entry for ".$self->_refkind($data)
1348 #======================================================================
1349 # VALUES, GENERATE, AUTOLOAD
1350 #======================================================================
1352 # LDNOTE: original code from nwiger, didn't touch code in that section
1353 # I feel the AUTOLOAD stuff should not be the default, it should
1354 # only be activated on explicit demand by user.
1358 my $data = shift || return;
1359 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1360 unless ref $data eq 'HASH';
1363 foreach my $k (sort keys %$data) {
1364 my $v = $data->{$k};
1365 $self->_SWITCH_refkind($v, {
1367 if ($self->{array_datatypes}) { # array datatype
1368 push @all_bind, $self->_bindtype($k, $v);
1370 else { # literal SQL with bind
1371 my ($sql, @bind) = @$v;
1372 $self->_assert_bindval_matches_bindtype(@bind);
1373 push @all_bind, @bind;
1376 ARRAYREFREF => sub { # literal SQL with bind
1377 my ($sql, @bind) = @${$v};
1378 $self->_assert_bindval_matches_bindtype(@bind);
1379 push @all_bind, @bind;
1381 SCALARREF => sub { # literal SQL without bind
1383 SCALAR_or_UNDEF => sub {
1384 push @all_bind, $self->_bindtype($k, $v);
1395 my(@sql, @sqlq, @sqlv);
1399 if ($ref eq 'HASH') {
1400 for my $k (sort keys %$_) {
1403 my $label = $self->_quote($k);
1404 if ($r eq 'ARRAY') {
1405 # literal SQL with bind
1406 my ($sql, @bind) = @$v;
1407 $self->_assert_bindval_matches_bindtype(@bind);
1408 push @sqlq, "$label = $sql";
1410 } elsif ($r eq 'SCALAR') {
1411 # literal SQL without bind
1412 push @sqlq, "$label = $$v";
1414 push @sqlq, "$label = ?";
1415 push @sqlv, $self->_bindtype($k, $v);
1418 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1419 } elsif ($ref eq 'ARRAY') {
1420 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1423 if ($r eq 'ARRAY') { # literal SQL with bind
1424 my ($sql, @bind) = @$v;
1425 $self->_assert_bindval_matches_bindtype(@bind);
1428 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1429 # embedded literal SQL
1436 push @sql, '(' . join(', ', @sqlq) . ')';
1437 } elsif ($ref eq 'SCALAR') {
1441 # strings get case twiddled
1442 push @sql, $self->_sqlcase($_);
1446 my $sql = join ' ', @sql;
1448 # this is pretty tricky
1449 # if ask for an array, return ($stmt, @bind)
1450 # otherwise, s/?/shift @sqlv/ to put it inline
1452 return ($sql, @sqlv);
1454 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1455 ref $d ? $d->[1] : $d/e;
1464 # This allows us to check for a local, then _form, attr
1466 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1467 return $self->generate($name, @_);
1478 SQL::Abstract - Generate SQL from Perl data structures
1484 my $sql = SQL::Abstract->new;
1486 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1488 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1490 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1492 my($stmt, @bind) = $sql->delete($table, \%where);
1494 # Then, use these in your DBI statements
1495 my $sth = $dbh->prepare($stmt);
1496 $sth->execute(@bind);
1498 # Just generate the WHERE clause
1499 my($stmt, @bind) = $sql->where(\%where, $order);
1501 # Return values in the same order, for hashed queries
1502 # See PERFORMANCE section for more details
1503 my @bind = $sql->values(\%fieldvals);
1507 This module was inspired by the excellent L<DBIx::Abstract>.
1508 However, in using that module I found that what I really wanted
1509 to do was generate SQL, but still retain complete control over my
1510 statement handles and use the DBI interface. So, I set out to
1511 create an abstract SQL generation module.
1513 While based on the concepts used by L<DBIx::Abstract>, there are
1514 several important differences, especially when it comes to WHERE
1515 clauses. I have modified the concepts used to make the SQL easier
1516 to generate from Perl data structures and, IMO, more intuitive.
1517 The underlying idea is for this module to do what you mean, based
1518 on the data structures you provide it. The big advantage is that
1519 you don't have to modify your code every time your data changes,
1520 as this module figures it out.
1522 To begin with, an SQL INSERT is as easy as just specifying a hash
1523 of C<key=value> pairs:
1526 name => 'Jimbo Bobson',
1527 phone => '123-456-7890',
1528 address => '42 Sister Lane',
1529 city => 'St. Louis',
1530 state => 'Louisiana',
1533 The SQL can then be generated with this:
1535 my($stmt, @bind) = $sql->insert('people', \%data);
1537 Which would give you something like this:
1539 $stmt = "INSERT INTO people
1540 (address, city, name, phone, state)
1541 VALUES (?, ?, ?, ?, ?)";
1542 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1543 '123-456-7890', 'Louisiana');
1545 These are then used directly in your DBI code:
1547 my $sth = $dbh->prepare($stmt);
1548 $sth->execute(@bind);
1550 =head2 Inserting and Updating Arrays
1552 If your database has array types (like for example Postgres),
1553 activate the special option C<< array_datatypes => 1 >>
1554 when creating the C<SQL::Abstract> object.
1555 Then you may use an arrayref to insert and update database array types:
1557 my $sql = SQL::Abstract->new(array_datatypes => 1);
1559 planets => [qw/Mercury Venus Earth Mars/]
1562 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1566 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1568 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1571 =head2 Inserting and Updating SQL
1573 In order to apply SQL functions to elements of your C<%data> you may
1574 specify a reference to an arrayref for the given hash value. For example,
1575 if you need to execute the Oracle C<to_date> function on a value, you can
1576 say something like this:
1580 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1583 The first value in the array is the actual SQL. Any other values are
1584 optional and would be included in the bind values array. This gives
1587 my($stmt, @bind) = $sql->insert('people', \%data);
1589 $stmt = "INSERT INTO people (name, date_entered)
1590 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1591 @bind = ('Bill', '03/02/2003');
1593 An UPDATE is just as easy, all you change is the name of the function:
1595 my($stmt, @bind) = $sql->update('people', \%data);
1597 Notice that your C<%data> isn't touched; the module will generate
1598 the appropriately quirky SQL for you automatically. Usually you'll
1599 want to specify a WHERE clause for your UPDATE, though, which is
1600 where handling C<%where> hashes comes in handy...
1602 =head2 Complex where statements
1604 This module can generate pretty complicated WHERE statements
1605 easily. For example, simple C<key=value> pairs are taken to mean
1606 equality, and if you want to see if a field is within a set
1607 of values, you can use an arrayref. Let's say we wanted to
1608 SELECT some data based on this criteria:
1611 requestor => 'inna',
1612 worker => ['nwiger', 'rcwe', 'sfz'],
1613 status => { '!=', 'completed' }
1616 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1618 The above would give you something like this:
1620 $stmt = "SELECT * FROM tickets WHERE
1621 ( requestor = ? ) AND ( status != ? )
1622 AND ( worker = ? OR worker = ? OR worker = ? )";
1623 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1625 Which you could then use in DBI code like so:
1627 my $sth = $dbh->prepare($stmt);
1628 $sth->execute(@bind);
1634 The methods are simple. There's one for every major SQL operation,
1635 and a constructor you use first. The arguments are specified in a
1636 similar order for each method (table, then fields, then a where
1637 clause) to try and simplify things.
1639 =head2 new(option => 'value')
1641 The C<new()> function takes a list of options and values, and returns
1642 a new B<SQL::Abstract> object which can then be used to generate SQL
1643 through the methods below. The options accepted are:
1649 If set to 'lower', then SQL will be generated in all lowercase. By
1650 default SQL is generated in "textbook" case meaning something like:
1652 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1654 Any setting other than 'lower' is ignored.
1658 This determines what the default comparison operator is. By default
1659 it is C<=>, meaning that a hash like this:
1661 %where = (name => 'nwiger', email => 'nate@wiger.org');
1663 Will generate SQL like this:
1665 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1667 However, you may want loose comparisons by default, so if you set
1668 C<cmp> to C<like> you would get SQL such as:
1670 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1672 You can also override the comparison on an individual basis - see
1673 the huge section on L</"WHERE CLAUSES"> at the bottom.
1675 =item sqltrue, sqlfalse
1677 Expressions for inserting boolean values within SQL statements.
1678 By default these are C<1=1> and C<1=0>. They are used
1679 by the special operators C<-in> and C<-not_in> for generating
1680 correct SQL even when the argument is an empty array (see below).
1684 This determines the default logical operator for multiple WHERE
1685 statements in arrays or hashes. If absent, the default logic is "or"
1686 for arrays, and "and" for hashes. This means that a WHERE
1690 event_date => {'>=', '2/13/99'},
1691 event_date => {'<=', '4/24/03'},
1694 will generate SQL like this:
1696 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1698 This is probably not what you want given this query, though (look
1699 at the dates). To change the "OR" to an "AND", simply specify:
1701 my $sql = SQL::Abstract->new(logic => 'and');
1703 Which will change the above C<WHERE> to:
1705 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1707 The logic can also be changed locally by inserting
1708 a modifier in front of an arrayref:
1710 @where = (-and => [event_date => {'>=', '2/13/99'},
1711 event_date => {'<=', '4/24/03'} ]);
1713 See the L</"WHERE CLAUSES"> section for explanations.
1717 This will automatically convert comparisons using the specified SQL
1718 function for both column and value. This is mostly used with an argument
1719 of C<upper> or C<lower>, so that the SQL will have the effect of
1720 case-insensitive "searches". For example, this:
1722 $sql = SQL::Abstract->new(convert => 'upper');
1723 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1725 Will turn out the following SQL:
1727 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1729 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1730 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1731 not validate this option; it will just pass through what you specify verbatim).
1735 This is a kludge because many databases suck. For example, you can't
1736 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1737 Instead, you have to use C<bind_param()>:
1739 $sth->bind_param(1, 'reg data');
1740 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1742 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1743 which loses track of which field each slot refers to. Fear not.
1745 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1746 Currently, you can specify either C<normal> (default) or C<columns>. If you
1747 specify C<columns>, you will get an array that looks like this:
1749 my $sql = SQL::Abstract->new(bindtype => 'columns');
1750 my($stmt, @bind) = $sql->insert(...);
1753 [ 'column1', 'value1' ],
1754 [ 'column2', 'value2' ],
1755 [ 'column3', 'value3' ],
1758 You can then iterate through this manually, using DBI's C<bind_param()>.
1760 $sth->prepare($stmt);
1763 my($col, $data) = @$_;
1764 if ($col eq 'details' || $col eq 'comments') {
1765 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1766 } elsif ($col eq 'image') {
1767 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1769 $sth->bind_param($i, $data);
1773 $sth->execute; # execute without @bind now
1775 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1776 Basically, the advantage is still that you don't have to care which fields
1777 are or are not included. You could wrap that above C<for> loop in a simple
1778 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1779 get a layer of abstraction over manual SQL specification.
1781 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1782 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1783 will expect the bind values in this format.
1787 This is the character that a table or column name will be quoted
1788 with. By default this is an empty string, but you could set it to
1789 the character C<`>, to generate SQL like this:
1791 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1793 Alternatively, you can supply an array ref of two items, the first being the left
1794 hand quote character, and the second the right hand quote character. For
1795 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1796 that generates SQL like this:
1798 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1800 Quoting is useful if you have tables or columns names that are reserved
1801 words in your database's SQL dialect.
1805 This is the character that will be used to escape L</quote_char>s appearing
1806 in an identifier before it has been quoted.
1808 The parameter default in case of a single L</quote_char> character is the quote
1811 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1812 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1813 of the B<opening (left)> L</quote_char> within the identifier are currently left
1814 untouched. The default for opening-closing-style quotes may change in future
1815 versions, thus you are B<strongly encouraged> to specify the escape character
1820 This is the character that separates a table and column name. It is
1821 necessary to specify this when the C<quote_char> option is selected,
1822 so that tables and column names can be individually quoted like this:
1824 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1826 =item injection_guard
1828 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1829 column name specified in a query structure. This is a safety mechanism to avoid
1830 injection attacks when mishandling user input e.g.:
1832 my %condition_as_column_value_pairs = get_values_from_user();
1833 $sqla->select( ... , \%condition_as_column_value_pairs );
1835 If the expression matches an exception is thrown. Note that literal SQL
1836 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1838 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1840 =item array_datatypes
1842 When this option is true, arrayrefs in INSERT or UPDATE are
1843 interpreted as array datatypes and are passed directly
1845 When this option is false, arrayrefs are interpreted
1846 as literal SQL, just like refs to arrayrefs
1847 (but this behavior is for backwards compatibility; when writing
1848 new queries, use the "reference to arrayref" syntax
1854 Takes a reference to a list of "special operators"
1855 to extend the syntax understood by L<SQL::Abstract>.
1856 See section L</"SPECIAL OPERATORS"> for details.
1860 Takes a reference to a list of "unary operators"
1861 to extend the syntax understood by L<SQL::Abstract>.
1862 See section L</"UNARY OPERATORS"> for details.
1868 =head2 insert($table, \@values || \%fieldvals, \%options)
1870 This is the simplest function. You simply give it a table name
1871 and either an arrayref of values or hashref of field/value pairs.
1872 It returns an SQL INSERT statement and a list of bind values.
1873 See the sections on L</"Inserting and Updating Arrays"> and
1874 L</"Inserting and Updating SQL"> for information on how to insert
1875 with those data types.
1877 The optional C<\%options> hash reference may contain additional
1878 options to generate the insert SQL. Currently supported options
1885 Takes either a scalar of raw SQL fields, or an array reference of
1886 field names, and adds on an SQL C<RETURNING> statement at the end.
1887 This allows you to return data generated by the insert statement
1888 (such as row IDs) without performing another C<SELECT> statement.
1889 Note, however, this is not part of the SQL standard and may not
1890 be supported by all database engines.
1894 =head2 update($table, \%fieldvals, \%where, \%options)
1896 This takes a table, hashref of field/value pairs, and an optional
1897 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1899 See the sections on L</"Inserting and Updating Arrays"> and
1900 L</"Inserting and Updating SQL"> for information on how to insert
1901 with those data types.
1903 The optional C<\%options> hash reference may contain additional
1904 options to generate the update SQL. Currently supported options
1911 See the C<returning> option to
1912 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1916 =head2 select($source, $fields, $where, $order)
1918 This returns a SQL SELECT statement and associated list of bind values, as
1919 specified by the arguments:
1925 Specification of the 'FROM' part of the statement.
1926 The argument can be either a plain scalar (interpreted as a table
1927 name, will be quoted), or an arrayref (interpreted as a list
1928 of table names, joined by commas, quoted), or a scalarref
1929 (literal SQL, not quoted).
1933 Specification of the list of fields to retrieve from
1935 The argument can be either an arrayref (interpreted as a list
1936 of field names, will be joined by commas and quoted), or a
1937 plain scalar (literal SQL, not quoted).
1938 Please observe that this API is not as flexible as that of
1939 the first argument C<$source>, for backwards compatibility reasons.
1943 Optional argument to specify the WHERE part of the query.
1944 The argument is most often a hashref, but can also be
1945 an arrayref or plain scalar --
1946 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1950 Optional argument to specify the ORDER BY part of the query.
1951 The argument can be a scalar, a hashref or an arrayref
1952 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1958 =head2 delete($table, \%where, \%options)
1960 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1961 It returns an SQL DELETE statement and list of bind values.
1963 The optional C<\%options> hash reference may contain additional
1964 options to generate the delete SQL. Currently supported options
1971 See the C<returning> option to
1972 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1976 =head2 where(\%where, $order)
1978 This is used to generate just the WHERE clause. For example,
1979 if you have an arbitrary data structure and know what the
1980 rest of your SQL is going to look like, but want an easy way
1981 to produce a WHERE clause, use this. It returns an SQL WHERE
1982 clause and list of bind values.
1985 =head2 values(\%data)
1987 This just returns the values from the hash C<%data>, in the same
1988 order that would be returned from any of the other above queries.
1989 Using this allows you to markedly speed up your queries if you
1990 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1992 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1994 Warning: This is an experimental method and subject to change.
1996 This returns arbitrarily generated SQL. It's a really basic shortcut.
1997 It will return two different things, depending on return context:
1999 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2000 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2002 These would return the following:
2004 # First calling form
2005 $stmt = "CREATE TABLE test (?, ?)";
2006 @bind = (field1, field2);
2008 # Second calling form
2009 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2011 Depending on what you're trying to do, it's up to you to choose the correct
2012 format. In this example, the second form is what you would want.
2016 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2020 ALTER SESSION SET nls_date_format = 'MM/YY'
2022 You get the idea. Strings get their case twiddled, but everything
2023 else remains verbatim.
2025 =head1 EXPORTABLE FUNCTIONS
2027 =head2 is_plain_value
2029 Determines if the supplied argument is a plain value as understood by this
2034 =item * The value is C<undef>
2036 =item * The value is a non-reference
2038 =item * The value is an object with stringification overloading
2040 =item * The value is of the form C<< { -value => $anything } >>
2044 On failure returns C<undef>, on success returns a B<scalar> reference
2045 to the original supplied argument.
2051 The stringification overloading detection is rather advanced: it takes
2052 into consideration not only the presence of a C<""> overload, but if that
2053 fails also checks for enabled
2054 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2055 on either C<0+> or C<bool>.
2057 Unfortunately testing in the field indicates that this
2058 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2059 but only when very large numbers of stringifying objects are involved.
2060 At the time of writing ( Sep 2014 ) there is no clear explanation of
2061 the direct cause, nor is there a manageably small test case that reliably
2062 reproduces the problem.
2064 If you encounter any of the following exceptions in B<random places within
2065 your application stack> - this module may be to blame:
2067 Operation "ne": no method found,
2068 left argument in overloaded package <something>,
2069 right argument in overloaded package <something>
2073 Stub found while resolving method "???" overloading """" in package <something>
2075 If you fall victim to the above - please attempt to reduce the problem
2076 to something that could be sent to the L<SQL::Abstract developers
2077 |DBIx::Class/GETTING HELP/SUPPORT>
2078 (either publicly or privately). As a workaround in the meantime you can
2079 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2080 value, which will most likely eliminate your problem (at the expense of
2081 not being able to properly detect exotic forms of stringification).
2083 This notice and environment variable will be removed in a future version,
2084 as soon as the underlying problem is found and a reliable workaround is
2089 =head2 is_literal_value
2091 Determines if the supplied argument is a literal value as understood by this
2096 =item * C<\$sql_string>
2098 =item * C<\[ $sql_string, @bind_values ]>
2102 On failure returns C<undef>, on success returns an B<array> reference
2103 containing the unpacked version of the supplied literal SQL and bind values.
2105 =head1 WHERE CLAUSES
2109 This module uses a variation on the idea from L<DBIx::Abstract>. It
2110 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2111 module is that things in arrays are OR'ed, and things in hashes
2114 The easiest way to explain is to show lots of examples. After
2115 each C<%where> hash shown, it is assumed you used:
2117 my($stmt, @bind) = $sql->where(\%where);
2119 However, note that the C<%where> hash can be used directly in any
2120 of the other functions as well, as described above.
2122 =head2 Key-value pairs
2124 So, let's get started. To begin, a simple hash:
2128 status => 'completed'
2131 Is converted to SQL C<key = val> statements:
2133 $stmt = "WHERE user = ? AND status = ?";
2134 @bind = ('nwiger', 'completed');
2136 One common thing I end up doing is having a list of values that
2137 a field can be in. To do this, simply specify a list inside of
2142 status => ['assigned', 'in-progress', 'pending'];
2145 This simple code will create the following:
2147 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2148 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2150 A field associated to an empty arrayref will be considered a
2151 logical false and will generate 0=1.
2153 =head2 Tests for NULL values
2155 If the value part is C<undef> then this is converted to SQL <IS NULL>
2164 $stmt = "WHERE user = ? AND status IS NULL";
2167 To test if a column IS NOT NULL:
2171 status => { '!=', undef },
2174 =head2 Specific comparison operators
2176 If you want to specify a different type of operator for your comparison,
2177 you can use a hashref for a given column:
2181 status => { '!=', 'completed' }
2184 Which would generate:
2186 $stmt = "WHERE user = ? AND status != ?";
2187 @bind = ('nwiger', 'completed');
2189 To test against multiple values, just enclose the values in an arrayref:
2191 status => { '=', ['assigned', 'in-progress', 'pending'] };
2193 Which would give you:
2195 "WHERE status = ? OR status = ? OR status = ?"
2198 The hashref can also contain multiple pairs, in which case it is expanded
2199 into an C<AND> of its elements:
2203 status => { '!=', 'completed', -not_like => 'pending%' }
2206 # Or more dynamically, like from a form
2207 $where{user} = 'nwiger';
2208 $where{status}{'!='} = 'completed';
2209 $where{status}{'-not_like'} = 'pending%';
2211 # Both generate this
2212 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2213 @bind = ('nwiger', 'completed', 'pending%');
2216 To get an OR instead, you can combine it with the arrayref idea:
2220 priority => [ { '=', 2 }, { '>', 5 } ]
2223 Which would generate:
2225 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2226 @bind = ('2', '5', 'nwiger');
2228 If you want to include literal SQL (with or without bind values), just use a
2229 scalar reference or reference to an arrayref as the value:
2232 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2233 date_expires => { '<' => \"now()" }
2236 Which would generate:
2238 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2239 @bind = ('11/26/2008');
2242 =head2 Logic and nesting operators
2244 In the example above,
2245 there is a subtle trap if you want to say something like
2246 this (notice the C<AND>):
2248 WHERE priority != ? AND priority != ?
2250 Because, in Perl you I<can't> do this:
2252 priority => { '!=' => 2, '!=' => 1 }
2254 As the second C<!=> key will obliterate the first. The solution
2255 is to use the special C<-modifier> form inside an arrayref:
2257 priority => [ -and => {'!=', 2},
2261 Normally, these would be joined by C<OR>, but the modifier tells it
2262 to use C<AND> instead. (Hint: You can use this in conjunction with the
2263 C<logic> option to C<new()> in order to change the way your queries
2264 work by default.) B<Important:> Note that the C<-modifier> goes
2265 B<INSIDE> the arrayref, as an extra first element. This will
2266 B<NOT> do what you think it might:
2268 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2270 Here is a quick list of equivalencies, since there is some overlap:
2273 status => {'!=', 'completed', 'not like', 'pending%' }
2274 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2277 status => {'=', ['assigned', 'in-progress']}
2278 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2279 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2283 =head2 Special operators: IN, BETWEEN, etc.
2285 You can also use the hashref format to compare a list of fields using the
2286 C<IN> comparison operator, by specifying the list as an arrayref:
2289 status => 'completed',
2290 reportid => { -in => [567, 2335, 2] }
2293 Which would generate:
2295 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2296 @bind = ('completed', '567', '2335', '2');
2298 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2301 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2302 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2303 'sqltrue' (by default: C<1=1>).
2305 In addition to the array you can supply a chunk of literal sql or
2306 literal sql with bind:
2309 customer => { -in => \[
2310 'SELECT cust_id FROM cust WHERE balance > ?',
2313 status => { -in => \'SELECT status_codes FROM states' },
2319 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2320 AND status IN ( SELECT status_codes FROM states )
2324 Finally, if the argument to C<-in> is not a reference, it will be
2325 treated as a single-element array.
2327 Another pair of operators is C<-between> and C<-not_between>,
2328 used with an arrayref of two values:
2332 completion_date => {
2333 -not_between => ['2002-10-01', '2003-02-06']
2339 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2341 Just like with C<-in> all plausible combinations of literal SQL
2345 start0 => { -between => [ 1, 2 ] },
2346 start1 => { -between => \["? AND ?", 1, 2] },
2347 start2 => { -between => \"lower(x) AND upper(y)" },
2348 start3 => { -between => [
2350 \["upper(?)", 'stuff' ],
2357 ( start0 BETWEEN ? AND ? )
2358 AND ( start1 BETWEEN ? AND ? )
2359 AND ( start2 BETWEEN lower(x) AND upper(y) )
2360 AND ( start3 BETWEEN lower(x) AND upper(?) )
2362 @bind = (1, 2, 1, 2, 'stuff');
2365 These are the two builtin "special operators"; but the
2366 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2368 =head2 Unary operators: bool
2370 If you wish to test against boolean columns or functions within your
2371 database you can use the C<-bool> and C<-not_bool> operators. For
2372 example to test the column C<is_user> being true and the column
2373 C<is_enabled> being false you would use:-
2377 -not_bool => 'is_enabled',
2382 WHERE is_user AND NOT is_enabled
2384 If a more complex combination is required, testing more conditions,
2385 then you should use the and/or operators:-
2390 -not_bool => { two=> { -rlike => 'bar' } },
2391 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2402 (NOT ( three = ? OR three > ? ))
2405 =head2 Nested conditions, -and/-or prefixes
2407 So far, we've seen how multiple conditions are joined with a top-level
2408 C<AND>. We can change this by putting the different conditions we want in
2409 hashes and then putting those hashes in an array. For example:
2414 status => { -like => ['pending%', 'dispatched'] },
2418 status => 'unassigned',
2422 This data structure would create the following:
2424 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2425 OR ( user = ? AND status = ? ) )";
2426 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2429 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2430 to change the logic inside:
2436 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2437 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2444 $stmt = "WHERE ( user = ?
2445 AND ( ( workhrs > ? AND geo = ? )
2446 OR ( workhrs < ? OR geo = ? ) ) )";
2447 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2449 =head3 Algebraic inconsistency, for historical reasons
2451 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2452 operator goes C<outside> of the nested structure; whereas when connecting
2453 several constraints on one column, the C<-and> operator goes
2454 C<inside> the arrayref. Here is an example combining both features:
2457 -and => [a => 1, b => 2],
2458 -or => [c => 3, d => 4],
2459 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2464 WHERE ( ( ( a = ? AND b = ? )
2465 OR ( c = ? OR d = ? )
2466 OR ( e LIKE ? AND e LIKE ? ) ) )
2468 This difference in syntax is unfortunate but must be preserved for
2469 historical reasons. So be careful: the two examples below would
2470 seem algebraically equivalent, but they are not
2473 { -like => 'foo%' },
2474 { -like => '%bar' },
2476 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2479 { col => { -like => 'foo%' } },
2480 { col => { -like => '%bar' } },
2482 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2485 =head2 Literal SQL and value type operators
2487 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2488 side" is a column name and the "right side" is a value (normally rendered as
2489 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2490 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2491 alter this behavior. There are several ways of doing so.
2495 This is a virtual operator that signals the string to its right side is an
2496 identifier (a column name) and not a value. For example to compare two
2497 columns you would write:
2500 priority => { '<', 2 },
2501 requestor => { -ident => 'submitter' },
2506 $stmt = "WHERE priority < ? AND requestor = submitter";
2509 If you are maintaining legacy code you may see a different construct as
2510 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2515 This is a virtual operator that signals that the construct to its right side
2516 is a value to be passed to DBI. This is for example necessary when you want
2517 to write a where clause against an array (for RDBMS that support such
2518 datatypes). For example:
2521 array => { -value => [1, 2, 3] }
2526 $stmt = 'WHERE array = ?';
2527 @bind = ([1, 2, 3]);
2529 Note that if you were to simply say:
2535 the result would probably not be what you wanted:
2537 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2542 Finally, sometimes only literal SQL will do. To include a random snippet
2543 of SQL verbatim, you specify it as a scalar reference. Consider this only
2544 as a last resort. Usually there is a better way. For example:
2547 priority => { '<', 2 },
2548 requestor => { -in => \'(SELECT name FROM hitmen)' },
2553 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2556 Note that in this example, you only get one bind parameter back, since
2557 the verbatim SQL is passed as part of the statement.
2561 Never use untrusted input as a literal SQL argument - this is a massive
2562 security risk (there is no way to check literal snippets for SQL
2563 injections and other nastyness). If you need to deal with untrusted input
2564 use literal SQL with placeholders as described next.
2566 =head3 Literal SQL with placeholders and bind values (subqueries)
2568 If the literal SQL to be inserted has placeholders and bind values,
2569 use a reference to an arrayref (yes this is a double reference --
2570 not so common, but perfectly legal Perl). For example, to find a date
2571 in Postgres you can use something like this:
2574 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2579 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2582 Note that you must pass the bind values in the same format as they are returned
2583 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2584 to C<columns>, you must provide the bind values in the
2585 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2586 scalar value; most commonly the column name, but you can use any scalar value
2587 (including references and blessed references), L<SQL::Abstract> will simply
2588 pass it through intact. So if C<bindtype> is set to C<columns> the above
2589 example will look like:
2592 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2595 Literal SQL is especially useful for nesting parenthesized clauses in the
2596 main SQL query. Here is a first example:
2598 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2602 bar => \["IN ($sub_stmt)" => @sub_bind],
2607 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2608 WHERE c2 < ? AND c3 LIKE ?))";
2609 @bind = (1234, 100, "foo%");
2611 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2612 are expressed in the same way. Of course the C<$sub_stmt> and
2613 its associated bind values can be generated through a former call
2616 my ($sub_stmt, @sub_bind)
2617 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2618 c3 => {-like => "foo%"}});
2621 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2624 In the examples above, the subquery was used as an operator on a column;
2625 but the same principle also applies for a clause within the main C<%where>
2626 hash, like an EXISTS subquery:
2628 my ($sub_stmt, @sub_bind)
2629 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2630 my %where = ( -and => [
2632 \["EXISTS ($sub_stmt)" => @sub_bind],
2637 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2638 WHERE c1 = ? AND c2 > t0.c0))";
2642 Observe that the condition on C<c2> in the subquery refers to
2643 column C<t0.c0> of the main query: this is I<not> a bind
2644 value, so we have to express it through a scalar ref.
2645 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2646 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2647 what we wanted here.
2649 Finally, here is an example where a subquery is used
2650 for expressing unary negation:
2652 my ($sub_stmt, @sub_bind)
2653 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2654 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2656 lname => {like => '%son%'},
2657 \["NOT ($sub_stmt)" => @sub_bind],
2662 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2663 @bind = ('%son%', 10, 20)
2665 =head3 Deprecated usage of Literal SQL
2667 Below are some examples of archaic use of literal SQL. It is shown only as
2668 reference for those who deal with legacy code. Each example has a much
2669 better, cleaner and safer alternative that users should opt for in new code.
2675 my %where = ( requestor => \'IS NOT NULL' )
2677 $stmt = "WHERE requestor IS NOT NULL"
2679 This used to be the way of generating NULL comparisons, before the handling
2680 of C<undef> got formalized. For new code please use the superior syntax as
2681 described in L</Tests for NULL values>.
2685 my %where = ( requestor => \'= submitter' )
2687 $stmt = "WHERE requestor = submitter"
2689 This used to be the only way to compare columns. Use the superior L</-ident>
2690 method for all new code. For example an identifier declared in such a way
2691 will be properly quoted if L</quote_char> is properly set, while the legacy
2692 form will remain as supplied.
2696 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2698 $stmt = "WHERE completed > ? AND is_ready"
2699 @bind = ('2012-12-21')
2701 Using an empty string literal used to be the only way to express a boolean.
2702 For all new code please use the much more readable
2703 L<-bool|/Unary operators: bool> operator.
2709 These pages could go on for a while, since the nesting of the data
2710 structures this module can handle are pretty much unlimited (the
2711 module implements the C<WHERE> expansion as a recursive function
2712 internally). Your best bet is to "play around" with the module a
2713 little to see how the data structures behave, and choose the best
2714 format for your data based on that.
2716 And of course, all the values above will probably be replaced with
2717 variables gotten from forms or the command line. After all, if you
2718 knew everything ahead of time, you wouldn't have to worry about
2719 dynamically-generating SQL and could just hardwire it into your
2722 =head1 ORDER BY CLAUSES
2724 Some functions take an order by clause. This can either be a scalar (just a
2725 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2726 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2729 Given | Will Generate
2730 ---------------------------------------------------------------
2732 'colA' | ORDER BY colA
2734 [qw/colA colB/] | ORDER BY colA, colB
2736 {-asc => 'colA'} | ORDER BY colA ASC
2738 {-desc => 'colB'} | ORDER BY colB DESC
2740 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2742 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2744 \'colA DESC' | ORDER BY colA DESC
2746 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2747 | /* ...with $x bound to ? */
2750 { -asc => 'colA' }, | colA ASC,
2751 { -desc => [qw/colB/] }, | colB DESC,
2752 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2753 \'colE DESC', | colE DESC,
2754 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2755 ] | /* ...with $x bound to ? */
2756 ===============================================================
2760 =head1 SPECIAL OPERATORS
2762 my $sqlmaker = SQL::Abstract->new(special_ops => [
2766 my ($self, $field, $op, $arg) = @_;
2772 handler => 'method_name',
2776 A "special operator" is a SQL syntactic clause that can be
2777 applied to a field, instead of a usual binary operator.
2780 WHERE field IN (?, ?, ?)
2781 WHERE field BETWEEN ? AND ?
2782 WHERE MATCH(field) AGAINST (?, ?)
2784 Special operators IN and BETWEEN are fairly standard and therefore
2785 are builtin within C<SQL::Abstract> (as the overridable methods
2786 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2787 like the MATCH .. AGAINST example above which is specific to MySQL,
2788 you can write your own operator handlers - supply a C<special_ops>
2789 argument to the C<new> method. That argument takes an arrayref of
2790 operator definitions; each operator definition is a hashref with two
2797 the regular expression to match the operator
2801 Either a coderef or a plain scalar method name. In both cases
2802 the expected return is C<< ($sql, @bind) >>.
2804 When supplied with a method name, it is simply called on the
2805 L<SQL::Abstract> object as:
2807 $self->$method_name($field, $op, $arg)
2811 $field is the LHS of the operator
2812 $op is the part that matched the handler regex
2815 When supplied with a coderef, it is called as:
2817 $coderef->($self, $field, $op, $arg)
2822 For example, here is an implementation
2823 of the MATCH .. AGAINST syntax for MySQL
2825 my $sqlmaker = SQL::Abstract->new(special_ops => [
2827 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2828 {regex => qr/^match$/i,
2830 my ($self, $field, $op, $arg) = @_;
2831 $arg = [$arg] if not ref $arg;
2832 my $label = $self->_quote($field);
2833 my ($placeholder) = $self->_convert('?');
2834 my $placeholders = join ", ", (($placeholder) x @$arg);
2835 my $sql = $self->_sqlcase('match') . " ($label) "
2836 . $self->_sqlcase('against') . " ($placeholders) ";
2837 my @bind = $self->_bindtype($field, @$arg);
2838 return ($sql, @bind);
2845 =head1 UNARY OPERATORS
2847 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2851 my ($self, $op, $arg) = @_;
2857 handler => 'method_name',
2861 A "unary operator" is a SQL syntactic clause that can be
2862 applied to a field - the operator goes before the field
2864 You can write your own operator handlers - supply a C<unary_ops>
2865 argument to the C<new> method. That argument takes an arrayref of
2866 operator definitions; each operator definition is a hashref with two
2873 the regular expression to match the operator
2877 Either a coderef or a plain scalar method name. In both cases
2878 the expected return is C<< $sql >>.
2880 When supplied with a method name, it is simply called on the
2881 L<SQL::Abstract> object as:
2883 $self->$method_name($op, $arg)
2887 $op is the part that matched the handler regex
2888 $arg is the RHS or argument of the operator
2890 When supplied with a coderef, it is called as:
2892 $coderef->($self, $op, $arg)
2900 Thanks to some benchmarking by Mark Stosberg, it turns out that
2901 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2902 I must admit this wasn't an intentional design issue, but it's a
2903 byproduct of the fact that you get to control your C<DBI> handles
2906 To maximize performance, use a code snippet like the following:
2908 # prepare a statement handle using the first row
2909 # and then reuse it for the rest of the rows
2911 for my $href (@array_of_hashrefs) {
2912 $stmt ||= $sql->insert('table', $href);
2913 $sth ||= $dbh->prepare($stmt);
2914 $sth->execute($sql->values($href));
2917 The reason this works is because the keys in your C<$href> are sorted
2918 internally by B<SQL::Abstract>. Thus, as long as your data retains
2919 the same structure, you only have to generate the SQL the first time
2920 around. On subsequent queries, simply use the C<values> function provided
2921 by this module to return your values in the correct order.
2923 However this depends on the values having the same type - if, for
2924 example, the values of a where clause may either have values
2925 (resulting in sql of the form C<column = ?> with a single bind
2926 value), or alternatively the values might be C<undef> (resulting in
2927 sql of the form C<column IS NULL> with no bind value) then the
2928 caching technique suggested will not work.
2932 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2933 really like this part (I do, at least). Building up a complex query
2934 can be as simple as the following:
2941 use CGI::FormBuilder;
2944 my $form = CGI::FormBuilder->new(...);
2945 my $sql = SQL::Abstract->new;
2947 if ($form->submitted) {
2948 my $field = $form->field;
2949 my $id = delete $field->{id};
2950 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2953 Of course, you would still have to connect using C<DBI> to run the
2954 query, but the point is that if you make your form look like your
2955 table, the actual query script can be extremely simplistic.
2957 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2958 a fast interface to returning and formatting data. I frequently
2959 use these three modules together to write complex database query
2960 apps in under 50 lines.
2962 =head1 HOW TO CONTRIBUTE
2964 Contributions are always welcome, in all usable forms (we especially
2965 welcome documentation improvements). The delivery methods include git-
2966 or unified-diff formatted patches, GitHub pull requests, or plain bug
2967 reports either via RT or the Mailing list. Contributors are generally
2968 granted full access to the official repository after their first several
2969 patches pass successful review.
2971 This project is maintained in a git repository. The code and related tools are
2972 accessible at the following locations:
2976 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2978 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
2980 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
2982 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
2988 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2989 Great care has been taken to preserve the I<published> behavior
2990 documented in previous versions in the 1.* family; however,
2991 some features that were previously undocumented, or behaved
2992 differently from the documentation, had to be changed in order
2993 to clarify the semantics. Hence, client code that was relying
2994 on some dark areas of C<SQL::Abstract> v1.*
2995 B<might behave differently> in v1.50.
2997 The main changes are:
3003 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3007 support for the { operator => \"..." } construct (to embed literal SQL)
3011 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3015 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3019 defensive programming: check arguments
3023 fixed bug with global logic, which was previously implemented
3024 through global variables yielding side-effects. Prior versions would
3025 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3026 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3027 Now this is interpreted
3028 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3033 fixed semantics of _bindtype on array args
3037 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3038 we just avoid shifting arrays within that tree.
3042 dropped the C<_modlogic> function
3046 =head1 ACKNOWLEDGEMENTS
3048 There are a number of individuals that have really helped out with
3049 this module. Unfortunately, most of them submitted bugs via CPAN
3050 so I have no idea who they are! But the people I do know are:
3052 Ash Berlin (order_by hash term support)
3053 Matt Trout (DBIx::Class support)
3054 Mark Stosberg (benchmarking)
3055 Chas Owens (initial "IN" operator support)
3056 Philip Collins (per-field SQL functions)
3057 Eric Kolve (hashref "AND" support)
3058 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3059 Dan Kubb (support for "quote_char" and "name_sep")
3060 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3061 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3062 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3063 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3064 Oliver Charles (support for "RETURNING" after "INSERT")
3070 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3074 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3076 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3078 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3079 While not an official support venue, C<DBIx::Class> makes heavy use of
3080 C<SQL::Abstract>, and as such list members there are very familiar with
3081 how to create queries.
3085 This module is free software; you may copy this under the same
3086 terms as perl itself (either the GNU General Public License or
3087 the Artistic License)