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(
24 $table, $self->_recurse_fields($fields), $where, $order, @rest
26 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
32 return $_[1].$self->_order_by($_[2]);
34 return $self->SUPER::_emulate_limit(@_);
39 my ($self, $fields) = @_;
40 my $ref = ref $fields;
41 return $self->_quote($fields) unless $ref;
42 return $$fields if $ref eq 'SCALAR';
44 if ($ref eq 'ARRAY') {
45 return join(', ', map { $self->_recurse_fields($_) } @$fields);
46 } elsif ($ref eq 'HASH') {
47 foreach my $func (keys %$fields) {
48 return $self->_sqlcase($func)
49 .'( '.$self->_recurse_fields($fields->{$func}).' )';
58 if (ref $_[0] eq 'HASH') {
59 if (defined $_[0]->{group_by}) {
60 $ret = $self->_sqlcase(' group by ')
61 .$self->_recurse_fields($_[0]->{group_by});
63 if (defined $_[0]->{having}) {
65 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
66 push(@{$self->{having_bind}}, @extra);
67 $ret .= $self->_sqlcase(' having ').$frag;
69 if (defined $_[0]->{order_by}) {
70 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
72 } elsif(ref $_[0] eq 'SCALAR') {
73 $ret = $self->_sqlcase(' order by ').${ $_[0] };
75 $ret = $self->SUPER::_order_by(@_);
80 sub _order_directions {
81 my ($self, $order) = @_;
82 $order = $order->{order_by} if ref $order eq 'HASH';
83 return $self->SUPER::_order_directions($order);
87 my ($self, $from) = @_;
88 if (ref $from eq 'ARRAY') {
89 return $self->_recurse_from(@$from);
90 } elsif (ref $from eq 'HASH') {
91 return $self->_make_as($from);
98 my ($self, $from, @join) = @_;
100 push(@sqlf, $self->_make_as($from));
101 foreach my $j (@join) {
104 # check whether a join type exists
105 my $join_clause = '';
106 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
107 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
109 $join_clause = ' JOIN ';
111 push(@sqlf, $join_clause);
113 if (ref $to eq 'ARRAY') {
114 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
116 push(@sqlf, $self->_make_as($to));
118 push(@sqlf, ' ON ', $self->_join_condition($on));
120 return join('', @sqlf);
124 my ($self, $from) = @_;
125 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
126 reverse each %{$self->_skip_options($from)});
130 my ($self, $hash) = @_;
132 $clean_hash->{$_} = $hash->{$_}
133 for grep {!/^-/} keys %$hash;
137 sub _join_condition {
138 my ($self, $cond) = @_;
139 if (ref $cond eq 'HASH') {
142 my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x;
144 return $self->_recurse_where(\%j);
145 } elsif (ref $cond eq 'ARRAY') {
146 return join(' OR ', map { $self->_join_condition($_) } @$cond);
148 die "Can't handle this yet!";
153 my ($self, $label) = @_;
154 return '' unless defined $label;
155 return "*" if $label eq '*';
156 return $label unless $self->{quote_char};
157 if(ref $self->{quote_char} eq "ARRAY"){
158 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
159 if !defined $self->{name_sep};
160 my $sep = $self->{name_sep};
161 return join($self->{name_sep},
162 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
163 split(/\Q$sep\E/,$label));
165 return $self->SUPER::_quote($label);
171 $_[0] =~ s/SELECT (.*?) FROM/
172 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
173 $self->SUPER::_RowNum(@_);
176 # Accessor for setting limit dialect. This is useful
177 # for JDBC-bridge among others where the remote SQL-dialect cannot
178 # be determined by the name of the driver alone.
182 $self->{limit_dialect} = shift if @_;
183 return $self->{limit_dialect};
188 $self->{quote_char} = shift if @_;
189 return $self->{quote_char};
194 $self->{name_sep} = shift if @_;
195 return $self->{name_sep};
201 package DBIx::Class::Storage::DBI::DebugCallback;
204 my ($self, $string) = @_;
205 $string =~ m/^(\w+)/;
206 ${$self}->($1, $string);
209 } # End of BEGIN block
211 use base qw/DBIx::Class/;
213 __PACKAGE__->load_components(qw/AccessorGroup/);
215 __PACKAGE__->mk_group_accessors('simple' =>
216 qw/connect_info _dbh _sql_maker _conn_pid _conn_tid debug debugfh
217 cursor on_connect_do transaction_depth/);
220 my $new = bless({}, ref $_[0] || $_[0]);
221 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
222 $new->transaction_depth(0);
223 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
224 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
225 $new->debugfh(IO::File->new($1, 'w'))
226 or $new->throw_exception("Cannot open trace file $1");
228 $new->debugfh(IO::File->new('>&STDERR'));
230 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
234 sub throw_exception {
235 my ($self, $msg) = @_;
241 DBIx::Class::Storage::DBI - DBI storage handler
247 This class represents the connection to the database
255 Executes the sql statements given as a listref on every db connect.
259 Causes SQL trace information to be emitted on C<debugfh> filehandle
260 (or C<STDERR> if C<debugfh> has not specifically been set).
264 Sets or retrieves the filehandle used for trace/debug output. This
265 should be an IO::Handle compatible object (only the C<print> method is
266 used). Initially set to be STDERR - although see information on the
267 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
271 Sets a callback to be executed each time a statement is run; takes a sub
272 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
273 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
279 my ($self, $cb) = @_;
280 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
281 $self->debugfh($cb_obj);
287 if( $self->connected ) {
288 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
289 $self->_dbh->disconnect;
297 if(my $dbh = $self->_dbh) {
298 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
299 $self->_sql_maker(undef);
300 return $self->_dbh(undef);
302 elsif($self->_conn_pid != $$) {
303 $self->_dbh->{InactiveDestroy} = 1;
304 $self->_sql_maker(undef);
305 return $self->_dbh(undef)
307 return ($dbh->FETCH('Active') && $dbh->ping);
313 sub ensure_connected {
316 unless ($self->connected) {
317 $self->_populate_dbh;
324 $self->ensure_connected;
330 unless ($self->_sql_maker) {
331 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
333 return $self->_sql_maker;
338 my @info = @{$self->connect_info || []};
339 $self->_dbh($self->_connect(@info));
340 my $driver = $self->_dbh->{Driver}->{Name};
341 eval "require DBIx::Class::Storage::DBI::${driver}";
343 bless $self, "DBIx::Class::Storage::DBI::${driver}";
345 # if on-connect sql statements are given execute them
346 foreach my $sql_statement (@{$self->on_connect_do || []}) {
347 $self->_dbh->do($sql_statement);
350 $self->_conn_pid($$);
351 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
355 my ($self, @info) = @_;
357 $self->throw_exception("You failed to provide any connection info")
360 my ($old_connect_via, $dbh);
362 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
363 $old_connect_via = $DBI::connect_via;
364 $DBI::connect_via = 'connect';
367 if(ref $info[0] eq 'CODE') {
371 $dbh = DBI->connect(@info);
374 $DBI::connect_via = $old_connect_via if $old_connect_via;
376 $self->throw_exception("DBI Connection failed: $DBI::errstr")
384 Calls begin_work on the current dbh.
386 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
387 an entire code block to be executed transactionally.
393 $self->dbh->begin_work
394 if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
399 Issues a commit against the current dbh.
405 if ($self->{transaction_depth} == 0) {
406 $self->dbh->commit unless $self->dbh->{AutoCommit};
409 $self->dbh->commit if --$self->{transaction_depth} == 0;
415 Issues a rollback against the current dbh. A nested rollback will
416 throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception,
417 which allows the rollback to propagate to the outermost transaction.
425 if ($self->{transaction_depth} == 0) {
426 $self->dbh->rollback unless $self->dbh->{AutoCommit};
429 --$self->{transaction_depth} == 0 ?
430 $self->dbh->rollback :
431 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
437 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
438 $error =~ /$exception_class/ and $self->throw_exception($error);
439 $self->{transaction_depth} = 0; # ensure that a failed rollback
440 $self->throw_exception($error); # resets the transaction depth
445 my ($self, $op, $extra_bind, $ident, @args) = @_;
446 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
447 unshift(@bind, @$extra_bind) if $extra_bind;
449 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
450 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
452 my $sth = $self->sth($sql,$op);
453 $self->throw_exception("no sth generated via sql: $sql") unless $sth;
454 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
457 $rv = $sth->execute(@bind)
458 or $self->throw_exception("Error executing '$sql': " . $sth->errstr);
460 $self->throw_exception("'$sql' did not generate a statement.");
462 return (wantarray ? ($rv, $sth, @bind) : $rv);
466 my ($self, $ident, $to_insert) = @_;
467 $self->throw_exception(
468 "Couldn't insert ".join(', ',
469 map "$_ => $to_insert->{$_}", keys %$to_insert
471 ) unless ($self->_execute('insert' => [], $ident, $to_insert));
476 return shift->_execute('update' => [], @_);
480 return shift->_execute('delete' => [], @_);
484 my ($self, $ident, $select, $condition, $attrs) = @_;
485 my $order = $attrs->{order_by};
486 if (ref $condition eq 'SCALAR') {
487 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
489 if (exists $attrs->{group_by} || $attrs->{having}) {
491 group_by => $attrs->{group_by},
492 having => $attrs->{having},
493 ($order ? (order_by => $order) : ())
496 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
497 if ($attrs->{software_limit} ||
498 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
499 $attrs->{software_limit} = 1;
501 push @args, $attrs->{rows}, $attrs->{offset};
503 return $self->_execute(@args);
508 my ($ident, $select, $condition, $attrs) = @_;
509 return $self->cursor->new($self, \@_, $attrs);
512 # Need to call finish() to work round broken DBDs
516 my ($rv, $sth, @bind) = $self->_select(@_);
517 my @row = $sth->fetchrow_array;
523 my ($self, $sql) = @_;
524 # 3 is the if_active parameter which avoids active sth re-use
525 return $self->dbh->prepare_cached($sql, {}, 3);
528 =head2 columns_info_for
530 Returns database type info for a given table columns.
534 sub columns_info_for {
535 my ($self, $table) = @_;
537 if ($self->dbh->can('column_info')) {
539 my $old_raise_err = $self->dbh->{RaiseError};
540 my $old_print_err = $self->dbh->{PrintError};
541 $self->dbh->{RaiseError} = 1;
542 $self->dbh->{PrintError} = 0;
544 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
546 while ( my $info = $sth->fetchrow_hashref() ){
548 $column_info{data_type} = $info->{TYPE_NAME};
549 $column_info{size} = $info->{COLUMN_SIZE};
550 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
551 $column_info{default_value} = $info->{COLUMN_DEF};
553 $result{$info->{COLUMN_NAME}} = \%column_info;
556 $self->dbh->{RaiseError} = $old_raise_err;
557 $self->dbh->{PrintError} = $old_print_err;
558 return \%result if !$@;
562 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
564 my @columns = @{$sth->{NAME_lc}};
565 for my $i ( 0 .. $#columns ){
567 my $type_num = $sth->{TYPE}->[$i];
569 if(defined $type_num && $self->dbh->can('type_info')) {
570 my $type_info = $self->dbh->type_info($type_num);
571 $type_name = $type_info->{TYPE_NAME} if $type_info;
573 $column_info{data_type} = $type_name ? $type_name : $type_num;
574 $column_info{size} = $sth->{PRECISION}->[$i];
575 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
577 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
578 $column_info{data_type} = $1;
579 $column_info{size} = $2;
582 $result{$columns[$i]} = \%column_info;
589 my ($self, $row) = @_;
591 return $self->dbh->func('last_insert_rowid');
595 sub sqlt_type { shift->dbh->{Driver}->{Name} }
597 sub deployment_statements {
598 my ($self, $schema, $type, $sqltargs) = @_;
599 $type ||= $self->sqlt_type;
600 eval "use SQL::Translator";
601 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
602 eval "use SQL::Translator::Parser::DBIx::Class;";
603 $self->throw_exception($@) if $@;
604 eval "use SQL::Translator::Producer::${type};";
605 $self->throw_exception($@) if $@;
606 my $tr = SQL::Translator->new(%$sqltargs);
607 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
608 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
612 my ($self, $schema, $type, $sqltargs) = @_;
613 my @statements = $self->deployment_statements($schema, $type, $sqltargs);
614 foreach(split(";\n", @statements)) {
615 $self->debugfh->print("$_\n") if $self->debug;
616 $self->dbh->do($_) or warn "SQL was:\n $_";
620 sub DESTROY { shift->disconnect }
624 =head1 ENVIRONMENT VARIABLES
626 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
628 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
629 is produced (as when the L<debug> method is set).
631 If the value is of the form C<1=/path/name> then the trace output is
632 written to the file C</path/name>.
636 Matt S. Trout <mst@shadowcatsystems.co.uk>
638 Andy Grundman <andy@hybridized.org>
642 You may distribute this code under the same terms as Perl itself.