clean up naming and provide aliases
[scpubgit/Q-Branch.git] / lib / SQL / Abstract / Clauses.pm
1 package SQL::Abstract::Clauses;
2
3 use strict;
4 use warnings;
5 use if $] < '5.010', 'MRO::Compat';
6 use mro 'c3';
7 use base 'SQL::Abstract';
8
9 BEGIN { *puke = \&SQL::Abstract::puke }
10
11 sub new {
12   shift->next::method(@_)->register_defaults
13 }
14
15 sub register_defaults {
16   my ($self) = @_;
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(select => @_) };
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(update => @_) };
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, $target) = @_;
30     my ($sql, @bind) = $self->render_aqt($target);
31     ($self->_sqlcase('update ').$sql, @bind);
32   };
33   $self->{clauses_of}{delete} = [ qw(target where returning) ];
34   $self->{expand}{delete} = sub { shift->_expand_statement(@_) };
35   $self->{render}{delete} = sub { shift->_render_statement(delete => @_) };
36   $self->{expand_clause}{"delete.$_"} = "_expand_delete_clause_$_"
37     for @{$self->{clauses_of}{delete}};
38   $self->{expand_clause}{"delete.from"} = '_expand_delete_clause_target';
39   $self->{render_clause}{'delete.target'} = sub {
40     my ($self, $from) = @_;
41     my ($sql, @bind) = $self->render_aqt($from);
42     ($self->_sqlcase('delete from ').$sql, @bind);
43   };
44   $self->{clauses_of}{insert} = [
45     'target', 'fields', 'values', 'returning'
46   ];
47   $self->{expand}{insert} = sub { shift->_expand_statement(@_) };
48   $self->{render}{insert} = sub { shift->_render_statement(insert => @_) };
49   $self->{expand_clause}{'insert.into'} = '_expand_insert_clause_target';
50   $self->{expand_clause}{'insert.target'} = '_expand_insert_clause_target';
51   $self->{expand_clause}{'insert.values'} = '_expand_insert_clause_values';
52   $self->{expand_clause}{'insert.returning'} = sub {
53     shift->_expand_maybe_list_expr(@_, -ident);
54   };
55   $self->{render_clause}{'insert.fields'} = sub {
56     return $_[0]->render_aqt($_[1]);
57   };
58   $self->{render_clause}{'insert.target'} = sub {
59     my ($self, $from) = @_;
60     my ($sql, @bind) = $self->render_aqt($from);
61     ($self->_sqlcase('insert into ').$sql, @bind);
62   };
63   return $self;
64 }
65
66 sub _expand_select_clause_select {
67   my ($self, $select) = @_;
68   +(select => $self->_expand_maybe_list_expr($select, -ident));
69 }
70
71 sub _expand_select_clause_from {
72   my ($self, $from) = @_;
73   +(from => $self->_expand_maybe_list_expr($from, -ident));
74 }
75
76 sub _expand_select_clause_where {
77   my ($self, $where) = @_;
78   +(where => $self->expand_expr($where));
79 }
80
81 sub _expand_select_clause_order_by {
82   my ($self, $order_by) = @_;
83   +(order_by => $self->_expand_order_by($order_by));
84 }
85
86 sub _expand_update_clause_target {
87   my ($self, $target) = @_;
88   +(target => $self->expand_expr($target, -ident));
89 }
90
91 sub _expand_update_clause_set {
92   return $_[1] if ref($_[1]) eq 'HASH' and ($_[1]->{-op}||[''])->[0] eq ',';
93   +(set => shift->_expand_update_set_values(@_));
94 }
95
96 sub _expand_update_clause_where {
97   +(where => shift->expand_expr(@_));
98 }
99
100 sub _expand_update_clause_returning {
101   +(returning => shift->_expand_maybe_list_expr(@_, -ident));
102 }
103
104 sub _expand_delete_clause_target {
105   +(target => shift->_expand_maybe_list_expr(@_, -ident));
106 }
107
108 sub _expand_delete_clause_where { +(where => shift->expand_expr(@_)); }
109
110 sub _expand_delete_clause_returning {
111   +(returning => shift->_expand_maybe_list_expr(@_, -ident));
112 }
113
114 sub _expand_statement {
115   my ($self, $type, $args) = @_;
116   my $ec = $self->{expand_clause};
117   return +{ "-${type}" => +{
118     map {
119       my $val = $args->{$_};
120       if (defined($val) and my $exp = $ec->{"${type}.$_"}) {
121         if ((my (@exp) = $self->$exp($val)) == 1) {
122           ($_ => $exp[0])
123         } else {
124           @exp
125         }
126       } else {
127         ($_ => $val)
128       }
129     } sort keys %$args
130   } };
131 }
132
133 sub _render_statement {
134   my ($self, $type, $args) = @_;
135   my @parts;
136   foreach my $clause (@{$self->{clauses_of}{$type}}) {
137     next unless my $clause_expr = $args->{$clause};
138     local $self->{convert_where} = $self->{convert} if $clause eq 'where';
139     my ($sql) = my @part = do {
140       if (my $rdr = $self->{render_clause}{"${type}.${clause}"}) {
141         $self->$rdr($clause_expr);
142       } else {
143         my ($clause_sql, @bind) = $self->render_aqt($clause_expr);
144         my $sql = join ' ',
145           $self->_sqlcase(join ' ', split '_', $clause),
146           $clause_sql;
147         ($sql, @bind);
148       }
149     };
150     next unless defined($sql) and length($sql);
151     push @parts, \@part;
152   }
153   return $self->_join_parts(' ', @parts);
154 }
155
156 sub select {
157   my ($self, @args) = @_;
158   my %clauses;
159   @clauses{qw(from select where order_by)} = @args;
160
161   # This oddity is to literalify since historically SQLA doesn't quote
162   # a single identifier argument, so we convert it into a literal
163
164   $clauses{select} = { -literal => [ $clauses{select}||'*' ] }
165     unless ref($clauses{select});
166
167   my ($sql, @bind) = $self->render_expr({ -select => \%clauses });
168   return wantarray ? ($sql, @bind) : $sql;
169 }
170
171 sub update {
172   my ($self, $table, $set, $where, $options) = @_;
173   my %clauses;
174   @clauses{qw(target set where)} = ($table, $set, $where);
175   puke "Unsupported data type specified to \$sql->update"
176     unless ref($clauses{set}) eq 'HASH';
177   @clauses{keys %$options} = values %$options;
178   my ($sql, @bind) = $self->render_expr({ -update => \%clauses });
179   return wantarray ? ($sql, @bind) : $sql;
180 }
181
182 sub delete {
183   my ($self, $table, $where, $options) = @_;
184   my %clauses = (target => $table, where => $where, %{$options||{}});
185   my ($sql, @bind) = $self->render_expr({ -delete => \%clauses });
186   return wantarray ? ($sql, @bind) : $sql;
187 }
188
189 sub insert {
190   my ($self, $table, $data, $options) = @_;
191   my %clauses = (target => $table, values => $data, %{$options||{}});
192   my ($sql, @bind) = $self->render_expr({ -insert => \%clauses });
193   return wantarray ? ($sql, @bind) : $sql;
194 }
195
196 sub _expand_insert_clause_target {
197   +(target => shift->_expand_maybe_list_expr(@_, -ident));
198 }
199
200 sub _expand_insert_clause_values {
201   my ($self, $data) = @_;
202   return $data if ref($data) eq 'HASH' and $data->{-row};
203   my ($f_aqt, $v_aqt) = $self->_expand_insert_values($data);
204   return (values => $v_aqt, ($f_aqt ? (fields => $f_aqt) : ()));
205 }
206
207 1;