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 };
558 sub _expand_expr_hashpair {
559 my ($self, $k, $v, $logic) = @_;
560 unless (defined($k) and length($k)) {
561 if (defined($k) and my $literal = is_literal_value($v)) {
562 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
563 return { -literal => $literal };
565 puke "Supplying an empty left hand side argument is not supported";
568 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
569 if ($k =~ s/ [_\s]? \d+ $//x ) {
570 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
571 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
574 # DBIx::Class requires a nest warning to be emitted once but the private
575 # method it overrode to do so no longer exists
576 if (ref($self) =~ /^DBIx::Class::SQLMaker/) {
577 unless ($Nest_Warned) {
579 "-nest in search conditions is deprecated, you most probably wanted:\n"
580 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
585 return $self->_expand_expr($v);
589 return $self->_expand_expr($v);
591 puke "-bool => undef not supported" unless defined($v);
592 return { -ident => $v };
595 return { -op => [ 'not', $self->_expand_expr($v) ] };
597 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
600 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
603 if (my ($logic) = $k =~ /^-(and|or)$/i) {
604 if (ref($v) eq 'HASH') {
605 return $self->_expand_expr($v, $logic);
607 if (ref($v) eq 'ARRAY') {
608 return $self->_expand_expr($v, $logic);
613 $op =~ s/^-// if length($op) > 1;
615 # top level special ops are illegal in general
616 puke "Illegal use of top-level '-$op'"
617 if List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
618 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
619 return { -op => [ $op, $v ] };
622 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
623 return +{ -bind => [ $m, $v ] };
625 if (my $custom = $self->{expand_unary}{$k}) {
626 return $self->$custom($v);
628 if ($self->{node_types}{$k}) {
634 and (keys %$v)[0] =~ /^-/
636 my ($func) = $k =~ /^-(.*)$/;
637 return +{ -func => [ $func, $self->_expand_expr($v) ] };
639 if (!ref($v) or is_literal_value($v)) {
640 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
647 and exists $v->{-value}
648 and not defined $v->{-value}
651 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
653 if (!ref($v) or Scalar::Util::blessed($v)) {
654 my $d = our $Default_Scalar_To;
659 ($d ? { $d => $v } : { -bind => [ $k, $v ] })
663 if (ref($v) eq 'HASH') {
667 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
674 $self->_assert_pass_injection_guard($vk);
675 if ($vk =~ s/ [_\s]? \d+ $//x ) {
676 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
677 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
679 if ($vk =~ /^(?:not[ _])?between$/) {
680 local our $Cur_Col_Meta = $k;
681 my @rhs = map $self->_expand_expr($_),
682 ref($vv) eq 'ARRAY' ? @$vv : $vv;
684 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
686 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
688 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
691 join(' ', split '_', $vk),
696 if ($vk =~ /^(?:not[ _])?in$/) {
697 if (my $literal = is_literal_value($vv)) {
698 my ($sql, @bind) = @$literal;
699 my $opened_sql = $self->_open_outer_paren($sql);
701 $vk, { -ident => $k },
702 [ { -literal => [ $opened_sql, @bind ] } ]
706 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
707 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
708 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
709 . 'will emit the logically correct SQL instead of raising this exception)'
711 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
713 my @rhs = map $self->_expand_expr($_),
714 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
715 map { defined($_) ? $_: puke($undef_err) }
716 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
717 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
720 join(' ', split '_', $vk),
725 if ($vk eq 'ident') {
726 if (! defined $vv or (ref($vv) and ref($vv) eq 'ARRAY')) {
727 puke "-$vk requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
735 if ($vk eq 'value') {
736 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
740 { -bind => [ $k, $vv ] }
743 if ($vk =~ /^is(?:[ _]not)?$/) {
744 puke "$vk can only take undef as argument"
748 and exists($vv->{-value})
749 and !defined($vv->{-value})
752 return +{ -op => [ $vk.' null', { -ident => $k } ] };
754 if ($vk =~ /^(and|or)$/) {
755 if (ref($vv) eq 'HASH') {
758 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
763 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{special_ops}}) {
764 return { -op => [ $vk, { -ident => $k }, $vv ] };
766 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{unary_ops}}) {
770 { -op => [ $vk, $vv ] }
773 if (ref($vv) eq 'ARRAY') {
774 my ($logic, @values) = (
775 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
780 $vk =~ $self->{inequality_op}
781 or join(' ', split '_', $vk) =~ $self->{not_like_op}
783 if (lc($logic) eq '-or' and @values > 1) {
784 my $op = uc join ' ', split '_', $vk;
785 belch "A multi-element arrayref as an argument to the inequality op '$op' "
786 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
787 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
792 # try to DWIM on equality operators
793 my $op = join ' ', split '_', $vk;
795 $op =~ $self->{equality_op} ? $self->sqlfalse
796 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
797 : $op =~ $self->{inequality_op} ? $self->sqltrue
798 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
799 : puke "operator '$op' applied on an empty array (field '$k')";
803 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
811 and exists $vv->{-value}
812 and not defined $vv->{-value}
815 my $op = join ' ', split '_', $vk;
817 $op =~ /^not$/i ? 'is not' # legacy
818 : $op =~ $self->{equality_op} ? 'is'
819 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
820 : $op =~ $self->{inequality_op} ? 'is not'
821 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
822 : puke "unexpected operator '$op' with undef operand";
823 return +{ -op => [ $is.' null', { -ident => $k } ] };
825 local our $Cur_Col_Meta = $k;
829 $self->_expand_expr($vv)
832 if (ref($v) eq 'ARRAY') {
833 return $self->sqlfalse unless @$v;
834 $self->_debug("ARRAY($k) means distribute over elements");
836 $v->[0] =~ /^-((?:and|or))$/i
837 ? ($v = [ @{$v}[1..$#$v] ], $1)
838 : ($self->{logic} || 'or')
842 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
845 if (my $literal = is_literal_value($v)) {
847 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
850 my ($sql, @bind) = @$literal;
851 if ($self->{bindtype} eq 'columns') {
853 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
854 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
858 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
864 my ($self, $expr) = @_;
865 my ($k, $v, @rest) = %$expr;
867 if (my $meth = $self->{node_types}{$k}) {
868 return $self->$meth($v);
870 die "notreached: $k";
874 my ($self, $where, $logic) = @_;
876 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
878 # Special case: top level simple string treated as literal
880 my $where_exp = (ref($where)
881 ? $self->_expand_expr($where, $logic)
882 : { -literal => [ $where ] });
884 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
886 # dispatch on appropriate method according to refkind of $where
887 # my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
889 # my ($sql, @bind) = $self->$method($where_exp, $logic);
891 my ($sql, @bind) = defined($where_exp) ? $self->_render_expr($where_exp) : (undef);
893 # DBIx::Class used to call _recurse_where in scalar context
894 # something else might too...
896 return ($sql, @bind);
899 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
905 my ($self, $ident) = @_;
907 return $self->_convert($self->_quote($ident));
911 my ($self, $value) = @_;
913 return ($self->_convert('?'), $self->_bindtype(undef, $value));
916 my %unop_postfix = map +($_ => 1),
917 'is null', 'is not null',
925 my ($self, $args) = @_;
926 my ($left, $low, $high) = @$args;
927 my ($rhsql, @rhbind) = do {
929 puke "Single arg to between must be a literal"
930 unless $low->{-literal};
933 my ($l, $h) = map [ $self->_render_expr($_) ], $low, $high;
934 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
935 @{$l}[1..$#$l], @{$h}[1..$#$h])
938 my ($lhsql, @lhbind) = $self->_render_expr($left);
940 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
944 }), 'between', 'not between'),
948 my ($self, $args) = @_;
949 my ($lhs, $rhs) = @$args;
952 my ($sql, @bind) = $self->_render_expr($_);
953 push @in_bind, @bind;
956 my ($lhsql, @lbind) = $self->_render_expr($lhs);
958 $lhsql.' '.$self->_sqlcase($op).' ( '
969 my ($op, @args) = @$v;
970 $op =~ s/^-// if length($op) > 1;
972 if (my $h = $special{$op}) {
973 return $self->$h(\@args);
975 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
976 puke "Special op '${op}' requires first value to be identifier"
977 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
978 return $self->${\($us->{handler})}($k, $op, $args[1]);
980 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
981 return $self->${\($us->{handler})}($op, $args[0]);
983 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
984 if (@args == 1 and $op !~ /^(and|or)$/) {
985 my ($expr_sql, @bind) = $self->_render_expr($args[0]);
986 my $op_sql = $self->_sqlcase($final_op);
988 $unop_postfix{lc($final_op)}
989 ? "${expr_sql} ${op_sql}"
990 : "${op_sql} ${expr_sql}"
992 return (($op eq 'not' ? '('.$final_sql.')' : $final_sql), @bind);
994 my @parts = map [ $self->_render_expr($_) ], @args;
995 my ($final_sql) = map +($op =~ /^(and|or)$/ ? "(${_})" : $_), join(
996 ($final_op eq ',' ? '' : ' ').$self->_sqlcase($final_op).' ',
1001 map @{$_}[1..$#$_], @parts
1008 my ($self, $rest) = @_;
1009 my ($func, @args) = @$rest;
1013 push @arg_sql, shift @x;
1015 } map [ $self->_render_expr($_) ], @args;
1016 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1020 my ($self, $bind) = @_;
1021 return ($self->_convert('?'), $self->_bindtype(@$bind));
1024 sub _render_literal {
1025 my ($self, $literal) = @_;
1026 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1030 # Some databases (SQLite) treat col IN (1, 2) different from
1031 # col IN ( (1, 2) ). Use this to strip all outer parens while
1032 # adding them back in the corresponding method
1033 sub _open_outer_paren {
1034 my ($self, $sql) = @_;
1036 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1038 # there are closing parens inside, need the heavy duty machinery
1039 # to reevaluate the extraction starting from $sql (full reevaluation)
1040 if ($inner =~ /\)/) {
1041 require Text::Balanced;
1043 my (undef, $remainder) = do {
1044 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1046 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1049 # the entire expression needs to be a balanced bracketed thing
1050 # (after an extract no remainder sans trailing space)
1051 last if defined $remainder and $remainder =~ /\S/;
1061 #======================================================================
1063 #======================================================================
1065 sub _expand_order_by {
1066 my ($self, $arg) = @_;
1068 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1070 my $expander = sub {
1071 my ($self, $dir, $expr) = @_;
1072 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1073 foreach my $arg (@to_expand) {
1077 and grep /^-(asc|desc)$/, keys %$arg
1079 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1082 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1083 map $self->_expand_expr($_, undef, -ident),
1084 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1085 return (@exp > 1 ? { -op => [ ',', @exp ] } : $exp[0]);
1088 local @{$self->{expand_unary}}{qw(-asc -desc)} = (
1089 sub { shift->$expander(asc => @_) },
1090 sub { shift->$expander(desc => @_) },
1093 return $self->$expander(undef, $arg);
1097 my ($self, $arg) = @_;
1099 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1101 my ($sql, @bind) = $self->_render_expr($expanded);
1103 my $final_sql = $self->_sqlcase(' order by ').$sql;
1105 return wantarray ? ($final_sql, @bind) : $final_sql;
1108 sub _order_by_chunks {
1109 my ($self, $arg) = @_;
1111 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1114 if (ref() eq 'HASH' and my $op = $_->{-op}) {
1115 if ($op->[0] eq ',') {
1116 return map [ $self->_render_expr($_) ], @{$op}[1..$#$op];
1119 return [ $self->_render_expr($_) ];
1123 #======================================================================
1124 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1125 #======================================================================
1130 ($self->_render_expr(
1131 $self->_expand_maybe_list_expr($from, undef, -ident)
1136 #======================================================================
1138 #======================================================================
1140 sub _expand_maybe_list_expr {
1141 my ($self, $expr, $logic, $default) = @_;
1143 if (ref($expr) eq 'ARRAY') {
1145 ',', map $self->_expand_expr($_, $logic, $default), @$expr
1152 return $self->_expand_expr($e, $logic, $default);
1155 # highly optimized, as it's called way too often
1157 # my ($self, $label) = @_;
1159 return '' unless defined $_[1];
1160 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1161 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1163 unless ($_[0]->{quote_char}) {
1164 if (ref($_[1]) eq 'ARRAY') {
1165 return join($_[0]->{name_sep}||'.', @{$_[1]});
1167 $_[0]->_assert_pass_injection_guard($_[1]);
1172 my $qref = ref $_[0]->{quote_char};
1174 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1175 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1176 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1178 my $esc = $_[0]->{escape_char} || $r;
1180 # parts containing * are naturally unquoted
1182 $_[0]->{name_sep}||'',
1186 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1188 (ref($_[1]) eq 'ARRAY'
1192 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1200 # Conversion, if applicable
1202 #my ($self, $arg) = @_;
1203 if ($_[0]->{convert_where}) {
1204 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1211 #my ($self, $col, @vals) = @_;
1212 # called often - tighten code
1213 return $_[0]->{bindtype} eq 'columns'
1214 ? map {[$_[1], $_]} @_[2 .. $#_]
1219 # Dies if any element of @bind is not in [colname => value] format
1220 # if bindtype is 'columns'.
1221 sub _assert_bindval_matches_bindtype {
1222 # my ($self, @bind) = @_;
1224 if ($self->{bindtype} eq 'columns') {
1226 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1227 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1233 sub _join_sql_clauses {
1234 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1236 if (@$clauses_aref > 1) {
1237 my $join = " " . $self->_sqlcase($logic) . " ";
1238 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1239 return ($sql, @$bind_aref);
1241 elsif (@$clauses_aref) {
1242 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1245 return (); # if no SQL, ignore @$bind_aref
1250 # Fix SQL case, if so requested
1252 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1253 # don't touch the argument ... crooked logic, but let's not change it!
1254 return $_[0]->{case} ? $_[1] : uc($_[1]);
1258 #======================================================================
1259 # DISPATCHING FROM REFKIND
1260 #======================================================================
1263 my ($self, $data) = @_;
1265 return 'UNDEF' unless defined $data;
1267 # blessed objects are treated like scalars
1268 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1270 return 'SCALAR' unless $ref;
1273 while ($ref eq 'REF') {
1275 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1279 return ($ref||'SCALAR') . ('REF' x $n_steps);
1283 my ($self, $data) = @_;
1284 my @try = ($self->_refkind($data));
1285 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1286 push @try, 'FALLBACK';
1290 sub _METHOD_FOR_refkind {
1291 my ($self, $meth_prefix, $data) = @_;
1294 for (@{$self->_try_refkind($data)}) {
1295 $method = $self->can($meth_prefix."_".$_)
1299 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1303 sub _SWITCH_refkind {
1304 my ($self, $data, $dispatch_table) = @_;
1307 for (@{$self->_try_refkind($data)}) {
1308 $coderef = $dispatch_table->{$_}
1312 puke "no dispatch entry for ".$self->_refkind($data)
1321 #======================================================================
1322 # VALUES, GENERATE, AUTOLOAD
1323 #======================================================================
1325 # LDNOTE: original code from nwiger, didn't touch code in that section
1326 # I feel the AUTOLOAD stuff should not be the default, it should
1327 # only be activated on explicit demand by user.
1331 my $data = shift || return;
1332 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1333 unless ref $data eq 'HASH';
1336 foreach my $k (sort keys %$data) {
1337 my $v = $data->{$k};
1338 $self->_SWITCH_refkind($v, {
1340 if ($self->{array_datatypes}) { # array datatype
1341 push @all_bind, $self->_bindtype($k, $v);
1343 else { # literal SQL with bind
1344 my ($sql, @bind) = @$v;
1345 $self->_assert_bindval_matches_bindtype(@bind);
1346 push @all_bind, @bind;
1349 ARRAYREFREF => sub { # literal SQL with bind
1350 my ($sql, @bind) = @${$v};
1351 $self->_assert_bindval_matches_bindtype(@bind);
1352 push @all_bind, @bind;
1354 SCALARREF => sub { # literal SQL without bind
1356 SCALAR_or_UNDEF => sub {
1357 push @all_bind, $self->_bindtype($k, $v);
1368 my(@sql, @sqlq, @sqlv);
1372 if ($ref eq 'HASH') {
1373 for my $k (sort keys %$_) {
1376 my $label = $self->_quote($k);
1377 if ($r eq 'ARRAY') {
1378 # literal SQL with bind
1379 my ($sql, @bind) = @$v;
1380 $self->_assert_bindval_matches_bindtype(@bind);
1381 push @sqlq, "$label = $sql";
1383 } elsif ($r eq 'SCALAR') {
1384 # literal SQL without bind
1385 push @sqlq, "$label = $$v";
1387 push @sqlq, "$label = ?";
1388 push @sqlv, $self->_bindtype($k, $v);
1391 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1392 } elsif ($ref eq 'ARRAY') {
1393 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1396 if ($r eq 'ARRAY') { # literal SQL with bind
1397 my ($sql, @bind) = @$v;
1398 $self->_assert_bindval_matches_bindtype(@bind);
1401 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1402 # embedded literal SQL
1409 push @sql, '(' . join(', ', @sqlq) . ')';
1410 } elsif ($ref eq 'SCALAR') {
1414 # strings get case twiddled
1415 push @sql, $self->_sqlcase($_);
1419 my $sql = join ' ', @sql;
1421 # this is pretty tricky
1422 # if ask for an array, return ($stmt, @bind)
1423 # otherwise, s/?/shift @sqlv/ to put it inline
1425 return ($sql, @sqlv);
1427 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1428 ref $d ? $d->[1] : $d/e;
1437 # This allows us to check for a local, then _form, attr
1439 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1440 return $self->generate($name, @_);
1451 SQL::Abstract - Generate SQL from Perl data structures
1457 my $sql = SQL::Abstract->new;
1459 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1461 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1463 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1465 my($stmt, @bind) = $sql->delete($table, \%where);
1467 # Then, use these in your DBI statements
1468 my $sth = $dbh->prepare($stmt);
1469 $sth->execute(@bind);
1471 # Just generate the WHERE clause
1472 my($stmt, @bind) = $sql->where(\%where, $order);
1474 # Return values in the same order, for hashed queries
1475 # See PERFORMANCE section for more details
1476 my @bind = $sql->values(\%fieldvals);
1480 This module was inspired by the excellent L<DBIx::Abstract>.
1481 However, in using that module I found that what I really wanted
1482 to do was generate SQL, but still retain complete control over my
1483 statement handles and use the DBI interface. So, I set out to
1484 create an abstract SQL generation module.
1486 While based on the concepts used by L<DBIx::Abstract>, there are
1487 several important differences, especially when it comes to WHERE
1488 clauses. I have modified the concepts used to make the SQL easier
1489 to generate from Perl data structures and, IMO, more intuitive.
1490 The underlying idea is for this module to do what you mean, based
1491 on the data structures you provide it. The big advantage is that
1492 you don't have to modify your code every time your data changes,
1493 as this module figures it out.
1495 To begin with, an SQL INSERT is as easy as just specifying a hash
1496 of C<key=value> pairs:
1499 name => 'Jimbo Bobson',
1500 phone => '123-456-7890',
1501 address => '42 Sister Lane',
1502 city => 'St. Louis',
1503 state => 'Louisiana',
1506 The SQL can then be generated with this:
1508 my($stmt, @bind) = $sql->insert('people', \%data);
1510 Which would give you something like this:
1512 $stmt = "INSERT INTO people
1513 (address, city, name, phone, state)
1514 VALUES (?, ?, ?, ?, ?)";
1515 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1516 '123-456-7890', 'Louisiana');
1518 These are then used directly in your DBI code:
1520 my $sth = $dbh->prepare($stmt);
1521 $sth->execute(@bind);
1523 =head2 Inserting and Updating Arrays
1525 If your database has array types (like for example Postgres),
1526 activate the special option C<< array_datatypes => 1 >>
1527 when creating the C<SQL::Abstract> object.
1528 Then you may use an arrayref to insert and update database array types:
1530 my $sql = SQL::Abstract->new(array_datatypes => 1);
1532 planets => [qw/Mercury Venus Earth Mars/]
1535 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1539 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1541 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1544 =head2 Inserting and Updating SQL
1546 In order to apply SQL functions to elements of your C<%data> you may
1547 specify a reference to an arrayref for the given hash value. For example,
1548 if you need to execute the Oracle C<to_date> function on a value, you can
1549 say something like this:
1553 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1556 The first value in the array is the actual SQL. Any other values are
1557 optional and would be included in the bind values array. This gives
1560 my($stmt, @bind) = $sql->insert('people', \%data);
1562 $stmt = "INSERT INTO people (name, date_entered)
1563 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1564 @bind = ('Bill', '03/02/2003');
1566 An UPDATE is just as easy, all you change is the name of the function:
1568 my($stmt, @bind) = $sql->update('people', \%data);
1570 Notice that your C<%data> isn't touched; the module will generate
1571 the appropriately quirky SQL for you automatically. Usually you'll
1572 want to specify a WHERE clause for your UPDATE, though, which is
1573 where handling C<%where> hashes comes in handy...
1575 =head2 Complex where statements
1577 This module can generate pretty complicated WHERE statements
1578 easily. For example, simple C<key=value> pairs are taken to mean
1579 equality, and if you want to see if a field is within a set
1580 of values, you can use an arrayref. Let's say we wanted to
1581 SELECT some data based on this criteria:
1584 requestor => 'inna',
1585 worker => ['nwiger', 'rcwe', 'sfz'],
1586 status => { '!=', 'completed' }
1589 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1591 The above would give you something like this:
1593 $stmt = "SELECT * FROM tickets WHERE
1594 ( requestor = ? ) AND ( status != ? )
1595 AND ( worker = ? OR worker = ? OR worker = ? )";
1596 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1598 Which you could then use in DBI code like so:
1600 my $sth = $dbh->prepare($stmt);
1601 $sth->execute(@bind);
1607 The methods are simple. There's one for every major SQL operation,
1608 and a constructor you use first. The arguments are specified in a
1609 similar order for each method (table, then fields, then a where
1610 clause) to try and simplify things.
1612 =head2 new(option => 'value')
1614 The C<new()> function takes a list of options and values, and returns
1615 a new B<SQL::Abstract> object which can then be used to generate SQL
1616 through the methods below. The options accepted are:
1622 If set to 'lower', then SQL will be generated in all lowercase. By
1623 default SQL is generated in "textbook" case meaning something like:
1625 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1627 Any setting other than 'lower' is ignored.
1631 This determines what the default comparison operator is. By default
1632 it is C<=>, meaning that a hash like this:
1634 %where = (name => 'nwiger', email => 'nate@wiger.org');
1636 Will generate SQL like this:
1638 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1640 However, you may want loose comparisons by default, so if you set
1641 C<cmp> to C<like> you would get SQL such as:
1643 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1645 You can also override the comparison on an individual basis - see
1646 the huge section on L</"WHERE CLAUSES"> at the bottom.
1648 =item sqltrue, sqlfalse
1650 Expressions for inserting boolean values within SQL statements.
1651 By default these are C<1=1> and C<1=0>. They are used
1652 by the special operators C<-in> and C<-not_in> for generating
1653 correct SQL even when the argument is an empty array (see below).
1657 This determines the default logical operator for multiple WHERE
1658 statements in arrays or hashes. If absent, the default logic is "or"
1659 for arrays, and "and" for hashes. This means that a WHERE
1663 event_date => {'>=', '2/13/99'},
1664 event_date => {'<=', '4/24/03'},
1667 will generate SQL like this:
1669 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1671 This is probably not what you want given this query, though (look
1672 at the dates). To change the "OR" to an "AND", simply specify:
1674 my $sql = SQL::Abstract->new(logic => 'and');
1676 Which will change the above C<WHERE> to:
1678 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1680 The logic can also be changed locally by inserting
1681 a modifier in front of an arrayref:
1683 @where = (-and => [event_date => {'>=', '2/13/99'},
1684 event_date => {'<=', '4/24/03'} ]);
1686 See the L</"WHERE CLAUSES"> section for explanations.
1690 This will automatically convert comparisons using the specified SQL
1691 function for both column and value. This is mostly used with an argument
1692 of C<upper> or C<lower>, so that the SQL will have the effect of
1693 case-insensitive "searches". For example, this:
1695 $sql = SQL::Abstract->new(convert => 'upper');
1696 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1698 Will turn out the following SQL:
1700 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1702 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1703 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1704 not validate this option; it will just pass through what you specify verbatim).
1708 This is a kludge because many databases suck. For example, you can't
1709 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1710 Instead, you have to use C<bind_param()>:
1712 $sth->bind_param(1, 'reg data');
1713 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1715 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1716 which loses track of which field each slot refers to. Fear not.
1718 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1719 Currently, you can specify either C<normal> (default) or C<columns>. If you
1720 specify C<columns>, you will get an array that looks like this:
1722 my $sql = SQL::Abstract->new(bindtype => 'columns');
1723 my($stmt, @bind) = $sql->insert(...);
1726 [ 'column1', 'value1' ],
1727 [ 'column2', 'value2' ],
1728 [ 'column3', 'value3' ],
1731 You can then iterate through this manually, using DBI's C<bind_param()>.
1733 $sth->prepare($stmt);
1736 my($col, $data) = @$_;
1737 if ($col eq 'details' || $col eq 'comments') {
1738 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1739 } elsif ($col eq 'image') {
1740 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1742 $sth->bind_param($i, $data);
1746 $sth->execute; # execute without @bind now
1748 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1749 Basically, the advantage is still that you don't have to care which fields
1750 are or are not included. You could wrap that above C<for> loop in a simple
1751 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1752 get a layer of abstraction over manual SQL specification.
1754 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1755 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1756 will expect the bind values in this format.
1760 This is the character that a table or column name will be quoted
1761 with. By default this is an empty string, but you could set it to
1762 the character C<`>, to generate SQL like this:
1764 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1766 Alternatively, you can supply an array ref of two items, the first being the left
1767 hand quote character, and the second the right hand quote character. For
1768 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1769 that generates SQL like this:
1771 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1773 Quoting is useful if you have tables or columns names that are reserved
1774 words in your database's SQL dialect.
1778 This is the character that will be used to escape L</quote_char>s appearing
1779 in an identifier before it has been quoted.
1781 The parameter default in case of a single L</quote_char> character is the quote
1784 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1785 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1786 of the B<opening (left)> L</quote_char> within the identifier are currently left
1787 untouched. The default for opening-closing-style quotes may change in future
1788 versions, thus you are B<strongly encouraged> to specify the escape character
1793 This is the character that separates a table and column name. It is
1794 necessary to specify this when the C<quote_char> option is selected,
1795 so that tables and column names can be individually quoted like this:
1797 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1799 =item injection_guard
1801 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1802 column name specified in a query structure. This is a safety mechanism to avoid
1803 injection attacks when mishandling user input e.g.:
1805 my %condition_as_column_value_pairs = get_values_from_user();
1806 $sqla->select( ... , \%condition_as_column_value_pairs );
1808 If the expression matches an exception is thrown. Note that literal SQL
1809 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1811 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1813 =item array_datatypes
1815 When this option is true, arrayrefs in INSERT or UPDATE are
1816 interpreted as array datatypes and are passed directly
1818 When this option is false, arrayrefs are interpreted
1819 as literal SQL, just like refs to arrayrefs
1820 (but this behavior is for backwards compatibility; when writing
1821 new queries, use the "reference to arrayref" syntax
1827 Takes a reference to a list of "special operators"
1828 to extend the syntax understood by L<SQL::Abstract>.
1829 See section L</"SPECIAL OPERATORS"> for details.
1833 Takes a reference to a list of "unary operators"
1834 to extend the syntax understood by L<SQL::Abstract>.
1835 See section L</"UNARY OPERATORS"> for details.
1841 =head2 insert($table, \@values || \%fieldvals, \%options)
1843 This is the simplest function. You simply give it a table name
1844 and either an arrayref of values or hashref of field/value pairs.
1845 It returns an SQL INSERT statement and a list of bind values.
1846 See the sections on L</"Inserting and Updating Arrays"> and
1847 L</"Inserting and Updating SQL"> for information on how to insert
1848 with those data types.
1850 The optional C<\%options> hash reference may contain additional
1851 options to generate the insert SQL. Currently supported options
1858 Takes either a scalar of raw SQL fields, or an array reference of
1859 field names, and adds on an SQL C<RETURNING> statement at the end.
1860 This allows you to return data generated by the insert statement
1861 (such as row IDs) without performing another C<SELECT> statement.
1862 Note, however, this is not part of the SQL standard and may not
1863 be supported by all database engines.
1867 =head2 update($table, \%fieldvals, \%where, \%options)
1869 This takes a table, hashref of field/value pairs, and an optional
1870 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1872 See the sections on L</"Inserting and Updating Arrays"> and
1873 L</"Inserting and Updating SQL"> for information on how to insert
1874 with those data types.
1876 The optional C<\%options> hash reference may contain additional
1877 options to generate the update SQL. Currently supported options
1884 See the C<returning> option to
1885 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1889 =head2 select($source, $fields, $where, $order)
1891 This returns a SQL SELECT statement and associated list of bind values, as
1892 specified by the arguments:
1898 Specification of the 'FROM' part of the statement.
1899 The argument can be either a plain scalar (interpreted as a table
1900 name, will be quoted), or an arrayref (interpreted as a list
1901 of table names, joined by commas, quoted), or a scalarref
1902 (literal SQL, not quoted).
1906 Specification of the list of fields to retrieve from
1908 The argument can be either an arrayref (interpreted as a list
1909 of field names, will be joined by commas and quoted), or a
1910 plain scalar (literal SQL, not quoted).
1911 Please observe that this API is not as flexible as that of
1912 the first argument C<$source>, for backwards compatibility reasons.
1916 Optional argument to specify the WHERE part of the query.
1917 The argument is most often a hashref, but can also be
1918 an arrayref or plain scalar --
1919 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1923 Optional argument to specify the ORDER BY part of the query.
1924 The argument can be a scalar, a hashref or an arrayref
1925 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1931 =head2 delete($table, \%where, \%options)
1933 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1934 It returns an SQL DELETE statement and list of bind values.
1936 The optional C<\%options> hash reference may contain additional
1937 options to generate the delete SQL. Currently supported options
1944 See the C<returning> option to
1945 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1949 =head2 where(\%where, $order)
1951 This is used to generate just the WHERE clause. For example,
1952 if you have an arbitrary data structure and know what the
1953 rest of your SQL is going to look like, but want an easy way
1954 to produce a WHERE clause, use this. It returns an SQL WHERE
1955 clause and list of bind values.
1958 =head2 values(\%data)
1960 This just returns the values from the hash C<%data>, in the same
1961 order that would be returned from any of the other above queries.
1962 Using this allows you to markedly speed up your queries if you
1963 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1965 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1967 Warning: This is an experimental method and subject to change.
1969 This returns arbitrarily generated SQL. It's a really basic shortcut.
1970 It will return two different things, depending on return context:
1972 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
1973 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
1975 These would return the following:
1977 # First calling form
1978 $stmt = "CREATE TABLE test (?, ?)";
1979 @bind = (field1, field2);
1981 # Second calling form
1982 $stmt_and_val = "CREATE TABLE test (field1, field2)";
1984 Depending on what you're trying to do, it's up to you to choose the correct
1985 format. In this example, the second form is what you would want.
1989 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
1993 ALTER SESSION SET nls_date_format = 'MM/YY'
1995 You get the idea. Strings get their case twiddled, but everything
1996 else remains verbatim.
1998 =head1 EXPORTABLE FUNCTIONS
2000 =head2 is_plain_value
2002 Determines if the supplied argument is a plain value as understood by this
2007 =item * The value is C<undef>
2009 =item * The value is a non-reference
2011 =item * The value is an object with stringification overloading
2013 =item * The value is of the form C<< { -value => $anything } >>
2017 On failure returns C<undef>, on success returns a B<scalar> reference
2018 to the original supplied argument.
2024 The stringification overloading detection is rather advanced: it takes
2025 into consideration not only the presence of a C<""> overload, but if that
2026 fails also checks for enabled
2027 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2028 on either C<0+> or C<bool>.
2030 Unfortunately testing in the field indicates that this
2031 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2032 but only when very large numbers of stringifying objects are involved.
2033 At the time of writing ( Sep 2014 ) there is no clear explanation of
2034 the direct cause, nor is there a manageably small test case that reliably
2035 reproduces the problem.
2037 If you encounter any of the following exceptions in B<random places within
2038 your application stack> - this module may be to blame:
2040 Operation "ne": no method found,
2041 left argument in overloaded package <something>,
2042 right argument in overloaded package <something>
2046 Stub found while resolving method "???" overloading """" in package <something>
2048 If you fall victim to the above - please attempt to reduce the problem
2049 to something that could be sent to the L<SQL::Abstract developers
2050 |DBIx::Class/GETTING HELP/SUPPORT>
2051 (either publicly or privately). As a workaround in the meantime you can
2052 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2053 value, which will most likely eliminate your problem (at the expense of
2054 not being able to properly detect exotic forms of stringification).
2056 This notice and environment variable will be removed in a future version,
2057 as soon as the underlying problem is found and a reliable workaround is
2062 =head2 is_literal_value
2064 Determines if the supplied argument is a literal value as understood by this
2069 =item * C<\$sql_string>
2071 =item * C<\[ $sql_string, @bind_values ]>
2075 On failure returns C<undef>, on success returns an B<array> reference
2076 containing the unpacked version of the supplied literal SQL and bind values.
2078 =head1 WHERE CLAUSES
2082 This module uses a variation on the idea from L<DBIx::Abstract>. It
2083 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2084 module is that things in arrays are OR'ed, and things in hashes
2087 The easiest way to explain is to show lots of examples. After
2088 each C<%where> hash shown, it is assumed you used:
2090 my($stmt, @bind) = $sql->where(\%where);
2092 However, note that the C<%where> hash can be used directly in any
2093 of the other functions as well, as described above.
2095 =head2 Key-value pairs
2097 So, let's get started. To begin, a simple hash:
2101 status => 'completed'
2104 Is converted to SQL C<key = val> statements:
2106 $stmt = "WHERE user = ? AND status = ?";
2107 @bind = ('nwiger', 'completed');
2109 One common thing I end up doing is having a list of values that
2110 a field can be in. To do this, simply specify a list inside of
2115 status => ['assigned', 'in-progress', 'pending'];
2118 This simple code will create the following:
2120 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2121 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2123 A field associated to an empty arrayref will be considered a
2124 logical false and will generate 0=1.
2126 =head2 Tests for NULL values
2128 If the value part is C<undef> then this is converted to SQL <IS NULL>
2137 $stmt = "WHERE user = ? AND status IS NULL";
2140 To test if a column IS NOT NULL:
2144 status => { '!=', undef },
2147 =head2 Specific comparison operators
2149 If you want to specify a different type of operator for your comparison,
2150 you can use a hashref for a given column:
2154 status => { '!=', 'completed' }
2157 Which would generate:
2159 $stmt = "WHERE user = ? AND status != ?";
2160 @bind = ('nwiger', 'completed');
2162 To test against multiple values, just enclose the values in an arrayref:
2164 status => { '=', ['assigned', 'in-progress', 'pending'] };
2166 Which would give you:
2168 "WHERE status = ? OR status = ? OR status = ?"
2171 The hashref can also contain multiple pairs, in which case it is expanded
2172 into an C<AND> of its elements:
2176 status => { '!=', 'completed', -not_like => 'pending%' }
2179 # Or more dynamically, like from a form
2180 $where{user} = 'nwiger';
2181 $where{status}{'!='} = 'completed';
2182 $where{status}{'-not_like'} = 'pending%';
2184 # Both generate this
2185 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2186 @bind = ('nwiger', 'completed', 'pending%');
2189 To get an OR instead, you can combine it with the arrayref idea:
2193 priority => [ { '=', 2 }, { '>', 5 } ]
2196 Which would generate:
2198 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2199 @bind = ('2', '5', 'nwiger');
2201 If you want to include literal SQL (with or without bind values), just use a
2202 scalar reference or reference to an arrayref as the value:
2205 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2206 date_expires => { '<' => \"now()" }
2209 Which would generate:
2211 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2212 @bind = ('11/26/2008');
2215 =head2 Logic and nesting operators
2217 In the example above,
2218 there is a subtle trap if you want to say something like
2219 this (notice the C<AND>):
2221 WHERE priority != ? AND priority != ?
2223 Because, in Perl you I<can't> do this:
2225 priority => { '!=' => 2, '!=' => 1 }
2227 As the second C<!=> key will obliterate the first. The solution
2228 is to use the special C<-modifier> form inside an arrayref:
2230 priority => [ -and => {'!=', 2},
2234 Normally, these would be joined by C<OR>, but the modifier tells it
2235 to use C<AND> instead. (Hint: You can use this in conjunction with the
2236 C<logic> option to C<new()> in order to change the way your queries
2237 work by default.) B<Important:> Note that the C<-modifier> goes
2238 B<INSIDE> the arrayref, as an extra first element. This will
2239 B<NOT> do what you think it might:
2241 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2243 Here is a quick list of equivalencies, since there is some overlap:
2246 status => {'!=', 'completed', 'not like', 'pending%' }
2247 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2250 status => {'=', ['assigned', 'in-progress']}
2251 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2252 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2256 =head2 Special operators: IN, BETWEEN, etc.
2258 You can also use the hashref format to compare a list of fields using the
2259 C<IN> comparison operator, by specifying the list as an arrayref:
2262 status => 'completed',
2263 reportid => { -in => [567, 2335, 2] }
2266 Which would generate:
2268 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2269 @bind = ('completed', '567', '2335', '2');
2271 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2274 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2275 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2276 'sqltrue' (by default: C<1=1>).
2278 In addition to the array you can supply a chunk of literal sql or
2279 literal sql with bind:
2282 customer => { -in => \[
2283 'SELECT cust_id FROM cust WHERE balance > ?',
2286 status => { -in => \'SELECT status_codes FROM states' },
2292 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2293 AND status IN ( SELECT status_codes FROM states )
2297 Finally, if the argument to C<-in> is not a reference, it will be
2298 treated as a single-element array.
2300 Another pair of operators is C<-between> and C<-not_between>,
2301 used with an arrayref of two values:
2305 completion_date => {
2306 -not_between => ['2002-10-01', '2003-02-06']
2312 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2314 Just like with C<-in> all plausible combinations of literal SQL
2318 start0 => { -between => [ 1, 2 ] },
2319 start1 => { -between => \["? AND ?", 1, 2] },
2320 start2 => { -between => \"lower(x) AND upper(y)" },
2321 start3 => { -between => [
2323 \["upper(?)", 'stuff' ],
2330 ( start0 BETWEEN ? AND ? )
2331 AND ( start1 BETWEEN ? AND ? )
2332 AND ( start2 BETWEEN lower(x) AND upper(y) )
2333 AND ( start3 BETWEEN lower(x) AND upper(?) )
2335 @bind = (1, 2, 1, 2, 'stuff');
2338 These are the two builtin "special operators"; but the
2339 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2341 =head2 Unary operators: bool
2343 If you wish to test against boolean columns or functions within your
2344 database you can use the C<-bool> and C<-not_bool> operators. For
2345 example to test the column C<is_user> being true and the column
2346 C<is_enabled> being false you would use:-
2350 -not_bool => 'is_enabled',
2355 WHERE is_user AND NOT is_enabled
2357 If a more complex combination is required, testing more conditions,
2358 then you should use the and/or operators:-
2363 -not_bool => { two=> { -rlike => 'bar' } },
2364 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2375 (NOT ( three = ? OR three > ? ))
2378 =head2 Nested conditions, -and/-or prefixes
2380 So far, we've seen how multiple conditions are joined with a top-level
2381 C<AND>. We can change this by putting the different conditions we want in
2382 hashes and then putting those hashes in an array. For example:
2387 status => { -like => ['pending%', 'dispatched'] },
2391 status => 'unassigned',
2395 This data structure would create the following:
2397 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2398 OR ( user = ? AND status = ? ) )";
2399 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2402 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2403 to change the logic inside:
2409 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2410 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2417 $stmt = "WHERE ( user = ?
2418 AND ( ( workhrs > ? AND geo = ? )
2419 OR ( workhrs < ? OR geo = ? ) ) )";
2420 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2422 =head3 Algebraic inconsistency, for historical reasons
2424 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2425 operator goes C<outside> of the nested structure; whereas when connecting
2426 several constraints on one column, the C<-and> operator goes
2427 C<inside> the arrayref. Here is an example combining both features:
2430 -and => [a => 1, b => 2],
2431 -or => [c => 3, d => 4],
2432 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2437 WHERE ( ( ( a = ? AND b = ? )
2438 OR ( c = ? OR d = ? )
2439 OR ( e LIKE ? AND e LIKE ? ) ) )
2441 This difference in syntax is unfortunate but must be preserved for
2442 historical reasons. So be careful: the two examples below would
2443 seem algebraically equivalent, but they are not
2446 { -like => 'foo%' },
2447 { -like => '%bar' },
2449 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2452 { col => { -like => 'foo%' } },
2453 { col => { -like => '%bar' } },
2455 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2458 =head2 Literal SQL and value type operators
2460 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2461 side" is a column name and the "right side" is a value (normally rendered as
2462 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2463 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2464 alter this behavior. There are several ways of doing so.
2468 This is a virtual operator that signals the string to its right side is an
2469 identifier (a column name) and not a value. For example to compare two
2470 columns you would write:
2473 priority => { '<', 2 },
2474 requestor => { -ident => 'submitter' },
2479 $stmt = "WHERE priority < ? AND requestor = submitter";
2482 If you are maintaining legacy code you may see a different construct as
2483 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2488 This is a virtual operator that signals that the construct to its right side
2489 is a value to be passed to DBI. This is for example necessary when you want
2490 to write a where clause against an array (for RDBMS that support such
2491 datatypes). For example:
2494 array => { -value => [1, 2, 3] }
2499 $stmt = 'WHERE array = ?';
2500 @bind = ([1, 2, 3]);
2502 Note that if you were to simply say:
2508 the result would probably not be what you wanted:
2510 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2515 Finally, sometimes only literal SQL will do. To include a random snippet
2516 of SQL verbatim, you specify it as a scalar reference. Consider this only
2517 as a last resort. Usually there is a better way. For example:
2520 priority => { '<', 2 },
2521 requestor => { -in => \'(SELECT name FROM hitmen)' },
2526 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2529 Note that in this example, you only get one bind parameter back, since
2530 the verbatim SQL is passed as part of the statement.
2534 Never use untrusted input as a literal SQL argument - this is a massive
2535 security risk (there is no way to check literal snippets for SQL
2536 injections and other nastyness). If you need to deal with untrusted input
2537 use literal SQL with placeholders as described next.
2539 =head3 Literal SQL with placeholders and bind values (subqueries)
2541 If the literal SQL to be inserted has placeholders and bind values,
2542 use a reference to an arrayref (yes this is a double reference --
2543 not so common, but perfectly legal Perl). For example, to find a date
2544 in Postgres you can use something like this:
2547 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2552 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2555 Note that you must pass the bind values in the same format as they are returned
2556 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2557 to C<columns>, you must provide the bind values in the
2558 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2559 scalar value; most commonly the column name, but you can use any scalar value
2560 (including references and blessed references), L<SQL::Abstract> will simply
2561 pass it through intact. So if C<bindtype> is set to C<columns> the above
2562 example will look like:
2565 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2568 Literal SQL is especially useful for nesting parenthesized clauses in the
2569 main SQL query. Here is a first example:
2571 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2575 bar => \["IN ($sub_stmt)" => @sub_bind],
2580 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2581 WHERE c2 < ? AND c3 LIKE ?))";
2582 @bind = (1234, 100, "foo%");
2584 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2585 are expressed in the same way. Of course the C<$sub_stmt> and
2586 its associated bind values can be generated through a former call
2589 my ($sub_stmt, @sub_bind)
2590 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2591 c3 => {-like => "foo%"}});
2594 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2597 In the examples above, the subquery was used as an operator on a column;
2598 but the same principle also applies for a clause within the main C<%where>
2599 hash, like an EXISTS subquery:
2601 my ($sub_stmt, @sub_bind)
2602 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2603 my %where = ( -and => [
2605 \["EXISTS ($sub_stmt)" => @sub_bind],
2610 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2611 WHERE c1 = ? AND c2 > t0.c0))";
2615 Observe that the condition on C<c2> in the subquery refers to
2616 column C<t0.c0> of the main query: this is I<not> a bind
2617 value, so we have to express it through a scalar ref.
2618 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2619 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2620 what we wanted here.
2622 Finally, here is an example where a subquery is used
2623 for expressing unary negation:
2625 my ($sub_stmt, @sub_bind)
2626 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2627 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2629 lname => {like => '%son%'},
2630 \["NOT ($sub_stmt)" => @sub_bind],
2635 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2636 @bind = ('%son%', 10, 20)
2638 =head3 Deprecated usage of Literal SQL
2640 Below are some examples of archaic use of literal SQL. It is shown only as
2641 reference for those who deal with legacy code. Each example has a much
2642 better, cleaner and safer alternative that users should opt for in new code.
2648 my %where = ( requestor => \'IS NOT NULL' )
2650 $stmt = "WHERE requestor IS NOT NULL"
2652 This used to be the way of generating NULL comparisons, before the handling
2653 of C<undef> got formalized. For new code please use the superior syntax as
2654 described in L</Tests for NULL values>.
2658 my %where = ( requestor => \'= submitter' )
2660 $stmt = "WHERE requestor = submitter"
2662 This used to be the only way to compare columns. Use the superior L</-ident>
2663 method for all new code. For example an identifier declared in such a way
2664 will be properly quoted if L</quote_char> is properly set, while the legacy
2665 form will remain as supplied.
2669 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2671 $stmt = "WHERE completed > ? AND is_ready"
2672 @bind = ('2012-12-21')
2674 Using an empty string literal used to be the only way to express a boolean.
2675 For all new code please use the much more readable
2676 L<-bool|/Unary operators: bool> operator.
2682 These pages could go on for a while, since the nesting of the data
2683 structures this module can handle are pretty much unlimited (the
2684 module implements the C<WHERE> expansion as a recursive function
2685 internally). Your best bet is to "play around" with the module a
2686 little to see how the data structures behave, and choose the best
2687 format for your data based on that.
2689 And of course, all the values above will probably be replaced with
2690 variables gotten from forms or the command line. After all, if you
2691 knew everything ahead of time, you wouldn't have to worry about
2692 dynamically-generating SQL and could just hardwire it into your
2695 =head1 ORDER BY CLAUSES
2697 Some functions take an order by clause. This can either be a scalar (just a
2698 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2699 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2702 Given | Will Generate
2703 ---------------------------------------------------------------
2705 'colA' | ORDER BY colA
2707 [qw/colA colB/] | ORDER BY colA, colB
2709 {-asc => 'colA'} | ORDER BY colA ASC
2711 {-desc => 'colB'} | ORDER BY colB DESC
2713 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2715 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2717 \'colA DESC' | ORDER BY colA DESC
2719 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2720 | /* ...with $x bound to ? */
2723 { -asc => 'colA' }, | colA ASC,
2724 { -desc => [qw/colB/] }, | colB DESC,
2725 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2726 \'colE DESC', | colE DESC,
2727 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2728 ] | /* ...with $x bound to ? */
2729 ===============================================================
2733 =head1 SPECIAL OPERATORS
2735 my $sqlmaker = SQL::Abstract->new(special_ops => [
2739 my ($self, $field, $op, $arg) = @_;
2745 handler => 'method_name',
2749 A "special operator" is a SQL syntactic clause that can be
2750 applied to a field, instead of a usual binary operator.
2753 WHERE field IN (?, ?, ?)
2754 WHERE field BETWEEN ? AND ?
2755 WHERE MATCH(field) AGAINST (?, ?)
2757 Special operators IN and BETWEEN are fairly standard and therefore
2758 are builtin within C<SQL::Abstract> (as the overridable methods
2759 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2760 like the MATCH .. AGAINST example above which is specific to MySQL,
2761 you can write your own operator handlers - supply a C<special_ops>
2762 argument to the C<new> method. That argument takes an arrayref of
2763 operator definitions; each operator definition is a hashref with two
2770 the regular expression to match the operator
2774 Either a coderef or a plain scalar method name. In both cases
2775 the expected return is C<< ($sql, @bind) >>.
2777 When supplied with a method name, it is simply called on the
2778 L<SQL::Abstract> object as:
2780 $self->$method_name($field, $op, $arg)
2784 $field is the LHS of the operator
2785 $op is the part that matched the handler regex
2788 When supplied with a coderef, it is called as:
2790 $coderef->($self, $field, $op, $arg)
2795 For example, here is an implementation
2796 of the MATCH .. AGAINST syntax for MySQL
2798 my $sqlmaker = SQL::Abstract->new(special_ops => [
2800 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2801 {regex => qr/^match$/i,
2803 my ($self, $field, $op, $arg) = @_;
2804 $arg = [$arg] if not ref $arg;
2805 my $label = $self->_quote($field);
2806 my ($placeholder) = $self->_convert('?');
2807 my $placeholders = join ", ", (($placeholder) x @$arg);
2808 my $sql = $self->_sqlcase('match') . " ($label) "
2809 . $self->_sqlcase('against') . " ($placeholders) ";
2810 my @bind = $self->_bindtype($field, @$arg);
2811 return ($sql, @bind);
2818 =head1 UNARY OPERATORS
2820 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2824 my ($self, $op, $arg) = @_;
2830 handler => 'method_name',
2834 A "unary operator" is a SQL syntactic clause that can be
2835 applied to a field - the operator goes before the field
2837 You can write your own operator handlers - supply a C<unary_ops>
2838 argument to the C<new> method. That argument takes an arrayref of
2839 operator definitions; each operator definition is a hashref with two
2846 the regular expression to match the operator
2850 Either a coderef or a plain scalar method name. In both cases
2851 the expected return is C<< $sql >>.
2853 When supplied with a method name, it is simply called on the
2854 L<SQL::Abstract> object as:
2856 $self->$method_name($op, $arg)
2860 $op is the part that matched the handler regex
2861 $arg is the RHS or argument of the operator
2863 When supplied with a coderef, it is called as:
2865 $coderef->($self, $op, $arg)
2873 Thanks to some benchmarking by Mark Stosberg, it turns out that
2874 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2875 I must admit this wasn't an intentional design issue, but it's a
2876 byproduct of the fact that you get to control your C<DBI> handles
2879 To maximize performance, use a code snippet like the following:
2881 # prepare a statement handle using the first row
2882 # and then reuse it for the rest of the rows
2884 for my $href (@array_of_hashrefs) {
2885 $stmt ||= $sql->insert('table', $href);
2886 $sth ||= $dbh->prepare($stmt);
2887 $sth->execute($sql->values($href));
2890 The reason this works is because the keys in your C<$href> are sorted
2891 internally by B<SQL::Abstract>. Thus, as long as your data retains
2892 the same structure, you only have to generate the SQL the first time
2893 around. On subsequent queries, simply use the C<values> function provided
2894 by this module to return your values in the correct order.
2896 However this depends on the values having the same type - if, for
2897 example, the values of a where clause may either have values
2898 (resulting in sql of the form C<column = ?> with a single bind
2899 value), or alternatively the values might be C<undef> (resulting in
2900 sql of the form C<column IS NULL> with no bind value) then the
2901 caching technique suggested will not work.
2905 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2906 really like this part (I do, at least). Building up a complex query
2907 can be as simple as the following:
2914 use CGI::FormBuilder;
2917 my $form = CGI::FormBuilder->new(...);
2918 my $sql = SQL::Abstract->new;
2920 if ($form->submitted) {
2921 my $field = $form->field;
2922 my $id = delete $field->{id};
2923 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2926 Of course, you would still have to connect using C<DBI> to run the
2927 query, but the point is that if you make your form look like your
2928 table, the actual query script can be extremely simplistic.
2930 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2931 a fast interface to returning and formatting data. I frequently
2932 use these three modules together to write complex database query
2933 apps in under 50 lines.
2935 =head1 HOW TO CONTRIBUTE
2937 Contributions are always welcome, in all usable forms (we especially
2938 welcome documentation improvements). The delivery methods include git-
2939 or unified-diff formatted patches, GitHub pull requests, or plain bug
2940 reports either via RT or the Mailing list. Contributors are generally
2941 granted full access to the official repository after their first several
2942 patches pass successful review.
2944 This project is maintained in a git repository. The code and related tools are
2945 accessible at the following locations:
2949 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2951 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
2953 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
2955 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
2961 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2962 Great care has been taken to preserve the I<published> behavior
2963 documented in previous versions in the 1.* family; however,
2964 some features that were previously undocumented, or behaved
2965 differently from the documentation, had to be changed in order
2966 to clarify the semantics. Hence, client code that was relying
2967 on some dark areas of C<SQL::Abstract> v1.*
2968 B<might behave differently> in v1.50.
2970 The main changes are:
2976 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
2980 support for the { operator => \"..." } construct (to embed literal SQL)
2984 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
2988 optional support for L<array datatypes|/"Inserting and Updating Arrays">
2992 defensive programming: check arguments
2996 fixed bug with global logic, which was previously implemented
2997 through global variables yielding side-effects. Prior versions would
2998 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
2999 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3000 Now this is interpreted
3001 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3006 fixed semantics of _bindtype on array args
3010 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3011 we just avoid shifting arrays within that tree.
3015 dropped the C<_modlogic> function
3019 =head1 ACKNOWLEDGEMENTS
3021 There are a number of individuals that have really helped out with
3022 this module. Unfortunately, most of them submitted bugs via CPAN
3023 so I have no idea who they are! But the people I do know are:
3025 Ash Berlin (order_by hash term support)
3026 Matt Trout (DBIx::Class support)
3027 Mark Stosberg (benchmarking)
3028 Chas Owens (initial "IN" operator support)
3029 Philip Collins (per-field SQL functions)
3030 Eric Kolve (hashref "AND" support)
3031 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3032 Dan Kubb (support for "quote_char" and "name_sep")
3033 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3034 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3035 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3036 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3037 Oliver Charles (support for "RETURNING" after "INSERT")
3043 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3047 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3049 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3051 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3052 While not an official support venue, C<DBIx::Class> makes heavy use of
3053 C<SQL::Abstract>, and as such list members there are very familiar with
3054 how to create queries.
3058 This module is free software; you may copy this under the same
3059 terms as perl itself (either the GNU General Public License or
3060 the Artistic License)