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