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_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($data),
400 sub _expand_update_set_values {
401 my ($self, $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($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 # hashref RHS values get expanded and used as op/func args
732 and (keys %$v)[0] =~ /^-/
734 my ($func) = $k =~ /^-(.*)$/;
736 if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) {
737 return +{ -op => [ $func, $self->_expand_expr($v) ] };
742 map $self->_expand_expr($_),
743 ref($v) eq 'ARRAY' ? @$v : $v
747 # scalars and literals get simply expanded
749 if (!ref($v) or is_literal_value($v)) {
750 return +{ -op => [ $op, $self->_expand_expr($v) ] };
756 sub _expand_hashpair_cmp {
757 my ($self, $k, $v) = @_;
758 $self->_expand_hashtriple($k, $self->{cmp}, $v);
761 sub _expand_hashtriple {
762 my ($self, $k, $vk, $vv) = @_;
764 my $ik = $self->_expand_ident(-ident => $k);
766 my $op = $self->_normalize_op($vk);
767 $self->_assert_pass_injection_guard($op);
769 if ($op =~ s/ _? \d+ $//x ) {
770 return $self->_expand_expr($k, { $vk, $vv });
772 if (my $x = $self->{expand_op}{$op}) {
773 local our $Cur_Col_Meta = $k;
774 return $self->$x($op, $vv, $k);
778 my $op = join(' ', split '_', $op);
780 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
781 return { -op => [ $op, $ik, $vv ] };
783 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
787 { -op => [ $op, $vv ] }
791 if (ref($vv) eq 'ARRAY') {
793 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
794 ? (shift(@raw), $1) : 'or';
795 my @values = map +{ $vk => $_ }, @raw;
797 $op =~ $self->{inequality_op}
798 or $op =~ $self->{not_like_op}
800 if (lc($logic) eq 'or' and @values > 1) {
801 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
802 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
803 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
808 # try to DWIM on equality operators
809 return ($self->_dwim_op_to_is($op,
810 "Supplying an empty arrayref to '%s' is deprecated",
811 "operator '%s' applied on an empty array (field '$k')"
812 ) ? $self->sqlfalse : $self->sqltrue);
814 return $self->_expand_op_andor($logic => \@values, $k);
816 if (is_undef_value($vv)) {
817 my $is = ($self->_dwim_op_to_is($op,
818 "Supplying an undefined argument to '%s' is deprecated",
819 "unexpected operator '%s' with undef operand",
820 ) ? 'is' : 'is not');
822 return $self->_expand_hashpair($k => { $is, undef });
824 local our $Cur_Col_Meta = $k;
828 $self->_expand_expr($vv)
833 my ($self, $raw, $empty, $fail) = @_;
835 my $op = $self->_normalize_op($raw);
837 if ($op =~ /^not$/i) {
840 if ($op =~ $self->{equality_op}) {
843 if ($op =~ $self->{like_op}) {
844 belch(sprintf $empty, uc(join ' ', split '_', $op));
847 if ($op =~ $self->{inequality_op}) {
850 if ($op =~ $self->{not_like_op}) {
851 belch(sprintf $empty, uc(join ' ', split '_', $op));
854 puke(sprintf $fail, $op);
858 my ($self, undef, $args) = @_;
859 my ($func, @args) = @$args;
860 return { -func => [ $func, map $self->expand_expr($_), @args ] };
864 my ($self, undef, $body, $k) = @_;
865 return $self->_expand_hashpair_cmp(
866 $k, { -ident => $body }
868 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
869 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
871 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
872 ref($body) ? @$body : $body;
873 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
874 unless ($self->{quote_char}) {
875 $self->_assert_pass_injection_guard($_) for @parts;
877 return +{ -ident => \@parts };
881 return $_[0]->_expand_hashpair_cmp(
882 $_[3], { -value => $_[2] },
884 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
888 +{ -op => [ 'not', $_[0]->_expand_expr($_[2]) ] };
892 my ($self, undef, $args) = @_;
893 +{ -row => [ map $self->expand_expr($_), @$args ] };
897 my ($self, undef, $args) = @_;
898 my ($op, @opargs) = @$args;
899 if (my $exp = $self->{expand_op}{$op}) {
900 return $self->$exp($op, \@opargs);
902 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
906 my ($self, undef, $v) = @_;
908 return $self->_expand_expr($v);
910 puke "-bool => undef not supported" unless defined($v);
911 return $self->_expand_ident(-ident => $v);
914 sub _expand_op_andor {
915 my ($self, $logop, $v, $k) = @_;
917 $v = [ map +{ $k, $_ },
919 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
923 if (ref($v) eq 'HASH') {
924 return undef unless keys %$v;
927 map $self->_expand_expr({ $_ => $v->{$_} }),
931 if (ref($v) eq 'ARRAY') {
932 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
935 (ref($_) eq 'ARRAY' and @$_)
936 or (ref($_) eq 'HASH' and %$_)
942 while (my ($el) = splice @expr, 0, 1) {
943 puke "Supplying an empty left hand side argument is not supported in array-pairs"
944 unless defined($el) and length($el);
945 my $elref = ref($el);
947 local our $Expand_Depth = 0;
948 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
949 } elsif ($elref eq 'ARRAY') {
950 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
951 } elsif (my $l = is_literal_value($el)) {
952 push @res, { -literal => $l };
953 } elsif ($elref eq 'HASH') {
954 local our $Expand_Depth = 0;
955 push @res, grep defined, $self->_expand_expr($el) if %$el;
961 # return $res[0] if @res == 1;
962 return { -op => [ $logop, @res ] };
968 my ($self, $op, $vv, $k) = @_;
969 ($k, $vv) = @$vv unless defined $k;
970 puke "$op can only take undef as argument"
974 and exists($vv->{-value})
975 and !defined($vv->{-value})
977 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
980 sub _expand_between {
981 my ($self, $op, $vv, $k) = @_;
982 $k = shift @{$vv = [ @$vv ]} unless defined $k;
983 my @rhs = map $self->_expand_expr($_),
984 ref($vv) eq 'ARRAY' ? @$vv : $vv;
986 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
988 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
990 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
994 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1000 my ($self, $op, $vv, $k) = @_;
1001 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1002 if (my $literal = is_literal_value($vv)) {
1003 my ($sql, @bind) = @$literal;
1004 my $opened_sql = $self->_open_outer_paren($sql);
1006 $op, $self->expand_expr($k, -ident),
1007 { -literal => [ $opened_sql, @bind ] }
1011 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1012 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1013 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1014 . 'will emit the logically correct SQL instead of raising this exception)'
1016 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1018 my @rhs = map $self->expand_expr($_, -value),
1019 map { defined($_) ? $_: puke($undef_err) }
1020 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1021 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1025 $self->expand_expr($k, -ident),
1031 my ($self, undef, $v) = @_;
1032 # DBIx::Class requires a nest warning to be emitted once but the private
1033 # method it overrode to do so no longer exists
1034 if ($self->{warn_once_on_nest}) {
1035 unless (our $Nest_Warned) {
1037 "-nest in search conditions is deprecated, you most probably wanted:\n"
1038 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1043 return $self->_expand_expr($v);
1047 my ($self, undef, $bind) = @_;
1048 return { -bind => $bind };
1051 sub _recurse_where {
1052 my ($self, $where, $logic) = @_;
1054 # Special case: top level simple string treated as literal
1056 my $where_exp = (ref($where)
1057 ? $self->_expand_expr($where, $logic)
1058 : { -literal => [ $where ] });
1060 # dispatch expanded expression
1062 my ($sql, @bind) = defined($where_exp) ? $self->render_aqt($where_exp) : (undef);
1063 # DBIx::Class used to call _recurse_where in scalar context
1064 # something else might too...
1066 return ($sql, @bind);
1069 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1075 my ($self, $ident) = @_;
1077 return $self->_convert($self->_quote($ident));
1081 my ($self, $values) = @_;
1082 my ($sql, @bind) = $self->_render_op([ ',', @$values ]);
1083 return "($sql)", @bind;
1087 my ($self, $rest) = @_;
1088 my ($func, @args) = @$rest;
1089 if (ref($func) eq 'HASH') {
1090 $func = $self->render_aqt($func);
1095 push @arg_sql, shift @x;
1097 } map [ $self->render_aqt($_) ], @args;
1098 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1102 my ($self, $bind) = @_;
1103 return ($self->_convert('?'), $self->_bindtype(@$bind));
1106 sub _render_literal {
1107 my ($self, $literal) = @_;
1108 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1113 my ($self, $v) = @_;
1114 my ($op, @args) = @$v;
1115 if (my $r = $self->{render_op}{$op}) {
1116 return $self->$r($op, \@args);
1121 my $op = join(' ', split '_', $op);
1123 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1124 if ($ss and @args > 1) {
1125 puke "Special op '${op}' requires first value to be identifier"
1126 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1127 my $k = join(($self->{name_sep}||'.'), @$ident);
1128 local our $Expand_Depth = 1;
1129 return $self->${\($ss->{handler})}($k, $op, $args[1]);
1131 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1132 return $self->${\($us->{handler})}($op, $args[0]);
1135 return $self->_render_unop_paren($op, \@args);
1139 return $self->_render_unop_prefix($op, \@args);
1141 return $self->_render_op_multop($op, \@args);
1147 sub _render_op_between {
1148 my ($self, $op, $args) = @_;
1149 my ($left, $low, $high) = @$args;
1150 my ($rhsql, @rhbind) = do {
1152 puke "Single arg to between must be a literal"
1153 unless $low->{-literal};
1156 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1157 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1158 @{$l}[1..$#$l], @{$h}[1..$#$h])
1161 my ($lhsql, @lhbind) = $self->render_aqt($left);
1165 $self->_sqlcase(join ' ', split '_', $op),
1173 my ($self, $op, $args) = @_;
1174 my ($lhs, @rhs) = @$args;
1177 my ($sql, @bind) = $self->render_aqt($_);
1178 push @in_bind, @bind;
1181 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1183 $lhsql.' '.$self->_sqlcase(join ' ', split '_', $op).' ( '
1184 .join(', ', @in_sql)
1190 sub _render_op_andor {
1191 my ($self, $op, $args) = @_;
1192 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1193 return '' unless @parts;
1194 return @{$parts[0]} if @parts == 1;
1195 my ($sql, @bind) = $self->_join_parts(' '.$self->_sqlcase($op).' ', @parts);
1196 return '( '.$sql.' )', @bind;
1199 sub _render_op_multop {
1200 my ($self, $op, $args) = @_;
1201 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1202 return '' unless @parts;
1203 return @{$parts[0]} if @parts == 1;
1204 my $join = ($op eq ','
1206 : ' '.$self->_sqlcase(join ' ', split '_', $op).' '
1208 return $self->_join_parts($join, @parts);
1212 my ($self, $join, @parts) = @_;
1214 join($join, map $_->[0], @parts),
1215 (wantarray ? (map @{$_}[1..$#$_], @parts) : ()),
1219 sub _render_unop_paren {
1220 my ($self, $op, $v) = @_;
1221 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1222 return "(${sql})", @bind;
1225 sub _render_unop_prefix {
1226 my ($self, $op, $v) = @_;
1227 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1229 my $op_sql = $self->_sqlcase($op); # join ' ', split '_', $op);
1230 return ("${op_sql} ${expr_sql}", @bind);
1233 sub _render_unop_postfix {
1234 my ($self, $op, $v) = @_;
1235 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1236 my $op_sql = $self->_sqlcase(join ' ', split '_', $op);
1237 return ($expr_sql.' '.$op_sql, @bind);
1240 # Some databases (SQLite) treat col IN (1, 2) different from
1241 # col IN ( (1, 2) ). Use this to strip all outer parens while
1242 # adding them back in the corresponding method
1243 sub _open_outer_paren {
1244 my ($self, $sql) = @_;
1246 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1248 # there are closing parens inside, need the heavy duty machinery
1249 # to reevaluate the extraction starting from $sql (full reevaluation)
1250 if ($inner =~ /\)/) {
1251 require Text::Balanced;
1253 my (undef, $remainder) = do {
1254 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1256 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1259 # the entire expression needs to be a balanced bracketed thing
1260 # (after an extract no remainder sans trailing space)
1261 last if defined $remainder and $remainder =~ /\S/;
1271 #======================================================================
1273 #======================================================================
1275 sub _expand_order_by {
1276 my ($self, $arg) = @_;
1278 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1280 return $self->_expand_maybe_list_expr($arg)
1281 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1283 my $expander = sub {
1284 my ($self, $dir, $expr) = @_;
1285 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1286 foreach my $arg (@to_expand) {
1290 and grep /^-(asc|desc)$/, keys %$arg
1292 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1296 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1298 map $self->expand_expr($_, -ident),
1299 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1300 return undef unless @exp;
1301 return undef if @exp == 1 and not defined($exp[0]);
1302 return +{ -op => [ ',', @exp ] };
1305 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1307 return $self->$expander(undef, $arg);
1311 my ($self, $arg) = @_;
1313 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1315 my ($sql, @bind) = $self->render_aqt($expanded);
1317 return '' unless length($sql);
1319 my $final_sql = $self->_sqlcase(' order by ').$sql;
1321 return wantarray ? ($final_sql, @bind) : $final_sql;
1324 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1326 sub _order_by_chunks {
1327 my ($self, $arg) = @_;
1329 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1331 return $self->_chunkify_order_by($expanded);
1334 sub _chunkify_order_by {
1335 my ($self, $expanded) = @_;
1337 return grep length, $self->render_aqt($expanded)
1338 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1341 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1342 my ($comma, @list) = @{$_->{-op}};
1343 return map $self->_chunkify_order_by($_), @list;
1345 return [ $self->render_aqt($_) ];
1349 #======================================================================
1350 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1351 #======================================================================
1357 $self->_expand_maybe_list_expr($from, -ident)
1362 #======================================================================
1364 #======================================================================
1366 sub _expand_maybe_list_expr {
1367 my ($self, $expr, $default) = @_;
1369 ',', map $self->expand_expr($_, $default),
1370 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1371 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1372 return +{ -op => [ ',',
1373 map $self->expand_expr($_, $default),
1374 ref($expr) eq 'ARRAY' ? @$expr : $expr
1378 # highly optimized, as it's called way too often
1380 # my ($self, $label) = @_;
1382 return '' unless defined $_[1];
1383 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1384 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1386 unless ($_[0]->{quote_char}) {
1387 if (ref($_[1]) eq 'ARRAY') {
1388 return join($_[0]->{name_sep}||'.', @{$_[1]});
1390 $_[0]->_assert_pass_injection_guard($_[1]);
1395 my $qref = ref $_[0]->{quote_char};
1397 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1398 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1399 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1401 my $esc = $_[0]->{escape_char} || $r;
1403 # parts containing * are naturally unquoted
1405 $_[0]->{name_sep}||'',
1409 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1411 (ref($_[1]) eq 'ARRAY'
1415 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1423 # Conversion, if applicable
1425 #my ($self, $arg) = @_;
1426 if ($_[0]->{convert_where}) {
1427 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1434 #my ($self, $col, @vals) = @_;
1435 # called often - tighten code
1436 return $_[0]->{bindtype} eq 'columns'
1437 ? map {[$_[1], $_]} @_[2 .. $#_]
1442 # Dies if any element of @bind is not in [colname => value] format
1443 # if bindtype is 'columns'.
1444 sub _assert_bindval_matches_bindtype {
1445 # my ($self, @bind) = @_;
1447 if ($self->{bindtype} eq 'columns') {
1449 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1450 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1456 sub _join_sql_clauses {
1457 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1459 if (@$clauses_aref > 1) {
1460 my $join = " " . $self->_sqlcase($logic) . " ";
1461 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1462 return ($sql, @$bind_aref);
1464 elsif (@$clauses_aref) {
1465 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1468 return (); # if no SQL, ignore @$bind_aref
1473 # Fix SQL case, if so requested
1475 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1476 # don't touch the argument ... crooked logic, but let's not change it!
1477 return $_[0]->{case} ? $_[1] : uc($_[1]);
1481 #======================================================================
1482 # DISPATCHING FROM REFKIND
1483 #======================================================================
1486 my ($self, $data) = @_;
1488 return 'UNDEF' unless defined $data;
1490 # blessed objects are treated like scalars
1491 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1493 return 'SCALAR' unless $ref;
1496 while ($ref eq 'REF') {
1498 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1502 return ($ref||'SCALAR') . ('REF' x $n_steps);
1506 my ($self, $data) = @_;
1507 my @try = ($self->_refkind($data));
1508 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1509 push @try, 'FALLBACK';
1513 sub _METHOD_FOR_refkind {
1514 my ($self, $meth_prefix, $data) = @_;
1517 for (@{$self->_try_refkind($data)}) {
1518 $method = $self->can($meth_prefix."_".$_)
1522 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1526 sub _SWITCH_refkind {
1527 my ($self, $data, $dispatch_table) = @_;
1530 for (@{$self->_try_refkind($data)}) {
1531 $coderef = $dispatch_table->{$_}
1535 puke "no dispatch entry for ".$self->_refkind($data)
1544 #======================================================================
1545 # VALUES, GENERATE, AUTOLOAD
1546 #======================================================================
1548 # LDNOTE: original code from nwiger, didn't touch code in that section
1549 # I feel the AUTOLOAD stuff should not be the default, it should
1550 # only be activated on explicit demand by user.
1554 my $data = shift || return;
1555 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1556 unless ref $data eq 'HASH';
1559 foreach my $k (sort keys %$data) {
1560 my $v = $data->{$k};
1561 $self->_SWITCH_refkind($v, {
1563 if ($self->{array_datatypes}) { # array datatype
1564 push @all_bind, $self->_bindtype($k, $v);
1566 else { # literal SQL with bind
1567 my ($sql, @bind) = @$v;
1568 $self->_assert_bindval_matches_bindtype(@bind);
1569 push @all_bind, @bind;
1572 ARRAYREFREF => sub { # literal SQL with bind
1573 my ($sql, @bind) = @${$v};
1574 $self->_assert_bindval_matches_bindtype(@bind);
1575 push @all_bind, @bind;
1577 SCALARREF => sub { # literal SQL without bind
1579 SCALAR_or_UNDEF => sub {
1580 push @all_bind, $self->_bindtype($k, $v);
1591 my(@sql, @sqlq, @sqlv);
1595 if ($ref eq 'HASH') {
1596 for my $k (sort keys %$_) {
1599 my $label = $self->_quote($k);
1600 if ($r eq 'ARRAY') {
1601 # literal SQL with bind
1602 my ($sql, @bind) = @$v;
1603 $self->_assert_bindval_matches_bindtype(@bind);
1604 push @sqlq, "$label = $sql";
1606 } elsif ($r eq 'SCALAR') {
1607 # literal SQL without bind
1608 push @sqlq, "$label = $$v";
1610 push @sqlq, "$label = ?";
1611 push @sqlv, $self->_bindtype($k, $v);
1614 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1615 } elsif ($ref eq 'ARRAY') {
1616 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1619 if ($r eq 'ARRAY') { # literal SQL with bind
1620 my ($sql, @bind) = @$v;
1621 $self->_assert_bindval_matches_bindtype(@bind);
1624 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1625 # embedded literal SQL
1632 push @sql, '(' . join(', ', @sqlq) . ')';
1633 } elsif ($ref eq 'SCALAR') {
1637 # strings get case twiddled
1638 push @sql, $self->_sqlcase($_);
1642 my $sql = join ' ', @sql;
1644 # this is pretty tricky
1645 # if ask for an array, return ($stmt, @bind)
1646 # otherwise, s/?/shift @sqlv/ to put it inline
1648 return ($sql, @sqlv);
1650 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1651 ref $d ? $d->[1] : $d/e;
1660 # This allows us to check for a local, then _form, attr
1662 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1663 return $self->generate($name, @_);
1674 SQL::Abstract - Generate SQL from Perl data structures
1680 my $sql = SQL::Abstract->new;
1682 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1684 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1686 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1688 my($stmt, @bind) = $sql->delete($table, \%where);
1690 # Then, use these in your DBI statements
1691 my $sth = $dbh->prepare($stmt);
1692 $sth->execute(@bind);
1694 # Just generate the WHERE clause
1695 my($stmt, @bind) = $sql->where(\%where, $order);
1697 # Return values in the same order, for hashed queries
1698 # See PERFORMANCE section for more details
1699 my @bind = $sql->values(\%fieldvals);
1703 This module was inspired by the excellent L<DBIx::Abstract>.
1704 However, in using that module I found that what I really wanted
1705 to do was generate SQL, but still retain complete control over my
1706 statement handles and use the DBI interface. So, I set out to
1707 create an abstract SQL generation module.
1709 While based on the concepts used by L<DBIx::Abstract>, there are
1710 several important differences, especially when it comes to WHERE
1711 clauses. I have modified the concepts used to make the SQL easier
1712 to generate from Perl data structures and, IMO, more intuitive.
1713 The underlying idea is for this module to do what you mean, based
1714 on the data structures you provide it. The big advantage is that
1715 you don't have to modify your code every time your data changes,
1716 as this module figures it out.
1718 To begin with, an SQL INSERT is as easy as just specifying a hash
1719 of C<key=value> pairs:
1722 name => 'Jimbo Bobson',
1723 phone => '123-456-7890',
1724 address => '42 Sister Lane',
1725 city => 'St. Louis',
1726 state => 'Louisiana',
1729 The SQL can then be generated with this:
1731 my($stmt, @bind) = $sql->insert('people', \%data);
1733 Which would give you something like this:
1735 $stmt = "INSERT INTO people
1736 (address, city, name, phone, state)
1737 VALUES (?, ?, ?, ?, ?)";
1738 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1739 '123-456-7890', 'Louisiana');
1741 These are then used directly in your DBI code:
1743 my $sth = $dbh->prepare($stmt);
1744 $sth->execute(@bind);
1746 =head2 Inserting and Updating Arrays
1748 If your database has array types (like for example Postgres),
1749 activate the special option C<< array_datatypes => 1 >>
1750 when creating the C<SQL::Abstract> object.
1751 Then you may use an arrayref to insert and update database array types:
1753 my $sql = SQL::Abstract->new(array_datatypes => 1);
1755 planets => [qw/Mercury Venus Earth Mars/]
1758 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1762 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1764 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1767 =head2 Inserting and Updating SQL
1769 In order to apply SQL functions to elements of your C<%data> you may
1770 specify a reference to an arrayref for the given hash value. For example,
1771 if you need to execute the Oracle C<to_date> function on a value, you can
1772 say something like this:
1776 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1779 The first value in the array is the actual SQL. Any other values are
1780 optional and would be included in the bind values array. This gives
1783 my($stmt, @bind) = $sql->insert('people', \%data);
1785 $stmt = "INSERT INTO people (name, date_entered)
1786 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1787 @bind = ('Bill', '03/02/2003');
1789 An UPDATE is just as easy, all you change is the name of the function:
1791 my($stmt, @bind) = $sql->update('people', \%data);
1793 Notice that your C<%data> isn't touched; the module will generate
1794 the appropriately quirky SQL for you automatically. Usually you'll
1795 want to specify a WHERE clause for your UPDATE, though, which is
1796 where handling C<%where> hashes comes in handy...
1798 =head2 Complex where statements
1800 This module can generate pretty complicated WHERE statements
1801 easily. For example, simple C<key=value> pairs are taken to mean
1802 equality, and if you want to see if a field is within a set
1803 of values, you can use an arrayref. Let's say we wanted to
1804 SELECT some data based on this criteria:
1807 requestor => 'inna',
1808 worker => ['nwiger', 'rcwe', 'sfz'],
1809 status => { '!=', 'completed' }
1812 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1814 The above would give you something like this:
1816 $stmt = "SELECT * FROM tickets WHERE
1817 ( requestor = ? ) AND ( status != ? )
1818 AND ( worker = ? OR worker = ? OR worker = ? )";
1819 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1821 Which you could then use in DBI code like so:
1823 my $sth = $dbh->prepare($stmt);
1824 $sth->execute(@bind);
1830 The methods are simple. There's one for every major SQL operation,
1831 and a constructor you use first. The arguments are specified in a
1832 similar order for each method (table, then fields, then a where
1833 clause) to try and simplify things.
1835 =head2 new(option => 'value')
1837 The C<new()> function takes a list of options and values, and returns
1838 a new B<SQL::Abstract> object which can then be used to generate SQL
1839 through the methods below. The options accepted are:
1845 If set to 'lower', then SQL will be generated in all lowercase. By
1846 default SQL is generated in "textbook" case meaning something like:
1848 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1850 Any setting other than 'lower' is ignored.
1854 This determines what the default comparison operator is. By default
1855 it is C<=>, meaning that a hash like this:
1857 %where = (name => 'nwiger', email => 'nate@wiger.org');
1859 Will generate SQL like this:
1861 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1863 However, you may want loose comparisons by default, so if you set
1864 C<cmp> to C<like> you would get SQL such as:
1866 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1868 You can also override the comparison on an individual basis - see
1869 the huge section on L</"WHERE CLAUSES"> at the bottom.
1871 =item sqltrue, sqlfalse
1873 Expressions for inserting boolean values within SQL statements.
1874 By default these are C<1=1> and C<1=0>. They are used
1875 by the special operators C<-in> and C<-not_in> for generating
1876 correct SQL even when the argument is an empty array (see below).
1880 This determines the default logical operator for multiple WHERE
1881 statements in arrays or hashes. If absent, the default logic is "or"
1882 for arrays, and "and" for hashes. This means that a WHERE
1886 event_date => {'>=', '2/13/99'},
1887 event_date => {'<=', '4/24/03'},
1890 will generate SQL like this:
1892 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1894 This is probably not what you want given this query, though (look
1895 at the dates). To change the "OR" to an "AND", simply specify:
1897 my $sql = SQL::Abstract->new(logic => 'and');
1899 Which will change the above C<WHERE> to:
1901 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1903 The logic can also be changed locally by inserting
1904 a modifier in front of an arrayref:
1906 @where = (-and => [event_date => {'>=', '2/13/99'},
1907 event_date => {'<=', '4/24/03'} ]);
1909 See the L</"WHERE CLAUSES"> section for explanations.
1913 This will automatically convert comparisons using the specified SQL
1914 function for both column and value. This is mostly used with an argument
1915 of C<upper> or C<lower>, so that the SQL will have the effect of
1916 case-insensitive "searches". For example, this:
1918 $sql = SQL::Abstract->new(convert => 'upper');
1919 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1921 Will turn out the following SQL:
1923 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1925 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1926 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1927 not validate this option; it will just pass through what you specify verbatim).
1931 This is a kludge because many databases suck. For example, you can't
1932 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1933 Instead, you have to use C<bind_param()>:
1935 $sth->bind_param(1, 'reg data');
1936 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1938 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1939 which loses track of which field each slot refers to. Fear not.
1941 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1942 Currently, you can specify either C<normal> (default) or C<columns>. If you
1943 specify C<columns>, you will get an array that looks like this:
1945 my $sql = SQL::Abstract->new(bindtype => 'columns');
1946 my($stmt, @bind) = $sql->insert(...);
1949 [ 'column1', 'value1' ],
1950 [ 'column2', 'value2' ],
1951 [ 'column3', 'value3' ],
1954 You can then iterate through this manually, using DBI's C<bind_param()>.
1956 $sth->prepare($stmt);
1959 my($col, $data) = @$_;
1960 if ($col eq 'details' || $col eq 'comments') {
1961 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1962 } elsif ($col eq 'image') {
1963 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1965 $sth->bind_param($i, $data);
1969 $sth->execute; # execute without @bind now
1971 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1972 Basically, the advantage is still that you don't have to care which fields
1973 are or are not included. You could wrap that above C<for> loop in a simple
1974 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1975 get a layer of abstraction over manual SQL specification.
1977 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1978 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1979 will expect the bind values in this format.
1983 This is the character that a table or column name will be quoted
1984 with. By default this is an empty string, but you could set it to
1985 the character C<`>, to generate SQL like this:
1987 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1989 Alternatively, you can supply an array ref of two items, the first being the left
1990 hand quote character, and the second the right hand quote character. For
1991 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1992 that generates SQL like this:
1994 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1996 Quoting is useful if you have tables or columns names that are reserved
1997 words in your database's SQL dialect.
2001 This is the character that will be used to escape L</quote_char>s appearing
2002 in an identifier before it has been quoted.
2004 The parameter default in case of a single L</quote_char> character is the quote
2007 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2008 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2009 of the B<opening (left)> L</quote_char> within the identifier are currently left
2010 untouched. The default for opening-closing-style quotes may change in future
2011 versions, thus you are B<strongly encouraged> to specify the escape character
2016 This is the character that separates a table and column name. It is
2017 necessary to specify this when the C<quote_char> option is selected,
2018 so that tables and column names can be individually quoted like this:
2020 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2022 =item injection_guard
2024 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2025 column name specified in a query structure. This is a safety mechanism to avoid
2026 injection attacks when mishandling user input e.g.:
2028 my %condition_as_column_value_pairs = get_values_from_user();
2029 $sqla->select( ... , \%condition_as_column_value_pairs );
2031 If the expression matches an exception is thrown. Note that literal SQL
2032 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2034 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2036 =item array_datatypes
2038 When this option is true, arrayrefs in INSERT or UPDATE are
2039 interpreted as array datatypes and are passed directly
2041 When this option is false, arrayrefs are interpreted
2042 as literal SQL, just like refs to arrayrefs
2043 (but this behavior is for backwards compatibility; when writing
2044 new queries, use the "reference to arrayref" syntax
2050 Takes a reference to a list of "special operators"
2051 to extend the syntax understood by L<SQL::Abstract>.
2052 See section L</"SPECIAL OPERATORS"> for details.
2056 Takes a reference to a list of "unary operators"
2057 to extend the syntax understood by L<SQL::Abstract>.
2058 See section L</"UNARY OPERATORS"> for details.
2064 =head2 insert($table, \@values || \%fieldvals, \%options)
2066 This is the simplest function. You simply give it a table name
2067 and either an arrayref of values or hashref of field/value pairs.
2068 It returns an SQL INSERT statement and a list of bind values.
2069 See the sections on L</"Inserting and Updating Arrays"> and
2070 L</"Inserting and Updating SQL"> for information on how to insert
2071 with those data types.
2073 The optional C<\%options> hash reference may contain additional
2074 options to generate the insert SQL. Currently supported options
2081 Takes either a scalar of raw SQL fields, or an array reference of
2082 field names, and adds on an SQL C<RETURNING> statement at the end.
2083 This allows you to return data generated by the insert statement
2084 (such as row IDs) without performing another C<SELECT> statement.
2085 Note, however, this is not part of the SQL standard and may not
2086 be supported by all database engines.
2090 =head2 update($table, \%fieldvals, \%where, \%options)
2092 This takes a table, hashref of field/value pairs, and an optional
2093 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2095 See the sections on L</"Inserting and Updating Arrays"> and
2096 L</"Inserting and Updating SQL"> for information on how to insert
2097 with those data types.
2099 The optional C<\%options> hash reference may contain additional
2100 options to generate the update SQL. Currently supported options
2107 See the C<returning> option to
2108 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2112 =head2 select($source, $fields, $where, $order)
2114 This returns a SQL SELECT statement and associated list of bind values, as
2115 specified by the arguments:
2121 Specification of the 'FROM' part of the statement.
2122 The argument can be either a plain scalar (interpreted as a table
2123 name, will be quoted), or an arrayref (interpreted as a list
2124 of table names, joined by commas, quoted), or a scalarref
2125 (literal SQL, not quoted).
2129 Specification of the list of fields to retrieve from
2131 The argument can be either an arrayref (interpreted as a list
2132 of field names, will be joined by commas and quoted), or a
2133 plain scalar (literal SQL, not quoted).
2134 Please observe that this API is not as flexible as that of
2135 the first argument C<$source>, for backwards compatibility reasons.
2139 Optional argument to specify the WHERE part of the query.
2140 The argument is most often a hashref, but can also be
2141 an arrayref or plain scalar --
2142 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2146 Optional argument to specify the ORDER BY part of the query.
2147 The argument can be a scalar, a hashref or an arrayref
2148 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2154 =head2 delete($table, \%where, \%options)
2156 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2157 It returns an SQL DELETE statement and list of bind values.
2159 The optional C<\%options> hash reference may contain additional
2160 options to generate the delete SQL. Currently supported options
2167 See the C<returning> option to
2168 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2172 =head2 where(\%where, $order)
2174 This is used to generate just the WHERE clause. For example,
2175 if you have an arbitrary data structure and know what the
2176 rest of your SQL is going to look like, but want an easy way
2177 to produce a WHERE clause, use this. It returns an SQL WHERE
2178 clause and list of bind values.
2181 =head2 values(\%data)
2183 This just returns the values from the hash C<%data>, in the same
2184 order that would be returned from any of the other above queries.
2185 Using this allows you to markedly speed up your queries if you
2186 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2188 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2190 Warning: This is an experimental method and subject to change.
2192 This returns arbitrarily generated SQL. It's a really basic shortcut.
2193 It will return two different things, depending on return context:
2195 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2196 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2198 These would return the following:
2200 # First calling form
2201 $stmt = "CREATE TABLE test (?, ?)";
2202 @bind = (field1, field2);
2204 # Second calling form
2205 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2207 Depending on what you're trying to do, it's up to you to choose the correct
2208 format. In this example, the second form is what you would want.
2212 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2216 ALTER SESSION SET nls_date_format = 'MM/YY'
2218 You get the idea. Strings get their case twiddled, but everything
2219 else remains verbatim.
2221 =head1 EXPORTABLE FUNCTIONS
2223 =head2 is_plain_value
2225 Determines if the supplied argument is a plain value as understood by this
2230 =item * The value is C<undef>
2232 =item * The value is a non-reference
2234 =item * The value is an object with stringification overloading
2236 =item * The value is of the form C<< { -value => $anything } >>
2240 On failure returns C<undef>, on success returns a B<scalar> reference
2241 to the original supplied argument.
2247 The stringification overloading detection is rather advanced: it takes
2248 into consideration not only the presence of a C<""> overload, but if that
2249 fails also checks for enabled
2250 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2251 on either C<0+> or C<bool>.
2253 Unfortunately testing in the field indicates that this
2254 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2255 but only when very large numbers of stringifying objects are involved.
2256 At the time of writing ( Sep 2014 ) there is no clear explanation of
2257 the direct cause, nor is there a manageably small test case that reliably
2258 reproduces the problem.
2260 If you encounter any of the following exceptions in B<random places within
2261 your application stack> - this module may be to blame:
2263 Operation "ne": no method found,
2264 left argument in overloaded package <something>,
2265 right argument in overloaded package <something>
2269 Stub found while resolving method "???" overloading """" in package <something>
2271 If you fall victim to the above - please attempt to reduce the problem
2272 to something that could be sent to the L<SQL::Abstract developers
2273 |DBIx::Class/GETTING HELP/SUPPORT>
2274 (either publicly or privately). As a workaround in the meantime you can
2275 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2276 value, which will most likely eliminate your problem (at the expense of
2277 not being able to properly detect exotic forms of stringification).
2279 This notice and environment variable will be removed in a future version,
2280 as soon as the underlying problem is found and a reliable workaround is
2285 =head2 is_literal_value
2287 Determines if the supplied argument is a literal value as understood by this
2292 =item * C<\$sql_string>
2294 =item * C<\[ $sql_string, @bind_values ]>
2298 On failure returns C<undef>, on success returns an B<array> reference
2299 containing the unpacked version of the supplied literal SQL and bind values.
2301 =head1 WHERE CLAUSES
2305 This module uses a variation on the idea from L<DBIx::Abstract>. It
2306 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2307 module is that things in arrays are OR'ed, and things in hashes
2310 The easiest way to explain is to show lots of examples. After
2311 each C<%where> hash shown, it is assumed you used:
2313 my($stmt, @bind) = $sql->where(\%where);
2315 However, note that the C<%where> hash can be used directly in any
2316 of the other functions as well, as described above.
2318 =head2 Key-value pairs
2320 So, let's get started. To begin, a simple hash:
2324 status => 'completed'
2327 Is converted to SQL C<key = val> statements:
2329 $stmt = "WHERE user = ? AND status = ?";
2330 @bind = ('nwiger', 'completed');
2332 One common thing I end up doing is having a list of values that
2333 a field can be in. To do this, simply specify a list inside of
2338 status => ['assigned', 'in-progress', 'pending'];
2341 This simple code will create the following:
2343 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2344 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2346 A field associated to an empty arrayref will be considered a
2347 logical false and will generate 0=1.
2349 =head2 Tests for NULL values
2351 If the value part is C<undef> then this is converted to SQL <IS NULL>
2360 $stmt = "WHERE user = ? AND status IS NULL";
2363 To test if a column IS NOT NULL:
2367 status => { '!=', undef },
2370 =head2 Specific comparison operators
2372 If you want to specify a different type of operator for your comparison,
2373 you can use a hashref for a given column:
2377 status => { '!=', 'completed' }
2380 Which would generate:
2382 $stmt = "WHERE user = ? AND status != ?";
2383 @bind = ('nwiger', 'completed');
2385 To test against multiple values, just enclose the values in an arrayref:
2387 status => { '=', ['assigned', 'in-progress', 'pending'] };
2389 Which would give you:
2391 "WHERE status = ? OR status = ? OR status = ?"
2394 The hashref can also contain multiple pairs, in which case it is expanded
2395 into an C<AND> of its elements:
2399 status => { '!=', 'completed', -not_like => 'pending%' }
2402 # Or more dynamically, like from a form
2403 $where{user} = 'nwiger';
2404 $where{status}{'!='} = 'completed';
2405 $where{status}{'-not_like'} = 'pending%';
2407 # Both generate this
2408 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2409 @bind = ('nwiger', 'completed', 'pending%');
2412 To get an OR instead, you can combine it with the arrayref idea:
2416 priority => [ { '=', 2 }, { '>', 5 } ]
2419 Which would generate:
2421 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2422 @bind = ('2', '5', 'nwiger');
2424 If you want to include literal SQL (with or without bind values), just use a
2425 scalar reference or reference to an arrayref as the value:
2428 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2429 date_expires => { '<' => \"now()" }
2432 Which would generate:
2434 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2435 @bind = ('11/26/2008');
2438 =head2 Logic and nesting operators
2440 In the example above,
2441 there is a subtle trap if you want to say something like
2442 this (notice the C<AND>):
2444 WHERE priority != ? AND priority != ?
2446 Because, in Perl you I<can't> do this:
2448 priority => { '!=' => 2, '!=' => 1 }
2450 As the second C<!=> key will obliterate the first. The solution
2451 is to use the special C<-modifier> form inside an arrayref:
2453 priority => [ -and => {'!=', 2},
2457 Normally, these would be joined by C<OR>, but the modifier tells it
2458 to use C<AND> instead. (Hint: You can use this in conjunction with the
2459 C<logic> option to C<new()> in order to change the way your queries
2460 work by default.) B<Important:> Note that the C<-modifier> goes
2461 B<INSIDE> the arrayref, as an extra first element. This will
2462 B<NOT> do what you think it might:
2464 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2466 Here is a quick list of equivalencies, since there is some overlap:
2469 status => {'!=', 'completed', 'not like', 'pending%' }
2470 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2473 status => {'=', ['assigned', 'in-progress']}
2474 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2475 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2479 =head2 Special operators: IN, BETWEEN, etc.
2481 You can also use the hashref format to compare a list of fields using the
2482 C<IN> comparison operator, by specifying the list as an arrayref:
2485 status => 'completed',
2486 reportid => { -in => [567, 2335, 2] }
2489 Which would generate:
2491 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2492 @bind = ('completed', '567', '2335', '2');
2494 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2497 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2498 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2499 'sqltrue' (by default: C<1=1>).
2501 In addition to the array you can supply a chunk of literal sql or
2502 literal sql with bind:
2505 customer => { -in => \[
2506 'SELECT cust_id FROM cust WHERE balance > ?',
2509 status => { -in => \'SELECT status_codes FROM states' },
2515 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2516 AND status IN ( SELECT status_codes FROM states )
2520 Finally, if the argument to C<-in> is not a reference, it will be
2521 treated as a single-element array.
2523 Another pair of operators is C<-between> and C<-not_between>,
2524 used with an arrayref of two values:
2528 completion_date => {
2529 -not_between => ['2002-10-01', '2003-02-06']
2535 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2537 Just like with C<-in> all plausible combinations of literal SQL
2541 start0 => { -between => [ 1, 2 ] },
2542 start1 => { -between => \["? AND ?", 1, 2] },
2543 start2 => { -between => \"lower(x) AND upper(y)" },
2544 start3 => { -between => [
2546 \["upper(?)", 'stuff' ],
2553 ( start0 BETWEEN ? AND ? )
2554 AND ( start1 BETWEEN ? AND ? )
2555 AND ( start2 BETWEEN lower(x) AND upper(y) )
2556 AND ( start3 BETWEEN lower(x) AND upper(?) )
2558 @bind = (1, 2, 1, 2, 'stuff');
2561 These are the two builtin "special operators"; but the
2562 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2564 =head2 Unary operators: bool
2566 If you wish to test against boolean columns or functions within your
2567 database you can use the C<-bool> and C<-not_bool> operators. For
2568 example to test the column C<is_user> being true and the column
2569 C<is_enabled> being false you would use:-
2573 -not_bool => 'is_enabled',
2578 WHERE is_user AND NOT is_enabled
2580 If a more complex combination is required, testing more conditions,
2581 then you should use the and/or operators:-
2586 -not_bool => { two=> { -rlike => 'bar' } },
2587 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2598 (NOT ( three = ? OR three > ? ))
2601 =head2 Nested conditions, -and/-or prefixes
2603 So far, we've seen how multiple conditions are joined with a top-level
2604 C<AND>. We can change this by putting the different conditions we want in
2605 hashes and then putting those hashes in an array. For example:
2610 status => { -like => ['pending%', 'dispatched'] },
2614 status => 'unassigned',
2618 This data structure would create the following:
2620 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2621 OR ( user = ? AND status = ? ) )";
2622 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2625 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2626 to change the logic inside:
2632 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2633 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2640 $stmt = "WHERE ( user = ?
2641 AND ( ( workhrs > ? AND geo = ? )
2642 OR ( workhrs < ? OR geo = ? ) ) )";
2643 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2645 =head3 Algebraic inconsistency, for historical reasons
2647 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2648 operator goes C<outside> of the nested structure; whereas when connecting
2649 several constraints on one column, the C<-and> operator goes
2650 C<inside> the arrayref. Here is an example combining both features:
2653 -and => [a => 1, b => 2],
2654 -or => [c => 3, d => 4],
2655 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2660 WHERE ( ( ( a = ? AND b = ? )
2661 OR ( c = ? OR d = ? )
2662 OR ( e LIKE ? AND e LIKE ? ) ) )
2664 This difference in syntax is unfortunate but must be preserved for
2665 historical reasons. So be careful: the two examples below would
2666 seem algebraically equivalent, but they are not
2669 { -like => 'foo%' },
2670 { -like => '%bar' },
2672 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2675 { col => { -like => 'foo%' } },
2676 { col => { -like => '%bar' } },
2678 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2681 =head2 Literal SQL and value type operators
2683 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2684 side" is a column name and the "right side" is a value (normally rendered as
2685 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2686 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2687 alter this behavior. There are several ways of doing so.
2691 This is a virtual operator that signals the string to its right side is an
2692 identifier (a column name) and not a value. For example to compare two
2693 columns you would write:
2696 priority => { '<', 2 },
2697 requestor => { -ident => 'submitter' },
2702 $stmt = "WHERE priority < ? AND requestor = submitter";
2705 If you are maintaining legacy code you may see a different construct as
2706 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2711 This is a virtual operator that signals that the construct to its right side
2712 is a value to be passed to DBI. This is for example necessary when you want
2713 to write a where clause against an array (for RDBMS that support such
2714 datatypes). For example:
2717 array => { -value => [1, 2, 3] }
2722 $stmt = 'WHERE array = ?';
2723 @bind = ([1, 2, 3]);
2725 Note that if you were to simply say:
2731 the result would probably not be what you wanted:
2733 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2738 Finally, sometimes only literal SQL will do. To include a random snippet
2739 of SQL verbatim, you specify it as a scalar reference. Consider this only
2740 as a last resort. Usually there is a better way. For example:
2743 priority => { '<', 2 },
2744 requestor => { -in => \'(SELECT name FROM hitmen)' },
2749 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2752 Note that in this example, you only get one bind parameter back, since
2753 the verbatim SQL is passed as part of the statement.
2757 Never use untrusted input as a literal SQL argument - this is a massive
2758 security risk (there is no way to check literal snippets for SQL
2759 injections and other nastyness). If you need to deal with untrusted input
2760 use literal SQL with placeholders as described next.
2762 =head3 Literal SQL with placeholders and bind values (subqueries)
2764 If the literal SQL to be inserted has placeholders and bind values,
2765 use a reference to an arrayref (yes this is a double reference --
2766 not so common, but perfectly legal Perl). For example, to find a date
2767 in Postgres you can use something like this:
2770 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2775 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2778 Note that you must pass the bind values in the same format as they are returned
2779 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2780 to C<columns>, you must provide the bind values in the
2781 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2782 scalar value; most commonly the column name, but you can use any scalar value
2783 (including references and blessed references), L<SQL::Abstract> will simply
2784 pass it through intact. So if C<bindtype> is set to C<columns> the above
2785 example will look like:
2788 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2791 Literal SQL is especially useful for nesting parenthesized clauses in the
2792 main SQL query. Here is a first example:
2794 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2798 bar => \["IN ($sub_stmt)" => @sub_bind],
2803 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2804 WHERE c2 < ? AND c3 LIKE ?))";
2805 @bind = (1234, 100, "foo%");
2807 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2808 are expressed in the same way. Of course the C<$sub_stmt> and
2809 its associated bind values can be generated through a former call
2812 my ($sub_stmt, @sub_bind)
2813 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2814 c3 => {-like => "foo%"}});
2817 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2820 In the examples above, the subquery was used as an operator on a column;
2821 but the same principle also applies for a clause within the main C<%where>
2822 hash, like an EXISTS subquery:
2824 my ($sub_stmt, @sub_bind)
2825 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2826 my %where = ( -and => [
2828 \["EXISTS ($sub_stmt)" => @sub_bind],
2833 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2834 WHERE c1 = ? AND c2 > t0.c0))";
2838 Observe that the condition on C<c2> in the subquery refers to
2839 column C<t0.c0> of the main query: this is I<not> a bind
2840 value, so we have to express it through a scalar ref.
2841 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2842 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2843 what we wanted here.
2845 Finally, here is an example where a subquery is used
2846 for expressing unary negation:
2848 my ($sub_stmt, @sub_bind)
2849 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2850 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2852 lname => {like => '%son%'},
2853 \["NOT ($sub_stmt)" => @sub_bind],
2858 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2859 @bind = ('%son%', 10, 20)
2861 =head3 Deprecated usage of Literal SQL
2863 Below are some examples of archaic use of literal SQL. It is shown only as
2864 reference for those who deal with legacy code. Each example has a much
2865 better, cleaner and safer alternative that users should opt for in new code.
2871 my %where = ( requestor => \'IS NOT NULL' )
2873 $stmt = "WHERE requestor IS NOT NULL"
2875 This used to be the way of generating NULL comparisons, before the handling
2876 of C<undef> got formalized. For new code please use the superior syntax as
2877 described in L</Tests for NULL values>.
2881 my %where = ( requestor => \'= submitter' )
2883 $stmt = "WHERE requestor = submitter"
2885 This used to be the only way to compare columns. Use the superior L</-ident>
2886 method for all new code. For example an identifier declared in such a way
2887 will be properly quoted if L</quote_char> is properly set, while the legacy
2888 form will remain as supplied.
2892 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2894 $stmt = "WHERE completed > ? AND is_ready"
2895 @bind = ('2012-12-21')
2897 Using an empty string literal used to be the only way to express a boolean.
2898 For all new code please use the much more readable
2899 L<-bool|/Unary operators: bool> operator.
2905 These pages could go on for a while, since the nesting of the data
2906 structures this module can handle are pretty much unlimited (the
2907 module implements the C<WHERE> expansion as a recursive function
2908 internally). Your best bet is to "play around" with the module a
2909 little to see how the data structures behave, and choose the best
2910 format for your data based on that.
2912 And of course, all the values above will probably be replaced with
2913 variables gotten from forms or the command line. After all, if you
2914 knew everything ahead of time, you wouldn't have to worry about
2915 dynamically-generating SQL and could just hardwire it into your
2918 =head1 ORDER BY CLAUSES
2920 Some functions take an order by clause. This can either be a scalar (just a
2921 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2922 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2925 Given | Will Generate
2926 ---------------------------------------------------------------
2928 'colA' | ORDER BY colA
2930 [qw/colA colB/] | ORDER BY colA, colB
2932 {-asc => 'colA'} | ORDER BY colA ASC
2934 {-desc => 'colB'} | ORDER BY colB DESC
2936 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2938 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2940 \'colA DESC' | ORDER BY colA DESC
2942 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2943 | /* ...with $x bound to ? */
2946 { -asc => 'colA' }, | colA ASC,
2947 { -desc => [qw/colB/] }, | colB DESC,
2948 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2949 \'colE DESC', | colE DESC,
2950 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2951 ] | /* ...with $x bound to ? */
2952 ===============================================================
2956 =head1 SPECIAL OPERATORS
2958 my $sqlmaker = SQL::Abstract->new(special_ops => [
2962 my ($self, $field, $op, $arg) = @_;
2968 handler => 'method_name',
2972 A "special operator" is a SQL syntactic clause that can be
2973 applied to a field, instead of a usual binary operator.
2976 WHERE field IN (?, ?, ?)
2977 WHERE field BETWEEN ? AND ?
2978 WHERE MATCH(field) AGAINST (?, ?)
2980 Special operators IN and BETWEEN are fairly standard and therefore
2981 are builtin within C<SQL::Abstract> (as the overridable methods
2982 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2983 like the MATCH .. AGAINST example above which is specific to MySQL,
2984 you can write your own operator handlers - supply a C<special_ops>
2985 argument to the C<new> method. That argument takes an arrayref of
2986 operator definitions; each operator definition is a hashref with two
2993 the regular expression to match the operator
2997 Either a coderef or a plain scalar method name. In both cases
2998 the expected return is C<< ($sql, @bind) >>.
3000 When supplied with a method name, it is simply called on the
3001 L<SQL::Abstract> object as:
3003 $self->$method_name($field, $op, $arg)
3007 $field is the LHS of the operator
3008 $op is the part that matched the handler regex
3011 When supplied with a coderef, it is called as:
3013 $coderef->($self, $field, $op, $arg)
3018 For example, here is an implementation
3019 of the MATCH .. AGAINST syntax for MySQL
3021 my $sqlmaker = SQL::Abstract->new(special_ops => [
3023 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3024 {regex => qr/^match$/i,
3026 my ($self, $field, $op, $arg) = @_;
3027 $arg = [$arg] if not ref $arg;
3028 my $label = $self->_quote($field);
3029 my ($placeholder) = $self->_convert('?');
3030 my $placeholders = join ", ", (($placeholder) x @$arg);
3031 my $sql = $self->_sqlcase('match') . " ($label) "
3032 . $self->_sqlcase('against') . " ($placeholders) ";
3033 my @bind = $self->_bindtype($field, @$arg);
3034 return ($sql, @bind);
3041 =head1 UNARY OPERATORS
3043 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3047 my ($self, $op, $arg) = @_;
3053 handler => 'method_name',
3057 A "unary operator" is a SQL syntactic clause that can be
3058 applied to a field - the operator goes before the field
3060 You can write your own operator handlers - supply a C<unary_ops>
3061 argument to the C<new> method. That argument takes an arrayref of
3062 operator definitions; each operator definition is a hashref with two
3069 the regular expression to match the operator
3073 Either a coderef or a plain scalar method name. In both cases
3074 the expected return is C<< $sql >>.
3076 When supplied with a method name, it is simply called on the
3077 L<SQL::Abstract> object as:
3079 $self->$method_name($op, $arg)
3083 $op is the part that matched the handler regex
3084 $arg is the RHS or argument of the operator
3086 When supplied with a coderef, it is called as:
3088 $coderef->($self, $op, $arg)
3096 Thanks to some benchmarking by Mark Stosberg, it turns out that
3097 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3098 I must admit this wasn't an intentional design issue, but it's a
3099 byproduct of the fact that you get to control your C<DBI> handles
3102 To maximize performance, use a code snippet like the following:
3104 # prepare a statement handle using the first row
3105 # and then reuse it for the rest of the rows
3107 for my $href (@array_of_hashrefs) {
3108 $stmt ||= $sql->insert('table', $href);
3109 $sth ||= $dbh->prepare($stmt);
3110 $sth->execute($sql->values($href));
3113 The reason this works is because the keys in your C<$href> are sorted
3114 internally by B<SQL::Abstract>. Thus, as long as your data retains
3115 the same structure, you only have to generate the SQL the first time
3116 around. On subsequent queries, simply use the C<values> function provided
3117 by this module to return your values in the correct order.
3119 However this depends on the values having the same type - if, for
3120 example, the values of a where clause may either have values
3121 (resulting in sql of the form C<column = ?> with a single bind
3122 value), or alternatively the values might be C<undef> (resulting in
3123 sql of the form C<column IS NULL> with no bind value) then the
3124 caching technique suggested will not work.
3128 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3129 really like this part (I do, at least). Building up a complex query
3130 can be as simple as the following:
3137 use CGI::FormBuilder;
3140 my $form = CGI::FormBuilder->new(...);
3141 my $sql = SQL::Abstract->new;
3143 if ($form->submitted) {
3144 my $field = $form->field;
3145 my $id = delete $field->{id};
3146 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3149 Of course, you would still have to connect using C<DBI> to run the
3150 query, but the point is that if you make your form look like your
3151 table, the actual query script can be extremely simplistic.
3153 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3154 a fast interface to returning and formatting data. I frequently
3155 use these three modules together to write complex database query
3156 apps in under 50 lines.
3158 =head1 HOW TO CONTRIBUTE
3160 Contributions are always welcome, in all usable forms (we especially
3161 welcome documentation improvements). The delivery methods include git-
3162 or unified-diff formatted patches, GitHub pull requests, or plain bug
3163 reports either via RT or the Mailing list. Contributors are generally
3164 granted full access to the official repository after their first several
3165 patches pass successful review.
3167 This project is maintained in a git repository. The code and related tools are
3168 accessible at the following locations:
3172 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3174 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3176 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3178 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3184 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3185 Great care has been taken to preserve the I<published> behavior
3186 documented in previous versions in the 1.* family; however,
3187 some features that were previously undocumented, or behaved
3188 differently from the documentation, had to be changed in order
3189 to clarify the semantics. Hence, client code that was relying
3190 on some dark areas of C<SQL::Abstract> v1.*
3191 B<might behave differently> in v1.50.
3193 The main changes are:
3199 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3203 support for the { operator => \"..." } construct (to embed literal SQL)
3207 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3211 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3215 defensive programming: check arguments
3219 fixed bug with global logic, which was previously implemented
3220 through global variables yielding side-effects. Prior versions would
3221 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3222 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3223 Now this is interpreted
3224 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3229 fixed semantics of _bindtype on array args
3233 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3234 we just avoid shifting arrays within that tree.
3238 dropped the C<_modlogic> function
3242 =head1 ACKNOWLEDGEMENTS
3244 There are a number of individuals that have really helped out with
3245 this module. Unfortunately, most of them submitted bugs via CPAN
3246 so I have no idea who they are! But the people I do know are:
3248 Ash Berlin (order_by hash term support)
3249 Matt Trout (DBIx::Class support)
3250 Mark Stosberg (benchmarking)
3251 Chas Owens (initial "IN" operator support)
3252 Philip Collins (per-field SQL functions)
3253 Eric Kolve (hashref "AND" support)
3254 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3255 Dan Kubb (support for "quote_char" and "name_sep")
3256 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3257 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3258 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3259 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3260 Oliver Charles (support for "RETURNING" after "INSERT")
3266 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3270 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3272 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3274 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3275 While not an official support venue, C<DBIx::Class> makes heavy use of
3276 C<SQL::Abstract>, and as such list members there are very familiar with
3277 how to create queries.
3281 This module is free software; you may copy this under the same
3282 terms as perl itself (either the GNU General Public License or
3283 the Artistic License)