lib/SQL/Abstract.pm

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