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 local $self->{having_bind} = [];
21 my ($sql, @ret) = $self->SUPER::select($table,
22 $self->_recurse_fields($fields), $where, $order, @rest);
23 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
29 return $_[1].$self->_order_by($_[2]);
31 return $self->SUPER::_emulate_limit(@_);
36 my ($self, $fields) = @_;
37 my $ref = ref $fields;
38 return $self->_quote($fields) unless $ref;
39 return $$fields if $ref eq 'SCALAR';
41 if ($ref eq 'ARRAY') {
42 return join(', ', map { $self->_recurse_fields($_) } @$fields);
43 } elsif ($ref eq 'HASH') {
44 foreach my $func (keys %$fields) {
45 return $self->_sqlcase($func)
46 .'( '.$self->_recurse_fields($fields->{$func}).' )';
55 if (ref $_[0] eq 'HASH') {
56 if (defined $_[0]->{group_by}) {
57 $ret = $self->_sqlcase(' group by ')
58 .$self->_recurse_fields($_[0]->{group_by});
60 if (defined $_[0]->{having}) {
62 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
63 push(@{$self->{having_bind}}, @extra);
64 $ret .= $self->_sqlcase(' having ').$frag;
66 if (defined $_[0]->{order_by}) {
67 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
70 $ret = $self->SUPER::_order_by(@_);
75 sub _order_directions {
76 my ($self, $order) = @_;
77 $order = $order->{order_by} if ref $order eq 'HASH';
78 return $self->SUPER::_order_directions($order);
82 my ($self, $from) = @_;
83 if (ref $from eq 'ARRAY') {
84 return $self->_recurse_from(@$from);
85 } elsif (ref $from eq 'HASH') {
86 return $self->_make_as($from);
93 my ($self, $from, @join) = @_;
95 push(@sqlf, $self->_make_as($from));
96 foreach my $j (@join) {
99 # check whether a join type exists
100 my $join_clause = '';
101 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
102 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
104 $join_clause = ' JOIN ';
106 push(@sqlf, $join_clause);
108 if (ref $to eq 'ARRAY') {
109 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
111 push(@sqlf, $self->_make_as($to));
113 push(@sqlf, ' ON ', $self->_join_condition($on));
115 return join('', @sqlf);
119 my ($self, $from) = @_;
120 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
121 reverse each %{$self->_skip_options($from)});
125 my ($self, $hash) = @_;
127 $clean_hash->{$_} = $hash->{$_}
128 for grep {!/^-/} keys %$hash;
132 sub _join_condition {
133 my ($self, $cond) = @_;
134 if (ref $cond eq 'HASH') {
136 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
137 return $self->_recurse_where(\%j);
138 } elsif (ref $cond eq 'ARRAY') {
139 return join(' OR ', map { $self->_join_condition($_) } @$cond);
141 die "Can't handle this yet!";
146 my ($self, $label) = @_;
147 return '' unless defined $label;
148 return $label unless $self->{quote_char};
149 return $self->SUPER::_quote($label);
155 $_[0] =~ s/SELECT (.*?) FROM/
156 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
157 $self->SUPER::_RowNum(@_);
160 # Accessor for setting limit dialect. This is useful
161 # for JDBC-bridge among others where the remote SQL-dialect cannot
162 # be determined by the name of the driver alone.
166 $self->{limit_dialect} = shift if @_;
167 return $self->{limit_dialect};
170 package DBIx::Class::Storage::DBI::DebugCallback;
173 my ($self, $string) = @_;
174 $string =~ m/^(\w+)/;
175 ${$self}->($1, $string);
178 } # End of BEGIN block
180 use base qw/DBIx::Class/;
182 __PACKAGE__->load_components(qw/AccessorGroup/);
184 __PACKAGE__->mk_group_accessors('simple' =>
185 qw/connect_info _dbh _sql_maker _connection_pid debug debugfh cursor
186 on_connect_do transaction_depth/);
189 my $new = bless({}, ref $_[0] || $_[0]);
190 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
191 $new->transaction_depth(0);
192 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
193 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
194 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
196 $new->debugfh(IO::File->new('>&STDERR'));
198 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
204 DBIx::Class::Storage::DBI - DBI storage handler
210 This class represents the connection to the database
218 Executes the sql statements given as a listref on every db connect.
222 Causes SQL trace information to be emitted on C<debugfh> filehandle
223 (or C<STDERR> if C<debugfh> has not specifically been set).
227 Sets or retrieves the filehandle used for trace/debug output. This
228 should be an IO::Handle compatible object (only the C<print> method is
229 used). Initially set to be STDERR - although see information on the
230 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
234 Sets a callback to be executed each time a statement is run; takes a sub
235 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
236 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
242 my ($self, $cb) = @_;
243 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
244 $self->debugfh($cb_obj);
250 if( $self->connected ) {
251 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
252 $self->_dbh->disconnect;
261 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
264 sub ensure_connected {
267 unless ($self->connected) {
268 $self->_populate_dbh;
276 if $self->_connection_pid && $self->_connection_pid != $$;
277 $self->ensure_connected;
283 unless ($self->_sql_maker) {
284 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
286 return $self->_sql_maker;
291 my @info = @{$self->connect_info || []};
292 $self->_dbh($self->_connect(@info));
293 my $driver = $self->_dbh->{Driver}->{Name};
294 eval "require DBIx::Class::Storage::DBI::${driver}";
296 bless $self, "DBIx::Class::Storage::DBI::${driver}";
298 # if on-connect sql statements are given execute them
299 foreach my $sql_statement (@{$self->on_connect_do || []}) {
300 $self->_dbh->do($sql_statement);
303 $self->_connection_pid($$);
307 my ($self, @info) = @_;
309 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
310 my $old_connect_via = $DBI::connect_via;
311 $DBI::connect_via = 'connect';
312 my $dbh = DBI->connect(@info);
313 $DBI::connect_via = $old_connect_via;
317 my $dbh = DBI->connect(@info);
318 croak "DBI Connection failed: $DBI::errstr"
325 Calls begin_work on the current dbh.
331 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
336 Issues a commit against the current dbh.
342 if ($self->{transaction_depth} == 0) {
343 $self->dbh->commit unless $self->dbh->{AutoCommit};
346 $self->dbh->commit if --$self->{transaction_depth} == 0;
352 Issues a rollback against the current dbh.
358 if ($self->{transaction_depth} == 0) {
359 $self->dbh->rollback unless $self->dbh->{AutoCommit};
362 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
367 my ($self, $op, $extra_bind, $ident, @args) = @_;
368 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
369 unshift(@bind, @$extra_bind) if $extra_bind;
371 my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind;
372 $self->debugfh->print("$sql: @debug_bind\n");
374 my $sth = $self->sth($sql,$op);
375 croak "no sth generated via sql: $sql" unless $sth;
376 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
379 $rv = $sth->execute(@bind);
381 croak "'$sql' did not generate a statement.";
383 return (wantarray ? ($rv, $sth, @bind) : $rv);
387 my ($self, $ident, $to_insert) = @_;
388 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
389 unless ($self->_execute('insert' => [], $ident, $to_insert));
394 return shift->_execute('update' => [], @_);
398 return shift->_execute('delete' => [], @_);
402 my ($self, $ident, $select, $condition, $attrs) = @_;
403 my $order = $attrs->{order_by};
404 if (ref $condition eq 'SCALAR') {
405 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
407 if (exists $attrs->{group_by} || $attrs->{having}) {
408 $order = { group_by => $attrs->{group_by},
409 having => $attrs->{having},
410 ($order ? (order_by => $order) : ()) };
412 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
413 if ($attrs->{software_limit} ||
414 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
415 $attrs->{software_limit} = 1;
417 push @args, $attrs->{rows}, $attrs->{offset};
419 return $self->_execute(@args);
424 my ($ident, $select, $condition, $attrs) = @_;
425 return $self->cursor->new($self, \@_, $attrs);
428 # Need to call finish() to work round broken DBDs
432 my ($rv, $sth, @bind) = $self->_select(@_);
433 my @row = $sth->fetchrow_array;
439 my ($self, $sql) = @_;
440 # 3 is the if_active parameter which avoids active sth re-use
441 return $self->dbh->prepare_cached($sql, {}, 3);
444 =head2 columns_info_for
446 Returns database type info for a given table columns.
450 sub columns_info_for {
451 my ($self, $table) = @_;
453 if ( $self->dbh->can( 'column_info' ) ){
454 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
456 while ( my $info = $sth->fetchrow_hashref() ){
458 $column_info{data_type} = $info->{TYPE_NAME};
459 $column_info{size} = $info->{COLUMN_SIZE};
460 $column_info{is_nullable} = $info->{NULLABLE};
461 $result{$info->{COLUMN_NAME}} = \%column_info;
464 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
466 my @columns = @{$sth->{NAME}};
467 for my $i ( 0 .. $#columns ){
468 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
475 my ($self, $row) = @_;
477 return $self->dbh->func('last_insert_rowid');
483 sub DESTROY { shift->disconnect }
487 =head1 ENVIRONMENT VARIABLES
489 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
491 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
492 is produced (as when the L<debug> method is set).
494 If the value is of the form C<1=/path/name> then the trace output is
495 written to the file C</path/name>.
499 Matt S. Trout <mst@shadowcatsystems.co.uk>
501 Andy Grundman <andy@hybridized.org>
505 You may distribute this code under the same terms as Perl itself.