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