lib/SQL/Abstract.pm

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