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