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