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