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 values)),
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->render_aqt({ -values => $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;
1086 sub _render_values {
1087 my ($self, $values) = @_;
1088 my ($sql, @bind) = $self->_join_parts(
1090 map [ $self->render_aqt($_) ],
1091 ref($values) eq 'ARRAY' ? @$values : $values
1093 return $self->_sqlcase('values ').$sql, @bind;
1097 my ($self, $rest) = @_;
1098 my ($func, @args) = @$rest;
1099 if (ref($func) eq 'HASH') {
1100 $func = $self->render_aqt($func);
1105 push @arg_sql, shift @x;
1107 } map [ $self->render_aqt($_) ], @args;
1108 return ($self->_sqlcase($func).'('.join(', ', @arg_sql).')', @bind);
1112 my ($self, $bind) = @_;
1113 return ($self->_convert('?'), $self->_bindtype(@$bind));
1116 sub _render_literal {
1117 my ($self, $literal) = @_;
1118 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1123 my ($self, $v) = @_;
1124 my ($op, @args) = @$v;
1125 if (my $r = $self->{render_op}{$op}) {
1126 return $self->$r($op, \@args);
1131 my $op = join(' ', split '_', $op);
1133 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1134 if ($ss and @args > 1) {
1135 puke "Special op '${op}' requires first value to be identifier"
1136 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1137 my $k = join(($self->{name_sep}||'.'), @$ident);
1138 local our $Expand_Depth = 1;
1139 return $self->${\($ss->{handler})}($k, $op, $args[1]);
1141 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1142 return $self->${\($us->{handler})}($op, $args[0]);
1145 return $self->_render_unop_paren($op, \@args);
1149 return $self->_render_unop_prefix($op, \@args);
1151 return $self->_render_op_multop($op, \@args);
1157 sub _render_op_between {
1158 my ($self, $op, $args) = @_;
1159 my ($left, $low, $high) = @$args;
1160 my ($rhsql, @rhbind) = do {
1162 puke "Single arg to between must be a literal"
1163 unless $low->{-literal};
1166 my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high;
1167 (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1168 @{$l}[1..$#$l], @{$h}[1..$#$h])
1171 my ($lhsql, @lhbind) = $self->render_aqt($left);
1175 $self->_sqlcase(join ' ', split '_', $op),
1183 my ($self, $op, $args) = @_;
1184 my ($lhs, @rhs) = @$args;
1187 my ($sql, @bind) = $self->render_aqt($_);
1188 push @in_bind, @bind;
1191 my ($lhsql, @lbind) = $self->render_aqt($lhs);
1193 $lhsql.' '.$self->_sqlcase(join ' ', split '_', $op).' ( '
1194 .join(', ', @in_sql)
1200 sub _render_op_andor {
1201 my ($self, $op, $args) = @_;
1202 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1203 return '' unless @parts;
1204 return @{$parts[0]} if @parts == 1;
1205 my ($sql, @bind) = $self->_join_parts(' '.$self->_sqlcase($op).' ', @parts);
1206 return '( '.$sql.' )', @bind;
1209 sub _render_op_multop {
1210 my ($self, $op, $args) = @_;
1211 my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args;
1212 return '' unless @parts;
1213 return @{$parts[0]} if @parts == 1;
1214 my $join = ($op eq ','
1216 : ' '.$self->_sqlcase(join ' ', split '_', $op).' '
1218 return $self->_join_parts($join, @parts);
1222 my ($self, $join, @parts) = @_;
1224 join($join, map $_->[0], @parts),
1225 (wantarray ? (map @{$_}[1..$#$_], @parts) : ()),
1229 sub _render_unop_paren {
1230 my ($self, $op, $v) = @_;
1231 my ($sql, @bind) = $self->_render_unop_prefix($op, $v);
1232 return "(${sql})", @bind;
1235 sub _render_unop_prefix {
1236 my ($self, $op, $v) = @_;
1237 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1239 my $op_sql = $self->_sqlcase($op); # join ' ', split '_', $op);
1240 return ("${op_sql} ${expr_sql}", @bind);
1243 sub _render_unop_postfix {
1244 my ($self, $op, $v) = @_;
1245 my ($expr_sql, @bind) = $self->render_aqt($v->[0]);
1246 my $op_sql = $self->_sqlcase(join ' ', split '_', $op);
1247 return ($expr_sql.' '.$op_sql, @bind);
1250 # Some databases (SQLite) treat col IN (1, 2) different from
1251 # col IN ( (1, 2) ). Use this to strip all outer parens while
1252 # adding them back in the corresponding method
1253 sub _open_outer_paren {
1254 my ($self, $sql) = @_;
1256 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1258 # there are closing parens inside, need the heavy duty machinery
1259 # to reevaluate the extraction starting from $sql (full reevaluation)
1260 if ($inner =~ /\)/) {
1261 require Text::Balanced;
1263 my (undef, $remainder) = do {
1264 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1266 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1269 # the entire expression needs to be a balanced bracketed thing
1270 # (after an extract no remainder sans trailing space)
1271 last if defined $remainder and $remainder =~ /\S/;
1281 #======================================================================
1283 #======================================================================
1285 sub _expand_order_by {
1286 my ($self, $arg) = @_;
1288 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1290 return $self->_expand_maybe_list_expr($arg)
1291 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1293 my $expander = sub {
1294 my ($self, $dir, $expr) = @_;
1295 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1296 foreach my $arg (@to_expand) {
1300 and grep /^-(asc|desc)$/, keys %$arg
1302 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1306 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1308 map $self->expand_expr($_, -ident),
1309 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1310 return undef unless @exp;
1311 return undef if @exp == 1 and not defined($exp[0]);
1312 return +{ -op => [ ',', @exp ] };
1315 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1317 return $self->$expander(undef, $arg);
1321 my ($self, $arg) = @_;
1323 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1325 my ($sql, @bind) = $self->render_aqt($expanded);
1327 return '' unless length($sql);
1329 my $final_sql = $self->_sqlcase(' order by ').$sql;
1331 return wantarray ? ($final_sql, @bind) : $final_sql;
1334 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1336 sub _order_by_chunks {
1337 my ($self, $arg) = @_;
1339 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1341 return $self->_chunkify_order_by($expanded);
1344 sub _chunkify_order_by {
1345 my ($self, $expanded) = @_;
1347 return grep length, $self->render_aqt($expanded)
1348 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1351 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1352 my ($comma, @list) = @{$_->{-op}};
1353 return map $self->_chunkify_order_by($_), @list;
1355 return [ $self->render_aqt($_) ];
1359 #======================================================================
1360 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1361 #======================================================================
1367 $self->_expand_maybe_list_expr($from, -ident)
1372 #======================================================================
1374 #======================================================================
1376 sub _expand_maybe_list_expr {
1377 my ($self, $expr, $default) = @_;
1379 ',', map $self->expand_expr($_, $default),
1380 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1381 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1382 return +{ -op => [ ',',
1383 map $self->expand_expr($_, $default),
1384 ref($expr) eq 'ARRAY' ? @$expr : $expr
1388 # highly optimized, as it's called way too often
1390 # my ($self, $label) = @_;
1392 return '' unless defined $_[1];
1393 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1394 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1396 unless ($_[0]->{quote_char}) {
1397 if (ref($_[1]) eq 'ARRAY') {
1398 return join($_[0]->{name_sep}||'.', @{$_[1]});
1400 $_[0]->_assert_pass_injection_guard($_[1]);
1405 my $qref = ref $_[0]->{quote_char};
1407 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1408 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1409 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1411 my $esc = $_[0]->{escape_char} || $r;
1413 # parts containing * are naturally unquoted
1415 $_[0]->{name_sep}||'',
1419 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1421 (ref($_[1]) eq 'ARRAY'
1425 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1433 # Conversion, if applicable
1435 #my ($self, $arg) = @_;
1436 if ($_[0]->{convert_where}) {
1437 return $_[0]->_sqlcase($_[0]->{convert_where}) .'(' . $_[1] . ')';
1444 #my ($self, $col, @vals) = @_;
1445 # called often - tighten code
1446 return $_[0]->{bindtype} eq 'columns'
1447 ? map {[$_[1], $_]} @_[2 .. $#_]
1452 # Dies if any element of @bind is not in [colname => value] format
1453 # if bindtype is 'columns'.
1454 sub _assert_bindval_matches_bindtype {
1455 # my ($self, @bind) = @_;
1457 if ($self->{bindtype} eq 'columns') {
1459 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1460 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1466 sub _join_sql_clauses {
1467 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1469 if (@$clauses_aref > 1) {
1470 my $join = " " . $self->_sqlcase($logic) . " ";
1471 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1472 return ($sql, @$bind_aref);
1474 elsif (@$clauses_aref) {
1475 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1478 return (); # if no SQL, ignore @$bind_aref
1483 # Fix SQL case, if so requested
1485 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1486 # don't touch the argument ... crooked logic, but let's not change it!
1487 return $_[0]->{case} ? $_[1] : uc($_[1]);
1491 #======================================================================
1492 # DISPATCHING FROM REFKIND
1493 #======================================================================
1496 my ($self, $data) = @_;
1498 return 'UNDEF' unless defined $data;
1500 # blessed objects are treated like scalars
1501 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1503 return 'SCALAR' unless $ref;
1506 while ($ref eq 'REF') {
1508 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1512 return ($ref||'SCALAR') . ('REF' x $n_steps);
1516 my ($self, $data) = @_;
1517 my @try = ($self->_refkind($data));
1518 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1519 push @try, 'FALLBACK';
1523 sub _METHOD_FOR_refkind {
1524 my ($self, $meth_prefix, $data) = @_;
1527 for (@{$self->_try_refkind($data)}) {
1528 $method = $self->can($meth_prefix."_".$_)
1532 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1536 sub _SWITCH_refkind {
1537 my ($self, $data, $dispatch_table) = @_;
1540 for (@{$self->_try_refkind($data)}) {
1541 $coderef = $dispatch_table->{$_}
1545 puke "no dispatch entry for ".$self->_refkind($data)
1554 #======================================================================
1555 # VALUES, GENERATE, AUTOLOAD
1556 #======================================================================
1558 # LDNOTE: original code from nwiger, didn't touch code in that section
1559 # I feel the AUTOLOAD stuff should not be the default, it should
1560 # only be activated on explicit demand by user.
1564 my $data = shift || return;
1565 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1566 unless ref $data eq 'HASH';
1569 foreach my $k (sort keys %$data) {
1570 my $v = $data->{$k};
1571 $self->_SWITCH_refkind($v, {
1573 if ($self->{array_datatypes}) { # array datatype
1574 push @all_bind, $self->_bindtype($k, $v);
1576 else { # literal SQL with bind
1577 my ($sql, @bind) = @$v;
1578 $self->_assert_bindval_matches_bindtype(@bind);
1579 push @all_bind, @bind;
1582 ARRAYREFREF => sub { # literal SQL with bind
1583 my ($sql, @bind) = @${$v};
1584 $self->_assert_bindval_matches_bindtype(@bind);
1585 push @all_bind, @bind;
1587 SCALARREF => sub { # literal SQL without bind
1589 SCALAR_or_UNDEF => sub {
1590 push @all_bind, $self->_bindtype($k, $v);
1601 my(@sql, @sqlq, @sqlv);
1605 if ($ref eq 'HASH') {
1606 for my $k (sort keys %$_) {
1609 my $label = $self->_quote($k);
1610 if ($r eq 'ARRAY') {
1611 # literal SQL with bind
1612 my ($sql, @bind) = @$v;
1613 $self->_assert_bindval_matches_bindtype(@bind);
1614 push @sqlq, "$label = $sql";
1616 } elsif ($r eq 'SCALAR') {
1617 # literal SQL without bind
1618 push @sqlq, "$label = $$v";
1620 push @sqlq, "$label = ?";
1621 push @sqlv, $self->_bindtype($k, $v);
1624 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1625 } elsif ($ref eq 'ARRAY') {
1626 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1629 if ($r eq 'ARRAY') { # literal SQL with bind
1630 my ($sql, @bind) = @$v;
1631 $self->_assert_bindval_matches_bindtype(@bind);
1634 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1635 # embedded literal SQL
1642 push @sql, '(' . join(', ', @sqlq) . ')';
1643 } elsif ($ref eq 'SCALAR') {
1647 # strings get case twiddled
1648 push @sql, $self->_sqlcase($_);
1652 my $sql = join ' ', @sql;
1654 # this is pretty tricky
1655 # if ask for an array, return ($stmt, @bind)
1656 # otherwise, s/?/shift @sqlv/ to put it inline
1658 return ($sql, @sqlv);
1660 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1661 ref $d ? $d->[1] : $d/e;
1670 # This allows us to check for a local, then _form, attr
1672 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1673 return $self->generate($name, @_);
1684 SQL::Abstract - Generate SQL from Perl data structures
1690 my $sql = SQL::Abstract->new;
1692 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1694 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1696 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1698 my($stmt, @bind) = $sql->delete($table, \%where);
1700 # Then, use these in your DBI statements
1701 my $sth = $dbh->prepare($stmt);
1702 $sth->execute(@bind);
1704 # Just generate the WHERE clause
1705 my($stmt, @bind) = $sql->where(\%where, $order);
1707 # Return values in the same order, for hashed queries
1708 # See PERFORMANCE section for more details
1709 my @bind = $sql->values(\%fieldvals);
1713 This module was inspired by the excellent L<DBIx::Abstract>.
1714 However, in using that module I found that what I really wanted
1715 to do was generate SQL, but still retain complete control over my
1716 statement handles and use the DBI interface. So, I set out to
1717 create an abstract SQL generation module.
1719 While based on the concepts used by L<DBIx::Abstract>, there are
1720 several important differences, especially when it comes to WHERE
1721 clauses. I have modified the concepts used to make the SQL easier
1722 to generate from Perl data structures and, IMO, more intuitive.
1723 The underlying idea is for this module to do what you mean, based
1724 on the data structures you provide it. The big advantage is that
1725 you don't have to modify your code every time your data changes,
1726 as this module figures it out.
1728 To begin with, an SQL INSERT is as easy as just specifying a hash
1729 of C<key=value> pairs:
1732 name => 'Jimbo Bobson',
1733 phone => '123-456-7890',
1734 address => '42 Sister Lane',
1735 city => 'St. Louis',
1736 state => 'Louisiana',
1739 The SQL can then be generated with this:
1741 my($stmt, @bind) = $sql->insert('people', \%data);
1743 Which would give you something like this:
1745 $stmt = "INSERT INTO people
1746 (address, city, name, phone, state)
1747 VALUES (?, ?, ?, ?, ?)";
1748 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1749 '123-456-7890', 'Louisiana');
1751 These are then used directly in your DBI code:
1753 my $sth = $dbh->prepare($stmt);
1754 $sth->execute(@bind);
1756 =head2 Inserting and Updating Arrays
1758 If your database has array types (like for example Postgres),
1759 activate the special option C<< array_datatypes => 1 >>
1760 when creating the C<SQL::Abstract> object.
1761 Then you may use an arrayref to insert and update database array types:
1763 my $sql = SQL::Abstract->new(array_datatypes => 1);
1765 planets => [qw/Mercury Venus Earth Mars/]
1768 my($stmt, @bind) = $sql->insert('solar_system', \%data);
1772 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1774 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1777 =head2 Inserting and Updating SQL
1779 In order to apply SQL functions to elements of your C<%data> you may
1780 specify a reference to an arrayref for the given hash value. For example,
1781 if you need to execute the Oracle C<to_date> function on a value, you can
1782 say something like this:
1786 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
1789 The first value in the array is the actual SQL. Any other values are
1790 optional and would be included in the bind values array. This gives
1793 my($stmt, @bind) = $sql->insert('people', \%data);
1795 $stmt = "INSERT INTO people (name, date_entered)
1796 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1797 @bind = ('Bill', '03/02/2003');
1799 An UPDATE is just as easy, all you change is the name of the function:
1801 my($stmt, @bind) = $sql->update('people', \%data);
1803 Notice that your C<%data> isn't touched; the module will generate
1804 the appropriately quirky SQL for you automatically. Usually you'll
1805 want to specify a WHERE clause for your UPDATE, though, which is
1806 where handling C<%where> hashes comes in handy...
1808 =head2 Complex where statements
1810 This module can generate pretty complicated WHERE statements
1811 easily. For example, simple C<key=value> pairs are taken to mean
1812 equality, and if you want to see if a field is within a set
1813 of values, you can use an arrayref. Let's say we wanted to
1814 SELECT some data based on this criteria:
1817 requestor => 'inna',
1818 worker => ['nwiger', 'rcwe', 'sfz'],
1819 status => { '!=', 'completed' }
1822 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1824 The above would give you something like this:
1826 $stmt = "SELECT * FROM tickets WHERE
1827 ( requestor = ? ) AND ( status != ? )
1828 AND ( worker = ? OR worker = ? OR worker = ? )";
1829 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1831 Which you could then use in DBI code like so:
1833 my $sth = $dbh->prepare($stmt);
1834 $sth->execute(@bind);
1840 The methods are simple. There's one for every major SQL operation,
1841 and a constructor you use first. The arguments are specified in a
1842 similar order for each method (table, then fields, then a where
1843 clause) to try and simplify things.
1845 =head2 new(option => 'value')
1847 The C<new()> function takes a list of options and values, and returns
1848 a new B<SQL::Abstract> object which can then be used to generate SQL
1849 through the methods below. The options accepted are:
1855 If set to 'lower', then SQL will be generated in all lowercase. By
1856 default SQL is generated in "textbook" case meaning something like:
1858 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1860 Any setting other than 'lower' is ignored.
1864 This determines what the default comparison operator is. By default
1865 it is C<=>, meaning that a hash like this:
1867 %where = (name => 'nwiger', email => 'nate@wiger.org');
1869 Will generate SQL like this:
1871 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1873 However, you may want loose comparisons by default, so if you set
1874 C<cmp> to C<like> you would get SQL such as:
1876 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1878 You can also override the comparison on an individual basis - see
1879 the huge section on L</"WHERE CLAUSES"> at the bottom.
1881 =item sqltrue, sqlfalse
1883 Expressions for inserting boolean values within SQL statements.
1884 By default these are C<1=1> and C<1=0>. They are used
1885 by the special operators C<-in> and C<-not_in> for generating
1886 correct SQL even when the argument is an empty array (see below).
1890 This determines the default logical operator for multiple WHERE
1891 statements in arrays or hashes. If absent, the default logic is "or"
1892 for arrays, and "and" for hashes. This means that a WHERE
1896 event_date => {'>=', '2/13/99'},
1897 event_date => {'<=', '4/24/03'},
1900 will generate SQL like this:
1902 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1904 This is probably not what you want given this query, though (look
1905 at the dates). To change the "OR" to an "AND", simply specify:
1907 my $sql = SQL::Abstract->new(logic => 'and');
1909 Which will change the above C<WHERE> to:
1911 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1913 The logic can also be changed locally by inserting
1914 a modifier in front of an arrayref:
1916 @where = (-and => [event_date => {'>=', '2/13/99'},
1917 event_date => {'<=', '4/24/03'} ]);
1919 See the L</"WHERE CLAUSES"> section for explanations.
1923 This will automatically convert comparisons using the specified SQL
1924 function for both column and value. This is mostly used with an argument
1925 of C<upper> or C<lower>, so that the SQL will have the effect of
1926 case-insensitive "searches". For example, this:
1928 $sql = SQL::Abstract->new(convert => 'upper');
1929 %where = (keywords => 'MaKe iT CAse inSeNSItive');
1931 Will turn out the following SQL:
1933 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1935 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1936 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1937 not validate this option; it will just pass through what you specify verbatim).
1941 This is a kludge because many databases suck. For example, you can't
1942 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1943 Instead, you have to use C<bind_param()>:
1945 $sth->bind_param(1, 'reg data');
1946 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1948 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1949 which loses track of which field each slot refers to. Fear not.
1951 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1952 Currently, you can specify either C<normal> (default) or C<columns>. If you
1953 specify C<columns>, you will get an array that looks like this:
1955 my $sql = SQL::Abstract->new(bindtype => 'columns');
1956 my($stmt, @bind) = $sql->insert(...);
1959 [ 'column1', 'value1' ],
1960 [ 'column2', 'value2' ],
1961 [ 'column3', 'value3' ],
1964 You can then iterate through this manually, using DBI's C<bind_param()>.
1966 $sth->prepare($stmt);
1969 my($col, $data) = @$_;
1970 if ($col eq 'details' || $col eq 'comments') {
1971 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1972 } elsif ($col eq 'image') {
1973 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1975 $sth->bind_param($i, $data);
1979 $sth->execute; # execute without @bind now
1981 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1982 Basically, the advantage is still that you don't have to care which fields
1983 are or are not included. You could wrap that above C<for> loop in a simple
1984 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1985 get a layer of abstraction over manual SQL specification.
1987 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
1988 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1989 will expect the bind values in this format.
1993 This is the character that a table or column name will be quoted
1994 with. By default this is an empty string, but you could set it to
1995 the character C<`>, to generate SQL like this:
1997 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1999 Alternatively, you can supply an array ref of two items, the first being the left
2000 hand quote character, and the second the right hand quote character. For
2001 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2002 that generates SQL like this:
2004 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2006 Quoting is useful if you have tables or columns names that are reserved
2007 words in your database's SQL dialect.
2011 This is the character that will be used to escape L</quote_char>s appearing
2012 in an identifier before it has been quoted.
2014 The parameter default in case of a single L</quote_char> character is the quote
2017 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2018 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2019 of the B<opening (left)> L</quote_char> within the identifier are currently left
2020 untouched. The default for opening-closing-style quotes may change in future
2021 versions, thus you are B<strongly encouraged> to specify the escape character
2026 This is the character that separates a table and column name. It is
2027 necessary to specify this when the C<quote_char> option is selected,
2028 so that tables and column names can be individually quoted like this:
2030 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2032 =item injection_guard
2034 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2035 column name specified in a query structure. This is a safety mechanism to avoid
2036 injection attacks when mishandling user input e.g.:
2038 my %condition_as_column_value_pairs = get_values_from_user();
2039 $sqla->select( ... , \%condition_as_column_value_pairs );
2041 If the expression matches an exception is thrown. Note that literal SQL
2042 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2044 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2046 =item array_datatypes
2048 When this option is true, arrayrefs in INSERT or UPDATE are
2049 interpreted as array datatypes and are passed directly
2051 When this option is false, arrayrefs are interpreted
2052 as literal SQL, just like refs to arrayrefs
2053 (but this behavior is for backwards compatibility; when writing
2054 new queries, use the "reference to arrayref" syntax
2060 Takes a reference to a list of "special operators"
2061 to extend the syntax understood by L<SQL::Abstract>.
2062 See section L</"SPECIAL OPERATORS"> for details.
2066 Takes a reference to a list of "unary operators"
2067 to extend the syntax understood by L<SQL::Abstract>.
2068 See section L</"UNARY OPERATORS"> for details.
2074 =head2 insert($table, \@values || \%fieldvals, \%options)
2076 This is the simplest function. You simply give it a table name
2077 and either an arrayref of values or hashref of field/value pairs.
2078 It returns an SQL INSERT statement and a list of bind values.
2079 See the sections on L</"Inserting and Updating Arrays"> and
2080 L</"Inserting and Updating SQL"> for information on how to insert
2081 with those data types.
2083 The optional C<\%options> hash reference may contain additional
2084 options to generate the insert SQL. Currently supported options
2091 Takes either a scalar of raw SQL fields, or an array reference of
2092 field names, and adds on an SQL C<RETURNING> statement at the end.
2093 This allows you to return data generated by the insert statement
2094 (such as row IDs) without performing another C<SELECT> statement.
2095 Note, however, this is not part of the SQL standard and may not
2096 be supported by all database engines.
2100 =head2 update($table, \%fieldvals, \%where, \%options)
2102 This takes a table, hashref of field/value pairs, and an optional
2103 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2105 See the sections on L</"Inserting and Updating Arrays"> and
2106 L</"Inserting and Updating SQL"> for information on how to insert
2107 with those data types.
2109 The optional C<\%options> hash reference may contain additional
2110 options to generate the update SQL. Currently supported options
2117 See the C<returning> option to
2118 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2122 =head2 select($source, $fields, $where, $order)
2124 This returns a SQL SELECT statement and associated list of bind values, as
2125 specified by the arguments:
2131 Specification of the 'FROM' part of the statement.
2132 The argument can be either a plain scalar (interpreted as a table
2133 name, will be quoted), or an arrayref (interpreted as a list
2134 of table names, joined by commas, quoted), or a scalarref
2135 (literal SQL, not quoted).
2139 Specification of the list of fields to retrieve from
2141 The argument can be either an arrayref (interpreted as a list
2142 of field names, will be joined by commas and quoted), or a
2143 plain scalar (literal SQL, not quoted).
2144 Please observe that this API is not as flexible as that of
2145 the first argument C<$source>, for backwards compatibility reasons.
2149 Optional argument to specify the WHERE part of the query.
2150 The argument is most often a hashref, but can also be
2151 an arrayref or plain scalar --
2152 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2156 Optional argument to specify the ORDER BY part of the query.
2157 The argument can be a scalar, a hashref or an arrayref
2158 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2164 =head2 delete($table, \%where, \%options)
2166 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2167 It returns an SQL DELETE statement and list of bind values.
2169 The optional C<\%options> hash reference may contain additional
2170 options to generate the delete SQL. Currently supported options
2177 See the C<returning> option to
2178 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2182 =head2 where(\%where, $order)
2184 This is used to generate just the WHERE clause. For example,
2185 if you have an arbitrary data structure and know what the
2186 rest of your SQL is going to look like, but want an easy way
2187 to produce a WHERE clause, use this. It returns an SQL WHERE
2188 clause and list of bind values.
2191 =head2 values(\%data)
2193 This just returns the values from the hash C<%data>, in the same
2194 order that would be returned from any of the other above queries.
2195 Using this allows you to markedly speed up your queries if you
2196 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2198 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2200 Warning: This is an experimental method and subject to change.
2202 This returns arbitrarily generated SQL. It's a really basic shortcut.
2203 It will return two different things, depending on return context:
2205 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2206 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2208 These would return the following:
2210 # First calling form
2211 $stmt = "CREATE TABLE test (?, ?)";
2212 @bind = (field1, field2);
2214 # Second calling form
2215 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2217 Depending on what you're trying to do, it's up to you to choose the correct
2218 format. In this example, the second form is what you would want.
2222 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2226 ALTER SESSION SET nls_date_format = 'MM/YY'
2228 You get the idea. Strings get their case twiddled, but everything
2229 else remains verbatim.
2231 =head1 EXPORTABLE FUNCTIONS
2233 =head2 is_plain_value
2235 Determines if the supplied argument is a plain value as understood by this
2240 =item * The value is C<undef>
2242 =item * The value is a non-reference
2244 =item * The value is an object with stringification overloading
2246 =item * The value is of the form C<< { -value => $anything } >>
2250 On failure returns C<undef>, on success returns a B<scalar> reference
2251 to the original supplied argument.
2257 The stringification overloading detection is rather advanced: it takes
2258 into consideration not only the presence of a C<""> overload, but if that
2259 fails also checks for enabled
2260 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2261 on either C<0+> or C<bool>.
2263 Unfortunately testing in the field indicates that this
2264 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2265 but only when very large numbers of stringifying objects are involved.
2266 At the time of writing ( Sep 2014 ) there is no clear explanation of
2267 the direct cause, nor is there a manageably small test case that reliably
2268 reproduces the problem.
2270 If you encounter any of the following exceptions in B<random places within
2271 your application stack> - this module may be to blame:
2273 Operation "ne": no method found,
2274 left argument in overloaded package <something>,
2275 right argument in overloaded package <something>
2279 Stub found while resolving method "???" overloading """" in package <something>
2281 If you fall victim to the above - please attempt to reduce the problem
2282 to something that could be sent to the L<SQL::Abstract developers
2283 |DBIx::Class/GETTING HELP/SUPPORT>
2284 (either publicly or privately). As a workaround in the meantime you can
2285 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2286 value, which will most likely eliminate your problem (at the expense of
2287 not being able to properly detect exotic forms of stringification).
2289 This notice and environment variable will be removed in a future version,
2290 as soon as the underlying problem is found and a reliable workaround is
2295 =head2 is_literal_value
2297 Determines if the supplied argument is a literal value as understood by this
2302 =item * C<\$sql_string>
2304 =item * C<\[ $sql_string, @bind_values ]>
2308 On failure returns C<undef>, on success returns an B<array> reference
2309 containing the unpacked version of the supplied literal SQL and bind values.
2311 =head1 WHERE CLAUSES
2315 This module uses a variation on the idea from L<DBIx::Abstract>. It
2316 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2317 module is that things in arrays are OR'ed, and things in hashes
2320 The easiest way to explain is to show lots of examples. After
2321 each C<%where> hash shown, it is assumed you used:
2323 my($stmt, @bind) = $sql->where(\%where);
2325 However, note that the C<%where> hash can be used directly in any
2326 of the other functions as well, as described above.
2328 =head2 Key-value pairs
2330 So, let's get started. To begin, a simple hash:
2334 status => 'completed'
2337 Is converted to SQL C<key = val> statements:
2339 $stmt = "WHERE user = ? AND status = ?";
2340 @bind = ('nwiger', 'completed');
2342 One common thing I end up doing is having a list of values that
2343 a field can be in. To do this, simply specify a list inside of
2348 status => ['assigned', 'in-progress', 'pending'];
2351 This simple code will create the following:
2353 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2354 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2356 A field associated to an empty arrayref will be considered a
2357 logical false and will generate 0=1.
2359 =head2 Tests for NULL values
2361 If the value part is C<undef> then this is converted to SQL <IS NULL>
2370 $stmt = "WHERE user = ? AND status IS NULL";
2373 To test if a column IS NOT NULL:
2377 status => { '!=', undef },
2380 =head2 Specific comparison operators
2382 If you want to specify a different type of operator for your comparison,
2383 you can use a hashref for a given column:
2387 status => { '!=', 'completed' }
2390 Which would generate:
2392 $stmt = "WHERE user = ? AND status != ?";
2393 @bind = ('nwiger', 'completed');
2395 To test against multiple values, just enclose the values in an arrayref:
2397 status => { '=', ['assigned', 'in-progress', 'pending'] };
2399 Which would give you:
2401 "WHERE status = ? OR status = ? OR status = ?"
2404 The hashref can also contain multiple pairs, in which case it is expanded
2405 into an C<AND> of its elements:
2409 status => { '!=', 'completed', -not_like => 'pending%' }
2412 # Or more dynamically, like from a form
2413 $where{user} = 'nwiger';
2414 $where{status}{'!='} = 'completed';
2415 $where{status}{'-not_like'} = 'pending%';
2417 # Both generate this
2418 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2419 @bind = ('nwiger', 'completed', 'pending%');
2422 To get an OR instead, you can combine it with the arrayref idea:
2426 priority => [ { '=', 2 }, { '>', 5 } ]
2429 Which would generate:
2431 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2432 @bind = ('2', '5', 'nwiger');
2434 If you want to include literal SQL (with or without bind values), just use a
2435 scalar reference or reference to an arrayref as the value:
2438 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2439 date_expires => { '<' => \"now()" }
2442 Which would generate:
2444 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2445 @bind = ('11/26/2008');
2448 =head2 Logic and nesting operators
2450 In the example above,
2451 there is a subtle trap if you want to say something like
2452 this (notice the C<AND>):
2454 WHERE priority != ? AND priority != ?
2456 Because, in Perl you I<can't> do this:
2458 priority => { '!=' => 2, '!=' => 1 }
2460 As the second C<!=> key will obliterate the first. The solution
2461 is to use the special C<-modifier> form inside an arrayref:
2463 priority => [ -and => {'!=', 2},
2467 Normally, these would be joined by C<OR>, but the modifier tells it
2468 to use C<AND> instead. (Hint: You can use this in conjunction with the
2469 C<logic> option to C<new()> in order to change the way your queries
2470 work by default.) B<Important:> Note that the C<-modifier> goes
2471 B<INSIDE> the arrayref, as an extra first element. This will
2472 B<NOT> do what you think it might:
2474 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2476 Here is a quick list of equivalencies, since there is some overlap:
2479 status => {'!=', 'completed', 'not like', 'pending%' }
2480 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2483 status => {'=', ['assigned', 'in-progress']}
2484 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2485 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2489 =head2 Special operators: IN, BETWEEN, etc.
2491 You can also use the hashref format to compare a list of fields using the
2492 C<IN> comparison operator, by specifying the list as an arrayref:
2495 status => 'completed',
2496 reportid => { -in => [567, 2335, 2] }
2499 Which would generate:
2501 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2502 @bind = ('completed', '567', '2335', '2');
2504 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2507 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2508 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2509 'sqltrue' (by default: C<1=1>).
2511 In addition to the array you can supply a chunk of literal sql or
2512 literal sql with bind:
2515 customer => { -in => \[
2516 'SELECT cust_id FROM cust WHERE balance > ?',
2519 status => { -in => \'SELECT status_codes FROM states' },
2525 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2526 AND status IN ( SELECT status_codes FROM states )
2530 Finally, if the argument to C<-in> is not a reference, it will be
2531 treated as a single-element array.
2533 Another pair of operators is C<-between> and C<-not_between>,
2534 used with an arrayref of two values:
2538 completion_date => {
2539 -not_between => ['2002-10-01', '2003-02-06']
2545 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2547 Just like with C<-in> all plausible combinations of literal SQL
2551 start0 => { -between => [ 1, 2 ] },
2552 start1 => { -between => \["? AND ?", 1, 2] },
2553 start2 => { -between => \"lower(x) AND upper(y)" },
2554 start3 => { -between => [
2556 \["upper(?)", 'stuff' ],
2563 ( start0 BETWEEN ? AND ? )
2564 AND ( start1 BETWEEN ? AND ? )
2565 AND ( start2 BETWEEN lower(x) AND upper(y) )
2566 AND ( start3 BETWEEN lower(x) AND upper(?) )
2568 @bind = (1, 2, 1, 2, 'stuff');
2571 These are the two builtin "special operators"; but the
2572 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2574 =head2 Unary operators: bool
2576 If you wish to test against boolean columns or functions within your
2577 database you can use the C<-bool> and C<-not_bool> operators. For
2578 example to test the column C<is_user> being true and the column
2579 C<is_enabled> being false you would use:-
2583 -not_bool => 'is_enabled',
2588 WHERE is_user AND NOT is_enabled
2590 If a more complex combination is required, testing more conditions,
2591 then you should use the and/or operators:-
2596 -not_bool => { two=> { -rlike => 'bar' } },
2597 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2608 (NOT ( three = ? OR three > ? ))
2611 =head2 Nested conditions, -and/-or prefixes
2613 So far, we've seen how multiple conditions are joined with a top-level
2614 C<AND>. We can change this by putting the different conditions we want in
2615 hashes and then putting those hashes in an array. For example:
2620 status => { -like => ['pending%', 'dispatched'] },
2624 status => 'unassigned',
2628 This data structure would create the following:
2630 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2631 OR ( user = ? AND status = ? ) )";
2632 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2635 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2636 to change the logic inside:
2642 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2643 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2650 $stmt = "WHERE ( user = ?
2651 AND ( ( workhrs > ? AND geo = ? )
2652 OR ( workhrs < ? OR geo = ? ) ) )";
2653 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2655 =head3 Algebraic inconsistency, for historical reasons
2657 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2658 operator goes C<outside> of the nested structure; whereas when connecting
2659 several constraints on one column, the C<-and> operator goes
2660 C<inside> the arrayref. Here is an example combining both features:
2663 -and => [a => 1, b => 2],
2664 -or => [c => 3, d => 4],
2665 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2670 WHERE ( ( ( a = ? AND b = ? )
2671 OR ( c = ? OR d = ? )
2672 OR ( e LIKE ? AND e LIKE ? ) ) )
2674 This difference in syntax is unfortunate but must be preserved for
2675 historical reasons. So be careful: the two examples below would
2676 seem algebraically equivalent, but they are not
2679 { -like => 'foo%' },
2680 { -like => '%bar' },
2682 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2685 { col => { -like => 'foo%' } },
2686 { col => { -like => '%bar' } },
2688 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2691 =head2 Literal SQL and value type operators
2693 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2694 side" is a column name and the "right side" is a value (normally rendered as
2695 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2696 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2697 alter this behavior. There are several ways of doing so.
2701 This is a virtual operator that signals the string to its right side is an
2702 identifier (a column name) and not a value. For example to compare two
2703 columns you would write:
2706 priority => { '<', 2 },
2707 requestor => { -ident => 'submitter' },
2712 $stmt = "WHERE priority < ? AND requestor = submitter";
2715 If you are maintaining legacy code you may see a different construct as
2716 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
2721 This is a virtual operator that signals that the construct to its right side
2722 is a value to be passed to DBI. This is for example necessary when you want
2723 to write a where clause against an array (for RDBMS that support such
2724 datatypes). For example:
2727 array => { -value => [1, 2, 3] }
2732 $stmt = 'WHERE array = ?';
2733 @bind = ([1, 2, 3]);
2735 Note that if you were to simply say:
2741 the result would probably not be what you wanted:
2743 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
2748 Finally, sometimes only literal SQL will do. To include a random snippet
2749 of SQL verbatim, you specify it as a scalar reference. Consider this only
2750 as a last resort. Usually there is a better way. For example:
2753 priority => { '<', 2 },
2754 requestor => { -in => \'(SELECT name FROM hitmen)' },
2759 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
2762 Note that in this example, you only get one bind parameter back, since
2763 the verbatim SQL is passed as part of the statement.
2767 Never use untrusted input as a literal SQL argument - this is a massive
2768 security risk (there is no way to check literal snippets for SQL
2769 injections and other nastyness). If you need to deal with untrusted input
2770 use literal SQL with placeholders as described next.
2772 =head3 Literal SQL with placeholders and bind values (subqueries)
2774 If the literal SQL to be inserted has placeholders and bind values,
2775 use a reference to an arrayref (yes this is a double reference --
2776 not so common, but perfectly legal Perl). For example, to find a date
2777 in Postgres you can use something like this:
2780 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
2785 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2788 Note that you must pass the bind values in the same format as they are returned
2789 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
2790 to C<columns>, you must provide the bind values in the
2791 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
2792 scalar value; most commonly the column name, but you can use any scalar value
2793 (including references and blessed references), L<SQL::Abstract> will simply
2794 pass it through intact. So if C<bindtype> is set to C<columns> the above
2795 example will look like:
2798 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
2801 Literal SQL is especially useful for nesting parenthesized clauses in the
2802 main SQL query. Here is a first example:
2804 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2808 bar => \["IN ($sub_stmt)" => @sub_bind],
2813 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2814 WHERE c2 < ? AND c3 LIKE ?))";
2815 @bind = (1234, 100, "foo%");
2817 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2818 are expressed in the same way. Of course the C<$sub_stmt> and
2819 its associated bind values can be generated through a former call
2822 my ($sub_stmt, @sub_bind)
2823 = $sql->select("t1", "c1", {c2 => {"<" => 100},
2824 c3 => {-like => "foo%"}});
2827 bar => \["> ALL ($sub_stmt)" => @sub_bind],
2830 In the examples above, the subquery was used as an operator on a column;
2831 but the same principle also applies for a clause within the main C<%where>
2832 hash, like an EXISTS subquery:
2834 my ($sub_stmt, @sub_bind)
2835 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2836 my %where = ( -and => [
2838 \["EXISTS ($sub_stmt)" => @sub_bind],
2843 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2844 WHERE c1 = ? AND c2 > t0.c0))";
2848 Observe that the condition on C<c2> in the subquery refers to
2849 column C<t0.c0> of the main query: this is I<not> a bind
2850 value, so we have to express it through a scalar ref.
2851 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2852 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2853 what we wanted here.
2855 Finally, here is an example where a subquery is used
2856 for expressing unary negation:
2858 my ($sub_stmt, @sub_bind)
2859 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2860 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2862 lname => {like => '%son%'},
2863 \["NOT ($sub_stmt)" => @sub_bind],
2868 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2869 @bind = ('%son%', 10, 20)
2871 =head3 Deprecated usage of Literal SQL
2873 Below are some examples of archaic use of literal SQL. It is shown only as
2874 reference for those who deal with legacy code. Each example has a much
2875 better, cleaner and safer alternative that users should opt for in new code.
2881 my %where = ( requestor => \'IS NOT NULL' )
2883 $stmt = "WHERE requestor IS NOT NULL"
2885 This used to be the way of generating NULL comparisons, before the handling
2886 of C<undef> got formalized. For new code please use the superior syntax as
2887 described in L</Tests for NULL values>.
2891 my %where = ( requestor => \'= submitter' )
2893 $stmt = "WHERE requestor = submitter"
2895 This used to be the only way to compare columns. Use the superior L</-ident>
2896 method for all new code. For example an identifier declared in such a way
2897 will be properly quoted if L</quote_char> is properly set, while the legacy
2898 form will remain as supplied.
2902 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
2904 $stmt = "WHERE completed > ? AND is_ready"
2905 @bind = ('2012-12-21')
2907 Using an empty string literal used to be the only way to express a boolean.
2908 For all new code please use the much more readable
2909 L<-bool|/Unary operators: bool> operator.
2915 These pages could go on for a while, since the nesting of the data
2916 structures this module can handle are pretty much unlimited (the
2917 module implements the C<WHERE> expansion as a recursive function
2918 internally). Your best bet is to "play around" with the module a
2919 little to see how the data structures behave, and choose the best
2920 format for your data based on that.
2922 And of course, all the values above will probably be replaced with
2923 variables gotten from forms or the command line. After all, if you
2924 knew everything ahead of time, you wouldn't have to worry about
2925 dynamically-generating SQL and could just hardwire it into your
2928 =head1 ORDER BY CLAUSES
2930 Some functions take an order by clause. This can either be a scalar (just a
2931 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
2932 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
2935 Given | Will Generate
2936 ---------------------------------------------------------------
2938 'colA' | ORDER BY colA
2940 [qw/colA colB/] | ORDER BY colA, colB
2942 {-asc => 'colA'} | ORDER BY colA ASC
2944 {-desc => 'colB'} | ORDER BY colB DESC
2946 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
2948 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
2950 \'colA DESC' | ORDER BY colA DESC
2952 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
2953 | /* ...with $x bound to ? */
2956 { -asc => 'colA' }, | colA ASC,
2957 { -desc => [qw/colB/] }, | colB DESC,
2958 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
2959 \'colE DESC', | colE DESC,
2960 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
2961 ] | /* ...with $x bound to ? */
2962 ===============================================================
2966 =head1 SPECIAL OPERATORS
2968 my $sqlmaker = SQL::Abstract->new(special_ops => [
2972 my ($self, $field, $op, $arg) = @_;
2978 handler => 'method_name',
2982 A "special operator" is a SQL syntactic clause that can be
2983 applied to a field, instead of a usual binary operator.
2986 WHERE field IN (?, ?, ?)
2987 WHERE field BETWEEN ? AND ?
2988 WHERE MATCH(field) AGAINST (?, ?)
2990 Special operators IN and BETWEEN are fairly standard and therefore
2991 are builtin within C<SQL::Abstract> (as the overridable methods
2992 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2993 like the MATCH .. AGAINST example above which is specific to MySQL,
2994 you can write your own operator handlers - supply a C<special_ops>
2995 argument to the C<new> method. That argument takes an arrayref of
2996 operator definitions; each operator definition is a hashref with two
3003 the regular expression to match the operator
3007 Either a coderef or a plain scalar method name. In both cases
3008 the expected return is C<< ($sql, @bind) >>.
3010 When supplied with a method name, it is simply called on the
3011 L<SQL::Abstract> object as:
3013 $self->$method_name($field, $op, $arg)
3017 $field is the LHS of the operator
3018 $op is the part that matched the handler regex
3021 When supplied with a coderef, it is called as:
3023 $coderef->($self, $field, $op, $arg)
3028 For example, here is an implementation
3029 of the MATCH .. AGAINST syntax for MySQL
3031 my $sqlmaker = SQL::Abstract->new(special_ops => [
3033 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3034 {regex => qr/^match$/i,
3036 my ($self, $field, $op, $arg) = @_;
3037 $arg = [$arg] if not ref $arg;
3038 my $label = $self->_quote($field);
3039 my ($placeholder) = $self->_convert('?');
3040 my $placeholders = join ", ", (($placeholder) x @$arg);
3041 my $sql = $self->_sqlcase('match') . " ($label) "
3042 . $self->_sqlcase('against') . " ($placeholders) ";
3043 my @bind = $self->_bindtype($field, @$arg);
3044 return ($sql, @bind);
3051 =head1 UNARY OPERATORS
3053 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3057 my ($self, $op, $arg) = @_;
3063 handler => 'method_name',
3067 A "unary operator" is a SQL syntactic clause that can be
3068 applied to a field - the operator goes before the field
3070 You can write your own operator handlers - supply a C<unary_ops>
3071 argument to the C<new> method. That argument takes an arrayref of
3072 operator definitions; each operator definition is a hashref with two
3079 the regular expression to match the operator
3083 Either a coderef or a plain scalar method name. In both cases
3084 the expected return is C<< $sql >>.
3086 When supplied with a method name, it is simply called on the
3087 L<SQL::Abstract> object as:
3089 $self->$method_name($op, $arg)
3093 $op is the part that matched the handler regex
3094 $arg is the RHS or argument of the operator
3096 When supplied with a coderef, it is called as:
3098 $coderef->($self, $op, $arg)
3106 Thanks to some benchmarking by Mark Stosberg, it turns out that
3107 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3108 I must admit this wasn't an intentional design issue, but it's a
3109 byproduct of the fact that you get to control your C<DBI> handles
3112 To maximize performance, use a code snippet like the following:
3114 # prepare a statement handle using the first row
3115 # and then reuse it for the rest of the rows
3117 for my $href (@array_of_hashrefs) {
3118 $stmt ||= $sql->insert('table', $href);
3119 $sth ||= $dbh->prepare($stmt);
3120 $sth->execute($sql->values($href));
3123 The reason this works is because the keys in your C<$href> are sorted
3124 internally by B<SQL::Abstract>. Thus, as long as your data retains
3125 the same structure, you only have to generate the SQL the first time
3126 around. On subsequent queries, simply use the C<values> function provided
3127 by this module to return your values in the correct order.
3129 However this depends on the values having the same type - if, for
3130 example, the values of a where clause may either have values
3131 (resulting in sql of the form C<column = ?> with a single bind
3132 value), or alternatively the values might be C<undef> (resulting in
3133 sql of the form C<column IS NULL> with no bind value) then the
3134 caching technique suggested will not work.
3138 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3139 really like this part (I do, at least). Building up a complex query
3140 can be as simple as the following:
3147 use CGI::FormBuilder;
3150 my $form = CGI::FormBuilder->new(...);
3151 my $sql = SQL::Abstract->new;
3153 if ($form->submitted) {
3154 my $field = $form->field;
3155 my $id = delete $field->{id};
3156 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3159 Of course, you would still have to connect using C<DBI> to run the
3160 query, but the point is that if you make your form look like your
3161 table, the actual query script can be extremely simplistic.
3163 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3164 a fast interface to returning and formatting data. I frequently
3165 use these three modules together to write complex database query
3166 apps in under 50 lines.
3168 =head1 HOW TO CONTRIBUTE
3170 Contributions are always welcome, in all usable forms (we especially
3171 welcome documentation improvements). The delivery methods include git-
3172 or unified-diff formatted patches, GitHub pull requests, or plain bug
3173 reports either via RT or the Mailing list. Contributors are generally
3174 granted full access to the official repository after their first several
3175 patches pass successful review.
3177 This project is maintained in a git repository. The code and related tools are
3178 accessible at the following locations:
3182 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3184 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3186 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3188 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3194 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3195 Great care has been taken to preserve the I<published> behavior
3196 documented in previous versions in the 1.* family; however,
3197 some features that were previously undocumented, or behaved
3198 differently from the documentation, had to be changed in order
3199 to clarify the semantics. Hence, client code that was relying
3200 on some dark areas of C<SQL::Abstract> v1.*
3201 B<might behave differently> in v1.50.
3203 The main changes are:
3209 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3213 support for the { operator => \"..." } construct (to embed literal SQL)
3217 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3221 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3225 defensive programming: check arguments
3229 fixed bug with global logic, which was previously implemented
3230 through global variables yielding side-effects. Prior versions would
3231 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3232 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3233 Now this is interpreted
3234 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3239 fixed semantics of _bindtype on array args
3243 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3244 we just avoid shifting arrays within that tree.
3248 dropped the C<_modlogic> function
3252 =head1 ACKNOWLEDGEMENTS
3254 There are a number of individuals that have really helped out with
3255 this module. Unfortunately, most of them submitted bugs via CPAN
3256 so I have no idea who they are! But the people I do know are:
3258 Ash Berlin (order_by hash term support)
3259 Matt Trout (DBIx::Class support)
3260 Mark Stosberg (benchmarking)
3261 Chas Owens (initial "IN" operator support)
3262 Philip Collins (per-field SQL functions)
3263 Eric Kolve (hashref "AND" support)
3264 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3265 Dan Kubb (support for "quote_char" and "name_sep")
3266 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3267 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3268 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3269 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3270 Oliver Charles (support for "RETURNING" after "INSERT")
3276 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3280 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3282 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3284 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3285 While not an official support venue, C<DBIx::Class> makes heavy use of
3286 C<SQL::Abstract>, and as such list members there are very familiar with
3287 how to create queries.
3291 This module is free software; you may copy this under the same
3292 terms as perl itself (either the GNU General Public License or
3293 the Artistic License)