lib/SQL/Abstract.pm

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