lib/SQL/Abstract.pm

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