1 package SQL::Abstract; # see doc at end of file
5 use Module::Runtime ();
10 use Exporter 'import';
11 our @EXPORT_OK = qw(is_plain_value is_literal_value);
21 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
27 #======================================================================
29 #======================================================================
31 our $VERSION = '1.87';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
147 bind => '_expand_noop',
148 literal => '_expand_noop',
151 'between' => '_expand_between',
152 'not_between' => '_expand_between',
153 'in' => '_expand_in',
154 'not_in' => '_expand_in',
155 'nest' => '_expand_nest',
156 (map +($_ => '_expand_op_andor'), ('and', 'or')),
157 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
158 'ident' => '_expand_ident',
159 'value' => '_expand_value',
162 (map +($_, "_render_$_"), qw(op func bind ident literal row values)),
165 (map +($_ => '_render_op_between'), 'between', 'not_between'),
166 (map +($_ => '_render_op_in'), 'in', 'not_in'),
167 (map +($_ => '_render_unop_postfix'),
168 'is_null', 'is_not_null', 'asc', 'desc',
170 (not => '_render_unop_paren'),
171 (map +($_ => '_render_op_andor'), qw(and or)),
172 ',' => '_render_op_multop',
175 delete => [ qw(target where returning) ],
176 update => [ qw(target set where returning) ],
177 insert => [ qw(target fields from returning) ],
178 select => [ qw(select from where order_by) ],
181 'delete.from' => '_expand_delete_clause_target',
182 'update.update' => '_expand_update_clause_target',
183 'insert.into' => '_expand_insert_clause_target',
184 'insert.values' => '_expand_insert_clause_from',
187 'delete.target' => '_render_delete_clause_target',
188 'update.target' => '_render_update_clause_target',
189 'insert.target' => '_render_insert_clause_target',
190 'insert.fields' => '_render_insert_clause_fields',
191 'insert.from' => '_render_insert_clause_from',
195 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
196 $Defaults{expand}{$stmt} = '_expand_statement';
197 $Defaults{render}{$stmt} = '_render_statement';
198 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
199 $Defaults{expand_clause}{"${stmt}.${clause}"}
200 = "_expand_${stmt}_clause_${clause}";
206 my $class = ref($self) || $self;
207 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
209 # choose our case by keeping an option around
210 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
212 # default logic for interpreting arrayrefs
213 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
215 # how to return bind vars
216 $opt{bindtype} ||= 'normal';
218 # default comparison is "=", but can be overridden
221 # try to recognize which are the 'equality' and 'inequality' ops
222 # (temporary quickfix (in 2007), should go through a more seasoned API)
223 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
224 $opt{inequality_op} = qr/^( != | <> )$/ix;
226 $opt{like_op} = qr/^ (is_)?r?like $/xi;
227 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
230 $opt{sqltrue} ||= '1=1';
231 $opt{sqlfalse} ||= '0=1';
234 $opt{special_ops} ||= [];
237 $opt{unary_ops} ||= [];
239 # rudimentary sanity-check for user supplied bits treated as functions/operators
240 # If a purported function matches this regular expression, an exception is thrown.
241 # Literal SQL is *NOT* subject to this check, only functions (and column names
242 # when quoting is not in effect)
245 # need to guard against ()'s in column names too, but this will break tons of
246 # hacks... ideas anyone?
247 $opt{injection_guard} ||= qr/
253 $opt{expand_unary} = {};
255 foreach my $name (sort keys %Defaults) {
256 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
259 if ($class ne __PACKAGE__) {
261 # check for overriden methods
263 foreach my $type (qw(insert update delete)) {
264 my $method = "_${type}_returning";
265 if (__PACKAGE__->can($method) ne $class->can($method)) {
266 my $clause = "${type}.returning";
267 $opt{expand_clause}{$clause} = sub { $_[2] },
268 $opt{render_clause}{$clause}
269 = sub { [ $_[0]->$method($_[3]) ] };
272 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
273 $opt{expand_clause}{'select.from'} = sub {
274 return +{ -literal => [ $_[0]->_table($_[2]) ] };
277 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
278 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
279 $opt{render_clause}{'select.order_by'} = sub {
280 [ $_[0]->_order_by($_[2]) ];
283 if ($class->isa('DBIx::Class::SQLMaker')) {
284 $opt{warn_once_on_nest} = 1;
285 $opt{disable_old_special_ops} = 1;
286 $opt{render_clause}{'select.where'} = sub {
287 my ($sql, @bind) = $_[0]->where($_[2]);
288 s/\A\s+//, s/\s+\Z// for $sql;
289 return [ $sql, @bind ];
294 if ($opt{lazy_join_sql_parts}) {
295 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
296 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
299 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
301 return bless \%opt, $class;
305 my ($self, $name, $key, $value) = @_;
306 return $self->{$name}{$key} unless @_ > 3;
307 $self->{$name}{$key} = $value;
312 foreach my $type (qw(
313 expand op_expand render op_render clause_expand clause_render
315 my $name = join '_', reverse split '_', $type;
316 my $singular = "${type}er";
317 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
318 or die "Method builder failed for ${singular}: $@";
319 eval qq{sub wrap_${singular} {
320 my (\$self, \$key, \$builder) = \@_;
321 my \$orig = \$self->_ext_rw('${name}', \$key);
324 \$builder->(\$orig, '${name}', \$key)
326 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
327 eval qq{sub ${singular}s {
328 my (\$self, \@args) = \@_;
329 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
330 \$self->_ext_rw('${name}', \$this_key, \$this_value);
333 }; 1 } or die "Method builder failed for ${singular}s: $@";
334 eval qq{sub wrap_${singular}s {
335 my (\$self, \@args) = \@_;
336 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
337 my \$orig = \$self->_ext_rw('${name}', \$this_key);
339 '${name}', \$this_key,
340 \$this_builder->(\$orig, '${name}', \$this_key),
344 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
345 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
346 or die "Method builder failed for ${singular}_list: $@";
350 sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
352 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
355 my ($self, $of, @clauses) = @_;
357 return @{$self->{clauses_of}{$of}||[]};
359 if (ref($clauses[0]) eq 'CODE') {
360 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
362 $self->{clauses_of}{$of} = \@clauses;
371 ref($self->{$_}) eq 'HASH'
380 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
381 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
383 sub _assert_pass_injection_guard {
384 if ($_[1] =~ $_[0]->{injection_guard}) {
385 my $class = ref $_[0];
386 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
387 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
388 . "{injection_guard} attribute to ${class}->new()"
393 #======================================================================
395 #======================================================================
398 my ($self, $table, $data, $options) = @_;
401 if (ref($table) eq 'HASH') {
404 my %clauses = (target => $table, values => $data, %{$options||{}});
408 my @rendered = $self->render_statement({ -insert => $stmt });
409 return wantarray ? @rendered : $rendered[0];
412 sub _expand_insert_clause_target {
413 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
416 sub _expand_insert_clause_fields {
418 $_[0]->expand_maybe_list_expr($_[2], -ident)
419 ] } if ref($_[2]) eq 'ARRAY';
420 return $_[2]; # should maybe still expand somewhat?
423 sub _expand_insert_clause_from {
424 my ($self, undef, $data) = @_;
425 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
426 return $self->expand_expr($data);
428 return $data if ref($data) eq 'HASH' and $data->{-row};
429 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
431 from => { -values => [ $v_aqt ] },
432 ($f_aqt ? (fields => $f_aqt) : ()),
436 sub _expand_insert_clause_returning {
437 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
440 sub _expand_insert_values {
441 my ($self, $data) = @_;
442 if (is_literal_value($data)) {
443 (undef, $self->expand_expr($data));
445 my ($fields, $values) = (
446 ref($data) eq 'HASH' ?
447 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
451 # no names (arrayref) means can't generate bindtype
452 !($fields) && $self->{bindtype} eq 'columns'
453 && belch "can't do 'columns' bindtype when called with arrayref";
457 ? $self->expand_expr({ -row => $fields }, -ident)
462 local our $Cur_Col_Meta = $fields->[$_];
463 $self->_expand_insert_value($values->[$_])
470 sub _render_insert_clause_fields {
471 return $_[0]->render_aqt($_[2]);
474 sub _render_insert_clause_target {
475 my ($self, undef, $from) = @_;
476 $self->join_query_parts(' ', $self->format_keyword('insert into'), $from);
479 sub _render_insert_clause_from {
480 return $_[0]->render_aqt($_[2], 1);
483 # So that subclasses can override INSERT ... RETURNING separately from
484 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
485 sub _insert_returning { shift->_returning(@_) }
487 sub _redispatch_returning {
488 my ($self, $type, undef, $returning) = @_;
489 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
493 my ($self, $options) = @_;
495 my $f = $options->{returning};
497 my ($sql, @bind) = @{ $self->render_aqt(
498 $self->expand_maybe_list_expr($f, -ident)
500 return ($self->_sqlcase(' returning ').$sql, @bind);
503 sub _expand_insert_value {
506 my $k = our $Cur_Col_Meta;
508 if (ref($v) eq 'ARRAY') {
509 if ($self->{array_datatypes}) {
510 return +{ -bind => [ $k, $v ] };
512 my ($sql, @bind) = @$v;
513 $self->_assert_bindval_matches_bindtype(@bind);
514 return +{ -literal => $v };
516 if (ref($v) eq 'HASH') {
517 if (grep !/^-/, keys %$v) {
518 belch "HASH ref as bind value in insert is not supported";
519 return +{ -bind => [ $k, $v ] };
523 return +{ -bind => [ $k, undef ] };
525 return $self->expand_expr($v);
530 #======================================================================
532 #======================================================================
535 my ($self, $table, $set, $where, $options) = @_;
538 if (ref($table) eq 'HASH') {
542 @clauses{qw(target set where)} = ($table, $set, $where);
543 puke "Unsupported data type specified to \$sql->update"
544 unless ref($clauses{set}) eq 'HASH';
545 @clauses{keys %$options} = values %$options;
549 my @rendered = $self->render_statement({ -update => $stmt });
550 return wantarray ? @rendered : $rendered[0];
553 sub _render_update_clause_target {
554 my ($self, undef, $target) = @_;
555 $self->join_query_parts(' ', $self->format_keyword('update'), $target);
558 sub _update_set_values {
559 my ($self, $data) = @_;
561 return @{ $self->render_aqt(
562 $self->_expand_update_set_values(undef, $data),
566 sub _expand_update_set_values {
567 my ($self, undef, $data) = @_;
568 $self->expand_maybe_list_expr( [
571 $set = { -bind => $_ } unless defined $set;
572 +{ -op => [ '=', { -ident => $k }, $set ] };
578 ? ($self->{array_datatypes}
579 ? [ $k, +{ -bind => [ $k, $v ] } ]
580 : [ $k, +{ -literal => $v } ])
582 local our $Cur_Col_Meta = $k;
583 [ $k, $self->_expand_expr($v) ]
590 sub _expand_update_clause_target {
591 my ($self, undef, $target) = @_;
592 +(target => $self->expand_maybe_list_expr($target, -ident));
595 sub _expand_update_clause_set {
596 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
597 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
600 sub _expand_update_clause_where {
601 +(where => $_[0]->expand_expr($_[2]));
604 sub _expand_update_clause_returning {
605 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
608 # So that subclasses can override UPDATE ... RETURNING separately from
610 sub _update_returning { shift->_returning(@_) }
614 #======================================================================
616 #======================================================================
619 my ($self, @args) = @_;
621 if (ref(my $sel = $args[0]) eq 'HASH') {
625 @clauses{qw(from select where order_by)} = @args;
627 # This oddity is to literalify since historically SQLA doesn't quote
628 # a single identifier argument, so we convert it into a literal
630 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
631 unless ref($clauses{select});
636 my @rendered = $self->render_statement({ -select => $stmt });
637 return wantarray ? @rendered : $rendered[0];
640 sub _expand_select_clause_select {
641 my ($self, undef, $select) = @_;
642 +(select => $self->expand_maybe_list_expr($select, -ident));
645 sub _expand_select_clause_from {
646 my ($self, undef, $from) = @_;
647 +(from => $self->expand_maybe_list_expr($from, -ident));
650 sub _expand_select_clause_where {
651 my ($self, undef, $where) = @_;
654 if (my $conv = $self->{convert}) {
666 ->wrap_expander(bind => $_wrap)
667 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
668 ->wrap_expander(func => sub {
671 my ($self, $type, $thing) = @_;
672 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
673 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
676 or $thing->[1]{-value}
677 or $thing->[1]{-bind})
679 return { -func => $thing }; # already went through our expander
681 return $self->$orig($type, $thing);
689 return +(where => $sqla->expand_expr($where));
692 sub _expand_select_clause_order_by {
693 my ($self, undef, $order_by) = @_;
694 +(order_by => $self->_expand_order_by($order_by));
698 my ($self, $fields) = @_;
699 return $fields unless ref($fields);
700 return @{ $self->render_aqt(
701 $self->expand_maybe_list_expr($fields, '-ident')
705 #======================================================================
707 #======================================================================
710 my ($self, $table, $where, $options) = @_;
713 if (ref($table) eq 'HASH') {
716 my %clauses = (target => $table, where => $where, %{$options||{}});
720 my @rendered = $self->render_statement({ -delete => $stmt });
721 return wantarray ? @rendered : $rendered[0];
724 # So that subclasses can override DELETE ... RETURNING separately from
726 sub _delete_returning { shift->_returning(@_) }
728 sub _expand_delete_clause_target {
729 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
732 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
734 sub _expand_delete_clause_returning {
735 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
738 sub _render_delete_clause_target {
739 my ($self, undef, $from) = @_;
740 $self->join_query_parts(' ', $self->format_keyword('delete from'), $from);
743 #======================================================================
745 #======================================================================
749 # Finally, a separate routine just to handle WHERE clauses
751 my ($self, $where, $order) = @_;
753 local $self->{convert_where} = $self->{convert};
756 my ($sql, @bind) = defined($where)
757 ? $self->_recurse_where($where)
759 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
763 my ($order_sql, @order_bind) = $self->_order_by($order);
765 push @bind, @order_bind;
768 return wantarray ? ($sql, @bind) : $sql;
771 { our $Default_Scalar_To = -value }
774 my ($self, $expr, $default_scalar_to) = @_;
775 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
776 $self->_expand_expr($expr);
780 my ($self, $aqt, $top_level) = @_;
781 my ($k, $v, @rest) = %$aqt;
783 die "Not a node type: $k" unless $k =~ s/^-//;
784 if (my $meth = $self->{render}{$k}) {
785 local our $Render_Top_Level = $top_level;
786 return $self->$meth($k, $v);
788 die "notreached: $k";
792 my ($self, $expr, $default_scalar_to) = @_;
793 return @{ $self->render_aqt(
794 $self->expand_expr($expr, $default_scalar_to)
798 sub render_statement {
799 my ($self, $expr, $default_scalar_to) = @_;
801 $self->expand_expr($expr, $default_scalar_to), 1
805 sub _expand_statement {
806 my ($self, $type, $args) = @_;
807 my $ec = $self->{expand_clause};
810 $args->{$type} = delete $args->{_}
812 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
813 return +{ "-${type}" => +{
815 my $val = $args->{$_};
816 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
817 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
822 } elsif ($has_clause{$_}) {
823 ($_ => $self->expand_expr($val))
831 sub _render_statement {
832 my ($self, $type, $args) = @_;
834 foreach my $clause (@{$self->{clauses_of}{$type}}) {
835 next unless my $clause_expr = $args->{$clause};
837 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
838 $self->$rdr($clause, $clause_expr, $args);
840 my $r = $self->render_aqt($clause_expr, 1);
841 next unless defined $r->[0] and length $r->[0];
842 $self->join_query_parts(' ',
843 $self->format_keyword($clause),
850 my $q = $self->join_query_parts(' ', @parts);
851 return $self->join_query_parts('',
852 (our $Render_Top_Level ? $q : ('(', $q, ')'))
857 my ($self, $raw) = @_;
859 return $op if grep $_->{$op}, @{$self}{qw(is_op expand_op render_op)};
860 s/^-(?=.)//, s/\s+/_/g for $op;
865 my ($self, $expr) = @_;
866 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
867 return undef unless defined($expr);
868 if (ref($expr) eq 'HASH') {
869 return undef unless my $kc = keys %$expr;
871 return $self->_expand_op_andor(and => $expr);
873 my ($key, $value) = %$expr;
874 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
875 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
876 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
878 return $self->_expand_hashpair($key, $value);
880 if (ref($expr) eq 'ARRAY') {
881 return $self->_expand_op_andor(lc($self->{logic}), $expr);
883 if (my $literal = is_literal_value($expr)) {
884 return +{ -literal => $literal };
886 if (!ref($expr) or Scalar::Util::blessed($expr)) {
887 return $self->_expand_scalar($expr);
892 sub _expand_hashpair {
893 my ($self, $k, $v) = @_;
894 unless (defined($k) and length($k)) {
895 if (defined($k) and my $literal = is_literal_value($v)) {
896 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
897 return { -literal => $literal };
899 puke "Supplying an empty left hand side argument is not supported";
902 return $self->_expand_hashpair_op($k, $v);
903 } elsif ($k =~ /^[^\w]/i) {
904 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
905 return $self->_expand_op(
906 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
909 return $self->_expand_hashpair_ident($k, $v);
912 sub _expand_hashpair_ident {
913 my ($self, $k, $v) = @_;
915 local our $Cur_Col_Meta = $k;
917 # hash with multiple or no elements is andor
919 if (ref($v) eq 'HASH' and keys %$v != 1) {
920 return $self->_expand_op_andor(and => $v, $k);
923 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
925 if (is_undef_value($v)) {
926 return $self->_expand_hashpair_cmp($k => undef);
929 # scalars and objects get expanded as whatever requested or values
931 if (!ref($v) or Scalar::Util::blessed($v)) {
932 return $self->_expand_hashpair_scalar($k, $v);
935 # single key hashref is a hashtriple
937 if (ref($v) eq 'HASH') {
938 return $self->_expand_hashtriple($k, %$v);
941 # arrayref needs re-engineering over the elements
943 if (ref($v) eq 'ARRAY') {
944 return $self->sqlfalse unless @$v;
945 $self->_debug("ARRAY($k) means distribute over elements");
947 $v->[0] =~ /^-(and|or)$/i
948 ? (shift(@{$v = [ @$v ]}), $1)
949 : lc($self->{logic} || 'OR')
951 return $self->_expand_op_andor(
956 if (my $literal = is_literal_value($v)) {
958 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
961 my ($sql, @bind) = @$literal;
962 if ($self->{bindtype} eq 'columns') {
964 $self->_assert_bindval_matches_bindtype($_);
967 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
973 my ($self, $expr) = @_;
975 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
978 sub _expand_hashpair_scalar {
979 my ($self, $k, $v) = @_;
981 return $self->_expand_hashpair_cmp(
982 $k, $self->_expand_scalar($v),
986 sub _expand_hashpair_op {
987 my ($self, $k, $v) = @_;
989 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
991 my $op = $self->_normalize_op($k);
995 my $op = join(' ', split '_', $op);
997 # the old special op system requires illegality for top-level use
1000 (our $Expand_Depth) == 1
1002 List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
1004 $self->{disable_old_special_ops}
1005 and List::Util::first { $op =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1009 puke "Illegal use of top-level '-$op'"
1013 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1014 return $self->$exp($op, $v);
1017 # Ops prefixed with -not_ get converted
1019 if (my ($rest) = $op =~/^not_(.*)$/) {
1022 $self->_expand_expr({ "-${rest}", $v })
1028 # the old unary op system means we should touch nothing and let it work
1030 my $op = join(' ', split '_', $op);
1032 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1033 return { -op => [ $op, $v ] };
1038 $self->{unknown_unop_always_func} && !$self->{render_op}{$op}
1048 and (keys %$v)[0] =~ /^-/
1052 (List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}})
1053 or $self->{render_op}{$op}
1061 if ($type eq -func and ref($v) eq 'ARRAY') {
1062 return $self->_expand_expr({ -func => [ $op, @$v ] });
1065 return $self->_expand_expr({ $type => [ $op, $v ] });
1068 sub _expand_hashpair_cmp {
1069 my ($self, $k, $v) = @_;
1070 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1073 sub _expand_hashtriple {
1074 my ($self, $k, $vk, $vv) = @_;
1076 my $ik = $self->_expand_expr({ -ident => $k });
1078 my $op = $self->_normalize_op($vk);
1079 $self->_assert_pass_injection_guard($op);
1081 if ($op =~ s/ _? \d+ $//x ) {
1082 return $self->_expand_expr($k, { $vk, $vv });
1084 if (my $x = $self->{expand_op}{$op}) {
1085 local our $Cur_Col_Meta = $k;
1086 return $self->$x($op, $vv, $k);
1090 my $op = join(' ', split '_', $op);
1092 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1093 return { -op => [ $op, $ik, $vv ] };
1095 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1099 { -op => [ $op, $vv ] }
1103 if (ref($vv) eq 'ARRAY') {
1105 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1106 ? (shift(@raw), lc $1) : 'or';
1107 my @values = map +{ $vk => $_ }, @raw;
1109 $op =~ $self->{inequality_op}
1110 or $op =~ $self->{not_like_op}
1112 if (lc($logic) eq 'or' and @values > 1) {
1113 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1114 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1115 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1120 # try to DWIM on equality operators
1121 return ($self->_dwim_op_to_is($op,
1122 "Supplying an empty arrayref to '%s' is deprecated",
1123 "operator '%s' applied on an empty array (field '$k')"
1124 ) ? $self->sqlfalse : $self->sqltrue);
1126 return $self->_expand_op_andor($logic => \@values, $k);
1128 if (is_undef_value($vv)) {
1129 my $is = ($self->_dwim_op_to_is($op,
1130 "Supplying an undefined argument to '%s' is deprecated",
1131 "unexpected operator '%s' with undef operand",
1132 ) ? 'is' : 'is not');
1134 return $self->_expand_hashpair($k => { $is, undef });
1136 local our $Cur_Col_Meta = $k;
1140 $self->_expand_expr($vv)
1144 sub _dwim_op_to_is {
1145 my ($self, $raw, $empty, $fail) = @_;
1147 my $op = $self->_normalize_op($raw);
1149 if ($op =~ /^not$/i) {
1152 if ($op =~ $self->{equality_op}) {
1155 if ($op =~ $self->{like_op}) {
1156 belch(sprintf $empty, uc(join ' ', split '_', $op));
1159 if ($op =~ $self->{inequality_op}) {
1162 if ($op =~ $self->{not_like_op}) {
1163 belch(sprintf $empty, uc(join ' ', split '_', $op));
1166 puke(sprintf $fail, $op);
1170 my ($self, undef, $args) = @_;
1171 my ($func, @args) = @$args;
1172 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1176 my ($self, undef, $body, $k) = @_;
1177 return $self->_expand_hashpair_cmp(
1178 $k, { -ident => $body }
1180 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1181 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1183 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1184 ref($body) ? @$body : $body;
1185 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1186 unless ($self->{quote_char}) {
1187 $self->_assert_pass_injection_guard($_) for @parts;
1189 return +{ -ident => \@parts };
1193 return $_[0]->_expand_hashpair_cmp(
1194 $_[3], { -value => $_[2] },
1195 ) if defined($_[3]);
1196 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1200 my ($self, undef, $args) = @_;
1201 +{ -row => [ map $self->expand_expr($_), @$args ] };
1205 my ($self, undef, $args) = @_;
1206 my ($op, @opargs) = @$args;
1207 if (my $exp = $self->{expand_op}{$op}) {
1208 return $self->$exp($op, \@opargs);
1210 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1214 my ($self, undef, $v) = @_;
1216 return $self->_expand_expr($v);
1218 puke "-bool => undef not supported" unless defined($v);
1219 return $self->_expand_expr({ -ident => $v });
1222 sub _expand_op_andor {
1223 my ($self, $logop, $v, $k) = @_;
1225 $v = [ map +{ $k, $_ },
1227 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1231 if (ref($v) eq 'HASH') {
1232 return undef unless keys %$v;
1235 map $self->_expand_expr({ $_ => $v->{$_} }),
1239 if (ref($v) eq 'ARRAY') {
1240 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1243 (ref($_) eq 'ARRAY' and @$_)
1244 or (ref($_) eq 'HASH' and %$_)
1250 while (my ($el) = splice @expr, 0, 1) {
1251 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1252 unless defined($el) and length($el);
1253 my $elref = ref($el);
1255 local our $Expand_Depth = 0;
1256 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1257 } elsif ($elref eq 'ARRAY') {
1258 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1259 } elsif (my $l = is_literal_value($el)) {
1260 push @res, { -literal => $l };
1261 } elsif ($elref eq 'HASH') {
1262 local our $Expand_Depth = 0;
1263 push @res, grep defined, $self->_expand_expr($el) if %$el;
1269 # return $res[0] if @res == 1;
1270 return { -op => [ $logop, @res ] };
1276 my ($self, $op, $vv, $k) = @_;
1277 ($k, $vv) = @$vv unless defined $k;
1278 puke "$op can only take undef as argument"
1282 and exists($vv->{-value})
1283 and !defined($vv->{-value})
1285 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1288 sub _expand_between {
1289 my ($self, $op, $vv, $k) = @_;
1290 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1291 my @rhs = map $self->_expand_expr($_),
1292 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1294 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1296 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1298 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1302 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1308 my ($self, $op, $vv, $k) = @_;
1309 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1310 if (my $literal = is_literal_value($vv)) {
1311 my ($sql, @bind) = @$literal;
1312 my $opened_sql = $self->_open_outer_paren($sql);
1314 $op, $self->expand_expr($k, -ident),
1315 { -literal => [ $opened_sql, @bind ] }
1319 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1320 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1321 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1322 . 'will emit the logically correct SQL instead of raising this exception)'
1324 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1326 my @rhs = map $self->expand_expr($_, -value),
1327 map { defined($_) ? $_: puke($undef_err) }
1328 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1329 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1333 $self->expand_expr($k, -ident),
1339 my ($self, undef, $v) = @_;
1340 # DBIx::Class requires a nest warning to be emitted once but the private
1341 # method it overrode to do so no longer exists
1342 if ($self->{warn_once_on_nest}) {
1343 unless (our $Nest_Warned) {
1345 "-nest in search conditions is deprecated, you most probably wanted:\n"
1346 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1351 return $self->_expand_expr($v);
1355 my ($self, $type, $v) = @_;
1356 return { "-${type}" => $v };
1359 sub _expand_values {
1360 my ($self, undef, $values) = @_;
1361 return { -values => [
1364 ? $self->expand_expr($_)
1365 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1366 ), ref($values) eq 'ARRAY' ? @$values : $values
1370 sub _recurse_where {
1371 my ($self, $where, $logic) = @_;
1373 # Special case: top level simple string treated as literal
1375 my $where_exp = (ref($where)
1376 ? $self->_expand_expr($where, $logic)
1377 : { -literal => [ $where ] });
1379 # dispatch expanded expression
1381 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1382 # DBIx::Class used to call _recurse_where in scalar context
1383 # something else might too...
1385 return ($sql, @bind);
1388 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1394 my ($self, undef, $ident) = @_;
1396 return [ $self->_convert($self->_quote($ident)) ];
1400 my ($self, undef, $values) = @_;
1401 return $self->join_query_parts('',
1403 $self->_render_op(undef, [ ',', @$values ]),
1409 my ($self, undef, $rest) = @_;
1410 my ($func, @args) = @$rest;
1411 return $self->join_query_parts('',
1412 $self->_sqlcase($func),
1413 $self->join_query_parts('',
1415 $self->join_query_parts(', ', @args),
1422 my ($self, undef, $bind) = @_;
1423 return [ $self->_convert('?'), $self->_bindtype(@$bind) ];
1426 sub _render_literal {
1427 my ($self, undef, $literal) = @_;
1428 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1433 my ($self, undef, $v) = @_;
1434 my ($op, @args) = @$v;
1435 if (my $r = $self->{render_op}{$op}) {
1436 return $self->$r($op, \@args);
1441 my $op = join(' ', split '_', $op);
1443 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1444 if ($ss and @args > 1) {
1445 puke "Special op '${op}' requires first value to be identifier"
1446 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1447 my $k = join(($self->{name_sep}||'.'), @$ident);
1448 local our $Expand_Depth = 1;
1449 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1451 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1452 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1455 return $self->_render_unop_paren($op, \@args);
1459 return $self->_render_unop_prefix($op, \@args);
1461 return $self->_render_op_multop($op, \@args);
1467 sub _render_op_between {
1468 my ($self, $op, $args) = @_;
1469 my ($left, $low, $high) = @$args;
1472 puke "Single arg to between must be a literal"
1473 unless $low->{-literal};
1476 +($low, $self->format_keyword('and'), $high);
1479 return $self->join_query_parts(' ',
1480 '(', $left, $self->format_keyword($op), @rh, ')',
1485 my ($self, $op, $args) = @_;
1486 my ($lhs, @rhs) = @$args;
1488 return $self->join_query_parts(' ',
1490 $self->format_keyword($op),
1491 $self->join_query_parts(' ',
1493 $self->join_query_parts(', ', @rhs),
1499 sub _render_op_andor {
1500 my ($self, $op, $args) = @_;
1501 return undef unless @$args;
1502 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1503 my $inner = $self->_render_op_multop($op, $args);
1504 return undef unless defined($inner->[0]) and length($inner->[0]);
1505 return $self->join_query_parts(' ',
1510 sub _render_op_multop {
1511 my ($self, $op, $args) = @_;
1513 return undef unless @parts;
1514 return $self->render_aqt($parts[0]) if @parts == 1;
1515 my $join = ($op eq ','
1517 : ' '.$self->format_keyword($op).' '
1519 return $self->join_query_parts($join, @parts);
1522 sub _render_values {
1523 my ($self, undef, $values) = @_;
1524 my $inner = $self->join_query_parts(' ',
1525 $self->format_keyword('values'),
1526 $self->join_query_parts(', ',
1527 ref($values) eq 'ARRAY' ? @$values : $values
1530 return $self->join_query_parts('',
1531 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1535 sub join_query_parts {
1536 my ($self, $join, @parts) = @_;
1539 ? $self->render_aqt($_)
1540 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1543 $self->{join_sql_parts}->(
1544 $join, grep defined && length, map $_->[0], @final
1546 (map @{$_}[1..$#$_], @final),
1550 sub _render_unop_paren {
1551 my ($self, $op, $v) = @_;
1552 return $self->join_query_parts('',
1553 '(', $self->_render_unop_prefix($op, $v), ')'
1557 sub _render_unop_prefix {
1558 my ($self, $op, $v) = @_;
1559 return $self->join_query_parts(' ',
1560 $self->_sqlcase($op), $v->[0]
1564 sub _render_unop_postfix {
1565 my ($self, $op, $v) = @_;
1566 return $self->join_query_parts(' ',
1567 $v->[0], $self->format_keyword($op),
1571 # Some databases (SQLite) treat col IN (1, 2) different from
1572 # col IN ( (1, 2) ). Use this to strip all outer parens while
1573 # adding them back in the corresponding method
1574 sub _open_outer_paren {
1575 my ($self, $sql) = @_;
1577 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1579 # there are closing parens inside, need the heavy duty machinery
1580 # to reevaluate the extraction starting from $sql (full reevaluation)
1581 if ($inner =~ /\)/) {
1582 require Text::Balanced;
1584 my (undef, $remainder) = do {
1585 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1587 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1590 # the entire expression needs to be a balanced bracketed thing
1591 # (after an extract no remainder sans trailing space)
1592 last if defined $remainder and $remainder =~ /\S/;
1602 #======================================================================
1604 #======================================================================
1606 sub _expand_order_by {
1607 my ($self, $arg) = @_;
1609 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1611 return $self->expand_maybe_list_expr($arg)
1612 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1614 my $expander = sub {
1615 my ($self, $dir, $expr) = @_;
1616 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1617 foreach my $arg (@to_expand) {
1621 and grep /^-(asc|desc)$/, keys %$arg
1623 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1627 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1629 map $self->expand_expr($_, -ident),
1630 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1631 return undef unless @exp;
1632 return undef if @exp == 1 and not defined($exp[0]);
1633 return +{ -op => [ ',', @exp ] };
1636 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1638 return $self->$expander(undef, $arg);
1642 my ($self, $arg) = @_;
1644 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1646 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1648 return '' unless length($sql);
1650 my $final_sql = $self->_sqlcase(' order by ').$sql;
1652 return ($final_sql, @bind);
1655 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1657 sub _order_by_chunks {
1658 my ($self, $arg) = @_;
1660 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1662 my @res = $self->_chunkify_order_by($expanded);
1663 (ref() ? $_->[0] : $_) .= '' for @res;
1667 sub _chunkify_order_by {
1668 my ($self, $expanded) = @_;
1670 return grep length, @{ $self->render_aqt($expanded) }
1671 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1674 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1675 my ($comma, @list) = @{$_->{-op}};
1676 return map $self->_chunkify_order_by($_), @list;
1678 return $self->render_aqt($_);
1682 #======================================================================
1683 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1684 #======================================================================
1690 $self->expand_maybe_list_expr($from, -ident)
1695 #======================================================================
1697 #======================================================================
1699 sub expand_maybe_list_expr {
1700 my ($self, $expr, $default) = @_;
1702 ',', map $self->expand_expr($_, $default),
1703 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1704 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1705 return +{ -op => [ ',',
1706 map $self->expand_expr($_, $default),
1707 ref($expr) eq 'ARRAY' ? @$expr : $expr
1711 # highly optimized, as it's called way too often
1713 # my ($self, $label) = @_;
1715 return '' unless defined $_[1];
1716 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1717 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1719 unless ($_[0]->{quote_char}) {
1720 if (ref($_[1]) eq 'ARRAY') {
1721 return join($_[0]->{name_sep}||'.', @{$_[1]});
1723 $_[0]->_assert_pass_injection_guard($_[1]);
1728 my $qref = ref $_[0]->{quote_char};
1730 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1731 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1732 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1734 my $esc = $_[0]->{escape_char} || $r;
1736 # parts containing * are naturally unquoted
1738 $_[0]->{name_sep}||'',
1742 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1744 (ref($_[1]) eq 'ARRAY'
1748 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1756 # Conversion, if applicable
1758 #my ($self, $arg) = @_;
1759 if (my $conv = $_[0]->{convert_where}) {
1760 return @{ $_[0]->join_query_parts('',
1761 $_[0]->format_keyword($conv),
1770 #my ($self, $col, @vals) = @_;
1771 # called often - tighten code
1772 return $_[0]->{bindtype} eq 'columns'
1773 ? map {[$_[1], $_]} @_[2 .. $#_]
1778 # Dies if any element of @bind is not in [colname => value] format
1779 # if bindtype is 'columns'.
1780 sub _assert_bindval_matches_bindtype {
1781 # my ($self, @bind) = @_;
1783 if ($self->{bindtype} eq 'columns') {
1785 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1786 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1792 sub _join_sql_clauses {
1793 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1795 if (@$clauses_aref > 1) {
1796 my $join = " " . $self->_sqlcase($logic) . " ";
1797 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1798 return ($sql, @$bind_aref);
1800 elsif (@$clauses_aref) {
1801 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1804 return (); # if no SQL, ignore @$bind_aref
1809 # Fix SQL case, if so requested
1811 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1812 # don't touch the argument ... crooked logic, but let's not change it!
1813 return $_[0]->{case} ? $_[1] : uc($_[1]);
1816 sub format_keyword { $_[0]->_sqlcase(join ' ', split '_', $_[1]) }
1818 #======================================================================
1819 # DISPATCHING FROM REFKIND
1820 #======================================================================
1823 my ($self, $data) = @_;
1825 return 'UNDEF' unless defined $data;
1827 # blessed objects are treated like scalars
1828 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1830 return 'SCALAR' unless $ref;
1833 while ($ref eq 'REF') {
1835 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1839 return ($ref||'SCALAR') . ('REF' x $n_steps);
1843 my ($self, $data) = @_;
1844 my @try = ($self->_refkind($data));
1845 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1846 push @try, 'FALLBACK';
1850 sub _METHOD_FOR_refkind {
1851 my ($self, $meth_prefix, $data) = @_;
1854 for (@{$self->_try_refkind($data)}) {
1855 $method = $self->can($meth_prefix."_".$_)
1859 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1863 sub _SWITCH_refkind {
1864 my ($self, $data, $dispatch_table) = @_;
1867 for (@{$self->_try_refkind($data)}) {
1868 $coderef = $dispatch_table->{$_}
1872 puke "no dispatch entry for ".$self->_refkind($data)
1881 #======================================================================
1882 # VALUES, GENERATE, AUTOLOAD
1883 #======================================================================
1885 # LDNOTE: original code from nwiger, didn't touch code in that section
1886 # I feel the AUTOLOAD stuff should not be the default, it should
1887 # only be activated on explicit demand by user.
1891 my $data = shift || return;
1892 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1893 unless ref $data eq 'HASH';
1896 foreach my $k (sort keys %$data) {
1897 my $v = $data->{$k};
1898 $self->_SWITCH_refkind($v, {
1900 if ($self->{array_datatypes}) { # array datatype
1901 push @all_bind, $self->_bindtype($k, $v);
1903 else { # literal SQL with bind
1904 my ($sql, @bind) = @$v;
1905 $self->_assert_bindval_matches_bindtype(@bind);
1906 push @all_bind, @bind;
1909 ARRAYREFREF => sub { # literal SQL with bind
1910 my ($sql, @bind) = @${$v};
1911 $self->_assert_bindval_matches_bindtype(@bind);
1912 push @all_bind, @bind;
1914 SCALARREF => sub { # literal SQL without bind
1916 SCALAR_or_UNDEF => sub {
1917 push @all_bind, $self->_bindtype($k, $v);
1928 my(@sql, @sqlq, @sqlv);
1932 if ($ref eq 'HASH') {
1933 for my $k (sort keys %$_) {
1936 my $label = $self->_quote($k);
1937 if ($r eq 'ARRAY') {
1938 # literal SQL with bind
1939 my ($sql, @bind) = @$v;
1940 $self->_assert_bindval_matches_bindtype(@bind);
1941 push @sqlq, "$label = $sql";
1943 } elsif ($r eq 'SCALAR') {
1944 # literal SQL without bind
1945 push @sqlq, "$label = $$v";
1947 push @sqlq, "$label = ?";
1948 push @sqlv, $self->_bindtype($k, $v);
1951 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1952 } elsif ($ref eq 'ARRAY') {
1953 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1956 if ($r eq 'ARRAY') { # literal SQL with bind
1957 my ($sql, @bind) = @$v;
1958 $self->_assert_bindval_matches_bindtype(@bind);
1961 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1962 # embedded literal SQL
1969 push @sql, '(' . join(', ', @sqlq) . ')';
1970 } elsif ($ref eq 'SCALAR') {
1974 # strings get case twiddled
1975 push @sql, $self->_sqlcase($_);
1979 my $sql = join ' ', @sql;
1981 # this is pretty tricky
1982 # if ask for an array, return ($stmt, @bind)
1983 # otherwise, s/?/shift @sqlv/ to put it inline
1985 return ($sql, @sqlv);
1987 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1988 ref $d ? $d->[1] : $d/e;
1997 # This allows us to check for a local, then _form, attr
1999 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2000 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2001 return $self->generate($name, @_);
2012 SQL::Abstract - Generate SQL from Perl data structures
2018 my $sql = SQL::Abstract->new;
2020 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2022 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2024 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2026 my($stmt, @bind) = $sql->delete($table, \%where);
2028 # Then, use these in your DBI statements
2029 my $sth = $dbh->prepare($stmt);
2030 $sth->execute(@bind);
2032 # Just generate the WHERE clause
2033 my($stmt, @bind) = $sql->where(\%where, $order);
2035 # Return values in the same order, for hashed queries
2036 # See PERFORMANCE section for more details
2037 my @bind = $sql->values(\%fieldvals);
2041 This module was inspired by the excellent L<DBIx::Abstract>.
2042 However, in using that module I found that what I really wanted
2043 to do was generate SQL, but still retain complete control over my
2044 statement handles and use the DBI interface. So, I set out to
2045 create an abstract SQL generation module.
2047 While based on the concepts used by L<DBIx::Abstract>, there are
2048 several important differences, especially when it comes to WHERE
2049 clauses. I have modified the concepts used to make the SQL easier
2050 to generate from Perl data structures and, IMO, more intuitive.
2051 The underlying idea is for this module to do what you mean, based
2052 on the data structures you provide it. The big advantage is that
2053 you don't have to modify your code every time your data changes,
2054 as this module figures it out.
2056 To begin with, an SQL INSERT is as easy as just specifying a hash
2057 of C<key=value> pairs:
2060 name => 'Jimbo Bobson',
2061 phone => '123-456-7890',
2062 address => '42 Sister Lane',
2063 city => 'St. Louis',
2064 state => 'Louisiana',
2067 The SQL can then be generated with this:
2069 my($stmt, @bind) = $sql->insert('people', \%data);
2071 Which would give you something like this:
2073 $stmt = "INSERT INTO people
2074 (address, city, name, phone, state)
2075 VALUES (?, ?, ?, ?, ?)";
2076 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2077 '123-456-7890', 'Louisiana');
2079 These are then used directly in your DBI code:
2081 my $sth = $dbh->prepare($stmt);
2082 $sth->execute(@bind);
2084 =head2 Inserting and Updating Arrays
2086 If your database has array types (like for example Postgres),
2087 activate the special option C<< array_datatypes => 1 >>
2088 when creating the C<SQL::Abstract> object.
2089 Then you may use an arrayref to insert and update database array types:
2091 my $sql = SQL::Abstract->new(array_datatypes => 1);
2093 planets => [qw/Mercury Venus Earth Mars/]
2096 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2100 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2102 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2105 =head2 Inserting and Updating SQL
2107 In order to apply SQL functions to elements of your C<%data> you may
2108 specify a reference to an arrayref for the given hash value. For example,
2109 if you need to execute the Oracle C<to_date> function on a value, you can
2110 say something like this:
2114 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2117 The first value in the array is the actual SQL. Any other values are
2118 optional and would be included in the bind values array. This gives
2121 my($stmt, @bind) = $sql->insert('people', \%data);
2123 $stmt = "INSERT INTO people (name, date_entered)
2124 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2125 @bind = ('Bill', '03/02/2003');
2127 An UPDATE is just as easy, all you change is the name of the function:
2129 my($stmt, @bind) = $sql->update('people', \%data);
2131 Notice that your C<%data> isn't touched; the module will generate
2132 the appropriately quirky SQL for you automatically. Usually you'll
2133 want to specify a WHERE clause for your UPDATE, though, which is
2134 where handling C<%where> hashes comes in handy...
2136 =head2 Complex where statements
2138 This module can generate pretty complicated WHERE statements
2139 easily. For example, simple C<key=value> pairs are taken to mean
2140 equality, and if you want to see if a field is within a set
2141 of values, you can use an arrayref. Let's say we wanted to
2142 SELECT some data based on this criteria:
2145 requestor => 'inna',
2146 worker => ['nwiger', 'rcwe', 'sfz'],
2147 status => { '!=', 'completed' }
2150 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2152 The above would give you something like this:
2154 $stmt = "SELECT * FROM tickets WHERE
2155 ( requestor = ? ) AND ( status != ? )
2156 AND ( worker = ? OR worker = ? OR worker = ? )";
2157 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2159 Which you could then use in DBI code like so:
2161 my $sth = $dbh->prepare($stmt);
2162 $sth->execute(@bind);
2168 The methods are simple. There's one for every major SQL operation,
2169 and a constructor you use first. The arguments are specified in a
2170 similar order for each method (table, then fields, then a where
2171 clause) to try and simplify things.
2173 =head2 new(option => 'value')
2175 The C<new()> function takes a list of options and values, and returns
2176 a new B<SQL::Abstract> object which can then be used to generate SQL
2177 through the methods below. The options accepted are:
2183 If set to 'lower', then SQL will be generated in all lowercase. By
2184 default SQL is generated in "textbook" case meaning something like:
2186 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2188 Any setting other than 'lower' is ignored.
2192 This determines what the default comparison operator is. By default
2193 it is C<=>, meaning that a hash like this:
2195 %where = (name => 'nwiger', email => 'nate@wiger.org');
2197 Will generate SQL like this:
2199 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2201 However, you may want loose comparisons by default, so if you set
2202 C<cmp> to C<like> you would get SQL such as:
2204 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2206 You can also override the comparison on an individual basis - see
2207 the huge section on L</"WHERE CLAUSES"> at the bottom.
2209 =item sqltrue, sqlfalse
2211 Expressions for inserting boolean values within SQL statements.
2212 By default these are C<1=1> and C<1=0>. They are used
2213 by the special operators C<-in> and C<-not_in> for generating
2214 correct SQL even when the argument is an empty array (see below).
2218 This determines the default logical operator for multiple WHERE
2219 statements in arrays or hashes. If absent, the default logic is "or"
2220 for arrays, and "and" for hashes. This means that a WHERE
2224 event_date => {'>=', '2/13/99'},
2225 event_date => {'<=', '4/24/03'},
2228 will generate SQL like this:
2230 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2232 This is probably not what you want given this query, though (look
2233 at the dates). To change the "OR" to an "AND", simply specify:
2235 my $sql = SQL::Abstract->new(logic => 'and');
2237 Which will change the above C<WHERE> to:
2239 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2241 The logic can also be changed locally by inserting
2242 a modifier in front of an arrayref:
2244 @where = (-and => [event_date => {'>=', '2/13/99'},
2245 event_date => {'<=', '4/24/03'} ]);
2247 See the L</"WHERE CLAUSES"> section for explanations.
2251 This will automatically convert comparisons using the specified SQL
2252 function for both column and value. This is mostly used with an argument
2253 of C<upper> or C<lower>, so that the SQL will have the effect of
2254 case-insensitive "searches". For example, this:
2256 $sql = SQL::Abstract->new(convert => 'upper');
2257 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2259 Will turn out the following SQL:
2261 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2263 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2264 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2265 not validate this option; it will just pass through what you specify verbatim).
2269 This is a kludge because many databases suck. For example, you can't
2270 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2271 Instead, you have to use C<bind_param()>:
2273 $sth->bind_param(1, 'reg data');
2274 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2276 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2277 which loses track of which field each slot refers to. Fear not.
2279 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2280 Currently, you can specify either C<normal> (default) or C<columns>. If you
2281 specify C<columns>, you will get an array that looks like this:
2283 my $sql = SQL::Abstract->new(bindtype => 'columns');
2284 my($stmt, @bind) = $sql->insert(...);
2287 [ 'column1', 'value1' ],
2288 [ 'column2', 'value2' ],
2289 [ 'column3', 'value3' ],
2292 You can then iterate through this manually, using DBI's C<bind_param()>.
2294 $sth->prepare($stmt);
2297 my($col, $data) = @$_;
2298 if ($col eq 'details' || $col eq 'comments') {
2299 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2300 } elsif ($col eq 'image') {
2301 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2303 $sth->bind_param($i, $data);
2307 $sth->execute; # execute without @bind now
2309 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2310 Basically, the advantage is still that you don't have to care which fields
2311 are or are not included. You could wrap that above C<for> loop in a simple
2312 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2313 get a layer of abstraction over manual SQL specification.
2315 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2316 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2317 will expect the bind values in this format.
2321 This is the character that a table or column name will be quoted
2322 with. By default this is an empty string, but you could set it to
2323 the character C<`>, to generate SQL like this:
2325 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2327 Alternatively, you can supply an array ref of two items, the first being the left
2328 hand quote character, and the second the right hand quote character. For
2329 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2330 that generates SQL like this:
2332 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2334 Quoting is useful if you have tables or columns names that are reserved
2335 words in your database's SQL dialect.
2339 This is the character that will be used to escape L</quote_char>s appearing
2340 in an identifier before it has been quoted.
2342 The parameter default in case of a single L</quote_char> character is the quote
2345 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2346 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2347 of the B<opening (left)> L</quote_char> within the identifier are currently left
2348 untouched. The default for opening-closing-style quotes may change in future
2349 versions, thus you are B<strongly encouraged> to specify the escape character
2354 This is the character that separates a table and column name. It is
2355 necessary to specify this when the C<quote_char> option is selected,
2356 so that tables and column names can be individually quoted like this:
2358 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2360 =item injection_guard
2362 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2363 column name specified in a query structure. This is a safety mechanism to avoid
2364 injection attacks when mishandling user input e.g.:
2366 my %condition_as_column_value_pairs = get_values_from_user();
2367 $sqla->select( ... , \%condition_as_column_value_pairs );
2369 If the expression matches an exception is thrown. Note that literal SQL
2370 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2372 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2374 =item array_datatypes
2376 When this option is true, arrayrefs in INSERT or UPDATE are
2377 interpreted as array datatypes and are passed directly
2379 When this option is false, arrayrefs are interpreted
2380 as literal SQL, just like refs to arrayrefs
2381 (but this behavior is for backwards compatibility; when writing
2382 new queries, use the "reference to arrayref" syntax
2388 Takes a reference to a list of "special operators"
2389 to extend the syntax understood by L<SQL::Abstract>.
2390 See section L</"SPECIAL OPERATORS"> for details.
2394 Takes a reference to a list of "unary operators"
2395 to extend the syntax understood by L<SQL::Abstract>.
2396 See section L</"UNARY OPERATORS"> for details.
2402 =head2 insert($table, \@values || \%fieldvals, \%options)
2404 This is the simplest function. You simply give it a table name
2405 and either an arrayref of values or hashref of field/value pairs.
2406 It returns an SQL INSERT statement and a list of bind values.
2407 See the sections on L</"Inserting and Updating Arrays"> and
2408 L</"Inserting and Updating SQL"> for information on how to insert
2409 with those data types.
2411 The optional C<\%options> hash reference may contain additional
2412 options to generate the insert SQL. Currently supported options
2419 Takes either a scalar of raw SQL fields, or an array reference of
2420 field names, and adds on an SQL C<RETURNING> statement at the end.
2421 This allows you to return data generated by the insert statement
2422 (such as row IDs) without performing another C<SELECT> statement.
2423 Note, however, this is not part of the SQL standard and may not
2424 be supported by all database engines.
2428 =head2 update($table, \%fieldvals, \%where, \%options)
2430 This takes a table, hashref of field/value pairs, and an optional
2431 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2433 See the sections on L</"Inserting and Updating Arrays"> and
2434 L</"Inserting and Updating SQL"> for information on how to insert
2435 with those data types.
2437 The optional C<\%options> hash reference may contain additional
2438 options to generate the update SQL. Currently supported options
2445 See the C<returning> option to
2446 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2450 =head2 select($source, $fields, $where, $order)
2452 This returns a SQL SELECT statement and associated list of bind values, as
2453 specified by the arguments:
2459 Specification of the 'FROM' part of the statement.
2460 The argument can be either a plain scalar (interpreted as a table
2461 name, will be quoted), or an arrayref (interpreted as a list
2462 of table names, joined by commas, quoted), or a scalarref
2463 (literal SQL, not quoted).
2467 Specification of the list of fields to retrieve from
2469 The argument can be either an arrayref (interpreted as a list
2470 of field names, will be joined by commas and quoted), or a
2471 plain scalar (literal SQL, not quoted).
2472 Please observe that this API is not as flexible as that of
2473 the first argument C<$source>, for backwards compatibility reasons.
2477 Optional argument to specify the WHERE part of the query.
2478 The argument is most often a hashref, but can also be
2479 an arrayref or plain scalar --
2480 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2484 Optional argument to specify the ORDER BY part of the query.
2485 The argument can be a scalar, a hashref or an arrayref
2486 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2492 =head2 delete($table, \%where, \%options)
2494 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2495 It returns an SQL DELETE statement and list of bind values.
2497 The optional C<\%options> hash reference may contain additional
2498 options to generate the delete SQL. Currently supported options
2505 See the C<returning> option to
2506 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2510 =head2 where(\%where, $order)
2512 This is used to generate just the WHERE clause. For example,
2513 if you have an arbitrary data structure and know what the
2514 rest of your SQL is going to look like, but want an easy way
2515 to produce a WHERE clause, use this. It returns an SQL WHERE
2516 clause and list of bind values.
2519 =head2 values(\%data)
2521 This just returns the values from the hash C<%data>, in the same
2522 order that would be returned from any of the other above queries.
2523 Using this allows you to markedly speed up your queries if you
2524 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2526 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2528 Warning: This is an experimental method and subject to change.
2530 This returns arbitrarily generated SQL. It's a really basic shortcut.
2531 It will return two different things, depending on return context:
2533 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2534 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2536 These would return the following:
2538 # First calling form
2539 $stmt = "CREATE TABLE test (?, ?)";
2540 @bind = (field1, field2);
2542 # Second calling form
2543 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2545 Depending on what you're trying to do, it's up to you to choose the correct
2546 format. In this example, the second form is what you would want.
2550 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2554 ALTER SESSION SET nls_date_format = 'MM/YY'
2556 You get the idea. Strings get their case twiddled, but everything
2557 else remains verbatim.
2559 =head1 EXPORTABLE FUNCTIONS
2561 =head2 is_plain_value
2563 Determines if the supplied argument is a plain value as understood by this
2568 =item * The value is C<undef>
2570 =item * The value is a non-reference
2572 =item * The value is an object with stringification overloading
2574 =item * The value is of the form C<< { -value => $anything } >>
2578 On failure returns C<undef>, on success returns a B<scalar> reference
2579 to the original supplied argument.
2585 The stringification overloading detection is rather advanced: it takes
2586 into consideration not only the presence of a C<""> overload, but if that
2587 fails also checks for enabled
2588 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2589 on either C<0+> or C<bool>.
2591 Unfortunately testing in the field indicates that this
2592 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2593 but only when very large numbers of stringifying objects are involved.
2594 At the time of writing ( Sep 2014 ) there is no clear explanation of
2595 the direct cause, nor is there a manageably small test case that reliably
2596 reproduces the problem.
2598 If you encounter any of the following exceptions in B<random places within
2599 your application stack> - this module may be to blame:
2601 Operation "ne": no method found,
2602 left argument in overloaded package <something>,
2603 right argument in overloaded package <something>
2607 Stub found while resolving method "???" overloading """" in package <something>
2609 If you fall victim to the above - please attempt to reduce the problem
2610 to something that could be sent to the L<SQL::Abstract developers
2611 |DBIx::Class/GETTING HELP/SUPPORT>
2612 (either publicly or privately). As a workaround in the meantime you can
2613 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2614 value, which will most likely eliminate your problem (at the expense of
2615 not being able to properly detect exotic forms of stringification).
2617 This notice and environment variable will be removed in a future version,
2618 as soon as the underlying problem is found and a reliable workaround is
2623 =head2 is_literal_value
2625 Determines if the supplied argument is a literal value as understood by this
2630 =item * C<\$sql_string>
2632 =item * C<\[ $sql_string, @bind_values ]>
2636 On failure returns C<undef>, on success returns an B<array> reference
2637 containing the unpacked version of the supplied literal SQL and bind values.
2639 =head1 WHERE CLAUSES
2643 This module uses a variation on the idea from L<DBIx::Abstract>. It
2644 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2645 module is that things in arrays are OR'ed, and things in hashes
2648 The easiest way to explain is to show lots of examples. After
2649 each C<%where> hash shown, it is assumed you used:
2651 my($stmt, @bind) = $sql->where(\%where);
2653 However, note that the C<%where> hash can be used directly in any
2654 of the other functions as well, as described above.
2656 =head2 Key-value pairs
2658 So, let's get started. To begin, a simple hash:
2662 status => 'completed'
2665 Is converted to SQL C<key = val> statements:
2667 $stmt = "WHERE user = ? AND status = ?";
2668 @bind = ('nwiger', 'completed');
2670 One common thing I end up doing is having a list of values that
2671 a field can be in. To do this, simply specify a list inside of
2676 status => ['assigned', 'in-progress', 'pending'];
2679 This simple code will create the following:
2681 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2682 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2684 A field associated to an empty arrayref will be considered a
2685 logical false and will generate 0=1.
2687 =head2 Tests for NULL values
2689 If the value part is C<undef> then this is converted to SQL <IS NULL>
2698 $stmt = "WHERE user = ? AND status IS NULL";
2701 To test if a column IS NOT NULL:
2705 status => { '!=', undef },
2708 =head2 Specific comparison operators
2710 If you want to specify a different type of operator for your comparison,
2711 you can use a hashref for a given column:
2715 status => { '!=', 'completed' }
2718 Which would generate:
2720 $stmt = "WHERE user = ? AND status != ?";
2721 @bind = ('nwiger', 'completed');
2723 To test against multiple values, just enclose the values in an arrayref:
2725 status => { '=', ['assigned', 'in-progress', 'pending'] };
2727 Which would give you:
2729 "WHERE status = ? OR status = ? OR status = ?"
2732 The hashref can also contain multiple pairs, in which case it is expanded
2733 into an C<AND> of its elements:
2737 status => { '!=', 'completed', -not_like => 'pending%' }
2740 # Or more dynamically, like from a form
2741 $where{user} = 'nwiger';
2742 $where{status}{'!='} = 'completed';
2743 $where{status}{'-not_like'} = 'pending%';
2745 # Both generate this
2746 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2747 @bind = ('nwiger', 'completed', 'pending%');
2750 To get an OR instead, you can combine it with the arrayref idea:
2754 priority => [ { '=', 2 }, { '>', 5 } ]
2757 Which would generate:
2759 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2760 @bind = ('2', '5', 'nwiger');
2762 If you want to include literal SQL (with or without bind values), just use a
2763 scalar reference or reference to an arrayref as the value:
2766 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2767 date_expires => { '<' => \"now()" }
2770 Which would generate:
2772 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2773 @bind = ('11/26/2008');
2776 =head2 Logic and nesting operators
2778 In the example above,
2779 there is a subtle trap if you want to say something like
2780 this (notice the C<AND>):
2782 WHERE priority != ? AND priority != ?
2784 Because, in Perl you I<can't> do this:
2786 priority => { '!=' => 2, '!=' => 1 }
2788 As the second C<!=> key will obliterate the first. The solution
2789 is to use the special C<-modifier> form inside an arrayref:
2791 priority => [ -and => {'!=', 2},
2795 Normally, these would be joined by C<OR>, but the modifier tells it
2796 to use C<AND> instead. (Hint: You can use this in conjunction with the
2797 C<logic> option to C<new()> in order to change the way your queries
2798 work by default.) B<Important:> Note that the C<-modifier> goes
2799 B<INSIDE> the arrayref, as an extra first element. This will
2800 B<NOT> do what you think it might:
2802 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2804 Here is a quick list of equivalencies, since there is some overlap:
2807 status => {'!=', 'completed', 'not like', 'pending%' }
2808 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2811 status => {'=', ['assigned', 'in-progress']}
2812 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2813 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2817 =head2 Special operators: IN, BETWEEN, etc.
2819 You can also use the hashref format to compare a list of fields using the
2820 C<IN> comparison operator, by specifying the list as an arrayref:
2823 status => 'completed',
2824 reportid => { -in => [567, 2335, 2] }
2827 Which would generate:
2829 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2830 @bind = ('completed', '567', '2335', '2');
2832 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2835 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2836 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2837 'sqltrue' (by default: C<1=1>).
2839 In addition to the array you can supply a chunk of literal sql or
2840 literal sql with bind:
2843 customer => { -in => \[
2844 'SELECT cust_id FROM cust WHERE balance > ?',
2847 status => { -in => \'SELECT status_codes FROM states' },
2853 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2854 AND status IN ( SELECT status_codes FROM states )
2858 Finally, if the argument to C<-in> is not a reference, it will be
2859 treated as a single-element array.
2861 Another pair of operators is C<-between> and C<-not_between>,
2862 used with an arrayref of two values:
2866 completion_date => {
2867 -not_between => ['2002-10-01', '2003-02-06']
2873 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2875 Just like with C<-in> all plausible combinations of literal SQL
2879 start0 => { -between => [ 1, 2 ] },
2880 start1 => { -between => \["? AND ?", 1, 2] },
2881 start2 => { -between => \"lower(x) AND upper(y)" },
2882 start3 => { -between => [
2884 \["upper(?)", 'stuff' ],
2891 ( start0 BETWEEN ? AND ? )
2892 AND ( start1 BETWEEN ? AND ? )
2893 AND ( start2 BETWEEN lower(x) AND upper(y) )
2894 AND ( start3 BETWEEN lower(x) AND upper(?) )
2896 @bind = (1, 2, 1, 2, 'stuff');
2899 These are the two builtin "special operators"; but the
2900 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2902 =head2 Unary operators: bool
2904 If you wish to test against boolean columns or functions within your
2905 database you can use the C<-bool> and C<-not_bool> operators. For
2906 example to test the column C<is_user> being true and the column
2907 C<is_enabled> being false you would use:-
2911 -not_bool => 'is_enabled',
2916 WHERE is_user AND NOT is_enabled
2918 If a more complex combination is required, testing more conditions,
2919 then you should use the and/or operators:-
2924 -not_bool => { two=> { -rlike => 'bar' } },
2925 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2936 (NOT ( three = ? OR three > ? ))
2939 =head2 Nested conditions, -and/-or prefixes
2941 So far, we've seen how multiple conditions are joined with a top-level
2942 C<AND>. We can change this by putting the different conditions we want in
2943 hashes and then putting those hashes in an array. For example:
2948 status => { -like => ['pending%', 'dispatched'] },
2952 status => 'unassigned',
2956 This data structure would create the following:
2958 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2959 OR ( user = ? AND status = ? ) )";
2960 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2963 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2964 to change the logic inside:
2970 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2971 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2978 $stmt = "WHERE ( user = ?
2979 AND ( ( workhrs > ? AND geo = ? )
2980 OR ( workhrs < ? OR geo = ? ) ) )";
2981 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2983 =head3 Algebraic inconsistency, for historical reasons
2985 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2986 operator goes C<outside> of the nested structure; whereas when connecting
2987 several constraints on one column, the C<-and> operator goes
2988 C<inside> the arrayref. Here is an example combining both features:
2991 -and => [a => 1, b => 2],
2992 -or => [c => 3, d => 4],
2993 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2998 WHERE ( ( ( a = ? AND b = ? )
2999 OR ( c = ? OR d = ? )
3000 OR ( e LIKE ? AND e LIKE ? ) ) )
3002 This difference in syntax is unfortunate but must be preserved for
3003 historical reasons. So be careful: the two examples below would
3004 seem algebraically equivalent, but they are not
3007 { -like => 'foo%' },
3008 { -like => '%bar' },
3010 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3013 { col => { -like => 'foo%' } },
3014 { col => { -like => '%bar' } },
3016 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3019 =head2 Literal SQL and value type operators
3021 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3022 side" is a column name and the "right side" is a value (normally rendered as
3023 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3024 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3025 alter this behavior. There are several ways of doing so.
3029 This is a virtual operator that signals the string to its right side is an
3030 identifier (a column name) and not a value. For example to compare two
3031 columns you would write:
3034 priority => { '<', 2 },
3035 requestor => { -ident => 'submitter' },
3040 $stmt = "WHERE priority < ? AND requestor = submitter";
3043 If you are maintaining legacy code you may see a different construct as
3044 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3049 This is a virtual operator that signals that the construct to its right side
3050 is a value to be passed to DBI. This is for example necessary when you want
3051 to write a where clause against an array (for RDBMS that support such
3052 datatypes). For example:
3055 array => { -value => [1, 2, 3] }
3060 $stmt = 'WHERE array = ?';
3061 @bind = ([1, 2, 3]);
3063 Note that if you were to simply say:
3069 the result would probably not be what you wanted:
3071 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3076 Finally, sometimes only literal SQL will do. To include a random snippet
3077 of SQL verbatim, you specify it as a scalar reference. Consider this only
3078 as a last resort. Usually there is a better way. For example:
3081 priority => { '<', 2 },
3082 requestor => { -in => \'(SELECT name FROM hitmen)' },
3087 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3090 Note that in this example, you only get one bind parameter back, since
3091 the verbatim SQL is passed as part of the statement.
3095 Never use untrusted input as a literal SQL argument - this is a massive
3096 security risk (there is no way to check literal snippets for SQL
3097 injections and other nastyness). If you need to deal with untrusted input
3098 use literal SQL with placeholders as described next.
3100 =head3 Literal SQL with placeholders and bind values (subqueries)
3102 If the literal SQL to be inserted has placeholders and bind values,
3103 use a reference to an arrayref (yes this is a double reference --
3104 not so common, but perfectly legal Perl). For example, to find a date
3105 in Postgres you can use something like this:
3108 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3113 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3116 Note that you must pass the bind values in the same format as they are returned
3117 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3118 to C<columns>, you must provide the bind values in the
3119 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3120 scalar value; most commonly the column name, but you can use any scalar value
3121 (including references and blessed references), L<SQL::Abstract> will simply
3122 pass it through intact. So if C<bindtype> is set to C<columns> the above
3123 example will look like:
3126 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3129 Literal SQL is especially useful for nesting parenthesized clauses in the
3130 main SQL query. Here is a first example:
3132 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3136 bar => \["IN ($sub_stmt)" => @sub_bind],
3141 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3142 WHERE c2 < ? AND c3 LIKE ?))";
3143 @bind = (1234, 100, "foo%");
3145 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3146 are expressed in the same way. Of course the C<$sub_stmt> and
3147 its associated bind values can be generated through a former call
3150 my ($sub_stmt, @sub_bind)
3151 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3152 c3 => {-like => "foo%"}});
3155 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3158 In the examples above, the subquery was used as an operator on a column;
3159 but the same principle also applies for a clause within the main C<%where>
3160 hash, like an EXISTS subquery:
3162 my ($sub_stmt, @sub_bind)
3163 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3164 my %where = ( -and => [
3166 \["EXISTS ($sub_stmt)" => @sub_bind],
3171 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3172 WHERE c1 = ? AND c2 > t0.c0))";
3176 Observe that the condition on C<c2> in the subquery refers to
3177 column C<t0.c0> of the main query: this is I<not> a bind
3178 value, so we have to express it through a scalar ref.
3179 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3180 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3181 what we wanted here.
3183 Finally, here is an example where a subquery is used
3184 for expressing unary negation:
3186 my ($sub_stmt, @sub_bind)
3187 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3188 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3190 lname => {like => '%son%'},
3191 \["NOT ($sub_stmt)" => @sub_bind],
3196 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3197 @bind = ('%son%', 10, 20)
3199 =head3 Deprecated usage of Literal SQL
3201 Below are some examples of archaic use of literal SQL. It is shown only as
3202 reference for those who deal with legacy code. Each example has a much
3203 better, cleaner and safer alternative that users should opt for in new code.
3209 my %where = ( requestor => \'IS NOT NULL' )
3211 $stmt = "WHERE requestor IS NOT NULL"
3213 This used to be the way of generating NULL comparisons, before the handling
3214 of C<undef> got formalized. For new code please use the superior syntax as
3215 described in L</Tests for NULL values>.
3219 my %where = ( requestor => \'= submitter' )
3221 $stmt = "WHERE requestor = submitter"
3223 This used to be the only way to compare columns. Use the superior L</-ident>
3224 method for all new code. For example an identifier declared in such a way
3225 will be properly quoted if L</quote_char> is properly set, while the legacy
3226 form will remain as supplied.
3230 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3232 $stmt = "WHERE completed > ? AND is_ready"
3233 @bind = ('2012-12-21')
3235 Using an empty string literal used to be the only way to express a boolean.
3236 For all new code please use the much more readable
3237 L<-bool|/Unary operators: bool> operator.
3243 These pages could go on for a while, since the nesting of the data
3244 structures this module can handle are pretty much unlimited (the
3245 module implements the C<WHERE> expansion as a recursive function
3246 internally). Your best bet is to "play around" with the module a
3247 little to see how the data structures behave, and choose the best
3248 format for your data based on that.
3250 And of course, all the values above will probably be replaced with
3251 variables gotten from forms or the command line. After all, if you
3252 knew everything ahead of time, you wouldn't have to worry about
3253 dynamically-generating SQL and could just hardwire it into your
3256 =head1 ORDER BY CLAUSES
3258 Some functions take an order by clause. This can either be a scalar (just a
3259 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3260 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3263 Given | Will Generate
3264 ---------------------------------------------------------------
3266 'colA' | ORDER BY colA
3268 [qw/colA colB/] | ORDER BY colA, colB
3270 {-asc => 'colA'} | ORDER BY colA ASC
3272 {-desc => 'colB'} | ORDER BY colB DESC
3274 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3276 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3278 \'colA DESC' | ORDER BY colA DESC
3280 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3281 | /* ...with $x bound to ? */
3284 { -asc => 'colA' }, | colA ASC,
3285 { -desc => [qw/colB/] }, | colB DESC,
3286 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3287 \'colE DESC', | colE DESC,
3288 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3289 ] | /* ...with $x bound to ? */
3290 ===============================================================
3294 =head1 SPECIAL OPERATORS
3296 my $sqlmaker = SQL::Abstract->new(special_ops => [
3300 my ($self, $field, $op, $arg) = @_;
3306 handler => 'method_name',
3310 A "special operator" is a SQL syntactic clause that can be
3311 applied to a field, instead of a usual binary operator.
3314 WHERE field IN (?, ?, ?)
3315 WHERE field BETWEEN ? AND ?
3316 WHERE MATCH(field) AGAINST (?, ?)
3318 Special operators IN and BETWEEN are fairly standard and therefore
3319 are builtin within C<SQL::Abstract> (as the overridable methods
3320 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3321 like the MATCH .. AGAINST example above which is specific to MySQL,
3322 you can write your own operator handlers - supply a C<special_ops>
3323 argument to the C<new> method. That argument takes an arrayref of
3324 operator definitions; each operator definition is a hashref with two
3331 the regular expression to match the operator
3335 Either a coderef or a plain scalar method name. In both cases
3336 the expected return is C<< ($sql, @bind) >>.
3338 When supplied with a method name, it is simply called on the
3339 L<SQL::Abstract> object as:
3341 $self->$method_name($field, $op, $arg)
3345 $field is the LHS of the operator
3346 $op is the part that matched the handler regex
3349 When supplied with a coderef, it is called as:
3351 $coderef->($self, $field, $op, $arg)
3356 For example, here is an implementation
3357 of the MATCH .. AGAINST syntax for MySQL
3359 my $sqlmaker = SQL::Abstract->new(special_ops => [
3361 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3362 {regex => qr/^match$/i,
3364 my ($self, $field, $op, $arg) = @_;
3365 $arg = [$arg] if not ref $arg;
3366 my $label = $self->_quote($field);
3367 my ($placeholder) = $self->_convert('?');
3368 my $placeholders = join ", ", (($placeholder) x @$arg);
3369 my $sql = $self->_sqlcase('match') . " ($label) "
3370 . $self->_sqlcase('against') . " ($placeholders) ";
3371 my @bind = $self->_bindtype($field, @$arg);
3372 return ($sql, @bind);
3379 =head1 UNARY OPERATORS
3381 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3385 my ($self, $op, $arg) = @_;
3391 handler => 'method_name',
3395 A "unary operator" is a SQL syntactic clause that can be
3396 applied to a field - the operator goes before the field
3398 You can write your own operator handlers - supply a C<unary_ops>
3399 argument to the C<new> method. That argument takes an arrayref of
3400 operator definitions; each operator definition is a hashref with two
3407 the regular expression to match the operator
3411 Either a coderef or a plain scalar method name. In both cases
3412 the expected return is C<< $sql >>.
3414 When supplied with a method name, it is simply called on the
3415 L<SQL::Abstract> object as:
3417 $self->$method_name($op, $arg)
3421 $op is the part that matched the handler regex
3422 $arg is the RHS or argument of the operator
3424 When supplied with a coderef, it is called as:
3426 $coderef->($self, $op, $arg)
3434 Thanks to some benchmarking by Mark Stosberg, it turns out that
3435 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3436 I must admit this wasn't an intentional design issue, but it's a
3437 byproduct of the fact that you get to control your C<DBI> handles
3440 To maximize performance, use a code snippet like the following:
3442 # prepare a statement handle using the first row
3443 # and then reuse it for the rest of the rows
3445 for my $href (@array_of_hashrefs) {
3446 $stmt ||= $sql->insert('table', $href);
3447 $sth ||= $dbh->prepare($stmt);
3448 $sth->execute($sql->values($href));
3451 The reason this works is because the keys in your C<$href> are sorted
3452 internally by B<SQL::Abstract>. Thus, as long as your data retains
3453 the same structure, you only have to generate the SQL the first time
3454 around. On subsequent queries, simply use the C<values> function provided
3455 by this module to return your values in the correct order.
3457 However this depends on the values having the same type - if, for
3458 example, the values of a where clause may either have values
3459 (resulting in sql of the form C<column = ?> with a single bind
3460 value), or alternatively the values might be C<undef> (resulting in
3461 sql of the form C<column IS NULL> with no bind value) then the
3462 caching technique suggested will not work.
3466 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3467 really like this part (I do, at least). Building up a complex query
3468 can be as simple as the following:
3475 use CGI::FormBuilder;
3478 my $form = CGI::FormBuilder->new(...);
3479 my $sql = SQL::Abstract->new;
3481 if ($form->submitted) {
3482 my $field = $form->field;
3483 my $id = delete $field->{id};
3484 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3487 Of course, you would still have to connect using C<DBI> to run the
3488 query, but the point is that if you make your form look like your
3489 table, the actual query script can be extremely simplistic.
3491 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3492 a fast interface to returning and formatting data. I frequently
3493 use these three modules together to write complex database query
3494 apps in under 50 lines.
3496 =head1 HOW TO CONTRIBUTE
3498 Contributions are always welcome, in all usable forms (we especially
3499 welcome documentation improvements). The delivery methods include git-
3500 or unified-diff formatted patches, GitHub pull requests, or plain bug
3501 reports either via RT or the Mailing list. Contributors are generally
3502 granted full access to the official repository after their first several
3503 patches pass successful review.
3505 This project is maintained in a git repository. The code and related tools are
3506 accessible at the following locations:
3510 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3512 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3514 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3516 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3522 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3523 Great care has been taken to preserve the I<published> behavior
3524 documented in previous versions in the 1.* family; however,
3525 some features that were previously undocumented, or behaved
3526 differently from the documentation, had to be changed in order
3527 to clarify the semantics. Hence, client code that was relying
3528 on some dark areas of C<SQL::Abstract> v1.*
3529 B<might behave differently> in v1.50.
3531 The main changes are:
3537 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3541 support for the { operator => \"..." } construct (to embed literal SQL)
3545 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3549 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3553 defensive programming: check arguments
3557 fixed bug with global logic, which was previously implemented
3558 through global variables yielding side-effects. Prior versions would
3559 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3560 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3561 Now this is interpreted
3562 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3567 fixed semantics of _bindtype on array args
3571 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3572 we just avoid shifting arrays within that tree.
3576 dropped the C<_modlogic> function
3580 =head1 ACKNOWLEDGEMENTS
3582 There are a number of individuals that have really helped out with
3583 this module. Unfortunately, most of them submitted bugs via CPAN
3584 so I have no idea who they are! But the people I do know are:
3586 Ash Berlin (order_by hash term support)
3587 Matt Trout (DBIx::Class support)
3588 Mark Stosberg (benchmarking)
3589 Chas Owens (initial "IN" operator support)
3590 Philip Collins (per-field SQL functions)
3591 Eric Kolve (hashref "AND" support)
3592 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3593 Dan Kubb (support for "quote_char" and "name_sep")
3594 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3595 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3596 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3597 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3598 Oliver Charles (support for "RETURNING" after "INSERT")
3604 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3608 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3610 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3612 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3613 While not an official support venue, C<DBIx::Class> makes heavy use of
3614 C<SQL::Abstract>, and as such list members there are very familiar with
3615 how to create queries.
3619 This module is free software; you may copy this under the same
3620 terms as perl itself (either the GNU General Public License or
3621 the Artistic License)