lib/SQL/Abstract.pm

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