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 is_undef_value);
21 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
27 #======================================================================
29 #======================================================================
31 our $VERSION = '1.87';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
147 list => '_expand_list',
150 (map +($_ => __PACKAGE__->make_binop_expander('_expand_between')),
151 qw(between not_between)),
152 (map +($_ => __PACKAGE__->make_binop_expander('_expand_in')),
154 (map +($_ => '_expand_op_andor'), ('and', 'or')),
155 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
156 (map +($_ => __PACKAGE__->make_unop_expander("_expand_${_}")),
157 qw(ident value nest)),
160 (map +($_, "_render_$_"),
161 qw(op func bind ident literal row values keyword)),
164 (map +($_ => '_render_op_between'), 'between', 'not_between'),
165 (map +($_ => '_render_op_in'), 'in', 'not_in'),
166 (map +($_ => '_render_unop_postfix'),
167 'is_null', 'is_not_null', 'asc', 'desc',
169 (not => '_render_unop_paren'),
170 (map +($_ => '_render_op_andor'), qw(and or)),
171 ',' => '_render_op_multop',
174 delete => [ qw(target where returning) ],
175 update => [ qw(target set where returning) ],
176 insert => [ qw(target fields from returning) ],
177 select => [ qw(select from where order_by) ],
180 'delete.from' => '_expand_delete_clause_target',
181 'update.update' => '_expand_update_clause_target',
182 'insert.into' => '_expand_insert_clause_target',
183 'insert.values' => '_expand_insert_clause_from',
186 'delete.target' => '_render_delete_clause_target',
187 'update.target' => '_render_update_clause_target',
188 'insert.target' => '_render_insert_clause_target',
189 'insert.fields' => '_render_insert_clause_fields',
190 'insert.from' => '_render_insert_clause_from',
194 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
195 $Defaults{expand}{$stmt} = '_expand_statement';
196 $Defaults{render}{$stmt} = '_render_statement';
197 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
198 $Defaults{expand_clause}{"${stmt}.${clause}"}
199 = "_expand_${stmt}_clause_${clause}";
205 my $class = ref($self) || $self;
206 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
208 # choose our case by keeping an option around
209 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
211 # default logic for interpreting arrayrefs
212 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
214 # how to return bind vars
215 $opt{bindtype} ||= 'normal';
217 # default comparison is "=", but can be overridden
220 # try to recognize which are the 'equality' and 'inequality' ops
221 # (temporary quickfix (in 2007), should go through a more seasoned API)
222 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
223 $opt{inequality_op} = qr/^( != | <> )$/ix;
225 $opt{like_op} = qr/^ (is_)?r?like $/xi;
226 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
229 $opt{sqltrue} ||= '1=1';
230 $opt{sqlfalse} ||= '0=1';
233 $opt{special_ops} ||= [];
236 $opt{unary_ops} ||= [];
238 # rudimentary sanity-check for user supplied bits treated as functions/operators
239 # If a purported function matches this regular expression, an exception is thrown.
240 # Literal SQL is *NOT* subject to this check, only functions (and column names
241 # when quoting is not in effect)
244 # need to guard against ()'s in column names too, but this will break tons of
245 # hacks... ideas anyone?
246 $opt{injection_guard} ||= qr/
252 $opt{expand_unary} = {};
254 foreach my $name (sort keys %Defaults) {
255 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
258 if ($class ne __PACKAGE__) {
260 # check for overriden methods
262 foreach my $type (qw(insert update delete)) {
263 my $method = "_${type}_returning";
264 if (__PACKAGE__->can($method) ne $class->can($method)) {
265 my $clause = "${type}.returning";
266 $opt{expand_clause}{$clause} = sub { $_[2] },
267 $opt{render_clause}{$clause}
268 = sub { [ $_[0]->$method($_[3]) ] };
271 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
272 $opt{expand_clause}{'select.from'} = sub {
273 return +{ -literal => [ $_[0]->_table($_[2]) ] };
276 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
277 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
278 $opt{render_clause}{'select.order_by'} = sub {
279 [ $_[0]->_order_by($_[2]) ];
282 if ($class->isa('DBIx::Class::SQLMaker')) {
283 $opt{warn_once_on_nest} = 1;
284 $opt{disable_old_special_ops} = 1;
285 $opt{render_clause}{'select.where'} = sub {
286 my ($sql, @bind) = $_[0]->where($_[2]);
287 s/\A\s+//, s/\s+\Z// for $sql;
288 return [ $sql, @bind ];
293 if ($opt{lazy_join_sql_parts}) {
294 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
295 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
298 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
300 return bless \%opt, $class;
304 my ($self, $name, $key, $value) = @_;
305 return $self->{$name}{$key} unless @_ > 3;
306 $self->{$name}{$key} = $value;
310 sub make_unop_expander {
311 my (undef, $exp) = @_;
313 my ($self, $name, $body, $k) = @_;
314 return $self->_expand_hashpair_cmp($k, { "-${name}" => $body })
316 return $self->$exp($name, $body);
320 sub make_binop_expander {
321 my (undef, $exp) = @_;
323 my ($self, $name, $body, $k) = @_;
324 $k = shift @{$body = [ @$body ]} unless defined $k;
325 $k = ref($k) ? $k : { -ident => $k };
326 return $self->$exp($name, $body, $k);
331 my ($self, $plugin, @args) = @_;
332 unless (ref $plugin) {
333 $plugin =~ s/\A\+/${\ref($self)}::Plugin::/;
334 require(join('/', split '::', $plugin).'.pm');
336 $plugin->apply_to($self, @args);
340 foreach my $type (qw(
341 expand op_expand render op_render clause_expand clause_render
343 my $name = join '_', reverse split '_', $type;
344 my $singular = "${type}er";
346 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
347 or die "Method builder failed for ${singular}: $@";
348 eval qq{sub wrap_${singular} {
349 shift->wrap_${singular}s(\@_)
350 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
352 eval qq{sub ${singular}s {
353 my (\$self, \@args) = \@_;
354 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
355 \$self->_ext_rw('${name}', \$this_key, \$this_value);
358 }; 1 } or die "Method builder failed for ${singular}s: $@";
359 eval qq{sub wrap_${singular}s {
360 my (\$self, \@args) = \@_;
361 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
362 my \$orig = \$self->_ext_rw('${name}', \$this_key);
364 '${name}', \$this_key,
365 \$this_builder->(\$orig, '${name}', \$this_key),
369 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
370 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
371 or die "Method builder failed for ${singular}_list: $@";
373 foreach my $singular (qw(unop_expander binop_expander)) {
374 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
375 or die "Method builder failed for ${singular}: $@";
376 eval qq{sub ${singular}s {
377 my (\$self, \@args) = \@_;
378 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
380 expand_op => \$this_key,
381 \$self->make_${singular}(\$this_value),
385 }; 1 } or die "Method builder failed for ${singular}s: $@";
389 #sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
391 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
394 my ($self, $of, @clauses) = @_;
396 return @{$self->{clauses_of}{$of}||[]};
398 if (ref($clauses[0]) eq 'CODE') {
399 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
401 $self->{clauses_of}{$of} = \@clauses;
410 ref($self->{$_}) eq 'HASH'
419 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
420 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
422 sub _assert_pass_injection_guard {
423 if ($_[1] =~ $_[0]->{injection_guard}) {
424 my $class = ref $_[0];
425 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
426 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
427 . "{injection_guard} attribute to ${class}->new()"
432 #======================================================================
434 #======================================================================
437 my ($self, $table, $data, $options) = @_;
440 if (ref($table) eq 'HASH') {
443 my %clauses = (target => $table, values => $data, %{$options||{}});
447 my @rendered = $self->render_statement({ -insert => $stmt });
448 return wantarray ? @rendered : $rendered[0];
451 sub _expand_insert_clause_target {
452 +(target => $_[0]->expand_expr($_[2], -ident));
455 sub _expand_insert_clause_fields {
457 $_[0]->expand_expr({ -list => $_[2] }, -ident)
458 ] } if ref($_[2]) eq 'ARRAY';
459 return $_[2]; # should maybe still expand somewhat?
462 sub _expand_insert_clause_from {
463 my ($self, undef, $data) = @_;
464 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
465 return $self->expand_expr($data);
467 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
469 from => { -values => [ $v_aqt ] },
470 ($f_aqt ? (fields => $f_aqt) : ()),
474 sub _expand_insert_clause_returning {
475 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
478 sub _expand_insert_values {
479 my ($self, $data) = @_;
480 if (is_literal_value($data)) {
481 (undef, $self->expand_expr($data));
483 my ($fields, $values) = (
484 ref($data) eq 'HASH' ?
485 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
489 # no names (arrayref) means can't generate bindtype
490 !($fields) && $self->{bindtype} eq 'columns'
491 && belch "can't do 'columns' bindtype when called with arrayref";
495 ? $self->expand_expr({ -row => $fields }, -ident)
500 local our $Cur_Col_Meta = $fields->[$_];
501 $self->_expand_insert_value($values->[$_])
508 sub _render_insert_clause_fields {
509 return $_[0]->render_aqt($_[2]);
512 sub _render_insert_clause_target {
513 my ($self, undef, $from) = @_;
514 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
517 sub _render_insert_clause_from {
518 return $_[0]->render_aqt($_[2], 1);
521 # So that subclasses can override INSERT ... RETURNING separately from
522 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
523 sub _insert_returning { shift->_returning(@_) }
525 sub _redispatch_returning {
526 my ($self, $type, undef, $returning) = @_;
527 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
531 my ($self, $options) = @_;
533 my $f = $options->{returning};
535 my ($sql, @bind) = @{ $self->render_aqt(
536 $self->expand_expr({ -list => $f }, -ident)
538 return ($self->_sqlcase(' returning ').$sql, @bind);
541 sub _expand_insert_value {
544 my $k = our $Cur_Col_Meta;
546 if (ref($v) eq 'ARRAY') {
547 if ($self->{array_datatypes}) {
548 return +{ -bind => [ $k, $v ] };
550 my ($sql, @bind) = @$v;
551 $self->_assert_bindval_matches_bindtype(@bind);
552 return +{ -literal => $v };
554 if (ref($v) eq 'HASH') {
555 if (grep !/^-/, keys %$v) {
556 belch "HASH ref as bind value in insert is not supported";
557 return +{ -bind => [ $k, $v ] };
561 return +{ -bind => [ $k, undef ] };
563 return $self->expand_expr($v);
568 #======================================================================
570 #======================================================================
573 my ($self, $table, $set, $where, $options) = @_;
576 if (ref($table) eq 'HASH') {
580 @clauses{qw(target set where)} = ($table, $set, $where);
581 puke "Unsupported data type specified to \$sql->update"
582 unless ref($clauses{set}) eq 'HASH';
583 @clauses{keys %$options} = values %$options;
587 my @rendered = $self->render_statement({ -update => $stmt });
588 return wantarray ? @rendered : $rendered[0];
591 sub _render_update_clause_target {
592 my ($self, undef, $target) = @_;
593 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
596 sub _update_set_values {
597 my ($self, $data) = @_;
599 return @{ $self->render_aqt(
600 $self->_expand_update_set_values(undef, $data),
604 sub _expand_update_set_values {
605 my ($self, undef, $data) = @_;
606 $self->expand_expr({ -list => [
609 $set = { -bind => $_ } unless defined $set;
610 +{ -op => [ '=', { -ident => $k }, $set ] };
616 ? ($self->{array_datatypes}
617 ? [ $k, +{ -bind => [ $k, $v ] } ]
618 : [ $k, +{ -literal => $v } ])
620 local our $Cur_Col_Meta = $k;
621 [ $k, $self->_expand_expr($v) ]
628 sub _expand_update_clause_target {
629 my ($self, undef, $target) = @_;
630 +(target => $self->expand_expr({ -list => $target }, -ident));
633 sub _expand_update_clause_set {
634 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
635 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
638 sub _expand_update_clause_where {
639 +(where => $_[0]->expand_expr($_[2]));
642 sub _expand_update_clause_returning {
643 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
646 # So that subclasses can override UPDATE ... RETURNING separately from
648 sub _update_returning { shift->_returning(@_) }
652 #======================================================================
654 #======================================================================
657 my ($self, @args) = @_;
659 if (ref(my $sel = $args[0]) eq 'HASH') {
663 @clauses{qw(from select where order_by)} = @args;
665 # This oddity is to literalify since historically SQLA doesn't quote
666 # a single identifier argument, so we convert it into a literal
668 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
669 unless ref($clauses{select});
674 my @rendered = $self->render_statement({ -select => $stmt });
675 return wantarray ? @rendered : $rendered[0];
678 sub _expand_select_clause_select {
679 my ($self, undef, $select) = @_;
680 +(select => $self->expand_expr({ -list => $select }, -ident));
683 sub _expand_select_clause_from {
684 my ($self, undef, $from) = @_;
685 +(from => $self->expand_expr({ -list => $from }, -ident));
688 sub _expand_select_clause_where {
689 my ($self, undef, $where) = @_;
692 if (my $conv = $self->{convert}) {
704 ->wrap_expander(bind => $_wrap)
705 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
706 ->wrap_expander(func => sub {
709 my ($self, $type, $thing) = @_;
710 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
711 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
714 or $thing->[1]{-value}
715 or $thing->[1]{-bind})
717 return { -func => $thing }; # already went through our expander
719 return $self->$orig($type, $thing);
727 return +(where => $sqla->expand_expr($where));
730 sub _expand_select_clause_order_by {
731 my ($self, undef, $order_by) = @_;
732 +(order_by => $self->_expand_order_by($order_by));
736 my ($self, $fields) = @_;
737 return $fields unless ref($fields);
738 return @{ $self->render_aqt(
739 $self->expand_expr({ -list => $fields }, '-ident')
743 #======================================================================
745 #======================================================================
748 my ($self, $table, $where, $options) = @_;
751 if (ref($table) eq 'HASH') {
754 my %clauses = (target => $table, where => $where, %{$options||{}});
758 my @rendered = $self->render_statement({ -delete => $stmt });
759 return wantarray ? @rendered : $rendered[0];
762 # So that subclasses can override DELETE ... RETURNING separately from
764 sub _delete_returning { shift->_returning(@_) }
766 sub _expand_delete_clause_target {
767 +(target => $_[0]->expand_expr({ -list => $_[2] }, -ident));
770 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
772 sub _expand_delete_clause_returning {
773 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
776 sub _render_delete_clause_target {
777 my ($self, undef, $from) = @_;
778 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
781 #======================================================================
783 #======================================================================
787 # Finally, a separate routine just to handle WHERE clauses
789 my ($self, $where, $order) = @_;
791 local $self->{convert_where} = $self->{convert};
794 my ($sql, @bind) = defined($where)
795 ? $self->_recurse_where($where)
797 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
801 my ($order_sql, @order_bind) = $self->_order_by($order);
803 push @bind, @order_bind;
806 return wantarray ? ($sql, @bind) : $sql;
809 { our $Default_Scalar_To = -value }
812 my ($self, $expr, $default_scalar_to) = @_;
813 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
814 $self->_expand_expr($expr);
818 my ($self, $aqt, $top_level) = @_;
819 my ($k, $v, @rest) = %$aqt;
821 die "Not a node type: $k" unless $k =~ s/^-//;
822 if (my $meth = $self->{render}{$k}) {
823 local our $Render_Top_Level = $top_level;
824 return $self->$meth($k, $v);
826 die "notreached: $k";
830 my ($self, $expr, $default_scalar_to) = @_;
831 return @{ $self->render_aqt(
832 $self->expand_expr($expr, $default_scalar_to)
836 sub render_statement {
837 my ($self, $expr, $default_scalar_to) = @_;
839 $self->expand_expr($expr, $default_scalar_to), 1
843 sub _expand_statement {
844 my ($self, $type, $args) = @_;
845 my $ec = $self->{expand_clause};
848 $args->{$type} = delete $args->{_}
850 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
851 return +{ "-${type}" => +{
853 my $val = $args->{$_};
854 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
855 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
860 } elsif ($has_clause{$_}) {
861 ($_ => $self->expand_expr($val))
869 sub _render_statement {
870 my ($self, $type, $args) = @_;
872 foreach my $clause (@{$self->{clauses_of}{$type}}) {
873 next unless my $clause_expr = $args->{$clause};
875 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
876 $self->$rdr($clause, $clause_expr, $args);
878 my $r = $self->render_aqt($clause_expr, 1);
879 next unless defined $r->[0] and length $r->[0];
880 $self->join_query_parts(' ',
881 { -keyword => $clause },
888 my $q = $self->join_query_parts(' ', @parts);
889 return $self->join_query_parts('',
890 (our $Render_Top_Level ? $q : ('(', $q, ')'))
895 my ($self, $raw) = @_;
897 return $op if grep $_->{$op}, @{$self}{qw(expand_op render_op)};
898 s/^-(?=.)//, s/\s+/_/g for $op;
903 my ($self, $expr) = @_;
904 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
905 return undef unless defined($expr);
906 if (ref($expr) eq 'HASH') {
907 return undef unless my $kc = keys %$expr;
909 return $self->_expand_op_andor(and => $expr);
911 my ($key, $value) = %$expr;
912 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
913 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
914 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
916 return $self->_expand_hashpair($key, $value);
918 if (ref($expr) eq 'ARRAY') {
919 return $self->_expand_op_andor(lc($self->{logic}), $expr);
921 if (my $literal = is_literal_value($expr)) {
922 return +{ -literal => $literal };
924 if (!ref($expr) or Scalar::Util::blessed($expr)) {
925 return $self->_expand_scalar($expr);
930 sub _expand_hashpair {
931 my ($self, $k, $v) = @_;
932 unless (defined($k) and length($k)) {
933 if (defined($k) and my $literal = is_literal_value($v)) {
934 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
935 return { -literal => $literal };
937 puke "Supplying an empty left hand side argument is not supported";
940 return $self->_expand_hashpair_op($k, $v);
941 } elsif ($k =~ /^[^\w]/i) {
942 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
943 return $self->_expand_op(
944 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
947 return $self->_expand_hashpair_ident($k, $v);
950 sub _expand_hashpair_ident {
951 my ($self, $k, $v) = @_;
953 local our $Cur_Col_Meta = $k;
955 # hash with multiple or no elements is andor
957 if (ref($v) eq 'HASH' and keys %$v != 1) {
958 return $self->_expand_op_andor(and => $v, $k);
961 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
963 if (is_undef_value($v)) {
964 return $self->_expand_hashpair_cmp($k => undef);
967 # scalars and objects get expanded as whatever requested or values
969 if (!ref($v) or Scalar::Util::blessed($v)) {
970 return $self->_expand_hashpair_scalar($k, $v);
973 # single key hashref is a hashtriple
975 if (ref($v) eq 'HASH') {
976 return $self->_expand_hashtriple($k, %$v);
979 # arrayref needs re-engineering over the elements
981 if (ref($v) eq 'ARRAY') {
982 return $self->sqlfalse unless @$v;
983 $self->_debug("ARRAY($k) means distribute over elements");
985 $v->[0] =~ /^-(and|or)$/i
986 ? (shift(@{$v = [ @$v ]}), $1)
987 : lc($self->{logic} || 'OR')
989 return $self->_expand_op_andor(
994 if (my $literal = is_literal_value($v)) {
996 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
999 my ($sql, @bind) = @$literal;
1000 if ($self->{bindtype} eq 'columns') {
1002 $self->_assert_bindval_matches_bindtype($_);
1005 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
1010 sub _expand_scalar {
1011 my ($self, $expr) = @_;
1013 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
1016 sub _expand_hashpair_scalar {
1017 my ($self, $k, $v) = @_;
1019 return $self->_expand_hashpair_cmp(
1020 $k, $self->_expand_scalar($v),
1024 sub _expand_hashpair_op {
1025 my ($self, $k, $v) = @_;
1027 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
1029 my $op = $self->_normalize_op($k);
1031 my $wsop = join(' ', split '_', $op);
1033 my $is_special = List::Util::first { $wsop =~ $_->{regex} }
1034 @{$self->{special_ops}};
1038 # the old special op system requires illegality for top-level use
1041 (our $Expand_Depth) == 1
1045 $self->{disable_old_special_ops}
1046 and List::Util::first { $wsop =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1050 puke "Illegal use of top-level '-$wsop'"
1054 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1055 return $self->$exp($op, $v);
1058 if ($self->{render}{$op}) {
1059 return { "-${op}" => $v };
1062 # Ops prefixed with -not_ get converted
1064 if (my ($rest) = $op =~/^not_(.*)$/) {
1067 $self->_expand_expr({ "-${rest}", $v })
1073 # the old unary op system means we should touch nothing and let it work
1075 my $op = join(' ', split '_', $op);
1077 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1078 return { -op => [ $op, $v ] };
1082 my $type = $is_special || $self->{render_op}{$op} ? -op : -func;
1084 if ($self->{restore_old_unop_handling}) {
1091 and (keys %$v)[0] =~ /^-/
1092 and not $self->{render_op}{$op}
1101 if ($type eq -func and ref($v) eq 'ARRAY') {
1102 return $self->_expand_expr({ -func => [ $op, @$v ] });
1105 return $self->_expand_expr({ $type => [ $op, $v ] });
1108 sub _expand_hashpair_cmp {
1109 my ($self, $k, $v) = @_;
1110 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1113 sub _expand_hashtriple {
1114 my ($self, $k, $vk, $vv) = @_;
1116 my $ik = $self->_expand_expr({ -ident => $k });
1118 my $op = $self->_normalize_op($vk);
1119 $self->_assert_pass_injection_guard($op);
1121 if ($op =~ s/ _? \d+ $//x ) {
1122 return $self->_expand_expr($k, { $vk, $vv });
1124 if (my $x = $self->{expand_op}{$op}) {
1125 local our $Cur_Col_Meta = $k;
1126 return $self->$x($op, $vv, $k);
1130 my $op = join(' ', split '_', $op);
1132 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1133 return { -op => [ $op, $ik, $vv ] };
1135 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1139 { -op => [ $op, $vv ] }
1143 if (ref($vv) eq 'ARRAY') {
1145 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1146 ? (shift(@raw), lc $1) : 'or';
1147 my @values = map +{ $vk => $_ }, @raw;
1149 $op =~ $self->{inequality_op}
1150 or $op =~ $self->{not_like_op}
1152 if (lc($logic) eq 'or' and @values > 1) {
1153 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1154 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1155 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1160 # try to DWIM on equality operators
1161 return ($self->_dwim_op_to_is($op,
1162 "Supplying an empty arrayref to '%s' is deprecated",
1163 "operator '%s' applied on an empty array (field '$k')"
1164 ) ? $self->sqlfalse : $self->sqltrue);
1166 return $self->_expand_op_andor($logic => \@values, $k);
1168 if (is_undef_value($vv)) {
1169 my $is = ($self->_dwim_op_to_is($op,
1170 "Supplying an undefined argument to '%s' is deprecated",
1171 "unexpected operator '%s' with undef operand",
1172 ) ? 'is' : 'is not');
1174 return $self->_expand_hashpair($k => { $is, undef });
1176 local our $Cur_Col_Meta = $k;
1180 $self->_expand_expr($vv)
1184 sub _dwim_op_to_is {
1185 my ($self, $raw, $empty, $fail) = @_;
1187 my $op = $self->_normalize_op($raw);
1189 if ($op =~ /^not$/i) {
1192 if ($op =~ $self->{equality_op}) {
1195 if ($op =~ $self->{like_op}) {
1196 belch(sprintf $empty, uc(join ' ', split '_', $op));
1199 if ($op =~ $self->{inequality_op}) {
1202 if ($op =~ $self->{not_like_op}) {
1203 belch(sprintf $empty, uc(join ' ', split '_', $op));
1206 puke(sprintf $fail, $op);
1210 my ($self, undef, $args) = @_;
1211 my ($func, @args) = @$args;
1212 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1216 my ($self, undef, $body) = @_;
1217 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1218 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1220 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1221 ref($body) ? @$body : $body;
1222 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1223 unless ($self->{quote_char}) {
1224 $self->_assert_pass_injection_guard($_) for @parts;
1226 return +{ -ident => \@parts };
1230 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1234 my ($self, undef, $args) = @_;
1235 +{ -row => [ map $self->expand_expr($_), @$args ] };
1239 my ($self, undef, $args) = @_;
1240 my ($op, @opargs) = @$args;
1241 if (my $exp = $self->{expand_op}{$op}) {
1242 return $self->$exp($op, \@opargs);
1244 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1248 my ($self, undef, $v) = @_;
1250 return $self->_expand_expr($v);
1252 puke "-bool => undef not supported" unless defined($v);
1253 return $self->_expand_expr({ -ident => $v });
1257 my ($self, undef, $expr) = @_;
1259 ',', map $self->expand_expr($_),
1260 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1261 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1262 return +{ -op => [ ',',
1263 map $self->expand_expr($_),
1264 ref($expr) eq 'ARRAY' ? @$expr : $expr
1268 sub _expand_op_andor {
1269 my ($self, $logop, $v, $k) = @_;
1271 $v = [ map +{ $k, $_ },
1273 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1277 if (ref($v) eq 'HASH') {
1278 return undef unless keys %$v;
1281 map $self->_expand_expr({ $_ => $v->{$_} }),
1285 if (ref($v) eq 'ARRAY') {
1286 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1289 (ref($_) eq 'ARRAY' and @$_)
1290 or (ref($_) eq 'HASH' and %$_)
1296 while (my ($el) = splice @expr, 0, 1) {
1297 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1298 unless defined($el) and length($el);
1299 my $elref = ref($el);
1301 local our $Expand_Depth = 0;
1302 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1303 } elsif ($elref eq 'ARRAY') {
1304 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1305 } elsif (my $l = is_literal_value($el)) {
1306 push @res, { -literal => $l };
1307 } elsif ($elref eq 'HASH') {
1308 local our $Expand_Depth = 0;
1309 push @res, grep defined, $self->_expand_expr($el) if %$el;
1315 # return $res[0] if @res == 1;
1316 return { -op => [ $logop, @res ] };
1322 my ($self, $op, $vv, $k) = @_;
1323 ($k, $vv) = @$vv unless defined $k;
1324 puke "$op can only take undef as argument"
1328 and exists($vv->{-value})
1329 and !defined($vv->{-value})
1331 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1334 sub _expand_between {
1335 my ($self, $op, $vv, $k) = @_;
1336 my @rhs = map $self->_expand_expr($_),
1337 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1339 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1341 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1343 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1347 $self->expand_expr($k),
1348 map $self->expand_expr($_, -value), @rhs
1353 my ($self, $op, $vv, $k) = @_;
1354 if (my $literal = is_literal_value($vv)) {
1355 my ($sql, @bind) = @$literal;
1356 my $opened_sql = $self->_open_outer_paren($sql);
1358 $op, $self->expand_expr($k, -ident),
1359 { -literal => [ $opened_sql, @bind ] }
1363 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1364 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1365 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1366 . 'will emit the logically correct SQL instead of raising this exception)'
1368 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1370 my @rhs = map $self->expand_expr($_, -value),
1371 map { defined($_) ? $_: puke($undef_err) }
1372 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1373 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1377 $self->expand_expr($k, -ident),
1383 my ($self, undef, $v) = @_;
1384 # DBIx::Class requires a nest warning to be emitted once but the private
1385 # method it overrode to do so no longer exists
1386 if ($self->{warn_once_on_nest}) {
1387 unless (our $Nest_Warned) {
1389 "-nest in search conditions is deprecated, you most probably wanted:\n"
1390 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1395 return $self->_expand_expr($v);
1398 sub _expand_values {
1399 my ($self, undef, $values) = @_;
1400 return { -values => [
1403 ? $self->expand_expr($_)
1404 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1405 ), ref($values) eq 'ARRAY' ? @$values : $values
1409 sub _recurse_where {
1410 my ($self, $where) = @_;
1412 # Special case: top level simple string treated as literal
1414 my $where_exp = (ref($where)
1415 ? $self->_expand_select_clause_where(undef, $where)
1416 : { -literal => [ $where ] });
1418 # dispatch expanded expression
1420 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1421 # DBIx::Class used to call _recurse_where in scalar context
1422 # something else might too...
1424 return ($sql, @bind);
1427 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1433 my ($self, undef, $ident) = @_;
1435 return [ $self->_quote($ident) ];
1439 my ($self, undef, $values) = @_;
1440 return $self->join_query_parts('',
1442 $self->_render_op(undef, [ ',', @$values ]),
1448 my ($self, undef, $rest) = @_;
1449 my ($func, @args) = @$rest;
1450 return $self->join_query_parts('',
1451 $self->_sqlcase($func),
1452 $self->join_query_parts('',
1454 $self->join_query_parts(', ', @args),
1461 my ($self, undef, $bind) = @_;
1462 return [ '?', $self->_bindtype(@$bind) ];
1465 sub _render_literal {
1466 my ($self, undef, $literal) = @_;
1467 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1471 sub _render_keyword {
1472 my ($self, undef, $keyword) = @_;
1473 return [ $self->_sqlcase(
1474 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1479 my ($self, undef, $v) = @_;
1480 my ($op, @args) = @$v;
1481 if (my $r = $self->{render_op}{$op}) {
1482 return $self->$r($op, \@args);
1487 my $op = join(' ', split '_', $op);
1489 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1490 if ($ss and @args > 1) {
1491 puke "Special op '${op}' requires first value to be identifier"
1492 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1493 my $k = join(($self->{name_sep}||'.'), @$ident);
1494 local our $Expand_Depth = 1;
1495 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1497 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1498 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1501 return $self->_render_unop_paren($op, \@args);
1505 return $self->_render_unop_prefix($op, \@args);
1507 return $self->_render_op_multop($op, \@args);
1513 sub _render_op_between {
1514 my ($self, $op, $args) = @_;
1515 my ($left, $low, $high) = @$args;
1518 puke "Single arg to between must be a literal"
1519 unless $low->{-literal};
1522 +($low, { -keyword => 'and' }, $high);
1525 return $self->join_query_parts(' ',
1526 '(', $left, { -keyword => $op }, @rh, ')',
1531 my ($self, $op, $args) = @_;
1532 my ($lhs, @rhs) = @$args;
1534 return $self->join_query_parts(' ',
1536 { -keyword => $op },
1537 $self->join_query_parts(' ',
1539 $self->join_query_parts(', ', @rhs),
1545 sub _render_op_andor {
1546 my ($self, $op, $args) = @_;
1547 return undef unless @$args;
1548 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1549 my $inner = $self->_render_op_multop($op, $args);
1550 return undef unless defined($inner->[0]) and length($inner->[0]);
1551 return $self->join_query_parts(' ',
1556 sub _render_op_multop {
1557 my ($self, $op, $args) = @_;
1559 return undef unless @parts;
1560 return $self->render_aqt($parts[0]) if @parts == 1;
1561 my $join = ($op eq ','
1563 : { -keyword => " ${op} " }
1565 return $self->join_query_parts($join, @parts);
1568 sub _render_values {
1569 my ($self, undef, $values) = @_;
1570 my $inner = $self->join_query_parts(' ',
1571 { -keyword => 'values' },
1572 $self->join_query_parts(', ',
1573 ref($values) eq 'ARRAY' ? @$values : $values
1576 return $self->join_query_parts('',
1577 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1581 sub join_query_parts {
1582 my ($self, $join, @parts) = @_;
1583 if (ref($join) eq 'HASH') {
1584 $join = $self->render_aqt($join)->[0];
1588 ? $self->render_aqt($_)
1589 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1592 $self->{join_sql_parts}->(
1593 $join, grep defined && length, map $_->[0], @final
1595 (map @{$_}[1..$#$_], @final),
1599 sub _render_unop_paren {
1600 my ($self, $op, $v) = @_;
1601 return $self->join_query_parts('',
1602 '(', $self->_render_unop_prefix($op, $v), ')'
1606 sub _render_unop_prefix {
1607 my ($self, $op, $v) = @_;
1608 my $op_sql = $self->{restore_old_unop_handling}
1609 ? $self->_sqlcase($op)
1610 : { -keyword => $op };
1611 return $self->join_query_parts(' ',
1612 ($self->{restore_old_unop_handling}
1613 ? $self->_sqlcase($op)
1614 : { -keyword => \$op }),
1619 sub _render_unop_postfix {
1620 my ($self, $op, $v) = @_;
1621 return $self->join_query_parts(' ',
1622 $v->[0], { -keyword => $op },
1626 # Some databases (SQLite) treat col IN (1, 2) different from
1627 # col IN ( (1, 2) ). Use this to strip all outer parens while
1628 # adding them back in the corresponding method
1629 sub _open_outer_paren {
1630 my ($self, $sql) = @_;
1632 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1634 # there are closing parens inside, need the heavy duty machinery
1635 # to reevaluate the extraction starting from $sql (full reevaluation)
1636 if ($inner =~ /\)/) {
1637 require Text::Balanced;
1639 my (undef, $remainder) = do {
1640 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1642 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1645 # the entire expression needs to be a balanced bracketed thing
1646 # (after an extract no remainder sans trailing space)
1647 last if defined $remainder and $remainder =~ /\S/;
1657 #======================================================================
1659 #======================================================================
1661 sub _expand_order_by {
1662 my ($self, $arg) = @_;
1664 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1666 return $self->expand_expr({ -list => $arg })
1667 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1669 my $expander = sub {
1670 my ($self, $dir, $expr) = @_;
1671 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1672 foreach my $arg (@to_expand) {
1676 and grep /^-(asc|desc)$/, keys %$arg
1678 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1682 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1684 map $self->expand_expr($_, -ident),
1685 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1686 return undef unless @exp;
1687 return undef if @exp == 1 and not defined($exp[0]);
1688 return +{ -op => [ ',', @exp ] };
1691 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1693 return $self->$expander(undef, $arg);
1697 my ($self, $arg) = @_;
1699 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1701 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1703 return '' unless length($sql);
1705 my $final_sql = $self->_sqlcase(' order by ').$sql;
1707 return ($final_sql, @bind);
1710 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1712 sub _order_by_chunks {
1713 my ($self, $arg) = @_;
1715 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1717 my @res = $self->_chunkify_order_by($expanded);
1718 (ref() ? $_->[0] : $_) .= '' for @res;
1722 sub _chunkify_order_by {
1723 my ($self, $expanded) = @_;
1725 return grep length, @{ $self->render_aqt($expanded) }
1726 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1729 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1730 my ($comma, @list) = @{$_->{-op}};
1731 return map $self->_chunkify_order_by($_), @list;
1733 return $self->render_aqt($_);
1737 #======================================================================
1738 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1739 #======================================================================
1745 $self->expand_expr({ -list => $from }, -ident)
1750 #======================================================================
1752 #======================================================================
1754 # highly optimized, as it's called way too often
1756 # my ($self, $label) = @_;
1758 return '' unless defined $_[1];
1759 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1760 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1762 unless ($_[0]->{quote_char}) {
1763 if (ref($_[1]) eq 'ARRAY') {
1764 return join($_[0]->{name_sep}||'.', @{$_[1]});
1766 $_[0]->_assert_pass_injection_guard($_[1]);
1771 my $qref = ref $_[0]->{quote_char};
1773 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1774 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1775 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1777 my $esc = $_[0]->{escape_char} || $r;
1779 # parts containing * are naturally unquoted
1781 $_[0]->{name_sep}||'',
1785 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1787 (ref($_[1]) eq 'ARRAY'
1791 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1799 # Conversion, if applicable
1801 #my ($self, $arg) = @_;
1802 if (my $conv = $_[0]->{convert_where}) {
1803 return @{ $_[0]->join_query_parts('',
1804 $_[0]->_sqlcase($conv),
1813 #my ($self, $col, @vals) = @_;
1814 # called often - tighten code
1815 return $_[0]->{bindtype} eq 'columns'
1816 ? map {[$_[1], $_]} @_[2 .. $#_]
1821 # Dies if any element of @bind is not in [colname => value] format
1822 # if bindtype is 'columns'.
1823 sub _assert_bindval_matches_bindtype {
1824 # my ($self, @bind) = @_;
1826 if ($self->{bindtype} eq 'columns') {
1828 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1829 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1835 # Fix SQL case, if so requested
1837 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1838 # don't touch the argument ... crooked logic, but let's not change it!
1839 return $_[0]->{case} ? $_[1] : uc($_[1]);
1842 #======================================================================
1843 # DISPATCHING FROM REFKIND
1844 #======================================================================
1847 my ($self, $data) = @_;
1849 return 'UNDEF' unless defined $data;
1851 # blessed objects are treated like scalars
1852 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1854 return 'SCALAR' unless $ref;
1857 while ($ref eq 'REF') {
1859 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1863 return ($ref||'SCALAR') . ('REF' x $n_steps);
1867 my ($self, $data) = @_;
1868 my @try = ($self->_refkind($data));
1869 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1870 push @try, 'FALLBACK';
1874 sub _METHOD_FOR_refkind {
1875 my ($self, $meth_prefix, $data) = @_;
1878 for (@{$self->_try_refkind($data)}) {
1879 $method = $self->can($meth_prefix."_".$_)
1883 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1887 sub _SWITCH_refkind {
1888 my ($self, $data, $dispatch_table) = @_;
1891 for (@{$self->_try_refkind($data)}) {
1892 $coderef = $dispatch_table->{$_}
1896 puke "no dispatch entry for ".$self->_refkind($data)
1905 #======================================================================
1906 # VALUES, GENERATE, AUTOLOAD
1907 #======================================================================
1909 # LDNOTE: original code from nwiger, didn't touch code in that section
1910 # I feel the AUTOLOAD stuff should not be the default, it should
1911 # only be activated on explicit demand by user.
1915 my $data = shift || return;
1916 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1917 unless ref $data eq 'HASH';
1920 foreach my $k (sort keys %$data) {
1921 my $v = $data->{$k};
1922 $self->_SWITCH_refkind($v, {
1924 if ($self->{array_datatypes}) { # array datatype
1925 push @all_bind, $self->_bindtype($k, $v);
1927 else { # literal SQL with bind
1928 my ($sql, @bind) = @$v;
1929 $self->_assert_bindval_matches_bindtype(@bind);
1930 push @all_bind, @bind;
1933 ARRAYREFREF => sub { # literal SQL with bind
1934 my ($sql, @bind) = @${$v};
1935 $self->_assert_bindval_matches_bindtype(@bind);
1936 push @all_bind, @bind;
1938 SCALARREF => sub { # literal SQL without bind
1940 SCALAR_or_UNDEF => sub {
1941 push @all_bind, $self->_bindtype($k, $v);
1952 my(@sql, @sqlq, @sqlv);
1956 if ($ref eq 'HASH') {
1957 for my $k (sort keys %$_) {
1960 my $label = $self->_quote($k);
1961 if ($r eq 'ARRAY') {
1962 # literal SQL with bind
1963 my ($sql, @bind) = @$v;
1964 $self->_assert_bindval_matches_bindtype(@bind);
1965 push @sqlq, "$label = $sql";
1967 } elsif ($r eq 'SCALAR') {
1968 # literal SQL without bind
1969 push @sqlq, "$label = $$v";
1971 push @sqlq, "$label = ?";
1972 push @sqlv, $self->_bindtype($k, $v);
1975 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1976 } elsif ($ref eq 'ARRAY') {
1977 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1980 if ($r eq 'ARRAY') { # literal SQL with bind
1981 my ($sql, @bind) = @$v;
1982 $self->_assert_bindval_matches_bindtype(@bind);
1985 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1986 # embedded literal SQL
1993 push @sql, '(' . join(', ', @sqlq) . ')';
1994 } elsif ($ref eq 'SCALAR') {
1998 # strings get case twiddled
1999 push @sql, $self->_sqlcase($_);
2003 my $sql = join ' ', @sql;
2005 # this is pretty tricky
2006 # if ask for an array, return ($stmt, @bind)
2007 # otherwise, s/?/shift @sqlv/ to put it inline
2009 return ($sql, @sqlv);
2011 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2012 ref $d ? $d->[1] : $d/e;
2021 # This allows us to check for a local, then _form, attr
2023 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2024 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2025 return $self->generate($name, @_);
2036 SQL::Abstract - Generate SQL from Perl data structures
2042 my $sql = SQL::Abstract->new;
2044 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2046 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2048 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2050 my($stmt, @bind) = $sql->delete($table, \%where);
2052 # Then, use these in your DBI statements
2053 my $sth = $dbh->prepare($stmt);
2054 $sth->execute(@bind);
2056 # Just generate the WHERE clause
2057 my($stmt, @bind) = $sql->where(\%where, $order);
2059 # Return values in the same order, for hashed queries
2060 # See PERFORMANCE section for more details
2061 my @bind = $sql->values(\%fieldvals);
2065 This module was inspired by the excellent L<DBIx::Abstract>.
2066 However, in using that module I found that what I really wanted
2067 to do was generate SQL, but still retain complete control over my
2068 statement handles and use the DBI interface. So, I set out to
2069 create an abstract SQL generation module.
2071 While based on the concepts used by L<DBIx::Abstract>, there are
2072 several important differences, especially when it comes to WHERE
2073 clauses. I have modified the concepts used to make the SQL easier
2074 to generate from Perl data structures and, IMO, more intuitive.
2075 The underlying idea is for this module to do what you mean, based
2076 on the data structures you provide it. The big advantage is that
2077 you don't have to modify your code every time your data changes,
2078 as this module figures it out.
2080 To begin with, an SQL INSERT is as easy as just specifying a hash
2081 of C<key=value> pairs:
2084 name => 'Jimbo Bobson',
2085 phone => '123-456-7890',
2086 address => '42 Sister Lane',
2087 city => 'St. Louis',
2088 state => 'Louisiana',
2091 The SQL can then be generated with this:
2093 my($stmt, @bind) = $sql->insert('people', \%data);
2095 Which would give you something like this:
2097 $stmt = "INSERT INTO people
2098 (address, city, name, phone, state)
2099 VALUES (?, ?, ?, ?, ?)";
2100 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2101 '123-456-7890', 'Louisiana');
2103 These are then used directly in your DBI code:
2105 my $sth = $dbh->prepare($stmt);
2106 $sth->execute(@bind);
2108 =head2 Inserting and Updating Arrays
2110 If your database has array types (like for example Postgres),
2111 activate the special option C<< array_datatypes => 1 >>
2112 when creating the C<SQL::Abstract> object.
2113 Then you may use an arrayref to insert and update database array types:
2115 my $sql = SQL::Abstract->new(array_datatypes => 1);
2117 planets => [qw/Mercury Venus Earth Mars/]
2120 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2124 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2126 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2129 =head2 Inserting and Updating SQL
2131 In order to apply SQL functions to elements of your C<%data> you may
2132 specify a reference to an arrayref for the given hash value. For example,
2133 if you need to execute the Oracle C<to_date> function on a value, you can
2134 say something like this:
2138 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2141 The first value in the array is the actual SQL. Any other values are
2142 optional and would be included in the bind values array. This gives
2145 my($stmt, @bind) = $sql->insert('people', \%data);
2147 $stmt = "INSERT INTO people (name, date_entered)
2148 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2149 @bind = ('Bill', '03/02/2003');
2151 An UPDATE is just as easy, all you change is the name of the function:
2153 my($stmt, @bind) = $sql->update('people', \%data);
2155 Notice that your C<%data> isn't touched; the module will generate
2156 the appropriately quirky SQL for you automatically. Usually you'll
2157 want to specify a WHERE clause for your UPDATE, though, which is
2158 where handling C<%where> hashes comes in handy...
2160 =head2 Complex where statements
2162 This module can generate pretty complicated WHERE statements
2163 easily. For example, simple C<key=value> pairs are taken to mean
2164 equality, and if you want to see if a field is within a set
2165 of values, you can use an arrayref. Let's say we wanted to
2166 SELECT some data based on this criteria:
2169 requestor => 'inna',
2170 worker => ['nwiger', 'rcwe', 'sfz'],
2171 status => { '!=', 'completed' }
2174 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2176 The above would give you something like this:
2178 $stmt = "SELECT * FROM tickets WHERE
2179 ( requestor = ? ) AND ( status != ? )
2180 AND ( worker = ? OR worker = ? OR worker = ? )";
2181 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2183 Which you could then use in DBI code like so:
2185 my $sth = $dbh->prepare($stmt);
2186 $sth->execute(@bind);
2192 The methods are simple. There's one for every major SQL operation,
2193 and a constructor you use first. The arguments are specified in a
2194 similar order for each method (table, then fields, then a where
2195 clause) to try and simplify things.
2197 =head2 new(option => 'value')
2199 The C<new()> function takes a list of options and values, and returns
2200 a new B<SQL::Abstract> object which can then be used to generate SQL
2201 through the methods below. The options accepted are:
2207 If set to 'lower', then SQL will be generated in all lowercase. By
2208 default SQL is generated in "textbook" case meaning something like:
2210 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2212 Any setting other than 'lower' is ignored.
2216 This determines what the default comparison operator is. By default
2217 it is C<=>, meaning that a hash like this:
2219 %where = (name => 'nwiger', email => 'nate@wiger.org');
2221 Will generate SQL like this:
2223 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2225 However, you may want loose comparisons by default, so if you set
2226 C<cmp> to C<like> you would get SQL such as:
2228 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2230 You can also override the comparison on an individual basis - see
2231 the huge section on L</"WHERE CLAUSES"> at the bottom.
2233 =item sqltrue, sqlfalse
2235 Expressions for inserting boolean values within SQL statements.
2236 By default these are C<1=1> and C<1=0>. They are used
2237 by the special operators C<-in> and C<-not_in> for generating
2238 correct SQL even when the argument is an empty array (see below).
2242 This determines the default logical operator for multiple WHERE
2243 statements in arrays or hashes. If absent, the default logic is "or"
2244 for arrays, and "and" for hashes. This means that a WHERE
2248 event_date => {'>=', '2/13/99'},
2249 event_date => {'<=', '4/24/03'},
2252 will generate SQL like this:
2254 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2256 This is probably not what you want given this query, though (look
2257 at the dates). To change the "OR" to an "AND", simply specify:
2259 my $sql = SQL::Abstract->new(logic => 'and');
2261 Which will change the above C<WHERE> to:
2263 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2265 The logic can also be changed locally by inserting
2266 a modifier in front of an arrayref:
2268 @where = (-and => [event_date => {'>=', '2/13/99'},
2269 event_date => {'<=', '4/24/03'} ]);
2271 See the L</"WHERE CLAUSES"> section for explanations.
2275 This will automatically convert comparisons using the specified SQL
2276 function for both column and value. This is mostly used with an argument
2277 of C<upper> or C<lower>, so that the SQL will have the effect of
2278 case-insensitive "searches". For example, this:
2280 $sql = SQL::Abstract->new(convert => 'upper');
2281 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2283 Will turn out the following SQL:
2285 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2287 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2288 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2289 not validate this option; it will just pass through what you specify verbatim).
2293 This is a kludge because many databases suck. For example, you can't
2294 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2295 Instead, you have to use C<bind_param()>:
2297 $sth->bind_param(1, 'reg data');
2298 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2300 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2301 which loses track of which field each slot refers to. Fear not.
2303 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2304 Currently, you can specify either C<normal> (default) or C<columns>. If you
2305 specify C<columns>, you will get an array that looks like this:
2307 my $sql = SQL::Abstract->new(bindtype => 'columns');
2308 my($stmt, @bind) = $sql->insert(...);
2311 [ 'column1', 'value1' ],
2312 [ 'column2', 'value2' ],
2313 [ 'column3', 'value3' ],
2316 You can then iterate through this manually, using DBI's C<bind_param()>.
2318 $sth->prepare($stmt);
2321 my($col, $data) = @$_;
2322 if ($col eq 'details' || $col eq 'comments') {
2323 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2324 } elsif ($col eq 'image') {
2325 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2327 $sth->bind_param($i, $data);
2331 $sth->execute; # execute without @bind now
2333 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2334 Basically, the advantage is still that you don't have to care which fields
2335 are or are not included. You could wrap that above C<for> loop in a simple
2336 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2337 get a layer of abstraction over manual SQL specification.
2339 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2340 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2341 will expect the bind values in this format.
2345 This is the character that a table or column name will be quoted
2346 with. By default this is an empty string, but you could set it to
2347 the character C<`>, to generate SQL like this:
2349 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2351 Alternatively, you can supply an array ref of two items, the first being the left
2352 hand quote character, and the second the right hand quote character. For
2353 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2354 that generates SQL like this:
2356 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2358 Quoting is useful if you have tables or columns names that are reserved
2359 words in your database's SQL dialect.
2363 This is the character that will be used to escape L</quote_char>s appearing
2364 in an identifier before it has been quoted.
2366 The parameter default in case of a single L</quote_char> character is the quote
2369 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2370 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2371 of the B<opening (left)> L</quote_char> within the identifier are currently left
2372 untouched. The default for opening-closing-style quotes may change in future
2373 versions, thus you are B<strongly encouraged> to specify the escape character
2378 This is the character that separates a table and column name. It is
2379 necessary to specify this when the C<quote_char> option is selected,
2380 so that tables and column names can be individually quoted like this:
2382 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2384 =item injection_guard
2386 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2387 column name specified in a query structure. This is a safety mechanism to avoid
2388 injection attacks when mishandling user input e.g.:
2390 my %condition_as_column_value_pairs = get_values_from_user();
2391 $sqla->select( ... , \%condition_as_column_value_pairs );
2393 If the expression matches an exception is thrown. Note that literal SQL
2394 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2396 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2398 =item array_datatypes
2400 When this option is true, arrayrefs in INSERT or UPDATE are
2401 interpreted as array datatypes and are passed directly
2403 When this option is false, arrayrefs are interpreted
2404 as literal SQL, just like refs to arrayrefs
2405 (but this behavior is for backwards compatibility; when writing
2406 new queries, use the "reference to arrayref" syntax
2412 Takes a reference to a list of "special operators"
2413 to extend the syntax understood by L<SQL::Abstract>.
2414 See section L</"SPECIAL OPERATORS"> for details.
2418 Takes a reference to a list of "unary operators"
2419 to extend the syntax understood by L<SQL::Abstract>.
2420 See section L</"UNARY OPERATORS"> for details.
2426 =head2 insert($table, \@values || \%fieldvals, \%options)
2428 This is the simplest function. You simply give it a table name
2429 and either an arrayref of values or hashref of field/value pairs.
2430 It returns an SQL INSERT statement and a list of bind values.
2431 See the sections on L</"Inserting and Updating Arrays"> and
2432 L</"Inserting and Updating SQL"> for information on how to insert
2433 with those data types.
2435 The optional C<\%options> hash reference may contain additional
2436 options to generate the insert SQL. Currently supported options
2443 Takes either a scalar of raw SQL fields, or an array reference of
2444 field names, and adds on an SQL C<RETURNING> statement at the end.
2445 This allows you to return data generated by the insert statement
2446 (such as row IDs) without performing another C<SELECT> statement.
2447 Note, however, this is not part of the SQL standard and may not
2448 be supported by all database engines.
2452 =head2 update($table, \%fieldvals, \%where, \%options)
2454 This takes a table, hashref of field/value pairs, and an optional
2455 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2457 See the sections on L</"Inserting and Updating Arrays"> and
2458 L</"Inserting and Updating SQL"> for information on how to insert
2459 with those data types.
2461 The optional C<\%options> hash reference may contain additional
2462 options to generate the update SQL. Currently supported options
2469 See the C<returning> option to
2470 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2474 =head2 select($source, $fields, $where, $order)
2476 This returns a SQL SELECT statement and associated list of bind values, as
2477 specified by the arguments:
2483 Specification of the 'FROM' part of the statement.
2484 The argument can be either a plain scalar (interpreted as a table
2485 name, will be quoted), or an arrayref (interpreted as a list
2486 of table names, joined by commas, quoted), or a scalarref
2487 (literal SQL, not quoted).
2491 Specification of the list of fields to retrieve from
2493 The argument can be either an arrayref (interpreted as a list
2494 of field names, will be joined by commas and quoted), or a
2495 plain scalar (literal SQL, not quoted).
2496 Please observe that this API is not as flexible as that of
2497 the first argument C<$source>, for backwards compatibility reasons.
2501 Optional argument to specify the WHERE part of the query.
2502 The argument is most often a hashref, but can also be
2503 an arrayref or plain scalar --
2504 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2508 Optional argument to specify the ORDER BY part of the query.
2509 The argument can be a scalar, a hashref or an arrayref
2510 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2516 =head2 delete($table, \%where, \%options)
2518 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2519 It returns an SQL DELETE statement and list of bind values.
2521 The optional C<\%options> hash reference may contain additional
2522 options to generate the delete SQL. Currently supported options
2529 See the C<returning> option to
2530 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2534 =head2 where(\%where, $order)
2536 This is used to generate just the WHERE clause. For example,
2537 if you have an arbitrary data structure and know what the
2538 rest of your SQL is going to look like, but want an easy way
2539 to produce a WHERE clause, use this. It returns an SQL WHERE
2540 clause and list of bind values.
2543 =head2 values(\%data)
2545 This just returns the values from the hash C<%data>, in the same
2546 order that would be returned from any of the other above queries.
2547 Using this allows you to markedly speed up your queries if you
2548 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2550 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2552 Warning: This is an experimental method and subject to change.
2554 This returns arbitrarily generated SQL. It's a really basic shortcut.
2555 It will return two different things, depending on return context:
2557 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2558 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2560 These would return the following:
2562 # First calling form
2563 $stmt = "CREATE TABLE test (?, ?)";
2564 @bind = (field1, field2);
2566 # Second calling form
2567 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2569 Depending on what you're trying to do, it's up to you to choose the correct
2570 format. In this example, the second form is what you would want.
2574 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2578 ALTER SESSION SET nls_date_format = 'MM/YY'
2580 You get the idea. Strings get their case twiddled, but everything
2581 else remains verbatim.
2583 =head1 EXPORTABLE FUNCTIONS
2585 =head2 is_plain_value
2587 Determines if the supplied argument is a plain value as understood by this
2592 =item * The value is C<undef>
2594 =item * The value is a non-reference
2596 =item * The value is an object with stringification overloading
2598 =item * The value is of the form C<< { -value => $anything } >>
2602 On failure returns C<undef>, on success returns a B<scalar> reference
2603 to the original supplied argument.
2609 The stringification overloading detection is rather advanced: it takes
2610 into consideration not only the presence of a C<""> overload, but if that
2611 fails also checks for enabled
2612 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2613 on either C<0+> or C<bool>.
2615 Unfortunately testing in the field indicates that this
2616 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2617 but only when very large numbers of stringifying objects are involved.
2618 At the time of writing ( Sep 2014 ) there is no clear explanation of
2619 the direct cause, nor is there a manageably small test case that reliably
2620 reproduces the problem.
2622 If you encounter any of the following exceptions in B<random places within
2623 your application stack> - this module may be to blame:
2625 Operation "ne": no method found,
2626 left argument in overloaded package <something>,
2627 right argument in overloaded package <something>
2631 Stub found while resolving method "???" overloading """" in package <something>
2633 If you fall victim to the above - please attempt to reduce the problem
2634 to something that could be sent to the L<SQL::Abstract developers
2635 |DBIx::Class/GETTING HELP/SUPPORT>
2636 (either publicly or privately). As a workaround in the meantime you can
2637 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2638 value, which will most likely eliminate your problem (at the expense of
2639 not being able to properly detect exotic forms of stringification).
2641 This notice and environment variable will be removed in a future version,
2642 as soon as the underlying problem is found and a reliable workaround is
2647 =head2 is_literal_value
2649 Determines if the supplied argument is a literal value as understood by this
2654 =item * C<\$sql_string>
2656 =item * C<\[ $sql_string, @bind_values ]>
2660 On failure returns C<undef>, on success returns an B<array> reference
2661 containing the unpacked version of the supplied literal SQL and bind values.
2663 =head2 is_undef_value
2665 Tests for undef, whether expanded or not.
2667 =head1 WHERE CLAUSES
2671 This module uses a variation on the idea from L<DBIx::Abstract>. It
2672 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2673 module is that things in arrays are OR'ed, and things in hashes
2676 The easiest way to explain is to show lots of examples. After
2677 each C<%where> hash shown, it is assumed you used:
2679 my($stmt, @bind) = $sql->where(\%where);
2681 However, note that the C<%where> hash can be used directly in any
2682 of the other functions as well, as described above.
2684 =head2 Key-value pairs
2686 So, let's get started. To begin, a simple hash:
2690 status => 'completed'
2693 Is converted to SQL C<key = val> statements:
2695 $stmt = "WHERE user = ? AND status = ?";
2696 @bind = ('nwiger', 'completed');
2698 One common thing I end up doing is having a list of values that
2699 a field can be in. To do this, simply specify a list inside of
2704 status => ['assigned', 'in-progress', 'pending'];
2707 This simple code will create the following:
2709 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2710 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2712 A field associated to an empty arrayref will be considered a
2713 logical false and will generate 0=1.
2715 =head2 Tests for NULL values
2717 If the value part is C<undef> then this is converted to SQL <IS NULL>
2726 $stmt = "WHERE user = ? AND status IS NULL";
2729 To test if a column IS NOT NULL:
2733 status => { '!=', undef },
2736 =head2 Specific comparison operators
2738 If you want to specify a different type of operator for your comparison,
2739 you can use a hashref for a given column:
2743 status => { '!=', 'completed' }
2746 Which would generate:
2748 $stmt = "WHERE user = ? AND status != ?";
2749 @bind = ('nwiger', 'completed');
2751 To test against multiple values, just enclose the values in an arrayref:
2753 status => { '=', ['assigned', 'in-progress', 'pending'] };
2755 Which would give you:
2757 "WHERE status = ? OR status = ? OR status = ?"
2760 The hashref can also contain multiple pairs, in which case it is expanded
2761 into an C<AND> of its elements:
2765 status => { '!=', 'completed', -not_like => 'pending%' }
2768 # Or more dynamically, like from a form
2769 $where{user} = 'nwiger';
2770 $where{status}{'!='} = 'completed';
2771 $where{status}{'-not_like'} = 'pending%';
2773 # Both generate this
2774 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2775 @bind = ('nwiger', 'completed', 'pending%');
2778 To get an OR instead, you can combine it with the arrayref idea:
2782 priority => [ { '=', 2 }, { '>', 5 } ]
2785 Which would generate:
2787 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2788 @bind = ('2', '5', 'nwiger');
2790 If you want to include literal SQL (with or without bind values), just use a
2791 scalar reference or reference to an arrayref as the value:
2794 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2795 date_expires => { '<' => \"now()" }
2798 Which would generate:
2800 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2801 @bind = ('11/26/2008');
2804 =head2 Logic and nesting operators
2806 In the example above,
2807 there is a subtle trap if you want to say something like
2808 this (notice the C<AND>):
2810 WHERE priority != ? AND priority != ?
2812 Because, in Perl you I<can't> do this:
2814 priority => { '!=' => 2, '!=' => 1 }
2816 As the second C<!=> key will obliterate the first. The solution
2817 is to use the special C<-modifier> form inside an arrayref:
2819 priority => [ -and => {'!=', 2},
2823 Normally, these would be joined by C<OR>, but the modifier tells it
2824 to use C<AND> instead. (Hint: You can use this in conjunction with the
2825 C<logic> option to C<new()> in order to change the way your queries
2826 work by default.) B<Important:> Note that the C<-modifier> goes
2827 B<INSIDE> the arrayref, as an extra first element. This will
2828 B<NOT> do what you think it might:
2830 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2832 Here is a quick list of equivalencies, since there is some overlap:
2835 status => {'!=', 'completed', 'not like', 'pending%' }
2836 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2839 status => {'=', ['assigned', 'in-progress']}
2840 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2841 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2845 =head2 Special operators: IN, BETWEEN, etc.
2847 You can also use the hashref format to compare a list of fields using the
2848 C<IN> comparison operator, by specifying the list as an arrayref:
2851 status => 'completed',
2852 reportid => { -in => [567, 2335, 2] }
2855 Which would generate:
2857 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2858 @bind = ('completed', '567', '2335', '2');
2860 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2863 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2864 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2865 'sqltrue' (by default: C<1=1>).
2867 In addition to the array you can supply a chunk of literal sql or
2868 literal sql with bind:
2871 customer => { -in => \[
2872 'SELECT cust_id FROM cust WHERE balance > ?',
2875 status => { -in => \'SELECT status_codes FROM states' },
2881 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2882 AND status IN ( SELECT status_codes FROM states )
2886 Finally, if the argument to C<-in> is not a reference, it will be
2887 treated as a single-element array.
2889 Another pair of operators is C<-between> and C<-not_between>,
2890 used with an arrayref of two values:
2894 completion_date => {
2895 -not_between => ['2002-10-01', '2003-02-06']
2901 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2903 Just like with C<-in> all plausible combinations of literal SQL
2907 start0 => { -between => [ 1, 2 ] },
2908 start1 => { -between => \["? AND ?", 1, 2] },
2909 start2 => { -between => \"lower(x) AND upper(y)" },
2910 start3 => { -between => [
2912 \["upper(?)", 'stuff' ],
2919 ( start0 BETWEEN ? AND ? )
2920 AND ( start1 BETWEEN ? AND ? )
2921 AND ( start2 BETWEEN lower(x) AND upper(y) )
2922 AND ( start3 BETWEEN lower(x) AND upper(?) )
2924 @bind = (1, 2, 1, 2, 'stuff');
2927 These are the two builtin "special operators"; but the
2928 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2930 =head2 Unary operators: bool
2932 If you wish to test against boolean columns or functions within your
2933 database you can use the C<-bool> and C<-not_bool> operators. For
2934 example to test the column C<is_user> being true and the column
2935 C<is_enabled> being false you would use:-
2939 -not_bool => 'is_enabled',
2944 WHERE is_user AND NOT is_enabled
2946 If a more complex combination is required, testing more conditions,
2947 then you should use the and/or operators:-
2952 -not_bool => { two=> { -rlike => 'bar' } },
2953 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2964 (NOT ( three = ? OR three > ? ))
2967 =head2 Nested conditions, -and/-or prefixes
2969 So far, we've seen how multiple conditions are joined with a top-level
2970 C<AND>. We can change this by putting the different conditions we want in
2971 hashes and then putting those hashes in an array. For example:
2976 status => { -like => ['pending%', 'dispatched'] },
2980 status => 'unassigned',
2984 This data structure would create the following:
2986 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2987 OR ( user = ? AND status = ? ) )";
2988 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2991 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2992 to change the logic inside:
2998 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2999 -or => { workhrs => {'<', 50}, geo => 'EURO' },
3006 $stmt = "WHERE ( user = ?
3007 AND ( ( workhrs > ? AND geo = ? )
3008 OR ( workhrs < ? OR geo = ? ) ) )";
3009 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
3011 =head3 Algebraic inconsistency, for historical reasons
3013 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
3014 operator goes C<outside> of the nested structure; whereas when connecting
3015 several constraints on one column, the C<-and> operator goes
3016 C<inside> the arrayref. Here is an example combining both features:
3019 -and => [a => 1, b => 2],
3020 -or => [c => 3, d => 4],
3021 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3026 WHERE ( ( ( a = ? AND b = ? )
3027 OR ( c = ? OR d = ? )
3028 OR ( e LIKE ? AND e LIKE ? ) ) )
3030 This difference in syntax is unfortunate but must be preserved for
3031 historical reasons. So be careful: the two examples below would
3032 seem algebraically equivalent, but they are not
3035 { -like => 'foo%' },
3036 { -like => '%bar' },
3038 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3041 { col => { -like => 'foo%' } },
3042 { col => { -like => '%bar' } },
3044 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3047 =head2 Literal SQL and value type operators
3049 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3050 side" is a column name and the "right side" is a value (normally rendered as
3051 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3052 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3053 alter this behavior. There are several ways of doing so.
3057 This is a virtual operator that signals the string to its right side is an
3058 identifier (a column name) and not a value. For example to compare two
3059 columns you would write:
3062 priority => { '<', 2 },
3063 requestor => { -ident => 'submitter' },
3068 $stmt = "WHERE priority < ? AND requestor = submitter";
3071 If you are maintaining legacy code you may see a different construct as
3072 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3077 This is a virtual operator that signals that the construct to its right side
3078 is a value to be passed to DBI. This is for example necessary when you want
3079 to write a where clause against an array (for RDBMS that support such
3080 datatypes). For example:
3083 array => { -value => [1, 2, 3] }
3088 $stmt = 'WHERE array = ?';
3089 @bind = ([1, 2, 3]);
3091 Note that if you were to simply say:
3097 the result would probably not be what you wanted:
3099 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3104 Finally, sometimes only literal SQL will do. To include a random snippet
3105 of SQL verbatim, you specify it as a scalar reference. Consider this only
3106 as a last resort. Usually there is a better way. For example:
3109 priority => { '<', 2 },
3110 requestor => { -in => \'(SELECT name FROM hitmen)' },
3115 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3118 Note that in this example, you only get one bind parameter back, since
3119 the verbatim SQL is passed as part of the statement.
3123 Never use untrusted input as a literal SQL argument - this is a massive
3124 security risk (there is no way to check literal snippets for SQL
3125 injections and other nastyness). If you need to deal with untrusted input
3126 use literal SQL with placeholders as described next.
3128 =head3 Literal SQL with placeholders and bind values (subqueries)
3130 If the literal SQL to be inserted has placeholders and bind values,
3131 use a reference to an arrayref (yes this is a double reference --
3132 not so common, but perfectly legal Perl). For example, to find a date
3133 in Postgres you can use something like this:
3136 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3141 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3144 Note that you must pass the bind values in the same format as they are returned
3145 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3146 to C<columns>, you must provide the bind values in the
3147 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3148 scalar value; most commonly the column name, but you can use any scalar value
3149 (including references and blessed references), L<SQL::Abstract> will simply
3150 pass it through intact. So if C<bindtype> is set to C<columns> the above
3151 example will look like:
3154 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3157 Literal SQL is especially useful for nesting parenthesized clauses in the
3158 main SQL query. Here is a first example:
3160 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3164 bar => \["IN ($sub_stmt)" => @sub_bind],
3169 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3170 WHERE c2 < ? AND c3 LIKE ?))";
3171 @bind = (1234, 100, "foo%");
3173 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3174 are expressed in the same way. Of course the C<$sub_stmt> and
3175 its associated bind values can be generated through a former call
3178 my ($sub_stmt, @sub_bind)
3179 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3180 c3 => {-like => "foo%"}});
3183 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3186 In the examples above, the subquery was used as an operator on a column;
3187 but the same principle also applies for a clause within the main C<%where>
3188 hash, like an EXISTS subquery:
3190 my ($sub_stmt, @sub_bind)
3191 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3192 my %where = ( -and => [
3194 \["EXISTS ($sub_stmt)" => @sub_bind],
3199 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3200 WHERE c1 = ? AND c2 > t0.c0))";
3204 Observe that the condition on C<c2> in the subquery refers to
3205 column C<t0.c0> of the main query: this is I<not> a bind
3206 value, so we have to express it through a scalar ref.
3207 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3208 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3209 what we wanted here.
3211 Finally, here is an example where a subquery is used
3212 for expressing unary negation:
3214 my ($sub_stmt, @sub_bind)
3215 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3216 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3218 lname => {like => '%son%'},
3219 \["NOT ($sub_stmt)" => @sub_bind],
3224 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3225 @bind = ('%son%', 10, 20)
3227 =head3 Deprecated usage of Literal SQL
3229 Below are some examples of archaic use of literal SQL. It is shown only as
3230 reference for those who deal with legacy code. Each example has a much
3231 better, cleaner and safer alternative that users should opt for in new code.
3237 my %where = ( requestor => \'IS NOT NULL' )
3239 $stmt = "WHERE requestor IS NOT NULL"
3241 This used to be the way of generating NULL comparisons, before the handling
3242 of C<undef> got formalized. For new code please use the superior syntax as
3243 described in L</Tests for NULL values>.
3247 my %where = ( requestor => \'= submitter' )
3249 $stmt = "WHERE requestor = submitter"
3251 This used to be the only way to compare columns. Use the superior L</-ident>
3252 method for all new code. For example an identifier declared in such a way
3253 will be properly quoted if L</quote_char> is properly set, while the legacy
3254 form will remain as supplied.
3258 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3260 $stmt = "WHERE completed > ? AND is_ready"
3261 @bind = ('2012-12-21')
3263 Using an empty string literal used to be the only way to express a boolean.
3264 For all new code please use the much more readable
3265 L<-bool|/Unary operators: bool> operator.
3271 These pages could go on for a while, since the nesting of the data
3272 structures this module can handle are pretty much unlimited (the
3273 module implements the C<WHERE> expansion as a recursive function
3274 internally). Your best bet is to "play around" with the module a
3275 little to see how the data structures behave, and choose the best
3276 format for your data based on that.
3278 And of course, all the values above will probably be replaced with
3279 variables gotten from forms or the command line. After all, if you
3280 knew everything ahead of time, you wouldn't have to worry about
3281 dynamically-generating SQL and could just hardwire it into your
3284 =head1 ORDER BY CLAUSES
3286 Some functions take an order by clause. This can either be a scalar (just a
3287 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3288 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3291 Given | Will Generate
3292 ---------------------------------------------------------------
3294 'colA' | ORDER BY colA
3296 [qw/colA colB/] | ORDER BY colA, colB
3298 {-asc => 'colA'} | ORDER BY colA ASC
3300 {-desc => 'colB'} | ORDER BY colB DESC
3302 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3304 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3306 \'colA DESC' | ORDER BY colA DESC
3308 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3309 | /* ...with $x bound to ? */
3312 { -asc => 'colA' }, | colA ASC,
3313 { -desc => [qw/colB/] }, | colB DESC,
3314 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3315 \'colE DESC', | colE DESC,
3316 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3317 ] | /* ...with $x bound to ? */
3318 ===============================================================
3322 =head1 OLD EXTENSION SYSTEM
3324 =head2 SPECIAL OPERATORS
3326 my $sqlmaker = SQL::Abstract->new(special_ops => [
3330 my ($self, $field, $op, $arg) = @_;
3336 handler => 'method_name',
3340 A "special operator" is a SQL syntactic clause that can be
3341 applied to a field, instead of a usual binary operator.
3344 WHERE field IN (?, ?, ?)
3345 WHERE field BETWEEN ? AND ?
3346 WHERE MATCH(field) AGAINST (?, ?)
3348 Special operators IN and BETWEEN are fairly standard and therefore
3349 are builtin within C<SQL::Abstract> (as the overridable methods
3350 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3351 like the MATCH .. AGAINST example above which is specific to MySQL,
3352 you can write your own operator handlers - supply a C<special_ops>
3353 argument to the C<new> method. That argument takes an arrayref of
3354 operator definitions; each operator definition is a hashref with two
3361 the regular expression to match the operator
3365 Either a coderef or a plain scalar method name. In both cases
3366 the expected return is C<< ($sql, @bind) >>.
3368 When supplied with a method name, it is simply called on the
3369 L<SQL::Abstract> object as:
3371 $self->$method_name($field, $op, $arg)
3375 $field is the LHS of the operator
3376 $op is the part that matched the handler regex
3379 When supplied with a coderef, it is called as:
3381 $coderef->($self, $field, $op, $arg)
3386 For example, here is an implementation
3387 of the MATCH .. AGAINST syntax for MySQL
3389 my $sqlmaker = SQL::Abstract->new(special_ops => [
3391 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3392 {regex => qr/^match$/i,
3394 my ($self, $field, $op, $arg) = @_;
3395 $arg = [$arg] if not ref $arg;
3396 my $label = $self->_quote($field);
3397 my ($placeholder) = $self->_convert('?');
3398 my $placeholders = join ", ", (($placeholder) x @$arg);
3399 my $sql = $self->_sqlcase('match') . " ($label) "
3400 . $self->_sqlcase('against') . " ($placeholders) ";
3401 my @bind = $self->_bindtype($field, @$arg);
3402 return ($sql, @bind);
3409 =head2 UNARY OPERATORS
3411 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3415 my ($self, $op, $arg) = @_;
3421 handler => 'method_name',
3425 A "unary operator" is a SQL syntactic clause that can be
3426 applied to a field - the operator goes before the field
3428 You can write your own operator handlers - supply a C<unary_ops>
3429 argument to the C<new> method. That argument takes an arrayref of
3430 operator definitions; each operator definition is a hashref with two
3437 the regular expression to match the operator
3441 Either a coderef or a plain scalar method name. In both cases
3442 the expected return is C<< $sql >>.
3444 When supplied with a method name, it is simply called on the
3445 L<SQL::Abstract> object as:
3447 $self->$method_name($op, $arg)
3451 $op is the part that matched the handler regex
3452 $arg is the RHS or argument of the operator
3454 When supplied with a coderef, it is called as:
3456 $coderef->($self, $op, $arg)
3463 See L<SQL::Abstract::Reference> for the C<expr> versus C<aqt> concept and
3464 an explanation of what the below extensions are extending.
3468 my ($sql, @bind) = $sqla->render_expr($expr);
3470 =head2 render_statement
3472 Use this if you may be rendering a top level statement so e.g. a SELECT
3473 query doesn't get wrapped in parens
3475 my ($sql, @bind) = $sqla->render_statement($expr);
3479 Expression expansion with optional default for scalars.
3481 my $aqt = $self->expand_expr($expr);
3482 my $aqt = $self->expand_expr($expr, -ident);
3486 Top level means avoid parens on statement AQT.
3488 my $res = $self->render_aqt($aqt, $top_level);
3489 my ($sql, @bind) = @$res;
3491 =head2 join_query_parts
3493 Similar to join() but will render hashrefs as nodes for both join and parts,
3494 and treats arrayref as a nested C<[ $join, @parts ]> structure.
3496 my $part = $self->join_query_parts($join, @parts);
3498 =head1 NEW EXTENSION SYSTEM
3502 my $sqla2 = $sqla->clone;
3504 Performs a semi-shallow copy such that extension methods won't leak state
3505 but excessive depth is avoided.
3515 =head2 clause_expander
3517 =head2 clause_expanders
3519 $sqla->expander('name' => sub { ... });
3520 $sqla->expanders('name1' => sub { ... }, 'name2' => sub { ... });
3522 =head2 expander_list
3524 =head2 op_expander_list
3526 =head2 clause_expander_list
3528 my @names = $sqla->expander_list;
3530 =head2 wrap_expander
3532 =head2 wrap_expanders
3534 =head2 wrap_op_expander
3536 =head2 wrap_op_expanders
3538 =head2 wrap_clause_expander
3540 =head2 wrap_clause_expanders
3542 $sqla->wrap_expander('name' => sub { my ($orig) = @_; sub { ... } });
3543 $sqla->wrap_expanders(
3544 'name1' => sub { my ($orig1) = @_; sub { ... } },
3545 'name2' => sub { my ($orig2) = @_; sub { ... } },
3556 =head2 clause_renderer
3558 =head2 clause_renderers
3560 $sqla->renderer('name' => sub { ... });
3561 $sqla->renderers('name1' => sub { ... }, 'name2' => sub { ... });
3563 =head2 renderer_list
3565 =head2 op_renderer_list
3567 =head2 clause_renderer_list
3569 my @names = $sqla->renderer_list;
3571 =head2 wrap_renderer
3573 =head2 wrap_renderers
3575 =head2 wrap_op_renderer
3577 =head2 wrap_op_renderers
3579 =head2 wrap_clause_renderer
3581 =head2 wrap_clause_renderers
3583 $sqla->wrap_renderer('name' => sub { my ($orig) = @_; sub { ... } });
3584 $sqla->wrap_renderers(
3585 'name1' => sub { my ($orig1) = @_; sub { ... } },
3586 'name2' => sub { my ($orig2) = @_; sub { ... } },
3591 my @clauses = $sqla->clauses_of('select');
3592 $sqla->clauses_of(select => \@new_clauses);
3593 $sqla->clauses_of(select => sub {
3594 my (undef, @old_clauses) = @_;
3596 return @new_clauses;
3599 =head2 statement_list
3601 my @list = $sqla->statement_list;
3603 =head2 make_unop_expander
3605 my $exp = $sqla->make_unop_expander(sub { ... });
3607 If the op is found as a binop, assumes it wants a default comparison, so
3608 the inner expander sub can reliably operate as
3610 sub { my ($self, $name, $body) = @_; ... }
3612 =head2 make_binop_expander
3614 my $exp = $sqla->make_binop_expander(sub { ... });
3616 If the op is found as a unop, assumes the value will be an arrayref with the
3617 LHS as the first entry, and converts that to an ident node if it's a simple
3618 scalar. So the inner expander sub looks like
3621 my ($self, $name, $body, $k) = @_;
3622 { -blah => [ map $self->expand_expr($_), $k, $body ] }
3625 =head2 unop_expander
3627 =head2 unop_expanders
3629 =head2 binop_expander
3631 =head2 binop_expanders
3633 The above methods operate exactly like the op_ versions but wrap the coderef
3634 using the appropriate make_ method first.
3638 Thanks to some benchmarking by Mark Stosberg, it turns out that
3639 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3640 I must admit this wasn't an intentional design issue, but it's a
3641 byproduct of the fact that you get to control your C<DBI> handles
3644 To maximize performance, use a code snippet like the following:
3646 # prepare a statement handle using the first row
3647 # and then reuse it for the rest of the rows
3649 for my $href (@array_of_hashrefs) {
3650 $stmt ||= $sql->insert('table', $href);
3651 $sth ||= $dbh->prepare($stmt);
3652 $sth->execute($sql->values($href));
3655 The reason this works is because the keys in your C<$href> are sorted
3656 internally by B<SQL::Abstract>. Thus, as long as your data retains
3657 the same structure, you only have to generate the SQL the first time
3658 around. On subsequent queries, simply use the C<values> function provided
3659 by this module to return your values in the correct order.
3661 However this depends on the values having the same type - if, for
3662 example, the values of a where clause may either have values
3663 (resulting in sql of the form C<column = ?> with a single bind
3664 value), or alternatively the values might be C<undef> (resulting in
3665 sql of the form C<column IS NULL> with no bind value) then the
3666 caching technique suggested will not work.
3670 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3671 really like this part (I do, at least). Building up a complex query
3672 can be as simple as the following:
3679 use CGI::FormBuilder;
3682 my $form = CGI::FormBuilder->new(...);
3683 my $sql = SQL::Abstract->new;
3685 if ($form->submitted) {
3686 my $field = $form->field;
3687 my $id = delete $field->{id};
3688 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3691 Of course, you would still have to connect using C<DBI> to run the
3692 query, but the point is that if you make your form look like your
3693 table, the actual query script can be extremely simplistic.
3695 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3696 a fast interface to returning and formatting data. I frequently
3697 use these three modules together to write complex database query
3698 apps in under 50 lines.
3700 =head1 HOW TO CONTRIBUTE
3702 Contributions are always welcome, in all usable forms (we especially
3703 welcome documentation improvements). The delivery methods include git-
3704 or unified-diff formatted patches, GitHub pull requests, or plain bug
3705 reports either via RT or the Mailing list. Contributors are generally
3706 granted full access to the official repository after their first several
3707 patches pass successful review.
3709 This project is maintained in a git repository. The code and related tools are
3710 accessible at the following locations:
3714 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3716 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3718 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3720 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3726 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3727 Great care has been taken to preserve the I<published> behavior
3728 documented in previous versions in the 1.* family; however,
3729 some features that were previously undocumented, or behaved
3730 differently from the documentation, had to be changed in order
3731 to clarify the semantics. Hence, client code that was relying
3732 on some dark areas of C<SQL::Abstract> v1.*
3733 B<might behave differently> in v1.50.
3735 The main changes are:
3741 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3745 support for the { operator => \"..." } construct (to embed literal SQL)
3749 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3753 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3757 defensive programming: check arguments
3761 fixed bug with global logic, which was previously implemented
3762 through global variables yielding side-effects. Prior versions would
3763 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3764 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3765 Now this is interpreted
3766 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3771 fixed semantics of _bindtype on array args
3775 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3776 we just avoid shifting arrays within that tree.
3780 dropped the C<_modlogic> function
3784 =head1 ACKNOWLEDGEMENTS
3786 There are a number of individuals that have really helped out with
3787 this module. Unfortunately, most of them submitted bugs via CPAN
3788 so I have no idea who they are! But the people I do know are:
3790 Ash Berlin (order_by hash term support)
3791 Matt Trout (DBIx::Class support)
3792 Mark Stosberg (benchmarking)
3793 Chas Owens (initial "IN" operator support)
3794 Philip Collins (per-field SQL functions)
3795 Eric Kolve (hashref "AND" support)
3796 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3797 Dan Kubb (support for "quote_char" and "name_sep")
3798 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3799 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3800 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3801 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3802 Oliver Charles (support for "RETURNING" after "INSERT")
3808 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3812 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3814 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3816 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3817 While not an official support venue, C<DBIx::Class> makes heavy use of
3818 C<SQL::Abstract>, and as such list members there are very familiar with
3819 how to create queries.
3823 This module is free software; you may copy this under the same
3824 terms as perl itself (either the GNU General Public License or
3825 the Artistic License)