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