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});
72 $ret = $self->SUPER::_order_by(@_);
77 sub _order_directions {
78 my ($self, $order) = @_;
79 $order = $order->{order_by} if ref $order eq 'HASH';
80 return $self->SUPER::_order_directions($order);
84 my ($self, $from) = @_;
85 if (ref $from eq 'ARRAY') {
86 return $self->_recurse_from(@$from);
87 } elsif (ref $from eq 'HASH') {
88 return $self->_make_as($from);
95 my ($self, $from, @join) = @_;
97 push(@sqlf, $self->_make_as($from));
98 foreach my $j (@join) {
101 # check whether a join type exists
102 my $join_clause = '';
103 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
104 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
106 $join_clause = ' JOIN ';
108 push(@sqlf, $join_clause);
110 if (ref $to eq 'ARRAY') {
111 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
113 push(@sqlf, $self->_make_as($to));
115 push(@sqlf, ' ON ', $self->_join_condition($on));
117 return join('', @sqlf);
121 my ($self, $from) = @_;
122 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
123 reverse each %{$self->_skip_options($from)});
127 my ($self, $hash) = @_;
129 $clean_hash->{$_} = $hash->{$_}
130 for grep {!/^-/} keys %$hash;
134 sub _join_condition {
135 my ($self, $cond) = @_;
136 if (ref $cond eq 'HASH') {
138 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
139 return $self->_recurse_where(\%j);
140 } elsif (ref $cond eq 'ARRAY') {
141 return join(' OR ', map { $self->_join_condition($_) } @$cond);
143 die "Can't handle this yet!";
148 my ($self, $label) = @_;
149 return '' unless defined $label;
150 return $label unless $self->{quote_char};
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')) || $new->throw_exception("Cannot open trace file $1");
213 $new->debugfh(IO::File->new('>&STDERR'));
215 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
219 sub throw_exception {
220 my ($self, $msg) = @_;
226 DBIx::Class::Storage::DBI - DBI storage handler
232 This class represents the connection to the database
240 Executes the sql statements given as a listref on every db connect.
244 Causes SQL trace information to be emitted on C<debugfh> filehandle
245 (or C<STDERR> if C<debugfh> has not specifically been set).
249 Sets or retrieves the filehandle used for trace/debug output. This
250 should be an IO::Handle compatible object (only the C<print> method is
251 used). Initially set to be STDERR - although see information on the
252 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
256 Sets a callback to be executed each time a statement is run; takes a sub
257 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
258 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
264 my ($self, $cb) = @_;
265 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
266 $self->debugfh($cb_obj);
272 if( $self->connected ) {
273 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
274 $self->_dbh->disconnect;
283 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
286 sub ensure_connected {
289 unless ($self->connected) {
290 $self->_populate_dbh;
297 if($self->_connection_pid && $self->_connection_pid != $$) {
298 $self->_dbh->{InactiveDestroy} = 1;
301 $self->ensure_connected;
307 unless ($self->_sql_maker) {
308 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
310 return $self->_sql_maker;
315 my @info = @{$self->connect_info || []};
316 $self->_dbh($self->_connect(@info));
317 my $driver = $self->_dbh->{Driver}->{Name};
318 eval "require DBIx::Class::Storage::DBI::${driver}";
320 bless $self, "DBIx::Class::Storage::DBI::${driver}";
322 # if on-connect sql statements are given execute them
323 foreach my $sql_statement (@{$self->on_connect_do || []}) {
324 $self->_dbh->do($sql_statement);
327 $self->_connection_pid($$);
331 my ($self, @info) = @_;
333 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
334 my $old_connect_via = $DBI::connect_via;
335 $DBI::connect_via = 'connect';
336 my $dbh = DBI->connect(@info);
337 $DBI::connect_via = $old_connect_via;
341 my $dbh = DBI->connect(@info);
342 $self->throw_exception("DBI Connection failed: $DBI::errstr")
349 Calls begin_work on the current dbh.
351 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
352 an entire code block to be executed transactionally.
358 $self->dbh->begin_work
359 if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
364 Issues a commit against the current dbh.
370 if ($self->{transaction_depth} == 0) {
371 $self->dbh->commit unless $self->dbh->{AutoCommit};
374 $self->dbh->commit if --$self->{transaction_depth} == 0;
380 Issues a rollback against the current dbh. A nested rollback will
381 throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception,
382 which allows the rollback to propagate to the outermost transaction.
390 if ($self->{transaction_depth} == 0) {
391 $self->dbh->rollback unless $self->dbh->{AutoCommit};
394 --$self->{transaction_depth} == 0 ?
395 $self->dbh->rollback :
396 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
402 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
403 $error =~ /$exception_class/ and $self->throw_exception($error);
404 $self->{transaction_depth} = 0; # ensure that a failed rollback
405 $self->throw_exception($error); # resets the transaction depth
410 my ($self, $op, $extra_bind, $ident, @args) = @_;
411 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
412 unshift(@bind, @$extra_bind) if $extra_bind;
414 my @debug_bind = map { defined $_ ? qq{`$_'} : q{`NULL'} } @bind;
415 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
417 my $sth = $self->sth($sql,$op);
418 $self->throw_exception("no sth generated via sql: $sql") unless $sth;
419 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
422 $rv = $sth->execute(@bind);
424 $self->throw_exception("'$sql' did not generate a statement.");
426 return (wantarray ? ($rv, $sth, @bind) : $rv);
430 my ($self, $ident, $to_insert) = @_;
431 $self->throw_exception( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
432 unless ($self->_execute('insert' => [], $ident, $to_insert));
437 return shift->_execute('update' => [], @_);
441 return shift->_execute('delete' => [], @_);
445 my ($self, $ident, $select, $condition, $attrs) = @_;
446 my $order = $attrs->{order_by};
447 if (ref $condition eq 'SCALAR') {
448 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
450 if (exists $attrs->{group_by} || $attrs->{having}) {
451 $order = { group_by => $attrs->{group_by},
452 having => $attrs->{having},
453 ($order ? (order_by => $order) : ()) };
455 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
456 if ($attrs->{software_limit} ||
457 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
458 $attrs->{software_limit} = 1;
460 push @args, $attrs->{rows}, $attrs->{offset};
462 return $self->_execute(@args);
467 my ($ident, $select, $condition, $attrs) = @_;
468 return $self->cursor->new($self, \@_, $attrs);
471 # Need to call finish() to work round broken DBDs
475 my ($rv, $sth, @bind) = $self->_select(@_);
476 my @row = $sth->fetchrow_array;
482 my ($self, $sql) = @_;
483 # 3 is the if_active parameter which avoids active sth re-use
484 return $self->dbh->prepare_cached($sql, {}, 3);
487 =head2 columns_info_for
489 Returns database type info for a given table columns.
493 sub columns_info_for {
494 my ($self, $table) = @_;
496 if ( $self->dbh->can( 'column_info' ) ){
497 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
499 while ( my $info = $sth->fetchrow_hashref() ){
501 $column_info{data_type} = $info->{TYPE_NAME};
502 $column_info{size} = $info->{COLUMN_SIZE};
503 $column_info{is_nullable} = $info->{NULLABLE};
504 $result{$info->{COLUMN_NAME}} = \%column_info;
507 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
509 my @columns = @{$sth->{NAME}};
510 for my $i ( 0 .. $#columns ){
511 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
518 my ($self, $row) = @_;
520 return $self->dbh->func('last_insert_rowid');
526 my $dsn = $self->connect_info->[0];
527 $dsn =~ /^dbi:(.*?)\d*:/;
531 sub deployment_statements {
532 my ($self, $schema, $type) = @_;
533 $type ||= $self->sqlt_type;
534 eval "use SQL::Translator";
535 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
536 eval "use SQL::Translator::Parser::DBIx::Class;";
537 $self->throw_exception($@) if $@;
538 eval "use SQL::Translator::Producer::${type};";
539 $self->throw_exception($@) if $@;
540 my $tr = SQL::Translator->new();
541 SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
542 return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
546 my ($self, $schema, $type) = @_;
547 foreach(split(";\n", $self->deployment_statements($schema, $type))) {
548 $self->dbh->do($_) or warn "SQL was:\n $_";
552 sub DESTROY { shift->disconnect }
556 =head1 ENVIRONMENT VARIABLES
558 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
560 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
561 is produced (as when the L<debug> method is set).
563 If the value is of the form C<1=/path/name> then the trace output is
564 written to the file C</path/name>.
568 Matt S. Trout <mst@shadowcatsystems.co.uk>
570 Andy Grundman <andy@hybridized.org>
574 You may distribute this code under the same terms as Perl itself.