lib/SQL/Abstract.pm

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