lib/SQL/Abstract.pm

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