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