lib/SQL/Abstract.pm

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