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