lib/SQL/Abstract.pm

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