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 local $self->{having_bind} = [];
23 my ($sql, @ret) = $self->SUPER::select($table,
24 $self->_recurse_fields($fields), $where, $order, @rest);
25 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
31 return $_[1].$self->_order_by($_[2]);
33 return $self->SUPER::_emulate_limit(@_);
38 my ($self, $fields) = @_;
39 my $ref = ref $fields;
40 return $self->_quote($fields) unless $ref;
41 return $$fields if $ref eq 'SCALAR';
43 if ($ref eq 'ARRAY') {
44 return join(', ', map { $self->_recurse_fields($_) } @$fields);
45 } elsif ($ref eq 'HASH') {
46 foreach my $func (keys %$fields) {
47 return $self->_sqlcase($func)
48 .'( '.$self->_recurse_fields($fields->{$func}).' )';
57 if (ref $_[0] eq 'HASH') {
58 if (defined $_[0]->{group_by}) {
59 $ret = $self->_sqlcase(' group by ')
60 .$self->_recurse_fields($_[0]->{group_by});
62 if (defined $_[0]->{having}) {
64 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
65 push(@{$self->{having_bind}}, @extra);
66 $ret .= $self->_sqlcase(' having ').$frag;
68 if (defined $_[0]->{order_by}) {
69 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
71 } elsif(ref $_[0] eq 'SCALAR') {
72 $ret = $self->_sqlcase(' order by ').${ $_[0] };
74 $ret = $self->SUPER::_order_by(@_);
79 sub _order_directions {
80 my ($self, $order) = @_;
81 $order = $order->{order_by} if ref $order eq 'HASH';
82 return $self->SUPER::_order_directions($order);
86 my ($self, $from) = @_;
87 if (ref $from eq 'ARRAY') {
88 return $self->_recurse_from(@$from);
89 } elsif (ref $from eq 'HASH') {
90 return $self->_make_as($from);
97 my ($self, $from, @join) = @_;
99 push(@sqlf, $self->_make_as($from));
100 foreach my $j (@join) {
103 # check whether a join type exists
104 my $join_clause = '';
105 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
106 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
108 $join_clause = ' JOIN ';
110 push(@sqlf, $join_clause);
112 if (ref $to eq 'ARRAY') {
113 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
115 push(@sqlf, $self->_make_as($to));
117 push(@sqlf, ' ON ', $self->_join_condition($on));
119 return join('', @sqlf);
123 my ($self, $from) = @_;
124 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
125 reverse each %{$self->_skip_options($from)});
129 my ($self, $hash) = @_;
131 $clean_hash->{$_} = $hash->{$_}
132 for grep {!/^-/} keys %$hash;
136 sub _join_condition {
137 my ($self, $cond) = @_;
138 if (ref $cond eq 'HASH') {
140 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
141 return $self->_recurse_where(\%j);
142 } elsif (ref $cond eq 'ARRAY') {
143 return join(' OR ', map { $self->_join_condition($_) } @$cond);
145 die "Can't handle this yet!";
150 my ($self, $label) = @_;
151 return '' unless defined $label;
152 return $label unless $self->{quote_char};
153 return $self->SUPER::_quote($label);
159 $_[0] =~ s/SELECT (.*?) FROM/
160 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
161 $self->SUPER::_RowNum(@_);
164 # Accessor for setting limit dialect. This is useful
165 # for JDBC-bridge among others where the remote SQL-dialect cannot
166 # be determined by the name of the driver alone.
170 $self->{limit_dialect} = shift if @_;
171 return $self->{limit_dialect};
176 $self->{quote_char} = shift if @_;
177 return $self->{quote_char};
182 $self->{name_sep} = shift if @_;
183 return $self->{name_sep};
189 package DBIx::Class::Storage::DBI::DebugCallback;
192 my ($self, $string) = @_;
193 $string =~ m/^(\w+)/;
194 ${$self}->($1, $string);
197 } # End of BEGIN block
199 use base qw/DBIx::Class/;
201 __PACKAGE__->load_components(qw/AccessorGroup/);
203 __PACKAGE__->mk_group_accessors('simple' =>
204 qw/connect_info _dbh _sql_maker _conn_pid _conn_tid debug debugfh
205 cursor on_connect_do transaction_depth/);
208 my $new = bless({}, ref $_[0] || $_[0]);
209 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
210 $new->transaction_depth(0);
211 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
212 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
213 $new->debugfh(IO::File->new($1, 'w')) || $new->throw_exception("Cannot open trace file $1");
215 $new->debugfh(IO::File->new('>&STDERR'));
217 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
221 sub throw_exception {
222 my ($self, $msg) = @_;
228 DBIx::Class::Storage::DBI - DBI storage handler
234 This class represents the connection to the database
242 Executes the sql statements given as a listref on every db connect.
246 Causes SQL trace information to be emitted on C<debugfh> filehandle
247 (or C<STDERR> if C<debugfh> has not specifically been set).
251 Sets or retrieves the filehandle used for trace/debug output. This
252 should be an IO::Handle compatible object (only the C<print> method is
253 used). Initially set to be STDERR - although see information on the
254 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
258 Sets a callback to be executed each time a statement is run; takes a sub
259 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
260 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
266 my ($self, $cb) = @_;
267 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
268 $self->debugfh($cb_obj);
274 if( $self->connected ) {
275 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
276 $self->_dbh->disconnect;
284 if(my $dbh = $self->_dbh) {
285 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
286 $self->_sql_maker(undef);
287 return $self->_dbh(undef);
289 elsif($self->_conn_pid != $$) {
290 $self->_dbh->{InactiveDestroy} = 1;
291 $self->_sql_maker(undef);
292 return $self->_dbh(undef)
294 return ($dbh->FETCH('Active') && $dbh->ping);
300 sub ensure_connected {
303 unless ($self->connected) {
304 $self->_populate_dbh;
311 $self->ensure_connected;
317 unless ($self->_sql_maker) {
318 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
320 return $self->_sql_maker;
325 my @info = @{$self->connect_info || []};
326 $self->_dbh($self->_connect(@info));
327 my $driver = $self->_dbh->{Driver}->{Name};
328 eval "require DBIx::Class::Storage::DBI::${driver}";
330 bless $self, "DBIx::Class::Storage::DBI::${driver}";
332 # if on-connect sql statements are given execute them
333 foreach my $sql_statement (@{$self->on_connect_do || []}) {
334 $self->_dbh->do($sql_statement);
337 $self->_conn_pid($$);
338 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
342 my ($self, @info) = @_;
344 $self->throw_exception("You failed to provide any connection info")
347 my ($old_connect_via, $dbh);
349 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
350 $old_connect_via = $DBI::connect_via;
351 $DBI::connect_via = 'connect';
354 if(ref $info[0] eq 'CODE') {
358 $dbh = DBI->connect(@info);
361 $DBI::connect_via = $old_connect_via if $old_connect_via;
363 $self->throw_exception("DBI Connection failed: $DBI::errstr")
371 Calls begin_work on the current dbh.
373 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
374 an entire code block to be executed transactionally.
380 $self->dbh->begin_work
381 if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
386 Issues a commit against the current dbh.
392 if ($self->{transaction_depth} == 0) {
393 $self->dbh->commit unless $self->dbh->{AutoCommit};
396 $self->dbh->commit if --$self->{transaction_depth} == 0;
402 Issues a rollback against the current dbh. A nested rollback will
403 throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception,
404 which allows the rollback to propagate to the outermost transaction.
412 if ($self->{transaction_depth} == 0) {
413 $self->dbh->rollback unless $self->dbh->{AutoCommit};
416 --$self->{transaction_depth} == 0 ?
417 $self->dbh->rollback :
418 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
424 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
425 $error =~ /$exception_class/ and $self->throw_exception($error);
426 $self->{transaction_depth} = 0; # ensure that a failed rollback
427 $self->throw_exception($error); # resets the transaction depth
432 my ($self, $op, $extra_bind, $ident, @args) = @_;
433 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
434 unshift(@bind, @$extra_bind) if $extra_bind;
436 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
437 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
439 my $sth = $self->sth($sql,$op);
440 $self->throw_exception("no sth generated via sql: $sql") unless $sth;
441 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
444 $rv = $sth->execute(@bind) or $self->throw_exception("Error executing '$sql': " . $sth->errstr);
446 $self->throw_exception("'$sql' did not generate a statement.");
448 return (wantarray ? ($rv, $sth, @bind) : $rv);
452 my ($self, $ident, $to_insert) = @_;
453 $self->throw_exception( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
454 unless ($self->_execute('insert' => [], $ident, $to_insert));
459 return shift->_execute('update' => [], @_);
463 return shift->_execute('delete' => [], @_);
467 my ($self, $ident, $select, $condition, $attrs) = @_;
468 my $order = $attrs->{order_by};
469 if (ref $condition eq 'SCALAR') {
470 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
472 if (exists $attrs->{group_by} || $attrs->{having}) {
473 $order = { group_by => $attrs->{group_by},
474 having => $attrs->{having},
475 ($order ? (order_by => $order) : ()) };
477 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
478 if ($attrs->{software_limit} ||
479 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
480 $attrs->{software_limit} = 1;
482 push @args, $attrs->{rows}, $attrs->{offset};
484 return $self->_execute(@args);
489 my ($ident, $select, $condition, $attrs) = @_;
490 return $self->cursor->new($self, \@_, $attrs);
493 # Need to call finish() to work round broken DBDs
497 my ($rv, $sth, @bind) = $self->_select(@_);
498 my @row = $sth->fetchrow_array;
504 my ($self, $sql) = @_;
505 # 3 is the if_active parameter which avoids active sth re-use
506 return $self->dbh->prepare_cached($sql, {}, 3);
509 =head2 columns_info_for
511 Returns database type info for a given table columns.
515 sub columns_info_for {
516 my ($self, $table) = @_;
518 if ($self->dbh->can('column_info')) {
520 my $old_raise_err = $self->dbh->{RaiseError};
521 my $old_print_err = $self->dbh->{PrintError};
522 $self->dbh->{RaiseError} = 1;
523 $self->dbh->{PrintError} = 0;
525 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
527 while ( my $info = $sth->fetchrow_hashref() ){
529 $column_info{data_type} = $info->{TYPE_NAME};
530 $column_info{size} = $info->{COLUMN_SIZE};
531 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
532 $column_info{default_value} = $info->{COLUMN_DEF};
533 $result{$info->{COLUMN_NAME}} = \%column_info;
536 $self->dbh->{RaiseError} = $old_raise_err;
537 $self->dbh->{PrintError} = $old_print_err;
538 return \%result if !$@;
542 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
544 my @columns = @{$sth->{NAME_lc}};
545 for my $i ( 0 .. $#columns ){
547 my $type_num = $sth->{TYPE}->[$i];
549 if(defined $type_num && $self->dbh->can('type_info')) {
550 my $type_info = $self->dbh->type_info($type_num);
551 $type_name = $type_info->{TYPE_NAME} if $type_info;
553 $column_info{data_type} = $type_name ? $type_name : $type_num;
554 $column_info{size} = $sth->{PRECISION}->[$i];
555 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
556 $result{$columns[$i]} = \%column_info;
563 my ($self, $row) = @_;
565 return $self->dbh->func('last_insert_rowid');
569 sub sqlt_type { shift->dbh->{Driver}->{Name} }
571 sub deployment_statements {
572 my ($self, $schema, $type, $sqltargs) = @_;
573 $type ||= $self->sqlt_type;
574 eval "use SQL::Translator";
575 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
576 eval "use SQL::Translator::Parser::DBIx::Class;";
577 $self->throw_exception($@) if $@;
578 eval "use SQL::Translator::Producer::${type};";
579 $self->throw_exception($@) if $@;
580 my $tr = SQL::Translator->new(%$sqltargs);
581 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
582 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
586 my ($self, $schema, $type, $sqltargs) = @_;
587 foreach(split(";\n", $self->deployment_statements($schema, $type, $sqltargs))) {
588 $self->debugfh->print("$_\n") if $self->debug;
589 $self->dbh->do($_) or warn "SQL was:\n $_";
593 sub DESTROY { shift->disconnect }
597 =head1 ENVIRONMENT VARIABLES
599 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
601 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
602 is produced (as when the L<debug> method is set).
604 If the value is of the form C<1=/path/name> then the trace output is
605 written to the file C</path/name>.
609 Matt S. Trout <mst@shadowcatsystems.co.uk>
611 Andy Grundman <andy@hybridized.org>
615 You may distribute this code under the same terms as Perl itself.