1 package DBIx::Class::Storage::DBI;
2 # -*- mode: cperl; cperl-indent-level: 2 -*-
4 use base 'DBIx::Class::Storage';
9 use SQL::Abstract::Limit;
10 use DBIx::Class::Storage::DBI::Cursor;
12 use Carp::Clan qw/DBIx::Class/;
16 package DBIC::SQL::Abstract; # Would merge upstream, but nate doesn't reply :(
18 use base qw/SQL::Abstract::Limit/;
21 my ($self, $table, $fields, $where, $order, @rest) = @_;
22 $table = $self->_quote($table) unless ref($table);
23 @rest = (-1) unless defined $rest[0];
24 local $self->{having_bind} = [];
25 my ($sql, @ret) = $self->SUPER::select(
26 $table, $self->_recurse_fields($fields), $where, $order, @rest
28 return wantarray ? ($sql, @ret, @{$self->{having_bind}}) : $sql;
34 $table = $self->_quote($table) unless ref($table);
35 $self->SUPER::insert($table, @_);
41 $table = $self->_quote($table) unless ref($table);
42 $self->SUPER::update($table, @_);
48 $table = $self->_quote($table) unless ref($table);
49 $self->SUPER::delete($table, @_);
55 return $_[1].$self->_order_by($_[2]);
57 return $self->SUPER::_emulate_limit(@_);
62 my ($self, $fields) = @_;
63 my $ref = ref $fields;
64 return $self->_quote($fields) unless $ref;
65 return $$fields if $ref eq 'SCALAR';
67 if ($ref eq 'ARRAY') {
68 return join(', ', map { $self->_recurse_fields($_) } @$fields);
69 } elsif ($ref eq 'HASH') {
70 foreach my $func (keys %$fields) {
71 return $self->_sqlcase($func)
72 .'( '.$self->_recurse_fields($fields->{$func}).' )';
81 if (ref $_[0] eq 'HASH') {
82 if (defined $_[0]->{group_by}) {
83 $ret = $self->_sqlcase(' group by ')
84 .$self->_recurse_fields($_[0]->{group_by});
86 if (defined $_[0]->{having}) {
88 ($frag, @extra) = $self->_recurse_where($_[0]->{having});
89 push(@{$self->{having_bind}}, @extra);
90 $ret .= $self->_sqlcase(' having ').$frag;
92 if (defined $_[0]->{order_by}) {
93 $ret .= $self->SUPER::_order_by($_[0]->{order_by});
95 } elsif(ref $_[0] eq 'SCALAR') {
96 $ret = $self->_sqlcase(' order by ').${ $_[0] };
98 $ret = $self->SUPER::_order_by(@_);
103 sub _order_directions {
104 my ($self, $order) = @_;
105 $order = $order->{order_by} if ref $order eq 'HASH';
106 return $self->SUPER::_order_directions($order);
110 my ($self, $from) = @_;
111 if (ref $from eq 'ARRAY') {
112 return $self->_recurse_from(@$from);
113 } elsif (ref $from eq 'HASH') {
114 return $self->_make_as($from);
116 return $from; # would love to quote here but _table ends up getting called
117 # twice during an ->select without a limit clause due to
118 # the way S::A::Limit->select works. should maybe consider
119 # bypassing this and doing S::A::select($self, ...) in
120 # our select method above. meantime, quoting shims have
121 # been added to select/insert/update/delete here
126 my ($self, $from, @join) = @_;
128 push(@sqlf, $self->_make_as($from));
129 foreach my $j (@join) {
132 # check whether a join type exists
133 my $join_clause = '';
134 if (ref($to) eq 'HASH' and exists($to->{-join_type})) {
135 $join_clause = ' '.uc($to->{-join_type}).' JOIN ';
137 $join_clause = ' JOIN ';
139 push(@sqlf, $join_clause);
141 if (ref $to eq 'ARRAY') {
142 push(@sqlf, '(', $self->_recurse_from(@$to), ')');
144 push(@sqlf, $self->_make_as($to));
146 push(@sqlf, ' ON ', $self->_join_condition($on));
148 return join('', @sqlf);
152 my ($self, $from) = @_;
153 return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ : $self->_quote($_)) }
154 reverse each %{$self->_skip_options($from)});
158 my ($self, $hash) = @_;
160 $clean_hash->{$_} = $hash->{$_}
161 for grep {!/^-/} keys %$hash;
165 sub _join_condition {
166 my ($self, $cond) = @_;
167 if (ref $cond eq 'HASH') {
170 my $x = '= '.$self->_quote($cond->{$_}); $j{$_} = \$x;
172 return $self->_recurse_where(\%j);
173 } elsif (ref $cond eq 'ARRAY') {
174 return join(' OR ', map { $self->_join_condition($_) } @$cond);
176 die "Can't handle this yet!";
181 my ($self, $label) = @_;
182 return '' unless defined $label;
183 return "*" if $label eq '*';
184 return $label unless $self->{quote_char};
185 if(ref $self->{quote_char} eq "ARRAY"){
186 return $self->{quote_char}->[0] . $label . $self->{quote_char}->[1]
187 if !defined $self->{name_sep};
188 my $sep = $self->{name_sep};
189 return join($self->{name_sep},
190 map { $self->{quote_char}->[0] . $_ . $self->{quote_char}->[1] }
191 split(/\Q$sep\E/,$label));
193 return $self->SUPER::_quote($label);
199 $_[0] =~ s/SELECT (.*?) FROM/
200 'SELECT '.join(', ', map { $_.' AS col'.++$c } split(', ', $1)).' FROM'/e;
201 $self->SUPER::_RowNum(@_);
204 # Accessor for setting limit dialect. This is useful
205 # for JDBC-bridge among others where the remote SQL-dialect cannot
206 # be determined by the name of the driver alone.
210 $self->{limit_dialect} = shift if @_;
211 return $self->{limit_dialect};
216 $self->{quote_char} = shift if @_;
217 return $self->{quote_char};
222 $self->{name_sep} = shift if @_;
223 return $self->{name_sep};
229 package DBIx::Class::Storage::DBI::DebugCallback;
232 my ($self, $string) = @_;
233 $string =~ m/^(\w+)/;
234 ${$self}->($1, $string);
237 } # End of BEGIN block
239 use base qw/DBIx::Class/;
241 __PACKAGE__->load_components(qw/AccessorGroup/);
243 __PACKAGE__->mk_group_accessors('simple' =>
244 qw/_connect_info _dbh _sql_maker _conn_pid _conn_tid debug debugfh
245 cursor on_connect_do transaction_depth/);
248 my $new = bless({}, ref $_[0] || $_[0]);
249 $new->cursor("DBIx::Class::Storage::DBI::Cursor");
250 $new->transaction_depth(0);
251 if (defined($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG}) &&
252 ($ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} =~ /=(.+)$/)) {
253 $new->debugfh(IO::File->new($1, 'w'))
254 or $new->throw_exception("Cannot open trace file $1");
256 $new->debugfh(IO::File->new('>&STDERR'));
258 $new->debug(1) if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG};
262 sub throw_exception {
263 my ($self, $msg) = @_;
269 DBIx::Class::Storage::DBI - DBI storage handler
275 This class represents the connection to the database
283 Connection information arrayref. Can either be the same arguments
284 one would pass to DBI->connect, or a code-reference which returns
285 a connected database handle. In either case, there is an optional
286 final element in the arrayref, which can hold a hashref of
287 connection-specific Storage::DBI options. These include
288 C<on_connect_do>, and the sql_maker options C<limit_dialect>,
289 C<quote_char>, and C<name_sep>. Examples:
291 ->connect_info([ 'dbi:SQLite:./foo.db' ]);
292 ->connect_info(sub { DBI->connect(...) });
293 ->connect_info([ 'dbi:Pg:dbname=foo',
297 { quote_char => q{`}, name_sep => q{@} },
302 Executes the sql statements given as a listref on every db connect.
306 Causes SQL trace information to be emitted on C<debugfh> filehandle
307 (or C<STDERR> if C<debugfh> has not specifically been set).
311 Sets or retrieves the filehandle used for trace/debug output. This
312 should be an IO::Handle compatible object (only the C<print> method is
313 used). Initially set to be STDERR - although see information on the
314 L<DBIX_CLASS_STORAGE_DBI_DEBUG> environment variable.
318 Sets a callback to be executed each time a statement is run; takes a sub
319 reference. Overrides debugfh. Callback is executed as $sub->($op, $info)
320 where $op is SELECT/INSERT/UPDATE/DELETE and $info is what would normally
326 my ($self, $cb) = @_;
327 my $cb_obj = bless(\$cb, 'DBIx::Class::Storage::DBI::DebugCallback');
328 $self->debugfh($cb_obj);
334 if( $self->connected ) {
335 $self->_dbh->rollback unless $self->_dbh->{AutoCommit};
336 $self->_dbh->disconnect;
344 if(my $dbh = $self->_dbh) {
345 if(defined $self->_conn_tid && $self->_conn_tid != threads->tid) {
346 $self->_sql_maker(undef);
347 return $self->_dbh(undef);
349 elsif($self->_conn_pid != $$) {
350 $self->_dbh->{InactiveDestroy} = 1;
351 $self->_sql_maker(undef);
352 return $self->_dbh(undef)
354 return ($dbh->FETCH('Active') && $dbh->ping);
360 sub ensure_connected {
363 unless ($self->connected) {
364 $self->_populate_dbh;
370 Returns the dbh - a data base handle of class L<DBI>.
377 $self->ensure_connected;
383 unless ($self->_sql_maker) {
384 $self->_sql_maker(new DBIC::SQL::Abstract( limit_dialect => $self->dbh ));
386 return $self->_sql_maker;
390 my ($self, $info_arg) = @_;
393 my $info = [ @$info_arg ]; # copy because we can alter it
394 my $last_info = $info->[-1];
395 if(ref $last_info eq 'HASH') {
397 if(my $on_connect_do = $last_info->{on_connect_do}) {
399 $self->on_connect_do($on_connect_do);
401 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
402 if(my $opt_val = $last_info->{$sql_maker_opt}) {
404 $self->sql_maker->$sql_maker_opt($opt_val);
408 # remove our options hashref if it was there, to avoid confusing
409 # DBI in the case the user didn't use all 4 DBI options, as in:
410 # [ 'dbi:SQLite:foo.db', { quote_char => q{`} } ]
411 pop(@$info) if $used;
414 $self->_connect_info($info);
417 $self->_connect_info;
422 my @info = @{$self->_connect_info || []};
423 $self->_dbh($self->_connect(@info));
424 my $driver = $self->_dbh->{Driver}->{Name};
425 eval "require DBIx::Class::Storage::DBI::${driver}";
427 bless $self, "DBIx::Class::Storage::DBI::${driver}";
429 # if on-connect sql statements are given execute them
430 foreach my $sql_statement (@{$self->on_connect_do || []}) {
431 $self->_dbh->do($sql_statement);
434 $self->_conn_pid($$);
435 $self->_conn_tid(threads->tid) if $INC{'threads.pm'};
439 my ($self, @info) = @_;
441 $self->throw_exception("You failed to provide any connection info")
444 my ($old_connect_via, $dbh);
446 if ($INC{'Apache/DBI.pm'} && $ENV{MOD_PERL}) {
447 $old_connect_via = $DBI::connect_via;
448 $DBI::connect_via = 'connect';
452 if(ref $info[0] eq 'CODE') {
456 $dbh = DBI->connect(@info);
460 $DBI::connect_via = $old_connect_via if $old_connect_via;
463 $self->throw_exception("DBI Connection failed: " . ($@ || $DBI::errstr));
471 Calls begin_work on the current dbh.
473 See L<DBIx::Class::Schema> for the txn_do() method, which allows for
474 an entire code block to be executed transactionally.
480 if ($self->{transaction_depth}++ == 0) {
481 my $dbh = $self->dbh;
482 if ($dbh->{AutoCommit}) {
483 $self->debugfh->print("BEGIN WORK\n")
492 Issues a commit against the current dbh.
498 if ($self->{transaction_depth} == 0) {
499 my $dbh = $self->dbh;
500 unless ($dbh->{AutoCommit}) {
501 $self->debugfh->print("COMMIT\n")
507 if (--$self->{transaction_depth} == 0) {
508 $self->debugfh->print("COMMIT\n")
517 Issues a rollback against the current dbh. A nested rollback will
518 throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception,
519 which allows the rollback to propagate to the outermost transaction.
527 if ($self->{transaction_depth} == 0) {
528 my $dbh = $self->dbh;
529 unless ($dbh->{AutoCommit}) {
530 $self->debugfh->print("ROLLBACK\n")
536 if (--$self->{transaction_depth} == 0) {
537 $self->debugfh->print("ROLLBACK\n")
539 $self->dbh->rollback;
542 die DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->new;
549 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
550 $error =~ /$exception_class/ and $self->throw_exception($error);
551 $self->{transaction_depth} = 0; # ensure that a failed rollback
552 $self->throw_exception($error); # resets the transaction depth
557 my ($self, $op, $extra_bind, $ident, @args) = @_;
558 my ($sql, @bind) = $self->sql_maker->$op($ident, @args);
559 unshift(@bind, @$extra_bind) if $extra_bind;
561 my @debug_bind = map { defined $_ ? qq{'$_'} : q{'NULL'} } @bind;
562 $self->debugfh->print("$sql: " . join(', ', @debug_bind) . "\n");
564 my $sth = eval { $self->sth($sql,$op) };
567 $self->throw_exception('no sth generated via sql (' . ($@ || $self->_dbh->errstr) . "): $sql");
570 @bind = map { ref $_ ? ''.$_ : $_ } @bind; # stringify args
573 $rv = eval { $sth->execute(@bind) };
576 $self->throw_exception("Error executing '$sql': ".($@ || $sth->errstr));
579 $self->throw_exception("'$sql' did not generate a statement.");
581 return (wantarray ? ($rv, $sth, @bind) : $rv);
585 my ($self, $ident, $to_insert) = @_;
586 $self->throw_exception(
587 "Couldn't insert ".join(', ',
588 map "$_ => $to_insert->{$_}", keys %$to_insert
590 ) unless ($self->_execute('insert' => [], $ident, $to_insert));
595 return shift->_execute('update' => [], @_);
599 return shift->_execute('delete' => [], @_);
603 my ($self, $ident, $select, $condition, $attrs) = @_;
604 my $order = $attrs->{order_by};
605 if (ref $condition eq 'SCALAR') {
606 $order = $1 if $$condition =~ s/ORDER BY (.*)$//i;
608 if (exists $attrs->{group_by} || $attrs->{having}) {
610 group_by => $attrs->{group_by},
611 having => $attrs->{having},
612 ($order ? (order_by => $order) : ())
615 my @args = ('select', $attrs->{bind}, $ident, $select, $condition, $order);
616 if ($attrs->{software_limit} ||
617 $self->sql_maker->_default_limit_syntax eq "GenericSubQ") {
618 $attrs->{software_limit} = 1;
620 push @args, $attrs->{rows}, $attrs->{offset};
622 return $self->_execute(@args);
627 my ($ident, $select, $condition, $attrs) = @_;
628 return $self->cursor->new($self, \@_, $attrs);
631 # Need to call finish() to work round broken DBDs
635 my ($rv, $sth, @bind) = $self->_select(@_);
636 my @row = $sth->fetchrow_array;
642 my ($self, $sql) = @_;
643 # 3 is the if_active parameter which avoids active sth re-use
644 return $self->dbh->prepare_cached($sql, {}, 3);
647 =head2 columns_info_for
649 Returns database type info for a given table columns.
653 sub columns_info_for {
654 my ($self, $table) = @_;
656 my $dbh = $self->dbh;
658 if ($dbh->can('column_info')) {
660 my $old_raise_err = $dbh->{RaiseError};
661 my $old_print_err = $dbh->{PrintError};
662 $dbh->{RaiseError} = 1;
663 $dbh->{PrintError} = 0;
665 my $sth = $dbh->column_info( undef, undef, $table, '%' );
667 while ( my $info = $sth->fetchrow_hashref() ){
669 $column_info{data_type} = $info->{TYPE_NAME};
670 $column_info{size} = $info->{COLUMN_SIZE};
671 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
672 $column_info{default_value} = $info->{COLUMN_DEF};
674 $result{$info->{COLUMN_NAME}} = \%column_info;
677 $dbh->{RaiseError} = $old_raise_err;
678 $dbh->{PrintError} = $old_print_err;
679 return \%result if !$@;
683 my $sth = $dbh->prepare("SELECT * FROM $table WHERE 1=0");
685 my @columns = @{$sth->{NAME_lc}};
686 for my $i ( 0 .. $#columns ){
688 my $type_num = $sth->{TYPE}->[$i];
690 if(defined $type_num && $dbh->can('type_info')) {
691 my $type_info = $dbh->type_info($type_num);
692 $type_name = $type_info->{TYPE_NAME} if $type_info;
694 $column_info{data_type} = $type_name ? $type_name : $type_num;
695 $column_info{size} = $sth->{PRECISION}->[$i];
696 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
698 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
699 $column_info{data_type} = $1;
700 $column_info{size} = $2;
703 $result{$columns[$i]} = \%column_info;
710 my ($self, $row) = @_;
712 return $self->dbh->func('last_insert_rowid');
716 sub sqlt_type { shift->dbh->{Driver}->{Name} }
720 my ($self, $schema, $databases, $version, $dir, $sqltargs) = @_;
722 if(!$dir || !-d $dir)
724 warn "No directory given, using ./\n";
727 $databases ||= ['MySQL', 'SQLite', 'PostgreSQL'];
728 $databases = [ $databases ] if(ref($databases) ne 'ARRAY');
729 $version ||= $schema->VERSION || '1.x';
731 eval "use SQL::Translator";
732 $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
734 my $sqlt = SQL::Translator->new({
738 foreach my $db (@$databases)
741 $sqlt->parser('SQL::Translator::Parser::DBIx::Class');
742 # $sqlt->parser_args({'DBIx::Class' => $schema);
743 $sqlt->data($schema);
744 $sqlt->producer($db);
747 my $filename = $schema->ddl_filename($db, $dir, $version);
750 $self->throw_exception("$filename already exists, skipping $db");
753 open($file, ">$filename")
754 or $self->throw_exception("Can't open $filename for writing ($!)");
755 my $output = $sqlt->translate;
757 # print join(":", keys %{$schema->source_registrations});
758 # print Dumper($sqlt->schema);
761 $self->throw_exception("Failed to translate to $db. (" . $sqlt->error . ")");
770 sub deployment_statements {
771 my ($self, $schema, $type, $version, $dir, $sqltargs) = @_;
772 $type ||= $self->sqlt_type;
773 $version ||= $schema->VERSION || '1.x';
775 # eval "use SQL::Translator";
776 # $self->throw_exception("Can't deploy without SQL::Translator: $@") if $@;
777 # eval "use SQL::Translator::Parser::DBIx::Class;";
778 # $self->throw_exception($@) if $@;
779 # eval "use SQL::Translator::Producer::${type};";
780 # $self->throw_exception($@) if $@;
781 # my $tr = SQL::Translator->new(%$sqltargs);
782 # SQL::Translator::Parser::DBIx::Class::parse( $tr, $schema );
783 # return "SQL::Translator::Producer::${type}"->can('produce')->($tr);
785 my $filename = $schema->ddl_filename($type, $dir, $version);
788 $schema->create_ddl_dir([ $type ], $version, $dir, $sqltargs);
791 open($file, "<$filename")
792 or $self->throw_exception("Can't open $filename ($!)");
796 return join('', @rows);
801 my ($self, $schema, $type, $sqltargs) = @_;
802 foreach my $statement ( $self->deployment_statements($schema, $type, undef, undef, $sqltargs) ) {
803 for ( split(";\n", $statement)) {
804 next if($_ =~ /^--/);
806 # next if($_ =~ /^DROP/m);
807 next if($_ =~ /^BEGIN TRANSACTION/m);
808 next if($_ =~ /^COMMIT/m);
809 $self->debugfh->print("$_\n") if $self->debug;
810 $self->dbh->do($_) or warn "SQL was:\n $_";
815 sub DESTROY { shift->disconnect }
819 =head1 ENVIRONMENT VARIABLES
821 =head2 DBIX_CLASS_STORAGE_DBI_DEBUG
823 If C<DBIX_CLASS_STORAGE_DBI_DEBUG> is set then SQL trace information
824 is produced (as when the L<debug> method is set).
826 If the value is of the form C<1=/path/name> then the trace output is
827 written to the file C</path/name>.
831 Matt S. Trout <mst@shadowcatsystems.co.uk>
833 Andy Grundman <andy@hybridized.org>
837 You may distribute this code under the same terms as Perl itself.