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