1 package SQL::Abstract; # see doc at end of file
5 use Module::Runtime ();
10 use Exporter 'import';
11 our @EXPORT_OK = qw(is_plain_value is_literal_value);
21 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
27 #======================================================================
29 #======================================================================
31 our $VERSION = '1.86';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
149 (map +($_ => __PACKAGE__->make_binop_expander('_expand_between')),
150 qw(between not_between)),
151 (map +($_ => __PACKAGE__->make_binop_expander('_expand_in')),
153 (map +($_ => '_expand_op_andor'), ('and', 'or')),
154 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
155 (map +($_ => __PACKAGE__->make_unop_expander("_expand_${_}")),
156 qw(ident value nest)),
159 (map +($_, "_render_$_"),
160 qw(op func bind ident literal row values keyword)),
163 (map +($_ => '_render_op_between'), 'between', 'not_between'),
164 (map +($_ => '_render_op_in'), 'in', 'not_in'),
165 (map +($_ => '_render_unop_postfix'),
166 'is_null', 'is_not_null', 'asc', 'desc',
168 (not => '_render_unop_paren'),
169 (map +($_ => '_render_op_andor'), qw(and or)),
170 ',' => '_render_op_multop',
173 delete => [ qw(target where returning) ],
174 update => [ qw(target set where returning) ],
175 insert => [ qw(target fields from returning) ],
176 select => [ qw(select from where order_by) ],
179 'delete.from' => '_expand_delete_clause_target',
180 'update.update' => '_expand_update_clause_target',
181 'insert.into' => '_expand_insert_clause_target',
182 'insert.values' => '_expand_insert_clause_from',
185 'delete.target' => '_render_delete_clause_target',
186 'update.target' => '_render_update_clause_target',
187 'insert.target' => '_render_insert_clause_target',
188 'insert.fields' => '_render_insert_clause_fields',
189 'insert.from' => '_render_insert_clause_from',
193 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
194 $Defaults{expand}{$stmt} = '_expand_statement';
195 $Defaults{render}{$stmt} = '_render_statement';
196 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
197 $Defaults{expand_clause}{"${stmt}.${clause}"}
198 = "_expand_${stmt}_clause_${clause}";
204 my $class = ref($self) || $self;
205 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
207 # choose our case by keeping an option around
208 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
210 # default logic for interpreting arrayrefs
211 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
213 # how to return bind vars
214 $opt{bindtype} ||= 'normal';
216 # default comparison is "=", but can be overridden
219 # try to recognize which are the 'equality' and 'inequality' ops
220 # (temporary quickfix (in 2007), should go through a more seasoned API)
221 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
222 $opt{inequality_op} = qr/^( != | <> )$/ix;
224 $opt{like_op} = qr/^ (is_)?r?like $/xi;
225 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
228 $opt{sqltrue} ||= '1=1';
229 $opt{sqlfalse} ||= '0=1';
232 $opt{special_ops} ||= [];
235 $opt{unary_ops} ||= [];
237 # rudimentary sanity-check for user supplied bits treated as functions/operators
238 # If a purported function matches this regular expression, an exception is thrown.
239 # Literal SQL is *NOT* subject to this check, only functions (and column names
240 # when quoting is not in effect)
243 # need to guard against ()'s in column names too, but this will break tons of
244 # hacks... ideas anyone?
245 $opt{injection_guard} ||= qr/
251 $opt{expand_unary} = {};
253 foreach my $name (sort keys %Defaults) {
254 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
257 if ($class ne __PACKAGE__) {
259 # check for overriden methods
261 foreach my $type (qw(insert update delete)) {
262 my $method = "_${type}_returning";
263 if (__PACKAGE__->can($method) ne $class->can($method)) {
264 my $clause = "${type}.returning";
265 $opt{expand_clause}{$clause} = sub { $_[2] },
266 $opt{render_clause}{$clause}
267 = sub { [ $_[0]->$method($_[3]) ] };
270 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
271 $opt{expand_clause}{'select.from'} = sub {
272 return +{ -literal => [ $_[0]->_table($_[2]) ] };
275 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
276 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
277 $opt{render_clause}{'select.order_by'} = sub {
278 [ $_[0]->_order_by($_[2]) ];
281 if ($class->isa('DBIx::Class::SQLMaker')) {
282 $opt{warn_once_on_nest} = 1;
283 $opt{disable_old_special_ops} = 1;
284 $opt{render_clause}{'select.where'} = sub {
285 my ($sql, @bind) = $_[0]->where($_[2]);
286 s/\A\s+//, s/\s+\Z// for $sql;
287 return [ $sql, @bind ];
292 if ($opt{lazy_join_sql_parts}) {
293 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
294 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
297 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
299 return bless \%opt, $class;
303 my ($self, $name, $key, $value) = @_;
304 return $self->{$name}{$key} unless @_ > 3;
305 $self->{$name}{$key} = $value;
309 sub make_unop_expander {
310 my (undef, $exp) = @_;
312 my ($self, $name, $body, $k) = @_;
313 return $self->_expand_hashpair_cmp($k, { "-${name}" => $body })
315 return $self->$exp($name, $body);
319 sub make_binop_expander {
320 my (undef, $exp) = @_;
322 my ($self, $name, $body, $k) = @_;
323 $k = shift @{$body = [ @$body ]} unless defined $k;
324 $k = ref($k) ? $k : { -ident => $k };
325 return $self->$exp($name, $body, $k);
330 foreach my $type (qw(
331 expand op_expand render op_render clause_expand clause_render
333 my $name = join '_', reverse split '_', $type;
334 my $singular = "${type}er";
336 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
337 or die "Method builder failed for ${singular}: $@";
338 eval qq{sub wrap_${singular} {
339 shift->wrap_${singular}s(\@_)
340 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
342 eval qq{sub ${singular}s {
343 my (\$self, \@args) = \@_;
344 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
345 \$self->_ext_rw('${name}', \$this_key, \$this_value);
348 }; 1 } or die "Method builder failed for ${singular}s: $@";
349 eval qq{sub wrap_${singular}s {
350 my (\$self, \@args) = \@_;
351 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
352 my \$orig = \$self->_ext_rw('${name}', \$this_key);
354 '${name}', \$this_key,
355 \$this_builder->(\$orig, '${name}', \$this_key),
359 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
360 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
361 or die "Method builder failed for ${singular}_list: $@";
363 foreach my $singular (qw(unop_expander binop_expander)) {
364 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
365 or die "Method builder failed for ${singular}: $@";
366 eval qq{sub ${singular}s {
367 my (\$self, \@args) = \@_;
368 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
370 expand_op => \$this_key,
371 \$self->make_${singular}(\$this_value),
375 }; 1 } or die "Method builder failed for ${singular}s: $@";
379 sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
381 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
384 my ($self, $of, @clauses) = @_;
386 return @{$self->{clauses_of}{$of}||[]};
388 if (ref($clauses[0]) eq 'CODE') {
389 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
391 $self->{clauses_of}{$of} = \@clauses;
400 ref($self->{$_}) eq 'HASH'
409 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
410 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
412 sub _assert_pass_injection_guard {
413 if ($_[1] =~ $_[0]->{injection_guard}) {
414 my $class = ref $_[0];
415 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
416 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
417 . "{injection_guard} attribute to ${class}->new()"
422 #======================================================================
424 #======================================================================
427 my ($self, $table, $data, $options) = @_;
430 if (ref($table) eq 'HASH') {
433 my %clauses = (target => $table, values => $data, %{$options||{}});
437 my @rendered = $self->render_statement({ -insert => $stmt });
438 return wantarray ? @rendered : $rendered[0];
441 sub _expand_insert_clause_target {
442 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
445 sub _expand_insert_clause_fields {
447 $_[0]->expand_maybe_list_expr($_[2], -ident)
448 ] } if ref($_[2]) eq 'ARRAY';
449 return $_[2]; # should maybe still expand somewhat?
452 sub _expand_insert_clause_from {
453 my ($self, undef, $data) = @_;
454 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
455 return $self->expand_expr($data);
457 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
459 from => { -values => [ $v_aqt ] },
460 ($f_aqt ? (fields => $f_aqt) : ()),
464 sub _expand_insert_clause_returning {
465 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
468 sub _expand_insert_values {
469 my ($self, $data) = @_;
470 if (is_literal_value($data)) {
471 (undef, $self->expand_expr($data));
473 my ($fields, $values) = (
474 ref($data) eq 'HASH' ?
475 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
479 # no names (arrayref) means can't generate bindtype
480 !($fields) && $self->{bindtype} eq 'columns'
481 && belch "can't do 'columns' bindtype when called with arrayref";
485 ? $self->expand_expr({ -row => $fields }, -ident)
490 local our $Cur_Col_Meta = $fields->[$_];
491 $self->_expand_insert_value($values->[$_])
498 sub _render_insert_clause_fields {
499 return $_[0]->render_aqt($_[2]);
502 sub _render_insert_clause_target {
503 my ($self, undef, $from) = @_;
504 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
507 sub _render_insert_clause_from {
508 return $_[0]->render_aqt($_[2], 1);
511 # So that subclasses can override INSERT ... RETURNING separately from
512 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
513 sub _insert_returning { shift->_returning(@_) }
515 sub _redispatch_returning {
516 my ($self, $type, undef, $returning) = @_;
517 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
521 my ($self, $options) = @_;
523 my $f = $options->{returning};
525 my ($sql, @bind) = @{ $self->render_aqt(
526 $self->expand_maybe_list_expr($f, -ident)
528 return ($self->_sqlcase(' returning ').$sql, @bind);
531 sub _expand_insert_value {
534 my $k = our $Cur_Col_Meta;
536 if (ref($v) eq 'ARRAY') {
537 if ($self->{array_datatypes}) {
538 return +{ -bind => [ $k, $v ] };
540 my ($sql, @bind) = @$v;
541 $self->_assert_bindval_matches_bindtype(@bind);
542 return +{ -literal => $v };
544 if (ref($v) eq 'HASH') {
545 if (grep !/^-/, keys %$v) {
546 belch "HASH ref as bind value in insert is not supported";
547 return +{ -bind => [ $k, $v ] };
551 return +{ -bind => [ $k, undef ] };
553 return $self->expand_expr($v);
558 #======================================================================
560 #======================================================================
563 my ($self, $table, $set, $where, $options) = @_;
566 if (ref($table) eq 'HASH') {
570 @clauses{qw(target set where)} = ($table, $set, $where);
571 puke "Unsupported data type specified to \$sql->update"
572 unless ref($clauses{set}) eq 'HASH';
573 @clauses{keys %$options} = values %$options;
577 my @rendered = $self->render_statement({ -update => $stmt });
578 return wantarray ? @rendered : $rendered[0];
581 sub _render_update_clause_target {
582 my ($self, undef, $target) = @_;
583 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
586 sub _update_set_values {
587 my ($self, $data) = @_;
589 return @{ $self->render_aqt(
590 $self->_expand_update_set_values(undef, $data),
594 sub _expand_update_set_values {
595 my ($self, undef, $data) = @_;
596 $self->expand_maybe_list_expr( [
599 $set = { -bind => $_ } unless defined $set;
600 +{ -op => [ '=', { -ident => $k }, $set ] };
606 ? ($self->{array_datatypes}
607 ? [ $k, +{ -bind => [ $k, $v ] } ]
608 : [ $k, +{ -literal => $v } ])
610 local our $Cur_Col_Meta = $k;
611 [ $k, $self->_expand_expr($v) ]
618 sub _expand_update_clause_target {
619 my ($self, undef, $target) = @_;
620 +(target => $self->expand_maybe_list_expr($target, -ident));
623 sub _expand_update_clause_set {
624 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
625 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
628 sub _expand_update_clause_where {
629 +(where => $_[0]->expand_expr($_[2]));
632 sub _expand_update_clause_returning {
633 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
636 # So that subclasses can override UPDATE ... RETURNING separately from
638 sub _update_returning { shift->_returning(@_) }
642 #======================================================================
644 #======================================================================
647 my ($self, @args) = @_;
649 if (ref(my $sel = $args[0]) eq 'HASH') {
653 @clauses{qw(from select where order_by)} = @args;
655 # This oddity is to literalify since historically SQLA doesn't quote
656 # a single identifier argument, so we convert it into a literal
658 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
659 unless ref($clauses{select});
664 my @rendered = $self->render_statement({ -select => $stmt });
665 return wantarray ? @rendered : $rendered[0];
668 sub _expand_select_clause_select {
669 my ($self, undef, $select) = @_;
670 +(select => $self->expand_maybe_list_expr($select, -ident));
673 sub _expand_select_clause_from {
674 my ($self, undef, $from) = @_;
675 +(from => $self->expand_maybe_list_expr($from, -ident));
678 sub _expand_select_clause_where {
679 my ($self, undef, $where) = @_;
682 if (my $conv = $self->{convert}) {
694 ->wrap_expander(bind => $_wrap)
695 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
696 ->wrap_expander(func => sub {
699 my ($self, $type, $thing) = @_;
700 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
701 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
704 or $thing->[1]{-value}
705 or $thing->[1]{-bind})
707 return { -func => $thing }; # already went through our expander
709 return $self->$orig($type, $thing);
717 return +(where => $sqla->expand_expr($where));
720 sub _expand_select_clause_order_by {
721 my ($self, undef, $order_by) = @_;
722 +(order_by => $self->_expand_order_by($order_by));
726 my ($self, $fields) = @_;
727 return $fields unless ref($fields);
728 return @{ $self->render_aqt(
729 $self->expand_maybe_list_expr($fields, '-ident')
733 #======================================================================
735 #======================================================================
738 my ($self, $table, $where, $options) = @_;
741 if (ref($table) eq 'HASH') {
744 my %clauses = (target => $table, where => $where, %{$options||{}});
748 my @rendered = $self->render_statement({ -delete => $stmt });
749 return wantarray ? @rendered : $rendered[0];
752 # So that subclasses can override DELETE ... RETURNING separately from
754 sub _delete_returning { shift->_returning(@_) }
756 sub _expand_delete_clause_target {
757 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
760 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
762 sub _expand_delete_clause_returning {
763 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
766 sub _render_delete_clause_target {
767 my ($self, undef, $from) = @_;
768 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
771 #======================================================================
773 #======================================================================
777 # Finally, a separate routine just to handle WHERE clauses
779 my ($self, $where, $order) = @_;
781 local $self->{convert_where} = $self->{convert};
784 my ($sql, @bind) = defined($where)
785 ? $self->_recurse_where($where)
787 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
791 my ($order_sql, @order_bind) = $self->_order_by($order);
793 push @bind, @order_bind;
796 return wantarray ? ($sql, @bind) : $sql;
799 { our $Default_Scalar_To = -value }
802 my ($self, $expr, $default_scalar_to) = @_;
803 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
804 $self->_expand_expr($expr);
808 my ($self, $aqt, $top_level) = @_;
809 my ($k, $v, @rest) = %$aqt;
811 die "Not a node type: $k" unless $k =~ s/^-//;
812 if (my $meth = $self->{render}{$k}) {
813 local our $Render_Top_Level = $top_level;
814 return $self->$meth($k, $v);
816 die "notreached: $k";
820 my ($self, $expr, $default_scalar_to) = @_;
821 return @{ $self->render_aqt(
822 $self->expand_expr($expr, $default_scalar_to)
826 sub render_statement {
827 my ($self, $expr, $default_scalar_to) = @_;
829 $self->expand_expr($expr, $default_scalar_to), 1
833 sub _expand_statement {
834 my ($self, $type, $args) = @_;
835 my $ec = $self->{expand_clause};
838 $args->{$type} = delete $args->{_}
840 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
841 return +{ "-${type}" => +{
843 my $val = $args->{$_};
844 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
845 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
850 } elsif ($has_clause{$_}) {
851 ($_ => $self->expand_expr($val))
859 sub _render_statement {
860 my ($self, $type, $args) = @_;
862 foreach my $clause (@{$self->{clauses_of}{$type}}) {
863 next unless my $clause_expr = $args->{$clause};
865 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
866 $self->$rdr($clause, $clause_expr, $args);
868 my $r = $self->render_aqt($clause_expr, 1);
869 next unless defined $r->[0] and length $r->[0];
870 $self->join_query_parts(' ',
871 { -keyword => $clause },
878 my $q = $self->join_query_parts(' ', @parts);
879 return $self->join_query_parts('',
880 (our $Render_Top_Level ? $q : ('(', $q, ')'))
885 my ($self, $raw) = @_;
887 return $op if grep $_->{$op}, @{$self}{qw(is_op expand_op render_op)};
888 s/^-(?=.)//, s/\s+/_/g for $op;
893 my ($self, $expr) = @_;
894 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
895 return undef unless defined($expr);
896 if (ref($expr) eq 'HASH') {
897 return undef unless my $kc = keys %$expr;
899 return $self->_expand_op_andor(and => $expr);
901 my ($key, $value) = %$expr;
902 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
903 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
904 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
906 return $self->_expand_hashpair($key, $value);
908 if (ref($expr) eq 'ARRAY') {
909 return $self->_expand_op_andor(lc($self->{logic}), $expr);
911 if (my $literal = is_literal_value($expr)) {
912 return +{ -literal => $literal };
914 if (!ref($expr) or Scalar::Util::blessed($expr)) {
915 return $self->_expand_scalar($expr);
920 sub _expand_hashpair {
921 my ($self, $k, $v) = @_;
922 unless (defined($k) and length($k)) {
923 if (defined($k) and my $literal = is_literal_value($v)) {
924 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
925 return { -literal => $literal };
927 puke "Supplying an empty left hand side argument is not supported";
930 return $self->_expand_hashpair_op($k, $v);
931 } elsif ($k =~ /^[^\w]/i) {
932 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
933 return $self->_expand_op(
934 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
937 return $self->_expand_hashpair_ident($k, $v);
940 sub _expand_hashpair_ident {
941 my ($self, $k, $v) = @_;
943 local our $Cur_Col_Meta = $k;
945 # hash with multiple or no elements is andor
947 if (ref($v) eq 'HASH' and keys %$v != 1) {
948 return $self->_expand_op_andor(and => $v, $k);
951 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
953 if (is_undef_value($v)) {
954 return $self->_expand_hashpair_cmp($k => undef);
957 # scalars and objects get expanded as whatever requested or values
959 if (!ref($v) or Scalar::Util::blessed($v)) {
960 return $self->_expand_hashpair_scalar($k, $v);
963 # single key hashref is a hashtriple
965 if (ref($v) eq 'HASH') {
966 return $self->_expand_hashtriple($k, %$v);
969 # arrayref needs re-engineering over the elements
971 if (ref($v) eq 'ARRAY') {
972 return $self->sqlfalse unless @$v;
973 $self->_debug("ARRAY($k) means distribute over elements");
975 $v->[0] =~ /^-(and|or)$/i
976 ? (shift(@{$v = [ @$v ]}), $1)
977 : lc($self->{logic} || 'OR')
979 return $self->_expand_op_andor(
984 if (my $literal = is_literal_value($v)) {
986 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
989 my ($sql, @bind) = @$literal;
990 if ($self->{bindtype} eq 'columns') {
992 $self->_assert_bindval_matches_bindtype($_);
995 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
1000 sub _expand_scalar {
1001 my ($self, $expr) = @_;
1003 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
1006 sub _expand_hashpair_scalar {
1007 my ($self, $k, $v) = @_;
1009 return $self->_expand_hashpair_cmp(
1010 $k, $self->_expand_scalar($v),
1014 sub _expand_hashpair_op {
1015 my ($self, $k, $v) = @_;
1017 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
1019 my $op = $self->_normalize_op($k);
1021 my $wsop = join(' ', split '_', $op);
1023 my $is_special = List::Util::first { $wsop =~ $_->{regex} }
1024 @{$self->{special_ops}};
1028 # the old special op system requires illegality for top-level use
1031 (our $Expand_Depth) == 1
1035 $self->{disable_old_special_ops}
1036 and List::Util::first { $wsop =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1040 puke "Illegal use of top-level '-$wsop'"
1044 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1045 return $self->$exp($op, $v);
1048 if ($self->{render}{$op}) {
1049 return { "-${op}" => $v };
1052 # Ops prefixed with -not_ get converted
1054 if (my ($rest) = $op =~/^not_(.*)$/) {
1057 $self->_expand_expr({ "-${rest}", $v })
1063 # the old unary op system means we should touch nothing and let it work
1065 my $op = join(' ', split '_', $op);
1067 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1068 return { -op => [ $op, $v ] };
1072 my $type = $is_special || $self->{render_op}{$op} ? -op : -func;
1074 if ($self->{restore_old_unop_handling}) {
1081 and (keys %$v)[0] =~ /^-/
1082 and not $self->{render_op}{$op}
1091 if ($type eq -func and ref($v) eq 'ARRAY') {
1092 return $self->_expand_expr({ -func => [ $op, @$v ] });
1095 return $self->_expand_expr({ $type => [ $op, $v ] });
1098 sub _expand_hashpair_cmp {
1099 my ($self, $k, $v) = @_;
1100 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1103 sub _expand_hashtriple {
1104 my ($self, $k, $vk, $vv) = @_;
1106 my $ik = $self->_expand_expr({ -ident => $k });
1108 my $op = $self->_normalize_op($vk);
1109 $self->_assert_pass_injection_guard($op);
1111 if ($op =~ s/ _? \d+ $//x ) {
1112 return $self->_expand_expr($k, { $vk, $vv });
1114 if (my $x = $self->{expand_op}{$op}) {
1115 local our $Cur_Col_Meta = $k;
1116 return $self->$x($op, $vv, $k);
1120 my $op = join(' ', split '_', $op);
1122 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1123 return { -op => [ $op, $ik, $vv ] };
1125 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1129 { -op => [ $op, $vv ] }
1133 if (ref($vv) eq 'ARRAY') {
1135 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1136 ? (shift(@raw), lc $1) : 'or';
1137 my @values = map +{ $vk => $_ }, @raw;
1139 $op =~ $self->{inequality_op}
1140 or $op =~ $self->{not_like_op}
1142 if (lc($logic) eq 'or' and @values > 1) {
1143 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1144 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1145 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1150 # try to DWIM on equality operators
1151 return ($self->_dwim_op_to_is($op,
1152 "Supplying an empty arrayref to '%s' is deprecated",
1153 "operator '%s' applied on an empty array (field '$k')"
1154 ) ? $self->sqlfalse : $self->sqltrue);
1156 return $self->_expand_op_andor($logic => \@values, $k);
1158 if (is_undef_value($vv)) {
1159 my $is = ($self->_dwim_op_to_is($op,
1160 "Supplying an undefined argument to '%s' is deprecated",
1161 "unexpected operator '%s' with undef operand",
1162 ) ? 'is' : 'is not');
1164 return $self->_expand_hashpair($k => { $is, undef });
1166 local our $Cur_Col_Meta = $k;
1170 $self->_expand_expr($vv)
1174 sub _dwim_op_to_is {
1175 my ($self, $raw, $empty, $fail) = @_;
1177 my $op = $self->_normalize_op($raw);
1179 if ($op =~ /^not$/i) {
1182 if ($op =~ $self->{equality_op}) {
1185 if ($op =~ $self->{like_op}) {
1186 belch(sprintf $empty, uc(join ' ', split '_', $op));
1189 if ($op =~ $self->{inequality_op}) {
1192 if ($op =~ $self->{not_like_op}) {
1193 belch(sprintf $empty, uc(join ' ', split '_', $op));
1196 puke(sprintf $fail, $op);
1200 my ($self, undef, $args) = @_;
1201 my ($func, @args) = @$args;
1202 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1206 my ($self, undef, $body) = @_;
1207 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1208 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1210 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1211 ref($body) ? @$body : $body;
1212 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1213 unless ($self->{quote_char}) {
1214 $self->_assert_pass_injection_guard($_) for @parts;
1216 return +{ -ident => \@parts };
1220 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1224 my ($self, undef, $args) = @_;
1225 +{ -row => [ map $self->expand_expr($_), @$args ] };
1229 my ($self, undef, $args) = @_;
1230 my ($op, @opargs) = @$args;
1231 if (my $exp = $self->{expand_op}{$op}) {
1232 return $self->$exp($op, \@opargs);
1234 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1238 my ($self, undef, $v) = @_;
1240 return $self->_expand_expr($v);
1242 puke "-bool => undef not supported" unless defined($v);
1243 return $self->_expand_expr({ -ident => $v });
1246 sub _expand_op_andor {
1247 my ($self, $logop, $v, $k) = @_;
1249 $v = [ map +{ $k, $_ },
1251 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1255 if (ref($v) eq 'HASH') {
1256 return undef unless keys %$v;
1259 map $self->_expand_expr({ $_ => $v->{$_} }),
1263 if (ref($v) eq 'ARRAY') {
1264 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1267 (ref($_) eq 'ARRAY' and @$_)
1268 or (ref($_) eq 'HASH' and %$_)
1274 while (my ($el) = splice @expr, 0, 1) {
1275 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1276 unless defined($el) and length($el);
1277 my $elref = ref($el);
1279 local our $Expand_Depth = 0;
1280 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1281 } elsif ($elref eq 'ARRAY') {
1282 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1283 } elsif (my $l = is_literal_value($el)) {
1284 push @res, { -literal => $l };
1285 } elsif ($elref eq 'HASH') {
1286 local our $Expand_Depth = 0;
1287 push @res, grep defined, $self->_expand_expr($el) if %$el;
1293 # return $res[0] if @res == 1;
1294 return { -op => [ $logop, @res ] };
1300 my ($self, $op, $vv, $k) = @_;
1301 ($k, $vv) = @$vv unless defined $k;
1302 puke "$op can only take undef as argument"
1306 and exists($vv->{-value})
1307 and !defined($vv->{-value})
1309 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1312 sub _expand_between {
1313 my ($self, $op, $vv, $k) = @_;
1314 my @rhs = map $self->_expand_expr($_),
1315 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1317 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1319 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1321 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1325 $self->expand_expr($k),
1326 map $self->expand_expr($_, -value), @rhs
1331 my ($self, $op, $vv, $k) = @_;
1332 if (my $literal = is_literal_value($vv)) {
1333 my ($sql, @bind) = @$literal;
1334 my $opened_sql = $self->_open_outer_paren($sql);
1336 $op, $self->expand_expr($k, -ident),
1337 { -literal => [ $opened_sql, @bind ] }
1341 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1342 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1343 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1344 . 'will emit the logically correct SQL instead of raising this exception)'
1346 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1348 my @rhs = map $self->expand_expr($_, -value),
1349 map { defined($_) ? $_: puke($undef_err) }
1350 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1351 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1355 $self->expand_expr($k, -ident),
1361 my ($self, undef, $v) = @_;
1362 # DBIx::Class requires a nest warning to be emitted once but the private
1363 # method it overrode to do so no longer exists
1364 if ($self->{warn_once_on_nest}) {
1365 unless (our $Nest_Warned) {
1367 "-nest in search conditions is deprecated, you most probably wanted:\n"
1368 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1373 return $self->_expand_expr($v);
1376 sub _expand_values {
1377 my ($self, undef, $values) = @_;
1378 return { -values => [
1381 ? $self->expand_expr($_)
1382 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1383 ), ref($values) eq 'ARRAY' ? @$values : $values
1387 sub _recurse_where {
1388 my ($self, $where) = @_;
1390 # Special case: top level simple string treated as literal
1392 my $where_exp = (ref($where)
1393 ? $self->_expand_select_clause_where(undef, $where)
1394 : { -literal => [ $where ] });
1396 # dispatch expanded expression
1398 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1399 # DBIx::Class used to call _recurse_where in scalar context
1400 # something else might too...
1402 return ($sql, @bind);
1405 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1411 my ($self, undef, $ident) = @_;
1413 return [ $self->_quote($ident) ];
1417 my ($self, undef, $values) = @_;
1418 return $self->join_query_parts('',
1420 $self->_render_op(undef, [ ',', @$values ]),
1426 my ($self, undef, $rest) = @_;
1427 my ($func, @args) = @$rest;
1428 return $self->join_query_parts('',
1429 $self->_sqlcase($func),
1430 $self->join_query_parts('',
1432 $self->join_query_parts(', ', @args),
1439 my ($self, undef, $bind) = @_;
1440 return [ '?', $self->_bindtype(@$bind) ];
1443 sub _render_literal {
1444 my ($self, undef, $literal) = @_;
1445 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1449 sub _render_keyword {
1450 my ($self, undef, $keyword) = @_;
1451 return [ $self->_sqlcase(
1452 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1457 my ($self, undef, $v) = @_;
1458 my ($op, @args) = @$v;
1459 if (my $r = $self->{render_op}{$op}) {
1460 return $self->$r($op, \@args);
1465 my $op = join(' ', split '_', $op);
1467 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1468 if ($ss and @args > 1) {
1469 puke "Special op '${op}' requires first value to be identifier"
1470 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1471 my $k = join(($self->{name_sep}||'.'), @$ident);
1472 local our $Expand_Depth = 1;
1473 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1475 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1476 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1479 return $self->_render_unop_paren($op, \@args);
1483 return $self->_render_unop_prefix($op, \@args);
1485 return $self->_render_op_multop($op, \@args);
1491 sub _render_op_between {
1492 my ($self, $op, $args) = @_;
1493 my ($left, $low, $high) = @$args;
1496 puke "Single arg to between must be a literal"
1497 unless $low->{-literal};
1500 +($low, { -keyword => 'and' }, $high);
1503 return $self->join_query_parts(' ',
1504 '(', $left, { -keyword => $op }, @rh, ')',
1509 my ($self, $op, $args) = @_;
1510 my ($lhs, @rhs) = @$args;
1512 return $self->join_query_parts(' ',
1514 { -keyword => $op },
1515 $self->join_query_parts(' ',
1517 $self->join_query_parts(', ', @rhs),
1523 sub _render_op_andor {
1524 my ($self, $op, $args) = @_;
1525 return undef unless @$args;
1526 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1527 my $inner = $self->_render_op_multop($op, $args);
1528 return undef unless defined($inner->[0]) and length($inner->[0]);
1529 return $self->join_query_parts(' ',
1534 sub _render_op_multop {
1535 my ($self, $op, $args) = @_;
1537 return undef unless @parts;
1538 return $self->render_aqt($parts[0]) if @parts == 1;
1539 my $join = ($op eq ','
1541 : { -keyword => " ${op} " }
1543 return $self->join_query_parts($join, @parts);
1546 sub _render_values {
1547 my ($self, undef, $values) = @_;
1548 my $inner = $self->join_query_parts(' ',
1549 { -keyword => 'values' },
1550 $self->join_query_parts(', ',
1551 ref($values) eq 'ARRAY' ? @$values : $values
1554 return $self->join_query_parts('',
1555 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1559 sub join_query_parts {
1560 my ($self, $join, @parts) = @_;
1561 if (ref($join) eq 'HASH') {
1562 $join = $self->render_aqt($join)->[0];
1566 ? $self->render_aqt($_)
1567 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1570 $self->{join_sql_parts}->(
1571 $join, grep defined && length, map $_->[0], @final
1573 (map @{$_}[1..$#$_], @final),
1577 sub _render_unop_paren {
1578 my ($self, $op, $v) = @_;
1579 return $self->join_query_parts('',
1580 '(', $self->_render_unop_prefix($op, $v), ')'
1584 sub _render_unop_prefix {
1585 my ($self, $op, $v) = @_;
1586 my $op_sql = $self->{restore_old_unop_handling}
1587 ? $self->_sqlcase($op)
1588 : { -keyword => $op };
1589 return $self->join_query_parts(' ',
1590 ($self->{restore_old_unop_handling}
1591 ? $self->_sqlcase($op)
1592 : { -keyword => \$op }),
1597 sub _render_unop_postfix {
1598 my ($self, $op, $v) = @_;
1599 return $self->join_query_parts(' ',
1600 $v->[0], { -keyword => $op },
1604 # Some databases (SQLite) treat col IN (1, 2) different from
1605 # col IN ( (1, 2) ). Use this to strip all outer parens while
1606 # adding them back in the corresponding method
1607 sub _open_outer_paren {
1608 my ($self, $sql) = @_;
1610 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1612 # there are closing parens inside, need the heavy duty machinery
1613 # to reevaluate the extraction starting from $sql (full reevaluation)
1614 if ($inner =~ /\)/) {
1615 require Text::Balanced;
1617 my (undef, $remainder) = do {
1618 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1620 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1623 # the entire expression needs to be a balanced bracketed thing
1624 # (after an extract no remainder sans trailing space)
1625 last if defined $remainder and $remainder =~ /\S/;
1635 #======================================================================
1637 #======================================================================
1639 sub _expand_order_by {
1640 my ($self, $arg) = @_;
1642 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1644 return $self->expand_maybe_list_expr($arg)
1645 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1647 my $expander = sub {
1648 my ($self, $dir, $expr) = @_;
1649 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1650 foreach my $arg (@to_expand) {
1654 and grep /^-(asc|desc)$/, keys %$arg
1656 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1660 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1662 map $self->expand_expr($_, -ident),
1663 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1664 return undef unless @exp;
1665 return undef if @exp == 1 and not defined($exp[0]);
1666 return +{ -op => [ ',', @exp ] };
1669 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1671 return $self->$expander(undef, $arg);
1675 my ($self, $arg) = @_;
1677 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1679 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1681 return '' unless length($sql);
1683 my $final_sql = $self->_sqlcase(' order by ').$sql;
1685 return ($final_sql, @bind);
1688 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1690 sub _order_by_chunks {
1691 my ($self, $arg) = @_;
1693 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1695 my @res = $self->_chunkify_order_by($expanded);
1696 (ref() ? $_->[0] : $_) .= '' for @res;
1700 sub _chunkify_order_by {
1701 my ($self, $expanded) = @_;
1703 return grep length, @{ $self->render_aqt($expanded) }
1704 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1707 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1708 my ($comma, @list) = @{$_->{-op}};
1709 return map $self->_chunkify_order_by($_), @list;
1711 return $self->render_aqt($_);
1715 #======================================================================
1716 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1717 #======================================================================
1723 $self->expand_maybe_list_expr($from, -ident)
1728 #======================================================================
1730 #======================================================================
1732 sub expand_maybe_list_expr {
1733 my ($self, $expr, $default) = @_;
1735 ',', map $self->expand_expr($_, $default),
1736 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1737 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1738 return +{ -op => [ ',',
1739 map $self->expand_expr($_, $default),
1740 ref($expr) eq 'ARRAY' ? @$expr : $expr
1744 # highly optimized, as it's called way too often
1746 # my ($self, $label) = @_;
1748 return '' unless defined $_[1];
1749 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1750 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1752 unless ($_[0]->{quote_char}) {
1753 if (ref($_[1]) eq 'ARRAY') {
1754 return join($_[0]->{name_sep}||'.', @{$_[1]});
1756 $_[0]->_assert_pass_injection_guard($_[1]);
1761 my $qref = ref $_[0]->{quote_char};
1763 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1764 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1765 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1767 my $esc = $_[0]->{escape_char} || $r;
1769 # parts containing * are naturally unquoted
1771 $_[0]->{name_sep}||'',
1775 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1777 (ref($_[1]) eq 'ARRAY'
1781 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1789 # Conversion, if applicable
1791 #my ($self, $arg) = @_;
1792 if (my $conv = $_[0]->{convert_where}) {
1793 return @{ $_[0]->join_query_parts('',
1794 $_[0]->_sqlcase($conv),
1803 #my ($self, $col, @vals) = @_;
1804 # called often - tighten code
1805 return $_[0]->{bindtype} eq 'columns'
1806 ? map {[$_[1], $_]} @_[2 .. $#_]
1811 # Dies if any element of @bind is not in [colname => value] format
1812 # if bindtype is 'columns'.
1813 sub _assert_bindval_matches_bindtype {
1814 # my ($self, @bind) = @_;
1816 if ($self->{bindtype} eq 'columns') {
1818 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1819 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1825 # Fix SQL case, if so requested
1827 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1828 # don't touch the argument ... crooked logic, but let's not change it!
1829 return $_[0]->{case} ? $_[1] : uc($_[1]);
1832 #======================================================================
1833 # DISPATCHING FROM REFKIND
1834 #======================================================================
1837 my ($self, $data) = @_;
1839 return 'UNDEF' unless defined $data;
1841 # blessed objects are treated like scalars
1842 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1844 return 'SCALAR' unless $ref;
1847 while ($ref eq 'REF') {
1849 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1853 return ($ref||'SCALAR') . ('REF' x $n_steps);
1857 my ($self, $data) = @_;
1858 my @try = ($self->_refkind($data));
1859 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1860 push @try, 'FALLBACK';
1864 sub _METHOD_FOR_refkind {
1865 my ($self, $meth_prefix, $data) = @_;
1868 for (@{$self->_try_refkind($data)}) {
1869 $method = $self->can($meth_prefix."_".$_)
1873 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1877 sub _SWITCH_refkind {
1878 my ($self, $data, $dispatch_table) = @_;
1881 for (@{$self->_try_refkind($data)}) {
1882 $coderef = $dispatch_table->{$_}
1886 puke "no dispatch entry for ".$self->_refkind($data)
1895 #======================================================================
1896 # VALUES, GENERATE, AUTOLOAD
1897 #======================================================================
1899 # LDNOTE: original code from nwiger, didn't touch code in that section
1900 # I feel the AUTOLOAD stuff should not be the default, it should
1901 # only be activated on explicit demand by user.
1905 my $data = shift || return;
1906 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1907 unless ref $data eq 'HASH';
1910 foreach my $k (sort keys %$data) {
1911 my $v = $data->{$k};
1912 $self->_SWITCH_refkind($v, {
1914 if ($self->{array_datatypes}) { # array datatype
1915 push @all_bind, $self->_bindtype($k, $v);
1917 else { # literal SQL with bind
1918 my ($sql, @bind) = @$v;
1919 $self->_assert_bindval_matches_bindtype(@bind);
1920 push @all_bind, @bind;
1923 ARRAYREFREF => sub { # literal SQL with bind
1924 my ($sql, @bind) = @${$v};
1925 $self->_assert_bindval_matches_bindtype(@bind);
1926 push @all_bind, @bind;
1928 SCALARREF => sub { # literal SQL without bind
1930 SCALAR_or_UNDEF => sub {
1931 push @all_bind, $self->_bindtype($k, $v);
1942 my(@sql, @sqlq, @sqlv);
1946 if ($ref eq 'HASH') {
1947 for my $k (sort keys %$_) {
1950 my $label = $self->_quote($k);
1951 if ($r eq 'ARRAY') {
1952 # literal SQL with bind
1953 my ($sql, @bind) = @$v;
1954 $self->_assert_bindval_matches_bindtype(@bind);
1955 push @sqlq, "$label = $sql";
1957 } elsif ($r eq 'SCALAR') {
1958 # literal SQL without bind
1959 push @sqlq, "$label = $$v";
1961 push @sqlq, "$label = ?";
1962 push @sqlv, $self->_bindtype($k, $v);
1965 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1966 } elsif ($ref eq 'ARRAY') {
1967 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1970 if ($r eq 'ARRAY') { # literal SQL with bind
1971 my ($sql, @bind) = @$v;
1972 $self->_assert_bindval_matches_bindtype(@bind);
1975 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1976 # embedded literal SQL
1983 push @sql, '(' . join(', ', @sqlq) . ')';
1984 } elsif ($ref eq 'SCALAR') {
1988 # strings get case twiddled
1989 push @sql, $self->_sqlcase($_);
1993 my $sql = join ' ', @sql;
1995 # this is pretty tricky
1996 # if ask for an array, return ($stmt, @bind)
1997 # otherwise, s/?/shift @sqlv/ to put it inline
1999 return ($sql, @sqlv);
2001 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2002 ref $d ? $d->[1] : $d/e;
2011 # This allows us to check for a local, then _form, attr
2013 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2014 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2015 return $self->generate($name, @_);
2026 SQL::Abstract - Generate SQL from Perl data structures
2032 my $sql = SQL::Abstract->new;
2034 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2036 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2038 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2040 my($stmt, @bind) = $sql->delete($table, \%where);
2042 # Then, use these in your DBI statements
2043 my $sth = $dbh->prepare($stmt);
2044 $sth->execute(@bind);
2046 # Just generate the WHERE clause
2047 my($stmt, @bind) = $sql->where(\%where, $order);
2049 # Return values in the same order, for hashed queries
2050 # See PERFORMANCE section for more details
2051 my @bind = $sql->values(\%fieldvals);
2055 This module was inspired by the excellent L<DBIx::Abstract>.
2056 However, in using that module I found that what I really wanted
2057 to do was generate SQL, but still retain complete control over my
2058 statement handles and use the DBI interface. So, I set out to
2059 create an abstract SQL generation module.
2061 While based on the concepts used by L<DBIx::Abstract>, there are
2062 several important differences, especially when it comes to WHERE
2063 clauses. I have modified the concepts used to make the SQL easier
2064 to generate from Perl data structures and, IMO, more intuitive.
2065 The underlying idea is for this module to do what you mean, based
2066 on the data structures you provide it. The big advantage is that
2067 you don't have to modify your code every time your data changes,
2068 as this module figures it out.
2070 To begin with, an SQL INSERT is as easy as just specifying a hash
2071 of C<key=value> pairs:
2074 name => 'Jimbo Bobson',
2075 phone => '123-456-7890',
2076 address => '42 Sister Lane',
2077 city => 'St. Louis',
2078 state => 'Louisiana',
2081 The SQL can then be generated with this:
2083 my($stmt, @bind) = $sql->insert('people', \%data);
2085 Which would give you something like this:
2087 $stmt = "INSERT INTO people
2088 (address, city, name, phone, state)
2089 VALUES (?, ?, ?, ?, ?)";
2090 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2091 '123-456-7890', 'Louisiana');
2093 These are then used directly in your DBI code:
2095 my $sth = $dbh->prepare($stmt);
2096 $sth->execute(@bind);
2098 =head2 Inserting and Updating Arrays
2100 If your database has array types (like for example Postgres),
2101 activate the special option C<< array_datatypes => 1 >>
2102 when creating the C<SQL::Abstract> object.
2103 Then you may use an arrayref to insert and update database array types:
2105 my $sql = SQL::Abstract->new(array_datatypes => 1);
2107 planets => [qw/Mercury Venus Earth Mars/]
2110 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2114 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2116 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2119 =head2 Inserting and Updating SQL
2121 In order to apply SQL functions to elements of your C<%data> you may
2122 specify a reference to an arrayref for the given hash value. For example,
2123 if you need to execute the Oracle C<to_date> function on a value, you can
2124 say something like this:
2128 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2131 The first value in the array is the actual SQL. Any other values are
2132 optional and would be included in the bind values array. This gives
2135 my($stmt, @bind) = $sql->insert('people', \%data);
2137 $stmt = "INSERT INTO people (name, date_entered)
2138 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2139 @bind = ('Bill', '03/02/2003');
2141 An UPDATE is just as easy, all you change is the name of the function:
2143 my($stmt, @bind) = $sql->update('people', \%data);
2145 Notice that your C<%data> isn't touched; the module will generate
2146 the appropriately quirky SQL for you automatically. Usually you'll
2147 want to specify a WHERE clause for your UPDATE, though, which is
2148 where handling C<%where> hashes comes in handy...
2150 =head2 Complex where statements
2152 This module can generate pretty complicated WHERE statements
2153 easily. For example, simple C<key=value> pairs are taken to mean
2154 equality, and if you want to see if a field is within a set
2155 of values, you can use an arrayref. Let's say we wanted to
2156 SELECT some data based on this criteria:
2159 requestor => 'inna',
2160 worker => ['nwiger', 'rcwe', 'sfz'],
2161 status => { '!=', 'completed' }
2164 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2166 The above would give you something like this:
2168 $stmt = "SELECT * FROM tickets WHERE
2169 ( requestor = ? ) AND ( status != ? )
2170 AND ( worker = ? OR worker = ? OR worker = ? )";
2171 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2173 Which you could then use in DBI code like so:
2175 my $sth = $dbh->prepare($stmt);
2176 $sth->execute(@bind);
2182 The methods are simple. There's one for every major SQL operation,
2183 and a constructor you use first. The arguments are specified in a
2184 similar order for each method (table, then fields, then a where
2185 clause) to try and simplify things.
2187 =head2 new(option => 'value')
2189 The C<new()> function takes a list of options and values, and returns
2190 a new B<SQL::Abstract> object which can then be used to generate SQL
2191 through the methods below. The options accepted are:
2197 If set to 'lower', then SQL will be generated in all lowercase. By
2198 default SQL is generated in "textbook" case meaning something like:
2200 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2202 Any setting other than 'lower' is ignored.
2206 This determines what the default comparison operator is. By default
2207 it is C<=>, meaning that a hash like this:
2209 %where = (name => 'nwiger', email => 'nate@wiger.org');
2211 Will generate SQL like this:
2213 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2215 However, you may want loose comparisons by default, so if you set
2216 C<cmp> to C<like> you would get SQL such as:
2218 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2220 You can also override the comparison on an individual basis - see
2221 the huge section on L</"WHERE CLAUSES"> at the bottom.
2223 =item sqltrue, sqlfalse
2225 Expressions for inserting boolean values within SQL statements.
2226 By default these are C<1=1> and C<1=0>. They are used
2227 by the special operators C<-in> and C<-not_in> for generating
2228 correct SQL even when the argument is an empty array (see below).
2232 This determines the default logical operator for multiple WHERE
2233 statements in arrays or hashes. If absent, the default logic is "or"
2234 for arrays, and "and" for hashes. This means that a WHERE
2238 event_date => {'>=', '2/13/99'},
2239 event_date => {'<=', '4/24/03'},
2242 will generate SQL like this:
2244 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2246 This is probably not what you want given this query, though (look
2247 at the dates). To change the "OR" to an "AND", simply specify:
2249 my $sql = SQL::Abstract->new(logic => 'and');
2251 Which will change the above C<WHERE> to:
2253 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2255 The logic can also be changed locally by inserting
2256 a modifier in front of an arrayref:
2258 @where = (-and => [event_date => {'>=', '2/13/99'},
2259 event_date => {'<=', '4/24/03'} ]);
2261 See the L</"WHERE CLAUSES"> section for explanations.
2265 This will automatically convert comparisons using the specified SQL
2266 function for both column and value. This is mostly used with an argument
2267 of C<upper> or C<lower>, so that the SQL will have the effect of
2268 case-insensitive "searches". For example, this:
2270 $sql = SQL::Abstract->new(convert => 'upper');
2271 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2273 Will turn out the following SQL:
2275 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2277 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2278 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2279 not validate this option; it will just pass through what you specify verbatim).
2283 This is a kludge because many databases suck. For example, you can't
2284 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2285 Instead, you have to use C<bind_param()>:
2287 $sth->bind_param(1, 'reg data');
2288 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2290 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2291 which loses track of which field each slot refers to. Fear not.
2293 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2294 Currently, you can specify either C<normal> (default) or C<columns>. If you
2295 specify C<columns>, you will get an array that looks like this:
2297 my $sql = SQL::Abstract->new(bindtype => 'columns');
2298 my($stmt, @bind) = $sql->insert(...);
2301 [ 'column1', 'value1' ],
2302 [ 'column2', 'value2' ],
2303 [ 'column3', 'value3' ],
2306 You can then iterate through this manually, using DBI's C<bind_param()>.
2308 $sth->prepare($stmt);
2311 my($col, $data) = @$_;
2312 if ($col eq 'details' || $col eq 'comments') {
2313 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2314 } elsif ($col eq 'image') {
2315 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2317 $sth->bind_param($i, $data);
2321 $sth->execute; # execute without @bind now
2323 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2324 Basically, the advantage is still that you don't have to care which fields
2325 are or are not included. You could wrap that above C<for> loop in a simple
2326 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2327 get a layer of abstraction over manual SQL specification.
2329 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2330 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2331 will expect the bind values in this format.
2335 This is the character that a table or column name will be quoted
2336 with. By default this is an empty string, but you could set it to
2337 the character C<`>, to generate SQL like this:
2339 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2341 Alternatively, you can supply an array ref of two items, the first being the left
2342 hand quote character, and the second the right hand quote character. For
2343 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2344 that generates SQL like this:
2346 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2348 Quoting is useful if you have tables or columns names that are reserved
2349 words in your database's SQL dialect.
2353 This is the character that will be used to escape L</quote_char>s appearing
2354 in an identifier before it has been quoted.
2356 The parameter default in case of a single L</quote_char> character is the quote
2359 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2360 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2361 of the B<opening (left)> L</quote_char> within the identifier are currently left
2362 untouched. The default for opening-closing-style quotes may change in future
2363 versions, thus you are B<strongly encouraged> to specify the escape character
2368 This is the character that separates a table and column name. It is
2369 necessary to specify this when the C<quote_char> option is selected,
2370 so that tables and column names can be individually quoted like this:
2372 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2374 =item injection_guard
2376 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2377 column name specified in a query structure. This is a safety mechanism to avoid
2378 injection attacks when mishandling user input e.g.:
2380 my %condition_as_column_value_pairs = get_values_from_user();
2381 $sqla->select( ... , \%condition_as_column_value_pairs );
2383 If the expression matches an exception is thrown. Note that literal SQL
2384 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2386 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2388 =item array_datatypes
2390 When this option is true, arrayrefs in INSERT or UPDATE are
2391 interpreted as array datatypes and are passed directly
2393 When this option is false, arrayrefs are interpreted
2394 as literal SQL, just like refs to arrayrefs
2395 (but this behavior is for backwards compatibility; when writing
2396 new queries, use the "reference to arrayref" syntax
2402 Takes a reference to a list of "special operators"
2403 to extend the syntax understood by L<SQL::Abstract>.
2404 See section L</"SPECIAL OPERATORS"> for details.
2408 Takes a reference to a list of "unary operators"
2409 to extend the syntax understood by L<SQL::Abstract>.
2410 See section L</"UNARY OPERATORS"> for details.
2416 =head2 insert($table, \@values || \%fieldvals, \%options)
2418 This is the simplest function. You simply give it a table name
2419 and either an arrayref of values or hashref of field/value pairs.
2420 It returns an SQL INSERT statement and a list of bind values.
2421 See the sections on L</"Inserting and Updating Arrays"> and
2422 L</"Inserting and Updating SQL"> for information on how to insert
2423 with those data types.
2425 The optional C<\%options> hash reference may contain additional
2426 options to generate the insert SQL. Currently supported options
2433 Takes either a scalar of raw SQL fields, or an array reference of
2434 field names, and adds on an SQL C<RETURNING> statement at the end.
2435 This allows you to return data generated by the insert statement
2436 (such as row IDs) without performing another C<SELECT> statement.
2437 Note, however, this is not part of the SQL standard and may not
2438 be supported by all database engines.
2442 =head2 update($table, \%fieldvals, \%where, \%options)
2444 This takes a table, hashref of field/value pairs, and an optional
2445 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2447 See the sections on L</"Inserting and Updating Arrays"> and
2448 L</"Inserting and Updating SQL"> for information on how to insert
2449 with those data types.
2451 The optional C<\%options> hash reference may contain additional
2452 options to generate the update SQL. Currently supported options
2459 See the C<returning> option to
2460 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2464 =head2 select($source, $fields, $where, $order)
2466 This returns a SQL SELECT statement and associated list of bind values, as
2467 specified by the arguments:
2473 Specification of the 'FROM' part of the statement.
2474 The argument can be either a plain scalar (interpreted as a table
2475 name, will be quoted), or an arrayref (interpreted as a list
2476 of table names, joined by commas, quoted), or a scalarref
2477 (literal SQL, not quoted).
2481 Specification of the list of fields to retrieve from
2483 The argument can be either an arrayref (interpreted as a list
2484 of field names, will be joined by commas and quoted), or a
2485 plain scalar (literal SQL, not quoted).
2486 Please observe that this API is not as flexible as that of
2487 the first argument C<$source>, for backwards compatibility reasons.
2491 Optional argument to specify the WHERE part of the query.
2492 The argument is most often a hashref, but can also be
2493 an arrayref or plain scalar --
2494 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2498 Optional argument to specify the ORDER BY part of the query.
2499 The argument can be a scalar, a hashref or an arrayref
2500 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2506 =head2 delete($table, \%where, \%options)
2508 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2509 It returns an SQL DELETE statement and list of bind values.
2511 The optional C<\%options> hash reference may contain additional
2512 options to generate the delete SQL. Currently supported options
2519 See the C<returning> option to
2520 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2524 =head2 where(\%where, $order)
2526 This is used to generate just the WHERE clause. For example,
2527 if you have an arbitrary data structure and know what the
2528 rest of your SQL is going to look like, but want an easy way
2529 to produce a WHERE clause, use this. It returns an SQL WHERE
2530 clause and list of bind values.
2533 =head2 values(\%data)
2535 This just returns the values from the hash C<%data>, in the same
2536 order that would be returned from any of the other above queries.
2537 Using this allows you to markedly speed up your queries if you
2538 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2540 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2542 Warning: This is an experimental method and subject to change.
2544 This returns arbitrarily generated SQL. It's a really basic shortcut.
2545 It will return two different things, depending on return context:
2547 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2548 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2550 These would return the following:
2552 # First calling form
2553 $stmt = "CREATE TABLE test (?, ?)";
2554 @bind = (field1, field2);
2556 # Second calling form
2557 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2559 Depending on what you're trying to do, it's up to you to choose the correct
2560 format. In this example, the second form is what you would want.
2564 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2568 ALTER SESSION SET nls_date_format = 'MM/YY'
2570 You get the idea. Strings get their case twiddled, but everything
2571 else remains verbatim.
2573 =head1 EXPORTABLE FUNCTIONS
2575 =head2 is_plain_value
2577 Determines if the supplied argument is a plain value as understood by this
2582 =item * The value is C<undef>
2584 =item * The value is a non-reference
2586 =item * The value is an object with stringification overloading
2588 =item * The value is of the form C<< { -value => $anything } >>
2592 On failure returns C<undef>, on success returns a B<scalar> reference
2593 to the original supplied argument.
2599 The stringification overloading detection is rather advanced: it takes
2600 into consideration not only the presence of a C<""> overload, but if that
2601 fails also checks for enabled
2602 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2603 on either C<0+> or C<bool>.
2605 Unfortunately testing in the field indicates that this
2606 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2607 but only when very large numbers of stringifying objects are involved.
2608 At the time of writing ( Sep 2014 ) there is no clear explanation of
2609 the direct cause, nor is there a manageably small test case that reliably
2610 reproduces the problem.
2612 If you encounter any of the following exceptions in B<random places within
2613 your application stack> - this module may be to blame:
2615 Operation "ne": no method found,
2616 left argument in overloaded package <something>,
2617 right argument in overloaded package <something>
2621 Stub found while resolving method "???" overloading """" in package <something>
2623 If you fall victim to the above - please attempt to reduce the problem
2624 to something that could be sent to the L<SQL::Abstract developers
2625 |DBIx::Class/GETTING HELP/SUPPORT>
2626 (either publicly or privately). As a workaround in the meantime you can
2627 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2628 value, which will most likely eliminate your problem (at the expense of
2629 not being able to properly detect exotic forms of stringification).
2631 This notice and environment variable will be removed in a future version,
2632 as soon as the underlying problem is found and a reliable workaround is
2637 =head2 is_literal_value
2639 Determines if the supplied argument is a literal value as understood by this
2644 =item * C<\$sql_string>
2646 =item * C<\[ $sql_string, @bind_values ]>
2650 On failure returns C<undef>, on success returns an B<array> reference
2651 containing the unpacked version of the supplied literal SQL and bind values.
2653 =head1 WHERE CLAUSES
2657 This module uses a variation on the idea from L<DBIx::Abstract>. It
2658 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2659 module is that things in arrays are OR'ed, and things in hashes
2662 The easiest way to explain is to show lots of examples. After
2663 each C<%where> hash shown, it is assumed you used:
2665 my($stmt, @bind) = $sql->where(\%where);
2667 However, note that the C<%where> hash can be used directly in any
2668 of the other functions as well, as described above.
2670 =head2 Key-value pairs
2672 So, let's get started. To begin, a simple hash:
2676 status => 'completed'
2679 Is converted to SQL C<key = val> statements:
2681 $stmt = "WHERE user = ? AND status = ?";
2682 @bind = ('nwiger', 'completed');
2684 One common thing I end up doing is having a list of values that
2685 a field can be in. To do this, simply specify a list inside of
2690 status => ['assigned', 'in-progress', 'pending'];
2693 This simple code will create the following:
2695 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2696 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2698 A field associated to an empty arrayref will be considered a
2699 logical false and will generate 0=1.
2701 =head2 Tests for NULL values
2703 If the value part is C<undef> then this is converted to SQL <IS NULL>
2712 $stmt = "WHERE user = ? AND status IS NULL";
2715 To test if a column IS NOT NULL:
2719 status => { '!=', undef },
2722 =head2 Specific comparison operators
2724 If you want to specify a different type of operator for your comparison,
2725 you can use a hashref for a given column:
2729 status => { '!=', 'completed' }
2732 Which would generate:
2734 $stmt = "WHERE user = ? AND status != ?";
2735 @bind = ('nwiger', 'completed');
2737 To test against multiple values, just enclose the values in an arrayref:
2739 status => { '=', ['assigned', 'in-progress', 'pending'] };
2741 Which would give you:
2743 "WHERE status = ? OR status = ? OR status = ?"
2746 The hashref can also contain multiple pairs, in which case it is expanded
2747 into an C<AND> of its elements:
2751 status => { '!=', 'completed', -not_like => 'pending%' }
2754 # Or more dynamically, like from a form
2755 $where{user} = 'nwiger';
2756 $where{status}{'!='} = 'completed';
2757 $where{status}{'-not_like'} = 'pending%';
2759 # Both generate this
2760 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2761 @bind = ('nwiger', 'completed', 'pending%');
2764 To get an OR instead, you can combine it with the arrayref idea:
2768 priority => [ { '=', 2 }, { '>', 5 } ]
2771 Which would generate:
2773 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2774 @bind = ('2', '5', 'nwiger');
2776 If you want to include literal SQL (with or without bind values), just use a
2777 scalar reference or reference to an arrayref as the value:
2780 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2781 date_expires => { '<' => \"now()" }
2784 Which would generate:
2786 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2787 @bind = ('11/26/2008');
2790 =head2 Logic and nesting operators
2792 In the example above,
2793 there is a subtle trap if you want to say something like
2794 this (notice the C<AND>):
2796 WHERE priority != ? AND priority != ?
2798 Because, in Perl you I<can't> do this:
2800 priority => { '!=' => 2, '!=' => 1 }
2802 As the second C<!=> key will obliterate the first. The solution
2803 is to use the special C<-modifier> form inside an arrayref:
2805 priority => [ -and => {'!=', 2},
2809 Normally, these would be joined by C<OR>, but the modifier tells it
2810 to use C<AND> instead. (Hint: You can use this in conjunction with the
2811 C<logic> option to C<new()> in order to change the way your queries
2812 work by default.) B<Important:> Note that the C<-modifier> goes
2813 B<INSIDE> the arrayref, as an extra first element. This will
2814 B<NOT> do what you think it might:
2816 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2818 Here is a quick list of equivalencies, since there is some overlap:
2821 status => {'!=', 'completed', 'not like', 'pending%' }
2822 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2825 status => {'=', ['assigned', 'in-progress']}
2826 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2827 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2831 =head2 Special operators: IN, BETWEEN, etc.
2833 You can also use the hashref format to compare a list of fields using the
2834 C<IN> comparison operator, by specifying the list as an arrayref:
2837 status => 'completed',
2838 reportid => { -in => [567, 2335, 2] }
2841 Which would generate:
2843 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2844 @bind = ('completed', '567', '2335', '2');
2846 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2849 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2850 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2851 'sqltrue' (by default: C<1=1>).
2853 In addition to the array you can supply a chunk of literal sql or
2854 literal sql with bind:
2857 customer => { -in => \[
2858 'SELECT cust_id FROM cust WHERE balance > ?',
2861 status => { -in => \'SELECT status_codes FROM states' },
2867 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2868 AND status IN ( SELECT status_codes FROM states )
2872 Finally, if the argument to C<-in> is not a reference, it will be
2873 treated as a single-element array.
2875 Another pair of operators is C<-between> and C<-not_between>,
2876 used with an arrayref of two values:
2880 completion_date => {
2881 -not_between => ['2002-10-01', '2003-02-06']
2887 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2889 Just like with C<-in> all plausible combinations of literal SQL
2893 start0 => { -between => [ 1, 2 ] },
2894 start1 => { -between => \["? AND ?", 1, 2] },
2895 start2 => { -between => \"lower(x) AND upper(y)" },
2896 start3 => { -between => [
2898 \["upper(?)", 'stuff' ],
2905 ( start0 BETWEEN ? AND ? )
2906 AND ( start1 BETWEEN ? AND ? )
2907 AND ( start2 BETWEEN lower(x) AND upper(y) )
2908 AND ( start3 BETWEEN lower(x) AND upper(?) )
2910 @bind = (1, 2, 1, 2, 'stuff');
2913 These are the two builtin "special operators"; but the
2914 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2916 =head2 Unary operators: bool
2918 If you wish to test against boolean columns or functions within your
2919 database you can use the C<-bool> and C<-not_bool> operators. For
2920 example to test the column C<is_user> being true and the column
2921 C<is_enabled> being false you would use:-
2925 -not_bool => 'is_enabled',
2930 WHERE is_user AND NOT is_enabled
2932 If a more complex combination is required, testing more conditions,
2933 then you should use the and/or operators:-
2938 -not_bool => { two=> { -rlike => 'bar' } },
2939 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2950 (NOT ( three = ? OR three > ? ))
2953 =head2 Nested conditions, -and/-or prefixes
2955 So far, we've seen how multiple conditions are joined with a top-level
2956 C<AND>. We can change this by putting the different conditions we want in
2957 hashes and then putting those hashes in an array. For example:
2962 status => { -like => ['pending%', 'dispatched'] },
2966 status => 'unassigned',
2970 This data structure would create the following:
2972 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2973 OR ( user = ? AND status = ? ) )";
2974 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2977 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2978 to change the logic inside:
2984 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2985 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2992 $stmt = "WHERE ( user = ?
2993 AND ( ( workhrs > ? AND geo = ? )
2994 OR ( workhrs < ? OR geo = ? ) ) )";
2995 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2997 =head3 Algebraic inconsistency, for historical reasons
2999 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
3000 operator goes C<outside> of the nested structure; whereas when connecting
3001 several constraints on one column, the C<-and> operator goes
3002 C<inside> the arrayref. Here is an example combining both features:
3005 -and => [a => 1, b => 2],
3006 -or => [c => 3, d => 4],
3007 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3012 WHERE ( ( ( a = ? AND b = ? )
3013 OR ( c = ? OR d = ? )
3014 OR ( e LIKE ? AND e LIKE ? ) ) )
3016 This difference in syntax is unfortunate but must be preserved for
3017 historical reasons. So be careful: the two examples below would
3018 seem algebraically equivalent, but they are not
3021 { -like => 'foo%' },
3022 { -like => '%bar' },
3024 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3027 { col => { -like => 'foo%' } },
3028 { col => { -like => '%bar' } },
3030 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3033 =head2 Literal SQL and value type operators
3035 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3036 side" is a column name and the "right side" is a value (normally rendered as
3037 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3038 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3039 alter this behavior. There are several ways of doing so.
3043 This is a virtual operator that signals the string to its right side is an
3044 identifier (a column name) and not a value. For example to compare two
3045 columns you would write:
3048 priority => { '<', 2 },
3049 requestor => { -ident => 'submitter' },
3054 $stmt = "WHERE priority < ? AND requestor = submitter";
3057 If you are maintaining legacy code you may see a different construct as
3058 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3063 This is a virtual operator that signals that the construct to its right side
3064 is a value to be passed to DBI. This is for example necessary when you want
3065 to write a where clause against an array (for RDBMS that support such
3066 datatypes). For example:
3069 array => { -value => [1, 2, 3] }
3074 $stmt = 'WHERE array = ?';
3075 @bind = ([1, 2, 3]);
3077 Note that if you were to simply say:
3083 the result would probably not be what you wanted:
3085 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3090 Finally, sometimes only literal SQL will do. To include a random snippet
3091 of SQL verbatim, you specify it as a scalar reference. Consider this only
3092 as a last resort. Usually there is a better way. For example:
3095 priority => { '<', 2 },
3096 requestor => { -in => \'(SELECT name FROM hitmen)' },
3101 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3104 Note that in this example, you only get one bind parameter back, since
3105 the verbatim SQL is passed as part of the statement.
3109 Never use untrusted input as a literal SQL argument - this is a massive
3110 security risk (there is no way to check literal snippets for SQL
3111 injections and other nastyness). If you need to deal with untrusted input
3112 use literal SQL with placeholders as described next.
3114 =head3 Literal SQL with placeholders and bind values (subqueries)
3116 If the literal SQL to be inserted has placeholders and bind values,
3117 use a reference to an arrayref (yes this is a double reference --
3118 not so common, but perfectly legal Perl). For example, to find a date
3119 in Postgres you can use something like this:
3122 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3127 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3130 Note that you must pass the bind values in the same format as they are returned
3131 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3132 to C<columns>, you must provide the bind values in the
3133 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3134 scalar value; most commonly the column name, but you can use any scalar value
3135 (including references and blessed references), L<SQL::Abstract> will simply
3136 pass it through intact. So if C<bindtype> is set to C<columns> the above
3137 example will look like:
3140 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3143 Literal SQL is especially useful for nesting parenthesized clauses in the
3144 main SQL query. Here is a first example:
3146 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3150 bar => \["IN ($sub_stmt)" => @sub_bind],
3155 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3156 WHERE c2 < ? AND c3 LIKE ?))";
3157 @bind = (1234, 100, "foo%");
3159 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3160 are expressed in the same way. Of course the C<$sub_stmt> and
3161 its associated bind values can be generated through a former call
3164 my ($sub_stmt, @sub_bind)
3165 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3166 c3 => {-like => "foo%"}});
3169 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3172 In the examples above, the subquery was used as an operator on a column;
3173 but the same principle also applies for a clause within the main C<%where>
3174 hash, like an EXISTS subquery:
3176 my ($sub_stmt, @sub_bind)
3177 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3178 my %where = ( -and => [
3180 \["EXISTS ($sub_stmt)" => @sub_bind],
3185 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3186 WHERE c1 = ? AND c2 > t0.c0))";
3190 Observe that the condition on C<c2> in the subquery refers to
3191 column C<t0.c0> of the main query: this is I<not> a bind
3192 value, so we have to express it through a scalar ref.
3193 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3194 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3195 what we wanted here.
3197 Finally, here is an example where a subquery is used
3198 for expressing unary negation:
3200 my ($sub_stmt, @sub_bind)
3201 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3202 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3204 lname => {like => '%son%'},
3205 \["NOT ($sub_stmt)" => @sub_bind],
3210 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3211 @bind = ('%son%', 10, 20)
3213 =head3 Deprecated usage of Literal SQL
3215 Below are some examples of archaic use of literal SQL. It is shown only as
3216 reference for those who deal with legacy code. Each example has a much
3217 better, cleaner and safer alternative that users should opt for in new code.
3223 my %where = ( requestor => \'IS NOT NULL' )
3225 $stmt = "WHERE requestor IS NOT NULL"
3227 This used to be the way of generating NULL comparisons, before the handling
3228 of C<undef> got formalized. For new code please use the superior syntax as
3229 described in L</Tests for NULL values>.
3233 my %where = ( requestor => \'= submitter' )
3235 $stmt = "WHERE requestor = submitter"
3237 This used to be the only way to compare columns. Use the superior L</-ident>
3238 method for all new code. For example an identifier declared in such a way
3239 will be properly quoted if L</quote_char> is properly set, while the legacy
3240 form will remain as supplied.
3244 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3246 $stmt = "WHERE completed > ? AND is_ready"
3247 @bind = ('2012-12-21')
3249 Using an empty string literal used to be the only way to express a boolean.
3250 For all new code please use the much more readable
3251 L<-bool|/Unary operators: bool> operator.
3257 These pages could go on for a while, since the nesting of the data
3258 structures this module can handle are pretty much unlimited (the
3259 module implements the C<WHERE> expansion as a recursive function
3260 internally). Your best bet is to "play around" with the module a
3261 little to see how the data structures behave, and choose the best
3262 format for your data based on that.
3264 And of course, all the values above will probably be replaced with
3265 variables gotten from forms or the command line. After all, if you
3266 knew everything ahead of time, you wouldn't have to worry about
3267 dynamically-generating SQL and could just hardwire it into your
3270 =head1 ORDER BY CLAUSES
3272 Some functions take an order by clause. This can either be a scalar (just a
3273 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3274 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3277 Given | Will Generate
3278 ---------------------------------------------------------------
3280 'colA' | ORDER BY colA
3282 [qw/colA colB/] | ORDER BY colA, colB
3284 {-asc => 'colA'} | ORDER BY colA ASC
3286 {-desc => 'colB'} | ORDER BY colB DESC
3288 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3290 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3292 \'colA DESC' | ORDER BY colA DESC
3294 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3295 | /* ...with $x bound to ? */
3298 { -asc => 'colA' }, | colA ASC,
3299 { -desc => [qw/colB/] }, | colB DESC,
3300 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3301 \'colE DESC', | colE DESC,
3302 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3303 ] | /* ...with $x bound to ? */
3304 ===============================================================
3308 =head1 OLD EXTENSION SYSTEM
3310 =head2 SPECIAL OPERATORS
3312 my $sqlmaker = SQL::Abstract->new(special_ops => [
3316 my ($self, $field, $op, $arg) = @_;
3322 handler => 'method_name',
3326 A "special operator" is a SQL syntactic clause that can be
3327 applied to a field, instead of a usual binary operator.
3330 WHERE field IN (?, ?, ?)
3331 WHERE field BETWEEN ? AND ?
3332 WHERE MATCH(field) AGAINST (?, ?)
3334 Special operators IN and BETWEEN are fairly standard and therefore
3335 are builtin within C<SQL::Abstract> (as the overridable methods
3336 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3337 like the MATCH .. AGAINST example above which is specific to MySQL,
3338 you can write your own operator handlers - supply a C<special_ops>
3339 argument to the C<new> method. That argument takes an arrayref of
3340 operator definitions; each operator definition is a hashref with two
3347 the regular expression to match the operator
3351 Either a coderef or a plain scalar method name. In both cases
3352 the expected return is C<< ($sql, @bind) >>.
3354 When supplied with a method name, it is simply called on the
3355 L<SQL::Abstract> object as:
3357 $self->$method_name($field, $op, $arg)
3361 $field is the LHS of the operator
3362 $op is the part that matched the handler regex
3365 When supplied with a coderef, it is called as:
3367 $coderef->($self, $field, $op, $arg)
3372 For example, here is an implementation
3373 of the MATCH .. AGAINST syntax for MySQL
3375 my $sqlmaker = SQL::Abstract->new(special_ops => [
3377 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3378 {regex => qr/^match$/i,
3380 my ($self, $field, $op, $arg) = @_;
3381 $arg = [$arg] if not ref $arg;
3382 my $label = $self->_quote($field);
3383 my ($placeholder) = $self->_convert('?');
3384 my $placeholders = join ", ", (($placeholder) x @$arg);
3385 my $sql = $self->_sqlcase('match') . " ($label) "
3386 . $self->_sqlcase('against') . " ($placeholders) ";
3387 my @bind = $self->_bindtype($field, @$arg);
3388 return ($sql, @bind);
3395 =head2 UNARY OPERATORS
3397 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3401 my ($self, $op, $arg) = @_;
3407 handler => 'method_name',
3411 A "unary operator" is a SQL syntactic clause that can be
3412 applied to a field - the operator goes before the field
3414 You can write your own operator handlers - supply a C<unary_ops>
3415 argument to the C<new> method. That argument takes an arrayref of
3416 operator definitions; each operator definition is a hashref with two
3423 the regular expression to match the operator
3427 Either a coderef or a plain scalar method name. In both cases
3428 the expected return is C<< $sql >>.
3430 When supplied with a method name, it is simply called on the
3431 L<SQL::Abstract> object as:
3433 $self->$method_name($op, $arg)
3437 $op is the part that matched the handler regex
3438 $arg is the RHS or argument of the operator
3440 When supplied with a coderef, it is called as:
3442 $coderef->($self, $op, $arg)
3447 =head1 NEW EXTENSION SYSTEM
3457 Thanks to some benchmarking by Mark Stosberg, it turns out that
3458 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3459 I must admit this wasn't an intentional design issue, but it's a
3460 byproduct of the fact that you get to control your C<DBI> handles
3463 To maximize performance, use a code snippet like the following:
3465 # prepare a statement handle using the first row
3466 # and then reuse it for the rest of the rows
3468 for my $href (@array_of_hashrefs) {
3469 $stmt ||= $sql->insert('table', $href);
3470 $sth ||= $dbh->prepare($stmt);
3471 $sth->execute($sql->values($href));
3474 The reason this works is because the keys in your C<$href> are sorted
3475 internally by B<SQL::Abstract>. Thus, as long as your data retains
3476 the same structure, you only have to generate the SQL the first time
3477 around. On subsequent queries, simply use the C<values> function provided
3478 by this module to return your values in the correct order.
3480 However this depends on the values having the same type - if, for
3481 example, the values of a where clause may either have values
3482 (resulting in sql of the form C<column = ?> with a single bind
3483 value), or alternatively the values might be C<undef> (resulting in
3484 sql of the form C<column IS NULL> with no bind value) then the
3485 caching technique suggested will not work.
3489 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3490 really like this part (I do, at least). Building up a complex query
3491 can be as simple as the following:
3498 use CGI::FormBuilder;
3501 my $form = CGI::FormBuilder->new(...);
3502 my $sql = SQL::Abstract->new;
3504 if ($form->submitted) {
3505 my $field = $form->field;
3506 my $id = delete $field->{id};
3507 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3510 Of course, you would still have to connect using C<DBI> to run the
3511 query, but the point is that if you make your form look like your
3512 table, the actual query script can be extremely simplistic.
3514 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3515 a fast interface to returning and formatting data. I frequently
3516 use these three modules together to write complex database query
3517 apps in under 50 lines.
3519 =head1 HOW TO CONTRIBUTE
3521 Contributions are always welcome, in all usable forms (we especially
3522 welcome documentation improvements). The delivery methods include git-
3523 or unified-diff formatted patches, GitHub pull requests, or plain bug
3524 reports either via RT or the Mailing list. Contributors are generally
3525 granted full access to the official repository after their first several
3526 patches pass successful review.
3528 This project is maintained in a git repository. The code and related tools are
3529 accessible at the following locations:
3533 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3535 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3537 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3539 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3545 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3546 Great care has been taken to preserve the I<published> behavior
3547 documented in previous versions in the 1.* family; however,
3548 some features that were previously undocumented, or behaved
3549 differently from the documentation, had to be changed in order
3550 to clarify the semantics. Hence, client code that was relying
3551 on some dark areas of C<SQL::Abstract> v1.*
3552 B<might behave differently> in v1.50.
3554 The main changes are:
3560 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3564 support for the { operator => \"..." } construct (to embed literal SQL)
3568 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3572 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3576 defensive programming: check arguments
3580 fixed bug with global logic, which was previously implemented
3581 through global variables yielding side-effects. Prior versions would
3582 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3583 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3584 Now this is interpreted
3585 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3590 fixed semantics of _bindtype on array args
3594 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3595 we just avoid shifting arrays within that tree.
3599 dropped the C<_modlogic> function
3603 =head1 ACKNOWLEDGEMENTS
3605 There are a number of individuals that have really helped out with
3606 this module. Unfortunately, most of them submitted bugs via CPAN
3607 so I have no idea who they are! But the people I do know are:
3609 Ash Berlin (order_by hash term support)
3610 Matt Trout (DBIx::Class support)
3611 Mark Stosberg (benchmarking)
3612 Chas Owens (initial "IN" operator support)
3613 Philip Collins (per-field SQL functions)
3614 Eric Kolve (hashref "AND" support)
3615 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3616 Dan Kubb (support for "quote_char" and "name_sep")
3617 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3618 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3619 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3620 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3621 Oliver Charles (support for "RETURNING" after "INSERT")
3627 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3631 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3633 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3635 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3636 While not an official support venue, C<DBIx::Class> makes heavy use of
3637 C<SQL::Abstract>, and as such list members there are very familiar with
3638 how to create queries.
3642 This module is free software; you may copy this under the same
3643 terms as perl itself (either the GNU General Public License or
3644 the Artistic License)