1 package SQL::Abstract; # see doc at end of file
10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
20 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
26 #======================================================================
28 #======================================================================
30 our $VERSION = '1.86';
32 # This would confuse some packagers
33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
37 # special operators (-in, -between). May be extended/overridden by user.
38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
39 my @BUILTIN_SPECIAL_OPS = (
40 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
41 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
45 #======================================================================
46 # DEBUGGING AND ERROR REPORTING
47 #======================================================================
50 return unless $_[0]->{debug}; shift; # a little faster
51 my $func = (caller(1))[3];
52 warn "[$func] ", @_, "\n";
56 my($func) = (caller(1))[3];
57 Carp::carp "[$func] Warning: ", @_;
61 my($func) = (caller(1))[3];
62 Carp::croak "[$func] Fatal: ", @_;
65 sub is_literal_value ($) {
66 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
67 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
71 # FIXME XSify - this can be done so much more efficiently
72 sub is_plain_value ($) {
74 ! length ref $_[0] ? \($_[0])
76 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
78 exists $_[0]->{-value}
79 ) ? \($_[0]->{-value})
81 # reuse @_ for even moar speedz
82 defined ( $_[1] = Scalar::Util::blessed $_[0] )
84 # deliberately not using Devel::OverloadInfo - the checks we are
85 # intersted in are much more limited than the fullblown thing, and
86 # this is a very hot piece of code
88 # simply using ->can('(""') can leave behind stub methods that
89 # break actually using the overload later (see L<perldiag/Stub
90 # found while resolving method "%s" overloading "%s" in package
91 # "%s"> and the source of overload::mycan())
93 # either has stringification which DBI SHOULD prefer out of the box
94 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
96 # has nummification or boolification, AND fallback is *not* disabled
98 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
101 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
103 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
107 # no fallback specified at all
108 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
110 # fallback explicitly undef
111 ! defined ${"$_[3]::()"}
124 #======================================================================
126 #======================================================================
130 my $class = ref($self) || $self;
131 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
133 # choose our case by keeping an option around
134 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
136 # default logic for interpreting arrayrefs
137 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
139 # how to return bind vars
140 $opt{bindtype} ||= 'normal';
142 # default comparison is "=", but can be overridden
145 # try to recognize which are the 'equality' and 'inequality' ops
146 # (temporary quickfix (in 2007), should go through a more seasoned API)
147 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
148 $opt{inequality_op} = qr/^( != | <> )$/ix;
150 $opt{like_op} = qr/^ (is\s+)? r?like $/xi;
151 $opt{not_like_op} = qr/^ (is\s+)? not \s+ r?like $/xi;
154 $opt{sqltrue} ||= '1=1';
155 $opt{sqlfalse} ||= '0=1';
158 $opt{user_special_ops} = [ @{$opt{special_ops} ||= []} ];
159 # regexes are applied in order, thus push after user-defines
160 push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
163 $opt{unary_ops} ||= [];
165 # rudimentary sanity-check for user supplied bits treated as functions/operators
166 # If a purported function matches this regular expression, an exception is thrown.
167 # Literal SQL is *NOT* subject to this check, only functions (and column names
168 # when quoting is not in effect)
171 # need to guard against ()'s in column names too, but this will break tons of
172 # hacks... ideas anyone?
173 $opt{injection_guard} ||= qr/
179 return bless \%opt, $class;
182 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
183 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
185 sub _assert_pass_injection_guard {
186 if ($_[1] =~ $_[0]->{injection_guard}) {
187 my $class = ref $_[0];
188 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
189 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
190 . "{injection_guard} attribute to ${class}->new()"
195 #======================================================================
197 #======================================================================
201 my $table = $self->_table(shift);
202 my $data = shift || return;
205 my $method = $self->_METHOD_FOR_refkind("_insert", $data);
206 my ($sql, @bind) = $self->$method($data);
207 $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
209 if ($options->{returning}) {
210 my ($s, @b) = $self->_insert_returning($options);
215 return wantarray ? ($sql, @bind) : $sql;
218 # So that subclasses can override INSERT ... RETURNING separately from
219 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
220 sub _insert_returning { shift->_returning(@_) }
223 my ($self, $options) = @_;
225 my $f = $options->{returning};
227 my $fieldlist = $self->_SWITCH_refkind($f, {
228 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$f;},
229 SCALAR => sub {$self->_quote($f)},
230 SCALARREF => sub {$$f},
232 return $self->_sqlcase(' returning ') . $fieldlist;
235 sub _insert_HASHREF { # explicit list of fields and then values
236 my ($self, $data) = @_;
238 my @fields = sort keys %$data;
240 my ($sql, @bind) = $self->_insert_values($data);
243 $_ = $self->_quote($_) foreach @fields;
244 $sql = "( ".join(", ", @fields).") ".$sql;
246 return ($sql, @bind);
249 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
250 my ($self, $data) = @_;
252 # no names (arrayref) so can't generate bindtype
253 $self->{bindtype} ne 'columns'
254 or belch "can't do 'columns' bindtype when called with arrayref";
256 my (@values, @all_bind);
257 foreach my $value (@$data) {
258 my ($values, @bind) = $self->_insert_value(undef, $value);
259 push @values, $values;
260 push @all_bind, @bind;
262 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
263 return ($sql, @all_bind);
266 sub _insert_ARRAYREFREF { # literal SQL with bind
267 my ($self, $data) = @_;
269 my ($sql, @bind) = @${$data};
270 $self->_assert_bindval_matches_bindtype(@bind);
272 return ($sql, @bind);
276 sub _insert_SCALARREF { # literal SQL without bind
277 my ($self, $data) = @_;
283 my ($self, $data) = @_;
285 my (@values, @all_bind);
286 foreach my $column (sort keys %$data) {
287 my ($values, @bind) = $self->_insert_value($column, $data->{$column});
288 push @values, $values;
289 push @all_bind, @bind;
291 my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
292 return ($sql, @all_bind);
296 my ($self, $column, $v) = @_;
298 my (@values, @all_bind);
299 $self->_SWITCH_refkind($v, {
302 if ($self->{array_datatypes}) { # if array datatype are activated
304 push @all_bind, $self->_bindtype($column, $v);
306 else { # else literal SQL with bind
307 my ($sql, @bind) = @$v;
308 $self->_assert_bindval_matches_bindtype(@bind);
310 push @all_bind, @bind;
314 ARRAYREFREF => sub { # literal SQL with bind
315 my ($sql, @bind) = @${$v};
316 $self->_assert_bindval_matches_bindtype(@bind);
318 push @all_bind, @bind;
321 # THINK: anything useful to do with a HASHREF ?
322 HASHREF => sub { # (nothing, but old SQLA passed it through)
323 #TODO in SQLA >= 2.0 it will die instead
324 belch "HASH ref as bind value in insert is not supported";
326 push @all_bind, $self->_bindtype($column, $v);
329 SCALARREF => sub { # literal SQL without bind
333 SCALAR_or_UNDEF => sub {
335 push @all_bind, $self->_bindtype($column, $v);
340 my $sql = join(", ", @values);
341 return ($sql, @all_bind);
346 #======================================================================
348 #======================================================================
353 my $table = $self->_table(shift);
354 my $data = shift || return;
358 # first build the 'SET' part of the sql statement
359 puke "Unsupported data type specified to \$sql->update"
360 unless ref $data eq 'HASH';
362 my ($sql, @all_bind) = $self->_update_set_values($data);
363 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
367 my($where_sql, @where_bind) = $self->where($where);
369 push @all_bind, @where_bind;
372 if ($options->{returning}) {
373 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
374 $sql .= $returning_sql;
375 push @all_bind, @returning_bind;
378 return wantarray ? ($sql, @all_bind) : $sql;
381 sub _update_set_values {
382 my ($self, $data) = @_;
384 my (@set, @all_bind);
385 for my $k (sort keys %$data) {
388 my $label = $self->_quote($k);
390 $self->_SWITCH_refkind($v, {
392 if ($self->{array_datatypes}) { # array datatype
393 push @set, "$label = ?";
394 push @all_bind, $self->_bindtype($k, $v);
396 else { # literal SQL with bind
397 my ($sql, @bind) = @$v;
398 $self->_assert_bindval_matches_bindtype(@bind);
399 push @set, "$label = $sql";
400 push @all_bind, @bind;
403 ARRAYREFREF => sub { # literal SQL with bind
404 my ($sql, @bind) = @${$v};
405 $self->_assert_bindval_matches_bindtype(@bind);
406 push @set, "$label = $sql";
407 push @all_bind, @bind;
409 SCALARREF => sub { # literal SQL without bind
410 push @set, "$label = $$v";
413 my ($op, $arg, @rest) = %$v;
415 puke 'Operator calls in update must be in the form { -op => $arg }'
416 if (@rest or not $op =~ /^\-(.+)/);
418 local our $Cur_Col_Meta = $k;
419 my ($sql, @bind) = $self->_render_expr(
420 $self->_expand_expr_hashpair($op, $arg)
423 push @set, "$label = $sql";
424 push @all_bind, @bind;
426 SCALAR_or_UNDEF => sub {
427 push @set, "$label = ?";
428 push @all_bind, $self->_bindtype($k, $v);
434 my $sql = join ', ', @set;
436 return ($sql, @all_bind);
439 # So that subclasses can override UPDATE ... RETURNING separately from
441 sub _update_returning { shift->_returning(@_) }
445 #======================================================================
447 #======================================================================
452 my $table = $self->_table(shift);
453 my $fields = shift || '*';
457 my ($fields_sql, @bind) = $self->_select_fields($fields);
459 my ($where_sql, @where_bind) = $self->where($where, $order);
460 push @bind, @where_bind;
462 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
463 $self->_sqlcase('from'), $table)
466 return wantarray ? ($sql, @bind) : $sql;
470 my ($self, $fields) = @_;
471 return ref $fields eq 'ARRAY' ? join ', ', map { $self->_quote($_) } @$fields
475 #======================================================================
477 #======================================================================
482 my $table = $self->_table(shift);
486 my($where_sql, @bind) = $self->where($where);
487 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
489 if ($options->{returning}) {
490 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
491 $sql .= $returning_sql;
492 push @bind, @returning_bind;
495 return wantarray ? ($sql, @bind) : $sql;
498 # So that subclasses can override DELETE ... RETURNING separately from
500 sub _delete_returning { shift->_returning(@_) }
504 #======================================================================
506 #======================================================================
510 # Finally, a separate routine just to handle WHERE clauses
512 my ($self, $where, $order) = @_;
515 my ($sql, @bind) = defined($where)
516 ? $self->_recurse_where($where)
518 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
522 my ($order_sql, @order_bind) = $self->_order_by($order);
524 push @bind, @order_bind;
527 return wantarray ? ($sql, @bind) : $sql;
531 my ($self, $expr, $logic) = @_;
532 return undef unless defined($expr);
533 if (ref($expr) eq 'HASH') {
534 if (keys %$expr > 1) {
538 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
542 return unless %$expr;
543 return $self->_expand_expr_hashpair(%$expr, $logic);
545 if (ref($expr) eq 'ARRAY') {
546 my $logic = lc($logic || $self->{logic});
547 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
553 while (my ($el) = splice @expr, 0, 1) {
554 puke "Supplying an empty left hand side argument is not supported in array-pairs"
555 unless defined($el) and length($el);
556 my $elref = ref($el);
558 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
559 } elsif ($elref eq 'ARRAY') {
560 push(@res, $self->_expand_expr($el)) if @$el;
561 } elsif (my $l = is_literal_value($el)) {
562 push @res, { -literal => $l };
563 } elsif ($elref eq 'HASH') {
564 push @res, $self->_expand_expr($el);
569 return { -op => [ $logic, @res ] };
571 if (my $literal = is_literal_value($expr)) {
572 return +{ -literal => $literal };
574 if (!ref($expr) or Scalar::Util::blessed($expr)) {
575 if (my $m = our $Cur_Col_Meta) {
576 return +{ -bind => [ $m, $expr ] };
578 return +{ -value => $expr };
583 sub _expand_expr_hashpair {
584 my ($self, $k, $v, $logic) = @_;
585 unless (defined($k) and length($k)) {
586 if (defined($k) and my $literal = is_literal_value($v)) {
587 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
588 return { -literal => $literal };
590 puke "Supplying an empty left hand side argument is not supported";
593 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
594 if ($k =~ s/ [_\s]? \d+ $//x ) {
595 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
596 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
599 return $self->_expand_expr($v);
603 return $self->_expand_expr($v);
605 puke "-bool => undef not supported" unless defined($v);
606 return { -ident => $v };
609 return { -op => [ 'not', $self->_expand_expr($v) ] };
611 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
614 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
617 if (my ($logic) = $k =~ /^-(and|or)$/i) {
618 if (ref($v) eq 'HASH') {
619 return $self->_expand_expr($v, $logic);
621 if (ref($v) eq 'ARRAY') {
622 return $self->_expand_expr($v, $logic);
627 $op =~ s/^-// if length($op) > 1;
629 # top level special ops are illegal in general
630 puke "Illegal use of top-level '-$op'"
631 if !(defined $self->{_nested_func_lhs})
632 and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
634 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
635 return +{ -bind => [ $m, $v ] };
637 if ($k eq '-op' or $k eq '-ident' or $k eq '-value' or $k eq '-bind' or $k eq '-literal' or $k eq '-func') {
643 and (keys %$v)[0] =~ /^-/
645 my ($func) = $k =~ /^-(.*)$/;
646 return +{ -func => [ $func, $self->_expand_expr($v) ] };
648 if (!ref($v) or is_literal_value($v)) {
649 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
656 and exists $v->{-value}
657 and not defined $v->{-value}
660 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
662 if (!ref($v) or Scalar::Util::blessed($v)) {
667 { -bind => [ $k, $v ] }
671 if (ref($v) eq 'HASH') {
675 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
682 $self->_assert_pass_injection_guard($vk);
683 if ($vk =~ s/ [_\s]? \d+ $//x ) {
684 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
685 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
687 if ($vk =~ /^(?:not[ _])?between$/) {
688 local our $Cur_Col_Meta = $k;
689 my @rhs = map $self->_expand_expr($_),
690 ref($vv) eq 'ARRAY' ? @$vv : $vv;
692 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
694 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
696 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
699 join(' ', split '_', $vk),
704 if ($vk =~ /^(?:not[ _])?in$/) {
705 if (my $literal = is_literal_value($vv)) {
706 my ($sql, @bind) = @$literal;
707 my $opened_sql = $self->_open_outer_paren($sql);
709 $vk, { -ident => $k },
710 [ { -literal => [ $opened_sql, @bind ] } ]
714 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
715 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
716 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
717 . 'will emit the logically correct SQL instead of raising this exception)'
719 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
721 my @rhs = map $self->_expand_expr($_),
722 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
723 map { defined($_) ? $_: puke($undef_err) }
724 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
725 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
728 join(' ', split '_', $vk),
733 if ($vk eq 'ident') {
734 if (! defined $vv or ref $vv) {
735 puke "-$vk requires a single plain scalar argument (a quotable identifier)";
743 if ($vk eq 'value') {
744 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
748 { -bind => [ $k, $vv ] }
751 if ($vk =~ /^is(?:[ _]not)?$/) {
752 puke "$vk can only take undef as argument"
756 and exists($vv->{-value})
757 and !defined($vv->{-value})
760 return +{ -op => [ $vk.' null', { -ident => $k } ] };
762 if ($vk =~ /^(and|or)$/) {
763 if (ref($vv) eq 'HASH') {
766 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
771 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{user_special_ops}}) {
772 return { -op => [ $vk, { -ident => $k }, $vv ] };
774 if (ref($vv) eq 'ARRAY') {
775 my ($logic, @values) = (
776 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
781 $vk =~ $self->{inequality_op}
782 or join(' ', split '_', $vk) =~ $self->{not_like_op}
784 if (lc($logic) eq '-or' and @values > 1) {
785 my $op = uc join ' ', split '_', $vk;
786 belch "A multi-element arrayref as an argument to the inequality op '$op' "
787 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
788 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
793 # try to DWIM on equality operators
794 my $op = join ' ', split '_', $vk;
796 $op =~ $self->{equality_op} ? $self->sqlfalse
797 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
798 : $op =~ $self->{inequality_op} ? $self->sqltrue
799 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
800 : puke "operator '$op' applied on an empty array (field '$k')";
804 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
812 and exists $vv->{-value}
813 and not defined $vv->{-value}
816 my $op = join ' ', split '_', $vk;
818 $op =~ /^not$/i ? 'is not' # legacy
819 : $op =~ $self->{equality_op} ? 'is'
820 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
821 : $op =~ $self->{inequality_op} ? 'is not'
822 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
823 : puke "unexpected operator '$op' with undef operand";
824 return +{ -op => [ $is.' null', { -ident => $k } ] };
826 local our $Cur_Col_Meta = $k;
830 $self->_expand_expr($vv)
833 if (ref($v) eq 'ARRAY') {
834 return $self->sqlfalse unless @$v;
835 $self->_debug("ARRAY($k) means distribute over elements");
837 $v->[0] =~ /^-((?:and|or))$/i
838 ? ($v = [ @{$v}[1..$#$v] ], $1)
839 : ($self->{logic} || 'or')
843 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
846 if (my $literal = is_literal_value($v)) {
848 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
851 my ($sql, @bind) = @$literal;
852 if ($self->{bindtype} eq 'columns') {
854 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
855 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
859 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
865 my ($self, $expr) = @_;
866 my ($k, $v, @rest) = %$expr;
868 my %op = map +("-$_" => '_where_op_'.uc($_)),
869 qw(op func value bind ident literal);
870 if (my $meth = $op{$k}) {
871 return $self->$meth(undef, $v);
873 die "notreached: $k";
877 my ($self, $where, $logic) = @_;
879 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
881 my $where_exp = $self->_expand_expr($where, $logic);
883 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
885 # dispatch on appropriate method according to refkind of $where
886 # my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
888 # my ($sql, @bind) = $self->$method($where_exp, $logic);
890 my ($sql, @bind) = defined($where_exp) ? $self->_render_expr($where_exp) : (undef);
892 # DBIx::Class used to call _recurse_where in scalar context
893 # something else might too...
895 return ($sql, @bind);
898 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
903 sub _where_op_IDENT {
905 my ($op, $rhs) = splice @_, -2;
906 if (! defined $rhs or length ref $rhs) {
907 puke "-$op requires a single plain scalar argument (a quotable identifier)";
910 # in case we are called as a top level special op (no '=')
911 my $has_lhs = my $lhs = shift;
913 $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
921 sub _where_op_VALUE {
923 my ($op, $rhs) = splice @_, -2;
925 # in case we are called as a top level special op (no '=')
929 if (! defined $rhs) {
931 ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
938 (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
945 $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
949 $self->_convert('?'),
956 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
962 my ($self, $args) = @_;
963 my ($left, $low, $high) = @$args;
964 my ($rhsql, @rhbind) = do {
966 puke "Single arg to between must be a literal"
967 unless $low->{-literal};
970 my ($l, $h) = map [ $self->_render_expr($_) ], $low, $high;
971 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
972 @{$l}[1..$#$l], @{$h}[1..$#$h])
975 my ($lhsql, @lhbind) = $self->_render_expr($left);
977 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
981 }), 'between', 'not between'),
985 my ($self, $args) = @_;
986 my ($lhs, $rhs) = @$args;
989 my ($sql, @bind) = $self->_render_expr($_);
990 push @in_bind, @bind;
993 my ($lhsql, @lbind) = $self->_render_expr($lhs);
995 $lhsql.' '.$self->_sqlcase($op).' ( '
1001 }), 'in', 'not in'),
1005 my ($self, undef, $v) = @_;
1006 my ($op, @args) = @$v;
1007 $op =~ s/^-// if length($op) > 1;
1009 local $self->{_nested_func_lhs};
1010 if (my $h = $special{$op}) {
1011 return $self->$h(\@args);
1013 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{user_special_ops}}) {
1014 puke "Special op '${op}' requires first value to be identifier"
1015 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1016 return $self->${\($us->{handler})}($k, $op, $args[1]);
1018 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
1019 if (@args == 1 and $op !~ /^(and|or)$/) {
1020 my ($expr_sql, @bind) = $self->_render_expr($args[0]);
1021 my $op_sql = $self->_sqlcase($final_op);
1023 $unop_postfix{lc($final_op)}
1024 ? "${expr_sql} ${op_sql}"
1025 : "${op_sql} ${expr_sql}"
1027 return (($op eq 'not' ? '('.$final_sql.')' : $final_sql), @bind);
1029 my @parts = map [ $self->_render_expr($_) ], @args;
1030 my ($final_sql) = map +($op =~ /^(and|or)$/ ? "(${_})" : $_), join(
1031 ' '.$self->_sqlcase($final_op).' ',
1036 map @{$_}[1..$#$_], @parts
1042 sub _where_op_FUNC {
1043 my ($self, undef, $rest) = @_;
1044 my ($func, @args) = @$rest;
1048 push @arg_sql, shift @x;
1050 } map [ $self->_render_expr($_) ], @args;
1051 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1054 sub _where_op_BIND {
1055 my ($self, undef, $bind) = @_;
1056 return ($self->_convert('?'), $self->_bindtype(@$bind));
1059 sub _where_op_LITERAL {
1060 my ($self, undef, $literal) = @_;
1061 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1065 # Some databases (SQLite) treat col IN (1, 2) different from
1066 # col IN ( (1, 2) ). Use this to strip all outer parens while
1067 # adding them back in the corresponding method
1068 sub _open_outer_paren {
1069 my ($self, $sql) = @_;
1071 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1073 # there are closing parens inside, need the heavy duty machinery
1074 # to reevaluate the extraction starting from $sql (full reevaluation)
1075 if ($inner =~ /\)/) {
1076 require Text::Balanced;
1078 my (undef, $remainder) = do {
1079 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1081 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1084 # the entire expression needs to be a balanced bracketed thing
1085 # (after an extract no remainder sans trailing space)
1086 last if defined $remainder and $remainder =~ /\S/;
1096 #======================================================================
1098 #======================================================================
1101 my ($self, $arg) = @_;
1104 for my $c ($self->_order_by_chunks($arg) ) {
1105 $self->_SWITCH_refkind($c, {
1106 SCALAR => sub { push @sql, $c },
1107 ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1113 $self->_sqlcase(' order by'),
1119 return wantarray ? ($sql, @bind) : $sql;
1122 sub _order_by_chunks {
1123 my ($self, $arg) = @_;
1125 return $self->_SWITCH_refkind($arg, {
1128 map { $self->_order_by_chunks($_ ) } @$arg;
1131 ARRAYREFREF => sub {
1132 my ($s, @b) = @$$arg;
1133 $self->_assert_bindval_matches_bindtype(@b);
1137 SCALAR => sub {$self->_quote($arg)},
1139 UNDEF => sub {return () },
1141 SCALARREF => sub {$$arg}, # literal SQL, no quoting
1144 # get first pair in hash
1145 my ($key, $val, @rest) = %$arg;
1147 return () unless $key;
1149 if (@rest or not $key =~ /^-(desc|asc)/i) {
1150 puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1156 for my $c ($self->_order_by_chunks($val)) {
1159 $self->_SWITCH_refkind($c, {
1164 ($sql, @bind) = @$c;
1168 $sql = $sql . ' ' . $self->_sqlcase($direction);
1170 push @ret, [ $sql, @bind];
1179 #======================================================================
1180 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1181 #======================================================================
1186 $self->_SWITCH_refkind($from, {
1187 ARRAYREF => sub {join ', ', map { $self->_quote($_) } @$from;},
1188 SCALAR => sub {$self->_quote($from)},
1189 SCALARREF => sub {$$from},
1194 #======================================================================
1196 #======================================================================
1198 # highly optimized, as it's called way too often
1200 # my ($self, $label) = @_;
1202 return '' unless defined $_[1];
1203 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1205 $_[0]->{quote_char} or
1206 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1208 my $qref = ref $_[0]->{quote_char};
1210 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1211 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1212 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1214 my $esc = $_[0]->{escape_char} || $r;
1216 # parts containing * are naturally unquoted
1217 return join($_[0]->{name_sep}||'', map
1218 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1219 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1224 # Conversion, if applicable
1226 #my ($self, $arg) = @_;
1227 if ($_[0]->{convert}) {
1228 return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1235 #my ($self, $col, @vals) = @_;
1236 # called often - tighten code
1237 return $_[0]->{bindtype} eq 'columns'
1238 ? map {[$_[1], $_]} @_[2 .. $#_]
1243 # Dies if any element of @bind is not in [colname => value] format
1244 # if bindtype is 'columns'.
1245 sub _assert_bindval_matches_bindtype {
1246 # my ($self, @bind) = @_;
1248 if ($self->{bindtype} eq 'columns') {
1250 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1251 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1257 sub _join_sql_clauses {
1258 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1260 if (@$clauses_aref > 1) {
1261 my $join = " " . $self->_sqlcase($logic) . " ";
1262 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1263 return ($sql, @$bind_aref);
1265 elsif (@$clauses_aref) {
1266 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1269 return (); # if no SQL, ignore @$bind_aref
1274 # Fix SQL case, if so requested
1276 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1277 # don't touch the argument ... crooked logic, but let's not change it!
1278 return $_[0]->{case} ? $_[1] : uc($_[1]);
1282 #======================================================================
1283 # DISPATCHING FROM REFKIND
1284 #======================================================================
1287 my ($self, $data) = @_;
1289 return 'UNDEF' unless defined $data;
1291 # blessed objects are treated like scalars
1292 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1294 return 'SCALAR' unless $ref;
1297 while ($ref eq 'REF') {
1299 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1303 return ($ref||'SCALAR') . ('REF' x $n_steps);
1307 my ($self, $data) = @_;
1308 my @try = ($self->_refkind($data));
1309 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1310 push @try, 'FALLBACK';
1314 sub _METHOD_FOR_refkind {
1315 my ($self, $meth_prefix, $data) = @_;
1318 for (@{$self->_try_refkind($data)}) {
1319 $method = $self->can($meth_prefix."_".$_)
1323 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1327 sub _SWITCH_refkind {
1328 my ($self, $data, $dispatch_table) = @_;
1331 for (@{$self->_try_refkind($data)}) {
1332 $coderef = $dispatch_table->{$_}
1336 puke "no dispatch entry for ".$self->_refkind($data)
1345 #======================================================================
1346 # VALUES, GENERATE, AUTOLOAD
1347 #======================================================================
1349 # LDNOTE: original code from nwiger, didn't touch code in that section
1350 # I feel the AUTOLOAD stuff should not be the default, it should
1351 # only be activated on explicit demand by user.
1355 my $data = shift || return;
1356 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1357 unless ref $data eq 'HASH';
1360 foreach my $k (sort keys %$data) {
1361 my $v = $data->{$k};
1362 $self->_SWITCH_refkind($v, {
1364 if ($self->{array_datatypes}) { # array datatype
1365 push @all_bind, $self->_bindtype($k, $v);
1367 else { # literal SQL with bind
1368 my ($sql, @bind) = @$v;
1369 $self->_assert_bindval_matches_bindtype(@bind);
1370 push @all_bind, @bind;
1373 ARRAYREFREF => sub { # literal SQL with bind
1374 my ($sql, @bind) = @${$v};
1375 $self->_assert_bindval_matches_bindtype(@bind);
1376 push @all_bind, @bind;
1378 SCALARREF => sub { # literal SQL without bind
1380 SCALAR_or_UNDEF => sub {
1381 push @all_bind, $self->_bindtype($k, $v);
1392 my(@sql, @sqlq, @sqlv);
1396 if ($ref eq 'HASH') {
1397 for my $k (sort keys %$_) {
1400 my $label = $self->_quote($k);
1401 if ($r eq 'ARRAY') {
1402 # literal SQL with bind
1403 my ($sql, @bind) = @$v;
1404 $self->_assert_bindval_matches_bindtype(@bind);
1405 push @sqlq, "$label = $sql";
1407 } elsif ($r eq 'SCALAR') {
1408 # literal SQL without bind
1409 push @sqlq, "$label = $$v";
1411 push @sqlq, "$label = ?";
1412 push @sqlv, $self->_bindtype($k, $v);
1415 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1416 } elsif ($ref eq 'ARRAY') {
1417 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1420 if ($r eq 'ARRAY') { # literal SQL with bind
1421 my ($sql, @bind) = @$v;
1422 $self->_assert_bindval_matches_bindtype(@bind);
1425 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1426 # embedded literal SQL
1433 push @sql, '(' . join(', ', @sqlq) . ')';
1434 } elsif ($ref eq 'SCALAR') {
1438 # strings get case twiddled
1439 push @sql, $self->_sqlcase($_);
1443 my $sql = join ' ', @sql;
1445 # this is pretty tricky
1446 # if ask for an array, return ($stmt, @bind)
1447 # otherwise, s/?/shift @sqlv/ to put it inline
1449 return ($sql, @sqlv);
1451 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1452 ref $d ? $d->[1] : $d/e;
1461 # This allows us to check for a local, then _form, attr
1463 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1464 return $self->generate($name, @_);
1475 SQL::Abstract - Generate SQL from Perl data structures
1481 my $sql = SQL::Abstract->new;
1483 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1485 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1487 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1489 my($stmt, @bind) = $sql->delete($table, \%where);
1491 # Then, use these in your DBI statements
1492 my $sth = $dbh->prepare($stmt);
1493 $sth->execute(@bind);
1495 # Just generate the WHERE clause
1496 my($stmt, @bind) = $sql->where(\%where, $order);
1498 # Return values in the same order, for hashed queries
1499 # See PERFORMANCE section for more details
1500 my @bind = $sql->values(\%fieldvals);
1504 This module was inspired by the excellent L<DBIx::Abstract>.
1505 However, in using that module I found that what I really wanted
1506 to do was generate SQL, but still retain complete control over my
1507 statement handles and use the DBI interface. So, I set out to
1508 create an abstract SQL generation module.
1510 While based on the concepts used by L<DBIx::Abstract>, there are
1511 several important differences, especially when it comes to WHERE
1512 clauses. I have modified the concepts used to make the SQL easier
1513 to generate from Perl data structures and, IMO, more intuitive.
1514 The underlying idea is for this module to do what you mean, based
1515 on the data structures you provide it. The big advantage is that
1516 you don't have to modify your code every time your data changes,
1517 as this module figures it out.
1519 To begin with, an SQL INSERT is as easy as just specifying a hash
1520 of C<key=value> pairs:
1523 name => 'Jimbo Bobson',
1524 phone => '123-456-7890',
1525 address => '42 Sister Lane',
1526 city => 'St. Louis',
1527 state => 'Louisiana',
1530 The SQL can then be generated with this:
1532 my($stmt, @bind) = $sql->insert('people', \%data);
1534 Which would give you something like this:
1536 $stmt = "INSERT INTO people
1537 (address, city, name, phone, state)
1538 VALUES (?, ?, ?, ?, ?)";
1539 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1540 '123-456-7890', 'Louisiana');
1542 These are then used directly in your DBI code:
1544 my $sth = $dbh->prepare($stmt);
1545 $sth->execute(@bind);
1547 =head2 Inserting and Updating Arrays
1549 If your database has array types (like for example Postgres),
1550 activate the special option C<< array_datatypes => 1 >>
1551 when creating the C<SQL::Abstract> object.
1552 Then you may use an arrayref to insert and update database array types:
1554 my $sql = SQL::Abstract->new(array_datatypes => 1);
1556 planets => [qw/Mercury Venus Earth Mars/]
1559 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1563 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1565 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1568 =head2 Inserting and Updating SQL
1570 In order to apply SQL functions to elements of your C<%data> you may
1571 specify a reference to an arrayref for the given hash value. For example,
1572 if you need to execute the Oracle C<to_date> function on a value, you can
1573 say something like this:
1577 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1580 The first value in the array is the actual SQL. Any other values are
1581 optional and would be included in the bind values array. This gives
1584 my($stmt, @bind) = $sql->insert('people', \%data);
1586 $stmt = "INSERT INTO people (name, date_entered)
1587 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1588 @bind = ('Bill', '03/02/2003');
1590 An UPDATE is just as easy, all you change is the name of the function:
1592 my($stmt, @bind) = $sql->update('people', \%data);
1594 Notice that your C<%data> isn't touched; the module will generate
1595 the appropriately quirky SQL for you automatically. Usually you'll
1596 want to specify a WHERE clause for your UPDATE, though, which is
1597 where handling C<%where> hashes comes in handy...
1599 =head2 Complex where statements
1601 This module can generate pretty complicated WHERE statements
1602 easily. For example, simple C<key=value> pairs are taken to mean
1603 equality, and if you want to see if a field is within a set
1604 of values, you can use an arrayref. Let's say we wanted to
1605 SELECT some data based on this criteria:
1608 requestor => 'inna',
1609 worker => ['nwiger', 'rcwe', 'sfz'],
1610 status => { '!=', 'completed' }
1613 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1615 The above would give you something like this:
1617 $stmt = "SELECT * FROM tickets WHERE
1618 ( requestor = ? ) AND ( status != ? )
1619 AND ( worker = ? OR worker = ? OR worker = ? )";
1620 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1622 Which you could then use in DBI code like so:
1624 my $sth = $dbh->prepare($stmt);
1625 $sth->execute(@bind);
1631 The methods are simple. There's one for every major SQL operation,
1632 and a constructor you use first. The arguments are specified in a
1633 similar order for each method (table, then fields, then a where
1634 clause) to try and simplify things.
1636 =head2 new(option => 'value')
1638 The C<new()> function takes a list of options and values, and returns
1639 a new B<SQL::Abstract> object which can then be used to generate SQL
1640 through the methods below. The options accepted are:
1646 If set to 'lower', then SQL will be generated in all lowercase. By
1647 default SQL is generated in "textbook" case meaning something like:
1649 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1651 Any setting other than 'lower' is ignored.
1655 This determines what the default comparison operator is. By default
1656 it is C<=>, meaning that a hash like this:
1658 %where = (name => 'nwiger', email => 'nate@wiger.org');
1660 Will generate SQL like this:
1662 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1664 However, you may want loose comparisons by default, so if you set
1665 C<cmp> to C<like> you would get SQL such as:
1667 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1669 You can also override the comparison on an individual basis - see
1670 the huge section on L</"WHERE CLAUSES"> at the bottom.
1672 =item sqltrue, sqlfalse
1674 Expressions for inserting boolean values within SQL statements.
1675 By default these are C<1=1> and C<1=0>. They are used
1676 by the special operators C<-in> and C<-not_in> for generating
1677 correct SQL even when the argument is an empty array (see below).
1681 This determines the default logical operator for multiple WHERE
1682 statements in arrays or hashes. If absent, the default logic is "or"
1683 for arrays, and "and" for hashes. This means that a WHERE
1687 event_date => {'>=', '2/13/99'},
1688 event_date => {'<=', '4/24/03'},
1691 will generate SQL like this:
1693 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1695 This is probably not what you want given this query, though (look
1696 at the dates). To change the "OR" to an "AND", simply specify:
1698 my $sql = SQL::Abstract->new(logic => 'and');
1700 Which will change the above C<WHERE> to:
1702 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1704 The logic can also be changed locally by inserting
1705 a modifier in front of an arrayref:
1707 @where = (-and => [event_date => {'>=', '2/13/99'},
1708 event_date => {'<=', '4/24/03'} ]);
1710 See the L</"WHERE CLAUSES"> section for explanations.
1714 This will automatically convert comparisons using the specified SQL
1715 function for both column and value. This is mostly used with an argument
1716 of C<upper> or C<lower>, so that the SQL will have the effect of
1717 case-insensitive "searches". For example, this:
1719 $sql = SQL::Abstract->new(convert => 'upper');
1720 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1722 Will turn out the following SQL:
1724 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1726 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1727 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1728 not validate this option; it will just pass through what you specify verbatim).
1732 This is a kludge because many databases suck. For example, you can't
1733 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1734 Instead, you have to use C<bind_param()>:
1736 $sth->bind_param(1, 'reg data');
1737 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1739 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1740 which loses track of which field each slot refers to. Fear not.
1742 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1743 Currently, you can specify either C<normal> (default) or C<columns>. If you
1744 specify C<columns>, you will get an array that looks like this:
1746 my $sql = SQL::Abstract->new(bindtype => 'columns');
1747 my($stmt, @bind) = $sql->insert(...);
1750 [ 'column1', 'value1' ],
1751 [ 'column2', 'value2' ],
1752 [ 'column3', 'value3' ],
1755 You can then iterate through this manually, using DBI's C<bind_param()>.
1757 $sth->prepare($stmt);
1760 my($col, $data) = @$_;
1761 if ($col eq 'details' || $col eq 'comments') {
1762 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1763 } elsif ($col eq 'image') {
1764 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1766 $sth->bind_param($i, $data);
1770 $sth->execute; # execute without @bind now
1772 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1773 Basically, the advantage is still that you don't have to care which fields
1774 are or are not included. You could wrap that above C<for> loop in a simple
1775 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1776 get a layer of abstraction over manual SQL specification.
1778 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1779 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1780 will expect the bind values in this format.
1784 This is the character that a table or column name will be quoted
1785 with. By default this is an empty string, but you could set it to
1786 the character C<`>, to generate SQL like this:
1788 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1790 Alternatively, you can supply an array ref of two items, the first being the left
1791 hand quote character, and the second the right hand quote character. For
1792 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1793 that generates SQL like this:
1795 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1797 Quoting is useful if you have tables or columns names that are reserved
1798 words in your database's SQL dialect.
1802 This is the character that will be used to escape L</quote_char>s appearing
1803 in an identifier before it has been quoted.
1805 The parameter default in case of a single L</quote_char> character is the quote
1808 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1809 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1810 of the B<opening (left)> L</quote_char> within the identifier are currently left
1811 untouched. The default for opening-closing-style quotes may change in future
1812 versions, thus you are B<strongly encouraged> to specify the escape character
1817 This is the character that separates a table and column name. It is
1818 necessary to specify this when the C<quote_char> option is selected,
1819 so that tables and column names can be individually quoted like this:
1821 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1823 =item injection_guard
1825 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1826 column name specified in a query structure. This is a safety mechanism to avoid
1827 injection attacks when mishandling user input e.g.:
1829 my %condition_as_column_value_pairs = get_values_from_user();
1830 $sqla->select( ... , \%condition_as_column_value_pairs );
1832 If the expression matches an exception is thrown. Note that literal SQL
1833 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1835 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1837 =item array_datatypes
1839 When this option is true, arrayrefs in INSERT or UPDATE are
1840 interpreted as array datatypes and are passed directly
1842 When this option is false, arrayrefs are interpreted
1843 as literal SQL, just like refs to arrayrefs
1844 (but this behavior is for backwards compatibility; when writing
1845 new queries, use the "reference to arrayref" syntax
1851 Takes a reference to a list of "special operators"
1852 to extend the syntax understood by L<SQL::Abstract>.
1853 See section L</"SPECIAL OPERATORS"> for details.
1857 Takes a reference to a list of "unary operators"
1858 to extend the syntax understood by L<SQL::Abstract>.
1859 See section L</"UNARY OPERATORS"> for details.
1865 =head2 insert($table, \@values || \%fieldvals, \%options)
1867 This is the simplest function. You simply give it a table name
1868 and either an arrayref of values or hashref of field/value pairs.
1869 It returns an SQL INSERT statement and a list of bind values.
1870 See the sections on L</"Inserting and Updating Arrays"> and
1871 L</"Inserting and Updating SQL"> for information on how to insert
1872 with those data types.
1874 The optional C<\%options> hash reference may contain additional
1875 options to generate the insert SQL. Currently supported options
1882 Takes either a scalar of raw SQL fields, or an array reference of
1883 field names, and adds on an SQL C<RETURNING> statement at the end.
1884 This allows you to return data generated by the insert statement
1885 (such as row IDs) without performing another C<SELECT> statement.
1886 Note, however, this is not part of the SQL standard and may not
1887 be supported by all database engines.
1891 =head2 update($table, \%fieldvals, \%where, \%options)
1893 This takes a table, hashref of field/value pairs, and an optional
1894 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1896 See the sections on L</"Inserting and Updating Arrays"> and
1897 L</"Inserting and Updating SQL"> for information on how to insert
1898 with those data types.
1900 The optional C<\%options> hash reference may contain additional
1901 options to generate the update SQL. Currently supported options
1908 See the C<returning> option to
1909 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1913 =head2 select($source, $fields, $where, $order)
1915 This returns a SQL SELECT statement and associated list of bind values, as
1916 specified by the arguments:
1922 Specification of the 'FROM' part of the statement.
1923 The argument can be either a plain scalar (interpreted as a table
1924 name, will be quoted), or an arrayref (interpreted as a list
1925 of table names, joined by commas, quoted), or a scalarref
1926 (literal SQL, not quoted).
1930 Specification of the list of fields to retrieve from
1932 The argument can be either an arrayref (interpreted as a list
1933 of field names, will be joined by commas and quoted), or a
1934 plain scalar (literal SQL, not quoted).
1935 Please observe that this API is not as flexible as that of
1936 the first argument C<$source>, for backwards compatibility reasons.
1940 Optional argument to specify the WHERE part of the query.
1941 The argument is most often a hashref, but can also be
1942 an arrayref or plain scalar --
1943 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1947 Optional argument to specify the ORDER BY part of the query.
1948 The argument can be a scalar, a hashref or an arrayref
1949 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1955 =head2 delete($table, \%where, \%options)
1957 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1958 It returns an SQL DELETE statement and list of bind values.
1960 The optional C<\%options> hash reference may contain additional
1961 options to generate the delete SQL. Currently supported options
1968 See the C<returning> option to
1969 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1973 =head2 where(\%where, $order)
1975 This is used to generate just the WHERE clause. For example,
1976 if you have an arbitrary data structure and know what the
1977 rest of your SQL is going to look like, but want an easy way
1978 to produce a WHERE clause, use this. It returns an SQL WHERE
1979 clause and list of bind values.
1982 =head2 values(\%data)
1984 This just returns the values from the hash C<%data>, in the same
1985 order that would be returned from any of the other above queries.
1986 Using this allows you to markedly speed up your queries if you
1987 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1989 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1991 Warning: This is an experimental method and subject to change.
1993 This returns arbitrarily generated SQL. It's a really basic shortcut.
1994 It will return two different things, depending on return context:
1996 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
1997 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
1999 These would return the following:
2001 # First calling form
2002 $stmt = "CREATE TABLE test (?, ?)";
2003 @bind = (field1, field2);
2005 # Second calling form
2006 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2008 Depending on what you're trying to do, it's up to you to choose the correct
2009 format. In this example, the second form is what you would want.
2013 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2017 ALTER SESSION SET nls_date_format = 'MM/YY'
2019 You get the idea. Strings get their case twiddled, but everything
2020 else remains verbatim.
2022 =head1 EXPORTABLE FUNCTIONS
2024 =head2 is_plain_value
2026 Determines if the supplied argument is a plain value as understood by this
2031 =item * The value is C<undef>
2033 =item * The value is a non-reference
2035 =item * The value is an object with stringification overloading
2037 =item * The value is of the form C<< { -value => $anything } >>
2041 On failure returns C<undef>, on success returns a B<scalar> reference
2042 to the original supplied argument.
2048 The stringification overloading detection is rather advanced: it takes
2049 into consideration not only the presence of a C<""> overload, but if that
2050 fails also checks for enabled
2051 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2052 on either C<0+> or C<bool>.
2054 Unfortunately testing in the field indicates that this
2055 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2056 but only when very large numbers of stringifying objects are involved.
2057 At the time of writing ( Sep 2014 ) there is no clear explanation of
2058 the direct cause, nor is there a manageably small test case that reliably
2059 reproduces the problem.
2061 If you encounter any of the following exceptions in B<random places within
2062 your application stack> - this module may be to blame:
2064 Operation "ne": no method found,
2065 left argument in overloaded package <something>,
2066 right argument in overloaded package <something>
2070 Stub found while resolving method "???" overloading """" in package <something>
2072 If you fall victim to the above - please attempt to reduce the problem
2073 to something that could be sent to the L<SQL::Abstract developers
2074 |DBIx::Class/GETTING HELP/SUPPORT>
2075 (either publicly or privately). As a workaround in the meantime you can
2076 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2077 value, which will most likely eliminate your problem (at the expense of
2078 not being able to properly detect exotic forms of stringification).
2080 This notice and environment variable will be removed in a future version,
2081 as soon as the underlying problem is found and a reliable workaround is
2086 =head2 is_literal_value
2088 Determines if the supplied argument is a literal value as understood by this
2093 =item * C<\$sql_string>
2095 =item * C<\[ $sql_string, @bind_values ]>
2099 On failure returns C<undef>, on success returns an B<array> reference
2100 containing the unpacked version of the supplied literal SQL and bind values.
2102 =head1 WHERE CLAUSES
2106 This module uses a variation on the idea from L<DBIx::Abstract>. It
2107 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2108 module is that things in arrays are OR'ed, and things in hashes
2111 The easiest way to explain is to show lots of examples. After
2112 each C<%where> hash shown, it is assumed you used:
2114 my($stmt, @bind) = $sql->where(\%where);
2116 However, note that the C<%where> hash can be used directly in any
2117 of the other functions as well, as described above.
2119 =head2 Key-value pairs
2121 So, let's get started. To begin, a simple hash:
2125 status => 'completed'
2128 Is converted to SQL C<key = val> statements:
2130 $stmt = "WHERE user = ? AND status = ?";
2131 @bind = ('nwiger', 'completed');
2133 One common thing I end up doing is having a list of values that
2134 a field can be in. To do this, simply specify a list inside of
2139 status => ['assigned', 'in-progress', 'pending'];
2142 This simple code will create the following:
2144 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2145 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2147 A field associated to an empty arrayref will be considered a
2148 logical false and will generate 0=1.
2150 =head2 Tests for NULL values
2152 If the value part is C<undef> then this is converted to SQL <IS NULL>
2161 $stmt = "WHERE user = ? AND status IS NULL";
2164 To test if a column IS NOT NULL:
2168 status => { '!=', undef },
2171 =head2 Specific comparison operators
2173 If you want to specify a different type of operator for your comparison,
2174 you can use a hashref for a given column:
2178 status => { '!=', 'completed' }
2181 Which would generate:
2183 $stmt = "WHERE user = ? AND status != ?";
2184 @bind = ('nwiger', 'completed');
2186 To test against multiple values, just enclose the values in an arrayref:
2188 status => { '=', ['assigned', 'in-progress', 'pending'] };
2190 Which would give you:
2192 "WHERE status = ? OR status = ? OR status = ?"
2195 The hashref can also contain multiple pairs, in which case it is expanded
2196 into an C<AND> of its elements:
2200 status => { '!=', 'completed', -not_like => 'pending%' }
2203 # Or more dynamically, like from a form
2204 $where{user} = 'nwiger';
2205 $where{status}{'!='} = 'completed';
2206 $where{status}{'-not_like'} = 'pending%';
2208 # Both generate this
2209 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2210 @bind = ('nwiger', 'completed', 'pending%');
2213 To get an OR instead, you can combine it with the arrayref idea:
2217 priority => [ { '=', 2 }, { '>', 5 } ]
2220 Which would generate:
2222 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2223 @bind = ('2', '5', 'nwiger');
2225 If you want to include literal SQL (with or without bind values), just use a
2226 scalar reference or reference to an arrayref as the value:
2229 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2230 date_expires => { '<' => \"now()" }
2233 Which would generate:
2235 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2236 @bind = ('11/26/2008');
2239 =head2 Logic and nesting operators
2241 In the example above,
2242 there is a subtle trap if you want to say something like
2243 this (notice the C<AND>):
2245 WHERE priority != ? AND priority != ?
2247 Because, in Perl you I<can't> do this:
2249 priority => { '!=' => 2, '!=' => 1 }
2251 As the second C<!=> key will obliterate the first. The solution
2252 is to use the special C<-modifier> form inside an arrayref:
2254 priority => [ -and => {'!=', 2},
2258 Normally, these would be joined by C<OR>, but the modifier tells it
2259 to use C<AND> instead. (Hint: You can use this in conjunction with the
2260 C<logic> option to C<new()> in order to change the way your queries
2261 work by default.) B<Important:> Note that the C<-modifier> goes
2262 B<INSIDE> the arrayref, as an extra first element. This will
2263 B<NOT> do what you think it might:
2265 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2267 Here is a quick list of equivalencies, since there is some overlap:
2270 status => {'!=', 'completed', 'not like', 'pending%' }
2271 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2274 status => {'=', ['assigned', 'in-progress']}
2275 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2276 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2280 =head2 Special operators: IN, BETWEEN, etc.
2282 You can also use the hashref format to compare a list of fields using the
2283 C<IN> comparison operator, by specifying the list as an arrayref:
2286 status => 'completed',
2287 reportid => { -in => [567, 2335, 2] }
2290 Which would generate:
2292 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2293 @bind = ('completed', '567', '2335', '2');
2295 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2298 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2299 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2300 'sqltrue' (by default: C<1=1>).
2302 In addition to the array you can supply a chunk of literal sql or
2303 literal sql with bind:
2306 customer => { -in => \[
2307 'SELECT cust_id FROM cust WHERE balance > ?',
2310 status => { -in => \'SELECT status_codes FROM states' },
2316 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2317 AND status IN ( SELECT status_codes FROM states )
2321 Finally, if the argument to C<-in> is not a reference, it will be
2322 treated as a single-element array.
2324 Another pair of operators is C<-between> and C<-not_between>,
2325 used with an arrayref of two values:
2329 completion_date => {
2330 -not_between => ['2002-10-01', '2003-02-06']
2336 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2338 Just like with C<-in> all plausible combinations of literal SQL
2342 start0 => { -between => [ 1, 2 ] },
2343 start1 => { -between => \["? AND ?", 1, 2] },
2344 start2 => { -between => \"lower(x) AND upper(y)" },
2345 start3 => { -between => [
2347 \["upper(?)", 'stuff' ],
2354 ( start0 BETWEEN ? AND ? )
2355 AND ( start1 BETWEEN ? AND ? )
2356 AND ( start2 BETWEEN lower(x) AND upper(y) )
2357 AND ( start3 BETWEEN lower(x) AND upper(?) )
2359 @bind = (1, 2, 1, 2, 'stuff');
2362 These are the two builtin "special operators"; but the
2363 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2365 =head2 Unary operators: bool
2367 If you wish to test against boolean columns or functions within your
2368 database you can use the C<-bool> and C<-not_bool> operators. For
2369 example to test the column C<is_user> being true and the column
2370 C<is_enabled> being false you would use:-
2374 -not_bool => 'is_enabled',
2379 WHERE is_user AND NOT is_enabled
2381 If a more complex combination is required, testing more conditions,
2382 then you should use the and/or operators:-
2387 -not_bool => { two=> { -rlike => 'bar' } },
2388 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2399 (NOT ( three = ? OR three > ? ))
2402 =head2 Nested conditions, -and/-or prefixes
2404 So far, we've seen how multiple conditions are joined with a top-level
2405 C<AND>. We can change this by putting the different conditions we want in
2406 hashes and then putting those hashes in an array. For example:
2411 status => { -like => ['pending%', 'dispatched'] },
2415 status => 'unassigned',
2419 This data structure would create the following:
2421 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2422 OR ( user = ? AND status = ? ) )";
2423 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2426 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2427 to change the logic inside:
2433 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2434 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2441 $stmt = "WHERE ( user = ?
2442 AND ( ( workhrs > ? AND geo = ? )
2443 OR ( workhrs < ? OR geo = ? ) ) )";
2444 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2446 =head3 Algebraic inconsistency, for historical reasons
2448 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2449 operator goes C<outside> of the nested structure; whereas when connecting
2450 several constraints on one column, the C<-and> operator goes
2451 C<inside> the arrayref. Here is an example combining both features:
2454 -and => [a => 1, b => 2],
2455 -or => [c => 3, d => 4],
2456 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2461 WHERE ( ( ( a = ? AND b = ? )
2462 OR ( c = ? OR d = ? )
2463 OR ( e LIKE ? AND e LIKE ? ) ) )
2465 This difference in syntax is unfortunate but must be preserved for
2466 historical reasons. So be careful: the two examples below would
2467 seem algebraically equivalent, but they are not
2470 { -like => 'foo%' },
2471 { -like => '%bar' },
2473 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2476 { col => { -like => 'foo%' } },
2477 { col => { -like => '%bar' } },
2479 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2482 =head2 Literal SQL and value type operators
2484 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2485 side" is a column name and the "right side" is a value (normally rendered as
2486 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2487 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2488 alter this behavior. There are several ways of doing so.
2492 This is a virtual operator that signals the string to its right side is an
2493 identifier (a column name) and not a value. For example to compare two
2494 columns you would write:
2497 priority => { '<', 2 },
2498 requestor => { -ident => 'submitter' },
2503 $stmt = "WHERE priority < ? AND requestor = submitter";
2506 If you are maintaining legacy code you may see a different construct as
2507 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2512 This is a virtual operator that signals that the construct to its right side
2513 is a value to be passed to DBI. This is for example necessary when you want
2514 to write a where clause against an array (for RDBMS that support such
2515 datatypes). For example:
2518 array => { -value => [1, 2, 3] }
2523 $stmt = 'WHERE array = ?';
2524 @bind = ([1, 2, 3]);
2526 Note that if you were to simply say:
2532 the result would probably not be what you wanted:
2534 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2539 Finally, sometimes only literal SQL will do. To include a random snippet
2540 of SQL verbatim, you specify it as a scalar reference. Consider this only
2541 as a last resort. Usually there is a better way. For example:
2544 priority => { '<', 2 },
2545 requestor => { -in => \'(SELECT name FROM hitmen)' },
2550 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2553 Note that in this example, you only get one bind parameter back, since
2554 the verbatim SQL is passed as part of the statement.
2558 Never use untrusted input as a literal SQL argument - this is a massive
2559 security risk (there is no way to check literal snippets for SQL
2560 injections and other nastyness). If you need to deal with untrusted input
2561 use literal SQL with placeholders as described next.
2563 =head3 Literal SQL with placeholders and bind values (subqueries)
2565 If the literal SQL to be inserted has placeholders and bind values,
2566 use a reference to an arrayref (yes this is a double reference --
2567 not so common, but perfectly legal Perl). For example, to find a date
2568 in Postgres you can use something like this:
2571 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2576 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2579 Note that you must pass the bind values in the same format as they are returned
2580 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2581 to C<columns>, you must provide the bind values in the
2582 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2583 scalar value; most commonly the column name, but you can use any scalar value
2584 (including references and blessed references), L<SQL::Abstract> will simply
2585 pass it through intact. So if C<bindtype> is set to C<columns> the above
2586 example will look like:
2589 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2592 Literal SQL is especially useful for nesting parenthesized clauses in the
2593 main SQL query. Here is a first example:
2595 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2599 bar => \["IN ($sub_stmt)" => @sub_bind],
2604 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2605 WHERE c2 < ? AND c3 LIKE ?))";
2606 @bind = (1234, 100, "foo%");
2608 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2609 are expressed in the same way. Of course the C<$sub_stmt> and
2610 its associated bind values can be generated through a former call
2613 my ($sub_stmt, @sub_bind)
2614 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2615 c3 => {-like => "foo%"}});
2618 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2621 In the examples above, the subquery was used as an operator on a column;
2622 but the same principle also applies for a clause within the main C<%where>
2623 hash, like an EXISTS subquery:
2625 my ($sub_stmt, @sub_bind)
2626 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2627 my %where = ( -and => [
2629 \["EXISTS ($sub_stmt)" => @sub_bind],
2634 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2635 WHERE c1 = ? AND c2 > t0.c0))";
2639 Observe that the condition on C<c2> in the subquery refers to
2640 column C<t0.c0> of the main query: this is I<not> a bind
2641 value, so we have to express it through a scalar ref.
2642 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2643 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2644 what we wanted here.
2646 Finally, here is an example where a subquery is used
2647 for expressing unary negation:
2649 my ($sub_stmt, @sub_bind)
2650 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2651 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2653 lname => {like => '%son%'},
2654 \["NOT ($sub_stmt)" => @sub_bind],
2659 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2660 @bind = ('%son%', 10, 20)
2662 =head3 Deprecated usage of Literal SQL
2664 Below are some examples of archaic use of literal SQL. It is shown only as
2665 reference for those who deal with legacy code. Each example has a much
2666 better, cleaner and safer alternative that users should opt for in new code.
2672 my %where = ( requestor => \'IS NOT NULL' )
2674 $stmt = "WHERE requestor IS NOT NULL"
2676 This used to be the way of generating NULL comparisons, before the handling
2677 of C<undef> got formalized. For new code please use the superior syntax as
2678 described in L</Tests for NULL values>.
2682 my %where = ( requestor => \'= submitter' )
2684 $stmt = "WHERE requestor = submitter"
2686 This used to be the only way to compare columns. Use the superior L</-ident>
2687 method for all new code. For example an identifier declared in such a way
2688 will be properly quoted if L</quote_char> is properly set, while the legacy
2689 form will remain as supplied.
2693 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2695 $stmt = "WHERE completed > ? AND is_ready"
2696 @bind = ('2012-12-21')
2698 Using an empty string literal used to be the only way to express a boolean.
2699 For all new code please use the much more readable
2700 L<-bool|/Unary operators: bool> operator.
2706 These pages could go on for a while, since the nesting of the data
2707 structures this module can handle are pretty much unlimited (the
2708 module implements the C<WHERE> expansion as a recursive function
2709 internally). Your best bet is to "play around" with the module a
2710 little to see how the data structures behave, and choose the best
2711 format for your data based on that.
2713 And of course, all the values above will probably be replaced with
2714 variables gotten from forms or the command line. After all, if you
2715 knew everything ahead of time, you wouldn't have to worry about
2716 dynamically-generating SQL and could just hardwire it into your
2719 =head1 ORDER BY CLAUSES
2721 Some functions take an order by clause. This can either be a scalar (just a
2722 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2723 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2726 Given | Will Generate
2727 ---------------------------------------------------------------
2729 'colA' | ORDER BY colA
2731 [qw/colA colB/] | ORDER BY colA, colB
2733 {-asc => 'colA'} | ORDER BY colA ASC
2735 {-desc => 'colB'} | ORDER BY colB DESC
2737 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2739 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2741 \'colA DESC' | ORDER BY colA DESC
2743 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2744 | /* ...with $x bound to ? */
2747 { -asc => 'colA' }, | colA ASC,
2748 { -desc => [qw/colB/] }, | colB DESC,
2749 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2750 \'colE DESC', | colE DESC,
2751 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2752 ] | /* ...with $x bound to ? */
2753 ===============================================================
2757 =head1 SPECIAL OPERATORS
2759 my $sqlmaker = SQL::Abstract->new(special_ops => [
2763 my ($self, $field, $op, $arg) = @_;
2769 handler => 'method_name',
2773 A "special operator" is a SQL syntactic clause that can be
2774 applied to a field, instead of a usual binary operator.
2777 WHERE field IN (?, ?, ?)
2778 WHERE field BETWEEN ? AND ?
2779 WHERE MATCH(field) AGAINST (?, ?)
2781 Special operators IN and BETWEEN are fairly standard and therefore
2782 are builtin within C<SQL::Abstract> (as the overridable methods
2783 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2784 like the MATCH .. AGAINST example above which is specific to MySQL,
2785 you can write your own operator handlers - supply a C<special_ops>
2786 argument to the C<new> method. That argument takes an arrayref of
2787 operator definitions; each operator definition is a hashref with two
2794 the regular expression to match the operator
2798 Either a coderef or a plain scalar method name. In both cases
2799 the expected return is C<< ($sql, @bind) >>.
2801 When supplied with a method name, it is simply called on the
2802 L<SQL::Abstract> object as:
2804 $self->$method_name($field, $op, $arg)
2808 $field is the LHS of the operator
2809 $op is the part that matched the handler regex
2812 When supplied with a coderef, it is called as:
2814 $coderef->($self, $field, $op, $arg)
2819 For example, here is an implementation
2820 of the MATCH .. AGAINST syntax for MySQL
2822 my $sqlmaker = SQL::Abstract->new(special_ops => [
2824 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2825 {regex => qr/^match$/i,
2827 my ($self, $field, $op, $arg) = @_;
2828 $arg = [$arg] if not ref $arg;
2829 my $label = $self->_quote($field);
2830 my ($placeholder) = $self->_convert('?');
2831 my $placeholders = join ", ", (($placeholder) x @$arg);
2832 my $sql = $self->_sqlcase('match') . " ($label) "
2833 . $self->_sqlcase('against') . " ($placeholders) ";
2834 my @bind = $self->_bindtype($field, @$arg);
2835 return ($sql, @bind);
2842 =head1 UNARY OPERATORS
2844 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2848 my ($self, $op, $arg) = @_;
2854 handler => 'method_name',
2858 A "unary operator" is a SQL syntactic clause that can be
2859 applied to a field - the operator goes before the field
2861 You can write your own operator handlers - supply a C<unary_ops>
2862 argument to the C<new> method. That argument takes an arrayref of
2863 operator definitions; each operator definition is a hashref with two
2870 the regular expression to match the operator
2874 Either a coderef or a plain scalar method name. In both cases
2875 the expected return is C<< $sql >>.
2877 When supplied with a method name, it is simply called on the
2878 L<SQL::Abstract> object as:
2880 $self->$method_name($op, $arg)
2884 $op is the part that matched the handler regex
2885 $arg is the RHS or argument of the operator
2887 When supplied with a coderef, it is called as:
2889 $coderef->($self, $op, $arg)
2897 Thanks to some benchmarking by Mark Stosberg, it turns out that
2898 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2899 I must admit this wasn't an intentional design issue, but it's a
2900 byproduct of the fact that you get to control your C<DBI> handles
2903 To maximize performance, use a code snippet like the following:
2905 # prepare a statement handle using the first row
2906 # and then reuse it for the rest of the rows
2908 for my $href (@array_of_hashrefs) {
2909 $stmt ||= $sql->insert('table', $href);
2910 $sth ||= $dbh->prepare($stmt);
2911 $sth->execute($sql->values($href));
2914 The reason this works is because the keys in your C<$href> are sorted
2915 internally by B<SQL::Abstract>. Thus, as long as your data retains
2916 the same structure, you only have to generate the SQL the first time
2917 around. On subsequent queries, simply use the C<values> function provided
2918 by this module to return your values in the correct order.
2920 However this depends on the values having the same type - if, for
2921 example, the values of a where clause may either have values
2922 (resulting in sql of the form C<column = ?> with a single bind
2923 value), or alternatively the values might be C<undef> (resulting in
2924 sql of the form C<column IS NULL> with no bind value) then the
2925 caching technique suggested will not work.
2929 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2930 really like this part (I do, at least). Building up a complex query
2931 can be as simple as the following:
2938 use CGI::FormBuilder;
2941 my $form = CGI::FormBuilder->new(...);
2942 my $sql = SQL::Abstract->new;
2944 if ($form->submitted) {
2945 my $field = $form->field;
2946 my $id = delete $field->{id};
2947 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2950 Of course, you would still have to connect using C<DBI> to run the
2951 query, but the point is that if you make your form look like your
2952 table, the actual query script can be extremely simplistic.
2954 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2955 a fast interface to returning and formatting data. I frequently
2956 use these three modules together to write complex database query
2957 apps in under 50 lines.
2959 =head1 HOW TO CONTRIBUTE
2961 Contributions are always welcome, in all usable forms (we especially
2962 welcome documentation improvements). The delivery methods include git-
2963 or unified-diff formatted patches, GitHub pull requests, or plain bug
2964 reports either via RT or the Mailing list. Contributors are generally
2965 granted full access to the official repository after their first several
2966 patches pass successful review.
2968 This project is maintained in a git repository. The code and related tools are
2969 accessible at the following locations:
2973 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2975 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
2977 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
2979 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
2985 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2986 Great care has been taken to preserve the I<published> behavior
2987 documented in previous versions in the 1.* family; however,
2988 some features that were previously undocumented, or behaved
2989 differently from the documentation, had to be changed in order
2990 to clarify the semantics. Hence, client code that was relying
2991 on some dark areas of C<SQL::Abstract> v1.*
2992 B<might behave differently> in v1.50.
2994 The main changes are:
3000 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3004 support for the { operator => \"..." } construct (to embed literal SQL)
3008 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3012 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3016 defensive programming: check arguments
3020 fixed bug with global logic, which was previously implemented
3021 through global variables yielding side-effects. Prior versions would
3022 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3023 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3024 Now this is interpreted
3025 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3030 fixed semantics of _bindtype on array args
3034 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3035 we just avoid shifting arrays within that tree.
3039 dropped the C<_modlogic> function
3043 =head1 ACKNOWLEDGEMENTS
3045 There are a number of individuals that have really helped out with
3046 this module. Unfortunately, most of them submitted bugs via CPAN
3047 so I have no idea who they are! But the people I do know are:
3049 Ash Berlin (order_by hash term support)
3050 Matt Trout (DBIx::Class support)
3051 Mark Stosberg (benchmarking)
3052 Chas Owens (initial "IN" operator support)
3053 Philip Collins (per-field SQL functions)
3054 Eric Kolve (hashref "AND" support)
3055 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3056 Dan Kubb (support for "quote_char" and "name_sep")
3057 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3058 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3059 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3060 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3061 Oliver Charles (support for "RETURNING" after "INSERT")
3067 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3071 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3073 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3075 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3076 While not an official support venue, C<DBIx::Class> makes heavy use of
3077 C<SQL::Abstract>, and as such list members there are very familiar with
3078 how to create queries.
3082 This module is free software; you may copy this under the same
3083 terms as perl itself (either the GNU General Public License or
3084 the Artistic License)