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