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.86';
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 nest => '_expand_nest',
144 bind => '_expand_bind',
145 row => '_expand_row',
147 func => '_expand_func',
148 values => '_expand_values',
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 ] };
1037 # an explicit node type is currently assumed to be expanded (this is almost
1038 # certainly wrong and there should be expansion anyway)
1040 if ($self->{render}{$op}) {
1041 return { $k => $v };
1045 $self->{unknown_unop_always_func} && !$self->{render_op}{$op}
1055 and (keys %$v)[0] =~ /^-/
1059 (List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}})
1060 or $self->{render_op}{$op}
1068 return +{ $type => [
1070 ($type eq -func and ref($v) eq 'ARRAY')
1071 ? map $self->_expand_expr($_), @$v
1072 : $self->_expand_expr($v)
1076 sub _expand_hashpair_cmp {
1077 my ($self, $k, $v) = @_;
1078 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1081 sub _expand_hashtriple {
1082 my ($self, $k, $vk, $vv) = @_;
1084 my $ik = $self->_expand_expr({ -ident => $k });
1086 my $op = $self->_normalize_op($vk);
1087 $self->_assert_pass_injection_guard($op);
1089 if ($op =~ s/ _? \d+ $//x ) {
1090 return $self->_expand_expr($k, { $vk, $vv });
1092 if (my $x = $self->{expand_op}{$op}) {
1093 local our $Cur_Col_Meta = $k;
1094 return $self->$x($op, $vv, $k);
1098 my $op = join(' ', split '_', $op);
1100 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1101 return { -op => [ $op, $ik, $vv ] };
1103 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1107 { -op => [ $op, $vv ] }
1111 if (ref($vv) eq 'ARRAY') {
1113 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1114 ? (shift(@raw), lc $1) : 'or';
1115 my @values = map +{ $vk => $_ }, @raw;
1117 $op =~ $self->{inequality_op}
1118 or $op =~ $self->{not_like_op}
1120 if (lc($logic) eq 'or' and @values > 1) {
1121 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1122 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1123 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1128 # try to DWIM on equality operators
1129 return ($self->_dwim_op_to_is($op,
1130 "Supplying an empty arrayref to '%s' is deprecated",
1131 "operator '%s' applied on an empty array (field '$k')"
1132 ) ? $self->sqlfalse : $self->sqltrue);
1134 return $self->_expand_op_andor($logic => \@values, $k);
1136 if (is_undef_value($vv)) {
1137 my $is = ($self->_dwim_op_to_is($op,
1138 "Supplying an undefined argument to '%s' is deprecated",
1139 "unexpected operator '%s' with undef operand",
1140 ) ? 'is' : 'is not');
1142 return $self->_expand_hashpair($k => { $is, undef });
1144 local our $Cur_Col_Meta = $k;
1148 $self->_expand_expr($vv)
1152 sub _dwim_op_to_is {
1153 my ($self, $raw, $empty, $fail) = @_;
1155 my $op = $self->_normalize_op($raw);
1157 if ($op =~ /^not$/i) {
1160 if ($op =~ $self->{equality_op}) {
1163 if ($op =~ $self->{like_op}) {
1164 belch(sprintf $empty, uc(join ' ', split '_', $op));
1167 if ($op =~ $self->{inequality_op}) {
1170 if ($op =~ $self->{not_like_op}) {
1171 belch(sprintf $empty, uc(join ' ', split '_', $op));
1174 puke(sprintf $fail, $op);
1178 my ($self, undef, $args) = @_;
1179 my ($func, @args) = @$args;
1180 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1184 my ($self, undef, $body, $k) = @_;
1185 return $self->_expand_hashpair_cmp(
1186 $k, { -ident => $body }
1188 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1189 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1191 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1192 ref($body) ? @$body : $body;
1193 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1194 unless ($self->{quote_char}) {
1195 $self->_assert_pass_injection_guard($_) for @parts;
1197 return +{ -ident => \@parts };
1201 return $_[0]->_expand_hashpair_cmp(
1202 $_[3], { -value => $_[2] },
1203 ) if defined($_[3]);
1204 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1208 my ($self, undef, $args) = @_;
1209 +{ -row => [ map $self->expand_expr($_), @$args ] };
1213 my ($self, undef, $args) = @_;
1214 my ($op, @opargs) = @$args;
1215 if (my $exp = $self->{expand_op}{$op}) {
1216 return $self->$exp($op, \@opargs);
1218 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1222 my ($self, undef, $v) = @_;
1224 return $self->_expand_expr($v);
1226 puke "-bool => undef not supported" unless defined($v);
1227 return $self->_expand_expr({ -ident => $v });
1230 sub _expand_op_andor {
1231 my ($self, $logop, $v, $k) = @_;
1233 $v = [ map +{ $k, $_ },
1235 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1239 if (ref($v) eq 'HASH') {
1240 return undef unless keys %$v;
1243 map $self->_expand_expr({ $_ => $v->{$_} }),
1247 if (ref($v) eq 'ARRAY') {
1248 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1251 (ref($_) eq 'ARRAY' and @$_)
1252 or (ref($_) eq 'HASH' and %$_)
1258 while (my ($el) = splice @expr, 0, 1) {
1259 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1260 unless defined($el) and length($el);
1261 my $elref = ref($el);
1263 local our $Expand_Depth = 0;
1264 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1265 } elsif ($elref eq 'ARRAY') {
1266 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1267 } elsif (my $l = is_literal_value($el)) {
1268 push @res, { -literal => $l };
1269 } elsif ($elref eq 'HASH') {
1270 local our $Expand_Depth = 0;
1271 push @res, grep defined, $self->_expand_expr($el) if %$el;
1277 # return $res[0] if @res == 1;
1278 return { -op => [ $logop, @res ] };
1284 my ($self, $op, $vv, $k) = @_;
1285 ($k, $vv) = @$vv unless defined $k;
1286 puke "$op can only take undef as argument"
1290 and exists($vv->{-value})
1291 and !defined($vv->{-value})
1293 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1296 sub _expand_between {
1297 my ($self, $op, $vv, $k) = @_;
1298 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1299 my @rhs = map $self->_expand_expr($_),
1300 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1302 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1304 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1306 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1310 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1316 my ($self, $op, $vv, $k) = @_;
1317 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1318 if (my $literal = is_literal_value($vv)) {
1319 my ($sql, @bind) = @$literal;
1320 my $opened_sql = $self->_open_outer_paren($sql);
1322 $op, $self->expand_expr($k, -ident),
1323 { -literal => [ $opened_sql, @bind ] }
1327 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1328 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1329 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1330 . 'will emit the logically correct SQL instead of raising this exception)'
1332 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1334 my @rhs = map $self->expand_expr($_, -value),
1335 map { defined($_) ? $_: puke($undef_err) }
1336 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1337 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1341 $self->expand_expr($k, -ident),
1347 my ($self, undef, $v) = @_;
1348 # DBIx::Class requires a nest warning to be emitted once but the private
1349 # method it overrode to do so no longer exists
1350 if ($self->{warn_once_on_nest}) {
1351 unless (our $Nest_Warned) {
1353 "-nest in search conditions is deprecated, you most probably wanted:\n"
1354 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1359 return $self->_expand_expr($v);
1363 my ($self, undef, $bind) = @_;
1364 return { -bind => $bind };
1367 sub _expand_values {
1368 my ($self, undef, $values) = @_;
1369 return { -values => [
1372 ? $self->expand_expr($_)
1373 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1374 ), ref($values) eq 'ARRAY' ? @$values : $values
1378 sub _recurse_where {
1379 my ($self, $where, $logic) = @_;
1381 # Special case: top level simple string treated as literal
1383 my $where_exp = (ref($where)
1384 ? $self->_expand_expr($where, $logic)
1385 : { -literal => [ $where ] });
1387 # dispatch expanded expression
1389 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1390 # DBIx::Class used to call _recurse_where in scalar context
1391 # something else might too...
1393 return ($sql, @bind);
1396 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1402 my ($self, undef, $ident) = @_;
1404 return [ $self->_convert($self->_quote($ident)) ];
1408 my ($self, undef, $values) = @_;
1409 return $self->join_query_parts('',
1411 $self->_render_op(undef, [ ',', @$values ]),
1417 my ($self, undef, $rest) = @_;
1418 my ($func, @args) = @$rest;
1419 return $self->join_query_parts('',
1420 $self->_sqlcase($func),
1421 $self->join_query_parts('',
1423 $self->join_query_parts(', ', @args),
1430 my ($self, undef, $bind) = @_;
1431 return [ $self->_convert('?'), $self->_bindtype(@$bind) ];
1434 sub _render_literal {
1435 my ($self, undef, $literal) = @_;
1436 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1441 my ($self, undef, $v) = @_;
1442 my ($op, @args) = @$v;
1443 if (my $r = $self->{render_op}{$op}) {
1444 return $self->$r($op, \@args);
1449 my $op = join(' ', split '_', $op);
1451 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1452 if ($ss and @args > 1) {
1453 puke "Special op '${op}' requires first value to be identifier"
1454 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1455 my $k = join(($self->{name_sep}||'.'), @$ident);
1456 local our $Expand_Depth = 1;
1457 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1459 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1460 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1463 return $self->_render_unop_paren($op, \@args);
1467 return $self->_render_unop_prefix($op, \@args);
1469 return $self->_render_op_multop($op, \@args);
1475 sub _render_op_between {
1476 my ($self, $op, $args) = @_;
1477 my ($left, $low, $high) = @$args;
1480 puke "Single arg to between must be a literal"
1481 unless $low->{-literal};
1484 +($low, $self->format_keyword('and'), $high);
1487 return $self->join_query_parts(' ',
1488 '(', $left, $self->format_keyword($op), @rh, ')',
1493 my ($self, $op, $args) = @_;
1494 my ($lhs, @rhs) = @$args;
1496 return $self->join_query_parts(' ',
1498 $self->format_keyword($op),
1499 $self->join_query_parts(' ',
1501 $self->join_query_parts(', ', @rhs),
1507 sub _render_op_andor {
1508 my ($self, $op, $args) = @_;
1509 return undef unless @$args;
1510 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1511 my $inner = $self->_render_op_multop($op, $args);
1512 return undef unless defined($inner->[0]) and length($inner->[0]);
1513 return $self->join_query_parts(' ',
1518 sub _render_op_multop {
1519 my ($self, $op, $args) = @_;
1521 return undef unless @parts;
1522 return $self->render_aqt($parts[0]) if @parts == 1;
1523 my $join = ($op eq ','
1525 : ' '.$self->format_keyword($op).' '
1527 return $self->join_query_parts($join, @parts);
1530 sub _render_values {
1531 my ($self, undef, $values) = @_;
1532 my $inner = $self->join_query_parts(' ',
1533 $self->format_keyword('values'),
1534 $self->join_query_parts(', ',
1535 ref($values) eq 'ARRAY' ? @$values : $values
1538 return $self->join_query_parts('',
1539 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1543 sub join_query_parts {
1544 my ($self, $join, @parts) = @_;
1547 ? $self->render_aqt($_)
1548 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1551 $self->{join_sql_parts}->(
1552 $join, grep defined && length, map $_->[0], @final
1554 (map @{$_}[1..$#$_], @final),
1558 sub _render_unop_paren {
1559 my ($self, $op, $v) = @_;
1560 return $self->join_query_parts('',
1561 '(', $self->_render_unop_prefix($op, $v), ')'
1565 sub _render_unop_prefix {
1566 my ($self, $op, $v) = @_;
1567 return $self->join_query_parts(' ',
1568 $self->_sqlcase($op), $v->[0]
1572 sub _render_unop_postfix {
1573 my ($self, $op, $v) = @_;
1574 return $self->join_query_parts(' ',
1575 $v->[0], $self->format_keyword($op),
1579 # Some databases (SQLite) treat col IN (1, 2) different from
1580 # col IN ( (1, 2) ). Use this to strip all outer parens while
1581 # adding them back in the corresponding method
1582 sub _open_outer_paren {
1583 my ($self, $sql) = @_;
1585 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1587 # there are closing parens inside, need the heavy duty machinery
1588 # to reevaluate the extraction starting from $sql (full reevaluation)
1589 if ($inner =~ /\)/) {
1590 require Text::Balanced;
1592 my (undef, $remainder) = do {
1593 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1595 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1598 # the entire expression needs to be a balanced bracketed thing
1599 # (after an extract no remainder sans trailing space)
1600 last if defined $remainder and $remainder =~ /\S/;
1610 #======================================================================
1612 #======================================================================
1614 sub _expand_order_by {
1615 my ($self, $arg) = @_;
1617 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1619 return $self->expand_maybe_list_expr($arg)
1620 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1622 my $expander = sub {
1623 my ($self, $dir, $expr) = @_;
1624 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1625 foreach my $arg (@to_expand) {
1629 and grep /^-(asc|desc)$/, keys %$arg
1631 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1635 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1637 map $self->expand_expr($_, -ident),
1638 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1639 return undef unless @exp;
1640 return undef if @exp == 1 and not defined($exp[0]);
1641 return +{ -op => [ ',', @exp ] };
1644 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1646 return $self->$expander(undef, $arg);
1650 my ($self, $arg) = @_;
1652 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1654 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1656 return '' unless length($sql);
1658 my $final_sql = $self->_sqlcase(' order by ').$sql;
1660 return ($final_sql, @bind);
1663 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1665 sub _order_by_chunks {
1666 my ($self, $arg) = @_;
1668 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1670 my @res = $self->_chunkify_order_by($expanded);
1671 (ref() ? $_->[0] : $_) .= '' for @res;
1675 sub _chunkify_order_by {
1676 my ($self, $expanded) = @_;
1678 return grep length, @{ $self->render_aqt($expanded) }
1679 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1682 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1683 my ($comma, @list) = @{$_->{-op}};
1684 return map $self->_chunkify_order_by($_), @list;
1686 return $self->render_aqt($_);
1690 #======================================================================
1691 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1692 #======================================================================
1698 $self->expand_maybe_list_expr($from, -ident)
1703 #======================================================================
1705 #======================================================================
1707 sub expand_maybe_list_expr {
1708 my ($self, $expr, $default) = @_;
1710 ',', map $self->expand_expr($_, $default),
1711 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1712 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1713 return +{ -op => [ ',',
1714 map $self->expand_expr($_, $default),
1715 ref($expr) eq 'ARRAY' ? @$expr : $expr
1719 # highly optimized, as it's called way too often
1721 # my ($self, $label) = @_;
1723 return '' unless defined $_[1];
1724 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1725 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1727 unless ($_[0]->{quote_char}) {
1728 if (ref($_[1]) eq 'ARRAY') {
1729 return join($_[0]->{name_sep}||'.', @{$_[1]});
1731 $_[0]->_assert_pass_injection_guard($_[1]);
1736 my $qref = ref $_[0]->{quote_char};
1738 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1739 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1740 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1742 my $esc = $_[0]->{escape_char} || $r;
1744 # parts containing * are naturally unquoted
1746 $_[0]->{name_sep}||'',
1750 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1752 (ref($_[1]) eq 'ARRAY'
1756 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1764 # Conversion, if applicable
1766 #my ($self, $arg) = @_;
1767 if (my $conv = $_[0]->{convert_where}) {
1768 return @{ $_[0]->join_query_parts('',
1769 $_[0]->format_keyword($conv),
1778 #my ($self, $col, @vals) = @_;
1779 # called often - tighten code
1780 return $_[0]->{bindtype} eq 'columns'
1781 ? map {[$_[1], $_]} @_[2 .. $#_]
1786 # Dies if any element of @bind is not in [colname => value] format
1787 # if bindtype is 'columns'.
1788 sub _assert_bindval_matches_bindtype {
1789 # my ($self, @bind) = @_;
1791 if ($self->{bindtype} eq 'columns') {
1793 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1794 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1800 sub _join_sql_clauses {
1801 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1803 if (@$clauses_aref > 1) {
1804 my $join = " " . $self->_sqlcase($logic) . " ";
1805 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1806 return ($sql, @$bind_aref);
1808 elsif (@$clauses_aref) {
1809 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1812 return (); # if no SQL, ignore @$bind_aref
1817 # Fix SQL case, if so requested
1819 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1820 # don't touch the argument ... crooked logic, but let's not change it!
1821 return $_[0]->{case} ? $_[1] : uc($_[1]);
1824 sub format_keyword { $_[0]->_sqlcase(join ' ', split '_', $_[1]) }
1826 #======================================================================
1827 # DISPATCHING FROM REFKIND
1828 #======================================================================
1831 my ($self, $data) = @_;
1833 return 'UNDEF' unless defined $data;
1835 # blessed objects are treated like scalars
1836 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1838 return 'SCALAR' unless $ref;
1841 while ($ref eq 'REF') {
1843 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1847 return ($ref||'SCALAR') . ('REF' x $n_steps);
1851 my ($self, $data) = @_;
1852 my @try = ($self->_refkind($data));
1853 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1854 push @try, 'FALLBACK';
1858 sub _METHOD_FOR_refkind {
1859 my ($self, $meth_prefix, $data) = @_;
1862 for (@{$self->_try_refkind($data)}) {
1863 $method = $self->can($meth_prefix."_".$_)
1867 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1871 sub _SWITCH_refkind {
1872 my ($self, $data, $dispatch_table) = @_;
1875 for (@{$self->_try_refkind($data)}) {
1876 $coderef = $dispatch_table->{$_}
1880 puke "no dispatch entry for ".$self->_refkind($data)
1889 #======================================================================
1890 # VALUES, GENERATE, AUTOLOAD
1891 #======================================================================
1893 # LDNOTE: original code from nwiger, didn't touch code in that section
1894 # I feel the AUTOLOAD stuff should not be the default, it should
1895 # only be activated on explicit demand by user.
1899 my $data = shift || return;
1900 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1901 unless ref $data eq 'HASH';
1904 foreach my $k (sort keys %$data) {
1905 my $v = $data->{$k};
1906 $self->_SWITCH_refkind($v, {
1908 if ($self->{array_datatypes}) { # array datatype
1909 push @all_bind, $self->_bindtype($k, $v);
1911 else { # literal SQL with bind
1912 my ($sql, @bind) = @$v;
1913 $self->_assert_bindval_matches_bindtype(@bind);
1914 push @all_bind, @bind;
1917 ARRAYREFREF => sub { # literal SQL with bind
1918 my ($sql, @bind) = @${$v};
1919 $self->_assert_bindval_matches_bindtype(@bind);
1920 push @all_bind, @bind;
1922 SCALARREF => sub { # literal SQL without bind
1924 SCALAR_or_UNDEF => sub {
1925 push @all_bind, $self->_bindtype($k, $v);
1936 my(@sql, @sqlq, @sqlv);
1940 if ($ref eq 'HASH') {
1941 for my $k (sort keys %$_) {
1944 my $label = $self->_quote($k);
1945 if ($r eq 'ARRAY') {
1946 # literal SQL with bind
1947 my ($sql, @bind) = @$v;
1948 $self->_assert_bindval_matches_bindtype(@bind);
1949 push @sqlq, "$label = $sql";
1951 } elsif ($r eq 'SCALAR') {
1952 # literal SQL without bind
1953 push @sqlq, "$label = $$v";
1955 push @sqlq, "$label = ?";
1956 push @sqlv, $self->_bindtype($k, $v);
1959 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1960 } elsif ($ref eq 'ARRAY') {
1961 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1964 if ($r eq 'ARRAY') { # literal SQL with bind
1965 my ($sql, @bind) = @$v;
1966 $self->_assert_bindval_matches_bindtype(@bind);
1969 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1970 # embedded literal SQL
1977 push @sql, '(' . join(', ', @sqlq) . ')';
1978 } elsif ($ref eq 'SCALAR') {
1982 # strings get case twiddled
1983 push @sql, $self->_sqlcase($_);
1987 my $sql = join ' ', @sql;
1989 # this is pretty tricky
1990 # if ask for an array, return ($stmt, @bind)
1991 # otherwise, s/?/shift @sqlv/ to put it inline
1993 return ($sql, @sqlv);
1995 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1996 ref $d ? $d->[1] : $d/e;
2005 # This allows us to check for a local, then _form, attr
2007 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2008 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2009 return $self->generate($name, @_);
2020 SQL::Abstract - Generate SQL from Perl data structures
2026 my $sql = SQL::Abstract->new;
2028 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2030 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2032 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2034 my($stmt, @bind) = $sql->delete($table, \%where);
2036 # Then, use these in your DBI statements
2037 my $sth = $dbh->prepare($stmt);
2038 $sth->execute(@bind);
2040 # Just generate the WHERE clause
2041 my($stmt, @bind) = $sql->where(\%where, $order);
2043 # Return values in the same order, for hashed queries
2044 # See PERFORMANCE section for more details
2045 my @bind = $sql->values(\%fieldvals);
2049 This module was inspired by the excellent L<DBIx::Abstract>.
2050 However, in using that module I found that what I really wanted
2051 to do was generate SQL, but still retain complete control over my
2052 statement handles and use the DBI interface. So, I set out to
2053 create an abstract SQL generation module.
2055 While based on the concepts used by L<DBIx::Abstract>, there are
2056 several important differences, especially when it comes to WHERE
2057 clauses. I have modified the concepts used to make the SQL easier
2058 to generate from Perl data structures and, IMO, more intuitive.
2059 The underlying idea is for this module to do what you mean, based
2060 on the data structures you provide it. The big advantage is that
2061 you don't have to modify your code every time your data changes,
2062 as this module figures it out.
2064 To begin with, an SQL INSERT is as easy as just specifying a hash
2065 of C<key=value> pairs:
2068 name => 'Jimbo Bobson',
2069 phone => '123-456-7890',
2070 address => '42 Sister Lane',
2071 city => 'St. Louis',
2072 state => 'Louisiana',
2075 The SQL can then be generated with this:
2077 my($stmt, @bind) = $sql->insert('people', \%data);
2079 Which would give you something like this:
2081 $stmt = "INSERT INTO people
2082 (address, city, name, phone, state)
2083 VALUES (?, ?, ?, ?, ?)";
2084 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2085 '123-456-7890', 'Louisiana');
2087 These are then used directly in your DBI code:
2089 my $sth = $dbh->prepare($stmt);
2090 $sth->execute(@bind);
2092 =head2 Inserting and Updating Arrays
2094 If your database has array types (like for example Postgres),
2095 activate the special option C<< array_datatypes => 1 >>
2096 when creating the C<SQL::Abstract> object.
2097 Then you may use an arrayref to insert and update database array types:
2099 my $sql = SQL::Abstract->new(array_datatypes => 1);
2101 planets => [qw/Mercury Venus Earth Mars/]
2104 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2108 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2110 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2113 =head2 Inserting and Updating SQL
2115 In order to apply SQL functions to elements of your C<%data> you may
2116 specify a reference to an arrayref for the given hash value. For example,
2117 if you need to execute the Oracle C<to_date> function on a value, you can
2118 say something like this:
2122 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2125 The first value in the array is the actual SQL. Any other values are
2126 optional and would be included in the bind values array. This gives
2129 my($stmt, @bind) = $sql->insert('people', \%data);
2131 $stmt = "INSERT INTO people (name, date_entered)
2132 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2133 @bind = ('Bill', '03/02/2003');
2135 An UPDATE is just as easy, all you change is the name of the function:
2137 my($stmt, @bind) = $sql->update('people', \%data);
2139 Notice that your C<%data> isn't touched; the module will generate
2140 the appropriately quirky SQL for you automatically. Usually you'll
2141 want to specify a WHERE clause for your UPDATE, though, which is
2142 where handling C<%where> hashes comes in handy...
2144 =head2 Complex where statements
2146 This module can generate pretty complicated WHERE statements
2147 easily. For example, simple C<key=value> pairs are taken to mean
2148 equality, and if you want to see if a field is within a set
2149 of values, you can use an arrayref. Let's say we wanted to
2150 SELECT some data based on this criteria:
2153 requestor => 'inna',
2154 worker => ['nwiger', 'rcwe', 'sfz'],
2155 status => { '!=', 'completed' }
2158 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2160 The above would give you something like this:
2162 $stmt = "SELECT * FROM tickets WHERE
2163 ( requestor = ? ) AND ( status != ? )
2164 AND ( worker = ? OR worker = ? OR worker = ? )";
2165 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2167 Which you could then use in DBI code like so:
2169 my $sth = $dbh->prepare($stmt);
2170 $sth->execute(@bind);
2176 The methods are simple. There's one for every major SQL operation,
2177 and a constructor you use first. The arguments are specified in a
2178 similar order for each method (table, then fields, then a where
2179 clause) to try and simplify things.
2181 =head2 new(option => 'value')
2183 The C<new()> function takes a list of options and values, and returns
2184 a new B<SQL::Abstract> object which can then be used to generate SQL
2185 through the methods below. The options accepted are:
2191 If set to 'lower', then SQL will be generated in all lowercase. By
2192 default SQL is generated in "textbook" case meaning something like:
2194 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2196 Any setting other than 'lower' is ignored.
2200 This determines what the default comparison operator is. By default
2201 it is C<=>, meaning that a hash like this:
2203 %where = (name => 'nwiger', email => 'nate@wiger.org');
2205 Will generate SQL like this:
2207 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2209 However, you may want loose comparisons by default, so if you set
2210 C<cmp> to C<like> you would get SQL such as:
2212 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2214 You can also override the comparison on an individual basis - see
2215 the huge section on L</"WHERE CLAUSES"> at the bottom.
2217 =item sqltrue, sqlfalse
2219 Expressions for inserting boolean values within SQL statements.
2220 By default these are C<1=1> and C<1=0>. They are used
2221 by the special operators C<-in> and C<-not_in> for generating
2222 correct SQL even when the argument is an empty array (see below).
2226 This determines the default logical operator for multiple WHERE
2227 statements in arrays or hashes. If absent, the default logic is "or"
2228 for arrays, and "and" for hashes. This means that a WHERE
2232 event_date => {'>=', '2/13/99'},
2233 event_date => {'<=', '4/24/03'},
2236 will generate SQL like this:
2238 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2240 This is probably not what you want given this query, though (look
2241 at the dates). To change the "OR" to an "AND", simply specify:
2243 my $sql = SQL::Abstract->new(logic => 'and');
2245 Which will change the above C<WHERE> to:
2247 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2249 The logic can also be changed locally by inserting
2250 a modifier in front of an arrayref:
2252 @where = (-and => [event_date => {'>=', '2/13/99'},
2253 event_date => {'<=', '4/24/03'} ]);
2255 See the L</"WHERE CLAUSES"> section for explanations.
2259 This will automatically convert comparisons using the specified SQL
2260 function for both column and value. This is mostly used with an argument
2261 of C<upper> or C<lower>, so that the SQL will have the effect of
2262 case-insensitive "searches". For example, this:
2264 $sql = SQL::Abstract->new(convert => 'upper');
2265 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2267 Will turn out the following SQL:
2269 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2271 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2272 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2273 not validate this option; it will just pass through what you specify verbatim).
2277 This is a kludge because many databases suck. For example, you can't
2278 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2279 Instead, you have to use C<bind_param()>:
2281 $sth->bind_param(1, 'reg data');
2282 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2284 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2285 which loses track of which field each slot refers to. Fear not.
2287 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2288 Currently, you can specify either C<normal> (default) or C<columns>. If you
2289 specify C<columns>, you will get an array that looks like this:
2291 my $sql = SQL::Abstract->new(bindtype => 'columns');
2292 my($stmt, @bind) = $sql->insert(...);
2295 [ 'column1', 'value1' ],
2296 [ 'column2', 'value2' ],
2297 [ 'column3', 'value3' ],
2300 You can then iterate through this manually, using DBI's C<bind_param()>.
2302 $sth->prepare($stmt);
2305 my($col, $data) = @$_;
2306 if ($col eq 'details' || $col eq 'comments') {
2307 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2308 } elsif ($col eq 'image') {
2309 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2311 $sth->bind_param($i, $data);
2315 $sth->execute; # execute without @bind now
2317 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2318 Basically, the advantage is still that you don't have to care which fields
2319 are or are not included. You could wrap that above C<for> loop in a simple
2320 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2321 get a layer of abstraction over manual SQL specification.
2323 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2324 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2325 will expect the bind values in this format.
2329 This is the character that a table or column name will be quoted
2330 with. By default this is an empty string, but you could set it to
2331 the character C<`>, to generate SQL like this:
2333 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2335 Alternatively, you can supply an array ref of two items, the first being the left
2336 hand quote character, and the second the right hand quote character. For
2337 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2338 that generates SQL like this:
2340 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2342 Quoting is useful if you have tables or columns names that are reserved
2343 words in your database's SQL dialect.
2347 This is the character that will be used to escape L</quote_char>s appearing
2348 in an identifier before it has been quoted.
2350 The parameter default in case of a single L</quote_char> character is the quote
2353 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2354 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2355 of the B<opening (left)> L</quote_char> within the identifier are currently left
2356 untouched. The default for opening-closing-style quotes may change in future
2357 versions, thus you are B<strongly encouraged> to specify the escape character
2362 This is the character that separates a table and column name. It is
2363 necessary to specify this when the C<quote_char> option is selected,
2364 so that tables and column names can be individually quoted like this:
2366 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2368 =item injection_guard
2370 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2371 column name specified in a query structure. This is a safety mechanism to avoid
2372 injection attacks when mishandling user input e.g.:
2374 my %condition_as_column_value_pairs = get_values_from_user();
2375 $sqla->select( ... , \%condition_as_column_value_pairs );
2377 If the expression matches an exception is thrown. Note that literal SQL
2378 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2380 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2382 =item array_datatypes
2384 When this option is true, arrayrefs in INSERT or UPDATE are
2385 interpreted as array datatypes and are passed directly
2387 When this option is false, arrayrefs are interpreted
2388 as literal SQL, just like refs to arrayrefs
2389 (but this behavior is for backwards compatibility; when writing
2390 new queries, use the "reference to arrayref" syntax
2396 Takes a reference to a list of "special operators"
2397 to extend the syntax understood by L<SQL::Abstract>.
2398 See section L</"SPECIAL OPERATORS"> for details.
2402 Takes a reference to a list of "unary operators"
2403 to extend the syntax understood by L<SQL::Abstract>.
2404 See section L</"UNARY OPERATORS"> for details.
2410 =head2 insert($table, \@values || \%fieldvals, \%options)
2412 This is the simplest function. You simply give it a table name
2413 and either an arrayref of values or hashref of field/value pairs.
2414 It returns an SQL INSERT statement and a list of bind values.
2415 See the sections on L</"Inserting and Updating Arrays"> and
2416 L</"Inserting and Updating SQL"> for information on how to insert
2417 with those data types.
2419 The optional C<\%options> hash reference may contain additional
2420 options to generate the insert SQL. Currently supported options
2427 Takes either a scalar of raw SQL fields, or an array reference of
2428 field names, and adds on an SQL C<RETURNING> statement at the end.
2429 This allows you to return data generated by the insert statement
2430 (such as row IDs) without performing another C<SELECT> statement.
2431 Note, however, this is not part of the SQL standard and may not
2432 be supported by all database engines.
2436 =head2 update($table, \%fieldvals, \%where, \%options)
2438 This takes a table, hashref of field/value pairs, and an optional
2439 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2441 See the sections on L</"Inserting and Updating Arrays"> and
2442 L</"Inserting and Updating SQL"> for information on how to insert
2443 with those data types.
2445 The optional C<\%options> hash reference may contain additional
2446 options to generate the update SQL. Currently supported options
2453 See the C<returning> option to
2454 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2458 =head2 select($source, $fields, $where, $order)
2460 This returns a SQL SELECT statement and associated list of bind values, as
2461 specified by the arguments:
2467 Specification of the 'FROM' part of the statement.
2468 The argument can be either a plain scalar (interpreted as a table
2469 name, will be quoted), or an arrayref (interpreted as a list
2470 of table names, joined by commas, quoted), or a scalarref
2471 (literal SQL, not quoted).
2475 Specification of the list of fields to retrieve from
2477 The argument can be either an arrayref (interpreted as a list
2478 of field names, will be joined by commas and quoted), or a
2479 plain scalar (literal SQL, not quoted).
2480 Please observe that this API is not as flexible as that of
2481 the first argument C<$source>, for backwards compatibility reasons.
2485 Optional argument to specify the WHERE part of the query.
2486 The argument is most often a hashref, but can also be
2487 an arrayref or plain scalar --
2488 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2492 Optional argument to specify the ORDER BY part of the query.
2493 The argument can be a scalar, a hashref or an arrayref
2494 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2500 =head2 delete($table, \%where, \%options)
2502 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2503 It returns an SQL DELETE statement and list of bind values.
2505 The optional C<\%options> hash reference may contain additional
2506 options to generate the delete SQL. Currently supported options
2513 See the C<returning> option to
2514 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2518 =head2 where(\%where, $order)
2520 This is used to generate just the WHERE clause. For example,
2521 if you have an arbitrary data structure and know what the
2522 rest of your SQL is going to look like, but want an easy way
2523 to produce a WHERE clause, use this. It returns an SQL WHERE
2524 clause and list of bind values.
2527 =head2 values(\%data)
2529 This just returns the values from the hash C<%data>, in the same
2530 order that would be returned from any of the other above queries.
2531 Using this allows you to markedly speed up your queries if you
2532 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2534 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2536 Warning: This is an experimental method and subject to change.
2538 This returns arbitrarily generated SQL. It's a really basic shortcut.
2539 It will return two different things, depending on return context:
2541 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2542 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2544 These would return the following:
2546 # First calling form
2547 $stmt = "CREATE TABLE test (?, ?)";
2548 @bind = (field1, field2);
2550 # Second calling form
2551 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2553 Depending on what you're trying to do, it's up to you to choose the correct
2554 format. In this example, the second form is what you would want.
2558 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2562 ALTER SESSION SET nls_date_format = 'MM/YY'
2564 You get the idea. Strings get their case twiddled, but everything
2565 else remains verbatim.
2567 =head1 EXPORTABLE FUNCTIONS
2569 =head2 is_plain_value
2571 Determines if the supplied argument is a plain value as understood by this
2576 =item * The value is C<undef>
2578 =item * The value is a non-reference
2580 =item * The value is an object with stringification overloading
2582 =item * The value is of the form C<< { -value => $anything } >>
2586 On failure returns C<undef>, on success returns a B<scalar> reference
2587 to the original supplied argument.
2593 The stringification overloading detection is rather advanced: it takes
2594 into consideration not only the presence of a C<""> overload, but if that
2595 fails also checks for enabled
2596 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2597 on either C<0+> or C<bool>.
2599 Unfortunately testing in the field indicates that this
2600 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2601 but only when very large numbers of stringifying objects are involved.
2602 At the time of writing ( Sep 2014 ) there is no clear explanation of
2603 the direct cause, nor is there a manageably small test case that reliably
2604 reproduces the problem.
2606 If you encounter any of the following exceptions in B<random places within
2607 your application stack> - this module may be to blame:
2609 Operation "ne": no method found,
2610 left argument in overloaded package <something>,
2611 right argument in overloaded package <something>
2615 Stub found while resolving method "???" overloading """" in package <something>
2617 If you fall victim to the above - please attempt to reduce the problem
2618 to something that could be sent to the L<SQL::Abstract developers
2619 |DBIx::Class/GETTING HELP/SUPPORT>
2620 (either publicly or privately). As a workaround in the meantime you can
2621 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2622 value, which will most likely eliminate your problem (at the expense of
2623 not being able to properly detect exotic forms of stringification).
2625 This notice and environment variable will be removed in a future version,
2626 as soon as the underlying problem is found and a reliable workaround is
2631 =head2 is_literal_value
2633 Determines if the supplied argument is a literal value as understood by this
2638 =item * C<\$sql_string>
2640 =item * C<\[ $sql_string, @bind_values ]>
2644 On failure returns C<undef>, on success returns an B<array> reference
2645 containing the unpacked version of the supplied literal SQL and bind values.
2647 =head1 WHERE CLAUSES
2651 This module uses a variation on the idea from L<DBIx::Abstract>. It
2652 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2653 module is that things in arrays are OR'ed, and things in hashes
2656 The easiest way to explain is to show lots of examples. After
2657 each C<%where> hash shown, it is assumed you used:
2659 my($stmt, @bind) = $sql->where(\%where);
2661 However, note that the C<%where> hash can be used directly in any
2662 of the other functions as well, as described above.
2664 =head2 Key-value pairs
2666 So, let's get started. To begin, a simple hash:
2670 status => 'completed'
2673 Is converted to SQL C<key = val> statements:
2675 $stmt = "WHERE user = ? AND status = ?";
2676 @bind = ('nwiger', 'completed');
2678 One common thing I end up doing is having a list of values that
2679 a field can be in. To do this, simply specify a list inside of
2684 status => ['assigned', 'in-progress', 'pending'];
2687 This simple code will create the following:
2689 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2690 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2692 A field associated to an empty arrayref will be considered a
2693 logical false and will generate 0=1.
2695 =head2 Tests for NULL values
2697 If the value part is C<undef> then this is converted to SQL <IS NULL>
2706 $stmt = "WHERE user = ? AND status IS NULL";
2709 To test if a column IS NOT NULL:
2713 status => { '!=', undef },
2716 =head2 Specific comparison operators
2718 If you want to specify a different type of operator for your comparison,
2719 you can use a hashref for a given column:
2723 status => { '!=', 'completed' }
2726 Which would generate:
2728 $stmt = "WHERE user = ? AND status != ?";
2729 @bind = ('nwiger', 'completed');
2731 To test against multiple values, just enclose the values in an arrayref:
2733 status => { '=', ['assigned', 'in-progress', 'pending'] };
2735 Which would give you:
2737 "WHERE status = ? OR status = ? OR status = ?"
2740 The hashref can also contain multiple pairs, in which case it is expanded
2741 into an C<AND> of its elements:
2745 status => { '!=', 'completed', -not_like => 'pending%' }
2748 # Or more dynamically, like from a form
2749 $where{user} = 'nwiger';
2750 $where{status}{'!='} = 'completed';
2751 $where{status}{'-not_like'} = 'pending%';
2753 # Both generate this
2754 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2755 @bind = ('nwiger', 'completed', 'pending%');
2758 To get an OR instead, you can combine it with the arrayref idea:
2762 priority => [ { '=', 2 }, { '>', 5 } ]
2765 Which would generate:
2767 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2768 @bind = ('2', '5', 'nwiger');
2770 If you want to include literal SQL (with or without bind values), just use a
2771 scalar reference or reference to an arrayref as the value:
2774 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2775 date_expires => { '<' => \"now()" }
2778 Which would generate:
2780 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2781 @bind = ('11/26/2008');
2784 =head2 Logic and nesting operators
2786 In the example above,
2787 there is a subtle trap if you want to say something like
2788 this (notice the C<AND>):
2790 WHERE priority != ? AND priority != ?
2792 Because, in Perl you I<can't> do this:
2794 priority => { '!=' => 2, '!=' => 1 }
2796 As the second C<!=> key will obliterate the first. The solution
2797 is to use the special C<-modifier> form inside an arrayref:
2799 priority => [ -and => {'!=', 2},
2803 Normally, these would be joined by C<OR>, but the modifier tells it
2804 to use C<AND> instead. (Hint: You can use this in conjunction with the
2805 C<logic> option to C<new()> in order to change the way your queries
2806 work by default.) B<Important:> Note that the C<-modifier> goes
2807 B<INSIDE> the arrayref, as an extra first element. This will
2808 B<NOT> do what you think it might:
2810 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2812 Here is a quick list of equivalencies, since there is some overlap:
2815 status => {'!=', 'completed', 'not like', 'pending%' }
2816 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2819 status => {'=', ['assigned', 'in-progress']}
2820 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2821 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2825 =head2 Special operators: IN, BETWEEN, etc.
2827 You can also use the hashref format to compare a list of fields using the
2828 C<IN> comparison operator, by specifying the list as an arrayref:
2831 status => 'completed',
2832 reportid => { -in => [567, 2335, 2] }
2835 Which would generate:
2837 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2838 @bind = ('completed', '567', '2335', '2');
2840 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2843 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2844 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2845 'sqltrue' (by default: C<1=1>).
2847 In addition to the array you can supply a chunk of literal sql or
2848 literal sql with bind:
2851 customer => { -in => \[
2852 'SELECT cust_id FROM cust WHERE balance > ?',
2855 status => { -in => \'SELECT status_codes FROM states' },
2861 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2862 AND status IN ( SELECT status_codes FROM states )
2866 Finally, if the argument to C<-in> is not a reference, it will be
2867 treated as a single-element array.
2869 Another pair of operators is C<-between> and C<-not_between>,
2870 used with an arrayref of two values:
2874 completion_date => {
2875 -not_between => ['2002-10-01', '2003-02-06']
2881 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2883 Just like with C<-in> all plausible combinations of literal SQL
2887 start0 => { -between => [ 1, 2 ] },
2888 start1 => { -between => \["? AND ?", 1, 2] },
2889 start2 => { -between => \"lower(x) AND upper(y)" },
2890 start3 => { -between => [
2892 \["upper(?)", 'stuff' ],
2899 ( start0 BETWEEN ? AND ? )
2900 AND ( start1 BETWEEN ? AND ? )
2901 AND ( start2 BETWEEN lower(x) AND upper(y) )
2902 AND ( start3 BETWEEN lower(x) AND upper(?) )
2904 @bind = (1, 2, 1, 2, 'stuff');
2907 These are the two builtin "special operators"; but the
2908 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2910 =head2 Unary operators: bool
2912 If you wish to test against boolean columns or functions within your
2913 database you can use the C<-bool> and C<-not_bool> operators. For
2914 example to test the column C<is_user> being true and the column
2915 C<is_enabled> being false you would use:-
2919 -not_bool => 'is_enabled',
2924 WHERE is_user AND NOT is_enabled
2926 If a more complex combination is required, testing more conditions,
2927 then you should use the and/or operators:-
2932 -not_bool => { two=> { -rlike => 'bar' } },
2933 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2944 (NOT ( three = ? OR three > ? ))
2947 =head2 Nested conditions, -and/-or prefixes
2949 So far, we've seen how multiple conditions are joined with a top-level
2950 C<AND>. We can change this by putting the different conditions we want in
2951 hashes and then putting those hashes in an array. For example:
2956 status => { -like => ['pending%', 'dispatched'] },
2960 status => 'unassigned',
2964 This data structure would create the following:
2966 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2967 OR ( user = ? AND status = ? ) )";
2968 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2971 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2972 to change the logic inside:
2978 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2979 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2986 $stmt = "WHERE ( user = ?
2987 AND ( ( workhrs > ? AND geo = ? )
2988 OR ( workhrs < ? OR geo = ? ) ) )";
2989 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2991 =head3 Algebraic inconsistency, for historical reasons
2993 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2994 operator goes C<outside> of the nested structure; whereas when connecting
2995 several constraints on one column, the C<-and> operator goes
2996 C<inside> the arrayref. Here is an example combining both features:
2999 -and => [a => 1, b => 2],
3000 -or => [c => 3, d => 4],
3001 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3006 WHERE ( ( ( a = ? AND b = ? )
3007 OR ( c = ? OR d = ? )
3008 OR ( e LIKE ? AND e LIKE ? ) ) )
3010 This difference in syntax is unfortunate but must be preserved for
3011 historical reasons. So be careful: the two examples below would
3012 seem algebraically equivalent, but they are not
3015 { -like => 'foo%' },
3016 { -like => '%bar' },
3018 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3021 { col => { -like => 'foo%' } },
3022 { col => { -like => '%bar' } },
3024 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3027 =head2 Literal SQL and value type operators
3029 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3030 side" is a column name and the "right side" is a value (normally rendered as
3031 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3032 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3033 alter this behavior. There are several ways of doing so.
3037 This is a virtual operator that signals the string to its right side is an
3038 identifier (a column name) and not a value. For example to compare two
3039 columns you would write:
3042 priority => { '<', 2 },
3043 requestor => { -ident => 'submitter' },
3048 $stmt = "WHERE priority < ? AND requestor = submitter";
3051 If you are maintaining legacy code you may see a different construct as
3052 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3057 This is a virtual operator that signals that the construct to its right side
3058 is a value to be passed to DBI. This is for example necessary when you want
3059 to write a where clause against an array (for RDBMS that support such
3060 datatypes). For example:
3063 array => { -value => [1, 2, 3] }
3068 $stmt = 'WHERE array = ?';
3069 @bind = ([1, 2, 3]);
3071 Note that if you were to simply say:
3077 the result would probably not be what you wanted:
3079 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3084 Finally, sometimes only literal SQL will do. To include a random snippet
3085 of SQL verbatim, you specify it as a scalar reference. Consider this only
3086 as a last resort. Usually there is a better way. For example:
3089 priority => { '<', 2 },
3090 requestor => { -in => \'(SELECT name FROM hitmen)' },
3095 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3098 Note that in this example, you only get one bind parameter back, since
3099 the verbatim SQL is passed as part of the statement.
3103 Never use untrusted input as a literal SQL argument - this is a massive
3104 security risk (there is no way to check literal snippets for SQL
3105 injections and other nastyness). If you need to deal with untrusted input
3106 use literal SQL with placeholders as described next.
3108 =head3 Literal SQL with placeholders and bind values (subqueries)
3110 If the literal SQL to be inserted has placeholders and bind values,
3111 use a reference to an arrayref (yes this is a double reference --
3112 not so common, but perfectly legal Perl). For example, to find a date
3113 in Postgres you can use something like this:
3116 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3121 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3124 Note that you must pass the bind values in the same format as they are returned
3125 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3126 to C<columns>, you must provide the bind values in the
3127 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3128 scalar value; most commonly the column name, but you can use any scalar value
3129 (including references and blessed references), L<SQL::Abstract> will simply
3130 pass it through intact. So if C<bindtype> is set to C<columns> the above
3131 example will look like:
3134 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3137 Literal SQL is especially useful for nesting parenthesized clauses in the
3138 main SQL query. Here is a first example:
3140 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3144 bar => \["IN ($sub_stmt)" => @sub_bind],
3149 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3150 WHERE c2 < ? AND c3 LIKE ?))";
3151 @bind = (1234, 100, "foo%");
3153 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3154 are expressed in the same way. Of course the C<$sub_stmt> and
3155 its associated bind values can be generated through a former call
3158 my ($sub_stmt, @sub_bind)
3159 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3160 c3 => {-like => "foo%"}});
3163 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3166 In the examples above, the subquery was used as an operator on a column;
3167 but the same principle also applies for a clause within the main C<%where>
3168 hash, like an EXISTS subquery:
3170 my ($sub_stmt, @sub_bind)
3171 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3172 my %where = ( -and => [
3174 \["EXISTS ($sub_stmt)" => @sub_bind],
3179 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3180 WHERE c1 = ? AND c2 > t0.c0))";
3184 Observe that the condition on C<c2> in the subquery refers to
3185 column C<t0.c0> of the main query: this is I<not> a bind
3186 value, so we have to express it through a scalar ref.
3187 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3188 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3189 what we wanted here.
3191 Finally, here is an example where a subquery is used
3192 for expressing unary negation:
3194 my ($sub_stmt, @sub_bind)
3195 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3196 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3198 lname => {like => '%son%'},
3199 \["NOT ($sub_stmt)" => @sub_bind],
3204 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3205 @bind = ('%son%', 10, 20)
3207 =head3 Deprecated usage of Literal SQL
3209 Below are some examples of archaic use of literal SQL. It is shown only as
3210 reference for those who deal with legacy code. Each example has a much
3211 better, cleaner and safer alternative that users should opt for in new code.
3217 my %where = ( requestor => \'IS NOT NULL' )
3219 $stmt = "WHERE requestor IS NOT NULL"
3221 This used to be the way of generating NULL comparisons, before the handling
3222 of C<undef> got formalized. For new code please use the superior syntax as
3223 described in L</Tests for NULL values>.
3227 my %where = ( requestor => \'= submitter' )
3229 $stmt = "WHERE requestor = submitter"
3231 This used to be the only way to compare columns. Use the superior L</-ident>
3232 method for all new code. For example an identifier declared in such a way
3233 will be properly quoted if L</quote_char> is properly set, while the legacy
3234 form will remain as supplied.
3238 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3240 $stmt = "WHERE completed > ? AND is_ready"
3241 @bind = ('2012-12-21')
3243 Using an empty string literal used to be the only way to express a boolean.
3244 For all new code please use the much more readable
3245 L<-bool|/Unary operators: bool> operator.
3251 These pages could go on for a while, since the nesting of the data
3252 structures this module can handle are pretty much unlimited (the
3253 module implements the C<WHERE> expansion as a recursive function
3254 internally). Your best bet is to "play around" with the module a
3255 little to see how the data structures behave, and choose the best
3256 format for your data based on that.
3258 And of course, all the values above will probably be replaced with
3259 variables gotten from forms or the command line. After all, if you
3260 knew everything ahead of time, you wouldn't have to worry about
3261 dynamically-generating SQL and could just hardwire it into your
3264 =head1 ORDER BY CLAUSES
3266 Some functions take an order by clause. This can either be a scalar (just a
3267 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3268 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3271 Given | Will Generate
3272 ---------------------------------------------------------------
3274 'colA' | ORDER BY colA
3276 [qw/colA colB/] | ORDER BY colA, colB
3278 {-asc => 'colA'} | ORDER BY colA ASC
3280 {-desc => 'colB'} | ORDER BY colB DESC
3282 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3284 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3286 \'colA DESC' | ORDER BY colA DESC
3288 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3289 | /* ...with $x bound to ? */
3292 { -asc => 'colA' }, | colA ASC,
3293 { -desc => [qw/colB/] }, | colB DESC,
3294 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3295 \'colE DESC', | colE DESC,
3296 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3297 ] | /* ...with $x bound to ? */
3298 ===============================================================
3302 =head1 SPECIAL OPERATORS
3304 my $sqlmaker = SQL::Abstract->new(special_ops => [
3308 my ($self, $field, $op, $arg) = @_;
3314 handler => 'method_name',
3318 A "special operator" is a SQL syntactic clause that can be
3319 applied to a field, instead of a usual binary operator.
3322 WHERE field IN (?, ?, ?)
3323 WHERE field BETWEEN ? AND ?
3324 WHERE MATCH(field) AGAINST (?, ?)
3326 Special operators IN and BETWEEN are fairly standard and therefore
3327 are builtin within C<SQL::Abstract> (as the overridable methods
3328 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3329 like the MATCH .. AGAINST example above which is specific to MySQL,
3330 you can write your own operator handlers - supply a C<special_ops>
3331 argument to the C<new> method. That argument takes an arrayref of
3332 operator definitions; each operator definition is a hashref with two
3339 the regular expression to match the operator
3343 Either a coderef or a plain scalar method name. In both cases
3344 the expected return is C<< ($sql, @bind) >>.
3346 When supplied with a method name, it is simply called on the
3347 L<SQL::Abstract> object as:
3349 $self->$method_name($field, $op, $arg)
3353 $field is the LHS of the operator
3354 $op is the part that matched the handler regex
3357 When supplied with a coderef, it is called as:
3359 $coderef->($self, $field, $op, $arg)
3364 For example, here is an implementation
3365 of the MATCH .. AGAINST syntax for MySQL
3367 my $sqlmaker = SQL::Abstract->new(special_ops => [
3369 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3370 {regex => qr/^match$/i,
3372 my ($self, $field, $op, $arg) = @_;
3373 $arg = [$arg] if not ref $arg;
3374 my $label = $self->_quote($field);
3375 my ($placeholder) = $self->_convert('?');
3376 my $placeholders = join ", ", (($placeholder) x @$arg);
3377 my $sql = $self->_sqlcase('match') . " ($label) "
3378 . $self->_sqlcase('against') . " ($placeholders) ";
3379 my @bind = $self->_bindtype($field, @$arg);
3380 return ($sql, @bind);
3387 =head1 UNARY OPERATORS
3389 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3393 my ($self, $op, $arg) = @_;
3399 handler => 'method_name',
3403 A "unary operator" is a SQL syntactic clause that can be
3404 applied to a field - the operator goes before the field
3406 You can write your own operator handlers - supply a C<unary_ops>
3407 argument to the C<new> method. That argument takes an arrayref of
3408 operator definitions; each operator definition is a hashref with two
3415 the regular expression to match the operator
3419 Either a coderef or a plain scalar method name. In both cases
3420 the expected return is C<< $sql >>.
3422 When supplied with a method name, it is simply called on the
3423 L<SQL::Abstract> object as:
3425 $self->$method_name($op, $arg)
3429 $op is the part that matched the handler regex
3430 $arg is the RHS or argument of the operator
3432 When supplied with a coderef, it is called as:
3434 $coderef->($self, $op, $arg)
3442 Thanks to some benchmarking by Mark Stosberg, it turns out that
3443 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3444 I must admit this wasn't an intentional design issue, but it's a
3445 byproduct of the fact that you get to control your C<DBI> handles
3448 To maximize performance, use a code snippet like the following:
3450 # prepare a statement handle using the first row
3451 # and then reuse it for the rest of the rows
3453 for my $href (@array_of_hashrefs) {
3454 $stmt ||= $sql->insert('table', $href);
3455 $sth ||= $dbh->prepare($stmt);
3456 $sth->execute($sql->values($href));
3459 The reason this works is because the keys in your C<$href> are sorted
3460 internally by B<SQL::Abstract>. Thus, as long as your data retains
3461 the same structure, you only have to generate the SQL the first time
3462 around. On subsequent queries, simply use the C<values> function provided
3463 by this module to return your values in the correct order.
3465 However this depends on the values having the same type - if, for
3466 example, the values of a where clause may either have values
3467 (resulting in sql of the form C<column = ?> with a single bind
3468 value), or alternatively the values might be C<undef> (resulting in
3469 sql of the form C<column IS NULL> with no bind value) then the
3470 caching technique suggested will not work.
3474 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3475 really like this part (I do, at least). Building up a complex query
3476 can be as simple as the following:
3483 use CGI::FormBuilder;
3486 my $form = CGI::FormBuilder->new(...);
3487 my $sql = SQL::Abstract->new;
3489 if ($form->submitted) {
3490 my $field = $form->field;
3491 my $id = delete $field->{id};
3492 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3495 Of course, you would still have to connect using C<DBI> to run the
3496 query, but the point is that if you make your form look like your
3497 table, the actual query script can be extremely simplistic.
3499 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3500 a fast interface to returning and formatting data. I frequently
3501 use these three modules together to write complex database query
3502 apps in under 50 lines.
3504 =head1 HOW TO CONTRIBUTE
3506 Contributions are always welcome, in all usable forms (we especially
3507 welcome documentation improvements). The delivery methods include git-
3508 or unified-diff formatted patches, GitHub pull requests, or plain bug
3509 reports either via RT or the Mailing list. Contributors are generally
3510 granted full access to the official repository after their first several
3511 patches pass successful review.
3513 This project is maintained in a git repository. The code and related tools are
3514 accessible at the following locations:
3518 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3520 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3522 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3524 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3530 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3531 Great care has been taken to preserve the I<published> behavior
3532 documented in previous versions in the 1.* family; however,
3533 some features that were previously undocumented, or behaved
3534 differently from the documentation, had to be changed in order
3535 to clarify the semantics. Hence, client code that was relying
3536 on some dark areas of C<SQL::Abstract> v1.*
3537 B<might behave differently> in v1.50.
3539 The main changes are:
3545 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3549 support for the { operator => \"..." } construct (to embed literal SQL)
3553 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3557 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3561 defensive programming: check arguments
3565 fixed bug with global logic, which was previously implemented
3566 through global variables yielding side-effects. Prior versions would
3567 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3568 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3569 Now this is interpreted
3570 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3575 fixed semantics of _bindtype on array args
3579 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3580 we just avoid shifting arrays within that tree.
3584 dropped the C<_modlogic> function
3588 =head1 ACKNOWLEDGEMENTS
3590 There are a number of individuals that have really helped out with
3591 this module. Unfortunately, most of them submitted bugs via CPAN
3592 so I have no idea who they are! But the people I do know are:
3594 Ash Berlin (order_by hash term support)
3595 Matt Trout (DBIx::Class support)
3596 Mark Stosberg (benchmarking)
3597 Chas Owens (initial "IN" operator support)
3598 Philip Collins (per-field SQL functions)
3599 Eric Kolve (hashref "AND" support)
3600 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3601 Dan Kubb (support for "quote_char" and "name_sep")
3602 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3603 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3604 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3605 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3606 Oliver Charles (support for "RETURNING" after "INSERT")
3612 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3616 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3618 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3620 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3621 While not an official support venue, C<DBIx::Class> makes heavy use of
3622 C<SQL::Abstract>, and as such list members there are very familiar with
3623 how to create queries.
3627 This module is free software; you may copy this under the same
3628 terms as perl itself (either the GNU General Public License or
3629 the Artistic License)