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