lib/SQL/Abstract.pm

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