lib/SQL/Abstract.pm

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