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