6 SQL::Abstract - Generate SQL from Perl data structures
12 my $sql = SQL::Abstract->new;
14 my($stmt, @bind) = $sql->select($table, \@fields, \%where, \@order);
16 my($stmt, @bind) = $sql->insert($table, \%fieldvals || \@values);
18 my($stmt, @bind) = $sql->update($table, \%fieldvals, \%where);
20 my($stmt, @bind) = $sql->delete($table, \%where);
22 # Then, use these in your DBI statements
23 my $sth = $dbh->prepare($stmt);
26 # Just generate the WHERE clause
27 my($stmt, @bind) = $sql->where(\%where, \@order);
29 # Return values in the same order, for hashed queries
30 # See PERFORMANCE section for more details
31 my @bind = $sql->values(\%fieldvals);
35 This module was inspired by the excellent L<DBIx::Abstract>.
36 However, in using that module I found that what I really wanted
37 to do was generate SQL, but still retain complete control over my
38 statement handles and use the DBI interface. So, I set out to
39 create an abstract SQL generation module.
41 While based on the concepts used by L<DBIx::Abstract>, there are
42 several important differences, especially when it comes to WHERE
43 clauses. I have modified the concepts used to make the SQL easier
44 to generate from Perl data structures and, IMO, more intuitive.
45 The underlying idea is for this module to do what you mean, based
46 on the data structures you provide it. The big advantage is that
47 you don't have to modify your code every time your data changes,
48 as this module figures it out.
50 To begin with, an SQL INSERT is as easy as just specifying a hash
51 of C<key=value> pairs:
54 name => 'Jimbo Bobson',
55 phone => '123-456-7890',
56 address => '42 Sister Lane',
61 The SQL can then be generated with this:
63 my($stmt, @bind) = $sql->insert('people', \%data);
65 Which would give you something like this:
67 $stmt = "INSERT INTO people
68 (address, city, name, phone, state)
69 VALUES (?, ?, ?, ?, ?)";
70 @bind = ('42 Sister Lane', 'St. Louis', 'Jimbo Bobson',
71 '123-456-7890', 'Louisiana');
73 These are then used directly in your DBI code:
75 my $sth = $dbh->prepare($stmt);
78 In addition, you can apply SQL functions to elements of your C<%data>
79 by specifying an arrayref for the given hash value. For example, if
80 you need to execute the Oracle C<to_date> function on a value, you
81 can say something like this:
85 date_entered => ["to_date(?,'MM/DD/YYYY')", "03/02/2003"],
88 The first value in the array is the actual SQL. Any other values are
89 optional and would be included in the bind values array. This gives
92 my($stmt, @bind) = $sql->insert('people', \%data);
94 $stmt = "INSERT INTO people (name, date_entered)
95 VALUES (?, to_date(?,'MM/DD/YYYY'))";
96 @bind = ('Bill', '03/02/2003');
98 An UPDATE is just as easy, all you change is the name of the function:
100 my($stmt, @bind) = $sql->update('people', \%data);
102 Notice that your C<%data> isn't touched; the module will generate
103 the appropriately quirky SQL for you automatically. Usually you'll
104 want to specify a WHERE clause for your UPDATE, though, which is
105 where handling C<%where> hashes comes in handy...
107 This module can generate pretty complicated WHERE statements
108 easily. For example, simple C<key=value> pairs are taken to mean
109 equality, and if you want to see if a field is within a set
110 of values, you can use an arrayref. Let's say we wanted to
111 SELECT some data based on this criteria:
115 worker => ['nwiger', 'rcwe', 'sfz'],
116 status => { '!=', 'completed' }
119 my($stmt, @bind) = $sql->select('tickets', '*', \%where);
121 The above would give you something like this:
123 $stmt = "SELECT * FROM tickets WHERE
124 ( requestor = ? ) AND ( status != ? )
125 AND ( worker = ? OR worker = ? OR worker = ? )";
126 @bind = ('inna', 'completed', 'nwiger', 'rcwe', 'sfz');
128 Which you could then use in DBI code like so:
130 my $sth = $dbh->prepare($stmt);
131 $sth->execute(@bind);
137 The functions are simple. There's one for each major SQL operation,
138 and a constructor you use first. The arguments are specified in a
139 similar order to each function (table, then fields, then a where
140 clause) to try and simplify things.
147 our $VERSION = '1.22';
148 our $REVISION = '$Id$';
151 # Fix SQL case, if so requested
154 return $self->{case} ? $_[0] : uc($_[0]);
157 # Anon copies of arrays/hashes
158 # Based on deep_copy example by merlyn
159 # http://www.stonehenge.com/merlyn/UnixReview/col30.html
162 return (ref $orig eq 'HASH') ? +{map { $_ => _anoncopy($orig->{$_}) } keys %$orig}
163 : (ref $orig eq 'ARRAY') ? [map _anoncopy($_), @$orig]
169 return unless $_[0]->{debug}; shift; # a little faster
170 my $func = (caller(1))[3];
171 warn "[$func] ", @_, "\n";
175 my($func) = (caller(1))[3];
176 carp "[$func] Warning: ", @_;
180 my($func) = (caller(1))[3];
181 croak "[$func] Fatal: ", @_;
188 if (ref $tab eq 'ARRAY') {
189 return join ', ', map { $self->_quote($_) } @$tab;
191 return $self->_quote($tab);
202 return $self->{quote_char} . $label . $self->{quote_char}
203 if !defined $self->{name_sep};
205 return join $self->{name_sep},
206 map { $self->{quote_char} . $_ . $self->{quote_char} }
207 split /\Q$self->{name_sep}\E/, $label;
210 # Conversion, if applicable
213 return @_ unless $self->{convert};
214 my $conv = $self->_sqlcase($self->{convert});
215 my @ret = map { $conv.'('.$_.')' } @_;
216 return wantarray ? @ret : $ret[0];
223 return $self->{bindtype} eq 'columns' ? [ @_ ] : @val;
226 # Modified -logic or -nest
229 my $sym = @_ ? lc(shift) : $self->{logic};
231 $sym = $self->{logic} if $sym eq 'nest';
232 return $self->_sqlcase($sym); # override join
235 =head2 new(option => 'value')
237 The C<new()> function takes a list of options and values, and returns
238 a new B<SQL::Abstract> object which can then be used to generate SQL
239 through the methods below. The options accepted are:
245 If set to 'lower', then SQL will be generated in all lowercase. By
246 default SQL is generated in "textbook" case meaning something like:
248 SELECT a_field FROM a_table WHERE some_field LIKE '%someval%'
252 This determines what the default comparison operator is. By default
253 it is C<=>, meaning that a hash like this:
255 %where = (name => 'nwiger', email => 'nate@wiger.org');
257 Will generate SQL like this:
259 WHERE name = 'nwiger' AND email = 'nate@wiger.org'
261 However, you may want loose comparisons by default, so if you set
262 C<cmp> to C<like> you would get SQL such as:
264 WHERE name like 'nwiger' AND email like 'nate@wiger.org'
266 You can also override the comparsion on an individual basis - see
267 the huge section on L</"WHERE CLAUSES"> at the bottom.
271 This determines the default logical operator for multiple WHERE
272 statements in arrays. By default it is "or", meaning that a WHERE
276 event_date => {'>=', '2/13/99'},
277 event_date => {'<=', '4/24/03'},
280 Will generate SQL like this:
282 WHERE event_date >= '2/13/99' OR event_date <= '4/24/03'
284 This is probably not what you want given this query, though (look
285 at the dates). To change the "OR" to an "AND", simply specify:
287 my $sql = SQL::Abstract->new(logic => 'and');
289 Which will change the above C<WHERE> to:
291 WHERE event_date >= '2/13/99' AND event_date <= '4/24/03'
295 This will automatically convert comparisons using the specified SQL
296 function for both column and value. This is mostly used with an argument
297 of C<upper> or C<lower>, so that the SQL will have the effect of
298 case-insensitive "searches". For example, this:
300 $sql = SQL::Abstract->new(convert => 'upper');
301 %where = (keywords => 'MaKe iT CAse inSeNSItive');
303 Will turn out the following SQL:
305 WHERE upper(keywords) like upper('MaKe iT CAse inSeNSItive')
307 The conversion can be C<upper()>, C<lower()>, or any other SQL function
308 that can be applied symmetrically to fields (actually B<SQL::Abstract> does
309 not validate this option; it will just pass through what you specify verbatim).
313 This is a kludge because many databases suck. For example, you can't
314 just bind values using DBI's C<execute()> for Oracle C<CLOB> or C<BLOB> fields.
315 Instead, you have to use C<bind_param()>:
317 $sth->bind_param(1, 'reg data');
318 $sth->bind_param(2, $lots, {ora_type => ORA_CLOB});
320 The problem is, B<SQL::Abstract> will normally just return a C<@bind> array,
321 which loses track of which field each slot refers to. Fear not.
323 If you specify C<bindtype> in new, you can determine how C<@bind> is returned.
324 Currently, you can specify either C<normal> (default) or C<columns>. If you
325 specify C<columns>, you will get an array that looks like this:
327 my $sql = SQL::Abstract->new(bindtype => 'columns');
328 my($stmt, @bind) = $sql->insert(...);
331 [ 'column1', 'value1' ],
332 [ 'column2', 'value2' ],
333 [ 'column3', 'value3' ],
336 You can then iterate through this manually, using DBI's C<bind_param()>.
338 $sth->prepare($stmt);
341 my($col, $data) = @$_;
342 if ($col eq 'details' || $col eq 'comments') {
343 $sth->bind_param($i, $data, {ora_type => ORA_CLOB});
344 } elsif ($col eq 'image') {
345 $sth->bind_param($i, $data, {ora_type => ORA_BLOB});
347 $sth->bind_param($i, $data);
351 $sth->execute; # execute without @bind now
353 Now, why would you still use B<SQL::Abstract> if you have to do this crap?
354 Basically, the advantage is still that you don't have to care which fields
355 are or are not included. You could wrap that above C<for> loop in a simple
356 sub called C<bind_fields()> or something and reuse it repeatedly. You still
357 get a layer of abstraction over manual SQL specification.
361 This is the character that a table or column name will be quoted
362 with. By default this is an empty string, but you could set it to
363 the character C<`>, to generate SQL like this:
365 SELECT `a_field` FROM `a_table` WHERE `some_field` LIKE '%someval%'
367 This is useful if you have tables or columns that are reserved words
368 in your database's SQL dialect.
372 This is the character that separates a table and column name. It is
373 necessary to specify this when the C<quote_char> option is selected,
374 so that tables and column names can be individually quoted like this:
376 SELECT `table`.`one_field` FROM `table` WHERE `table`.`other_field` = 1
384 my $class = ref($self) || $self;
385 my %opt = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
387 # choose our case by keeping an option around
388 delete $opt{case} if $opt{case} && $opt{case} ne 'lower';
390 # override logical operator
391 $opt{logic} = uc $opt{logic} if $opt{logic};
393 # how to return bind vars
394 $opt{bindtype} ||= delete($opt{bind_type}) || 'normal';
396 # default comparison is "=", but can be overridden
399 # default quotation character around tables/columns
400 $opt{quote_char} ||= '';
402 return bless \%opt, $class;
405 =head2 insert($table, \@values || \%fieldvals)
407 This is the simplest function. You simply give it a table name
408 and either an arrayref of values or hashref of field/value pairs.
409 It returns an SQL INSERT statement and a list of bind values.
415 my $table = $self->_table(shift);
416 my $data = shift || return;
418 my $sql = $self->_sqlcase('insert into') . " $table ";
419 my(@sqlf, @sqlv, @sqlq) = ();
422 if ($ref eq 'HASH') {
423 for my $k (sort keys %$data) {
426 # named fields, so must save names in order
427 push @sqlf, $self->_quote($k);
429 # SQL included for values
431 push @sqlq, shift @val;
432 push @sqlv, $self->_bindtype($k, @val);
433 } elsif ($r eq 'SCALAR') {
434 # embedded literal SQL
438 push @sqlv, $self->_bindtype($k, $v);
441 $sql .= '(' . join(', ', @sqlf) .') '. $self->_sqlcase('values') . ' ('. join(', ', @sqlq) .')';
442 } elsif ($ref eq 'ARRAY') {
443 # just generate values(?,?) part
444 # no names (arrayref) so can't generate bindtype
445 carp "Warning: ",__PACKAGE__,"->insert called with arrayref when bindtype set"
446 if $self->{bindtype} ne 'normal';
451 push @sqlq, shift @val;
453 } elsif ($r eq 'SCALAR') {
454 # embedded literal SQL
461 $sql .= $self->_sqlcase('values') . ' ('. join(', ', @sqlq) .')';
462 } elsif ($ref eq 'SCALAR') {
466 puke "Unsupported data type specified to \$sql->insert";
469 return wantarray ? ($sql, @sqlv) : $sql;
472 =head2 update($table, \%fieldvals, \%where)
474 This takes a table, hashref of field/value pairs, and an optional
475 hashref WHERE clause. It returns an SQL UPDATE function and a list
482 my $table = $self->_table(shift);
483 my $data = shift || return;
486 my $sql = $self->_sqlcase('update') . " $table " . $self->_sqlcase('set ');
487 my(@sqlf, @sqlv) = ();
489 puke "Unsupported data type specified to \$sql->update"
490 unless ref $data eq 'HASH';
492 for my $k (sort keys %$data) {
495 my $label = $self->_quote($k);
497 # SQL included for values
499 my $sql = shift @bind;
500 push @sqlf, "$label = $sql";
501 push @sqlv, $self->_bindtype($k, @bind);
502 } elsif ($r eq 'SCALAR') {
503 # embedded literal SQL
504 push @sqlf, "$label = $$v";
506 push @sqlf, "$label = ?";
507 push @sqlv, $self->_bindtype($k, $v);
511 $sql .= join ', ', @sqlf;
514 my($wsql, @wval) = $self->where($where);
519 return wantarray ? ($sql, @sqlv) : $sql;
522 =head2 select($table, \@fields, \%where, \@order)
524 This takes a table, arrayref of fields (or '*'), optional hashref
525 WHERE clause, and optional arrayref order by, and returns the
526 corresponding SQL SELECT statement and list of bind values.
532 my $table = $self->_table(shift);
533 my $fields = shift || '*';
537 my $f = (ref $fields eq 'ARRAY') ? join ', ', map { $self->_quote($_) } @$fields : $fields;
538 my $sql = join ' ', $self->_sqlcase('select'), $f, $self->_sqlcase('from'), $table;
540 my(@sqlf, @sqlv) = ();
541 my($wsql, @wval) = $self->where($where, $order);
545 return wantarray ? ($sql, @sqlv) : $sql;
548 =head2 delete($table, \%where)
550 This takes a table name and optional hashref WHERE clause.
551 It returns an SQL DELETE statement and list of bind values.
557 my $table = $self->_table(shift);
560 my $sql = $self->_sqlcase('delete from') . " $table";
561 my(@sqlf, @sqlv) = ();
564 my($wsql, @wval) = $self->where($where);
569 return wantarray ? ($sql, @sqlv) : $sql;
572 =head2 where(\%where, \@order)
574 This is used to generate just the WHERE clause. For example,
575 if you have an arbitrary data structure and know what the
576 rest of your SQL is going to look like, but want an easy way
577 to produce a WHERE clause, use this. It returns an SQL WHERE
578 clause and list of bind values.
582 # Finally, a separate routine just to handle WHERE clauses
588 # Need a separate routine to properly wrap w/ "where"
590 my @ret = $self->_recurse_where($where);
593 $sql .= $self->_sqlcase(' where ') . $wh if $wh;
598 $sql .= $self->_order_by($order);
601 return wantarray ? ($sql, @ret) : $sql;
606 local $^W = 0; # really, you've gotta be fucking kidding me
608 my $where = _anoncopy(shift); # prevent destroying original
609 my $ref = ref $where || '';
610 my $join = shift || $self->{logic} ||
611 ($ref eq 'ARRAY' ? $self->_sqlcase('or') : $self->_sqlcase('and'));
613 # For assembling SQL fields and values
614 my(@sqlf, @sqlv) = ();
616 # If an arrayref, then we join each element
617 if ($ref eq 'ARRAY') {
618 # need to use while() so can shift() for arrays
620 while (my $el = shift @$where) {
622 # skip empty elements, otherwise get invalid trailing AND stuff
623 if (my $ref2 = ref $el) {
624 if ($ref2 eq 'ARRAY') {
626 } elsif ($ref2 eq 'HASH') {
628 $subjoin ||= $self->_sqlcase('and');
629 } elsif ($ref2 eq 'SCALAR') {
634 $self->_debug("$ref2(*top) means join with $subjoin");
636 # top-level arrayref with scalars, recurse in pairs
637 $self->_debug("NOREF(*top) means join with $subjoin");
638 $el = {$el => shift(@$where)};
640 my @ret = $self->_recurse_where($el, $subjoin);
641 push @sqlf, shift @ret;
645 elsif ($ref eq 'HASH') {
646 # Note: during recursion, the last element will always be a hashref,
647 # since it needs to point a column => value. So this be the end.
648 for my $k (sort keys %$where) {
649 my $v = $where->{$k};
650 my $label = $self->_quote($k);
652 if ($k =~ /^-(\D+)/) {
653 # special nesting, like -and, -or, -nest, so shift over
654 my $subjoin = $self->_modlogic($1);
655 $self->_debug("OP(-$1) means special logic ($subjoin), recursing...");
656 my @ret = $self->_recurse_where($v, $subjoin);
657 push @sqlf, shift @ret;
659 } elsif (! defined($v)) {
661 $self->_debug("UNDEF($k) means IS NULL");
662 push @sqlf, $label . $self->_sqlcase(' is null');
663 } elsif (ref $v eq 'ARRAY') {
666 # multiple elements: multiple options
667 $self->_debug("ARRAY($k) means multiple elements: [ @v ]");
669 # special nesting, like -and, -or, -nest, so shift over
670 my $subjoin = $self->_sqlcase('or');
671 if ($v[0] =~ /^-(\D+)/) {
672 $subjoin = $self->_modlogic($1); # override subjoin
673 $self->_debug("OP(-$1) means special logic ($subjoin), shifting...");
677 # map into an array of hashrefs and recurse
678 my @ret = $self->_recurse_where([map { {$k => $_} } @v], $subjoin);
680 # push results into our structure
681 push @sqlf, shift @ret;
683 } elsif (ref $v eq 'HASH') {
684 # modified operator { '!=', 'completed' }
685 for my $f (sort keys %$v) {
688 # do the right thing for single -in values
689 $x = [$x] if ($f =~ /^-?\s*(not[\s_]+)?in\s*$/i && ref $x ne 'ARRAY');
691 $self->_debug("HASH($k) means modified operator: { $f }");
693 # check for the operator being "IN" or "BETWEEN" or whatever
694 if (ref $x eq 'ARRAY') {
695 if ($f =~ /^-?\s*(not[\s_]+)?(in|between)\s*$/i) {
696 my $u = $self->_modlogic($1 . $2);
697 $self->_debug("HASH($f => $x) uses special operator: [ $u ]");
698 if ($u =~ /between/i) {
700 # Throw an exception if you try to use between with
701 # anything other than 2 values
702 $self->puke("You need two values to use between") unless @$x == 2;
703 push @sqlf, join ' ', $self->_convert($label), $u, $self->_convert('?'),
704 $self->_sqlcase('and'), $self->_convert('?');
706 # DWIM for empty arrayrefs
707 push @sqlf, join ' ', $self->_convert($label), $u, '(',
708 join(', ', map { $self->_convert('?') } @$x),
711 # Empty IN defaults to 0=1 and empty NOT IN to 1=1
712 push(@sqlf, ($u =~ /not/i ? "1=1" : "0=1"));
714 push @sqlv, $self->_bindtype($k, @$x);
716 # multiple elements: multiple options
717 $self->_debug("ARRAY($x) means multiple elements: [ @$x ]");
719 # map into an array of hashrefs and recurse
720 my @ret = $self->_recurse_where([map { {$k => {$f, $_}} } @$x]);
722 # push results into our structure
723 push @sqlf, shift @ret;
726 } elsif (! defined($x)) {
728 my $not = ($f eq '!=' || $f eq 'not like') ? ' not' : '';
729 push @sqlf, $label . $self->_sqlcase(" is$not null");
732 $f =~ s/^-//; # strip leading -like =>
733 $f =~ s/_/ /; # _ => " "
734 push @sqlf, join ' ', $self->_convert($label), $self->_sqlcase($f), $self->_convert('?');
735 push @sqlv, $self->_bindtype($k, $x);
738 } elsif (ref $v eq 'SCALAR') {
740 $self->_debug("SCALAR($k) means literal SQL: $$v");
741 push @sqlf, "$label $$v";
743 # standard key => val
744 $self->_debug("NOREF($k) means simple key=val: $k $self->{cmp} $v");
745 push @sqlf, join ' ', $self->_convert($label), $self->_sqlcase($self->{cmp}), $self->_convert('?');
746 push @sqlv, $self->_bindtype($k, $v);
750 elsif ($ref eq 'SCALAR') {
752 $self->_debug("SCALAR(*top) means literal SQL: $$where");
755 elsif (defined $where) {
757 $self->_debug("NOREF(*top) means literal SQL: $where");
761 # assemble and return sql
762 my $wsql = @sqlf ? '( ' . join(" $join ", @sqlf) . ' )' : '';
763 return wantarray ? ($wsql, @sqlv) : $wsql;
770 my @vals = $ref eq 'ARRAY' ? @{$_[0]} :
771 $ref eq 'SCALAR' ? ${$_[0]} :
773 puke "Unsupported data struct $ref for ORDER BY";
775 my $val = join ', ', map { $self->_quote($_) } @vals;
776 return $val ? $self->_sqlcase(' order by')." $val" : '';
779 =head2 values(\%data)
781 This just returns the values from the hash C<%data>, in the same
782 order that would be returned from any of the other above queries.
783 Using this allows you to markedly speed up your queries if you
784 are affecting lots of rows. See below under the L</"PERFORMANCE"> section.
790 my $data = shift || return;
791 puke "Argument to ", __PACKAGE__, "->values must be a \\%hash"
792 unless ref $data eq 'HASH';
793 return map { $self->_bindtype($_, $data->{$_}) } sort keys %$data;
796 =head2 generate($any, 'number', $of, \@data, $struct, \%types)
798 Warning: This is an experimental method and subject to change.
800 This returns arbitrarily generated SQL. It's a really basic shortcut.
801 It will return two different things, depending on return context:
803 my($stmt, @bind) = $sql->generate('create table', \$table, \@fields);
804 my $stmt_and_val = $sql->generate('create table', \$table, \@fields);
806 These would return the following:
809 $stmt = "CREATE TABLE test (?, ?)";
810 @bind = (field1, field2);
812 # Second calling form
813 $stmt_and_val = "CREATE TABLE test (field1, field2)";
815 Depending on what you're trying to do, it's up to you to choose the correct
816 format. In this example, the second form is what you would want.
820 $sql->generate('alter session', { nls_date_format => 'MM/YY' });
824 ALTER SESSION SET nls_date_format = 'MM/YY'
826 You get the idea. Strings get their case twiddled, but everything
827 else remains verbatim.
834 my(@sql, @sqlq, @sqlv);
838 if ($ref eq 'HASH') {
839 for my $k (sort keys %$_) {
842 my $label = $self->_quote($k);
844 # SQL included for values
846 my $sql = shift @bind;
847 push @sqlq, "$label = $sql";
848 push @sqlv, $self->_bindtype($k, @bind);
849 } elsif ($r eq 'SCALAR') {
850 # embedded literal SQL
851 push @sqlq, "$label = $$v";
853 push @sqlq, "$label = ?";
854 push @sqlv, $self->_bindtype($k, $v);
857 push @sql, $self->_sqlcase('set'), join ', ', @sqlq;
858 } elsif ($ref eq 'ARRAY') {
859 # unlike insert(), assume these are ONLY the column names, i.e. for SQL
864 push @sqlq, shift @val;
866 } elsif ($r eq 'SCALAR') {
867 # embedded literal SQL
874 push @sql, '(' . join(', ', @sqlq) . ')';
875 } elsif ($ref eq 'SCALAR') {
879 # strings get case twiddled
880 push @sql, $self->_sqlcase($_);
884 my $sql = join ' ', @sql;
886 # this is pretty tricky
887 # if ask for an array, return ($stmt, @bind)
888 # otherwise, s/?/shift @sqlv/ to put it inline
890 return ($sql, @sqlv);
892 1 while $sql =~ s/\?/my $d = shift(@sqlv);
893 ref $d ? $d->[1] : $d/e;
900 # This allows us to check for a local, then _form, attr
902 my($name) = $AUTOLOAD =~ /.*::(.+)/;
903 return $self->generate($name, @_);
912 This module uses a variation on the idea from L<DBIx::Abstract>. It
913 is B<NOT>, repeat I<not> 100% compatible. B<The main logic of this
914 module is that things in arrays are OR'ed, and things in hashes
917 The easiest way to explain is to show lots of examples. After
918 each C<%where> hash shown, it is assumed you used:
920 my($stmt, @bind) = $sql->where(\%where);
922 However, note that the C<%where> hash can be used directly in any
923 of the other functions as well, as described above.
925 So, let's get started. To begin, a simple hash:
929 status => 'completed'
932 Is converted to SQL C<key = val> statements:
934 $stmt = "WHERE user = ? AND status = ?";
935 @bind = ('nwiger', 'completed');
937 One common thing I end up doing is having a list of values that
938 a field can be in. To do this, simply specify a list inside of
943 status => ['assigned', 'in-progress', 'pending'];
946 This simple code will create the following:
948 $stmt = "WHERE user = ? AND ( status = ? OR status = ? OR status = ? )";
949 @bind = ('nwiger', 'assigned', 'in-progress', 'pending');
951 If you want to specify a different type of operator for your comparison,
952 you can use a hashref for a given column:
956 status => { '!=', 'completed' }
959 Which would generate:
961 $stmt = "WHERE user = ? AND status != ?";
962 @bind = ('nwiger', 'completed');
964 To test against multiple values, just enclose the values in an arrayref:
966 status => { '!=', ['assigned', 'in-progress', 'pending'] };
968 Which would give you:
970 "WHERE status != ? OR status != ? OR status != ?"
972 But, this is probably not what you want in this case (look at it). So
973 the hashref can also contain multiple pairs, in which case it is expanded
974 into an C<AND> of its elements:
978 status => { '!=', 'completed', -not_like => 'pending%' }
981 # Or more dynamically, like from a form
982 $where{user} = 'nwiger';
983 $where{status}{'!='} = 'completed';
984 $where{status}{'-not_like'} = 'pending%';
987 $stmt = "WHERE user = ? AND status != ? AND status NOT LIKE ?";
988 @bind = ('nwiger', 'completed', 'pending%');
990 To get an OR instead, you can combine it with the arrayref idea:
994 priority => [ {'=', 2}, {'!=', 1} ]
997 Which would generate:
999 $stmt = "WHERE user = ? AND priority = ? OR priority != ?";
1000 @bind = ('nwiger', '2', '1');
1002 However, there is a subtle trap if you want to say something like
1003 this (notice the C<AND>):
1005 WHERE priority != ? AND priority != ?
1007 Because, in Perl you I<can't> do this:
1009 priority => { '!=', 2, '!=', 1 }
1011 As the second C<!=> key will obliterate the first. The solution
1012 is to use the special C<-modifier> form inside an arrayref:
1014 priority => [ -and => {'!=', 2}, {'!=', 1} ]
1016 Normally, these would be joined by C<OR>, but the modifier tells it
1017 to use C<AND> instead. (Hint: You can use this in conjunction with the
1018 C<logic> option to C<new()> in order to change the way your queries
1019 work by default.) B<Important:> Note that the C<-modifier> goes
1020 B<INSIDE> the arrayref, as an extra first element. This will
1021 B<NOT> do what you think it might:
1023 priority => -and => [{'!=', 2}, {'!=', 1}] # WRONG!
1025 Here is a quick list of equivalencies, since there is some overlap:
1028 status => {'!=', 'completed', 'not like', 'pending%' }
1029 status => [ -and => {'!=', 'completed'}, {'not like', 'pending%'}]
1032 status => {'=', ['assigned', 'in-progress']}
1033 status => [ -or => {'=', 'assigned'}, {'=', 'in-progress'}]
1034 status => [ {'=', 'assigned'}, {'=', 'in-progress'} ]
1036 In addition to C<-and> and C<-or>, there is also a special C<-nest>
1037 operator which adds an additional set of parens, to create a subquery.
1038 For example, to get something like this:
1040 $stmt = WHERE user = ? AND ( workhrs > ? OR geo = ? )
1041 @bind = ('nwiger', '20', 'ASIA');
1047 -nest => [ workhrs => {'>', 20}, geo => 'ASIA' ],
1050 You can also use the hashref format to compare a list of fields using the
1051 C<IN> comparison operator, by specifying the list as an arrayref:
1054 status => 'completed',
1055 reportid => { -in => [567, 2335, 2] }
1058 Which would generate:
1060 $stmt = "WHERE status = ? AND reportid IN (?,?,?)";
1061 @bind = ('completed', '567', '2335', '2');
1063 You can use this same format to use other grouping functions, such
1064 as C<BETWEEN>, C<SOME>, and so forth. For example:
1068 completion_date => {
1069 -not_between => ['2002-10-01', '2003-02-06']
1075 WHERE user = ? AND completion_date NOT BETWEEN ( ? AND ? )
1077 So far, we've seen how multiple conditions are joined with a top-level
1078 C<AND>. We can change this by putting the different conditions we want in
1079 hashes and then putting those hashes in an array. For example:
1084 status => { -like => ['pending%', 'dispatched'] },
1088 status => 'unassigned',
1092 This data structure would create the following:
1094 $stmt = "WHERE ( user = ? AND ( status LIKE ? OR status LIKE ? ) )
1095 OR ( user = ? AND status = ? ) )";
1096 @bind = ('nwiger', 'pending', 'dispatched', 'robot', 'unassigned');
1098 This can be combined with the C<-nest> operator to properly group
1105 -and => [workhrs => {'>', 20}, geo => 'ASIA' ],
1106 -and => [workhrs => {'<', 50}, geo => 'EURO' ]
1113 WHERE ( user = ? AND
1114 ( ( workhrs > ? AND geo = ? )
1115 OR ( workhrs < ? AND geo = ? ) ) )
1117 Finally, sometimes only literal SQL will do. If you want to include
1118 literal SQL verbatim, you can specify it as a scalar reference, namely:
1120 my $inn = 'is Not Null';
1122 priority => { '<', 2 },
1128 $stmt = "WHERE priority < ? AND requestor is Not Null";
1131 Note that in this example, you only get one bind parameter back, since
1132 the verbatim SQL is passed as part of the statement.
1134 Of course, just to prove a point, the above can also be accomplished
1138 priority => { '<', 2 },
1139 requestor => { '!=', undef },
1144 These pages could go on for a while, since the nesting of the data
1145 structures this module can handle are pretty much unlimited (the
1146 module implements the C<WHERE> expansion as a recursive function
1147 internally). Your best bet is to "play around" with the module a
1148 little to see how the data structures behave, and choose the best
1149 format for your data based on that.
1151 And of course, all the values above will probably be replaced with
1152 variables gotten from forms or the command line. After all, if you
1153 knew everything ahead of time, you wouldn't have to worry about
1154 dynamically-generating SQL and could just hardwire it into your
1159 Thanks to some benchmarking by Mark Stosberg, it turns out that
1160 this module is many orders of magnitude faster than using C<DBIx::Abstract>.
1161 I must admit this wasn't an intentional design issue, but it's a
1162 byproduct of the fact that you get to control your C<DBI> handles
1165 To maximize performance, use a code snippet like the following:
1167 # prepare a statement handle using the first row
1168 # and then reuse it for the rest of the rows
1170 for my $href (@array_of_hashrefs) {
1171 $stmt ||= $sql->insert('table', $href);
1172 $sth ||= $dbh->prepare($stmt);
1173 $sth->execute($sql->values($href));
1176 The reason this works is because the keys in your C<$href> are sorted
1177 internally by B<SQL::Abstract>. Thus, as long as your data retains
1178 the same structure, you only have to generate the SQL the first time
1179 around. On subsequent queries, simply use the C<values> function provided
1180 by this module to return your values in the correct order.
1184 If you use my C<CGI::FormBuilder> module at all, you'll hopefully
1185 really like this part (I do, at least). Building up a complex query
1186 can be as simple as the following:
1190 use CGI::FormBuilder;
1193 my $form = CGI::FormBuilder->new(...);
1194 my $sql = SQL::Abstract->new;
1196 if ($form->submitted) {
1197 my $field = $form->field;
1198 my $id = delete $field->{id};
1199 my($stmt, @bind) = $sql->update('table', $field, {id => $id});
1202 Of course, you would still have to connect using C<DBI> to run the
1203 query, but the point is that if you make your form look like your
1204 table, the actual query script can be extremely simplistic.
1206 If you're B<REALLY> lazy (I am), check out C<HTML::QuickTable> for
1207 a fast interface to returning and formatting data. I frequently
1208 use these three modules together to write complex database query
1209 apps in under 50 lines.
1213 There is not (yet) any explicit support for SQL compound logic
1214 statements like "AND NOT". Instead, just do the de Morgan's
1215 law transformations yourself. For example, this:
1217 "lname LIKE '%son%' AND NOT ( age < 10 OR age > 20 )"
1221 "lname LIKE '%son%' AND ( age >= 10 AND age <= 20 )"
1223 With the corresponding C<%where> hash:
1226 lname => {like => '%son%'},
1227 age => [-and => {'>=', 10}, {'<=', 20}],
1230 Again, remember that the C<-and> goes I<inside> the arrayref.
1232 =head1 ACKNOWLEDGEMENTS
1234 There are a number of individuals that have really helped out with
1235 this module. Unfortunately, most of them submitted bugs via CPAN
1236 so I have no idea who they are! But the people I do know are:
1238 Mark Stosberg (benchmarking)
1239 Chas Owens (initial "IN" operator support)
1240 Philip Collins (per-field SQL functions)
1241 Eric Kolve (hashref "AND" support)
1242 Mike Fragassi (enhancements to "BETWEEN" and "LIKE")
1243 Dan Kubb (support for "quote_char" and "name_sep")
1244 Matt Trout (DBIx::Class support)
1250 If found, please DO NOT submit anything via C<rt.cpan.org> - that
1251 just causes me a ton of work. Email me a patch (or script demonstrating
1252 the problem) to the below address, and include the VERSION you're using.
1256 L<DBIx::Abstract>, L<DBI|DBI>, L<CGI::FormBuilder>, L<HTML::QuickTable>
1260 Copyright (c) 2001-2006 Nathan Wiger <nwiger@cpan.org>. All Rights Reserved.
1262 For support, your best bet is to try the C<DBIx::Class> users mailing list.
1263 While not an official support venue, C<DBIx::Class> makes heavy use of
1264 C<SQL::Abstract>, and as such list members there are very familiar with
1265 how to create queries.
1267 This module is free software; you may copy this under the terms of
1268 the GNU General Public License, or the Artistic License, copies of
1269 which should have accompanied your Perl kit.