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