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