1 package DBIx::Class::Storage::DBI;
3 use base 'DBIx::Class::Storage';
8 use SQL::Abstract::Limit;
9 use DBIx::Class::Storage::DBI::Cursor;
11 use Carp::Clan qw/DBIx::Class/;
15 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
17 use base qw/SQL::Abstract::Limit/;
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);
29 return $_[1].$self->_order_by($_[2]);
31 return $self->SUPER::_emulate_limit(@_);
36 my ($self, $fields) = @_;
37 my $ref = ref $fields;
38 return $self->_quote($fields) unless $ref;
39 return $$fields if $ref eq 'SCALAR';
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}).' )';
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});
59 if (defined $_[0]->{order_by}) {
60 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
63 $ret = $self->SUPER::_order_by(@_);
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);
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);
86 my ($self, $from, @join) = @_;
88 push(@sqlf, $self->_make_as($from));
89 foreach my $j (@join) {
92 # check whether a join type exists
94 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
95 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
97 $join_clause = ' JOIN ';
99 push(@sqlf, $join_clause);
101 if (ref $to eq 'ARRAY') {
102 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
104 push(@sqlf, $self->_make_as($to));
106 push(@sqlf, ' ON ', $self->_join_condition($on));
108 return join('', @sqlf);
112 my ($self, $from) = @_;
113 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
114 reverse each %{$self->_skip_options($from)});
118 my ($self, $hash) = @_;
120 $clean_hash->{$_} = $hash->{$_}
121 for grep {!/^-/} keys %$hash;
125 sub _join_condition {
126 my ($self, $cond) = @_;
127 if (ref $cond eq 'HASH') {
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);
134 die "Can't handle this yet!";
139 my ($self, $label) = @_;
140 return '' unless defined $label;
141 return "*" if $label eq '*';
142 return $label unless $self->{quote_char};
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));
151 return $self->SUPER::_quote($label);
157 $_[0] =~ s/SELECT (.*?) FROM/
158 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
159 $self->SUPER::_RowNum(@_);
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.
168 $self->{limit_dialect} = shift if @_;
169 return $self->{limit_dialect};
174 $self->{quote_char} = shift if @_;
175 return $self->{quote_char};
180 $self->{name_sep} = shift if @_;
181 return $self->{name_sep};
187 package DBIx::Class::Storage::DBI::DebugCallback;
190 my ($self, $string) = @_;
191 $string =~ m/^(\w+)/;
192 ${$self}->($1, $string);
195 } # End of BEGIN block
197 use base qw/DBIx::Class/;
199 __PACKAGE__->load_components(qw/AccessorGroup/);
201 __PACKAGE__->mk_group_accessors('simple' =>
202 qw/connect_info _dbh _sql_maker _connection_pid debug debugfh cursor
203 on_connect_do transaction_depth/);
206 my $new = bless({}, ref $_[0] || $_[0]);
207 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
208 $new->transaction_depth(0);
209 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
210 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
211 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
213 $new->debugfh(IO::File->new('>&STDERR'));
215 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
221 DBIx::Class::Storage::DBI - DBI storage handler
227 This class represents the connection to the database
235 Executes the sql statements given as a listref on every db connect.
239 Causes SQL trace information to be emitted on C<debugfh> filehandle
240 (or C<STDERR> if C<debugfh> has not specifically been set).
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.
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
259 my ($self, $cb) = @_;
260 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
261 $self->debugfh($cb_obj);
267 if( $self->connected ) {
268 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
269 $self->_dbh->disconnect;
278 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
281 sub ensure_connected {
284 unless ($self->connected) {
285 $self->_populate_dbh;
292 if($self->_connection_pid && $self->_connection_pid != $$) {
293 $self->_dbh->{InactiveDestroy} = 1;
296 $self->ensure_connected;
302 unless ($self->_sql_maker) {
303 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
305 return $self->_sql_maker;
310 my @info = @{$self->connect_info || []};
311 $self->_dbh($self->_connect(@info));
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);
318 $self->_connection_pid($$);
322 my ($self, @info) = @_;
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;
337 Calls begin_work on the current dbh.
339 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
340 an entire code block to be executed transactionally.
346 $self->dbh->begin_work
347 if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
352 Issues a commit against the current dbh.
358 if ($self->{transaction_depth} == 0) {
359 $self->dbh->commit unless $self->dbh->{AutoCommit};
362 $self->dbh->commit if --$self->{transaction_depth} == 0;
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.
378 if ($self->{transaction_depth} == 0) {
379 $self->dbh->rollback unless $self->dbh->{AutoCommit};
382 --$self->{transaction_depth} == 0 ?
383 $self->dbh->rollback :
384 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
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
398 my ($self, $op, $extra_bind, $ident, @args) = @_;
399 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
400 unshift(@bind, @$extra_bind) if $extra_bind;
402 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
403 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
405 my $sth = $self->sth($sql,$op);
406 croak "no sth generated via sql: $sql" unless $sth;
407 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
410 $rv = $sth->execute(@bind);
412 croak "'$sql' did not generate a statement.";
414 return (wantarray ? ($rv, $sth, @bind) : $rv);
418 my ($self, $ident, $to_insert) = @_;
419 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
420 unless ($self->_execute('insert' => [], $ident, $to_insert));
425 return shift->_execute('update' => [], @_);
429 return shift->_execute('delete' => [], @_);
433 my ($self, $ident, $select, $condition, $attrs) = @_;
434 my $order = $attrs->{order_by};
435 if (ref $condition eq 'SCALAR') {
436 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
438 if (exists $attrs->{group_by}) {
439 $order = { group_by => $attrs->{group_by},
440 ($order ? (order_by => $order) : ()) };
442 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
443 if ($attrs->{software_limit} ||
444 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
445 $attrs->{software_limit} = 1;
447 push @args, $attrs->{rows}, $attrs->{offset};
449 return $self->_execute(@args);
454 my ($ident, $select, $condition, $attrs) = @_;
455 return $self->cursor->new($self, \@_, $attrs);
458 # Need to call finish() to work round broken DBDs
462 my ($rv, $sth, @bind) = $self->_select(@_);
463 my @row = $sth->fetchrow_array;
469 my ($self, $sql) = @_;
470 # 3 is the if_active parameter which avoids active sth re-use
471 return $self->dbh->prepare_cached($sql, {}, 3);
474 =head2 columns_info_for
476 Returns database type info for a given table columns.
480 sub columns_info_for {
481 my ($self, $table) = @_;
483 if ( $self->dbh->can( 'column_info' ) ){
484 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
486 while ( my $info = $sth->fetchrow_hashref() ){
488 $column_info{data_type} = $info->{TYPE_NAME};
489 $column_info{size} = $info->{COLUMN_SIZE};
490 $column_info{is_nullable} = $info->{NULLABLE};
491 $result{$info->{COLUMN_NAME}} = \%column_info;
494 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
496 my @columns = @{$sth->{NAME}};
497 for my $i ( 0 .. $#columns ){
498 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
504 sub DESTROY { shift->disconnect }
508 =head1 ENVIRONMENT VARIABLES
510 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
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).
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>.
520 Matt S. Trout <mst@shadowcatsystems.co.uk>
522 Andy Grundman <andy@hybridized.org>
526 You may distribute this code under the same terms as Perl itself.