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