1 package SQL::Abstract::Clauses;
5 use if $] < '5.010', 'MRO::Compat';
7 use base 'SQL::Abstract';
9 BEGIN { *puke = \&SQL::Abstract::puke }
12 shift->next::method(@_)->register_defaults
15 sub register_defaults {
17 $self->{clauses_of}{select} = [ qw(select from where order_by) ];
18 $self->{expand}{select} = sub { shift->_expand_statement(@_) };
19 $self->{render}{select} = sub { shift->_render_statement(@_) };
20 $self->{expand_clause}{"select.$_"} = "_expand_select_clause_$_"
21 for @{$self->{clauses_of}{select}};
22 $self->{clauses_of}{update} = [ qw(target set where returning) ];
23 $self->{expand}{update} = sub { shift->_expand_statement(@_) };
24 $self->{render}{update} = sub { shift->_render_statement(@_) };
25 $self->{expand_clause}{"update.$_"} = "_expand_update_clause_$_"
26 for @{$self->{clauses_of}{update}};
27 $self->{expand_clause}{'update.update'} = '_expand_update_clause_target';
28 $self->{render_clause}{'update.target'} = sub {
29 my ($self, undef, $target) = @_;
30 $self->join_query_parts(' ', $self->format_keyword('update'), $target);
32 $self->{clauses_of}{delete} = [ qw(target where returning) ];
33 $self->{expand}{delete} = sub { shift->_expand_statement(@_) };
34 $self->{render}{delete} = sub { shift->_render_statement(@_) };
35 $self->{expand_clause}{"delete.$_"} = "_expand_delete_clause_$_"
36 for @{$self->{clauses_of}{delete}};
37 $self->{expand_clause}{"delete.from"} = '_expand_delete_clause_target';
38 $self->{render_clause}{'delete.target'} = sub {
39 my ($self, undef, $from) = @_;
40 $self->join_query_parts(' ', $self->format_keyword('delete from'), $from);
42 $self->{clauses_of}{insert} = [
43 'target', 'fields', 'from', 'returning'
45 $self->{expand}{insert} = sub { shift->_expand_statement(@_) };
46 $self->{render}{insert} = sub { shift->_render_statement(@_) };
47 $self->{expand_clause}{"insert.$_"} = "_expand_insert_clause_$_"
48 for @{$self->{clauses_of}{insert}};
49 $self->{expand_clause}{'insert.into'} = '_expand_insert_clause_target';
50 $self->{expand_clause}{'insert.values'} = '_expand_insert_clause_from';
51 $self->{render_clause}{'insert.fields'} = sub {
52 return $_[0]->render_aqt($_[2]);
54 $self->{render_clause}{'insert.target'} = sub {
55 my ($self, undef, $from) = @_;
56 $self->join_query_parts(' ', $self->format_keyword('insert into'), $from);
58 $self->{render_clause}{'insert.from'} = sub {
59 return $_[0]->render_aqt($_[2], 1);
61 $self->{expand}{values} = '_expand_values';
62 $self->{render}{values} = '_render_values';
63 $self->{expand}{exists} = sub {
64 $_[0]->_expand_op(undef, [ exists => $_[2] ]);
69 sub _expand_select_clause_select {
70 my ($self, undef, $select) = @_;
71 +(select => $self->_expand_maybe_list_expr($select, -ident));
74 sub _expand_select_clause_from {
75 my ($self, undef, $from) = @_;
76 +(from => $self->_expand_maybe_list_expr($from, -ident));
79 sub _expand_select_clause_where {
80 my ($self, undef, $where) = @_;
83 if (my $conv = $self->{convert}) {
95 ->wrap_expanders(map +($_ => $_wrap), qw(ident value bind))
96 ->wrap_op_expanders(map +($_ => $_wrap), qw(ident value bind))
97 ->wrap_expander(func => sub {
100 my ($self, $type, $thing) = @_;
101 if (ref($thing) eq 'ARRAY' and $thing->[0] eq $conv
102 and @$thing == 2 and ref($thing->[1]) eq 'HASH'
105 or $thing->[1]{-value}
106 or $thing->[1]{-bind})
108 return { -func => $thing }; # already went through our expander
110 return $self->$orig($type, $thing);
118 return +(where => $sqla->expand_expr($where));
121 sub _expand_select_clause_order_by {
122 my ($self, undef, $order_by) = @_;
123 +(order_by => $self->_expand_order_by($order_by));
126 sub _expand_update_clause_target {
127 my ($self, undef, $target) = @_;
128 +(target => $self->_expand_maybe_list_expr($target, -ident));
131 sub _expand_update_clause_set {
132 return $_[2] if ref($_[2]) eq 'HASH' and ($_[2]->{-op}||[''])->[0] eq ',';
133 +(set => $_[0]->_expand_update_set_values($_[1], $_[2]));
136 sub _expand_update_clause_where {
137 +(where => $_[0]->expand_expr($_[2]));
140 sub _expand_update_clause_returning {
141 +(returning => $_[0]->_expand_maybe_list_expr($_[2], -ident));
144 sub _expand_delete_clause_target {
145 +(target => $_[0]->_expand_maybe_list_expr($_[2], -ident));
148 sub _expand_delete_clause_where { +(where => $_[0]->expand_expr($_[2])); }
150 sub _expand_delete_clause_returning {
151 +(returning => $_[0]->_expand_maybe_list_expr($_[2], -ident));
154 sub _expand_statement {
155 my ($self, $type, $args) = @_;
156 my $ec = $self->{expand_clause};
159 $args->{$type} = delete $args->{_}
161 return +{ "-${type}" => +{
163 my $val = $args->{$_};
164 if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
165 if ((my (@exp) = $self->$exp($_ => $val)) == 1) {
171 ($_ => $self->expand_expr($val))
177 sub _render_statement {
178 my ($self, $type, $args) = @_;
180 foreach my $clause (@{$self->{clauses_of}{$type}}) {
181 next unless my $clause_expr = $args->{$clause};
183 if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
184 $self->$rdr($clause, $clause_expr);
186 $self->join_query_parts(' ',
187 $self->format_keyword($clause),
188 $self->render_aqt($clause_expr, 1)
194 my $q = $self->join_query_parts(' ', @parts);
195 return $self->join_query_parts('',
196 (our $Render_Top_Level ? $q : ('(', $q, ')'))
201 my ($self, $aqt, $top_level) = @_;
202 local our $Render_Top_Level = $top_level;
203 return $self->next::method($aqt);
206 sub render_statement {
207 my ($self, $expr, $default_scalar_to) = @_;
209 $self->expand_expr($expr, $default_scalar_to), 1
214 my ($self, @args) = @_;
217 if (ref(my $sel = $args[0]) eq 'HASH') {
221 @clauses{qw(from select where order_by)} = @args;
223 # This oddity is to literalify since historically SQLA doesn't quote
224 # a single identifier argument, so we convert it into a literal
226 $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
227 unless ref($clauses{select});
232 my $rendered = $self->render_statement({ -select => $stmt });
233 return wantarray ? @$rendered : $rendered->[0];
237 my ($self, $table, $set, $where, $options) = @_;
240 if (ref($table) eq 'HASH') {
244 @clauses{qw(target set where)} = ($table, $set, $where);
245 puke "Unsupported data type specified to \$sql->update"
246 unless ref($clauses{set}) eq 'HASH';
247 @clauses{keys %$options} = values %$options;
251 my $rendered = $self->render_statement({ -update => $stmt });
252 return wantarray ? @$rendered : $rendered->[0];
256 my ($self, $table, $where, $options) = @_;
259 if (ref($table) eq 'HASH') {
262 my %clauses = (target => $table, where => $where, %{$options||{}});
266 my $rendered = $self->render_statement({ -delete => $stmt });
267 return wantarray ? @$rendered : $rendered->[0];
271 my ($self, $table, $data, $options) = @_;
274 if (ref($table) eq 'HASH') {
277 my %clauses = (target => $table, values => $data, %{$options||{}});
281 my $rendered = $self->render_statement({ -insert => $stmt });
282 return wantarray ? @$rendered : $rendered->[0];
285 sub _expand_insert_clause_target {
286 +(target => $_[0]->_expand_maybe_list_expr($_[2], -ident));
289 sub _expand_insert_clause_fields {
291 $_[0]->_expand_maybe_list_expr($_[2], -ident)
292 ] } if ref($_[2]) eq 'ARRAY';
293 return $_[2]; # should maybe still expand somewhat?
296 sub _expand_insert_clause_from {
297 my ($self, undef, $data) = @_;
298 if (ref($data) eq 'HASH' and (keys(%$data))[0] =~ /^-/) {
299 return $self->expand_expr($data);
301 return $data if ref($data) eq 'HASH' and $data->{-row};
302 my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
304 from => { -values => [ $v_aqt ] },
305 ($f_aqt ? (fields => $f_aqt) : ()),
309 sub _expand_insert_clause_returning {
310 +(returning => $_[0]->_expand_maybe_list_expr($_[2], -ident));
314 my ($self, undef, $values) = @_;
315 return { -values => [
318 ? $self->expand_expr($_)
319 : +{ -row => [ map $self->expand_expr($_), @$_ ] }
320 ), ref($values) eq 'ARRAY' ? @$values : $values
325 my ($self, undef, $values) = @_;
326 my $inner = $self->join_query_parts(' ',
327 $self->format_keyword('values'),
328 $self->join_query_parts(', ',
329 ref($values) eq 'ARRAY' ? @$values : $values
332 return $self->join_query_parts('',
333 (our $Render_Top_Level ? $inner : ('(', $inner, ')'))
338 my ($self, $name, $key, $value) = @_;
339 return $self->{$name}{$key} unless @_ > 3;
340 $self->{$name}{$key} = $value;
345 foreach my $type (qw(
346 expand op_expand render op_render clause_expand clause_render
348 my $name = join '_', reverse split '_', $type;
349 my $singular = "${type}er";
350 eval qq{sub ${singular} { shift->_ext_rw($name => \@_) }; 1 }
351 or die "Method builder failed for ${singular}: $@";
352 eval qq{sub wrap_${singular} {
353 my (\$self, \$key, \$builder) = \@_;
354 my \$orig = \$self->_ext_rw('${name}', \$key);
357 \$builder->(\$orig, '${name}', \$key)
359 }; 1 } or die "Method builder failed for wrap_${singular}: $@";
360 eval qq{sub ${singular}s {
361 my (\$self, \@args) = \@_;
362 while (my (\$this_key, \$this_value) = splice(\@args, 0, 2)) {
363 \$self->_ext_rw('${name}', \$this_key, \$this_value);
366 }; 1 } or die "Method builder failed for ${singular}s: $@";
367 eval qq{sub wrap_${singular}s {
368 my (\$self, \@args) = \@_;
369 while (my (\$this_key, \$this_builder) = splice(\@args, 0, 2)) {
370 my \$orig = \$self->_ext_rw('${name}', \$this_key);
372 '${name}', \$this_key,
373 \$this_builder->(\$orig, '${name}', \$this_key),
377 }; 1 } or die "Method builder failed for wrap_${singular}s: $@";
378 eval qq{sub ${singular}_list { sort keys %{\$_[0]->{\$name}} }; 1; }
379 or die "Method builder failed for ${singular}_list: $@";
383 sub statement_list { sort keys %{$_[0]->{clauses_of}} }
386 my ($self, $of, @clauses) = @_;
388 return @{$self->{clauses_of}{$of}||[]};
390 if (ref($clauses[0]) eq 'CODE') {
391 @clauses = $self->${\($clauses[0])}(@{$self->{clauses_of}{$of}||[]});
393 $self->{clauses_of}{$of} = \@clauses;
402 ref($self->{$_}) eq 'HASH'