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);
994 my $op = join(' ', split '_', $op);
996 # the old special op system requires illegality for top-level use
999 (our $Expand_Depth) == 1
1001 List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
1003 $self->{disable_old_special_ops}
1004 and List::Util::first { $op =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1008 puke "Illegal use of top-level '-$op'"
1012 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1013 return $self->$exp($op, $v);
1016 if ($self->{render}{$op}) {
1017 return { "-${op}" => $v };
1020 # Ops prefixed with -not_ get converted
1022 if (my ($rest) = $op =~/^not_(.*)$/) {
1025 $self->_expand_expr({ "-${rest}", $v })
1031 # the old unary op system means we should touch nothing and let it work
1033 my $op = join(' ', split '_', $op);
1035 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1036 return { -op => [ $op, $v ] };
1041 $self->{unknown_unop_always_func} && !$self->{render_op}{$op}
1051 and (keys %$v)[0] =~ /^-/
1055 (List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}})
1056 or $self->{render_op}{$op}
1064 if ($type eq -func and ref($v) eq 'ARRAY') {
1065 return $self->_expand_expr({ -func => [ $op, @$v ] });
1068 return $self->_expand_expr({ $type => [ $op, $v ] });
1071 sub _expand_hashpair_cmp {
1072 my ($self, $k, $v) = @_;
1073 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1076 sub _expand_hashtriple {
1077 my ($self, $k, $vk, $vv) = @_;
1079 my $ik = $self->_expand_expr({ -ident => $k });
1081 my $op = $self->_normalize_op($vk);
1082 $self->_assert_pass_injection_guard($op);
1084 if ($op =~ s/ _? \d+ $//x ) {
1085 return $self->_expand_expr($k, { $vk, $vv });
1087 if (my $x = $self->{expand_op}{$op}) {
1088 local our $Cur_Col_Meta = $k;
1089 return $self->$x($op, $vv, $k);
1093 my $op = join(' ', split '_', $op);
1095 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1096 return { -op => [ $op, $ik, $vv ] };
1098 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1102 { -op => [ $op, $vv ] }
1106 if (ref($vv) eq 'ARRAY') {
1108 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1109 ? (shift(@raw), lc $1) : 'or';
1110 my @values = map +{ $vk => $_ }, @raw;
1112 $op =~ $self->{inequality_op}
1113 or $op =~ $self->{not_like_op}
1115 if (lc($logic) eq 'or' and @values > 1) {
1116 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1117 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1118 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1123 # try to DWIM on equality operators
1124 return ($self->_dwim_op_to_is($op,
1125 "Supplying an empty arrayref to '%s' is deprecated",
1126 "operator '%s' applied on an empty array (field '$k')"
1127 ) ? $self->sqlfalse : $self->sqltrue);
1129 return $self->_expand_op_andor($logic => \@values, $k);
1131 if (is_undef_value($vv)) {
1132 my $is = ($self->_dwim_op_to_is($op,
1133 "Supplying an undefined argument to '%s' is deprecated",
1134 "unexpected operator '%s' with undef operand",
1135 ) ? 'is' : 'is not');
1137 return $self->_expand_hashpair($k => { $is, undef });
1139 local our $Cur_Col_Meta = $k;
1143 $self->_expand_expr($vv)
1147 sub _dwim_op_to_is {
1148 my ($self, $raw, $empty, $fail) = @_;
1150 my $op = $self->_normalize_op($raw);
1152 if ($op =~ /^not$/i) {
1155 if ($op =~ $self->{equality_op}) {
1158 if ($op =~ $self->{like_op}) {
1159 belch(sprintf $empty, uc(join ' ', split '_', $op));
1162 if ($op =~ $self->{inequality_op}) {
1165 if ($op =~ $self->{not_like_op}) {
1166 belch(sprintf $empty, uc(join ' ', split '_', $op));
1169 puke(sprintf $fail, $op);
1173 my ($self, undef, $args) = @_;
1174 my ($func, @args) = @$args;
1175 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1179 my ($self, undef, $body, $k) = @_;
1180 return $self->_expand_hashpair_cmp(
1181 $k, { -ident => $body }
1183 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1184 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1186 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1187 ref($body) ? @$body : $body;
1188 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1189 unless ($self->{quote_char}) {
1190 $self->_assert_pass_injection_guard($_) for @parts;
1192 return +{ -ident => \@parts };
1196 return $_[0]->_expand_hashpair_cmp(
1197 $_[3], { -value => $_[2] },
1198 ) if defined($_[3]);
1199 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1203 my ($self, undef, $args) = @_;
1204 +{ -row => [ map $self->expand_expr($_), @$args ] };
1208 my ($self, undef, $args) = @_;
1209 my ($op, @opargs) = @$args;
1210 if (my $exp = $self->{expand_op}{$op}) {
1211 return $self->$exp($op, \@opargs);
1213 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1217 my ($self, undef, $v) = @_;
1219 return $self->_expand_expr($v);
1221 puke "-bool => undef not supported" unless defined($v);
1222 return $self->_expand_expr({ -ident => $v });
1225 sub _expand_op_andor {
1226 my ($self, $logop, $v, $k) = @_;
1228 $v = [ map +{ $k, $_ },
1230 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1234 if (ref($v) eq 'HASH') {
1235 return undef unless keys %$v;
1238 map $self->_expand_expr({ $_ => $v->{$_} }),
1242 if (ref($v) eq 'ARRAY') {
1243 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1246 (ref($_) eq 'ARRAY' and @$_)
1247 or (ref($_) eq 'HASH' and %$_)
1253 while (my ($el) = splice @expr, 0, 1) {
1254 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1255 unless defined($el) and length($el);
1256 my $elref = ref($el);
1258 local our $Expand_Depth = 0;
1259 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1260 } elsif ($elref eq 'ARRAY') {
1261 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1262 } elsif (my $l = is_literal_value($el)) {
1263 push @res, { -literal => $l };
1264 } elsif ($elref eq 'HASH') {
1265 local our $Expand_Depth = 0;
1266 push @res, grep defined, $self->_expand_expr($el) if %$el;
1272 # return $res[0] if @res == 1;
1273 return { -op => [ $logop, @res ] };
1279 my ($self, $op, $vv, $k) = @_;
1280 ($k, $vv) = @$vv unless defined $k;
1281 puke "$op can only take undef as argument"
1285 and exists($vv->{-value})
1286 and !defined($vv->{-value})
1288 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1291 sub _expand_between {
1292 my ($self, $op, $vv, $k) = @_;
1293 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1294 my @rhs = map $self->_expand_expr($_),
1295 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1297 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1299 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1301 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1305 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1306 map $self->expand_expr($_, -value), @rhs
1311 my ($self, $op, $vv, $k) = @_;
1312 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1313 if (my $literal = is_literal_value($vv)) {
1314 my ($sql, @bind) = @$literal;
1315 my $opened_sql = $self->_open_outer_paren($sql);
1317 $op, $self->expand_expr($k, -ident),
1318 { -literal => [ $opened_sql, @bind ] }
1322 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1323 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1324 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1325 . 'will emit the logically correct SQL instead of raising this exception)'
1327 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1329 my @rhs = map $self->expand_expr($_, -value),
1330 map { defined($_) ? $_: puke($undef_err) }
1331 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1332 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1336 $self->expand_expr($k, -ident),
1342 my ($self, undef, $v) = @_;
1343 # DBIx::Class requires a nest warning to be emitted once but the private
1344 # method it overrode to do so no longer exists
1345 if ($self->{warn_once_on_nest}) {
1346 unless (our $Nest_Warned) {
1348 "-nest in search conditions is deprecated, you most probably wanted:\n"
1349 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1354 return $self->_expand_expr($v);
1358 my ($self, $type, $v) = @_;
1359 return { "-${type}" => $v };
1362 sub _expand_values {
1363 my ($self, undef, $values) = @_;
1364 return { -values => [
1367 ? $self->expand_expr($_)
1368 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1369 ), ref($values) eq 'ARRAY' ? @$values : $values
1373 sub _recurse_where {
1374 my ($self, $where) = @_;
1376 # Special case: top level simple string treated as literal
1378 my $where_exp = (ref($where)
1379 ? $self->_expand_select_clause_where(undef, $where)
1380 : { -literal => [ $where ] });
1382 # dispatch expanded expression
1384 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1385 # DBIx::Class used to call _recurse_where in scalar context
1386 # something else might too...
1388 return ($sql, @bind);
1391 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1397 my ($self, undef, $ident) = @_;
1399 return [ $self->_quote($ident) ];
1403 my ($self, undef, $values) = @_;
1404 return $self->join_query_parts('',
1406 $self->_render_op(undef, [ ',', @$values ]),
1412 my ($self, undef, $rest) = @_;
1413 my ($func, @args) = @$rest;
1414 return $self->join_query_parts('',
1415 $self->_sqlcase($func),
1416 $self->join_query_parts('',
1418 $self->join_query_parts(', ', @args),
1425 my ($self, undef, $bind) = @_;
1426 return [ '?', $self->_bindtype(@$bind) ];
1429 sub _render_literal {
1430 my ($self, undef, $literal) = @_;
1431 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1435 sub _render_keyword {
1436 my ($self, undef, $keyword) = @_;
1437 return [ $self->_sqlcase(
1438 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1443 my ($self, undef, $v) = @_;
1444 my ($op, @args) = @$v;
1445 if (my $r = $self->{render_op}{$op}) {
1446 return $self->$r($op, \@args);
1451 my $op = join(' ', split '_', $op);
1453 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1454 if ($ss and @args > 1) {
1455 puke "Special op '${op}' requires first value to be identifier"
1456 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1457 my $k = join(($self->{name_sep}||'.'), @$ident);
1458 local our $Expand_Depth = 1;
1459 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1461 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1462 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1465 return $self->_render_unop_paren($op, \@args);
1469 return $self->_render_unop_prefix($op, \@args);
1471 return $self->_render_op_multop($op, \@args);
1477 sub _render_op_between {
1478 my ($self, $op, $args) = @_;
1479 my ($left, $low, $high) = @$args;
1482 puke "Single arg to between must be a literal"
1483 unless $low->{-literal};
1486 +($low, { -keyword => 'and' }, $high);
1489 return $self->join_query_parts(' ',
1490 '(', $left, { -keyword => $op }, @rh, ')',
1495 my ($self, $op, $args) = @_;
1496 my ($lhs, @rhs) = @$args;
1498 return $self->join_query_parts(' ',
1500 { -keyword => $op },
1501 $self->join_query_parts(' ',
1503 $self->join_query_parts(', ', @rhs),
1509 sub _render_op_andor {
1510 my ($self, $op, $args) = @_;
1511 return undef unless @$args;
1512 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1513 my $inner = $self->_render_op_multop($op, $args);
1514 return undef unless defined($inner->[0]) and length($inner->[0]);
1515 return $self->join_query_parts(' ',
1520 sub _render_op_multop {
1521 my ($self, $op, $args) = @_;
1523 return undef unless @parts;
1524 return $self->render_aqt($parts[0]) if @parts == 1;
1525 my $join = ($op eq ','
1527 : { -keyword => " ${op} " }
1529 return $self->join_query_parts($join, @parts);
1532 sub _render_values {
1533 my ($self, undef, $values) = @_;
1534 my $inner = $self->join_query_parts(' ',
1535 { -keyword => 'values' },
1536 $self->join_query_parts(', ',
1537 ref($values) eq 'ARRAY' ? @$values : $values
1540 return $self->join_query_parts('',
1541 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1545 sub join_query_parts {
1546 my ($self, $join, @parts) = @_;
1547 if (ref($join) eq 'HASH') {
1548 $join = $self->render_aqt($join)->[0];
1552 ? $self->render_aqt($_)
1553 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1556 $self->{join_sql_parts}->(
1557 $join, grep defined && length, map $_->[0], @final
1559 (map @{$_}[1..$#$_], @final),
1563 sub _render_unop_paren {
1564 my ($self, $op, $v) = @_;
1565 return $self->join_query_parts('',
1566 '(', $self->_render_unop_prefix($op, $v), ')'
1570 sub _render_unop_prefix {
1571 my ($self, $op, $v) = @_;
1572 return $self->join_query_parts(' ',
1573 { -keyword => \$op }, $v->[0]
1577 sub _render_unop_postfix {
1578 my ($self, $op, $v) = @_;
1579 return $self->join_query_parts(' ',
1580 $v->[0], { -keyword => $op },
1584 # Some databases (SQLite) treat col IN (1, 2) different from
1585 # col IN ( (1, 2) ). Use this to strip all outer parens while
1586 # adding them back in the corresponding method
1587 sub _open_outer_paren {
1588 my ($self, $sql) = @_;
1590 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1592 # there are closing parens inside, need the heavy duty machinery
1593 # to reevaluate the extraction starting from $sql (full reevaluation)
1594 if ($inner =~ /\)/) {
1595 require Text::Balanced;
1597 my (undef, $remainder) = do {
1598 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1600 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1603 # the entire expression needs to be a balanced bracketed thing
1604 # (after an extract no remainder sans trailing space)
1605 last if defined $remainder and $remainder =~ /\S/;
1615 #======================================================================
1617 #======================================================================
1619 sub _expand_order_by {
1620 my ($self, $arg) = @_;
1622 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1624 return $self->expand_maybe_list_expr($arg)
1625 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1627 my $expander = sub {
1628 my ($self, $dir, $expr) = @_;
1629 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1630 foreach my $arg (@to_expand) {
1634 and grep /^-(asc|desc)$/, keys %$arg
1636 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1640 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1642 map $self->expand_expr($_, -ident),
1643 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1644 return undef unless @exp;
1645 return undef if @exp == 1 and not defined($exp[0]);
1646 return +{ -op => [ ',', @exp ] };
1649 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1651 return $self->$expander(undef, $arg);
1655 my ($self, $arg) = @_;
1657 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1659 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1661 return '' unless length($sql);
1663 my $final_sql = $self->_sqlcase(' order by ').$sql;
1665 return ($final_sql, @bind);
1668 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1670 sub _order_by_chunks {
1671 my ($self, $arg) = @_;
1673 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1675 my @res = $self->_chunkify_order_by($expanded);
1676 (ref() ? $_->[0] : $_) .= '' for @res;
1680 sub _chunkify_order_by {
1681 my ($self, $expanded) = @_;
1683 return grep length, @{ $self->render_aqt($expanded) }
1684 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1687 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1688 my ($comma, @list) = @{$_->{-op}};
1689 return map $self->_chunkify_order_by($_), @list;
1691 return $self->render_aqt($_);
1695 #======================================================================
1696 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1697 #======================================================================
1703 $self->expand_maybe_list_expr($from, -ident)
1708 #======================================================================
1710 #======================================================================
1712 sub expand_maybe_list_expr {
1713 my ($self, $expr, $default) = @_;
1715 ',', map $self->expand_expr($_, $default),
1716 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1717 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1718 return +{ -op => [ ',',
1719 map $self->expand_expr($_, $default),
1720 ref($expr) eq 'ARRAY' ? @$expr : $expr
1724 # highly optimized, as it's called way too often
1726 # my ($self, $label) = @_;
1728 return '' unless defined $_[1];
1729 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1730 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1732 unless ($_[0]->{quote_char}) {
1733 if (ref($_[1]) eq 'ARRAY') {
1734 return join($_[0]->{name_sep}||'.', @{$_[1]});
1736 $_[0]->_assert_pass_injection_guard($_[1]);
1741 my $qref = ref $_[0]->{quote_char};
1743 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1744 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1745 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1747 my $esc = $_[0]->{escape_char} || $r;
1749 # parts containing * are naturally unquoted
1751 $_[0]->{name_sep}||'',
1755 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1757 (ref($_[1]) eq 'ARRAY'
1761 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1769 # Conversion, if applicable
1771 #my ($self, $arg) = @_;
1772 if (my $conv = $_[0]->{convert_where}) {
1773 return @{ $_[0]->join_query_parts('',
1774 $_[0]->_sqlcase($conv),
1783 #my ($self, $col, @vals) = @_;
1784 # called often - tighten code
1785 return $_[0]->{bindtype} eq 'columns'
1786 ? map {[$_[1], $_]} @_[2 .. $#_]
1791 # Dies if any element of @bind is not in [colname => value] format
1792 # if bindtype is 'columns'.
1793 sub _assert_bindval_matches_bindtype {
1794 # my ($self, @bind) = @_;
1796 if ($self->{bindtype} eq 'columns') {
1798 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1799 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1805 # Fix SQL case, if so requested
1807 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1808 # don't touch the argument ... crooked logic, but let's not change it!
1809 return $_[0]->{case} ? $_[1] : uc($_[1]);
1812 #======================================================================
1813 # DISPATCHING FROM REFKIND
1814 #======================================================================
1817 my ($self, $data) = @_;
1819 return 'UNDEF' unless defined $data;
1821 # blessed objects are treated like scalars
1822 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1824 return 'SCALAR' unless $ref;
1827 while ($ref eq 'REF') {
1829 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1833 return ($ref||'SCALAR') . ('REF' x $n_steps);
1837 my ($self, $data) = @_;
1838 my @try = ($self->_refkind($data));
1839 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1840 push @try, 'FALLBACK';
1844 sub _METHOD_FOR_refkind {
1845 my ($self, $meth_prefix, $data) = @_;
1848 for (@{$self->_try_refkind($data)}) {
1849 $method = $self->can($meth_prefix."_".$_)
1853 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1857 sub _SWITCH_refkind {
1858 my ($self, $data, $dispatch_table) = @_;
1861 for (@{$self->_try_refkind($data)}) {
1862 $coderef = $dispatch_table->{$_}
1866 puke "no dispatch entry for ".$self->_refkind($data)
1875 #======================================================================
1876 # VALUES, GENERATE, AUTOLOAD
1877 #======================================================================
1879 # LDNOTE: original code from nwiger, didn't touch code in that section
1880 # I feel the AUTOLOAD stuff should not be the default, it should
1881 # only be activated on explicit demand by user.
1885 my $data = shift || return;
1886 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1887 unless ref $data eq 'HASH';
1890 foreach my $k (sort keys %$data) {
1891 my $v = $data->{$k};
1892 $self->_SWITCH_refkind($v, {
1894 if ($self->{array_datatypes}) { # array datatype
1895 push @all_bind, $self->_bindtype($k, $v);
1897 else { # literal SQL with bind
1898 my ($sql, @bind) = @$v;
1899 $self->_assert_bindval_matches_bindtype(@bind);
1900 push @all_bind, @bind;
1903 ARRAYREFREF => sub { # literal SQL with bind
1904 my ($sql, @bind) = @${$v};
1905 $self->_assert_bindval_matches_bindtype(@bind);
1906 push @all_bind, @bind;
1908 SCALARREF => sub { # literal SQL without bind
1910 SCALAR_or_UNDEF => sub {
1911 push @all_bind, $self->_bindtype($k, $v);
1922 my(@sql, @sqlq, @sqlv);
1926 if ($ref eq 'HASH') {
1927 for my $k (sort keys %$_) {
1930 my $label = $self->_quote($k);
1931 if ($r eq 'ARRAY') {
1932 # literal SQL with bind
1933 my ($sql, @bind) = @$v;
1934 $self->_assert_bindval_matches_bindtype(@bind);
1935 push @sqlq, "$label = $sql";
1937 } elsif ($r eq 'SCALAR') {
1938 # literal SQL without bind
1939 push @sqlq, "$label = $$v";
1941 push @sqlq, "$label = ?";
1942 push @sqlv, $self->_bindtype($k, $v);
1945 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1946 } elsif ($ref eq 'ARRAY') {
1947 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1950 if ($r eq 'ARRAY') { # literal SQL with bind
1951 my ($sql, @bind) = @$v;
1952 $self->_assert_bindval_matches_bindtype(@bind);
1955 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1956 # embedded literal SQL
1963 push @sql, '(' . join(', ', @sqlq) . ')';
1964 } elsif ($ref eq 'SCALAR') {
1968 # strings get case twiddled
1969 push @sql, $self->_sqlcase($_);
1973 my $sql = join ' ', @sql;
1975 # this is pretty tricky
1976 # if ask for an array, return ($stmt, @bind)
1977 # otherwise, s/?/shift @sqlv/ to put it inline
1979 return ($sql, @sqlv);
1981 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1982 ref $d ? $d->[1] : $d/e;
1991 # This allows us to check for a local, then _form, attr
1993 my($name) = $AUTOLOAD =~ /.*::(.+)/;
1994 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
1995 return $self->generate($name, @_);
2006 SQL::Abstract - Generate SQL from Perl data structures
2012 my $sql = SQL::Abstract->new;
2014 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2016 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2018 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2020 my($stmt, @bind) = $sql->delete($table, \%where);
2022 # Then, use these in your DBI statements
2023 my $sth = $dbh->prepare($stmt);
2024 $sth->execute(@bind);
2026 # Just generate the WHERE clause
2027 my($stmt, @bind) = $sql->where(\%where, $order);
2029 # Return values in the same order, for hashed queries
2030 # See PERFORMANCE section for more details
2031 my @bind = $sql->values(\%fieldvals);
2035 This module was inspired by the excellent L<DBIx::Abstract>.
2036 However, in using that module I found that what I really wanted
2037 to do was generate SQL, but still retain complete control over my
2038 statement handles and use the DBI interface. So, I set out to
2039 create an abstract SQL generation module.
2041 While based on the concepts used by L<DBIx::Abstract>, there are
2042 several important differences, especially when it comes to WHERE
2043 clauses. I have modified the concepts used to make the SQL easier
2044 to generate from Perl data structures and, IMO, more intuitive.
2045 The underlying idea is for this module to do what you mean, based
2046 on the data structures you provide it. The big advantage is that
2047 you don't have to modify your code every time your data changes,
2048 as this module figures it out.
2050 To begin with, an SQL INSERT is as easy as just specifying a hash
2051 of C<key=value> pairs:
2054 name => 'Jimbo Bobson',
2055 phone => '123-456-7890',
2056 address => '42 Sister Lane',
2057 city => 'St. Louis',
2058 state => 'Louisiana',
2061 The SQL can then be generated with this:
2063 my($stmt, @bind) = $sql->insert('people', \%data);
2065 Which would give you something like this:
2067 $stmt = "INSERT INTO people
2068 (address, city, name, phone, state)
2069 VALUES (?, ?, ?, ?, ?)";
2070 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2071 '123-456-7890', 'Louisiana');
2073 These are then used directly in your DBI code:
2075 my $sth = $dbh->prepare($stmt);
2076 $sth->execute(@bind);
2078 =head2 Inserting and Updating Arrays
2080 If your database has array types (like for example Postgres),
2081 activate the special option C<< array_datatypes => 1 >>
2082 when creating the C<SQL::Abstract> object.
2083 Then you may use an arrayref to insert and update database array types:
2085 my $sql = SQL::Abstract->new(array_datatypes => 1);
2087 planets => [qw/Mercury Venus Earth Mars/]
2090 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2094 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2096 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2099 =head2 Inserting and Updating SQL
2101 In order to apply SQL functions to elements of your C<%data> you may
2102 specify a reference to an arrayref for the given hash value. For example,
2103 if you need to execute the Oracle C<to_date> function on a value, you can
2104 say something like this:
2108 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2111 The first value in the array is the actual SQL. Any other values are
2112 optional and would be included in the bind values array. This gives
2115 my($stmt, @bind) = $sql->insert('people', \%data);
2117 $stmt = "INSERT INTO people (name, date_entered)
2118 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2119 @bind = ('Bill', '03/02/2003');
2121 An UPDATE is just as easy, all you change is the name of the function:
2123 my($stmt, @bind) = $sql->update('people', \%data);
2125 Notice that your C<%data> isn't touched; the module will generate
2126 the appropriately quirky SQL for you automatically. Usually you'll
2127 want to specify a WHERE clause for your UPDATE, though, which is
2128 where handling C<%where> hashes comes in handy...
2130 =head2 Complex where statements
2132 This module can generate pretty complicated WHERE statements
2133 easily. For example, simple C<key=value> pairs are taken to mean
2134 equality, and if you want to see if a field is within a set
2135 of values, you can use an arrayref. Let's say we wanted to
2136 SELECT some data based on this criteria:
2139 requestor => 'inna',
2140 worker => ['nwiger', 'rcwe', 'sfz'],
2141 status => { '!=', 'completed' }
2144 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2146 The above would give you something like this:
2148 $stmt = "SELECT * FROM tickets WHERE
2149 ( requestor = ? ) AND ( status != ? )
2150 AND ( worker = ? OR worker = ? OR worker = ? )";
2151 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2153 Which you could then use in DBI code like so:
2155 my $sth = $dbh->prepare($stmt);
2156 $sth->execute(@bind);
2162 The methods are simple. There's one for every major SQL operation,
2163 and a constructor you use first. The arguments are specified in a
2164 similar order for each method (table, then fields, then a where
2165 clause) to try and simplify things.
2167 =head2 new(option => 'value')
2169 The C<new()> function takes a list of options and values, and returns
2170 a new B<SQL::Abstract> object which can then be used to generate SQL
2171 through the methods below. The options accepted are:
2177 If set to 'lower', then SQL will be generated in all lowercase. By
2178 default SQL is generated in "textbook" case meaning something like:
2180 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2182 Any setting other than 'lower' is ignored.
2186 This determines what the default comparison operator is. By default
2187 it is C<=>, meaning that a hash like this:
2189 %where = (name => 'nwiger', email => 'nate@wiger.org');
2191 Will generate SQL like this:
2193 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2195 However, you may want loose comparisons by default, so if you set
2196 C<cmp> to C<like> you would get SQL such as:
2198 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2200 You can also override the comparison on an individual basis - see
2201 the huge section on L</"WHERE CLAUSES"> at the bottom.
2203 =item sqltrue, sqlfalse
2205 Expressions for inserting boolean values within SQL statements.
2206 By default these are C<1=1> and C<1=0>. They are used
2207 by the special operators C<-in> and C<-not_in> for generating
2208 correct SQL even when the argument is an empty array (see below).
2212 This determines the default logical operator for multiple WHERE
2213 statements in arrays or hashes. If absent, the default logic is "or"
2214 for arrays, and "and" for hashes. This means that a WHERE
2218 event_date => {'>=', '2/13/99'},
2219 event_date => {'<=', '4/24/03'},
2222 will generate SQL like this:
2224 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2226 This is probably not what you want given this query, though (look
2227 at the dates). To change the "OR" to an "AND", simply specify:
2229 my $sql = SQL::Abstract->new(logic => 'and');
2231 Which will change the above C<WHERE> to:
2233 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2235 The logic can also be changed locally by inserting
2236 a modifier in front of an arrayref:
2238 @where = (-and => [event_date => {'>=', '2/13/99'},
2239 event_date => {'<=', '4/24/03'} ]);
2241 See the L</"WHERE CLAUSES"> section for explanations.
2245 This will automatically convert comparisons using the specified SQL
2246 function for both column and value. This is mostly used with an argument
2247 of C<upper> or C<lower>, so that the SQL will have the effect of
2248 case-insensitive "searches". For example, this:
2250 $sql = SQL::Abstract->new(convert => 'upper');
2251 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2253 Will turn out the following SQL:
2255 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2257 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2258 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2259 not validate this option; it will just pass through what you specify verbatim).
2263 This is a kludge because many databases suck. For example, you can't
2264 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2265 Instead, you have to use C<bind_param()>:
2267 $sth->bind_param(1, 'reg data');
2268 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2270 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2271 which loses track of which field each slot refers to. Fear not.
2273 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2274 Currently, you can specify either C<normal> (default) or C<columns>. If you
2275 specify C<columns>, you will get an array that looks like this:
2277 my $sql = SQL::Abstract->new(bindtype => 'columns');
2278 my($stmt, @bind) = $sql->insert(...);
2281 [ 'column1', 'value1' ],
2282 [ 'column2', 'value2' ],
2283 [ 'column3', 'value3' ],
2286 You can then iterate through this manually, using DBI's C<bind_param()>.
2288 $sth->prepare($stmt);
2291 my($col, $data) = @$_;
2292 if ($col eq 'details' || $col eq 'comments') {
2293 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2294 } elsif ($col eq 'image') {
2295 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2297 $sth->bind_param($i, $data);
2301 $sth->execute; # execute without @bind now
2303 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2304 Basically, the advantage is still that you don't have to care which fields
2305 are or are not included. You could wrap that above C<for> loop in a simple
2306 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2307 get a layer of abstraction over manual SQL specification.
2309 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2310 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2311 will expect the bind values in this format.
2315 This is the character that a table or column name will be quoted
2316 with. By default this is an empty string, but you could set it to
2317 the character C<`>, to generate SQL like this:
2319 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2321 Alternatively, you can supply an array ref of two items, the first being the left
2322 hand quote character, and the second the right hand quote character. For
2323 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2324 that generates SQL like this:
2326 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2328 Quoting is useful if you have tables or columns names that are reserved
2329 words in your database's SQL dialect.
2333 This is the character that will be used to escape L</quote_char>s appearing
2334 in an identifier before it has been quoted.
2336 The parameter default in case of a single L</quote_char> character is the quote
2339 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2340 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2341 of the B<opening (left)> L</quote_char> within the identifier are currently left
2342 untouched. The default for opening-closing-style quotes may change in future
2343 versions, thus you are B<strongly encouraged> to specify the escape character
2348 This is the character that separates a table and column name. It is
2349 necessary to specify this when the C<quote_char> option is selected,
2350 so that tables and column names can be individually quoted like this:
2352 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2354 =item injection_guard
2356 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2357 column name specified in a query structure. This is a safety mechanism to avoid
2358 injection attacks when mishandling user input e.g.:
2360 my %condition_as_column_value_pairs = get_values_from_user();
2361 $sqla->select( ... , \%condition_as_column_value_pairs );
2363 If the expression matches an exception is thrown. Note that literal SQL
2364 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2366 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2368 =item array_datatypes
2370 When this option is true, arrayrefs in INSERT or UPDATE are
2371 interpreted as array datatypes and are passed directly
2373 When this option is false, arrayrefs are interpreted
2374 as literal SQL, just like refs to arrayrefs
2375 (but this behavior is for backwards compatibility; when writing
2376 new queries, use the "reference to arrayref" syntax
2382 Takes a reference to a list of "special operators"
2383 to extend the syntax understood by L<SQL::Abstract>.
2384 See section L</"SPECIAL OPERATORS"> for details.
2388 Takes a reference to a list of "unary operators"
2389 to extend the syntax understood by L<SQL::Abstract>.
2390 See section L</"UNARY OPERATORS"> for details.
2396 =head2 insert($table, \@values || \%fieldvals, \%options)
2398 This is the simplest function. You simply give it a table name
2399 and either an arrayref of values or hashref of field/value pairs.
2400 It returns an SQL INSERT statement and a list of bind values.
2401 See the sections on L</"Inserting and Updating Arrays"> and
2402 L</"Inserting and Updating SQL"> for information on how to insert
2403 with those data types.
2405 The optional C<\%options> hash reference may contain additional
2406 options to generate the insert SQL. Currently supported options
2413 Takes either a scalar of raw SQL fields, or an array reference of
2414 field names, and adds on an SQL C<RETURNING> statement at the end.
2415 This allows you to return data generated by the insert statement
2416 (such as row IDs) without performing another C<SELECT> statement.
2417 Note, however, this is not part of the SQL standard and may not
2418 be supported by all database engines.
2422 =head2 update($table, \%fieldvals, \%where, \%options)
2424 This takes a table, hashref of field/value pairs, and an optional
2425 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2427 See the sections on L</"Inserting and Updating Arrays"> and
2428 L</"Inserting and Updating SQL"> for information on how to insert
2429 with those data types.
2431 The optional C<\%options> hash reference may contain additional
2432 options to generate the update SQL. Currently supported options
2439 See the C<returning> option to
2440 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2444 =head2 select($source, $fields, $where, $order)
2446 This returns a SQL SELECT statement and associated list of bind values, as
2447 specified by the arguments:
2453 Specification of the 'FROM' part of the statement.
2454 The argument can be either a plain scalar (interpreted as a table
2455 name, will be quoted), or an arrayref (interpreted as a list
2456 of table names, joined by commas, quoted), or a scalarref
2457 (literal SQL, not quoted).
2461 Specification of the list of fields to retrieve from
2463 The argument can be either an arrayref (interpreted as a list
2464 of field names, will be joined by commas and quoted), or a
2465 plain scalar (literal SQL, not quoted).
2466 Please observe that this API is not as flexible as that of
2467 the first argument C<$source>, for backwards compatibility reasons.
2471 Optional argument to specify the WHERE part of the query.
2472 The argument is most often a hashref, but can also be
2473 an arrayref or plain scalar --
2474 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2478 Optional argument to specify the ORDER BY part of the query.
2479 The argument can be a scalar, a hashref or an arrayref
2480 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2486 =head2 delete($table, \%where, \%options)
2488 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2489 It returns an SQL DELETE statement and list of bind values.
2491 The optional C<\%options> hash reference may contain additional
2492 options to generate the delete SQL. Currently supported options
2499 See the C<returning> option to
2500 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2504 =head2 where(\%where, $order)
2506 This is used to generate just the WHERE clause. For example,
2507 if you have an arbitrary data structure and know what the
2508 rest of your SQL is going to look like, but want an easy way
2509 to produce a WHERE clause, use this. It returns an SQL WHERE
2510 clause and list of bind values.
2513 =head2 values(\%data)
2515 This just returns the values from the hash C<%data>, in the same
2516 order that would be returned from any of the other above queries.
2517 Using this allows you to markedly speed up your queries if you
2518 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2520 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2522 Warning: This is an experimental method and subject to change.
2524 This returns arbitrarily generated SQL. It's a really basic shortcut.
2525 It will return two different things, depending on return context:
2527 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2528 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2530 These would return the following:
2532 # First calling form
2533 $stmt = "CREATE TABLE test (?, ?)";
2534 @bind = (field1, field2);
2536 # Second calling form
2537 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2539 Depending on what you're trying to do, it's up to you to choose the correct
2540 format. In this example, the second form is what you would want.
2544 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2548 ALTER SESSION SET nls_date_format = 'MM/YY'
2550 You get the idea. Strings get their case twiddled, but everything
2551 else remains verbatim.
2553 =head1 EXPORTABLE FUNCTIONS
2555 =head2 is_plain_value
2557 Determines if the supplied argument is a plain value as understood by this
2562 =item * The value is C<undef>
2564 =item * The value is a non-reference
2566 =item * The value is an object with stringification overloading
2568 =item * The value is of the form C<< { -value => $anything } >>
2572 On failure returns C<undef>, on success returns a B<scalar> reference
2573 to the original supplied argument.
2579 The stringification overloading detection is rather advanced: it takes
2580 into consideration not only the presence of a C<""> overload, but if that
2581 fails also checks for enabled
2582 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2583 on either C<0+> or C<bool>.
2585 Unfortunately testing in the field indicates that this
2586 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2587 but only when very large numbers of stringifying objects are involved.
2588 At the time of writing ( Sep 2014 ) there is no clear explanation of
2589 the direct cause, nor is there a manageably small test case that reliably
2590 reproduces the problem.
2592 If you encounter any of the following exceptions in B<random places within
2593 your application stack> - this module may be to blame:
2595 Operation "ne": no method found,
2596 left argument in overloaded package <something>,
2597 right argument in overloaded package <something>
2601 Stub found while resolving method "???" overloading """" in package <something>
2603 If you fall victim to the above - please attempt to reduce the problem
2604 to something that could be sent to the L<SQL::Abstract developers
2605 |DBIx::Class/GETTING HELP/SUPPORT>
2606 (either publicly or privately). As a workaround in the meantime you can
2607 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2608 value, which will most likely eliminate your problem (at the expense of
2609 not being able to properly detect exotic forms of stringification).
2611 This notice and environment variable will be removed in a future version,
2612 as soon as the underlying problem is found and a reliable workaround is
2617 =head2 is_literal_value
2619 Determines if the supplied argument is a literal value as understood by this
2624 =item * C<\$sql_string>
2626 =item * C<\[ $sql_string, @bind_values ]>
2630 On failure returns C<undef>, on success returns an B<array> reference
2631 containing the unpacked version of the supplied literal SQL and bind values.
2633 =head1 WHERE CLAUSES
2637 This module uses a variation on the idea from L<DBIx::Abstract>. It
2638 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2639 module is that things in arrays are OR'ed, and things in hashes
2642 The easiest way to explain is to show lots of examples. After
2643 each C<%where> hash shown, it is assumed you used:
2645 my($stmt, @bind) = $sql->where(\%where);
2647 However, note that the C<%where> hash can be used directly in any
2648 of the other functions as well, as described above.
2650 =head2 Key-value pairs
2652 So, let's get started. To begin, a simple hash:
2656 status => 'completed'
2659 Is converted to SQL C<key = val> statements:
2661 $stmt = "WHERE user = ? AND status = ?";
2662 @bind = ('nwiger', 'completed');
2664 One common thing I end up doing is having a list of values that
2665 a field can be in. To do this, simply specify a list inside of
2670 status => ['assigned', 'in-progress', 'pending'];
2673 This simple code will create the following:
2675 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2676 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2678 A field associated to an empty arrayref will be considered a
2679 logical false and will generate 0=1.
2681 =head2 Tests for NULL values
2683 If the value part is C<undef> then this is converted to SQL <IS NULL>
2692 $stmt = "WHERE user = ? AND status IS NULL";
2695 To test if a column IS NOT NULL:
2699 status => { '!=', undef },
2702 =head2 Specific comparison operators
2704 If you want to specify a different type of operator for your comparison,
2705 you can use a hashref for a given column:
2709 status => { '!=', 'completed' }
2712 Which would generate:
2714 $stmt = "WHERE user = ? AND status != ?";
2715 @bind = ('nwiger', 'completed');
2717 To test against multiple values, just enclose the values in an arrayref:
2719 status => { '=', ['assigned', 'in-progress', 'pending'] };
2721 Which would give you:
2723 "WHERE status = ? OR status = ? OR status = ?"
2726 The hashref can also contain multiple pairs, in which case it is expanded
2727 into an C<AND> of its elements:
2731 status => { '!=', 'completed', -not_like => 'pending%' }
2734 # Or more dynamically, like from a form
2735 $where{user} = 'nwiger';
2736 $where{status}{'!='} = 'completed';
2737 $where{status}{'-not_like'} = 'pending%';
2739 # Both generate this
2740 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2741 @bind = ('nwiger', 'completed', 'pending%');
2744 To get an OR instead, you can combine it with the arrayref idea:
2748 priority => [ { '=', 2 }, { '>', 5 } ]
2751 Which would generate:
2753 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2754 @bind = ('2', '5', 'nwiger');
2756 If you want to include literal SQL (with or without bind values), just use a
2757 scalar reference or reference to an arrayref as the value:
2760 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2761 date_expires => { '<' => \"now()" }
2764 Which would generate:
2766 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2767 @bind = ('11/26/2008');
2770 =head2 Logic and nesting operators
2772 In the example above,
2773 there is a subtle trap if you want to say something like
2774 this (notice the C<AND>):
2776 WHERE priority != ? AND priority != ?
2778 Because, in Perl you I<can't> do this:
2780 priority => { '!=' => 2, '!=' => 1 }
2782 As the second C<!=> key will obliterate the first. The solution
2783 is to use the special C<-modifier> form inside an arrayref:
2785 priority => [ -and => {'!=', 2},
2789 Normally, these would be joined by C<OR>, but the modifier tells it
2790 to use C<AND> instead. (Hint: You can use this in conjunction with the
2791 C<logic> option to C<new()> in order to change the way your queries
2792 work by default.) B<Important:> Note that the C<-modifier> goes
2793 B<INSIDE> the arrayref, as an extra first element. This will
2794 B<NOT> do what you think it might:
2796 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2798 Here is a quick list of equivalencies, since there is some overlap:
2801 status => {'!=', 'completed', 'not like', 'pending%' }
2802 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2805 status => {'=', ['assigned', 'in-progress']}
2806 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2807 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2811 =head2 Special operators: IN, BETWEEN, etc.
2813 You can also use the hashref format to compare a list of fields using the
2814 C<IN> comparison operator, by specifying the list as an arrayref:
2817 status => 'completed',
2818 reportid => { -in => [567, 2335, 2] }
2821 Which would generate:
2823 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2824 @bind = ('completed', '567', '2335', '2');
2826 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2829 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2830 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2831 'sqltrue' (by default: C<1=1>).
2833 In addition to the array you can supply a chunk of literal sql or
2834 literal sql with bind:
2837 customer => { -in => \[
2838 'SELECT cust_id FROM cust WHERE balance > ?',
2841 status => { -in => \'SELECT status_codes FROM states' },
2847 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2848 AND status IN ( SELECT status_codes FROM states )
2852 Finally, if the argument to C<-in> is not a reference, it will be
2853 treated as a single-element array.
2855 Another pair of operators is C<-between> and C<-not_between>,
2856 used with an arrayref of two values:
2860 completion_date => {
2861 -not_between => ['2002-10-01', '2003-02-06']
2867 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2869 Just like with C<-in> all plausible combinations of literal SQL
2873 start0 => { -between => [ 1, 2 ] },
2874 start1 => { -between => \["? AND ?", 1, 2] },
2875 start2 => { -between => \"lower(x) AND upper(y)" },
2876 start3 => { -between => [
2878 \["upper(?)", 'stuff' ],
2885 ( start0 BETWEEN ? AND ? )
2886 AND ( start1 BETWEEN ? AND ? )
2887 AND ( start2 BETWEEN lower(x) AND upper(y) )
2888 AND ( start3 BETWEEN lower(x) AND upper(?) )
2890 @bind = (1, 2, 1, 2, 'stuff');
2893 These are the two builtin "special operators"; but the
2894 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2896 =head2 Unary operators: bool
2898 If you wish to test against boolean columns or functions within your
2899 database you can use the C<-bool> and C<-not_bool> operators. For
2900 example to test the column C<is_user> being true and the column
2901 C<is_enabled> being false you would use:-
2905 -not_bool => 'is_enabled',
2910 WHERE is_user AND NOT is_enabled
2912 If a more complex combination is required, testing more conditions,
2913 then you should use the and/or operators:-
2918 -not_bool => { two=> { -rlike => 'bar' } },
2919 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2930 (NOT ( three = ? OR three > ? ))
2933 =head2 Nested conditions, -and/-or prefixes
2935 So far, we've seen how multiple conditions are joined with a top-level
2936 C<AND>. We can change this by putting the different conditions we want in
2937 hashes and then putting those hashes in an array. For example:
2942 status => { -like => ['pending%', 'dispatched'] },
2946 status => 'unassigned',
2950 This data structure would create the following:
2952 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2953 OR ( user = ? AND status = ? ) )";
2954 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2957 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2958 to change the logic inside:
2964 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2965 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2972 $stmt = "WHERE ( user = ?
2973 AND ( ( workhrs > ? AND geo = ? )
2974 OR ( workhrs < ? OR geo = ? ) ) )";
2975 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2977 =head3 Algebraic inconsistency, for historical reasons
2979 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2980 operator goes C<outside> of the nested structure; whereas when connecting
2981 several constraints on one column, the C<-and> operator goes
2982 C<inside> the arrayref. Here is an example combining both features:
2985 -and => [a => 1, b => 2],
2986 -or => [c => 3, d => 4],
2987 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2992 WHERE ( ( ( a = ? AND b = ? )
2993 OR ( c = ? OR d = ? )
2994 OR ( e LIKE ? AND e LIKE ? ) ) )
2996 This difference in syntax is unfortunate but must be preserved for
2997 historical reasons. So be careful: the two examples below would
2998 seem algebraically equivalent, but they are not
3001 { -like => 'foo%' },
3002 { -like => '%bar' },
3004 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3007 { col => { -like => 'foo%' } },
3008 { col => { -like => '%bar' } },
3010 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3013 =head2 Literal SQL and value type operators
3015 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3016 side" is a column name and the "right side" is a value (normally rendered as
3017 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3018 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3019 alter this behavior. There are several ways of doing so.
3023 This is a virtual operator that signals the string to its right side is an
3024 identifier (a column name) and not a value. For example to compare two
3025 columns you would write:
3028 priority => { '<', 2 },
3029 requestor => { -ident => 'submitter' },
3034 $stmt = "WHERE priority < ? AND requestor = submitter";
3037 If you are maintaining legacy code you may see a different construct as
3038 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3043 This is a virtual operator that signals that the construct to its right side
3044 is a value to be passed to DBI. This is for example necessary when you want
3045 to write a where clause against an array (for RDBMS that support such
3046 datatypes). For example:
3049 array => { -value => [1, 2, 3] }
3054 $stmt = 'WHERE array = ?';
3055 @bind = ([1, 2, 3]);
3057 Note that if you were to simply say:
3063 the result would probably not be what you wanted:
3065 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3070 Finally, sometimes only literal SQL will do. To include a random snippet
3071 of SQL verbatim, you specify it as a scalar reference. Consider this only
3072 as a last resort. Usually there is a better way. For example:
3075 priority => { '<', 2 },
3076 requestor => { -in => \'(SELECT name FROM hitmen)' },
3081 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3084 Note that in this example, you only get one bind parameter back, since
3085 the verbatim SQL is passed as part of the statement.
3089 Never use untrusted input as a literal SQL argument - this is a massive
3090 security risk (there is no way to check literal snippets for SQL
3091 injections and other nastyness). If you need to deal with untrusted input
3092 use literal SQL with placeholders as described next.
3094 =head3 Literal SQL with placeholders and bind values (subqueries)
3096 If the literal SQL to be inserted has placeholders and bind values,
3097 use a reference to an arrayref (yes this is a double reference --
3098 not so common, but perfectly legal Perl). For example, to find a date
3099 in Postgres you can use something like this:
3102 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3107 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3110 Note that you must pass the bind values in the same format as they are returned
3111 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3112 to C<columns>, you must provide the bind values in the
3113 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3114 scalar value; most commonly the column name, but you can use any scalar value
3115 (including references and blessed references), L<SQL::Abstract> will simply
3116 pass it through intact. So if C<bindtype> is set to C<columns> the above
3117 example will look like:
3120 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3123 Literal SQL is especially useful for nesting parenthesized clauses in the
3124 main SQL query. Here is a first example:
3126 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3130 bar => \["IN ($sub_stmt)" => @sub_bind],
3135 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3136 WHERE c2 < ? AND c3 LIKE ?))";
3137 @bind = (1234, 100, "foo%");
3139 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3140 are expressed in the same way. Of course the C<$sub_stmt> and
3141 its associated bind values can be generated through a former call
3144 my ($sub_stmt, @sub_bind)
3145 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3146 c3 => {-like => "foo%"}});
3149 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3152 In the examples above, the subquery was used as an operator on a column;
3153 but the same principle also applies for a clause within the main C<%where>
3154 hash, like an EXISTS subquery:
3156 my ($sub_stmt, @sub_bind)
3157 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3158 my %where = ( -and => [
3160 \["EXISTS ($sub_stmt)" => @sub_bind],
3165 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3166 WHERE c1 = ? AND c2 > t0.c0))";
3170 Observe that the condition on C<c2> in the subquery refers to
3171 column C<t0.c0> of the main query: this is I<not> a bind
3172 value, so we have to express it through a scalar ref.
3173 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3174 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3175 what we wanted here.
3177 Finally, here is an example where a subquery is used
3178 for expressing unary negation:
3180 my ($sub_stmt, @sub_bind)
3181 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3182 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3184 lname => {like => '%son%'},
3185 \["NOT ($sub_stmt)" => @sub_bind],
3190 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3191 @bind = ('%son%', 10, 20)
3193 =head3 Deprecated usage of Literal SQL
3195 Below are some examples of archaic use of literal SQL. It is shown only as
3196 reference for those who deal with legacy code. Each example has a much
3197 better, cleaner and safer alternative that users should opt for in new code.
3203 my %where = ( requestor => \'IS NOT NULL' )
3205 $stmt = "WHERE requestor IS NOT NULL"
3207 This used to be the way of generating NULL comparisons, before the handling
3208 of C<undef> got formalized. For new code please use the superior syntax as
3209 described in L</Tests for NULL values>.
3213 my %where = ( requestor => \'= submitter' )
3215 $stmt = "WHERE requestor = submitter"
3217 This used to be the only way to compare columns. Use the superior L</-ident>
3218 method for all new code. For example an identifier declared in such a way
3219 will be properly quoted if L</quote_char> is properly set, while the legacy
3220 form will remain as supplied.
3224 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3226 $stmt = "WHERE completed > ? AND is_ready"
3227 @bind = ('2012-12-21')
3229 Using an empty string literal used to be the only way to express a boolean.
3230 For all new code please use the much more readable
3231 L<-bool|/Unary operators: bool> operator.
3237 These pages could go on for a while, since the nesting of the data
3238 structures this module can handle are pretty much unlimited (the
3239 module implements the C<WHERE> expansion as a recursive function
3240 internally). Your best bet is to "play around" with the module a
3241 little to see how the data structures behave, and choose the best
3242 format for your data based on that.
3244 And of course, all the values above will probably be replaced with
3245 variables gotten from forms or the command line. After all, if you
3246 knew everything ahead of time, you wouldn't have to worry about
3247 dynamically-generating SQL and could just hardwire it into your
3250 =head1 ORDER BY CLAUSES
3252 Some functions take an order by clause. This can either be a scalar (just a
3253 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3254 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3257 Given | Will Generate
3258 ---------------------------------------------------------------
3260 'colA' | ORDER BY colA
3262 [qw/colA colB/] | ORDER BY colA, colB
3264 {-asc => 'colA'} | ORDER BY colA ASC
3266 {-desc => 'colB'} | ORDER BY colB DESC
3268 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3270 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3272 \'colA DESC' | ORDER BY colA DESC
3274 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3275 | /* ...with $x bound to ? */
3278 { -asc => 'colA' }, | colA ASC,
3279 { -desc => [qw/colB/] }, | colB DESC,
3280 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3281 \'colE DESC', | colE DESC,
3282 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3283 ] | /* ...with $x bound to ? */
3284 ===============================================================
3288 =head1 SPECIAL OPERATORS
3290 my $sqlmaker = SQL::Abstract->new(special_ops => [
3294 my ($self, $field, $op, $arg) = @_;
3300 handler => 'method_name',
3304 A "special operator" is a SQL syntactic clause that can be
3305 applied to a field, instead of a usual binary operator.
3308 WHERE field IN (?, ?, ?)
3309 WHERE field BETWEEN ? AND ?
3310 WHERE MATCH(field) AGAINST (?, ?)
3312 Special operators IN and BETWEEN are fairly standard and therefore
3313 are builtin within C<SQL::Abstract> (as the overridable methods
3314 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3315 like the MATCH .. AGAINST example above which is specific to MySQL,
3316 you can write your own operator handlers - supply a C<special_ops>
3317 argument to the C<new> method. That argument takes an arrayref of
3318 operator definitions; each operator definition is a hashref with two
3325 the regular expression to match the operator
3329 Either a coderef or a plain scalar method name. In both cases
3330 the expected return is C<< ($sql, @bind) >>.
3332 When supplied with a method name, it is simply called on the
3333 L<SQL::Abstract> object as:
3335 $self->$method_name($field, $op, $arg)
3339 $field is the LHS of the operator
3340 $op is the part that matched the handler regex
3343 When supplied with a coderef, it is called as:
3345 $coderef->($self, $field, $op, $arg)
3350 For example, here is an implementation
3351 of the MATCH .. AGAINST syntax for MySQL
3353 my $sqlmaker = SQL::Abstract->new(special_ops => [
3355 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3356 {regex => qr/^match$/i,
3358 my ($self, $field, $op, $arg) = @_;
3359 $arg = [$arg] if not ref $arg;
3360 my $label = $self->_quote($field);
3361 my ($placeholder) = $self->_convert('?');
3362 my $placeholders = join ", ", (($placeholder) x @$arg);
3363 my $sql = $self->_sqlcase('match') . " ($label) "
3364 . $self->_sqlcase('against') . " ($placeholders) ";
3365 my @bind = $self->_bindtype($field, @$arg);
3366 return ($sql, @bind);
3373 =head1 UNARY OPERATORS
3375 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3379 my ($self, $op, $arg) = @_;
3385 handler => 'method_name',
3389 A "unary operator" is a SQL syntactic clause that can be
3390 applied to a field - the operator goes before the field
3392 You can write your own operator handlers - supply a C<unary_ops>
3393 argument to the C<new> method. That argument takes an arrayref of
3394 operator definitions; each operator definition is a hashref with two
3401 the regular expression to match the operator
3405 Either a coderef or a plain scalar method name. In both cases
3406 the expected return is C<< $sql >>.
3408 When supplied with a method name, it is simply called on the
3409 L<SQL::Abstract> object as:
3411 $self->$method_name($op, $arg)
3415 $op is the part that matched the handler regex
3416 $arg is the RHS or argument of the operator
3418 When supplied with a coderef, it is called as:
3420 $coderef->($self, $op, $arg)
3428 Thanks to some benchmarking by Mark Stosberg, it turns out that
3429 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3430 I must admit this wasn't an intentional design issue, but it's a
3431 byproduct of the fact that you get to control your C<DBI> handles
3434 To maximize performance, use a code snippet like the following:
3436 # prepare a statement handle using the first row
3437 # and then reuse it for the rest of the rows
3439 for my $href (@array_of_hashrefs) {
3440 $stmt ||= $sql->insert('table', $href);
3441 $sth ||= $dbh->prepare($stmt);
3442 $sth->execute($sql->values($href));
3445 The reason this works is because the keys in your C<$href> are sorted
3446 internally by B<SQL::Abstract>. Thus, as long as your data retains
3447 the same structure, you only have to generate the SQL the first time
3448 around. On subsequent queries, simply use the C<values> function provided
3449 by this module to return your values in the correct order.
3451 However this depends on the values having the same type - if, for
3452 example, the values of a where clause may either have values
3453 (resulting in sql of the form C<column = ?> with a single bind
3454 value), or alternatively the values might be C<undef> (resulting in
3455 sql of the form C<column IS NULL> with no bind value) then the
3456 caching technique suggested will not work.
3460 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3461 really like this part (I do, at least). Building up a complex query
3462 can be as simple as the following:
3469 use CGI::FormBuilder;
3472 my $form = CGI::FormBuilder->new(...);
3473 my $sql = SQL::Abstract->new;
3475 if ($form->submitted) {
3476 my $field = $form->field;
3477 my $id = delete $field->{id};
3478 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3481 Of course, you would still have to connect using C<DBI> to run the
3482 query, but the point is that if you make your form look like your
3483 table, the actual query script can be extremely simplistic.
3485 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3486 a fast interface to returning and formatting data. I frequently
3487 use these three modules together to write complex database query
3488 apps in under 50 lines.
3490 =head1 HOW TO CONTRIBUTE
3492 Contributions are always welcome, in all usable forms (we especially
3493 welcome documentation improvements). The delivery methods include git-
3494 or unified-diff formatted patches, GitHub pull requests, or plain bug
3495 reports either via RT or the Mailing list. Contributors are generally
3496 granted full access to the official repository after their first several
3497 patches pass successful review.
3499 This project is maintained in a git repository. The code and related tools are
3500 accessible at the following locations:
3504 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3506 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3508 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3510 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3516 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3517 Great care has been taken to preserve the I<published> behavior
3518 documented in previous versions in the 1.* family; however,
3519 some features that were previously undocumented, or behaved
3520 differently from the documentation, had to be changed in order
3521 to clarify the semantics. Hence, client code that was relying
3522 on some dark areas of C<SQL::Abstract> v1.*
3523 B<might behave differently> in v1.50.
3525 The main changes are:
3531 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3535 support for the { operator => \"..." } construct (to embed literal SQL)
3539 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3543 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3547 defensive programming: check arguments
3551 fixed bug with global logic, which was previously implemented
3552 through global variables yielding side-effects. Prior versions would
3553 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3554 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3555 Now this is interpreted
3556 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3561 fixed semantics of _bindtype on array args
3565 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3566 we just avoid shifting arrays within that tree.
3570 dropped the C<_modlogic> function
3574 =head1 ACKNOWLEDGEMENTS
3576 There are a number of individuals that have really helped out with
3577 this module. Unfortunately, most of them submitted bugs via CPAN
3578 so I have no idea who they are! But the people I do know are:
3580 Ash Berlin (order_by hash term support)
3581 Matt Trout (DBIx::Class support)
3582 Mark Stosberg (benchmarking)
3583 Chas Owens (initial "IN" operator support)
3584 Philip Collins (per-field SQL functions)
3585 Eric Kolve (hashref "AND" support)
3586 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3587 Dan Kubb (support for "quote_char" and "name_sep")
3588 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3589 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3590 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3591 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3592 Oliver Charles (support for "RETURNING" after "INSERT")
3598 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3602 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3604 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3606 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3607 While not an official support venue, C<DBIx::Class> makes heavy use of
3608 C<SQL::Abstract>, and as such list members there are very familiar with
3609 how to create queries.
3613 This module is free software; you may copy this under the same
3614 terms as perl itself (either the GNU General Public License or
3615 the Artistic License)