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 $table = $self->_quote($table) unless ref($table);
22 @rest = (-1) unless defined $rest[0];
23 local $self->{having_bind} = [];
24 my ($sql, @ret) = $self->SUPER::select(
25 $table, $self->_recurse_fields($fields), $where, $order, @rest
27 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
33 $table = $self->_quote($table) unless ref($table);
34 $self->SUPER::insert($table, @_);
40 $table = $self->_quote($table) unless ref($table);
41 $self->SUPER::update($table, @_);
47 $table = $self->_quote($table) unless ref($table);
48 $self->SUPER::delete($table, @_);
54 return $_[1].$self->_order_by($_[2]);
56 return $self->SUPER::_emulate_limit(@_);
61 my ($self, $fields) = @_;
62 my $ref = ref $fields;
63 return $self->_quote($fields) unless $ref;
64 return $$fields if $ref eq 'SCALAR';
66 if ($ref eq 'ARRAY') {
67 return join(', ', map { $self->_recurse_fields($_) } @$fields);
68 } elsif ($ref eq 'HASH') {
69 foreach my $func (keys %$fields) {
70 return $self->_sqlcase($func)
71 .'( '.$self->_recurse_fields($fields->{$func}).' )';
80 if (ref $_[0] eq 'HASH') {
81 if (defined $_[0]->{group_by}) {
82 $ret = $self->_sqlcase(' group by ')
83 .$self->_recurse_fields($_[0]->{group_by});
85 if (defined $_[0]->{having}) {
87 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
88 push(@{$self->{having_bind}}, @extra);
89 $ret .= $self->_sqlcase(' having ').$frag;
91 if (defined $_[0]->{order_by}) {
92 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
94 } elsif(ref $_[0] eq 'SCALAR') {
95 $ret = $self->_sqlcase(' order by ').${ $_[0] };
97 $ret = $self->SUPER::_order_by(@_);
102 sub _order_directions {
103 my ($self, $order) = @_;
104 $order = $order->{order_by} if ref $order eq 'HASH';
105 return $self->SUPER::_order_directions($order);
109 my ($self, $from) = @_;
110 if (ref $from eq 'ARRAY') {
111 return $self->_recurse_from(@$from);
112 } elsif (ref $from eq 'HASH') {
113 return $self->_make_as($from);
115 return $from; # would love to quote here but _table ends up getting called
116 # twice during an ->select without a limit clause due to
117 # the way S::A::Limit->select works. should maybe consider
118 # bypassing this and doing S::A::select($self, ...) in
119 # our select method above. meantime, quoting shims have
120 # been added to select/insert/update/delete here
125 my ($self, $from, @join) = @_;
127 push(@sqlf, $self->_make_as($from));
128 foreach my $j (@join) {
131 # check whether a join type exists
132 my $join_clause = '';
133 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
134 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
136 $join_clause = ' JOIN ';
138 push(@sqlf, $join_clause);
140 if (ref $to eq 'ARRAY') {
141 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
143 push(@sqlf, $self->_make_as($to));
145 push(@sqlf, ' ON ', $self->_join_condition($on));
147 return join('', @sqlf);
151 my ($self, $from) = @_;
152 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
153 reverse each %{$self->_skip_options($from)});
157 my ($self, $hash) = @_;
159 $clean_hash->{$_} = $hash->{$_}
160 for grep {!/^-/} keys %$hash;
164 sub _join_condition {
165 my ($self, $cond) = @_;
166 if (ref $cond eq 'HASH') {
169 my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x;
171 return $self->_recurse_where(\%j);
172 } elsif (ref $cond eq 'ARRAY') {
173 return join(' OR ', map { $self->_join_condition($_) } @$cond);
175 die "Can't handle this yet!";
180 my ($self, $label) = @_;
181 return '' unless defined $label;
182 return "*" if $label eq '*';
183 return $label unless $self->{quote_char};
184 if(ref $self->{quote_char} eq "ARRAY"){
185 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
186 if !defined $self->{name_sep};
187 my $sep = $self->{name_sep};
188 return join($self->{name_sep},
189 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
190 split(/\Q$sep\E/,$label));
192 return $self->SUPER::_quote($label);
198 $_[0] =~ s/SELECT (.*?) FROM/
199 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
200 $self->SUPER::_RowNum(@_);
203 # Accessor for setting limit dialect. This is useful
204 # for JDBC-bridge among others where the remote SQL-dialect cannot
205 # be determined by the name of the driver alone.
209 $self->{limit_dialect} = shift if @_;
210 return $self->{limit_dialect};
215 $self->{quote_char} = shift if @_;
216 return $self->{quote_char};
221 $self->{name_sep} = shift if @_;
222 return $self->{name_sep};
228 package DBIx::Class::Storage::DBI::DebugCallback;
231 my ($self, $string) = @_;
232 $string =~ m/^(\w+)/;
233 ${$self}->($1, $string);
236 } # End of BEGIN block
238 use base qw/DBIx::Class/;
240 __PACKAGE__->load_components(qw/AccessorGroup/);
242 __PACKAGE__->mk_group_accessors('simple' =>
243 qw/connect_info _dbh _sql_maker _conn_pid _conn_tid debug debugfh
244 cursor on_connect_do transaction_depth/);
247 my $new = bless({}, ref $_[0] || $_[0]);
248 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
249 $new->transaction_depth(0);
250 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
251 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
252 $new->debugfh(IO::File->new($1, 'w'))
253 or $new->throw_exception("Cannot open trace file $1");
255 $new->debugfh(IO::File->new('>&STDERR'));
257 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
261 sub throw_exception {
262 my ($self, $msg) = @_;
268 DBIx::Class::Storage::DBI - DBI storage handler
274 This class represents the connection to the database
282 Executes the sql statements given as a listref on every db connect.
286 Causes SQL trace information to be emitted on C<debugfh> filehandle
287 (or C<STDERR> if C<debugfh> has not specifically been set).
291 Sets or retrieves the filehandle used for trace/debug output. This
292 should be an IO::Handle compatible object (only the C<print> method is
293 used). Initially set to be STDERR - although see information on the
294 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
298 Sets a callback to be executed each time a statement is run; takes a sub
299 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
300 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
306 my ($self, $cb) = @_;
307 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
308 $self->debugfh($cb_obj);
314 if( $self->connected ) {
315 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
316 $self->_dbh->disconnect;
324 if(my $dbh = $self->_dbh) {
325 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
326 $self->_sql_maker(undef);
327 return $self->_dbh(undef);
329 elsif($self->_conn_pid != $$) {
330 $self->_dbh->{InactiveDestroy} = 1;
331 $self->_sql_maker(undef);
332 return $self->_dbh(undef)
334 return ($dbh->FETCH('Active') && $dbh->ping);
340 sub ensure_connected {
343 unless ($self->connected) {
344 $self->_populate_dbh;
350 Returns the dbh - a data base handle of class L<DBI>.
357 $self->ensure_connected;
363 unless ($self->_sql_maker) {
364 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
366 return $self->_sql_maker;
371 my @info = @{$self->connect_info || []};
372 $self->_dbh($self->_connect(@info));
373 my $driver = $self->_dbh->{Driver}->{Name};
374 eval "require DBIx::Class::Storage::DBI::${driver}";
376 bless $self, "DBIx::Class::Storage::DBI::${driver}";
378 # if on-connect sql statements are given execute them
379 foreach my $sql_statement (@{$self->on_connect_do || []}) {
380 $self->_dbh->do($sql_statement);
383 $self->_conn_pid($$);
384 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
388 my ($self, @info) = @_;
390 $self->throw_exception("You failed to provide any connection info")
393 my ($old_connect_via, $dbh);
395 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
396 $old_connect_via = $DBI::connect_via;
397 $DBI::connect_via = 'connect';
401 if(ref $info[0] eq 'CODE') {
405 $dbh = DBI->connect(@info);
409 $DBI::connect_via = $old_connect_via if $old_connect_via;
412 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
420 Calls begin_work on the current dbh.
422 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
423 an entire code block to be executed transactionally.
429 if ($self->{transaction_depth}++ == 0) {
430 my $dbh = $self->dbh;
431 if ($dbh->{AutoCommit}) {
432 $self->debugfh->print("BEGIN WORK\n")
441 Issues a commit against the current dbh.
447 if ($self->{transaction_depth} == 0) {
448 my $dbh = $self->dbh;
449 unless ($dbh->{AutoCommit}) {
450 $self->debugfh->print("COMMIT\n")
456 if (--$self->{transaction_depth} == 0) {
457 $self->debugfh->print("COMMIT\n")
466 Issues a rollback against the current dbh. A nested rollback will
467 throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception,
468 which allows the rollback to propagate to the outermost transaction.
476 if ($self->{transaction_depth} == 0) {
477 my $dbh = $self->dbh;
478 unless ($dbh->{AutoCommit}) {
479 $self->debugfh->print("ROLLBACK\n")
485 if (--$self->{transaction_depth} == 0) {
486 $self->debugfh->print("ROLLBACK\n")
488 $self->dbh->rollback;
491 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
498 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
499 $error =~ /$exception_class/ and $self->throw_exception($error);
500 $self->{transaction_depth} = 0; # ensure that a failed rollback
501 $self->throw_exception($error); # resets the transaction depth
506 my ($self, $op, $extra_bind, $ident, @args) = @_;
507 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
508 unshift(@bind, @$extra_bind) if $extra_bind;
510 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
511 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
513 my $sth = eval { $self->sth($sql,$op) };
516 $self->throw_exception('no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql");
519 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
522 $rv = eval { $sth->execute(@bind) };
525 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
528 $self->throw_exception("'$sql' did not generate a statement.");
530 return (wantarray ? ($rv, $sth, @bind) : $rv);
534 my ($self, $ident, $to_insert) = @_;
535 $self->throw_exception(
536 "Couldn't insert ".join(', ',
537 map "$_ => $to_insert->{$_}", keys %$to_insert
539 ) unless ($self->_execute('insert' => [], $ident, $to_insert));
544 return shift->_execute('update' => [], @_);
548 return shift->_execute('delete' => [], @_);
552 my ($self, $ident, $select, $condition, $attrs) = @_;
553 my $order = $attrs->{order_by};
554 if (ref $condition eq 'SCALAR') {
555 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
557 if (exists $attrs->{group_by} || $attrs->{having}) {
559 group_by => $attrs->{group_by},
560 having => $attrs->{having},
561 ($order ? (order_by => $order) : ())
564 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
565 if ($attrs->{software_limit} ||
566 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
567 $attrs->{software_limit} = 1;
569 push @args, $attrs->{rows}, $attrs->{offset};
571 return $self->_execute(@args);
576 my ($ident, $select, $condition, $attrs) = @_;
577 return $self->cursor->new($self, \@_, $attrs);
580 # Need to call finish() to work round broken DBDs
584 my ($rv, $sth, @bind) = $self->_select(@_);
585 my @row = $sth->fetchrow_array;
591 my ($self, $sql) = @_;
592 # 3 is the if_active parameter which avoids active sth re-use
593 return $self->dbh->prepare_cached($sql, {}, 3);
596 =head2 columns_info_for
598 Returns database type info for a given table columns.
602 sub columns_info_for {
603 my ($self, $table) = @_;
605 my $dbh = $self->dbh;
607 if ($dbh->can('column_info')) {
609 my $old_raise_err = $dbh->{RaiseError};
610 my $old_print_err = $dbh->{PrintError};
611 $dbh->{RaiseError} = 1;
612 $dbh->{PrintError} = 0;
614 my $sth = $dbh->column_info( undef, undef, $table, '%' );
616 while ( my $info = $sth->fetchrow_hashref() ){
618 $column_info{data_type} = $info->{TYPE_NAME};
619 $column_info{size} = $info->{COLUMN_SIZE};
620 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
621 $column_info{default_value} = $info->{COLUMN_DEF};
623 $result{$info->{COLUMN_NAME}} = \%column_info;
626 $dbh->{RaiseError} = $old_raise_err;
627 $dbh->{PrintError} = $old_print_err;
628 return \%result if !$@;
632 my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
634 my @columns = @{$sth->{NAME_lc}};
635 for my $i ( 0 .. $#columns ){
637 my $type_num = $sth->{TYPE}->[$i];
639 if(defined $type_num && $dbh->can('type_info')) {
640 my $type_info = $dbh->type_info($type_num);
641 $type_name = $type_info->{TYPE_NAME} if $type_info;
643 $column_info{data_type} = $type_name ? $type_name : $type_num;
644 $column_info{size} = $sth->{PRECISION}->[$i];
645 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
647 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
648 $column_info{data_type} = $1;
649 $column_info{size} = $2;
652 $result{$columns[$i]} = \%column_info;
659 my ($self, $row) = @_;
661 return $self->dbh->func('last_insert_rowid');
665 sub sqlt_type { shift->dbh->{Driver}->{Name} }
667 sub deployment_statements {
668 my ($self, $schema, $type, $sqltargs) = @_;
669 $type ||= $self->sqlt_type;
670 eval "use SQL::Translator";
671 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
672 eval "use SQL::Translator::Parser::DBIx::Class;";
673 $self->throw_exception($@) if $@;
674 eval "use SQL::Translator::Producer::${type};";
675 $self->throw_exception($@) if $@;
676 my $tr = SQL::Translator->new(%$sqltargs);
677 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
678 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
682 my ($self, $schema, $type, $sqltargs) = @_;
683 foreach my $statement ( $self->deployment_statements($schema, $type, $sqltargs) ) {
684 for ( split(";\n", $statement)) {
685 $self->debugfh->print("$_\n") if $self->debug;
686 $self->dbh->do($_) or warn "SQL was:\n $_";
691 sub DESTROY { shift->disconnect }
695 =head1 ENVIRONMENT VARIABLES
697 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
699 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
700 is produced (as when the L<debug> method is set).
702 If the value is of the form C<1=/path/name> then the trace output is
703 written to the file C</path/name>.
707 Matt S. Trout <mst@shadowcatsystems.co.uk>
709 Andy Grundman <andy@hybridized.org>
713 You may distribute this code under the same terms as Perl itself.