lib/SQL/Abstract.pm

   1 package SQL::Abstract; # see doc at end of file
   2
   3 # LDNOTE : this code is heavy refactoring from original SQLA.
   4 # Several design decisions will need discussion during
   5 # the test / diffusion / acceptance phase; those are marked with flag
   6 # 'LDNOTE' (note by laurent.dami AT free.fr)
   7
   8 use Carp;
   9 use strict;
  10 use warnings;
  11 use List::Util   qw/first/;
  12 use Scalar::Util qw/blessed/;
  13
  14 #======================================================================
  15 # GLOBALS
  16 #======================================================================
  17
  18 our $VERSION  = '1.58';
  19
  20 # This would confuse some packagers
  21 #$VERSION      = eval $VERSION; # numify for warning-free dev releases
  22
  23 our $AUTOLOAD;
  24
  25 # special operators (-in, -between). May be extended/overridden by user.
  26 # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation
  27 my @BUILTIN_SPECIAL_OPS = (
  28   {regex => qr/^(not )?between$/i, handler => '_where_field_BETWEEN'},
  29   {regex => qr/^(not )?in$/i,      handler => '_where_field_IN'},
  30 );
  31
  32 # unaryish operators - key maps to handler
  33 my @BUILTIN_UNARY_OPS = (
  34   # the digits are backcompat stuff
  35   { regex => qr/^and  (?: \s? \d+ )? $/xi, handler => '_where_op_ANDOR' },
  36   { regex => qr/^or   (?: \s? \d+ )? $/xi, handler => '_where_op_ANDOR' },
  37   { regex => qr/^nest (?: \s? \d+ )? $/xi, handler => '_where_op_NEST' },
  38   { regex => qr/^ (?: not \s )? bool $/xi, handler => '_where_op_BOOL' },
  39 );
  40
  41 #======================================================================
  42 # DEBUGGING AND ERROR REPORTING
  43 #======================================================================
  44
  45 sub _debug {
  46   return unless $_[0]->{debug}; shift; # a little faster
  47   my $func = (caller(1))[3];
  48   warn "[$func] ", @_, "\n";
  49 }
  50
  51 sub belch (@) {
  52   my($func) = (caller(1))[3];
  53   carp "[$func] Warning: ", @_;
  54 }
  55
  56 sub puke (@) {
  57   my($func) = (caller(1))[3];
  58   croak "[$func] Fatal: ", @_;
  59 }
  60
  61
  62 #======================================================================
  63 # NEW
  64 #======================================================================
  65
  66 sub new {
  67   my $self = shift;
  68   my $class = ref($self) || $self;
  69   my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
  70
  71   # choose our case by keeping an option around
  72   delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
  73
  74   # default logic for interpreting arrayrefs
  75   $opt{logic} = $opt{logic} ? uc $opt{logic} : 'OR';
  76
  77   # how to return bind vars
  78   # LDNOTE: changed nwiger code : why this 'delete' ??
  79   # $opt{bindtype} ||= delete($opt{bind_type}) || 'normal';
  80   $opt{bindtype} ||= 'normal';
  81
  82   # default comparison is "=", but can be overridden
  83   $opt{cmp} ||= '=';
  84
  85   # try to recognize which are the 'equality' and 'unequality' ops
  86   # (temporary quickfix, should go through a more seasoned API)
  87  $opt{equality_op}   = qr/^(\Q$opt{cmp}\E|is|(is\s+)?like)$/i;
  88  $opt{inequality_op} = qr/^(!=|<>|(is\s+)?not(\s+like)?)$/i;
  89
  90   # SQL booleans
  91   $opt{sqltrue}  ||= '1=1';
  92   $opt{sqlfalse} ||= '0=1';
  93
  94   # special operators
  95   $opt{special_ops} ||= [];
  96   push @{$opt{special_ops}}, @BUILTIN_SPECIAL_OPS;
  97
  98   # unary operators
  99   $opt{unary_ops} ||= [];
 100   push @{$opt{unary_ops}}, @BUILTIN_UNARY_OPS;
 101
 102   return bless \%opt, $class;
 103 }
 104
 105
 106
 107 #======================================================================
 108 # INSERT methods
 109 #======================================================================
 110
 111 sub insert {
 112   my $self  = shift;
 113   my $table = $self->_table(shift);
 114   my $data  = shift || return;
 115
 116   my $method       = $self->_METHOD_FOR_refkind("_insert", $data);
 117   my ($sql, @bind) = $self->$method($data);
 118   $sql = join " ", $self->_sqlcase('insert into'), $table, $sql;
 119   return wantarray ? ($sql, @bind) : $sql;
 120 }
 121
 122 sub _insert_HASHREF { # explicit list of fields and then values
 123   my ($self, $data) = @_;
 124
 125   my @fields = sort keys %$data;
 126
 127   my ($sql, @bind) = $self->_insert_values($data);
 128
 129   # assemble SQL
 130   $_ = $self->_quote($_) foreach @fields;
 131   $sql = "( ".join(", ", @fields).") ".$sql;
 132
 133   return ($sql, @bind);
 134 }
 135
 136 sub _insert_ARRAYREF { # just generate values(?,?) part (no list of fields)
 137   my ($self, $data) = @_;
 138
 139   # no names (arrayref) so can't generate bindtype
 140   $self->{bindtype} ne 'columns'
 141     or belch "can't do 'columns' bindtype when called with arrayref";
 142
 143   # fold the list of values into a hash of column name - value pairs
 144   # (where the column names are artificially generated, and their
 145   # lexicographical ordering keep the ordering of the original list)
 146   my $i = "a";  # incremented values will be in lexicographical order
 147   my $data_in_hash = { map { ($i++ => $_) } @$data };
 148
 149   return $self->_insert_values($data_in_hash);
 150 }
 151
 152 sub _insert_ARRAYREFREF { # literal SQL with bind
 153   my ($self, $data) = @_;
 154
 155   my ($sql, @bind) = @${$data};
 156   $self->_assert_bindval_matches_bindtype(@bind);
 157
 158   return ($sql, @bind);
 159 }
 160
 161
 162 sub _insert_SCALARREF { # literal SQL without bind
 163   my ($self, $data) = @_;
 164
 165   return ($$data);
 166 }
 167
 168 sub _insert_values {
 169   my ($self, $data) = @_;
 170
 171   my (@values, @all_bind);
 172   foreach my $column (sort keys %$data) {
 173     my $v = $data->{$column};
 174
 175     $self->_SWITCH_refkind($v, {
 176
 177       ARRAYREF => sub {
 178         if ($self->{array_datatypes}) { # if array datatype are activated
 179           push @values, '?';
 180           push @all_bind, $self->_bindtype($column, $v);
 181         }
 182         else {                          # else literal SQL with bind
 183           my ($sql, @bind) = @$v;
 184           $self->_assert_bindval_matches_bindtype(@bind);
 185           push @values, $sql;
 186           push @all_bind, @bind;
 187         }
 188       },
 189
 190       ARRAYREFREF => sub { # literal SQL with bind
 191         my ($sql, @bind) = @${$v};
 192         $self->_assert_bindval_matches_bindtype(@bind);
 193         push @values, $sql;
 194         push @all_bind, @bind;
 195       },
 196
 197       # THINK : anything useful to do with a HASHREF ?
 198       HASHREF => sub {  # (nothing, but old SQLA passed it through)
 199         #TODO in SQLA >= 2.0 it will die instead
 200         belch "HASH ref as bind value in insert is not supported";
 201         push @values, '?';
 202         push @all_bind, $self->_bindtype($column, $v);
 203       },
 204
 205       SCALARREF => sub {  # literal SQL without bind
 206         push @values, $$v;
 207       },
 208
 209       SCALAR_or_UNDEF => sub {
 210         push @values, '?';
 211         push @all_bind, $self->_bindtype($column, $v);
 212       },
 213
 214      });
 215
 216   }
 217
 218   my $sql = $self->_sqlcase('values')." ( ".join(", ", @values)." )";
 219   return ($sql, @all_bind);
 220 }
 221
 222
 223
 224 #======================================================================
 225 # UPDATE methods
 226 #======================================================================
 227
 228
 229 sub update {
 230   my $self  = shift;
 231   my $table = $self->_table(shift);
 232   my $data  = shift || return;
 233   my $where = shift;
 234
 235   # first build the 'SET' part of the sql statement
 236   my (@set, @all_bind);
 237   puke "Unsupported data type specified to \$sql->update"
 238     unless ref $data eq 'HASH';
 239
 240   for my $k (sort keys %$data) {
 241     my $v = $data->{$k};
 242     my $r = ref $v;
 243     my $label = $self->_quote($k);
 244
 245     $self->_SWITCH_refkind($v, {
 246       ARRAYREF => sub {
 247         if ($self->{array_datatypes}) { # array datatype
 248           push @set, "$label = ?";
 249           push @all_bind, $self->_bindtype($k, $v);
 250         }
 251         else {                          # literal SQL with bind
 252           my ($sql, @bind) = @$v;
 253           $self->_assert_bindval_matches_bindtype(@bind);
 254           push @set, "$label = $sql";
 255           push @all_bind, @bind;
 256         }
 257       },
 258       ARRAYREFREF => sub { # literal SQL with bind
 259         my ($sql, @bind) = @${$v};
 260         $self->_assert_bindval_matches_bindtype(@bind);
 261         push @set, "$label = $sql";
 262         push @all_bind, @bind;
 263       },
 264       SCALARREF => sub {  # literal SQL without bind
 265         push @set, "$label = $$v";
 266        },
 267       SCALAR_or_UNDEF => sub {
 268         push @set, "$label = ?";
 269         push @all_bind, $self->_bindtype($k, $v);
 270       },
 271     });
 272   }
 273
 274   # generate sql
 275   my $sql = $self->_sqlcase('update') . " $table " . $self->_sqlcase('set ')
 276           . join ', ', @set;
 277
 278   if ($where) {
 279     my($where_sql, @where_bind) = $self->where($where);
 280     $sql .= $where_sql;
 281     push @all_bind, @where_bind;
 282   }
 283
 284   return wantarray ? ($sql, @all_bind) : $sql;
 285 }
 286
 287
 288
 289
 290 #======================================================================
 291 # SELECT
 292 #======================================================================
 293
 294
 295 sub select {
 296   my $self   = shift;
 297   my $table  = $self->_table(shift);
 298   my $fields = shift || '*';
 299   my $where  = shift;
 300   my $order  = shift;
 301
 302   my($where_sql, @bind) = $self->where($where, $order);
 303
 304   my $f = (ref $fields eq 'ARRAY') ? join ', ', map { $self->_quote($_) } @$fields
 305                                    : $fields;
 306   my $sql = join(' ', $self->_sqlcase('select'), $f,
 307                       $self->_sqlcase('from'),   $table)
 308           . $where_sql;
 309
 310   return wantarray ? ($sql, @bind) : $sql;
 311 }
 312
 313 #======================================================================
 314 # DELETE
 315 #======================================================================
 316
 317
 318 sub delete {
 319   my $self  = shift;
 320   my $table = $self->_table(shift);
 321   my $where = shift;
 322
 323
 324   my($where_sql, @bind) = $self->where($where);
 325   my $sql = $self->_sqlcase('delete from') . " $table" . $where_sql;
 326
 327   return wantarray ? ($sql, @bind) : $sql;
 328 }
 329
 330
 331 #======================================================================
 332 # WHERE: entry point
 333 #======================================================================
 334
 335
 336
 337 # Finally, a separate routine just to handle WHERE clauses
 338 sub where {
 339   my ($self, $where, $order) = @_;
 340
 341   # where ?
 342   my ($sql, @bind) = $self->_recurse_where($where);
 343   $sql = $sql ? $self->_sqlcase(' where ') . "( $sql )" : '';
 344
 345   # order by?
 346   if ($order) {
 347     $sql .= $self->_order_by($order);
 348   }
 349
 350   return wantarray ? ($sql, @bind) : $sql;
 351 }
 352
 353
 354 sub _recurse_where {
 355   my ($self, $where, $logic) = @_;
 356
 357   # dispatch on appropriate method according to refkind of $where
 358   my $method = $self->_METHOD_FOR_refkind("_where", $where);
 359
 360
 361   my ($sql, @bind) =  $self->$method($where, $logic);
 362
 363   # DBIx::Class directly calls _recurse_where in scalar context, so
 364   # we must implement it, even if not in the official API
 365   return wantarray ? ($sql, @bind) : $sql;
 366 }
 367
 368
 369
 370 #======================================================================
 371 # WHERE: top-level ARRAYREF
 372 #======================================================================
 373
 374
 375 sub _where_ARRAYREF {
 376   my ($self, $where, $logic) = @_;
 377
 378   $logic = uc($logic || $self->{logic});
 379   $logic eq 'AND' or $logic eq 'OR' or puke "unknown logic: $logic";
 380
 381   my @clauses = @$where;
 382
 383   my (@sql_clauses, @all_bind);
 384   # need to use while() so can shift() for pairs
 385   while (my $el = shift @clauses) {
 386
 387     # switch according to kind of $el and get corresponding ($sql, @bind)
 388     my ($sql, @bind) = $self->_SWITCH_refkind($el, {
 389
 390       # skip empty elements, otherwise get invalid trailing AND stuff
 391       ARRAYREF  => sub {$self->_recurse_where($el)        if @$el},
 392
 393       ARRAYREFREF => sub { @{${$el}}                 if @{${$el}}},
 394
 395       HASHREF   => sub {$self->_recurse_where($el, 'and') if %$el},
 396            # LDNOTE : previous SQLA code for hashrefs was creating a dirty
 397            # side-effect: the first hashref within an array would change
 398            # the global logic to 'AND'. So [ {cond1, cond2}, [cond3, cond4] ]
 399            # was interpreted as "(cond1 AND cond2) OR (cond3 AND cond4)",
 400            # whereas it should be "(cond1 AND cond2) OR (cond3 OR cond4)".
 401
 402       SCALARREF => sub { ($$el);                                 },
 403
 404       SCALAR    => sub {# top-level arrayref with scalars, recurse in pairs
 405                         $self->_recurse_where({$el => shift(@clauses)})},
 406
 407       UNDEF     => sub {puke "not supported : UNDEF in arrayref" },
 408     });
 409
 410     if ($sql) {
 411       push @sql_clauses, $sql;
 412       push @all_bind, @bind;
 413     }
 414   }
 415
 416   return $self->_join_sql_clauses($logic, \@sql_clauses, \@all_bind);
 417 }
 418
 419 #======================================================================
 420 # WHERE: top-level ARRAYREFREF
 421 #======================================================================
 422
 423 sub _where_ARRAYREFREF {
 424     my ($self, $where) = @_;
 425     my ($sql, @bind) = @{${$where}};
 426
 427     return ($sql, @bind);
 428 }
 429
 430 #======================================================================
 431 # WHERE: top-level HASHREF
 432 #======================================================================
 433
 434 sub _where_HASHREF {
 435   my ($self, $where) = @_;
 436   my (@sql_clauses, @all_bind);
 437
 438   for my $k (sort keys %$where) {
 439     my $v = $where->{$k};
 440
 441     # ($k => $v) is either a special op or a regular hashpair
 442     my ($sql, @bind) = ($k =~ /^(-.+)/) ? $self->_where_op_in_hash($1, $v)
 443                                         : do {
 444          my $method = $self->_METHOD_FOR_refkind("_where_hashpair", $v);
 445          $self->$method($k, $v);
 446        };
 447
 448     push @sql_clauses, $sql;
 449     push @all_bind, @bind;
 450   }
 451
 452   return $self->_join_sql_clauses('and', \@sql_clauses, \@all_bind);
 453 }
 454
 455
 456 sub _where_op_in_hash {
 457   my ($self, $orig_op, $v) = @_;
 458
 459   # put the operator in canonical form
 460   my $op = $orig_op;
 461   $op =~ s/^-//;        # remove initial dash
 462   $op =~ s/[_\t ]+/ /g; # underscores and whitespace become single spaces
 463   $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
 464
 465   $self->_debug("OP(-$op) within hashref, recursing...");
 466
 467   my $op_entry = first {$op =~ $_->{regex}} @{$self->{unary_ops}};
 468   my $handler = $op_entry->{handler};
 469   if (! $handler) {
 470     puke "unknown operator: $orig_op";
 471   }
 472   elsif (not ref $handler) {
 473     if ($op =~ s/\s?\d+$//) {
 474       belch 'Use of [and|or|nest]_N modifiers is deprecated and will be removed in SQLA v2.0. '
 475           . "You probably wanted ...-and => [ -$op => COND1, -$op => COND2 ... ]";
 476     }
 477     return $self->$handler ($op, $v);
 478   }
 479   elsif (ref $handler eq 'CODE') {
 480     return $handler->($self, $op, $v);
 481   }
 482   else {
 483     puke "Illegal handler for operator $orig_op - expecting a method name or a coderef";
 484   }
 485 }
 486
 487 sub _where_op_ANDOR {
 488   my ($self, $op, $v) = @_;
 489
 490   $self->_SWITCH_refkind($v, {
 491     ARRAYREF => sub {
 492       return $self->_where_ARRAYREF($v, $op);
 493     },
 494
 495     HASHREF => sub {
 496       return ( $op =~ /^or/i )
 497         ? $self->_where_ARRAYREF( [ map { $_ => $v->{$_} } ( sort keys %$v ) ], $op )
 498         : $self->_where_HASHREF($v);
 499     },
 500
 501     SCALARREF  => sub {
 502       puke "-$op => \\\$scalar not supported, use -nest => ...";
 503     },
 504
 505     ARRAYREFREF => sub {
 506       puke "-$op => \\[..] not supported, use -nest => ...";
 507     },
 508
 509     SCALAR => sub { # permissively interpreted as SQL
 510       puke "-$op => 'scalar' not supported, use -nest => \\'scalar'";
 511     },
 512
 513     UNDEF => sub {
 514       puke "-$op => undef not supported";
 515     },
 516    });
 517 }
 518
 519 sub _where_op_NEST {
 520   my ($self, $op, $v) = @_;
 521
 522   $self->_SWITCH_refkind($v, {
 523
 524     ARRAYREF => sub {
 525       return $self->_where_ARRAYREF($v, '');
 526     },
 527
 528     HASHREF => sub {
 529       return $self->_where_HASHREF($v);
 530     },
 531
 532     SCALARREF  => sub {         # literal SQL
 533       return ($$v);
 534     },
 535
 536     ARRAYREFREF => sub {        # literal SQL
 537       return @{${$v}};
 538     },
 539
 540     SCALAR => sub { # permissively interpreted as SQL
 541       belch "literal SQL should be -nest => \\'scalar' "
 542           . "instead of -nest => 'scalar' ";
 543       return ($v);
 544     },
 545
 546     UNDEF => sub {
 547       puke "-$op => undef not supported";
 548     },
 549    });
 550 }
 551
 552
 553 sub _where_op_BOOL {
 554   my ($self, $op, $v) = @_;
 555
 556   my ( $prefix, $suffix ) = ( $op =~ /\bnot\b/i )
 557     ? ( '(NOT ', ')' )
 558     : ( '', '' );
 559   $self->_SWITCH_refkind($v, {
 560     ARRAYREF => sub {
 561       my ( $sql, @bind ) = $self->_where_ARRAYREF($v, '');
 562       return ( ($prefix . $sql . $suffix), @bind );
 563     },
 564
 565     ARRAYREFREF => sub {
 566       my ( $sql, @bind ) = @{ ${$v} };
 567       return ( ($prefix . $sql . $suffix), @bind );
 568     },
 569
 570     HASHREF => sub {
 571       my ( $sql, @bind ) = $self->_where_HASHREF($v);
 572       return ( ($prefix . $sql . $suffix), @bind );
 573     },
 574
 575     SCALARREF  => sub {         # literal SQL
 576       return ($prefix . $$v . $suffix);
 577     },
 578
 579     SCALAR => sub { # interpreted as SQL column
 580       return ($prefix . $self->_convert($self->_quote($v)) . $suffix);
 581     },
 582
 583     UNDEF => sub {
 584       puke "-$op => undef not supported";
 585     },
 586    });
 587 }
 588
 589
 590 sub _where_hashpair_ARRAYREF {
 591   my ($self, $k, $v) = @_;
 592
 593   if( @$v ) {
 594     my @v = @$v; # need copy because of shift below
 595     $self->_debug("ARRAY($k) means distribute over elements");
 596
 597     # put apart first element if it is an operator (-and, -or)
 598     my $op = (
 599        (defined $v[0] && $v[0] =~ /^ - (?: AND|OR ) $/ix)
 600          ? shift @v
 601          : ''
 602     );
 603     my @distributed = map { {$k =>  $_} } @v;
 604
 605     if ($op) {
 606       $self->_debug("OP($op) reinjected into the distributed array");
 607       unshift @distributed, $op;
 608     }
 609
 610     my $logic = $op ? substr($op, 1) : '';
 611
 612     return $self->_recurse_where(\@distributed, $logic);
 613   }
 614   else {
 615     # LDNOTE : not sure of this one. What does "distribute over nothing" mean?
 616     $self->_debug("empty ARRAY($k) means 0=1");
 617     return ($self->{sqlfalse});
 618   }
 619 }
 620
 621 sub _where_hashpair_HASHREF {
 622   my ($self, $k, $v, $logic) = @_;
 623   $logic ||= 'and';
 624
 625   my ($all_sql, @all_bind);
 626
 627   for my $orig_op (sort keys %$v) {
 628     my $val = $v->{$orig_op};
 629
 630     # put the operator in canonical form
 631     my $op = $orig_op;
 632     $op =~ s/^-//;        # remove initial dash
 633     $op =~ s/[_\t ]+/ /g; # underscores and whitespace become single spaces
 634     $op =~ s/^\s+|\s+$//g;# remove leading/trailing space
 635
 636     my ($sql, @bind);
 637
 638     # CASE: special operators like -in or -between
 639     my $special_op = first {$op =~ $_->{regex}} @{$self->{special_ops}};
 640     if ($special_op) {
 641       my $handler = $special_op->{handler};
 642       if (! $handler) {
 643         puke "No handler supplied for special operator $orig_op";
 644       }
 645       elsif (not ref $handler) {
 646         ($sql, @bind) = $self->$handler ($k, $op, $val);
 647       }
 648       elsif (ref $handler eq 'CODE') {
 649         ($sql, @bind) = $handler->($self, $k, $op, $val);
 650       }
 651       else {
 652         puke "Illegal handler for special operator $orig_op - expecting a method name or a coderef";
 653       }
 654     }
 655     else {
 656       $self->_SWITCH_refkind($val, {
 657
 658         ARRAYREF => sub {       # CASE: col => {op => \@vals}
 659           ($sql, @bind) = $self->_where_field_op_ARRAYREF($k, $op, $val);
 660         },
 661
 662         SCALARREF => sub {      # CASE: col => {op => \$scalar} (literal SQL without bind)
 663           $sql  = join ' ', $self->_convert($self->_quote($k)),
 664                             $self->_sqlcase($op),
 665                             $$val;
 666         },
 667
 668         ARRAYREFREF => sub {    # CASE: col => {op => \[$sql, @bind]} (literal SQL with bind)
 669           my ($sub_sql, @sub_bind) = @$$val;
 670           $self->_assert_bindval_matches_bindtype(@sub_bind);
 671           $sql  = join ' ', $self->_convert($self->_quote($k)),
 672                             $self->_sqlcase($op),
 673                             $sub_sql;
 674           @bind = @sub_bind;
 675         },
 676
 677         HASHREF => sub {
 678           ($sql, @bind) = $self->_where_hashpair_HASHREF($k, $val, $op);
 679         },
 680
 681         UNDEF => sub {          # CASE: col => {op => undef} : sql "IS (NOT)? NULL"
 682           my $is = ($op =~ $self->{equality_op})   ? 'is'     :
 683                    ($op =~ $self->{inequality_op}) ? 'is not' :
 684                puke "unexpected operator '$orig_op' with undef operand";
 685           $sql = $self->_quote($k) . $self->_sqlcase(" $is null");
 686         },
 687
 688         FALLBACK => sub {       # CASE: col => {op => $scalar}
 689           $sql  = join ' ', $self->_convert($self->_quote($k)),
 690                             $self->_sqlcase($op),
 691                             $self->_convert('?');
 692           @bind = $self->_bindtype($k, $val);
 693         },
 694       });
 695     }
 696
 697     ($all_sql) = (defined $all_sql and $all_sql) ? $self->_join_sql_clauses($logic, [$all_sql, $sql], []) : $sql;
 698     push @all_bind, @bind;
 699   }
 700   return ($all_sql, @all_bind);
 701 }
 702
 703
 704
 705 sub _where_field_op_ARRAYREF {
 706   my ($self, $k, $op, $vals) = @_;
 707
 708   my @vals = @$vals;  #always work on a copy
 709
 710   if(@vals) {
 711     $self->_debug(sprintf '%s means multiple elements: [ %s ]',
 712       $vals,
 713       join (', ', map { defined $_ ? "'$_'" : 'NULL' } @vals ),
 714     );
 715
 716     # see if the first element is an -and/-or op
 717     my $logic;
 718     if (defined $vals[0] && $vals[0] =~ /^ - ( AND|OR ) $/ix) {
 719       $logic = uc $1;
 720       shift @vals;
 721     }
 722
 723     # distribute $op over each remaining member of @vals, append logic if exists
 724     return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
 725
 726     # LDNOTE : had planned to change the distribution logic when
 727     # $op =~ $self->{inequality_op}, because of Morgan laws :
 728     # with {field => {'!=' => [22, 33]}}, it would be ridiculous to generate
 729     # WHERE field != 22 OR  field != 33 : the user probably means
 730     # WHERE field != 22 AND field != 33.
 731     # To do this, replace the above to roughly :
 732     # my $logic = ($op =~ $self->{inequality_op}) ? 'AND' : 'OR';
 733     # return $self->_recurse_where([map { {$k => {$op, $_}} } @vals], $logic);
 734
 735   }
 736   else {
 737     # try to DWIM on equality operators
 738     # LDNOTE : not 100% sure this is the correct thing to do ...
 739     return ($self->{sqlfalse}) if $op =~ $self->{equality_op};
 740     return ($self->{sqltrue})  if $op =~ $self->{inequality_op};
 741
 742     # otherwise
 743     puke "operator '$op' applied on an empty array (field '$k')";
 744   }
 745 }
 746
 747
 748 sub _where_hashpair_SCALARREF {
 749   my ($self, $k, $v) = @_;
 750   $self->_debug("SCALAR($k) means literal SQL: $$v");
 751   my $sql = $self->_quote($k) . " " . $$v;
 752   return ($sql);
 753 }
 754
 755 # literal SQL with bind
 756 sub _where_hashpair_ARRAYREFREF {
 757   my ($self, $k, $v) = @_;
 758   $self->_debug("REF($k) means literal SQL: @${$v}");
 759   my ($sql, @bind) = @${$v};
 760   $self->_assert_bindval_matches_bindtype(@bind);
 761   $sql  = $self->_quote($k) . " " . $sql;
 762   return ($sql, @bind );
 763 }
 764
 765 # literal SQL without bind
 766 sub _where_hashpair_SCALAR {
 767   my ($self, $k, $v) = @_;
 768   $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
 769   my $sql = join ' ', $self->_convert($self->_quote($k)),
 770                       $self->_sqlcase($self->{cmp}),
 771                       $self->_convert('?');
 772   my @bind =  $self->_bindtype($k, $v);
 773   return ( $sql, @bind);
 774 }
 775
 776
 777 sub _where_hashpair_UNDEF {
 778   my ($self, $k, $v) = @_;
 779   $self->_debug("UNDEF($k) means IS NULL");
 780   my $sql = $self->_quote($k) . $self->_sqlcase(' is null');
 781   return ($sql);
 782 }
 783
 784 #======================================================================
 785 # WHERE: TOP-LEVEL OTHERS (SCALARREF, SCALAR, UNDEF)
 786 #======================================================================
 787
 788
 789 sub _where_SCALARREF {
 790   my ($self, $where) = @_;
 791
 792   # literal sql
 793   $self->_debug("SCALAR(*top) means literal SQL: $$where");
 794   return ($$where);
 795 }
 796
 797
 798 sub _where_SCALAR {
 799   my ($self, $where) = @_;
 800
 801   # literal sql
 802   $self->_debug("NOREF(*top) means literal SQL: $where");
 803   return ($where);
 804 }
 805
 806
 807 sub _where_UNDEF {
 808   my ($self) = @_;
 809   return ();
 810 }
 811
 812
 813 #======================================================================
 814 # WHERE: BUILTIN SPECIAL OPERATORS (-in, -between)
 815 #======================================================================
 816
 817
 818 sub _where_field_BETWEEN {
 819   my ($self, $k, $op, $vals) = @_;
 820
 821   my ($label, $and, $placeholder);
 822   $label       = $self->_convert($self->_quote($k));
 823   $and         = ' ' . $self->_sqlcase('and') . ' ';
 824   $placeholder = $self->_convert('?');
 825   $op               = $self->_sqlcase($op);
 826
 827   my ($clause, @bind) = $self->_SWITCH_refkind($vals, {
 828     ARRAYREFREF => sub {
 829       return @$$vals;
 830     },
 831     SCALARREF => sub {
 832       return $$vals;
 833     },
 834     ARRAYREF => sub {
 835       puke "special op 'between' accepts an arrayref with exactly two values"
 836         if @$vals != 2;
 837
 838       my (@all_sql, @all_bind);
 839       foreach my $val (@$vals) {
 840         my ($sql, @bind) = $self->_SWITCH_refkind($val, {
 841            SCALAR => sub {
 842              return ($placeholder, ($val));
 843            },
 844            SCALARREF => sub {
 845              return ($self->_convert($$val), ());
 846            },
 847            ARRAYREFREF => sub {
 848              my ($sql, @bind) = @$$val;
 849              return ($self->_convert($sql), @bind);
 850            },
 851         });
 852         push @all_sql, $sql;
 853         push @all_bind, @bind;
 854       }
 855
 856       return (
 857         (join $and, @all_sql),
 858         $self->_bindtype($k, @all_bind),
 859       );
 860     },
 861     FALLBACK => sub {
 862       puke "special op 'between' accepts an arrayref with two values, or a single literal scalarref/arrayref-ref";
 863     },
 864   });
 865
 866   my $sql = "( $label $op $clause )";
 867   return ($sql, @bind)
 868 }
 869
 870
 871 sub _where_field_IN {
 872   my ($self, $k, $op, $vals) = @_;
 873
 874   # backwards compatibility : if scalar, force into an arrayref
 875   $vals = [$vals] if defined $vals && ! ref $vals;
 876
 877   my ($label)       = $self->_convert($self->_quote($k));
 878   my ($placeholder) = $self->_convert('?');
 879   $op               = $self->_sqlcase($op);
 880
 881   my ($sql, @bind) = $self->_SWITCH_refkind($vals, {
 882     ARRAYREF => sub {     # list of choices
 883       if (@$vals) { # nonempty list
 884         my $placeholders  = join ", ", (($placeholder) x @$vals);
 885         my $sql           = "$label $op ( $placeholders )";
 886         my @bind = $self->_bindtype($k, @$vals);
 887
 888         return ($sql, @bind);
 889       }
 890       else { # empty list : some databases won't understand "IN ()", so DWIM
 891         my $sql = ($op =~ /\bnot\b/i) ? $self->{sqltrue} : $self->{sqlfalse};
 892         return ($sql);
 893       }
 894     },
 895
 896     SCALARREF => sub {  # literal SQL
 897       my $sql = $self->_open_outer_paren ($$vals);
 898       return ("$label $op ( $sql )");
 899     },
 900     ARRAYREFREF => sub {  # literal SQL with bind
 901       my ($sql, @bind) = @$$vals;
 902       $self->_assert_bindval_matches_bindtype(@bind);
 903       $sql = $self->_open_outer_paren ($sql);
 904       return ("$label $op ( $sql )", @bind);
 905     },
 906
 907     FALLBACK => sub {
 908       puke "special op 'in' requires an arrayref (or scalarref/arrayref-ref)";
 909     },
 910   });
 911
 912   return ($sql, @bind);
 913 }
 914
 915 # Some databases (SQLite) treat col IN (1, 2) different from
 916 # col IN ( (1, 2) ). Use this to strip all outer parens while
 917 # adding them back in the corresponding method
 918 sub _open_outer_paren {
 919   my ($self, $sql) = @_;
 920   $sql = $1 while $sql =~ /^ \s* \( (.*) \) \s* $/x;
 921   return $sql;
 922 }
 923
 924
 925 #======================================================================
 926 # ORDER BY
 927 #======================================================================
 928
 929 sub _order_by {
 930   my ($self, $arg) = @_;
 931
 932   my (@sql, @bind);
 933   for my $c ($self->_order_by_chunks ($arg) ) {
 934     $self->_SWITCH_refkind ($c, {
 935       SCALAR => sub { push @sql, $c },
 936       ARRAYREF => sub { push @sql, shift @$c; push @bind, @$c },
 937     });
 938   }
 939
 940   my $sql = @sql
 941     ? sprintf ('%s %s',
 942         $self->_sqlcase(' order by'),
 943         join (', ', @sql)
 944       )
 945     : ''
 946   ;
 947
 948   return wantarray ? ($sql, @bind) : $sql;
 949 }
 950
 951 sub _order_by_chunks {
 952   my ($self, $arg) = @_;
 953
 954   return $self->_SWITCH_refkind($arg, {
 955
 956     ARRAYREF => sub {
 957       map { $self->_order_by_chunks ($_ ) } @$arg;
 958     },
 959
 960     ARRAYREFREF => sub { [ @$$arg ] },
 961
 962     SCALAR    => sub {$self->_quote($arg)},
 963
 964     UNDEF     => sub {return () },
 965
 966     SCALARREF => sub {$$arg}, # literal SQL, no quoting
 967
 968     HASHREF   => sub {
 969       # get first pair in hash
 970       my ($key, $val) = each %$arg;
 971
 972       return () unless $key;
 973
 974       if ( (keys %$arg) > 1 or not $key =~ /^-(desc|asc)/i ) {
 975         puke "hash passed to _order_by must have exactly one key (-desc or -asc)";
 976       }
 977
 978       my $direction = $1;
 979
 980       my @ret;
 981       for my $c ($self->_order_by_chunks ($val)) {
 982         my ($sql, @bind);
 983
 984         $self->_SWITCH_refkind ($c, {
 985           SCALAR => sub {
 986             $sql = $c;
 987           },
 988           ARRAYREF => sub {
 989             ($sql, @bind) = @$c;
 990           },
 991         });
 992
 993         $sql = $sql . ' ' . $self->_sqlcase($direction);
 994
 995         push @ret, [ $sql, @bind];
 996       }
 997
 998       return @ret;
 999     },
1000   });
1001 }
1002
1003
1004 #======================================================================
1005 # DATASOURCE (FOR NOW, JUST PLAIN TABLE OR LIST OF TABLES)
1006 #======================================================================
1007
1008 sub _table  {
1009   my $self = shift;
1010   my $from = shift;
1011   $self->_SWITCH_refkind($from, {
1012     ARRAYREF     => sub {join ', ', map { $self->_quote($_) } @$from;},
1013     SCALAR       => sub {$self->_quote($from)},
1014     SCALARREF    => sub {$$from},
1015     ARRAYREFREF  => sub {join ', ', @$from;},
1016   });
1017 }
1018
1019
1020 #======================================================================
1021 # UTILITY FUNCTIONS
1022 #======================================================================
1023
1024 sub _quote {
1025   my $self  = shift;
1026   my $label = shift;
1027
1028   $label or puke "can't quote an empty label";
1029
1030   # left and right quote characters
1031   my ($ql, $qr, @other) = $self->_SWITCH_refkind($self->{quote_char}, {
1032     SCALAR   => sub {($self->{quote_char}, $self->{quote_char})},
1033     ARRAYREF => sub {@{$self->{quote_char}}},
1034     UNDEF    => sub {()},
1035    });
1036   not @other
1037       or puke "quote_char must be an arrayref of 2 values";
1038
1039   # no quoting if no quoting chars
1040   $ql or return $label;
1041
1042   # no quoting for literal SQL
1043   return $$label if ref($label) eq 'SCALAR';
1044
1045   # separate table / column (if applicable)
1046   my $sep = $self->{name_sep} || '';
1047   my @to_quote = $sep ? split /\Q$sep\E/, $label : ($label);
1048
1049   # do the quoting, except for "*" or for `table`.*
1050   my @quoted = map { $_ eq '*' ? $_: $ql.$_.$qr} @to_quote;
1051
1052   # reassemble and return.
1053   return join $sep, @quoted;
1054 }
1055
1056
1057 # Conversion, if applicable
1058 sub _convert ($) {
1059   my ($self, $arg) = @_;
1060
1061 # LDNOTE : modified the previous implementation below because
1062 # it was not consistent : the first "return" is always an array,
1063 # the second "return" is context-dependent. Anyway, _convert
1064 # seems always used with just a single argument, so make it a
1065 # scalar function.
1066 #     return @_ unless $self->{convert};
1067 #     my $conv = $self->_sqlcase($self->{convert});
1068 #     my @ret = map { $conv.'('.$_.')' } @_;
1069 #     return wantarray ? @ret : $ret[0];
1070   if ($self->{convert}) {
1071     my $conv = $self->_sqlcase($self->{convert});
1072     $arg = $conv.'('.$arg.')';
1073   }
1074   return $arg;
1075 }
1076
1077 # And bindtype
1078 sub _bindtype (@) {
1079   my $self = shift;
1080   my($col, @vals) = @_;
1081
1082   #LDNOTE : changed original implementation below because it did not make
1083   # sense when bindtype eq 'columns' and @vals > 1.
1084 #  return $self->{bindtype} eq 'columns' ? [ $col, @vals ] : @vals;
1085
1086   return $self->{bindtype} eq 'columns' ? map {[$col, $_]} @vals : @vals;
1087 }
1088
1089 # Dies if any element of @bind is not in [colname => value] format
1090 # if bindtype is 'columns'.
1091 sub _assert_bindval_matches_bindtype {
1092   my ($self, @bind) = @_;
1093
1094   if ($self->{bindtype} eq 'columns') {
1095     foreach my $val (@bind) {
1096       if (!defined $val || ref($val) ne 'ARRAY' || @$val != 2) {
1097         die "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
1098       }
1099     }
1100   }
1101 }
1102
1103 sub _join_sql_clauses {
1104   my ($self, $logic, $clauses_aref, $bind_aref) = @_;
1105
1106   if (@$clauses_aref > 1) {
1107     my $join  = " " . $self->_sqlcase($logic) . " ";
1108     my $sql = '( ' . join($join, @$clauses_aref) . ' )';
1109     return ($sql, @$bind_aref);
1110   }
1111   elsif (@$clauses_aref) {
1112     return ($clauses_aref->[0], @$bind_aref); # no parentheses
1113   }
1114   else {
1115     return (); # if no SQL, ignore @$bind_aref
1116   }
1117 }
1118
1119
1120 # Fix SQL case, if so requested
1121 sub _sqlcase {
1122   my $self = shift;
1123
1124   # LDNOTE: if $self->{case} is true, then it contains 'lower', so we
1125   # don't touch the argument ... crooked logic, but let's not change it!
1126   return $self->{case} ? $_[0] : uc($_[0]);
1127 }
1128
1129
1130 #======================================================================
1131 # DISPATCHING FROM REFKIND
1132 #======================================================================
1133
1134 sub _refkind {
1135   my ($self, $data) = @_;
1136   my $suffix = '';
1137   my $ref;
1138   my $n_steps = 0;
1139
1140   while (1) {
1141     # blessed objects are treated like scalars
1142     $ref = (blessed $data) ? '' : ref $data;
1143     $n_steps += 1 if $ref;
1144     last          if $ref ne 'REF';
1145     $data = $$data;
1146   }
1147
1148   my $base = $ref || (defined $data ? 'SCALAR' : 'UNDEF');
1149
1150   return $base . ('REF' x $n_steps);
1151 }
1152
1153
1154
1155 sub _try_refkind {
1156   my ($self, $data) = @_;
1157   my @try = ($self->_refkind($data));
1158   push @try, 'SCALAR_or_UNDEF' if $try[0] eq 'SCALAR' || $try[0] eq 'UNDEF';
1159   push @try, 'FALLBACK';
1160   return @try;
1161 }
1162
1163 sub _METHOD_FOR_refkind {
1164   my ($self, $meth_prefix, $data) = @_;
1165   my $method = first {$_} map {$self->can($meth_prefix."_".$_)}
1166                               $self->_try_refkind($data)
1167     or puke "cannot dispatch on '$meth_prefix' for ".$self->_refkind($data);
1168   return $method;
1169 }
1170
1171
1172 sub _SWITCH_refkind {
1173   my ($self, $data, $dispatch_table) = @_;
1174
1175   my $coderef = first {$_} map {$dispatch_table->{$_}}
1176                                $self->_try_refkind($data)
1177     or puke "no dispatch entry for ".$self->_refkind($data);
1178   $coderef->();
1179 }
1180
1181
1182
1183
1184 #======================================================================
1185 # VALUES, GENERATE, AUTOLOAD
1186 #======================================================================
1187
1188 # LDNOTE: original code from nwiger, didn't touch code in that section
1189 # I feel the AUTOLOAD stuff should not be the default, it should
1190 # only be activated on explicit demand by user.
1191
1192 sub values {
1193     my $self = shift;
1194     my $data = shift || return;
1195     puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
1196         unless ref $data eq 'HASH';
1197
1198     my @all_bind;
1199     foreach my $k ( sort keys %$data ) {
1200         my $v = $data->{$k};
1201         $self->_SWITCH_refkind($v, {
1202           ARRAYREF => sub {
1203             if ($self->{array_datatypes}) { # array datatype
1204               push @all_bind, $self->_bindtype($k, $v);
1205             }
1206             else {                          # literal SQL with bind
1207               my ($sql, @bind) = @$v;
1208               $self->_assert_bindval_matches_bindtype(@bind);
1209               push @all_bind, @bind;
1210             }
1211           },
1212           ARRAYREFREF => sub { # literal SQL with bind
1213             my ($sql, @bind) = @${$v};
1214             $self->_assert_bindval_matches_bindtype(@bind);
1215             push @all_bind, @bind;
1216           },
1217           SCALARREF => sub {  # literal SQL without bind
1218           },
1219           SCALAR_or_UNDEF => sub {
1220             push @all_bind, $self->_bindtype($k, $v);
1221           },
1222         });
1223     }
1224
1225     return @all_bind;
1226 }
1227
1228 sub generate {
1229     my $self  = shift;
1230
1231     my(@sql, @sqlq, @sqlv);
1232
1233     for (@_) {
1234         my $ref = ref $_;
1235         if ($ref eq 'HASH') {
1236             for my $k (sort keys %$_) {
1237                 my $v = $_->{$k};
1238                 my $r = ref $v;
1239                 my $label = $self->_quote($k);
1240                 if ($r eq 'ARRAY') {
1241                     # literal SQL with bind
1242                     my ($sql, @bind) = @$v;
1243                     $self->_assert_bindval_matches_bindtype(@bind);
1244                     push @sqlq, "$label = $sql";
1245                     push @sqlv, @bind;
1246                 } elsif ($r eq 'SCALAR') {
1247                     # literal SQL without bind
1248                     push @sqlq, "$label = $$v";
1249                 } else {
1250                     push @sqlq, "$label = ?";
1251                     push @sqlv, $self->_bindtype($k, $v);
1252                 }
1253             }
1254             push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
1255         } elsif ($ref eq 'ARRAY') {
1256             # unlike insert(), assume these are ONLY the column names, i.e. for SQL
1257             for my $v (@$_) {
1258                 my $r = ref $v;
1259                 if ($r eq 'ARRAY') {   # literal SQL with bind
1260                     my ($sql, @bind) = @$v;
1261                     $self->_assert_bindval_matches_bindtype(@bind);
1262                     push @sqlq, $sql;
1263                     push @sqlv, @bind;
1264                 } elsif ($r eq 'SCALAR') {  # literal SQL without bind
1265                     # embedded literal SQL
1266                     push @sqlq, $$v;
1267                 } else {
1268                     push @sqlq, '?';
1269                     push @sqlv, $v;
1270                 }
1271             }
1272             push @sql, '(' . join(', ', @sqlq) . ')';
1273         } elsif ($ref eq 'SCALAR') {
1274             # literal SQL
1275             push @sql, $$_;
1276         } else {
1277             # strings get case twiddled
1278             push @sql, $self->_sqlcase($_);
1279         }
1280     }
1281
1282     my $sql = join ' ', @sql;
1283
1284     # this is pretty tricky
1285     # if ask for an array, return ($stmt, @bind)
1286     # otherwise, s/?/shift @sqlv/ to put it inline
1287     if (wantarray) {
1288         return ($sql, @sqlv);
1289     } else {
1290         1 while $sql =~ s/\?/my $d = shift(@sqlv);
1291                              ref $d ? $d->[1] : $d/e;
1292         return $sql;
1293     }
1294 }
1295
1296
1297 sub DESTROY { 1 }
1298
1299 sub AUTOLOAD {
1300     # This allows us to check for a local, then _form, attr
1301     my $self = shift;
1302     my($name) = $AUTOLOAD =~ /.*::(.+)/;
1303     return $self->generate($name, @_);
1304 }
1305
1306 1;
1307
1308
1309
1310 __END__
1311
1312 =head1 NAME
1313
1314 SQL::Abstract - Generate SQL from Perl data structures
1315
1316 =head1 SYNOPSIS
1317
1318     use SQL::Abstract;
1319
1320     my $sql = SQL::Abstract->new;
1321
1322     my($stmt, @bind) = $sql->select($table, \@fields, \%where, \@order);
1323
1324     my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
1325
1326     my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
1327
1328     my($stmt, @bind) = $sql->delete($table, \%where);
1329
1330     # Then, use these in your DBI statements
1331     my $sth = $dbh->prepare($stmt);
1332     $sth->execute(@bind);
1333
1334     # Just generate the WHERE clause
1335     my($stmt, @bind) = $sql->where(\%where, \@order);
1336
1337     # Return values in the same order, for hashed queries
1338     # See PERFORMANCE section for more details
1339     my @bind = $sql->values(\%fieldvals);
1340
1341 =head1 DESCRIPTION
1342
1343 This module was inspired by the excellent L<DBIx::Abstract>.
1344 However, in using that module I found that what I really wanted
1345 to do was generate SQL, but still retain complete control over my
1346 statement handles and use the DBI interface. So, I set out to
1347 create an abstract SQL generation module.
1348
1349 While based on the concepts used by L<DBIx::Abstract>, there are
1350 several important differences, especially when it comes to WHERE
1351 clauses. I have modified the concepts used to make the SQL easier
1352 to generate from Perl data structures and, IMO, more intuitive.
1353 The underlying idea is for this module to do what you mean, based
1354 on the data structures you provide it. The big advantage is that
1355 you don't have to modify your code every time your data changes,
1356 as this module figures it out.
1357
1358 To begin with, an SQL INSERT is as easy as just specifying a hash
1359 of C<key=value> pairs:
1360
1361     my %data = (
1362         name => 'Jimbo Bobson',
1363         phone => '123-456-7890',
1364         address => '42 Sister Lane',
1365         city => 'St. Louis',
1366         state => 'Louisiana',
1367     );
1368
1369 The SQL can then be generated with this:
1370
1371     my($stmt, @bind) = $sql->insert('people', \%data);
1372
1373 Which would give you something like this:
1374
1375     $stmt = "INSERT INTO people
1376                     (address, city, name, phone, state)
1377                     VALUES (?, ?, ?, ?, ?)";
1378     @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
1379              '123-456-7890', 'Louisiana');
1380
1381 These are then used directly in your DBI code:
1382
1383     my $sth = $dbh->prepare($stmt);
1384     $sth->execute(@bind);
1385
1386 =head2 Inserting and Updating Arrays
1387
1388 If your database has array types (like for example Postgres),
1389 activate the special option C<< array_datatypes => 1 >>
1390 when creating the C<SQL::Abstract> object.
1391 Then you may use an arrayref to insert and update database array types:
1392
1393     my $sql = SQL::Abstract->new(array_datatypes => 1);
1394     my %data = (
1395         planets => [qw/Mercury Venus Earth Mars/]
1396     );
1397
1398     my($stmt, @bind) = $sql->insert('solar_system', \%data);
1399
1400 This results in:
1401
1402     $stmt = "INSERT INTO solar_system (planets) VALUES (?)"
1403
1404     @bind = (['Mercury', 'Venus', 'Earth', 'Mars']);
1405
1406
1407 =head2 Inserting and Updating SQL
1408
1409 In order to apply SQL functions to elements of your C<%data> you may
1410 specify a reference to an arrayref for the given hash value. For example,
1411 if you need to execute the Oracle C<to_date> function on a value, you can
1412 say something like this:
1413
1414     my %data = (
1415         name => 'Bill',
1416         date_entered => \["to_date(?,'MM/DD/YYYY')", "03/02/2003"],
1417     );
1418
1419 The first value in the array is the actual SQL. Any other values are
1420 optional and would be included in the bind values array. This gives
1421 you:
1422
1423     my($stmt, @bind) = $sql->insert('people', \%data);
1424
1425     $stmt = "INSERT INTO people (name, date_entered)
1426                 VALUES (?, to_date(?,'MM/DD/YYYY'))";
1427     @bind = ('Bill', '03/02/2003');
1428
1429 An UPDATE is just as easy, all you change is the name of the function:
1430
1431     my($stmt, @bind) = $sql->update('people', \%data);
1432
1433 Notice that your C<%data> isn't touched; the module will generate
1434 the appropriately quirky SQL for you automatically. Usually you'll
1435 want to specify a WHERE clause for your UPDATE, though, which is
1436 where handling C<%where> hashes comes in handy...
1437
1438 =head2 Complex where statements
1439
1440 This module can generate pretty complicated WHERE statements
1441 easily. For example, simple C<key=value> pairs are taken to mean
1442 equality, and if you want to see if a field is within a set
1443 of values, you can use an arrayref. Let's say we wanted to
1444 SELECT some data based on this criteria:
1445
1446     my %where = (
1447        requestor => 'inna',
1448        worker => ['nwiger', 'rcwe', 'sfz'],
1449        status => { '!=', 'completed' }
1450     );
1451
1452     my($stmt, @bind) = $sql->select('tickets', '*', \%where);
1453
1454 The above would give you something like this:
1455
1456     $stmt = "SELECT * FROM tickets WHERE
1457                 ( requestor = ? ) AND ( status != ? )
1458                 AND ( worker = ? OR worker = ? OR worker = ? )";
1459     @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
1460
1461 Which you could then use in DBI code like so:
1462
1463     my $sth = $dbh->prepare($stmt);
1464     $sth->execute(@bind);
1465
1466 Easy, eh?
1467
1468 =head1 FUNCTIONS
1469
1470 The functions are simple. There's one for each major SQL operation,
1471 and a constructor you use first. The arguments are specified in a
1472 similar order to each function (table, then fields, then a where
1473 clause) to try and simplify things.
1474
1475
1476
1477
1478 =head2 new(option => 'value')
1479
1480 The C<new()> function takes a list of options and values, and returns
1481 a new B<SQL::Abstract> object which can then be used to generate SQL
1482 through the methods below. The options accepted are:
1483
1484 =over
1485
1486 =item case
1487
1488 If set to 'lower', then SQL will be generated in all lowercase. By
1489 default SQL is generated in "textbook" case meaning something like:
1490
1491     SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
1492
1493 Any setting other than 'lower' is ignored.
1494
1495 =item cmp
1496
1497 This determines what the default comparison operator is. By default
1498 it is C<=>, meaning that a hash like this:
1499
1500     %where = (name => 'nwiger', email => 'nate@wiger.org');
1501
1502 Will generate SQL like this:
1503
1504     WHERE name = 'nwiger' AND email = 'nate@wiger.org'
1505
1506 However, you may want loose comparisons by default, so if you set
1507 C<cmp> to C<like> you would get SQL such as:
1508
1509     WHERE name like 'nwiger' AND email like 'nate@wiger.org'
1510
1511 You can also override the comparsion on an individual basis - see
1512 the huge section on L</"WHERE CLAUSES"> at the bottom.
1513
1514 =item sqltrue, sqlfalse
1515
1516 Expressions for inserting boolean values within SQL statements.
1517 By default these are C<1=1> and C<1=0>. They are used
1518 by the special operators C<-in> and C<-not_in> for generating
1519 correct SQL even when the argument is an empty array (see below).
1520
1521 =item logic
1522
1523 This determines the default logical operator for multiple WHERE
1524 statements in arrays or hashes. If absent, the default logic is "or"
1525 for arrays, and "and" for hashes. This means that a WHERE
1526 array of the form:
1527
1528     @where = (
1529         event_date => {'>=', '2/13/99'},
1530         event_date => {'<=', '4/24/03'},
1531     );
1532
1533 will generate SQL like this:
1534
1535     WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
1536
1537 This is probably not what you want given this query, though (look
1538 at the dates). To change the "OR" to an "AND", simply specify:
1539
1540     my $sql = SQL::Abstract->new(logic => 'and');
1541
1542 Which will change the above C<WHERE> to:
1543
1544     WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
1545
1546 The logic can also be changed locally by inserting
1547 a modifier in front of an arrayref :
1548
1549     @where = (-and => [event_date => {'>=', '2/13/99'},
1550                        event_date => {'<=', '4/24/03'} ]);
1551
1552 See the L</"WHERE CLAUSES"> section for explanations.
1553
1554 =item convert
1555
1556 This will automatically convert comparisons using the specified SQL
1557 function for both column and value. This is mostly used with an argument
1558 of C<upper> or C<lower>, so that the SQL will have the effect of
1559 case-insensitive "searches". For example, this:
1560
1561     $sql = SQL::Abstract->new(convert => 'upper');
1562     %where = (keywords => 'MaKe iT CAse inSeNSItive');
1563
1564 Will turn out the following SQL:
1565
1566     WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
1567
1568 The conversion can be C<upper()>, C<lower()>, or any other SQL function
1569 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
1570 not validate this option; it will just pass through what you specify verbatim).
1571
1572 =item bindtype
1573
1574 This is a kludge because many databases suck. For example, you can't
1575 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
1576 Instead, you have to use C<bind_param()>:
1577
1578     $sth->bind_param(1, 'reg data');
1579     $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
1580
1581 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
1582 which loses track of which field each slot refers to. Fear not.
1583
1584 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
1585 Currently, you can specify either C<normal> (default) or C<columns>. If you
1586 specify C<columns>, you will get an array that looks like this:
1587
1588     my $sql = SQL::Abstract->new(bindtype => 'columns');
1589     my($stmt, @bind) = $sql->insert(...);
1590
1591     @bind = (
1592         [ 'column1', 'value1' ],
1593         [ 'column2', 'value2' ],
1594         [ 'column3', 'value3' ],
1595     );
1596
1597 You can then iterate through this manually, using DBI's C<bind_param()>.
1598
1599     $sth->prepare($stmt);
1600     my $i = 1;
1601     for (@bind) {
1602         my($col, $data) = @$_;
1603         if ($col eq 'details' || $col eq 'comments') {
1604             $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
1605         } elsif ($col eq 'image') {
1606             $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
1607         } else {
1608             $sth->bind_param($i, $data);
1609         }
1610         $i++;
1611     }
1612     $sth->execute;      # execute without @bind now
1613
1614 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
1615 Basically, the advantage is still that you don't have to care which fields
1616 are or are not included. You could wrap that above C<for> loop in a simple
1617 sub called C<bind_fields()> or something and reuse it repeatedly. You still
1618 get a layer of abstraction over manual SQL specification.
1619
1620 Note that if you set L</bindtype> to C<columns>, the C<\[$sql, @bind]>
1621 construct (see L</Literal SQL with placeholders and bind values (subqueries)>)
1622 will expect the bind values in this format.
1623
1624 =item quote_char
1625
1626 This is the character that a table or column name will be quoted
1627 with.  By default this is an empty string, but you could set it to
1628 the character C<`>, to generate SQL like this:
1629
1630   SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
1631
1632 Alternatively, you can supply an array ref of two items, the first being the left
1633 hand quote character, and the second the right hand quote character. For
1634 example, you could supply C<['[',']']> for SQL Server 2000 compliant quotes
1635 that generates SQL like this:
1636
1637   SELECT [a_field] FROM [a_table] WHERE [some_field] LIKE '%someval%'
1638
1639 Quoting is useful if you have tables or columns names that are reserved
1640 words in your database's SQL dialect.
1641
1642 =item name_sep
1643
1644 This is the character that separates a table and column name.  It is
1645 necessary to specify this when the C<quote_char> option is selected,
1646 so that tables and column names can be individually quoted like this:
1647
1648   SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
1649
1650 =item array_datatypes
1651
1652 When this option is true, arrayrefs in INSERT or UPDATE are
1653 interpreted as array datatypes and are passed directly
1654 to the DBI layer.
1655 When this option is false, arrayrefs are interpreted
1656 as literal SQL, just like refs to arrayrefs
1657 (but this behavior is for backwards compatibility; when writing
1658 new queries, use the "reference to arrayref" syntax
1659 for literal SQL).
1660
1661
1662 =item special_ops
1663
1664 Takes a reference to a list of "special operators"
1665 to extend the syntax understood by L<SQL::Abstract>.
1666 See section L</"SPECIAL OPERATORS"> for details.
1667
1668 =item unary_ops
1669
1670 Takes a reference to a list of "unary operators"
1671 to extend the syntax understood by L<SQL::Abstract>.
1672 See section L</"UNARY OPERATORS"> for details.
1673
1674
1675
1676 =back
1677
1678 =head2 insert($table, \@values || \%fieldvals)
1679
1680 This is the simplest function. You simply give it a table name
1681 and either an arrayref of values or hashref of field/value pairs.
1682 It returns an SQL INSERT statement and a list of bind values.
1683 See the sections on L</"Inserting and Updating Arrays"> and
1684 L</"Inserting and Updating SQL"> for information on how to insert
1685 with those data types.
1686
1687 =head2 update($table, \%fieldvals, \%where)
1688
1689 This takes a table, hashref of field/value pairs, and an optional
1690 hashref L<WHERE clause|/WHERE CLAUSES>. It returns an SQL UPDATE function and a list
1691 of bind values.
1692 See the sections on L</"Inserting and Updating Arrays"> and
1693 L</"Inserting and Updating SQL"> for information on how to insert
1694 with those data types.
1695
1696 =head2 select($source, $fields, $where, $order)
1697
1698 This returns a SQL SELECT statement and associated list of bind values, as
1699 specified by the arguments  :
1700
1701 =over
1702
1703 =item $source
1704
1705 Specification of the 'FROM' part of the statement.
1706 The argument can be either a plain scalar (interpreted as a table
1707 name, will be quoted), or an arrayref (interpreted as a list
1708 of table names, joined by commas, quoted), or a scalarref
1709 (literal table name, not quoted), or a ref to an arrayref
1710 (list of literal table names, joined by commas, not quoted).
1711
1712 =item $fields
1713
1714 Specification of the list of fields to retrieve from
1715 the source.
1716 The argument can be either an arrayref (interpreted as a list
1717 of field names, will be joined by commas and quoted), or a
1718 plain scalar (literal SQL, not quoted).
1719 Please observe that this API is not as flexible as for
1720 the first argument C<$table>, for backwards compatibility reasons.
1721
1722 =item $where
1723
1724 Optional argument to specify the WHERE part of the query.
1725 The argument is most often a hashref, but can also be
1726 an arrayref or plain scalar --
1727 see section L<WHERE clause|/"WHERE CLAUSES"> for details.
1728
1729 =item $order
1730
1731 Optional argument to specify the ORDER BY part of the query.
1732 The argument can be a scalar, a hashref or an arrayref
1733 -- see section L<ORDER BY clause|/"ORDER BY CLAUSES">
1734 for details.
1735
1736 =back
1737
1738
1739 =head2 delete($table, \%where)
1740
1741 This takes a table name and optional hashref L<WHERE clause|/WHERE CLAUSES>.
1742 It returns an SQL DELETE statement and list of bind values.
1743
1744 =head2 where(\%where, \@order)
1745
1746 This is used to generate just the WHERE clause. For example,
1747 if you have an arbitrary data structure and know what the
1748 rest of your SQL is going to look like, but want an easy way
1749 to produce a WHERE clause, use this. It returns an SQL WHERE
1750 clause and list of bind values.
1751
1752
1753 =head2 values(\%data)
1754
1755 This just returns the values from the hash C<%data>, in the same
1756 order that would be returned from any of the other above queries.
1757 Using this allows you to markedly speed up your queries if you
1758 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
1759
1760 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
1761
1762 Warning: This is an experimental method and subject to change.
1763
1764 This returns arbitrarily generated SQL. It's a really basic shortcut.
1765 It will return two different things, depending on return context:
1766
1767     my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
1768     my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
1769
1770 These would return the following:
1771
1772     # First calling form
1773     $stmt = "CREATE TABLE test (?, ?)";
1774     @bind = (field1, field2);
1775
1776     # Second calling form
1777     $stmt_and_val = "CREATE TABLE test (field1, field2)";
1778
1779 Depending on what you're trying to do, it's up to you to choose the correct
1780 format. In this example, the second form is what you would want.
1781
1782 By the same token:
1783
1784     $sql->generate('alter session', { nls_date_format => 'MM/YY' });
1785
1786 Might give you:
1787
1788     ALTER SESSION SET nls_date_format = 'MM/YY'
1789
1790 You get the idea. Strings get their case twiddled, but everything
1791 else remains verbatim.
1792
1793
1794
1795
1796 =head1 WHERE CLAUSES
1797
1798 =head2 Introduction
1799
1800 This module uses a variation on the idea from L<DBIx::Abstract>. It
1801 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
1802 module is that things in arrays are OR'ed, and things in hashes
1803 are AND'ed.>
1804
1805 The easiest way to explain is to show lots of examples. After
1806 each C<%where> hash shown, it is assumed you used:
1807
1808     my($stmt, @bind) = $sql->where(\%where);
1809
1810 However, note that the C<%where> hash can be used directly in any
1811 of the other functions as well, as described above.
1812
1813 =head2 Key-value pairs
1814
1815 So, let's get started. To begin, a simple hash:
1816
1817     my %where  = (
1818         user   => 'nwiger',
1819         status => 'completed'
1820     );
1821
1822 Is converted to SQL C<key = val> statements:
1823
1824     $stmt = "WHERE user = ? AND status = ?";
1825     @bind = ('nwiger', 'completed');
1826
1827 One common thing I end up doing is having a list of values that
1828 a field can be in. To do this, simply specify a list inside of
1829 an arrayref:
1830
1831     my %where  = (
1832         user   => 'nwiger',
1833         status => ['assigned', 'in-progress', 'pending'];
1834     );
1835
1836 This simple code will create the following:
1837
1838     $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
1839     @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
1840
1841 A field associated to an empty arrayref will be considered a
1842 logical false and will generate 0=1.
1843
1844 =head2 Specific comparison operators
1845
1846 If you want to specify a different type of operator for your comparison,
1847 you can use a hashref for a given column:
1848
1849     my %where  = (
1850         user   => 'nwiger',
1851         status => { '!=', 'completed' }
1852     );
1853
1854 Which would generate:
1855
1856     $stmt = "WHERE user = ? AND status != ?";
1857     @bind = ('nwiger', 'completed');
1858
1859 To test against multiple values, just enclose the values in an arrayref:
1860
1861     status => { '=', ['assigned', 'in-progress', 'pending'] };
1862
1863 Which would give you:
1864
1865     "WHERE status = ? OR status = ? OR status = ?"
1866
1867
1868 The hashref can also contain multiple pairs, in which case it is expanded
1869 into an C<AND> of its elements:
1870
1871     my %where  = (
1872         user   => 'nwiger',
1873         status => { '!=', 'completed', -not_like => 'pending%' }
1874     );
1875
1876     # Or more dynamically, like from a form
1877     $where{user} = 'nwiger';
1878     $where{status}{'!='} = 'completed';
1879     $where{status}{'-not_like'} = 'pending%';
1880
1881     # Both generate this
1882     $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
1883     @bind = ('nwiger', 'completed', 'pending%');
1884
1885
1886 To get an OR instead, you can combine it with the arrayref idea:
1887
1888     my %where => (
1889          user => 'nwiger',
1890          priority => [ {'=', 2}, {'!=', 1} ]
1891     );
1892
1893 Which would generate:
1894
1895     $stmt = "WHERE user = ? AND priority = ? OR priority != ?";
1896     @bind = ('nwiger', '2', '1');
1897
1898 If you want to include literal SQL (with or without bind values), just use a
1899 scalar reference or array reference as the value:
1900
1901     my %where  = (
1902         date_entered => { '>' => \["to_date(?, 'MM/DD/YYYY')", "11/26/2008"] },
1903         date_expires => { '<' => \"now()" }
1904     );
1905
1906 Which would generate:
1907
1908     $stmt = "WHERE date_entered > "to_date(?, 'MM/DD/YYYY') AND date_expires < now()";
1909     @bind = ('11/26/2008');
1910
1911
1912 =head2 Logic and nesting operators
1913
1914 In the example above,
1915 there is a subtle trap if you want to say something like
1916 this (notice the C<AND>):
1917
1918     WHERE priority != ? AND priority != ?
1919
1920 Because, in Perl you I<can't> do this:
1921
1922     priority => { '!=', 2, '!=', 1 }
1923
1924 As the second C<!=> key will obliterate the first. The solution
1925 is to use the special C<-modifier> form inside an arrayref:
1926
1927     priority => [ -and => {'!=', 2},
1928                           {'!=', 1} ]
1929
1930
1931 Normally, these would be joined by C<OR>, but the modifier tells it
1932 to use C<AND> instead. (Hint: You can use this in conjunction with the
1933 C<logic> option to C<new()> in order to change the way your queries
1934 work by default.) B<Important:> Note that the C<-modifier> goes
1935 B<INSIDE> the arrayref, as an extra first element. This will
1936 B<NOT> do what you think it might:
1937
1938     priority => -and => [{'!=', 2}, {'!=', 1}]   # WRONG!
1939
1940 Here is a quick list of equivalencies, since there is some overlap:
1941
1942     # Same
1943     status => {'!=', 'completed', 'not like', 'pending%' }
1944     status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
1945
1946     # Same
1947     status => {'=', ['assigned', 'in-progress']}
1948     status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
1949     status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
1950
1951
1952
1953 =head2 Special operators : IN, BETWEEN, etc.
1954
1955 You can also use the hashref format to compare a list of fields using the
1956 C<IN> comparison operator, by specifying the list as an arrayref:
1957
1958     my %where  = (
1959         status   => 'completed',
1960         reportid => { -in => [567, 2335, 2] }
1961     );
1962
1963 Which would generate:
1964
1965     $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
1966     @bind = ('completed', '567', '2335', '2');
1967
1968 The reverse operator C<-not_in> generates SQL C<NOT IN> and is used in
1969 the same way.
1970
1971 If the argument to C<-in> is an empty array, 'sqlfalse' is generated
1972 (by default : C<1=0>). Similarly, C<< -not_in => [] >> generates
1973 'sqltrue' (by default : C<1=1>).
1974
1975
1976
1977 Another pair of operators is C<-between> and C<-not_between>,
1978 used with an arrayref of two values:
1979
1980     my %where  = (
1981         user   => 'nwiger',
1982         completion_date => {
1983            -not_between => ['2002-10-01', '2003-02-06']
1984         }
1985     );
1986
1987 Would give you:
1988
1989     WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
1990
1991 These are the two builtin "special operators"; but the
1992 list can be expanded : see section L</"SPECIAL OPERATORS"> below.
1993
1994 =head2 Unary operators: bool
1995
1996 If you wish to test against boolean columns or functions within your
1997 database you can use the C<-bool> and C<-not_bool> operators. For
1998 example to test the column C<is_user> being true and the column
1999 <is_enabled> being false you would use:-
2000
2001     my %where  = (
2002         -bool       => 'is_user',
2003         -not_bool   => 'is_enabled',
2004     );
2005
2006 Would give you:
2007
2008     WHERE is_user AND NOT is_enabled
2009
2010 If a more complex combination is required, testing more conditions,
2011 then you should use the and/or operators:-
2012
2013     my %where  = (
2014         -and           => [
2015             -bool      => 'one',
2016             -bool      => 'two',
2017             -bool      => 'three',
2018             -not_bool  => 'four',
2019         ],
2020     );
2021
2022 Would give you:
2023
2024     WHERE one AND two AND three AND NOT four
2025
2026
2027 =head2 Nested conditions, -and/-or prefixes
2028
2029 So far, we've seen how multiple conditions are joined with a top-level
2030 C<AND>.  We can change this by putting the different conditions we want in
2031 hashes and then putting those hashes in an array. For example:
2032
2033     my @where = (
2034         {
2035             user   => 'nwiger',
2036             status => { -like => ['pending%', 'dispatched'] },
2037         },
2038         {
2039             user   => 'robot',
2040             status => 'unassigned',
2041         }
2042     );
2043
2044 This data structure would create the following:
2045
2046     $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
2047                 OR ( user = ? AND status = ? ) )";
2048     @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
2049
2050
2051 There is also a special C<-nest>
2052 operator which adds an additional set of parens, to create a subquery.
2053 For example, to get something like this:
2054
2055     $stmt = "WHERE user = ? AND ( workhrs > ? OR geo = ? )";
2056     @bind = ('nwiger', '20', 'ASIA');
2057
2058 You would do:
2059
2060     my %where = (
2061          user => 'nwiger',
2062         -nest => [ workhrs => {'>', 20}, geo => 'ASIA' ],
2063     );
2064
2065
2066 Finally, clauses in hashrefs or arrayrefs can be
2067 prefixed with an C<-and> or C<-or> to change the logic
2068 inside :
2069
2070     my @where = (
2071          -and => [
2072             user => 'nwiger',
2073             -nest => [
2074                 -and => [workhrs => {'>', 20}, geo => 'ASIA' ],
2075                 -and => [workhrs => {'<', 50}, geo => 'EURO' ]
2076             ],
2077         ],
2078     );
2079
2080 That would yield:
2081
2082     WHERE ( user = ? AND
2083           ( ( workhrs > ? AND geo = ? )
2084          OR ( workhrs < ? AND geo = ? ) ) )
2085
2086
2087 =head2 Algebraic inconsistency, for historical reasons
2088
2089 C<Important note>: when connecting several conditions, the C<-and->|C<-or>
2090 operator goes C<outside> of the nested structure; whereas when connecting
2091 several constraints on one column, the C<-and> operator goes
2092 C<inside> the arrayref. Here is an example combining both features :
2093
2094    my @where = (
2095      -and => [a => 1, b => 2],
2096      -or  => [c => 3, d => 4],
2097       e   => [-and => {-like => 'foo%'}, {-like => '%bar'} ]
2098    )
2099
2100 yielding
2101
2102   WHERE ( (    ( a = ? AND b = ? )
2103             OR ( c = ? OR d = ? )
2104             OR ( e LIKE ? AND e LIKE ? ) ) )
2105
2106 This difference in syntax is unfortunate but must be preserved for
2107 historical reasons. So be careful : the two examples below would
2108 seem algebraically equivalent, but they are not
2109
2110   {col => [-and => {-like => 'foo%'}, {-like => '%bar'}]}
2111   # yields : WHERE ( ( col LIKE ? AND col LIKE ? ) )
2112
2113   [-and => {col => {-like => 'foo%'}, {col => {-like => '%bar'}}]]
2114   # yields : WHERE ( ( col LIKE ? OR col LIKE ? ) )
2115
2116
2117 =head2 Literal SQL
2118
2119 Finally, sometimes only literal SQL will do. If you want to include
2120 literal SQL verbatim, you can specify it as a scalar reference, namely:
2121
2122     my $inn = 'is Not Null';
2123     my %where = (
2124         priority => { '<', 2 },
2125         requestor => \$inn
2126     );
2127
2128 This would create:
2129
2130     $stmt = "WHERE priority < ? AND requestor is Not Null";
2131     @bind = ('2');
2132
2133 Note that in this example, you only get one bind parameter back, since
2134 the verbatim SQL is passed as part of the statement.
2135
2136 Of course, just to prove a point, the above can also be accomplished
2137 with this:
2138
2139     my %where = (
2140         priority  => { '<', 2 },
2141         requestor => { '!=', undef },
2142     );
2143
2144
2145 TMTOWTDI.
2146
2147 Conditions on boolean columns can be expressed in the same way, passing
2148 a reference to an empty string, however using liternal SQL in this way
2149 is deprecated - the preferred method is to use the boolean operators -
2150 see L</"Unary operators: bool"> :
2151
2152     my %where = (
2153         priority  => { '<', 2 },
2154         is_ready  => \"";
2155     );
2156
2157 which yields
2158
2159     $stmt = "WHERE priority < ? AND is_ready";
2160     @bind = ('2');
2161
2162
2163 =head2 Literal SQL with placeholders and bind values (subqueries)
2164
2165 If the literal SQL to be inserted has placeholders and bind values,
2166 use a reference to an arrayref (yes this is a double reference --
2167 not so common, but perfectly legal Perl). For example, to find a date
2168 in Postgres you can use something like this:
2169
2170     my %where = (
2171        date_column => \[q/= date '2008-09-30' - ?::integer/, 10/]
2172     )
2173
2174 This would create:
2175
2176     $stmt = "WHERE ( date_column = date '2008-09-30' - ?::integer )"
2177     @bind = ('10');
2178
2179 Note that you must pass the bind values in the same format as they are returned
2180 by L</where>. That means that if you set L</bindtype> to C<columns>, you must
2181 provide the bind values in the C<< [ column_meta => value ] >> format, where
2182 C<column_meta> is an opaque scalar value; most commonly the column name, but
2183 you can use any scalar value (including references and blessed references),
2184 L<SQL::Abstract> will simply pass it through intact. So if C<bindtype> is set
2185 to C<columns> the above example will look like:
2186
2187     my %where = (
2188        date_column => \[q/= date '2008-09-30' - ?::integer/, [ dummy => 10 ]/]
2189     )
2190
2191 Literal SQL is especially useful for nesting parenthesized clauses in the
2192 main SQL query. Here is a first example :
2193
2194   my ($sub_stmt, @sub_bind) = ("SELECT c1 FROM t1 WHERE c2 < ? AND c3 LIKE ?",
2195                                100, "foo%");
2196   my %where = (
2197     foo => 1234,
2198     bar => \["IN ($sub_stmt)" => @sub_bind],
2199   );
2200
2201 This yields :
2202
2203   $stmt = "WHERE (foo = ? AND bar IN (SELECT c1 FROM t1
2204                                              WHERE c2 < ? AND c3 LIKE ?))";
2205   @bind = (1234, 100, "foo%");
2206
2207 Other subquery operators, like for example C<"E<gt> ALL"> or C<"NOT IN">,
2208 are expressed in the same way. Of course the C<$sub_stmt> and
2209 its associated bind values can be generated through a former call
2210 to C<select()> :
2211
2212   my ($sub_stmt, @sub_bind)
2213      = $sql->select("t1", "c1", {c2 => {"<" => 100},
2214                                  c3 => {-like => "foo%"}});
2215   my %where = (
2216     foo => 1234,
2217     bar => \["> ALL ($sub_stmt)" => @sub_bind],
2218   );
2219
2220 In the examples above, the subquery was used as an operator on a column;
2221 but the same principle also applies for a clause within the main C<%where>
2222 hash, like an EXISTS subquery :
2223
2224   my ($sub_stmt, @sub_bind)
2225      = $sql->select("t1", "*", {c1 => 1, c2 => \"> t0.c0"});
2226   my %where = (
2227     foo   => 1234,
2228     -nest => \["EXISTS ($sub_stmt)" => @sub_bind],
2229   );
2230
2231 which yields
2232
2233   $stmt = "WHERE (foo = ? AND EXISTS (SELECT * FROM t1
2234                                         WHERE c1 = ? AND c2 > t0.c0))";
2235   @bind = (1234, 1);
2236
2237
2238 Observe that the condition on C<c2> in the subquery refers to
2239 column C<t0.c0> of the main query : this is I<not> a bind
2240 value, so we have to express it through a scalar ref.
2241 Writing C<< c2 => {">" => "t0.c0"} >> would have generated
2242 C<< c2 > ? >> with bind value C<"t0.c0"> ... not exactly
2243 what we wanted here.
2244
2245 Another use of the subquery technique is when some SQL clauses need
2246 parentheses, as it often occurs with some proprietary SQL extensions
2247 like for example fulltext expressions, geospatial expressions,
2248 NATIVE clauses, etc. Here is an example of a fulltext query in MySQL :
2249
2250   my %where = (
2251     -nest => \["MATCH (col1, col2) AGAINST (?)" => qw/apples/]
2252   );
2253
2254 Finally, here is an example where a subquery is used
2255 for expressing unary negation:
2256
2257   my ($sub_stmt, @sub_bind)
2258      = $sql->where({age => [{"<" => 10}, {">" => 20}]});
2259   $sub_stmt =~ s/^ where //i; # don't want "WHERE" in the subclause
2260   my %where = (
2261         lname  => {like => '%son%'},
2262         -nest  => \["NOT ($sub_stmt)" => @sub_bind],
2263     );
2264
2265 This yields
2266
2267   $stmt = "lname LIKE ? AND NOT ( age < ? OR age > ? )"
2268   @bind = ('%son%', 10, 20)
2269
2270
2271
2272 =head2 Conclusion
2273
2274 These pages could go on for a while, since the nesting of the data
2275 structures this module can handle are pretty much unlimited (the
2276 module implements the C<WHERE> expansion as a recursive function
2277 internally). Your best bet is to "play around" with the module a
2278 little to see how the data structures behave, and choose the best
2279 format for your data based on that.
2280
2281 And of course, all the values above will probably be replaced with
2282 variables gotten from forms or the command line. After all, if you
2283 knew everything ahead of time, you wouldn't have to worry about
2284 dynamically-generating SQL and could just hardwire it into your
2285 script.
2286
2287
2288
2289
2290 =head1 ORDER BY CLAUSES
2291
2292 Some functions take an order by clause. This can either be a scalar (just a
2293 column name,) a hash of C<< { -desc => 'col' } >> or C<< { -asc => 'col' } >>,
2294 or an array of either of the two previous forms. Examples:
2295
2296                Given            |         Will Generate
2297     ----------------------------------------------------------
2298                                 |
2299     \'colA DESC'                | ORDER BY colA DESC
2300                                 |
2301     'colA'                      | ORDER BY colA
2302                                 |
2303     [qw/colA colB/]             | ORDER BY colA, colB
2304                                 |
2305     {-asc  => 'colA'}           | ORDER BY colA ASC
2306                                 |
2307     {-desc => 'colB'}           | ORDER BY colB DESC
2308                                 |
2309     ['colA', {-asc => 'colB'}]  | ORDER BY colA, colB ASC
2310                                 |
2311     { -asc => [qw/colA colB] }  | ORDER BY colA ASC, colB ASC
2312                                 |
2313     [                           |
2314       { -asc => 'colA' },       | ORDER BY colA ASC, colB DESC,
2315       { -desc => [qw/colB/],    |          colC ASC, colD ASC
2316       { -asc => [qw/colC colD/],|
2317     ]                           |
2318     ===========================================================
2319
2320
2321
2322 =head1 SPECIAL OPERATORS
2323
2324   my $sqlmaker = SQL::Abstract->new(special_ops => [
2325      {
2326       regex => qr/.../,
2327       handler => sub {
2328         my ($self, $field, $op, $arg) = @_;
2329         ...
2330       },
2331      },
2332      {
2333       regex => qr/.../,
2334       handler => 'method_name',
2335      },
2336    ]);
2337
2338 A "special operator" is a SQL syntactic clause that can be
2339 applied to a field, instead of a usual binary operator.
2340 For example :
2341
2342    WHERE field IN (?, ?, ?)
2343    WHERE field BETWEEN ? AND ?
2344    WHERE MATCH(field) AGAINST (?, ?)
2345
2346 Special operators IN and BETWEEN are fairly standard and therefore
2347 are builtin within C<SQL::Abstract> (as the overridable methods
2348 C<_where_field_IN> and C<_where_field_BETWEEN>). For other operators,
2349 like the MATCH .. AGAINST example above which is specific to MySQL,
2350 you can write your own operator handlers - supply a C<special_ops>
2351 argument to the C<new> method. That argument takes an arrayref of
2352 operator definitions; each operator definition is a hashref with two
2353 entries:
2354
2355 =over
2356
2357 =item regex
2358
2359 the regular expression to match the operator
2360
2361 =item handler
2362
2363 Either a coderef or a plain scalar method name. In both cases
2364 the expected return is C<< ($sql, @bind) >>.
2365
2366 When supplied with a method name, it is simply called on the
2367 L<SQL::Abstract/> object as:
2368
2369  $self->$method_name ($field, $op, $arg)
2370
2371  Where:
2372
2373   $op is the part that matched the handler regex
2374   $field is the LHS of the operator
2375   $arg is the RHS
2376
2377 When supplied with a coderef, it is called as:
2378
2379  $coderef->($self, $field, $op, $arg)
2380
2381
2382 =back
2383
2384 For example, here is an implementation
2385 of the MATCH .. AGAINST syntax for MySQL
2386
2387   my $sqlmaker = SQL::Abstract->new(special_ops => [
2388
2389     # special op for MySql MATCH (field) AGAINST(word1, word2, ...)
2390     {regex => qr/^match$/i,
2391      handler => sub {
2392        my ($self, $field, $op, $arg) = @_;
2393        $arg = [$arg] if not ref $arg;
2394        my $label         = $self->_quote($field);
2395        my ($placeholder) = $self->_convert('?');
2396        my $placeholders  = join ", ", (($placeholder) x @$arg);
2397        my $sql           = $self->_sqlcase('match') . " ($label) "
2398                          . $self->_sqlcase('against') . " ($placeholders) ";
2399        my @bind = $self->_bindtype($field, @$arg);
2400        return ($sql, @bind);
2401        }
2402      },
2403
2404   ]);
2405
2406
2407 =head1 UNARY OPERATORS
2408
2409   my $sqlmaker = SQL::Abstract->new(unary_ops => [
2410      {
2411       regex => qr/.../,
2412       handler => sub {
2413         my ($self, $op, $arg) = @_;
2414         ...
2415       },
2416      },
2417      {
2418       regex => qr/.../,
2419       handler => 'method_name',
2420      },
2421    ]);
2422
2423 A "unary operator" is a SQL syntactic clause that can be
2424 applied to a field - the operator goes before the field
2425
2426 You can write your own operator handlers - supply a C<unary_ops>
2427 argument to the C<new> method. That argument takes an arrayref of
2428 operator definitions; each operator definition is a hashref with two
2429 entries:
2430
2431 =over
2432
2433 =item regex
2434
2435 the regular expression to match the operator
2436
2437 =item handler
2438
2439 Either a coderef or a plain scalar method name. In both cases
2440 the expected return is C<< $sql >>.
2441
2442 When supplied with a method name, it is simply called on the
2443 L<SQL::Abstract/> object as:
2444
2445  $self->$method_name ($op, $arg)
2446
2447  Where:
2448
2449   $op is the part that matched the handler regex
2450   $arg is the RHS or argument of the operator
2451
2452 When supplied with a coderef, it is called as:
2453
2454  $coderef->($self, $op, $arg)
2455
2456
2457 =back
2458
2459
2460 =head1 PERFORMANCE
2461
2462 Thanks to some benchmarking by Mark Stosberg, it turns out that
2463 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
2464 I must admit this wasn't an intentional design issue, but it's a
2465 byproduct of the fact that you get to control your C<DBI> handles
2466 yourself.
2467
2468 To maximize performance, use a code snippet like the following:
2469
2470     # prepare a statement handle using the first row
2471     # and then reuse it for the rest of the rows
2472     my($sth, $stmt);
2473     for my $href (@array_of_hashrefs) {
2474         $stmt ||= $sql->insert('table', $href);
2475         $sth  ||= $dbh->prepare($stmt);
2476         $sth->execute($sql->values($href));
2477     }
2478
2479 The reason this works is because the keys in your C<$href> are sorted
2480 internally by B<SQL::Abstract>. Thus, as long as your data retains
2481 the same structure, you only have to generate the SQL the first time
2482 around. On subsequent queries, simply use the C<values> function provided
2483 by this module to return your values in the correct order.
2484
2485
2486 =head1 FORMBUILDER
2487
2488 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
2489 really like this part (I do, at least). Building up a complex query
2490 can be as simple as the following:
2491
2492     #!/usr/bin/perl
2493
2494     use CGI::FormBuilder;
2495     use SQL::Abstract;
2496
2497     my $form = CGI::FormBuilder->new(...);
2498     my $sql  = SQL::Abstract->new;
2499
2500     if ($form->submitted) {
2501         my $field = $form->field;
2502         my $id = delete $field->{id};
2503         my($stmt, @bind) = $sql->update('table', $field, {id => $id});
2504     }
2505
2506 Of course, you would still have to connect using C<DBI> to run the
2507 query, but the point is that if you make your form look like your
2508 table, the actual query script can be extremely simplistic.
2509
2510 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
2511 a fast interface to returning and formatting data. I frequently
2512 use these three modules together to write complex database query
2513 apps in under 50 lines.
2514
2515
2516 =head1 CHANGES
2517
2518 Version 1.50 was a major internal refactoring of C<SQL::Abstract>.
2519 Great care has been taken to preserve the I<published> behavior
2520 documented in previous versions in the 1.* family; however,
2521 some features that were previously undocumented, or behaved
2522 differently from the documentation, had to be changed in order
2523 to clarify the semantics. Hence, client code that was relying
2524 on some dark areas of C<SQL::Abstract> v1.*
2525 B<might behave differently> in v1.50.
2526
2527 The main changes are :
2528
2529 =over
2530
2531 =item *
2532
2533 support for literal SQL through the C<< \ [$sql, bind] >> syntax.
2534
2535 =item *
2536
2537 support for the { operator => \"..." } construct (to embed literal SQL)
2538
2539 =item *
2540
2541 support for the { operator => \["...", @bind] } construct (to embed literal SQL with bind values)
2542
2543 =item *
2544
2545 optional support for L<array datatypes|/"Inserting and Updating Arrays">
2546
2547 =item *
2548
2549 defensive programming : check arguments
2550
2551 =item *
2552
2553 fixed bug with global logic, which was previously implemented
2554 through global variables yielding side-effects. Prior versions would
2555 interpret C<< [ {cond1, cond2}, [cond3, cond4] ] >>
2556 as C<< "(cond1 AND cond2) OR (cond3 AND cond4)" >>.
2557 Now this is interpreted
2558 as C<< "(cond1 AND cond2) OR (cond3 OR cond4)" >>.
2559
2560
2561 =item *
2562
2563 fixed semantics of  _bindtype on array args
2564
2565 =item *
2566
2567 dropped the C<_anoncopy> of the %where tree. No longer necessary,
2568 we just avoid shifting arrays within that tree.
2569
2570 =item *
2571
2572 dropped the C<_modlogic> function
2573
2574 =back
2575
2576
2577
2578 =head1 ACKNOWLEDGEMENTS
2579
2580 There are a number of individuals that have really helped out with
2581 this module. Unfortunately, most of them submitted bugs via CPAN
2582 so I have no idea who they are! But the people I do know are:
2583
2584     Ash Berlin (order_by hash term support)
2585     Matt Trout (DBIx::Class support)
2586     Mark Stosberg (benchmarking)
2587     Chas Owens (initial "IN" operator support)
2588     Philip Collins (per-field SQL functions)
2589     Eric Kolve (hashref "AND" support)
2590     Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
2591     Dan Kubb (support for "quote_char" and "name_sep")
2592     Guillermo Roditi (patch to cleanup "IN" and "BETWEEN", fix and tests for _order_by)
2593     Laurent Dami (internal refactoring, multiple -nest, extensible list of special operators, literal SQL)
2594     Norbert Buchmuller (support for literal SQL in hashpair, misc. fixes & tests)
2595     Peter Rabbitson (rewrite of SQLA::Test, misc. fixes & tests)
2596
2597 Thanks!
2598
2599 =head1 SEE ALSO
2600
2601 L<DBIx::Class>, L<DBIx::Abstract>, L<CGI::FormBuilder>, L<HTML::QuickTable>.
2602
2603 =head1 AUTHOR
2604
2605 Copyright (c) 2001-2007 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
2606
2607 This module is actively maintained by Matt Trout <mst@shadowcatsystems.co.uk>
2608
2609 For support, your best bet is to try the C<DBIx::Class> users mailing list.
2610 While not an official support venue, C<DBIx::Class> makes heavy use of
2611 C<SQL::Abstract>, and as such list members there are very familiar with
2612 how to create queries.
2613
2614 =head1 LICENSE
2615
2616 This module is free software; you may copy this under the terms of
2617 the GNU General Public License, or the Artistic License, copies of
2618 which should have accompanied your Perl kit.
2619
2620 =cut
2621