1 package DBIx::Class::Schema::Loader::DBI;
5 use base qw/DBIx::Class::Schema::Loader::Base/;
7 use Carp::Clan qw/^DBIx::Class/;
11 our $VERSION = '0.07010';
13 __PACKAGE__->mk_group_accessors('simple', qw/
15 _disable_uniq_detection
22 DBIx::Class::Schema::Loader::DBI - DBIx::Class::Schema::Loader DBI Implementation.
26 See L<DBIx::Class::Schema::Loader::Base>
30 This is the base class for L<DBIx::Class::Schema::Loader::Base> classes for
31 DBI-based storage backends, and implements the common functionality between them.
33 See L<DBIx::Class::Schema::Loader::Base> for the available options.
39 Overlays L<DBIx::Class::Schema::Loader::Base/new> to do some DBI-specific
45 my $self = shift->next::method(@_);
47 # rebless to vendor-specific class if it exists and loads and we're not in a
49 if (not $self->loader_class) {
50 my $dbh = $self->schema->storage->dbh;
51 my $driver = $dbh->{Driver}->{Name};
53 my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
54 if ($self->load_optional_class($subclass)) {
55 bless $self, $subclass unless $self->isa($subclass);
60 # Set up the default quoting character and name seperators
61 $self->{_quoter} = $self->_build_quoter;
62 $self->{_namesep} = $self->_build_namesep;
64 # For our usage as regex matches, concatenating multiple quoter
65 # values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
66 if( ref $self->{_quoter} eq 'ARRAY') {
67 $self->{_quoter} = join(q{}, @{$self->{_quoter}});
77 my $dbh = $self->schema->storage->dbh;
78 return $dbh->get_info(29)
79 || $self->schema->storage->sql_maker->quote_char
85 my $dbh = $self->schema->storage->dbh;
86 return $dbh->get_info(41)
87 || $self->schema->storage->sql_maker->name_sep
91 # Override this in vendor modules to do things at the end of ->new()
94 # Override this in vendor module to load a subclass if necessary
97 # Returns an array of table names
99 my ($self, $opts) = (shift, shift);
101 my ($table, $type) = @_ ? @_ : ('%', '%');
103 my $dbh = $self->schema->storage->dbh;
104 my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
106 my $qt = qr/[\Q$self->{_quoter}\E"'`\[\]]/;
108 my $all_tables_quoted = (grep /$qt/, @tables) == @tables;
110 if ($self->{_quoter} && $all_tables_quoted) {
111 s/.* $qt (?= .* $qt\z)//xg for @tables;
113 s/^.*\Q$self->{_namesep}\E// for @tables;
115 s/$qt//g for @tables;
117 return $self->_filter_tables(\@tables, $opts);
120 # apply constraint/exclude and ignore bad tables and views
122 my ($self, $tables, $opts) = @_;
124 my @tables = @$tables;
128 my $constraint = $opts->{constraint};
129 my $exclude = $opts->{exclude};
131 @tables = grep { /$constraint/ } @$tables if defined $constraint;
132 @tables = grep { ! /$exclude/ } @$tables if defined $exclude;
134 LOOP: for my $table (@tables) {
136 local $^W = 0; # for ADO
137 my $sth = $self->_sth_for($table, undef, \'1 = 0');
141 warn "Bad table or view '$table', ignoring: $_\n";
142 $self->_unregister_source_for_table($table);
143 no warnings 'exiting';
147 push @filtered_tables, $table;
150 return @filtered_tables;
155 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
162 local $self->schema->storage->dbh->{RaiseError} = 1;
163 local $self->schema->storage->dbh->{PrintError} = 0;
164 $self->next::method(@_);
168 my ($self, $table) = @_;
170 my $sql_maker = $self->schema->storage->sql_maker;
171 my $name_sep = $sql_maker->name_sep;
172 my $db_schema = $self->db_schema;
175 return $self->_quote($self->{db_schema})
177 . $self->_quote($table);
180 return $self->_quote($table);
184 my ($self, $table, $fields, $where) = @_;
186 my $dbh = $self->schema->storage->dbh;
188 my $sth = $dbh->prepare($self->schema->storage->sql_maker
189 ->select(\$self->_table_as_sql($table), $fields, $where));
194 # Returns an arrayref of column names
196 my ($self, $table) = @_;
198 my $sth = $self->_sth_for($table, undef, \'1 = 0');
200 my $retval = $self->preserve_case ? \@{$sth->{NAME}} : \@{$sth->{NAME_lc}};
206 # Returns arrayref of pk col names
208 my ($self, $table) = @_;
210 return [] if $self->_disable_pk_detection;
212 my $dbh = $self->schema->storage->dbh;
215 $dbh->primary_key('', $self->db_schema, $table);
218 warn "Cannot find primary keys for this driver: $_";
219 $self->_disable_pk_detection(1);
223 return [] if not @primary;
225 @primary = map { $self->_lc($_) } @primary;
226 s/\Q$self->{_quoter}\E//g for @primary;
231 # Override this for vendor-specific uniq info
232 sub _table_uniq_info {
233 my ($self, $table) = @_;
235 return [] if $self->_disable_uniq_detection;
237 my $dbh = $self->schema->storage->dbh;
239 if (not $dbh->can('statistics_info')) {
240 warn "No UNIQUE constraint information can be gathered for this driver";
241 $self->_disable_uniq_detection(1);
246 my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
247 while(my $row = $sth->fetchrow_hashref) {
248 # skip table-level stats, conditional indexes, and any index missing
250 next if $row->{TYPE} eq 'table'
251 || defined $row->{FILTER_CONDITION}
252 || !$row->{INDEX_NAME}
253 || !defined $row->{ORDINAL_POSITION}
254 || !$row->{COLUMN_NAME};
256 $indices{$row->{INDEX_NAME}}[$row->{ORDINAL_POSITION}] = $self->_lc($row->{COLUMN_NAME});
261 foreach my $index_name (keys %indices) {
262 my $index = $indices{$index_name};
263 push(@retval, [ $index_name => [ @$index[1..$#$index] ] ]);
271 my ($self, $table) = @_;
273 return [] if $self->_disable_fk_detection;
275 my $dbh = $self->schema->storage->dbh;
277 $dbh->foreign_key_info( '', $self->db_schema, '',
278 '', $self->db_schema, $table );
281 warn "Cannot introspect relationships for this driver: $_";
282 $self->_disable_fk_detection(1);
290 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
291 while(my $raw_rel = $sth->fetchrow_arrayref) {
292 my $uk_tbl = $raw_rel->[2];
293 my $uk_col = $self->_lc($raw_rel->[3]);
294 my $fk_col = $self->_lc($raw_rel->[7]);
295 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
296 $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
297 $uk_col =~ s/\Q$self->{_quoter}\E//g;
298 $fk_col =~ s/\Q$self->{_quoter}\E//g;
299 $relid =~ s/\Q$self->{_quoter}\E//g;
300 $rels{$relid}->{tbl} = $uk_tbl;
301 $rels{$relid}->{cols}{$uk_col} = $fk_col;
306 foreach my $relid (keys %rels) {
308 remote_columns => [ keys %{$rels{$relid}->{cols}} ],
309 local_columns => [ values %{$rels{$relid}->{cols}} ],
310 remote_table => $rels{$relid}->{tbl},
317 # ported in from DBIx::Class::Storage::DBI:
318 sub _columns_info_for {
319 my ($self, $table) = @_;
321 my $dbh = $self->schema->storage->dbh;
325 if ($dbh->can('column_info')) {
326 my $sth = $self->_dbh_column_info($dbh, undef, $self->db_schema, $table, '%' );
327 while ( my $info = $sth->fetchrow_hashref() ){
328 my $column_info = {};
329 $column_info->{data_type} = lc $info->{TYPE_NAME};
331 my $size = $info->{COLUMN_SIZE};
333 if (defined $size && defined $info->{DECIMAL_DIGITS}) {
334 $column_info->{size} = [$size, $info->{DECIMAL_DIGITS}];
336 elsif (defined $size) {
337 $column_info->{size} = $size;
340 $column_info->{is_nullable} = $info->{NULLABLE} ? 1 : 0;
341 $column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
342 my $col_name = $info->{COLUMN_NAME};
343 $col_name =~ s/^\"(.*)\"$/$1/;
345 $col_name = $self->_lc($col_name);
347 my $extra_info = $self->_extra_column_info(
348 $table, $col_name, $column_info, $info
350 $column_info = { %$column_info, %$extra_info };
352 $result{$col_name} = $column_info;
356 return \%result if %result;
359 my $sth = $self->_sth_for($table, undef, \'1 = 0');
362 my @columns = @{ $sth->{NAME} };
364 for my $i (0 .. $#columns) {
365 my $column_info = {};
366 $column_info->{data_type} = lc $sth->{TYPE}[$i];
368 my $size = $sth->{PRECISION}[$i];
370 if (defined $size && defined $sth->{SCALE}[$i]) {
371 $column_info->{size} = [$size, $sth->{SCALE}[$i]];
373 elsif (defined $size) {
374 $column_info->{size} = $size;
377 $column_info->{is_nullable} = $sth->{NULLABLE}[$i] ? 1 : 0;
379 if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
380 $column_info->{data_type} = $1;
381 $column_info->{size} = $2;
384 my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info, $sth) || {};
385 $column_info = { %$column_info, %$extra_info };
387 $result{ $self->_lc($columns[$i]) } = $column_info;
391 foreach my $col (keys %result) {
392 my $colinfo = $result{$col};
393 my $type_num = $colinfo->{data_type};
395 if (defined $type_num && $type_num =~ /^-?\d+\z/ && $dbh->can('type_info')) {
396 my $type_name = $self->_dbh_type_info_type_name($type_num);
397 $colinfo->{data_type} = lc $type_name if $type_name;
404 # Need to override this for the buggy Firebird ODBC driver.
405 sub _dbh_type_info_type_name {
406 my ($self, $type_num) = @_;
408 my $dbh = $self->schema->storage->dbh;
410 my $type_info = $dbh->type_info($type_num);
412 return $type_info ? $type_info->{TYPE_NAME} : undef;
415 # do not use this, override _columns_info_for instead
416 sub _extra_column_info {}
418 # override to mask warnings if needed (see mysql)
419 sub _dbh_column_info {
420 my ($self, $dbh) = (shift, shift);
422 return $dbh->column_info(@_);
425 # If a coderef uses DBI->connect, this should get its connect info.
426 sub _try_infer_connect_info_from_coderef {
427 my ($self, $code) = @_;
429 my ($dsn, $user, $pass, $params);
431 no warnings 'redefine';
433 local *DBI::connect = sub {
434 (undef, $dsn, $user, $pass, $params) = @_;
439 return ($dsn, $user, $pass, $params);
444 L<DBIx::Class::Schema::Loader>
448 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
452 This library is free software; you can redistribute it and/or modify it under
453 the same terms as Perl itself.
458 # vim:et sts=4 sw=4 tw=0: