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