1 package DBIx::Class::Storage::DBI;
6 use SQL::Abstract::Limit;
7 use DBIx::Class::Storage::DBI::Cursor;
9 use Carp::Clan qw/DBIx::Class/;
13 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
15 use base qw/SQL::Abstract::Limit/;
18 my ($self, $table, $fields, $where, $order, @rest) = @_;
19 @rest = (-1) unless defined $rest[0];
20 $self->SUPER::select($table, $self->_recurse_fields($fields),
21 $where, $order, @rest);
27 return $_[1].$self->_order_by($_[2]);
29 return $self->SUPER::_emulate_limit(@_);
34 my ($self, $fields) = @_;
35 my $ref = ref $fields;
36 return $self->_quote($fields) unless $ref;
37 return $$fields if $ref eq 'SCALAR';
39 if ($ref eq 'ARRAY') {
40 return join(', ', map { $self->_recurse_fields($_) } @$fields);
41 } elsif ($ref eq 'HASH') {
42 foreach my $func (keys %$fields) {
43 return $self->_sqlcase($func)
44 .'( '.$self->_recurse_fields($fields->{$func}).' )';
52 if (ref $_[0] eq 'HASH') {
53 if (defined $_[0]->{group_by}) {
54 $ret = $self->_sqlcase(' group by ')
55 .$self->_recurse_fields($_[0]->{group_by});
57 if (defined $_[0]->{order_by}) {
58 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
61 $ret = $self->SUPER::_order_by(@_);
67 my ($self, $from) = @_;
68 if (ref $from eq 'ARRAY') {
69 return $self->_recurse_from(@$from);
70 } elsif (ref $from eq 'HASH') {
71 return $self->_make_as($from);
78 my ($self, $from, @join) = @_;
80 push(@sqlf, $self->_make_as($from));
81 foreach my $j (@join) {
84 # check whether a join type exists
86 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
87 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
89 $join_clause = ' JOIN ';
91 push(@sqlf, $join_clause);
93 if (ref $to eq 'ARRAY') {
94 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
96 push(@sqlf, $self->_make_as($to));
98 push(@sqlf, ' ON ', $self->_join_condition($on));
100 return join('', @sqlf);
104 my ($self, $from) = @_;
105 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
106 reverse each %{$self->_skip_options($from)});
110 my ($self, $hash) = @_;
112 $clean_hash->{$_} = $hash->{$_}
113 for grep {!/^-/} keys %$hash;
117 sub _join_condition {
118 my ($self, $cond) = @_;
119 if (ref $cond eq 'HASH') {
121 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
122 return $self->_recurse_where(\%j);
123 } elsif (ref $cond eq 'ARRAY') {
124 return join(' OR ', map { $self->_join_condition($_) } @$cond);
126 die "Can't handle this yet!";
131 my ($self, $label) = @_;
132 return '' unless defined $label;
133 return $label unless $self->{quote_char};
134 return $self->SUPER::_quote($label);
137 # Accessor for setting limit dialect. This is useful
138 # for JDBC-bridge among others where the remote SQL-dialect cannot
139 # be determined by the name of the driver alone.
143 $self->{limit_dialect} = shift if @_;
144 return $self->{limit_dialect};
147 package DBIx::Class::Storage::DBI::DebugCallback;
150 my ($self, $string) = @_;
151 $string =~ m/^(\w+)/;
152 ${$self}->($1, $string);
155 } # End of BEGIN block
157 use base qw/DBIx::Class/;
159 __PACKAGE__->load_components(qw/AccessorGroup/);
161 __PACKAGE__->mk_group_accessors('simple' =>
162 qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/);
165 my $new = bless({}, ref $_[0] || $_[0]);
166 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
167 $new->transaction_depth(0);
168 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
169 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
170 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
172 $new->debugfh(IO::File->new('>&STDERR'));
174 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
180 DBIx::Class::Storage::DBI - DBI storage handler
186 This class represents the connection to the database
194 Executes the sql statements given as a listref on every db connect.
198 Causes SQL trace information to be emitted on C<debugfh> filehandle
199 (or C<STDERR> if C<debugfh> has not specifically been set).
203 Sets or retrieves the filehandle used for trace/debug output. This
204 should be an IO::Handle compatible object (only the C<print> method is
205 used). Initially set to be STDERR - although see information on the
206 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
210 Sets a callback to be executed each time a statement is run; takes a sub
211 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
212 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
218 my ($self, $cb) = @_;
219 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
220 $self->debugfh($cb_obj);
226 if( $self->connected ) {
227 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
228 $self->_dbh->disconnect;
237 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
240 sub ensure_connected {
243 unless ($self->connected) {
244 $self->_populate_dbh;
251 $self->ensure_connected;
257 unless ($self->_sql_maker) {
258 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
260 return $self->_sql_maker;
265 my @info = @{$self->connect_info || []};
266 $self->_dbh($self->_connect(@info));
267 my $driver = $self->_dbh->{Driver}->{Name};
268 eval "require DBIx::Class::Storage::DBI::${driver}";
270 bless $self, "DBIx::Class::Storage::DBI::${driver}";
272 # if on-connect sql statements are given execute them
273 foreach my $sql_statement (@{$self->on_connect_do || []}) {
274 $self->_dbh->do($sql_statement);
279 my ($self, @info) = @_;
280 return DBI->connect(@info);
285 Calls begin_work on the current dbh.
291 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
296 Issues a commit against the current dbh.
302 if ($self->{transaction_depth} == 0) {
303 $self->dbh->commit unless $self->dbh->{AutoCommit};
306 $self->dbh->commit if --$self->{transaction_depth} == 0;
312 Issues a rollback against the current dbh.
318 if ($self->{transaction_depth} == 0) {
319 $self->dbh->rollback unless $self->dbh->{AutoCommit};
322 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
327 my ($self, $op, $extra_bind, $ident, @args) = @_;
328 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
329 unshift(@bind, @$extra_bind) if $extra_bind;
331 my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind;
332 $self->debugfh->print("$sql: @debug_bind\n");
334 my $sth = $self->sth($sql,$op);
335 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
338 $rv = $sth->execute(@bind);
340 croak "'$sql' did not generate a statement.";
342 return (wantarray ? ($rv, $sth, @bind) : $rv);
346 my ($self, $ident, $to_insert) = @_;
347 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
348 unless ($self->_execute('insert' => [], $ident, $to_insert));
353 return shift->_execute('update' => [], @_);
357 return shift->_execute('delete' => [], @_);
361 my ($self, $ident, $select, $condition, $attrs) = @_;
362 my $order = $attrs->{order_by};
363 if (ref $condition eq 'SCALAR') {
364 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
366 if (exists $attrs->{group_by}) {
367 $order = { group_by => $attrs->{group_by},
368 ($order ? (order_by => $order) : ()) };
370 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
371 if ($attrs->{software_limit} ||
372 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
373 $attrs->{software_limit} = 1;
375 push @args, $attrs->{rows}, $attrs->{offset};
377 return $self->_execute(@args);
382 my ($ident, $select, $condition, $attrs) = @_;
383 return $self->cursor->new($self, \@_, $attrs);
386 # Need to call finish() to work round broken DBDs
390 my ($rv, $sth, @bind) = $self->_select(@_);
391 my @row = $sth->fetchrow_array;
397 my ($self, $sql) = @_;
398 # 3 is the if_active parameter which avoids active sth re-use
399 return $self->dbh->prepare_cached($sql, {}, 3);
402 =head2 columns_info_for
404 Returns database type info for a given table columns.
408 sub columns_info_for {
409 my ($self, $table) = @_;
411 if ( $self->dbh->can( 'column_info' ) ){
412 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
414 while ( my $info = $sth->fetchrow_hashref() ){
416 $column_info{data_type} = $info->{TYPE_NAME};
417 $column_info{size} = $info->{COLUMN_SIZE};
418 $column_info{is_nullable} = $info->{NULLABLE};
419 $result{$info->{COLUMN_NAME}} = \%column_info;
422 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
424 my @columns = @{$sth->{NAME}};
425 for my $i ( 0 .. $#columns ){
426 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
433 my ($self, $row) = @_;
435 return $self->dbh->func('last_insert_rowid');
441 sub DESTROY { shift->disconnect }
445 =head1 ENVIRONMENT VARIABLES
447 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
449 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
450 is produced (as when the L<debug> method is set).
452 If the value is of the form C<1=/path/name> then the trace output is
453 written to the file C</path/name>.
457 Matt S. Trout <mst@shadowcatsystems.co.uk>
459 Andy Grundman <andy@hybridized.org>
463 You may distribute this code under the same terms as Perl itself.