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