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