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