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 return undef unless defined($expr);
503 if (ref($expr) eq 'HASH') {
504 if (keys %$expr > 1) {
508 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
512 return unless %$expr;
513 return $self->_expand_expr_hashpair(%$expr, $logic);
515 if (ref($expr) eq 'ARRAY') {
516 my $logic = lc($logic || $self->{logic});
517 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
523 while (my ($el) = splice @expr, 0, 1) {
524 puke "Supplying an empty left hand side argument is not supported in array-pairs"
525 unless defined($el) and length($el);
526 my $elref = ref($el);
528 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
529 } elsif ($elref eq 'ARRAY') {
530 push(@res, $self->_expand_expr($el)) if @$el;
531 } elsif (my $l = is_literal_value($el)) {
532 push @res, { -literal => $l };
533 } elsif ($elref eq 'HASH') {
534 push @res, $self->_expand_expr($el);
539 return { -op => [ $logic, @res ] };
541 if (my $literal = is_literal_value($expr)) {
542 return +{ -literal => $literal };
544 if (!ref($expr) or Scalar::Util::blessed($expr)) {
545 if (my $d = $Default_Scalar_To) {
546 return +{ $d => $expr };
548 if (my $m = our $Cur_Col_Meta) {
549 return +{ -bind => [ $m, $expr ] };
551 return +{ -value => $expr };
556 sub _expand_expr_hashpair {
557 my ($self, $k, $v, $logic) = @_;
558 unless (defined($k) and length($k)) {
559 if (defined($k) and my $literal = is_literal_value($v)) {
560 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
561 return { -literal => $literal };
563 puke "Supplying an empty left hand side argument is not supported";
566 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
567 if ($k =~ s/ [_\s]? \d+ $//x ) {
568 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
569 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
572 return $self->_expand_expr($v);
576 return $self->_expand_expr($v);
578 puke "-bool => undef not supported" unless defined($v);
579 return { -ident => $v };
582 return { -op => [ 'not', $self->_expand_expr($v) ] };
584 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
587 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
590 if (my ($logic) = $k =~ /^-(and|or)$/i) {
591 if (ref($v) eq 'HASH') {
592 return $self->_expand_expr($v, $logic);
594 if (ref($v) eq 'ARRAY') {
595 return $self->_expand_expr($v, $logic);
600 $op =~ s/^-// if length($op) > 1;
602 # top level special ops are illegal in general
603 puke "Illegal use of top-level '-$op'"
604 if List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
605 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
606 return { -op => [ $op, $v ] };
609 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
610 return +{ -bind => [ $m, $v ] };
612 if (my $custom = $self->{expand_unary}{$k}) {
613 return $self->$custom($v);
615 if ($self->{node_types}{$k}) {
621 and (keys %$v)[0] =~ /^-/
623 my ($func) = $k =~ /^-(.*)$/;
624 return +{ -func => [ $func, $self->_expand_expr($v) ] };
626 if (!ref($v) or is_literal_value($v)) {
627 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
634 and exists $v->{-value}
635 and not defined $v->{-value}
638 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
640 if (!ref($v) or Scalar::Util::blessed($v)) {
641 my $d = our $Default_Scalar_To;
646 ($d ? { $d => $v } : { -bind => [ $k, $v ] })
650 if (ref($v) eq 'HASH') {
654 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
661 $self->_assert_pass_injection_guard($vk);
662 if ($vk =~ s/ [_\s]? \d+ $//x ) {
663 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
664 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
666 if ($vk =~ /^(?:not[ _])?between$/) {
667 local our $Cur_Col_Meta = $k;
668 my @rhs = map $self->_expand_expr($_),
669 ref($vv) eq 'ARRAY' ? @$vv : $vv;
671 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
673 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
675 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
678 join(' ', split '_', $vk),
683 if ($vk =~ /^(?:not[ _])?in$/) {
684 if (my $literal = is_literal_value($vv)) {
685 my ($sql, @bind) = @$literal;
686 my $opened_sql = $self->_open_outer_paren($sql);
688 $vk, { -ident => $k },
689 [ { -literal => [ $opened_sql, @bind ] } ]
693 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
694 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
695 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
696 . 'will emit the logically correct SQL instead of raising this exception)'
698 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
700 my @rhs = map $self->_expand_expr($_),
701 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
702 map { defined($_) ? $_: puke($undef_err) }
703 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
704 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
707 join(' ', split '_', $vk),
712 if ($vk eq 'ident') {
713 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
714 puke "-$vk requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
722 if ($vk eq 'value') {
723 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
727 { -bind => [ $k, $vv ] }
730 if ($vk =~ /^is(?:[ _]not)?$/) {
731 puke "$vk can only take undef as argument"
735 and exists($vv->{-value})
736 and !defined($vv->{-value})
739 return +{ -op => [ $vk.' null', { -ident => $k } ] };
741 if ($vk =~ /^(and|or)$/) {
742 if (ref($vv) eq 'HASH') {
745 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
750 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{special_ops}}) {
751 return { -op => [ $vk, { -ident => $k }, $vv ] };
753 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{unary_ops}}) {
757 { -op => [ $vk, $vv ] }
760 if (ref($vv) eq 'ARRAY') {
761 my ($logic, @values) = (
762 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
767 $vk =~ $self->{inequality_op}
768 or join(' ', split '_', $vk) =~ $self->{not_like_op}
770 if (lc($logic) eq '-or' and @values > 1) {
771 my $op = uc join ' ', split '_', $vk;
772 belch "A multi-element arrayref as an argument to the inequality op '$op' "
773 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
774 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
779 # try to DWIM on equality operators
780 my $op = join ' ', split '_', $vk;
782 $op =~ $self->{equality_op} ? $self->sqlfalse
783 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
784 : $op =~ $self->{inequality_op} ? $self->sqltrue
785 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
786 : puke "operator '$op' applied on an empty array (field '$k')";
790 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
798 and exists $vv->{-value}
799 and not defined $vv->{-value}
802 my $op = join ' ', split '_', $vk;
804 $op =~ /^not$/i ? 'is not' # legacy
805 : $op =~ $self->{equality_op} ? 'is'
806 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
807 : $op =~ $self->{inequality_op} ? 'is not'
808 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
809 : puke "unexpected operator '$op' with undef operand";
810 return +{ -op => [ $is.' null', { -ident => $k } ] };
812 local our $Cur_Col_Meta = $k;
816 $self->_expand_expr($vv)
819 if (ref($v) eq 'ARRAY') {
820 return $self->sqlfalse unless @$v;
821 $self->_debug("ARRAY($k) means distribute over elements");
823 $v->[0] =~ /^-((?:and|or))$/i
824 ? ($v = [ @{$v}[1..$#$v] ], $1)
825 : ($self->{logic} || 'or')
829 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
832 if (my $literal = is_literal_value($v)) {
834 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
837 my ($sql, @bind) = @$literal;
838 if ($self->{bindtype} eq 'columns') {
840 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
841 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
845 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
851 my ($self, $expr) = @_;
852 my ($k, $v, @rest) = %$expr;
854 if (my $meth = $self->{node_types}{$k}) {
855 return $self->$meth($v);
857 die "notreached: $k";
861 my ($self, $where, $logic) = @_;
863 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
865 my $where_exp = $self->_expand_expr($where, $logic);
867 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
869 # dispatch on appropriate method according to refkind of $where
870 # my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
872 # my ($sql, @bind) = $self->$method($where_exp, $logic);
874 my ($sql, @bind) = defined($where_exp) ? $self->_render_expr($where_exp) : (undef);
876 # DBIx::Class used to call _recurse_where in scalar context
877 # something else might too...
879 return ($sql, @bind);
882 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
888 my ($self, $ident) = @_;
890 return $self->_convert($self->_quote($ident));
894 my ($self, $value) = @_;
896 return ($self->_convert('?'), $self->_bindtype(undef, $value));
899 my %unop_postfix = map +($_ => 1),
900 'is null', 'is not null',
908 my ($self, $args) = @_;
909 my ($left, $low, $high) = @$args;
910 my ($rhsql, @rhbind) = do {
912 puke "Single arg to between must be a literal"
913 unless $low->{-literal};
916 my ($l, $h) = map [ $self->_render_expr($_) ], $low, $high;
917 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
918 @{$l}[1..$#$l], @{$h}[1..$#$h])
921 my ($lhsql, @lhbind) = $self->_render_expr($left);
923 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
927 }), 'between', 'not between'),
931 my ($self, $args) = @_;
932 my ($lhs, $rhs) = @$args;
935 my ($sql, @bind) = $self->_render_expr($_);
936 push @in_bind, @bind;
939 my ($lhsql, @lbind) = $self->_render_expr($lhs);
941 $lhsql.' '.$self->_sqlcase($op).' ( '
952 my ($op, @args) = @$v;
953 $op =~ s/^-// if length($op) > 1;
955 if (my $h = $special{$op}) {
956 return $self->$h(\@args);
958 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
959 puke "Special op '${op}' requires first value to be identifier"
960 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
961 return $self->${\($us->{handler})}($k, $op, $args[1]);
963 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
964 return $self->${\($us->{handler})}($op, $args[0]);
966 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
967 if (@args == 1 and $op !~ /^(and|or)$/) {
968 my ($expr_sql, @bind) = $self->_render_expr($args[0]);
969 my $op_sql = $self->_sqlcase($final_op);
971 $unop_postfix{lc($final_op)}
972 ? "${expr_sql} ${op_sql}"
973 : "${op_sql} ${expr_sql}"
975 return (($op eq 'not' ? '('.$final_sql.')' : $final_sql), @bind);
977 my @parts = map [ $self->_render_expr($_) ], @args;
978 my ($final_sql) = map +($op =~ /^(and|or)$/ ? "(${_})" : $_), join(
979 ($final_op eq ',' ? '' : ' ').$self->_sqlcase($final_op).' ',
984 map @{$_}[1..$#$_], @parts
991 my ($self, $rest) = @_;
992 my ($func, @args) = @$rest;
996 push @arg_sql, shift @x;
998 } map [ $self->_render_expr($_) ], @args;
999 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1003 my ($self, $bind) = @_;
1004 return ($self->_convert('?'), $self->_bindtype(@$bind));
1007 sub _render_literal {
1008 my ($self, $literal) = @_;
1009 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1013 # Some databases (SQLite) treat col IN (1, 2) different from
1014 # col IN ( (1, 2) ). Use this to strip all outer parens while
1015 # adding them back in the corresponding method
1016 sub _open_outer_paren {
1017 my ($self, $sql) = @_;
1019 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1021 # there are closing parens inside, need the heavy duty machinery
1022 # to reevaluate the extraction starting from $sql (full reevaluation)
1023 if ($inner =~ /\)/) {
1024 require Text::Balanced;
1026 my (undef, $remainder) = do {
1027 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1029 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1032 # the entire expression needs to be a balanced bracketed thing
1033 # (after an extract no remainder sans trailing space)
1034 last if defined $remainder and $remainder =~ /\S/;
1044 #======================================================================
1046 #======================================================================
1048 sub _expand_order_by {
1049 my ($self, $arg) = @_;
1051 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1053 my $expander = sub {
1054 my ($self, $dir, $expr) = @_;
1055 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1056 foreach my $arg (@to_expand) {
1060 and grep /^-(asc|desc)$/, keys %$arg
1062 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1065 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1066 map $self->_expand_expr($_, undef, -ident), @to_expand;
1067 return (@exp > 1 ? { -op => [ ',', @exp ] } : $exp[0]);
1070 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1071 sub { shift->$expander(asc => @_) },
1072 sub { shift->$expander(desc => @_) },
1075 return $self->$expander(undef, $arg);
1079 my ($self, $arg) = @_;
1081 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1083 my ($sql, @bind) = $self->_render_expr($expanded);
1085 my $final_sql = $self->_sqlcase(' order by ').$sql;
1087 return wantarray ? ($final_sql, @bind) : $final_sql;
1090 sub _order_by_chunks {
1091 my ($self, $arg) = @_;
1093 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1096 if (ref() eq 'HASH' and my $op = $_->{-op}) {
1097 if ($op->[0] eq ',') {
1098 return map [ $self->_render_expr($_) ], @{$op}[1..$#$op];
1101 return [ $self->_render_expr($_) ];
1105 #======================================================================
1106 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1107 #======================================================================
1112 ($self->_render_expr(
1113 $self->_expand_maybe_list_expr($from, undef, -ident)
1118 #======================================================================
1120 #======================================================================
1122 sub _expand_maybe_list_expr {
1123 my ($self, $expr, $logic, $default) = @_;
1125 if (ref($expr) eq 'ARRAY') {
1127 ',', map $self->_expand_expr($_, $logic, $default), @$expr
1134 return $self->_expand_expr($e, $logic, $default);
1137 # highly optimized, as it's called way too often
1139 # my ($self, $label) = @_;
1141 return '' unless defined $_[1];
1142 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1143 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1145 unless ($_[0]->{quote_char}) {
1146 if (ref($_[1]) eq 'ARRAY') {
1147 return join($_[0]->{name_sep}||'.', @{$_[1]});
1149 $_[0]->_assert_pass_injection_guard($_[1]);
1154 my $qref = ref $_[0]->{quote_char};
1156 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1157 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1158 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1160 my $esc = $_[0]->{escape_char} || $r;
1162 # parts containing * are naturally unquoted
1164 $_[0]->{name_sep}||'',
1168 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1170 (ref($_[1]) eq 'ARRAY'
1174 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1182 # Conversion, if applicable
1184 #my ($self, $arg) = @_;
1185 if ($_[0]->{convert_where}) {
1186 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1193 #my ($self, $col, @vals) = @_;
1194 # called often - tighten code
1195 return $_[0]->{bindtype} eq 'columns'
1196 ? map {[$_[1], $_]} @_[2 .. $#_]
1201 # Dies if any element of @bind is not in [colname => value] format
1202 # if bindtype is 'columns'.
1203 sub _assert_bindval_matches_bindtype {
1204 # my ($self, @bind) = @_;
1206 if ($self->{bindtype} eq 'columns') {
1208 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1209 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1215 sub _join_sql_clauses {
1216 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1218 if (@$clauses_aref > 1) {
1219 my $join = " " . $self->_sqlcase($logic) . " ";
1220 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1221 return ($sql, @$bind_aref);
1223 elsif (@$clauses_aref) {
1224 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1227 return (); # if no SQL, ignore @$bind_aref
1232 # Fix SQL case, if so requested
1234 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1235 # don't touch the argument ... crooked logic, but let's not change it!
1236 return $_[0]->{case} ? $_[1] : uc($_[1]);
1240 #======================================================================
1241 # DISPATCHING FROM REFKIND
1242 #======================================================================
1245 my ($self, $data) = @_;
1247 return 'UNDEF' unless defined $data;
1249 # blessed objects are treated like scalars
1250 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1252 return 'SCALAR' unless $ref;
1255 while ($ref eq 'REF') {
1257 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1261 return ($ref||'SCALAR') . ('REF' x $n_steps);
1265 my ($self, $data) = @_;
1266 my @try = ($self->_refkind($data));
1267 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1268 push @try, 'FALLBACK';
1272 sub _METHOD_FOR_refkind {
1273 my ($self, $meth_prefix, $data) = @_;
1276 for (@{$self->_try_refkind($data)}) {
1277 $method = $self->can($meth_prefix."_".$_)
1281 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1285 sub _SWITCH_refkind {
1286 my ($self, $data, $dispatch_table) = @_;
1289 for (@{$self->_try_refkind($data)}) {
1290 $coderef = $dispatch_table->{$_}
1294 puke "no dispatch entry for ".$self->_refkind($data)
1303 #======================================================================
1304 # VALUES, GENERATE, AUTOLOAD
1305 #======================================================================
1307 # LDNOTE: original code from nwiger, didn't touch code in that section
1308 # I feel the AUTOLOAD stuff should not be the default, it should
1309 # only be activated on explicit demand by user.
1313 my $data = shift || return;
1314 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1315 unless ref $data eq 'HASH';
1318 foreach my $k (sort keys %$data) {
1319 my $v = $data->{$k};
1320 $self->_SWITCH_refkind($v, {
1322 if ($self->{array_datatypes}) { # array datatype
1323 push @all_bind, $self->_bindtype($k, $v);
1325 else { # literal SQL with bind
1326 my ($sql, @bind) = @$v;
1327 $self->_assert_bindval_matches_bindtype(@bind);
1328 push @all_bind, @bind;
1331 ARRAYREFREF => sub { # literal SQL with bind
1332 my ($sql, @bind) = @${$v};
1333 $self->_assert_bindval_matches_bindtype(@bind);
1334 push @all_bind, @bind;
1336 SCALARREF => sub { # literal SQL without bind
1338 SCALAR_or_UNDEF => sub {
1339 push @all_bind, $self->_bindtype($k, $v);
1350 my(@sql, @sqlq, @sqlv);
1354 if ($ref eq 'HASH') {
1355 for my $k (sort keys %$_) {
1358 my $label = $self->_quote($k);
1359 if ($r eq 'ARRAY') {
1360 # literal SQL with bind
1361 my ($sql, @bind) = @$v;
1362 $self->_assert_bindval_matches_bindtype(@bind);
1363 push @sqlq, "$label = $sql";
1365 } elsif ($r eq 'SCALAR') {
1366 # literal SQL without bind
1367 push @sqlq, "$label = $$v";
1369 push @sqlq, "$label = ?";
1370 push @sqlv, $self->_bindtype($k, $v);
1373 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1374 } elsif ($ref eq 'ARRAY') {
1375 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1378 if ($r eq 'ARRAY') { # literal SQL with bind
1379 my ($sql, @bind) = @$v;
1380 $self->_assert_bindval_matches_bindtype(@bind);
1383 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1384 # embedded literal SQL
1391 push @sql, '(' . join(', ', @sqlq) . ')';
1392 } elsif ($ref eq 'SCALAR') {
1396 # strings get case twiddled
1397 push @sql, $self->_sqlcase($_);
1401 my $sql = join ' ', @sql;
1403 # this is pretty tricky
1404 # if ask for an array, return ($stmt, @bind)
1405 # otherwise, s/?/shift @sqlv/ to put it inline
1407 return ($sql, @sqlv);
1409 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1410 ref $d ? $d->[1] : $d/e;
1419 # This allows us to check for a local, then _form, attr
1421 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1422 return $self->generate($name, @_);
1433 SQL::Abstract - Generate SQL from Perl data structures
1439 my $sql = SQL::Abstract->new;
1441 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1443 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1445 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1447 my($stmt, @bind) = $sql->delete($table, \%where);
1449 # Then, use these in your DBI statements
1450 my $sth = $dbh->prepare($stmt);
1451 $sth->execute(@bind);
1453 # Just generate the WHERE clause
1454 my($stmt, @bind) = $sql->where(\%where, $order);
1456 # Return values in the same order, for hashed queries
1457 # See PERFORMANCE section for more details
1458 my @bind = $sql->values(\%fieldvals);
1462 This module was inspired by the excellent L<DBIx::Abstract>.
1463 However, in using that module I found that what I really wanted
1464 to do was generate SQL, but still retain complete control over my
1465 statement handles and use the DBI interface. So, I set out to
1466 create an abstract SQL generation module.
1468 While based on the concepts used by L<DBIx::Abstract>, there are
1469 several important differences, especially when it comes to WHERE
1470 clauses. I have modified the concepts used to make the SQL easier
1471 to generate from Perl data structures and, IMO, more intuitive.
1472 The underlying idea is for this module to do what you mean, based
1473 on the data structures you provide it. The big advantage is that
1474 you don't have to modify your code every time your data changes,
1475 as this module figures it out.
1477 To begin with, an SQL INSERT is as easy as just specifying a hash
1478 of C<key=value> pairs:
1481 name => 'Jimbo Bobson',
1482 phone => '123-456-7890',
1483 address => '42 Sister Lane',
1484 city => 'St. Louis',
1485 state => 'Louisiana',
1488 The SQL can then be generated with this:
1490 my($stmt, @bind) = $sql->insert('people', \%data);
1492 Which would give you something like this:
1494 $stmt = "INSERT INTO people
1495 (address, city, name, phone, state)
1496 VALUES (?, ?, ?, ?, ?)";
1497 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1498 '123-456-7890', 'Louisiana');
1500 These are then used directly in your DBI code:
1502 my $sth = $dbh->prepare($stmt);
1503 $sth->execute(@bind);
1505 =head2 Inserting and Updating Arrays
1507 If your database has array types (like for example Postgres),
1508 activate the special option C<< array_datatypes => 1 >>
1509 when creating the C<SQL::Abstract> object.
1510 Then you may use an arrayref to insert and update database array types:
1512 my $sql = SQL::Abstract->new(array_datatypes => 1);
1514 planets => [qw/Mercury Venus Earth Mars/]
1517 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1521 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1523 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1526 =head2 Inserting and Updating SQL
1528 In order to apply SQL functions to elements of your C<%data> you may
1529 specify a reference to an arrayref for the given hash value. For example,
1530 if you need to execute the Oracle C<to_date> function on a value, you can
1531 say something like this:
1535 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1538 The first value in the array is the actual SQL. Any other values are
1539 optional and would be included in the bind values array. This gives
1542 my($stmt, @bind) = $sql->insert('people', \%data);
1544 $stmt = "INSERT INTO people (name, date_entered)
1545 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1546 @bind = ('Bill', '03/02/2003');
1548 An UPDATE is just as easy, all you change is the name of the function:
1550 my($stmt, @bind) = $sql->update('people', \%data);
1552 Notice that your C<%data> isn't touched; the module will generate
1553 the appropriately quirky SQL for you automatically. Usually you'll
1554 want to specify a WHERE clause for your UPDATE, though, which is
1555 where handling C<%where> hashes comes in handy...
1557 =head2 Complex where statements
1559 This module can generate pretty complicated WHERE statements
1560 easily. For example, simple C<key=value> pairs are taken to mean
1561 equality, and if you want to see if a field is within a set
1562 of values, you can use an arrayref. Let's say we wanted to
1563 SELECT some data based on this criteria:
1566 requestor => 'inna',
1567 worker => ['nwiger', 'rcwe', 'sfz'],
1568 status => { '!=', 'completed' }
1571 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1573 The above would give you something like this:
1575 $stmt = "SELECT * FROM tickets WHERE
1576 ( requestor = ? ) AND ( status != ? )
1577 AND ( worker = ? OR worker = ? OR worker = ? )";
1578 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1580 Which you could then use in DBI code like so:
1582 my $sth = $dbh->prepare($stmt);
1583 $sth->execute(@bind);
1589 The methods are simple. There's one for every major SQL operation,
1590 and a constructor you use first. The arguments are specified in a
1591 similar order for each method (table, then fields, then a where
1592 clause) to try and simplify things.
1594 =head2 new(option => 'value')
1596 The C<new()> function takes a list of options and values, and returns
1597 a new B<SQL::Abstract> object which can then be used to generate SQL
1598 through the methods below. The options accepted are:
1604 If set to 'lower', then SQL will be generated in all lowercase. By
1605 default SQL is generated in "textbook" case meaning something like:
1607 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1609 Any setting other than 'lower' is ignored.
1613 This determines what the default comparison operator is. By default
1614 it is C<=>, meaning that a hash like this:
1616 %where = (name => 'nwiger', email => 'nate@wiger.org');
1618 Will generate SQL like this:
1620 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1622 However, you may want loose comparisons by default, so if you set
1623 C<cmp> to C<like> you would get SQL such as:
1625 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1627 You can also override the comparison on an individual basis - see
1628 the huge section on L</"WHERE CLAUSES"> at the bottom.
1630 =item sqltrue, sqlfalse
1632 Expressions for inserting boolean values within SQL statements.
1633 By default these are C<1=1> and C<1=0>. They are used
1634 by the special operators C<-in> and C<-not_in> for generating
1635 correct SQL even when the argument is an empty array (see below).
1639 This determines the default logical operator for multiple WHERE
1640 statements in arrays or hashes. If absent, the default logic is "or"
1641 for arrays, and "and" for hashes. This means that a WHERE
1645 event_date => {'>=', '2/13/99'},
1646 event_date => {'<=', '4/24/03'},
1649 will generate SQL like this:
1651 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1653 This is probably not what you want given this query, though (look
1654 at the dates). To change the "OR" to an "AND", simply specify:
1656 my $sql = SQL::Abstract->new(logic => 'and');
1658 Which will change the above C<WHERE> to:
1660 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1662 The logic can also be changed locally by inserting
1663 a modifier in front of an arrayref:
1665 @where = (-and => [event_date => {'>=', '2/13/99'},
1666 event_date => {'<=', '4/24/03'} ]);
1668 See the L</"WHERE CLAUSES"> section for explanations.
1672 This will automatically convert comparisons using the specified SQL
1673 function for both column and value. This is mostly used with an argument
1674 of C<upper> or C<lower>, so that the SQL will have the effect of
1675 case-insensitive "searches". For example, this:
1677 $sql = SQL::Abstract->new(convert => 'upper');
1678 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1680 Will turn out the following SQL:
1682 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1684 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1685 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1686 not validate this option; it will just pass through what you specify verbatim).
1690 This is a kludge because many databases suck. For example, you can't
1691 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1692 Instead, you have to use C<bind_param()>:
1694 $sth->bind_param(1, 'reg data');
1695 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1697 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1698 which loses track of which field each slot refers to. Fear not.
1700 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1701 Currently, you can specify either C<normal> (default) or C<columns>. If you
1702 specify C<columns>, you will get an array that looks like this:
1704 my $sql = SQL::Abstract->new(bindtype => 'columns');
1705 my($stmt, @bind) = $sql->insert(...);
1708 [ 'column1', 'value1' ],
1709 [ 'column2', 'value2' ],
1710 [ 'column3', 'value3' ],
1713 You can then iterate through this manually, using DBI's C<bind_param()>.
1715 $sth->prepare($stmt);
1718 my($col, $data) = @$_;
1719 if ($col eq 'details' || $col eq 'comments') {
1720 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1721 } elsif ($col eq 'image') {
1722 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1724 $sth->bind_param($i, $data);
1728 $sth->execute; # execute without @bind now
1730 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1731 Basically, the advantage is still that you don't have to care which fields
1732 are or are not included. You could wrap that above C<for> loop in a simple
1733 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1734 get a layer of abstraction over manual SQL specification.
1736 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1737 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1738 will expect the bind values in this format.
1742 This is the character that a table or column name will be quoted
1743 with. By default this is an empty string, but you could set it to
1744 the character C<`>, to generate SQL like this:
1746 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1748 Alternatively, you can supply an array ref of two items, the first being the left
1749 hand quote character, and the second the right hand quote character. For
1750 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1751 that generates SQL like this:
1753 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1755 Quoting is useful if you have tables or columns names that are reserved
1756 words in your database's SQL dialect.
1760 This is the character that will be used to escape L</quote_char>s appearing
1761 in an identifier before it has been quoted.
1763 The parameter default in case of a single L</quote_char> character is the quote
1766 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1767 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1768 of the B<opening (left)> L</quote_char> within the identifier are currently left
1769 untouched. The default for opening-closing-style quotes may change in future
1770 versions, thus you are B<strongly encouraged> to specify the escape character
1775 This is the character that separates a table and column name. It is
1776 necessary to specify this when the C<quote_char> option is selected,
1777 so that tables and column names can be individually quoted like this:
1779 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1781 =item injection_guard
1783 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1784 column name specified in a query structure. This is a safety mechanism to avoid
1785 injection attacks when mishandling user input e.g.:
1787 my %condition_as_column_value_pairs = get_values_from_user();
1788 $sqla->select( ... , \%condition_as_column_value_pairs );
1790 If the expression matches an exception is thrown. Note that literal SQL
1791 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1793 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1795 =item array_datatypes
1797 When this option is true, arrayrefs in INSERT or UPDATE are
1798 interpreted as array datatypes and are passed directly
1800 When this option is false, arrayrefs are interpreted
1801 as literal SQL, just like refs to arrayrefs
1802 (but this behavior is for backwards compatibility; when writing
1803 new queries, use the "reference to arrayref" syntax
1809 Takes a reference to a list of "special operators"
1810 to extend the syntax understood by L<SQL::Abstract>.
1811 See section L</"SPECIAL OPERATORS"> for details.
1815 Takes a reference to a list of "unary operators"
1816 to extend the syntax understood by L<SQL::Abstract>.
1817 See section L</"UNARY OPERATORS"> for details.
1823 =head2 insert($table, \@values || \%fieldvals, \%options)
1825 This is the simplest function. You simply give it a table name
1826 and either an arrayref of values or hashref of field/value pairs.
1827 It returns an SQL INSERT statement and a list of bind values.
1828 See the sections on L</"Inserting and Updating Arrays"> and
1829 L</"Inserting and Updating SQL"> for information on how to insert
1830 with those data types.
1832 The optional C<\%options> hash reference may contain additional
1833 options to generate the insert SQL. Currently supported options
1840 Takes either a scalar of raw SQL fields, or an array reference of
1841 field names, and adds on an SQL C<RETURNING> statement at the end.
1842 This allows you to return data generated by the insert statement
1843 (such as row IDs) without performing another C<SELECT> statement.
1844 Note, however, this is not part of the SQL standard and may not
1845 be supported by all database engines.
1849 =head2 update($table, \%fieldvals, \%where, \%options)
1851 This takes a table, hashref of field/value pairs, and an optional
1852 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1854 See the sections on L</"Inserting and Updating Arrays"> and
1855 L</"Inserting and Updating SQL"> for information on how to insert
1856 with those data types.
1858 The optional C<\%options> hash reference may contain additional
1859 options to generate the update SQL. Currently supported options
1866 See the C<returning> option to
1867 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1871 =head2 select($source, $fields, $where, $order)
1873 This returns a SQL SELECT statement and associated list of bind values, as
1874 specified by the arguments:
1880 Specification of the 'FROM' part of the statement.
1881 The argument can be either a plain scalar (interpreted as a table
1882 name, will be quoted), or an arrayref (interpreted as a list
1883 of table names, joined by commas, quoted), or a scalarref
1884 (literal SQL, not quoted).
1888 Specification of the list of fields to retrieve from
1890 The argument can be either an arrayref (interpreted as a list
1891 of field names, will be joined by commas and quoted), or a
1892 plain scalar (literal SQL, not quoted).
1893 Please observe that this API is not as flexible as that of
1894 the first argument C<$source>, for backwards compatibility reasons.
1898 Optional argument to specify the WHERE part of the query.
1899 The argument is most often a hashref, but can also be
1900 an arrayref or plain scalar --
1901 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1905 Optional argument to specify the ORDER BY part of the query.
1906 The argument can be a scalar, a hashref or an arrayref
1907 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1913 =head2 delete($table, \%where, \%options)
1915 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1916 It returns an SQL DELETE statement and list of bind values.
1918 The optional C<\%options> hash reference may contain additional
1919 options to generate the delete SQL. Currently supported options
1926 See the C<returning> option to
1927 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1931 =head2 where(\%where, $order)
1933 This is used to generate just the WHERE clause. For example,
1934 if you have an arbitrary data structure and know what the
1935 rest of your SQL is going to look like, but want an easy way
1936 to produce a WHERE clause, use this. It returns an SQL WHERE
1937 clause and list of bind values.
1940 =head2 values(\%data)
1942 This just returns the values from the hash C<%data>, in the same
1943 order that would be returned from any of the other above queries.
1944 Using this allows you to markedly speed up your queries if you
1945 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1947 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1949 Warning: This is an experimental method and subject to change.
1951 This returns arbitrarily generated SQL. It's a really basic shortcut.
1952 It will return two different things, depending on return context:
1954 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
1955 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
1957 These would return the following:
1959 # First calling form
1960 $stmt = "CREATE TABLE test (?, ?)";
1961 @bind = (field1, field2);
1963 # Second calling form
1964 $stmt_and_val = "CREATE TABLE test (field1, field2)";
1966 Depending on what you're trying to do, it's up to you to choose the correct
1967 format. In this example, the second form is what you would want.
1971 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
1975 ALTER SESSION SET nls_date_format = 'MM/YY'
1977 You get the idea. Strings get their case twiddled, but everything
1978 else remains verbatim.
1980 =head1 EXPORTABLE FUNCTIONS
1982 =head2 is_plain_value
1984 Determines if the supplied argument is a plain value as understood by this
1989 =item * The value is C<undef>
1991 =item * The value is a non-reference
1993 =item * The value is an object with stringification overloading
1995 =item * The value is of the form C<< { -value => $anything } >>
1999 On failure returns C<undef>, on success returns a B<scalar> reference
2000 to the original supplied argument.
2006 The stringification overloading detection is rather advanced: it takes
2007 into consideration not only the presence of a C<""> overload, but if that
2008 fails also checks for enabled
2009 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2010 on either C<0+> or C<bool>.
2012 Unfortunately testing in the field indicates that this
2013 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2014 but only when very large numbers of stringifying objects are involved.
2015 At the time of writing ( Sep 2014 ) there is no clear explanation of
2016 the direct cause, nor is there a manageably small test case that reliably
2017 reproduces the problem.
2019 If you encounter any of the following exceptions in B<random places within
2020 your application stack> - this module may be to blame:
2022 Operation "ne": no method found,
2023 left argument in overloaded package <something>,
2024 right argument in overloaded package <something>
2028 Stub found while resolving method "???" overloading """" in package <something>
2030 If you fall victim to the above - please attempt to reduce the problem
2031 to something that could be sent to the L<SQL::Abstract developers
2032 |DBIx::Class/GETTING HELP/SUPPORT>
2033 (either publicly or privately). As a workaround in the meantime you can
2034 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2035 value, which will most likely eliminate your problem (at the expense of
2036 not being able to properly detect exotic forms of stringification).
2038 This notice and environment variable will be removed in a future version,
2039 as soon as the underlying problem is found and a reliable workaround is
2044 =head2 is_literal_value
2046 Determines if the supplied argument is a literal value as understood by this
2051 =item * C<\$sql_string>
2053 =item * C<\[ $sql_string, @bind_values ]>
2057 On failure returns C<undef>, on success returns an B<array> reference
2058 containing the unpacked version of the supplied literal SQL and bind values.
2060 =head1 WHERE CLAUSES
2064 This module uses a variation on the idea from L<DBIx::Abstract>. It
2065 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2066 module is that things in arrays are OR'ed, and things in hashes
2069 The easiest way to explain is to show lots of examples. After
2070 each C<%where> hash shown, it is assumed you used:
2072 my($stmt, @bind) = $sql->where(\%where);
2074 However, note that the C<%where> hash can be used directly in any
2075 of the other functions as well, as described above.
2077 =head2 Key-value pairs
2079 So, let's get started. To begin, a simple hash:
2083 status => 'completed'
2086 Is converted to SQL C<key = val> statements:
2088 $stmt = "WHERE user = ? AND status = ?";
2089 @bind = ('nwiger', 'completed');
2091 One common thing I end up doing is having a list of values that
2092 a field can be in. To do this, simply specify a list inside of
2097 status => ['assigned', 'in-progress', 'pending'];
2100 This simple code will create the following:
2102 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2103 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2105 A field associated to an empty arrayref will be considered a
2106 logical false and will generate 0=1.
2108 =head2 Tests for NULL values
2110 If the value part is C<undef> then this is converted to SQL <IS NULL>
2119 $stmt = "WHERE user = ? AND status IS NULL";
2122 To test if a column IS NOT NULL:
2126 status => { '!=', undef },
2129 =head2 Specific comparison operators
2131 If you want to specify a different type of operator for your comparison,
2132 you can use a hashref for a given column:
2136 status => { '!=', 'completed' }
2139 Which would generate:
2141 $stmt = "WHERE user = ? AND status != ?";
2142 @bind = ('nwiger', 'completed');
2144 To test against multiple values, just enclose the values in an arrayref:
2146 status => { '=', ['assigned', 'in-progress', 'pending'] };
2148 Which would give you:
2150 "WHERE status = ? OR status = ? OR status = ?"
2153 The hashref can also contain multiple pairs, in which case it is expanded
2154 into an C<AND> of its elements:
2158 status => { '!=', 'completed', -not_like => 'pending%' }
2161 # Or more dynamically, like from a form
2162 $where{user} = 'nwiger';
2163 $where{status}{'!='} = 'completed';
2164 $where{status}{'-not_like'} = 'pending%';
2166 # Both generate this
2167 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2168 @bind = ('nwiger', 'completed', 'pending%');
2171 To get an OR instead, you can combine it with the arrayref idea:
2175 priority => [ { '=', 2 }, { '>', 5 } ]
2178 Which would generate:
2180 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2181 @bind = ('2', '5', 'nwiger');
2183 If you want to include literal SQL (with or without bind values), just use a
2184 scalar reference or reference to an arrayref as the value:
2187 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2188 date_expires => { '<' => \"now()" }
2191 Which would generate:
2193 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2194 @bind = ('11/26/2008');
2197 =head2 Logic and nesting operators
2199 In the example above,
2200 there is a subtle trap if you want to say something like
2201 this (notice the C<AND>):
2203 WHERE priority != ? AND priority != ?
2205 Because, in Perl you I<can't> do this:
2207 priority => { '!=' => 2, '!=' => 1 }
2209 As the second C<!=> key will obliterate the first. The solution
2210 is to use the special C<-modifier> form inside an arrayref:
2212 priority => [ -and => {'!=', 2},
2216 Normally, these would be joined by C<OR>, but the modifier tells it
2217 to use C<AND> instead. (Hint: You can use this in conjunction with the
2218 C<logic> option to C<new()> in order to change the way your queries
2219 work by default.) B<Important:> Note that the C<-modifier> goes
2220 B<INSIDE> the arrayref, as an extra first element. This will
2221 B<NOT> do what you think it might:
2223 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2225 Here is a quick list of equivalencies, since there is some overlap:
2228 status => {'!=', 'completed', 'not like', 'pending%' }
2229 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2232 status => {'=', ['assigned', 'in-progress']}
2233 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2234 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2238 =head2 Special operators: IN, BETWEEN, etc.
2240 You can also use the hashref format to compare a list of fields using the
2241 C<IN> comparison operator, by specifying the list as an arrayref:
2244 status => 'completed',
2245 reportid => { -in => [567, 2335, 2] }
2248 Which would generate:
2250 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2251 @bind = ('completed', '567', '2335', '2');
2253 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2256 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2257 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2258 'sqltrue' (by default: C<1=1>).
2260 In addition to the array you can supply a chunk of literal sql or
2261 literal sql with bind:
2264 customer => { -in => \[
2265 'SELECT cust_id FROM cust WHERE balance > ?',
2268 status => { -in => \'SELECT status_codes FROM states' },
2274 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2275 AND status IN ( SELECT status_codes FROM states )
2279 Finally, if the argument to C<-in> is not a reference, it will be
2280 treated as a single-element array.
2282 Another pair of operators is C<-between> and C<-not_between>,
2283 used with an arrayref of two values:
2287 completion_date => {
2288 -not_between => ['2002-10-01', '2003-02-06']
2294 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2296 Just like with C<-in> all plausible combinations of literal SQL
2300 start0 => { -between => [ 1, 2 ] },
2301 start1 => { -between => \["? AND ?", 1, 2] },
2302 start2 => { -between => \"lower(x) AND upper(y)" },
2303 start3 => { -between => [
2305 \["upper(?)", 'stuff' ],
2312 ( start0 BETWEEN ? AND ? )
2313 AND ( start1 BETWEEN ? AND ? )
2314 AND ( start2 BETWEEN lower(x) AND upper(y) )
2315 AND ( start3 BETWEEN lower(x) AND upper(?) )
2317 @bind = (1, 2, 1, 2, 'stuff');
2320 These are the two builtin "special operators"; but the
2321 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2323 =head2 Unary operators: bool
2325 If you wish to test against boolean columns or functions within your
2326 database you can use the C<-bool> and C<-not_bool> operators. For
2327 example to test the column C<is_user> being true and the column
2328 C<is_enabled> being false you would use:-
2332 -not_bool => 'is_enabled',
2337 WHERE is_user AND NOT is_enabled
2339 If a more complex combination is required, testing more conditions,
2340 then you should use the and/or operators:-
2345 -not_bool => { two=> { -rlike => 'bar' } },
2346 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2357 (NOT ( three = ? OR three > ? ))
2360 =head2 Nested conditions, -and/-or prefixes
2362 So far, we've seen how multiple conditions are joined with a top-level
2363 C<AND>. We can change this by putting the different conditions we want in
2364 hashes and then putting those hashes in an array. For example:
2369 status => { -like => ['pending%', 'dispatched'] },
2373 status => 'unassigned',
2377 This data structure would create the following:
2379 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2380 OR ( user = ? AND status = ? ) )";
2381 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2384 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2385 to change the logic inside:
2391 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2392 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2399 $stmt = "WHERE ( user = ?
2400 AND ( ( workhrs > ? AND geo = ? )
2401 OR ( workhrs < ? OR geo = ? ) ) )";
2402 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2404 =head3 Algebraic inconsistency, for historical reasons
2406 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2407 operator goes C<outside> of the nested structure; whereas when connecting
2408 several constraints on one column, the C<-and> operator goes
2409 C<inside> the arrayref. Here is an example combining both features:
2412 -and => [a => 1, b => 2],
2413 -or => [c => 3, d => 4],
2414 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2419 WHERE ( ( ( a = ? AND b = ? )
2420 OR ( c = ? OR d = ? )
2421 OR ( e LIKE ? AND e LIKE ? ) ) )
2423 This difference in syntax is unfortunate but must be preserved for
2424 historical reasons. So be careful: the two examples below would
2425 seem algebraically equivalent, but they are not
2428 { -like => 'foo%' },
2429 { -like => '%bar' },
2431 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2434 { col => { -like => 'foo%' } },
2435 { col => { -like => '%bar' } },
2437 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2440 =head2 Literal SQL and value type operators
2442 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2443 side" is a column name and the "right side" is a value (normally rendered as
2444 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2445 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2446 alter this behavior. There are several ways of doing so.
2450 This is a virtual operator that signals the string to its right side is an
2451 identifier (a column name) and not a value. For example to compare two
2452 columns you would write:
2455 priority => { '<', 2 },
2456 requestor => { -ident => 'submitter' },
2461 $stmt = "WHERE priority < ? AND requestor = submitter";
2464 If you are maintaining legacy code you may see a different construct as
2465 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2470 This is a virtual operator that signals that the construct to its right side
2471 is a value to be passed to DBI. This is for example necessary when you want
2472 to write a where clause against an array (for RDBMS that support such
2473 datatypes). For example:
2476 array => { -value => [1, 2, 3] }
2481 $stmt = 'WHERE array = ?';
2482 @bind = ([1, 2, 3]);
2484 Note that if you were to simply say:
2490 the result would probably not be what you wanted:
2492 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2497 Finally, sometimes only literal SQL will do. To include a random snippet
2498 of SQL verbatim, you specify it as a scalar reference. Consider this only
2499 as a last resort. Usually there is a better way. For example:
2502 priority => { '<', 2 },
2503 requestor => { -in => \'(SELECT name FROM hitmen)' },
2508 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2511 Note that in this example, you only get one bind parameter back, since
2512 the verbatim SQL is passed as part of the statement.
2516 Never use untrusted input as a literal SQL argument - this is a massive
2517 security risk (there is no way to check literal snippets for SQL
2518 injections and other nastyness). If you need to deal with untrusted input
2519 use literal SQL with placeholders as described next.
2521 =head3 Literal SQL with placeholders and bind values (subqueries)
2523 If the literal SQL to be inserted has placeholders and bind values,
2524 use a reference to an arrayref (yes this is a double reference --
2525 not so common, but perfectly legal Perl). For example, to find a date
2526 in Postgres you can use something like this:
2529 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2534 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2537 Note that you must pass the bind values in the same format as they are returned
2538 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2539 to C<columns>, you must provide the bind values in the
2540 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2541 scalar value; most commonly the column name, but you can use any scalar value
2542 (including references and blessed references), L<SQL::Abstract> will simply
2543 pass it through intact. So if C<bindtype> is set to C<columns> the above
2544 example will look like:
2547 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2550 Literal SQL is especially useful for nesting parenthesized clauses in the
2551 main SQL query. Here is a first example:
2553 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2557 bar => \["IN ($sub_stmt)" => @sub_bind],
2562 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2563 WHERE c2 < ? AND c3 LIKE ?))";
2564 @bind = (1234, 100, "foo%");
2566 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2567 are expressed in the same way. Of course the C<$sub_stmt> and
2568 its associated bind values can be generated through a former call
2571 my ($sub_stmt, @sub_bind)
2572 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2573 c3 => {-like => "foo%"}});
2576 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2579 In the examples above, the subquery was used as an operator on a column;
2580 but the same principle also applies for a clause within the main C<%where>
2581 hash, like an EXISTS subquery:
2583 my ($sub_stmt, @sub_bind)
2584 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2585 my %where = ( -and => [
2587 \["EXISTS ($sub_stmt)" => @sub_bind],
2592 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2593 WHERE c1 = ? AND c2 > t0.c0))";
2597 Observe that the condition on C<c2> in the subquery refers to
2598 column C<t0.c0> of the main query: this is I<not> a bind
2599 value, so we have to express it through a scalar ref.
2600 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2601 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2602 what we wanted here.
2604 Finally, here is an example where a subquery is used
2605 for expressing unary negation:
2607 my ($sub_stmt, @sub_bind)
2608 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2609 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2611 lname => {like => '%son%'},
2612 \["NOT ($sub_stmt)" => @sub_bind],
2617 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2618 @bind = ('%son%', 10, 20)
2620 =head3 Deprecated usage of Literal SQL
2622 Below are some examples of archaic use of literal SQL. It is shown only as
2623 reference for those who deal with legacy code. Each example has a much
2624 better, cleaner and safer alternative that users should opt for in new code.
2630 my %where = ( requestor => \'IS NOT NULL' )
2632 $stmt = "WHERE requestor IS NOT NULL"
2634 This used to be the way of generating NULL comparisons, before the handling
2635 of C<undef> got formalized. For new code please use the superior syntax as
2636 described in L</Tests for NULL values>.
2640 my %where = ( requestor => \'= submitter' )
2642 $stmt = "WHERE requestor = submitter"
2644 This used to be the only way to compare columns. Use the superior L</-ident>
2645 method for all new code. For example an identifier declared in such a way
2646 will be properly quoted if L</quote_char> is properly set, while the legacy
2647 form will remain as supplied.
2651 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2653 $stmt = "WHERE completed > ? AND is_ready"
2654 @bind = ('2012-12-21')
2656 Using an empty string literal used to be the only way to express a boolean.
2657 For all new code please use the much more readable
2658 L<-bool|/Unary operators: bool> operator.
2664 These pages could go on for a while, since the nesting of the data
2665 structures this module can handle are pretty much unlimited (the
2666 module implements the C<WHERE> expansion as a recursive function
2667 internally). Your best bet is to "play around" with the module a
2668 little to see how the data structures behave, and choose the best
2669 format for your data based on that.
2671 And of course, all the values above will probably be replaced with
2672 variables gotten from forms or the command line. After all, if you
2673 knew everything ahead of time, you wouldn't have to worry about
2674 dynamically-generating SQL and could just hardwire it into your
2677 =head1 ORDER BY CLAUSES
2679 Some functions take an order by clause. This can either be a scalar (just a
2680 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2681 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2684 Given | Will Generate
2685 ---------------------------------------------------------------
2687 'colA' | ORDER BY colA
2689 [qw/colA colB/] | ORDER BY colA, colB
2691 {-asc => 'colA'} | ORDER BY colA ASC
2693 {-desc => 'colB'} | ORDER BY colB DESC
2695 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2697 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2699 \'colA DESC' | ORDER BY colA DESC
2701 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2702 | /* ...with $x bound to ? */
2705 { -asc => 'colA' }, | colA ASC,
2706 { -desc => [qw/colB/] }, | colB DESC,
2707 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2708 \'colE DESC', | colE DESC,
2709 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2710 ] | /* ...with $x bound to ? */
2711 ===============================================================
2715 =head1 SPECIAL OPERATORS
2717 my $sqlmaker = SQL::Abstract->new(special_ops => [
2721 my ($self, $field, $op, $arg) = @_;
2727 handler => 'method_name',
2731 A "special operator" is a SQL syntactic clause that can be
2732 applied to a field, instead of a usual binary operator.
2735 WHERE field IN (?, ?, ?)
2736 WHERE field BETWEEN ? AND ?
2737 WHERE MATCH(field) AGAINST (?, ?)
2739 Special operators IN and BETWEEN are fairly standard and therefore
2740 are builtin within C<SQL::Abstract> (as the overridable methods
2741 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2742 like the MATCH .. AGAINST example above which is specific to MySQL,
2743 you can write your own operator handlers - supply a C<special_ops>
2744 argument to the C<new> method. That argument takes an arrayref of
2745 operator definitions; each operator definition is a hashref with two
2752 the regular expression to match the operator
2756 Either a coderef or a plain scalar method name. In both cases
2757 the expected return is C<< ($sql, @bind) >>.
2759 When supplied with a method name, it is simply called on the
2760 L<SQL::Abstract> object as:
2762 $self->$method_name($field, $op, $arg)
2766 $field is the LHS of the operator
2767 $op is the part that matched the handler regex
2770 When supplied with a coderef, it is called as:
2772 $coderef->($self, $field, $op, $arg)
2777 For example, here is an implementation
2778 of the MATCH .. AGAINST syntax for MySQL
2780 my $sqlmaker = SQL::Abstract->new(special_ops => [
2782 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2783 {regex => qr/^match$/i,
2785 my ($self, $field, $op, $arg) = @_;
2786 $arg = [$arg] if not ref $arg;
2787 my $label = $self->_quote($field);
2788 my ($placeholder) = $self->_convert('?');
2789 my $placeholders = join ", ", (($placeholder) x @$arg);
2790 my $sql = $self->_sqlcase('match') . " ($label) "
2791 . $self->_sqlcase('against') . " ($placeholders) ";
2792 my @bind = $self->_bindtype($field, @$arg);
2793 return ($sql, @bind);
2800 =head1 UNARY OPERATORS
2802 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2806 my ($self, $op, $arg) = @_;
2812 handler => 'method_name',
2816 A "unary operator" is a SQL syntactic clause that can be
2817 applied to a field - the operator goes before the field
2819 You can write your own operator handlers - supply a C<unary_ops>
2820 argument to the C<new> method. That argument takes an arrayref of
2821 operator definitions; each operator definition is a hashref with two
2828 the regular expression to match the operator
2832 Either a coderef or a plain scalar method name. In both cases
2833 the expected return is C<< $sql >>.
2835 When supplied with a method name, it is simply called on the
2836 L<SQL::Abstract> object as:
2838 $self->$method_name($op, $arg)
2842 $op is the part that matched the handler regex
2843 $arg is the RHS or argument of the operator
2845 When supplied with a coderef, it is called as:
2847 $coderef->($self, $op, $arg)
2855 Thanks to some benchmarking by Mark Stosberg, it turns out that
2856 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2857 I must admit this wasn't an intentional design issue, but it's a
2858 byproduct of the fact that you get to control your C<DBI> handles
2861 To maximize performance, use a code snippet like the following:
2863 # prepare a statement handle using the first row
2864 # and then reuse it for the rest of the rows
2866 for my $href (@array_of_hashrefs) {
2867 $stmt ||= $sql->insert('table', $href);
2868 $sth ||= $dbh->prepare($stmt);
2869 $sth->execute($sql->values($href));
2872 The reason this works is because the keys in your C<$href> are sorted
2873 internally by B<SQL::Abstract>. Thus, as long as your data retains
2874 the same structure, you only have to generate the SQL the first time
2875 around. On subsequent queries, simply use the C<values> function provided
2876 by this module to return your values in the correct order.
2878 However this depends on the values having the same type - if, for
2879 example, the values of a where clause may either have values
2880 (resulting in sql of the form C<column = ?> with a single bind
2881 value), or alternatively the values might be C<undef> (resulting in
2882 sql of the form C<column IS NULL> with no bind value) then the
2883 caching technique suggested will not work.
2887 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2888 really like this part (I do, at least). Building up a complex query
2889 can be as simple as the following:
2896 use CGI::FormBuilder;
2899 my $form = CGI::FormBuilder->new(...);
2900 my $sql = SQL::Abstract->new;
2902 if ($form->submitted) {
2903 my $field = $form->field;
2904 my $id = delete $field->{id};
2905 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2908 Of course, you would still have to connect using C<DBI> to run the
2909 query, but the point is that if you make your form look like your
2910 table, the actual query script can be extremely simplistic.
2912 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2913 a fast interface to returning and formatting data. I frequently
2914 use these three modules together to write complex database query
2915 apps in under 50 lines.
2917 =head1 HOW TO CONTRIBUTE
2919 Contributions are always welcome, in all usable forms (we especially
2920 welcome documentation improvements). The delivery methods include git-
2921 or unified-diff formatted patches, GitHub pull requests, or plain bug
2922 reports either via RT or the Mailing list. Contributors are generally
2923 granted full access to the official repository after their first several
2924 patches pass successful review.
2926 This project is maintained in a git repository. The code and related tools are
2927 accessible at the following locations:
2931 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2933 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
2935 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
2937 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
2943 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2944 Great care has been taken to preserve the I<published> behavior
2945 documented in previous versions in the 1.* family; however,
2946 some features that were previously undocumented, or behaved
2947 differently from the documentation, had to be changed in order
2948 to clarify the semantics. Hence, client code that was relying
2949 on some dark areas of C<SQL::Abstract> v1.*
2950 B<might behave differently> in v1.50.
2952 The main changes are:
2958 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
2962 support for the { operator => \"..." } construct (to embed literal SQL)
2966 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
2970 optional support for L<array datatypes|/"Inserting and Updating Arrays">
2974 defensive programming: check arguments
2978 fixed bug with global logic, which was previously implemented
2979 through global variables yielding side-effects. Prior versions would
2980 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
2981 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
2982 Now this is interpreted
2983 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
2988 fixed semantics of _bindtype on array args
2992 dropped the C<_anoncopy> of the %where tree. No longer necessary,
2993 we just avoid shifting arrays within that tree.
2997 dropped the C<_modlogic> function
3001 =head1 ACKNOWLEDGEMENTS
3003 There are a number of individuals that have really helped out with
3004 this module. Unfortunately, most of them submitted bugs via CPAN
3005 so I have no idea who they are! But the people I do know are:
3007 Ash Berlin (order_by hash term support)
3008 Matt Trout (DBIx::Class support)
3009 Mark Stosberg (benchmarking)
3010 Chas Owens (initial "IN" operator support)
3011 Philip Collins (per-field SQL functions)
3012 Eric Kolve (hashref "AND" support)
3013 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3014 Dan Kubb (support for "quote_char" and "name_sep")
3015 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3016 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3017 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3018 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3019 Oliver Charles (support for "RETURNING" after "INSERT")
3025 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3029 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3031 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3033 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3034 While not an official support venue, C<DBIx::Class> makes heavy use of
3035 C<SQL::Abstract>, and as such list members there are very familiar with
3036 how to create queries.
3040 This module is free software; you may copy this under the same
3041 terms as perl itself (either the GNU General Public License or
3042 the Artistic License)