lib/SQL/Abstract.pm

   1 package SQL::Abstract; # see doc at end of file
   2
   3 use strict;
   4 use warnings;
   5 use Carp ();
   6 use List::Util ();
   7 use Scalar::Util ();
   8
   9 use Exporter 'import';
  10 our @EXPORT_OK = qw(is_plain_value is_literal_value);
  11
  12 BEGIN {
  13   if ($] < 5.009_005) {
  14     require MRO::Compat;
  15   }
  16   else {
  17     require mro;
  18   }
  19
  20   *SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION = $ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}
  21     ? sub () { 0 }
  22     : sub () { 1 }
  23   ;
  24 }
  25
  26 #======================================================================
  27 # GLOBALS
  28 #======================================================================
  29
  30 our $VERSION  = '1.86';
  31
  32 # This would confuse some packagers
  33 $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
  34
  35 our $AUTOLOAD;
  36
  37 # special operators (-in, -between). May be extended/overridden by user.
  38 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
  39 my @BUILTIN_SPECIAL_OPS = (
  40   {regex => qr/^ (?: not \s )? between $/ix, handler => '_where_field_BETWEEN'},
  41   {regex => qr/^ (?: not \s )? in      $/ix, handler => '_where_field_IN'},
  42   {regex => qr/^ ident                 $/ix, handler => '_where_op_IDENT'},
  43   {regex => qr/^ value                 $/ix, handler => '_where_op_VALUE'},
  44   {regex => qr/^ is (?: \s+ not )?     $/ix, handler => '_where_field_IS'},
  45 );
  46
  47 # unaryish operators - key maps to handler
  48 my @BUILTIN_UNARY_OPS = (
  49   # the digits are backcompat stuff
  50   { regex => qr/^ and  (?: [_\s]? \d+ )? $/xi, handler => '_where_op_ANDOR' },
  51   { regex => qr/^ or   (?: [_\s]? \d+ )? $/xi, handler => '_where_op_ANDOR' },
  52   { regex => qr/^ nest (?: [_\s]? \d+ )? $/xi, handler => '_where_op_NEST' },
  53   { regex => qr/^ (?: not \s )? bool     $/xi, handler => '_where_op_BOOL' },
  54   { regex => qr/^ ident                  $/xi, handler => '_where_op_IDENT' },
  55   { regex => qr/^ value                  $/xi, handler => '_where_op_VALUE' },
  56   { regex => qr/^ op                     $/xi, handler => '_where_op_OP' },
  57   { regex => qr/^ bind                   $/xi, handler => '_where_op_BIND' },
  58   { regex => qr/^ literal                $/xi, handler => '_where_op_LITERAL' },
  59 );
  60
  61 #======================================================================
  62 # DEBUGGING AND ERROR REPORTING
  63 #======================================================================
  64
  65 sub _debug {
  66   return unless $_[0]->{debug}; shift; # a little faster
  67   my $func = (caller(1))[3];
  68   warn "[$func] ", @_, "\n";
  69 }
  70
  71 sub belch (@) {
  72   my($func) = (caller(1))[3];
  73   Carp::carp "[$func] Warning: ", @_;
  74 }
  75
  76 sub puke (@) {
  77   my($func) = (caller(1))[3];
  78   Carp::croak "[$func] Fatal: ", @_;
  79 }
  80
  81 sub is_literal_value ($) {
  82     ref $_[0] eq 'SCALAR'                                     ? [ ${$_[0]} ]
  83   : ( ref $_[0] eq 'REF' and ref ${$_[0]} eq 'ARRAY' )        ? [ @${ $_[0] } ]
  84   : undef;
  85 }
  86
  87 # FIXME XSify - this can be done so much more efficiently
  88 sub is_plain_value ($) {
  89   no strict 'refs';
  90     ! length ref $_[0]                                        ? \($_[0])
  91   : (
  92     ref $_[0] eq 'HASH' and keys %{$_[0]} == 1
  93       and
  94     exists $_[0]->{-value}
  95   )                                                           ? \($_[0]->{-value})
  96   : (
  97       # reuse @_ for even moar speedz
  98       defined ( $_[1] = Scalar::Util::blessed $_[0] )
  99         and
 100       # deliberately not using Devel::OverloadInfo - the checks we are
 101       # intersted in are much more limited than the fullblown thing, and
 102       # this is a very hot piece of code
 103       (
 104         # simply using ->can('(""') can leave behind stub methods that
 105         # break actually using the overload later (see L<perldiag/Stub
 106         # found while resolving method "%s" overloading "%s" in package
 107         # "%s"> and the source of overload::mycan())
 108         #
 109         # either has stringification which DBI SHOULD prefer out of the box
 110         grep { *{ (qq[${_}::(""]) }{CODE} } @{ $_[2] = mro::get_linear_isa( $_[1] ) }
 111           or
 112         # has nummification or boolification, AND fallback is *not* disabled
 113         (
 114           SQL::Abstract::_ENV_::DETECT_AUTOGENERATED_STRINGIFICATION
 115             and
 116           (
 117             grep { *{"${_}::(0+"}{CODE} } @{$_[2]}
 118               or
 119             grep { *{"${_}::(bool"}{CODE} } @{$_[2]}
 120           )
 121             and
 122           (
 123             # no fallback specified at all
 124             ! ( ($_[3]) = grep { *{"${_}::()"}{CODE} } @{$_[2]} )
 125               or
 126             # fallback explicitly undef
 127             ! defined ${"$_[3]::()"}
 128               or
 129             # explicitly true
 130             !! ${"$_[3]::()"}
 131           )
 132         )
 133       )
 134     )                                                          ? \($_[0])
 135   : undef;
 136 }
 137
 138
 139
 140 #======================================================================
 141 # NEW
 142 #======================================================================
 143
 144 sub new {
 145   my $self = shift;
 146   my $class = ref($self) || $self;
 147   my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
 148
 149   # choose our case by keeping an option around
 150   delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
 151
 152   # default logic for interpreting arrayrefs
 153   $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
 154
 155   # how to return bind vars
 156   $opt{bindtype} ||= 'normal';
 157
 158   # default comparison is "=", but can be overridden
 159   $opt{cmp} ||= '=';
 160
 161   # try to recognize which are the 'equality' and 'inequality' ops
 162   # (temporary quickfix (in 2007), should go through a more seasoned API)
 163   $opt{equality_op}   = qr/^( \Q$opt{cmp}\E | \= )$/ix;
 164   $opt{inequality_op} = qr/^( != | <> )$/ix;
 165
 166   $opt{like_op}       = qr/^ (is\s+)? r?like $/xi;
 167   $opt{not_like_op}   = qr/^ (is\s+)? not \s+ r?like $/xi;
 168
 169   # SQL booleans
 170   $opt{sqltrue}  ||= '1=1';
 171   $opt{sqlfalse} ||= '0=1';
 172
 173   # special operators
 174   $opt{special_ops} ||= [];
 175   # regexes are applied in order, thus push after user-defines
 176   push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
 177
 178   # unary operators
 179   $opt{unary_ops} ||= [];
 180   push @{$opt{unary_ops}}, @BUILTIN_UNARY_OPS;
 181
 182   # rudimentary sanity-check for user supplied bits treated as functions/operators
 183   # If a purported  function matches this regular expression, an exception is thrown.
 184   # Literal SQL is *NOT* subject to this check, only functions (and column names
 185   # when quoting is not in effect)
 186
 187   # FIXME
 188   # need to guard against ()'s in column names too, but this will break tons of
 189   # hacks... ideas anyone?
 190   $opt{injection_guard} ||= qr/
 191     \;
 192       |
 193     ^ \s* go \s
 194   /xmi;
 195
 196   return bless \%opt, $class;
 197 }
 198
 199
 200 sub _assert_pass_injection_guard {
 201   if ($_[1] =~ $_[0]->{injection_guard}) {
 202     my $class = ref $_[0];
 203     puke "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
 204      . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
 205      . "{injection_guard} attribute to ${class}->new()"
 206   }
 207 }
 208
 209
 210 #======================================================================
 211 # INSERT methods
 212 #======================================================================
 213
 214 sub insert {
 215   my $self    = shift;
 216   my $table   = $self->_table(shift);
 217   my $data    = shift || return;
 218   my $options = shift;
 219
 220   my $method       = $self->_METHOD_FOR_refkind("_insert", $data);
 221   my ($sql, @bind) = $self->$method($data);
 222   $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
 223
 224   if ($options->{returning}) {
 225     my ($s, @b) = $self->_insert_returning($options);
 226     $sql .= $s;
 227     push @bind, @b;
 228   }
 229
 230   return wantarray ? ($sql, @bind) : $sql;
 231 }
 232
 233 # So that subclasses can override INSERT ... RETURNING separately from
 234 # UPDATE and DELETE (e.g. DBIx::Class::SQLMaker::Oracle does this)
 235 sub _insert_returning { shift->_returning(@_) }
 236
 237 sub _returning {
 238   my ($self, $options) = @_;
 239
 240   my $f = $options->{returning};
 241
 242   my $fieldlist = $self->_SWITCH_refkind($f, {
 243     ARRAYREF     => sub {join ', ', map { $self->_quote($_) } @$f;},
 244     SCALAR       => sub {$self->_quote($f)},
 245     SCALARREF    => sub {$$f},
 246   });
 247   return $self->_sqlcase(' returning ') . $fieldlist;
 248 }
 249
 250 sub _insert_HASHREF { # explicit list of fields and then values
 251   my ($self, $data) = @_;
 252
 253   my @fields = sort keys %$data;
 254
 255   my ($sql, @bind) = $self->_insert_values($data);
 256
 257   # assemble SQL
 258   $_ = $self->_quote($_) foreach @fields;
 259   $sql = "( ".join(", ", @fields).") ".$sql;
 260
 261   return ($sql, @bind);
 262 }
 263
 264 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
 265   my ($self, $data) = @_;
 266
 267   # no names (arrayref) so can't generate bindtype
 268   $self->{bindtype} ne 'columns'
 269     or belch "can't do 'columns' bindtype when called with arrayref";
 270
 271   my (@values, @all_bind);
 272   foreach my $value (@$data) {
 273     my ($values, @bind) = $self->_insert_value(undef, $value);
 274     push @values, $values;
 275     push @all_bind, @bind;
 276   }
 277   my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
 278   return ($sql, @all_bind);
 279 }
 280
 281 sub _insert_ARRAYREFREF { # literal SQL with bind
 282   my ($self, $data) = @_;
 283
 284   my ($sql, @bind) = @${$data};
 285   $self->_assert_bindval_matches_bindtype(@bind);
 286
 287   return ($sql, @bind);
 288 }
 289
 290
 291 sub _insert_SCALARREF { # literal SQL without bind
 292   my ($self, $data) = @_;
 293
 294   return ($$data);
 295 }
 296
 297 sub _insert_values {
 298   my ($self, $data) = @_;
 299
 300   my (@values, @all_bind);
 301   foreach my $column (sort keys %$data) {
 302     my ($values, @bind) = $self->_insert_value($column, $data->{$column});
 303     push @values, $values;
 304     push @all_bind, @bind;
 305   }
 306   my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
 307   return ($sql, @all_bind);
 308 }
 309
 310 sub _insert_value {
 311   my ($self, $column, $v) = @_;
 312
 313   my (@values, @all_bind);
 314   $self->_SWITCH_refkind($v, {
 315
 316     ARRAYREF => sub {
 317       if ($self->{array_datatypes}) { # if array datatype are activated
 318         push @values, '?';
 319         push @all_bind, $self->_bindtype($column, $v);
 320       }
 321       else {                  # else literal SQL with bind
 322         my ($sql, @bind) = @$v;
 323         $self->_assert_bindval_matches_bindtype(@bind);
 324         push @values, $sql;
 325         push @all_bind, @bind;
 326       }
 327     },
 328
 329     ARRAYREFREF => sub {        # literal SQL with bind
 330       my ($sql, @bind) = @${$v};
 331       $self->_assert_bindval_matches_bindtype(@bind);
 332       push @values, $sql;
 333       push @all_bind, @bind;
 334     },
 335
 336     # THINK: anything useful to do with a HASHREF ?
 337     HASHREF => sub {       # (nothing, but old SQLA passed it through)
 338       #TODO in SQLA >= 2.0 it will die instead
 339       belch "HASH ref as bind value in insert is not supported";
 340       push @values, '?';
 341       push @all_bind, $self->_bindtype($column, $v);
 342     },
 343
 344     SCALARREF => sub {          # literal SQL without bind
 345       push @values, $$v;
 346     },
 347
 348     SCALAR_or_UNDEF => sub {
 349       push @values, '?';
 350       push @all_bind, $self->_bindtype($column, $v);
 351     },
 352
 353   });
 354
 355   my $sql = join(", ", @values);
 356   return ($sql, @all_bind);
 357 }
 358
 359
 360
 361 #======================================================================
 362 # UPDATE methods
 363 #======================================================================
 364
 365
 366 sub update {
 367   my $self    = shift;
 368   my $table   = $self->_table(shift);
 369   my $data    = shift || return;
 370   my $where   = shift;
 371   my $options = shift;
 372
 373   # first build the 'SET' part of the sql statement
 374   puke "Unsupported data type specified to \$sql->update"
 375     unless ref $data eq 'HASH';
 376
 377   my ($sql, @all_bind) = $self->_update_set_values($data);
 378   $sql = $self->_sqlcase('update ') . $table . $self->_sqlcase(' set ')
 379           . $sql;
 380
 381   if ($where) {
 382     my($where_sql, @where_bind) = $self->where($where);
 383     $sql .= $where_sql;
 384     push @all_bind, @where_bind;
 385   }
 386
 387   if ($options->{returning}) {
 388     my ($returning_sql, @returning_bind) = $self->_update_returning($options);
 389     $sql .= $returning_sql;
 390     push @all_bind, @returning_bind;
 391   }
 392
 393   return wantarray ? ($sql, @all_bind) : $sql;
 394 }
 395
 396 sub _update_set_values {
 397   my ($self, $data) = @_;
 398
 399   my (@set, @all_bind);
 400   for my $k (sort keys %$data) {
 401     my $v = $data->{$k};
 402     my $r = ref $v;
 403     my $label = $self->_quote($k);
 404
 405     $self->_SWITCH_refkind($v, {
 406       ARRAYREF => sub {
 407         if ($self->{array_datatypes}) { # array datatype
 408           push @set, "$label = ?";
 409           push @all_bind, $self->_bindtype($k, $v);
 410         }
 411         else {                          # literal SQL with bind
 412           my ($sql, @bind) = @$v;
 413           $self->_assert_bindval_matches_bindtype(@bind);
 414           push @set, "$label = $sql";
 415           push @all_bind, @bind;
 416         }
 417       },
 418       ARRAYREFREF => sub { # literal SQL with bind
 419         my ($sql, @bind) = @${$v};
 420         $self->_assert_bindval_matches_bindtype(@bind);
 421         push @set, "$label = $sql";
 422         push @all_bind, @bind;
 423       },
 424       SCALARREF => sub {  # literal SQL without bind
 425         push @set, "$label = $$v";
 426       },
 427       HASHREF => sub {
 428         my ($op, $arg, @rest) = %$v;
 429
 430         puke 'Operator calls in update must be in the form { -op => $arg }'
 431           if (@rest or not $op =~ /^\-(.+)/);
 432
 433         local $self->{_nested_func_lhs} = $k;
 434         my ($sql, @bind) = $self->_where_unary_op($1, $arg);
 435
 436         push @set, "$label = $sql";
 437         push @all_bind, @bind;
 438       },
 439       SCALAR_or_UNDEF => sub {
 440         push @set, "$label = ?";
 441         push @all_bind, $self->_bindtype($k, $v);
 442       },
 443     });
 444   }
 445
 446   # generate sql
 447   my $sql = join ', ', @set;
 448
 449   return ($sql, @all_bind);
 450 }
 451
 452 # So that subclasses can override UPDATE ... RETURNING separately from
 453 # INSERT and DELETE
 454 sub _update_returning { shift->_returning(@_) }
 455
 456
 457
 458 #======================================================================
 459 # SELECT
 460 #======================================================================
 461
 462
 463 sub select {
 464   my $self   = shift;
 465   my $table  = $self->_table(shift);
 466   my $fields = shift || '*';
 467   my $where  = shift;
 468   my $order  = shift;
 469
 470   my ($fields_sql, @bind) = $self->_select_fields($fields);
 471
 472   my ($where_sql, @where_bind) = $self->where($where, $order);
 473   push @bind, @where_bind;
 474
 475   my $sql = join(' ', $self->_sqlcase('select'), $fields_sql,
 476                       $self->_sqlcase('from'),   $table)
 477           . $where_sql;
 478
 479   return wantarray ? ($sql, @bind) : $sql;
 480 }
 481
 482 sub _select_fields {
 483   my ($self, $fields) = @_;
 484   return ref $fields eq 'ARRAY' ? join ', ', map { $self->_quote($_) } @$fields
 485                                 : $fields;
 486 }
 487
 488 #======================================================================
 489 # DELETE
 490 #======================================================================
 491
 492
 493 sub delete {
 494   my $self    = shift;
 495   my $table   = $self->_table(shift);
 496   my $where   = shift;
 497   my $options = shift;
 498
 499   my($where_sql, @bind) = $self->where($where);
 500   my $sql = $self->_sqlcase('delete from ') . $table . $where_sql;
 501
 502   if ($options->{returning}) {
 503     my ($returning_sql, @returning_bind) = $self->_delete_returning($options);
 504     $sql .= $returning_sql;
 505     push @bind, @returning_bind;
 506   }
 507
 508   return wantarray ? ($sql, @bind) : $sql;
 509 }
 510
 511 # So that subclasses can override DELETE ... RETURNING separately from
 512 # INSERT and UPDATE
 513 sub _delete_returning { shift->_returning(@_) }
 514
 515
 516
 517 #======================================================================
 518 # WHERE: entry point
 519 #======================================================================
 520
 521
 522
 523 # Finally, a separate routine just to handle WHERE clauses
 524 sub where {
 525   my ($self, $where, $order) = @_;
 526
 527   # where ?
 528   my ($sql, @bind) = $self->_recurse_where($where);
 529   $sql = (defined $sql and length $sql) ? $self->_sqlcase(' where ') . "( $sql )" : '';
 530
 531   # order by?
 532   if ($order) {
 533     my ($order_sql, @order_bind) = $self->_order_by($order);
 534     $sql .= $order_sql;
 535     push @bind, @order_bind;
 536   }
 537
 538   return wantarray ? ($sql, @bind) : $sql;
 539 }
 540
 541 sub _expand_expr {
 542   my ($self, $expr, $logic) = @_;
 543   if (ref($expr) eq 'HASH') {
 544     if (keys %$expr > 1) {
 545       $logic ||= 'and';
 546       return +{ "-${logic}" => [
 547         map $self->_expand_expr_hashpair($_ => $expr->{$_}, $logic),
 548           sort keys %$expr
 549       ] };
 550     }
 551     return $self->_expand_expr_hashpair(%$expr, $logic);
 552   }
 553   if (ref($expr) eq 'ARRAY') {
 554     $logic = lc($logic || $self->{logic});
 555     $logic eq 'and' or $logic eq 'or' or puke "unknown logic: $logic";
 556
 557     my @expr = @$expr;
 558
 559     my @res;
 560
 561     while (my ($el) = splice @expr, 0, 1) {
 562       puke "Supplying an empty left hand side argument is not supported in array-pairs"
 563         unless defined($el) and length($el);
 564       my $elref = ref($el);
 565       if (!$elref) {
 566         push(@res, $self->_expand_expr({ $el, shift(@expr) }));
 567       } elsif ($elref eq 'ARRAY') {
 568         push(@res, $self->_expand_expr($el)) if @$el;
 569       } elsif (is_literal_value($el)) {
 570         push @res, $el;
 571       } elsif ($elref eq 'HASH') {
 572         push @res, $self->_expand_expr($el);
 573       } else {
 574         die "unimplemented"
 575       }
 576     }
 577     return { '-'.$logic => \@res };
 578   }
 579   if (my $literal = is_literal_value($expr)) {
 580     return +{ -literal => $literal };
 581   }
 582   return $expr;
 583 }
 584
 585 sub _expand_expr_hashpair {
 586   my ($self, $k, $v, $logic) = @_;
 587   unless (defined($k) and length($k)) {
 588     if (defined($k) and my $literal = is_literal_value($v)) {
 589       belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
 590       return { -literal => $literal };
 591     }
 592     puke "Supplying an empty left hand side argument is not supported";
 593   }
 594   if ($k =~ /^-/) {
 595     if ($k eq '-nest') {
 596       return $self->_expand_expr($v);
 597     }
 598     if ($k eq '-bool') {
 599       if (ref($v)) {
 600         return $self->_expand_expr($v);
 601       }
 602       puke "-bool => undef not supported" unless defined($v);
 603       return { -ident => $v };
 604     }
 605     if (my ($rest) = $k =~/^-not[_ ](.*)$/) {
 606       return $self->_expand_expr({ -not => { "-${rest}", $v } }, $logic);
 607     }
 608     if (my ($logic) = $k =~ /^-(and|or)$/) {
 609       if (ref($v) eq 'HASH') {
 610         return $self->_expand_expr($v, $logic);
 611       }
 612     }
 613   } else {
 614     unless (defined($v)) {
 615       my $orig_op = my $op = $self->{cmp};
 616       my $is =
 617         $op =~ /^not$/i               ? 'is not'  # legacy
 618       : $op =~ $self->{equality_op}   ? 'is'
 619       : $op =~ $self->{like_op}       ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
 620       : $op =~ $self->{inequality_op} ? 'is not'
 621       : $op =~ $self->{not_like_op}   ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
 622       : puke "unexpected operator '$orig_op' with undef operand";
 623       return +{ -op => [ $is.' null', { -ident => $k } ] };
 624     }
 625     if (!ref($v)) {
 626       return +{
 627         -op => [
 628           $self->{cmp},
 629           { -ident => $k },
 630           { -bind => [ $k, $v ] }
 631         ]
 632       };
 633     }
 634     if (ref($v) eq 'HASH') {
 635       if (keys %$v > 1) {
 636         return { -and => [
 637           map $self->_expand_expr_hashpair($k => { $_ => $v->{$_} }),
 638             sort keys %$v
 639         ] };
 640       }
 641       my ($vk, $vv) = %$v;
 642       $vk =~ s/^-//;
 643       if ($vk =~ /^(?:not[ _])?between$/) {
 644         my @rhs = map $self->_expand_expr($_),
 645                     ref($vv) eq 'ARRAY' ? @$vv : $vv;
 646         unless (
 647           (@rhs == 1 and ref($rhs[0]) eq 'HASH' and $rhs[0]->{-literal})
 648           or
 649           (@rhs == 2 and defined($rhs[0]) and defined($rhs[1]))
 650         ) {
 651           puke "Operator '${\uc($vk)}' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
 652         }
 653         return +{ -op => [
 654           join(' ', split '_', $vk),
 655           { -ident => $k },
 656           map {
 657             my $v = ref($_) ? $_->{-value} :$_;
 658             ($v ? { -bind => [ $k, $v ] } : $_)
 659           } @rhs
 660         ] }
 661       }
 662       if ($vk =~ /^(?:not[ _])?in$/) {
 663         if (my $literal = is_literal_value($vv)) {
 664           my ($sql, @bind) = @$literal;
 665           my $opened_sql = $self->_open_outer_paren($sql);
 666           return +{ -op => [
 667             $vk, { -ident => $k },
 668             [ { -literal => [ $opened_sql, @bind ] } ]
 669           ] };
 670         }
 671         my $undef_err =
 672           'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
 673         . "-${\uc($vk)} operator was given an undef-containing list: !!!AUDIT YOUR CODE "
 674         . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
 675         . 'will emit the logically correct SQL instead of raising this exception)'
 676         ;
 677         puke("Argument passed to the '${\uc($vk)}' operator can not be undefined")
 678           if !defined($vv);
 679         my @rhs = map $self->_expand_expr($_),
 680                     map { ref($_) ? $_ : { -bind => [ $k, $_ ] } }
 681                     map { defined($_) ? $_: puke($undef_err) }
 682                       (ref($vv) eq 'ARRAY' ? @$vv : $vv);
 683         return +{
 684           -literal => [ $self->{$vk =~ /^not/ ? 'sqltrue' : 'sqlfalse'} ]
 685         } unless @rhs;
 686
 687         return +{ -op => [
 688           join(' ', split '_', $vk),
 689           { -ident => $k },
 690           \@rhs
 691         ] };
 692       }
 693     }
 694     if (ref($v) eq 'ARRAY') {
 695       return $self->{sqlfalse} unless @$v;
 696       $self->_debug("ARRAY($k) means distribute over elements");
 697       my $this_logic = (
 698         $v->[0] =~ /^-((?:and|or))$/i
 699           ? ($v = [ @{$v}[1..$#$v] ], $1)
 700           : ($self->{logic} || 'or')
 701       );
 702       return +{ "-${this_logic}" => [ map $self->_expand_expr({ $k => $_ }, $this_logic), @$v ] };
 703     }
 704     if (my $literal = is_literal_value($v)) {
 705       unless (length $k) {
 706         belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
 707         return \$literal;
 708       }
 709       my ($sql, @bind) = @$literal;
 710       if ($self->{bindtype} eq 'columns') {
 711         for (@bind) {
 712           if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
 713             puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
 714           }
 715         }
 716       }
 717       return +{ -literal => [ $self->_quote($k).' '.$sql, @bind ] };
 718     }
 719   }
 720   return { $k => $v };
 721 }
 722
 723 sub _recurse_where {
 724   my ($self, $where, $logic) = @_;
 725
 726   my $where_exp = $self->_expand_expr($where, $logic);
 727
 728   # dispatch on appropriate method according to refkind of $where
 729   my $method = $self->_METHOD_FOR_refkind("_where", $where_exp);
 730
 731   my ($sql, @bind) =  $self->$method($where_exp, $logic);
 732
 733   # DBIx::Class used to call _recurse_where in scalar context
 734   # something else might too...
 735   if (wantarray) {
 736     return ($sql, @bind);
 737   }
 738   else {
 739     belch "Calling _recurse_where in scalar context is deprecated and will go away before 2.0";
 740     return $sql;
 741   }
 742 }
 743
 744
 745
 746 #======================================================================
 747 # WHERE: top-level ARRAYREF
 748 #======================================================================
 749
 750
 751 sub _where_ARRAYREF {
 752   my ($self, $where, $logic) = @_;
 753
 754   $logic = uc($logic || $self->{logic});
 755   $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
 756
 757   my @clauses = @$where;
 758
 759   my (@sql_clauses, @all_bind);
 760   # need to use while() so can shift() for pairs
 761   while (@clauses) {
 762     my $el = shift @clauses;
 763
 764     $el = undef if (defined $el and ! length $el);
 765
 766     # switch according to kind of $el and get corresponding ($sql, @bind)
 767     my ($sql, @bind) = $self->_SWITCH_refkind($el, {
 768
 769       # skip empty elements, otherwise get invalid trailing AND stuff
 770       ARRAYREF  => sub {$self->_recurse_where($el)        if @$el},
 771
 772       ARRAYREFREF => sub {
 773         my ($s, @b) = @$$el;
 774         $self->_assert_bindval_matches_bindtype(@b);
 775         ($s, @b);
 776       },
 777
 778       HASHREF   => sub {$self->_recurse_where($el, 'and') if %$el},
 779
 780       SCALARREF => sub { ($$el);                                 },
 781
 782       SCALAR    => sub {
 783         # top-level arrayref with scalars, recurse in pairs
 784         $self->_recurse_where({$el => shift(@clauses)})
 785       },
 786
 787       UNDEF     => sub {puke "Supplying an empty left hand side argument is not supported in array-pairs" },
 788     });
 789
 790     if ($sql) {
 791       push @sql_clauses, $sql;
 792       push @all_bind, @bind;
 793     }
 794   }
 795
 796   return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
 797 }
 798
 799 #======================================================================
 800 # WHERE: top-level ARRAYREFREF
 801 #======================================================================
 802
 803 sub _where_ARRAYREFREF {
 804     my ($self, $where) = @_;
 805     my ($sql, @bind) = @$$where;
 806     $self->_assert_bindval_matches_bindtype(@bind);
 807     return ($sql, @bind);
 808 }
 809
 810 #======================================================================
 811 # WHERE: top-level HASHREF
 812 #======================================================================
 813
 814 sub _where_HASHREF {
 815   my ($self, $where) = @_;
 816   my (@sql_clauses, @all_bind);
 817
 818   for my $k (sort keys %$where) {
 819     my $v = $where->{$k};
 820
 821     # ($k => $v) is either a special unary op or a regular hashpair
 822     my ($sql, @bind) = do {
 823       if ($k =~ /^-./) {
 824         # put the operator in canonical form
 825         my $op = $k;
 826         $op = substr $op, 1;  # remove initial dash
 827         $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
 828         $op =~ s/\s+/ /g;     # compress whitespace
 829
 830         # so that -not_foo works correctly
 831         $op =~ s/^not_/NOT /i;
 832
 833         $self->_debug("Unary OP(-$op) within hashref, recursing...");
 834         my ($s, @b) = $self->_where_unary_op($op, $v);
 835
 836         # top level vs nested
 837         # we assume that handled unary ops will take care of their ()s
 838         $s = "($s)" unless (
 839           List::Util::first {$op =~ $_->{regex}} @{$self->{unary_ops}}
 840             or
 841           ( defined $self->{_nested_func_lhs} and $self->{_nested_func_lhs} eq $k )
 842         );
 843         ($s, @b);
 844       }
 845       else {
 846         if (! length $k) {
 847           if (is_literal_value ($v) ) {
 848             belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead';
 849           }
 850           else {
 851             puke "Supplying an empty left hand side argument is not supported in hash-pairs";
 852           }
 853         }
 854
 855         my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
 856         $self->$method($k, $v);
 857       }
 858     };
 859
 860     push @sql_clauses, $sql;
 861     push @all_bind, @bind;
 862   }
 863
 864   return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
 865 }
 866
 867 sub _where_unary_op {
 868   my ($self, $op, $rhs) = @_;
 869
 870   $op =~ s/^-// if length($op) > 1;
 871
 872   # top level special ops are illegal in general
 873   puke "Illegal use of top-level '-$op'"
 874     if !(defined $self->{_nested_func_lhs})
 875     and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}
 876     and not List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}};
 877
 878   if (my $op_entry = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) {
 879     my $handler = $op_entry->{handler};
 880
 881     if (not ref $handler) {
 882       if ($op =~ s/ [_\s]? \d+ $//x ) {
 883         belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
 884             . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
 885       }
 886       return $self->$handler($op, $rhs);
 887     }
 888     elsif (ref $handler eq 'CODE') {
 889       return $handler->($self, $op, $rhs);
 890     }
 891     else {
 892       puke "Illegal handler for operator $op - expecting a method name or a coderef";
 893     }
 894   }
 895
 896   $self->_debug("Generic unary OP: $op - recursing as function");
 897
 898   $self->_assert_pass_injection_guard($op);
 899
 900   my ($sql, @bind) = $self->_SWITCH_refkind($rhs, {
 901     SCALAR =>   sub {
 902       puke "Illegal use of top-level '-$op'"
 903         unless defined $self->{_nested_func_lhs};
 904
 905       return (
 906         $self->_convert('?'),
 907         $self->_bindtype($self->{_nested_func_lhs}, $rhs)
 908       );
 909     },
 910     FALLBACK => sub {
 911       $self->_recurse_where($rhs)
 912     },
 913   });
 914
 915   $sql = sprintf('%s %s',
 916     $self->_sqlcase($op),
 917     $sql,
 918   );
 919
 920   return ($sql, @bind);
 921 }
 922
 923 sub _where_op_ANDOR {
 924   my ($self, $op, $v) = @_;
 925
 926   $self->_SWITCH_refkind($v, {
 927     ARRAYREF => sub {
 928       return $self->_where_ARRAYREF($v, $op);
 929     },
 930
 931     HASHREF => sub {
 932       return ($op =~ /^or/i)
 933         ? $self->_where_ARRAYREF([ map { $_ => $v->{$_} } (sort keys %$v) ], $op)
 934         : $self->_where_HASHREF($v);
 935     },
 936
 937     SCALARREF  => sub {
 938       puke "-$op => \\\$scalar makes little sense, use " .
 939         ($op =~ /^or/i
 940           ? '[ \$scalar, \%rest_of_conditions ] instead'
 941           : '-and => [ \$scalar, \%rest_of_conditions ] instead'
 942         );
 943     },
 944
 945     ARRAYREFREF => sub {
 946       puke "-$op => \\[...] makes little sense, use " .
 947         ($op =~ /^or/i
 948           ? '[ \[...], \%rest_of_conditions ] instead'
 949           : '-and => [ \[...], \%rest_of_conditions ] instead'
 950         );
 951     },
 952
 953     SCALAR => sub { # permissively interpreted as SQL
 954       puke "-$op => \$value makes little sense, use -bool => \$value instead";
 955     },
 956
 957     UNDEF => sub {
 958       puke "-$op => undef not supported";
 959     },
 960    });
 961 }
 962
 963 sub _where_op_NEST {
 964   my ($self, $op, $v) = @_;
 965
 966   $self->_SWITCH_refkind($v, {
 967
 968     SCALAR => sub { # permissively interpreted as SQL
 969       belch "literal SQL should be -nest => \\'scalar' "
 970           . "instead of -nest => 'scalar' ";
 971       return ($v);
 972     },
 973
 974     UNDEF => sub {
 975       puke "-$op => undef not supported";
 976     },
 977
 978     FALLBACK => sub {
 979       $self->_recurse_where($v);
 980     },
 981
 982    });
 983 }
 984
 985
 986 sub _where_op_BOOL {
 987   my ($self, $op, $v) = @_;
 988
 989   my ($s, @b) = $self->_SWITCH_refkind($v, {
 990     SCALAR => sub { # interpreted as SQL column
 991       $self->_convert($self->_quote($v));
 992     },
 993
 994     UNDEF => sub {
 995       puke "-$op => undef not supported";
 996     },
 997
 998     FALLBACK => sub {
 999       $self->_recurse_where($v);
1000     },
1001   });
1002
1003   $s = "(NOT $s)" if $op =~ /^not/i;
1004   ($s, @b);
1005 }
1006
1007
1008 sub _where_op_IDENT {
1009   my $self = shift;
1010   my ($op, $rhs) = splice @_, -2;
1011   if (! defined $rhs or length ref $rhs) {
1012     puke "-$op requires a single plain scalar argument (a quotable identifier)";
1013   }
1014
1015   # in case we are called as a top level special op (no '=')
1016   my $has_lhs = my $lhs = shift;
1017
1018   $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
1019
1020   return $has_lhs
1021     ? "$lhs = $rhs"
1022     : $rhs
1023   ;
1024 }
1025
1026 sub _where_op_VALUE {
1027   my $self = shift;
1028   my ($op, $rhs) = splice @_, -2;
1029
1030   # in case we are called as a top level special op (no '=')
1031   my $lhs = shift;
1032
1033   # special-case NULL
1034   if (! defined $rhs) {
1035     return defined $lhs
1036       ? $self->_where_hashpair_HASHREF($lhs, { -is => undef })
1037       : undef
1038     ;
1039   }
1040
1041   my @bind =
1042     $self->_bindtype(
1043       (defined $lhs ? $lhs : $self->{_nested_func_lhs}),
1044       $rhs,
1045     )
1046   ;
1047
1048   return $lhs
1049     ? (
1050       $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'),
1051       @bind
1052     )
1053     : (
1054       $self->_convert('?'),
1055       @bind,
1056     )
1057   ;
1058 }
1059
1060
1061 my %unop_postfix = map +($_ => 1), 'is null', 'is not null';
1062
1063 my %special = (
1064   (map +($_ => do {
1065     my $op = $_;
1066     sub {
1067       my ($self, $args) = @_;
1068       my ($left, $low, $high) = @$args;
1069       my ($rhsql, @rhbind) = do {
1070         if (@$args == 2) {
1071           puke "Single arg to between must be a literal"
1072             unless $low->{-literal};
1073           @{$low->{-literal}}
1074         } else {
1075           local $self->{_nested_func_lhs} = $left->{-ident}
1076             if ref($left) eq 'HASH' and $left->{-ident};
1077           my ($l, $h) = map [ $self->_where_unary_op(%$_) ], $low, $high;
1078           (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]),
1079            @{$l}[1..$#$l], @{$h}[1..$#$h])
1080         }
1081       };
1082       my ($lhsql, @lhbind) = $self->_recurse_where($left);
1083       return (
1084         join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'),
1085         @lhbind, @rhbind
1086       );
1087     }
1088   }), 'between', 'not between'),
1089   (map +($_ => do {
1090     my $op = $_;
1091     sub {
1092       my ($self, $args) = @_;
1093       my ($lhs, $rhs) = @$args;
1094       my @in_bind;
1095       my @in_sql = map {
1096         local $self->{_nested_func_lhs} = $lhs->{-ident}
1097           if ref($lhs) eq 'HASH' and $lhs->{-ident};
1098         my ($sql, @bind) = $self->_where_unary_op(%$_);
1099         push @in_bind, @bind;
1100         $sql;
1101       } @$rhs;
1102       my ($lhsql, @lbind) = $self->_recurse_where($lhs);
1103       return (
1104         $lhsql.' '.$self->_sqlcase($op).' ( '
1105         .join(', ', @in_sql)
1106         .' )',
1107         @lbind, @in_bind
1108       );
1109     }
1110   }), 'in', 'not in'),
1111 );
1112
1113 sub _where_op_OP {
1114   my ($self, undef, $v) = @_;
1115   my ($op, @args) = @$v;
1116   $op =~ s/^-// if length($op) > 1;
1117   local $self->{_nested_func_lhs};
1118   if (my $h = $special{$op}) {
1119     return $self->$h(\@args);
1120   }
1121   if (@args == 1) {
1122     my ($expr_sql, @bind) = $self->_recurse_where($args[0]);
1123     my $final_op = join ' ', split '_', $op;
1124     my $op_sql = $self->_sqlcase($final_op);
1125     my $final_sql = (
1126       $unop_postfix{lc($final_op)}
1127         ? "${expr_sql} ${op_sql}"
1128         : "${op_sql} ${expr_sql}"
1129     );
1130     return ($final_sql, @bind);
1131   } elsif (@args == 2) {
1132      my ($l, $r) = map [ $self->_recurse_where($_) ], @args;
1133      return (                                                                          $l->[0].' '.$self->_sqlcase(join ' ', split '_', $op).' '.$r->[0],              @{$l}[1..$#$l], @{$r}[1..$#$r]                                                );
1134   }
1135   die "unhandled";
1136 }
1137
1138 sub _where_op_BIND {
1139   my ($self, undef, $bind) = @_;
1140   return ($self->_convert('?'), $self->_bindtype(@$bind));
1141 }
1142
1143 sub _where_op_LITERAL {
1144   my ($self, undef, $literal) = @_;
1145   $self->_assert_bindval_matches_bindtype(@{$literal}[1..$#$literal]);
1146   return @$literal;
1147 }
1148
1149 sub _where_hashpair_ARRAYREF {
1150   my ($self, $k, $v) = @_;
1151
1152   if (@$v) {
1153     my @v = @$v; # need copy because of shift below
1154     $self->_debug("ARRAY($k) means distribute over elements");
1155
1156     # put apart first element if it is an operator (-and, -or)
1157     my $op = (
1158        (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
1159          ? shift @v
1160          : ''
1161     );
1162     my @distributed = map { {$k =>  $_} } @v;
1163
1164     if ($op) {
1165       $self->_debug("OP($op) reinjected into the distributed array");
1166       unshift @distributed, $op;
1167     }
1168
1169     my $logic = $op ? substr($op, 1) : '';
1170
1171     return $self->_recurse_where(\@distributed, $logic);
1172   }
1173   else {
1174     $self->_debug("empty ARRAY($k) means 0=1");
1175     return ($self->{sqlfalse});
1176   }
1177 }
1178
1179 sub _where_hashpair_HASHREF {
1180   my ($self, $k, $v, $logic) = @_;
1181   $logic ||= 'and';
1182
1183   local $self->{_nested_func_lhs} = defined $self->{_nested_func_lhs}
1184     ? $self->{_nested_func_lhs}
1185     : $k
1186   ;
1187
1188   my ($all_sql, @all_bind);
1189
1190   for my $orig_op (sort keys %$v) {
1191     my $val = $v->{$orig_op};
1192
1193     # put the operator in canonical form
1194     my $op = $orig_op;
1195
1196     # FIXME - we need to phase out dash-less ops
1197     $op =~ s/^-//;        # remove possible initial dash
1198     $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
1199     $op =~ s/\s+/ /g;     # compress whitespace
1200
1201     $self->_assert_pass_injection_guard($op);
1202
1203     # fixup is_not
1204     $op =~ s/^is_not/IS NOT/i;
1205
1206     # so that -not_foo works correctly
1207     $op =~ s/^not_/NOT /i;
1208
1209     # another retarded special case: foo => { $op => { -value => undef } }
1210     if (ref $val eq 'HASH' and keys %$val == 1 and exists $val->{-value} and ! defined $val->{-value} ) {
1211       $val = undef;
1212     }
1213
1214     my ($sql, @bind);
1215
1216     # CASE: col-value logic modifiers
1217     if ($orig_op =~ /^ \- (and|or) $/xi) {
1218       ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $1);
1219     }
1220     # CASE: special operators like -in or -between
1221     elsif (my $special_op = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) {
1222       my $handler = $special_op->{handler};
1223       if (! $handler) {
1224         puke "No handler supplied for special operator $orig_op";
1225       }
1226       elsif (not ref $handler) {
1227         ($sql, @bind) = $self->$handler($k, $op, $val);
1228       }
1229       elsif (ref $handler eq 'CODE') {
1230         ($sql, @bind) = $handler->($self, $k, $op, $val);
1231       }
1232       else {
1233         puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
1234       }
1235     }
1236     else {
1237       $self->_SWITCH_refkind($val, {
1238
1239         ARRAYREF => sub {       # CASE: col => {op => \@vals}
1240           ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
1241         },
1242
1243         ARRAYREFREF => sub {    # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
1244           my ($sub_sql, @sub_bind) = @$$val;
1245           $self->_assert_bindval_matches_bindtype(@sub_bind);
1246           $sql  = join ' ', $self->_convert($self->_quote($k)),
1247                             $self->_sqlcase($op),
1248                             $sub_sql;
1249           @bind = @sub_bind;
1250         },
1251
1252         UNDEF => sub {          # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
1253           my $is =
1254             $op =~ /^not$/i               ? 'is not'  # legacy
1255           : $op =~ $self->{equality_op}   ? 'is'
1256           : $op =~ $self->{like_op}       ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is'
1257           : $op =~ $self->{inequality_op} ? 'is not'
1258           : $op =~ $self->{not_like_op}   ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not'
1259           : puke "unexpected operator '$orig_op' with undef operand";
1260
1261           $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
1262         },
1263
1264         FALLBACK => sub {       # CASE: col => {op/func => $stuff}
1265           ($sql, @bind) = $self->_where_unary_op($op, $val);
1266
1267           $sql = join(' ',
1268             $self->_convert($self->_quote($k)),
1269             $self->{_nested_func_lhs} eq $k ? $sql : "($sql)",  # top level vs nested
1270           );
1271         },
1272       });
1273     }
1274
1275     ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
1276     push @all_bind, @bind;
1277   }
1278   return ($all_sql, @all_bind);
1279 }
1280
1281 sub _where_field_IS {
1282   my ($self, $k, $op, $v) = @_;
1283
1284   my ($s) = $self->_SWITCH_refkind($v, {
1285     UNDEF => sub {
1286       join ' ',
1287         $self->_convert($self->_quote($k)),
1288         map { $self->_sqlcase($_)} ($op, 'null')
1289     },
1290     FALLBACK => sub {
1291       puke "$op can only take undef as argument";
1292     },
1293   });
1294
1295   $s;
1296 }
1297
1298 sub _where_field_op_ARRAYREF {
1299   my ($self, $k, $op, $vals) = @_;
1300
1301   my @vals = @$vals;  #always work on a copy
1302
1303   if (@vals) {
1304     $self->_debug(sprintf '%s means multiple elements: [ %s ]',
1305       $vals,
1306       join(', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
1307     );
1308
1309     # see if the first element is an -and/-or op
1310     my $logic;
1311     if (defined $vals[0] && $vals[0] =~ /^ - (AND|OR) $/ix) {
1312       $logic = uc $1;
1313       shift @vals;
1314     }
1315
1316     # a long standing API wart - an attempt to change this behavior during
1317     # the 1.50 series failed *spectacularly*. Warn instead and leave the
1318     # behavior as is
1319     if (
1320       @vals > 1
1321         and
1322       (!$logic or $logic eq 'OR')
1323         and
1324       ($op =~ $self->{inequality_op} or $op =~ $self->{not_like_op})
1325     ) {
1326       my $o = uc($op);
1327       belch "A multi-element arrayref as an argument to the inequality op '$o' "
1328           . 'is technically equivalent to an always-true 1=1 (you probably wanted '
1329           . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)"
1330       ;
1331     }
1332
1333     # distribute $op over each remaining member of @vals, append logic if exists
1334     return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
1335
1336   }
1337   else {
1338     # try to DWIM on equality operators
1339     return
1340       $op =~ $self->{equality_op}   ? $self->{sqlfalse}
1341     : $op =~ $self->{like_op}       ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqlfalse}
1342     : $op =~ $self->{inequality_op} ? $self->{sqltrue}
1343     : $op =~ $self->{not_like_op}   ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->{sqltrue}
1344     : puke "operator '$op' applied on an empty array (field '$k')";
1345   }
1346 }
1347
1348
1349 sub _where_hashpair_SCALARREF {
1350   my ($self, $k, $v) = @_;
1351   $self->_debug("SCALAR($k) means literal SQL: $$v");
1352   my $sql = $self->_quote($k) . " " . $$v;
1353   return ($sql);
1354 }
1355
1356 # literal SQL with bind
1357 sub _where_hashpair_ARRAYREFREF {
1358   my ($self, $k, $v) = @_;
1359   $self->_debug("REF($k) means literal SQL: @${$v}");
1360   my ($sql, @bind) = @$$v;
1361   $self->_assert_bindval_matches_bindtype(@bind);
1362   $sql  = $self->_quote($k) . " " . $sql;
1363   return ($sql, @bind );
1364 }
1365
1366 # literal SQL without bind
1367 sub _where_hashpair_SCALAR {
1368   my ($self, $k, $v) = @_;
1369   $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
1370   return ($self->_where_hashpair_HASHREF($k, { $self->{cmp} => $v }));
1371 }
1372
1373
1374 sub _where_hashpair_UNDEF {
1375   my ($self, $k, $v) = @_;
1376   $self->_debug("UNDEF($k) means IS NULL");
1377   return $self->_where_hashpair_HASHREF($k, { -is => undef });
1378 }
1379
1380 #======================================================================
1381 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
1382 #======================================================================
1383
1384
1385 sub _where_SCALARREF {
1386   my ($self, $where) = @_;
1387
1388   # literal sql
1389   $self->_debug("SCALAR(*top) means literal SQL: $$where");
1390   return ($$where);
1391 }
1392
1393
1394 sub _where_SCALAR {
1395   my ($self, $where) = @_;
1396
1397   # literal sql
1398   $self->_debug("NOREF(*top) means literal SQL: $where");
1399   return ($where);
1400 }
1401
1402
1403 sub _where_UNDEF {
1404   my ($self) = @_;
1405   return ();
1406 }
1407
1408
1409 #======================================================================
1410 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
1411 #======================================================================
1412
1413
1414 sub _where_field_BETWEEN {
1415   my ($self, $k, $op, $vals) = @_;
1416
1417   my ($label, $and, $placeholder);
1418   $label       = $self->_convert($self->_quote($k));
1419   $and         = ' ' . $self->_sqlcase('and') . ' ';
1420   $placeholder = $self->_convert('?');
1421   $op               = $self->_sqlcase($op);
1422
1423   my $invalid_args = "Operator '$op' requires either an arrayref with two defined values or expressions, or a single literal scalarref/arrayref-ref";
1424
1425   my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
1426     ARRAYREFREF => sub {
1427       my ($s, @b) = @$$vals;
1428       $self->_assert_bindval_matches_bindtype(@b);
1429       ($s, @b);
1430     },
1431     SCALARREF => sub {
1432       return $$vals;
1433     },
1434     ARRAYREF => sub {
1435       puke $invalid_args if @$vals != 2;
1436
1437       my (@all_sql, @all_bind);
1438       foreach my $val (@$vals) {
1439         my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1440            SCALAR => sub {
1441              return ($placeholder, $self->_bindtype($k, $val) );
1442            },
1443            SCALARREF => sub {
1444              return $$val;
1445            },
1446            ARRAYREFREF => sub {
1447              my ($sql, @bind) = @$$val;
1448              $self->_assert_bindval_matches_bindtype(@bind);
1449              return ($sql, @bind);
1450            },
1451            HASHREF => sub {
1452              my ($func, $arg, @rest) = %$val;
1453              puke "Only simple { -func => arg } functions accepted as sub-arguments to BETWEEN"
1454                if (@rest or $func !~ /^ \- (.+)/x);
1455              $self->_where_unary_op($1 => $arg);
1456            },
1457            FALLBACK => sub {
1458              puke $invalid_args,
1459            },
1460         });
1461         push @all_sql, $sql;
1462         push @all_bind, @bind;
1463       }
1464
1465       return (
1466         (join $and, @all_sql),
1467         @all_bind
1468       );
1469     },
1470     FALLBACK => sub {
1471       puke $invalid_args,
1472     },
1473   });
1474
1475   my $sql = "( $label $op $clause )";
1476   return ($sql, @bind)
1477 }
1478
1479
1480 sub _where_field_IN {
1481   my ($self, $k, $op, $vals) = @_;
1482
1483   # backwards compatibility: if scalar, force into an arrayref
1484   $vals = [$vals] if defined $vals && ! ref $vals;
1485
1486   my ($label)       = $self->_convert($self->_quote($k));
1487   my ($placeholder) = $self->_convert('?');
1488   $op               = $self->_sqlcase($op);
1489
1490   my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
1491     ARRAYREF => sub {     # list of choices
1492       if (@$vals) { # nonempty list
1493         my (@all_sql, @all_bind);
1494
1495         for my $val (@$vals) {
1496           my ($sql, @bind) = $self->_SWITCH_refkind($val, {
1497             SCALAR => sub {
1498               return ($placeholder, $val);
1499             },
1500             SCALARREF => sub {
1501               return $$val;
1502             },
1503             ARRAYREFREF => sub {
1504               my ($sql, @bind) = @$$val;
1505               $self->_assert_bindval_matches_bindtype(@bind);
1506               return ($sql, @bind);
1507             },
1508             HASHREF => sub {
1509               my ($func, $arg, @rest) = %$val;
1510               puke "Only simple { -func => arg } functions accepted as sub-arguments to IN"
1511                 if (@rest or $func !~ /^ \- (.+)/x);
1512               $self->_where_unary_op($1 => $arg);
1513             },
1514             UNDEF => sub {
1515               puke(
1516                 'SQL::Abstract before v1.75 used to generate incorrect SQL when the '
1517               . "-$op operator was given an undef-containing list: !!!AUDIT YOUR CODE "
1518               . 'AND DATA!!! (the upcoming Data::Query-based version of SQL::Abstract '
1519               . 'will emit the logically correct SQL instead of raising this exception)'
1520               );
1521             },
1522           });
1523           push @all_sql, $sql;
1524           push @all_bind, @bind;
1525         }
1526
1527         return (
1528           sprintf('%s %s ( %s )',
1529             $label,
1530             $op,
1531             join(', ', @all_sql)
1532           ),
1533           $self->_bindtype($k, @all_bind),
1534         );
1535       }
1536       else { # empty list: some databases won't understand "IN ()", so DWIM
1537         my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
1538         return ($sql);
1539       }
1540     },
1541
1542     SCALARREF => sub {  # literal SQL
1543       my $sql = $self->_open_outer_paren($$vals);
1544       return ("$label $op ( $sql )");
1545     },
1546     ARRAYREFREF => sub {  # literal SQL with bind
1547       my ($sql, @bind) = @$$vals;
1548       $self->_assert_bindval_matches_bindtype(@bind);
1549       $sql = $self->_open_outer_paren($sql);
1550       return ("$label $op ( $sql )", @bind);
1551     },
1552
1553     UNDEF => sub {
1554       puke "Argument passed to the '$op' operator can not be undefined";
1555     },
1556
1557     FALLBACK => sub {
1558       puke "special op $op requires an arrayref (or scalarref/arrayref-ref)";
1559     },
1560   });
1561
1562   return ($sql, @bind);
1563 }
1564
1565 # Some databases (SQLite) treat col IN (1, 2) different from
1566 # col IN ( (1, 2) ). Use this to strip all outer parens while
1567 # adding them back in the corresponding method
1568 sub _open_outer_paren {
1569   my ($self, $sql) = @_;
1570
1571   while (my ($inner) = $sql =~ /^ \s* \( (.*) \) \s* $/xs) {
1572
1573     # there are closing parens inside, need the heavy duty machinery
1574     # to reevaluate the extraction starting from $sql (full reevaluation)
1575     if ($inner =~ /\)/) {
1576       require Text::Balanced;
1577
1578       my (undef, $remainder) = do {
1579         # idiotic design - writes to $@ but *DOES NOT* throw exceptions
1580         local $@;
1581         Text::Balanced::extract_bracketed($sql, '()', qr/\s*/);
1582       };
1583
1584       # the entire expression needs to be a balanced bracketed thing
1585       # (after an extract no remainder sans trailing space)
1586       last if defined $remainder and $remainder =~ /\S/;
1587     }
1588
1589     $sql = $inner;
1590   }
1591
1592   $sql;
1593 }
1594
1595
1596 #======================================================================
1597 # ORDER BY
1598 #======================================================================
1599
1600 sub _order_by {
1601   my ($self, $arg) = @_;
1602
1603   my (@sql, @bind);
1604   for my $c ($self->_order_by_chunks($arg) ) {
1605     $self->_SWITCH_refkind($c, {
1606       SCALAR => sub { push @sql, $c },
1607       ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
1608     });
1609   }
1610
1611   my $sql = @sql
1612     ? sprintf('%s %s',
1613         $self->_sqlcase(' order by'),
1614         join(', ', @sql)
1615       )
1616     : ''
1617   ;
1618
1619   return wantarray ? ($sql, @bind) : $sql;
1620 }
1621
1622 sub _order_by_chunks {
1623   my ($self, $arg) = @_;
1624
1625   return $self->_SWITCH_refkind($arg, {
1626
1627     ARRAYREF => sub {
1628       map { $self->_order_by_chunks($_ ) } @$arg;
1629     },
1630
1631     ARRAYREFREF => sub {
1632       my ($s, @b) = @$$arg;
1633       $self->_assert_bindval_matches_bindtype(@b);
1634       [ $s, @b ];
1635     },
1636
1637     SCALAR    => sub {$self->_quote($arg)},
1638
1639     UNDEF     => sub {return () },
1640
1641     SCALARREF => sub {$$arg}, # literal SQL, no quoting
1642
1643     HASHREF   => sub {
1644       # get first pair in hash
1645       my ($key, $val, @rest) = %$arg;
1646
1647       return () unless $key;
1648
1649       if (@rest or not $key =~ /^-(desc|asc)/i) {
1650         puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
1651       }
1652
1653       my $direction = $1;
1654
1655       my @ret;
1656       for my $c ($self->_order_by_chunks($val)) {
1657         my ($sql, @bind);
1658
1659         $self->_SWITCH_refkind($c, {
1660           SCALAR => sub {
1661             $sql = $c;
1662           },
1663           ARRAYREF => sub {
1664             ($sql, @bind) = @$c;
1665           },
1666         });
1667
1668         $sql = $sql . ' ' . $self->_sqlcase($direction);
1669
1670         push @ret, [ $sql, @bind];
1671       }
1672
1673       return @ret;
1674     },
1675   });
1676 }
1677
1678
1679 #======================================================================
1680 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1681 #======================================================================
1682
1683 sub _table  {
1684   my $self = shift;
1685   my $from = shift;
1686   $self->_SWITCH_refkind($from, {
1687     ARRAYREF     => sub {join ', ', map { $self->_quote($_) } @$from;},
1688     SCALAR       => sub {$self->_quote($from)},
1689     SCALARREF    => sub {$$from},
1690   });
1691 }
1692
1693
1694 #======================================================================
1695 # UTILITY FUNCTIONS
1696 #======================================================================
1697
1698 # highly optimized, as it's called way too often
1699 sub _quote {
1700   # my ($self, $label) = @_;
1701
1702   return '' unless defined $_[1];
1703   return ${$_[1]} if ref($_[1]) eq 'SCALAR';
1704
1705   $_[0]->{quote_char} or
1706     ($_[0]->_assert_pass_injection_guard($_[1]), return $_[1]);
1707
1708   my $qref = ref $_[0]->{quote_char};
1709   my ($l, $r) =
1710       !$qref             ? ($_[0]->{quote_char}, $_[0]->{quote_char})
1711     : ($qref eq 'ARRAY') ? @{$_[0]->{quote_char}}
1712     : puke "Unsupported quote_char format: $_[0]->{quote_char}";
1713
1714   my $esc = $_[0]->{escape_char} || $r;
1715
1716   # parts containing * are naturally unquoted
1717   return join($_[0]->{name_sep}||'', map
1718     +( $_ eq '*' ? $_ : do { (my $n = $_) =~ s/(\Q$esc\E|\Q$r\E)/$esc$1/g; $l . $n . $r } ),
1719     ( $_[0]->{name_sep} ? split (/\Q$_[0]->{name_sep}\E/, $_[1] ) : $_[1] )
1720   );
1721 }
1722
1723
1724 # Conversion, if applicable
1725 sub _convert {
1726   #my ($self, $arg) = @_;
1727   if ($_[0]->{convert}) {
1728     return $_[0]->_sqlcase($_[0]->{convert}) .'(' . $_[1] . ')';
1729   }
1730   return $_[1];
1731 }
1732
1733 # And bindtype
1734 sub _bindtype {
1735   #my ($self, $col, @vals) = @_;
1736   # called often - tighten code
1737   return $_[0]->{bindtype} eq 'columns'
1738     ? map {[$_[1], $_]} @_[2 .. $#_]
1739     : @_[2 .. $#_]
1740   ;
1741 }
1742
1743 # Dies if any element of @bind is not in [colname => value] format
1744 # if bindtype is 'columns'.
1745 sub _assert_bindval_matches_bindtype {
1746 #  my ($self, @bind) = @_;
1747   my $self = shift;
1748   if ($self->{bindtype} eq 'columns') {
1749     for (@_) {
1750       if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
1751         puke "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1752       }
1753     }
1754   }
1755 }
1756
1757 sub _join_sql_clauses {
1758   my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1759
1760   if (@$clauses_aref > 1) {
1761     my $join  = " " . $self->_sqlcase($logic) . " ";
1762     my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1763     return ($sql, @$bind_aref);
1764   }
1765   elsif (@$clauses_aref) {
1766     return ($clauses_aref->[0], @$bind_aref); # no parentheses
1767   }
1768   else {
1769     return (); # if no SQL, ignore @$bind_aref
1770   }
1771 }
1772
1773
1774 # Fix SQL case, if so requested
1775 sub _sqlcase {
1776   # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1777   # don't touch the argument ... crooked logic, but let's not change it!
1778   return $_[0]->{case} ? $_[1] : uc($_[1]);
1779 }
1780
1781
1782 #======================================================================
1783 # DISPATCHING FROM REFKIND
1784 #======================================================================
1785
1786 sub _refkind {
1787   my ($self, $data) = @_;
1788
1789   return 'UNDEF' unless defined $data;
1790
1791   # blessed objects are treated like scalars
1792   my $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1793
1794   return 'SCALAR' unless $ref;
1795
1796   my $n_steps = 1;
1797   while ($ref eq 'REF') {
1798     $data = $$data;
1799     $ref = (Scalar::Util::blessed $data) ? '' : ref $data;
1800     $n_steps++ if $ref;
1801   }
1802
1803   return ($ref||'SCALAR') . ('REF' x $n_steps);
1804 }
1805
1806 sub _try_refkind {
1807   my ($self, $data) = @_;
1808   my @try = ($self->_refkind($data));
1809   push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1810   push @try, 'FALLBACK';
1811   return \@try;
1812 }
1813
1814 sub _METHOD_FOR_refkind {
1815   my ($self, $meth_prefix, $data) = @_;
1816
1817   my $method;
1818   for (@{$self->_try_refkind($data)}) {
1819     $method = $self->can($meth_prefix."_".$_)
1820       and last;
1821   }
1822
1823   return $method || puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1824 }
1825
1826
1827 sub _SWITCH_refkind {
1828   my ($self, $data, $dispatch_table) = @_;
1829
1830   my $coderef;
1831   for (@{$self->_try_refkind($data)}) {
1832     $coderef = $dispatch_table->{$_}
1833       and last;
1834   }
1835
1836   puke "no dispatch entry for ".$self->_refkind($data)
1837     unless $coderef;
1838
1839   $coderef->();
1840 }
1841
1842
1843
1844
1845 #======================================================================
1846 # VALUES, GENERATE, AUTOLOAD
1847 #======================================================================
1848
1849 # LDNOTE: original code from nwiger, didn't touch code in that section
1850 # I feel the AUTOLOAD stuff should not be the default, it should
1851 # only be activated on explicit demand by user.
1852
1853 sub values {
1854     my $self = shift;
1855     my $data = shift || return;
1856     puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1857         unless ref $data eq 'HASH';
1858
1859     my @all_bind;
1860     foreach my $k (sort keys %$data) {
1861         my $v = $data->{$k};
1862         $self->_SWITCH_refkind($v, {
1863           ARRAYREF => sub {
1864             if ($self->{array_datatypes}) { # array datatype
1865               push @all_bind, $self->_bindtype($k, $v);
1866             }
1867             else {                          # literal SQL with bind
1868               my ($sql, @bind) = @$v;
1869               $self->_assert_bindval_matches_bindtype(@bind);
1870               push @all_bind, @bind;
1871             }
1872           },
1873           ARRAYREFREF => sub { # literal SQL with bind
1874             my ($sql, @bind) = @${$v};
1875             $self->_assert_bindval_matches_bindtype(@bind);
1876             push @all_bind, @bind;
1877           },
1878           SCALARREF => sub {  # literal SQL without bind
1879           },
1880           SCALAR_or_UNDEF => sub {
1881             push @all_bind, $self->_bindtype($k, $v);
1882           },
1883         });
1884     }
1885
1886     return @all_bind;
1887 }
1888
1889 sub generate {
1890     my $self  = shift;
1891
1892     my(@sql, @sqlq, @sqlv);
1893
1894     for (@_) {
1895         my $ref = ref $_;
1896         if ($ref eq 'HASH') {
1897             for my $k (sort keys %$_) {
1898                 my $v = $_->{$k};
1899                 my $r = ref $v;
1900                 my $label = $self->_quote($k);
1901                 if ($r eq 'ARRAY') {
1902                     # literal SQL with bind
1903                     my ($sql, @bind) = @$v;
1904                     $self->_assert_bindval_matches_bindtype(@bind);
1905                     push @sqlq, "$label = $sql";
1906                     push @sqlv, @bind;
1907                 } elsif ($r eq 'SCALAR') {
1908                     # literal SQL without bind
1909                     push @sqlq, "$label = $$v";
1910                 } else {
1911                     push @sqlq, "$label = ?";
1912                     push @sqlv, $self->_bindtype($k, $v);
1913                 }
1914             }
1915             push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1916         } elsif ($ref eq 'ARRAY') {
1917             # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1918             for my $v (@$_) {
1919                 my $r = ref $v;
1920                 if ($r eq 'ARRAY') {   # literal SQL with bind
1921                     my ($sql, @bind) = @$v;
1922                     $self->_assert_bindval_matches_bindtype(@bind);
1923                     push @sqlq, $sql;
1924                     push @sqlv, @bind;
1925                 } elsif ($r eq 'SCALAR') {  # literal SQL without bind
1926                     # embedded literal SQL
1927                     push @sqlq, $$v;
1928                 } else {
1929                     push @sqlq, '?';
1930                     push @sqlv, $v;
1931                 }
1932             }
1933             push @sql, '(' . join(', ', @sqlq) . ')';
1934         } elsif ($ref eq 'SCALAR') {
1935             # literal SQL
1936             push @sql, $$_;
1937         } else {
1938             # strings get case twiddled
1939             push @sql, $self->_sqlcase($_);
1940         }
1941     }
1942
1943     my $sql = join ' ', @sql;
1944
1945     # this is pretty tricky
1946     # if ask for an array, return ($stmt, @bind)
1947     # otherwise, s/?/shift @sqlv/ to put it inline
1948     if (wantarray) {
1949         return ($sql, @sqlv);
1950     } else {
1951         1 while $sql =~ s/\?/my $d = shift(@sqlv);
1952                              ref $d ? $d->[1] : $d/e;
1953         return $sql;
1954     }
1955 }
1956
1957
1958 sub DESTROY { 1 }
1959
1960 sub AUTOLOAD {
1961     # This allows us to check for a local, then _form, attr
1962     my $self = shift;
1963     my($name) = $AUTOLOAD =~ /.*::(.+)/;
1964     return $self->generate($name, @_);
1965 }
1966
1967 1;
1968
1969
1970
1971 __END__
1972
1973 =head1 NAME
1974
1975 SQL::Abstract - Generate SQL from Perl data structures
1976
1977 =head1 SYNOPSIS
1978
1979     use SQL::Abstract;
1980
1981     my $sql = SQL::Abstract->new;
1982
1983     my($stmt, @bind) = $sql->select($source, \@fields, \%where, $order);
1984
1985     my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1986
1987     my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1988
1989     my($stmt, @bind) = $sql->delete($table, \%where);
1990
1991     # Then, use these in your DBI statements
1992     my $sth = $dbh->prepare($stmt);
1993     $sth->execute(@bind);
1994
1995     # Just generate the WHERE clause
1996     my($stmt, @bind) = $sql->where(\%where, $order);
1997
1998     # Return values in the same order, for hashed queries
1999     # See PERFORMANCE section for more details
2000     my @bind = $sql->values(\%fieldvals);
2001
2002 =head1 DESCRIPTION
2003
2004 This module was inspired by the excellent L<DBIx::Abstract>.
2005 However, in using that module I found that what I really wanted
2006 to do was generate SQL, but still retain complete control over my
2007 statement handles and use the DBI interface. So, I set out to
2008 create an abstract SQL generation module.
2009
2010 While based on the concepts used by L<DBIx::Abstract>, there are
2011 several important differences, especially when it comes to WHERE
2012 clauses. I have modified the concepts used to make the SQL easier
2013 to generate from Perl data structures and, IMO, more intuitive.
2014 The underlying idea is for this module to do what you mean, based
2015 on the data structures you provide it. The big advantage is that
2016 you don't have to modify your code every time your data changes,
2017 as this module figures it out.
2018
2019 To begin with, an SQL INSERT is as easy as just specifying a hash
2020 of C<key=value> pairs:
2021
2022     my %data = (
2023         name => 'Jimbo Bobson',
2024         phone => '123-456-7890',
2025         address => '42 Sister Lane',
2026         city => 'St. Louis',
2027         state => 'Louisiana',
2028     );
2029
2030 The SQL can then be generated with this:
2031
2032     my($stmt, @bind) = $sql->insert('people', \%data);
2033
2034 Which would give you something like this:
2035
2036     $stmt = "INSERT INTO people
2037                     (address, city, name, phone, state)
2038                     VALUES (?, ?, ?, ?, ?)";
2039     @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
2040              '123-456-7890', 'Louisiana');
2041
2042 These are then used directly in your DBI code:
2043
2044     my $sth = $dbh->prepare($stmt);
2045     $sth->execute(@bind);
2046
2047 =head2 Inserting and Updating Arrays
2048
2049 If your database has array types (like for example Postgres),
2050 activate the special option C<< array_datatypes => 1 >>
2051 when creating the C<SQL::Abstract> object.
2052 Then you may use an arrayref to insert and update database array types:
2053
2054     my $sql = SQL::Abstract->new(array_datatypes => 1);
2055     my %data = (
2056         planets => [qw/Mercury Venus Earth Mars/]
2057     );
2058
2059     my($stmt, @bind) = $sql->insert('solar_system', \%data);
2060
2061 This results in:
2062
2063     $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
2064
2065     @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
2066
2067
2068 =head2 Inserting and Updating SQL
2069
2070 In order to apply SQL functions to elements of your C<%data> you may
2071 specify a reference to an arrayref for the given hash value. For example,
2072 if you need to execute the Oracle C<to_date> function on a value, you can
2073 say something like this:
2074
2075     my %data = (
2076         name => 'Bill',
2077         date_entered => \[ "to_date(?,'MM/DD/YYYY')", "03/02/2003" ],
2078     );
2079
2080 The first value in the array is the actual SQL. Any other values are
2081 optional and would be included in the bind values array. This gives
2082 you:
2083
2084     my($stmt, @bind) = $sql->insert('people', \%data);
2085
2086     $stmt = "INSERT INTO people (name, date_entered)
2087                 VALUES (?, to_date(?,'MM/DD/YYYY'))";
2088     @bind = ('Bill', '03/02/2003');
2089
2090 An UPDATE is just as easy, all you change is the name of the function:
2091
2092     my($stmt, @bind) = $sql->update('people', \%data);
2093
2094 Notice that your C<%data> isn't touched; the module will generate
2095 the appropriately quirky SQL for you automatically. Usually you'll
2096 want to specify a WHERE clause for your UPDATE, though, which is
2097 where handling C<%where> hashes comes in handy...
2098
2099 =head2 Complex where statements
2100
2101 This module can generate pretty complicated WHERE statements
2102 easily. For example, simple C<key=value> pairs are taken to mean
2103 equality, and if you want to see if a field is within a set
2104 of values, you can use an arrayref. Let's say we wanted to
2105 SELECT some data based on this criteria:
2106
2107     my %where = (
2108        requestor => 'inna',
2109        worker => ['nwiger', 'rcwe', 'sfz'],
2110        status => { '!=', 'completed' }
2111     );
2112
2113     my($stmt, @bind) = $sql->select('tickets', '*', \%where);
2114
2115 The above would give you something like this:
2116
2117     $stmt = "SELECT * FROM tickets WHERE
2118                 ( requestor = ? ) AND ( status != ? )
2119                 AND ( worker = ? OR worker = ? OR worker = ? )";
2120     @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
2121
2122 Which you could then use in DBI code like so:
2123
2124     my $sth = $dbh->prepare($stmt);
2125     $sth->execute(@bind);
2126
2127 Easy, eh?
2128
2129 =head1 METHODS
2130
2131 The methods are simple. There's one for every major SQL operation,
2132 and a constructor you use first. The arguments are specified in a
2133 similar order for each method (table, then fields, then a where
2134 clause) to try and simplify things.
2135
2136 =head2 new(option => 'value')
2137
2138 The C<new()> function takes a list of options and values, and returns
2139 a new B<SQL::Abstract> object which can then be used to generate SQL
2140 through the methods below. The options accepted are:
2141
2142 =over
2143
2144 =item case
2145
2146 If set to 'lower', then SQL will be generated in all lowercase. By
2147 default SQL is generated in "textbook" case meaning something like:
2148
2149     SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
2150
2151 Any setting other than 'lower' is ignored.
2152
2153 =item cmp
2154
2155 This determines what the default comparison operator is. By default
2156 it is C<=>, meaning that a hash like this:
2157
2158     %where = (name => 'nwiger', email => 'nate@wiger.org');
2159
2160 Will generate SQL like this:
2161
2162     WHERE name = 'nwiger' AND email = 'nate@wiger.org'
2163
2164 However, you may want loose comparisons by default, so if you set
2165 C<cmp> to C<like> you would get SQL such as:
2166
2167     WHERE name like 'nwiger' AND email like 'nate@wiger.org'
2168
2169 You can also override the comparison on an individual basis - see
2170 the huge section on L</"WHERE CLAUSES"> at the bottom.
2171
2172 =item sqltrue, sqlfalse
2173
2174 Expressions for inserting boolean values within SQL statements.
2175 By default these are C<1=1> and C<1=0>. They are used
2176 by the special operators C<-in> and C<-not_in> for generating
2177 correct SQL even when the argument is an empty array (see below).
2178
2179 =item logic
2180
2181 This determines the default logical operator for multiple WHERE
2182 statements in arrays or hashes. If absent, the default logic is "or"
2183 for arrays, and "and" for hashes. This means that a WHERE
2184 array of the form:
2185
2186     @where = (
2187         event_date => {'>=', '2/13/99'},
2188         event_date => {'<=', '4/24/03'},
2189     );
2190
2191 will generate SQL like this:
2192
2193     WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
2194
2195 This is probably not what you want given this query, though (look
2196 at the dates). To change the "OR" to an "AND", simply specify:
2197
2198     my $sql = SQL::Abstract->new(logic => 'and');
2199
2200 Which will change the above C<WHERE> to:
2201
2202     WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
2203
2204 The logic can also be changed locally by inserting
2205 a modifier in front of an arrayref:
2206
2207     @where = (-and => [event_date => {'>=', '2/13/99'},
2208                        event_date => {'<=', '4/24/03'} ]);
2209
2210 See the L</"WHERE CLAUSES"> section for explanations.
2211
2212 =item convert
2213
2214 This will automatically convert comparisons using the specified SQL
2215 function for both column and value. This is mostly used with an argument
2216 of C<upper> or C<lower>, so that the SQL will have the effect of
2217 case-insensitive "searches". For example, this:
2218
2219     $sql = SQL::Abstract->new(convert => 'upper');
2220     %where = (keywords => 'MaKe iT CAse inSeNSItive');
2221
2222 Will turn out the following SQL:
2223
2224     WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
2225
2226 The conversion can be C<upper()>, C<lower()>, or any other SQL function
2227 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
2228 not validate this option; it will just pass through what you specify verbatim).
2229
2230 =item bindtype
2231
2232 This is a kludge because many databases suck. For example, you can't
2233 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
2234 Instead, you have to use C<bind_param()>:
2235
2236     $sth->bind_param(1, 'reg data');
2237     $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
2238
2239 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
2240 which loses track of which field each slot refers to. Fear not.
2241
2242 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
2243 Currently, you can specify either C<normal> (default) or C<columns>. If you
2244 specify C<columns>, you will get an array that looks like this:
2245
2246     my $sql = SQL::Abstract->new(bindtype => 'columns');
2247     my($stmt, @bind) = $sql->insert(...);
2248
2249     @bind = (
2250         [ 'column1', 'value1' ],
2251         [ 'column2', 'value2' ],
2252         [ 'column3', 'value3' ],
2253     );
2254
2255 You can then iterate through this manually, using DBI's C<bind_param()>.
2256
2257     $sth->prepare($stmt);
2258     my $i = 1;
2259     for (@bind) {
2260         my($col, $data) = @$_;
2261         if ($col eq 'details' || $col eq 'comments') {
2262             $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
2263         } elsif ($col eq 'image') {
2264             $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
2265         } else {
2266             $sth->bind_param($i, $data);
2267         }
2268         $i++;
2269     }
2270     $sth->execute;      # execute without @bind now
2271
2272 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
2273 Basically, the advantage is still that you don't have to care which fields
2274 are or are not included. You could wrap that above C<for> loop in a simple
2275 sub called C<bind_fields()> or something and reuse it repeatedly. You still
2276 get a layer of abstraction over manual SQL specification.
2277
2278 Note that if you set L</bindtype> to C<columns>, the C<\[ $sql, @bind ]>
2279 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
2280 will expect the bind values in this format.
2281
2282 =item quote_char
2283
2284 This is the character that a table or column name will be quoted
2285 with.  By default this is an empty string, but you could set it to
2286 the character C<`>, to generate SQL like this:
2287
2288   SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
2289
2290 Alternatively, you can supply an array ref of two items, the first being the left
2291 hand quote character, and the second the right hand quote character. For
2292 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
2293 that generates SQL like this:
2294
2295   SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
2296
2297 Quoting is useful if you have tables or columns names that are reserved
2298 words in your database's SQL dialect.
2299
2300 =item escape_char
2301
2302 This is the character that will be used to escape L</quote_char>s appearing
2303 in an identifier before it has been quoted.
2304
2305 The parameter default in case of a single L</quote_char> character is the quote
2306 character itself.
2307
2308 When opening-closing-style quoting is used (L</quote_char> is an arrayref)
2309 this parameter defaults to the B<closing (right)> L</quote_char>. Occurrences
2310 of the B<opening (left)> L</quote_char> within the identifier are currently left
2311 untouched. The default for opening-closing-style quotes may change in future
2312 versions, thus you are B<strongly encouraged> to specify the escape character
2313 explicitly.
2314
2315 =item name_sep
2316
2317 This is the character that separates a table and column name.  It is
2318 necessary to specify this when the C<quote_char> option is selected,
2319 so that tables and column names can be individually quoted like this:
2320
2321   SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
2322
2323 =item injection_guard
2324
2325 A regular expression C<qr/.../> that is applied to any C<-function> and unquoted
2326 column name specified in a query structure. This is a safety mechanism to avoid
2327 injection attacks when mishandling user input e.g.:
2328
2329   my %condition_as_column_value_pairs = get_values_from_user();
2330   $sqla->select( ... , \%condition_as_column_value_pairs );
2331
2332 If the expression matches an exception is thrown. Note that literal SQL
2333 supplied via C<\'...'> or C<\['...']> is B<not> checked in any way.
2334
2335 Defaults to checking for C<;> and the C<GO> keyword (TransactSQL)
2336
2337 =item array_datatypes
2338
2339 When this option is true, arrayrefs in INSERT or UPDATE are
2340 interpreted as array datatypes and are passed directly
2341 to the DBI layer.
2342 When this option is false, arrayrefs are interpreted
2343 as literal SQL, just like refs to arrayrefs
2344 (but this behavior is for backwards compatibility; when writing
2345 new queries, use the "reference to arrayref" syntax
2346 for literal SQL).
2347
2348
2349 =item special_ops
2350
2351 Takes a reference to a list of "special operators"
2352 to extend the syntax understood by L<SQL::Abstract>.
2353 See section L</"SPECIAL OPERATORS"> for details.
2354
2355 =item unary_ops
2356
2357 Takes a reference to a list of "unary operators"
2358 to extend the syntax understood by L<SQL::Abstract>.
2359 See section L</"UNARY OPERATORS"> for details.
2360
2361
2362
2363 =back
2364
2365 =head2 insert($table, \@values || \%fieldvals, \%options)
2366
2367 This is the simplest function. You simply give it a table name
2368 and either an arrayref of values or hashref of field/value pairs.
2369 It returns an SQL INSERT statement and a list of bind values.
2370 See the sections on L</"Inserting and Updating Arrays"> and
2371 L</"Inserting and Updating SQL"> for information on how to insert
2372 with those data types.
2373
2374 The optional C<\%options> hash reference may contain additional
2375 options to generate the insert SQL. Currently supported options
2376 are:
2377
2378 =over 4
2379
2380 =item returning
2381
2382 Takes either a scalar of raw SQL fields, or an array reference of
2383 field names, and adds on an SQL C<RETURNING> statement at the end.
2384 This allows you to return data generated by the insert statement
2385 (such as row IDs) without performing another C<SELECT> statement.
2386 Note, however, this is not part of the SQL standard and may not
2387 be supported by all database engines.
2388
2389 =back
2390
2391 =head2 update($table, \%fieldvals, \%where, \%options)
2392
2393 This takes a table, hashref of field/value pairs, and an optional
2394 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
2395 of bind values.
2396 See the sections on L</"Inserting and Updating Arrays"> and
2397 L</"Inserting and Updating SQL"> for information on how to insert
2398 with those data types.
2399
2400 The optional C<\%options> hash reference may contain additional
2401 options to generate the update SQL. Currently supported options
2402 are:
2403
2404 =over 4
2405
2406 =item returning
2407
2408 See the C<returning> option to
2409 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2410
2411 =back
2412
2413 =head2 select($source, $fields, $where, $order)
2414
2415 This returns a SQL SELECT statement and associated list of bind values, as
2416 specified by the arguments:
2417
2418 =over
2419
2420 =item $source
2421
2422 Specification of the 'FROM' part of the statement.
2423 The argument can be either a plain scalar (interpreted as a table
2424 name, will be quoted), or an arrayref (interpreted as a list
2425 of table names, joined by commas, quoted), or a scalarref
2426 (literal SQL, not quoted).
2427
2428 =item $fields
2429
2430 Specification of the list of fields to retrieve from
2431 the source.
2432 The argument can be either an arrayref (interpreted as a list
2433 of field names, will be joined by commas and quoted), or a
2434 plain scalar (literal SQL, not quoted).
2435 Please observe that this API is not as flexible as that of
2436 the first argument C<$source>, for backwards compatibility reasons.
2437
2438 =item $where
2439
2440 Optional argument to specify the WHERE part of the query.
2441 The argument is most often a hashref, but can also be
2442 an arrayref or plain scalar --
2443 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
2444
2445 =item $order
2446
2447 Optional argument to specify the ORDER BY part of the query.
2448 The argument can be a scalar, a hashref or an arrayref
2449 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
2450 for details.
2451
2452 =back
2453
2454
2455 =head2 delete($table, \%where, \%options)
2456
2457 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
2458 It returns an SQL DELETE statement and list of bind values.
2459
2460 The optional C<\%options> hash reference may contain additional
2461 options to generate the delete SQL. Currently supported options
2462 are:
2463
2464 =over 4
2465
2466 =item returning
2467
2468 See the C<returning> option to
2469 L<insert|/insert($table, \@values || \%fieldvals, \%options)>.
2470
2471 =back
2472
2473 =head2 where(\%where, $order)
2474
2475 This is used to generate just the WHERE clause. For example,
2476 if you have an arbitrary data structure and know what the
2477 rest of your SQL is going to look like, but want an easy way
2478 to produce a WHERE clause, use this. It returns an SQL WHERE
2479 clause and list of bind values.
2480
2481
2482 =head2 values(\%data)
2483
2484 This just returns the values from the hash C<%data>, in the same
2485 order that would be returned from any of the other above queries.
2486 Using this allows you to markedly speed up your queries if you
2487 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
2488
2489 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
2490
2491 Warning: This is an experimental method and subject to change.
2492
2493 This returns arbitrarily generated SQL. It's a really basic shortcut.
2494 It will return two different things, depending on return context:
2495
2496     my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
2497     my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
2498
2499 These would return the following:
2500
2501     # First calling form
2502     $stmt = "CREATE TABLE test (?, ?)";
2503     @bind = (field1, field2);
2504
2505     # Second calling form
2506     $stmt_and_val = "CREATE TABLE test (field1, field2)";
2507
2508 Depending on what you're trying to do, it's up to you to choose the correct
2509 format. In this example, the second form is what you would want.
2510
2511 By the same token:
2512
2513     $sql->generate('alter session', { nls_date_format => 'MM/YY' });
2514
2515 Might give you:
2516
2517     ALTER SESSION SET nls_date_format = 'MM/YY'
2518
2519 You get the idea. Strings get their case twiddled, but everything
2520 else remains verbatim.
2521
2522 =head1 EXPORTABLE FUNCTIONS
2523
2524 =head2 is_plain_value
2525
2526 Determines if the supplied argument is a plain value as understood by this
2527 module:
2528
2529 =over
2530
2531 =item * The value is C<undef>
2532
2533 =item * The value is a non-reference
2534
2535 =item * The value is an object with stringification overloading
2536
2537 =item * The value is of the form C<< { -value => $anything } >>
2538
2539 =back
2540
2541 On failure returns C<undef>, on success returns a B<scalar> reference
2542 to the original supplied argument.
2543
2544 =over
2545
2546 =item * Note
2547
2548 The stringification overloading detection is rather advanced: it takes
2549 into consideration not only the presence of a C<""> overload, but if that
2550 fails also checks for enabled
2551 L<autogenerated versions of C<"">|overload/Magic Autogeneration>, based
2552 on either C<0+> or C<bool>.
2553
2554 Unfortunately testing in the field indicates that this
2555 detection B<< may tickle a latent bug in perl versions before 5.018 >>,
2556 but only when very large numbers of stringifying objects are involved.
2557 At the time of writing ( Sep 2014 ) there is no clear explanation of
2558 the direct cause, nor is there a manageably small test case that reliably
2559 reproduces the problem.
2560
2561 If you encounter any of the following exceptions in B<random places within
2562 your application stack> - this module may be to blame:
2563
2564   Operation "ne": no method found,
2565     left argument in overloaded package <something>,
2566     right argument in overloaded package <something>
2567
2568 or perhaps even
2569
2570   Stub found while resolving method "???" overloading """" in package <something>
2571
2572 If you fall victim to the above - please attempt to reduce the problem
2573 to something that could be sent to the L<SQL::Abstract developers
2574 |DBIx::Class/GETTING HELP/SUPPORT>
2575 (either publicly or privately). As a workaround in the meantime you can
2576 set C<$ENV{SQLA_ISVALUE_IGNORE_AUTOGENERATED_STRINGIFICATION}> to a true
2577 value, which will most likely eliminate your problem (at the expense of
2578 not being able to properly detect exotic forms of stringification).
2579
2580 This notice and environment variable will be removed in a future version,
2581 as soon as the underlying problem is found and a reliable workaround is
2582 devised.
2583
2584 =back
2585
2586 =head2 is_literal_value
2587
2588 Determines if the supplied argument is a literal value as understood by this
2589 module:
2590
2591 =over
2592
2593 =item * C<\$sql_string>
2594
2595 =item * C<\[ $sql_string, @bind_values ]>
2596
2597 =back
2598
2599 On failure returns C<undef>, on success returns an B<array> reference
2600 containing the unpacked version of the supplied literal SQL and bind values.
2601
2602 =head1 WHERE CLAUSES
2603
2604 =head2 Introduction
2605
2606 This module uses a variation on the idea from L<DBIx::Abstract>. It
2607 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
2608 module is that things in arrays are OR'ed, and things in hashes
2609 are AND'ed.>
2610
2611 The easiest way to explain is to show lots of examples. After
2612 each C<%where> hash shown, it is assumed you used:
2613
2614     my($stmt, @bind) = $sql->where(\%where);
2615
2616 However, note that the C<%where> hash can be used directly in any
2617 of the other functions as well, as described above.
2618
2619 =head2 Key-value pairs
2620
2621 So, let's get started. To begin, a simple hash:
2622
2623     my %where  = (
2624         user   => 'nwiger',
2625         status => 'completed'
2626     );
2627
2628 Is converted to SQL C<key = val> statements:
2629
2630     $stmt = "WHERE user = ? AND status = ?";
2631     @bind = ('nwiger', 'completed');
2632
2633 One common thing I end up doing is having a list of values that
2634 a field can be in. To do this, simply specify a list inside of
2635 an arrayref:
2636
2637     my %where  = (
2638         user   => 'nwiger',
2639         status => ['assigned', 'in-progress', 'pending'];
2640     );
2641
2642 This simple code will create the following:
2643
2644     $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
2645     @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
2646
2647 A field associated to an empty arrayref will be considered a
2648 logical false and will generate 0=1.
2649
2650 =head2 Tests for NULL values
2651
2652 If the value part is C<undef> then this is converted to SQL <IS NULL>
2653
2654     my %where  = (
2655         user   => 'nwiger',
2656         status => undef,
2657     );
2658
2659 becomes:
2660
2661     $stmt = "WHERE user = ? AND status IS NULL";
2662     @bind = ('nwiger');
2663
2664 To test if a column IS NOT NULL:
2665
2666     my %where  = (
2667         user   => 'nwiger',
2668         status => { '!=', undef },
2669     );
2670
2671 =head2 Specific comparison operators
2672
2673 If you want to specify a different type of operator for your comparison,
2674 you can use a hashref for a given column:
2675
2676     my %where  = (
2677         user   => 'nwiger',
2678         status => { '!=', 'completed' }
2679     );
2680
2681 Which would generate:
2682
2683     $stmt = "WHERE user = ? AND status != ?";
2684     @bind = ('nwiger', 'completed');
2685
2686 To test against multiple values, just enclose the values in an arrayref:
2687
2688     status => { '=', ['assigned', 'in-progress', 'pending'] };
2689
2690 Which would give you:
2691
2692     "WHERE status = ? OR status = ? OR status = ?"
2693
2694
2695 The hashref can also contain multiple pairs, in which case it is expanded
2696 into an C<AND> of its elements:
2697
2698     my %where  = (
2699         user   => 'nwiger',
2700         status => { '!=', 'completed', -not_like => 'pending%' }
2701     );
2702
2703     # Or more dynamically, like from a form
2704     $where{user} = 'nwiger';
2705     $where{status}{'!='} = 'completed';
2706     $where{status}{'-not_like'} = 'pending%';
2707
2708     # Both generate this
2709     $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
2710     @bind = ('nwiger', 'completed', 'pending%');
2711
2712
2713 To get an OR instead, you can combine it with the arrayref idea:
2714
2715     my %where => (
2716          user => 'nwiger',
2717          priority => [ { '=', 2 }, { '>', 5 } ]
2718     );
2719
2720 Which would generate:
2721
2722     $stmt = "WHERE ( priority = ? OR priority > ? ) AND user = ?";
2723     @bind = ('2', '5', 'nwiger');
2724
2725 If you want to include literal SQL (with or without bind values), just use a
2726 scalar reference or reference to an arrayref as the value:
2727
2728     my %where  = (
2729         date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
2730         date_expires => { '<' => \"now()" }
2731     );
2732
2733 Which would generate:
2734
2735     $stmt = "WHERE date_entered > to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
2736     @bind = ('11/26/2008');
2737
2738
2739 =head2 Logic and nesting operators
2740
2741 In the example above,
2742 there is a subtle trap if you want to say something like
2743 this (notice the C<AND>):
2744
2745     WHERE priority != ? AND priority != ?
2746
2747 Because, in Perl you I<can't> do this:
2748
2749     priority => { '!=' => 2, '!=' => 1 }
2750
2751 As the second C<!=> key will obliterate the first. The solution
2752 is to use the special C<-modifier> form inside an arrayref:
2753
2754     priority => [ -and => {'!=', 2},
2755                           {'!=', 1} ]
2756
2757
2758 Normally, these would be joined by C<OR>, but the modifier tells it
2759 to use C<AND> instead. (Hint: You can use this in conjunction with the
2760 C<logic> option to C<new()> in order to change the way your queries
2761 work by default.) B<Important:> Note that the C<-modifier> goes
2762 B<INSIDE> the arrayref, as an extra first element. This will
2763 B<NOT> do what you think it might:
2764
2765     priority => -and => [{'!=', 2}, {'!=', 1}]   # WRONG!
2766
2767 Here is a quick list of equivalencies, since there is some overlap:
2768
2769     # Same
2770     status => {'!=', 'completed', 'not like', 'pending%' }
2771     status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
2772
2773     # Same
2774     status => {'=', ['assigned', 'in-progress']}
2775     status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
2776     status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
2777
2778
2779
2780 =head2 Special operators: IN, BETWEEN, etc.
2781
2782 You can also use the hashref format to compare a list of fields using the
2783 C<IN> comparison operator, by specifying the list as an arrayref:
2784
2785     my %where  = (
2786         status   => 'completed',
2787         reportid => { -in => [567, 2335, 2] }
2788     );
2789
2790 Which would generate:
2791
2792     $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
2793     @bind = ('completed', '567', '2335', '2');
2794
2795 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
2796 the same way.
2797
2798 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
2799 (by default: C<1=0>). Similarly, C<< -not_in => [] >> generates
2800 'sqltrue' (by default: C<1=1>).
2801
2802 In addition to the array you can supply a chunk of literal sql or
2803 literal sql with bind:
2804
2805     my %where = {
2806       customer => { -in => \[
2807         'SELECT cust_id FROM cust WHERE balance > ?',
2808         2000,
2809       ],
2810       status => { -in => \'SELECT status_codes FROM states' },
2811     };
2812
2813 would generate:
2814
2815     $stmt = "WHERE (
2816           customer IN ( SELECT cust_id FROM cust WHERE balance > ? )
2817       AND status IN ( SELECT status_codes FROM states )
2818     )";
2819     @bind = ('2000');
2820
2821 Finally, if the argument to C<-in> is not a reference, it will be
2822 treated as a single-element array.
2823
2824 Another pair of operators is C<-between> and C<-not_between>,
2825 used with an arrayref of two values:
2826
2827     my %where  = (
2828         user   => 'nwiger',
2829         completion_date => {
2830            -not_between => ['2002-10-01', '2003-02-06']
2831         }
2832     );
2833
2834 Would give you:
2835
2836     WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
2837
2838 Just like with C<-in> all plausible combinations of literal SQL
2839 are possible:
2840
2841     my %where = {
2842       start0 => { -between => [ 1, 2 ] },
2843       start1 => { -between => \["? AND ?", 1, 2] },
2844       start2 => { -between => \"lower(x) AND upper(y)" },
2845       start3 => { -between => [
2846         \"lower(x)",
2847         \["upper(?)", 'stuff' ],
2848       ] },
2849     };
2850
2851 Would give you:
2852
2853     $stmt = "WHERE (
2854           ( start0 BETWEEN ? AND ?                )
2855       AND ( start1 BETWEEN ? AND ?                )
2856       AND ( start2 BETWEEN lower(x) AND upper(y)  )
2857       AND ( start3 BETWEEN lower(x) AND upper(?)  )
2858     )";
2859     @bind = (1, 2, 1, 2, 'stuff');
2860
2861
2862 These are the two builtin "special operators"; but the
2863 list can be expanded: see section L</"SPECIAL OPERATORS"> below.
2864
2865 =head2 Unary operators: bool
2866
2867 If you wish to test against boolean columns or functions within your
2868 database you can use the C<-bool> and C<-not_bool> operators. For
2869 example to test the column C<is_user> being true and the column
2870 C<is_enabled> being false you would use:-
2871
2872     my %where  = (
2873         -bool       => 'is_user',
2874         -not_bool   => 'is_enabled',
2875     );
2876
2877 Would give you:
2878
2879     WHERE is_user AND NOT is_enabled
2880
2881 If a more complex combination is required, testing more conditions,
2882 then you should use the and/or operators:-
2883
2884     my %where  = (
2885         -and           => [
2886             -bool      => 'one',
2887             -not_bool  => { two=> { -rlike => 'bar' } },
2888             -not_bool  => { three => [ { '=', 2 }, { '>', 5 } ] },
2889         ],
2890     );
2891
2892 Would give you:
2893
2894     WHERE
2895       one
2896         AND
2897       (NOT two RLIKE ?)
2898         AND
2899       (NOT ( three = ? OR three > ? ))
2900
2901
2902 =head2 Nested conditions, -and/-or prefixes
2903
2904 So far, we've seen how multiple conditions are joined with a top-level
2905 C<AND>.  We can change this by putting the different conditions we want in
2906 hashes and then putting those hashes in an array. For example:
2907
2908     my @where = (
2909         {
2910             user   => 'nwiger',
2911             status => { -like => ['pending%', 'dispatched'] },
2912         },
2913         {
2914             user   => 'robot',
2915             status => 'unassigned',
2916         }
2917     );
2918
2919 This data structure would create the following:
2920
2921     $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2922                 OR ( user = ? AND status = ? ) )";
2923     @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2924
2925
2926 Clauses in hashrefs or arrayrefs can be prefixed with an C<-and> or C<-or>
2927 to change the logic inside:
2928
2929     my @where = (
2930          -and => [
2931             user => 'nwiger',
2932             [
2933                 -and => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2934                 -or => { workhrs => {'<', 50}, geo => 'EURO' },
2935             ],
2936         ],
2937     );
2938
2939 That would yield:
2940
2941     $stmt = "WHERE ( user = ?
2942                AND ( ( workhrs > ? AND geo = ? )
2943                   OR ( workhrs < ? OR geo = ? ) ) )";
2944     @bind = ('nwiger', '20', 'ASIA', '50', 'EURO');
2945
2946 =head3 Algebraic inconsistency, for historical reasons
2947
2948 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2949 operator goes C<outside> of the nested structure; whereas when connecting
2950 several constraints on one column, the C<-and> operator goes
2951 C<inside> the arrayref. Here is an example combining both features:
2952
2953    my @where = (
2954      -and => [a => 1, b => 2],
2955      -or  => [c => 3, d => 4],
2956       e   => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2957    )
2958
2959 yielding
2960
2961   WHERE ( (    ( a = ? AND b = ? )
2962             OR ( c = ? OR d = ? )
2963             OR ( e LIKE ? AND e LIKE ? ) ) )
2964
2965 This difference in syntax is unfortunate but must be preserved for
2966 historical reasons. So be careful: the two examples below would
2967 seem algebraically equivalent, but they are not
2968
2969   { col => [ -and =>
2970     { -like => 'foo%' },
2971     { -like => '%bar' },
2972   ] }
2973   # yields: WHERE ( ( col LIKE ? AND col LIKE ? ) )
2974
2975   [ -and =>
2976     { col => { -like => 'foo%' } },
2977     { col => { -like => '%bar' } },
2978   ]
2979   # yields: WHERE ( ( col LIKE ? OR col LIKE ? ) )
2980
2981
2982 =head2 Literal SQL and value type operators
2983
2984 The basic premise of SQL::Abstract is that in WHERE specifications the "left
2985 side" is a column name and the "right side" is a value (normally rendered as
2986 a placeholder). This holds true for both hashrefs and arrayref pairs as you
2987 see in the L</WHERE CLAUSES> examples above. Sometimes it is necessary to
2988 alter this behavior. There are several ways of doing so.
2989
2990 =head3 -ident
2991
2992 This is a virtual operator that signals the string to its right side is an
2993 identifier (a column name) and not a value. For example to compare two
2994 columns you would write:
2995
2996     my %where = (
2997         priority => { '<', 2 },
2998         requestor => { -ident => 'submitter' },
2999     );
3000
3001 which creates:
3002
3003     $stmt = "WHERE priority < ? AND requestor = submitter";
3004     @bind = ('2');
3005
3006 If you are maintaining legacy code you may see a different construct as
3007 described in L</Deprecated usage of Literal SQL>, please use C<-ident> in new
3008 code.
3009
3010 =head3 -value
3011
3012 This is a virtual operator that signals that the construct to its right side
3013 is a value to be passed to DBI. This is for example necessary when you want
3014 to write a where clause against an array (for RDBMS that support such
3015 datatypes). For example:
3016
3017     my %where = (
3018         array => { -value => [1, 2, 3] }
3019     );
3020
3021 will result in:
3022
3023     $stmt = 'WHERE array = ?';
3024     @bind = ([1, 2, 3]);
3025
3026 Note that if you were to simply say:
3027
3028     my %where = (
3029         array => [1, 2, 3]
3030     );
3031
3032 the result would probably not be what you wanted:
3033
3034     $stmt = 'WHERE array = ? OR array = ? OR array = ?';
3035     @bind = (1, 2, 3);
3036
3037 =head3 Literal SQL
3038
3039 Finally, sometimes only literal SQL will do. To include a random snippet
3040 of SQL verbatim, you specify it as a scalar reference. Consider this only
3041 as a last resort. Usually there is a better way. For example:
3042
3043     my %where = (
3044         priority => { '<', 2 },
3045         requestor => { -in => \'(SELECT name FROM hitmen)' },
3046     );
3047
3048 Would create:
3049
3050     $stmt = "WHERE priority < ? AND requestor IN (SELECT name FROM hitmen)"
3051     @bind = (2);
3052
3053 Note that in this example, you only get one bind parameter back, since
3054 the verbatim SQL is passed as part of the statement.
3055
3056 =head4 CAVEAT
3057
3058   Never use untrusted input as a literal SQL argument - this is a massive
3059   security risk (there is no way to check literal snippets for SQL
3060   injections and other nastyness). If you need to deal with untrusted input
3061   use literal SQL with placeholders as described next.
3062
3063 =head3 Literal SQL with placeholders and bind values (subqueries)
3064
3065 If the literal SQL to be inserted has placeholders and bind values,
3066 use a reference to an arrayref (yes this is a double reference --
3067 not so common, but perfectly legal Perl). For example, to find a date
3068 in Postgres you can use something like this:
3069
3070     my %where = (
3071        date_column => \[ "= date '2008-09-30' - ?::integer", 10 ]
3072     )
3073
3074 This would create:
3075
3076     $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
3077     @bind = ('10');
3078
3079 Note that you must pass the bind values in the same format as they are returned
3080 by L<where|/where(\%where, $order)>. This means that if you set L</bindtype>
3081 to C<columns>, you must provide the bind values in the
3082 C<< [ column_meta => value ] >> format, where C<column_meta> is an opaque
3083 scalar value; most commonly the column name, but you can use any scalar value
3084 (including references and blessed references), L<SQL::Abstract> will simply
3085 pass it through intact. So if C<bindtype> is set to C<columns> the above
3086 example will look like:
3087
3088     my %where = (
3089        date_column => \[ "= date '2008-09-30' - ?::integer", [ {} => 10 ] ]
3090     )
3091
3092 Literal SQL is especially useful for nesting parenthesized clauses in the
3093 main SQL query. Here is a first example:
3094
3095   my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
3096                                100, "foo%");
3097   my %where = (
3098     foo => 1234,
3099     bar => \["IN ($sub_stmt)" => @sub_bind],
3100   );
3101
3102 This yields:
3103
3104   $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
3105                                              WHERE c2 < ? AND c3 LIKE ?))";
3106   @bind = (1234, 100, "foo%");
3107
3108 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
3109 are expressed in the same way. Of course the C<$sub_stmt> and
3110 its associated bind values can be generated through a former call
3111 to C<select()> :
3112
3113   my ($sub_stmt, @sub_bind)
3114      = $sql->select("t1", "c1", {c2 => {"<" => 100},
3115                                  c3 => {-like => "foo%"}});
3116   my %where = (
3117     foo => 1234,
3118     bar => \["> ALL ($sub_stmt)" => @sub_bind],
3119   );
3120
3121 In the examples above, the subquery was used as an operator on a column;
3122 but the same principle also applies for a clause within the main C<%where>
3123 hash, like an EXISTS subquery:
3124
3125   my ($sub_stmt, @sub_bind)
3126      = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
3127   my %where = ( -and => [
3128     foo   => 1234,
3129     \["EXISTS ($sub_stmt)" => @sub_bind],
3130   ]);
3131
3132 which yields
3133
3134   $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
3135                                         WHERE c1 = ? AND c2 > t0.c0))";
3136   @bind = (1234, 1);
3137
3138
3139 Observe that the condition on C<c2> in the subquery refers to
3140 column C<t0.c0> of the main query: this is I<not> a bind
3141 value, so we have to express it through a scalar ref.
3142 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
3143 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
3144 what we wanted here.
3145
3146 Finally, here is an example where a subquery is used
3147 for expressing unary negation:
3148
3149   my ($sub_stmt, @sub_bind)
3150      = $sql->where({age => [{"<" => 10}, {">" => 20}]});
3151   $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
3152   my %where = (
3153         lname  => {like => '%son%'},
3154         \["NOT ($sub_stmt)" => @sub_bind],
3155     );
3156
3157 This yields
3158
3159   $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
3160   @bind = ('%son%', 10, 20)
3161
3162 =head3 Deprecated usage of Literal SQL
3163
3164 Below are some examples of archaic use of literal SQL. It is shown only as
3165 reference for those who deal with legacy code. Each example has a much
3166 better, cleaner and safer alternative that users should opt for in new code.
3167
3168 =over
3169
3170 =item *
3171
3172     my %where = ( requestor => \'IS NOT NULL' )
3173
3174     $stmt = "WHERE requestor IS NOT NULL"
3175
3176 This used to be the way of generating NULL comparisons, before the handling
3177 of C<undef> got formalized. For new code please use the superior syntax as
3178 described in L</Tests for NULL values>.
3179
3180 =item *
3181
3182     my %where = ( requestor => \'= submitter' )
3183
3184     $stmt = "WHERE requestor = submitter"
3185
3186 This used to be the only way to compare columns. Use the superior L</-ident>
3187 method for all new code. For example an identifier declared in such a way
3188 will be properly quoted if L</quote_char> is properly set, while the legacy
3189 form will remain as supplied.
3190
3191 =item *
3192
3193     my %where = ( is_ready  => \"", completed => { '>', '2012-12-21' } )
3194
3195     $stmt = "WHERE completed > ? AND is_ready"
3196     @bind = ('2012-12-21')
3197
3198 Using an empty string literal used to be the only way to express a boolean.
3199 For all new code please use the much more readable
3200 L<-bool|/Unary operators: bool> operator.
3201
3202 =back
3203
3204 =head2 Conclusion
3205
3206 These pages could go on for a while, since the nesting of the data
3207 structures this module can handle are pretty much unlimited (the
3208 module implements the C<WHERE> expansion as a recursive function
3209 internally). Your best bet is to "play around" with the module a
3210 little to see how the data structures behave, and choose the best
3211 format for your data based on that.
3212
3213 And of course, all the values above will probably be replaced with
3214 variables gotten from forms or the command line. After all, if you
3215 knew everything ahead of time, you wouldn't have to worry about
3216 dynamically-generating SQL and could just hardwire it into your
3217 script.
3218
3219 =head1 ORDER BY CLAUSES
3220
3221 Some functions take an order by clause. This can either be a scalar (just a
3222 column name), a hashref of C<< { -desc => 'col' } >> or C<< { -asc => 'col' }
3223 >>, a scalarref, an arrayref-ref, or an arrayref of any of the previous
3224 forms. Examples:
3225
3226                Given              |         Will Generate
3227     ---------------------------------------------------------------
3228                                   |
3229     'colA'                        | ORDER BY colA
3230                                   |
3231     [qw/colA colB/]               | ORDER BY colA, colB
3232                                   |
3233     {-asc  => 'colA'}             | ORDER BY colA ASC
3234                                   |
3235     {-desc => 'colB'}             | ORDER BY colB DESC
3236                                   |
3237     ['colA', {-asc => 'colB'}]    | ORDER BY colA, colB ASC
3238                                   |
3239     { -asc => [qw/colA colB/] }   | ORDER BY colA ASC, colB ASC
3240                                   |
3241     \'colA DESC'                  | ORDER BY colA DESC
3242                                   |
3243     \[ 'FUNC(colA, ?)', $x ]      | ORDER BY FUNC(colA, ?)
3244                                   |   /* ...with $x bound to ? */
3245                                   |
3246     [                             | ORDER BY
3247       { -asc => 'colA' },         |     colA ASC,
3248       { -desc => [qw/colB/] },    |     colB DESC,
3249       { -asc => [qw/colC colD/] },|     colC ASC, colD ASC,
3250       \'colE DESC',               |     colE DESC,
3251       \[ 'FUNC(colF, ?)', $x ],   |     FUNC(colF, ?)
3252     ]                             |   /* ...with $x bound to ? */
3253     ===============================================================
3254
3255
3256
3257 =head1 SPECIAL OPERATORS
3258
3259   my $sqlmaker = SQL::Abstract->new(special_ops => [
3260      {
3261       regex => qr/.../,
3262       handler => sub {
3263         my ($self, $field, $op, $arg) = @_;
3264         ...
3265       },
3266      },
3267      {
3268       regex => qr/.../,
3269       handler => 'method_name',
3270      },
3271    ]);
3272
3273 A "special operator" is a SQL syntactic clause that can be
3274 applied to a field, instead of a usual binary operator.
3275 For example:
3276
3277    WHERE field IN (?, ?, ?)
3278    WHERE field BETWEEN ? AND ?
3279    WHERE MATCH(field) AGAINST (?, ?)
3280
3281 Special operators IN and BETWEEN are fairly standard and therefore
3282 are builtin within C<SQL::Abstract> (as the overridable methods
3283 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
3284 like the MATCH .. AGAINST example above which is specific to MySQL,
3285 you can write your own operator handlers - supply a C<special_ops>
3286 argument to the C<new> method. That argument takes an arrayref of
3287 operator definitions; each operator definition is a hashref with two
3288 entries:
3289
3290 =over
3291
3292 =item regex
3293
3294 the regular expression to match the operator
3295
3296 =item handler
3297
3298 Either a coderef or a plain scalar method name. In both cases
3299 the expected return is C<< ($sql, @bind) >>.
3300
3301 When supplied with a method name, it is simply called on the
3302 L<SQL::Abstract> object as:
3303
3304  $self->$method_name($field, $op, $arg)
3305
3306  Where:
3307
3308   $field is the LHS of the operator
3309   $op is the part that matched the handler regex
3310   $arg is the RHS
3311
3312 When supplied with a coderef, it is called as:
3313
3314  $coderef->($self, $field, $op, $arg)
3315
3316
3317 =back
3318
3319 For example, here is an implementation
3320 of the MATCH .. AGAINST syntax for MySQL
3321
3322   my $sqlmaker = SQL::Abstract->new(special_ops => [
3323
3324     # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
3325     {regex => qr/^match$/i,
3326      handler => sub {
3327        my ($self, $field, $op, $arg) = @_;
3328        $arg = [$arg] if not ref $arg;
3329        my $label         = $self->_quote($field);
3330        my ($placeholder) = $self->_convert('?');
3331        my $placeholders  = join ", ", (($placeholder) x @$arg);
3332        my $sql           = $self->_sqlcase('match') . " ($label) "
3333                          . $self->_sqlcase('against') . " ($placeholders) ";
3334        my @bind = $self->_bindtype($field, @$arg);
3335        return ($sql, @bind);
3336        }
3337      },
3338
3339   ]);
3340
3341
3342 =head1 UNARY OPERATORS
3343
3344   my $sqlmaker = SQL::Abstract->new(unary_ops => [
3345      {
3346       regex => qr/.../,
3347       handler => sub {
3348         my ($self, $op, $arg) = @_;
3349         ...
3350       },
3351      },
3352      {
3353       regex => qr/.../,
3354       handler => 'method_name',
3355      },
3356    ]);
3357
3358 A "unary operator" is a SQL syntactic clause that can be
3359 applied to a field - the operator goes before the field
3360
3361 You can write your own operator handlers - supply a C<unary_ops>
3362 argument to the C<new> method. That argument takes an arrayref of
3363 operator definitions; each operator definition is a hashref with two
3364 entries:
3365
3366 =over
3367
3368 =item regex
3369
3370 the regular expression to match the operator
3371
3372 =item handler
3373
3374 Either a coderef or a plain scalar method name. In both cases
3375 the expected return is C<< $sql >>.
3376
3377 When supplied with a method name, it is simply called on the
3378 L<SQL::Abstract> object as:
3379
3380  $self->$method_name($op, $arg)
3381
3382  Where:
3383
3384   $op is the part that matched the handler regex
3385   $arg is the RHS or argument of the operator
3386
3387 When supplied with a coderef, it is called as:
3388
3389  $coderef->($self, $op, $arg)
3390
3391
3392 =back
3393
3394
3395 =head1 PERFORMANCE
3396
3397 Thanks to some benchmarking by Mark Stosberg, it turns out that
3398 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
3399 I must admit this wasn't an intentional design issue, but it's a
3400 byproduct of the fact that you get to control your C<DBI> handles
3401 yourself.
3402
3403 To maximize performance, use a code snippet like the following:
3404
3405     # prepare a statement handle using the first row
3406     # and then reuse it for the rest of the rows
3407     my($sth, $stmt);
3408     for my $href (@array_of_hashrefs) {
3409         $stmt ||= $sql->insert('table', $href);
3410         $sth  ||= $dbh->prepare($stmt);
3411         $sth->execute($sql->values($href));
3412     }
3413
3414 The reason this works is because the keys in your C<$href> are sorted
3415 internally by B<SQL::Abstract>. Thus, as long as your data retains
3416 the same structure, you only have to generate the SQL the first time
3417 around. On subsequent queries, simply use the C<values> function provided
3418 by this module to return your values in the correct order.
3419
3420 However this depends on the values having the same type - if, for
3421 example, the values of a where clause may either have values
3422 (resulting in sql of the form C<column = ?> with a single bind
3423 value), or alternatively the values might be C<undef> (resulting in
3424 sql of the form C<column IS NULL> with no bind value) then the
3425 caching technique suggested will not work.
3426
3427 =head1 FORMBUILDER
3428
3429 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
3430 really like this part (I do, at least). Building up a complex query
3431 can be as simple as the following:
3432
3433     #!/usr/bin/perl
3434
3435     use warnings;
3436     use strict;
3437
3438     use CGI::FormBuilder;
3439     use SQL::Abstract;
3440
3441     my $form = CGI::FormBuilder->new(...);
3442     my $sql  = SQL::Abstract->new;
3443
3444     if ($form->submitted) {
3445         my $field = $form->field;
3446         my $id = delete $field->{id};
3447         my($stmt, @bind) = $sql->update('table', $field, {id => $id});
3448     }
3449
3450 Of course, you would still have to connect using C<DBI> to run the
3451 query, but the point is that if you make your form look like your
3452 table, the actual query script can be extremely simplistic.
3453
3454 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
3455 a fast interface to returning and formatting data. I frequently
3456 use these three modules together to write complex database query
3457 apps in under 50 lines.
3458
3459 =head1 HOW TO CONTRIBUTE
3460
3461 Contributions are always welcome, in all usable forms (we especially
3462 welcome documentation improvements). The delivery methods include git-
3463 or unified-diff formatted patches, GitHub pull requests, or plain bug
3464 reports either via RT or the Mailing list. Contributors are generally
3465 granted full access to the official repository after their first several
3466 patches pass successful review.
3467
3468 This project is maintained in a git repository. The code and related tools are
3469 accessible at the following locations:
3470
3471 =over
3472
3473 =item * Official repo: L<git://git.shadowcat.co.uk/dbsrgits/SQL-Abstract.git>
3474
3475 =item * Official gitweb: L<http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits/SQL-Abstract.git>
3476
3477 =item * GitHub mirror: L<https://github.com/dbsrgits/sql-abstract>
3478
3479 =item * Authorized committers: L<ssh://dbsrgits@git.shadowcat.co.uk/SQL-Abstract.git>
3480
3481 =back
3482
3483 =head1 CHANGES
3484
3485 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
3486 Great care has been taken to preserve the I<published> behavior
3487 documented in previous versions in the 1.* family; however,
3488 some features that were previously undocumented, or behaved
3489 differently from the documentation, had to be changed in order
3490 to clarify the semantics. Hence, client code that was relying
3491 on some dark areas of C<SQL::Abstract> v1.*
3492 B<might behave differently> in v1.50.
3493
3494 The main changes are:
3495
3496 =over
3497
3498 =item *
3499
3500 support for literal SQL through the C<< \ [ $sql, @bind ] >> syntax.
3501
3502 =item *
3503
3504 support for the { operator => \"..." } construct (to embed literal SQL)
3505
3506 =item *
3507
3508 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
3509
3510 =item *
3511
3512 optional support for L<array datatypes|/"Inserting and Updating Arrays">
3513
3514 =item *
3515
3516 defensive programming: check arguments
3517
3518 =item *
3519
3520 fixed bug with global logic, which was previously implemented
3521 through global variables yielding side-effects. Prior versions would
3522 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
3523 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
3524 Now this is interpreted
3525 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
3526
3527
3528 =item *
3529
3530 fixed semantics of  _bindtype on array args
3531
3532 =item *
3533
3534 dropped the C<_anoncopy> of the %where tree. No longer necessary,
3535 we just avoid shifting arrays within that tree.
3536
3537 =item *
3538
3539 dropped the C<_modlogic> function
3540
3541 =back
3542
3543 =head1 ACKNOWLEDGEMENTS
3544
3545 There are a number of individuals that have really helped out with
3546 this module. Unfortunately, most of them submitted bugs via CPAN
3547 so I have no idea who they are! But the people I do know are:
3548
3549     Ash Berlin (order_by hash term support)
3550     Matt Trout (DBIx::Class support)
3551     Mark Stosberg (benchmarking)
3552     Chas Owens (initial "IN" operator support)
3553     Philip Collins (per-field SQL functions)
3554     Eric Kolve (hashref "AND" support)
3555     Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
3556     Dan Kubb (support for "quote_char" and "name_sep")
3557     Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
3558     Laurent Dami (internal refactoring, extensible list of special operators, literal SQL)
3559     Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
3560     Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
3561     Oliver Charles (support for "RETURNING" after "INSERT")
3562
3563 Thanks!
3564
3565 =head1 SEE ALSO
3566
3567 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
3568
3569 =head1 AUTHOR
3570
3571 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
3572
3573 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
3574
3575 For support, your best bet is to try the C<DBIx::Class> users mailing list.
3576 While not an official support venue, C<DBIx::Class> makes heavy use of
3577 C<SQL::Abstract>, and as such list members there are very familiar with
3578 how to create queries.
3579
3580 =head1 LICENSE
3581
3582 This module is free software; you may copy this under the same
3583 terms as perl itself (either the GNU General Public License or
3584 the Artistic License)
3585
3586 =cut