lib/SQL/Abstract.pm

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