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