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