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