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