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 $self->SUPER::_quote($label);
136 # Accessor for setting limit dialect. This is useful
137 # for JDBC-bridge among others where the remote SQL-dialect cannot
138 # be determined by the name of the driver alone.
142 $self->{limit_dialect} = shift if @_;
143 return $self->{limit_dialect};
146 package DBIx::Class::Storage::DBI::DebugCallback;
149 my ($self, $string) = @_;
150 $string =~ m/^(\w+)/;
151 ${$self}->($1, $string);
154 } # End of BEGIN block
156 use base qw/DBIx::Class/;
158 __PACKAGE__->load_components(qw/AccessorGroup/);
160 __PACKAGE__->mk_group_accessors('simple' =>
161 qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/);
164 my $new = bless({}, ref $_[0] || $_[0]);
165 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
166 $new->transaction_depth(0);
167 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
168 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
169 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
171 $new->debugfh(IO::File->new('>&STDERR'));
173 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
179 DBIx::Class::Storage::DBI - DBI storage handler
185 This class represents the connection to the database
193 Executes the sql statements given as a listref on every db connect.
197 Causes SQL trace information to be emitted on C<debugfh> filehandle
198 (or C<STDERR> if C<debugfh> has not specifically been set).
202 Sets or retrieves the filehandle used for trace/debug output. This
203 should be an IO::Handle compatible object (only the C<print> method is
204 used). Initially set to be STDERR - although see information on the
205 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
209 Sets a callback to be executed each time a statement is run; takes a sub
210 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
211 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
217 my ($self, $cb) = @_;
218 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
219 $self->debugfh($cb_obj);
225 if( $self->connected ) {
226 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
227 $self->_dbh->disconnect;
236 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
239 sub ensure_connected {
242 unless ($self->connected) {
243 $self->_populate_dbh;
250 $self->ensure_connected;
256 unless ($self->_sql_maker) {
257 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
259 return $self->_sql_maker;
264 my @info = @{$self->connect_info || []};
265 $self->_dbh($self->_connect(@info));
266 my $driver = $self->_dbh->{Driver}->{Name};
267 eval "require DBIx::Class::Storage::DBI::${driver}";
269 bless $self, "DBIx::Class::Storage::DBI::${driver}";
271 # if on-connect sql statements are given execute them
272 foreach my $sql_statement (@{$self->on_connect_do || []}) {
273 $self->_dbh->do($sql_statement);
278 my ($self, @info) = @_;
279 return DBI->connect(@info);
284 Calls begin_work on the current dbh.
290 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
295 Issues a commit against the current dbh.
301 if ($self->{transaction_depth} == 0) {
302 $self->dbh->commit unless $self->dbh->{AutoCommit};
305 $self->dbh->commit if --$self->{transaction_depth} == 0;
311 Issues a rollback against the current dbh.
317 if ($self->{transaction_depth} == 0) {
318 $self->dbh->rollback unless $self->dbh->{AutoCommit};
321 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
326 my ($self, $op, $extra_bind, $ident, @args) = @_;
327 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
328 unshift(@bind, @$extra_bind) if $extra_bind;
330 my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind;
331 $self->debugfh->print("$sql: @debug_bind\n");
333 my $sth = $self->sth($sql,$op);
334 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
337 $rv = $sth->execute(@bind);
339 croak "'$sql' did not generate a statement.";
341 return (wantarray ? ($rv, $sth, @bind) : $rv);
345 my ($self, $ident, $to_insert) = @_;
346 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
347 unless ($self->_execute('insert' => [], $ident, $to_insert));
352 return shift->_execute('update' => [], @_);
356 return shift->_execute('delete' => [], @_);
360 my ($self, $ident, $select, $condition, $attrs) = @_;
361 my $order = $attrs->{order_by};
362 if (ref $condition eq 'SCALAR') {
363 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
365 if (exists $attrs->{group_by}) {
366 $order = { group_by => $attrs->{group_by},
367 ($order ? (order_by => $order) : ()) };
369 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
370 if ($attrs->{software_limit} ||
371 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
372 $attrs->{software_limit} = 1;
374 push @args, $attrs->{rows}, $attrs->{offset};
376 return $self->_execute(@args);
381 my ($ident, $select, $condition, $attrs) = @_;
382 return $self->cursor->new($self, \@_, $attrs);
385 # Need to call finish() to work round broken DBDs
389 my ($rv, $sth, @bind) = $self->_select(@_);
390 my @row = $sth->fetchrow_array;
396 my ($self, $sql) = @_;
397 # 3 is the if_active parameter which avoids active sth re-use
398 return $self->dbh->prepare_cached($sql, {}, 3);
401 =head2 columns_info_for
403 Returns database type info for a given table columns.
407 sub columns_info_for {
408 my ($self, $table) = @_;
410 if ( $self->dbh->can( 'column_info' ) ){
411 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
413 while ( my $info = $sth->fetchrow_hashref() ){
415 $column_info{data_type} = $info->{TYPE_NAME};
416 $column_info{size} = $info->{COLUMN_SIZE};
417 $column_info{is_nullable} = $info->{NULLABLE};
418 $result{$info->{COLUMN_NAME}} = \%column_info;
421 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
423 my @columns = @{$sth->{NAME}};
424 for my $i ( 0 .. $#columns ){
425 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
432 my ($self, $row) = @_;
434 return $self->dbh->func('last_insert_rowid');
440 sub DESTROY { shift->disconnect }
444 =head1 ENVIRONMENT VARIABLES
446 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
448 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
449 is produced (as when the L<debug> method is set).
451 If the value is of the form C<1=/path/name> then the trace output is
452 written to the file C</path/name>.
456 Matt S. Trout <mst@shadowcatsystems.co.uk>
458 Andy Grundman <andy@hybridized.org>
462 You may distribute this code under the same terms as Perl itself.