lib/SQL/Abstract.pm

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