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/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
47 #======================================================================
48 # DEBUGGING AND ERROR REPORTING
49 #======================================================================
52 return unless $_[0]->{debug}; shift; # a little faster
53 my $func = (caller(1))[3];
54 warn "[$func] ", @_, "\n";
58 my($func) = (caller(1))[3];
59 Carp::carp "[$func] Warning: ", @_;
63 my($func) = (caller(1))[3];
64 Carp::croak "[$func] Fatal: ", @_;
67 sub is_literal_value ($) {
68 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
69 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
73 sub is_undef_value ($) {
77 and exists $_[0]->{-value}
78 and not defined $_[0]->{-value}
82 # FIXME XSify - this can be done so much more efficiently
83 sub is_plain_value ($) {
85 ! length ref $_[0] ? \($_[0])
87 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
89 exists $_[0]->{-value}
90 ) ? \($_[0]->{-value})
92 # reuse @_ for even moar speedz
93 defined ( $_[1] = Scalar::Util::blessed $_[0] )
95 # deliberately not using Devel::OverloadInfo - the checks we are
96 # intersted in are much more limited than the fullblown thing, and
97 # this is a very hot piece of code
99 # simply using ->can('(""') can leave behind stub methods that
100 # break actually using the overload later (see L<perldiag/Stub
101 # found while resolving method "%s" overloading "%s" in package
102 # "%s"> and the source of overload::mycan())
104 # either has stringification which DBI SHOULD prefer out of the box
105 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
107 # has nummification or boolification, AND fallback is *not* disabled
109 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
112 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
114 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
118 # no fallback specified at all
119 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
121 # fallback explicitly undef
122 ! defined ${"$_[3]::()"}
135 #======================================================================
137 #======================================================================
141 my $class = ref($self) || $self;
142 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
144 # choose our case by keeping an option around
145 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
147 # default logic for interpreting arrayrefs
148 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
150 # how to return bind vars
151 $opt{bindtype} ||= 'normal';
153 # default comparison is "=", but can be overridden
156 # try to recognize which are the 'equality' and 'inequality' ops
157 # (temporary quickfix (in 2007), should go through a more seasoned API)
158 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
159 $opt{inequality_op} = qr/^( != | <> )$/ix;
161 $opt{like_op} = qr/^ (is_)?r?like $/xi;
162 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
165 $opt{sqltrue} ||= '1=1';
166 $opt{sqlfalse} ||= '0=1';
169 $opt{special_ops} ||= [];
171 if ($class->isa('DBIx::Class::SQLMaker')) {
172 $opt{warn_once_on_nest} = 1;
173 $opt{disable_old_special_ops} = 1;
177 $opt{unary_ops} ||= [];
179 # rudimentary sanity-check for user supplied bits treated as functions/operators
180 # If a purported function matches this regular expression, an exception is thrown.
181 # Literal SQL is *NOT* subject to this check, only functions (and column names
182 # when quoting is not in effect)
185 # need to guard against ()'s in column names too, but this will break tons of
186 # hacks... ideas anyone?
187 $opt{injection_guard} ||= qr/
193 $opt{expand_unary} = {};
196 not => '_expand_not',
197 bool => '_expand_bool',
198 and => '_expand_op_andor',
199 or => '_expand_op_andor',
200 nest => '_expand_nest',
201 bind => '_expand_bind',
203 not_in => '_expand_in',
204 row => '_expand_row',
205 between => '_expand_between',
206 not_between => '_expand_between',
208 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
209 ident => '_expand_ident',
210 value => '_expand_value',
211 func => '_expand_func',
215 'between' => '_expand_between',
216 'not_between' => '_expand_between',
217 'in' => '_expand_in',
218 'not_in' => '_expand_in',
219 'nest' => '_expand_nest',
220 (map +($_ => '_expand_op_andor'), ('and', 'or')),
221 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
222 'ident' => '_expand_ident',
223 'value' => '_expand_value',
227 (map +($_, "_render_$_"), qw(op func bind ident literal row)),
232 (map +($_ => '_render_op_between'), 'between', 'not_between'),
233 (map +($_ => '_render_op_in'), 'in', 'not_in'),
234 (map +($_ => '_render_unop_postfix'),
235 'is_null', 'is_not_null', 'asc', 'desc',
237 (not => '_render_unop_paren'),
238 (map +($_ => '_render_op_andor'), qw(and or)),
239 ',' => '_render_op_multop',
242 return bless \%opt, $class;
245 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
246 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
248 sub _assert_pass_injection_guard {
249 if ($_[1] =~ $_[0]->{injection_guard}) {
250 my $class = ref $_[0];
251 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
252 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
253 . "{injection_guard} attribute to ${class}->new()"
258 #======================================================================
260 #======================================================================
264 my $table = $self->_table(shift);
265 my $data = shift || return;
270 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
272 my @parts = ([ $self->_sqlcase('insert into').' '.$table ]);
273 push @parts, [ $self->render_aqt($f_aqt) ] if $f_aqt;
274 push @parts, [ $self->_sqlcase('values') ], [ $self->render_aqt($v_aqt) ];
276 if ($options->{returning}) {
277 push @parts, [ $self->_insert_returning($options) ];
280 return $self->join_query_parts(' ', @parts);
283 sub _expand_insert_values {
284 my ($self, $data) = @_;
285 if (is_literal_value($data)) {
286 (undef, $self->expand_expr($data));
288 my ($fields, $values) = (
289 ref($data) eq 'HASH' ?
290 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
294 # no names (arrayref) means can't generate bindtype
295 !($fields) && $self->{bindtype} eq 'columns'
296 && belch "can't do 'columns' bindtype when called with arrayref";
300 ? $self->expand_expr({ -row => $fields }, -ident)
305 local our $Cur_Col_Meta = $fields->[$_];
306 $self->_expand_insert_value($values->[$_])
313 # So that subclasses can override INSERT ... RETURNING separately from
314 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
315 sub _insert_returning { shift->_returning(@_) }
318 my ($self, $options) = @_;
320 my $f = $options->{returning};
322 my ($sql, @bind) = $self->render_aqt(
323 $self->_expand_maybe_list_expr($f, -ident)
326 ? $self->_sqlcase(' returning ') . $sql
327 : ($self->_sqlcase(' returning ').$sql, @bind);
330 sub _expand_insert_value {
333 my $k = our $Cur_Col_Meta;
335 if (ref($v) eq 'ARRAY') {
336 if ($self->{array_datatypes}) {
337 return +{ -bind => [ $k, $v ] };
339 my ($sql, @bind) = @$v;
340 $self->_assert_bindval_matches_bindtype(@bind);
341 return +{ -literal => $v };
343 if (ref($v) eq 'HASH') {
344 if (grep !/^-/, keys %$v) {
345 belch "HASH ref as bind value in insert is not supported";
346 return +{ -bind => [ $k, $v ] };
350 return +{ -bind => [ $k, undef ] };
352 return $self->expand_expr($v);
357 #======================================================================
359 #======================================================================
364 my $table = $self->_table(shift);
365 my $data = shift || return;
369 # first build the 'SET' part of the sql statement
370 puke "Unsupported data type specified to \$sql->update"
371 unless ref $data eq 'HASH';
373 my ($sql, @all_bind) = $self->_update_set_values($data);
374 $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
378 my($where_sql, @where_bind) = $self->where($where);
380 push @all_bind, @where_bind;
383 if ($options->{returning}) {
384 my ($returning_sql, @returning_bind) = $self->_update_returning($options);
385 $sql .= $returning_sql;
386 push @all_bind, @returning_bind;
389 return wantarray ? ($sql, @all_bind) : $sql;
392 sub _update_set_values {
393 my ($self, $data) = @_;
395 return $self->render_aqt(
396 $self->_expand_update_set_values(undef, $data),
400 sub _expand_update_set_values {
401 my ($self, undef, $data) = @_;
402 $self->_expand_maybe_list_expr( [
405 $set = { -bind => $_ } unless defined $set;
406 +{ -op => [ '=', $self->_expand_ident(-ident => $k), $set ] };
412 ? ($self->{array_datatypes}
413 ? [ $k, +{ -bind => [ $k, $v ] } ]
414 : [ $k, +{ -literal => $v } ])
416 local our $Cur_Col_Meta = $k;
417 [ $k, $self->_expand_expr($v) ]
424 # So that subclasses can override UPDATE ... RETURNING separately from
426 sub _update_returning { shift->_returning(@_) }
430 #======================================================================
432 #======================================================================
437 my $table = $self->_table(shift);
438 my $fields = shift || '*';
442 my ($fields_sql, @bind) = $self->_select_fields($fields);
444 my ($where_sql, @where_bind) = $self->where($where, $order);
445 push @bind, @where_bind;
447 my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
448 $self->_sqlcase('from'), $table)
451 return wantarray ? ($sql, @bind) : $sql;
455 my ($self, $fields) = @_;
456 return $fields unless ref($fields);
457 return $self->render_aqt(
458 $self->_expand_maybe_list_expr($fields, '-ident')
462 #======================================================================
464 #======================================================================
469 my $table = $self->_table(shift);
473 my($where_sql, @bind) = $self->where($where);
474 my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
476 if ($options->{returning}) {
477 my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
478 $sql .= $returning_sql;
479 push @bind, @returning_bind;
482 return wantarray ? ($sql, @bind) : $sql;
485 # So that subclasses can override DELETE ... RETURNING separately from
487 sub _delete_returning { shift->_returning(@_) }
491 #======================================================================
493 #======================================================================
497 # Finally, a separate routine just to handle WHERE clauses
499 my ($self, $where, $order) = @_;
501 local $self->{convert_where} = $self->{convert};
504 my ($sql, @bind) = defined($where)
505 ? $self->_recurse_where($where)
507 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
511 my ($order_sql, @order_bind) = $self->_order_by($order);
513 push @bind, @order_bind;
516 return wantarray ? ($sql, @bind) : $sql;
519 { our $Default_Scalar_To = -value }
522 my ($self, $expr, $default_scalar_to) = @_;
523 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
524 $self->_expand_expr($expr);
528 my ($self, $aqt) = @_;
529 my ($k, $v, @rest) = %$aqt;
531 die "Not a node type: $k" unless $k =~ s/^-//;
532 if (my $meth = $self->{render}{$k}) {
533 return $self->$meth($k, $v);
535 die "notreached: $k";
539 my ($self, $expr, $default_scalar_to) = @_;
540 my ($sql, @bind) = $self->render_aqt(
541 $self->expand_expr($expr, $default_scalar_to)
543 return (wantarray ? ($sql, @bind) : $sql);
547 my ($self, $raw) = @_;
548 s/^-(?=.)//, s/\s+/_/g for my $op = lc $raw;
553 my ($self, $expr) = @_;
554 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
555 return undef unless defined($expr);
556 if (ref($expr) eq 'HASH') {
557 return undef unless my $kc = keys %$expr;
559 return $self->_expand_op_andor(and => $expr);
561 my ($key, $value) = %$expr;
562 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
563 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
564 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
566 return $self->_expand_hashpair($key, $value);
568 if (ref($expr) eq 'ARRAY') {
569 return $self->_expand_op_andor(lc($self->{logic}), $expr);
571 if (my $literal = is_literal_value($expr)) {
572 return +{ -literal => $literal };
574 if (!ref($expr) or Scalar::Util::blessed($expr)) {
575 return $self->_expand_scalar($expr);
580 sub _expand_hashpair {
581 my ($self, $k, $v) = @_;
582 unless (defined($k) and length($k)) {
583 if (defined($k) and my $literal = is_literal_value($v)) {
584 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
585 return { -literal => $literal };
587 puke "Supplying an empty left hand side argument is not supported";
590 return $self->_expand_hashpair_op($k, $v);
591 } elsif ($k =~ /^[^\w]/i) {
592 my ($lhs, @rhs) = @$v;
593 return $self->_expand_op(
594 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
597 return $self->_expand_hashpair_ident($k, $v);
600 sub _expand_hashpair_ident {
601 my ($self, $k, $v) = @_;
603 local our $Cur_Col_Meta = $k;
605 # hash with multiple or no elements is andor
607 if (ref($v) eq 'HASH' and keys %$v != 1) {
608 return $self->_expand_op_andor(and => $v, $k);
611 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
613 if (is_undef_value($v)) {
614 return $self->_expand_hashpair_cmp($k => undef);
617 # scalars and objects get expanded as whatever requested or values
619 if (!ref($v) or Scalar::Util::blessed($v)) {
620 return $self->_expand_hashpair_scalar($k, $v);
623 # single key hashref is a hashtriple
625 if (ref($v) eq 'HASH') {
626 return $self->_expand_hashtriple($k, %$v);
629 # arrayref needs re-engineering over the elements
631 if (ref($v) eq 'ARRAY') {
632 return $self->sqlfalse unless @$v;
633 $self->_debug("ARRAY($k) means distribute over elements");
635 $v->[0] =~ /^-(and|or)$/i
636 ? (shift(@{$v = [ @$v ]}), $1)
637 : lc($self->{logic} || 'OR')
639 return $self->_expand_op_andor(
644 if (my $literal = is_literal_value($v)) {
646 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
649 my ($sql, @bind) = @$literal;
650 if ($self->{bindtype} eq 'columns') {
652 $self->_assert_bindval_matches_bindtype($_);
655 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
661 my ($self, $expr) = @_;
663 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
666 sub _expand_hashpair_scalar {
667 my ($self, $k, $v) = @_;
669 return $self->_expand_hashpair_cmp(
670 $k, $self->_expand_scalar($v),
674 sub _expand_hashpair_op {
675 my ($self, $k, $v) = @_;
677 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
679 my $op = $self->_normalize_op($k);
681 if (my $exp = $self->{expand}{$op}) {
682 return $self->$exp($op, $v);
685 # Ops prefixed with -not_ get converted
687 if (my ($rest) = $op =~/^not_(.*)$/) {
690 $self->_expand_expr({ "-${rest}", $v })
696 my $op = join(' ', split '_', $op);
698 # the old special op system requires illegality for top-level use
701 (our $Expand_Depth) == 1
703 List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
705 $self->{disable_old_special_ops}
706 and List::Util::first { $op =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
710 puke "Illegal use of top-level '-$op'"
713 # the old unary op system means we should touch nothing and let it work
715 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
716 return { -op => [ $op, $v ] };
720 # an explicit node type is currently assumed to be expanded (this is almost
721 # certainly wrong and there should be expansion anyway)
723 if ($self->{render}{$op}) {
727 my $type = $self->{unknown_unop_always_func} ? -func : -op;
734 and (keys %$v)[0] =~ /^-/
737 (List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}})
746 ($type eq -func and ref($v) eq 'ARRAY')
747 ? map $self->_expand_expr($_), @$v
748 : $self->_expand_expr($v)
752 sub _expand_hashpair_cmp {
753 my ($self, $k, $v) = @_;
754 $self->_expand_hashtriple($k, $self->{cmp}, $v);
757 sub _expand_hashtriple {
758 my ($self, $k, $vk, $vv) = @_;
760 my $ik = $self->_expand_ident(-ident => $k);
762 my $op = $self->_normalize_op($vk);
763 $self->_assert_pass_injection_guard($op);
765 if ($op =~ s/ _? \d+ $//x ) {
766 return $self->_expand_expr($k, { $vk, $vv });
768 if (my $x = $self->{expand_op}{$op}) {
769 local our $Cur_Col_Meta = $k;
770 return $self->$x($op, $vv, $k);
774 my $op = join(' ', split '_', $op);
776 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
777 return { -op => [ $op, $ik, $vv ] };
779 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
783 { -op => [ $op, $vv ] }
787 if (ref($vv) eq 'ARRAY') {
789 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
790 ? (shift(@raw), $1) : 'or';
791 my @values = map +{ $vk => $_ }, @raw;
793 $op =~ $self->{inequality_op}
794 or $op =~ $self->{not_like_op}
796 if (lc($logic) eq 'or' and @values > 1) {
797 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
798 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
799 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
804 # try to DWIM on equality operators
805 return ($self->_dwim_op_to_is($op,
806 "Supplying an empty arrayref to '%s' is deprecated",
807 "operator '%s' applied on an empty array (field '$k')"
808 ) ? $self->sqlfalse : $self->sqltrue);
810 return $self->_expand_op_andor($logic => \@values, $k);
812 if (is_undef_value($vv)) {
813 my $is = ($self->_dwim_op_to_is($op,
814 "Supplying an undefined argument to '%s' is deprecated",
815 "unexpected operator '%s' with undef operand",
816 ) ? 'is' : 'is not');
818 return $self->_expand_hashpair($k => { $is, undef });
820 local our $Cur_Col_Meta = $k;
824 $self->_expand_expr($vv)
829 my ($self, $raw, $empty, $fail) = @_;
831 my $op = $self->_normalize_op($raw);
833 if ($op =~ /^not$/i) {
836 if ($op =~ $self->{equality_op}) {
839 if ($op =~ $self->{like_op}) {
840 belch(sprintf $empty, uc(join ' ', split '_', $op));
843 if ($op =~ $self->{inequality_op}) {
846 if ($op =~ $self->{not_like_op}) {
847 belch(sprintf $empty, uc(join ' ', split '_', $op));
850 puke(sprintf $fail, $op);
854 my ($self, undef, $args) = @_;
855 my ($func, @args) = @$args;
856 return { -func => [ $func, map $self->expand_expr($_), @args ] };
860 my ($self, undef, $body, $k) = @_;
861 return $self->_expand_hashpair_cmp(
862 $k, { -ident => $body }
864 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
865 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
867 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
868 ref($body) ? @$body : $body;
869 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
870 unless ($self->{quote_char}) {
871 $self->_assert_pass_injection_guard($_) for @parts;
873 return +{ -ident => \@parts };
877 return $_[0]->_expand_hashpair_cmp(
878 $_[3], { -value => $_[2] },
880 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
884 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
888 my ($self, undef, $args) = @_;
889 +{ -row => [ map $self->expand_expr($_), @$args ] };
893 my ($self, undef, $args) = @_;
894 my ($op, @opargs) = @$args;
895 if (my $exp = $self->{expand_op}{$op}) {
896 return $self->$exp($op, \@opargs);
898 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
902 my ($self, undef, $v) = @_;
904 return $self->_expand_expr($v);
906 puke "-bool => undef not supported" unless defined($v);
907 return $self->_expand_ident(-ident => $v);
910 sub _expand_op_andor {
911 my ($self, $logop, $v, $k) = @_;
913 $v = [ map +{ $k, $_ },
915 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
919 if (ref($v) eq 'HASH') {
920 return undef unless keys %$v;
923 map $self->_expand_expr({ $_ => $v->{$_} }),
927 if (ref($v) eq 'ARRAY') {
928 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
931 (ref($_) eq 'ARRAY' and @$_)
932 or (ref($_) eq 'HASH' and %$_)
938 while (my ($el) = splice @expr, 0, 1) {
939 puke "Supplying an empty left hand side argument is not supported in array-pairs"
940 unless defined($el) and length($el);
941 my $elref = ref($el);
943 local our $Expand_Depth = 0;
944 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
945 } elsif ($elref eq 'ARRAY') {
946 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
947 } elsif (my $l = is_literal_value($el)) {
948 push @res, { -literal => $l };
949 } elsif ($elref eq 'HASH') {
950 local our $Expand_Depth = 0;
951 push @res, grep defined, $self->_expand_expr($el) if %$el;
957 # return $res[0] if @res == 1;
958 return { -op => [ $logop, @res ] };
964 my ($self, $op, $vv, $k) = @_;
965 ($k, $vv) = @$vv unless defined $k;
966 puke "$op can only take undef as argument"
970 and exists($vv->{-value})
971 and !defined($vv->{-value})
973 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
976 sub _expand_between {
977 my ($self, $op, $vv, $k) = @_;
978 $k = shift @{$vv = [ @$vv ]} unless defined $k;
979 my @rhs = map $self->_expand_expr($_),
980 ref($vv) eq 'ARRAY' ? @$vv : $vv;
982 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
984 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
986 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
990 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
996 my ($self, $op, $vv, $k) = @_;
997 $k = shift @{$vv = [ @$vv ]} unless defined $k;
998 if (my $literal = is_literal_value($vv)) {
999 my ($sql, @bind) = @$literal;
1000 my $opened_sql = $self->_open_outer_paren($sql);
1002 $op, $self->expand_expr($k, -ident),
1003 { -literal => [ $opened_sql, @bind ] }
1007 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1008 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1009 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1010 . 'will emit the logically correct SQL instead of raising this exception)'
1012 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1014 my @rhs = map $self->expand_expr($_, -value),
1015 map { defined($_) ? $_: puke($undef_err) }
1016 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1017 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1021 $self->expand_expr($k, -ident),
1027 my ($self, undef, $v) = @_;
1028 # DBIx::Class requires a nest warning to be emitted once but the private
1029 # method it overrode to do so no longer exists
1030 if ($self->{warn_once_on_nest}) {
1031 unless (our $Nest_Warned) {
1033 "-nest in search conditions is deprecated, you most probably wanted:\n"
1034 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1039 return $self->_expand_expr($v);
1043 my ($self, undef, $bind) = @_;
1044 return { -bind => $bind };
1047 sub _recurse_where {
1048 my ($self, $where, $logic) = @_;
1050 # Special case: top level simple string treated as literal
1052 my $where_exp = (ref($where)
1053 ? $self->_expand_expr($where, $logic)
1054 : { -literal => [ $where ] });
1056 # dispatch expanded expression
1058 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1059 # DBIx::Class used to call _recurse_where in scalar context
1060 # something else might too...
1062 return ($sql, @bind);
1065 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1071 my ($self, undef, $ident) = @_;
1073 return $self->_convert($self->_quote($ident));
1077 my ($self, undef, $values) = @_;
1078 my ($sql, @bind) = $self->_render_op(undef, [ ',', @$values ]);
1079 return $self->join_query_parts('', [ '(' ], [ $sql, @bind ], [ ')' ]);
1083 my ($self, undef, $rest) = @_;
1084 my ($func, @args) = @$rest;
1085 return $self->join_query_parts('',
1086 [ $self->_sqlcase($func) ],
1088 [ $self->join_query_parts(', ', @args) ],
1094 my ($self, undef, $bind) = @_;
1095 return ($self->_convert('?'), $self->_bindtype(@$bind));
1098 sub _render_literal {
1099 my ($self, undef, $literal) = @_;
1100 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1105 my ($self, undef, $v) = @_;
1106 my ($op, @args) = @$v;
1107 if (my $r = $self->{render_op}{$op}) {
1108 return $self->$r($op, \@args);
1113 my $op = join(' ', split '_', $op);
1115 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1116 if ($ss and @args > 1) {
1117 puke "Special op '${op}' requires first value to be identifier"
1118 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1119 my $k = join(($self->{name_sep}||'.'), @$ident);
1120 local our $Expand_Depth = 1;
1121 return $self->${\($ss->{handler})}($k, $op, $args[1]);
1123 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1124 return $self->${\($us->{handler})}($op, $args[0]);
1127 return $self->_render_unop_paren($op, \@args);
1131 return $self->_render_unop_prefix($op, \@args);
1133 return $self->_render_op_multop($op, \@args);
1139 sub _render_op_between {
1140 my ($self, $op, $args) = @_;
1141 my ($left, $low, $high) = @$args;
1144 puke "Single arg to between must be a literal"
1145 unless $low->{-literal};
1148 +($low, $self->format_keyword('and'), $high);
1151 return $self->join_query_parts(' ',
1152 '(', $left, $self->format_keyword($op), @rh, ')',
1157 my ($self, $op, $args) = @_;
1158 my ($lhs, @rhs) = @$args;
1160 return $self->join_query_parts(' ',
1162 $self->format_keyword($op),
1164 [ $self->join_query_parts(', ', @rhs) ],
1169 sub _render_op_andor {
1170 my ($self, $op, $args) = @_;
1171 my @parts = map [ $self->render_aqt($_) ], @$args;
1172 return '' unless @parts;
1173 return @{$parts[0]} if @parts == 1;
1174 my ($sql, @bind) = $self->join_query_parts(' ',
1175 '(', [ $self->join_query_parts(
1176 ' '.$self->format_keyword($op).' ',
1181 sub _render_op_multop {
1182 my ($self, $op, $args) = @_;
1183 my @parts = map [ $self->render_aqt($_) ], @$args;
1184 return '' unless @parts;
1185 return @{$parts[0]} if @parts == 1;
1186 my $join = ($op eq ','
1188 : ' '.$self->_sqlcase(join ' ', split '_', $op).' '
1190 return $self->join_query_parts($join, @parts);
1193 sub join_query_parts {
1194 my ($self, $join, @parts) = @_;
1197 ? [ $self->render_aqt($_) ]
1198 : ref($_) eq 'ARRAY' ? $_ : [ $_ ]),
1201 join($join, map $_->[0], @final),
1202 (wantarray ? (map @{$_}[1..$#$_], @final) : ()),
1206 sub _render_unop_paren {
1207 my ($self, $op, $v) = @_;
1208 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1209 return "(${sql})", @bind;
1212 sub _render_unop_prefix {
1213 my ($self, $op, $v) = @_;
1214 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1216 my $op_sql = $self->_sqlcase($op); # join ' ', split '_', $op);
1217 return ("${op_sql} ${expr_sql}", @bind);
1220 sub _render_unop_postfix {
1221 my ($self, $op, $v) = @_;
1222 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1223 my $op_sql = $self->_sqlcase(join ' ', split '_', $op);
1224 return ($expr_sql.' '.$op_sql, @bind);
1227 # Some databases (SQLite) treat col IN (1, 2) different from
1228 # col IN ( (1, 2) ). Use this to strip all outer parens while
1229 # adding them back in the corresponding method
1230 sub _open_outer_paren {
1231 my ($self, $sql) = @_;
1233 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1235 # there are closing parens inside, need the heavy duty machinery
1236 # to reevaluate the extraction starting from $sql (full reevaluation)
1237 if ($inner =~ /\)/) {
1238 require Text::Balanced;
1240 my (undef, $remainder) = do {
1241 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1243 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1246 # the entire expression needs to be a balanced bracketed thing
1247 # (after an extract no remainder sans trailing space)
1248 last if defined $remainder and $remainder =~ /\S/;
1258 #======================================================================
1260 #======================================================================
1262 sub _expand_order_by {
1263 my ($self, $arg) = @_;
1265 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1267 return $self->_expand_maybe_list_expr($arg)
1268 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1270 my $expander = sub {
1271 my ($self, $dir, $expr) = @_;
1272 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1273 foreach my $arg (@to_expand) {
1277 and grep /^-(asc|desc)$/, keys %$arg
1279 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1283 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1285 map $self->expand_expr($_, -ident),
1286 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1287 return undef unless @exp;
1288 return undef if @exp == 1 and not defined($exp[0]);
1289 return +{ -op => [ ',', @exp ] };
1292 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1294 return $self->$expander(undef, $arg);
1298 my ($self, $arg) = @_;
1300 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1302 my ($sql, @bind) = $self->render_aqt($expanded);
1304 return '' unless length($sql);
1306 my $final_sql = $self->_sqlcase(' order by ').$sql;
1308 return wantarray ? ($final_sql, @bind) : $final_sql;
1311 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1313 sub _order_by_chunks {
1314 my ($self, $arg) = @_;
1316 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1318 return $self->_chunkify_order_by($expanded);
1321 sub _chunkify_order_by {
1322 my ($self, $expanded) = @_;
1324 return grep length, $self->render_aqt($expanded)
1325 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1328 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1329 my ($comma, @list) = @{$_->{-op}};
1330 return map $self->_chunkify_order_by($_), @list;
1332 return [ $self->render_aqt($_) ];
1336 #======================================================================
1337 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1338 #======================================================================
1344 $self->_expand_maybe_list_expr($from, -ident)
1349 #======================================================================
1351 #======================================================================
1353 sub _expand_maybe_list_expr {
1354 my ($self, $expr, $default) = @_;
1356 ',', map $self->expand_expr($_, $default),
1357 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1358 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1359 return +{ -op => [ ',',
1360 map $self->expand_expr($_, $default),
1361 ref($expr) eq 'ARRAY' ? @$expr : $expr
1365 # highly optimized, as it's called way too often
1367 # my ($self, $label) = @_;
1369 return '' unless defined $_[1];
1370 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1371 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1373 unless ($_[0]->{quote_char}) {
1374 if (ref($_[1]) eq 'ARRAY') {
1375 return join($_[0]->{name_sep}||'.', @{$_[1]});
1377 $_[0]->_assert_pass_injection_guard($_[1]);
1382 my $qref = ref $_[0]->{quote_char};
1384 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1385 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1386 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1388 my $esc = $_[0]->{escape_char} || $r;
1390 # parts containing * are naturally unquoted
1392 $_[0]->{name_sep}||'',
1396 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1398 (ref($_[1]) eq 'ARRAY'
1402 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1410 # Conversion, if applicable
1412 #my ($self, $arg) = @_;
1413 if ($_[0]->{convert_where}) {
1414 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1421 #my ($self, $col, @vals) = @_;
1422 # called often - tighten code
1423 return $_[0]->{bindtype} eq 'columns'
1424 ? map {[$_[1], $_]} @_[2 .. $#_]
1429 # Dies if any element of @bind is not in [colname => value] format
1430 # if bindtype is 'columns'.
1431 sub _assert_bindval_matches_bindtype {
1432 # my ($self, @bind) = @_;
1434 if ($self->{bindtype} eq 'columns') {
1436 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1437 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1443 sub _join_sql_clauses {
1444 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1446 if (@$clauses_aref > 1) {
1447 my $join = " " . $self->_sqlcase($logic) . " ";
1448 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1449 return ($sql, @$bind_aref);
1451 elsif (@$clauses_aref) {
1452 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1455 return (); # if no SQL, ignore @$bind_aref
1460 # Fix SQL case, if so requested
1462 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1463 # don't touch the argument ... crooked logic, but let's not change it!
1464 return $_[0]->{case} ? $_[1] : uc($_[1]);
1467 sub format_keyword { $_[0]->_sqlcase(join ' ', split '_', $_[1]) }
1469 #======================================================================
1470 # DISPATCHING FROM REFKIND
1471 #======================================================================
1474 my ($self, $data) = @_;
1476 return 'UNDEF' unless defined $data;
1478 # blessed objects are treated like scalars
1479 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1481 return 'SCALAR' unless $ref;
1484 while ($ref eq 'REF') {
1486 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1490 return ($ref||'SCALAR') . ('REF' x $n_steps);
1494 my ($self, $data) = @_;
1495 my @try = ($self->_refkind($data));
1496 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1497 push @try, 'FALLBACK';
1501 sub _METHOD_FOR_refkind {
1502 my ($self, $meth_prefix, $data) = @_;
1505 for (@{$self->_try_refkind($data)}) {
1506 $method = $self->can($meth_prefix."_".$_)
1510 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1514 sub _SWITCH_refkind {
1515 my ($self, $data, $dispatch_table) = @_;
1518 for (@{$self->_try_refkind($data)}) {
1519 $coderef = $dispatch_table->{$_}
1523 puke "no dispatch entry for ".$self->_refkind($data)
1532 #======================================================================
1533 # VALUES, GENERATE, AUTOLOAD
1534 #======================================================================
1536 # LDNOTE: original code from nwiger, didn't touch code in that section
1537 # I feel the AUTOLOAD stuff should not be the default, it should
1538 # only be activated on explicit demand by user.
1542 my $data = shift || return;
1543 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1544 unless ref $data eq 'HASH';
1547 foreach my $k (sort keys %$data) {
1548 my $v = $data->{$k};
1549 $self->_SWITCH_refkind($v, {
1551 if ($self->{array_datatypes}) { # array datatype
1552 push @all_bind, $self->_bindtype($k, $v);
1554 else { # literal SQL with bind
1555 my ($sql, @bind) = @$v;
1556 $self->_assert_bindval_matches_bindtype(@bind);
1557 push @all_bind, @bind;
1560 ARRAYREFREF => sub { # literal SQL with bind
1561 my ($sql, @bind) = @${$v};
1562 $self->_assert_bindval_matches_bindtype(@bind);
1563 push @all_bind, @bind;
1565 SCALARREF => sub { # literal SQL without bind
1567 SCALAR_or_UNDEF => sub {
1568 push @all_bind, $self->_bindtype($k, $v);
1579 my(@sql, @sqlq, @sqlv);
1583 if ($ref eq 'HASH') {
1584 for my $k (sort keys %$_) {
1587 my $label = $self->_quote($k);
1588 if ($r eq 'ARRAY') {
1589 # literal SQL with bind
1590 my ($sql, @bind) = @$v;
1591 $self->_assert_bindval_matches_bindtype(@bind);
1592 push @sqlq, "$label = $sql";
1594 } elsif ($r eq 'SCALAR') {
1595 # literal SQL without bind
1596 push @sqlq, "$label = $$v";
1598 push @sqlq, "$label = ?";
1599 push @sqlv, $self->_bindtype($k, $v);
1602 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1603 } elsif ($ref eq 'ARRAY') {
1604 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1607 if ($r eq 'ARRAY') { # literal SQL with bind
1608 my ($sql, @bind) = @$v;
1609 $self->_assert_bindval_matches_bindtype(@bind);
1612 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1613 # embedded literal SQL
1620 push @sql, '(' . join(', ', @sqlq) . ')';
1621 } elsif ($ref eq 'SCALAR') {
1625 # strings get case twiddled
1626 push @sql, $self->_sqlcase($_);
1630 my $sql = join ' ', @sql;
1632 # this is pretty tricky
1633 # if ask for an array, return ($stmt, @bind)
1634 # otherwise, s/?/shift @sqlv/ to put it inline
1636 return ($sql, @sqlv);
1638 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1639 ref $d ? $d->[1] : $d/e;
1648 # This allows us to check for a local, then _form, attr
1650 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1651 return $self->generate($name, @_);
1662 SQL::Abstract - Generate SQL from Perl data structures
1668 my $sql = SQL::Abstract->new;
1670 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1672 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1674 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1676 my($stmt, @bind) = $sql->delete($table, \%where);
1678 # Then, use these in your DBI statements
1679 my $sth = $dbh->prepare($stmt);
1680 $sth->execute(@bind);
1682 # Just generate the WHERE clause
1683 my($stmt, @bind) = $sql->where(\%where, $order);
1685 # Return values in the same order, for hashed queries
1686 # See PERFORMANCE section for more details
1687 my @bind = $sql->values(\%fieldvals);
1691 This module was inspired by the excellent L<DBIx::Abstract>.
1692 However, in using that module I found that what I really wanted
1693 to do was generate SQL, but still retain complete control over my
1694 statement handles and use the DBI interface. So, I set out to
1695 create an abstract SQL generation module.
1697 While based on the concepts used by L<DBIx::Abstract>, there are
1698 several important differences, especially when it comes to WHERE
1699 clauses. I have modified the concepts used to make the SQL easier
1700 to generate from Perl data structures and, IMO, more intuitive.
1701 The underlying idea is for this module to do what you mean, based
1702 on the data structures you provide it. The big advantage is that
1703 you don't have to modify your code every time your data changes,
1704 as this module figures it out.
1706 To begin with, an SQL INSERT is as easy as just specifying a hash
1707 of C<key=value> pairs:
1710 name => 'Jimbo Bobson',
1711 phone => '123-456-7890',
1712 address => '42 Sister Lane',
1713 city => 'St. Louis',
1714 state => 'Louisiana',
1717 The SQL can then be generated with this:
1719 my($stmt, @bind) = $sql->insert('people', \%data);
1721 Which would give you something like this:
1723 $stmt = "INSERT INTO people
1724 (address, city, name, phone, state)
1725 VALUES (?, ?, ?, ?, ?)";
1726 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1727 '123-456-7890', 'Louisiana');
1729 These are then used directly in your DBI code:
1731 my $sth = $dbh->prepare($stmt);
1732 $sth->execute(@bind);
1734 =head2 Inserting and Updating Arrays
1736 If your database has array types (like for example Postgres),
1737 activate the special option C<< array_datatypes => 1 >>
1738 when creating the C<SQL::Abstract> object.
1739 Then you may use an arrayref to insert and update database array types:
1741 my $sql = SQL::Abstract->new(array_datatypes => 1);
1743 planets => [qw/Mercury Venus Earth Mars/]
1746 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1750 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1752 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1755 =head2 Inserting and Updating SQL
1757 In order to apply SQL functions to elements of your C<%data> you may
1758 specify a reference to an arrayref for the given hash value. For example,
1759 if you need to execute the Oracle C<to_date> function on a value, you can
1760 say something like this:
1764 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1767 The first value in the array is the actual SQL. Any other values are
1768 optional and would be included in the bind values array. This gives
1771 my($stmt, @bind) = $sql->insert('people', \%data);
1773 $stmt = "INSERT INTO people (name, date_entered)
1774 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1775 @bind = ('Bill', '03/02/2003');
1777 An UPDATE is just as easy, all you change is the name of the function:
1779 my($stmt, @bind) = $sql->update('people', \%data);
1781 Notice that your C<%data> isn't touched; the module will generate
1782 the appropriately quirky SQL for you automatically. Usually you'll
1783 want to specify a WHERE clause for your UPDATE, though, which is
1784 where handling C<%where> hashes comes in handy...
1786 =head2 Complex where statements
1788 This module can generate pretty complicated WHERE statements
1789 easily. For example, simple C<key=value> pairs are taken to mean
1790 equality, and if you want to see if a field is within a set
1791 of values, you can use an arrayref. Let's say we wanted to
1792 SELECT some data based on this criteria:
1795 requestor => 'inna',
1796 worker => ['nwiger', 'rcwe', 'sfz'],
1797 status => { '!=', 'completed' }
1800 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1802 The above would give you something like this:
1804 $stmt = "SELECT * FROM tickets WHERE
1805 ( requestor = ? ) AND ( status != ? )
1806 AND ( worker = ? OR worker = ? OR worker = ? )";
1807 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1809 Which you could then use in DBI code like so:
1811 my $sth = $dbh->prepare($stmt);
1812 $sth->execute(@bind);
1818 The methods are simple. There's one for every major SQL operation,
1819 and a constructor you use first. The arguments are specified in a
1820 similar order for each method (table, then fields, then a where
1821 clause) to try and simplify things.
1823 =head2 new(option => 'value')
1825 The C<new()> function takes a list of options and values, and returns
1826 a new B<SQL::Abstract> object which can then be used to generate SQL
1827 through the methods below. The options accepted are:
1833 If set to 'lower', then SQL will be generated in all lowercase. By
1834 default SQL is generated in "textbook" case meaning something like:
1836 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1838 Any setting other than 'lower' is ignored.
1842 This determines what the default comparison operator is. By default
1843 it is C<=>, meaning that a hash like this:
1845 %where = (name => 'nwiger', email => 'nate@wiger.org');
1847 Will generate SQL like this:
1849 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1851 However, you may want loose comparisons by default, so if you set
1852 C<cmp> to C<like> you would get SQL such as:
1854 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1856 You can also override the comparison on an individual basis - see
1857 the huge section on L</"WHERE CLAUSES"> at the bottom.
1859 =item sqltrue, sqlfalse
1861 Expressions for inserting boolean values within SQL statements.
1862 By default these are C<1=1> and C<1=0>. They are used
1863 by the special operators C<-in> and C<-not_in> for generating
1864 correct SQL even when the argument is an empty array (see below).
1868 This determines the default logical operator for multiple WHERE
1869 statements in arrays or hashes. If absent, the default logic is "or"
1870 for arrays, and "and" for hashes. This means that a WHERE
1874 event_date => {'>=', '2/13/99'},
1875 event_date => {'<=', '4/24/03'},
1878 will generate SQL like this:
1880 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1882 This is probably not what you want given this query, though (look
1883 at the dates). To change the "OR" to an "AND", simply specify:
1885 my $sql = SQL::Abstract->new(logic => 'and');
1887 Which will change the above C<WHERE> to:
1889 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1891 The logic can also be changed locally by inserting
1892 a modifier in front of an arrayref:
1894 @where = (-and => [event_date => {'>=', '2/13/99'},
1895 event_date => {'<=', '4/24/03'} ]);
1897 See the L</"WHERE CLAUSES"> section for explanations.
1901 This will automatically convert comparisons using the specified SQL
1902 function for both column and value. This is mostly used with an argument
1903 of C<upper> or C<lower>, so that the SQL will have the effect of
1904 case-insensitive "searches". For example, this:
1906 $sql = SQL::Abstract->new(convert => 'upper');
1907 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1909 Will turn out the following SQL:
1911 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1913 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1914 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1915 not validate this option; it will just pass through what you specify verbatim).
1919 This is a kludge because many databases suck. For example, you can't
1920 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1921 Instead, you have to use C<bind_param()>:
1923 $sth->bind_param(1, 'reg data');
1924 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1926 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1927 which loses track of which field each slot refers to. Fear not.
1929 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1930 Currently, you can specify either C<normal> (default) or C<columns>. If you
1931 specify C<columns>, you will get an array that looks like this:
1933 my $sql = SQL::Abstract->new(bindtype => 'columns');
1934 my($stmt, @bind) = $sql->insert(...);
1937 [ 'column1', 'value1' ],
1938 [ 'column2', 'value2' ],
1939 [ 'column3', 'value3' ],
1942 You can then iterate through this manually, using DBI's C<bind_param()>.
1944 $sth->prepare($stmt);
1947 my($col, $data) = @$_;
1948 if ($col eq 'details' || $col eq 'comments') {
1949 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1950 } elsif ($col eq 'image') {
1951 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1953 $sth->bind_param($i, $data);
1957 $sth->execute; # execute without @bind now
1959 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1960 Basically, the advantage is still that you don't have to care which fields
1961 are or are not included. You could wrap that above C<for> loop in a simple
1962 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1963 get a layer of abstraction over manual SQL specification.
1965 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1966 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1967 will expect the bind values in this format.
1971 This is the character that a table or column name will be quoted
1972 with. By default this is an empty string, but you could set it to
1973 the character C<`>, to generate SQL like this:
1975 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1977 Alternatively, you can supply an array ref of two items, the first being the left
1978 hand quote character, and the second the right hand quote character. For
1979 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1980 that generates SQL like this:
1982 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1984 Quoting is useful if you have tables or columns names that are reserved
1985 words in your database's SQL dialect.
1989 This is the character that will be used to escape L</quote_char>s appearing
1990 in an identifier before it has been quoted.
1992 The parameter default in case of a single L</quote_char> character is the quote
1995 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
1996 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
1997 of the B<opening (left)> L</quote_char> within the identifier are currently left
1998 untouched. The default for opening-closing-style quotes may change in future
1999 versions, thus you are B<strongly encouraged> to specify the escape character
2004 This is the character that separates a table and column name. It is
2005 necessary to specify this when the C<quote_char> option is selected,
2006 so that tables and column names can be individually quoted like this:
2008 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2010 =item injection_guard
2012 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2013 column name specified in a query structure. This is a safety mechanism to avoid
2014 injection attacks when mishandling user input e.g.:
2016 my %condition_as_column_value_pairs = get_values_from_user();
2017 $sqla->select( ... , \%condition_as_column_value_pairs );
2019 If the expression matches an exception is thrown. Note that literal SQL
2020 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2022 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2024 =item array_datatypes
2026 When this option is true, arrayrefs in INSERT or UPDATE are
2027 interpreted as array datatypes and are passed directly
2029 When this option is false, arrayrefs are interpreted
2030 as literal SQL, just like refs to arrayrefs
2031 (but this behavior is for backwards compatibility; when writing
2032 new queries, use the "reference to arrayref" syntax
2038 Takes a reference to a list of "special operators"
2039 to extend the syntax understood by L<SQL::Abstract>.
2040 See section L</"SPECIAL OPERATORS"> for details.
2044 Takes a reference to a list of "unary operators"
2045 to extend the syntax understood by L<SQL::Abstract>.
2046 See section L</"UNARY OPERATORS"> for details.
2052 =head2 insert($table, \@values || \%fieldvals, \%options)
2054 This is the simplest function. You simply give it a table name
2055 and either an arrayref of values or hashref of field/value pairs.
2056 It returns an SQL INSERT statement and a list of bind values.
2057 See the sections on L</"Inserting and Updating Arrays"> and
2058 L</"Inserting and Updating SQL"> for information on how to insert
2059 with those data types.
2061 The optional C<\%options> hash reference may contain additional
2062 options to generate the insert SQL. Currently supported options
2069 Takes either a scalar of raw SQL fields, or an array reference of
2070 field names, and adds on an SQL C<RETURNING> statement at the end.
2071 This allows you to return data generated by the insert statement
2072 (such as row IDs) without performing another C<SELECT> statement.
2073 Note, however, this is not part of the SQL standard and may not
2074 be supported by all database engines.
2078 =head2 update($table, \%fieldvals, \%where, \%options)
2080 This takes a table, hashref of field/value pairs, and an optional
2081 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2083 See the sections on L</"Inserting and Updating Arrays"> and
2084 L</"Inserting and Updating SQL"> for information on how to insert
2085 with those data types.
2087 The optional C<\%options> hash reference may contain additional
2088 options to generate the update SQL. Currently supported options
2095 See the C<returning> option to
2096 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2100 =head2 select($source, $fields, $where, $order)
2102 This returns a SQL SELECT statement and associated list of bind values, as
2103 specified by the arguments:
2109 Specification of the 'FROM' part of the statement.
2110 The argument can be either a plain scalar (interpreted as a table
2111 name, will be quoted), or an arrayref (interpreted as a list
2112 of table names, joined by commas, quoted), or a scalarref
2113 (literal SQL, not quoted).
2117 Specification of the list of fields to retrieve from
2119 The argument can be either an arrayref (interpreted as a list
2120 of field names, will be joined by commas and quoted), or a
2121 plain scalar (literal SQL, not quoted).
2122 Please observe that this API is not as flexible as that of
2123 the first argument C<$source>, for backwards compatibility reasons.
2127 Optional argument to specify the WHERE part of the query.
2128 The argument is most often a hashref, but can also be
2129 an arrayref or plain scalar --
2130 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2134 Optional argument to specify the ORDER BY part of the query.
2135 The argument can be a scalar, a hashref or an arrayref
2136 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2142 =head2 delete($table, \%where, \%options)
2144 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2145 It returns an SQL DELETE statement and list of bind values.
2147 The optional C<\%options> hash reference may contain additional
2148 options to generate the delete SQL. Currently supported options
2155 See the C<returning> option to
2156 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2160 =head2 where(\%where, $order)
2162 This is used to generate just the WHERE clause. For example,
2163 if you have an arbitrary data structure and know what the
2164 rest of your SQL is going to look like, but want an easy way
2165 to produce a WHERE clause, use this. It returns an SQL WHERE
2166 clause and list of bind values.
2169 =head2 values(\%data)
2171 This just returns the values from the hash C<%data>, in the same
2172 order that would be returned from any of the other above queries.
2173 Using this allows you to markedly speed up your queries if you
2174 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2176 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2178 Warning: This is an experimental method and subject to change.
2180 This returns arbitrarily generated SQL. It's a really basic shortcut.
2181 It will return two different things, depending on return context:
2183 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2184 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2186 These would return the following:
2188 # First calling form
2189 $stmt = "CREATE TABLE test (?, ?)";
2190 @bind = (field1, field2);
2192 # Second calling form
2193 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2195 Depending on what you're trying to do, it's up to you to choose the correct
2196 format. In this example, the second form is what you would want.
2200 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2204 ALTER SESSION SET nls_date_format = 'MM/YY'
2206 You get the idea. Strings get their case twiddled, but everything
2207 else remains verbatim.
2209 =head1 EXPORTABLE FUNCTIONS
2211 =head2 is_plain_value
2213 Determines if the supplied argument is a plain value as understood by this
2218 =item * The value is C<undef>
2220 =item * The value is a non-reference
2222 =item * The value is an object with stringification overloading
2224 =item * The value is of the form C<< { -value => $anything } >>
2228 On failure returns C<undef>, on success returns a B<scalar> reference
2229 to the original supplied argument.
2235 The stringification overloading detection is rather advanced: it takes
2236 into consideration not only the presence of a C<""> overload, but if that
2237 fails also checks for enabled
2238 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2239 on either C<0+> or C<bool>.
2241 Unfortunately testing in the field indicates that this
2242 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2243 but only when very large numbers of stringifying objects are involved.
2244 At the time of writing ( Sep 2014 ) there is no clear explanation of
2245 the direct cause, nor is there a manageably small test case that reliably
2246 reproduces the problem.
2248 If you encounter any of the following exceptions in B<random places within
2249 your application stack> - this module may be to blame:
2251 Operation "ne": no method found,
2252 left argument in overloaded package <something>,
2253 right argument in overloaded package <something>
2257 Stub found while resolving method "???" overloading """" in package <something>
2259 If you fall victim to the above - please attempt to reduce the problem
2260 to something that could be sent to the L<SQL::Abstract developers
2261 |DBIx::Class/GETTING HELP/SUPPORT>
2262 (either publicly or privately). As a workaround in the meantime you can
2263 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2264 value, which will most likely eliminate your problem (at the expense of
2265 not being able to properly detect exotic forms of stringification).
2267 This notice and environment variable will be removed in a future version,
2268 as soon as the underlying problem is found and a reliable workaround is
2273 =head2 is_literal_value
2275 Determines if the supplied argument is a literal value as understood by this
2280 =item * C<\$sql_string>
2282 =item * C<\[ $sql_string, @bind_values ]>
2286 On failure returns C<undef>, on success returns an B<array> reference
2287 containing the unpacked version of the supplied literal SQL and bind values.
2289 =head1 WHERE CLAUSES
2293 This module uses a variation on the idea from L<DBIx::Abstract>. It
2294 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2295 module is that things in arrays are OR'ed, and things in hashes
2298 The easiest way to explain is to show lots of examples. After
2299 each C<%where> hash shown, it is assumed you used:
2301 my($stmt, @bind) = $sql->where(\%where);
2303 However, note that the C<%where> hash can be used directly in any
2304 of the other functions as well, as described above.
2306 =head2 Key-value pairs
2308 So, let's get started. To begin, a simple hash:
2312 status => 'completed'
2315 Is converted to SQL C<key = val> statements:
2317 $stmt = "WHERE user = ? AND status = ?";
2318 @bind = ('nwiger', 'completed');
2320 One common thing I end up doing is having a list of values that
2321 a field can be in. To do this, simply specify a list inside of
2326 status => ['assigned', 'in-progress', 'pending'];
2329 This simple code will create the following:
2331 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2332 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2334 A field associated to an empty arrayref will be considered a
2335 logical false and will generate 0=1.
2337 =head2 Tests for NULL values
2339 If the value part is C<undef> then this is converted to SQL <IS NULL>
2348 $stmt = "WHERE user = ? AND status IS NULL";
2351 To test if a column IS NOT NULL:
2355 status => { '!=', undef },
2358 =head2 Specific comparison operators
2360 If you want to specify a different type of operator for your comparison,
2361 you can use a hashref for a given column:
2365 status => { '!=', 'completed' }
2368 Which would generate:
2370 $stmt = "WHERE user = ? AND status != ?";
2371 @bind = ('nwiger', 'completed');
2373 To test against multiple values, just enclose the values in an arrayref:
2375 status => { '=', ['assigned', 'in-progress', 'pending'] };
2377 Which would give you:
2379 "WHERE status = ? OR status = ? OR status = ?"
2382 The hashref can also contain multiple pairs, in which case it is expanded
2383 into an C<AND> of its elements:
2387 status => { '!=', 'completed', -not_like => 'pending%' }
2390 # Or more dynamically, like from a form
2391 $where{user} = 'nwiger';
2392 $where{status}{'!='} = 'completed';
2393 $where{status}{'-not_like'} = 'pending%';
2395 # Both generate this
2396 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2397 @bind = ('nwiger', 'completed', 'pending%');
2400 To get an OR instead, you can combine it with the arrayref idea:
2404 priority => [ { '=', 2 }, { '>', 5 } ]
2407 Which would generate:
2409 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2410 @bind = ('2', '5', 'nwiger');
2412 If you want to include literal SQL (with or without bind values), just use a
2413 scalar reference or reference to an arrayref as the value:
2416 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2417 date_expires => { '<' => \"now()" }
2420 Which would generate:
2422 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2423 @bind = ('11/26/2008');
2426 =head2 Logic and nesting operators
2428 In the example above,
2429 there is a subtle trap if you want to say something like
2430 this (notice the C<AND>):
2432 WHERE priority != ? AND priority != ?
2434 Because, in Perl you I<can't> do this:
2436 priority => { '!=' => 2, '!=' => 1 }
2438 As the second C<!=> key will obliterate the first. The solution
2439 is to use the special C<-modifier> form inside an arrayref:
2441 priority => [ -and => {'!=', 2},
2445 Normally, these would be joined by C<OR>, but the modifier tells it
2446 to use C<AND> instead. (Hint: You can use this in conjunction with the
2447 C<logic> option to C<new()> in order to change the way your queries
2448 work by default.) B<Important:> Note that the C<-modifier> goes
2449 B<INSIDE> the arrayref, as an extra first element. This will
2450 B<NOT> do what you think it might:
2452 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2454 Here is a quick list of equivalencies, since there is some overlap:
2457 status => {'!=', 'completed', 'not like', 'pending%' }
2458 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2461 status => {'=', ['assigned', 'in-progress']}
2462 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2463 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2467 =head2 Special operators: IN, BETWEEN, etc.
2469 You can also use the hashref format to compare a list of fields using the
2470 C<IN> comparison operator, by specifying the list as an arrayref:
2473 status => 'completed',
2474 reportid => { -in => [567, 2335, 2] }
2477 Which would generate:
2479 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2480 @bind = ('completed', '567', '2335', '2');
2482 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2485 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2486 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2487 'sqltrue' (by default: C<1=1>).
2489 In addition to the array you can supply a chunk of literal sql or
2490 literal sql with bind:
2493 customer => { -in => \[
2494 'SELECT cust_id FROM cust WHERE balance > ?',
2497 status => { -in => \'SELECT status_codes FROM states' },
2503 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2504 AND status IN ( SELECT status_codes FROM states )
2508 Finally, if the argument to C<-in> is not a reference, it will be
2509 treated as a single-element array.
2511 Another pair of operators is C<-between> and C<-not_between>,
2512 used with an arrayref of two values:
2516 completion_date => {
2517 -not_between => ['2002-10-01', '2003-02-06']
2523 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2525 Just like with C<-in> all plausible combinations of literal SQL
2529 start0 => { -between => [ 1, 2 ] },
2530 start1 => { -between => \["? AND ?", 1, 2] },
2531 start2 => { -between => \"lower(x) AND upper(y)" },
2532 start3 => { -between => [
2534 \["upper(?)", 'stuff' ],
2541 ( start0 BETWEEN ? AND ? )
2542 AND ( start1 BETWEEN ? AND ? )
2543 AND ( start2 BETWEEN lower(x) AND upper(y) )
2544 AND ( start3 BETWEEN lower(x) AND upper(?) )
2546 @bind = (1, 2, 1, 2, 'stuff');
2549 These are the two builtin "special operators"; but the
2550 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2552 =head2 Unary operators: bool
2554 If you wish to test against boolean columns or functions within your
2555 database you can use the C<-bool> and C<-not_bool> operators. For
2556 example to test the column C<is_user> being true and the column
2557 C<is_enabled> being false you would use:-
2561 -not_bool => 'is_enabled',
2566 WHERE is_user AND NOT is_enabled
2568 If a more complex combination is required, testing more conditions,
2569 then you should use the and/or operators:-
2574 -not_bool => { two=> { -rlike => 'bar' } },
2575 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2586 (NOT ( three = ? OR three > ? ))
2589 =head2 Nested conditions, -and/-or prefixes
2591 So far, we've seen how multiple conditions are joined with a top-level
2592 C<AND>. We can change this by putting the different conditions we want in
2593 hashes and then putting those hashes in an array. For example:
2598 status => { -like => ['pending%', 'dispatched'] },
2602 status => 'unassigned',
2606 This data structure would create the following:
2608 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2609 OR ( user = ? AND status = ? ) )";
2610 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2613 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2614 to change the logic inside:
2620 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2621 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2628 $stmt = "WHERE ( user = ?
2629 AND ( ( workhrs > ? AND geo = ? )
2630 OR ( workhrs < ? OR geo = ? ) ) )";
2631 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2633 =head3 Algebraic inconsistency, for historical reasons
2635 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2636 operator goes C<outside> of the nested structure; whereas when connecting
2637 several constraints on one column, the C<-and> operator goes
2638 C<inside> the arrayref. Here is an example combining both features:
2641 -and => [a => 1, b => 2],
2642 -or => [c => 3, d => 4],
2643 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2648 WHERE ( ( ( a = ? AND b = ? )
2649 OR ( c = ? OR d = ? )
2650 OR ( e LIKE ? AND e LIKE ? ) ) )
2652 This difference in syntax is unfortunate but must be preserved for
2653 historical reasons. So be careful: the two examples below would
2654 seem algebraically equivalent, but they are not
2657 { -like => 'foo%' },
2658 { -like => '%bar' },
2660 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2663 { col => { -like => 'foo%' } },
2664 { col => { -like => '%bar' } },
2666 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2669 =head2 Literal SQL and value type operators
2671 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2672 side" is a column name and the "right side" is a value (normally rendered as
2673 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2674 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2675 alter this behavior. There are several ways of doing so.
2679 This is a virtual operator that signals the string to its right side is an
2680 identifier (a column name) and not a value. For example to compare two
2681 columns you would write:
2684 priority => { '<', 2 },
2685 requestor => { -ident => 'submitter' },
2690 $stmt = "WHERE priority < ? AND requestor = submitter";
2693 If you are maintaining legacy code you may see a different construct as
2694 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2699 This is a virtual operator that signals that the construct to its right side
2700 is a value to be passed to DBI. This is for example necessary when you want
2701 to write a where clause against an array (for RDBMS that support such
2702 datatypes). For example:
2705 array => { -value => [1, 2, 3] }
2710 $stmt = 'WHERE array = ?';
2711 @bind = ([1, 2, 3]);
2713 Note that if you were to simply say:
2719 the result would probably not be what you wanted:
2721 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2726 Finally, sometimes only literal SQL will do. To include a random snippet
2727 of SQL verbatim, you specify it as a scalar reference. Consider this only
2728 as a last resort. Usually there is a better way. For example:
2731 priority => { '<', 2 },
2732 requestor => { -in => \'(SELECT name FROM hitmen)' },
2737 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2740 Note that in this example, you only get one bind parameter back, since
2741 the verbatim SQL is passed as part of the statement.
2745 Never use untrusted input as a literal SQL argument - this is a massive
2746 security risk (there is no way to check literal snippets for SQL
2747 injections and other nastyness). If you need to deal with untrusted input
2748 use literal SQL with placeholders as described next.
2750 =head3 Literal SQL with placeholders and bind values (subqueries)
2752 If the literal SQL to be inserted has placeholders and bind values,
2753 use a reference to an arrayref (yes this is a double reference --
2754 not so common, but perfectly legal Perl). For example, to find a date
2755 in Postgres you can use something like this:
2758 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2763 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2766 Note that you must pass the bind values in the same format as they are returned
2767 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2768 to C<columns>, you must provide the bind values in the
2769 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2770 scalar value; most commonly the column name, but you can use any scalar value
2771 (including references and blessed references), L<SQL::Abstract> will simply
2772 pass it through intact. So if C<bindtype> is set to C<columns> the above
2773 example will look like:
2776 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2779 Literal SQL is especially useful for nesting parenthesized clauses in the
2780 main SQL query. Here is a first example:
2782 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2786 bar => \["IN ($sub_stmt)" => @sub_bind],
2791 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2792 WHERE c2 < ? AND c3 LIKE ?))";
2793 @bind = (1234, 100, "foo%");
2795 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2796 are expressed in the same way. Of course the C<$sub_stmt> and
2797 its associated bind values can be generated through a former call
2800 my ($sub_stmt, @sub_bind)
2801 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2802 c3 => {-like => "foo%"}});
2805 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2808 In the examples above, the subquery was used as an operator on a column;
2809 but the same principle also applies for a clause within the main C<%where>
2810 hash, like an EXISTS subquery:
2812 my ($sub_stmt, @sub_bind)
2813 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2814 my %where = ( -and => [
2816 \["EXISTS ($sub_stmt)" => @sub_bind],
2821 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2822 WHERE c1 = ? AND c2 > t0.c0))";
2826 Observe that the condition on C<c2> in the subquery refers to
2827 column C<t0.c0> of the main query: this is I<not> a bind
2828 value, so we have to express it through a scalar ref.
2829 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2830 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2831 what we wanted here.
2833 Finally, here is an example where a subquery is used
2834 for expressing unary negation:
2836 my ($sub_stmt, @sub_bind)
2837 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2838 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2840 lname => {like => '%son%'},
2841 \["NOT ($sub_stmt)" => @sub_bind],
2846 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2847 @bind = ('%son%', 10, 20)
2849 =head3 Deprecated usage of Literal SQL
2851 Below are some examples of archaic use of literal SQL. It is shown only as
2852 reference for those who deal with legacy code. Each example has a much
2853 better, cleaner and safer alternative that users should opt for in new code.
2859 my %where = ( requestor => \'IS NOT NULL' )
2861 $stmt = "WHERE requestor IS NOT NULL"
2863 This used to be the way of generating NULL comparisons, before the handling
2864 of C<undef> got formalized. For new code please use the superior syntax as
2865 described in L</Tests for NULL values>.
2869 my %where = ( requestor => \'= submitter' )
2871 $stmt = "WHERE requestor = submitter"
2873 This used to be the only way to compare columns. Use the superior L</-ident>
2874 method for all new code. For example an identifier declared in such a way
2875 will be properly quoted if L</quote_char> is properly set, while the legacy
2876 form will remain as supplied.
2880 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2882 $stmt = "WHERE completed > ? AND is_ready"
2883 @bind = ('2012-12-21')
2885 Using an empty string literal used to be the only way to express a boolean.
2886 For all new code please use the much more readable
2887 L<-bool|/Unary operators: bool> operator.
2893 These pages could go on for a while, since the nesting of the data
2894 structures this module can handle are pretty much unlimited (the
2895 module implements the C<WHERE> expansion as a recursive function
2896 internally). Your best bet is to "play around" with the module a
2897 little to see how the data structures behave, and choose the best
2898 format for your data based on that.
2900 And of course, all the values above will probably be replaced with
2901 variables gotten from forms or the command line. After all, if you
2902 knew everything ahead of time, you wouldn't have to worry about
2903 dynamically-generating SQL and could just hardwire it into your
2906 =head1 ORDER BY CLAUSES
2908 Some functions take an order by clause. This can either be a scalar (just a
2909 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2910 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2913 Given | Will Generate
2914 ---------------------------------------------------------------
2916 'colA' | ORDER BY colA
2918 [qw/colA colB/] | ORDER BY colA, colB
2920 {-asc => 'colA'} | ORDER BY colA ASC
2922 {-desc => 'colB'} | ORDER BY colB DESC
2924 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2926 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2928 \'colA DESC' | ORDER BY colA DESC
2930 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2931 | /* ...with $x bound to ? */
2934 { -asc => 'colA' }, | colA ASC,
2935 { -desc => [qw/colB/] }, | colB DESC,
2936 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2937 \'colE DESC', | colE DESC,
2938 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2939 ] | /* ...with $x bound to ? */
2940 ===============================================================
2944 =head1 SPECIAL OPERATORS
2946 my $sqlmaker = SQL::Abstract->new(special_ops => [
2950 my ($self, $field, $op, $arg) = @_;
2956 handler => 'method_name',
2960 A "special operator" is a SQL syntactic clause that can be
2961 applied to a field, instead of a usual binary operator.
2964 WHERE field IN (?, ?, ?)
2965 WHERE field BETWEEN ? AND ?
2966 WHERE MATCH(field) AGAINST (?, ?)
2968 Special operators IN and BETWEEN are fairly standard and therefore
2969 are builtin within C<SQL::Abstract> (as the overridable methods
2970 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2971 like the MATCH .. AGAINST example above which is specific to MySQL,
2972 you can write your own operator handlers - supply a C<special_ops>
2973 argument to the C<new> method. That argument takes an arrayref of
2974 operator definitions; each operator definition is a hashref with two
2981 the regular expression to match the operator
2985 Either a coderef or a plain scalar method name. In both cases
2986 the expected return is C<< ($sql, @bind) >>.
2988 When supplied with a method name, it is simply called on the
2989 L<SQL::Abstract> object as:
2991 $self->$method_name($field, $op, $arg)
2995 $field is the LHS of the operator
2996 $op is the part that matched the handler regex
2999 When supplied with a coderef, it is called as:
3001 $coderef->($self, $field, $op, $arg)
3006 For example, here is an implementation
3007 of the MATCH .. AGAINST syntax for MySQL
3009 my $sqlmaker = SQL::Abstract->new(special_ops => [
3011 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3012 {regex => qr/^match$/i,
3014 my ($self, $field, $op, $arg) = @_;
3015 $arg = [$arg] if not ref $arg;
3016 my $label = $self->_quote($field);
3017 my ($placeholder) = $self->_convert('?');
3018 my $placeholders = join ", ", (($placeholder) x @$arg);
3019 my $sql = $self->_sqlcase('match') . " ($label) "
3020 . $self->_sqlcase('against') . " ($placeholders) ";
3021 my @bind = $self->_bindtype($field, @$arg);
3022 return ($sql, @bind);
3029 =head1 UNARY OPERATORS
3031 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3035 my ($self, $op, $arg) = @_;
3041 handler => 'method_name',
3045 A "unary operator" is a SQL syntactic clause that can be
3046 applied to a field - the operator goes before the field
3048 You can write your own operator handlers - supply a C<unary_ops>
3049 argument to the C<new> method. That argument takes an arrayref of
3050 operator definitions; each operator definition is a hashref with two
3057 the regular expression to match the operator
3061 Either a coderef or a plain scalar method name. In both cases
3062 the expected return is C<< $sql >>.
3064 When supplied with a method name, it is simply called on the
3065 L<SQL::Abstract> object as:
3067 $self->$method_name($op, $arg)
3071 $op is the part that matched the handler regex
3072 $arg is the RHS or argument of the operator
3074 When supplied with a coderef, it is called as:
3076 $coderef->($self, $op, $arg)
3084 Thanks to some benchmarking by Mark Stosberg, it turns out that
3085 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3086 I must admit this wasn't an intentional design issue, but it's a
3087 byproduct of the fact that you get to control your C<DBI> handles
3090 To maximize performance, use a code snippet like the following:
3092 # prepare a statement handle using the first row
3093 # and then reuse it for the rest of the rows
3095 for my $href (@array_of_hashrefs) {
3096 $stmt ||= $sql->insert('table', $href);
3097 $sth ||= $dbh->prepare($stmt);
3098 $sth->execute($sql->values($href));
3101 The reason this works is because the keys in your C<$href> are sorted
3102 internally by B<SQL::Abstract>. Thus, as long as your data retains
3103 the same structure, you only have to generate the SQL the first time
3104 around. On subsequent queries, simply use the C<values> function provided
3105 by this module to return your values in the correct order.
3107 However this depends on the values having the same type - if, for
3108 example, the values of a where clause may either have values
3109 (resulting in sql of the form C<column = ?> with a single bind
3110 value), or alternatively the values might be C<undef> (resulting in
3111 sql of the form C<column IS NULL> with no bind value) then the
3112 caching technique suggested will not work.
3116 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3117 really like this part (I do, at least). Building up a complex query
3118 can be as simple as the following:
3125 use CGI::FormBuilder;
3128 my $form = CGI::FormBuilder->new(...);
3129 my $sql = SQL::Abstract->new;
3131 if ($form->submitted) {
3132 my $field = $form->field;
3133 my $id = delete $field->{id};
3134 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3137 Of course, you would still have to connect using C<DBI> to run the
3138 query, but the point is that if you make your form look like your
3139 table, the actual query script can be extremely simplistic.
3141 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3142 a fast interface to returning and formatting data. I frequently
3143 use these three modules together to write complex database query
3144 apps in under 50 lines.
3146 =head1 HOW TO CONTRIBUTE
3148 Contributions are always welcome, in all usable forms (we especially
3149 welcome documentation improvements). The delivery methods include git-
3150 or unified-diff formatted patches, GitHub pull requests, or plain bug
3151 reports either via RT or the Mailing list. Contributors are generally
3152 granted full access to the official repository after their first several
3153 patches pass successful review.
3155 This project is maintained in a git repository. The code and related tools are
3156 accessible at the following locations:
3160 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3162 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3164 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3166 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3172 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3173 Great care has been taken to preserve the I<published> behavior
3174 documented in previous versions in the 1.* family; however,
3175 some features that were previously undocumented, or behaved
3176 differently from the documentation, had to be changed in order
3177 to clarify the semantics. Hence, client code that was relying
3178 on some dark areas of C<SQL::Abstract> v1.*
3179 B<might behave differently> in v1.50.
3181 The main changes are:
3187 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3191 support for the { operator => \"..." } construct (to embed literal SQL)
3195 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3199 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3203 defensive programming: check arguments
3207 fixed bug with global logic, which was previously implemented
3208 through global variables yielding side-effects. Prior versions would
3209 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3210 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3211 Now this is interpreted
3212 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3217 fixed semantics of _bindtype on array args
3221 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3222 we just avoid shifting arrays within that tree.
3226 dropped the C<_modlogic> function
3230 =head1 ACKNOWLEDGEMENTS
3232 There are a number of individuals that have really helped out with
3233 this module. Unfortunately, most of them submitted bugs via CPAN
3234 so I have no idea who they are! But the people I do know are:
3236 Ash Berlin (order_by hash term support)
3237 Matt Trout (DBIx::Class support)
3238 Mark Stosberg (benchmarking)
3239 Chas Owens (initial "IN" operator support)
3240 Philip Collins (per-field SQL functions)
3241 Eric Kolve (hashref "AND" support)
3242 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3243 Dan Kubb (support for "quote_char" and "name_sep")
3244 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3245 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3246 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3247 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3248 Oliver Charles (support for "RETURNING" after "INSERT")
3254 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3258 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3260 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3262 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3263 While not an official support venue, C<DBIx::Class> makes heavy use of
3264 C<SQL::Abstract>, and as such list members there are very familiar with
3265 how to create queries.
3269 This module is free software; you may copy this under the same
3270 terms as perl itself (either the GNU General Public License or
3271 the Artistic License)