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