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) = @_;
514 local $self->{convert_where} = $self->{convert};
517 my ($sql, @bind) = defined($where)
518 ? $self->_recurse_where($where)
520 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
524 my ($order_sql, @order_bind) = $self->_order_by($order);
526 push @bind, @order_bind;
529 return wantarray ? ($sql, @bind) : $sql;
533 my ($self, $expr, $logic, $default_scalar_to) = @_;
534 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
535 return undef unless defined($expr);
536 if (ref($expr) eq 'HASH') {
537 if (keys %$expr > 1) {
541 map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
545 return unless %$expr;
546 return $self->_expand_expr_hashpair(%$expr, $logic);
548 if (ref($expr) eq 'ARRAY') {
549 my $logic = lc($logic || $self->{logic});
550 $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
556 while (my ($el) = splice @expr, 0, 1) {
557 puke "Supplying an empty left hand side argument is not supported in array-pairs"
558 unless defined($el) and length($el);
559 my $elref = ref($el);
561 push(@res, $self->_expand_expr({ $el, shift(@expr) }));
562 } elsif ($elref eq 'ARRAY') {
563 push(@res, $self->_expand_expr($el)) if @$el;
564 } elsif (my $l = is_literal_value($el)) {
565 push @res, { -literal => $l };
566 } elsif ($elref eq 'HASH') {
567 push @res, $self->_expand_expr($el);
572 return { -op => [ $logic, @res ] };
574 if (my $literal = is_literal_value($expr)) {
575 return +{ -literal => $literal };
577 if (!ref($expr) or Scalar::Util::blessed($expr)) {
578 if (my $d = $Default_Scalar_To) {
579 return +{ $d => $expr };
581 if (my $m = our $Cur_Col_Meta) {
582 return +{ -bind => [ $m, $expr ] };
584 return +{ -value => $expr };
589 sub _expand_expr_hashpair {
590 my ($self, $k, $v, $logic) = @_;
591 unless (defined($k) and length($k)) {
592 if (defined($k) and my $literal = is_literal_value($v)) {
593 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
594 return { -literal => $literal };
596 puke "Supplying an empty left hand side argument is not supported";
599 $self->_assert_pass_injection_guard($k =~ /^-(.*)$/s);
600 if ($k =~ s/ [_\s]? \d+ $//x ) {
601 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
602 . "You probably wanted ...-and => [ $k => COND1, $k => COND2 ... ]";
605 return $self->_expand_expr($v);
609 return $self->_expand_expr($v);
611 puke "-bool => undef not supported" unless defined($v);
612 return { -ident => $v };
615 return { -op => [ 'not', $self->_expand_expr($v) ] };
617 if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
620 $self->_expand_expr_hashpair("-${rest}", $v, $logic)
623 if (my ($logic) = $k =~ /^-(and|or)$/i) {
624 if (ref($v) eq 'HASH') {
625 return $self->_expand_expr($v, $logic);
627 if (ref($v) eq 'ARRAY') {
628 return $self->_expand_expr($v, $logic);
633 $op =~ s/^-// if length($op) > 1;
635 # top level special ops are illegal in general
636 puke "Illegal use of top-level '-$op'"
637 if List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
639 if ($k eq '-value' and my $m = our $Cur_Col_Meta) {
640 return +{ -bind => [ $m, $v ] };
642 if ($k eq '-op' or $k eq '-ident' or $k eq '-value' or $k eq '-bind' or $k eq '-literal' or $k eq '-func') {
645 if (my $custom = $self->{custom_expansions}{($k =~ /^-(.*)$/)[0]}) {
646 return $self->$custom($v);
651 and (keys %$v)[0] =~ /^-/
653 my ($func) = $k =~ /^-(.*)$/;
654 return +{ -func => [ $func, $self->_expand_expr($v) ] };
656 if (!ref($v) or is_literal_value($v)) {
657 return +{ -op => [ $k =~ /^-(.*)$/, $self->_expand_expr($v) ] };
664 and exists $v->{-value}
665 and not defined $v->{-value}
668 return $self->_expand_expr_hashpair($k => { $self->{cmp} => undef });
670 if (!ref($v) or Scalar::Util::blessed($v)) {
675 { -bind => [ $k, $v ] }
679 if (ref($v) eq 'HASH') {
683 map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
690 $self->_assert_pass_injection_guard($vk);
691 if ($vk =~ s/ [_\s]? \d+ $//x ) {
692 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
693 . "You probably wanted ...-and => [ -$vk => COND1, -$vk => COND2 ... ]";
695 if ($vk =~ /^(?:not[ _])?between$/) {
696 local our $Cur_Col_Meta = $k;
697 my @rhs = map $self->_expand_expr($_),
698 ref($vv) eq 'ARRAY' ? @$vv : $vv;
700 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
702 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
704 puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
707 join(' ', split '_', $vk),
712 if ($vk =~ /^(?:not[ _])?in$/) {
713 if (my $literal = is_literal_value($vv)) {
714 my ($sql, @bind) = @$literal;
715 my $opened_sql = $self->_open_outer_paren($sql);
717 $vk, { -ident => $k },
718 [ { -literal => [ $opened_sql, @bind ] } ]
722 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
723 . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
724 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
725 . 'will emit the logically correct SQL instead of raising this exception)'
727 puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
729 my @rhs = map $self->_expand_expr($_),
730 map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
731 map { defined($_) ? $_: puke($undef_err) }
732 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
733 return $self->${\($vk =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
736 join(' ', split '_', $vk),
741 if ($vk eq 'ident') {
742 if (! defined $vv or ref $vv) {
743 puke "-$vk requires a single plain scalar argument (a quotable identifier)";
751 if ($vk eq 'value') {
752 return $self->_expand_expr_hashpair($k, undef) unless defined($vv);
756 { -bind => [ $k, $vv ] }
759 if ($vk =~ /^is(?:[ _]not)?$/) {
760 puke "$vk can only take undef as argument"
764 and exists($vv->{-value})
765 and !defined($vv->{-value})
768 return +{ -op => [ $vk.' null', { -ident => $k } ] };
770 if ($vk =~ /^(and|or)$/) {
771 if (ref($vv) eq 'HASH') {
774 map $self->_expand_expr_hashpair($k, { $_ => $vv->{$_} }),
779 if (my $us = List::Util::first { $vk =~ $_->{regex} } @{$self->{user_special_ops}}) {
780 return { -op => [ $vk, { -ident => $k }, $vv ] };
782 if (ref($vv) eq 'ARRAY') {
783 my ($logic, @values) = (
784 (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i)
789 $vk =~ $self->{inequality_op}
790 or join(' ', split '_', $vk) =~ $self->{not_like_op}
792 if (lc($logic) eq '-or' and @values > 1) {
793 my $op = uc join ' ', split '_', $vk;
794 belch "A multi-element arrayref as an argument to the inequality op '$op' "
795 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
796 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
801 # try to DWIM on equality operators
802 my $op = join ' ', split '_', $vk;
804 $op =~ $self->{equality_op} ? $self->sqlfalse
805 : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse
806 : $op =~ $self->{inequality_op} ? $self->sqltrue
807 : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue
808 : puke "operator '$op' applied on an empty array (field '$k')";
812 map $self->_expand_expr_hashpair($k => { $vk => $_ }),
820 and exists $vv->{-value}
821 and not defined $vv->{-value}
824 my $op = join ' ', split '_', $vk;
826 $op =~ /^not$/i ? 'is not' # legacy
827 : $op =~ $self->{equality_op} ? 'is'
828 : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
829 : $op =~ $self->{inequality_op} ? 'is not'
830 : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
831 : puke "unexpected operator '$op' with undef operand";
832 return +{ -op => [ $is.' null', { -ident => $k } ] };
834 local our $Cur_Col_Meta = $k;
838 $self->_expand_expr($vv)
841 if (ref($v) eq 'ARRAY') {
842 return $self->sqlfalse unless @$v;
843 $self->_debug("ARRAY($k) means distribute over elements");
845 $v->[0] =~ /^-((?:and|or))$/i
846 ? ($v = [ @{$v}[1..$#$v] ], $1)
847 : ($self->{logic} || 'or')
851 map $self->_expand_expr({ $k => $_ }, $this_logic), @$v
854 if (my $literal = is_literal_value($v)) {
856 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
859 my ($sql, @bind) = @$literal;
860 if ($self->{bindtype} eq 'columns') {
862 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
863 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
867 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
873 my ($self, $expr) = @_;
874 my ($k, $v, @rest) = %$expr;
876 my %op = map +("-$_" => '_render_'.$_),
877 qw(op func value bind ident literal);
878 if (my $meth = $op{$k}) {
879 return $self->$meth($v);
881 die "notreached: $k";
885 my ($self, $where, $logic) = @_;
887 #print STDERR Data::Dumper::Concise::Dumper([ $where, $logic ]);
889 my $where_exp = $self->_expand_expr($where, $logic);
891 #print STDERR Data::Dumper::Concise::Dumper([ EXP => $where_exp ]);
893 # dispatch on appropriate method according to refkind of $where
894 # my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
896 # my ($sql, @bind) = $self->$method($where_exp, $logic);
898 my ($sql, @bind) = defined($where_exp) ? $self->_render_expr($where_exp) : (undef);
900 # DBIx::Class used to call _recurse_where in scalar context
901 # something else might too...
903 return ($sql, @bind);
906 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
912 my ($self, $ident) = @_;
914 return $self->_convert($self->_quote($ident));
918 my ($self, $value) = @_;
920 return ($self->_convert('?'), $self->_bindtype(undef, $value));
923 my %unop_postfix = map +($_ => 1),
924 'is null', 'is not null',
932 my ($self, $args) = @_;
933 my ($left, $low, $high) = @$args;
934 my ($rhsql, @rhbind) = do {
936 puke "Single arg to between must be a literal"
937 unless $low->{-literal};
940 my ($l, $h) = map [ $self->_render_expr($_) ], $low, $high;
941 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
942 @{$l}[1..$#$l], @{$h}[1..$#$h])
945 my ($lhsql, @lhbind) = $self->_render_expr($left);
947 join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
951 }), 'between', 'not between'),
955 my ($self, $args) = @_;
956 my ($lhs, $rhs) = @$args;
959 my ($sql, @bind) = $self->_render_expr($_);
960 push @in_bind, @bind;
963 my ($lhsql, @lbind) = $self->_render_expr($lhs);
965 $lhsql.' '.$self->_sqlcase($op).' ( '
976 my ($op, @args) = @$v;
977 $op =~ s/^-// if length($op) > 1;
979 if (my $h = $special{$op}) {
980 return $self->$h(\@args);
982 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{user_special_ops}}) {
983 puke "Special op '${op}' requires first value to be identifier"
984 unless my ($k) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
985 return $self->${\($us->{handler})}($k, $op, $args[1]);
987 my $final_op = $op =~ /^(?:is|not)_/ ? join(' ', split '_', $op) : $op;
988 if (@args == 1 and $op !~ /^(and|or)$/) {
989 my ($expr_sql, @bind) = $self->_render_expr($args[0]);
990 my $op_sql = $self->_sqlcase($final_op);
992 $unop_postfix{lc($final_op)}
993 ? "${expr_sql} ${op_sql}"
994 : "${op_sql} ${expr_sql}"
996 return (($op eq 'not' ? '('.$final_sql.')' : $final_sql), @bind);
998 my @parts = map [ $self->_render_expr($_) ], @args;
999 my ($final_sql) = map +($op =~ /^(and|or)$/ ? "(${_})" : $_), join(
1000 ($final_op eq ',' ? '' : ' ').$self->_sqlcase($final_op).' ',
1005 map @{$_}[1..$#$_], @parts
1012 my ($self, $rest) = @_;
1013 my ($func, @args) = @$rest;
1017 push @arg_sql, shift @x;
1019 } map [ $self->_render_expr($_) ], @args;
1020 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1024 my ($self, $bind) = @_;
1025 return ($self->_convert('?'), $self->_bindtype(@$bind));
1028 sub _render_literal {
1029 my ($self, $literal) = @_;
1030 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1034 # Some databases (SQLite) treat col IN (1, 2) different from
1035 # col IN ( (1, 2) ). Use this to strip all outer parens while
1036 # adding them back in the corresponding method
1037 sub _open_outer_paren {
1038 my ($self, $sql) = @_;
1040 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1042 # there are closing parens inside, need the heavy duty machinery
1043 # to reevaluate the extraction starting from $sql (full reevaluation)
1044 if ($inner =~ /\)/) {
1045 require Text::Balanced;
1047 my (undef, $remainder) = do {
1048 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1050 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1053 # the entire expression needs to be a balanced bracketed thing
1054 # (after an extract no remainder sans trailing space)
1055 last if defined $remainder and $remainder =~ /\S/;
1065 #======================================================================
1067 #======================================================================
1070 my ($self, $arg) = @_;
1072 return '' unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1074 my $expander = sub {
1075 my ($self, $dir, $expr) = @_;
1076 my @exp = map +(defined($dir) ? { -op => [ $dir => $_ ] } : $_),
1077 map $self->_expand_expr($_, undef, -ident),
1078 ref($expr) eq 'ARRAY' ? @$expr : $expr;
1079 return (@exp > 1 ? { -op => [ ',', @exp ] } : $exp[0]);
1082 local $self->{custom_expansions} = {
1083 asc => sub { shift->$expander(asc => @_) },
1084 desc => sub { shift->$expander(desc => @_) },
1087 my $expanded = $self->$expander(undef, $arg);
1089 my ($sql, @bind) = $self->_render_expr($expanded);
1091 my $final_sql = $self->_sqlcase(' order by ').$sql;
1093 return wantarray ? ($final_sql, @bind) : $final_sql;
1096 #======================================================================
1097 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1098 #======================================================================
1103 ($self->_render_expr(
1104 $self->_expand_maybe_list_expr($from, undef, -ident)
1109 #======================================================================
1111 #======================================================================
1113 sub _expand_maybe_list_expr {
1114 my ($self, $expr, $logic, $default) = @_;
1116 if (ref($expr) eq 'ARRAY') {
1118 ',', map $self->_expand_expr($_, $logic, $default), @$expr
1125 return $self->_expand_expr($e, $logic, $default);
1128 # highly optimized, as it's called way too often
1130 # my ($self, $label) = @_;
1132 return '' unless defined $_[1];
1133 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1135 $_[0]->{quote_char} or
1136 ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1138 my $qref = ref $_[0]->{quote_char};
1140 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1141 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1142 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1144 my $esc = $_[0]->{escape_char} || $r;
1146 # parts containing * are naturally unquoted
1147 return join($_[0]->{name_sep}||'', map
1148 +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1149 ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1154 # Conversion, if applicable
1156 #my ($self, $arg) = @_;
1157 if ($_[0]->{convert_where}) {
1158 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1165 #my ($self, $col, @vals) = @_;
1166 # called often - tighten code
1167 return $_[0]->{bindtype} eq 'columns'
1168 ? map {[$_[1], $_]} @_[2 .. $#_]
1173 # Dies if any element of @bind is not in [colname => value] format
1174 # if bindtype is 'columns'.
1175 sub _assert_bindval_matches_bindtype {
1176 # my ($self, @bind) = @_;
1178 if ($self->{bindtype} eq 'columns') {
1180 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1181 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1187 sub _join_sql_clauses {
1188 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1190 if (@$clauses_aref > 1) {
1191 my $join = " " . $self->_sqlcase($logic) . " ";
1192 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1193 return ($sql, @$bind_aref);
1195 elsif (@$clauses_aref) {
1196 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1199 return (); # if no SQL, ignore @$bind_aref
1204 # Fix SQL case, if so requested
1206 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1207 # don't touch the argument ... crooked logic, but let's not change it!
1208 return $_[0]->{case} ? $_[1] : uc($_[1]);
1212 #======================================================================
1213 # DISPATCHING FROM REFKIND
1214 #======================================================================
1217 my ($self, $data) = @_;
1219 return 'UNDEF' unless defined $data;
1221 # blessed objects are treated like scalars
1222 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1224 return 'SCALAR' unless $ref;
1227 while ($ref eq 'REF') {
1229 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1233 return ($ref||'SCALAR') . ('REF' x $n_steps);
1237 my ($self, $data) = @_;
1238 my @try = ($self->_refkind($data));
1239 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1240 push @try, 'FALLBACK';
1244 sub _METHOD_FOR_refkind {
1245 my ($self, $meth_prefix, $data) = @_;
1248 for (@{$self->_try_refkind($data)}) {
1249 $method = $self->can($meth_prefix."_".$_)
1253 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1257 sub _SWITCH_refkind {
1258 my ($self, $data, $dispatch_table) = @_;
1261 for (@{$self->_try_refkind($data)}) {
1262 $coderef = $dispatch_table->{$_}
1266 puke "no dispatch entry for ".$self->_refkind($data)
1275 #======================================================================
1276 # VALUES, GENERATE, AUTOLOAD
1277 #======================================================================
1279 # LDNOTE: original code from nwiger, didn't touch code in that section
1280 # I feel the AUTOLOAD stuff should not be the default, it should
1281 # only be activated on explicit demand by user.
1285 my $data = shift || return;
1286 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1287 unless ref $data eq 'HASH';
1290 foreach my $k (sort keys %$data) {
1291 my $v = $data->{$k};
1292 $self->_SWITCH_refkind($v, {
1294 if ($self->{array_datatypes}) { # array datatype
1295 push @all_bind, $self->_bindtype($k, $v);
1297 else { # literal SQL with bind
1298 my ($sql, @bind) = @$v;
1299 $self->_assert_bindval_matches_bindtype(@bind);
1300 push @all_bind, @bind;
1303 ARRAYREFREF => sub { # literal SQL with bind
1304 my ($sql, @bind) = @${$v};
1305 $self->_assert_bindval_matches_bindtype(@bind);
1306 push @all_bind, @bind;
1308 SCALARREF => sub { # literal SQL without bind
1310 SCALAR_or_UNDEF => sub {
1311 push @all_bind, $self->_bindtype($k, $v);
1322 my(@sql, @sqlq, @sqlv);
1326 if ($ref eq 'HASH') {
1327 for my $k (sort keys %$_) {
1330 my $label = $self->_quote($k);
1331 if ($r eq 'ARRAY') {
1332 # literal SQL with bind
1333 my ($sql, @bind) = @$v;
1334 $self->_assert_bindval_matches_bindtype(@bind);
1335 push @sqlq, "$label = $sql";
1337 } elsif ($r eq 'SCALAR') {
1338 # literal SQL without bind
1339 push @sqlq, "$label = $$v";
1341 push @sqlq, "$label = ?";
1342 push @sqlv, $self->_bindtype($k, $v);
1345 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1346 } elsif ($ref eq 'ARRAY') {
1347 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1350 if ($r eq 'ARRAY') { # literal SQL with bind
1351 my ($sql, @bind) = @$v;
1352 $self->_assert_bindval_matches_bindtype(@bind);
1355 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1356 # embedded literal SQL
1363 push @sql, '(' . join(', ', @sqlq) . ')';
1364 } elsif ($ref eq 'SCALAR') {
1368 # strings get case twiddled
1369 push @sql, $self->_sqlcase($_);
1373 my $sql = join ' ', @sql;
1375 # this is pretty tricky
1376 # if ask for an array, return ($stmt, @bind)
1377 # otherwise, s/?/shift @sqlv/ to put it inline
1379 return ($sql, @sqlv);
1381 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1382 ref $d ? $d->[1] : $d/e;
1391 # This allows us to check for a local, then _form, attr
1393 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1394 return $self->generate($name, @_);
1405 SQL::Abstract - Generate SQL from Perl data structures
1411 my $sql = SQL::Abstract->new;
1413 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1415 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1417 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1419 my($stmt, @bind) = $sql->delete($table, \%where);
1421 # Then, use these in your DBI statements
1422 my $sth = $dbh->prepare($stmt);
1423 $sth->execute(@bind);
1425 # Just generate the WHERE clause
1426 my($stmt, @bind) = $sql->where(\%where, $order);
1428 # Return values in the same order, for hashed queries
1429 # See PERFORMANCE section for more details
1430 my @bind = $sql->values(\%fieldvals);
1434 This module was inspired by the excellent L<DBIx::Abstract>.
1435 However, in using that module I found that what I really wanted
1436 to do was generate SQL, but still retain complete control over my
1437 statement handles and use the DBI interface. So, I set out to
1438 create an abstract SQL generation module.
1440 While based on the concepts used by L<DBIx::Abstract>, there are
1441 several important differences, especially when it comes to WHERE
1442 clauses. I have modified the concepts used to make the SQL easier
1443 to generate from Perl data structures and, IMO, more intuitive.
1444 The underlying idea is for this module to do what you mean, based
1445 on the data structures you provide it. The big advantage is that
1446 you don't have to modify your code every time your data changes,
1447 as this module figures it out.
1449 To begin with, an SQL INSERT is as easy as just specifying a hash
1450 of C<key=value> pairs:
1453 name => 'Jimbo Bobson',
1454 phone => '123-456-7890',
1455 address => '42 Sister Lane',
1456 city => 'St. Louis',
1457 state => 'Louisiana',
1460 The SQL can then be generated with this:
1462 my($stmt, @bind) = $sql->insert('people', \%data);
1464 Which would give you something like this:
1466 $stmt = "INSERT INTO people
1467 (address, city, name, phone, state)
1468 VALUES (?, ?, ?, ?, ?)";
1469 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1470 '123-456-7890', 'Louisiana');
1472 These are then used directly in your DBI code:
1474 my $sth = $dbh->prepare($stmt);
1475 $sth->execute(@bind);
1477 =head2 Inserting and Updating Arrays
1479 If your database has array types (like for example Postgres),
1480 activate the special option C<< array_datatypes => 1 >>
1481 when creating the C<SQL::Abstract> object.
1482 Then you may use an arrayref to insert and update database array types:
1484 my $sql = SQL::Abstract->new(array_datatypes => 1);
1486 planets => [qw/Mercury Venus Earth Mars/]
1489 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1493 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1495 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1498 =head2 Inserting and Updating SQL
1500 In order to apply SQL functions to elements of your C<%data> you may
1501 specify a reference to an arrayref for the given hash value. For example,
1502 if you need to execute the Oracle C<to_date> function on a value, you can
1503 say something like this:
1507 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1510 The first value in the array is the actual SQL. Any other values are
1511 optional and would be included in the bind values array. This gives
1514 my($stmt, @bind) = $sql->insert('people', \%data);
1516 $stmt = "INSERT INTO people (name, date_entered)
1517 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1518 @bind = ('Bill', '03/02/2003');
1520 An UPDATE is just as easy, all you change is the name of the function:
1522 my($stmt, @bind) = $sql->update('people', \%data);
1524 Notice that your C<%data> isn't touched; the module will generate
1525 the appropriately quirky SQL for you automatically. Usually you'll
1526 want to specify a WHERE clause for your UPDATE, though, which is
1527 where handling C<%where> hashes comes in handy...
1529 =head2 Complex where statements
1531 This module can generate pretty complicated WHERE statements
1532 easily. For example, simple C<key=value> pairs are taken to mean
1533 equality, and if you want to see if a field is within a set
1534 of values, you can use an arrayref. Let's say we wanted to
1535 SELECT some data based on this criteria:
1538 requestor => 'inna',
1539 worker => ['nwiger', 'rcwe', 'sfz'],
1540 status => { '!=', 'completed' }
1543 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1545 The above would give you something like this:
1547 $stmt = "SELECT * FROM tickets WHERE
1548 ( requestor = ? ) AND ( status != ? )
1549 AND ( worker = ? OR worker = ? OR worker = ? )";
1550 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1552 Which you could then use in DBI code like so:
1554 my $sth = $dbh->prepare($stmt);
1555 $sth->execute(@bind);
1561 The methods are simple. There's one for every major SQL operation,
1562 and a constructor you use first. The arguments are specified in a
1563 similar order for each method (table, then fields, then a where
1564 clause) to try and simplify things.
1566 =head2 new(option => 'value')
1568 The C<new()> function takes a list of options and values, and returns
1569 a new B<SQL::Abstract> object which can then be used to generate SQL
1570 through the methods below. The options accepted are:
1576 If set to 'lower', then SQL will be generated in all lowercase. By
1577 default SQL is generated in "textbook" case meaning something like:
1579 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1581 Any setting other than 'lower' is ignored.
1585 This determines what the default comparison operator is. By default
1586 it is C<=>, meaning that a hash like this:
1588 %where = (name => 'nwiger', email => 'nate@wiger.org');
1590 Will generate SQL like this:
1592 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1594 However, you may want loose comparisons by default, so if you set
1595 C<cmp> to C<like> you would get SQL such as:
1597 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1599 You can also override the comparison on an individual basis - see
1600 the huge section on L</"WHERE CLAUSES"> at the bottom.
1602 =item sqltrue, sqlfalse
1604 Expressions for inserting boolean values within SQL statements.
1605 By default these are C<1=1> and C<1=0>. They are used
1606 by the special operators C<-in> and C<-not_in> for generating
1607 correct SQL even when the argument is an empty array (see below).
1611 This determines the default logical operator for multiple WHERE
1612 statements in arrays or hashes. If absent, the default logic is "or"
1613 for arrays, and "and" for hashes. This means that a WHERE
1617 event_date => {'>=', '2/13/99'},
1618 event_date => {'<=', '4/24/03'},
1621 will generate SQL like this:
1623 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1625 This is probably not what you want given this query, though (look
1626 at the dates). To change the "OR" to an "AND", simply specify:
1628 my $sql = SQL::Abstract->new(logic => 'and');
1630 Which will change the above C<WHERE> to:
1632 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1634 The logic can also be changed locally by inserting
1635 a modifier in front of an arrayref:
1637 @where = (-and => [event_date => {'>=', '2/13/99'},
1638 event_date => {'<=', '4/24/03'} ]);
1640 See the L</"WHERE CLAUSES"> section for explanations.
1644 This will automatically convert comparisons using the specified SQL
1645 function for both column and value. This is mostly used with an argument
1646 of C<upper> or C<lower>, so that the SQL will have the effect of
1647 case-insensitive "searches". For example, this:
1649 $sql = SQL::Abstract->new(convert => 'upper');
1650 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1652 Will turn out the following SQL:
1654 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1656 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1657 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1658 not validate this option; it will just pass through what you specify verbatim).
1662 This is a kludge because many databases suck. For example, you can't
1663 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1664 Instead, you have to use C<bind_param()>:
1666 $sth->bind_param(1, 'reg data');
1667 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1669 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1670 which loses track of which field each slot refers to. Fear not.
1672 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1673 Currently, you can specify either C<normal> (default) or C<columns>. If you
1674 specify C<columns>, you will get an array that looks like this:
1676 my $sql = SQL::Abstract->new(bindtype => 'columns');
1677 my($stmt, @bind) = $sql->insert(...);
1680 [ 'column1', 'value1' ],
1681 [ 'column2', 'value2' ],
1682 [ 'column3', 'value3' ],
1685 You can then iterate through this manually, using DBI's C<bind_param()>.
1687 $sth->prepare($stmt);
1690 my($col, $data) = @$_;
1691 if ($col eq 'details' || $col eq 'comments') {
1692 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1693 } elsif ($col eq 'image') {
1694 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1696 $sth->bind_param($i, $data);
1700 $sth->execute; # execute without @bind now
1702 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1703 Basically, the advantage is still that you don't have to care which fields
1704 are or are not included. You could wrap that above C<for> loop in a simple
1705 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1706 get a layer of abstraction over manual SQL specification.
1708 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1709 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1710 will expect the bind values in this format.
1714 This is the character that a table or column name will be quoted
1715 with. By default this is an empty string, but you could set it to
1716 the character C<`>, to generate SQL like this:
1718 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1720 Alternatively, you can supply an array ref of two items, the first being the left
1721 hand quote character, and the second the right hand quote character. For
1722 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1723 that generates SQL like this:
1725 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1727 Quoting is useful if you have tables or columns names that are reserved
1728 words in your database's SQL dialect.
1732 This is the character that will be used to escape L</quote_char>s appearing
1733 in an identifier before it has been quoted.
1735 The parameter default in case of a single L</quote_char> character is the quote
1738 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1739 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1740 of the B<opening (left)> L</quote_char> within the identifier are currently left
1741 untouched. The default for opening-closing-style quotes may change in future
1742 versions, thus you are B<strongly encouraged> to specify the escape character
1747 This is the character that separates a table and column name. It is
1748 necessary to specify this when the C<quote_char> option is selected,
1749 so that tables and column names can be individually quoted like this:
1751 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1753 =item injection_guard
1755 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
1756 column name specified in a query structure. This is a safety mechanism to avoid
1757 injection attacks when mishandling user input e.g.:
1759 my %condition_as_column_value_pairs = get_values_from_user();
1760 $sqla->select( ... , \%condition_as_column_value_pairs );
1762 If the expression matches an exception is thrown. Note that literal SQL
1763 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
1765 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
1767 =item array_datatypes
1769 When this option is true, arrayrefs in INSERT or UPDATE are
1770 interpreted as array datatypes and are passed directly
1772 When this option is false, arrayrefs are interpreted
1773 as literal SQL, just like refs to arrayrefs
1774 (but this behavior is for backwards compatibility; when writing
1775 new queries, use the "reference to arrayref" syntax
1781 Takes a reference to a list of "special operators"
1782 to extend the syntax understood by L<SQL::Abstract>.
1783 See section L</"SPECIAL OPERATORS"> for details.
1787 Takes a reference to a list of "unary operators"
1788 to extend the syntax understood by L<SQL::Abstract>.
1789 See section L</"UNARY OPERATORS"> for details.
1795 =head2 insert($table, \@values || \%fieldvals, \%options)
1797 This is the simplest function. You simply give it a table name
1798 and either an arrayref of values or hashref of field/value pairs.
1799 It returns an SQL INSERT statement and a list of bind values.
1800 See the sections on L</"Inserting and Updating Arrays"> and
1801 L</"Inserting and Updating SQL"> for information on how to insert
1802 with those data types.
1804 The optional C<\%options> hash reference may contain additional
1805 options to generate the insert SQL. Currently supported options
1812 Takes either a scalar of raw SQL fields, or an array reference of
1813 field names, and adds on an SQL C<RETURNING> statement at the end.
1814 This allows you to return data generated by the insert statement
1815 (such as row IDs) without performing another C<SELECT> statement.
1816 Note, however, this is not part of the SQL standard and may not
1817 be supported by all database engines.
1821 =head2 update($table, \%fieldvals, \%where, \%options)
1823 This takes a table, hashref of field/value pairs, and an optional
1824 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1826 See the sections on L</"Inserting and Updating Arrays"> and
1827 L</"Inserting and Updating SQL"> for information on how to insert
1828 with those data types.
1830 The optional C<\%options> hash reference may contain additional
1831 options to generate the update SQL. Currently supported options
1838 See the C<returning> option to
1839 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1843 =head2 select($source, $fields, $where, $order)
1845 This returns a SQL SELECT statement and associated list of bind values, as
1846 specified by the arguments:
1852 Specification of the 'FROM' part of the statement.
1853 The argument can be either a plain scalar (interpreted as a table
1854 name, will be quoted), or an arrayref (interpreted as a list
1855 of table names, joined by commas, quoted), or a scalarref
1856 (literal SQL, not quoted).
1860 Specification of the list of fields to retrieve from
1862 The argument can be either an arrayref (interpreted as a list
1863 of field names, will be joined by commas and quoted), or a
1864 plain scalar (literal SQL, not quoted).
1865 Please observe that this API is not as flexible as that of
1866 the first argument C<$source>, for backwards compatibility reasons.
1870 Optional argument to specify the WHERE part of the query.
1871 The argument is most often a hashref, but can also be
1872 an arrayref or plain scalar --
1873 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1877 Optional argument to specify the ORDER BY part of the query.
1878 The argument can be a scalar, a hashref or an arrayref
1879 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1885 =head2 delete($table, \%where, \%options)
1887 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1888 It returns an SQL DELETE statement and list of bind values.
1890 The optional C<\%options> hash reference may contain additional
1891 options to generate the delete SQL. Currently supported options
1898 See the C<returning> option to
1899 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
1903 =head2 where(\%where, $order)
1905 This is used to generate just the WHERE clause. For example,
1906 if you have an arbitrary data structure and know what the
1907 rest of your SQL is going to look like, but want an easy way
1908 to produce a WHERE clause, use this. It returns an SQL WHERE
1909 clause and list of bind values.
1912 =head2 values(\%data)
1914 This just returns the values from the hash C<%data>, in the same
1915 order that would be returned from any of the other above queries.
1916 Using this allows you to markedly speed up your queries if you
1917 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1919 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1921 Warning: This is an experimental method and subject to change.
1923 This returns arbitrarily generated SQL. It's a really basic shortcut.
1924 It will return two different things, depending on return context:
1926 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
1927 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
1929 These would return the following:
1931 # First calling form
1932 $stmt = "CREATE TABLE test (?, ?)";
1933 @bind = (field1, field2);
1935 # Second calling form
1936 $stmt_and_val = "CREATE TABLE test (field1, field2)";
1938 Depending on what you're trying to do, it's up to you to choose the correct
1939 format. In this example, the second form is what you would want.
1943 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
1947 ALTER SESSION SET nls_date_format = 'MM/YY'
1949 You get the idea. Strings get their case twiddled, but everything
1950 else remains verbatim.
1952 =head1 EXPORTABLE FUNCTIONS
1954 =head2 is_plain_value
1956 Determines if the supplied argument is a plain value as understood by this
1961 =item * The value is C<undef>
1963 =item * The value is a non-reference
1965 =item * The value is an object with stringification overloading
1967 =item * The value is of the form C<< { -value => $anything } >>
1971 On failure returns C<undef>, on success returns a B<scalar> reference
1972 to the original supplied argument.
1978 The stringification overloading detection is rather advanced: it takes
1979 into consideration not only the presence of a C<""> overload, but if that
1980 fails also checks for enabled
1981 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
1982 on either C<0+> or C<bool>.
1984 Unfortunately testing in the field indicates that this
1985 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
1986 but only when very large numbers of stringifying objects are involved.
1987 At the time of writing ( Sep 2014 ) there is no clear explanation of
1988 the direct cause, nor is there a manageably small test case that reliably
1989 reproduces the problem.
1991 If you encounter any of the following exceptions in B<random places within
1992 your application stack> - this module may be to blame:
1994 Operation "ne": no method found,
1995 left argument in overloaded package <something>,
1996 right argument in overloaded package <something>
2000 Stub found while resolving method "???" overloading """" in package <something>
2002 If you fall victim to the above - please attempt to reduce the problem
2003 to something that could be sent to the L<SQL::Abstract developers
2004 |DBIx::Class/GETTING HELP/SUPPORT>
2005 (either publicly or privately). As a workaround in the meantime you can
2006 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2007 value, which will most likely eliminate your problem (at the expense of
2008 not being able to properly detect exotic forms of stringification).
2010 This notice and environment variable will be removed in a future version,
2011 as soon as the underlying problem is found and a reliable workaround is
2016 =head2 is_literal_value
2018 Determines if the supplied argument is a literal value as understood by this
2023 =item * C<\$sql_string>
2025 =item * C<\[ $sql_string, @bind_values ]>
2029 On failure returns C<undef>, on success returns an B<array> reference
2030 containing the unpacked version of the supplied literal SQL and bind values.
2032 =head1 WHERE CLAUSES
2036 This module uses a variation on the idea from L<DBIx::Abstract>. It
2037 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2038 module is that things in arrays are OR'ed, and things in hashes
2041 The easiest way to explain is to show lots of examples. After
2042 each C<%where> hash shown, it is assumed you used:
2044 my($stmt, @bind) = $sql->where(\%where);
2046 However, note that the C<%where> hash can be used directly in any
2047 of the other functions as well, as described above.
2049 =head2 Key-value pairs
2051 So, let's get started. To begin, a simple hash:
2055 status => 'completed'
2058 Is converted to SQL C<key = val> statements:
2060 $stmt = "WHERE user = ? AND status = ?";
2061 @bind = ('nwiger', 'completed');
2063 One common thing I end up doing is having a list of values that
2064 a field can be in. To do this, simply specify a list inside of
2069 status => ['assigned', 'in-progress', 'pending'];
2072 This simple code will create the following:
2074 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2075 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2077 A field associated to an empty arrayref will be considered a
2078 logical false and will generate 0=1.
2080 =head2 Tests for NULL values
2082 If the value part is C<undef> then this is converted to SQL <IS NULL>
2091 $stmt = "WHERE user = ? AND status IS NULL";
2094 To test if a column IS NOT NULL:
2098 status => { '!=', undef },
2101 =head2 Specific comparison operators
2103 If you want to specify a different type of operator for your comparison,
2104 you can use a hashref for a given column:
2108 status => { '!=', 'completed' }
2111 Which would generate:
2113 $stmt = "WHERE user = ? AND status != ?";
2114 @bind = ('nwiger', 'completed');
2116 To test against multiple values, just enclose the values in an arrayref:
2118 status => { '=', ['assigned', 'in-progress', 'pending'] };
2120 Which would give you:
2122 "WHERE status = ? OR status = ? OR status = ?"
2125 The hashref can also contain multiple pairs, in which case it is expanded
2126 into an C<AND> of its elements:
2130 status => { '!=', 'completed', -not_like => 'pending%' }
2133 # Or more dynamically, like from a form
2134 $where{user} = 'nwiger';
2135 $where{status}{'!='} = 'completed';
2136 $where{status}{'-not_like'} = 'pending%';
2138 # Both generate this
2139 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2140 @bind = ('nwiger', 'completed', 'pending%');
2143 To get an OR instead, you can combine it with the arrayref idea:
2147 priority => [ { '=', 2 }, { '>', 5 } ]
2150 Which would generate:
2152 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2153 @bind = ('2', '5', 'nwiger');
2155 If you want to include literal SQL (with or without bind values), just use a
2156 scalar reference or reference to an arrayref as the value:
2159 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2160 date_expires => { '<' => \"now()" }
2163 Which would generate:
2165 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2166 @bind = ('11/26/2008');
2169 =head2 Logic and nesting operators
2171 In the example above,
2172 there is a subtle trap if you want to say something like
2173 this (notice the C<AND>):
2175 WHERE priority != ? AND priority != ?
2177 Because, in Perl you I<can't> do this:
2179 priority => { '!=' => 2, '!=' => 1 }
2181 As the second C<!=> key will obliterate the first. The solution
2182 is to use the special C<-modifier> form inside an arrayref:
2184 priority => [ -and => {'!=', 2},
2188 Normally, these would be joined by C<OR>, but the modifier tells it
2189 to use C<AND> instead. (Hint: You can use this in conjunction with the
2190 C<logic> option to C<new()> in order to change the way your queries
2191 work by default.) B<Important:> Note that the C<-modifier> goes
2192 B<INSIDE> the arrayref, as an extra first element. This will
2193 B<NOT> do what you think it might:
2195 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2197 Here is a quick list of equivalencies, since there is some overlap:
2200 status => {'!=', 'completed', 'not like', 'pending%' }
2201 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2204 status => {'=', ['assigned', 'in-progress']}
2205 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2206 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2210 =head2 Special operators: IN, BETWEEN, etc.
2212 You can also use the hashref format to compare a list of fields using the
2213 C<IN> comparison operator, by specifying the list as an arrayref:
2216 status => 'completed',
2217 reportid => { -in => [567, 2335, 2] }
2220 Which would generate:
2222 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2223 @bind = ('completed', '567', '2335', '2');
2225 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2228 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2229 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2230 'sqltrue' (by default: C<1=1>).
2232 In addition to the array you can supply a chunk of literal sql or
2233 literal sql with bind:
2236 customer => { -in => \[
2237 'SELECT cust_id FROM cust WHERE balance > ?',
2240 status => { -in => \'SELECT status_codes FROM states' },
2246 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2247 AND status IN ( SELECT status_codes FROM states )
2251 Finally, if the argument to C<-in> is not a reference, it will be
2252 treated as a single-element array.
2254 Another pair of operators is C<-between> and C<-not_between>,
2255 used with an arrayref of two values:
2259 completion_date => {
2260 -not_between => ['2002-10-01', '2003-02-06']
2266 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2268 Just like with C<-in> all plausible combinations of literal SQL
2272 start0 => { -between => [ 1, 2 ] },
2273 start1 => { -between => \["? AND ?", 1, 2] },
2274 start2 => { -between => \"lower(x) AND upper(y)" },
2275 start3 => { -between => [
2277 \["upper(?)", 'stuff' ],
2284 ( start0 BETWEEN ? AND ? )
2285 AND ( start1 BETWEEN ? AND ? )
2286 AND ( start2 BETWEEN lower(x) AND upper(y) )
2287 AND ( start3 BETWEEN lower(x) AND upper(?) )
2289 @bind = (1, 2, 1, 2, 'stuff');
2292 These are the two builtin "special operators"; but the
2293 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2295 =head2 Unary operators: bool
2297 If you wish to test against boolean columns or functions within your
2298 database you can use the C<-bool> and C<-not_bool> operators. For
2299 example to test the column C<is_user> being true and the column
2300 C<is_enabled> being false you would use:-
2304 -not_bool => 'is_enabled',
2309 WHERE is_user AND NOT is_enabled
2311 If a more complex combination is required, testing more conditions,
2312 then you should use the and/or operators:-
2317 -not_bool => { two=> { -rlike => 'bar' } },
2318 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2329 (NOT ( three = ? OR three > ? ))
2332 =head2 Nested conditions, -and/-or prefixes
2334 So far, we've seen how multiple conditions are joined with a top-level
2335 C<AND>. We can change this by putting the different conditions we want in
2336 hashes and then putting those hashes in an array. For example:
2341 status => { -like => ['pending%', 'dispatched'] },
2345 status => 'unassigned',
2349 This data structure would create the following:
2351 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2352 OR ( user = ? AND status = ? ) )";
2353 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2356 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2357 to change the logic inside:
2363 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2364 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2371 $stmt = "WHERE ( user = ?
2372 AND ( ( workhrs > ? AND geo = ? )
2373 OR ( workhrs < ? OR geo = ? ) ) )";
2374 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2376 =head3 Algebraic inconsistency, for historical reasons
2378 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2379 operator goes C<outside> of the nested structure; whereas when connecting
2380 several constraints on one column, the C<-and> operator goes
2381 C<inside> the arrayref. Here is an example combining both features:
2384 -and => [a => 1, b => 2],
2385 -or => [c => 3, d => 4],
2386 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2391 WHERE ( ( ( a = ? AND b = ? )
2392 OR ( c = ? OR d = ? )
2393 OR ( e LIKE ? AND e LIKE ? ) ) )
2395 This difference in syntax is unfortunate but must be preserved for
2396 historical reasons. So be careful: the two examples below would
2397 seem algebraically equivalent, but they are not
2400 { -like => 'foo%' },
2401 { -like => '%bar' },
2403 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2406 { col => { -like => 'foo%' } },
2407 { col => { -like => '%bar' } },
2409 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2412 =head2 Literal SQL and value type operators
2414 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2415 side" is a column name and the "right side" is a value (normally rendered as
2416 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2417 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2418 alter this behavior. There are several ways of doing so.
2422 This is a virtual operator that signals the string to its right side is an
2423 identifier (a column name) and not a value. For example to compare two
2424 columns you would write:
2427 priority => { '<', 2 },
2428 requestor => { -ident => 'submitter' },
2433 $stmt = "WHERE priority < ? AND requestor = submitter";
2436 If you are maintaining legacy code you may see a different construct as
2437 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2442 This is a virtual operator that signals that the construct to its right side
2443 is a value to be passed to DBI. This is for example necessary when you want
2444 to write a where clause against an array (for RDBMS that support such
2445 datatypes). For example:
2448 array => { -value => [1, 2, 3] }
2453 $stmt = 'WHERE array = ?';
2454 @bind = ([1, 2, 3]);
2456 Note that if you were to simply say:
2462 the result would probably not be what you wanted:
2464 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2469 Finally, sometimes only literal SQL will do. To include a random snippet
2470 of SQL verbatim, you specify it as a scalar reference. Consider this only
2471 as a last resort. Usually there is a better way. For example:
2474 priority => { '<', 2 },
2475 requestor => { -in => \'(SELECT name FROM hitmen)' },
2480 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2483 Note that in this example, you only get one bind parameter back, since
2484 the verbatim SQL is passed as part of the statement.
2488 Never use untrusted input as a literal SQL argument - this is a massive
2489 security risk (there is no way to check literal snippets for SQL
2490 injections and other nastyness). If you need to deal with untrusted input
2491 use literal SQL with placeholders as described next.
2493 =head3 Literal SQL with placeholders and bind values (subqueries)
2495 If the literal SQL to be inserted has placeholders and bind values,
2496 use a reference to an arrayref (yes this is a double reference --
2497 not so common, but perfectly legal Perl). For example, to find a date
2498 in Postgres you can use something like this:
2501 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2506 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2509 Note that you must pass the bind values in the same format as they are returned
2510 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2511 to C<columns>, you must provide the bind values in the
2512 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2513 scalar value; most commonly the column name, but you can use any scalar value
2514 (including references and blessed references), L<SQL::Abstract> will simply
2515 pass it through intact. So if C<bindtype> is set to C<columns> the above
2516 example will look like:
2519 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2522 Literal SQL is especially useful for nesting parenthesized clauses in the
2523 main SQL query. Here is a first example:
2525 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2529 bar => \["IN ($sub_stmt)" => @sub_bind],
2534 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2535 WHERE c2 < ? AND c3 LIKE ?))";
2536 @bind = (1234, 100, "foo%");
2538 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2539 are expressed in the same way. Of course the C<$sub_stmt> and
2540 its associated bind values can be generated through a former call
2543 my ($sub_stmt, @sub_bind)
2544 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2545 c3 => {-like => "foo%"}});
2548 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2551 In the examples above, the subquery was used as an operator on a column;
2552 but the same principle also applies for a clause within the main C<%where>
2553 hash, like an EXISTS subquery:
2555 my ($sub_stmt, @sub_bind)
2556 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2557 my %where = ( -and => [
2559 \["EXISTS ($sub_stmt)" => @sub_bind],
2564 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2565 WHERE c1 = ? AND c2 > t0.c0))";
2569 Observe that the condition on C<c2> in the subquery refers to
2570 column C<t0.c0> of the main query: this is I<not> a bind
2571 value, so we have to express it through a scalar ref.
2572 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2573 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2574 what we wanted here.
2576 Finally, here is an example where a subquery is used
2577 for expressing unary negation:
2579 my ($sub_stmt, @sub_bind)
2580 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2581 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2583 lname => {like => '%son%'},
2584 \["NOT ($sub_stmt)" => @sub_bind],
2589 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2590 @bind = ('%son%', 10, 20)
2592 =head3 Deprecated usage of Literal SQL
2594 Below are some examples of archaic use of literal SQL. It is shown only as
2595 reference for those who deal with legacy code. Each example has a much
2596 better, cleaner and safer alternative that users should opt for in new code.
2602 my %where = ( requestor => \'IS NOT NULL' )
2604 $stmt = "WHERE requestor IS NOT NULL"
2606 This used to be the way of generating NULL comparisons, before the handling
2607 of C<undef> got formalized. For new code please use the superior syntax as
2608 described in L</Tests for NULL values>.
2612 my %where = ( requestor => \'= submitter' )
2614 $stmt = "WHERE requestor = submitter"
2616 This used to be the only way to compare columns. Use the superior L</-ident>
2617 method for all new code. For example an identifier declared in such a way
2618 will be properly quoted if L</quote_char> is properly set, while the legacy
2619 form will remain as supplied.
2623 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2625 $stmt = "WHERE completed > ? AND is_ready"
2626 @bind = ('2012-12-21')
2628 Using an empty string literal used to be the only way to express a boolean.
2629 For all new code please use the much more readable
2630 L<-bool|/Unary operators: bool> operator.
2636 These pages could go on for a while, since the nesting of the data
2637 structures this module can handle are pretty much unlimited (the
2638 module implements the C<WHERE> expansion as a recursive function
2639 internally). Your best bet is to "play around" with the module a
2640 little to see how the data structures behave, and choose the best
2641 format for your data based on that.
2643 And of course, all the values above will probably be replaced with
2644 variables gotten from forms or the command line. After all, if you
2645 knew everything ahead of time, you wouldn't have to worry about
2646 dynamically-generating SQL and could just hardwire it into your
2649 =head1 ORDER BY CLAUSES
2651 Some functions take an order by clause. This can either be a scalar (just a
2652 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2653 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2656 Given | Will Generate
2657 ---------------------------------------------------------------
2659 'colA' | ORDER BY colA
2661 [qw/colA colB/] | ORDER BY colA, colB
2663 {-asc => 'colA'} | ORDER BY colA ASC
2665 {-desc => 'colB'} | ORDER BY colB DESC
2667 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2669 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2671 \'colA DESC' | ORDER BY colA DESC
2673 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2674 | /* ...with $x bound to ? */
2677 { -asc => 'colA' }, | colA ASC,
2678 { -desc => [qw/colB/] }, | colB DESC,
2679 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2680 \'colE DESC', | colE DESC,
2681 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2682 ] | /* ...with $x bound to ? */
2683 ===============================================================
2687 =head1 SPECIAL OPERATORS
2689 my $sqlmaker = SQL::Abstract->new(special_ops => [
2693 my ($self, $field, $op, $arg) = @_;
2699 handler => 'method_name',
2703 A "special operator" is a SQL syntactic clause that can be
2704 applied to a field, instead of a usual binary operator.
2707 WHERE field IN (?, ?, ?)
2708 WHERE field BETWEEN ? AND ?
2709 WHERE MATCH(field) AGAINST (?, ?)
2711 Special operators IN and BETWEEN are fairly standard and therefore
2712 are builtin within C<SQL::Abstract> (as the overridable methods
2713 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2714 like the MATCH .. AGAINST example above which is specific to MySQL,
2715 you can write your own operator handlers - supply a C<special_ops>
2716 argument to the C<new> method. That argument takes an arrayref of
2717 operator definitions; each operator definition is a hashref with two
2724 the regular expression to match the operator
2728 Either a coderef or a plain scalar method name. In both cases
2729 the expected return is C<< ($sql, @bind) >>.
2731 When supplied with a method name, it is simply called on the
2732 L<SQL::Abstract> object as:
2734 $self->$method_name($field, $op, $arg)
2738 $field is the LHS of the operator
2739 $op is the part that matched the handler regex
2742 When supplied with a coderef, it is called as:
2744 $coderef->($self, $field, $op, $arg)
2749 For example, here is an implementation
2750 of the MATCH .. AGAINST syntax for MySQL
2752 my $sqlmaker = SQL::Abstract->new(special_ops => [
2754 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2755 {regex => qr/^match$/i,
2757 my ($self, $field, $op, $arg) = @_;
2758 $arg = [$arg] if not ref $arg;
2759 my $label = $self->_quote($field);
2760 my ($placeholder) = $self->_convert('?');
2761 my $placeholders = join ", ", (($placeholder) x @$arg);
2762 my $sql = $self->_sqlcase('match') . " ($label) "
2763 . $self->_sqlcase('against') . " ($placeholders) ";
2764 my @bind = $self->_bindtype($field, @$arg);
2765 return ($sql, @bind);
2772 =head1 UNARY OPERATORS
2774 my $sqlmaker = SQL::Abstract->new(unary_ops => [
2778 my ($self, $op, $arg) = @_;
2784 handler => 'method_name',
2788 A "unary operator" is a SQL syntactic clause that can be
2789 applied to a field - the operator goes before the field
2791 You can write your own operator handlers - supply a C<unary_ops>
2792 argument to the C<new> method. That argument takes an arrayref of
2793 operator definitions; each operator definition is a hashref with two
2800 the regular expression to match the operator
2804 Either a coderef or a plain scalar method name. In both cases
2805 the expected return is C<< $sql >>.
2807 When supplied with a method name, it is simply called on the
2808 L<SQL::Abstract> object as:
2810 $self->$method_name($op, $arg)
2814 $op is the part that matched the handler regex
2815 $arg is the RHS or argument of the operator
2817 When supplied with a coderef, it is called as:
2819 $coderef->($self, $op, $arg)
2827 Thanks to some benchmarking by Mark Stosberg, it turns out that
2828 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2829 I must admit this wasn't an intentional design issue, but it's a
2830 byproduct of the fact that you get to control your C<DBI> handles
2833 To maximize performance, use a code snippet like the following:
2835 # prepare a statement handle using the first row
2836 # and then reuse it for the rest of the rows
2838 for my $href (@array_of_hashrefs) {
2839 $stmt ||= $sql->insert('table', $href);
2840 $sth ||= $dbh->prepare($stmt);
2841 $sth->execute($sql->values($href));
2844 The reason this works is because the keys in your C<$href> are sorted
2845 internally by B<SQL::Abstract>. Thus, as long as your data retains
2846 the same structure, you only have to generate the SQL the first time
2847 around. On subsequent queries, simply use the C<values> function provided
2848 by this module to return your values in the correct order.
2850 However this depends on the values having the same type - if, for
2851 example, the values of a where clause may either have values
2852 (resulting in sql of the form C<column = ?> with a single bind
2853 value), or alternatively the values might be C<undef> (resulting in
2854 sql of the form C<column IS NULL> with no bind value) then the
2855 caching technique suggested will not work.
2859 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2860 really like this part (I do, at least). Building up a complex query
2861 can be as simple as the following:
2868 use CGI::FormBuilder;
2871 my $form = CGI::FormBuilder->new(...);
2872 my $sql = SQL::Abstract->new;
2874 if ($form->submitted) {
2875 my $field = $form->field;
2876 my $id = delete $field->{id};
2877 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2880 Of course, you would still have to connect using C<DBI> to run the
2881 query, but the point is that if you make your form look like your
2882 table, the actual query script can be extremely simplistic.
2884 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2885 a fast interface to returning and formatting data. I frequently
2886 use these three modules together to write complex database query
2887 apps in under 50 lines.
2889 =head1 HOW TO CONTRIBUTE
2891 Contributions are always welcome, in all usable forms (we especially
2892 welcome documentation improvements). The delivery methods include git-
2893 or unified-diff formatted patches, GitHub pull requests, or plain bug
2894 reports either via RT or the Mailing list. Contributors are generally
2895 granted full access to the official repository after their first several
2896 patches pass successful review.
2898 This project is maintained in a git repository. The code and related tools are
2899 accessible at the following locations:
2903 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
2905 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
2907 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
2909 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
2915 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2916 Great care has been taken to preserve the I<published> behavior
2917 documented in previous versions in the 1.* family; however,
2918 some features that were previously undocumented, or behaved
2919 differently from the documentation, had to be changed in order
2920 to clarify the semantics. Hence, client code that was relying
2921 on some dark areas of C<SQL::Abstract> v1.*
2922 B<might behave differently> in v1.50.
2924 The main changes are:
2930 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
2934 support for the { operator => \"..." } construct (to embed literal SQL)
2938 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
2942 optional support for L<array datatypes|/"Inserting and Updating Arrays">
2946 defensive programming: check arguments
2950 fixed bug with global logic, which was previously implemented
2951 through global variables yielding side-effects. Prior versions would
2952 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
2953 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
2954 Now this is interpreted
2955 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
2960 fixed semantics of _bindtype on array args
2964 dropped the C<_anoncopy> of the %where tree. No longer necessary,
2965 we just avoid shifting arrays within that tree.
2969 dropped the C<_modlogic> function
2973 =head1 ACKNOWLEDGEMENTS
2975 There are a number of individuals that have really helped out with
2976 this module. Unfortunately, most of them submitted bugs via CPAN
2977 so I have no idea who they are! But the people I do know are:
2979 Ash Berlin (order_by hash term support)
2980 Matt Trout (DBIx::Class support)
2981 Mark Stosberg (benchmarking)
2982 Chas Owens (initial "IN" operator support)
2983 Philip Collins (per-field SQL functions)
2984 Eric Kolve (hashref "AND" support)
2985 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
2986 Dan Kubb (support for "quote_char" and "name_sep")
2987 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
2988 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
2989 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
2990 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
2991 Oliver Charles (support for "RETURNING" after "INSERT")
2997 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3001 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3003 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3005 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3006 While not an official support venue, C<DBIx::Class> makes heavy use of
3007 C<SQL::Abstract>, and as such list members there are very familiar with
3008 how to create queries.
3012 This module is free software; you may copy this under the same
3013 terms as perl itself (either the GNU General Public License or
3014 the Artistic License)