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; |
92b858c9 |
8 | use IO::File; |
701da8c4 |
9 | use Carp::Clan qw/DBIx::Class/; |
8b445e33 |
10 | |
bd7efd39 |
11 | BEGIN { |
12 | |
cb5f2eea |
13 | package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :( |
bd7efd39 |
14 | |
15 | use base qw/SQL::Abstract::Limit/; |
16 | |
54540863 |
17 | sub select { |
18 | my ($self, $table, $fields, $where, $order, @rest) = @_; |
19 | @rest = (-1) unless defined $rest[0]; |
20 | $self->SUPER::select($table, $self->_recurse_fields($fields), |
21 | $where, $order, @rest); |
22 | } |
23 | |
24 | sub _emulate_limit { |
25 | my $self = shift; |
26 | if ($_[3] == -1) { |
27 | return $_[1].$self->_order_by($_[2]); |
28 | } else { |
29 | return $self->SUPER::_emulate_limit(@_); |
30 | } |
31 | } |
32 | |
33 | sub _recurse_fields { |
34 | my ($self, $fields) = @_; |
35 | my $ref = ref $fields; |
36 | return $self->_quote($fields) unless $ref; |
37 | return $$fields if $ref eq 'SCALAR'; |
38 | |
39 | if ($ref eq 'ARRAY') { |
40 | return join(', ', map { $self->_recurse_fields($_) } @$fields); |
41 | } elsif ($ref eq 'HASH') { |
42 | foreach my $func (keys %$fields) { |
43 | return $self->_sqlcase($func) |
44 | .'( '.$self->_recurse_fields($fields->{$func}).' )'; |
45 | } |
46 | } |
47 | } |
48 | |
49 | sub _order_by { |
50 | my $self = shift; |
51 | my $ret = ''; |
52 | if (ref $_[0] eq 'HASH') { |
53 | if (defined $_[0]->{group_by}) { |
54 | $ret = $self->_sqlcase(' group by ') |
55 | .$self->_recurse_fields($_[0]->{group_by}); |
56 | } |
57 | if (defined $_[0]->{order_by}) { |
58 | $ret .= $self->SUPER::_order_by($_[0]->{order_by}); |
59 | } |
60 | } else { |
61 | $ret = $self->SUPER::_order_by(@_); |
62 | } |
63 | return $ret; |
64 | } |
65 | |
2a816814 |
66 | sub _table { |
bd7efd39 |
67 | my ($self, $from) = @_; |
68 | if (ref $from eq 'ARRAY') { |
69 | return $self->_recurse_from(@$from); |
70 | } elsif (ref $from eq 'HASH') { |
71 | return $self->_make_as($from); |
72 | } else { |
73 | return $from; |
74 | } |
75 | } |
76 | |
77 | sub _recurse_from { |
78 | my ($self, $from, @join) = @_; |
79 | my @sqlf; |
80 | push(@sqlf, $self->_make_as($from)); |
81 | foreach my $j (@join) { |
82 | my ($to, $on) = @$j; |
73856587 |
83 | |
54540863 |
84 | # check whether a join type exists |
85 | my $join_clause = ''; |
86 | if (ref($to) eq 'HASH' and exists($to->{-join_type})) { |
87 | $join_clause = ' '.uc($to->{-join_type}).' JOIN '; |
88 | } else { |
89 | $join_clause = ' JOIN '; |
90 | } |
73856587 |
91 | push(@sqlf, $join_clause); |
92 | |
bd7efd39 |
93 | if (ref $to eq 'ARRAY') { |
94 | push(@sqlf, '(', $self->_recurse_from(@$to), ')'); |
95 | } else { |
96cdbbab |
96 | push(@sqlf, $self->_make_as($to)); |
bd7efd39 |
97 | } |
98 | push(@sqlf, ' ON ', $self->_join_condition($on)); |
99 | } |
100 | return join('', @sqlf); |
101 | } |
102 | |
103 | sub _make_as { |
104 | my ($self, $from) = @_; |
54540863 |
105 | return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) } |
2a816814 |
106 | reverse each %{$self->_skip_options($from)}); |
73856587 |
107 | } |
108 | |
109 | sub _skip_options { |
54540863 |
110 | my ($self, $hash) = @_; |
111 | my $clean_hash = {}; |
112 | $clean_hash->{$_} = $hash->{$_} |
113 | for grep {!/^-/} keys %$hash; |
114 | return $clean_hash; |
bd7efd39 |
115 | } |
116 | |
117 | sub _join_condition { |
118 | my ($self, $cond) = @_; |
5efe4c79 |
119 | if (ref $cond eq 'HASH') { |
120 | my %j; |
121 | for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; }; |
122 | return $self->_recurse_where(\%j); |
123 | } elsif (ref $cond eq 'ARRAY') { |
124 | return join(' OR ', map { $self->_join_condition($_) } @$cond); |
125 | } else { |
126 | die "Can't handle this yet!"; |
127 | } |
bd7efd39 |
128 | } |
129 | |
2a816814 |
130 | sub _quote { |
131 | my ($self, $label) = @_; |
132 | return '' unless defined $label; |
133 | return $self->SUPER::_quote($label); |
134 | } |
135 | |
7be93b07 |
136 | # Accessor for setting limit dialect. This is useful |
137 | # for JDBC-bridge among others where the remote SQL-dialect cannot |
138 | # be determined by the name of the driver alone. |
139 | # |
140 | sub limit_dialect { |
141 | my $self = shift; |
142 | $self->{limit_dialect} = shift if @_; |
143 | return $self->{limit_dialect}; |
144 | } |
145 | |
486ad69b |
146 | package DBIx::Class::Storage::DBI::DebugCallback; |
147 | |
148 | sub print { |
149 | my ($self, $string) = @_; |
150 | $string =~ m/^(\w+)/; |
151 | ${$self}->($1, $string); |
152 | } |
153 | |
bd7efd39 |
154 | } # End of BEGIN block |
155 | |
8b445e33 |
156 | use base qw/DBIx::Class/; |
157 | |
1f692767 |
158 | __PACKAGE__->load_components(qw/AccessorGroup/); |
8b445e33 |
159 | |
223b8fe3 |
160 | __PACKAGE__->mk_group_accessors('simple' => |
92b858c9 |
161 | qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/); |
8091aa91 |
162 | |
8b445e33 |
163 | sub new { |
223b8fe3 |
164 | my $new = bless({}, ref $_[0] || $_[0]); |
28927b50 |
165 | $new->cursor("DBIx::Class::Storage::DBI::Cursor"); |
d79f59b9 |
166 | $new->transaction_depth(0); |
5e65c358 |
167 | if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) && |
168 | ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) { |
701da8c4 |
169 | $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1"); |
92b858c9 |
170 | } else { |
171 | $new->debugfh(IO::File->new('>&STDERR')); |
172 | } |
28927b50 |
173 | $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}; |
223b8fe3 |
174 | return $new; |
8b445e33 |
175 | } |
176 | |
8b445e33 |
177 | =head1 NAME |
178 | |
179 | DBIx::Class::Storage::DBI - DBI storage handler |
180 | |
181 | =head1 SYNOPSIS |
182 | |
183 | =head1 DESCRIPTION |
184 | |
185 | This class represents the connection to the database |
186 | |
187 | =head1 METHODS |
188 | |
8b445e33 |
189 | =cut |
190 | |
d7c4c15c |
191 | =head2 on_connect_do |
192 | |
193 | Executes the sql statements given as a listref on every db connect. |
194 | |
92b858c9 |
195 | =head2 debug |
196 | |
197 | Causes SQL trace information to be emitted on C<debugfh> filehandle |
198 | (or C<STDERR> if C<debugfh> has not specifically been set). |
199 | |
200 | =head2 debugfh |
201 | |
202 | Sets or retrieves the filehandle used for trace/debug output. This |
203 | should be an IO::Handle compatible object (only the C<print> method is |
204 | used). Initially set to be STDERR - although see information on the |
205 | L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable. |
206 | |
486ad69b |
207 | =head2 debugcb |
208 | |
209 | Sets a callback to be executed each time a statement is run; takes a sub |
210 | reference. Overrides debugfh. Callback is executed as $sub->($op, $info) |
211 | where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally |
212 | be printed. |
213 | |
d7c4c15c |
214 | =cut |
215 | |
486ad69b |
216 | sub debugcb { |
217 | my ($self, $cb) = @_; |
218 | my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback'); |
219 | $self->debugfh($cb_obj); |
220 | } |
221 | |
412db1f4 |
222 | sub disconnect { |
223 | my ($self) = @_; |
224 | |
225 | $self->_dbh->disconnect if $self->_dbh; |
226 | } |
227 | |
228 | sub connected { |
8b445e33 |
229 | my ($self) = @_; |
412db1f4 |
230 | |
8b445e33 |
231 | my $dbh; |
412db1f4 |
232 | (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping) |
233 | } |
234 | |
235 | sub ensure_connected { |
236 | my ($self) = @_; |
237 | |
238 | unless ($self->connected) { |
8b445e33 |
239 | $self->_populate_dbh; |
240 | } |
412db1f4 |
241 | } |
242 | |
243 | sub dbh { |
244 | my ($self) = @_; |
245 | |
246 | $self->ensure_connected; |
8b445e33 |
247 | return $self->_dbh; |
248 | } |
249 | |
48c69e7c |
250 | sub sql_maker { |
251 | my ($self) = @_; |
fdc1c3d0 |
252 | unless ($self->_sql_maker) { |
bd7efd39 |
253 | $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh )); |
48c69e7c |
254 | } |
255 | return $self->_sql_maker; |
256 | } |
257 | |
8b445e33 |
258 | sub _populate_dbh { |
259 | my ($self) = @_; |
260 | my @info = @{$self->connect_info || []}; |
261 | $self->_dbh($self->_connect(@info)); |
d7c4c15c |
262 | |
263 | # if on-connect sql statements are given execute them |
264 | foreach my $sql_statement (@{$self->on_connect_do || []}) { |
265 | $self->_dbh->do($sql_statement); |
266 | } |
8b445e33 |
267 | } |
268 | |
269 | sub _connect { |
270 | my ($self, @info) = @_; |
271 | return DBI->connect(@info); |
272 | } |
273 | |
8091aa91 |
274 | =head2 txn_begin |
8b445e33 |
275 | |
8091aa91 |
276 | Calls begin_work on the current dbh. |
8b445e33 |
277 | |
278 | =cut |
279 | |
8091aa91 |
280 | sub txn_begin { |
d79f59b9 |
281 | my $self = shift; |
282 | $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit}; |
8091aa91 |
283 | } |
8b445e33 |
284 | |
8091aa91 |
285 | =head2 txn_commit |
8b445e33 |
286 | |
8091aa91 |
287 | Issues a commit against the current dbh. |
8b445e33 |
288 | |
8091aa91 |
289 | =cut |
290 | |
291 | sub txn_commit { |
d79f59b9 |
292 | my $self = shift; |
293 | if ($self->{transaction_depth} == 0) { |
294 | $self->dbh->commit unless $self->dbh->{AutoCommit}; |
8091aa91 |
295 | } |
296 | else { |
d79f59b9 |
297 | $self->dbh->commit if --$self->{transaction_depth} == 0; |
8091aa91 |
298 | } |
299 | } |
300 | |
301 | =head2 txn_rollback |
302 | |
303 | Issues a rollback against the current dbh. |
8b445e33 |
304 | |
305 | =cut |
306 | |
8091aa91 |
307 | sub txn_rollback { |
d79f59b9 |
308 | my $self = shift; |
309 | if ($self->{transaction_depth} == 0) { |
310 | $self->dbh->rollback unless $self->dbh->{AutoCommit}; |
8091aa91 |
311 | } |
312 | else { |
d79f59b9 |
313 | --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@; |
8091aa91 |
314 | } |
315 | } |
8b445e33 |
316 | |
223b8fe3 |
317 | sub _execute { |
318 | my ($self, $op, $extra_bind, $ident, @args) = @_; |
319 | my ($sql, @bind) = $self->sql_maker->$op($ident, @args); |
944f30bf |
320 | unshift(@bind, @$extra_bind) if $extra_bind; |
f59ffc79 |
321 | if ($self->debug) { |
322 | my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind; |
323 | $self->debugfh->print("$sql: @debug_bind\n"); |
324 | } |
2f5911b2 |
325 | my $sth = $self->sth($sql,$op); |
438adc0e |
326 | @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args |
701da8c4 |
327 | my $rv; |
328 | if ($sth) { |
329 | $rv = $sth->execute(@bind); |
330 | } else { |
331 | croak "'$sql' did not generate a statement."; |
332 | } |
223b8fe3 |
333 | return (wantarray ? ($rv, $sth, @bind) : $rv); |
334 | } |
335 | |
8b445e33 |
336 | sub insert { |
337 | my ($self, $ident, $to_insert) = @_; |
701da8c4 |
338 | croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" ) |
a4b2f17b |
339 | unless ($self->_execute('insert' => [], $ident, $to_insert)); |
8b445e33 |
340 | return $to_insert; |
341 | } |
342 | |
343 | sub update { |
223b8fe3 |
344 | return shift->_execute('update' => [], @_); |
8b445e33 |
345 | } |
346 | |
347 | sub delete { |
223b8fe3 |
348 | return shift->_execute('delete' => [], @_); |
8b445e33 |
349 | } |
350 | |
de705b51 |
351 | sub _select { |
8b445e33 |
352 | my ($self, $ident, $select, $condition, $attrs) = @_; |
223b8fe3 |
353 | my $order = $attrs->{order_by}; |
354 | if (ref $condition eq 'SCALAR') { |
355 | $order = $1 if $$condition =~ s/ORDER BY (.*)$//i; |
356 | } |
54540863 |
357 | if (exists $attrs->{group_by}) { |
358 | $order = { group_by => $attrs->{group_by}, |
359 | ($order ? (order_by => $order) : ()) }; |
360 | } |
5c91499f |
361 | my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order); |
9229f20a |
362 | if ($attrs->{software_limit} || |
363 | $self->sql_maker->_default_limit_syntax eq "GenericSubQ") { |
364 | $attrs->{software_limit} = 1; |
5c91499f |
365 | } else { |
366 | push @args, $attrs->{rows}, $attrs->{offset}; |
367 | } |
de705b51 |
368 | return $self->_execute(@args); |
369 | } |
370 | |
371 | sub select { |
372 | my $self = shift; |
373 | my ($ident, $select, $condition, $attrs) = @_; |
cb5f2eea |
374 | return $self->cursor->new($self, \@_, $attrs); |
8b445e33 |
375 | } |
376 | |
6157db4f |
377 | # Need to call finish() to work round broken DBDs |
378 | |
1a14aa3f |
379 | sub select_single { |
de705b51 |
380 | my $self = shift; |
381 | my ($rv, $sth, @bind) = $self->_select(@_); |
6157db4f |
382 | my @row = $sth->fetchrow_array; |
383 | $sth->finish(); |
384 | return @row; |
1a14aa3f |
385 | } |
386 | |
8b445e33 |
387 | sub sth { |
cb5f2eea |
388 | my ($self, $sql) = @_; |
91fa659e |
389 | # 3 is the if_active parameter which avoids active sth re-use |
390 | return $self->dbh->prepare_cached($sql, {}, 3); |
8b445e33 |
391 | } |
392 | |
a953d8d9 |
393 | =head2 columns_info_for |
394 | |
395 | Returns database type info for a given table columns. |
396 | |
397 | =cut |
398 | |
399 | sub columns_info_for { |
400 | my ($self, $table) = @_; |
a953d8d9 |
401 | my %result; |
103e3e03 |
402 | if ( $self->dbh->can( 'column_info' ) ){ |
403 | my $sth = $self->dbh->column_info( undef, undef, $table, '%' ); |
404 | $sth->execute(); |
405 | while ( my $info = $sth->fetchrow_hashref() ){ |
406 | my %column_info; |
a953d8d9 |
407 | $column_info{data_type} = $info->{TYPE_NAME}; |
408 | $column_info{size} = $info->{COLUMN_SIZE}; |
409 | $column_info{is_nullable} = $info->{NULLABLE}; |
103e3e03 |
410 | $result{$info->{COLUMN_NAME}} = \%column_info; |
411 | } |
412 | }else{ |
413 | my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0"); |
414 | $sth->execute; |
415 | my @columns = @{$sth->{NAME}}; |
416 | for my $i ( 0 .. $#columns ){ |
417 | $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i]; |
a953d8d9 |
418 | } |
a953d8d9 |
419 | } |
420 | return \%result; |
421 | } |
422 | |
8b445e33 |
423 | 1; |
424 | |
92b858c9 |
425 | =head1 ENVIRONMENT VARIABLES |
426 | |
427 | =head2 DBIX_CLASS_STORAGE_DBI_DEBUG |
428 | |
429 | If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information |
430 | is produced (as when the L<debug> method is set). |
431 | |
432 | If the value is of the form C<1=/path/name> then the trace output is |
433 | written to the file C</path/name>. |
434 | |
8b445e33 |
435 | =head1 AUTHORS |
436 | |
daec44b8 |
437 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
8b445e33 |
438 | |
9f19b1d6 |
439 | Andy Grundman <andy@hybridized.org> |
440 | |
8b445e33 |
441 | =head1 LICENSE |
442 | |
443 | You may distribute this code under the same terms as Perl itself. |
444 | |
445 | =cut |
446 | |