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