1 package DBIx::Class::Schema::Loader::DBI;
5 use base qw/DBIx::Class::Schema::Loader::Base/;
8 use List::MoreUtils 'any';
9 use Carp::Clan qw/^DBIx::Class/;
11 use DBIx::Class::Schema::Loader::Table ();
13 our $VERSION = '0.07036_03';
15 __PACKAGE__->mk_group_accessors('simple', qw/
17 _disable_uniq_detection
26 DBIx::Class::Schema::Loader::DBI - DBIx::Class::Schema::Loader DBI Implementation.
30 See L<DBIx::Class::Schema::Loader::Base>
34 This is the base class for L<DBIx::Class::Schema::Loader::Base> classes for
35 DBI-based storage backends, and implements the common functionality between them.
37 See L<DBIx::Class::Schema::Loader::Base> for the available options.
43 Overlays L<DBIx::Class::Schema::Loader::Base/new> to do some DBI-specific
49 my $self = shift->next::method(@_);
51 # rebless to vendor-specific class if it exists and loads and we're not in a
53 if (not $self->loader_class) {
54 my $driver = $self->dbh->{Driver}->{Name};
56 my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
57 if ((not $self->isa($subclass)) && $self->load_optional_class($subclass)) {
58 bless $self, $subclass;
60 Class::C3::reinitialize() if $] < 5.009005;
64 # Set up the default quoting character and name separators
65 $self->quote_char($self->_build_quote_char);
66 $self->name_sep($self->_build_name_sep);
73 sub _build_quote_char {
76 my $quote_char = $self->dbh->get_info(29)
77 || $self->schema->storage->sql_maker->quote_char
80 # For our usage as regex matches, concatenating multiple quote_char
81 # values works fine (e.g. s/[\Q<>\E]// if quote_char was [ '<', '>' ])
82 if (ref $quote_char eq 'ARRAY') {
83 $quote_char = join '', @$quote_char;
91 return $self->dbh->get_info(41)
92 || $self->schema->storage->sql_maker->name_sep
96 # Override this in vendor modules to do things at the end of ->new()
99 # Override this in vendor module to load a subclass if necessary
102 sub _system_schemas {
103 return ('information_schema');
111 my ($self, $schema) = (shift, shift);
113 my ($table_pattern, $table_type_pattern) = @_ ? @_ : ('%', '%');
115 return $self->dbh->tables(undef, $schema, $table_pattern, $table_type_pattern);
118 # default to be overridden in subclasses if necessary
119 sub _supports_db_schema { 1 }
121 # Returns an array of table objects
123 my ($self, $opts) = (shift, shift);
127 my $qt = qr/[\Q$self->{quote_char}\E"'`\[\]]/;
128 my $nqt = qr/[^\Q$self->{quote_char}\E"'`\[\]]/;
129 my $ns = qr/[\Q$self->{name_sep}\E]/;
130 my $nns = qr/[^\Q$self->{name_sep}\E]/;
132 foreach my $schema (@{ $self->db_schema || [undef] }) {
133 my @raw_table_names = $self->_dbh_tables($schema, @_);
135 TABLE: foreach my $raw_table_name (@raw_table_names) {
136 my $quoted = $raw_table_name =~ /^$qt/;
138 # These regexes are not entirely correct, but hopefully they will work
139 # in most cases. RT reports welcome.
140 my ($schema_name, $table_name1, $table_name2) = $quoted ?
141 $raw_table_name =~ /^(?:${qt}(${nqt}+?)${qt}${ns})?(?:${qt}(.+?)${qt}|(${nns}+))\z/
143 $raw_table_name =~ /^(?:(${nns}+?)${ns})?(?:${qt}(.+?)${qt}|(${nns}+))\z/;
145 my $table_name = $table_name1 || $table_name2;
147 foreach my $system_schema ($self->_system_schemas) {
151 if (ref $system_schema) {
153 if $schema_name =~ $system_schema
154 && $schema !~ $system_schema;
158 if $schema_name eq $system_schema
159 && $schema ne $system_schema;
162 next TABLE if $matches;
166 foreach my $system_table ($self->_system_tables) {
169 if (ref $system_table) {
170 $matches = 1 if $table_name =~ $system_table;
173 $matches = 1 if $table_name eq $system_table
176 next TABLE if $matches;
179 $schema_name ||= $schema;
181 my $table = DBIx::Class::Schema::Loader::Table->new(
184 schema => $schema_name,
185 ($self->_supports_db_schema ? () : (
190 push @tables, $table;
194 return $self->_filter_tables(\@tables, $opts);
197 sub _recurse_constraint {
198 my ($constraint, @parts) = @_;
200 my $name = shift @parts;
202 # If there are any parts left, the constraint must be an arrayref
203 croak "depth of constraint/exclude array does not match length of moniker_parts"
204 unless !!@parts == !!(ref $constraint eq 'ARRAY');
206 # if ths is the last part, use the constraint directly
207 return $name =~ $constraint unless @parts;
209 # recurse into the first matching subconstraint
210 foreach (@{$constraint}) {
211 my ($re, $sub) = @{$_};
212 return _recurse_constraint($sub, @parts)
218 sub _check_constraint {
219 my ($include, $constraint, @tables) = @_;
221 return @tables unless defined $constraint;
223 return grep { !$include xor _recurse_constraint($constraint, @{$_}) } @tables
224 if ref $constraint eq 'ARRAY';
226 return grep { !$include xor /$constraint/ } @tables;
231 # apply constraint/exclude and ignore bad tables and views
233 my ($self, $tables, $opts) = @_;
235 my @tables = @$tables;
239 @tables = _check_constraint(1, $opts->{constraint}, @tables);
240 @tables = _check_constraint(0, $opts->{exclude}, @tables);
242 TABLE: for my $table (@tables) {
244 local $^W = 0; # for ADO
245 my $sth = $self->_sth_for($table, undef, \'1 = 0');
250 warn "Bad table or view '$table', ignoring: $_\n";
254 push @filtered_tables, $table;
257 return @filtered_tables;
262 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
269 local $self->dbh->{RaiseError} = 1;
270 local $self->dbh->{PrintError} = 0;
272 $self->next::method(@_);
274 $self->schema->storage->disconnect unless $self->dynamic;
278 my ($self, $table, $fields, $where) = @_;
280 my $sth = $self->dbh->prepare($self->schema->storage->sql_maker
281 ->select(\$table->sql_name, $fields, $where));
286 # Returns an arrayref of column names
288 my ($self, $table) = @_;
290 my $sth = $self->_sth_for($table, undef, \'1 = 0');
293 my $retval = [ map $self->_lc($_), @{$sth->{NAME}} ];
300 # Returns arrayref of pk col names
302 my ($self, $table) = @_;
304 return [] if $self->_disable_pk_detection;
307 $self->dbh->primary_key('', $table->schema, $table->name);
310 warn "Cannot find primary keys for this driver: $_";
311 $self->_disable_pk_detection(1);
315 return [] if not @primary;
317 @primary = map { $self->_lc($_) } @primary;
318 s/[\Q$self->{quote_char}\E]//g for @primary;
323 # Override this for vendor-specific uniq info
324 sub _table_uniq_info {
325 my ($self, $table) = @_;
327 return [] if $self->_disable_uniq_detection;
329 if (not $self->dbh->can('statistics_info')) {
330 warn "No UNIQUE constraint information can be gathered for this driver";
331 $self->_disable_uniq_detection(1);
336 my $sth = $self->dbh->statistics_info(undef, $table->schema, $table->name, 1, 1);
337 while(my $row = $sth->fetchrow_hashref) {
338 # skip table-level stats, conditional indexes, and any index missing
340 next if $row->{TYPE} eq 'table'
341 || defined $row->{FILTER_CONDITION}
342 || !$row->{INDEX_NAME}
343 || !defined $row->{ORDINAL_POSITION}
344 || !$row->{COLUMN_NAME};
346 $indices{$row->{INDEX_NAME}}[$row->{ORDINAL_POSITION}] = $self->_lc($row->{COLUMN_NAME});
351 foreach my $index_name (keys %indices) {
352 my $index = $indices{$index_name};
353 push(@retval, [ $index_name => [ @$index[1..$#$index] ] ]);
360 my ($self, $table) = @_;
361 my $dbh = $self->dbh;
363 my $comments_table = $table->clone;
364 $comments_table->name($self->table_comments_table);
367 (exists $self->_tables->{$comments_table->sql_name} || undef)
368 && try { $dbh->selectrow_array(<<"EOF") };
370 FROM @{[ $comments_table->sql_name ]}
371 WHERE table_name = @{[ $dbh->quote($table->name) ]}
374 # Failback: try the REMARKS column on table_info
375 if (!$comment && $dbh->can('table_info')) {
376 my $sth = $self->_dbh_table_info( $dbh, undef, $table->schema, $table->name );
377 my $info = $sth->fetchrow_hashref();
378 $comment = $info->{REMARKS};
384 sub _column_comment {
385 my ($self, $table, $column_number, $column_name) = @_;
386 my $dbh = $self->dbh;
388 my $comments_table = $table->clone;
389 $comments_table->name($self->column_comments_table);
392 (exists $self->_tables->{$comments_table->sql_name} || undef)
393 && try { $dbh->selectrow_array(<<"EOF") };
395 FROM @{[ $comments_table->sql_name ]}
396 WHERE table_name = @{[ $dbh->quote($table->name) ]}
397 AND column_name = @{[ $dbh->quote($column_name) ]}
400 # Failback: try the REMARKS column on column_info
401 if (!$comment && $dbh->can('column_info')) {
402 if (my $sth = try { $self->_dbh_column_info( $dbh, undef, $table->schema, $table->name, $column_name ) }) {
403 my $info = $sth->fetchrow_hashref();
404 $comment = $info->{REMARKS};
413 my ($self, $table) = @_;
415 return [] if $self->_disable_fk_detection;
418 $self->dbh->foreign_key_info( '', '', '',
419 '', ($table->schema || ''), $table->name );
422 warn "Cannot introspect relationships for this driver: $_";
423 $self->_disable_fk_detection(1);
439 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
440 REL: while(my $raw_rel = $sth->fetchrow_arrayref) {
441 my $uk_scm = $raw_rel->[1];
442 my $uk_tbl = $raw_rel->[2];
443 my $uk_col = $self->_lc($raw_rel->[3]);
444 my $fk_scm = $raw_rel->[5];
445 my $fk_col = $self->_lc($raw_rel->[7]);
446 my $key_seq = $raw_rel->[8] - 1;
447 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
449 my $update_rule = $raw_rel->[9];
450 my $delete_rule = $raw_rel->[10];
452 $update_rule = $rules[$update_rule] if defined $update_rule;
453 $delete_rule = $rules[$delete_rule] if defined $delete_rule;
455 my $is_deferrable = $raw_rel->[13];
457 ($is_deferrable = $is_deferrable == 7 ? 0 : 1)
458 if defined $is_deferrable;
460 foreach my $var ($uk_scm, $uk_tbl, $uk_col, $fk_scm, $fk_col, $relid) {
461 $var =~ s/[\Q$self->{quote_char}\E]//g if defined $var;
464 if ($self->db_schema && $self->db_schema->[0] ne '%'
465 && (not any { $_ eq $uk_scm } @{ $self->db_schema })) {
470 $rels{$relid}{tbl} ||= DBIx::Class::Schema::Loader::Table->new(
474 ($self->_supports_db_schema ? () : (
479 $rels{$relid}{attrs}{on_delete} = $delete_rule if $delete_rule;
480 $rels{$relid}{attrs}{on_update} = $update_rule if $update_rule;
481 $rels{$relid}{attrs}{is_deferrable} = $is_deferrable if defined $is_deferrable;
483 # Add this data IN ORDER
484 $rels{$relid}{rcols}[$key_seq] = $uk_col;
485 $rels{$relid}{lcols}[$key_seq] = $fk_col;
490 foreach my $relid (keys %rels) {
492 remote_columns => [ grep defined, @{ $rels{$relid}{rcols} } ],
493 local_columns => [ grep defined, @{ $rels{$relid}{lcols} } ],
494 remote_table => $rels{$relid}->{tbl},
495 (exists $rels{$relid}{attrs} ?
496 (attrs => $rels{$relid}{attrs})
500 _constraint_name => $relid,
507 # ported in from DBIx::Class::Storage::DBI:
508 sub _columns_info_for {
509 my ($self, $table) = @_;
511 my $dbh = $self->schema->storage->dbh;
515 if (my $sth = try { $self->_dbh_column_info($dbh, undef, $table->schema, $table->name, '%' ) }) {
516 COL_INFO: while (my $info = try { $sth->fetchrow_hashref } catch { +{} }) {
517 next COL_INFO unless %$info;
519 my $column_info = {};
520 $column_info->{data_type} = lc $info->{TYPE_NAME};
522 my $size = $info->{COLUMN_SIZE};
524 if (defined $size && defined $info->{DECIMAL_DIGITS}) {
525 $column_info->{size} = [$size, $info->{DECIMAL_DIGITS}];
527 elsif (defined $size) {
528 $column_info->{size} = $size;
531 $column_info->{is_nullable} = $info->{NULLABLE} ? 1 : 0;
532 $column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
533 my $col_name = $info->{COLUMN_NAME};
534 $col_name =~ s/^\"(.*)\"$/$1/;
536 my $extra_info = $self->_extra_column_info(
537 $table, $col_name, $column_info, $info
539 $column_info = { %$column_info, %$extra_info };
541 $result{$col_name} = $column_info;
546 my $sth = $self->_sth_for($table, undef, \'1 = 0');
549 my @columns = @{ $sth->{NAME} };
551 COL: for my $i (0 .. $#columns) {
552 next COL if %{ $result{ $columns[$i] }||{} };
554 my $column_info = {};
555 $column_info->{data_type} = lc $sth->{TYPE}[$i];
557 my $size = $sth->{PRECISION}[$i];
559 if (defined $size && defined $sth->{SCALE}[$i]) {
560 $column_info->{size} = [$size, $sth->{SCALE}[$i]];
562 elsif (defined $size) {
563 $column_info->{size} = $size;
566 $column_info->{is_nullable} = $sth->{NULLABLE}[$i] ? 1 : 0;
568 if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
569 $column_info->{data_type} = $1;
570 $column_info->{size} = $2;
573 my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info, $sth) || {};
574 $column_info = { %$column_info, %$extra_info };
576 $result{ $columns[$i] } = $column_info;
580 foreach my $col (keys %result) {
581 my $colinfo = $result{$col};
582 my $type_num = $colinfo->{data_type};
584 if (defined $type_num && $type_num =~ /^-?\d+\z/ && $dbh->can('type_info')) {
585 my $type_name = $self->_dbh_type_info_type_name($type_num);
586 $colinfo->{data_type} = lc $type_name if $type_name;
590 # check for instances of the same column name with different case in preserve_case=0 mode
591 if (not $self->preserve_case) {
594 foreach my $col (keys %result) {
595 push @{ $lc_colnames{lc $col} }, $col;
598 if (keys %lc_colnames != keys %result) {
599 my @offending_colnames = map @$_, grep @$_ > 1, values %lc_colnames;
601 my $offending_colnames = join ", ", map "'$_'", @offending_colnames;
603 croak "columns $offending_colnames in table @{[ $table->sql_name ]} collide in preserve_case=0 mode. preserve_case=1 mode required";
609 while (my ($col, $info) = each %result) {
610 $lc_result{ $self->_lc($col) } = $info;
613 %result = %lc_result;
619 # Need to override this for the buggy Firebird ODBC driver.
620 sub _dbh_type_info_type_name {
621 my ($self, $type_num) = @_;
623 # We wrap it in a try block for MSSQL+DBD::Sybase, which can have issues.
624 # TODO investigate further
625 my $type_info = try { $self->dbh->type_info($type_num) };
627 return $type_info ? $type_info->{TYPE_NAME} : undef;
630 # do not use this, override _columns_info_for instead
631 sub _extra_column_info {}
633 # override to mask warnings if needed
634 sub _dbh_table_info {
635 my ($self, $dbh) = (shift, shift);
637 return $dbh->table_info(@_);
640 # override to mask warnings if needed (see mysql)
641 sub _dbh_column_info {
642 my ($self, $dbh) = (shift, shift);
644 return $dbh->column_info(@_);
647 # If a coderef uses DBI->connect, this should get its connect info.
648 sub _try_infer_connect_info_from_coderef {
649 my ($self, $code) = @_;
651 my ($dsn, $user, $pass, $params);
653 no warnings 'redefine';
655 local *DBI::connect = sub {
656 (undef, $dsn, $user, $pass, $params) = @_;
661 return ($dsn, $user, $pass, $params);
667 return $self->schema->storage->dbh;
672 L<DBIx::Class::Schema::Loader>
676 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
680 This library is free software; you can redistribute it and/or modify it under
681 the same terms as Perl itself.
686 # vim:et sts=4 sw=4 tw=0: