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.07005';
15 DBIx::Class::Schema::Loader::DBI - DBIx::Class::Schema::Loader DBI Implementation.
19 See L<DBIx::Class::Schema::Loader::Base>
23 This is the base class for L<DBIx::Class::Schema::Loader::Base> classes for
24 DBI-based storage backends, and implements the common functionality between them.
26 See L<DBIx::Class::Schema::Loader::Base> for the available options.
32 Overlays L<DBIx::Class::Schema::Loader::Base/new> to do some DBI-specific
38 my $self = shift->next::method(@_);
40 # rebless to vendor-specific class if it exists and loads and we're not in a
42 if (not $self->loader_class) {
43 my $dbh = $self->schema->storage->dbh;
44 my $driver = $dbh->{Driver}->{Name};
46 my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
47 if ($self->load_optional_class($subclass)) {
48 bless $self, $subclass unless $self->isa($subclass);
53 # Set up the default quoting character and name seperators
54 $self->{_quoter} = $self->_build_quoter;
55 $self->{_namesep} = $self->_build_namesep;
57 # For our usage as regex matches, concatenating multiple quoter
58 # values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
59 if( ref $self->{_quoter} eq 'ARRAY') {
60 $self->{_quoter} = join(q{}, @{$self->{_quoter}});
70 my $dbh = $self->schema->storage->dbh;
71 return $dbh->get_info(29)
72 || $self->schema->storage->sql_maker->quote_char
78 my $dbh = $self->schema->storage->dbh;
79 return $dbh->get_info(41)
80 || $self->schema->storage->sql_maker->name_sep
84 # Override this in vendor modules to do things at the end of ->new()
87 # Override this in vendor module to load a subclass if necessary
90 # Returns an array of table names
92 my ($self, $opts) = (shift, shift);
94 my ($table, $type) = @_ ? @_ : ('%', '%');
96 my $dbh = $self->schema->storage->dbh;
97 my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
99 my $qt = qr/[\Q$self->{_quoter}\E"'`\[\]]/;
101 my $all_tables_quoted = (grep /$qt/, @tables) == @tables;
103 if ($self->{_quoter} && $all_tables_quoted) {
104 s/.* $qt (?= .* $qt)//xg for @tables;
106 s/^.*\Q$self->{_namesep}\E// for @tables;
108 s/$qt//g for @tables;
110 return $self->_filter_tables(\@tables, $opts);
113 # apply constraint/exclude and ignore bad tables and views
115 my ($self, $tables, $opts) = @_;
117 my @tables = @$tables;
121 my $constraint = $opts->{constraint};
122 my $exclude = $opts->{exclude};
124 @tables = grep { /$constraint/ } @$tables if defined $constraint;
125 @tables = grep { ! /$exclude/ } @$tables if defined $exclude;
127 LOOP: for my $table (@tables) {
129 my $sth = $self->_sth_for($table, undef, \'1 = 0');
133 warn "Bad table or view '$table', ignoring: $_\n";
134 $self->_unregister_source_for_table($table);
135 no warnings 'exiting';
139 push @filtered_tables, $table;
142 return @filtered_tables;
147 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
154 local $self->schema->storage->dbh->{RaiseError} = 1;
155 local $self->schema->storage->dbh->{PrintError} = 0;
156 $self->next::method(@_);
160 my ($self, $table) = @_;
162 if($self->{db_schema}) {
163 $table = $self->{db_schema} . $self->{_namesep} .
164 $self->_quote_table_name($table);
166 $table = $self->_quote_table_name($table);
173 my ($self, $table, $fields, $where) = @_;
175 my $dbh = $self->schema->storage->dbh;
177 my $sth = $dbh->prepare($self->schema->storage->sql_maker
178 ->select(\$self->_table_as_sql($table), $fields, $where));
183 # Returns an arrayref of column names
185 my ($self, $table) = @_;
187 my $sth = $self->_sth_for($table, undef, \'1 = 0');
189 my $retval = $self->preserve_case ? \@{$sth->{NAME}} : \@{$sth->{NAME_lc}};
195 # Returns arrayref of pk col names
197 my ($self, $table) = @_;
199 my $dbh = $self->schema->storage->dbh;
201 my @primary = map { $self->_lc($_) } $dbh->primary_key('', $self->db_schema, $table);
202 s/\Q$self->{_quoter}\E//g for @primary;
207 # Override this for vendor-specific uniq info
208 sub _table_uniq_info {
209 my ($self, $table) = @_;
211 my $dbh = $self->schema->storage->dbh;
212 if(!$dbh->can('statistics_info')) {
213 warn "No UNIQUE constraint information can be gathered for this vendor";
218 my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
219 while(my $row = $sth->fetchrow_hashref) {
220 # skip table-level stats, conditional indexes, and any index missing
222 next if $row->{TYPE} eq 'table'
223 || defined $row->{FILTER_CONDITION}
224 || !$row->{INDEX_NAME}
225 || !defined $row->{ORDINAL_POSITION}
226 || !$row->{COLUMN_NAME};
228 $indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
233 foreach my $index_name (keys %indices) {
234 my $index = $indices{$index_name};
235 push(@retval, [ $index_name => [
246 my ($self, $table) = @_;
248 my $dbh = $self->schema->storage->dbh;
249 my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
250 '', $self->db_schema, $table );
255 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
256 while(my $raw_rel = $sth->fetchrow_arrayref) {
257 my $uk_tbl = $raw_rel->[2];
258 my $uk_col = $self->_lc($raw_rel->[3]);
259 my $fk_col = $self->_lc($raw_rel->[7]);
260 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
261 $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
262 $uk_col =~ s/\Q$self->{_quoter}\E//g;
263 $fk_col =~ s/\Q$self->{_quoter}\E//g;
264 $relid =~ s/\Q$self->{_quoter}\E//g;
265 $rels{$relid}->{tbl} = $uk_tbl;
266 $rels{$relid}->{cols}{$uk_col} = $fk_col;
271 foreach my $relid (keys %rels) {
273 remote_columns => [ keys %{$rels{$relid}->{cols}} ],
274 local_columns => [ values %{$rels{$relid}->{cols}} ],
275 remote_table => $rels{$relid}->{tbl},
282 # ported in from DBIx::Class::Storage::DBI:
283 sub _columns_info_for {
284 my ($self, $table) = @_;
286 my $dbh = $self->schema->storage->dbh;
290 if ($dbh->can('column_info')) {
291 my $sth = $self->_dbh_column_info($dbh, undef, $self->db_schema, $table, '%' );
292 while ( my $info = $sth->fetchrow_hashref() ){
293 my $column_info = {};
294 $column_info->{data_type} = lc $info->{TYPE_NAME};
296 my $size = $info->{COLUMN_SIZE};
298 if (defined $size && defined $info->{DECIMAL_DIGITS}) {
299 $column_info->{size} = [$size, $info->{DECIMAL_DIGITS}];
301 elsif (defined $size) {
302 $column_info->{size} = $size;
305 $column_info->{is_nullable} = $info->{NULLABLE} ? 1 : 0;
306 $column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
307 my $col_name = $info->{COLUMN_NAME};
308 $col_name =~ s/^\"(.*)\"$/$1/;
310 $col_name = $self->_lc($col_name);
312 my $extra_info = $self->_extra_column_info(
313 $table, $col_name, $column_info, $info
315 $column_info = { %$column_info, %$extra_info };
317 $result{$col_name} = $column_info;
321 return \%result if %result;
324 my $sth = $self->_sth_for($table, undef, \'1 = 0');
327 my @columns = @{ $sth->{NAME} };
329 for my $i (0 .. $#columns) {
330 my $column_info = {};
331 $column_info->{data_type} = lc $sth->{TYPE}[$i];
333 my $size = $sth->{PRECISION}[$i];
335 if (defined $size && defined $sth->{SCALE}[$i]) {
336 $column_info->{size} = [$size, $sth->{SCALE}[$i]];
338 elsif (defined $size) {
339 $column_info->{size} = $size;
342 $column_info->{is_nullable} = $sth->{NULLABLE}[$i] ? 1 : 0;
344 if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
345 $column_info->{data_type} = $1;
346 $column_info->{size} = $2;
349 my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info) || {};
350 $column_info = { %$column_info, %$extra_info };
352 $result{ $self->_lc($columns[$i]) } = $column_info;
356 foreach my $col (keys %result) {
357 my $colinfo = $result{$col};
358 my $type_num = $colinfo->{data_type};
360 if (defined $type_num && $type_num =~ /^\d+\z/ && $dbh->can('type_info')) {
361 my $type_info = $dbh->type_info($type_num);
362 $type_name = $type_info->{TYPE_NAME} if $type_info;
363 $colinfo->{data_type} = lc $type_name if $type_name;
370 # do not use this, override _columns_info_for instead
371 sub _extra_column_info {}
373 # override to mask warnings if needed (see mysql)
374 sub _dbh_column_info {
375 my ($self, $dbh) = (shift, shift);
377 return $dbh->column_info(@_);
382 L<DBIx::Class::Schema::Loader>
386 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
390 This library is free software; you can redistribute it and/or modify it under
391 the same terms as Perl itself.
396 # vim:et sts=4 sw=4 tw=0: