1 package DBIx::Class::Storage::DBI;
6 use SQL::Abstract::Limit;
7 use DBIx::Class::Storage::DBI::Cursor;
12 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
14 use base qw/SQL::Abstract::Limit/;
17 my ($self, $table, $fields, $where, $order, @rest) = @_;
18 @rest = (-1) unless defined $rest[0];
19 $self->SUPER::select($table, $self->_recurse_fields($fields),
20 $where, $order, @rest);
26 return $_[1].$self->_order_by($_[2]);
28 return $self->SUPER::_emulate_limit(@_);
33 my ($self, $fields) = @_;
34 my $ref = ref $fields;
35 return $self->_quote($fields) unless $ref;
36 return $$fields if $ref eq 'SCALAR';
38 if ($ref eq 'ARRAY') {
39 return join(', ', map { $self->_recurse_fields($_) } @$fields);
40 } elsif ($ref eq 'HASH') {
41 foreach my $func (keys %$fields) {
42 return $self->_sqlcase($func)
43 .'( '.$self->_recurse_fields($fields->{$func}).' )';
51 if (ref $_[0] eq 'HASH') {
52 if (defined $_[0]->{group_by}) {
53 $ret = $self->_sqlcase(' group by ')
54 .$self->_recurse_fields($_[0]->{group_by});
56 if (defined $_[0]->{order_by}) {
57 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
60 $ret = $self->SUPER::_order_by(@_);
66 my ($self, $from) = @_;
67 if (ref $from eq 'ARRAY') {
68 return $self->_recurse_from(@$from);
69 } elsif (ref $from eq 'HASH') {
70 return $self->_make_as($from);
77 my ($self, $from, @join) = @_;
79 push(@sqlf, $self->_make_as($from));
80 foreach my $j (@join) {
83 # check whether a join type exists
85 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
86 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
88 $join_clause = ' JOIN ';
90 push(@sqlf, $join_clause);
92 if (ref $to eq 'ARRAY') {
93 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
95 push(@sqlf, $self->_make_as($to));
97 push(@sqlf, ' ON ', $self->_join_condition($on));
99 return join('', @sqlf);
103 my ($self, $from) = @_;
104 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
105 reverse each %{$self->_skip_options($from)});
109 my ($self, $hash) = @_;
111 $clean_hash->{$_} = $hash->{$_}
112 for grep {!/^-/} keys %$hash;
116 sub _join_condition {
117 my ($self, $cond) = @_;
118 if (ref $cond eq 'HASH') {
120 for (keys %$cond) { my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x; };
121 return $self->_recurse_where(\%j);
122 } elsif (ref $cond eq 'ARRAY') {
123 return join(' OR ', map { $self->_join_condition($_) } @$cond);
125 die "Can't handle this yet!";
130 my ($self, $label) = @_;
131 return '' unless defined $label;
132 return $self->SUPER::_quote($label);
135 } # End of BEGIN block
137 use base qw/DBIx::Class/;
139 __PACKAGE__->load_components(qw/Exception AccessorGroup/);
141 __PACKAGE__->mk_group_accessors('simple' =>
142 qw/connect_info _dbh _sql_maker debug debugfh cursor on_connect_do transaction_depth/);
145 my $new = bless({}, ref $_[0] || $_[0]);
146 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
147 $new->transaction_depth(0);
148 if ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/) {
149 $new->debugfh(IO::File->new($1, 'w')||die "Cannot open trace file $1");
151 $new->debugfh(IO::File->new('>&STDERR'));
153 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
159 DBIx::Class::Storage::DBI - DBI storage handler
165 This class represents the connection to the database
173 Executes the sql statements given as a listref on every db connect.
177 Causes SQL trace information to be emitted on C<debugfh> filehandle
178 (or C<STDERR> if C<debugfh> has not specifically been set).
182 Sets or retrieves the filehandle used for trace/debug output. This
183 should be an IO::Handle compatible object (only the C<print> method is
184 used). Initially set to be STDERR - although see information on the
185 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
192 unless (($dbh = $self->_dbh) && $dbh->FETCH('Active') && $dbh->ping) {
193 $self->_populate_dbh;
200 unless ($self->_sql_maker) {
201 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
203 return $self->_sql_maker;
208 my @info = @{$self->connect_info || []};
209 $self->_dbh($self->_connect(@info));
211 # if on-connect sql statements are given execute them
212 foreach my $sql_statement (@{$self->on_connect_do || []}) {
213 $self->_dbh->do($sql_statement);
218 my ($self, @info) = @_;
219 return DBI->connect(@info);
224 Calls begin_work on the current dbh.
230 $self->dbh->begin_work if $self->{transaction_depth}++ == 0 and $self->dbh->{AutoCommit};
235 Issues a commit against the current dbh.
241 if ($self->{transaction_depth} == 0) {
242 $self->dbh->commit unless $self->dbh->{AutoCommit};
245 $self->dbh->commit if --$self->{transaction_depth} == 0;
251 Issues a rollback against the current dbh.
257 if ($self->{transaction_depth} == 0) {
258 $self->dbh->rollback unless $self->dbh->{AutoCommit};
261 --$self->{transaction_depth} == 0 ? $self->dbh->rollback : die $@;
266 my ($self, $op, $extra_bind, $ident, @args) = @_;
267 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
268 unshift(@bind, @$extra_bind) if $extra_bind;
269 $self->debugfh->print("$sql: @bind\n") if $self->debug;
270 my $sth = $self->sth($sql,$op);
271 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
272 my $rv = $sth->execute(@bind);
273 return (wantarray ? ($rv, $sth, @bind) : $rv);
277 my ($self, $ident, $to_insert) = @_;
278 $self->throw( "Couldn't insert ".join(', ', map "$_ => $to_insert->{$_}", keys %$to_insert)." into ${ident}" )
279 unless ($self->_execute('insert' => [], $ident, $to_insert));
284 return shift->_execute('update' => [], @_);
288 return shift->_execute('delete' => [], @_);
292 my ($self, $ident, $select, $condition, $attrs) = @_;
293 my $order = $attrs->{order_by};
294 if (ref $condition eq 'SCALAR') {
295 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
297 if (exists $attrs->{group_by}) {
298 $order = { group_by => $attrs->{group_by},
299 ($order ? (order_by => $order) : ()) };
301 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
302 if ($attrs->{software_limit} ||
303 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
304 $attrs->{software_limit} = 1;
306 push @args, $attrs->{rows}, $attrs->{offset};
308 return $self->_execute(@args);
313 my ($ident, $select, $condition, $attrs) = @_;
314 return $self->cursor->new($self, \@_, $attrs);
319 my ($rv, $sth, @bind) = $self->_select(@_);
320 return $sth->fetchrow_array;
324 my ($self, $sql) = @_;
325 # 3 is the if_active parameter which avoids active sth re-use
326 return $self->dbh->prepare_cached($sql, {}, 3);
329 =head2 columns_info_for
331 Returns database type info for a given table columns.
335 sub columns_info_for {
336 my ($self, $table) = @_;
338 if ( $self->dbh->can( 'column_info' ) ){
339 my $sth = $self->dbh->column_info( undef, undef, $table, '%' );
341 while ( my $info = $sth->fetchrow_hashref() ){
343 $column_info{data_type} = $info->{TYPE_NAME};
344 $column_info{size} = $info->{COLUMN_SIZE};
345 $column_info{is_nullable} = $info->{NULLABLE};
346 $result{$info->{COLUMN_NAME}} = \%column_info;
349 my $sth = $self->dbh->prepare("SELECT * FROM $table WHERE 1=0");
351 my @columns = @{$sth->{NAME}};
352 for my $i ( 0 .. $#columns ){
353 $result{$columns[$i]}{data_type} = $sth->{TYPE}->[$i];
361 =head1 ENVIRONMENT VARIABLES
363 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
365 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
366 is produced (as when the L<debug> method is set).
368 If the value is of the form C<1=/path/name> then the trace output is
369 written to the file C</path/name>.
373 Matt S. Trout <mst@shadowcatsystems.co.uk>
375 Andy Grundman <andy@hybridized.org>
379 You may distribute this code under the same terms as Perl itself.