1 package SQL::Abstract; # see doc at end of file
5 use Module::Runtime ();
10 use Exporter 'import';
11 our @EXPORT_OK = qw(is_plain_value is_literal_value);
21 *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
27 #======================================================================
29 #======================================================================
31 our $VERSION = '1.87';
33 # This would confuse some packagers
34 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
38 # special operators (-in, -between). May be extended/overridden by user.
39 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
40 my @BUILTIN_SPECIAL_OPS = (
41 {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }},
42 {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }},
43 {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }},
44 {regex => qr/^ ident $/ix, handler => sub { die "NOPE" }},
45 {regex => qr/^ value $/ix, handler => sub { die "NOPE" }},
48 #======================================================================
49 # DEBUGGING AND ERROR REPORTING
50 #======================================================================
53 return unless $_[0]->{debug}; shift; # a little faster
54 my $func = (caller(1))[3];
55 warn "[$func] ", @_, "\n";
59 my($func) = (caller(1))[3];
60 Carp::carp "[$func] Warning: ", @_;
64 my($func) = (caller(1))[3];
65 Carp::croak "[$func] Fatal: ", @_;
68 sub is_literal_value ($) {
69 ref $_[0] eq 'SCALAR' ? [ ${$_[0]} ]
70 : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' ) ? [ @${ $_[0] } ]
74 sub is_undef_value ($) {
78 and exists $_[0]->{-value}
79 and not defined $_[0]->{-value}
83 # FIXME XSify - this can be done so much more efficiently
84 sub is_plain_value ($) {
86 ! length ref $_[0] ? \($_[0])
88 ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
90 exists $_[0]->{-value}
91 ) ? \($_[0]->{-value})
93 # reuse @_ for even moar speedz
94 defined ( $_[1] = Scalar::Util::blessed $_[0] )
96 # deliberately not using Devel::OverloadInfo - the checks we are
97 # intersted in are much more limited than the fullblown thing, and
98 # this is a very hot piece of code
100 # simply using ->can('(""') can leave behind stub methods that
101 # break actually using the overload later (see L<perldiag/Stub
102 # found while resolving method "%s" overloading "%s" in package
103 # "%s"> and the source of overload::mycan())
105 # either has stringification which DBI SHOULD prefer out of the box
106 grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
108 # has nummification or boolification, AND fallback is *not* disabled
110 SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
113 grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
115 grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
119 # no fallback specified at all
120 ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
122 # fallback explicitly undef
123 ! defined ${"$_[3]::()"}
136 #======================================================================
138 #======================================================================
142 bool => '_expand_bool',
143 row => '_expand_row',
145 func => '_expand_func',
146 values => '_expand_values',
147 bind => '_expand_noop',
148 literal => '_expand_noop',
149 keyword => '_expand_noop',
152 'between' => '_expand_between',
153 'not_between' => '_expand_between',
154 'in' => '_expand_in',
155 'not_in' => '_expand_in',
156 'nest' => '_expand_nest',
157 (map +($_ => '_expand_op_andor'), ('and', 'or')),
158 (map +($_ => '_expand_op_is'), ('is', 'is_not')),
159 'ident' => '_expand_ident',
160 'value' => '_expand_value',
163 (map +($_, "_render_$_"),
164 qw(op func bind ident literal row values keyword)),
167 (map +($_ => '_render_op_between'), 'between', 'not_between'),
168 (map +($_ => '_render_op_in'), 'in', 'not_in'),
169 (map +($_ => '_render_unop_postfix'),
170 'is_null', 'is_not_null', 'asc', 'desc',
172 (not => '_render_unop_paren'),
173 (map +($_ => '_render_op_andor'), qw(and or)),
174 ',' => '_render_op_multop',
177 delete => [ qw(target where returning) ],
178 update => [ qw(target set where returning) ],
179 insert => [ qw(target fields from returning) ],
180 select => [ qw(select from where order_by) ],
183 'delete.from' => '_expand_delete_clause_target',
184 'update.update' => '_expand_update_clause_target',
185 'insert.into' => '_expand_insert_clause_target',
186 'insert.values' => '_expand_insert_clause_from',
189 'delete.target' => '_render_delete_clause_target',
190 'update.target' => '_render_update_clause_target',
191 'insert.target' => '_render_insert_clause_target',
192 'insert.fields' => '_render_insert_clause_fields',
193 'insert.from' => '_render_insert_clause_from',
197 foreach my $stmt (keys %{$Defaults{clauses_of}}) {
198 $Defaults{expand}{$stmt} = '_expand_statement';
199 $Defaults{render}{$stmt} = '_render_statement';
200 foreach my $clause (@{$Defaults{clauses_of}{$stmt}}) {
201 $Defaults{expand_clause}{"${stmt}.${clause}"}
202 = "_expand_${stmt}_clause_${clause}";
208 my $class = ref($self) || $self;
209 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
211 # choose our case by keeping an option around
212 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
214 # default logic for interpreting arrayrefs
215 $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
217 # how to return bind vars
218 $opt{bindtype} ||= 'normal';
220 # default comparison is "=", but can be overridden
223 # try to recognize which are the 'equality' and 'inequality' ops
224 # (temporary quickfix (in 2007), should go through a more seasoned API)
225 $opt{equality_op} = qr/^( \Q$opt{cmp}\E | \= )$/ix;
226 $opt{inequality_op} = qr/^( != | <> )$/ix;
228 $opt{like_op} = qr/^ (is_)?r?like $/xi;
229 $opt{not_like_op} = qr/^ (is_)?not_r?like $/xi;
232 $opt{sqltrue} ||= '1=1';
233 $opt{sqlfalse} ||= '0=1';
236 $opt{special_ops} ||= [];
239 $opt{unary_ops} ||= [];
241 # rudimentary sanity-check for user supplied bits treated as functions/operators
242 # If a purported function matches this regular expression, an exception is thrown.
243 # Literal SQL is *NOT* subject to this check, only functions (and column names
244 # when quoting is not in effect)
247 # need to guard against ()'s in column names too, but this will break tons of
248 # hacks... ideas anyone?
249 $opt{injection_guard} ||= qr/
255 $opt{expand_unary} = {};
257 foreach my $name (sort keys %Defaults) {
258 $opt{$name} = { %{$Defaults{$name}}, %{$opt{$name}||{}} };
261 if ($class ne __PACKAGE__) {
263 # check for overriden methods
265 foreach my $type (qw(insert update delete)) {
266 my $method = "_${type}_returning";
267 if (__PACKAGE__->can($method) ne $class->can($method)) {
268 my $clause = "${type}.returning";
269 $opt{expand_clause}{$clause} = sub { $_[2] },
270 $opt{render_clause}{$clause}
271 = sub { [ $_[0]->$method($_[3]) ] };
274 if (__PACKAGE__->can('_table') ne $class->can('_table')) {
275 $opt{expand_clause}{'select.from'} = sub {
276 return +{ -literal => [ $_[0]->_table($_[2]) ] };
279 if (__PACKAGE__->can('_order_by') ne $class->can('_order_by')) {
280 $opt{expand_clause}{'select.order_by'} = sub { $_[2] };
281 $opt{render_clause}{'select.order_by'} = sub {
282 [ $_[0]->_order_by($_[2]) ];
285 if ($class->isa('DBIx::Class::SQLMaker')) {
286 $opt{warn_once_on_nest} = 1;
287 $opt{disable_old_special_ops} = 1;
288 $opt{render_clause}{'select.where'} = sub {
289 my ($sql, @bind) = $_[0]->where($_[2]);
290 s/\A\s+//, s/\s+\Z// for $sql;
291 return [ $sql, @bind ];
296 if ($opt{lazy_join_sql_parts}) {
297 my $mod = Module::Runtime::use_module('SQL::Abstract::Parts');
298 $opt{join_sql_parts} ||= sub { $mod->new(@_) };
301 $opt{join_sql_parts} ||= sub { join $_[0], @_[1..$#_] };
303 return bless \%opt, $class;
307 my ($self, $name, $key, $value) = @_;
308 return $self->{$name}{$key} unless @_ > 3;
309 $self->{$name}{$key} = $value;
314 foreach my $type (qw(
315 expand op_expand render op_render clause_expand clause_render
317 my $name = join '_', reverse split '_', $type;
318 my $singular = "${type}er";
319 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
320 or die "Method builder failed for ${singular}: $@";
321 eval qq{sub wrap_${singular} {
322 my (\$self, \$key, \$builder) = \@_;
323 my \$orig = \$self->_ext_rw('${name}', \$key);
326 \$builder->(\$orig, '${name}', \$key)
328 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
329 eval qq{sub ${singular}s {
330 my (\$self, \@args) = \@_;
331 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
332 \$self->_ext_rw('${name}', \$this_key, \$this_value);
335 }; 1 } or die "Method builder failed for ${singular}s: $@";
336 eval qq{sub wrap_${singular}s {
337 my (\$self, \@args) = \@_;
338 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
339 my \$orig = \$self->_ext_rw('${name}', \$this_key);
341 '${name}', \$this_key,
342 \$this_builder->(\$orig, '${name}', \$this_key),
346 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
347 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
348 or die "Method builder failed for ${singular}_list: $@";
352 sub register_op { $_[0]->{is_op}{$_[1]} = 1; $_[0] }
354 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
357 my ($self, $of, @clauses) = @_;
359 return @{$self->{clauses_of}{$of}||[]};
361 if (ref($clauses[0]) eq 'CODE') {
362 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
364 $self->{clauses_of}{$of} = \@clauses;
373 ref($self->{$_}) eq 'HASH'
382 sub sqltrue { +{ -literal => [ $_[0]->{sqltrue} ] } }
383 sub sqlfalse { +{ -literal => [ $_[0]->{sqlfalse} ] } }
385 sub _assert_pass_injection_guard {
386 if ($_[1] =~ $_[0]->{injection_guard}) {
387 my $class = ref $_[0];
388 puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
389 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
390 . "{injection_guard} attribute to ${class}->new()"
395 #======================================================================
397 #======================================================================
400 my ($self, $table, $data, $options) = @_;
403 if (ref($table) eq 'HASH') {
406 my %clauses = (target => $table, values => $data, %{$options||{}});
410 my @rendered = $self->render_statement({ -insert => $stmt });
411 return wantarray ? @rendered : $rendered[0];
414 sub _expand_insert_clause_target {
415 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
418 sub _expand_insert_clause_fields {
420 $_[0]->expand_maybe_list_expr($_[2], -ident)
421 ] } if ref($_[2]) eq 'ARRAY';
422 return $_[2]; # should maybe still expand somewhat?
425 sub _expand_insert_clause_from {
426 my ($self, undef, $data) = @_;
427 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
428 return $self->expand_expr($data);
430 return $data if ref($data) eq 'HASH' and $data->{-row};
431 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
433 from => { -values => [ $v_aqt ] },
434 ($f_aqt ? (fields => $f_aqt) : ()),
438 sub _expand_insert_clause_returning {
439 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
442 sub _expand_insert_values {
443 my ($self, $data) = @_;
444 if (is_literal_value($data)) {
445 (undef, $self->expand_expr($data));
447 my ($fields, $values) = (
448 ref($data) eq 'HASH' ?
449 ([ sort keys %$data ], [ @{$data}{sort keys %$data} ])
453 # no names (arrayref) means can't generate bindtype
454 !($fields) && $self->{bindtype} eq 'columns'
455 && belch "can't do 'columns' bindtype when called with arrayref";
459 ? $self->expand_expr({ -row => $fields }, -ident)
464 local our $Cur_Col_Meta = $fields->[$_];
465 $self->_expand_insert_value($values->[$_])
472 sub _render_insert_clause_fields {
473 return $_[0]->render_aqt($_[2]);
476 sub _render_insert_clause_target {
477 my ($self, undef, $from) = @_;
478 $self->join_query_parts(' ', { -keyword => 'insert into' }, $from);
481 sub _render_insert_clause_from {
482 return $_[0]->render_aqt($_[2], 1);
485 # So that subclasses can override INSERT ... RETURNING separately from
486 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
487 sub _insert_returning { shift->_returning(@_) }
489 sub _redispatch_returning {
490 my ($self, $type, undef, $returning) = @_;
491 [ $self->${\"_${type}_returning"}({ returning => $returning }) ];
495 my ($self, $options) = @_;
497 my $f = $options->{returning};
499 my ($sql, @bind) = @{ $self->render_aqt(
500 $self->expand_maybe_list_expr($f, -ident)
502 return ($self->_sqlcase(' returning ').$sql, @bind);
505 sub _expand_insert_value {
508 my $k = our $Cur_Col_Meta;
510 if (ref($v) eq 'ARRAY') {
511 if ($self->{array_datatypes}) {
512 return +{ -bind => [ $k, $v ] };
514 my ($sql, @bind) = @$v;
515 $self->_assert_bindval_matches_bindtype(@bind);
516 return +{ -literal => $v };
518 if (ref($v) eq 'HASH') {
519 if (grep !/^-/, keys %$v) {
520 belch "HASH ref as bind value in insert is not supported";
521 return +{ -bind => [ $k, $v ] };
525 return +{ -bind => [ $k, undef ] };
527 return $self->expand_expr($v);
532 #======================================================================
534 #======================================================================
537 my ($self, $table, $set, $where, $options) = @_;
540 if (ref($table) eq 'HASH') {
544 @clauses{qw(target set where)} = ($table, $set, $where);
545 puke "Unsupported data type specified to \$sql->update"
546 unless ref($clauses{set}) eq 'HASH';
547 @clauses{keys %$options} = values %$options;
551 my @rendered = $self->render_statement({ -update => $stmt });
552 return wantarray ? @rendered : $rendered[0];
555 sub _render_update_clause_target {
556 my ($self, undef, $target) = @_;
557 $self->join_query_parts(' ', { -keyword => 'update' }, $target);
560 sub _update_set_values {
561 my ($self, $data) = @_;
563 return @{ $self->render_aqt(
564 $self->_expand_update_set_values(undef, $data),
568 sub _expand_update_set_values {
569 my ($self, undef, $data) = @_;
570 $self->expand_maybe_list_expr( [
573 $set = { -bind => $_ } unless defined $set;
574 +{ -op => [ '=', { -ident => $k }, $set ] };
580 ? ($self->{array_datatypes}
581 ? [ $k, +{ -bind => [ $k, $v ] } ]
582 : [ $k, +{ -literal => $v } ])
584 local our $Cur_Col_Meta = $k;
585 [ $k, $self->_expand_expr($v) ]
592 sub _expand_update_clause_target {
593 my ($self, undef, $target) = @_;
594 +(target => $self->expand_maybe_list_expr($target, -ident));
597 sub _expand_update_clause_set {
598 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
599 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
602 sub _expand_update_clause_where {
603 +(where => $_[0]->expand_expr($_[2]));
606 sub _expand_update_clause_returning {
607 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
610 # So that subclasses can override UPDATE ... RETURNING separately from
612 sub _update_returning { shift->_returning(@_) }
616 #======================================================================
618 #======================================================================
621 my ($self, @args) = @_;
623 if (ref(my $sel = $args[0]) eq 'HASH') {
627 @clauses{qw(from select where order_by)} = @args;
629 # This oddity is to literalify since historically SQLA doesn't quote
630 # a single identifier argument, so we convert it into a literal
632 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
633 unless ref($clauses{select});
638 my @rendered = $self->render_statement({ -select => $stmt });
639 return wantarray ? @rendered : $rendered[0];
642 sub _expand_select_clause_select {
643 my ($self, undef, $select) = @_;
644 +(select => $self->expand_maybe_list_expr($select, -ident));
647 sub _expand_select_clause_from {
648 my ($self, undef, $from) = @_;
649 +(from => $self->expand_maybe_list_expr($from, -ident));
652 sub _expand_select_clause_where {
653 my ($self, undef, $where) = @_;
656 if (my $conv = $self->{convert}) {
668 ->wrap_expander(bind => $_wrap)
669 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value))
670 ->wrap_expander(func => sub {
673 my ($self, $type, $thing) = @_;
674 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
675 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
678 or $thing->[1]{-value}
679 or $thing->[1]{-bind})
681 return { -func => $thing }; # already went through our expander
683 return $self->$orig($type, $thing);
691 return +(where => $sqla->expand_expr($where));
694 sub _expand_select_clause_order_by {
695 my ($self, undef, $order_by) = @_;
696 +(order_by => $self->_expand_order_by($order_by));
700 my ($self, $fields) = @_;
701 return $fields unless ref($fields);
702 return @{ $self->render_aqt(
703 $self->expand_maybe_list_expr($fields, '-ident')
707 #======================================================================
709 #======================================================================
712 my ($self, $table, $where, $options) = @_;
715 if (ref($table) eq 'HASH') {
718 my %clauses = (target => $table, where => $where, %{$options||{}});
722 my @rendered = $self->render_statement({ -delete => $stmt });
723 return wantarray ? @rendered : $rendered[0];
726 # So that subclasses can override DELETE ... RETURNING separately from
728 sub _delete_returning { shift->_returning(@_) }
730 sub _expand_delete_clause_target {
731 +(target => $_[0]->expand_maybe_list_expr($_[2], -ident));
734 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
736 sub _expand_delete_clause_returning {
737 +(returning => $_[0]->expand_maybe_list_expr($_[2], -ident));
740 sub _render_delete_clause_target {
741 my ($self, undef, $from) = @_;
742 $self->join_query_parts(' ', { -keyword => 'delete from' }, $from);
745 #======================================================================
747 #======================================================================
751 # Finally, a separate routine just to handle WHERE clauses
753 my ($self, $where, $order) = @_;
755 local $self->{convert_where} = $self->{convert};
758 my ($sql, @bind) = defined($where)
759 ? $self->_recurse_where($where)
761 $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
765 my ($order_sql, @order_bind) = $self->_order_by($order);
767 push @bind, @order_bind;
770 return wantarray ? ($sql, @bind) : $sql;
773 { our $Default_Scalar_To = -value }
776 my ($self, $expr, $default_scalar_to) = @_;
777 local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to;
778 $self->_expand_expr($expr);
782 my ($self, $aqt, $top_level) = @_;
783 my ($k, $v, @rest) = %$aqt;
785 die "Not a node type: $k" unless $k =~ s/^-//;
786 if (my $meth = $self->{render}{$k}) {
787 local our $Render_Top_Level = $top_level;
788 return $self->$meth($k, $v);
790 die "notreached: $k";
794 my ($self, $expr, $default_scalar_to) = @_;
795 return @{ $self->render_aqt(
796 $self->expand_expr($expr, $default_scalar_to)
800 sub render_statement {
801 my ($self, $expr, $default_scalar_to) = @_;
803 $self->expand_expr($expr, $default_scalar_to), 1
807 sub _expand_statement {
808 my ($self, $type, $args) = @_;
809 my $ec = $self->{expand_clause};
812 $args->{$type} = delete $args->{_}
814 my %has_clause = map +($_ => 1), @{$self->{clauses_of}{$type}};
815 return +{ "-${type}" => +{
817 my $val = $args->{$_};
818 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
819 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
824 } elsif ($has_clause{$_}) {
825 ($_ => $self->expand_expr($val))
833 sub _render_statement {
834 my ($self, $type, $args) = @_;
836 foreach my $clause (@{$self->{clauses_of}{$type}}) {
837 next unless my $clause_expr = $args->{$clause};
839 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
840 $self->$rdr($clause, $clause_expr, $args);
842 my $r = $self->render_aqt($clause_expr, 1);
843 next unless defined $r->[0] and length $r->[0];
844 $self->join_query_parts(' ',
845 { -keyword => $clause },
852 my $q = $self->join_query_parts(' ', @parts);
853 return $self->join_query_parts('',
854 (our $Render_Top_Level ? $q : ('(', $q, ')'))
859 my ($self, $raw) = @_;
861 return $op if grep $_->{$op}, @{$self}{qw(is_op expand_op render_op)};
862 s/^-(?=.)//, s/\s+/_/g for $op;
867 my ($self, $expr) = @_;
868 our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1;
869 return undef unless defined($expr);
870 if (ref($expr) eq 'HASH') {
871 return undef unless my $kc = keys %$expr;
873 return $self->_expand_op_andor(and => $expr);
875 my ($key, $value) = %$expr;
876 if ($key =~ /^-/ and $key =~ s/ [_\s]? \d+ $//x ) {
877 belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
878 . "You probably wanted ...-and => [ $key => COND1, $key => COND2 ... ]";
880 return $self->_expand_hashpair($key, $value);
882 if (ref($expr) eq 'ARRAY') {
883 return $self->_expand_op_andor(lc($self->{logic}), $expr);
885 if (my $literal = is_literal_value($expr)) {
886 return +{ -literal => $literal };
888 if (!ref($expr) or Scalar::Util::blessed($expr)) {
889 return $self->_expand_scalar($expr);
894 sub _expand_hashpair {
895 my ($self, $k, $v) = @_;
896 unless (defined($k) and length($k)) {
897 if (defined($k) and my $literal = is_literal_value($v)) {
898 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
899 return { -literal => $literal };
901 puke "Supplying an empty left hand side argument is not supported";
904 return $self->_expand_hashpair_op($k, $v);
905 } elsif ($k =~ /^[^\w]/i) {
906 my ($lhs, @rhs) = ref($v) eq 'ARRAY' ? @$v : $v;
907 return $self->_expand_op(
908 -op, [ $k, $self->expand_expr($lhs, -ident), @rhs ]
911 return $self->_expand_hashpair_ident($k, $v);
914 sub _expand_hashpair_ident {
915 my ($self, $k, $v) = @_;
917 local our $Cur_Col_Meta = $k;
919 # hash with multiple or no elements is andor
921 if (ref($v) eq 'HASH' and keys %$v != 1) {
922 return $self->_expand_op_andor(and => $v, $k);
925 # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL
927 if (is_undef_value($v)) {
928 return $self->_expand_hashpair_cmp($k => undef);
931 # scalars and objects get expanded as whatever requested or values
933 if (!ref($v) or Scalar::Util::blessed($v)) {
934 return $self->_expand_hashpair_scalar($k, $v);
937 # single key hashref is a hashtriple
939 if (ref($v) eq 'HASH') {
940 return $self->_expand_hashtriple($k, %$v);
943 # arrayref needs re-engineering over the elements
945 if (ref($v) eq 'ARRAY') {
946 return $self->sqlfalse unless @$v;
947 $self->_debug("ARRAY($k) means distribute over elements");
949 $v->[0] =~ /^-(and|or)$/i
950 ? (shift(@{$v = [ @$v ]}), $1)
951 : lc($self->{logic} || 'OR')
953 return $self->_expand_op_andor(
958 if (my $literal = is_literal_value($v)) {
960 belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
963 my ($sql, @bind) = @$literal;
964 if ($self->{bindtype} eq 'columns') {
966 $self->_assert_bindval_matches_bindtype($_);
969 return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
975 my ($self, $expr) = @_;
977 return $self->_expand_expr({ (our $Default_Scalar_To) => $expr });
980 sub _expand_hashpair_scalar {
981 my ($self, $k, $v) = @_;
983 return $self->_expand_hashpair_cmp(
984 $k, $self->_expand_scalar($v),
988 sub _expand_hashpair_op {
989 my ($self, $k, $v) = @_;
991 $self->_assert_pass_injection_guard($k =~ /\A-(.*)\Z/s);
993 my $op = $self->_normalize_op($k);
997 my $op = join(' ', split '_', $op);
999 # the old special op system requires illegality for top-level use
1002 (our $Expand_Depth) == 1
1004 List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
1006 $self->{disable_old_special_ops}
1007 and List::Util::first { $op =~ $_->{regex} } @BUILTIN_SPECIAL_OPS
1011 puke "Illegal use of top-level '-$op'"
1015 if (my $exp = $self->{expand}{$op}||$self->{expand_op}{$op}) {
1016 return $self->$exp($op, $v);
1019 # Ops prefixed with -not_ get converted
1021 if (my ($rest) = $op =~/^not_(.*)$/) {
1024 $self->_expand_expr({ "-${rest}", $v })
1030 # the old unary op system means we should touch nothing and let it work
1032 my $op = join(' ', split '_', $op);
1034 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1035 return { -op => [ $op, $v ] };
1040 $self->{unknown_unop_always_func} && !$self->{render_op}{$op}
1050 and (keys %$v)[0] =~ /^-/
1054 (List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}})
1055 or $self->{render_op}{$op}
1063 if ($type eq -func and ref($v) eq 'ARRAY') {
1064 return $self->_expand_expr({ -func => [ $op, @$v ] });
1067 return $self->_expand_expr({ $type => [ $op, $v ] });
1070 sub _expand_hashpair_cmp {
1071 my ($self, $k, $v) = @_;
1072 $self->_expand_hashtriple($k, $self->{cmp}, $v);
1075 sub _expand_hashtriple {
1076 my ($self, $k, $vk, $vv) = @_;
1078 my $ik = $self->_expand_expr({ -ident => $k });
1080 my $op = $self->_normalize_op($vk);
1081 $self->_assert_pass_injection_guard($op);
1083 if ($op =~ s/ _? \d+ $//x ) {
1084 return $self->_expand_expr($k, { $vk, $vv });
1086 if (my $x = $self->{expand_op}{$op}) {
1087 local our $Cur_Col_Meta = $k;
1088 return $self->$x($op, $vv, $k);
1092 my $op = join(' ', split '_', $op);
1094 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1095 return { -op => [ $op, $ik, $vv ] };
1097 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1101 { -op => [ $op, $vv ] }
1105 if (ref($vv) eq 'ARRAY') {
1107 my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i)
1108 ? (shift(@raw), lc $1) : 'or';
1109 my @values = map +{ $vk => $_ }, @raw;
1111 $op =~ $self->{inequality_op}
1112 or $op =~ $self->{not_like_op}
1114 if (lc($logic) eq 'or' and @values > 1) {
1115 belch "A multi-element arrayref as an argument to the inequality op '${\uc(join ' ', split '_', $op)}' "
1116 . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1117 . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1122 # try to DWIM on equality operators
1123 return ($self->_dwim_op_to_is($op,
1124 "Supplying an empty arrayref to '%s' is deprecated",
1125 "operator '%s' applied on an empty array (field '$k')"
1126 ) ? $self->sqlfalse : $self->sqltrue);
1128 return $self->_expand_op_andor($logic => \@values, $k);
1130 if (is_undef_value($vv)) {
1131 my $is = ($self->_dwim_op_to_is($op,
1132 "Supplying an undefined argument to '%s' is deprecated",
1133 "unexpected operator '%s' with undef operand",
1134 ) ? 'is' : 'is not');
1136 return $self->_expand_hashpair($k => { $is, undef });
1138 local our $Cur_Col_Meta = $k;
1142 $self->_expand_expr($vv)
1146 sub _dwim_op_to_is {
1147 my ($self, $raw, $empty, $fail) = @_;
1149 my $op = $self->_normalize_op($raw);
1151 if ($op =~ /^not$/i) {
1154 if ($op =~ $self->{equality_op}) {
1157 if ($op =~ $self->{like_op}) {
1158 belch(sprintf $empty, uc(join ' ', split '_', $op));
1161 if ($op =~ $self->{inequality_op}) {
1164 if ($op =~ $self->{not_like_op}) {
1165 belch(sprintf $empty, uc(join ' ', split '_', $op));
1168 puke(sprintf $fail, $op);
1172 my ($self, undef, $args) = @_;
1173 my ($func, @args) = @$args;
1174 return +{ -func => [ $func, map $self->expand_expr($_), @args ] };
1178 my ($self, undef, $body, $k) = @_;
1179 return $self->_expand_hashpair_cmp(
1180 $k, { -ident => $body }
1182 unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) {
1183 puke "-ident requires a single plain scalar argument (a quotable identifier) or an arrayref of identifier parts";
1185 my @parts = map split(/\Q${\($self->{name_sep}||'.')}\E/, $_),
1186 ref($body) ? @$body : $body;
1187 return { -ident => $parts[-1] } if $self->{_dequalify_idents};
1188 unless ($self->{quote_char}) {
1189 $self->_assert_pass_injection_guard($_) for @parts;
1191 return +{ -ident => \@parts };
1195 return $_[0]->_expand_hashpair_cmp(
1196 $_[3], { -value => $_[2] },
1197 ) if defined($_[3]);
1198 +{ -bind => [ our $Cur_Col_Meta, $_[2] ] };
1202 my ($self, undef, $args) = @_;
1203 +{ -row => [ map $self->expand_expr($_), @$args ] };
1207 my ($self, undef, $args) = @_;
1208 my ($op, @opargs) = @$args;
1209 if (my $exp = $self->{expand_op}{$op}) {
1210 return $self->$exp($op, \@opargs);
1212 +{ -op => [ $op, map $self->expand_expr($_), @opargs ] };
1216 my ($self, undef, $v) = @_;
1218 return $self->_expand_expr($v);
1220 puke "-bool => undef not supported" unless defined($v);
1221 return $self->_expand_expr({ -ident => $v });
1224 sub _expand_op_andor {
1225 my ($self, $logop, $v, $k) = @_;
1227 $v = [ map +{ $k, $_ },
1229 ? (map +{ $_ => $v->{$_} }, sort keys %$v)
1233 if (ref($v) eq 'HASH') {
1234 return undef unless keys %$v;
1237 map $self->_expand_expr({ $_ => $v->{$_} }),
1241 if (ref($v) eq 'ARRAY') {
1242 $logop eq 'and' or $logop eq 'or' or puke "unknown logic: $logop";
1245 (ref($_) eq 'ARRAY' and @$_)
1246 or (ref($_) eq 'HASH' and %$_)
1252 while (my ($el) = splice @expr, 0, 1) {
1253 puke "Supplying an empty left hand side argument is not supported in array-pairs"
1254 unless defined($el) and length($el);
1255 my $elref = ref($el);
1257 local our $Expand_Depth = 0;
1258 push(@res, grep defined, $self->_expand_expr({ $el, shift(@expr) }));
1259 } elsif ($elref eq 'ARRAY') {
1260 push(@res, grep defined, $self->_expand_expr($el)) if @$el;
1261 } elsif (my $l = is_literal_value($el)) {
1262 push @res, { -literal => $l };
1263 } elsif ($elref eq 'HASH') {
1264 local our $Expand_Depth = 0;
1265 push @res, grep defined, $self->_expand_expr($el) if %$el;
1271 # return $res[0] if @res == 1;
1272 return { -op => [ $logop, @res ] };
1278 my ($self, $op, $vv, $k) = @_;
1279 ($k, $vv) = @$vv unless defined $k;
1280 puke "$op can only take undef as argument"
1284 and exists($vv->{-value})
1285 and !defined($vv->{-value})
1287 return +{ -op => [ $op.'_null', $self->expand_expr($k, -ident) ] };
1290 sub _expand_between {
1291 my ($self, $op, $vv, $k) = @_;
1292 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1293 my @rhs = map $self->_expand_expr($_),
1294 ref($vv) eq 'ARRAY' ? @$vv : $vv;
1296 (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
1298 (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
1300 puke "Operator '${\uc($op)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1304 $self->expand_expr(ref($k) ? $k : { -ident => $k }),
1305 map $self->expand_expr($_, -value), @rhs
1310 my ($self, $op, $vv, $k) = @_;
1311 $k = shift @{$vv = [ @$vv ]} unless defined $k;
1312 if (my $literal = is_literal_value($vv)) {
1313 my ($sql, @bind) = @$literal;
1314 my $opened_sql = $self->_open_outer_paren($sql);
1316 $op, $self->expand_expr($k, -ident),
1317 { -literal => [ $opened_sql, @bind ] }
1321 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1322 . "-${\uc($op)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1323 . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1324 . 'will emit the logically correct SQL instead of raising this exception)'
1326 puke("Argument passed to the '${\uc($op)}' operator can not be undefined")
1328 my @rhs = map $self->expand_expr($_, -value),
1329 map { defined($_) ? $_: puke($undef_err) }
1330 (ref($vv) eq 'ARRAY' ? @$vv : $vv);
1331 return $self->${\($op =~ /^not/ ? 'sqltrue' : 'sqlfalse')} unless @rhs;
1335 $self->expand_expr($k, -ident),
1341 my ($self, undef, $v) = @_;
1342 # DBIx::Class requires a nest warning to be emitted once but the private
1343 # method it overrode to do so no longer exists
1344 if ($self->{warn_once_on_nest}) {
1345 unless (our $Nest_Warned) {
1347 "-nest in search conditions is deprecated, you most probably wanted:\n"
1348 .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }|
1353 return $self->_expand_expr($v);
1357 my ($self, $type, $v) = @_;
1358 return { "-${type}" => $v };
1361 sub _expand_values {
1362 my ($self, undef, $values) = @_;
1363 return { -values => [
1366 ? $self->expand_expr($_)
1367 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
1368 ), ref($values) eq 'ARRAY' ? @$values : $values
1372 sub _recurse_where {
1373 my ($self, $where) = @_;
1375 # Special case: top level simple string treated as literal
1377 my $where_exp = (ref($where)
1378 ? $self->_expand_select_clause_where(undef, $where)
1379 : { -literal => [ $where ] });
1381 # dispatch expanded expression
1383 my ($sql, @bind) = defined($where_exp) ? @{ $self->render_aqt($where_exp) || [] } : ();
1384 # DBIx::Class used to call _recurse_where in scalar context
1385 # something else might too...
1387 return ($sql, @bind);
1390 belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
1396 my ($self, undef, $ident) = @_;
1398 return [ $self->_quote($ident) ];
1402 my ($self, undef, $values) = @_;
1403 return $self->join_query_parts('',
1405 $self->_render_op(undef, [ ',', @$values ]),
1411 my ($self, undef, $rest) = @_;
1412 my ($func, @args) = @$rest;
1413 return $self->join_query_parts('',
1414 $self->_sqlcase($func),
1415 $self->join_query_parts('',
1417 $self->join_query_parts(', ', @args),
1424 my ($self, undef, $bind) = @_;
1425 return [ '?', $self->_bindtype(@$bind) ];
1428 sub _render_literal {
1429 my ($self, undef, $literal) = @_;
1430 $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1434 sub _render_keyword {
1435 my ($self, undef, $keyword) = @_;
1436 return [ $self->_sqlcase(join ' ', split '_', $keyword) ];
1440 my ($self, undef, $v) = @_;
1441 my ($op, @args) = @$v;
1442 if (my $r = $self->{render_op}{$op}) {
1443 return $self->$r($op, \@args);
1448 my $op = join(' ', split '_', $op);
1450 my $ss = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}};
1451 if ($ss and @args > 1) {
1452 puke "Special op '${op}' requires first value to be identifier"
1453 unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0];
1454 my $k = join(($self->{name_sep}||'.'), @$ident);
1455 local our $Expand_Depth = 1;
1456 return [ $self->${\($ss->{handler})}($k, $op, $args[1]) ];
1458 if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
1459 return [ $self->${\($us->{handler})}($op, $args[0]) ];
1462 return $self->_render_unop_paren($op, \@args);
1466 return $self->_render_unop_prefix($op, \@args);
1468 return $self->_render_op_multop($op, \@args);
1474 sub _render_op_between {
1475 my ($self, $op, $args) = @_;
1476 my ($left, $low, $high) = @$args;
1479 puke "Single arg to between must be a literal"
1480 unless $low->{-literal};
1483 +($low, { -keyword => 'and' }, $high);
1486 return $self->join_query_parts(' ',
1487 '(', $left, { -keyword => $op }, @rh, ')',
1492 my ($self, $op, $args) = @_;
1493 my ($lhs, @rhs) = @$args;
1495 return $self->join_query_parts(' ',
1497 { -keyword => $op },
1498 $self->join_query_parts(' ',
1500 $self->join_query_parts(', ', @rhs),
1506 sub _render_op_andor {
1507 my ($self, $op, $args) = @_;
1508 return undef unless @$args;
1509 return $self->join_query_parts('', $args->[0]) if @$args == 1;
1510 my $inner = $self->_render_op_multop($op, $args);
1511 return undef unless defined($inner->[0]) and length($inner->[0]);
1512 return $self->join_query_parts(' ',
1517 sub _render_op_multop {
1518 my ($self, $op, $args) = @_;
1520 return undef unless @parts;
1521 return $self->render_aqt($parts[0]) if @parts == 1;
1522 my $join = ($op eq ','
1524 : $self->_sqlcase(' '.(join ' ', split '_', $op).' ')
1526 return $self->join_query_parts($join, @parts);
1529 sub _render_values {
1530 my ($self, undef, $values) = @_;
1531 my $inner = $self->join_query_parts(' ',
1532 { -keyword => 'values' },
1533 $self->join_query_parts(', ',
1534 ref($values) eq 'ARRAY' ? @$values : $values
1537 return $self->join_query_parts('',
1538 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
1542 sub join_query_parts {
1543 my ($self, $join, @parts) = @_;
1546 ? $self->render_aqt($_)
1547 : ((ref($_) eq 'ARRAY') ? $_ : [ $_ ])
1550 $self->{join_sql_parts}->(
1551 $join, grep defined && length, map $_->[0], @final
1553 (map @{$_}[1..$#$_], @final),
1557 sub _render_unop_paren {
1558 my ($self, $op, $v) = @_;
1559 return $self->join_query_parts('',
1560 '(', $self->_render_unop_prefix($op, $v), ')'
1564 sub _render_unop_prefix {
1565 my ($self, $op, $v) = @_;
1566 return $self->join_query_parts(' ',
1567 $self->_sqlcase($op), $v->[0]
1571 sub _render_unop_postfix {
1572 my ($self, $op, $v) = @_;
1573 return $self->join_query_parts(' ',
1574 $v->[0], { -keyword => $op },
1578 # Some databases (SQLite) treat col IN (1, 2) different from
1579 # col IN ( (1, 2) ). Use this to strip all outer parens while
1580 # adding them back in the corresponding method
1581 sub _open_outer_paren {
1582 my ($self, $sql) = @_;
1584 while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1586 # there are closing parens inside, need the heavy duty machinery
1587 # to reevaluate the extraction starting from $sql (full reevaluation)
1588 if ($inner =~ /\)/) {
1589 require Text::Balanced;
1591 my (undef, $remainder) = do {
1592 # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1594 Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1597 # the entire expression needs to be a balanced bracketed thing
1598 # (after an extract no remainder sans trailing space)
1599 last if defined $remainder and $remainder =~ /\S/;
1609 #======================================================================
1611 #======================================================================
1613 sub _expand_order_by {
1614 my ($self, $arg) = @_;
1616 return unless defined($arg) and not (ref($arg) eq 'ARRAY' and !@$arg);
1618 return $self->expand_maybe_list_expr($arg)
1619 if ref($arg) eq 'HASH' and ($arg->{-op}||[''])->[0] eq ',';
1621 my $expander = sub {
1622 my ($self, $dir, $expr) = @_;
1623 my @to_expand = ref($expr) eq 'ARRAY' ? @$expr : $expr;
1624 foreach my $arg (@to_expand) {
1628 and grep /^-(asc|desc)$/, keys %$arg
1630 puke "ordering direction hash passed to order by must have exactly one key (-asc or -desc)";
1634 defined($dir) ? { -op => [ $dir =~ /^-?(.*)$/ ,=> $_ ] } : $_
1636 map $self->expand_expr($_, -ident),
1637 map ref($_) eq 'ARRAY' ? @$_ : $_, @to_expand;
1638 return undef unless @exp;
1639 return undef if @exp == 1 and not defined($exp[0]);
1640 return +{ -op => [ ',', @exp ] };
1643 local @{$self->{expand}}{qw(asc desc)} = (($expander) x 2);
1645 return $self->$expander(undef, $arg);
1649 my ($self, $arg) = @_;
1651 return '' unless defined(my $expanded = $self->_expand_order_by($arg));
1653 my ($sql, @bind) = @{ $self->render_aqt($expanded) };
1655 return '' unless length($sql);
1657 my $final_sql = $self->_sqlcase(' order by ').$sql;
1659 return ($final_sql, @bind);
1662 # _order_by no longer needs to call this so doesn't but DBIC uses it.
1664 sub _order_by_chunks {
1665 my ($self, $arg) = @_;
1667 return () unless defined(my $expanded = $self->_expand_order_by($arg));
1669 my @res = $self->_chunkify_order_by($expanded);
1670 (ref() ? $_->[0] : $_) .= '' for @res;
1674 sub _chunkify_order_by {
1675 my ($self, $expanded) = @_;
1677 return grep length, @{ $self->render_aqt($expanded) }
1678 if $expanded->{-ident} or @{$expanded->{-literal}||[]} == 1;
1681 if (ref() eq 'HASH' and $_->{-op} and $_->{-op}[0] eq ',') {
1682 my ($comma, @list) = @{$_->{-op}};
1683 return map $self->_chunkify_order_by($_), @list;
1685 return $self->render_aqt($_);
1689 #======================================================================
1690 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1691 #======================================================================
1697 $self->expand_maybe_list_expr($from, -ident)
1702 #======================================================================
1704 #======================================================================
1706 sub expand_maybe_list_expr {
1707 my ($self, $expr, $default) = @_;
1709 ',', map $self->expand_expr($_, $default),
1710 @{$expr->{-op}}[1..$#{$expr->{-op}}]
1711 ] } if ref($expr) eq 'HASH' and ($expr->{-op}||[''])->[0] eq ',';
1712 return +{ -op => [ ',',
1713 map $self->expand_expr($_, $default),
1714 ref($expr) eq 'ARRAY' ? @$expr : $expr
1718 # highly optimized, as it's called way too often
1720 # my ($self, $label) = @_;
1722 return '' unless defined $_[1];
1723 return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1724 puke 'Identifier cannot be hashref' if ref($_[1]) eq 'HASH';
1726 unless ($_[0]->{quote_char}) {
1727 if (ref($_[1]) eq 'ARRAY') {
1728 return join($_[0]->{name_sep}||'.', @{$_[1]});
1730 $_[0]->_assert_pass_injection_guard($_[1]);
1735 my $qref = ref $_[0]->{quote_char};
1737 !$qref ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1738 : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1739 : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1741 my $esc = $_[0]->{escape_char} || $r;
1743 # parts containing * are naturally unquoted
1745 $_[0]->{name_sep}||'',
1749 : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r }
1751 (ref($_[1]) eq 'ARRAY'
1755 ? split (/\Q$_[0]->{name_sep}\E/, $_[1] )
1763 # Conversion, if applicable
1765 #my ($self, $arg) = @_;
1766 if (my $conv = $_[0]->{convert_where}) {
1767 return @{ $_[0]->join_query_parts('',
1768 $_[0]->_sqlcase($conv),
1777 #my ($self, $col, @vals) = @_;
1778 # called often - tighten code
1779 return $_[0]->{bindtype} eq 'columns'
1780 ? map {[$_[1], $_]} @_[2 .. $#_]
1785 # Dies if any element of @bind is not in [colname => value] format
1786 # if bindtype is 'columns'.
1787 sub _assert_bindval_matches_bindtype {
1788 # my ($self, @bind) = @_;
1790 if ($self->{bindtype} eq 'columns') {
1792 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1793 puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1799 sub _join_sql_clauses {
1800 my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1802 if (@$clauses_aref > 1) {
1803 my $join = " " . $self->_sqlcase($logic) . " ";
1804 my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1805 return ($sql, @$bind_aref);
1807 elsif (@$clauses_aref) {
1808 return ($clauses_aref->[0], @$bind_aref); # no parentheses
1811 return (); # if no SQL, ignore @$bind_aref
1816 # Fix SQL case, if so requested
1818 # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1819 # don't touch the argument ... crooked logic, but let's not change it!
1820 return $_[0]->{case} ? $_[1] : uc($_[1]);
1823 #======================================================================
1824 # DISPATCHING FROM REFKIND
1825 #======================================================================
1828 my ($self, $data) = @_;
1830 return 'UNDEF' unless defined $data;
1832 # blessed objects are treated like scalars
1833 my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1835 return 'SCALAR' unless $ref;
1838 while ($ref eq 'REF') {
1840 $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1844 return ($ref||'SCALAR') . ('REF' x $n_steps);
1848 my ($self, $data) = @_;
1849 my @try = ($self->_refkind($data));
1850 push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1851 push @try, 'FALLBACK';
1855 sub _METHOD_FOR_refkind {
1856 my ($self, $meth_prefix, $data) = @_;
1859 for (@{$self->_try_refkind($data)}) {
1860 $method = $self->can($meth_prefix."_".$_)
1864 return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1868 sub _SWITCH_refkind {
1869 my ($self, $data, $dispatch_table) = @_;
1872 for (@{$self->_try_refkind($data)}) {
1873 $coderef = $dispatch_table->{$_}
1877 puke "no dispatch entry for ".$self->_refkind($data)
1886 #======================================================================
1887 # VALUES, GENERATE, AUTOLOAD
1888 #======================================================================
1890 # LDNOTE: original code from nwiger, didn't touch code in that section
1891 # I feel the AUTOLOAD stuff should not be the default, it should
1892 # only be activated on explicit demand by user.
1896 my $data = shift || return;
1897 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1898 unless ref $data eq 'HASH';
1901 foreach my $k (sort keys %$data) {
1902 my $v = $data->{$k};
1903 $self->_SWITCH_refkind($v, {
1905 if ($self->{array_datatypes}) { # array datatype
1906 push @all_bind, $self->_bindtype($k, $v);
1908 else { # literal SQL with bind
1909 my ($sql, @bind) = @$v;
1910 $self->_assert_bindval_matches_bindtype(@bind);
1911 push @all_bind, @bind;
1914 ARRAYREFREF => sub { # literal SQL with bind
1915 my ($sql, @bind) = @${$v};
1916 $self->_assert_bindval_matches_bindtype(@bind);
1917 push @all_bind, @bind;
1919 SCALARREF => sub { # literal SQL without bind
1921 SCALAR_or_UNDEF => sub {
1922 push @all_bind, $self->_bindtype($k, $v);
1933 my(@sql, @sqlq, @sqlv);
1937 if ($ref eq 'HASH') {
1938 for my $k (sort keys %$_) {
1941 my $label = $self->_quote($k);
1942 if ($r eq 'ARRAY') {
1943 # literal SQL with bind
1944 my ($sql, @bind) = @$v;
1945 $self->_assert_bindval_matches_bindtype(@bind);
1946 push @sqlq, "$label = $sql";
1948 } elsif ($r eq 'SCALAR') {
1949 # literal SQL without bind
1950 push @sqlq, "$label = $$v";
1952 push @sqlq, "$label = ?";
1953 push @sqlv, $self->_bindtype($k, $v);
1956 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1957 } elsif ($ref eq 'ARRAY') {
1958 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1961 if ($r eq 'ARRAY') { # literal SQL with bind
1962 my ($sql, @bind) = @$v;
1963 $self->_assert_bindval_matches_bindtype(@bind);
1966 } elsif ($r eq 'SCALAR') { # literal SQL without bind
1967 # embedded literal SQL
1974 push @sql, '(' . join(', ', @sqlq) . ')';
1975 } elsif ($ref eq 'SCALAR') {
1979 # strings get case twiddled
1980 push @sql, $self->_sqlcase($_);
1984 my $sql = join ' ', @sql;
1986 # this is pretty tricky
1987 # if ask for an array, return ($stmt, @bind)
1988 # otherwise, s/?/shift @sqlv/ to put it inline
1990 return ($sql, @sqlv);
1992 1 while $sql =~ s/\?/my $d = shift(@sqlv);
1993 ref $d ? $d->[1] : $d/e;
2002 # This allows us to check for a local, then _form, attr
2004 my($name) = $AUTOLOAD =~ /.*::(.+)/;
2005 puke "AUTOLOAD invoked for method name ${name} and allow_autoload option not set" unless $self->{allow_autoload};
2006 return $self->generate($name, @_);
2017 SQL::Abstract - Generate SQL from Perl data structures
2023 my $sql = SQL::Abstract->new;
2025 my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
2027 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
2029 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
2031 my($stmt, @bind) = $sql->delete($table, \%where);
2033 # Then, use these in your DBI statements
2034 my $sth = $dbh->prepare($stmt);
2035 $sth->execute(@bind);
2037 # Just generate the WHERE clause
2038 my($stmt, @bind) = $sql->where(\%where, $order);
2040 # Return values in the same order, for hashed queries
2041 # See PERFORMANCE section for more details
2042 my @bind = $sql->values(\%fieldvals);
2046 This module was inspired by the excellent L<DBIx::Abstract>.
2047 However, in using that module I found that what I really wanted
2048 to do was generate SQL, but still retain complete control over my
2049 statement handles and use the DBI interface. So, I set out to
2050 create an abstract SQL generation module.
2052 While based on the concepts used by L<DBIx::Abstract>, there are
2053 several important differences, especially when it comes to WHERE
2054 clauses. I have modified the concepts used to make the SQL easier
2055 to generate from Perl data structures and, IMO, more intuitive.
2056 The underlying idea is for this module to do what you mean, based
2057 on the data structures you provide it. The big advantage is that
2058 you don't have to modify your code every time your data changes,
2059 as this module figures it out.
2061 To begin with, an SQL INSERT is as easy as just specifying a hash
2062 of C<key=value> pairs:
2065 name => 'Jimbo Bobson',
2066 phone => '123-456-7890',
2067 address => '42 Sister Lane',
2068 city => 'St. Louis',
2069 state => 'Louisiana',
2072 The SQL can then be generated with this:
2074 my($stmt, @bind) = $sql->insert('people', \%data);
2076 Which would give you something like this:
2078 $stmt = "INSERT INTO people
2079 (address, city, name, phone, state)
2080 VALUES (?, ?, ?, ?, ?)";
2081 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2082 '123-456-7890', 'Louisiana');
2084 These are then used directly in your DBI code:
2086 my $sth = $dbh->prepare($stmt);
2087 $sth->execute(@bind);
2089 =head2 Inserting and Updating Arrays
2091 If your database has array types (like for example Postgres),
2092 activate the special option C<< array_datatypes => 1 >>
2093 when creating the C<SQL::Abstract> object.
2094 Then you may use an arrayref to insert and update database array types:
2096 my $sql = SQL::Abstract->new(array_datatypes => 1);
2098 planets => [qw/Mercury Venus Earth Mars/]
2101 my($stmt, @bind) = $sql->insert('solar_system', \%data);
2105 $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2107 @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2110 =head2 Inserting and Updating SQL
2112 In order to apply SQL functions to elements of your C<%data> you may
2113 specify a reference to an arrayref for the given hash value. For example,
2114 if you need to execute the Oracle C<to_date> function on a value, you can
2115 say something like this:
2119 date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2122 The first value in the array is the actual SQL. Any other values are
2123 optional and would be included in the bind values array. This gives
2126 my($stmt, @bind) = $sql->insert('people', \%data);
2128 $stmt = "INSERT INTO people (name, date_entered)
2129 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2130 @bind = ('Bill', '03/02/2003');
2132 An UPDATE is just as easy, all you change is the name of the function:
2134 my($stmt, @bind) = $sql->update('people', \%data);
2136 Notice that your C<%data> isn't touched; the module will generate
2137 the appropriately quirky SQL for you automatically. Usually you'll
2138 want to specify a WHERE clause for your UPDATE, though, which is
2139 where handling C<%where> hashes comes in handy...
2141 =head2 Complex where statements
2143 This module can generate pretty complicated WHERE statements
2144 easily. For example, simple C<key=value> pairs are taken to mean
2145 equality, and if you want to see if a field is within a set
2146 of values, you can use an arrayref. Let's say we wanted to
2147 SELECT some data based on this criteria:
2150 requestor => 'inna',
2151 worker => ['nwiger', 'rcwe', 'sfz'],
2152 status => { '!=', 'completed' }
2155 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2157 The above would give you something like this:
2159 $stmt = "SELECT * FROM tickets WHERE
2160 ( requestor = ? ) AND ( status != ? )
2161 AND ( worker = ? OR worker = ? OR worker = ? )";
2162 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2164 Which you could then use in DBI code like so:
2166 my $sth = $dbh->prepare($stmt);
2167 $sth->execute(@bind);
2173 The methods are simple. There's one for every major SQL operation,
2174 and a constructor you use first. The arguments are specified in a
2175 similar order for each method (table, then fields, then a where
2176 clause) to try and simplify things.
2178 =head2 new(option => 'value')
2180 The C<new()> function takes a list of options and values, and returns
2181 a new B<SQL::Abstract> object which can then be used to generate SQL
2182 through the methods below. The options accepted are:
2188 If set to 'lower', then SQL will be generated in all lowercase. By
2189 default SQL is generated in "textbook" case meaning something like:
2191 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2193 Any setting other than 'lower' is ignored.
2197 This determines what the default comparison operator is. By default
2198 it is C<=>, meaning that a hash like this:
2200 %where = (name => 'nwiger', email => 'nate@wiger.org');
2202 Will generate SQL like this:
2204 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2206 However, you may want loose comparisons by default, so if you set
2207 C<cmp> to C<like> you would get SQL such as:
2209 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2211 You can also override the comparison on an individual basis - see
2212 the huge section on L</"WHERE CLAUSES"> at the bottom.
2214 =item sqltrue, sqlfalse
2216 Expressions for inserting boolean values within SQL statements.
2217 By default these are C<1=1> and C<1=0>. They are used
2218 by the special operators C<-in> and C<-not_in> for generating
2219 correct SQL even when the argument is an empty array (see below).
2223 This determines the default logical operator for multiple WHERE
2224 statements in arrays or hashes. If absent, the default logic is "or"
2225 for arrays, and "and" for hashes. This means that a WHERE
2229 event_date => {'>=', '2/13/99'},
2230 event_date => {'<=', '4/24/03'},
2233 will generate SQL like this:
2235 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2237 This is probably not what you want given this query, though (look
2238 at the dates). To change the "OR" to an "AND", simply specify:
2240 my $sql = SQL::Abstract->new(logic => 'and');
2242 Which will change the above C<WHERE> to:
2244 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2246 The logic can also be changed locally by inserting
2247 a modifier in front of an arrayref:
2249 @where = (-and => [event_date => {'>=', '2/13/99'},
2250 event_date => {'<=', '4/24/03'} ]);
2252 See the L</"WHERE CLAUSES"> section for explanations.
2256 This will automatically convert comparisons using the specified SQL
2257 function for both column and value. This is mostly used with an argument
2258 of C<upper> or C<lower>, so that the SQL will have the effect of
2259 case-insensitive "searches". For example, this:
2261 $sql = SQL::Abstract->new(convert => 'upper');
2262 %where = (keywords => 'MaKe iT CAse inSeNSItive');
2264 Will turn out the following SQL:
2266 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2268 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2269 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2270 not validate this option; it will just pass through what you specify verbatim).
2274 This is a kludge because many databases suck. For example, you can't
2275 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2276 Instead, you have to use C<bind_param()>:
2278 $sth->bind_param(1, 'reg data');
2279 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2281 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2282 which loses track of which field each slot refers to. Fear not.
2284 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2285 Currently, you can specify either C<normal> (default) or C<columns>. If you
2286 specify C<columns>, you will get an array that looks like this:
2288 my $sql = SQL::Abstract->new(bindtype => 'columns');
2289 my($stmt, @bind) = $sql->insert(...);
2292 [ 'column1', 'value1' ],
2293 [ 'column2', 'value2' ],
2294 [ 'column3', 'value3' ],
2297 You can then iterate through this manually, using DBI's C<bind_param()>.
2299 $sth->prepare($stmt);
2302 my($col, $data) = @$_;
2303 if ($col eq 'details' || $col eq 'comments') {
2304 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2305 } elsif ($col eq 'image') {
2306 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2308 $sth->bind_param($i, $data);
2312 $sth->execute; # execute without @bind now
2314 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2315 Basically, the advantage is still that you don't have to care which fields
2316 are or are not included. You could wrap that above C<for> loop in a simple
2317 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2318 get a layer of abstraction over manual SQL specification.
2320 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2321 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2322 will expect the bind values in this format.
2326 This is the character that a table or column name will be quoted
2327 with. By default this is an empty string, but you could set it to
2328 the character C<`>, to generate SQL like this:
2330 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2332 Alternatively, you can supply an array ref of two items, the first being the left
2333 hand quote character, and the second the right hand quote character. For
2334 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2335 that generates SQL like this:
2337 SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2339 Quoting is useful if you have tables or columns names that are reserved
2340 words in your database's SQL dialect.
2344 This is the character that will be used to escape L</quote_char>s appearing
2345 in an identifier before it has been quoted.
2347 The parameter default in case of a single L</quote_char> character is the quote
2350 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2351 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2352 of the B<opening (left)> L</quote_char> within the identifier are currently left
2353 untouched. The default for opening-closing-style quotes may change in future
2354 versions, thus you are B<strongly encouraged> to specify the escape character
2359 This is the character that separates a table and column name. It is
2360 necessary to specify this when the C<quote_char> option is selected,
2361 so that tables and column names can be individually quoted like this:
2363 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2365 =item injection_guard
2367 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2368 column name specified in a query structure. This is a safety mechanism to avoid
2369 injection attacks when mishandling user input e.g.:
2371 my %condition_as_column_value_pairs = get_values_from_user();
2372 $sqla->select( ... , \%condition_as_column_value_pairs );
2374 If the expression matches an exception is thrown. Note that literal SQL
2375 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2377 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2379 =item array_datatypes
2381 When this option is true, arrayrefs in INSERT or UPDATE are
2382 interpreted as array datatypes and are passed directly
2384 When this option is false, arrayrefs are interpreted
2385 as literal SQL, just like refs to arrayrefs
2386 (but this behavior is for backwards compatibility; when writing
2387 new queries, use the "reference to arrayref" syntax
2393 Takes a reference to a list of "special operators"
2394 to extend the syntax understood by L<SQL::Abstract>.
2395 See section L</"SPECIAL OPERATORS"> for details.
2399 Takes a reference to a list of "unary operators"
2400 to extend the syntax understood by L<SQL::Abstract>.
2401 See section L</"UNARY OPERATORS"> for details.
2407 =head2 insert($table, \@values || \%fieldvals, \%options)
2409 This is the simplest function. You simply give it a table name
2410 and either an arrayref of values or hashref of field/value pairs.
2411 It returns an SQL INSERT statement and a list of bind values.
2412 See the sections on L</"Inserting and Updating Arrays"> and
2413 L</"Inserting and Updating SQL"> for information on how to insert
2414 with those data types.
2416 The optional C<\%options> hash reference may contain additional
2417 options to generate the insert SQL. Currently supported options
2424 Takes either a scalar of raw SQL fields, or an array reference of
2425 field names, and adds on an SQL C<RETURNING> statement at the end.
2426 This allows you to return data generated by the insert statement
2427 (such as row IDs) without performing another C<SELECT> statement.
2428 Note, however, this is not part of the SQL standard and may not
2429 be supported by all database engines.
2433 =head2 update($table, \%fieldvals, \%where, \%options)
2435 This takes a table, hashref of field/value pairs, and an optional
2436 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2438 See the sections on L</"Inserting and Updating Arrays"> and
2439 L</"Inserting and Updating SQL"> for information on how to insert
2440 with those data types.
2442 The optional C<\%options> hash reference may contain additional
2443 options to generate the update SQL. Currently supported options
2450 See the C<returning> option to
2451 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2455 =head2 select($source, $fields, $where, $order)
2457 This returns a SQL SELECT statement and associated list of bind values, as
2458 specified by the arguments:
2464 Specification of the 'FROM' part of the statement.
2465 The argument can be either a plain scalar (interpreted as a table
2466 name, will be quoted), or an arrayref (interpreted as a list
2467 of table names, joined by commas, quoted), or a scalarref
2468 (literal SQL, not quoted).
2472 Specification of the list of fields to retrieve from
2474 The argument can be either an arrayref (interpreted as a list
2475 of field names, will be joined by commas and quoted), or a
2476 plain scalar (literal SQL, not quoted).
2477 Please observe that this API is not as flexible as that of
2478 the first argument C<$source>, for backwards compatibility reasons.
2482 Optional argument to specify the WHERE part of the query.
2483 The argument is most often a hashref, but can also be
2484 an arrayref or plain scalar --
2485 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2489 Optional argument to specify the ORDER BY part of the query.
2490 The argument can be a scalar, a hashref or an arrayref
2491 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2497 =head2 delete($table, \%where, \%options)
2499 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2500 It returns an SQL DELETE statement and list of bind values.
2502 The optional C<\%options> hash reference may contain additional
2503 options to generate the delete SQL. Currently supported options
2510 See the C<returning> option to
2511 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2515 =head2 where(\%where, $order)
2517 This is used to generate just the WHERE clause. For example,
2518 if you have an arbitrary data structure and know what the
2519 rest of your SQL is going to look like, but want an easy way
2520 to produce a WHERE clause, use this. It returns an SQL WHERE
2521 clause and list of bind values.
2524 =head2 values(\%data)
2526 This just returns the values from the hash C<%data>, in the same
2527 order that would be returned from any of the other above queries.
2528 Using this allows you to markedly speed up your queries if you
2529 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2531 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2533 Warning: This is an experimental method and subject to change.
2535 This returns arbitrarily generated SQL. It's a really basic shortcut.
2536 It will return two different things, depending on return context:
2538 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2539 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2541 These would return the following:
2543 # First calling form
2544 $stmt = "CREATE TABLE test (?, ?)";
2545 @bind = (field1, field2);
2547 # Second calling form
2548 $stmt_and_val = "CREATE TABLE test (field1, field2)";
2550 Depending on what you're trying to do, it's up to you to choose the correct
2551 format. In this example, the second form is what you would want.
2555 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2559 ALTER SESSION SET nls_date_format = 'MM/YY'
2561 You get the idea. Strings get their case twiddled, but everything
2562 else remains verbatim.
2564 =head1 EXPORTABLE FUNCTIONS
2566 =head2 is_plain_value
2568 Determines if the supplied argument is a plain value as understood by this
2573 =item * The value is C<undef>
2575 =item * The value is a non-reference
2577 =item * The value is an object with stringification overloading
2579 =item * The value is of the form C<< { -value => $anything } >>
2583 On failure returns C<undef>, on success returns a B<scalar> reference
2584 to the original supplied argument.
2590 The stringification overloading detection is rather advanced: it takes
2591 into consideration not only the presence of a C<""> overload, but if that
2592 fails also checks for enabled
2593 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2594 on either C<0+> or C<bool>.
2596 Unfortunately testing in the field indicates that this
2597 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2598 but only when very large numbers of stringifying objects are involved.
2599 At the time of writing ( Sep 2014 ) there is no clear explanation of
2600 the direct cause, nor is there a manageably small test case that reliably
2601 reproduces the problem.
2603 If you encounter any of the following exceptions in B<random places within
2604 your application stack> - this module may be to blame:
2606 Operation "ne": no method found,
2607 left argument in overloaded package <something>,
2608 right argument in overloaded package <something>
2612 Stub found while resolving method "???" overloading """" in package <something>
2614 If you fall victim to the above - please attempt to reduce the problem
2615 to something that could be sent to the L<SQL::Abstract developers
2616 |DBIx::Class/GETTING HELP/SUPPORT>
2617 (either publicly or privately). As a workaround in the meantime you can
2618 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2619 value, which will most likely eliminate your problem (at the expense of
2620 not being able to properly detect exotic forms of stringification).
2622 This notice and environment variable will be removed in a future version,
2623 as soon as the underlying problem is found and a reliable workaround is
2628 =head2 is_literal_value
2630 Determines if the supplied argument is a literal value as understood by this
2635 =item * C<\$sql_string>
2637 =item * C<\[ $sql_string, @bind_values ]>
2641 On failure returns C<undef>, on success returns an B<array> reference
2642 containing the unpacked version of the supplied literal SQL and bind values.
2644 =head1 WHERE CLAUSES
2648 This module uses a variation on the idea from L<DBIx::Abstract>. It
2649 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2650 module is that things in arrays are OR'ed, and things in hashes
2653 The easiest way to explain is to show lots of examples. After
2654 each C<%where> hash shown, it is assumed you used:
2656 my($stmt, @bind) = $sql->where(\%where);
2658 However, note that the C<%where> hash can be used directly in any
2659 of the other functions as well, as described above.
2661 =head2 Key-value pairs
2663 So, let's get started. To begin, a simple hash:
2667 status => 'completed'
2670 Is converted to SQL C<key = val> statements:
2672 $stmt = "WHERE user = ? AND status = ?";
2673 @bind = ('nwiger', 'completed');
2675 One common thing I end up doing is having a list of values that
2676 a field can be in. To do this, simply specify a list inside of
2681 status => ['assigned', 'in-progress', 'pending'];
2684 This simple code will create the following:
2686 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2687 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2689 A field associated to an empty arrayref will be considered a
2690 logical false and will generate 0=1.
2692 =head2 Tests for NULL values
2694 If the value part is C<undef> then this is converted to SQL <IS NULL>
2703 $stmt = "WHERE user = ? AND status IS NULL";
2706 To test if a column IS NOT NULL:
2710 status => { '!=', undef },
2713 =head2 Specific comparison operators
2715 If you want to specify a different type of operator for your comparison,
2716 you can use a hashref for a given column:
2720 status => { '!=', 'completed' }
2723 Which would generate:
2725 $stmt = "WHERE user = ? AND status != ?";
2726 @bind = ('nwiger', 'completed');
2728 To test against multiple values, just enclose the values in an arrayref:
2730 status => { '=', ['assigned', 'in-progress', 'pending'] };
2732 Which would give you:
2734 "WHERE status = ? OR status = ? OR status = ?"
2737 The hashref can also contain multiple pairs, in which case it is expanded
2738 into an C<AND> of its elements:
2742 status => { '!=', 'completed', -not_like => 'pending%' }
2745 # Or more dynamically, like from a form
2746 $where{user} = 'nwiger';
2747 $where{status}{'!='} = 'completed';
2748 $where{status}{'-not_like'} = 'pending%';
2750 # Both generate this
2751 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2752 @bind = ('nwiger', 'completed', 'pending%');
2755 To get an OR instead, you can combine it with the arrayref idea:
2759 priority => [ { '=', 2 }, { '>', 5 } ]
2762 Which would generate:
2764 $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2765 @bind = ('2', '5', 'nwiger');
2767 If you want to include literal SQL (with or without bind values), just use a
2768 scalar reference or reference to an arrayref as the value:
2771 date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2772 date_expires => { '<' => \"now()" }
2775 Which would generate:
2777 $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2778 @bind = ('11/26/2008');
2781 =head2 Logic and nesting operators
2783 In the example above,
2784 there is a subtle trap if you want to say something like
2785 this (notice the C<AND>):
2787 WHERE priority != ? AND priority != ?
2789 Because, in Perl you I<can't> do this:
2791 priority => { '!=' => 2, '!=' => 1 }
2793 As the second C<!=> key will obliterate the first. The solution
2794 is to use the special C<-modifier> form inside an arrayref:
2796 priority => [ -and => {'!=', 2},
2800 Normally, these would be joined by C<OR>, but the modifier tells it
2801 to use C<AND> instead. (Hint: You can use this in conjunction with the
2802 C<logic> option to C<new()> in order to change the way your queries
2803 work by default.) B<Important:> Note that the C<-modifier> goes
2804 B<INSIDE> the arrayref, as an extra first element. This will
2805 B<NOT> do what you think it might:
2807 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
2809 Here is a quick list of equivalencies, since there is some overlap:
2812 status => {'!=', 'completed', 'not like', 'pending%' }
2813 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2816 status => {'=', ['assigned', 'in-progress']}
2817 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2818 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2822 =head2 Special operators: IN, BETWEEN, etc.
2824 You can also use the hashref format to compare a list of fields using the
2825 C<IN> comparison operator, by specifying the list as an arrayref:
2828 status => 'completed',
2829 reportid => { -in => [567, 2335, 2] }
2832 Which would generate:
2834 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2835 @bind = ('completed', '567', '2335', '2');
2837 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2840 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2841 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2842 'sqltrue' (by default: C<1=1>).
2844 In addition to the array you can supply a chunk of literal sql or
2845 literal sql with bind:
2848 customer => { -in => \[
2849 'SELECT cust_id FROM cust WHERE balance > ?',
2852 status => { -in => \'SELECT status_codes FROM states' },
2858 customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2859 AND status IN ( SELECT status_codes FROM states )
2863 Finally, if the argument to C<-in> is not a reference, it will be
2864 treated as a single-element array.
2866 Another pair of operators is C<-between> and C<-not_between>,
2867 used with an arrayref of two values:
2871 completion_date => {
2872 -not_between => ['2002-10-01', '2003-02-06']
2878 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2880 Just like with C<-in> all plausible combinations of literal SQL
2884 start0 => { -between => [ 1, 2 ] },
2885 start1 => { -between => \["? AND ?", 1, 2] },
2886 start2 => { -between => \"lower(x) AND upper(y)" },
2887 start3 => { -between => [
2889 \["upper(?)", 'stuff' ],
2896 ( start0 BETWEEN ? AND ? )
2897 AND ( start1 BETWEEN ? AND ? )
2898 AND ( start2 BETWEEN lower(x) AND upper(y) )
2899 AND ( start3 BETWEEN lower(x) AND upper(?) )
2901 @bind = (1, 2, 1, 2, 'stuff');
2904 These are the two builtin "special operators"; but the
2905 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2907 =head2 Unary operators: bool
2909 If you wish to test against boolean columns or functions within your
2910 database you can use the C<-bool> and C<-not_bool> operators. For
2911 example to test the column C<is_user> being true and the column
2912 C<is_enabled> being false you would use:-
2916 -not_bool => 'is_enabled',
2921 WHERE is_user AND NOT is_enabled
2923 If a more complex combination is required, testing more conditions,
2924 then you should use the and/or operators:-
2929 -not_bool => { two=> { -rlike => 'bar' } },
2930 -not_bool => { three => [ { '=', 2 }, { '>', 5 } ] },
2941 (NOT ( three = ? OR three > ? ))
2944 =head2 Nested conditions, -and/-or prefixes
2946 So far, we've seen how multiple conditions are joined with a top-level
2947 C<AND>. We can change this by putting the different conditions we want in
2948 hashes and then putting those hashes in an array. For example:
2953 status => { -like => ['pending%', 'dispatched'] },
2957 status => 'unassigned',
2961 This data structure would create the following:
2963 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2964 OR ( user = ? AND status = ? ) )";
2965 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2968 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2969 to change the logic inside:
2975 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2976 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2983 $stmt = "WHERE ( user = ?
2984 AND ( ( workhrs > ? AND geo = ? )
2985 OR ( workhrs < ? OR geo = ? ) ) )";
2986 @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2988 =head3 Algebraic inconsistency, for historical reasons
2990 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2991 operator goes C<outside> of the nested structure; whereas when connecting
2992 several constraints on one column, the C<-and> operator goes
2993 C<inside> the arrayref. Here is an example combining both features:
2996 -and => [a => 1, b => 2],
2997 -or => [c => 3, d => 4],
2998 e => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
3003 WHERE ( ( ( a = ? AND b = ? )
3004 OR ( c = ? OR d = ? )
3005 OR ( e LIKE ? AND e LIKE ? ) ) )
3007 This difference in syntax is unfortunate but must be preserved for
3008 historical reasons. So be careful: the two examples below would
3009 seem algebraically equivalent, but they are not
3012 { -like => 'foo%' },
3013 { -like => '%bar' },
3015 # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
3018 { col => { -like => 'foo%' } },
3019 { col => { -like => '%bar' } },
3021 # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
3024 =head2 Literal SQL and value type operators
3026 The basic premise of SQL::Abstract is that in WHERE specifications the "left
3027 side" is a column name and the "right side" is a value (normally rendered as
3028 a placeholder). This holds true for both hashrefs and arrayref pairs as you
3029 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
3030 alter this behavior. There are several ways of doing so.
3034 This is a virtual operator that signals the string to its right side is an
3035 identifier (a column name) and not a value. For example to compare two
3036 columns you would write:
3039 priority => { '<', 2 },
3040 requestor => { -ident => 'submitter' },
3045 $stmt = "WHERE priority < ? AND requestor = submitter";
3048 If you are maintaining legacy code you may see a different construct as
3049 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3054 This is a virtual operator that signals that the construct to its right side
3055 is a value to be passed to DBI. This is for example necessary when you want
3056 to write a where clause against an array (for RDBMS that support such
3057 datatypes). For example:
3060 array => { -value => [1, 2, 3] }
3065 $stmt = 'WHERE array = ?';
3066 @bind = ([1, 2, 3]);
3068 Note that if you were to simply say:
3074 the result would probably not be what you wanted:
3076 $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3081 Finally, sometimes only literal SQL will do. To include a random snippet
3082 of SQL verbatim, you specify it as a scalar reference. Consider this only
3083 as a last resort. Usually there is a better way. For example:
3086 priority => { '<', 2 },
3087 requestor => { -in => \'(SELECT name FROM hitmen)' },
3092 $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3095 Note that in this example, you only get one bind parameter back, since
3096 the verbatim SQL is passed as part of the statement.
3100 Never use untrusted input as a literal SQL argument - this is a massive
3101 security risk (there is no way to check literal snippets for SQL
3102 injections and other nastyness). If you need to deal with untrusted input
3103 use literal SQL with placeholders as described next.
3105 =head3 Literal SQL with placeholders and bind values (subqueries)
3107 If the literal SQL to be inserted has placeholders and bind values,
3108 use a reference to an arrayref (yes this is a double reference --
3109 not so common, but perfectly legal Perl). For example, to find a date
3110 in Postgres you can use something like this:
3113 date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3118 $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3121 Note that you must pass the bind values in the same format as they are returned
3122 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3123 to C<columns>, you must provide the bind values in the
3124 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3125 scalar value; most commonly the column name, but you can use any scalar value
3126 (including references and blessed references), L<SQL::Abstract> will simply
3127 pass it through intact. So if C<bindtype> is set to C<columns> the above
3128 example will look like:
3131 date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3134 Literal SQL is especially useful for nesting parenthesized clauses in the
3135 main SQL query. Here is a first example:
3137 my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3141 bar => \["IN ($sub_stmt)" => @sub_bind],
3146 $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3147 WHERE c2 < ? AND c3 LIKE ?))";
3148 @bind = (1234, 100, "foo%");
3150 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3151 are expressed in the same way. Of course the C<$sub_stmt> and
3152 its associated bind values can be generated through a former call
3155 my ($sub_stmt, @sub_bind)
3156 = $sql->select("t1", "c1", {c2 => {"<" => 100},
3157 c3 => {-like => "foo%"}});
3160 bar => \["> ALL ($sub_stmt)" => @sub_bind],
3163 In the examples above, the subquery was used as an operator on a column;
3164 but the same principle also applies for a clause within the main C<%where>
3165 hash, like an EXISTS subquery:
3167 my ($sub_stmt, @sub_bind)
3168 = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3169 my %where = ( -and => [
3171 \["EXISTS ($sub_stmt)" => @sub_bind],
3176 $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3177 WHERE c1 = ? AND c2 > t0.c0))";
3181 Observe that the condition on C<c2> in the subquery refers to
3182 column C<t0.c0> of the main query: this is I<not> a bind
3183 value, so we have to express it through a scalar ref.
3184 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3185 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3186 what we wanted here.
3188 Finally, here is an example where a subquery is used
3189 for expressing unary negation:
3191 my ($sub_stmt, @sub_bind)
3192 = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3193 $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3195 lname => {like => '%son%'},
3196 \["NOT ($sub_stmt)" => @sub_bind],
3201 $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3202 @bind = ('%son%', 10, 20)
3204 =head3 Deprecated usage of Literal SQL
3206 Below are some examples of archaic use of literal SQL. It is shown only as
3207 reference for those who deal with legacy code. Each example has a much
3208 better, cleaner and safer alternative that users should opt for in new code.
3214 my %where = ( requestor => \'IS NOT NULL' )
3216 $stmt = "WHERE requestor IS NOT NULL"
3218 This used to be the way of generating NULL comparisons, before the handling
3219 of C<undef> got formalized. For new code please use the superior syntax as
3220 described in L</Tests for NULL values>.
3224 my %where = ( requestor => \'= submitter' )
3226 $stmt = "WHERE requestor = submitter"
3228 This used to be the only way to compare columns. Use the superior L</-ident>
3229 method for all new code. For example an identifier declared in such a way
3230 will be properly quoted if L</quote_char> is properly set, while the legacy
3231 form will remain as supplied.
3235 my %where = ( is_ready => \"", completed => { '>', '2012-12-21' } )
3237 $stmt = "WHERE completed > ? AND is_ready"
3238 @bind = ('2012-12-21')
3240 Using an empty string literal used to be the only way to express a boolean.
3241 For all new code please use the much more readable
3242 L<-bool|/Unary operators: bool> operator.
3248 These pages could go on for a while, since the nesting of the data
3249 structures this module can handle are pretty much unlimited (the
3250 module implements the C<WHERE> expansion as a recursive function
3251 internally). Your best bet is to "play around" with the module a
3252 little to see how the data structures behave, and choose the best
3253 format for your data based on that.
3255 And of course, all the values above will probably be replaced with
3256 variables gotten from forms or the command line. After all, if you
3257 knew everything ahead of time, you wouldn't have to worry about
3258 dynamically-generating SQL and could just hardwire it into your
3261 =head1 ORDER BY CLAUSES
3263 Some functions take an order by clause. This can either be a scalar (just a
3264 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3265 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3268 Given | Will Generate
3269 ---------------------------------------------------------------
3271 'colA' | ORDER BY colA
3273 [qw/colA colB/] | ORDER BY colA, colB
3275 {-asc => 'colA'} | ORDER BY colA ASC
3277 {-desc => 'colB'} | ORDER BY colB DESC
3279 ['colA', {-asc => 'colB'}] | ORDER BY colA, colB ASC
3281 { -asc => [qw/colA colB/] } | ORDER BY colA ASC, colB ASC
3283 \'colA DESC' | ORDER BY colA DESC
3285 \[ 'FUNC(colA, ?)', $x ] | ORDER BY FUNC(colA, ?)
3286 | /* ...with $x bound to ? */
3289 { -asc => 'colA' }, | colA ASC,
3290 { -desc => [qw/colB/] }, | colB DESC,
3291 { -asc => [qw/colC colD/] },| colC ASC, colD ASC,
3292 \'colE DESC', | colE DESC,
3293 \[ 'FUNC(colF, ?)', $x ], | FUNC(colF, ?)
3294 ] | /* ...with $x bound to ? */
3295 ===============================================================
3299 =head1 SPECIAL OPERATORS
3301 my $sqlmaker = SQL::Abstract->new(special_ops => [
3305 my ($self, $field, $op, $arg) = @_;
3311 handler => 'method_name',
3315 A "special operator" is a SQL syntactic clause that can be
3316 applied to a field, instead of a usual binary operator.
3319 WHERE field IN (?, ?, ?)
3320 WHERE field BETWEEN ? AND ?
3321 WHERE MATCH(field) AGAINST (?, ?)
3323 Special operators IN and BETWEEN are fairly standard and therefore
3324 are builtin within C<SQL::Abstract> (as the overridable methods
3325 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3326 like the MATCH .. AGAINST example above which is specific to MySQL,
3327 you can write your own operator handlers - supply a C<special_ops>
3328 argument to the C<new> method. That argument takes an arrayref of
3329 operator definitions; each operator definition is a hashref with two
3336 the regular expression to match the operator
3340 Either a coderef or a plain scalar method name. In both cases
3341 the expected return is C<< ($sql, @bind) >>.
3343 When supplied with a method name, it is simply called on the
3344 L<SQL::Abstract> object as:
3346 $self->$method_name($field, $op, $arg)
3350 $field is the LHS of the operator
3351 $op is the part that matched the handler regex
3354 When supplied with a coderef, it is called as:
3356 $coderef->($self, $field, $op, $arg)
3361 For example, here is an implementation
3362 of the MATCH .. AGAINST syntax for MySQL
3364 my $sqlmaker = SQL::Abstract->new(special_ops => [
3366 # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3367 {regex => qr/^match$/i,
3369 my ($self, $field, $op, $arg) = @_;
3370 $arg = [$arg] if not ref $arg;
3371 my $label = $self->_quote($field);
3372 my ($placeholder) = $self->_convert('?');
3373 my $placeholders = join ", ", (($placeholder) x @$arg);
3374 my $sql = $self->_sqlcase('match') . " ($label) "
3375 . $self->_sqlcase('against') . " ($placeholders) ";
3376 my @bind = $self->_bindtype($field, @$arg);
3377 return ($sql, @bind);
3384 =head1 UNARY OPERATORS
3386 my $sqlmaker = SQL::Abstract->new(unary_ops => [
3390 my ($self, $op, $arg) = @_;
3396 handler => 'method_name',
3400 A "unary operator" is a SQL syntactic clause that can be
3401 applied to a field - the operator goes before the field
3403 You can write your own operator handlers - supply a C<unary_ops>
3404 argument to the C<new> method. That argument takes an arrayref of
3405 operator definitions; each operator definition is a hashref with two
3412 the regular expression to match the operator
3416 Either a coderef or a plain scalar method name. In both cases
3417 the expected return is C<< $sql >>.
3419 When supplied with a method name, it is simply called on the
3420 L<SQL::Abstract> object as:
3422 $self->$method_name($op, $arg)
3426 $op is the part that matched the handler regex
3427 $arg is the RHS or argument of the operator
3429 When supplied with a coderef, it is called as:
3431 $coderef->($self, $op, $arg)
3439 Thanks to some benchmarking by Mark Stosberg, it turns out that
3440 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3441 I must admit this wasn't an intentional design issue, but it's a
3442 byproduct of the fact that you get to control your C<DBI> handles
3445 To maximize performance, use a code snippet like the following:
3447 # prepare a statement handle using the first row
3448 # and then reuse it for the rest of the rows
3450 for my $href (@array_of_hashrefs) {
3451 $stmt ||= $sql->insert('table', $href);
3452 $sth ||= $dbh->prepare($stmt);
3453 $sth->execute($sql->values($href));
3456 The reason this works is because the keys in your C<$href> are sorted
3457 internally by B<SQL::Abstract>. Thus, as long as your data retains
3458 the same structure, you only have to generate the SQL the first time
3459 around. On subsequent queries, simply use the C<values> function provided
3460 by this module to return your values in the correct order.
3462 However this depends on the values having the same type - if, for
3463 example, the values of a where clause may either have values
3464 (resulting in sql of the form C<column = ?> with a single bind
3465 value), or alternatively the values might be C<undef> (resulting in
3466 sql of the form C<column IS NULL> with no bind value) then the
3467 caching technique suggested will not work.
3471 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3472 really like this part (I do, at least). Building up a complex query
3473 can be as simple as the following:
3480 use CGI::FormBuilder;
3483 my $form = CGI::FormBuilder->new(...);
3484 my $sql = SQL::Abstract->new;
3486 if ($form->submitted) {
3487 my $field = $form->field;
3488 my $id = delete $field->{id};
3489 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3492 Of course, you would still have to connect using C<DBI> to run the
3493 query, but the point is that if you make your form look like your
3494 table, the actual query script can be extremely simplistic.
3496 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3497 a fast interface to returning and formatting data. I frequently
3498 use these three modules together to write complex database query
3499 apps in under 50 lines.
3501 =head1 HOW TO CONTRIBUTE
3503 Contributions are always welcome, in all usable forms (we especially
3504 welcome documentation improvements). The delivery methods include git-
3505 or unified-diff formatted patches, GitHub pull requests, or plain bug
3506 reports either via RT or the Mailing list. Contributors are generally
3507 granted full access to the official repository after their first several
3508 patches pass successful review.
3510 This project is maintained in a git repository. The code and related tools are
3511 accessible at the following locations:
3515 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3517 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3519 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3521 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3527 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3528 Great care has been taken to preserve the I<published> behavior
3529 documented in previous versions in the 1.* family; however,
3530 some features that were previously undocumented, or behaved
3531 differently from the documentation, had to be changed in order
3532 to clarify the semantics. Hence, client code that was relying
3533 on some dark areas of C<SQL::Abstract> v1.*
3534 B<might behave differently> in v1.50.
3536 The main changes are:
3542 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3546 support for the { operator => \"..." } construct (to embed literal SQL)
3550 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3554 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3558 defensive programming: check arguments
3562 fixed bug with global logic, which was previously implemented
3563 through global variables yielding side-effects. Prior versions would
3564 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3565 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3566 Now this is interpreted
3567 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3572 fixed semantics of _bindtype on array args
3576 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3577 we just avoid shifting arrays within that tree.
3581 dropped the C<_modlogic> function
3585 =head1 ACKNOWLEDGEMENTS
3587 There are a number of individuals that have really helped out with
3588 this module. Unfortunately, most of them submitted bugs via CPAN
3589 so I have no idea who they are! But the people I do know are:
3591 Ash Berlin (order_by hash term support)
3592 Matt Trout (DBIx::Class support)
3593 Mark Stosberg (benchmarking)
3594 Chas Owens (initial "IN" operator support)
3595 Philip Collins (per-field SQL functions)
3596 Eric Kolve (hashref "AND" support)
3597 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3598 Dan Kubb (support for "quote_char" and "name_sep")
3599 Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3600 Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3601 Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3602 Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3603 Oliver Charles (support for "RETURNING" after "INSERT")
3609 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3613 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3615 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3617 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3618 While not an official support venue, C<DBIx::Class> makes heavy use of
3619 C<SQL::Abstract>, and as such list members there are very familiar with
3620 how to create queries.
3624 This module is free software; you may copy this under the same
3625 terms as perl itself (either the GNU General Public License or
3626 the Artistic License)