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(@_);
66 sub _order_directions {
67 my ($self, $order) = @_;
68 $order = $order->{order_by} if ref $order eq 'HASH';
69 return $self->SUPER::_order_directions($order);
73 my ($self, $from) = @_;
74 if (ref $from eq 'ARRAY') {
75 return $self->_recurse_from(@$from);
76 } elsif (ref $from eq 'HASH') {
77 return $self->_make_as($from);
84 my ($self, $from, @join) = @_;
86 push(@sqlf, $self->_make_as($from));
87 foreach my $j (@join) {
90 # check whether a join type exists
92 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
93 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
95 $join_clause = ' JOIN ';
97 push(@sqlf, $join_clause);
99 if (ref $to eq 'ARRAY') {
100 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
102 push(@sqlf, $self->_make_as($to));
104 push(@sqlf, ' ON ', $self->_join_condition($on));
106 return join('', @sqlf);
110 my ($self, $from) = @_;
111 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
112 reverse each %{$self->_skip_options($from)});
116 my ($self, $hash) = @_;
118 $clean_hash->{$_} = $hash->{$_}
119 for grep {!/^-/} keys %$hash;
123 sub _join_condition {
124 my ($self, $cond) = @_;
125 if (ref $cond eq 'HASH') {
127 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
128 return $self->_recurse_where(\%j);
129 } elsif (ref $cond eq 'ARRAY') {
130 return join(' OR ', map { $self->_join_condition($_) } @$cond);
132 die "Can't handle this yet!";
137 my ($self, $label) = @_;
138 return '' unless defined $label;
139 return "*" if $label eq '*';
140 return $label unless $self->{quote_char};
141 if(ref $self->{quote_char} eq "ARRAY"){
142 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
143 if !defined $self->{name_sep};
144 my $sep = $self->{name_sep};
145 return join($self->{name_sep},
146 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
147 split(/\Q$sep\E/,$label));
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};
172 $self->{quote_char} = shift if @_;
173 return $self->{quote_char};
178 $self->{name_sep} = shift if @_;
179 return $self->{name_sep};
185 package DBIx::Class::Storage::DBI::DebugCallback;
188 my ($self, $string) = @_;
189 $string =~ m/^(\w+)/;
190 ${$self}->($1, $string);
193 } # End of BEGIN block
195 use base qw/DBIx::Class/;
197 __PACKAGE__->load_components(qw/AccessorGroup/);
199 __PACKAGE__->mk_group_accessors('simple' =>
200 qw/connect_info _dbh _sql_maker _connection_pid debug debugfh cursor
201 on_connect_do transaction_depth/);
204 my $new = bless({}, ref $_[0] || $_[0]);
205 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
206 $new->transaction_depth(0);
207 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
208 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
209 $new->debugfh(IO::File->new($1, 'w')||croak "Cannot open trace file $1");
211 $new->debugfh(IO::File->new('>&STDERR'));
213 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
219 DBIx::Class::Storage::DBI - DBI storage handler
225 This class represents the connection to the database
233 Executes the sql statements given as a listref on every db connect.
237 Causes SQL trace information to be emitted on C<debugfh> filehandle
238 (or C<STDERR> if C<debugfh> has not specifically been set).
242 Sets or retrieves the filehandle used for trace/debug output. This
243 should be an IO::Handle compatible object (only the C<print> method is
244 used). Initially set to be STDERR - although see information on the
245 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
249 Sets a callback to be executed each time a statement is run; takes a sub
250 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
251 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
257 my ($self, $cb) = @_;
258 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
259 $self->debugfh($cb_obj);
265 if( $self->connected ) {
266 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
267 $self->_dbh->disconnect;
276 (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping)
279 sub ensure_connected {
282 unless ($self->connected) {
283 $self->_populate_dbh;
291 if $self->_connection_pid && $self->_connection_pid != $$;
292 $self->ensure_connected;
298 unless ($self->_sql_maker) {
299 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
301 return $self->_sql_maker;
306 my @info = @{$self->connect_info || []};
307 $self->_dbh($self->_connect(@info));
309 # if on-connect sql statements are given execute them
310 foreach my $sql_statement (@{$self->on_connect_do || []}) {
311 $self->_dbh->do($sql_statement);
314 $self->_connection_pid($$);
318 my ($self, @info) = @_;
320 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
321 my $old_connect_via = $DBI::connect_via;
322 $DBI::connect_via = 'connect';
323 my $dbh = DBI->connect(@info);
324 $DBI::connect_via = $old_connect_via;
333 Calls begin_work on the current dbh.
339 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
344 Issues a commit against the current dbh.
350 if ($self->{transaction_depth} == 0) {
351 $self->dbh->commit unless $self->dbh->{AutoCommit};
354 $self->dbh->commit if --$self->{transaction_depth} == 0;
360 Issues a rollback against the current dbh.
366 if ($self->{transaction_depth} == 0) {
367 $self->dbh->rollback unless $self->dbh->{AutoCommit};
370 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
375 my ($self, $op, $extra_bind, $ident, @args) = @_;
376 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
377 unshift(@bind, @$extra_bind) if $extra_bind;
379 my @debug_bind = map { defined $_ ? $_ : 'NULL' } @bind;
380 $self->debugfh->print("$sql: @debug_bind\n");
382 my $sth = $self->sth($sql,$op);
383 croak "no sth generated via sql: $sql" unless $sth;
384 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
387 $rv = $sth->execute(@bind);
389 croak "'$sql' did not generate a statement.";
391 return (wantarray ? ($rv, $sth, @bind) : $rv);
395 my ($self, $ident, $to_insert) = @_;
396 croak( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
397 unless ($self->_execute('insert' => [], $ident, $to_insert));
402 return shift->_execute('update' => [], @_);
406 return shift->_execute('delete' => [], @_);
410 my ($self, $ident, $select, $condition, $attrs) = @_;
411 my $order = $attrs->{order_by};
412 if (ref $condition eq 'SCALAR') {
413 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
415 if (exists $attrs->{group_by}) {
416 $order = { group_by => $attrs->{group_by},
417 ($order ? (order_by => $order) : ()) };
419 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
420 if ($attrs->{software_limit} ||
421 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
422 $attrs->{software_limit} = 1;
424 push @args, $attrs->{rows}, $attrs->{offset};
426 return $self->_execute(@args);
431 my ($ident, $select, $condition, $attrs) = @_;
432 return $self->cursor->new($self, \@_, $attrs);
435 # Need to call finish() to work round broken DBDs
439 my ($rv, $sth, @bind) = $self->_select(@_);
440 my @row = $sth->fetchrow_array;
446 my ($self, $sql) = @_;
447 # 3 is the if_active parameter which avoids active sth re-use
448 return $self->dbh->prepare_cached($sql, {}, 3);
451 =head2 columns_info_for
453 Returns database type info for a given table columns.
457 sub columns_info_for {
458 my ($self, $table) = @_;
460 if ( $self->dbh->can( 'column_info' ) ){
461 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
463 while ( my $info = $sth->fetchrow_hashref() ){
465 $column_info{data_type} = $info->{TYPE_NAME};
466 $column_info{size} = $info->{COLUMN_SIZE};
467 $column_info{is_nullable} = $info->{NULLABLE};
468 $result{$info->{COLUMN_NAME}} = \%column_info;
471 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
473 my @columns = @{$sth->{NAME}};
474 for my $i ( 0 .. $#columns ){
475 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
481 sub DESTROY { shift->disconnect }
485 =head1 ENVIRONMENT VARIABLES
487 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
489 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
490 is produced (as when the L<debug> method is set).
492 If the value is of the form C<1=/path/name> then the trace output is
493 written to the file C</path/name>.
497 Matt S. Trout <mst@shadowcatsystems.co.uk>
499 Andy Grundman <andy@hybridized.org>
503 You may distribute this code under the same terms as Perl itself.