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 'between' => '_expand_between',
150 'not_between' => '_expand_between',
151 'in' => '_expand_in',
152 'not_in' => '_expand_in',
153 'nest' => '_expand_nest',
154 (map +($_ => '_expand_op_andor'), ('and', 'or')),
155 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
156 'ident' => '_expand_ident',
157 'value' => '_expand_value',
160 (map +($_, "_render_$_"),
161 qw(op func bind ident literal row values keyword)),
164 (map +($_ => '_render_op_between'), 'between', 'not_between'),
165 (map +($_ => '_render_op_in'), 'in', 'not_in'),
166 (map +($_ => '_render_unop_postfix'),
167 'is_null', 'is_not_null', 'asc', 'desc',
169 (not => '_render_unop_paren'),
170 (map +($_ => '_render_op_andor'), qw(and or)),
171 ',' => '_render_op_multop',
174 delete => [ qw(target where returning) ],
175 update => [ qw(target set where returning) ],
176 insert => [ qw(target fields from returning) ],
177 select => [ qw(select from where order_by) ],
180 'delete.from' => '_expand_delete_clause_target',
181 'update.update' => '_expand_update_clause_target',
182 'insert.into' => '_expand_insert_clause_target',
183 'insert.values' => '_expand_insert_clause_from',
186 'delete.target' => '_render_delete_clause_target',
187 'update.target' => '_render_update_clause_target',
188 'insert.target' => '_render_insert_clause_target',
189 'insert.fields' => '_render_insert_clause_fields',
190 'insert.from' => '_render_insert_clause_from',
194 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
195 $Defaults{expand}{$stmt} = '_expand_statement';
196 $Defaults{render}{$stmt} = '_render_statement';
197 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
198 $Defaults{expand_clause}{"${stmt}.${clause}"}
199 = "_expand_${stmt}_clause_${clause}";
205 my $class = ref($self) || $self;
206 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
208 # choose our case by keeping an option around
209 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
211 # default logic for interpreting arrayrefs
212 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
214 # how to return bind vars
215 $opt{bindtype} ||= 'normal';
217 # default comparison is "=", but can be overridden
220 # try to recognize which are the 'equality' and 'inequality' ops
221 # (temporary quickfix (in 2007), should go through a more seasoned API)
222 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
223 $opt{inequality_op} = qr/^( != | <> )$/ix;
225 $opt{like_op} = qr/^ (is_)?r?like $/xi;
226 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
229 $opt{sqltrue} ||= '1=1';
230 $opt{sqlfalse} ||= '0=1';
233 $opt{special_ops} ||= [];
236 $opt{unary_ops} ||= [];
238 # rudimentary sanity-check for user supplied bits treated as functions/operators
239 # If a purported function matches this regular expression, an exception is thrown.
240 # Literal SQL is *NOT* subject to this check, only functions (and column names
241 # when quoting is not in effect)
244 # need to guard against ()'s in column names too, but this will break tons of
245 # hacks... ideas anyone?
246 $opt{injection_guard} ||= qr/
252 $opt{expand_unary} = {};
254 foreach my $name (sort keys %Defaults) {
255 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
258 if ($class ne __PACKAGE__) {
260 # check for overriden methods
262 foreach my $type (qw(insert update delete)) {
263 my $method = "_${type}_returning";
264 if (__PACKAGE__->can($method) ne $class->can($method)) {
265 my $clause = "${type}.returning";
266 $opt{expand_clause}{$clause} = sub { $_[2] },
267 $opt{render_clause}{$clause}
268 = sub { [ $_[0]->$method($_[3]) ] };
271 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
272 $opt{expand_clause}{'select.from'} = sub {
273 return +{ -literal => [ $_[0]->_table($_[2]) ] };
276 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
277 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
278 $opt{render_clause}{'select.order_by'} = sub {
279 [ $_[0]->_order_by($_[2]) ];
282 if ($class->isa('DBIx::Class::SQLMaker')) {
283 $opt{warn_once_on_nest} = 1;
284 $opt{disable_old_special_ops} = 1;
285 $opt{render_clause}{'select.where'} = sub {
286 my ($sql, @bind) = $_[0]->where($_[2]);
287 s/\A\s+//, s/\s+\Z// for $sql;
288 return [ $sql, @bind ];
293 if ($opt{lazy_join_sql_parts}) {
294 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
295 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
298 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
300 return bless \%opt, $class;
304 my ($self, $name, $key, $value) = @_;
305 return $self->{$name}{$key} unless @_ > 3;
306 $self->{$name}{$key} = $value;
311 foreach my $type (qw(
312 expand op_expand render op_render clause_expand clause_render
314 my $name = join '_', reverse split '_', $type;
315 my $singular = "${type}er";
316 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
317 or die "Method builder failed for ${singular}: $@";
318 eval qq{sub wrap_${singular} {
319 my (\$self, \$key, \$builder) = \@_;
320 my \$orig = \$self->_ext_rw('${name}', \$key);
323 \$builder->(\$orig, '${name}', \$key)
325 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
326 eval qq{sub ${singular}s {
327 my (\$self, \@args) = \@_;
328 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
329 \$self->_ext_rw('${name}', \$this_key, \$this_value);
332 }; 1 } or die "Method builder failed for ${singular}s: $@";
333 eval qq{sub wrap_${singular}s {
334 my (\$self, \@args) = \@_;
335 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
336 my \$orig = \$self->_ext_rw('${name}', \$this_key);
338 '${name}', \$this_key,
339 \$this_builder->(\$orig, '${name}', \$this_key),
343 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
344 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
345 or die "Method builder failed for ${singular}_list: $@";
349 sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
351 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
354 my ($self, $of, @clauses) = @_;
356 return @{$self->{clauses_of}{$of}||[]};
358 if (ref($clauses[0]) eq 'CODE') {
359 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
361 $self->{clauses_of}{$of} = \@clauses;
370 ref($self->{$_}) eq 'HASH'
379 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
380 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
382 sub _assert_pass_injection_guard {
383 if ($_[1] =~ $_[0]->{injection_guard}) {
384 my $class = ref $_[0];
385 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
386 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
387 . "{injection_guard} attribute to ${class}->new()"
392 #======================================================================
394 #======================================================================
397 my ($self, $table, $data, $options) = @_;
400 if (ref($table) eq 'HASH') {
403 my %clauses = (target => $table, values => $data, %{$options||{}});
407 my @rendered = $self->render_statement({ -insert => $stmt });
408 return wantarray ? @rendered : $rendered[0];
411 sub _expand_insert_clause_target {
412 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
415 sub _expand_insert_clause_fields {
417 $_[0]->expand_maybe_list_expr($_[2], -ident)
418 ] } if ref($_[2]) eq 'ARRAY';
419 return $_[2]; # should maybe still expand somewhat?
422 sub _expand_insert_clause_from {
423 my ($self, undef, $data) = @_;
424 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
425 return $self->expand_expr($data);
427 return $data if ref($data) eq 'HASH' and $data->{-row};
428 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
430 from => { -values => [ $v_aqt ] },
431 ($f_aqt ? (fields => $f_aqt) : ()),
435 sub _expand_insert_clause_returning {
436 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
439 sub _expand_insert_values {
440 my ($self, $data) = @_;
441 if (is_literal_value($data)) {
442 (undef, $self->expand_expr($data));
444 my ($fields, $values) = (
445 ref($data) eq 'HASH' ?
446 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
450 # no names (arrayref) means can't generate bindtype
451 !($fields) && $self->{bindtype} eq 'columns'
452 && belch "can't do 'columns' bindtype when called with arrayref";
456 ? $self->expand_expr({ -row => $fields }, -ident)
461 local our $Cur_Col_Meta = $fields->[$_];
462 $self->_expand_insert_value($values->[$_])
469 sub _render_insert_clause_fields {
470 return $_[0]->render_aqt($_[2]);
473 sub _render_insert_clause_target {
474 my ($self, undef, $from) = @_;
475 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
478 sub _render_insert_clause_from {
479 return $_[0]->render_aqt($_[2], 1);
482 # So that subclasses can override INSERT ... RETURNING separately from
483 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
484 sub _insert_returning { shift->_returning(@_) }
486 sub _redispatch_returning {
487 my ($self, $type, undef, $returning) = @_;
488 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
492 my ($self, $options) = @_;
494 my $f = $options->{returning};
496 my ($sql, @bind) = @{ $self->render_aqt(
497 $self->expand_maybe_list_expr($f, -ident)
499 return ($self->_sqlcase(' returning ').$sql, @bind);
502 sub _expand_insert_value {
505 my $k = our $Cur_Col_Meta;
507 if (ref($v) eq 'ARRAY') {
508 if ($self->{array_datatypes}) {
509 return +{ -bind => [ $k, $v ] };
511 my ($sql, @bind) = @$v;
512 $self->_assert_bindval_matches_bindtype(@bind);
513 return +{ -literal => $v };
515 if (ref($v) eq 'HASH') {
516 if (grep !/^-/, keys %$v) {
517 belch "HASH ref as bind value in insert is not supported";
518 return +{ -bind => [ $k, $v ] };
522 return +{ -bind => [ $k, undef ] };
524 return $self->expand_expr($v);
529 #======================================================================
531 #======================================================================
534 my ($self, $table, $set, $where, $options) = @_;
537 if (ref($table) eq 'HASH') {
541 @clauses{qw(target set where)} = ($table, $set, $where);
542 puke "Unsupported data type specified to \$sql->update"
543 unless ref($clauses{set}) eq 'HASH';
544 @clauses{keys %$options} = values %$options;
548 my @rendered = $self->render_statement({ -update => $stmt });
549 return wantarray ? @rendered : $rendered[0];
552 sub _render_update_clause_target {
553 my ($self, undef, $target) = @_;
554 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
557 sub _update_set_values {
558 my ($self, $data) = @_;
560 return @{ $self->render_aqt(
561 $self->_expand_update_set_values(undef, $data),
565 sub _expand_update_set_values {
566 my ($self, undef, $data) = @_;
567 $self->expand_maybe_list_expr( [
570 $set = { -bind => $_ } unless defined $set;
571 +{ -op => [ '=', { -ident => $k }, $set ] };
577 ? ($self->{array_datatypes}
578 ? [ $k, +{ -bind => [ $k, $v ] } ]
579 : [ $k, +{ -literal => $v } ])
581 local our $Cur_Col_Meta = $k;
582 [ $k, $self->_expand_expr($v) ]
589 sub _expand_update_clause_target {
590 my ($self, undef, $target) = @_;
591 +(target => $self->expand_maybe_list_expr($target, -ident));
594 sub _expand_update_clause_set {
595 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
596 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
599 sub _expand_update_clause_where {
600 +(where => $_[0]->expand_expr($_[2]));
603 sub _expand_update_clause_returning {
604 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
607 # So that subclasses can override UPDATE ... RETURNING separately from
609 sub _update_returning { shift->_returning(@_) }
613 #======================================================================
615 #======================================================================
618 my ($self, @args) = @_;
620 if (ref(my $sel = $args[0]) eq 'HASH') {
624 @clauses{qw(from select where order_by)} = @args;
626 # This oddity is to literalify since historically SQLA doesn't quote
627 # a single identifier argument, so we convert it into a literal
629 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
630 unless ref($clauses{select});
635 my @rendered = $self->render_statement({ -select => $stmt });
636 return wantarray ? @rendered : $rendered[0];
639 sub _expand_select_clause_select {
640 my ($self, undef, $select) = @_;
641 +(select => $self->expand_maybe_list_expr($select, -ident));
644 sub _expand_select_clause_from {
645 my ($self, undef, $from) = @_;
646 +(from => $self->expand_maybe_list_expr($from, -ident));
649 sub _expand_select_clause_where {
650 my ($self, undef, $where) = @_;
653 if (my $conv = $self->{convert}) {
665 ->wrap_expander(bind => $_wrap)
666 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
667 ->wrap_expander(func => sub {
670 my ($self, $type, $thing) = @_;
671 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
672 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
675 or $thing->[1]{-value}
676 or $thing->[1]{-bind})
678 return { -func => $thing }; # already went through our expander
680 return $self->$orig($type, $thing);
688 return +(where => $sqla->expand_expr($where));
691 sub _expand_select_clause_order_by {
692 my ($self, undef, $order_by) = @_;
693 +(order_by => $self->_expand_order_by($order_by));
697 my ($self, $fields) = @_;
698 return $fields unless ref($fields);
699 return @{ $self->render_aqt(
700 $self->expand_maybe_list_expr($fields, '-ident')
704 #======================================================================
706 #======================================================================
709 my ($self, $table, $where, $options) = @_;
712 if (ref($table) eq 'HASH') {
715 my %clauses = (target => $table, where => $where, %{$options||{}});
719 my @rendered = $self->render_statement({ -delete => $stmt });
720 return wantarray ? @rendered : $rendered[0];
723 # So that subclasses can override DELETE ... RETURNING separately from
725 sub _delete_returning { shift->_returning(@_) }
727 sub _expand_delete_clause_target {
728 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
731 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
733 sub _expand_delete_clause_returning {
734 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
737 sub _render_delete_clause_target {
738 my ($self, undef, $from) = @_;
739 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
742 #======================================================================
744 #======================================================================
748 # Finally, a separate routine just to handle WHERE clauses
750 my ($self, $where, $order) = @_;
752 local $self->{convert_where} = $self->{convert};
755 my ($sql, @bind) = defined($where)
756 ? $self->_recurse_where($where)
758 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
762 my ($order_sql, @order_bind) = $self->_order_by($order);
764 push @bind, @order_bind;
767 return wantarray ? ($sql, @bind) : $sql;
770 { our $Default_Scalar_To = -value }
773 my ($self, $expr, $default_scalar_to) = @_;
774 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
775 $self->_expand_expr($expr);
779 my ($self, $aqt, $top_level) = @_;
780 my ($k, $v, @rest) = %$aqt;
782 die "Not a node type: $k" unless $k =~ s/^-//;
783 if (my $meth = $self->{render}{$k}) {
784 local our $Render_Top_Level = $top_level;
785 return $self->$meth($k, $v);
787 die "notreached: $k";
791 my ($self, $expr, $default_scalar_to) = @_;
792 return @{ $self->render_aqt(
793 $self->expand_expr($expr, $default_scalar_to)
797 sub render_statement {
798 my ($self, $expr, $default_scalar_to) = @_;
800 $self->expand_expr($expr, $default_scalar_to), 1
804 sub _expand_statement {
805 my ($self, $type, $args) = @_;
806 my $ec = $self->{expand_clause};
809 $args->{$type} = delete $args->{_}
811 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
812 return +{ "-${type}" => +{
814 my $val = $args->{$_};
815 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
816 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
821 } elsif ($has_clause{$_}) {
822 ($_ => $self->expand_expr($val))
830 sub _render_statement {
831 my ($self, $type, $args) = @_;
833 foreach my $clause (@{$self->{clauses_of}{$type}}) {
834 next unless my $clause_expr = $args->{$clause};
836 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
837 $self->$rdr($clause, $clause_expr, $args);
839 my $r = $self->render_aqt($clause_expr, 1);
840 next unless defined $r->[0] and length $r->[0];
841 $self->join_query_parts(' ',
842 { -keyword => $clause },
849 my $q = $self->join_query_parts(' ', @parts);
850 return $self->join_query_parts('',
851 (our $Render_Top_Level ? $q : ('(', $q, ')'))
856 my ($self, $raw) = @_;
858 return $op if grep $_->{$op}, @{$self}{qw(is_op expand_op render_op)};
859 s/^-(?=.)//, s/\s+/_/g for $op;
864 my ($self, $expr) = @_;
865 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
866 return undef unless defined($expr);
867 if (ref($expr) eq 'HASH') {
868 return undef unless my $kc = keys %$expr;
870 return $self->_expand_op_andor(and => $expr);
872 my ($key, $value) = %$expr;
873 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
874 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
875 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
877 return $self->_expand_hashpair($key, $value);
879 if (ref($expr) eq 'ARRAY') {
880 return $self->_expand_op_andor(lc($self->{logic}), $expr);
882 if (my $literal = is_literal_value($expr)) {
883 return +{ -literal => $literal };
885 if (!ref($expr) or Scalar::Util::blessed($expr)) {
886 return $self->_expand_scalar($expr);
891 sub _expand_hashpair {
892 my ($self, $k, $v) = @_;
893 unless (defined($k) and length($k)) {
894 if (defined($k) and my $literal = is_literal_value($v)) {
895 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
896 return { -literal => $literal };
898 puke "Supplying an empty left hand side argument is not supported";
901 return $self->_expand_hashpair_op($k, $v);
902 } elsif ($k =~ /^[^\w]/i) {
903 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
904 return $self->_expand_op(
905 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
908 return $self->_expand_hashpair_ident($k, $v);
911 sub _expand_hashpair_ident {
912 my ($self, $k, $v) = @_;
914 local our $Cur_Col_Meta = $k;
916 # hash with multiple or no elements is andor
918 if (ref($v) eq 'HASH' and keys %$v != 1) {
919 return $self->_expand_op_andor(and => $v, $k);
922 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
924 if (is_undef_value($v)) {
925 return $self->_expand_hashpair_cmp($k => undef);
928 # scalars and objects get expanded as whatever requested or values
930 if (!ref($v) or Scalar::Util::blessed($v)) {
931 return $self->_expand_hashpair_scalar($k, $v);
934 # single key hashref is a hashtriple
936 if (ref($v) eq 'HASH') {
937 return $self->_expand_hashtriple($k, %$v);
940 # arrayref needs re-engineering over the elements
942 if (ref($v) eq 'ARRAY') {
943 return $self->sqlfalse unless @$v;
944 $self->_debug("ARRAY($k) means distribute over elements");
946 $v->[0] =~ /^-(and|or)$/i
947 ? (shift(@{$v = [ @$v ]}), $1)
948 : lc($self->{logic} || 'OR')
950 return $self->_expand_op_andor(
955 if (my $literal = is_literal_value($v)) {
957 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
960 my ($sql, @bind) = @$literal;
961 if ($self->{bindtype} eq 'columns') {
963 $self->_assert_bindval_matches_bindtype($_);
966 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
972 my ($self, $expr) = @_;
974 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
977 sub _expand_hashpair_scalar {
978 my ($self, $k, $v) = @_;
980 return $self->_expand_hashpair_cmp(
981 $k, $self->_expand_scalar($v),
985 sub _expand_hashpair_op {
986 my ($self, $k, $v) = @_;
988 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
990 my $op = $self->_normalize_op($k);
992 my $wsop = join(' ', split '_', $op);
994 my $is_special = List::Util::first { $wsop =~ $_->{regex} }
995 @{$self->{special_ops}};
999 # the old special op system requires illegality for top-level use
1002 (our $Expand_Depth) == 1
1006 $self->{disable_old_special_ops}
1007 and List::Util::first { $wsop =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1011 puke "Illegal use of top-level '-$wsop'"
1015 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1016 return $self->$exp($op, $v);
1019 if ($self->{render}{$op}) {
1020 return { "-${op}" => $v };
1023 # Ops prefixed with -not_ get converted
1025 if (my ($rest) = $op =~/^not_(.*)$/) {
1028 $self->_expand_expr({ "-${rest}", $v })
1034 # the old unary op system means we should touch nothing and let it work
1036 my $op = join(' ', split '_', $op);
1038 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1039 return { -op => [ $op, $v ] };
1043 my $type = $is_special || $self->{render_op}{$op} ? -op : -func;
1045 if ($self->{restore_old_unop_handling}) {
1052 and (keys %$v)[0] =~ /^-/
1053 and not $self->{render_op}{$op}
1062 if ($type eq -func and ref($v) eq 'ARRAY') {
1063 return $self->_expand_expr({ -func => [ $op, @$v ] });
1066 return $self->_expand_expr({ $type => [ $op, $v ] });
1069 sub _expand_hashpair_cmp {
1070 my ($self, $k, $v) = @_;
1071 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1074 sub _expand_hashtriple {
1075 my ($self, $k, $vk, $vv) = @_;
1077 my $ik = $self->_expand_expr({ -ident => $k });
1079 my $op = $self->_normalize_op($vk);
1080 $self->_assert_pass_injection_guard($op);
1082 if ($op =~ s/ _? \d+ $//x ) {
1083 return $self->_expand_expr($k, { $vk, $vv });
1085 if (my $x = $self->{expand_op}{$op}) {
1086 local our $Cur_Col_Meta = $k;
1087 return $self->$x($op, $vv, $k);
1091 my $op = join(' ', split '_', $op);
1093 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1094 return { -op => [ $op, $ik, $vv ] };
1096 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1100 { -op => [ $op, $vv ] }
1104 if (ref($vv) eq 'ARRAY') {
1106 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1107 ? (shift(@raw), lc $1) : 'or';
1108 my @values = map +{ $vk => $_ }, @raw;
1110 $op =~ $self->{inequality_op}
1111 or $op =~ $self->{not_like_op}
1113 if (lc($logic) eq 'or' and @values > 1) {
1114 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1115 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1116 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1121 # try to DWIM on equality operators
1122 return ($self->_dwim_op_to_is($op,
1123 "Supplying an empty arrayref to '%s' is deprecated",
1124 "operator '%s' applied on an empty array (field '$k')"
1125 ) ? $self->sqlfalse : $self->sqltrue);
1127 return $self->_expand_op_andor($logic => \@values, $k);
1129 if (is_undef_value($vv)) {
1130 my $is = ($self->_dwim_op_to_is($op,
1131 "Supplying an undefined argument to '%s' is deprecated",
1132 "unexpected operator '%s' with undef operand",
1133 ) ? 'is' : 'is not');
1135 return $self->_expand_hashpair($k => { $is, undef });
1137 local our $Cur_Col_Meta = $k;
1141 $self->_expand_expr($vv)
1145 sub _dwim_op_to_is {
1146 my ($self, $raw, $empty, $fail) = @_;
1148 my $op = $self->_normalize_op($raw);
1150 if ($op =~ /^not$/i) {
1153 if ($op =~ $self->{equality_op}) {
1156 if ($op =~ $self->{like_op}) {
1157 belch(sprintf $empty, uc(join ' ', split '_', $op));
1160 if ($op =~ $self->{inequality_op}) {
1163 if ($op =~ $self->{not_like_op}) {
1164 belch(sprintf $empty, uc(join ' ', split '_', $op));
1167 puke(sprintf $fail, $op);
1171 my ($self, undef, $args) = @_;
1172 my ($func, @args) = @$args;
1173 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1177 my ($self, undef, $body, $k) = @_;
1178 return $self->_expand_hashpair_cmp(
1179 $k, { -ident => $body }
1181 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1182 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1184 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1185 ref($body) ? @$body : $body;
1186 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1187 unless ($self->{quote_char}) {
1188 $self->_assert_pass_injection_guard($_) for @parts;
1190 return +{ -ident => \@parts };
1194 return $_[0]->_expand_hashpair_cmp(
1195 $_[3], { -value => $_[2] },
1196 ) if defined($_[3]);
1197 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1201 my ($self, undef, $args) = @_;
1202 +{ -row => [ map $self->expand_expr($_), @$args ] };
1206 my ($self, undef, $args) = @_;
1207 my ($op, @opargs) = @$args;
1208 if (my $exp = $self->{expand_op}{$op}) {
1209 return $self->$exp($op, \@opargs);
1211 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1215 my ($self, undef, $v) = @_;
1217 return $self->_expand_expr($v);
1219 puke "-bool => undef not supported" unless defined($v);
1220 return $self->_expand_expr({ -ident => $v });
1223 sub _expand_op_andor {
1224 my ($self, $logop, $v, $k) = @_;
1226 $v = [ map +{ $k, $_ },
1228 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1232 if (ref($v) eq 'HASH') {
1233 return undef unless keys %$v;
1236 map $self->_expand_expr({ $_ => $v->{$_} }),
1240 if (ref($v) eq 'ARRAY') {
1241 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1244 (ref($_) eq 'ARRAY' and @$_)
1245 or (ref($_) eq 'HASH' and %$_)
1251 while (my ($el) = splice @expr, 0, 1) {
1252 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1253 unless defined($el) and length($el);
1254 my $elref = ref($el);
1256 local our $Expand_Depth = 0;
1257 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1258 } elsif ($elref eq 'ARRAY') {
1259 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1260 } elsif (my $l = is_literal_value($el)) {
1261 push @res, { -literal => $l };
1262 } elsif ($elref eq 'HASH') {
1263 local our $Expand_Depth = 0;
1264 push @res, grep defined, $self->_expand_expr($el) if %$el;
1270 # return $res[0] if @res == 1;
1271 return { -op => [ $logop, @res ] };
1277 my ($self, $op, $vv, $k) = @_;
1278 ($k, $vv) = @$vv unless defined $k;
1279 puke "$op can only take undef as argument"
1283 and exists($vv->{-value})
1284 and !defined($vv->{-value})
1286 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1289 sub _expand_between {
1290 my ($self, $op, $vv, $k) = @_;
1291 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1292 my @rhs = map $self->_expand_expr($_),
1293 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1295 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1297 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1299 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1303 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1304 map $self->expand_expr($_, -value), @rhs
1309 my ($self, $op, $vv, $k) = @_;
1310 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1311 if (my $literal = is_literal_value($vv)) {
1312 my ($sql, @bind) = @$literal;
1313 my $opened_sql = $self->_open_outer_paren($sql);
1315 $op, $self->expand_expr($k, -ident),
1316 { -literal => [ $opened_sql, @bind ] }
1320 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1321 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1322 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1323 . 'will emit the logically correct SQL instead of raising this exception)'
1325 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1327 my @rhs = map $self->expand_expr($_, -value),
1328 map { defined($_) ? $_: puke($undef_err) }
1329 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1330 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1334 $self->expand_expr($k, -ident),
1340 my ($self, undef, $v) = @_;
1341 # DBIx::Class requires a nest warning to be emitted once but the private
1342 # method it overrode to do so no longer exists
1343 if ($self->{warn_once_on_nest}) {
1344 unless (our $Nest_Warned) {
1346 "-nest in search conditions is deprecated, you most probably wanted:\n"
1347 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1352 return $self->_expand_expr($v);
1355 sub _expand_values {
1356 my ($self, undef, $values) = @_;
1357 return { -values => [
1360 ? $self->expand_expr($_)
1361 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1362 ), ref($values) eq 'ARRAY' ? @$values : $values
1366 sub _recurse_where {
1367 my ($self, $where) = @_;
1369 # Special case: top level simple string treated as literal
1371 my $where_exp = (ref($where)
1372 ? $self->_expand_select_clause_where(undef, $where)
1373 : { -literal => [ $where ] });
1375 # dispatch expanded expression
1377 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1378 # DBIx::Class used to call _recurse_where in scalar context
1379 # something else might too...
1381 return ($sql, @bind);
1384 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1390 my ($self, undef, $ident) = @_;
1392 return [ $self->_quote($ident) ];
1396 my ($self, undef, $values) = @_;
1397 return $self->join_query_parts('',
1399 $self->_render_op(undef, [ ',', @$values ]),
1405 my ($self, undef, $rest) = @_;
1406 my ($func, @args) = @$rest;
1407 return $self->join_query_parts('',
1408 $self->_sqlcase($func),
1409 $self->join_query_parts('',
1411 $self->join_query_parts(', ', @args),
1418 my ($self, undef, $bind) = @_;
1419 return [ '?', $self->_bindtype(@$bind) ];
1422 sub _render_literal {
1423 my ($self, undef, $literal) = @_;
1424 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1428 sub _render_keyword {
1429 my ($self, undef, $keyword) = @_;
1430 return [ $self->_sqlcase(
1431 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1436 my ($self, undef, $v) = @_;
1437 my ($op, @args) = @$v;
1438 if (my $r = $self->{render_op}{$op}) {
1439 return $self->$r($op, \@args);
1444 my $op = join(' ', split '_', $op);
1446 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1447 if ($ss and @args > 1) {
1448 puke "Special op '${op}' requires first value to be identifier"
1449 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1450 my $k = join(($self->{name_sep}||'.'), @$ident);
1451 local our $Expand_Depth = 1;
1452 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1454 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1455 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1458 return $self->_render_unop_paren($op, \@args);
1462 return $self->_render_unop_prefix($op, \@args);
1464 return $self->_render_op_multop($op, \@args);
1470 sub _render_op_between {
1471 my ($self, $op, $args) = @_;
1472 my ($left, $low, $high) = @$args;
1475 puke "Single arg to between must be a literal"
1476 unless $low->{-literal};
1479 +($low, { -keyword => 'and' }, $high);
1482 return $self->join_query_parts(' ',
1483 '(', $left, { -keyword => $op }, @rh, ')',
1488 my ($self, $op, $args) = @_;
1489 my ($lhs, @rhs) = @$args;
1491 return $self->join_query_parts(' ',
1493 { -keyword => $op },
1494 $self->join_query_parts(' ',
1496 $self->join_query_parts(', ', @rhs),
1502 sub _render_op_andor {
1503 my ($self, $op, $args) = @_;
1504 return undef unless @$args;
1505 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1506 my $inner = $self->_render_op_multop($op, $args);
1507 return undef unless defined($inner->[0]) and length($inner->[0]);
1508 return $self->join_query_parts(' ',
1513 sub _render_op_multop {
1514 my ($self, $op, $args) = @_;
1516 return undef unless @parts;
1517 return $self->render_aqt($parts[0]) if @parts == 1;
1518 my $join = ($op eq ','
1520 : { -keyword => " ${op} " }
1522 return $self->join_query_parts($join, @parts);
1525 sub _render_values {
1526 my ($self, undef, $values) = @_;
1527 my $inner = $self->join_query_parts(' ',
1528 { -keyword => 'values' },
1529 $self->join_query_parts(', ',
1530 ref($values) eq 'ARRAY' ? @$values : $values
1533 return $self->join_query_parts('',
1534 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1538 sub join_query_parts {
1539 my ($self, $join, @parts) = @_;
1540 if (ref($join) eq 'HASH') {
1541 $join = $self->render_aqt($join)->[0];
1545 ? $self->render_aqt($_)
1546 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1549 $self->{join_sql_parts}->(
1550 $join, grep defined && length, map $_->[0], @final
1552 (map @{$_}[1..$#$_], @final),
1556 sub _render_unop_paren {
1557 my ($self, $op, $v) = @_;
1558 return $self->join_query_parts('',
1559 '(', $self->_render_unop_prefix($op, $v), ')'
1563 sub _render_unop_prefix {
1564 my ($self, $op, $v) = @_;
1565 my $op_sql = $self->{restore_old_unop_handling}
1566 ? $self->_sqlcase($op)
1567 : { -keyword => $op };
1568 return $self->join_query_parts(' ',
1569 ($self->{restore_old_unop_handling}
1570 ? $self->_sqlcase($op)
1571 : { -keyword => \$op }),
1576 sub _render_unop_postfix {
1577 my ($self, $op, $v) = @_;
1578 return $self->join_query_parts(' ',
1579 $v->[0], { -keyword => $op },
1583 # Some databases (SQLite) treat col IN (1, 2) different from
1584 # col IN ( (1, 2) ). Use this to strip all outer parens while
1585 # adding them back in the corresponding method
1586 sub _open_outer_paren {
1587 my ($self, $sql) = @_;
1589 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1591 # there are closing parens inside, need the heavy duty machinery
1592 # to reevaluate the extraction starting from $sql (full reevaluation)
1593 if ($inner =~ /\)/) {
1594 require Text::Balanced;
1596 my (undef, $remainder) = do {
1597 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1599 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1602 # the entire expression needs to be a balanced bracketed thing
1603 # (after an extract no remainder sans trailing space)
1604 last if defined $remainder and $remainder =~ /\S/;
1614 #======================================================================
1616 #======================================================================
1618 sub _expand_order_by {
1619 my ($self, $arg) = @_;
1621 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1623 return $self->expand_maybe_list_expr($arg)
1624 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1626 my $expander = sub {
1627 my ($self, $dir, $expr) = @_;
1628 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1629 foreach my $arg (@to_expand) {
1633 and grep /^-(asc|desc)$/, keys %$arg
1635 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1639 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1641 map $self->expand_expr($_, -ident),
1642 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1643 return undef unless @exp;
1644 return undef if @exp == 1 and not defined($exp[0]);
1645 return +{ -op => [ ',', @exp ] };
1648 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1650 return $self->$expander(undef, $arg);
1654 my ($self, $arg) = @_;
1656 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1658 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1660 return '' unless length($sql);
1662 my $final_sql = $self->_sqlcase(' order by ').$sql;
1664 return ($final_sql, @bind);
1667 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1669 sub _order_by_chunks {
1670 my ($self, $arg) = @_;
1672 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1674 my @res = $self->_chunkify_order_by($expanded);
1675 (ref() ? $_->[0] : $_) .= '' for @res;
1679 sub _chunkify_order_by {
1680 my ($self, $expanded) = @_;
1682 return grep length, @{ $self->render_aqt($expanded) }
1683 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1686 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1687 my ($comma, @list) = @{$_->{-op}};
1688 return map $self->_chunkify_order_by($_), @list;
1690 return $self->render_aqt($_);
1694 #======================================================================
1695 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1696 #======================================================================
1702 $self->expand_maybe_list_expr($from, -ident)
1707 #======================================================================
1709 #======================================================================
1711 sub expand_maybe_list_expr {
1712 my ($self, $expr, $default) = @_;
1714 ',', map $self->expand_expr($_, $default),
1715 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1716 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1717 return +{ -op => [ ',',
1718 map $self->expand_expr($_, $default),
1719 ref($expr) eq 'ARRAY' ? @$expr : $expr
1723 # highly optimized, as it's called way too often
1725 # my ($self, $label) = @_;
1727 return '' unless defined $_[1];
1728 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1729 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1731 unless ($_[0]->{quote_char}) {
1732 if (ref($_[1]) eq 'ARRAY') {
1733 return join($_[0]->{name_sep}||'.', @{$_[1]});
1735 $_[0]->_assert_pass_injection_guard($_[1]);
1740 my $qref = ref $_[0]->{quote_char};
1742 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1743 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1744 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1746 my $esc = $_[0]->{escape_char} || $r;
1748 # parts containing * are naturally unquoted
1750 $_[0]->{name_sep}||'',
1754 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1756 (ref($_[1]) eq 'ARRAY'
1760 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1768 # Conversion, if applicable
1770 #my ($self, $arg) = @_;
1771 if (my $conv = $_[0]->{convert_where}) {
1772 return @{ $_[0]->join_query_parts('',
1773 $_[0]->_sqlcase($conv),
1782 #my ($self, $col, @vals) = @_;
1783 # called often - tighten code
1784 return $_[0]->{bindtype} eq 'columns'
1785 ? map {[$_[1], $_]} @_[2 .. $#_]
1790 # Dies if any element of @bind is not in [colname => value] format
1791 # if bindtype is 'columns'.
1792 sub _assert_bindval_matches_bindtype {
1793 # my ($self, @bind) = @_;
1795 if ($self->{bindtype} eq 'columns') {
1797 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1798 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1804 # Fix SQL case, if so requested
1806 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1807 # don't touch the argument ... crooked logic, but let's not change it!
1808 return $_[0]->{case} ? $_[1] : uc($_[1]);
1811 #======================================================================
1812 # DISPATCHING FROM REFKIND
1813 #======================================================================
1816 my ($self, $data) = @_;
1818 return 'UNDEF' unless defined $data;
1820 # blessed objects are treated like scalars
1821 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1823 return 'SCALAR' unless $ref;
1826 while ($ref eq 'REF') {
1828 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1832 return ($ref||'SCALAR') . ('REF' x $n_steps);
1836 my ($self, $data) = @_;
1837 my @try = ($self->_refkind($data));
1838 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1839 push @try, 'FALLBACK';
1843 sub _METHOD_FOR_refkind {
1844 my ($self, $meth_prefix, $data) = @_;
1847 for (@{$self->_try_refkind($data)}) {
1848 $method = $self->can($meth_prefix."_".$_)
1852 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1856 sub _SWITCH_refkind {
1857 my ($self, $data, $dispatch_table) = @_;
1860 for (@{$self->_try_refkind($data)}) {
1861 $coderef = $dispatch_table->{$_}
1865 puke "no dispatch entry for ".$self->_refkind($data)
1874 #======================================================================
1875 # VALUES, GENERATE, AUTOLOAD
1876 #======================================================================
1878 # LDNOTE: original code from nwiger, didn't touch code in that section
1879 # I feel the AUTOLOAD stuff should not be the default, it should
1880 # only be activated on explicit demand by user.
1884 my $data = shift || return;
1885 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1886 unless ref $data eq 'HASH';
1889 foreach my $k (sort keys %$data) {
1890 my $v = $data->{$k};
1891 $self->_SWITCH_refkind($v, {
1893 if ($self->{array_datatypes}) { # array datatype
1894 push @all_bind, $self->_bindtype($k, $v);
1896 else { # literal SQL with bind
1897 my ($sql, @bind) = @$v;
1898 $self->_assert_bindval_matches_bindtype(@bind);
1899 push @all_bind, @bind;
1902 ARRAYREFREF => sub { # literal SQL with bind
1903 my ($sql, @bind) = @${$v};
1904 $self->_assert_bindval_matches_bindtype(@bind);
1905 push @all_bind, @bind;
1907 SCALARREF => sub { # literal SQL without bind
1909 SCALAR_or_UNDEF => sub {
1910 push @all_bind, $self->_bindtype($k, $v);
1921 my(@sql, @sqlq, @sqlv);
1925 if ($ref eq 'HASH') {
1926 for my $k (sort keys %$_) {
1929 my $label = $self->_quote($k);
1930 if ($r eq 'ARRAY') {
1931 # literal SQL with bind
1932 my ($sql, @bind) = @$v;
1933 $self->_assert_bindval_matches_bindtype(@bind);
1934 push @sqlq, "$label = $sql";
1936 } elsif ($r eq 'SCALAR') {
1937 # literal SQL without bind
1938 push @sqlq, "$label = $$v";
1940 push @sqlq, "$label = ?";
1941 push @sqlv, $self->_bindtype($k, $v);
1944 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1945 } elsif ($ref eq 'ARRAY') {
1946 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1949 if ($r eq 'ARRAY') { # literal SQL with bind
1950 my ($sql, @bind) = @$v;
1951 $self->_assert_bindval_matches_bindtype(@bind);
1954 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1955 # embedded literal SQL
1962 push @sql, '(' . join(', ', @sqlq) . ')';
1963 } elsif ($ref eq 'SCALAR') {
1967 # strings get case twiddled
1968 push @sql, $self->_sqlcase($_);
1972 my $sql = join ' ', @sql;
1974 # this is pretty tricky
1975 # if ask for an array, return ($stmt, @bind)
1976 # otherwise, s/?/shift @sqlv/ to put it inline
1978 return ($sql, @sqlv);
1980 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1981 ref $d ? $d->[1] : $d/e;
1990 # This allows us to check for a local, then _form, attr
1992 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1993 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
1994 return $self->generate($name, @_);
2005 SQL::Abstract - Generate SQL from Perl data structures
2011 my $sql = SQL::Abstract->new;
2013 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2015 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2017 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2019 my($stmt, @bind) = $sql->delete($table, \%where);
2021 # Then, use these in your DBI statements
2022 my $sth = $dbh->prepare($stmt);
2023 $sth->execute(@bind);
2025 # Just generate the WHERE clause
2026 my($stmt, @bind) = $sql->where(\%where, $order);
2028 # Return values in the same order, for hashed queries
2029 # See PERFORMANCE section for more details
2030 my @bind = $sql->values(\%fieldvals);
2034 This module was inspired by the excellent L<DBIx::Abstract>.
2035 However, in using that module I found that what I really wanted
2036 to do was generate SQL, but still retain complete control over my
2037 statement handles and use the DBI interface. So, I set out to
2038 create an abstract SQL generation module.
2040 While based on the concepts used by L<DBIx::Abstract>, there are
2041 several important differences, especially when it comes to WHERE
2042 clauses. I have modified the concepts used to make the SQL easier
2043 to generate from Perl data structures and, IMO, more intuitive.
2044 The underlying idea is for this module to do what you mean, based
2045 on the data structures you provide it. The big advantage is that
2046 you don't have to modify your code every time your data changes,
2047 as this module figures it out.
2049 To begin with, an SQL INSERT is as easy as just specifying a hash
2050 of C<key=value> pairs:
2053 name => 'Jimbo Bobson',
2054 phone => '123-456-7890',
2055 address => '42 Sister Lane',
2056 city => 'St. Louis',
2057 state => 'Louisiana',
2060 The SQL can then be generated with this:
2062 my($stmt, @bind) = $sql->insert('people', \%data);
2064 Which would give you something like this:
2066 $stmt = "INSERT INTO people
2067 (address, city, name, phone, state)
2068 VALUES (?, ?, ?, ?, ?)";
2069 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2070 '123-456-7890', 'Louisiana');
2072 These are then used directly in your DBI code:
2074 my $sth = $dbh->prepare($stmt);
2075 $sth->execute(@bind);
2077 =head2 Inserting and Updating Arrays
2079 If your database has array types (like for example Postgres),
2080 activate the special option C<< array_datatypes => 1 >>
2081 when creating the C<SQL::Abstract> object.
2082 Then you may use an arrayref to insert and update database array types:
2084 my $sql = SQL::Abstract->new(array_datatypes => 1);
2086 planets => [qw/Mercury Venus Earth Mars/]
2089 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2093 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2095 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2098 =head2 Inserting and Updating SQL
2100 In order to apply SQL functions to elements of your C<%data> you may
2101 specify a reference to an arrayref for the given hash value. For example,
2102 if you need to execute the Oracle C<to_date> function on a value, you can
2103 say something like this:
2107 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2110 The first value in the array is the actual SQL. Any other values are
2111 optional and would be included in the bind values array. This gives
2114 my($stmt, @bind) = $sql->insert('people', \%data);
2116 $stmt = "INSERT INTO people (name, date_entered)
2117 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2118 @bind = ('Bill', '03/02/2003');
2120 An UPDATE is just as easy, all you change is the name of the function:
2122 my($stmt, @bind) = $sql->update('people', \%data);
2124 Notice that your C<%data> isn't touched; the module will generate
2125 the appropriately quirky SQL for you automatically. Usually you'll
2126 want to specify a WHERE clause for your UPDATE, though, which is
2127 where handling C<%where> hashes comes in handy...
2129 =head2 Complex where statements
2131 This module can generate pretty complicated WHERE statements
2132 easily. For example, simple C<key=value> pairs are taken to mean
2133 equality, and if you want to see if a field is within a set
2134 of values, you can use an arrayref. Let's say we wanted to
2135 SELECT some data based on this criteria:
2138 requestor => 'inna',
2139 worker => ['nwiger', 'rcwe', 'sfz'],
2140 status => { '!=', 'completed' }
2143 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2145 The above would give you something like this:
2147 $stmt = "SELECT * FROM tickets WHERE
2148 ( requestor = ? ) AND ( status != ? )
2149 AND ( worker = ? OR worker = ? OR worker = ? )";
2150 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2152 Which you could then use in DBI code like so:
2154 my $sth = $dbh->prepare($stmt);
2155 $sth->execute(@bind);
2161 The methods are simple. There's one for every major SQL operation,
2162 and a constructor you use first. The arguments are specified in a
2163 similar order for each method (table, then fields, then a where
2164 clause) to try and simplify things.
2166 =head2 new(option => 'value')
2168 The C<new()> function takes a list of options and values, and returns
2169 a new B<SQL::Abstract> object which can then be used to generate SQL
2170 through the methods below. The options accepted are:
2176 If set to 'lower', then SQL will be generated in all lowercase. By
2177 default SQL is generated in "textbook" case meaning something like:
2179 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2181 Any setting other than 'lower' is ignored.
2185 This determines what the default comparison operator is. By default
2186 it is C<=>, meaning that a hash like this:
2188 %where = (name => 'nwiger', email => 'nate@wiger.org');
2190 Will generate SQL like this:
2192 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2194 However, you may want loose comparisons by default, so if you set
2195 C<cmp> to C<like> you would get SQL such as:
2197 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2199 You can also override the comparison on an individual basis - see
2200 the huge section on L</"WHERE CLAUSES"> at the bottom.
2202 =item sqltrue, sqlfalse
2204 Expressions for inserting boolean values within SQL statements.
2205 By default these are C<1=1> and C<1=0>. They are used
2206 by the special operators C<-in> and C<-not_in> for generating
2207 correct SQL even when the argument is an empty array (see below).
2211 This determines the default logical operator for multiple WHERE
2212 statements in arrays or hashes. If absent, the default logic is "or"
2213 for arrays, and "and" for hashes. This means that a WHERE
2217 event_date => {'>=', '2/13/99'},
2218 event_date => {'<=', '4/24/03'},
2221 will generate SQL like this:
2223 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2225 This is probably not what you want given this query, though (look
2226 at the dates). To change the "OR" to an "AND", simply specify:
2228 my $sql = SQL::Abstract->new(logic => 'and');
2230 Which will change the above C<WHERE> to:
2232 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2234 The logic can also be changed locally by inserting
2235 a modifier in front of an arrayref:
2237 @where = (-and => [event_date => {'>=', '2/13/99'},
2238 event_date => {'<=', '4/24/03'} ]);
2240 See the L</"WHERE CLAUSES"> section for explanations.
2244 This will automatically convert comparisons using the specified SQL
2245 function for both column and value. This is mostly used with an argument
2246 of C<upper> or C<lower>, so that the SQL will have the effect of
2247 case-insensitive "searches". For example, this:
2249 $sql = SQL::Abstract->new(convert => 'upper');
2250 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2252 Will turn out the following SQL:
2254 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2256 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2257 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2258 not validate this option; it will just pass through what you specify verbatim).
2262 This is a kludge because many databases suck. For example, you can't
2263 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2264 Instead, you have to use C<bind_param()>:
2266 $sth->bind_param(1, 'reg data');
2267 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2269 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2270 which loses track of which field each slot refers to. Fear not.
2272 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2273 Currently, you can specify either C<normal> (default) or C<columns>. If you
2274 specify C<columns>, you will get an array that looks like this:
2276 my $sql = SQL::Abstract->new(bindtype => 'columns');
2277 my($stmt, @bind) = $sql->insert(...);
2280 [ 'column1', 'value1' ],
2281 [ 'column2', 'value2' ],
2282 [ 'column3', 'value3' ],
2285 You can then iterate through this manually, using DBI's C<bind_param()>.
2287 $sth->prepare($stmt);
2290 my($col, $data) = @$_;
2291 if ($col eq 'details' || $col eq 'comments') {
2292 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2293 } elsif ($col eq 'image') {
2294 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2296 $sth->bind_param($i, $data);
2300 $sth->execute; # execute without @bind now
2302 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2303 Basically, the advantage is still that you don't have to care which fields
2304 are or are not included. You could wrap that above C<for> loop in a simple
2305 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2306 get a layer of abstraction over manual SQL specification.
2308 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2309 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2310 will expect the bind values in this format.
2314 This is the character that a table or column name will be quoted
2315 with. By default this is an empty string, but you could set it to
2316 the character C<`>, to generate SQL like this:
2318 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2320 Alternatively, you can supply an array ref of two items, the first being the left
2321 hand quote character, and the second the right hand quote character. For
2322 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2323 that generates SQL like this:
2325 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2327 Quoting is useful if you have tables or columns names that are reserved
2328 words in your database's SQL dialect.
2332 This is the character that will be used to escape L</quote_char>s appearing
2333 in an identifier before it has been quoted.
2335 The parameter default in case of a single L</quote_char> character is the quote
2338 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2339 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2340 of the B<opening (left)> L</quote_char> within the identifier are currently left
2341 untouched. The default for opening-closing-style quotes may change in future
2342 versions, thus you are B<strongly encouraged> to specify the escape character
2347 This is the character that separates a table and column name. It is
2348 necessary to specify this when the C<quote_char> option is selected,
2349 so that tables and column names can be individually quoted like this:
2351 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2353 =item injection_guard
2355 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2356 column name specified in a query structure. This is a safety mechanism to avoid
2357 injection attacks when mishandling user input e.g.:
2359 my %condition_as_column_value_pairs = get_values_from_user();
2360 $sqla->select( ... , \%condition_as_column_value_pairs );
2362 If the expression matches an exception is thrown. Note that literal SQL
2363 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2365 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2367 =item array_datatypes
2369 When this option is true, arrayrefs in INSERT or UPDATE are
2370 interpreted as array datatypes and are passed directly
2372 When this option is false, arrayrefs are interpreted
2373 as literal SQL, just like refs to arrayrefs
2374 (but this behavior is for backwards compatibility; when writing
2375 new queries, use the "reference to arrayref" syntax
2381 Takes a reference to a list of "special operators"
2382 to extend the syntax understood by L<SQL::Abstract>.
2383 See section L</"SPECIAL OPERATORS"> for details.
2387 Takes a reference to a list of "unary operators"
2388 to extend the syntax understood by L<SQL::Abstract>.
2389 See section L</"UNARY OPERATORS"> for details.
2395 =head2 insert($table, \@values || \%fieldvals, \%options)
2397 This is the simplest function. You simply give it a table name
2398 and either an arrayref of values or hashref of field/value pairs.
2399 It returns an SQL INSERT statement and a list of bind values.
2400 See the sections on L</"Inserting and Updating Arrays"> and
2401 L</"Inserting and Updating SQL"> for information on how to insert
2402 with those data types.
2404 The optional C<\%options> hash reference may contain additional
2405 options to generate the insert SQL. Currently supported options
2412 Takes either a scalar of raw SQL fields, or an array reference of
2413 field names, and adds on an SQL C<RETURNING> statement at the end.
2414 This allows you to return data generated by the insert statement
2415 (such as row IDs) without performing another C<SELECT> statement.
2416 Note, however, this is not part of the SQL standard and may not
2417 be supported by all database engines.
2421 =head2 update($table, \%fieldvals, \%where, \%options)
2423 This takes a table, hashref of field/value pairs, and an optional
2424 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2426 See the sections on L</"Inserting and Updating Arrays"> and
2427 L</"Inserting and Updating SQL"> for information on how to insert
2428 with those data types.
2430 The optional C<\%options> hash reference may contain additional
2431 options to generate the update SQL. Currently supported options
2438 See the C<returning> option to
2439 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2443 =head2 select($source, $fields, $where, $order)
2445 This returns a SQL SELECT statement and associated list of bind values, as
2446 specified by the arguments:
2452 Specification of the 'FROM' part of the statement.
2453 The argument can be either a plain scalar (interpreted as a table
2454 name, will be quoted), or an arrayref (interpreted as a list
2455 of table names, joined by commas, quoted), or a scalarref
2456 (literal SQL, not quoted).
2460 Specification of the list of fields to retrieve from
2462 The argument can be either an arrayref (interpreted as a list
2463 of field names, will be joined by commas and quoted), or a
2464 plain scalar (literal SQL, not quoted).
2465 Please observe that this API is not as flexible as that of
2466 the first argument C<$source>, for backwards compatibility reasons.
2470 Optional argument to specify the WHERE part of the query.
2471 The argument is most often a hashref, but can also be
2472 an arrayref or plain scalar --
2473 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2477 Optional argument to specify the ORDER BY part of the query.
2478 The argument can be a scalar, a hashref or an arrayref
2479 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2485 =head2 delete($table, \%where, \%options)
2487 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2488 It returns an SQL DELETE statement and list of bind values.
2490 The optional C<\%options> hash reference may contain additional
2491 options to generate the delete SQL. Currently supported options
2498 See the C<returning> option to
2499 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2503 =head2 where(\%where, $order)
2505 This is used to generate just the WHERE clause. For example,
2506 if you have an arbitrary data structure and know what the
2507 rest of your SQL is going to look like, but want an easy way
2508 to produce a WHERE clause, use this. It returns an SQL WHERE
2509 clause and list of bind values.
2512 =head2 values(\%data)
2514 This just returns the values from the hash C<%data>, in the same
2515 order that would be returned from any of the other above queries.
2516 Using this allows you to markedly speed up your queries if you
2517 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2519 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2521 Warning: This is an experimental method and subject to change.
2523 This returns arbitrarily generated SQL. It's a really basic shortcut.
2524 It will return two different things, depending on return context:
2526 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2527 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2529 These would return the following:
2531 # First calling form
2532 $stmt = "CREATE TABLE test (?, ?)";
2533 @bind = (field1, field2);
2535 # Second calling form
2536 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2538 Depending on what you're trying to do, it's up to you to choose the correct
2539 format. In this example, the second form is what you would want.
2543 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2547 ALTER SESSION SET nls_date_format = 'MM/YY'
2549 You get the idea. Strings get their case twiddled, but everything
2550 else remains verbatim.
2552 =head1 EXPORTABLE FUNCTIONS
2554 =head2 is_plain_value
2556 Determines if the supplied argument is a plain value as understood by this
2561 =item * The value is C<undef>
2563 =item * The value is a non-reference
2565 =item * The value is an object with stringification overloading
2567 =item * The value is of the form C<< { -value => $anything } >>
2571 On failure returns C<undef>, on success returns a B<scalar> reference
2572 to the original supplied argument.
2578 The stringification overloading detection is rather advanced: it takes
2579 into consideration not only the presence of a C<""> overload, but if that
2580 fails also checks for enabled
2581 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2582 on either C<0+> or C<bool>.
2584 Unfortunately testing in the field indicates that this
2585 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2586 but only when very large numbers of stringifying objects are involved.
2587 At the time of writing ( Sep 2014 ) there is no clear explanation of
2588 the direct cause, nor is there a manageably small test case that reliably
2589 reproduces the problem.
2591 If you encounter any of the following exceptions in B<random places within
2592 your application stack> - this module may be to blame:
2594 Operation "ne": no method found,
2595 left argument in overloaded package <something>,
2596 right argument in overloaded package <something>
2600 Stub found while resolving method "???" overloading """" in package <something>
2602 If you fall victim to the above - please attempt to reduce the problem
2603 to something that could be sent to the L<SQL::Abstract developers
2604 |DBIx::Class/GETTING HELP/SUPPORT>
2605 (either publicly or privately). As a workaround in the meantime you can
2606 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2607 value, which will most likely eliminate your problem (at the expense of
2608 not being able to properly detect exotic forms of stringification).
2610 This notice and environment variable will be removed in a future version,
2611 as soon as the underlying problem is found and a reliable workaround is
2616 =head2 is_literal_value
2618 Determines if the supplied argument is a literal value as understood by this
2623 =item * C<\$sql_string>
2625 =item * C<\[ $sql_string, @bind_values ]>
2629 On failure returns C<undef>, on success returns an B<array> reference
2630 containing the unpacked version of the supplied literal SQL and bind values.
2632 =head1 WHERE CLAUSES
2636 This module uses a variation on the idea from L<DBIx::Abstract>. It
2637 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2638 module is that things in arrays are OR'ed, and things in hashes
2641 The easiest way to explain is to show lots of examples. After
2642 each C<%where> hash shown, it is assumed you used:
2644 my($stmt, @bind) = $sql->where(\%where);
2646 However, note that the C<%where> hash can be used directly in any
2647 of the other functions as well, as described above.
2649 =head2 Key-value pairs
2651 So, let's get started. To begin, a simple hash:
2655 status => 'completed'
2658 Is converted to SQL C<key = val> statements:
2660 $stmt = "WHERE user = ? AND status = ?";
2661 @bind = ('nwiger', 'completed');
2663 One common thing I end up doing is having a list of values that
2664 a field can be in. To do this, simply specify a list inside of
2669 status => ['assigned', 'in-progress', 'pending'];
2672 This simple code will create the following:
2674 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2675 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2677 A field associated to an empty arrayref will be considered a
2678 logical false and will generate 0=1.
2680 =head2 Tests for NULL values
2682 If the value part is C<undef> then this is converted to SQL <IS NULL>
2691 $stmt = "WHERE user = ? AND status IS NULL";
2694 To test if a column IS NOT NULL:
2698 status => { '!=', undef },
2701 =head2 Specific comparison operators
2703 If you want to specify a different type of operator for your comparison,
2704 you can use a hashref for a given column:
2708 status => { '!=', 'completed' }
2711 Which would generate:
2713 $stmt = "WHERE user = ? AND status != ?";
2714 @bind = ('nwiger', 'completed');
2716 To test against multiple values, just enclose the values in an arrayref:
2718 status => { '=', ['assigned', 'in-progress', 'pending'] };
2720 Which would give you:
2722 "WHERE status = ? OR status = ? OR status = ?"
2725 The hashref can also contain multiple pairs, in which case it is expanded
2726 into an C<AND> of its elements:
2730 status => { '!=', 'completed', -not_like => 'pending%' }
2733 # Or more dynamically, like from a form
2734 $where{user} = 'nwiger';
2735 $where{status}{'!='} = 'completed';
2736 $where{status}{'-not_like'} = 'pending%';
2738 # Both generate this
2739 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2740 @bind = ('nwiger', 'completed', 'pending%');
2743 To get an OR instead, you can combine it with the arrayref idea:
2747 priority => [ { '=', 2 }, { '>', 5 } ]
2750 Which would generate:
2752 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2753 @bind = ('2', '5', 'nwiger');
2755 If you want to include literal SQL (with or without bind values), just use a
2756 scalar reference or reference to an arrayref as the value:
2759 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2760 date_expires => { '<' => \"now()" }
2763 Which would generate:
2765 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2766 @bind = ('11/26/2008');
2769 =head2 Logic and nesting operators
2771 In the example above,
2772 there is a subtle trap if you want to say something like
2773 this (notice the C<AND>):
2775 WHERE priority != ? AND priority != ?
2777 Because, in Perl you I<can't> do this:
2779 priority => { '!=' => 2, '!=' => 1 }
2781 As the second C<!=> key will obliterate the first. The solution
2782 is to use the special C<-modifier> form inside an arrayref:
2784 priority => [ -and => {'!=', 2},
2788 Normally, these would be joined by C<OR>, but the modifier tells it
2789 to use C<AND> instead. (Hint: You can use this in conjunction with the
2790 C<logic> option to C<new()> in order to change the way your queries
2791 work by default.) B<Important:> Note that the C<-modifier> goes
2792 B<INSIDE> the arrayref, as an extra first element. This will
2793 B<NOT> do what you think it might:
2795 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2797 Here is a quick list of equivalencies, since there is some overlap:
2800 status => {'!=', 'completed', 'not like', 'pending%' }
2801 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2804 status => {'=', ['assigned', 'in-progress']}
2805 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2806 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2810 =head2 Special operators: IN, BETWEEN, etc.
2812 You can also use the hashref format to compare a list of fields using the
2813 C<IN> comparison operator, by specifying the list as an arrayref:
2816 status => 'completed',
2817 reportid => { -in => [567, 2335, 2] }
2820 Which would generate:
2822 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2823 @bind = ('completed', '567', '2335', '2');
2825 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2828 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2829 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2830 'sqltrue' (by default: C<1=1>).
2832 In addition to the array you can supply a chunk of literal sql or
2833 literal sql with bind:
2836 customer => { -in => \[
2837 'SELECT cust_id FROM cust WHERE balance > ?',
2840 status => { -in => \'SELECT status_codes FROM states' },
2846 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2847 AND status IN ( SELECT status_codes FROM states )
2851 Finally, if the argument to C<-in> is not a reference, it will be
2852 treated as a single-element array.
2854 Another pair of operators is C<-between> and C<-not_between>,
2855 used with an arrayref of two values:
2859 completion_date => {
2860 -not_between => ['2002-10-01', '2003-02-06']
2866 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2868 Just like with C<-in> all plausible combinations of literal SQL
2872 start0 => { -between => [ 1, 2 ] },
2873 start1 => { -between => \["? AND ?", 1, 2] },
2874 start2 => { -between => \"lower(x) AND upper(y)" },
2875 start3 => { -between => [
2877 \["upper(?)", 'stuff' ],
2884 ( start0 BETWEEN ? AND ? )
2885 AND ( start1 BETWEEN ? AND ? )
2886 AND ( start2 BETWEEN lower(x) AND upper(y) )
2887 AND ( start3 BETWEEN lower(x) AND upper(?) )
2889 @bind = (1, 2, 1, 2, 'stuff');
2892 These are the two builtin "special operators"; but the
2893 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2895 =head2 Unary operators: bool
2897 If you wish to test against boolean columns or functions within your
2898 database you can use the C<-bool> and C<-not_bool> operators. For
2899 example to test the column C<is_user> being true and the column
2900 C<is_enabled> being false you would use:-
2904 -not_bool => 'is_enabled',
2909 WHERE is_user AND NOT is_enabled
2911 If a more complex combination is required, testing more conditions,
2912 then you should use the and/or operators:-
2917 -not_bool => { two=> { -rlike => 'bar' } },
2918 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2929 (NOT ( three = ? OR three > ? ))
2932 =head2 Nested conditions, -and/-or prefixes
2934 So far, we've seen how multiple conditions are joined with a top-level
2935 C<AND>. We can change this by putting the different conditions we want in
2936 hashes and then putting those hashes in an array. For example:
2941 status => { -like => ['pending%', 'dispatched'] },
2945 status => 'unassigned',
2949 This data structure would create the following:
2951 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2952 OR ( user = ? AND status = ? ) )";
2953 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2956 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2957 to change the logic inside:
2963 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2964 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2971 $stmt = "WHERE ( user = ?
2972 AND ( ( workhrs > ? AND geo = ? )
2973 OR ( workhrs < ? OR geo = ? ) ) )";
2974 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2976 =head3 Algebraic inconsistency, for historical reasons
2978 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2979 operator goes C<outside> of the nested structure; whereas when connecting
2980 several constraints on one column, the C<-and> operator goes
2981 C<inside> the arrayref. Here is an example combining both features:
2984 -and => [a => 1, b => 2],
2985 -or => [c => 3, d => 4],
2986 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2991 WHERE ( ( ( a = ? AND b = ? )
2992 OR ( c = ? OR d = ? )
2993 OR ( e LIKE ? AND e LIKE ? ) ) )
2995 This difference in syntax is unfortunate but must be preserved for
2996 historical reasons. So be careful: the two examples below would
2997 seem algebraically equivalent, but they are not
3000 { -like => 'foo%' },
3001 { -like => '%bar' },
3003 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3006 { col => { -like => 'foo%' } },
3007 { col => { -like => '%bar' } },
3009 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3012 =head2 Literal SQL and value type operators
3014 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3015 side" is a column name and the "right side" is a value (normally rendered as
3016 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3017 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3018 alter this behavior. There are several ways of doing so.
3022 This is a virtual operator that signals the string to its right side is an
3023 identifier (a column name) and not a value. For example to compare two
3024 columns you would write:
3027 priority => { '<', 2 },
3028 requestor => { -ident => 'submitter' },
3033 $stmt = "WHERE priority < ? AND requestor = submitter";
3036 If you are maintaining legacy code you may see a different construct as
3037 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3042 This is a virtual operator that signals that the construct to its right side
3043 is a value to be passed to DBI. This is for example necessary when you want
3044 to write a where clause against an array (for RDBMS that support such
3045 datatypes). For example:
3048 array => { -value => [1, 2, 3] }
3053 $stmt = 'WHERE array = ?';
3054 @bind = ([1, 2, 3]);
3056 Note that if you were to simply say:
3062 the result would probably not be what you wanted:
3064 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3069 Finally, sometimes only literal SQL will do. To include a random snippet
3070 of SQL verbatim, you specify it as a scalar reference. Consider this only
3071 as a last resort. Usually there is a better way. For example:
3074 priority => { '<', 2 },
3075 requestor => { -in => \'(SELECT name FROM hitmen)' },
3080 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3083 Note that in this example, you only get one bind parameter back, since
3084 the verbatim SQL is passed as part of the statement.
3088 Never use untrusted input as a literal SQL argument - this is a massive
3089 security risk (there is no way to check literal snippets for SQL
3090 injections and other nastyness). If you need to deal with untrusted input
3091 use literal SQL with placeholders as described next.
3093 =head3 Literal SQL with placeholders and bind values (subqueries)
3095 If the literal SQL to be inserted has placeholders and bind values,
3096 use a reference to an arrayref (yes this is a double reference --
3097 not so common, but perfectly legal Perl). For example, to find a date
3098 in Postgres you can use something like this:
3101 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3106 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3109 Note that you must pass the bind values in the same format as they are returned
3110 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3111 to C<columns>, you must provide the bind values in the
3112 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3113 scalar value; most commonly the column name, but you can use any scalar value
3114 (including references and blessed references), L<SQL::Abstract> will simply
3115 pass it through intact. So if C<bindtype> is set to C<columns> the above
3116 example will look like:
3119 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3122 Literal SQL is especially useful for nesting parenthesized clauses in the
3123 main SQL query. Here is a first example:
3125 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3129 bar => \["IN ($sub_stmt)" => @sub_bind],
3134 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3135 WHERE c2 < ? AND c3 LIKE ?))";
3136 @bind = (1234, 100, "foo%");
3138 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3139 are expressed in the same way. Of course the C<$sub_stmt> and
3140 its associated bind values can be generated through a former call
3143 my ($sub_stmt, @sub_bind)
3144 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3145 c3 => {-like => "foo%"}});
3148 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3151 In the examples above, the subquery was used as an operator on a column;
3152 but the same principle also applies for a clause within the main C<%where>
3153 hash, like an EXISTS subquery:
3155 my ($sub_stmt, @sub_bind)
3156 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3157 my %where = ( -and => [
3159 \["EXISTS ($sub_stmt)" => @sub_bind],
3164 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3165 WHERE c1 = ? AND c2 > t0.c0))";
3169 Observe that the condition on C<c2> in the subquery refers to
3170 column C<t0.c0> of the main query: this is I<not> a bind
3171 value, so we have to express it through a scalar ref.
3172 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3173 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3174 what we wanted here.
3176 Finally, here is an example where a subquery is used
3177 for expressing unary negation:
3179 my ($sub_stmt, @sub_bind)
3180 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3181 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3183 lname => {like => '%son%'},
3184 \["NOT ($sub_stmt)" => @sub_bind],
3189 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3190 @bind = ('%son%', 10, 20)
3192 =head3 Deprecated usage of Literal SQL
3194 Below are some examples of archaic use of literal SQL. It is shown only as
3195 reference for those who deal with legacy code. Each example has a much
3196 better, cleaner and safer alternative that users should opt for in new code.
3202 my %where = ( requestor => \'IS NOT NULL' )
3204 $stmt = "WHERE requestor IS NOT NULL"
3206 This used to be the way of generating NULL comparisons, before the handling
3207 of C<undef> got formalized. For new code please use the superior syntax as
3208 described in L</Tests for NULL values>.
3212 my %where = ( requestor => \'= submitter' )
3214 $stmt = "WHERE requestor = submitter"
3216 This used to be the only way to compare columns. Use the superior L</-ident>
3217 method for all new code. For example an identifier declared in such a way
3218 will be properly quoted if L</quote_char> is properly set, while the legacy
3219 form will remain as supplied.
3223 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3225 $stmt = "WHERE completed > ? AND is_ready"
3226 @bind = ('2012-12-21')
3228 Using an empty string literal used to be the only way to express a boolean.
3229 For all new code please use the much more readable
3230 L<-bool|/Unary operators: bool> operator.
3236 These pages could go on for a while, since the nesting of the data
3237 structures this module can handle are pretty much unlimited (the
3238 module implements the C<WHERE> expansion as a recursive function
3239 internally). Your best bet is to "play around" with the module a
3240 little to see how the data structures behave, and choose the best
3241 format for your data based on that.
3243 And of course, all the values above will probably be replaced with
3244 variables gotten from forms or the command line. After all, if you
3245 knew everything ahead of time, you wouldn't have to worry about
3246 dynamically-generating SQL and could just hardwire it into your
3249 =head1 ORDER BY CLAUSES
3251 Some functions take an order by clause. This can either be a scalar (just a
3252 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3253 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3256 Given | Will Generate
3257 ---------------------------------------------------------------
3259 'colA' | ORDER BY colA
3261 [qw/colA colB/] | ORDER BY colA, colB
3263 {-asc => 'colA'} | ORDER BY colA ASC
3265 {-desc => 'colB'} | ORDER BY colB DESC
3267 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3269 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3271 \'colA DESC' | ORDER BY colA DESC
3273 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3274 | /* ...with $x bound to ? */
3277 { -asc => 'colA' }, | colA ASC,
3278 { -desc => [qw/colB/] }, | colB DESC,
3279 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3280 \'colE DESC', | colE DESC,
3281 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3282 ] | /* ...with $x bound to ? */
3283 ===============================================================
3287 =head1 SPECIAL OPERATORS
3289 my $sqlmaker = SQL::Abstract->new(special_ops => [
3293 my ($self, $field, $op, $arg) = @_;
3299 handler => 'method_name',
3303 A "special operator" is a SQL syntactic clause that can be
3304 applied to a field, instead of a usual binary operator.
3307 WHERE field IN (?, ?, ?)
3308 WHERE field BETWEEN ? AND ?
3309 WHERE MATCH(field) AGAINST (?, ?)
3311 Special operators IN and BETWEEN are fairly standard and therefore
3312 are builtin within C<SQL::Abstract> (as the overridable methods
3313 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3314 like the MATCH .. AGAINST example above which is specific to MySQL,
3315 you can write your own operator handlers - supply a C<special_ops>
3316 argument to the C<new> method. That argument takes an arrayref of
3317 operator definitions; each operator definition is a hashref with two
3324 the regular expression to match the operator
3328 Either a coderef or a plain scalar method name. In both cases
3329 the expected return is C<< ($sql, @bind) >>.
3331 When supplied with a method name, it is simply called on the
3332 L<SQL::Abstract> object as:
3334 $self->$method_name($field, $op, $arg)
3338 $field is the LHS of the operator
3339 $op is the part that matched the handler regex
3342 When supplied with a coderef, it is called as:
3344 $coderef->($self, $field, $op, $arg)
3349 For example, here is an implementation
3350 of the MATCH .. AGAINST syntax for MySQL
3352 my $sqlmaker = SQL::Abstract->new(special_ops => [
3354 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3355 {regex => qr/^match$/i,
3357 my ($self, $field, $op, $arg) = @_;
3358 $arg = [$arg] if not ref $arg;
3359 my $label = $self->_quote($field);
3360 my ($placeholder) = $self->_convert('?');
3361 my $placeholders = join ", ", (($placeholder) x @$arg);
3362 my $sql = $self->_sqlcase('match') . " ($label) "
3363 . $self->_sqlcase('against') . " ($placeholders) ";
3364 my @bind = $self->_bindtype($field, @$arg);
3365 return ($sql, @bind);
3372 =head1 UNARY OPERATORS
3374 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3378 my ($self, $op, $arg) = @_;
3384 handler => 'method_name',
3388 A "unary operator" is a SQL syntactic clause that can be
3389 applied to a field - the operator goes before the field
3391 You can write your own operator handlers - supply a C<unary_ops>
3392 argument to the C<new> method. That argument takes an arrayref of
3393 operator definitions; each operator definition is a hashref with two
3400 the regular expression to match the operator
3404 Either a coderef or a plain scalar method name. In both cases
3405 the expected return is C<< $sql >>.
3407 When supplied with a method name, it is simply called on the
3408 L<SQL::Abstract> object as:
3410 $self->$method_name($op, $arg)
3414 $op is the part that matched the handler regex
3415 $arg is the RHS or argument of the operator
3417 When supplied with a coderef, it is called as:
3419 $coderef->($self, $op, $arg)
3427 Thanks to some benchmarking by Mark Stosberg, it turns out that
3428 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3429 I must admit this wasn't an intentional design issue, but it's a
3430 byproduct of the fact that you get to control your C<DBI> handles
3433 To maximize performance, use a code snippet like the following:
3435 # prepare a statement handle using the first row
3436 # and then reuse it for the rest of the rows
3438 for my $href (@array_of_hashrefs) {
3439 $stmt ||= $sql->insert('table', $href);
3440 $sth ||= $dbh->prepare($stmt);
3441 $sth->execute($sql->values($href));
3444 The reason this works is because the keys in your C<$href> are sorted
3445 internally by B<SQL::Abstract>. Thus, as long as your data retains
3446 the same structure, you only have to generate the SQL the first time
3447 around. On subsequent queries, simply use the C<values> function provided
3448 by this module to return your values in the correct order.
3450 However this depends on the values having the same type - if, for
3451 example, the values of a where clause may either have values
3452 (resulting in sql of the form C<column = ?> with a single bind
3453 value), or alternatively the values might be C<undef> (resulting in
3454 sql of the form C<column IS NULL> with no bind value) then the
3455 caching technique suggested will not work.
3459 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3460 really like this part (I do, at least). Building up a complex query
3461 can be as simple as the following:
3468 use CGI::FormBuilder;
3471 my $form = CGI::FormBuilder->new(...);
3472 my $sql = SQL::Abstract->new;
3474 if ($form->submitted) {
3475 my $field = $form->field;
3476 my $id = delete $field->{id};
3477 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3480 Of course, you would still have to connect using C<DBI> to run the
3481 query, but the point is that if you make your form look like your
3482 table, the actual query script can be extremely simplistic.
3484 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3485 a fast interface to returning and formatting data. I frequently
3486 use these three modules together to write complex database query
3487 apps in under 50 lines.
3489 =head1 HOW TO CONTRIBUTE
3491 Contributions are always welcome, in all usable forms (we especially
3492 welcome documentation improvements). The delivery methods include git-
3493 or unified-diff formatted patches, GitHub pull requests, or plain bug
3494 reports either via RT or the Mailing list. Contributors are generally
3495 granted full access to the official repository after their first several
3496 patches pass successful review.
3498 This project is maintained in a git repository. The code and related tools are
3499 accessible at the following locations:
3503 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3505 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3507 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3509 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3515 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3516 Great care has been taken to preserve the I<published> behavior
3517 documented in previous versions in the 1.* family; however,
3518 some features that were previously undocumented, or behaved
3519 differently from the documentation, had to be changed in order
3520 to clarify the semantics. Hence, client code that was relying
3521 on some dark areas of C<SQL::Abstract> v1.*
3522 B<might behave differently> in v1.50.
3524 The main changes are:
3530 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3534 support for the { operator => \"..." } construct (to embed literal SQL)
3538 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3542 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3546 defensive programming: check arguments
3550 fixed bug with global logic, which was previously implemented
3551 through global variables yielding side-effects. Prior versions would
3552 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3553 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3554 Now this is interpreted
3555 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3560 fixed semantics of _bindtype on array args
3564 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3565 we just avoid shifting arrays within that tree.
3569 dropped the C<_modlogic> function
3573 =head1 ACKNOWLEDGEMENTS
3575 There are a number of individuals that have really helped out with
3576 this module. Unfortunately, most of them submitted bugs via CPAN
3577 so I have no idea who they are! But the people I do know are:
3579 Ash Berlin (order_by hash term support)
3580 Matt Trout (DBIx::Class support)
3581 Mark Stosberg (benchmarking)
3582 Chas Owens (initial "IN" operator support)
3583 Philip Collins (per-field SQL functions)
3584 Eric Kolve (hashref "AND" support)
3585 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3586 Dan Kubb (support for "quote_char" and "name_sep")
3587 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3588 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3589 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3590 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3591 Oliver Charles (support for "RETURNING" after "INSERT")
3597 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3601 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3603 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3605 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3606 While not an official support venue, C<DBIx::Class> makes heavy use of
3607 C<SQL::Abstract>, and as such list members there are very familiar with
3608 how to create queries.
3612 This module is free software; you may copy this under the same
3613 terms as perl itself (either the GNU General Public License or
3614 the Artistic License)