lib/SQL/Abstract.pm

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