lib/SQL/Abstract.pm

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