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.86';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
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 foreach my $type (qw(
332 expand op_expand render op_render clause_expand clause_render
334 my $name = join '_', reverse split '_', $type;
335 my $singular = "${type}er";
337 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
338 or die "Method builder failed for ${singular}: $@";
339 eval qq{sub wrap_${singular} {
340 shift->wrap_${singular}s(\@_)
341 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
343 eval qq{sub ${singular}s {
344 my (\$self, \@args) = \@_;
345 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
346 \$self->_ext_rw('${name}', \$this_key, \$this_value);
349 }; 1 } or die "Method builder failed for ${singular}s: $@";
350 eval qq{sub wrap_${singular}s {
351 my (\$self, \@args) = \@_;
352 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
353 my \$orig = \$self->_ext_rw('${name}', \$this_key);
355 '${name}', \$this_key,
356 \$this_builder->(\$orig, '${name}', \$this_key),
360 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
361 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
362 or die "Method builder failed for ${singular}_list: $@";
364 foreach my $singular (qw(unop_expander binop_expander)) {
365 eval qq{sub ${singular} { shift->${singular}s(\@_) }; 1 }
366 or die "Method builder failed for ${singular}: $@";
367 eval qq{sub ${singular}s {
368 my (\$self, \@args) = \@_;
369 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
371 expand_op => \$this_key,
372 \$self->make_${singular}(\$this_value),
376 }; 1 } or die "Method builder failed for ${singular}s: $@";
380 #sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
382 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
385 my ($self, $of, @clauses) = @_;
387 return @{$self->{clauses_of}{$of}||[]};
389 if (ref($clauses[0]) eq 'CODE') {
390 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
392 $self->{clauses_of}{$of} = \@clauses;
401 ref($self->{$_}) eq 'HASH'
410 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
411 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
413 sub _assert_pass_injection_guard {
414 if ($_[1] =~ $_[0]->{injection_guard}) {
415 my $class = ref $_[0];
416 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
417 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
418 . "{injection_guard} attribute to ${class}->new()"
423 #======================================================================
425 #======================================================================
428 my ($self, $table, $data, $options) = @_;
431 if (ref($table) eq 'HASH') {
434 my %clauses = (target => $table, values => $data, %{$options||{}});
438 my @rendered = $self->render_statement({ -insert => $stmt });
439 return wantarray ? @rendered : $rendered[0];
442 sub _expand_insert_clause_target {
443 +(target => $_[0]->expand_expr($_[2], -ident));
446 sub _expand_insert_clause_fields {
448 $_[0]->expand_expr({ -list => $_[2] }, -ident)
449 ] } if ref($_[2]) eq 'ARRAY';
450 return $_[2]; # should maybe still expand somewhat?
453 sub _expand_insert_clause_from {
454 my ($self, undef, $data) = @_;
455 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
456 return $self->expand_expr($data);
458 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
460 from => { -values => [ $v_aqt ] },
461 ($f_aqt ? (fields => $f_aqt) : ()),
465 sub _expand_insert_clause_returning {
466 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
469 sub _expand_insert_values {
470 my ($self, $data) = @_;
471 if (is_literal_value($data)) {
472 (undef, $self->expand_expr($data));
474 my ($fields, $values) = (
475 ref($data) eq 'HASH' ?
476 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
480 # no names (arrayref) means can't generate bindtype
481 !($fields) && $self->{bindtype} eq 'columns'
482 && belch "can't do 'columns' bindtype when called with arrayref";
486 ? $self->expand_expr({ -row => $fields }, -ident)
491 local our $Cur_Col_Meta = $fields->[$_];
492 $self->_expand_insert_value($values->[$_])
499 sub _render_insert_clause_fields {
500 return $_[0]->render_aqt($_[2]);
503 sub _render_insert_clause_target {
504 my ($self, undef, $from) = @_;
505 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
508 sub _render_insert_clause_from {
509 return $_[0]->render_aqt($_[2], 1);
512 # So that subclasses can override INSERT ... RETURNING separately from
513 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
514 sub _insert_returning { shift->_returning(@_) }
516 sub _redispatch_returning {
517 my ($self, $type, undef, $returning) = @_;
518 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
522 my ($self, $options) = @_;
524 my $f = $options->{returning};
526 my ($sql, @bind) = @{ $self->render_aqt(
527 $self->expand_expr({ -list => $f }, -ident)
529 return ($self->_sqlcase(' returning ').$sql, @bind);
532 sub _expand_insert_value {
535 my $k = our $Cur_Col_Meta;
537 if (ref($v) eq 'ARRAY') {
538 if ($self->{array_datatypes}) {
539 return +{ -bind => [ $k, $v ] };
541 my ($sql, @bind) = @$v;
542 $self->_assert_bindval_matches_bindtype(@bind);
543 return +{ -literal => $v };
545 if (ref($v) eq 'HASH') {
546 if (grep !/^-/, keys %$v) {
547 belch "HASH ref as bind value in insert is not supported";
548 return +{ -bind => [ $k, $v ] };
552 return +{ -bind => [ $k, undef ] };
554 return $self->expand_expr($v);
559 #======================================================================
561 #======================================================================
564 my ($self, $table, $set, $where, $options) = @_;
567 if (ref($table) eq 'HASH') {
571 @clauses{qw(target set where)} = ($table, $set, $where);
572 puke "Unsupported data type specified to \$sql->update"
573 unless ref($clauses{set}) eq 'HASH';
574 @clauses{keys %$options} = values %$options;
578 my @rendered = $self->render_statement({ -update => $stmt });
579 return wantarray ? @rendered : $rendered[0];
582 sub _render_update_clause_target {
583 my ($self, undef, $target) = @_;
584 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
587 sub _update_set_values {
588 my ($self, $data) = @_;
590 return @{ $self->render_aqt(
591 $self->_expand_update_set_values(undef, $data),
595 sub _expand_update_set_values {
596 my ($self, undef, $data) = @_;
597 $self->expand_expr({ -list => [
600 $set = { -bind => $_ } unless defined $set;
601 +{ -op => [ '=', { -ident => $k }, $set ] };
607 ? ($self->{array_datatypes}
608 ? [ $k, +{ -bind => [ $k, $v ] } ]
609 : [ $k, +{ -literal => $v } ])
611 local our $Cur_Col_Meta = $k;
612 [ $k, $self->_expand_expr($v) ]
619 sub _expand_update_clause_target {
620 my ($self, undef, $target) = @_;
621 +(target => $self->expand_expr({ -list => $target }, -ident));
624 sub _expand_update_clause_set {
625 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
626 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
629 sub _expand_update_clause_where {
630 +(where => $_[0]->expand_expr($_[2]));
633 sub _expand_update_clause_returning {
634 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
637 # So that subclasses can override UPDATE ... RETURNING separately from
639 sub _update_returning { shift->_returning(@_) }
643 #======================================================================
645 #======================================================================
648 my ($self, @args) = @_;
650 if (ref(my $sel = $args[0]) eq 'HASH') {
654 @clauses{qw(from select where order_by)} = @args;
656 # This oddity is to literalify since historically SQLA doesn't quote
657 # a single identifier argument, so we convert it into a literal
659 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
660 unless ref($clauses{select});
665 my @rendered = $self->render_statement({ -select => $stmt });
666 return wantarray ? @rendered : $rendered[0];
669 sub _expand_select_clause_select {
670 my ($self, undef, $select) = @_;
671 +(select => $self->expand_expr({ -list => $select }, -ident));
674 sub _expand_select_clause_from {
675 my ($self, undef, $from) = @_;
676 +(from => $self->expand_expr({ -list => $from }, -ident));
679 sub _expand_select_clause_where {
680 my ($self, undef, $where) = @_;
683 if (my $conv = $self->{convert}) {
695 ->wrap_expander(bind => $_wrap)
696 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
697 ->wrap_expander(func => sub {
700 my ($self, $type, $thing) = @_;
701 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
702 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
705 or $thing->[1]{-value}
706 or $thing->[1]{-bind})
708 return { -func => $thing }; # already went through our expander
710 return $self->$orig($type, $thing);
718 return +(where => $sqla->expand_expr($where));
721 sub _expand_select_clause_order_by {
722 my ($self, undef, $order_by) = @_;
723 +(order_by => $self->_expand_order_by($order_by));
727 my ($self, $fields) = @_;
728 return $fields unless ref($fields);
729 return @{ $self->render_aqt(
730 $self->expand_expr({ -list => $fields }, '-ident')
734 #======================================================================
736 #======================================================================
739 my ($self, $table, $where, $options) = @_;
742 if (ref($table) eq 'HASH') {
745 my %clauses = (target => $table, where => $where, %{$options||{}});
749 my @rendered = $self->render_statement({ -delete => $stmt });
750 return wantarray ? @rendered : $rendered[0];
753 # So that subclasses can override DELETE ... RETURNING separately from
755 sub _delete_returning { shift->_returning(@_) }
757 sub _expand_delete_clause_target {
758 +(target => $_[0]->expand_expr({ -list => $_[2] }, -ident));
761 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
763 sub _expand_delete_clause_returning {
764 +(returning => $_[0]->expand_expr({ -list => $_[2] }, -ident));
767 sub _render_delete_clause_target {
768 my ($self, undef, $from) = @_;
769 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
772 #======================================================================
774 #======================================================================
778 # Finally, a separate routine just to handle WHERE clauses
780 my ($self, $where, $order) = @_;
782 local $self->{convert_where} = $self->{convert};
785 my ($sql, @bind) = defined($where)
786 ? $self->_recurse_where($where)
788 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
792 my ($order_sql, @order_bind) = $self->_order_by($order);
794 push @bind, @order_bind;
797 return wantarray ? ($sql, @bind) : $sql;
800 { our $Default_Scalar_To = -value }
803 my ($self, $expr, $default_scalar_to) = @_;
804 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
805 $self->_expand_expr($expr);
809 my ($self, $aqt, $top_level) = @_;
810 my ($k, $v, @rest) = %$aqt;
812 die "Not a node type: $k" unless $k =~ s/^-//;
813 if (my $meth = $self->{render}{$k}) {
814 local our $Render_Top_Level = $top_level;
815 return $self->$meth($k, $v);
817 die "notreached: $k";
821 my ($self, $expr, $default_scalar_to) = @_;
822 return @{ $self->render_aqt(
823 $self->expand_expr($expr, $default_scalar_to)
827 sub render_statement {
828 my ($self, $expr, $default_scalar_to) = @_;
830 $self->expand_expr($expr, $default_scalar_to), 1
834 sub _expand_statement {
835 my ($self, $type, $args) = @_;
836 my $ec = $self->{expand_clause};
839 $args->{$type} = delete $args->{_}
841 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
842 return +{ "-${type}" => +{
844 my $val = $args->{$_};
845 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
846 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
851 } elsif ($has_clause{$_}) {
852 ($_ => $self->expand_expr($val))
860 sub _render_statement {
861 my ($self, $type, $args) = @_;
863 foreach my $clause (@{$self->{clauses_of}{$type}}) {
864 next unless my $clause_expr = $args->{$clause};
866 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
867 $self->$rdr($clause, $clause_expr, $args);
869 my $r = $self->render_aqt($clause_expr, 1);
870 next unless defined $r->[0] and length $r->[0];
871 $self->join_query_parts(' ',
872 { -keyword => $clause },
879 my $q = $self->join_query_parts(' ', @parts);
880 return $self->join_query_parts('',
881 (our $Render_Top_Level ? $q : ('(', $q, ')'))
886 my ($self, $raw) = @_;
888 return $op if grep $_->{$op}, @{$self}{qw(expand_op render_op)};
889 s/^-(?=.)//, s/\s+/_/g for $op;
894 my ($self, $expr) = @_;
895 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
896 return undef unless defined($expr);
897 if (ref($expr) eq 'HASH') {
898 return undef unless my $kc = keys %$expr;
900 return $self->_expand_op_andor(and => $expr);
902 my ($key, $value) = %$expr;
903 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
904 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
905 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
907 return $self->_expand_hashpair($key, $value);
909 if (ref($expr) eq 'ARRAY') {
910 return $self->_expand_op_andor(lc($self->{logic}), $expr);
912 if (my $literal = is_literal_value($expr)) {
913 return +{ -literal => $literal };
915 if (!ref($expr) or Scalar::Util::blessed($expr)) {
916 return $self->_expand_scalar($expr);
921 sub _expand_hashpair {
922 my ($self, $k, $v) = @_;
923 unless (defined($k) and length($k)) {
924 if (defined($k) and my $literal = is_literal_value($v)) {
925 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
926 return { -literal => $literal };
928 puke "Supplying an empty left hand side argument is not supported";
931 return $self->_expand_hashpair_op($k, $v);
932 } elsif ($k =~ /^[^\w]/i) {
933 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
934 return $self->_expand_op(
935 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
938 return $self->_expand_hashpair_ident($k, $v);
941 sub _expand_hashpair_ident {
942 my ($self, $k, $v) = @_;
944 local our $Cur_Col_Meta = $k;
946 # hash with multiple or no elements is andor
948 if (ref($v) eq 'HASH' and keys %$v != 1) {
949 return $self->_expand_op_andor(and => $v, $k);
952 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
954 if (is_undef_value($v)) {
955 return $self->_expand_hashpair_cmp($k => undef);
958 # scalars and objects get expanded as whatever requested or values
960 if (!ref($v) or Scalar::Util::blessed($v)) {
961 return $self->_expand_hashpair_scalar($k, $v);
964 # single key hashref is a hashtriple
966 if (ref($v) eq 'HASH') {
967 return $self->_expand_hashtriple($k, %$v);
970 # arrayref needs re-engineering over the elements
972 if (ref($v) eq 'ARRAY') {
973 return $self->sqlfalse unless @$v;
974 $self->_debug("ARRAY($k) means distribute over elements");
976 $v->[0] =~ /^-(and|or)$/i
977 ? (shift(@{$v = [ @$v ]}), $1)
978 : lc($self->{logic} || 'OR')
980 return $self->_expand_op_andor(
985 if (my $literal = is_literal_value($v)) {
987 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
990 my ($sql, @bind) = @$literal;
991 if ($self->{bindtype} eq 'columns') {
993 $self->_assert_bindval_matches_bindtype($_);
996 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
1001 sub _expand_scalar {
1002 my ($self, $expr) = @_;
1004 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
1007 sub _expand_hashpair_scalar {
1008 my ($self, $k, $v) = @_;
1010 return $self->_expand_hashpair_cmp(
1011 $k, $self->_expand_scalar($v),
1015 sub _expand_hashpair_op {
1016 my ($self, $k, $v) = @_;
1018 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
1020 my $op = $self->_normalize_op($k);
1022 my $wsop = join(' ', split '_', $op);
1024 my $is_special = List::Util::first { $wsop =~ $_->{regex} }
1025 @{$self->{special_ops}};
1029 # the old special op system requires illegality for top-level use
1032 (our $Expand_Depth) == 1
1036 $self->{disable_old_special_ops}
1037 and List::Util::first { $wsop =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1041 puke "Illegal use of top-level '-$wsop'"
1045 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1046 return $self->$exp($op, $v);
1049 if ($self->{render}{$op}) {
1050 return { "-${op}" => $v };
1053 # Ops prefixed with -not_ get converted
1055 if (my ($rest) = $op =~/^not_(.*)$/) {
1058 $self->_expand_expr({ "-${rest}", $v })
1064 # the old unary op system means we should touch nothing and let it work
1066 my $op = join(' ', split '_', $op);
1068 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1069 return { -op => [ $op, $v ] };
1073 my $type = $is_special || $self->{render_op}{$op} ? -op : -func;
1075 if ($self->{restore_old_unop_handling}) {
1082 and (keys %$v)[0] =~ /^-/
1083 and not $self->{render_op}{$op}
1092 if ($type eq -func and ref($v) eq 'ARRAY') {
1093 return $self->_expand_expr({ -func => [ $op, @$v ] });
1096 return $self->_expand_expr({ $type => [ $op, $v ] });
1099 sub _expand_hashpair_cmp {
1100 my ($self, $k, $v) = @_;
1101 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1104 sub _expand_hashtriple {
1105 my ($self, $k, $vk, $vv) = @_;
1107 my $ik = $self->_expand_expr({ -ident => $k });
1109 my $op = $self->_normalize_op($vk);
1110 $self->_assert_pass_injection_guard($op);
1112 if ($op =~ s/ _? \d+ $//x ) {
1113 return $self->_expand_expr($k, { $vk, $vv });
1115 if (my $x = $self->{expand_op}{$op}) {
1116 local our $Cur_Col_Meta = $k;
1117 return $self->$x($op, $vv, $k);
1121 my $op = join(' ', split '_', $op);
1123 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1124 return { -op => [ $op, $ik, $vv ] };
1126 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1130 { -op => [ $op, $vv ] }
1134 if (ref($vv) eq 'ARRAY') {
1136 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1137 ? (shift(@raw), lc $1) : 'or';
1138 my @values = map +{ $vk => $_ }, @raw;
1140 $op =~ $self->{inequality_op}
1141 or $op =~ $self->{not_like_op}
1143 if (lc($logic) eq 'or' and @values > 1) {
1144 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1145 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1146 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1151 # try to DWIM on equality operators
1152 return ($self->_dwim_op_to_is($op,
1153 "Supplying an empty arrayref to '%s' is deprecated",
1154 "operator '%s' applied on an empty array (field '$k')"
1155 ) ? $self->sqlfalse : $self->sqltrue);
1157 return $self->_expand_op_andor($logic => \@values, $k);
1159 if (is_undef_value($vv)) {
1160 my $is = ($self->_dwim_op_to_is($op,
1161 "Supplying an undefined argument to '%s' is deprecated",
1162 "unexpected operator '%s' with undef operand",
1163 ) ? 'is' : 'is not');
1165 return $self->_expand_hashpair($k => { $is, undef });
1167 local our $Cur_Col_Meta = $k;
1171 $self->_expand_expr($vv)
1175 sub _dwim_op_to_is {
1176 my ($self, $raw, $empty, $fail) = @_;
1178 my $op = $self->_normalize_op($raw);
1180 if ($op =~ /^not$/i) {
1183 if ($op =~ $self->{equality_op}) {
1186 if ($op =~ $self->{like_op}) {
1187 belch(sprintf $empty, uc(join ' ', split '_', $op));
1190 if ($op =~ $self->{inequality_op}) {
1193 if ($op =~ $self->{not_like_op}) {
1194 belch(sprintf $empty, uc(join ' ', split '_', $op));
1197 puke(sprintf $fail, $op);
1201 my ($self, undef, $args) = @_;
1202 my ($func, @args) = @$args;
1203 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1207 my ($self, undef, $body) = @_;
1208 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1209 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1211 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1212 ref($body) ? @$body : $body;
1213 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1214 unless ($self->{quote_char}) {
1215 $self->_assert_pass_injection_guard($_) for @parts;
1217 return +{ -ident => \@parts };
1221 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1225 my ($self, undef, $args) = @_;
1226 +{ -row => [ map $self->expand_expr($_), @$args ] };
1230 my ($self, undef, $args) = @_;
1231 my ($op, @opargs) = @$args;
1232 if (my $exp = $self->{expand_op}{$op}) {
1233 return $self->$exp($op, \@opargs);
1235 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1239 my ($self, undef, $v) = @_;
1241 return $self->_expand_expr($v);
1243 puke "-bool => undef not supported" unless defined($v);
1244 return $self->_expand_expr({ -ident => $v });
1248 my ($self, undef, $expr) = @_;
1250 ',', map $self->expand_expr($_),
1251 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1252 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1253 return +{ -op => [ ',',
1254 map $self->expand_expr($_),
1255 ref($expr) eq 'ARRAY' ? @$expr : $expr
1259 sub _expand_op_andor {
1260 my ($self, $logop, $v, $k) = @_;
1262 $v = [ map +{ $k, $_ },
1264 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1268 if (ref($v) eq 'HASH') {
1269 return undef unless keys %$v;
1272 map $self->_expand_expr({ $_ => $v->{$_} }),
1276 if (ref($v) eq 'ARRAY') {
1277 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1280 (ref($_) eq 'ARRAY' and @$_)
1281 or (ref($_) eq 'HASH' and %$_)
1287 while (my ($el) = splice @expr, 0, 1) {
1288 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1289 unless defined($el) and length($el);
1290 my $elref = ref($el);
1292 local our $Expand_Depth = 0;
1293 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1294 } elsif ($elref eq 'ARRAY') {
1295 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1296 } elsif (my $l = is_literal_value($el)) {
1297 push @res, { -literal => $l };
1298 } elsif ($elref eq 'HASH') {
1299 local our $Expand_Depth = 0;
1300 push @res, grep defined, $self->_expand_expr($el) if %$el;
1306 # return $res[0] if @res == 1;
1307 return { -op => [ $logop, @res ] };
1313 my ($self, $op, $vv, $k) = @_;
1314 ($k, $vv) = @$vv unless defined $k;
1315 puke "$op can only take undef as argument"
1319 and exists($vv->{-value})
1320 and !defined($vv->{-value})
1322 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1325 sub _expand_between {
1326 my ($self, $op, $vv, $k) = @_;
1327 my @rhs = map $self->_expand_expr($_),
1328 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1330 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1332 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1334 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1338 $self->expand_expr($k),
1339 map $self->expand_expr($_, -value), @rhs
1344 my ($self, $op, $vv, $k) = @_;
1345 if (my $literal = is_literal_value($vv)) {
1346 my ($sql, @bind) = @$literal;
1347 my $opened_sql = $self->_open_outer_paren($sql);
1349 $op, $self->expand_expr($k, -ident),
1350 { -literal => [ $opened_sql, @bind ] }
1354 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1355 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1356 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1357 . 'will emit the logically correct SQL instead of raising this exception)'
1359 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1361 my @rhs = map $self->expand_expr($_, -value),
1362 map { defined($_) ? $_: puke($undef_err) }
1363 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1364 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1368 $self->expand_expr($k, -ident),
1374 my ($self, undef, $v) = @_;
1375 # DBIx::Class requires a nest warning to be emitted once but the private
1376 # method it overrode to do so no longer exists
1377 if ($self->{warn_once_on_nest}) {
1378 unless (our $Nest_Warned) {
1380 "-nest in search conditions is deprecated, you most probably wanted:\n"
1381 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1386 return $self->_expand_expr($v);
1389 sub _expand_values {
1390 my ($self, undef, $values) = @_;
1391 return { -values => [
1394 ? $self->expand_expr($_)
1395 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1396 ), ref($values) eq 'ARRAY' ? @$values : $values
1400 sub _recurse_where {
1401 my ($self, $where) = @_;
1403 # Special case: top level simple string treated as literal
1405 my $where_exp = (ref($where)
1406 ? $self->_expand_select_clause_where(undef, $where)
1407 : { -literal => [ $where ] });
1409 # dispatch expanded expression
1411 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1412 # DBIx::Class used to call _recurse_where in scalar context
1413 # something else might too...
1415 return ($sql, @bind);
1418 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1424 my ($self, undef, $ident) = @_;
1426 return [ $self->_quote($ident) ];
1430 my ($self, undef, $values) = @_;
1431 return $self->join_query_parts('',
1433 $self->_render_op(undef, [ ',', @$values ]),
1439 my ($self, undef, $rest) = @_;
1440 my ($func, @args) = @$rest;
1441 return $self->join_query_parts('',
1442 $self->_sqlcase($func),
1443 $self->join_query_parts('',
1445 $self->join_query_parts(', ', @args),
1452 my ($self, undef, $bind) = @_;
1453 return [ '?', $self->_bindtype(@$bind) ];
1456 sub _render_literal {
1457 my ($self, undef, $literal) = @_;
1458 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1462 sub _render_keyword {
1463 my ($self, undef, $keyword) = @_;
1464 return [ $self->_sqlcase(
1465 ref($keyword) ? $$keyword : join ' ', split '_', $keyword
1470 my ($self, undef, $v) = @_;
1471 my ($op, @args) = @$v;
1472 if (my $r = $self->{render_op}{$op}) {
1473 return $self->$r($op, \@args);
1478 my $op = join(' ', split '_', $op);
1480 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1481 if ($ss and @args > 1) {
1482 puke "Special op '${op}' requires first value to be identifier"
1483 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1484 my $k = join(($self->{name_sep}||'.'), @$ident);
1485 local our $Expand_Depth = 1;
1486 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1488 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1489 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1492 return $self->_render_unop_paren($op, \@args);
1496 return $self->_render_unop_prefix($op, \@args);
1498 return $self->_render_op_multop($op, \@args);
1504 sub _render_op_between {
1505 my ($self, $op, $args) = @_;
1506 my ($left, $low, $high) = @$args;
1509 puke "Single arg to between must be a literal"
1510 unless $low->{-literal};
1513 +($low, { -keyword => 'and' }, $high);
1516 return $self->join_query_parts(' ',
1517 '(', $left, { -keyword => $op }, @rh, ')',
1522 my ($self, $op, $args) = @_;
1523 my ($lhs, @rhs) = @$args;
1525 return $self->join_query_parts(' ',
1527 { -keyword => $op },
1528 $self->join_query_parts(' ',
1530 $self->join_query_parts(', ', @rhs),
1536 sub _render_op_andor {
1537 my ($self, $op, $args) = @_;
1538 return undef unless @$args;
1539 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1540 my $inner = $self->_render_op_multop($op, $args);
1541 return undef unless defined($inner->[0]) and length($inner->[0]);
1542 return $self->join_query_parts(' ',
1547 sub _render_op_multop {
1548 my ($self, $op, $args) = @_;
1550 return undef unless @parts;
1551 return $self->render_aqt($parts[0]) if @parts == 1;
1552 my $join = ($op eq ','
1554 : { -keyword => " ${op} " }
1556 return $self->join_query_parts($join, @parts);
1559 sub _render_values {
1560 my ($self, undef, $values) = @_;
1561 my $inner = $self->join_query_parts(' ',
1562 { -keyword => 'values' },
1563 $self->join_query_parts(', ',
1564 ref($values) eq 'ARRAY' ? @$values : $values
1567 return $self->join_query_parts('',
1568 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1572 sub join_query_parts {
1573 my ($self, $join, @parts) = @_;
1574 if (ref($join) eq 'HASH') {
1575 $join = $self->render_aqt($join)->[0];
1579 ? $self->render_aqt($_)
1580 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1583 $self->{join_sql_parts}->(
1584 $join, grep defined && length, map $_->[0], @final
1586 (map @{$_}[1..$#$_], @final),
1590 sub _render_unop_paren {
1591 my ($self, $op, $v) = @_;
1592 return $self->join_query_parts('',
1593 '(', $self->_render_unop_prefix($op, $v), ')'
1597 sub _render_unop_prefix {
1598 my ($self, $op, $v) = @_;
1599 my $op_sql = $self->{restore_old_unop_handling}
1600 ? $self->_sqlcase($op)
1601 : { -keyword => $op };
1602 return $self->join_query_parts(' ',
1603 ($self->{restore_old_unop_handling}
1604 ? $self->_sqlcase($op)
1605 : { -keyword => \$op }),
1610 sub _render_unop_postfix {
1611 my ($self, $op, $v) = @_;
1612 return $self->join_query_parts(' ',
1613 $v->[0], { -keyword => $op },
1617 # Some databases (SQLite) treat col IN (1, 2) different from
1618 # col IN ( (1, 2) ). Use this to strip all outer parens while
1619 # adding them back in the corresponding method
1620 sub _open_outer_paren {
1621 my ($self, $sql) = @_;
1623 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1625 # there are closing parens inside, need the heavy duty machinery
1626 # to reevaluate the extraction starting from $sql (full reevaluation)
1627 if ($inner =~ /\)/) {
1628 require Text::Balanced;
1630 my (undef, $remainder) = do {
1631 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1633 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1636 # the entire expression needs to be a balanced bracketed thing
1637 # (after an extract no remainder sans trailing space)
1638 last if defined $remainder and $remainder =~ /\S/;
1648 #======================================================================
1650 #======================================================================
1652 sub _expand_order_by {
1653 my ($self, $arg) = @_;
1655 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1657 return $self->expand_expr({ -list => $arg })
1658 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1660 my $expander = sub {
1661 my ($self, $dir, $expr) = @_;
1662 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1663 foreach my $arg (@to_expand) {
1667 and grep /^-(asc|desc)$/, keys %$arg
1669 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1673 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1675 map $self->expand_expr($_, -ident),
1676 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1677 return undef unless @exp;
1678 return undef if @exp == 1 and not defined($exp[0]);
1679 return +{ -op => [ ',', @exp ] };
1682 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1684 return $self->$expander(undef, $arg);
1688 my ($self, $arg) = @_;
1690 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1692 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1694 return '' unless length($sql);
1696 my $final_sql = $self->_sqlcase(' order by ').$sql;
1698 return ($final_sql, @bind);
1701 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1703 sub _order_by_chunks {
1704 my ($self, $arg) = @_;
1706 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1708 my @res = $self->_chunkify_order_by($expanded);
1709 (ref() ? $_->[0] : $_) .= '' for @res;
1713 sub _chunkify_order_by {
1714 my ($self, $expanded) = @_;
1716 return grep length, @{ $self->render_aqt($expanded) }
1717 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1720 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1721 my ($comma, @list) = @{$_->{-op}};
1722 return map $self->_chunkify_order_by($_), @list;
1724 return $self->render_aqt($_);
1728 #======================================================================
1729 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1730 #======================================================================
1736 $self->expand_expr({ -list => $from }, -ident)
1741 #======================================================================
1743 #======================================================================
1745 # highly optimized, as it's called way too often
1747 # my ($self, $label) = @_;
1749 return '' unless defined $_[1];
1750 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1751 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1753 unless ($_[0]->{quote_char}) {
1754 if (ref($_[1]) eq 'ARRAY') {
1755 return join($_[0]->{name_sep}||'.', @{$_[1]});
1757 $_[0]->_assert_pass_injection_guard($_[1]);
1762 my $qref = ref $_[0]->{quote_char};
1764 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1765 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1766 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1768 my $esc = $_[0]->{escape_char} || $r;
1770 # parts containing * are naturally unquoted
1772 $_[0]->{name_sep}||'',
1776 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1778 (ref($_[1]) eq 'ARRAY'
1782 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1790 # Conversion, if applicable
1792 #my ($self, $arg) = @_;
1793 if (my $conv = $_[0]->{convert_where}) {
1794 return @{ $_[0]->join_query_parts('',
1795 $_[0]->_sqlcase($conv),
1804 #my ($self, $col, @vals) = @_;
1805 # called often - tighten code
1806 return $_[0]->{bindtype} eq 'columns'
1807 ? map {[$_[1], $_]} @_[2 .. $#_]
1812 # Dies if any element of @bind is not in [colname => value] format
1813 # if bindtype is 'columns'.
1814 sub _assert_bindval_matches_bindtype {
1815 # my ($self, @bind) = @_;
1817 if ($self->{bindtype} eq 'columns') {
1819 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1820 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1826 # Fix SQL case, if so requested
1828 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1829 # don't touch the argument ... crooked logic, but let's not change it!
1830 return $_[0]->{case} ? $_[1] : uc($_[1]);
1833 #======================================================================
1834 # DISPATCHING FROM REFKIND
1835 #======================================================================
1838 my ($self, $data) = @_;
1840 return 'UNDEF' unless defined $data;
1842 # blessed objects are treated like scalars
1843 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1845 return 'SCALAR' unless $ref;
1848 while ($ref eq 'REF') {
1850 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1854 return ($ref||'SCALAR') . ('REF' x $n_steps);
1858 my ($self, $data) = @_;
1859 my @try = ($self->_refkind($data));
1860 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1861 push @try, 'FALLBACK';
1865 sub _METHOD_FOR_refkind {
1866 my ($self, $meth_prefix, $data) = @_;
1869 for (@{$self->_try_refkind($data)}) {
1870 $method = $self->can($meth_prefix."_".$_)
1874 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1878 sub _SWITCH_refkind {
1879 my ($self, $data, $dispatch_table) = @_;
1882 for (@{$self->_try_refkind($data)}) {
1883 $coderef = $dispatch_table->{$_}
1887 puke "no dispatch entry for ".$self->_refkind($data)
1896 #======================================================================
1897 # VALUES, GENERATE, AUTOLOAD
1898 #======================================================================
1900 # LDNOTE: original code from nwiger, didn't touch code in that section
1901 # I feel the AUTOLOAD stuff should not be the default, it should
1902 # only be activated on explicit demand by user.
1906 my $data = shift || return;
1907 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1908 unless ref $data eq 'HASH';
1911 foreach my $k (sort keys %$data) {
1912 my $v = $data->{$k};
1913 $self->_SWITCH_refkind($v, {
1915 if ($self->{array_datatypes}) { # array datatype
1916 push @all_bind, $self->_bindtype($k, $v);
1918 else { # literal SQL with bind
1919 my ($sql, @bind) = @$v;
1920 $self->_assert_bindval_matches_bindtype(@bind);
1921 push @all_bind, @bind;
1924 ARRAYREFREF => sub { # literal SQL with bind
1925 my ($sql, @bind) = @${$v};
1926 $self->_assert_bindval_matches_bindtype(@bind);
1927 push @all_bind, @bind;
1929 SCALARREF => sub { # literal SQL without bind
1931 SCALAR_or_UNDEF => sub {
1932 push @all_bind, $self->_bindtype($k, $v);
1943 my(@sql, @sqlq, @sqlv);
1947 if ($ref eq 'HASH') {
1948 for my $k (sort keys %$_) {
1951 my $label = $self->_quote($k);
1952 if ($r eq 'ARRAY') {
1953 # literal SQL with bind
1954 my ($sql, @bind) = @$v;
1955 $self->_assert_bindval_matches_bindtype(@bind);
1956 push @sqlq, "$label = $sql";
1958 } elsif ($r eq 'SCALAR') {
1959 # literal SQL without bind
1960 push @sqlq, "$label = $$v";
1962 push @sqlq, "$label = ?";
1963 push @sqlv, $self->_bindtype($k, $v);
1966 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1967 } elsif ($ref eq 'ARRAY') {
1968 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1971 if ($r eq 'ARRAY') { # literal SQL with bind
1972 my ($sql, @bind) = @$v;
1973 $self->_assert_bindval_matches_bindtype(@bind);
1976 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1977 # embedded literal SQL
1984 push @sql, '(' . join(', ', @sqlq) . ')';
1985 } elsif ($ref eq 'SCALAR') {
1989 # strings get case twiddled
1990 push @sql, $self->_sqlcase($_);
1994 my $sql = join ' ', @sql;
1996 # this is pretty tricky
1997 # if ask for an array, return ($stmt, @bind)
1998 # otherwise, s/?/shift @sqlv/ to put it inline
2000 return ($sql, @sqlv);
2002 1 while $sql =~ s/\?/my $d = shift(@sqlv);
2003 ref $d ? $d->[1] : $d/e;
2012 # This allows us to check for a local, then _form, attr
2014 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2015 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2016 return $self->generate($name, @_);
2027 SQL::Abstract - Generate SQL from Perl data structures
2033 my $sql = SQL::Abstract->new;
2035 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2037 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2039 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2041 my($stmt, @bind) = $sql->delete($table, \%where);
2043 # Then, use these in your DBI statements
2044 my $sth = $dbh->prepare($stmt);
2045 $sth->execute(@bind);
2047 # Just generate the WHERE clause
2048 my($stmt, @bind) = $sql->where(\%where, $order);
2050 # Return values in the same order, for hashed queries
2051 # See PERFORMANCE section for more details
2052 my @bind = $sql->values(\%fieldvals);
2056 This module was inspired by the excellent L<DBIx::Abstract>.
2057 However, in using that module I found that what I really wanted
2058 to do was generate SQL, but still retain complete control over my
2059 statement handles and use the DBI interface. So, I set out to
2060 create an abstract SQL generation module.
2062 While based on the concepts used by L<DBIx::Abstract>, there are
2063 several important differences, especially when it comes to WHERE
2064 clauses. I have modified the concepts used to make the SQL easier
2065 to generate from Perl data structures and, IMO, more intuitive.
2066 The underlying idea is for this module to do what you mean, based
2067 on the data structures you provide it. The big advantage is that
2068 you don't have to modify your code every time your data changes,
2069 as this module figures it out.
2071 To begin with, an SQL INSERT is as easy as just specifying a hash
2072 of C<key=value> pairs:
2075 name => 'Jimbo Bobson',
2076 phone => '123-456-7890',
2077 address => '42 Sister Lane',
2078 city => 'St. Louis',
2079 state => 'Louisiana',
2082 The SQL can then be generated with this:
2084 my($stmt, @bind) = $sql->insert('people', \%data);
2086 Which would give you something like this:
2088 $stmt = "INSERT INTO people
2089 (address, city, name, phone, state)
2090 VALUES (?, ?, ?, ?, ?)";
2091 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2092 '123-456-7890', 'Louisiana');
2094 These are then used directly in your DBI code:
2096 my $sth = $dbh->prepare($stmt);
2097 $sth->execute(@bind);
2099 =head2 Inserting and Updating Arrays
2101 If your database has array types (like for example Postgres),
2102 activate the special option C<< array_datatypes => 1 >>
2103 when creating the C<SQL::Abstract> object.
2104 Then you may use an arrayref to insert and update database array types:
2106 my $sql = SQL::Abstract->new(array_datatypes => 1);
2108 planets => [qw/Mercury Venus Earth Mars/]
2111 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2115 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2117 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2120 =head2 Inserting and Updating SQL
2122 In order to apply SQL functions to elements of your C<%data> you may
2123 specify a reference to an arrayref for the given hash value. For example,
2124 if you need to execute the Oracle C<to_date> function on a value, you can
2125 say something like this:
2129 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2132 The first value in the array is the actual SQL. Any other values are
2133 optional and would be included in the bind values array. This gives
2136 my($stmt, @bind) = $sql->insert('people', \%data);
2138 $stmt = "INSERT INTO people (name, date_entered)
2139 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2140 @bind = ('Bill', '03/02/2003');
2142 An UPDATE is just as easy, all you change is the name of the function:
2144 my($stmt, @bind) = $sql->update('people', \%data);
2146 Notice that your C<%data> isn't touched; the module will generate
2147 the appropriately quirky SQL for you automatically. Usually you'll
2148 want to specify a WHERE clause for your UPDATE, though, which is
2149 where handling C<%where> hashes comes in handy...
2151 =head2 Complex where statements
2153 This module can generate pretty complicated WHERE statements
2154 easily. For example, simple C<key=value> pairs are taken to mean
2155 equality, and if you want to see if a field is within a set
2156 of values, you can use an arrayref. Let's say we wanted to
2157 SELECT some data based on this criteria:
2160 requestor => 'inna',
2161 worker => ['nwiger', 'rcwe', 'sfz'],
2162 status => { '!=', 'completed' }
2165 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2167 The above would give you something like this:
2169 $stmt = "SELECT * FROM tickets WHERE
2170 ( requestor = ? ) AND ( status != ? )
2171 AND ( worker = ? OR worker = ? OR worker = ? )";
2172 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2174 Which you could then use in DBI code like so:
2176 my $sth = $dbh->prepare($stmt);
2177 $sth->execute(@bind);
2183 The methods are simple. There's one for every major SQL operation,
2184 and a constructor you use first. The arguments are specified in a
2185 similar order for each method (table, then fields, then a where
2186 clause) to try and simplify things.
2188 =head2 new(option => 'value')
2190 The C<new()> function takes a list of options and values, and returns
2191 a new B<SQL::Abstract> object which can then be used to generate SQL
2192 through the methods below. The options accepted are:
2198 If set to 'lower', then SQL will be generated in all lowercase. By
2199 default SQL is generated in "textbook" case meaning something like:
2201 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2203 Any setting other than 'lower' is ignored.
2207 This determines what the default comparison operator is. By default
2208 it is C<=>, meaning that a hash like this:
2210 %where = (name => 'nwiger', email => 'nate@wiger.org');
2212 Will generate SQL like this:
2214 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2216 However, you may want loose comparisons by default, so if you set
2217 C<cmp> to C<like> you would get SQL such as:
2219 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2221 You can also override the comparison on an individual basis - see
2222 the huge section on L</"WHERE CLAUSES"> at the bottom.
2224 =item sqltrue, sqlfalse
2226 Expressions for inserting boolean values within SQL statements.
2227 By default these are C<1=1> and C<1=0>. They are used
2228 by the special operators C<-in> and C<-not_in> for generating
2229 correct SQL even when the argument is an empty array (see below).
2233 This determines the default logical operator for multiple WHERE
2234 statements in arrays or hashes. If absent, the default logic is "or"
2235 for arrays, and "and" for hashes. This means that a WHERE
2239 event_date => {'>=', '2/13/99'},
2240 event_date => {'<=', '4/24/03'},
2243 will generate SQL like this:
2245 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2247 This is probably not what you want given this query, though (look
2248 at the dates). To change the "OR" to an "AND", simply specify:
2250 my $sql = SQL::Abstract->new(logic => 'and');
2252 Which will change the above C<WHERE> to:
2254 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2256 The logic can also be changed locally by inserting
2257 a modifier in front of an arrayref:
2259 @where = (-and => [event_date => {'>=', '2/13/99'},
2260 event_date => {'<=', '4/24/03'} ]);
2262 See the L</"WHERE CLAUSES"> section for explanations.
2266 This will automatically convert comparisons using the specified SQL
2267 function for both column and value. This is mostly used with an argument
2268 of C<upper> or C<lower>, so that the SQL will have the effect of
2269 case-insensitive "searches". For example, this:
2271 $sql = SQL::Abstract->new(convert => 'upper');
2272 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2274 Will turn out the following SQL:
2276 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2278 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2279 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2280 not validate this option; it will just pass through what you specify verbatim).
2284 This is a kludge because many databases suck. For example, you can't
2285 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2286 Instead, you have to use C<bind_param()>:
2288 $sth->bind_param(1, 'reg data');
2289 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2291 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2292 which loses track of which field each slot refers to. Fear not.
2294 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2295 Currently, you can specify either C<normal> (default) or C<columns>. If you
2296 specify C<columns>, you will get an array that looks like this:
2298 my $sql = SQL::Abstract->new(bindtype => 'columns');
2299 my($stmt, @bind) = $sql->insert(...);
2302 [ 'column1', 'value1' ],
2303 [ 'column2', 'value2' ],
2304 [ 'column3', 'value3' ],
2307 You can then iterate through this manually, using DBI's C<bind_param()>.
2309 $sth->prepare($stmt);
2312 my($col, $data) = @$_;
2313 if ($col eq 'details' || $col eq 'comments') {
2314 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2315 } elsif ($col eq 'image') {
2316 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2318 $sth->bind_param($i, $data);
2322 $sth->execute; # execute without @bind now
2324 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2325 Basically, the advantage is still that you don't have to care which fields
2326 are or are not included. You could wrap that above C<for> loop in a simple
2327 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2328 get a layer of abstraction over manual SQL specification.
2330 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2331 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2332 will expect the bind values in this format.
2336 This is the character that a table or column name will be quoted
2337 with. By default this is an empty string, but you could set it to
2338 the character C<`>, to generate SQL like this:
2340 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2342 Alternatively, you can supply an array ref of two items, the first being the left
2343 hand quote character, and the second the right hand quote character. For
2344 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2345 that generates SQL like this:
2347 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2349 Quoting is useful if you have tables or columns names that are reserved
2350 words in your database's SQL dialect.
2354 This is the character that will be used to escape L</quote_char>s appearing
2355 in an identifier before it has been quoted.
2357 The parameter default in case of a single L</quote_char> character is the quote
2360 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2361 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2362 of the B<opening (left)> L</quote_char> within the identifier are currently left
2363 untouched. The default for opening-closing-style quotes may change in future
2364 versions, thus you are B<strongly encouraged> to specify the escape character
2369 This is the character that separates a table and column name. It is
2370 necessary to specify this when the C<quote_char> option is selected,
2371 so that tables and column names can be individually quoted like this:
2373 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2375 =item injection_guard
2377 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2378 column name specified in a query structure. This is a safety mechanism to avoid
2379 injection attacks when mishandling user input e.g.:
2381 my %condition_as_column_value_pairs = get_values_from_user();
2382 $sqla->select( ... , \%condition_as_column_value_pairs );
2384 If the expression matches an exception is thrown. Note that literal SQL
2385 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2387 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2389 =item array_datatypes
2391 When this option is true, arrayrefs in INSERT or UPDATE are
2392 interpreted as array datatypes and are passed directly
2394 When this option is false, arrayrefs are interpreted
2395 as literal SQL, just like refs to arrayrefs
2396 (but this behavior is for backwards compatibility; when writing
2397 new queries, use the "reference to arrayref" syntax
2403 Takes a reference to a list of "special operators"
2404 to extend the syntax understood by L<SQL::Abstract>.
2405 See section L</"SPECIAL OPERATORS"> for details.
2409 Takes a reference to a list of "unary operators"
2410 to extend the syntax understood by L<SQL::Abstract>.
2411 See section L</"UNARY OPERATORS"> for details.
2417 =head2 insert($table, \@values || \%fieldvals, \%options)
2419 This is the simplest function. You simply give it a table name
2420 and either an arrayref of values or hashref of field/value pairs.
2421 It returns an SQL INSERT statement and a list of bind values.
2422 See the sections on L</"Inserting and Updating Arrays"> and
2423 L</"Inserting and Updating SQL"> for information on how to insert
2424 with those data types.
2426 The optional C<\%options> hash reference may contain additional
2427 options to generate the insert SQL. Currently supported options
2434 Takes either a scalar of raw SQL fields, or an array reference of
2435 field names, and adds on an SQL C<RETURNING> statement at the end.
2436 This allows you to return data generated by the insert statement
2437 (such as row IDs) without performing another C<SELECT> statement.
2438 Note, however, this is not part of the SQL standard and may not
2439 be supported by all database engines.
2443 =head2 update($table, \%fieldvals, \%where, \%options)
2445 This takes a table, hashref of field/value pairs, and an optional
2446 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2448 See the sections on L</"Inserting and Updating Arrays"> and
2449 L</"Inserting and Updating SQL"> for information on how to insert
2450 with those data types.
2452 The optional C<\%options> hash reference may contain additional
2453 options to generate the update SQL. Currently supported options
2460 See the C<returning> option to
2461 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2465 =head2 select($source, $fields, $where, $order)
2467 This returns a SQL SELECT statement and associated list of bind values, as
2468 specified by the arguments:
2474 Specification of the 'FROM' part of the statement.
2475 The argument can be either a plain scalar (interpreted as a table
2476 name, will be quoted), or an arrayref (interpreted as a list
2477 of table names, joined by commas, quoted), or a scalarref
2478 (literal SQL, not quoted).
2482 Specification of the list of fields to retrieve from
2484 The argument can be either an arrayref (interpreted as a list
2485 of field names, will be joined by commas and quoted), or a
2486 plain scalar (literal SQL, not quoted).
2487 Please observe that this API is not as flexible as that of
2488 the first argument C<$source>, for backwards compatibility reasons.
2492 Optional argument to specify the WHERE part of the query.
2493 The argument is most often a hashref, but can also be
2494 an arrayref or plain scalar --
2495 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2499 Optional argument to specify the ORDER BY part of the query.
2500 The argument can be a scalar, a hashref or an arrayref
2501 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2507 =head2 delete($table, \%where, \%options)
2509 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2510 It returns an SQL DELETE statement and list of bind values.
2512 The optional C<\%options> hash reference may contain additional
2513 options to generate the delete SQL. Currently supported options
2520 See the C<returning> option to
2521 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2525 =head2 where(\%where, $order)
2527 This is used to generate just the WHERE clause. For example,
2528 if you have an arbitrary data structure and know what the
2529 rest of your SQL is going to look like, but want an easy way
2530 to produce a WHERE clause, use this. It returns an SQL WHERE
2531 clause and list of bind values.
2534 =head2 values(\%data)
2536 This just returns the values from the hash C<%data>, in the same
2537 order that would be returned from any of the other above queries.
2538 Using this allows you to markedly speed up your queries if you
2539 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2541 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2543 Warning: This is an experimental method and subject to change.
2545 This returns arbitrarily generated SQL. It's a really basic shortcut.
2546 It will return two different things, depending on return context:
2548 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2549 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2551 These would return the following:
2553 # First calling form
2554 $stmt = "CREATE TABLE test (?, ?)";
2555 @bind = (field1, field2);
2557 # Second calling form
2558 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2560 Depending on what you're trying to do, it's up to you to choose the correct
2561 format. In this example, the second form is what you would want.
2565 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2569 ALTER SESSION SET nls_date_format = 'MM/YY'
2571 You get the idea. Strings get their case twiddled, but everything
2572 else remains verbatim.
2574 =head1 EXPORTABLE FUNCTIONS
2576 =head2 is_plain_value
2578 Determines if the supplied argument is a plain value as understood by this
2583 =item * The value is C<undef>
2585 =item * The value is a non-reference
2587 =item * The value is an object with stringification overloading
2589 =item * The value is of the form C<< { -value => $anything } >>
2593 On failure returns C<undef>, on success returns a B<scalar> reference
2594 to the original supplied argument.
2600 The stringification overloading detection is rather advanced: it takes
2601 into consideration not only the presence of a C<""> overload, but if that
2602 fails also checks for enabled
2603 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2604 on either C<0+> or C<bool>.
2606 Unfortunately testing in the field indicates that this
2607 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2608 but only when very large numbers of stringifying objects are involved.
2609 At the time of writing ( Sep 2014 ) there is no clear explanation of
2610 the direct cause, nor is there a manageably small test case that reliably
2611 reproduces the problem.
2613 If you encounter any of the following exceptions in B<random places within
2614 your application stack> - this module may be to blame:
2616 Operation "ne": no method found,
2617 left argument in overloaded package <something>,
2618 right argument in overloaded package <something>
2622 Stub found while resolving method "???" overloading """" in package <something>
2624 If you fall victim to the above - please attempt to reduce the problem
2625 to something that could be sent to the L<SQL::Abstract developers
2626 |DBIx::Class/GETTING HELP/SUPPORT>
2627 (either publicly or privately). As a workaround in the meantime you can
2628 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2629 value, which will most likely eliminate your problem (at the expense of
2630 not being able to properly detect exotic forms of stringification).
2632 This notice and environment variable will be removed in a future version,
2633 as soon as the underlying problem is found and a reliable workaround is
2638 =head2 is_literal_value
2640 Determines if the supplied argument is a literal value as understood by this
2645 =item * C<\$sql_string>
2647 =item * C<\[ $sql_string, @bind_values ]>
2651 On failure returns C<undef>, on success returns an B<array> reference
2652 containing the unpacked version of the supplied literal SQL and bind values.
2654 =head2 is_undef_value
2656 Tests for undef, whether expanded or not.
2658 =head1 WHERE CLAUSES
2662 This module uses a variation on the idea from L<DBIx::Abstract>. It
2663 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2664 module is that things in arrays are OR'ed, and things in hashes
2667 The easiest way to explain is to show lots of examples. After
2668 each C<%where> hash shown, it is assumed you used:
2670 my($stmt, @bind) = $sql->where(\%where);
2672 However, note that the C<%where> hash can be used directly in any
2673 of the other functions as well, as described above.
2675 =head2 Key-value pairs
2677 So, let's get started. To begin, a simple hash:
2681 status => 'completed'
2684 Is converted to SQL C<key = val> statements:
2686 $stmt = "WHERE user = ? AND status = ?";
2687 @bind = ('nwiger', 'completed');
2689 One common thing I end up doing is having a list of values that
2690 a field can be in. To do this, simply specify a list inside of
2695 status => ['assigned', 'in-progress', 'pending'];
2698 This simple code will create the following:
2700 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2701 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2703 A field associated to an empty arrayref will be considered a
2704 logical false and will generate 0=1.
2706 =head2 Tests for NULL values
2708 If the value part is C<undef> then this is converted to SQL <IS NULL>
2717 $stmt = "WHERE user = ? AND status IS NULL";
2720 To test if a column IS NOT NULL:
2724 status => { '!=', undef },
2727 =head2 Specific comparison operators
2729 If you want to specify a different type of operator for your comparison,
2730 you can use a hashref for a given column:
2734 status => { '!=', 'completed' }
2737 Which would generate:
2739 $stmt = "WHERE user = ? AND status != ?";
2740 @bind = ('nwiger', 'completed');
2742 To test against multiple values, just enclose the values in an arrayref:
2744 status => { '=', ['assigned', 'in-progress', 'pending'] };
2746 Which would give you:
2748 "WHERE status = ? OR status = ? OR status = ?"
2751 The hashref can also contain multiple pairs, in which case it is expanded
2752 into an C<AND> of its elements:
2756 status => { '!=', 'completed', -not_like => 'pending%' }
2759 # Or more dynamically, like from a form
2760 $where{user} = 'nwiger';
2761 $where{status}{'!='} = 'completed';
2762 $where{status}{'-not_like'} = 'pending%';
2764 # Both generate this
2765 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2766 @bind = ('nwiger', 'completed', 'pending%');
2769 To get an OR instead, you can combine it with the arrayref idea:
2773 priority => [ { '=', 2 }, { '>', 5 } ]
2776 Which would generate:
2778 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2779 @bind = ('2', '5', 'nwiger');
2781 If you want to include literal SQL (with or without bind values), just use a
2782 scalar reference or reference to an arrayref as the value:
2785 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2786 date_expires => { '<' => \"now()" }
2789 Which would generate:
2791 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2792 @bind = ('11/26/2008');
2795 =head2 Logic and nesting operators
2797 In the example above,
2798 there is a subtle trap if you want to say something like
2799 this (notice the C<AND>):
2801 WHERE priority != ? AND priority != ?
2803 Because, in Perl you I<can't> do this:
2805 priority => { '!=' => 2, '!=' => 1 }
2807 As the second C<!=> key will obliterate the first. The solution
2808 is to use the special C<-modifier> form inside an arrayref:
2810 priority => [ -and => {'!=', 2},
2814 Normally, these would be joined by C<OR>, but the modifier tells it
2815 to use C<AND> instead. (Hint: You can use this in conjunction with the
2816 C<logic> option to C<new()> in order to change the way your queries
2817 work by default.) B<Important:> Note that the C<-modifier> goes
2818 B<INSIDE> the arrayref, as an extra first element. This will
2819 B<NOT> do what you think it might:
2821 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2823 Here is a quick list of equivalencies, since there is some overlap:
2826 status => {'!=', 'completed', 'not like', 'pending%' }
2827 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2830 status => {'=', ['assigned', 'in-progress']}
2831 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2832 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2836 =head2 Special operators: IN, BETWEEN, etc.
2838 You can also use the hashref format to compare a list of fields using the
2839 C<IN> comparison operator, by specifying the list as an arrayref:
2842 status => 'completed',
2843 reportid => { -in => [567, 2335, 2] }
2846 Which would generate:
2848 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2849 @bind = ('completed', '567', '2335', '2');
2851 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2854 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2855 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2856 'sqltrue' (by default: C<1=1>).
2858 In addition to the array you can supply a chunk of literal sql or
2859 literal sql with bind:
2862 customer => { -in => \[
2863 'SELECT cust_id FROM cust WHERE balance > ?',
2866 status => { -in => \'SELECT status_codes FROM states' },
2872 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2873 AND status IN ( SELECT status_codes FROM states )
2877 Finally, if the argument to C<-in> is not a reference, it will be
2878 treated as a single-element array.
2880 Another pair of operators is C<-between> and C<-not_between>,
2881 used with an arrayref of two values:
2885 completion_date => {
2886 -not_between => ['2002-10-01', '2003-02-06']
2892 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2894 Just like with C<-in> all plausible combinations of literal SQL
2898 start0 => { -between => [ 1, 2 ] },
2899 start1 => { -between => \["? AND ?", 1, 2] },
2900 start2 => { -between => \"lower(x) AND upper(y)" },
2901 start3 => { -between => [
2903 \["upper(?)", 'stuff' ],
2910 ( start0 BETWEEN ? AND ? )
2911 AND ( start1 BETWEEN ? AND ? )
2912 AND ( start2 BETWEEN lower(x) AND upper(y) )
2913 AND ( start3 BETWEEN lower(x) AND upper(?) )
2915 @bind = (1, 2, 1, 2, 'stuff');
2918 These are the two builtin "special operators"; but the
2919 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2921 =head2 Unary operators: bool
2923 If you wish to test against boolean columns or functions within your
2924 database you can use the C<-bool> and C<-not_bool> operators. For
2925 example to test the column C<is_user> being true and the column
2926 C<is_enabled> being false you would use:-
2930 -not_bool => 'is_enabled',
2935 WHERE is_user AND NOT is_enabled
2937 If a more complex combination is required, testing more conditions,
2938 then you should use the and/or operators:-
2943 -not_bool => { two=> { -rlike => 'bar' } },
2944 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2955 (NOT ( three = ? OR three > ? ))
2958 =head2 Nested conditions, -and/-or prefixes
2960 So far, we've seen how multiple conditions are joined with a top-level
2961 C<AND>. We can change this by putting the different conditions we want in
2962 hashes and then putting those hashes in an array. For example:
2967 status => { -like => ['pending%', 'dispatched'] },
2971 status => 'unassigned',
2975 This data structure would create the following:
2977 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2978 OR ( user = ? AND status = ? ) )";
2979 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2982 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2983 to change the logic inside:
2989 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2990 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2997 $stmt = "WHERE ( user = ?
2998 AND ( ( workhrs > ? AND geo = ? )
2999 OR ( workhrs < ? OR geo = ? ) ) )";
3000 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
3002 =head3 Algebraic inconsistency, for historical reasons
3004 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
3005 operator goes C<outside> of the nested structure; whereas when connecting
3006 several constraints on one column, the C<-and> operator goes
3007 C<inside> the arrayref. Here is an example combining both features:
3010 -and => [a => 1, b => 2],
3011 -or => [c => 3, d => 4],
3012 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3017 WHERE ( ( ( a = ? AND b = ? )
3018 OR ( c = ? OR d = ? )
3019 OR ( e LIKE ? AND e LIKE ? ) ) )
3021 This difference in syntax is unfortunate but must be preserved for
3022 historical reasons. So be careful: the two examples below would
3023 seem algebraically equivalent, but they are not
3026 { -like => 'foo%' },
3027 { -like => '%bar' },
3029 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3032 { col => { -like => 'foo%' } },
3033 { col => { -like => '%bar' } },
3035 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3038 =head2 Literal SQL and value type operators
3040 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3041 side" is a column name and the "right side" is a value (normally rendered as
3042 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3043 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3044 alter this behavior. There are several ways of doing so.
3048 This is a virtual operator that signals the string to its right side is an
3049 identifier (a column name) and not a value. For example to compare two
3050 columns you would write:
3053 priority => { '<', 2 },
3054 requestor => { -ident => 'submitter' },
3059 $stmt = "WHERE priority < ? AND requestor = submitter";
3062 If you are maintaining legacy code you may see a different construct as
3063 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3068 This is a virtual operator that signals that the construct to its right side
3069 is a value to be passed to DBI. This is for example necessary when you want
3070 to write a where clause against an array (for RDBMS that support such
3071 datatypes). For example:
3074 array => { -value => [1, 2, 3] }
3079 $stmt = 'WHERE array = ?';
3080 @bind = ([1, 2, 3]);
3082 Note that if you were to simply say:
3088 the result would probably not be what you wanted:
3090 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3095 Finally, sometimes only literal SQL will do. To include a random snippet
3096 of SQL verbatim, you specify it as a scalar reference. Consider this only
3097 as a last resort. Usually there is a better way. For example:
3100 priority => { '<', 2 },
3101 requestor => { -in => \'(SELECT name FROM hitmen)' },
3106 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3109 Note that in this example, you only get one bind parameter back, since
3110 the verbatim SQL is passed as part of the statement.
3114 Never use untrusted input as a literal SQL argument - this is a massive
3115 security risk (there is no way to check literal snippets for SQL
3116 injections and other nastyness). If you need to deal with untrusted input
3117 use literal SQL with placeholders as described next.
3119 =head3 Literal SQL with placeholders and bind values (subqueries)
3121 If the literal SQL to be inserted has placeholders and bind values,
3122 use a reference to an arrayref (yes this is a double reference --
3123 not so common, but perfectly legal Perl). For example, to find a date
3124 in Postgres you can use something like this:
3127 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3132 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3135 Note that you must pass the bind values in the same format as they are returned
3136 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3137 to C<columns>, you must provide the bind values in the
3138 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3139 scalar value; most commonly the column name, but you can use any scalar value
3140 (including references and blessed references), L<SQL::Abstract> will simply
3141 pass it through intact. So if C<bindtype> is set to C<columns> the above
3142 example will look like:
3145 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3148 Literal SQL is especially useful for nesting parenthesized clauses in the
3149 main SQL query. Here is a first example:
3151 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3155 bar => \["IN ($sub_stmt)" => @sub_bind],
3160 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3161 WHERE c2 < ? AND c3 LIKE ?))";
3162 @bind = (1234, 100, "foo%");
3164 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3165 are expressed in the same way. Of course the C<$sub_stmt> and
3166 its associated bind values can be generated through a former call
3169 my ($sub_stmt, @sub_bind)
3170 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3171 c3 => {-like => "foo%"}});
3174 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3177 In the examples above, the subquery was used as an operator on a column;
3178 but the same principle also applies for a clause within the main C<%where>
3179 hash, like an EXISTS subquery:
3181 my ($sub_stmt, @sub_bind)
3182 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3183 my %where = ( -and => [
3185 \["EXISTS ($sub_stmt)" => @sub_bind],
3190 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3191 WHERE c1 = ? AND c2 > t0.c0))";
3195 Observe that the condition on C<c2> in the subquery refers to
3196 column C<t0.c0> of the main query: this is I<not> a bind
3197 value, so we have to express it through a scalar ref.
3198 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3199 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3200 what we wanted here.
3202 Finally, here is an example where a subquery is used
3203 for expressing unary negation:
3205 my ($sub_stmt, @sub_bind)
3206 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3207 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3209 lname => {like => '%son%'},
3210 \["NOT ($sub_stmt)" => @sub_bind],
3215 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3216 @bind = ('%son%', 10, 20)
3218 =head3 Deprecated usage of Literal SQL
3220 Below are some examples of archaic use of literal SQL. It is shown only as
3221 reference for those who deal with legacy code. Each example has a much
3222 better, cleaner and safer alternative that users should opt for in new code.
3228 my %where = ( requestor => \'IS NOT NULL' )
3230 $stmt = "WHERE requestor IS NOT NULL"
3232 This used to be the way of generating NULL comparisons, before the handling
3233 of C<undef> got formalized. For new code please use the superior syntax as
3234 described in L</Tests for NULL values>.
3238 my %where = ( requestor => \'= submitter' )
3240 $stmt = "WHERE requestor = submitter"
3242 This used to be the only way to compare columns. Use the superior L</-ident>
3243 method for all new code. For example an identifier declared in such a way
3244 will be properly quoted if L</quote_char> is properly set, while the legacy
3245 form will remain as supplied.
3249 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3251 $stmt = "WHERE completed > ? AND is_ready"
3252 @bind = ('2012-12-21')
3254 Using an empty string literal used to be the only way to express a boolean.
3255 For all new code please use the much more readable
3256 L<-bool|/Unary operators: bool> operator.
3262 These pages could go on for a while, since the nesting of the data
3263 structures this module can handle are pretty much unlimited (the
3264 module implements the C<WHERE> expansion as a recursive function
3265 internally). Your best bet is to "play around" with the module a
3266 little to see how the data structures behave, and choose the best
3267 format for your data based on that.
3269 And of course, all the values above will probably be replaced with
3270 variables gotten from forms or the command line. After all, if you
3271 knew everything ahead of time, you wouldn't have to worry about
3272 dynamically-generating SQL and could just hardwire it into your
3275 =head1 ORDER BY CLAUSES
3277 Some functions take an order by clause. This can either be a scalar (just a
3278 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3279 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3282 Given | Will Generate
3283 ---------------------------------------------------------------
3285 'colA' | ORDER BY colA
3287 [qw/colA colB/] | ORDER BY colA, colB
3289 {-asc => 'colA'} | ORDER BY colA ASC
3291 {-desc => 'colB'} | ORDER BY colB DESC
3293 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3295 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3297 \'colA DESC' | ORDER BY colA DESC
3299 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3300 | /* ...with $x bound to ? */
3303 { -asc => 'colA' }, | colA ASC,
3304 { -desc => [qw/colB/] }, | colB DESC,
3305 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3306 \'colE DESC', | colE DESC,
3307 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3308 ] | /* ...with $x bound to ? */
3309 ===============================================================
3313 =head1 OLD EXTENSION SYSTEM
3315 =head2 SPECIAL OPERATORS
3317 my $sqlmaker = SQL::Abstract->new(special_ops => [
3321 my ($self, $field, $op, $arg) = @_;
3327 handler => 'method_name',
3331 A "special operator" is a SQL syntactic clause that can be
3332 applied to a field, instead of a usual binary operator.
3335 WHERE field IN (?, ?, ?)
3336 WHERE field BETWEEN ? AND ?
3337 WHERE MATCH(field) AGAINST (?, ?)
3339 Special operators IN and BETWEEN are fairly standard and therefore
3340 are builtin within C<SQL::Abstract> (as the overridable methods
3341 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3342 like the MATCH .. AGAINST example above which is specific to MySQL,
3343 you can write your own operator handlers - supply a C<special_ops>
3344 argument to the C<new> method. That argument takes an arrayref of
3345 operator definitions; each operator definition is a hashref with two
3352 the regular expression to match the operator
3356 Either a coderef or a plain scalar method name. In both cases
3357 the expected return is C<< ($sql, @bind) >>.
3359 When supplied with a method name, it is simply called on the
3360 L<SQL::Abstract> object as:
3362 $self->$method_name($field, $op, $arg)
3366 $field is the LHS of the operator
3367 $op is the part that matched the handler regex
3370 When supplied with a coderef, it is called as:
3372 $coderef->($self, $field, $op, $arg)
3377 For example, here is an implementation
3378 of the MATCH .. AGAINST syntax for MySQL
3380 my $sqlmaker = SQL::Abstract->new(special_ops => [
3382 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3383 {regex => qr/^match$/i,
3385 my ($self, $field, $op, $arg) = @_;
3386 $arg = [$arg] if not ref $arg;
3387 my $label = $self->_quote($field);
3388 my ($placeholder) = $self->_convert('?');
3389 my $placeholders = join ", ", (($placeholder) x @$arg);
3390 my $sql = $self->_sqlcase('match') . " ($label) "
3391 . $self->_sqlcase('against') . " ($placeholders) ";
3392 my @bind = $self->_bindtype($field, @$arg);
3393 return ($sql, @bind);
3400 =head2 UNARY OPERATORS
3402 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3406 my ($self, $op, $arg) = @_;
3412 handler => 'method_name',
3416 A "unary operator" is a SQL syntactic clause that can be
3417 applied to a field - the operator goes before the field
3419 You can write your own operator handlers - supply a C<unary_ops>
3420 argument to the C<new> method. That argument takes an arrayref of
3421 operator definitions; each operator definition is a hashref with two
3428 the regular expression to match the operator
3432 Either a coderef or a plain scalar method name. In both cases
3433 the expected return is C<< $sql >>.
3435 When supplied with a method name, it is simply called on the
3436 L<SQL::Abstract> object as:
3438 $self->$method_name($op, $arg)
3442 $op is the part that matched the handler regex
3443 $arg is the RHS or argument of the operator
3445 When supplied with a coderef, it is called as:
3447 $coderef->($self, $op, $arg)
3454 See L<SQL::Abstract::Reference> for the C<expr> versus C<aqt> concept and
3455 an explanation of what the below extensions are extending.
3459 my ($sql, @bind) = $sqla->render_expr($expr);
3461 =head2 render_statement
3463 Use this if you may be rendering a top level statement so e.g. a SELECT
3464 query doesn't get wrapped in parens
3466 my ($sql, @bind) = $sqla->render_statement($expr);
3470 Expression expansion with optional default for scalars.
3472 my $aqt = $self->expand_expr($expr);
3473 my $aqt = $self->expand_expr($expr, -ident);
3477 Top level means avoid parens on statement AQT.
3479 my $res = $self->render_aqt($aqt, $top_level);
3480 my ($sql, @bind) = @$res;
3482 =head2 join_query_parts
3484 Similar to join() but will render hashrefs as nodes for both join and parts,
3485 and treats arrayref as a nested C<[ $join, @parts ]> structure.
3487 my $part = $self->join_query_parts($join, @parts);
3489 =head1 NEW EXTENSION SYSTEM
3493 my $sqla2 = $sqla->clone;
3495 Performs a semi-shallow copy such that extension methods won't leak state
3496 but excessive depth is avoided.
3506 =head2 clause_expander
3508 =head2 clause_expanders
3510 $sqla->expander('name' => sub { ... });
3511 $sqla->expanders('name1' => sub { ... }, 'name2' => sub { ... });
3513 =head2 expander_list
3515 =head2 op_expander_list
3517 =head2 clause_expander_list
3519 my @names = $sqla->expander_list;
3521 =head2 wrap_expander
3523 =head2 wrap_expanders
3525 =head2 wrap_op_expander
3527 =head2 wrap_op_expanders
3529 =head2 wrap_clause_expander
3531 =head2 wrap_clause_expanders
3533 $sqla->wrap_expander('name' => sub { my ($orig) = @_; sub { ... } });
3534 $sqla->wrap_expanders(
3535 'name1' => sub { my ($orig1) = @_; sub { ... } },
3536 'name2' => sub { my ($orig2) = @_; sub { ... } },
3547 =head2 clause_renderer
3549 =head2 clause_renderers
3551 $sqla->renderer('name' => sub { ... });
3552 $sqla->renderers('name1' => sub { ... }, 'name2' => sub { ... });
3554 =head2 renderer_list
3556 =head2 op_renderer_list
3558 =head2 clause_renderer_list
3560 my @names = $sqla->renderer_list;
3562 =head2 wrap_renderer
3564 =head2 wrap_renderers
3566 =head2 wrap_op_renderer
3568 =head2 wrap_op_renderers
3570 =head2 wrap_clause_renderer
3572 =head2 wrap_clause_renderers
3574 $sqla->wrap_renderer('name' => sub { my ($orig) = @_; sub { ... } });
3575 $sqla->wrap_renderers(
3576 'name1' => sub { my ($orig1) = @_; sub { ... } },
3577 'name2' => sub { my ($orig2) = @_; sub { ... } },
3582 my @clauses = $sqla->clauses_of('select');
3583 $sqla->clauses_of(select => \@new_clauses);
3584 $sqla->clauses_of(select => sub {
3585 my (undef, @old_clauses) = @_;
3587 return @new_clauses;
3590 =head2 statement_list
3592 my @list = $sqla->statement_list;
3594 =head2 make_unop_expander
3596 my $exp = $sqla->make_unop_expander(sub { ... });
3598 If the op is found as a binop, assumes it wants a default comparison, so
3599 the inner expander sub can reliably operate as
3601 sub { my ($self, $name, $body) = @_; ... }
3603 =head2 make_binop_expander
3605 my $exp = $sqla->make_binop_expander(sub { ... });
3607 If the op is found as a unop, assumes the value will be an arrayref with the
3608 LHS as the first entry, and converts that to an ident node if it's a simple
3609 scalar. So the inner expander sub looks like
3612 my ($self, $name, $body, $k) = @_;
3613 { -blah => [ map $self->expand_expr($_), $k, $body ] }
3616 =head2 unop_expander
3618 =head2 unop_expanders
3620 =head2 binop_expander
3622 =head2 binop_expanders
3624 The above methods operate exactly like the op_ versions but wrap the coderef
3625 using the appropriate make_ method first.
3629 Thanks to some benchmarking by Mark Stosberg, it turns out that
3630 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3631 I must admit this wasn't an intentional design issue, but it's a
3632 byproduct of the fact that you get to control your C<DBI> handles
3635 To maximize performance, use a code snippet like the following:
3637 # prepare a statement handle using the first row
3638 # and then reuse it for the rest of the rows
3640 for my $href (@array_of_hashrefs) {
3641 $stmt ||= $sql->insert('table', $href);
3642 $sth ||= $dbh->prepare($stmt);
3643 $sth->execute($sql->values($href));
3646 The reason this works is because the keys in your C<$href> are sorted
3647 internally by B<SQL::Abstract>. Thus, as long as your data retains
3648 the same structure, you only have to generate the SQL the first time
3649 around. On subsequent queries, simply use the C<values> function provided
3650 by this module to return your values in the correct order.
3652 However this depends on the values having the same type - if, for
3653 example, the values of a where clause may either have values
3654 (resulting in sql of the form C<column = ?> with a single bind
3655 value), or alternatively the values might be C<undef> (resulting in
3656 sql of the form C<column IS NULL> with no bind value) then the
3657 caching technique suggested will not work.
3661 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3662 really like this part (I do, at least). Building up a complex query
3663 can be as simple as the following:
3670 use CGI::FormBuilder;
3673 my $form = CGI::FormBuilder->new(...);
3674 my $sql = SQL::Abstract->new;
3676 if ($form->submitted) {
3677 my $field = $form->field;
3678 my $id = delete $field->{id};
3679 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3682 Of course, you would still have to connect using C<DBI> to run the
3683 query, but the point is that if you make your form look like your
3684 table, the actual query script can be extremely simplistic.
3686 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3687 a fast interface to returning and formatting data. I frequently
3688 use these three modules together to write complex database query
3689 apps in under 50 lines.
3691 =head1 HOW TO CONTRIBUTE
3693 Contributions are always welcome, in all usable forms (we especially
3694 welcome documentation improvements). The delivery methods include git-
3695 or unified-diff formatted patches, GitHub pull requests, or plain bug
3696 reports either via RT or the Mailing list. Contributors are generally
3697 granted full access to the official repository after their first several
3698 patches pass successful review.
3700 This project is maintained in a git repository. The code and related tools are
3701 accessible at the following locations:
3705 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3707 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3709 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3711 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3717 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3718 Great care has been taken to preserve the I<published> behavior
3719 documented in previous versions in the 1.* family; however,
3720 some features that were previously undocumented, or behaved
3721 differently from the documentation, had to be changed in order
3722 to clarify the semantics. Hence, client code that was relying
3723 on some dark areas of C<SQL::Abstract> v1.*
3724 B<might behave differently> in v1.50.
3726 The main changes are:
3732 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3736 support for the { operator => \"..." } construct (to embed literal SQL)
3740 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3744 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3748 defensive programming: check arguments
3752 fixed bug with global logic, which was previously implemented
3753 through global variables yielding side-effects. Prior versions would
3754 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3755 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3756 Now this is interpreted
3757 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3762 fixed semantics of _bindtype on array args
3766 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3767 we just avoid shifting arrays within that tree.
3771 dropped the C<_modlogic> function
3775 =head1 ACKNOWLEDGEMENTS
3777 There are a number of individuals that have really helped out with
3778 this module. Unfortunately, most of them submitted bugs via CPAN
3779 so I have no idea who they are! But the people I do know are:
3781 Ash Berlin (order_by hash term support)
3782 Matt Trout (DBIx::Class support)
3783 Mark Stosberg (benchmarking)
3784 Chas Owens (initial "IN" operator support)
3785 Philip Collins (per-field SQL functions)
3786 Eric Kolve (hashref "AND" support)
3787 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3788 Dan Kubb (support for "quote_char" and "name_sep")
3789 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3790 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3791 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3792 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3793 Oliver Charles (support for "RETURNING" after "INSERT")
3799 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3803 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3805 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3807 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3808 While not an official support venue, C<DBIx::Class> makes heavy use of
3809 C<SQL::Abstract>, and as such list members there are very familiar with
3810 how to create queries.
3814 This module is free software; you may copy this under the same
3815 terms as perl itself (either the GNU General Public License or
3816 the Artistic License)