1 package SQL::Abstract; # see doc at end of file
5 use Module::Runtime ();
10 use Exporter 'import';
11 our @EXPORT_OK = qw(is_plain_value is_literal_value);
21 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
27 #======================================================================
29 #======================================================================
31 our $VERSION = '1.87';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
149 (map +($_ => __PACKAGE__->make_binop_expander('_expand_between')),
150 qw(between not_between)),
151 #(map +($_ => __PACKAGE__->make_binop_expander('_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_$_"),
163 qw(op func bind ident literal row values keyword)),
166 (map +($_ => '_render_op_between'), 'between', 'not_between'),
167 (map +($_ => '_render_op_in'), 'in', 'not_in'),
168 (map +($_ => '_render_unop_postfix'),
169 'is_null', 'is_not_null', 'asc', 'desc',
171 (not => '_render_unop_paren'),
172 (map +($_ => '_render_op_andor'), qw(and or)),
173 ',' => '_render_op_multop',
176 delete => [ qw(target where returning) ],
177 update => [ qw(target set where returning) ],
178 insert => [ qw(target fields from returning) ],
179 select => [ qw(select from where order_by) ],
182 'delete.from' => '_expand_delete_clause_target',
183 'update.update' => '_expand_update_clause_target',
184 'insert.into' => '_expand_insert_clause_target',
185 'insert.values' => '_expand_insert_clause_from',
188 'delete.target' => '_render_delete_clause_target',
189 'update.target' => '_render_update_clause_target',
190 'insert.target' => '_render_insert_clause_target',
191 'insert.fields' => '_render_insert_clause_fields',
192 'insert.from' => '_render_insert_clause_from',
196 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
197 $Defaults{expand}{$stmt} = '_expand_statement';
198 $Defaults{render}{$stmt} = '_render_statement';
199 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
200 $Defaults{expand_clause}{"${stmt}.${clause}"}
201 = "_expand_${stmt}_clause_${clause}";
207 my $class = ref($self) || $self;
208 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
210 # choose our case by keeping an option around
211 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
213 # default logic for interpreting arrayrefs
214 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
216 # how to return bind vars
217 $opt{bindtype} ||= 'normal';
219 # default comparison is "=", but can be overridden
222 # try to recognize which are the 'equality' and 'inequality' ops
223 # (temporary quickfix (in 2007), should go through a more seasoned API)
224 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
225 $opt{inequality_op} = qr/^( != | <> )$/ix;
227 $opt{like_op} = qr/^ (is_)?r?like $/xi;
228 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
231 $opt{sqltrue} ||= '1=1';
232 $opt{sqlfalse} ||= '0=1';
235 $opt{special_ops} ||= [];
238 $opt{unary_ops} ||= [];
240 # rudimentary sanity-check for user supplied bits treated as functions/operators
241 # If a purported function matches this regular expression, an exception is thrown.
242 # Literal SQL is *NOT* subject to this check, only functions (and column names
243 # when quoting is not in effect)
246 # need to guard against ()'s in column names too, but this will break tons of
247 # hacks... ideas anyone?
248 $opt{injection_guard} ||= qr/
254 $opt{expand_unary} = {};
256 foreach my $name (sort keys %Defaults) {
257 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
260 if ($class ne __PACKAGE__) {
262 # check for overriden methods
264 foreach my $type (qw(insert update delete)) {
265 my $method = "_${type}_returning";
266 if (__PACKAGE__->can($method) ne $class->can($method)) {
267 my $clause = "${type}.returning";
268 $opt{expand_clause}{$clause} = sub { $_[2] },
269 $opt{render_clause}{$clause}
270 = sub { [ $_[0]->$method($_[3]) ] };
273 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
274 $opt{expand_clause}{'select.from'} = sub {
275 return +{ -literal => [ $_[0]->_table($_[2]) ] };
278 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
279 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
280 $opt{render_clause}{'select.order_by'} = sub {
281 [ $_[0]->_order_by($_[2]) ];
284 if ($class->isa('DBIx::Class::SQLMaker')) {
285 $opt{warn_once_on_nest} = 1;
286 $opt{disable_old_special_ops} = 1;
287 $opt{render_clause}{'select.where'} = sub {
288 my ($sql, @bind) = $_[0]->where($_[2]);
289 s/\A\s+//, s/\s+\Z// for $sql;
290 return [ $sql, @bind ];
295 if ($opt{lazy_join_sql_parts}) {
296 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
297 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
300 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
302 return bless \%opt, $class;
306 my ($self, $name, $key, $value) = @_;
307 return $self->{$name}{$key} unless @_ > 3;
308 $self->{$name}{$key} = $value;
312 sub make_unop_expander {
313 my (undef, $exp) = @_;
315 my ($self, $name, $body, $k) = @_;
316 return $self->_expand_hashpair_cmp($k, { "-${name}" => $body })
318 return $self->$exp($name, $body);
322 sub make_binop_expander {
323 my (undef, $exp) = @_;
325 my ($self, $name, $body, $k) = @_;
326 $k = shift @{$body = [ @$body ]} unless defined $k;
327 $k = ref($k) ? $k : { -ident => $k };
328 return $self->$exp($name, $body, $k);
333 foreach my $type (qw(
334 expand op_expand render op_render clause_expand clause_render
336 my $name = join '_', reverse split '_', $type;
337 my $singular = "${type}er";
338 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
339 or die "Method builder failed for ${singular}: $@";
340 eval qq{sub wrap_${singular} {
341 my (\$self, \$key, \$builder) = \@_;
342 my \$orig = \$self->_ext_rw('${name}', \$key);
345 \$builder->(\$orig, '${name}', \$key)
347 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
348 eval qq{sub ${singular}s {
349 my (\$self, \@args) = \@_;
350 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
351 \$self->_ext_rw('${name}', \$this_key, \$this_value);
354 }; 1 } or die "Method builder failed for ${singular}s: $@";
355 eval qq{sub wrap_${singular}s {
356 my (\$self, \@args) = \@_;
357 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
358 my \$orig = \$self->_ext_rw('${name}', \$this_key);
360 '${name}', \$this_key,
361 \$this_builder->(\$orig, '${name}', \$this_key),
365 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
366 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
367 or die "Method builder failed for ${singular}_list: $@";
371 sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
373 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
376 my ($self, $of, @clauses) = @_;
378 return @{$self->{clauses_of}{$of}||[]};
380 if (ref($clauses[0]) eq 'CODE') {
381 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
383 $self->{clauses_of}{$of} = \@clauses;
392 ref($self->{$_}) eq 'HASH'
401 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
402 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
404 sub _assert_pass_injection_guard {
405 if ($_[1] =~ $_[0]->{injection_guard}) {
406 my $class = ref $_[0];
407 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
408 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
409 . "{injection_guard} attribute to ${class}->new()"
414 #======================================================================
416 #======================================================================
419 my ($self, $table, $data, $options) = @_;
422 if (ref($table) eq 'HASH') {
425 my %clauses = (target => $table, values => $data, %{$options||{}});
429 my @rendered = $self->render_statement({ -insert => $stmt });
430 return wantarray ? @rendered : $rendered[0];
433 sub _expand_insert_clause_target {
434 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
437 sub _expand_insert_clause_fields {
439 $_[0]->expand_maybe_list_expr($_[2], -ident)
440 ] } if ref($_[2]) eq 'ARRAY';
441 return $_[2]; # should maybe still expand somewhat?
444 sub _expand_insert_clause_from {
445 my ($self, undef, $data) = @_;
446 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
447 return $self->expand_expr($data);
449 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
451 from => { -values => [ $v_aqt ] },
452 ($f_aqt ? (fields => $f_aqt) : ()),
456 sub _expand_insert_clause_returning {
457 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
460 sub _expand_insert_values {
461 my ($self, $data) = @_;
462 if (is_literal_value($data)) {
463 (undef, $self->expand_expr($data));
465 my ($fields, $values) = (
466 ref($data) eq 'HASH' ?
467 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
471 # no names (arrayref) means can't generate bindtype
472 !($fields) && $self->{bindtype} eq 'columns'
473 && belch "can't do 'columns' bindtype when called with arrayref";
477 ? $self->expand_expr({ -row => $fields }, -ident)
482 local our $Cur_Col_Meta = $fields->[$_];
483 $self->_expand_insert_value($values->[$_])
490 sub _render_insert_clause_fields {
491 return $_[0]->render_aqt($_[2]);
494 sub _render_insert_clause_target {
495 my ($self, undef, $from) = @_;
496 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
499 sub _render_insert_clause_from {
500 return $_[0]->render_aqt($_[2], 1);
503 # So that subclasses can override INSERT ... RETURNING separately from
504 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
505 sub _insert_returning { shift->_returning(@_) }
507 sub _redispatch_returning {
508 my ($self, $type, undef, $returning) = @_;
509 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
513 my ($self, $options) = @_;
515 my $f = $options->{returning};
517 my ($sql, @bind) = @{ $self->render_aqt(
518 $self->expand_maybe_list_expr($f, -ident)
520 return ($self->_sqlcase(' returning ').$sql, @bind);
523 sub _expand_insert_value {
526 my $k = our $Cur_Col_Meta;
528 if (ref($v) eq 'ARRAY') {
529 if ($self->{array_datatypes}) {
530 return +{ -bind => [ $k, $v ] };
532 my ($sql, @bind) = @$v;
533 $self->_assert_bindval_matches_bindtype(@bind);
534 return +{ -literal => $v };
536 if (ref($v) eq 'HASH') {
537 if (grep !/^-/, keys %$v) {
538 belch "HASH ref as bind value in insert is not supported";
539 return +{ -bind => [ $k, $v ] };
543 return +{ -bind => [ $k, undef ] };
545 return $self->expand_expr($v);
550 #======================================================================
552 #======================================================================
555 my ($self, $table, $set, $where, $options) = @_;
558 if (ref($table) eq 'HASH') {
562 @clauses{qw(target set where)} = ($table, $set, $where);
563 puke "Unsupported data type specified to \$sql->update"
564 unless ref($clauses{set}) eq 'HASH';
565 @clauses{keys %$options} = values %$options;
569 my @rendered = $self->render_statement({ -update => $stmt });
570 return wantarray ? @rendered : $rendered[0];
573 sub _render_update_clause_target {
574 my ($self, undef, $target) = @_;
575 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
578 sub _update_set_values {
579 my ($self, $data) = @_;
581 return @{ $self->render_aqt(
582 $self->_expand_update_set_values(undef, $data),
586 sub _expand_update_set_values {
587 my ($self, undef, $data) = @_;
588 $self->expand_maybe_list_expr( [
591 $set = { -bind => $_ } unless defined $set;
592 +{ -op => [ '=', { -ident => $k }, $set ] };
598 ? ($self->{array_datatypes}
599 ? [ $k, +{ -bind => [ $k, $v ] } ]
600 : [ $k, +{ -literal => $v } ])
602 local our $Cur_Col_Meta = $k;
603 [ $k, $self->_expand_expr($v) ]
610 sub _expand_update_clause_target {
611 my ($self, undef, $target) = @_;
612 +(target => $self->expand_maybe_list_expr($target, -ident));
615 sub _expand_update_clause_set {
616 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
617 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
620 sub _expand_update_clause_where {
621 +(where => $_[0]->expand_expr($_[2]));
624 sub _expand_update_clause_returning {
625 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
628 # So that subclasses can override UPDATE ... RETURNING separately from
630 sub _update_returning { shift->_returning(@_) }
634 #======================================================================
636 #======================================================================
639 my ($self, @args) = @_;
641 if (ref(my $sel = $args[0]) eq 'HASH') {
645 @clauses{qw(from select where order_by)} = @args;
647 # This oddity is to literalify since historically SQLA doesn't quote
648 # a single identifier argument, so we convert it into a literal
650 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
651 unless ref($clauses{select});
656 my @rendered = $self->render_statement({ -select => $stmt });
657 return wantarray ? @rendered : $rendered[0];
660 sub _expand_select_clause_select {
661 my ($self, undef, $select) = @_;
662 +(select => $self->expand_maybe_list_expr($select, -ident));
665 sub _expand_select_clause_from {
666 my ($self, undef, $from) = @_;
667 +(from => $self->expand_maybe_list_expr($from, -ident));
670 sub _expand_select_clause_where {
671 my ($self, undef, $where) = @_;
674 if (my $conv = $self->{convert}) {
686 ->wrap_expander(bind => $_wrap)
687 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
688 ->wrap_expander(func => sub {
691 my ($self, $type, $thing) = @_;
692 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
693 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
696 or $thing->[1]{-value}
697 or $thing->[1]{-bind})
699 return { -func => $thing }; # already went through our expander
701 return $self->$orig($type, $thing);
709 return +(where => $sqla->expand_expr($where));
712 sub _expand_select_clause_order_by {
713 my ($self, undef, $order_by) = @_;
714 +(order_by => $self->_expand_order_by($order_by));
718 my ($self, $fields) = @_;
719 return $fields unless ref($fields);
720 return @{ $self->render_aqt(
721 $self->expand_maybe_list_expr($fields, '-ident')
725 #======================================================================
727 #======================================================================
730 my ($self, $table, $where, $options) = @_;
733 if (ref($table) eq 'HASH') {
736 my %clauses = (target => $table, where => $where, %{$options||{}});
740 my @rendered = $self->render_statement({ -delete => $stmt });
741 return wantarray ? @rendered : $rendered[0];
744 # So that subclasses can override DELETE ... RETURNING separately from
746 sub _delete_returning { shift->_returning(@_) }
748 sub _expand_delete_clause_target {
749 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
752 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
754 sub _expand_delete_clause_returning {
755 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
758 sub _render_delete_clause_target {
759 my ($self, undef, $from) = @_;
760 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
763 #======================================================================
765 #======================================================================
769 # Finally, a separate routine just to handle WHERE clauses
771 my ($self, $where, $order) = @_;
773 local $self->{convert_where} = $self->{convert};
776 my ($sql, @bind) = defined($where)
777 ? $self->_recurse_where($where)
779 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
783 my ($order_sql, @order_bind) = $self->_order_by($order);
785 push @bind, @order_bind;
788 return wantarray ? ($sql, @bind) : $sql;
791 { our $Default_Scalar_To = -value }
794 my ($self, $expr, $default_scalar_to) = @_;
795 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
796 $self->_expand_expr($expr);
800 my ($self, $aqt, $top_level) = @_;
801 my ($k, $v, @rest) = %$aqt;
803 die "Not a node type: $k" unless $k =~ s/^-//;
804 if (my $meth = $self->{render}{$k}) {
805 local our $Render_Top_Level = $top_level;
806 return $self->$meth($k, $v);
808 die "notreached: $k";
812 my ($self, $expr, $default_scalar_to) = @_;
813 return @{ $self->render_aqt(
814 $self->expand_expr($expr, $default_scalar_to)
818 sub render_statement {
819 my ($self, $expr, $default_scalar_to) = @_;
821 $self->expand_expr($expr, $default_scalar_to), 1
825 sub _expand_statement {
826 my ($self, $type, $args) = @_;
827 my $ec = $self->{expand_clause};
830 $args->{$type} = delete $args->{_}
832 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
833 return +{ "-${type}" => +{
835 my $val = $args->{$_};
836 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
837 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
842 } elsif ($has_clause{$_}) {
843 ($_ => $self->expand_expr($val))
851 sub _render_statement {
852 my ($self, $type, $args) = @_;
854 foreach my $clause (@{$self->{clauses_of}{$type}}) {
855 next unless my $clause_expr = $args->{$clause};
857 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
858 $self->$rdr($clause, $clause_expr, $args);
860 my $r = $self->render_aqt($clause_expr, 1);
861 next unless defined $r->[0] and length $r->[0];
862 $self->join_query_parts(' ',
863 { -keyword => $clause },
870 my $q = $self->join_query_parts(' ', @parts);
871 return $self->join_query_parts('',
872 (our $Render_Top_Level ? $q : ('(', $q, ')'))
877 my ($self, $raw) = @_;
879 return $op if grep $_->{$op}, @{$self}{qw(is_op expand_op render_op)};
880 s/^-(?=.)//, s/\s+/_/g for $op;
885 my ($self, $expr) = @_;
886 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
887 return undef unless defined($expr);
888 if (ref($expr) eq 'HASH') {
889 return undef unless my $kc = keys %$expr;
891 return $self->_expand_op_andor(and => $expr);
893 my ($key, $value) = %$expr;
894 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
895 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
896 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
898 return $self->_expand_hashpair($key, $value);
900 if (ref($expr) eq 'ARRAY') {
901 return $self->_expand_op_andor(lc($self->{logic}), $expr);
903 if (my $literal = is_literal_value($expr)) {
904 return +{ -literal => $literal };
906 if (!ref($expr) or Scalar::Util::blessed($expr)) {
907 return $self->_expand_scalar($expr);
912 sub _expand_hashpair {
913 my ($self, $k, $v) = @_;
914 unless (defined($k) and length($k)) {
915 if (defined($k) and my $literal = is_literal_value($v)) {
916 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
917 return { -literal => $literal };
919 puke "Supplying an empty left hand side argument is not supported";
922 return $self->_expand_hashpair_op($k, $v);
923 } elsif ($k =~ /^[^\w]/i) {
924 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
925 return $self->_expand_op(
926 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
929 return $self->_expand_hashpair_ident($k, $v);
932 sub _expand_hashpair_ident {
933 my ($self, $k, $v) = @_;
935 local our $Cur_Col_Meta = $k;
937 # hash with multiple or no elements is andor
939 if (ref($v) eq 'HASH' and keys %$v != 1) {
940 return $self->_expand_op_andor(and => $v, $k);
943 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
945 if (is_undef_value($v)) {
946 return $self->_expand_hashpair_cmp($k => undef);
949 # scalars and objects get expanded as whatever requested or values
951 if (!ref($v) or Scalar::Util::blessed($v)) {
952 return $self->_expand_hashpair_scalar($k, $v);
955 # single key hashref is a hashtriple
957 if (ref($v) eq 'HASH') {
958 return $self->_expand_hashtriple($k, %$v);
961 # arrayref needs re-engineering over the elements
963 if (ref($v) eq 'ARRAY') {
964 return $self->sqlfalse unless @$v;
965 $self->_debug("ARRAY($k) means distribute over elements");
967 $v->[0] =~ /^-(and|or)$/i
968 ? (shift(@{$v = [ @$v ]}), $1)
969 : lc($self->{logic} || 'OR')
971 return $self->_expand_op_andor(
976 if (my $literal = is_literal_value($v)) {
978 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
981 my ($sql, @bind) = @$literal;
982 if ($self->{bindtype} eq 'columns') {
984 $self->_assert_bindval_matches_bindtype($_);
987 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
993 my ($self, $expr) = @_;
995 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
998 sub _expand_hashpair_scalar {
999 my ($self, $k, $v) = @_;
1001 return $self->_expand_hashpair_cmp(
1002 $k, $self->_expand_scalar($v),
1006 sub _expand_hashpair_op {
1007 my ($self, $k, $v) = @_;
1009 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
1011 my $op = $self->_normalize_op($k);
1013 my $wsop = join(' ', split '_', $op);
1015 my $is_special = List::Util::first { $wsop =~ $_->{regex} }
1016 @{$self->{special_ops}};
1020 # the old special op system requires illegality for top-level use
1023 (our $Expand_Depth) == 1
1027 $self->{disable_old_special_ops}
1028 and List::Util::first { $wsop =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1032 puke "Illegal use of top-level '-$wsop'"
1036 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1037 return $self->$exp($op, $v);
1040 if ($self->{render}{$op}) {
1041 return { "-${op}" => $v };
1044 # Ops prefixed with -not_ get converted
1046 if (my ($rest) = $op =~/^not_(.*)$/) {
1049 $self->_expand_expr({ "-${rest}", $v })
1055 # the old unary op system means we should touch nothing and let it work
1057 my $op = join(' ', split '_', $op);
1059 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1060 return { -op => [ $op, $v ] };
1064 my $type = $is_special || $self->{render_op}{$op} ? -op : -func;
1066 if ($self->{restore_old_unop_handling}) {
1073 and (keys %$v)[0] =~ /^-/
1074 and not $self->{render_op}{$op}
1083 if ($type eq -func and ref($v) eq 'ARRAY') {
1084 return $self->_expand_expr({ -func => [ $op, @$v ] });
1087 return $self->_expand_expr({ $type => [ $op, $v ] });
1090 sub _expand_hashpair_cmp {
1091 my ($self, $k, $v) = @_;
1092 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1095 sub _expand_hashtriple {
1096 my ($self, $k, $vk, $vv) = @_;
1098 my $ik = $self->_expand_expr({ -ident => $k });
1100 my $op = $self->_normalize_op($vk);
1101 $self->_assert_pass_injection_guard($op);
1103 if ($op =~ s/ _? \d+ $//x ) {
1104 return $self->_expand_expr($k, { $vk, $vv });
1106 if (my $x = $self->{expand_op}{$op}) {
1107 local our $Cur_Col_Meta = $k;
1108 return $self->$x($op, $vv, $k);
1112 my $op = join(' ', split '_', $op);
1114 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1115 return { -op => [ $op, $ik, $vv ] };
1117 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1121 { -op => [ $op, $vv ] }
1125 if (ref($vv) eq 'ARRAY') {
1127 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1128 ? (shift(@raw), lc $1) : 'or';
1129 my @values = map +{ $vk => $_ }, @raw;
1131 $op =~ $self->{inequality_op}
1132 or $op =~ $self->{not_like_op}
1134 if (lc($logic) eq 'or' and @values > 1) {
1135 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1136 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1137 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1142 # try to DWIM on equality operators
1143 return ($self->_dwim_op_to_is($op,
1144 "Supplying an empty arrayref to '%s' is deprecated",
1145 "operator '%s' applied on an empty array (field '$k')"
1146 ) ? $self->sqlfalse : $self->sqltrue);
1148 return $self->_expand_op_andor($logic => \@values, $k);
1150 if (is_undef_value($vv)) {
1151 my $is = ($self->_dwim_op_to_is($op,
1152 "Supplying an undefined argument to '%s' is deprecated",
1153 "unexpected operator '%s' with undef operand",
1154 ) ? 'is' : 'is not');
1156 return $self->_expand_hashpair($k => { $is, undef });
1158 local our $Cur_Col_Meta = $k;
1162 $self->_expand_expr($vv)
1166 sub _dwim_op_to_is {
1167 my ($self, $raw, $empty, $fail) = @_;
1169 my $op = $self->_normalize_op($raw);
1171 if ($op =~ /^not$/i) {
1174 if ($op =~ $self->{equality_op}) {
1177 if ($op =~ $self->{like_op}) {
1178 belch(sprintf $empty, uc(join ' ', split '_', $op));
1181 if ($op =~ $self->{inequality_op}) {
1184 if ($op =~ $self->{not_like_op}) {
1185 belch(sprintf $empty, uc(join ' ', split '_', $op));
1188 puke(sprintf $fail, $op);
1192 my ($self, undef, $args) = @_;
1193 my ($func, @args) = @$args;
1194 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1198 my ($self, undef, $body, $k) = @_;
1199 return $self->_expand_hashpair_cmp(
1200 $k, { -ident => $body }
1202 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1203 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1205 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1206 ref($body) ? @$body : $body;
1207 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1208 unless ($self->{quote_char}) {
1209 $self->_assert_pass_injection_guard($_) for @parts;
1211 return +{ -ident => \@parts };
1215 return $_[0]->_expand_hashpair_cmp(
1216 $_[3], { -value => $_[2] },
1217 ) if defined($_[3]);
1218 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1222 my ($self, undef, $args) = @_;
1223 +{ -row => [ map $self->expand_expr($_), @$args ] };
1227 my ($self, undef, $args) = @_;
1228 my ($op, @opargs) = @$args;
1229 if (my $exp = $self->{expand_op}{$op}) {
1230 return $self->$exp($op, \@opargs);
1232 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1236 my ($self, undef, $v) = @_;
1238 return $self->_expand_expr($v);
1240 puke "-bool => undef not supported" unless defined($v);
1241 return $self->_expand_expr({ -ident => $v });
1244 sub _expand_op_andor {
1245 my ($self, $logop, $v, $k) = @_;
1247 $v = [ map +{ $k, $_ },
1249 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1253 if (ref($v) eq 'HASH') {
1254 return undef unless keys %$v;
1257 map $self->_expand_expr({ $_ => $v->{$_} }),
1261 if (ref($v) eq 'ARRAY') {
1262 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1265 (ref($_) eq 'ARRAY' and @$_)
1266 or (ref($_) eq 'HASH' and %$_)
1272 while (my ($el) = splice @expr, 0, 1) {
1273 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1274 unless defined($el) and length($el);
1275 my $elref = ref($el);
1277 local our $Expand_Depth = 0;
1278 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1279 } elsif ($elref eq 'ARRAY') {
1280 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1281 } elsif (my $l = is_literal_value($el)) {
1282 push @res, { -literal => $l };
1283 } elsif ($elref eq 'HASH') {
1284 local our $Expand_Depth = 0;
1285 push @res, grep defined, $self->_expand_expr($el) if %$el;
1291 # return $res[0] if @res == 1;
1292 return { -op => [ $logop, @res ] };
1298 my ($self, $op, $vv, $k) = @_;
1299 ($k, $vv) = @$vv unless defined $k;
1300 puke "$op can only take undef as argument"
1304 and exists($vv->{-value})
1305 and !defined($vv->{-value})
1307 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1310 sub _expand_between {
1311 my ($self, $op, $vv, $k) = @_;
1312 my @rhs = map $self->_expand_expr($_),
1313 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1315 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1317 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1319 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1323 $self->expand_expr($k),
1324 map $self->expand_expr($_, -value), @rhs
1329 my ($self, $op, $vv, $k) = @_;
1330 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1331 if (my $literal = is_literal_value($vv)) {
1332 my ($sql, @bind) = @$literal;
1333 my $opened_sql = $self->_open_outer_paren($sql);
1335 $op, $self->expand_expr($k, -ident),
1336 { -literal => [ $opened_sql, @bind ] }
1340 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1341 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1342 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1343 . 'will emit the logically correct SQL instead of raising this exception)'
1345 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1347 my @rhs = map $self->expand_expr($_, -value),
1348 map { defined($_) ? $_: puke($undef_err) }
1349 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1350 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1354 $self->expand_expr($k, -ident),
1360 my ($self, undef, $v) = @_;
1361 # DBIx::Class requires a nest warning to be emitted once but the private
1362 # method it overrode to do so no longer exists
1363 if ($self->{warn_once_on_nest}) {
1364 unless (our $Nest_Warned) {
1366 "-nest in search conditions is deprecated, you most probably wanted:\n"
1367 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1372 return $self->_expand_expr($v);
1375 sub _expand_values {
1376 my ($self, undef, $values) = @_;
1377 return { -values => [
1380 ? $self->expand_expr($_)
1381 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1382 ), ref($values) eq 'ARRAY' ? @$values : $values
1386 sub _recurse_where {
1387 my ($self, $where) = @_;
1389 # Special case: top level simple string treated as literal
1391 my $where_exp = (ref($where)
1392 ? $self->_expand_select_clause_where(undef, $where)
1393 : { -literal => [ $where ] });
1395 # dispatch expanded expression
1397 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1398 # DBIx::Class used to call _recurse_where in scalar context
1399 # something else might too...
1401 return ($sql, @bind);
1404 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1410 my ($self, undef, $ident) = @_;
1412 return [ $self->_quote($ident) ];
1416 my ($self, undef, $values) = @_;
1417 return $self->join_query_parts('',
1419 $self->_render_op(undef, [ ',', @$values ]),
1425 my ($self, undef, $rest) = @_;
1426 my ($func, @args) = @$rest;
1427 return $self->join_query_parts('',
1428 $self->_sqlcase($func),
1429 $self->join_query_parts('',
1431 $self->join_query_parts(', ', @args),
1438 my ($self, undef, $bind) = @_;
1439 return [ '?', $self->_bindtype(@$bind) ];
1442 sub _render_literal {
1443 my ($self, undef, $literal) = @_;
1444 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1448 sub _render_keyword {
1449 my ($self, undef, $keyword) = @_;
1450 return [ $self->_sqlcase(
1451 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1456 my ($self, undef, $v) = @_;
1457 my ($op, @args) = @$v;
1458 if (my $r = $self->{render_op}{$op}) {
1459 return $self->$r($op, \@args);
1464 my $op = join(' ', split '_', $op);
1466 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1467 if ($ss and @args > 1) {
1468 puke "Special op '${op}' requires first value to be identifier"
1469 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1470 my $k = join(($self->{name_sep}||'.'), @$ident);
1471 local our $Expand_Depth = 1;
1472 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1474 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1475 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1478 return $self->_render_unop_paren($op, \@args);
1482 return $self->_render_unop_prefix($op, \@args);
1484 return $self->_render_op_multop($op, \@args);
1490 sub _render_op_between {
1491 my ($self, $op, $args) = @_;
1492 my ($left, $low, $high) = @$args;
1495 puke "Single arg to between must be a literal"
1496 unless $low->{-literal};
1499 +($low, { -keyword => 'and' }, $high);
1502 return $self->join_query_parts(' ',
1503 '(', $left, { -keyword => $op }, @rh, ')',
1508 my ($self, $op, $args) = @_;
1509 my ($lhs, @rhs) = @$args;
1511 return $self->join_query_parts(' ',
1513 { -keyword => $op },
1514 $self->join_query_parts(' ',
1516 $self->join_query_parts(', ', @rhs),
1522 sub _render_op_andor {
1523 my ($self, $op, $args) = @_;
1524 return undef unless @$args;
1525 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1526 my $inner = $self->_render_op_multop($op, $args);
1527 return undef unless defined($inner->[0]) and length($inner->[0]);
1528 return $self->join_query_parts(' ',
1533 sub _render_op_multop {
1534 my ($self, $op, $args) = @_;
1536 return undef unless @parts;
1537 return $self->render_aqt($parts[0]) if @parts == 1;
1538 my $join = ($op eq ','
1540 : { -keyword => " ${op} " }
1542 return $self->join_query_parts($join, @parts);
1545 sub _render_values {
1546 my ($self, undef, $values) = @_;
1547 my $inner = $self->join_query_parts(' ',
1548 { -keyword => 'values' },
1549 $self->join_query_parts(', ',
1550 ref($values) eq 'ARRAY' ? @$values : $values
1553 return $self->join_query_parts('',
1554 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1558 sub join_query_parts {
1559 my ($self, $join, @parts) = @_;
1560 if (ref($join) eq 'HASH') {
1561 $join = $self->render_aqt($join)->[0];
1565 ? $self->render_aqt($_)
1566 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1569 $self->{join_sql_parts}->(
1570 $join, grep defined && length, map $_->[0], @final
1572 (map @{$_}[1..$#$_], @final),
1576 sub _render_unop_paren {
1577 my ($self, $op, $v) = @_;
1578 return $self->join_query_parts('',
1579 '(', $self->_render_unop_prefix($op, $v), ')'
1583 sub _render_unop_prefix {
1584 my ($self, $op, $v) = @_;
1585 my $op_sql = $self->{restore_old_unop_handling}
1586 ? $self->_sqlcase($op)
1587 : { -keyword => $op };
1588 return $self->join_query_parts(' ',
1589 ($self->{restore_old_unop_handling}
1590 ? $self->_sqlcase($op)
1591 : { -keyword => \$op }),
1596 sub _render_unop_postfix {
1597 my ($self, $op, $v) = @_;
1598 return $self->join_query_parts(' ',
1599 $v->[0], { -keyword => $op },
1603 # Some databases (SQLite) treat col IN (1, 2) different from
1604 # col IN ( (1, 2) ). Use this to strip all outer parens while
1605 # adding them back in the corresponding method
1606 sub _open_outer_paren {
1607 my ($self, $sql) = @_;
1609 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1611 # there are closing parens inside, need the heavy duty machinery
1612 # to reevaluate the extraction starting from $sql (full reevaluation)
1613 if ($inner =~ /\)/) {
1614 require Text::Balanced;
1616 my (undef, $remainder) = do {
1617 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1619 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1622 # the entire expression needs to be a balanced bracketed thing
1623 # (after an extract no remainder sans trailing space)
1624 last if defined $remainder and $remainder =~ /\S/;
1634 #======================================================================
1636 #======================================================================
1638 sub _expand_order_by {
1639 my ($self, $arg) = @_;
1641 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1643 return $self->expand_maybe_list_expr($arg)
1644 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1646 my $expander = sub {
1647 my ($self, $dir, $expr) = @_;
1648 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1649 foreach my $arg (@to_expand) {
1653 and grep /^-(asc|desc)$/, keys %$arg
1655 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1659 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1661 map $self->expand_expr($_, -ident),
1662 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1663 return undef unless @exp;
1664 return undef if @exp == 1 and not defined($exp[0]);
1665 return +{ -op => [ ',', @exp ] };
1668 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1670 return $self->$expander(undef, $arg);
1674 my ($self, $arg) = @_;
1676 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1678 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1680 return '' unless length($sql);
1682 my $final_sql = $self->_sqlcase(' order by ').$sql;
1684 return ($final_sql, @bind);
1687 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1689 sub _order_by_chunks {
1690 my ($self, $arg) = @_;
1692 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1694 my @res = $self->_chunkify_order_by($expanded);
1695 (ref() ? $_->[0] : $_) .= '' for @res;
1699 sub _chunkify_order_by {
1700 my ($self, $expanded) = @_;
1702 return grep length, @{ $self->render_aqt($expanded) }
1703 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1706 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1707 my ($comma, @list) = @{$_->{-op}};
1708 return map $self->_chunkify_order_by($_), @list;
1710 return $self->render_aqt($_);
1714 #======================================================================
1715 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1716 #======================================================================
1722 $self->expand_maybe_list_expr($from, -ident)
1727 #======================================================================
1729 #======================================================================
1731 sub expand_maybe_list_expr {
1732 my ($self, $expr, $default) = @_;
1734 ',', map $self->expand_expr($_, $default),
1735 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1736 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1737 return +{ -op => [ ',',
1738 map $self->expand_expr($_, $default),
1739 ref($expr) eq 'ARRAY' ? @$expr : $expr
1743 # highly optimized, as it's called way too often
1745 # my ($self, $label) = @_;
1747 return '' unless defined $_[1];
1748 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1749 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1751 unless ($_[0]->{quote_char}) {
1752 if (ref($_[1]) eq 'ARRAY') {
1753 return join($_[0]->{name_sep}||'.', @{$_[1]});
1755 $_[0]->_assert_pass_injection_guard($_[1]);
1760 my $qref = ref $_[0]->{quote_char};
1762 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1763 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1764 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1766 my $esc = $_[0]->{escape_char} || $r;
1768 # parts containing * are naturally unquoted
1770 $_[0]->{name_sep}||'',
1774 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1776 (ref($_[1]) eq 'ARRAY'
1780 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1788 # Conversion, if applicable
1790 #my ($self, $arg) = @_;
1791 if (my $conv = $_[0]->{convert_where}) {
1792 return @{ $_[0]->join_query_parts('',
1793 $_[0]->_sqlcase($conv),
1802 #my ($self, $col, @vals) = @_;
1803 # called often - tighten code
1804 return $_[0]->{bindtype} eq 'columns'
1805 ? map {[$_[1], $_]} @_[2 .. $#_]
1810 # Dies if any element of @bind is not in [colname => value] format
1811 # if bindtype is 'columns'.
1812 sub _assert_bindval_matches_bindtype {
1813 # my ($self, @bind) = @_;
1815 if ($self->{bindtype} eq 'columns') {
1817 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1818 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1824 # Fix SQL case, if so requested
1826 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1827 # don't touch the argument ... crooked logic, but let's not change it!
1828 return $_[0]->{case} ? $_[1] : uc($_[1]);
1831 #======================================================================
1832 # DISPATCHING FROM REFKIND
1833 #======================================================================
1836 my ($self, $data) = @_;
1838 return 'UNDEF' unless defined $data;
1840 # blessed objects are treated like scalars
1841 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1843 return 'SCALAR' unless $ref;
1846 while ($ref eq 'REF') {
1848 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1852 return ($ref||'SCALAR') . ('REF' x $n_steps);
1856 my ($self, $data) = @_;
1857 my @try = ($self->_refkind($data));
1858 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1859 push @try, 'FALLBACK';
1863 sub _METHOD_FOR_refkind {
1864 my ($self, $meth_prefix, $data) = @_;
1867 for (@{$self->_try_refkind($data)}) {
1868 $method = $self->can($meth_prefix."_".$_)
1872 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1876 sub _SWITCH_refkind {
1877 my ($self, $data, $dispatch_table) = @_;
1880 for (@{$self->_try_refkind($data)}) {
1881 $coderef = $dispatch_table->{$_}
1885 puke "no dispatch entry for ".$self->_refkind($data)
1894 #======================================================================
1895 # VALUES, GENERATE, AUTOLOAD
1896 #======================================================================
1898 # LDNOTE: original code from nwiger, didn't touch code in that section
1899 # I feel the AUTOLOAD stuff should not be the default, it should
1900 # only be activated on explicit demand by user.
1904 my $data = shift || return;
1905 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1906 unless ref $data eq 'HASH';
1909 foreach my $k (sort keys %$data) {
1910 my $v = $data->{$k};
1911 $self->_SWITCH_refkind($v, {
1913 if ($self->{array_datatypes}) { # array datatype
1914 push @all_bind, $self->_bindtype($k, $v);
1916 else { # literal SQL with bind
1917 my ($sql, @bind) = @$v;
1918 $self->_assert_bindval_matches_bindtype(@bind);
1919 push @all_bind, @bind;
1922 ARRAYREFREF => sub { # literal SQL with bind
1923 my ($sql, @bind) = @${$v};
1924 $self->_assert_bindval_matches_bindtype(@bind);
1925 push @all_bind, @bind;
1927 SCALARREF => sub { # literal SQL without bind
1929 SCALAR_or_UNDEF => sub {
1930 push @all_bind, $self->_bindtype($k, $v);
1941 my(@sql, @sqlq, @sqlv);
1945 if ($ref eq 'HASH') {
1946 for my $k (sort keys %$_) {
1949 my $label = $self->_quote($k);
1950 if ($r eq 'ARRAY') {
1951 # literal SQL with bind
1952 my ($sql, @bind) = @$v;
1953 $self->_assert_bindval_matches_bindtype(@bind);
1954 push @sqlq, "$label = $sql";
1956 } elsif ($r eq 'SCALAR') {
1957 # literal SQL without bind
1958 push @sqlq, "$label = $$v";
1960 push @sqlq, "$label = ?";
1961 push @sqlv, $self->_bindtype($k, $v);
1964 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1965 } elsif ($ref eq 'ARRAY') {
1966 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1969 if ($r eq 'ARRAY') { # literal SQL with bind
1970 my ($sql, @bind) = @$v;
1971 $self->_assert_bindval_matches_bindtype(@bind);
1974 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1975 # embedded literal SQL
1982 push @sql, '(' . join(', ', @sqlq) . ')';
1983 } elsif ($ref eq 'SCALAR') {
1987 # strings get case twiddled
1988 push @sql, $self->_sqlcase($_);
1992 my $sql = join ' ', @sql;
1994 # this is pretty tricky
1995 # if ask for an array, return ($stmt, @bind)
1996 # otherwise, s/?/shift @sqlv/ to put it inline
1998 return ($sql, @sqlv);
2000 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2001 ref $d ? $d->[1] : $d/e;
2010 # This allows us to check for a local, then _form, attr
2012 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2013 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2014 return $self->generate($name, @_);
2025 SQL::Abstract - Generate SQL from Perl data structures
2031 my $sql = SQL::Abstract->new;
2033 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2035 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2037 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2039 my($stmt, @bind) = $sql->delete($table, \%where);
2041 # Then, use these in your DBI statements
2042 my $sth = $dbh->prepare($stmt);
2043 $sth->execute(@bind);
2045 # Just generate the WHERE clause
2046 my($stmt, @bind) = $sql->where(\%where, $order);
2048 # Return values in the same order, for hashed queries
2049 # See PERFORMANCE section for more details
2050 my @bind = $sql->values(\%fieldvals);
2054 This module was inspired by the excellent L<DBIx::Abstract>.
2055 However, in using that module I found that what I really wanted
2056 to do was generate SQL, but still retain complete control over my
2057 statement handles and use the DBI interface. So, I set out to
2058 create an abstract SQL generation module.
2060 While based on the concepts used by L<DBIx::Abstract>, there are
2061 several important differences, especially when it comes to WHERE
2062 clauses. I have modified the concepts used to make the SQL easier
2063 to generate from Perl data structures and, IMO, more intuitive.
2064 The underlying idea is for this module to do what you mean, based
2065 on the data structures you provide it. The big advantage is that
2066 you don't have to modify your code every time your data changes,
2067 as this module figures it out.
2069 To begin with, an SQL INSERT is as easy as just specifying a hash
2070 of C<key=value> pairs:
2073 name => 'Jimbo Bobson',
2074 phone => '123-456-7890',
2075 address => '42 Sister Lane',
2076 city => 'St. Louis',
2077 state => 'Louisiana',
2080 The SQL can then be generated with this:
2082 my($stmt, @bind) = $sql->insert('people', \%data);
2084 Which would give you something like this:
2086 $stmt = "INSERT INTO people
2087 (address, city, name, phone, state)
2088 VALUES (?, ?, ?, ?, ?)";
2089 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2090 '123-456-7890', 'Louisiana');
2092 These are then used directly in your DBI code:
2094 my $sth = $dbh->prepare($stmt);
2095 $sth->execute(@bind);
2097 =head2 Inserting and Updating Arrays
2099 If your database has array types (like for example Postgres),
2100 activate the special option C<< array_datatypes => 1 >>
2101 when creating the C<SQL::Abstract> object.
2102 Then you may use an arrayref to insert and update database array types:
2104 my $sql = SQL::Abstract->new(array_datatypes => 1);
2106 planets => [qw/Mercury Venus Earth Mars/]
2109 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2113 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2115 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2118 =head2 Inserting and Updating SQL
2120 In order to apply SQL functions to elements of your C<%data> you may
2121 specify a reference to an arrayref for the given hash value. For example,
2122 if you need to execute the Oracle C<to_date> function on a value, you can
2123 say something like this:
2127 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2130 The first value in the array is the actual SQL. Any other values are
2131 optional and would be included in the bind values array. This gives
2134 my($stmt, @bind) = $sql->insert('people', \%data);
2136 $stmt = "INSERT INTO people (name, date_entered)
2137 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2138 @bind = ('Bill', '03/02/2003');
2140 An UPDATE is just as easy, all you change is the name of the function:
2142 my($stmt, @bind) = $sql->update('people', \%data);
2144 Notice that your C<%data> isn't touched; the module will generate
2145 the appropriately quirky SQL for you automatically. Usually you'll
2146 want to specify a WHERE clause for your UPDATE, though, which is
2147 where handling C<%where> hashes comes in handy...
2149 =head2 Complex where statements
2151 This module can generate pretty complicated WHERE statements
2152 easily. For example, simple C<key=value> pairs are taken to mean
2153 equality, and if you want to see if a field is within a set
2154 of values, you can use an arrayref. Let's say we wanted to
2155 SELECT some data based on this criteria:
2158 requestor => 'inna',
2159 worker => ['nwiger', 'rcwe', 'sfz'],
2160 status => { '!=', 'completed' }
2163 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2165 The above would give you something like this:
2167 $stmt = "SELECT * FROM tickets WHERE
2168 ( requestor = ? ) AND ( status != ? )
2169 AND ( worker = ? OR worker = ? OR worker = ? )";
2170 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2172 Which you could then use in DBI code like so:
2174 my $sth = $dbh->prepare($stmt);
2175 $sth->execute(@bind);
2181 The methods are simple. There's one for every major SQL operation,
2182 and a constructor you use first. The arguments are specified in a
2183 similar order for each method (table, then fields, then a where
2184 clause) to try and simplify things.
2186 =head2 new(option => 'value')
2188 The C<new()> function takes a list of options and values, and returns
2189 a new B<SQL::Abstract> object which can then be used to generate SQL
2190 through the methods below. The options accepted are:
2196 If set to 'lower', then SQL will be generated in all lowercase. By
2197 default SQL is generated in "textbook" case meaning something like:
2199 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2201 Any setting other than 'lower' is ignored.
2205 This determines what the default comparison operator is. By default
2206 it is C<=>, meaning that a hash like this:
2208 %where = (name => 'nwiger', email => 'nate@wiger.org');
2210 Will generate SQL like this:
2212 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2214 However, you may want loose comparisons by default, so if you set
2215 C<cmp> to C<like> you would get SQL such as:
2217 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2219 You can also override the comparison on an individual basis - see
2220 the huge section on L</"WHERE CLAUSES"> at the bottom.
2222 =item sqltrue, sqlfalse
2224 Expressions for inserting boolean values within SQL statements.
2225 By default these are C<1=1> and C<1=0>. They are used
2226 by the special operators C<-in> and C<-not_in> for generating
2227 correct SQL even when the argument is an empty array (see below).
2231 This determines the default logical operator for multiple WHERE
2232 statements in arrays or hashes. If absent, the default logic is "or"
2233 for arrays, and "and" for hashes. This means that a WHERE
2237 event_date => {'>=', '2/13/99'},
2238 event_date => {'<=', '4/24/03'},
2241 will generate SQL like this:
2243 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2245 This is probably not what you want given this query, though (look
2246 at the dates). To change the "OR" to an "AND", simply specify:
2248 my $sql = SQL::Abstract->new(logic => 'and');
2250 Which will change the above C<WHERE> to:
2252 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2254 The logic can also be changed locally by inserting
2255 a modifier in front of an arrayref:
2257 @where = (-and => [event_date => {'>=', '2/13/99'},
2258 event_date => {'<=', '4/24/03'} ]);
2260 See the L</"WHERE CLAUSES"> section for explanations.
2264 This will automatically convert comparisons using the specified SQL
2265 function for both column and value. This is mostly used with an argument
2266 of C<upper> or C<lower>, so that the SQL will have the effect of
2267 case-insensitive "searches". For example, this:
2269 $sql = SQL::Abstract->new(convert => 'upper');
2270 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2272 Will turn out the following SQL:
2274 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2276 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2277 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2278 not validate this option; it will just pass through what you specify verbatim).
2282 This is a kludge because many databases suck. For example, you can't
2283 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2284 Instead, you have to use C<bind_param()>:
2286 $sth->bind_param(1, 'reg data');
2287 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2289 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2290 which loses track of which field each slot refers to. Fear not.
2292 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2293 Currently, you can specify either C<normal> (default) or C<columns>. If you
2294 specify C<columns>, you will get an array that looks like this:
2296 my $sql = SQL::Abstract->new(bindtype => 'columns');
2297 my($stmt, @bind) = $sql->insert(...);
2300 [ 'column1', 'value1' ],
2301 [ 'column2', 'value2' ],
2302 [ 'column3', 'value3' ],
2305 You can then iterate through this manually, using DBI's C<bind_param()>.
2307 $sth->prepare($stmt);
2310 my($col, $data) = @$_;
2311 if ($col eq 'details' || $col eq 'comments') {
2312 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2313 } elsif ($col eq 'image') {
2314 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2316 $sth->bind_param($i, $data);
2320 $sth->execute; # execute without @bind now
2322 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2323 Basically, the advantage is still that you don't have to care which fields
2324 are or are not included. You could wrap that above C<for> loop in a simple
2325 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2326 get a layer of abstraction over manual SQL specification.
2328 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2329 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2330 will expect the bind values in this format.
2334 This is the character that a table or column name will be quoted
2335 with. By default this is an empty string, but you could set it to
2336 the character C<`>, to generate SQL like this:
2338 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2340 Alternatively, you can supply an array ref of two items, the first being the left
2341 hand quote character, and the second the right hand quote character. For
2342 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2343 that generates SQL like this:
2345 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2347 Quoting is useful if you have tables or columns names that are reserved
2348 words in your database's SQL dialect.
2352 This is the character that will be used to escape L</quote_char>s appearing
2353 in an identifier before it has been quoted.
2355 The parameter default in case of a single L</quote_char> character is the quote
2358 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2359 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2360 of the B<opening (left)> L</quote_char> within the identifier are currently left
2361 untouched. The default for opening-closing-style quotes may change in future
2362 versions, thus you are B<strongly encouraged> to specify the escape character
2367 This is the character that separates a table and column name. It is
2368 necessary to specify this when the C<quote_char> option is selected,
2369 so that tables and column names can be individually quoted like this:
2371 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2373 =item injection_guard
2375 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2376 column name specified in a query structure. This is a safety mechanism to avoid
2377 injection attacks when mishandling user input e.g.:
2379 my %condition_as_column_value_pairs = get_values_from_user();
2380 $sqla->select( ... , \%condition_as_column_value_pairs );
2382 If the expression matches an exception is thrown. Note that literal SQL
2383 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2385 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2387 =item array_datatypes
2389 When this option is true, arrayrefs in INSERT or UPDATE are
2390 interpreted as array datatypes and are passed directly
2392 When this option is false, arrayrefs are interpreted
2393 as literal SQL, just like refs to arrayrefs
2394 (but this behavior is for backwards compatibility; when writing
2395 new queries, use the "reference to arrayref" syntax
2401 Takes a reference to a list of "special operators"
2402 to extend the syntax understood by L<SQL::Abstract>.
2403 See section L</"SPECIAL OPERATORS"> for details.
2407 Takes a reference to a list of "unary operators"
2408 to extend the syntax understood by L<SQL::Abstract>.
2409 See section L</"UNARY OPERATORS"> for details.
2415 =head2 insert($table, \@values || \%fieldvals, \%options)
2417 This is the simplest function. You simply give it a table name
2418 and either an arrayref of values or hashref of field/value pairs.
2419 It returns an SQL INSERT statement and a list of bind values.
2420 See the sections on L</"Inserting and Updating Arrays"> and
2421 L</"Inserting and Updating SQL"> for information on how to insert
2422 with those data types.
2424 The optional C<\%options> hash reference may contain additional
2425 options to generate the insert SQL. Currently supported options
2432 Takes either a scalar of raw SQL fields, or an array reference of
2433 field names, and adds on an SQL C<RETURNING> statement at the end.
2434 This allows you to return data generated by the insert statement
2435 (such as row IDs) without performing another C<SELECT> statement.
2436 Note, however, this is not part of the SQL standard and may not
2437 be supported by all database engines.
2441 =head2 update($table, \%fieldvals, \%where, \%options)
2443 This takes a table, hashref of field/value pairs, and an optional
2444 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2446 See the sections on L</"Inserting and Updating Arrays"> and
2447 L</"Inserting and Updating SQL"> for information on how to insert
2448 with those data types.
2450 The optional C<\%options> hash reference may contain additional
2451 options to generate the update SQL. Currently supported options
2458 See the C<returning> option to
2459 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2463 =head2 select($source, $fields, $where, $order)
2465 This returns a SQL SELECT statement and associated list of bind values, as
2466 specified by the arguments:
2472 Specification of the 'FROM' part of the statement.
2473 The argument can be either a plain scalar (interpreted as a table
2474 name, will be quoted), or an arrayref (interpreted as a list
2475 of table names, joined by commas, quoted), or a scalarref
2476 (literal SQL, not quoted).
2480 Specification of the list of fields to retrieve from
2482 The argument can be either an arrayref (interpreted as a list
2483 of field names, will be joined by commas and quoted), or a
2484 plain scalar (literal SQL, not quoted).
2485 Please observe that this API is not as flexible as that of
2486 the first argument C<$source>, for backwards compatibility reasons.
2490 Optional argument to specify the WHERE part of the query.
2491 The argument is most often a hashref, but can also be
2492 an arrayref or plain scalar --
2493 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2497 Optional argument to specify the ORDER BY part of the query.
2498 The argument can be a scalar, a hashref or an arrayref
2499 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2505 =head2 delete($table, \%where, \%options)
2507 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2508 It returns an SQL DELETE statement and list of bind values.
2510 The optional C<\%options> hash reference may contain additional
2511 options to generate the delete SQL. Currently supported options
2518 See the C<returning> option to
2519 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2523 =head2 where(\%where, $order)
2525 This is used to generate just the WHERE clause. For example,
2526 if you have an arbitrary data structure and know what the
2527 rest of your SQL is going to look like, but want an easy way
2528 to produce a WHERE clause, use this. It returns an SQL WHERE
2529 clause and list of bind values.
2532 =head2 values(\%data)
2534 This just returns the values from the hash C<%data>, in the same
2535 order that would be returned from any of the other above queries.
2536 Using this allows you to markedly speed up your queries if you
2537 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2539 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2541 Warning: This is an experimental method and subject to change.
2543 This returns arbitrarily generated SQL. It's a really basic shortcut.
2544 It will return two different things, depending on return context:
2546 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2547 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2549 These would return the following:
2551 # First calling form
2552 $stmt = "CREATE TABLE test (?, ?)";
2553 @bind = (field1, field2);
2555 # Second calling form
2556 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2558 Depending on what you're trying to do, it's up to you to choose the correct
2559 format. In this example, the second form is what you would want.
2563 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2567 ALTER SESSION SET nls_date_format = 'MM/YY'
2569 You get the idea. Strings get their case twiddled, but everything
2570 else remains verbatim.
2572 =head1 EXPORTABLE FUNCTIONS
2574 =head2 is_plain_value
2576 Determines if the supplied argument is a plain value as understood by this
2581 =item * The value is C<undef>
2583 =item * The value is a non-reference
2585 =item * The value is an object with stringification overloading
2587 =item * The value is of the form C<< { -value => $anything } >>
2591 On failure returns C<undef>, on success returns a B<scalar> reference
2592 to the original supplied argument.
2598 The stringification overloading detection is rather advanced: it takes
2599 into consideration not only the presence of a C<""> overload, but if that
2600 fails also checks for enabled
2601 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2602 on either C<0+> or C<bool>.
2604 Unfortunately testing in the field indicates that this
2605 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2606 but only when very large numbers of stringifying objects are involved.
2607 At the time of writing ( Sep 2014 ) there is no clear explanation of
2608 the direct cause, nor is there a manageably small test case that reliably
2609 reproduces the problem.
2611 If you encounter any of the following exceptions in B<random places within
2612 your application stack> - this module may be to blame:
2614 Operation "ne": no method found,
2615 left argument in overloaded package <something>,
2616 right argument in overloaded package <something>
2620 Stub found while resolving method "???" overloading """" in package <something>
2622 If you fall victim to the above - please attempt to reduce the problem
2623 to something that could be sent to the L<SQL::Abstract developers
2624 |DBIx::Class/GETTING HELP/SUPPORT>
2625 (either publicly or privately). As a workaround in the meantime you can
2626 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2627 value, which will most likely eliminate your problem (at the expense of
2628 not being able to properly detect exotic forms of stringification).
2630 This notice and environment variable will be removed in a future version,
2631 as soon as the underlying problem is found and a reliable workaround is
2636 =head2 is_literal_value
2638 Determines if the supplied argument is a literal value as understood by this
2643 =item * C<\$sql_string>
2645 =item * C<\[ $sql_string, @bind_values ]>
2649 On failure returns C<undef>, on success returns an B<array> reference
2650 containing the unpacked version of the supplied literal SQL and bind values.
2652 =head1 WHERE CLAUSES
2656 This module uses a variation on the idea from L<DBIx::Abstract>. It
2657 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2658 module is that things in arrays are OR'ed, and things in hashes
2661 The easiest way to explain is to show lots of examples. After
2662 each C<%where> hash shown, it is assumed you used:
2664 my($stmt, @bind) = $sql->where(\%where);
2666 However, note that the C<%where> hash can be used directly in any
2667 of the other functions as well, as described above.
2669 =head2 Key-value pairs
2671 So, let's get started. To begin, a simple hash:
2675 status => 'completed'
2678 Is converted to SQL C<key = val> statements:
2680 $stmt = "WHERE user = ? AND status = ?";
2681 @bind = ('nwiger', 'completed');
2683 One common thing I end up doing is having a list of values that
2684 a field can be in. To do this, simply specify a list inside of
2689 status => ['assigned', 'in-progress', 'pending'];
2692 This simple code will create the following:
2694 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2695 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2697 A field associated to an empty arrayref will be considered a
2698 logical false and will generate 0=1.
2700 =head2 Tests for NULL values
2702 If the value part is C<undef> then this is converted to SQL <IS NULL>
2711 $stmt = "WHERE user = ? AND status IS NULL";
2714 To test if a column IS NOT NULL:
2718 status => { '!=', undef },
2721 =head2 Specific comparison operators
2723 If you want to specify a different type of operator for your comparison,
2724 you can use a hashref for a given column:
2728 status => { '!=', 'completed' }
2731 Which would generate:
2733 $stmt = "WHERE user = ? AND status != ?";
2734 @bind = ('nwiger', 'completed');
2736 To test against multiple values, just enclose the values in an arrayref:
2738 status => { '=', ['assigned', 'in-progress', 'pending'] };
2740 Which would give you:
2742 "WHERE status = ? OR status = ? OR status = ?"
2745 The hashref can also contain multiple pairs, in which case it is expanded
2746 into an C<AND> of its elements:
2750 status => { '!=', 'completed', -not_like => 'pending%' }
2753 # Or more dynamically, like from a form
2754 $where{user} = 'nwiger';
2755 $where{status}{'!='} = 'completed';
2756 $where{status}{'-not_like'} = 'pending%';
2758 # Both generate this
2759 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2760 @bind = ('nwiger', 'completed', 'pending%');
2763 To get an OR instead, you can combine it with the arrayref idea:
2767 priority => [ { '=', 2 }, { '>', 5 } ]
2770 Which would generate:
2772 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2773 @bind = ('2', '5', 'nwiger');
2775 If you want to include literal SQL (with or without bind values), just use a
2776 scalar reference or reference to an arrayref as the value:
2779 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2780 date_expires => { '<' => \"now()" }
2783 Which would generate:
2785 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2786 @bind = ('11/26/2008');
2789 =head2 Logic and nesting operators
2791 In the example above,
2792 there is a subtle trap if you want to say something like
2793 this (notice the C<AND>):
2795 WHERE priority != ? AND priority != ?
2797 Because, in Perl you I<can't> do this:
2799 priority => { '!=' => 2, '!=' => 1 }
2801 As the second C<!=> key will obliterate the first. The solution
2802 is to use the special C<-modifier> form inside an arrayref:
2804 priority => [ -and => {'!=', 2},
2808 Normally, these would be joined by C<OR>, but the modifier tells it
2809 to use C<AND> instead. (Hint: You can use this in conjunction with the
2810 C<logic> option to C<new()> in order to change the way your queries
2811 work by default.) B<Important:> Note that the C<-modifier> goes
2812 B<INSIDE> the arrayref, as an extra first element. This will
2813 B<NOT> do what you think it might:
2815 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2817 Here is a quick list of equivalencies, since there is some overlap:
2820 status => {'!=', 'completed', 'not like', 'pending%' }
2821 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2824 status => {'=', ['assigned', 'in-progress']}
2825 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2826 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2830 =head2 Special operators: IN, BETWEEN, etc.
2832 You can also use the hashref format to compare a list of fields using the
2833 C<IN> comparison operator, by specifying the list as an arrayref:
2836 status => 'completed',
2837 reportid => { -in => [567, 2335, 2] }
2840 Which would generate:
2842 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2843 @bind = ('completed', '567', '2335', '2');
2845 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2848 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2849 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2850 'sqltrue' (by default: C<1=1>).
2852 In addition to the array you can supply a chunk of literal sql or
2853 literal sql with bind:
2856 customer => { -in => \[
2857 'SELECT cust_id FROM cust WHERE balance > ?',
2860 status => { -in => \'SELECT status_codes FROM states' },
2866 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2867 AND status IN ( SELECT status_codes FROM states )
2871 Finally, if the argument to C<-in> is not a reference, it will be
2872 treated as a single-element array.
2874 Another pair of operators is C<-between> and C<-not_between>,
2875 used with an arrayref of two values:
2879 completion_date => {
2880 -not_between => ['2002-10-01', '2003-02-06']
2886 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2888 Just like with C<-in> all plausible combinations of literal SQL
2892 start0 => { -between => [ 1, 2 ] },
2893 start1 => { -between => \["? AND ?", 1, 2] },
2894 start2 => { -between => \"lower(x) AND upper(y)" },
2895 start3 => { -between => [
2897 \["upper(?)", 'stuff' ],
2904 ( start0 BETWEEN ? AND ? )
2905 AND ( start1 BETWEEN ? AND ? )
2906 AND ( start2 BETWEEN lower(x) AND upper(y) )
2907 AND ( start3 BETWEEN lower(x) AND upper(?) )
2909 @bind = (1, 2, 1, 2, 'stuff');
2912 These are the two builtin "special operators"; but the
2913 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2915 =head2 Unary operators: bool
2917 If you wish to test against boolean columns or functions within your
2918 database you can use the C<-bool> and C<-not_bool> operators. For
2919 example to test the column C<is_user> being true and the column
2920 C<is_enabled> being false you would use:-
2924 -not_bool => 'is_enabled',
2929 WHERE is_user AND NOT is_enabled
2931 If a more complex combination is required, testing more conditions,
2932 then you should use the and/or operators:-
2937 -not_bool => { two=> { -rlike => 'bar' } },
2938 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2949 (NOT ( three = ? OR three > ? ))
2952 =head2 Nested conditions, -and/-or prefixes
2954 So far, we've seen how multiple conditions are joined with a top-level
2955 C<AND>. We can change this by putting the different conditions we want in
2956 hashes and then putting those hashes in an array. For example:
2961 status => { -like => ['pending%', 'dispatched'] },
2965 status => 'unassigned',
2969 This data structure would create the following:
2971 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2972 OR ( user = ? AND status = ? ) )";
2973 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2976 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2977 to change the logic inside:
2983 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2984 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2991 $stmt = "WHERE ( user = ?
2992 AND ( ( workhrs > ? AND geo = ? )
2993 OR ( workhrs < ? OR geo = ? ) ) )";
2994 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2996 =head3 Algebraic inconsistency, for historical reasons
2998 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2999 operator goes C<outside> of the nested structure; whereas when connecting
3000 several constraints on one column, the C<-and> operator goes
3001 C<inside> the arrayref. Here is an example combining both features:
3004 -and => [a => 1, b => 2],
3005 -or => [c => 3, d => 4],
3006 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3011 WHERE ( ( ( a = ? AND b = ? )
3012 OR ( c = ? OR d = ? )
3013 OR ( e LIKE ? AND e LIKE ? ) ) )
3015 This difference in syntax is unfortunate but must be preserved for
3016 historical reasons. So be careful: the two examples below would
3017 seem algebraically equivalent, but they are not
3020 { -like => 'foo%' },
3021 { -like => '%bar' },
3023 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3026 { col => { -like => 'foo%' } },
3027 { col => { -like => '%bar' } },
3029 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3032 =head2 Literal SQL and value type operators
3034 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3035 side" is a column name and the "right side" is a value (normally rendered as
3036 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3037 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3038 alter this behavior. There are several ways of doing so.
3042 This is a virtual operator that signals the string to its right side is an
3043 identifier (a column name) and not a value. For example to compare two
3044 columns you would write:
3047 priority => { '<', 2 },
3048 requestor => { -ident => 'submitter' },
3053 $stmt = "WHERE priority < ? AND requestor = submitter";
3056 If you are maintaining legacy code you may see a different construct as
3057 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3062 This is a virtual operator that signals that the construct to its right side
3063 is a value to be passed to DBI. This is for example necessary when you want
3064 to write a where clause against an array (for RDBMS that support such
3065 datatypes). For example:
3068 array => { -value => [1, 2, 3] }
3073 $stmt = 'WHERE array = ?';
3074 @bind = ([1, 2, 3]);
3076 Note that if you were to simply say:
3082 the result would probably not be what you wanted:
3084 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3089 Finally, sometimes only literal SQL will do. To include a random snippet
3090 of SQL verbatim, you specify it as a scalar reference. Consider this only
3091 as a last resort. Usually there is a better way. For example:
3094 priority => { '<', 2 },
3095 requestor => { -in => \'(SELECT name FROM hitmen)' },
3100 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3103 Note that in this example, you only get one bind parameter back, since
3104 the verbatim SQL is passed as part of the statement.
3108 Never use untrusted input as a literal SQL argument - this is a massive
3109 security risk (there is no way to check literal snippets for SQL
3110 injections and other nastyness). If you need to deal with untrusted input
3111 use literal SQL with placeholders as described next.
3113 =head3 Literal SQL with placeholders and bind values (subqueries)
3115 If the literal SQL to be inserted has placeholders and bind values,
3116 use a reference to an arrayref (yes this is a double reference --
3117 not so common, but perfectly legal Perl). For example, to find a date
3118 in Postgres you can use something like this:
3121 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3126 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3129 Note that you must pass the bind values in the same format as they are returned
3130 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3131 to C<columns>, you must provide the bind values in the
3132 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3133 scalar value; most commonly the column name, but you can use any scalar value
3134 (including references and blessed references), L<SQL::Abstract> will simply
3135 pass it through intact. So if C<bindtype> is set to C<columns> the above
3136 example will look like:
3139 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3142 Literal SQL is especially useful for nesting parenthesized clauses in the
3143 main SQL query. Here is a first example:
3145 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3149 bar => \["IN ($sub_stmt)" => @sub_bind],
3154 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3155 WHERE c2 < ? AND c3 LIKE ?))";
3156 @bind = (1234, 100, "foo%");
3158 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3159 are expressed in the same way. Of course the C<$sub_stmt> and
3160 its associated bind values can be generated through a former call
3163 my ($sub_stmt, @sub_bind)
3164 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3165 c3 => {-like => "foo%"}});
3168 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3171 In the examples above, the subquery was used as an operator on a column;
3172 but the same principle also applies for a clause within the main C<%where>
3173 hash, like an EXISTS subquery:
3175 my ($sub_stmt, @sub_bind)
3176 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3177 my %where = ( -and => [
3179 \["EXISTS ($sub_stmt)" => @sub_bind],
3184 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3185 WHERE c1 = ? AND c2 > t0.c0))";
3189 Observe that the condition on C<c2> in the subquery refers to
3190 column C<t0.c0> of the main query: this is I<not> a bind
3191 value, so we have to express it through a scalar ref.
3192 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3193 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3194 what we wanted here.
3196 Finally, here is an example where a subquery is used
3197 for expressing unary negation:
3199 my ($sub_stmt, @sub_bind)
3200 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3201 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3203 lname => {like => '%son%'},
3204 \["NOT ($sub_stmt)" => @sub_bind],
3209 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3210 @bind = ('%son%', 10, 20)
3212 =head3 Deprecated usage of Literal SQL
3214 Below are some examples of archaic use of literal SQL. It is shown only as
3215 reference for those who deal with legacy code. Each example has a much
3216 better, cleaner and safer alternative that users should opt for in new code.
3222 my %where = ( requestor => \'IS NOT NULL' )
3224 $stmt = "WHERE requestor IS NOT NULL"
3226 This used to be the way of generating NULL comparisons, before the handling
3227 of C<undef> got formalized. For new code please use the superior syntax as
3228 described in L</Tests for NULL values>.
3232 my %where = ( requestor => \'= submitter' )
3234 $stmt = "WHERE requestor = submitter"
3236 This used to be the only way to compare columns. Use the superior L</-ident>
3237 method for all new code. For example an identifier declared in such a way
3238 will be properly quoted if L</quote_char> is properly set, while the legacy
3239 form will remain as supplied.
3243 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3245 $stmt = "WHERE completed > ? AND is_ready"
3246 @bind = ('2012-12-21')
3248 Using an empty string literal used to be the only way to express a boolean.
3249 For all new code please use the much more readable
3250 L<-bool|/Unary operators: bool> operator.
3256 These pages could go on for a while, since the nesting of the data
3257 structures this module can handle are pretty much unlimited (the
3258 module implements the C<WHERE> expansion as a recursive function
3259 internally). Your best bet is to "play around" with the module a
3260 little to see how the data structures behave, and choose the best
3261 format for your data based on that.
3263 And of course, all the values above will probably be replaced with
3264 variables gotten from forms or the command line. After all, if you
3265 knew everything ahead of time, you wouldn't have to worry about
3266 dynamically-generating SQL and could just hardwire it into your
3269 =head1 ORDER BY CLAUSES
3271 Some functions take an order by clause. This can either be a scalar (just a
3272 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3273 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3276 Given | Will Generate
3277 ---------------------------------------------------------------
3279 'colA' | ORDER BY colA
3281 [qw/colA colB/] | ORDER BY colA, colB
3283 {-asc => 'colA'} | ORDER BY colA ASC
3285 {-desc => 'colB'} | ORDER BY colB DESC
3287 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3289 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3291 \'colA DESC' | ORDER BY colA DESC
3293 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3294 | /* ...with $x bound to ? */
3297 { -asc => 'colA' }, | colA ASC,
3298 { -desc => [qw/colB/] }, | colB DESC,
3299 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3300 \'colE DESC', | colE DESC,
3301 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3302 ] | /* ...with $x bound to ? */
3303 ===============================================================
3307 =head1 SPECIAL OPERATORS
3309 my $sqlmaker = SQL::Abstract->new(special_ops => [
3313 my ($self, $field, $op, $arg) = @_;
3319 handler => 'method_name',
3323 A "special operator" is a SQL syntactic clause that can be
3324 applied to a field, instead of a usual binary operator.
3327 WHERE field IN (?, ?, ?)
3328 WHERE field BETWEEN ? AND ?
3329 WHERE MATCH(field) AGAINST (?, ?)
3331 Special operators IN and BETWEEN are fairly standard and therefore
3332 are builtin within C<SQL::Abstract> (as the overridable methods
3333 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3334 like the MATCH .. AGAINST example above which is specific to MySQL,
3335 you can write your own operator handlers - supply a C<special_ops>
3336 argument to the C<new> method. That argument takes an arrayref of
3337 operator definitions; each operator definition is a hashref with two
3344 the regular expression to match the operator
3348 Either a coderef or a plain scalar method name. In both cases
3349 the expected return is C<< ($sql, @bind) >>.
3351 When supplied with a method name, it is simply called on the
3352 L<SQL::Abstract> object as:
3354 $self->$method_name($field, $op, $arg)
3358 $field is the LHS of the operator
3359 $op is the part that matched the handler regex
3362 When supplied with a coderef, it is called as:
3364 $coderef->($self, $field, $op, $arg)
3369 For example, here is an implementation
3370 of the MATCH .. AGAINST syntax for MySQL
3372 my $sqlmaker = SQL::Abstract->new(special_ops => [
3374 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3375 {regex => qr/^match$/i,
3377 my ($self, $field, $op, $arg) = @_;
3378 $arg = [$arg] if not ref $arg;
3379 my $label = $self->_quote($field);
3380 my ($placeholder) = $self->_convert('?');
3381 my $placeholders = join ", ", (($placeholder) x @$arg);
3382 my $sql = $self->_sqlcase('match') . " ($label) "
3383 . $self->_sqlcase('against') . " ($placeholders) ";
3384 my @bind = $self->_bindtype($field, @$arg);
3385 return ($sql, @bind);
3392 =head1 UNARY OPERATORS
3394 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3398 my ($self, $op, $arg) = @_;
3404 handler => 'method_name',
3408 A "unary operator" is a SQL syntactic clause that can be
3409 applied to a field - the operator goes before the field
3411 You can write your own operator handlers - supply a C<unary_ops>
3412 argument to the C<new> method. That argument takes an arrayref of
3413 operator definitions; each operator definition is a hashref with two
3420 the regular expression to match the operator
3424 Either a coderef or a plain scalar method name. In both cases
3425 the expected return is C<< $sql >>.
3427 When supplied with a method name, it is simply called on the
3428 L<SQL::Abstract> object as:
3430 $self->$method_name($op, $arg)
3434 $op is the part that matched the handler regex
3435 $arg is the RHS or argument of the operator
3437 When supplied with a coderef, it is called as:
3439 $coderef->($self, $op, $arg)
3447 Thanks to some benchmarking by Mark Stosberg, it turns out that
3448 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3449 I must admit this wasn't an intentional design issue, but it's a
3450 byproduct of the fact that you get to control your C<DBI> handles
3453 To maximize performance, use a code snippet like the following:
3455 # prepare a statement handle using the first row
3456 # and then reuse it for the rest of the rows
3458 for my $href (@array_of_hashrefs) {
3459 $stmt ||= $sql->insert('table', $href);
3460 $sth ||= $dbh->prepare($stmt);
3461 $sth->execute($sql->values($href));
3464 The reason this works is because the keys in your C<$href> are sorted
3465 internally by B<SQL::Abstract>. Thus, as long as your data retains
3466 the same structure, you only have to generate the SQL the first time
3467 around. On subsequent queries, simply use the C<values> function provided
3468 by this module to return your values in the correct order.
3470 However this depends on the values having the same type - if, for
3471 example, the values of a where clause may either have values
3472 (resulting in sql of the form C<column = ?> with a single bind
3473 value), or alternatively the values might be C<undef> (resulting in
3474 sql of the form C<column IS NULL> with no bind value) then the
3475 caching technique suggested will not work.
3479 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3480 really like this part (I do, at least). Building up a complex query
3481 can be as simple as the following:
3488 use CGI::FormBuilder;
3491 my $form = CGI::FormBuilder->new(...);
3492 my $sql = SQL::Abstract->new;
3494 if ($form->submitted) {
3495 my $field = $form->field;
3496 my $id = delete $field->{id};
3497 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3500 Of course, you would still have to connect using C<DBI> to run the
3501 query, but the point is that if you make your form look like your
3502 table, the actual query script can be extremely simplistic.
3504 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3505 a fast interface to returning and formatting data. I frequently
3506 use these three modules together to write complex database query
3507 apps in under 50 lines.
3509 =head1 HOW TO CONTRIBUTE
3511 Contributions are always welcome, in all usable forms (we especially
3512 welcome documentation improvements). The delivery methods include git-
3513 or unified-diff formatted patches, GitHub pull requests, or plain bug
3514 reports either via RT or the Mailing list. Contributors are generally
3515 granted full access to the official repository after their first several
3516 patches pass successful review.
3518 This project is maintained in a git repository. The code and related tools are
3519 accessible at the following locations:
3523 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3525 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3527 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3529 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3535 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3536 Great care has been taken to preserve the I<published> behavior
3537 documented in previous versions in the 1.* family; however,
3538 some features that were previously undocumented, or behaved
3539 differently from the documentation, had to be changed in order
3540 to clarify the semantics. Hence, client code that was relying
3541 on some dark areas of C<SQL::Abstract> v1.*
3542 B<might behave differently> in v1.50.
3544 The main changes are:
3550 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3554 support for the { operator => \"..." } construct (to embed literal SQL)
3558 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3562 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3566 defensive programming: check arguments
3570 fixed bug with global logic, which was previously implemented
3571 through global variables yielding side-effects. Prior versions would
3572 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3573 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3574 Now this is interpreted
3575 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3580 fixed semantics of _bindtype on array args
3584 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3585 we just avoid shifting arrays within that tree.
3589 dropped the C<_modlogic> function
3593 =head1 ACKNOWLEDGEMENTS
3595 There are a number of individuals that have really helped out with
3596 this module. Unfortunately, most of them submitted bugs via CPAN
3597 so I have no idea who they are! But the people I do know are:
3599 Ash Berlin (order_by hash term support)
3600 Matt Trout (DBIx::Class support)
3601 Mark Stosberg (benchmarking)
3602 Chas Owens (initial "IN" operator support)
3603 Philip Collins (per-field SQL functions)
3604 Eric Kolve (hashref "AND" support)
3605 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3606 Dan Kubb (support for "quote_char" and "name_sep")
3607 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3608 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3609 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3610 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3611 Oliver Charles (support for "RETURNING" after "INSERT")
3617 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3621 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3623 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3625 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3626 While not an official support venue, C<DBIx::Class> makes heavy use of
3627 C<SQL::Abstract>, and as such list members there are very familiar with
3628 how to create queries.
3632 This module is free software; you may copy this under the same
3633 terms as perl itself (either the GNU General Public License or
3634 the Artistic License)