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