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