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);
140 $_[0] =~ s/SELECT (.*?) FROM/
141 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
142 $self->SUPER::_RowNum(@_);
145 # Accessor for setting limit dialect. This is useful
146 # for JDBC-bridge among others where the remote SQL-dialect cannot
147 # be determined by the name of the driver alone.
151 $self->{limit_dialect} = shift if @_;
152 return $self->{limit_dialect};
155 package DBIx::Class::Storage::DBI::DebugCallback;
158 my ($self, $string) = @_;
159 $string =~ m/^(\w+)/;
160 ${$self}->($1, $string);
163 } # End of BEGIN block
165 use base qw/DBIx::Class/;
167 __PACKAGE__->load_components(qw/AccessorGroup/);
169 __PACKAGE__->mk_group_accessors('simple' =>
170 qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/);
173 my $new = bless({}, ref $_[0] || $_[0]);
174 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
175 $new->transaction_depth(0);
176 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
177 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
178 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
180 $new->debugfh(IO::File->new('>&STDERR'));
182 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
188 DBIx::Class::Storage::DBI - DBI storage handler
194 This class represents the connection to the database
202 Executes the sql statements given as a listref on every db connect.
206 Causes SQL trace information to be emitted on C<debugfh> filehandle
207 (or C<STDERR> if C<debugfh> has not specifically been set).
211 Sets or retrieves the filehandle used for trace/debug output. This
212 should be an IO::Handle compatible object (only the C<print> method is
213 used). Initially set to be STDERR - although see information on the
214 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
218 Sets a callback to be executed each time a statement is run; takes a sub
219 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
220 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
226 my ($self, $cb) = @_;
227 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
228 $self->debugfh($cb_obj);
234 if( $self->connected ) {
235 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
236 $self->_dbh->disconnect;
245 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
248 sub ensure_connected {
251 unless ($self->connected) {
252 $self->_populate_dbh;
259 $self->ensure_connected;
265 unless ($self->_sql_maker) {
266 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
268 return $self->_sql_maker;
273 my @info = @{$self->connect_info || []};
274 $self->_dbh($self->_connect(@info));
276 # if on-connect sql statements are given execute them
277 foreach my $sql_statement (@{$self->on_connect_do || []}) {
278 $self->_dbh->do($sql_statement);
283 my ($self, @info) = @_;
284 return DBI->connect(@info);
289 Calls begin_work on the current dbh.
295 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
300 Issues a commit against the current dbh.
306 if ($self->{transaction_depth} == 0) {
307 $self->dbh->commit unless $self->dbh->{AutoCommit};
310 $self->dbh->commit if --$self->{transaction_depth} == 0;
316 Issues a rollback against the current dbh.
322 if ($self->{transaction_depth} == 0) {
323 $self->dbh->rollback unless $self->dbh->{AutoCommit};
326 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
331 my ($self, $op, $extra_bind, $ident, @args) = @_;
332 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
333 unshift(@bind, @$extra_bind) if $extra_bind;
335 my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind;
336 $self->debugfh->print("$sql: @debug_bind\n");
338 my $sth = $self->sth($sql,$op);
339 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
342 $rv = $sth->execute(@bind);
344 croak "'$sql' did not generate a statement.";
346 return (wantarray ? ($rv, $sth, @bind) : $rv);
350 my ($self, $ident, $to_insert) = @_;
351 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
352 unless ($self->_execute('insert' => [], $ident, $to_insert));
357 return shift->_execute('update' => [], @_);
361 return shift->_execute('delete' => [], @_);
365 my ($self, $ident, $select, $condition, $attrs) = @_;
366 my $order = $attrs->{order_by};
367 if (ref $condition eq 'SCALAR') {
368 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
370 if (exists $attrs->{group_by}) {
371 $order = { group_by => $attrs->{group_by},
372 ($order ? (order_by => $order) : ()) };
374 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
375 if ($attrs->{software_limit} ||
376 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
377 $attrs->{software_limit} = 1;
379 push @args, $attrs->{rows}, $attrs->{offset};
381 return $self->_execute(@args);
386 my ($ident, $select, $condition, $attrs) = @_;
387 return $self->cursor->new($self, \@_, $attrs);
390 # Need to call finish() to work round broken DBDs
394 my ($rv, $sth, @bind) = $self->_select(@_);
395 my @row = $sth->fetchrow_array;
401 my ($self, $sql) = @_;
402 # 3 is the if_active parameter which avoids active sth re-use
403 return $self->dbh->prepare_cached($sql, {}, 3);
406 =head2 columns_info_for
408 Returns database type info for a given table columns.
412 sub columns_info_for {
413 my ($self, $table) = @_;
415 if ( $self->dbh->can( 'column_info' ) ){
416 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
418 while ( my $info = $sth->fetchrow_hashref() ){
420 $column_info{data_type} = $info->{TYPE_NAME};
421 $column_info{size} = $info->{COLUMN_SIZE};
422 $column_info{is_nullable} = $info->{NULLABLE};
423 $result{$info->{COLUMN_NAME}} = \%column_info;
426 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
428 my @columns = @{$sth->{NAME}};
429 for my $i ( 0 .. $#columns ){
430 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
436 sub DESTROY { shift->disconnect }
440 =head1 ENVIRONMENT VARIABLES
442 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
444 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
445 is produced (as when the L<debug> method is set).
447 If the value is of the form C<1=/path/name> then the trace output is
448 written to the file C</path/name>.
452 Matt S. Trout <mst@shadowcatsystems.co.uk>
454 Andy Grundman <andy@hybridized.org>
458 You may distribute this code under the same terms as Perl itself.