Commit | Line | Data |
8b445e33 |
1 | package DBIx::Class::Storage::DBI; |
2 | |
20a2c954 |
3 | use strict; |
4 | use warnings; |
8b445e33 |
5 | use DBI; |
aeaf3ce2 |
6 | use SQL::Abstract::Limit; |
28927b50 |
7 | use DBIx::Class::Storage::DBI::Cursor; |
8b445e33 |
8 | |
bd7efd39 |
9 | BEGIN { |
10 | |
cb5f2eea |
11 | package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :( |
bd7efd39 |
12 | |
13 | use base qw/SQL::Abstract::Limit/; |
14 | |
54540863 |
15 | sub select { |
16 | my ($self, $table, $fields, $where, $order, @rest) = @_; |
17 | @rest = (-1) unless defined $rest[0]; |
18 | $self->SUPER::select($table, $self->_recurse_fields($fields), |
19 | $where, $order, @rest); |
20 | } |
21 | |
22 | sub _emulate_limit { |
23 | my $self = shift; |
24 | if ($_[3] == -1) { |
25 | return $_[1].$self->_order_by($_[2]); |
26 | } else { |
27 | return $self->SUPER::_emulate_limit(@_); |
28 | } |
29 | } |
30 | |
31 | sub _recurse_fields { |
32 | my ($self, $fields) = @_; |
33 | my $ref = ref $fields; |
34 | return $self->_quote($fields) unless $ref; |
35 | return $$fields if $ref eq 'SCALAR'; |
36 | |
37 | if ($ref eq 'ARRAY') { |
38 | return join(', ', map { $self->_recurse_fields($_) } @$fields); |
39 | } elsif ($ref eq 'HASH') { |
40 | foreach my $func (keys %$fields) { |
41 | return $self->_sqlcase($func) |
42 | .'( '.$self->_recurse_fields($fields->{$func}).' )'; |
43 | } |
44 | } |
45 | } |
46 | |
47 | sub _order_by { |
48 | my $self = shift; |
49 | my $ret = ''; |
50 | if (ref $_[0] eq 'HASH') { |
51 | if (defined $_[0]->{group_by}) { |
52 | $ret = $self->_sqlcase(' group by ') |
53 | .$self->_recurse_fields($_[0]->{group_by}); |
54 | } |
55 | if (defined $_[0]->{order_by}) { |
56 | $ret .= $self->SUPER::_order_by($_[0]->{order_by}); |
57 | } |
58 | } else { |
59 | $ret = $self->SUPER::_order_by(@_); |
60 | } |
61 | return $ret; |
62 | } |
63 | |
2a816814 |
64 | sub _table { |
bd7efd39 |
65 | my ($self, $from) = @_; |
66 | if (ref $from eq 'ARRAY') { |
67 | return $self->_recurse_from(@$from); |
68 | } elsif (ref $from eq 'HASH') { |
69 | return $self->_make_as($from); |
70 | } else { |
71 | return $from; |
72 | } |
73 | } |
74 | |
75 | sub _recurse_from { |
76 | my ($self, $from, @join) = @_; |
77 | my @sqlf; |
78 | push(@sqlf, $self->_make_as($from)); |
79 | foreach my $j (@join) { |
80 | my ($to, $on) = @$j; |
73856587 |
81 | |
54540863 |
82 | # check whether a join type exists |
83 | my $join_clause = ''; |
84 | if (ref($to) eq 'HASH' and exists($to->{-join_type})) { |
85 | $join_clause = ' '.uc($to->{-join_type}).' JOIN '; |
86 | } else { |
87 | $join_clause = ' JOIN '; |
88 | } |
73856587 |
89 | push(@sqlf, $join_clause); |
90 | |
bd7efd39 |
91 | if (ref $to eq 'ARRAY') { |
92 | push(@sqlf, '(', $self->_recurse_from(@$to), ')'); |
93 | } else { |
96cdbbab |
94 | push(@sqlf, $self->_make_as($to)); |
bd7efd39 |
95 | } |
96 | push(@sqlf, ' ON ', $self->_join_condition($on)); |
97 | } |
98 | return join('', @sqlf); |
99 | } |
100 | |
101 | sub _make_as { |
102 | my ($self, $from) = @_; |
54540863 |
103 | return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) } |
2a816814 |
104 | reverse each %{$self->_skip_options($from)}); |
73856587 |
105 | } |
106 | |
107 | sub _skip_options { |
54540863 |
108 | my ($self, $hash) = @_; |
109 | my $clean_hash = {}; |
110 | $clean_hash->{$_} = $hash->{$_} |
111 | for grep {!/^-/} keys %$hash; |
112 | return $clean_hash; |
bd7efd39 |
113 | } |
114 | |
115 | sub _join_condition { |
116 | my ($self, $cond) = @_; |
5efe4c79 |
117 | if (ref $cond eq 'HASH') { |
118 | my %j; |
119 | for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; }; |
120 | return $self->_recurse_where(\%j); |
121 | } elsif (ref $cond eq 'ARRAY') { |
122 | return join(' OR ', map { $self->_join_condition($_) } @$cond); |
123 | } else { |
124 | die "Can't handle this yet!"; |
125 | } |
bd7efd39 |
126 | } |
127 | |
2a816814 |
128 | sub _quote { |
129 | my ($self, $label) = @_; |
130 | return '' unless defined $label; |
131 | return $self->SUPER::_quote($label); |
132 | } |
133 | |
bd7efd39 |
134 | } # End of BEGIN block |
135 | |
8b445e33 |
136 | use base qw/DBIx::Class/; |
137 | |
438adc0e |
138 | __PACKAGE__->load_components(qw/Exception AccessorGroup/); |
8b445e33 |
139 | |
223b8fe3 |
140 | __PACKAGE__->mk_group_accessors('simple' => |
d7c4c15c |
141 | qw/connect_info _dbh _sql_maker debug cursor on_connect_do/); |
8b445e33 |
142 | |
8091aa91 |
143 | our $TRANSACTION = 0; |
144 | |
8b445e33 |
145 | sub new { |
223b8fe3 |
146 | my $new = bless({}, ref $_[0] || $_[0]); |
28927b50 |
147 | $new->cursor("DBIx::Class::Storage::DBI::Cursor"); |
148 | $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}; |
223b8fe3 |
149 | return $new; |
8b445e33 |
150 | } |
151 | |
8b445e33 |
152 | =head1 NAME |
153 | |
154 | DBIx::Class::Storage::DBI - DBI storage handler |
155 | |
156 | =head1 SYNOPSIS |
157 | |
158 | =head1 DESCRIPTION |
159 | |
160 | This class represents the connection to the database |
161 | |
162 | =head1 METHODS |
163 | |
8b445e33 |
164 | =cut |
165 | |
d7c4c15c |
166 | =head2 on_connect_do |
167 | |
168 | Executes the sql statements given as a listref on every db connect. |
169 | |
170 | =cut |
171 | |
8b445e33 |
172 | sub dbh { |
173 | my ($self) = @_; |
174 | my $dbh; |
175 | unless (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping) { |
176 | $self->_populate_dbh; |
177 | } |
178 | return $self->_dbh; |
179 | } |
180 | |
48c69e7c |
181 | sub sql_maker { |
182 | my ($self) = @_; |
fdc1c3d0 |
183 | unless ($self->_sql_maker) { |
bd7efd39 |
184 | $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh )); |
48c69e7c |
185 | } |
186 | return $self->_sql_maker; |
187 | } |
188 | |
8b445e33 |
189 | sub _populate_dbh { |
190 | my ($self) = @_; |
191 | my @info = @{$self->connect_info || []}; |
192 | $self->_dbh($self->_connect(@info)); |
d7c4c15c |
193 | |
194 | # if on-connect sql statements are given execute them |
195 | foreach my $sql_statement (@{$self->on_connect_do || []}) { |
196 | $self->_dbh->do($sql_statement); |
197 | } |
8b445e33 |
198 | } |
199 | |
200 | sub _connect { |
201 | my ($self, @info) = @_; |
202 | return DBI->connect(@info); |
203 | } |
204 | |
8091aa91 |
205 | =head2 txn_begin |
8b445e33 |
206 | |
8091aa91 |
207 | Calls begin_work on the current dbh. |
8b445e33 |
208 | |
209 | =cut |
210 | |
8091aa91 |
211 | sub txn_begin { |
212 | $_[0]->dbh->begin_work if $TRANSACTION++ == 0 and $_[0]->dbh->{AutoCommit}; |
213 | } |
8b445e33 |
214 | |
8091aa91 |
215 | =head2 txn_commit |
8b445e33 |
216 | |
8091aa91 |
217 | Issues a commit against the current dbh. |
8b445e33 |
218 | |
8091aa91 |
219 | =cut |
220 | |
221 | sub txn_commit { |
222 | if ($TRANSACTION == 0) { |
223 | $_[0]->dbh->commit; |
224 | } |
225 | else { |
226 | $_[0]->dbh->commit if --$TRANSACTION == 0; |
227 | } |
228 | } |
229 | |
230 | =head2 txn_rollback |
231 | |
232 | Issues a rollback against the current dbh. |
8b445e33 |
233 | |
234 | =cut |
235 | |
8091aa91 |
236 | sub txn_rollback { |
237 | if ($TRANSACTION == 0) { |
238 | $_[0]->dbh->rollback; |
239 | } |
240 | else { |
241 | --$TRANSACTION == 0 ? $_[0]->dbh->rollback : die $@; |
242 | } |
243 | } |
8b445e33 |
244 | |
223b8fe3 |
245 | sub _execute { |
246 | my ($self, $op, $extra_bind, $ident, @args) = @_; |
247 | my ($sql, @bind) = $self->sql_maker->$op($ident, @args); |
944f30bf |
248 | unshift(@bind, @$extra_bind) if $extra_bind; |
223b8fe3 |
249 | warn "$sql: @bind" if $self->debug; |
2f5911b2 |
250 | my $sth = $self->sth($sql,$op); |
438adc0e |
251 | @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args |
252 | my $rv = $sth->execute(@bind); |
223b8fe3 |
253 | return (wantarray ? ($rv, $sth, @bind) : $rv); |
254 | } |
255 | |
8b445e33 |
256 | sub insert { |
257 | my ($self, $ident, $to_insert) = @_; |
20a2c954 |
258 | $self->throw( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" ) |
a4b2f17b |
259 | unless ($self->_execute('insert' => [], $ident, $to_insert)); |
8b445e33 |
260 | return $to_insert; |
261 | } |
262 | |
263 | sub update { |
223b8fe3 |
264 | return shift->_execute('update' => [], @_); |
8b445e33 |
265 | } |
266 | |
267 | sub delete { |
223b8fe3 |
268 | return shift->_execute('delete' => [], @_); |
8b445e33 |
269 | } |
270 | |
de705b51 |
271 | sub _select { |
8b445e33 |
272 | my ($self, $ident, $select, $condition, $attrs) = @_; |
223b8fe3 |
273 | my $order = $attrs->{order_by}; |
274 | if (ref $condition eq 'SCALAR') { |
275 | $order = $1 if $$condition =~ s/ORDER BY (.*)$//i; |
276 | } |
54540863 |
277 | if (exists $attrs->{group_by}) { |
278 | $order = { group_by => $attrs->{group_by}, |
279 | ($order ? (order_by => $order) : ()) }; |
280 | } |
5c91499f |
281 | my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order); |
9229f20a |
282 | if ($attrs->{software_limit} || |
283 | $self->sql_maker->_default_limit_syntax eq "GenericSubQ") { |
284 | $attrs->{software_limit} = 1; |
5c91499f |
285 | } else { |
286 | push @args, $attrs->{rows}, $attrs->{offset}; |
287 | } |
de705b51 |
288 | return $self->_execute(@args); |
289 | } |
290 | |
291 | sub select { |
292 | my $self = shift; |
293 | my ($ident, $select, $condition, $attrs) = @_; |
cb5f2eea |
294 | return $self->cursor->new($self, \@_, $attrs); |
8b445e33 |
295 | } |
296 | |
1a14aa3f |
297 | sub select_single { |
de705b51 |
298 | my $self = shift; |
299 | my ($rv, $sth, @bind) = $self->_select(@_); |
1a14aa3f |
300 | return $sth->fetchrow_array; |
301 | } |
302 | |
8b445e33 |
303 | sub sth { |
cb5f2eea |
304 | my ($self, $sql) = @_; |
91fa659e |
305 | # 3 is the if_active parameter which avoids active sth re-use |
306 | return $self->dbh->prepare_cached($sql, {}, 3); |
8b445e33 |
307 | } |
308 | |
a953d8d9 |
309 | =head2 columns_info_for |
310 | |
311 | Returns database type info for a given table columns. |
312 | |
313 | =cut |
314 | |
315 | sub columns_info_for { |
316 | my ($self, $table) = @_; |
317 | my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0"); |
318 | $sth->execute; |
319 | my %result; |
320 | my @columns = @{$sth->{NAME}}; |
321 | for my $i ( 0 .. $#columns ){ |
322 | my $type = $sth->{TYPE}->[$i]; |
323 | my $info = $self->dbh->type_info($type); |
324 | my %column_info; |
325 | if ( $info ){ |
326 | $column_info{data_type} = $info->{TYPE_NAME}; |
327 | $column_info{size} = $info->{COLUMN_SIZE}; |
328 | $column_info{is_nullable} = $info->{NULLABLE}; |
329 | }else{ |
330 | $column_info{data_type} = $type; |
331 | } |
332 | $result{$columns[$i]} = \%column_info; |
333 | } |
334 | return \%result; |
335 | } |
336 | |
8b445e33 |
337 | 1; |
338 | |
8b445e33 |
339 | =head1 AUTHORS |
340 | |
daec44b8 |
341 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
8b445e33 |
342 | |
9f19b1d6 |
343 | Andy Grundman <andy@hybridized.org> |
344 | |
8b445e33 |
345 | =head1 LICENSE |
346 | |
347 | You may distribute this code under the same terms as Perl itself. |
348 | |
349 | =cut |
350 | |