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; |
41728a6e |
133 | return $label unless $self->{quote_char}; |
2a816814 |
134 | return $self->SUPER::_quote($label); |
135 | } |
136 | |
7be93b07 |
137 | # Accessor for setting limit dialect. This is useful |
138 | # for JDBC-bridge among others where the remote SQL-dialect cannot |
139 | # be determined by the name of the driver alone. |
140 | # |
141 | sub limit_dialect { |
142 | my $self = shift; |
143 | $self->{limit_dialect} = shift if @_; |
144 | return $self->{limit_dialect}; |
145 | } |
146 | |
486ad69b |
147 | package DBIx::Class::Storage::DBI::DebugCallback; |
148 | |
149 | sub print { |
150 | my ($self, $string) = @_; |
151 | $string =~ m/^(\w+)/; |
152 | ${$self}->($1, $string); |
153 | } |
154 | |
bd7efd39 |
155 | } # End of BEGIN block |
156 | |
8b445e33 |
157 | use base qw/DBIx::Class/; |
158 | |
1f692767 |
159 | __PACKAGE__->load_components(qw/AccessorGroup/); |
8b445e33 |
160 | |
223b8fe3 |
161 | __PACKAGE__->mk_group_accessors('simple' => |
92b858c9 |
162 | qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/); |
8091aa91 |
163 | |
8b445e33 |
164 | sub new { |
223b8fe3 |
165 | my $new = bless({}, ref $_[0] || $_[0]); |
28927b50 |
166 | $new->cursor("DBIx::Class::Storage::DBI::Cursor"); |
d79f59b9 |
167 | $new->transaction_depth(0); |
5e65c358 |
168 | if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) && |
169 | ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) { |
701da8c4 |
170 | $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1"); |
92b858c9 |
171 | } else { |
172 | $new->debugfh(IO::File->new('>&STDERR')); |
173 | } |
28927b50 |
174 | $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}; |
223b8fe3 |
175 | return $new; |
8b445e33 |
176 | } |
177 | |
8b445e33 |
178 | =head1 NAME |
179 | |
180 | DBIx::Class::Storage::DBI - DBI storage handler |
181 | |
182 | =head1 SYNOPSIS |
183 | |
184 | =head1 DESCRIPTION |
185 | |
186 | This class represents the connection to the database |
187 | |
188 | =head1 METHODS |
189 | |
8b445e33 |
190 | =cut |
191 | |
d7c4c15c |
192 | =head2 on_connect_do |
193 | |
194 | Executes the sql statements given as a listref on every db connect. |
195 | |
92b858c9 |
196 | =head2 debug |
197 | |
198 | Causes SQL trace information to be emitted on C<debugfh> filehandle |
199 | (or C<STDERR> if C<debugfh> has not specifically been set). |
200 | |
201 | =head2 debugfh |
202 | |
203 | Sets or retrieves the filehandle used for trace/debug output. This |
204 | should be an IO::Handle compatible object (only the C<print> method is |
205 | used). Initially set to be STDERR - although see information on the |
206 | L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable. |
207 | |
486ad69b |
208 | =head2 debugcb |
209 | |
210 | Sets a callback to be executed each time a statement is run; takes a sub |
211 | reference. Overrides debugfh. Callback is executed as $sub->($op, $info) |
212 | where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally |
213 | be printed. |
214 | |
d7c4c15c |
215 | =cut |
216 | |
486ad69b |
217 | sub debugcb { |
218 | my ($self, $cb) = @_; |
219 | my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback'); |
220 | $self->debugfh($cb_obj); |
221 | } |
222 | |
412db1f4 |
223 | sub disconnect { |
224 | my ($self) = @_; |
225 | |
92925617 |
226 | if( $self->connected ) { |
227 | $self->_dbh->rollback unless $self->_dbh->{AutoCommit}; |
228 | $self->_dbh->disconnect; |
229 | $self->_dbh(undef); |
230 | } |
412db1f4 |
231 | } |
232 | |
233 | sub connected { |
8b445e33 |
234 | my ($self) = @_; |
412db1f4 |
235 | |
8b445e33 |
236 | my $dbh; |
412db1f4 |
237 | (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping) |
238 | } |
239 | |
240 | sub ensure_connected { |
241 | my ($self) = @_; |
242 | |
243 | unless ($self->connected) { |
8b445e33 |
244 | $self->_populate_dbh; |
245 | } |
412db1f4 |
246 | } |
247 | |
248 | sub dbh { |
249 | my ($self) = @_; |
250 | |
251 | $self->ensure_connected; |
8b445e33 |
252 | return $self->_dbh; |
253 | } |
254 | |
48c69e7c |
255 | sub sql_maker { |
256 | my ($self) = @_; |
fdc1c3d0 |
257 | unless ($self->_sql_maker) { |
bd7efd39 |
258 | $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh )); |
48c69e7c |
259 | } |
260 | return $self->_sql_maker; |
261 | } |
262 | |
8b445e33 |
263 | sub _populate_dbh { |
264 | my ($self) = @_; |
265 | my @info = @{$self->connect_info || []}; |
266 | $self->_dbh($self->_connect(@info)); |
d7c4c15c |
267 | |
268 | # if on-connect sql statements are given execute them |
269 | foreach my $sql_statement (@{$self->on_connect_do || []}) { |
270 | $self->_dbh->do($sql_statement); |
271 | } |
8b445e33 |
272 | } |
273 | |
274 | sub _connect { |
275 | my ($self, @info) = @_; |
276 | return DBI->connect(@info); |
277 | } |
278 | |
8091aa91 |
279 | =head2 txn_begin |
8b445e33 |
280 | |
8091aa91 |
281 | Calls begin_work on the current dbh. |
8b445e33 |
282 | |
283 | =cut |
284 | |
8091aa91 |
285 | sub txn_begin { |
d79f59b9 |
286 | my $self = shift; |
287 | $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit}; |
8091aa91 |
288 | } |
8b445e33 |
289 | |
8091aa91 |
290 | =head2 txn_commit |
8b445e33 |
291 | |
8091aa91 |
292 | Issues a commit against the current dbh. |
8b445e33 |
293 | |
8091aa91 |
294 | =cut |
295 | |
296 | sub txn_commit { |
d79f59b9 |
297 | my $self = shift; |
298 | if ($self->{transaction_depth} == 0) { |
299 | $self->dbh->commit unless $self->dbh->{AutoCommit}; |
8091aa91 |
300 | } |
301 | else { |
d79f59b9 |
302 | $self->dbh->commit if --$self->{transaction_depth} == 0; |
8091aa91 |
303 | } |
304 | } |
305 | |
306 | =head2 txn_rollback |
307 | |
308 | Issues a rollback against the current dbh. |
8b445e33 |
309 | |
310 | =cut |
311 | |
8091aa91 |
312 | sub txn_rollback { |
d79f59b9 |
313 | my $self = shift; |
314 | if ($self->{transaction_depth} == 0) { |
315 | $self->dbh->rollback unless $self->dbh->{AutoCommit}; |
8091aa91 |
316 | } |
317 | else { |
d79f59b9 |
318 | --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@; |
8091aa91 |
319 | } |
320 | } |
8b445e33 |
321 | |
223b8fe3 |
322 | sub _execute { |
323 | my ($self, $op, $extra_bind, $ident, @args) = @_; |
324 | my ($sql, @bind) = $self->sql_maker->$op($ident, @args); |
944f30bf |
325 | unshift(@bind, @$extra_bind) if $extra_bind; |
f59ffc79 |
326 | if ($self->debug) { |
327 | my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind; |
328 | $self->debugfh->print("$sql: @debug_bind\n"); |
329 | } |
2f5911b2 |
330 | my $sth = $self->sth($sql,$op); |
438adc0e |
331 | @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args |
701da8c4 |
332 | my $rv; |
333 | if ($sth) { |
334 | $rv = $sth->execute(@bind); |
335 | } else { |
336 | croak "'$sql' did not generate a statement."; |
337 | } |
223b8fe3 |
338 | return (wantarray ? ($rv, $sth, @bind) : $rv); |
339 | } |
340 | |
8b445e33 |
341 | sub insert { |
342 | my ($self, $ident, $to_insert) = @_; |
701da8c4 |
343 | croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" ) |
a4b2f17b |
344 | unless ($self->_execute('insert' => [], $ident, $to_insert)); |
8b445e33 |
345 | return $to_insert; |
346 | } |
347 | |
348 | sub update { |
223b8fe3 |
349 | return shift->_execute('update' => [], @_); |
8b445e33 |
350 | } |
351 | |
352 | sub delete { |
223b8fe3 |
353 | return shift->_execute('delete' => [], @_); |
8b445e33 |
354 | } |
355 | |
de705b51 |
356 | sub _select { |
8b445e33 |
357 | my ($self, $ident, $select, $condition, $attrs) = @_; |
223b8fe3 |
358 | my $order = $attrs->{order_by}; |
359 | if (ref $condition eq 'SCALAR') { |
360 | $order = $1 if $$condition =~ s/ORDER BY (.*)$//i; |
361 | } |
54540863 |
362 | if (exists $attrs->{group_by}) { |
363 | $order = { group_by => $attrs->{group_by}, |
364 | ($order ? (order_by => $order) : ()) }; |
365 | } |
5c91499f |
366 | my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order); |
9229f20a |
367 | if ($attrs->{software_limit} || |
368 | $self->sql_maker->_default_limit_syntax eq "GenericSubQ") { |
369 | $attrs->{software_limit} = 1; |
5c91499f |
370 | } else { |
371 | push @args, $attrs->{rows}, $attrs->{offset}; |
372 | } |
de705b51 |
373 | return $self->_execute(@args); |
374 | } |
375 | |
376 | sub select { |
377 | my $self = shift; |
378 | my ($ident, $select, $condition, $attrs) = @_; |
cb5f2eea |
379 | return $self->cursor->new($self, \@_, $attrs); |
8b445e33 |
380 | } |
381 | |
6157db4f |
382 | # Need to call finish() to work round broken DBDs |
383 | |
1a14aa3f |
384 | sub select_single { |
de705b51 |
385 | my $self = shift; |
386 | my ($rv, $sth, @bind) = $self->_select(@_); |
6157db4f |
387 | my @row = $sth->fetchrow_array; |
388 | $sth->finish(); |
389 | return @row; |
1a14aa3f |
390 | } |
391 | |
8b445e33 |
392 | sub sth { |
cb5f2eea |
393 | my ($self, $sql) = @_; |
91fa659e |
394 | # 3 is the if_active parameter which avoids active sth re-use |
395 | return $self->dbh->prepare_cached($sql, {}, 3); |
8b445e33 |
396 | } |
397 | |
a953d8d9 |
398 | =head2 columns_info_for |
399 | |
400 | Returns database type info for a given table columns. |
401 | |
402 | =cut |
403 | |
404 | sub columns_info_for { |
405 | my ($self, $table) = @_; |
a953d8d9 |
406 | my %result; |
103e3e03 |
407 | if ( $self->dbh->can( 'column_info' ) ){ |
408 | my $sth = $self->dbh->column_info( undef, undef, $table, '%' ); |
409 | $sth->execute(); |
410 | while ( my $info = $sth->fetchrow_hashref() ){ |
411 | my %column_info; |
a953d8d9 |
412 | $column_info{data_type} = $info->{TYPE_NAME}; |
413 | $column_info{size} = $info->{COLUMN_SIZE}; |
414 | $column_info{is_nullable} = $info->{NULLABLE}; |
103e3e03 |
415 | $result{$info->{COLUMN_NAME}} = \%column_info; |
416 | } |
417 | }else{ |
418 | my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0"); |
419 | $sth->execute; |
420 | my @columns = @{$sth->{NAME}}; |
421 | for my $i ( 0 .. $#columns ){ |
422 | $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i]; |
a953d8d9 |
423 | } |
a953d8d9 |
424 | } |
425 | return \%result; |
426 | } |
427 | |
92925617 |
428 | sub DESTROY { shift->disconnect } |
429 | |
8b445e33 |
430 | 1; |
431 | |
92b858c9 |
432 | =head1 ENVIRONMENT VARIABLES |
433 | |
434 | =head2 DBIX_CLASS_STORAGE_DBI_DEBUG |
435 | |
436 | If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information |
437 | is produced (as when the L<debug> method is set). |
438 | |
439 | If the value is of the form C<1=/path/name> then the trace output is |
440 | written to the file C</path/name>. |
441 | |
8b445e33 |
442 | =head1 AUTHORS |
443 | |
daec44b8 |
444 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
8b445e33 |
445 | |
9f19b1d6 |
446 | Andy Grundman <andy@hybridized.org> |
447 | |
8b445e33 |
448 | =head1 LICENSE |
449 | |
450 | You may distribute this code under the same terms as Perl itself. |
451 | |
452 | =cut |
453 | |