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