1 package SQL::Abstract::ExtraClauses;
6 is => 'ro', init_arg => undef,
8 expand_expr expand_maybe_list_expr render_aqt join_query_parts
13 my ($self, $method, @args) = @_;
15 local $self->{sqla} = shift;
16 $self->$method(@args, @_)
21 my ($self, @pairs) = @_;
22 my $sqla = $self->sqla;
23 while (my ($method, $cases) = splice(@pairs, 0, 2)) {
25 while (my ($name, $case) = splice(@cases, 0, 2)) {
26 $sqla->$method($name, $self->cb($case));
33 my ($self, $sqla) = @_;
34 $self = $self->new unless ref($self);
35 local $self->{sqla} = $sqla;
36 $self->register_extensions($sqla);
39 sub register_extensions {
40 my ($self, $sqla) = @_;
42 my @clauses = $sqla->clauses_of('select');
44 CLAUSE: foreach my $idx (0..$#clauses) {
45 if ($clauses[$idx] eq 'order_by') {
46 @before_setop = @clauses[0..$idx-1];
47 splice(@clauses, $idx, 0, qw(setop group_by having));
52 die "Huh?" unless @before_setop;
53 $sqla->clauses_of(select => @clauses);
55 $sqla->clauses_of(update => sub {
56 my ($self, @clauses) = @_;
57 splice(@clauses, 2, 0, 'from');
61 $sqla->clauses_of(delete => sub {
62 my ($self, @clauses) = @_;
63 splice(@clauses, 1, 0, 'using');
72 (map +($_ => "_${x}_${_}"), qw(join from_list alias))
75 ), qw(expand render)),
76 binop_expander => [ as => '_expand_op_as' ],
77 renderer => [ as => '_render_as' ],
78 expander => [ cast => '_expand_cast' ],
80 "select.from", '_expand_from_list',
82 => sub { $_[0]->expand_maybe_list_expr($_[2], -ident) },
84 => sub { $_[0]->expand_expr($_[2]) },
85 'update.from' => '_expand_from_list',
86 "update.target", '_expand_update_clause_target',
87 "update.update", '_expand_update_clause_target',
88 'delete.using' => '_expand_from_list',
89 'insert.rowvalues' => sub {
90 +(from => $_[0]->expand_expr({ -values => $_[2] }));
92 'insert.select' => sub {
93 +(from => $_[0]->expand_expr({ -select => $_[2] }));
99 $sqla->wrap_expander(select => sub {
100 $self->cb('_expand_select', $_[0], \@before_setop);
105 'select.setop' => sub { $_[0]->render_aqt($_[2]) }
107 expander => [ map +($_ => '_expand_setop'), qw(union intersect except) ],
108 renderer => [ map +($_ => '_render_setop'), qw(union intersect except) ],
111 my $setop_expander = $self->cb('_expand_clause_setop');
113 $sqla->clause_expanders(
114 map +($_ => $setop_expander),
116 map +($_, "${_}_all", "${_}_distinct"),
117 qw(union intersect except)
120 foreach my $stmt (qw(select insert update delete)) {
121 $sqla->clauses_of($stmt => 'with', $sqla->clauses_of($stmt));
123 clause_expanders => [
124 "${stmt}.with" => '_expand_with',
125 "${stmt}.with_recursive" => '_expand_with',
127 clause_renderer => [ "${stmt}.with" => '_render_with' ],
135 my ($self, $orig, $before_setop, @args) = @_;
136 my $exp = $self->sqla->$orig(@args);
137 return $exp unless my $setop = (my $sel = $exp->{-select})->{setop};
138 if (my @keys = grep $sel->{$_}, @$before_setop) {
139 my %inner; @inner{@keys} = delete @{$sel}{@keys};
140 unshift @{(values(%$setop))[0]{queries}},
141 { -select => \%inner };
146 sub _expand_from_list {
147 my ($self, undef, $args) = @_;
148 if (ref($args) eq 'HASH') {
149 return $args if $args->{-from_list};
150 return { -from_list => [ $self->expand_expr($args) ] };
153 my @args = ref($args) eq 'ARRAY' ? @$args : ($args);
154 while (my $entry = shift @args) {
155 if (!ref($entry) and $entry =~ /^-(.*)/) {
157 $list[-1] = $self->expand_expr({ -as => [
158 $list[-1], map +(ref($_) eq 'ARRAY' ? @$_ : $_), shift(@args)
162 $entry = { $entry => shift @args };
164 my $aqt = $self->expand_expr($entry, -ident);
165 if ($aqt->{-join} and not $aqt->{-join}{from}) {
166 $aqt->{-join}{from} = pop @list;
170 return { -from_list => \@list };
174 my ($self, undef, $args) = @_;
180 if (my $as = delete $proto{as}) {
181 $proto{to} = $self->expand_expr({ -as => [ $proto{to}, $as ] });
183 if (defined($proto{using}) and ref(my $using = $proto{using}) ne 'HASH') {
185 map [ $self->expand_expr($_, -ident) ],
186 ref($using) eq 'ARRAY' ? @$using: $using
189 my %ret = map +($_ => $self->expand_expr($proto{$_}, -ident)),
191 $ret{type} = $proto{type};
192 return +{ -join => \%ret };
195 sub _render_from_list {
196 my ($self, undef, $list) = @_;
197 return $self->join_query_parts(', ', @$list);
201 my ($self, undef, $args) = @_;
205 { -keyword => join '_', ($args->{type}||()), 'join' },
206 (map +($_->{-ident} || $_->{-as} ? $_ : ('(', $_, ')')), $args->{to}),
208 { -keyword => 'on' },
212 { -keyword => 'using' },
213 '(', $args->{using}, ')',
216 return $self->join_query_parts(' ', @parts);
220 my ($self, undef, $vv, $k) = @_;
221 my @vv = (ref($vv) eq 'ARRAY' ? @$vv : $vv);
222 my $ik = $self->expand_expr($k, -ident);
223 return +{ -as => [ $ik, $self->expand_expr($vv[0], -alias) ] }
224 if @vv == 1 and ref($vv[0]) eq 'HASH';
226 my @as = map $self->expand_expr($_, -ident), @vv;
227 return { -as => [ $ik, { -alias => \@as } ] };
231 my ($self, undef, $args) = @_;
232 my ($thing, $alias) = @$args;
233 return $self->join_query_parts(
236 { -keyword => 'as' },
242 my ($self, undef, $args) = @_;
243 my ($as, @cols) = @$args;
245 ? $self->join_query_parts('',
248 $self->join_query_parts(
254 : $self->render_aqt($as)
258 sub _expand_update_clause_target {
259 my ($self, undef, $target) = @_;
260 +(target => $self->_expand_from_list(undef, $target));
264 my ($self, undef, $thing) = @_;
265 return { -func => [ cast => $thing ] } if ref($thing) eq 'HASH';
266 my ($cast, $to) = @{$thing};
267 +{ -func => [ cast => { -as => [
268 $self->expand_expr($cast),
269 $self->expand_expr($to, -ident),
274 my ($self, undef, $args) = @_;
275 if (ref($args) eq 'HASH' and my $alias = $args->{-alias}) {
279 map $self->expand_expr($_, -ident),
280 ref($args) eq 'ARRAY' ? @{$args} : $args
286 my ($self, $name, $with) = @_;
287 my (undef, $type) = split '_', $name;
288 if (ref($with) eq 'HASH') {
293 $self->expand_expr({ -alias => $_->[0] }, -ident),
294 $self->expand_expr($_->[1]),
295 ], @{$with->{queries}}
301 while (my ($alias, $query) = splice @with, 0, 2) {
303 $self->expand_expr({ -alias => $alias }, -ident),
304 $self->expand_expr($query)
307 return +(with => { ($type ? (type => $type) : ()), queries => \@exp });
311 my ($self, undef, $with) = @_;
312 my $q_part = $self->join_query_parts(', ',
314 my ($alias, $query) = @$_;
315 $self->join_query_parts(' ',
317 { -keyword => 'as' },
320 } @{$with->{queries}}
322 return $self->join_query_parts(' ',
323 { -keyword => join '_', 'with', ($with->{type}||'') },
329 my ($self, $setop, $args) = @_;
332 queries => [ map $self->expand_expr($_), @{$args->{queries}} ],
337 my ($self, $setop, $args) = @_;
338 $self->join_query_parts(
339 { -keyword => ' '.join('_', $setop, ($args->{type}||())).' ' },
344 sub _expand_clause_setop {
345 my ($self, $setop, $args) = @_;
346 my ($op, $type) = split '_', $setop;
347 +(setop => $self->expand_expr({
349 ($type ? (type => $type) : ()),
350 queries => (ref($args) eq 'ARRAY' ? $args : [ $args ])
361 SQL::Abstract::ExtraClauses - new/experimental additions to L<SQL::Abstract>
365 my $sqla = SQL::Abstract->new;
366 SQL::Abstract::ExtraClauses->apply_to($sqla);
372 Applies the plugin to an L<SQL::Abstract> object.
374 =head2 register_extensions
376 Registers the extensions described below
380 For plugin authors, creates a callback to call a method on the plugin.
384 For plugin authors, registers callbacks more easily.
388 Available only during plugin callback executions, contains the currently
389 active L<SQL::Abstract> object.
395 Represents a table alias. Expands name and column names with ident as default.
398 { -alias => [ 't', 'x', 'y', 'z' ] }
402 { -ident => [ 't' ] }, { -ident => [ 'x' ] },
403 { -ident => [ 'y' ] }, { -ident => [ 'z' ] },
412 Represents an sql AS. LHS is expanded with ident as default, RHS is treated
413 as a list of arguments for the alias node.
416 { foo => { -as => 'bar' } }
421 { -ident => [ 'foo' ] },
422 { -alias => [ { -ident => [ 'bar' ] } ] },
431 { -as => [ { -select => { _ => 'blah' } }, 't', 'blah' ] }
436 { select => { -op => [ ',', { -ident => [ 'blah' ] } ] } }
438 { -alias => [ { -ident => [ 't' ] }, { -ident => [ 'blah' ] } ] },
442 (SELECT blah) AS t(blah)
448 { -cast => [ { -ident => 'birthday' }, 'date' ] }
453 -as => [ { -ident => [ 'birthday' ] }, { -ident => [ 'date' ] } ]
458 CAST(birthday AS date)
463 If given an arrayref, pretends it was given a hashref with the first
464 element of the arrayref as the value for 'to' and the remaining pairs copied.
466 Given a hashref, the 'as' key is if presented expanded to wrap the 'to'.
468 If present the 'using' key is expanded as a list of idents.
470 Known keys are: 'from' (the left hand side), 'type' ('left', 'right', or
471 nothing), 'to' (the right hand side), 'on' and 'using'.
476 on => { 'lft.bloo' => { '>' => 'rgt.blee' } },
483 from => { -ident => [ 'lft' ] },
485 '>', { -ident => [ 'lft', 'bloo' ] },
486 { -ident => [ 'rgt', 'blee' ] },
488 to => { -ident => [ 'rgt' ] },
493 lft LEFT JOIN rgt ON lft.bloo > rgt.blee
498 List of components of the FROM clause; -foo type elements indicate a pair
499 with the next element; this is easiest if I show you:
503 't1', -as => 'table_one', -join =>
504 [ 't2', 'on', { 'table_one.x' => 't2.x' } ],
508 { -from_list => [ { -join => {
510 { -ident => [ 't1' ] },
511 { -alias => [ { -ident => [ 'table_one' ] } ] },
514 '=', { -ident => [ 'table_one', 'x' ] },
515 { -ident => [ 't2', 'x' ] },
517 to => { -ident => [ 't2' ] },
522 t1 AS table_one JOIN t2 ON table_one.x = t2.x
529 [ 't1', -as => 'table_one', -join => [ 't2', 'using', [ 'x' ] ] ]
533 { -from_list => [ { -join => {
535 { -ident => [ 't1' ] },
536 { -alias => [ { -ident => [ 'table_one' ] } ] },
538 to => { -ident => [ 't2' ] },
542 -op => [ 'or', { -op => [ 'or', { -ident => [ 'x' ] } ] } ]
547 t1 AS table_one JOIN t2 USING ( x )
555 { -join => { from => 'y', to => 'z', type => 'left' } }, 'type',
561 { -from_list => [ { -join => {
562 from => { -ident => [ 'x' ] },
564 from => { -ident => [ 'y' ] },
565 to => { -ident => [ 'z' ] },
572 x LEFT JOIN ( y LEFT JOIN z )