1 package DBIx::Class::Schema::Loader::DBI;
5 use base qw/DBIx::Class::Schema::Loader::Base/;
7 use Carp::Clan qw/^DBIx::Class/;
9 our $VERSION = '0.05003';
13 DBIx::Class::Schema::Loader::DBI - DBIx::Class::Schema::Loader DBI Implementation.
17 See L<DBIx::Class::Schema::Loader::Base>
21 This is the base class for L<DBIx::Class::Schema::Loader::Base> classes for
22 DBI-based storage backends, and implements the common functionality between them.
24 See L<DBIx::Class::Schema::Loader::Base> for the available options.
30 Overlays L<DBIx::Class::Schema::Loader::Base/new> to do some DBI-specific
36 my $self = shift->next::method(@_);
38 # rebless to vendor-specific class if it exists and loads
39 my $dbh = $self->schema->storage->dbh;
40 my $driver = $dbh->{Driver}->{Name};
42 my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
43 if ($self->load_optional_class($subclass)) {
44 bless $self, $subclass unless $self->isa($subclass);
48 # Set up the default quoting character and name seperators
49 $self->{_quoter} = $self->_build_quoter;
50 $self->{_namesep} = $self->_build_namesep;
52 # For our usage as regex matches, concatenating multiple quoter
53 # values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
54 if( ref $self->{_quoter} eq 'ARRAY') {
55 $self->{_quoter} = join(q{}, @{$self->{_quoter}});
65 my $dbh = $self->schema->storage->dbh;
66 return $dbh->get_info(29)
67 || $self->schema->storage->sql_maker->quote_char
73 my $dbh = $self->schema->storage->dbh;
74 return $dbh->get_info(41)
75 || $self->schema->storage->sql_maker->name_sep
79 # Override this in vendor modules to do things at the end of ->new()
82 # Override this in vendor module to load a subclass if necessary
85 # Returns an array of table names
87 my ($self, $opts) = (shift, shift);
89 my ($table, $type) = @_ ? @_ : ('%', '%');
91 my $dbh = $self->schema->storage->dbh;
92 my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
94 my $qt = qr/[\Q$self->{_quoter}\E"'`\[\]]/;
96 my $all_tables_quoted = (grep /$qt/, @tables) == @tables;
98 if ($self->{_quoter} && $all_tables_quoted) {
99 s/.* $qt (?= .* $qt)//xg for @tables;
101 s/^.*\Q$self->{_namesep}\E// for @tables;
103 s/$qt//g for @tables;
105 return $self->_filter_tables(\@tables, $opts);
108 # apply constraint/exclude and ignore bad tables and views
110 my ($self, $tables, $opts) = @_;
112 my @tables = @$tables;
116 my $constraint = $opts->{constraint};
117 my $exclude = $opts->{exclude};
119 @tables = grep { /$constraint/ } @$tables if defined $constraint;
120 @tables = grep { ! /$exclude/ } @$tables if defined $exclude;
122 for my $table (@tables) {
124 my $sth = $self->_sth_for($table, undef, \'1 = 0');
128 push @filtered_tables, $table;
131 warn "Bad table or view '$table', ignoring: $@\n";
134 my $schema = $self->schema;
135 # in older DBIC it's a private method
136 my $unregister = $schema->can('unregister_source')
137 || $schema->can('_unregister_source');
138 $schema->$unregister($self->_table2moniker($table));
143 return @filtered_tables;
148 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
155 local $self->schema->storage->dbh->{RaiseError} = 1;
156 local $self->schema->storage->dbh->{PrintError} = 0;
157 $self->next::method(@_);
161 my ($self, $table) = @_;
163 if($self->{db_schema}) {
164 $table = $self->{db_schema} . $self->{_namesep} .
165 $self->_quote_table_name($table);
167 $table = $self->_quote_table_name($table);
174 my ($self, $table, $fields, $where) = @_;
176 my $dbh = $self->schema->storage->dbh;
178 my $sth = $dbh->prepare($self->schema->storage->sql_maker
179 ->select(\$self->_table_as_sql($table), $fields, $where));
184 # Returns an arrayref of column names
186 my ($self, $table) = @_;
188 my $sth = $self->_sth_for($table, undef, \'1 = 0');
190 my $retval = $self->_is_case_sensitive ? \@{$sth->{NAME}} : \@{$sth->{NAME_lc}};
196 # Returns arrayref of pk col names
198 my ($self, $table) = @_;
200 my $dbh = $self->schema->storage->dbh;
202 my @primary = map { lc } $dbh->primary_key('', $self->db_schema, $table);
203 s/\Q$self->{_quoter}\E//g for @primary;
208 # Override this for vendor-specific uniq info
209 sub _table_uniq_info {
210 my ($self, $table) = @_;
212 my $dbh = $self->schema->storage->dbh;
213 if(!$dbh->can('statistics_info')) {
214 warn "No UNIQUE constraint information can be gathered for this vendor";
219 my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
220 while(my $row = $sth->fetchrow_hashref) {
221 # skip table-level stats, conditional indexes, and any index missing
223 next if $row->{TYPE} eq 'table'
224 || defined $row->{FILTER_CONDITION}
225 || !$row->{INDEX_NAME}
226 || !defined $row->{ORDINAL_POSITION}
227 || !$row->{COLUMN_NAME};
229 $indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
234 foreach my $index_name (keys %indices) {
235 my $index = $indices{$index_name};
236 push(@retval, [ $index_name => [
247 my ($self, $table) = @_;
249 my $dbh = $self->schema->storage->dbh;
250 my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
251 '', $self->db_schema, $table );
256 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
257 while(my $raw_rel = $sth->fetchrow_arrayref) {
258 my $uk_tbl = $raw_rel->[2];
259 my $uk_col = lc $raw_rel->[3];
260 my $fk_col = lc $raw_rel->[7];
261 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
262 $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
263 $uk_col =~ s/\Q$self->{_quoter}\E//g;
264 $fk_col =~ s/\Q$self->{_quoter}\E//g;
265 $relid =~ s/\Q$self->{_quoter}\E//g;
266 $rels{$relid}->{tbl} = $uk_tbl;
267 $rels{$relid}->{cols}->{$uk_col} = $fk_col;
272 foreach my $relid (keys %rels) {
274 remote_columns => [ keys %{$rels{$relid}->{cols}} ],
275 local_columns => [ values %{$rels{$relid}->{cols}} ],
276 remote_table => $rels{$relid}->{tbl},
283 # ported in from DBIx::Class::Storage::DBI:
284 sub _columns_info_for {
285 my ($self, $table) = @_;
287 my $dbh = $self->schema->storage->dbh;
289 if ($dbh->can('column_info')) {
292 my $sth = $dbh->column_info( undef, $self->db_schema, $table, '%' );
293 while ( my $info = $sth->fetchrow_hashref() ){
294 my $column_info = {};
295 $column_info->{data_type} = $info->{TYPE_NAME};
296 $column_info->{size} = $info->{COLUMN_SIZE} if defined $info->{COLUMN_SIZE};
297 $column_info->{is_nullable} = $info->{NULLABLE} ? 1 : 0;
298 $column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
299 my $col_name = $info->{COLUMN_NAME};
300 $col_name =~ s/^\"(.*)\"$/$1/;
302 my $extra_info = $self->_extra_column_info(
303 $table, $col_name, $column_info, $info
305 $column_info = { %$column_info, %$extra_info };
307 $result{$col_name} = $column_info;
311 return \%result if !$@ && scalar keys %result;
315 my $sth = $self->_sth_for($table, undef, \'1 = 0');
317 my @columns = @{ $self->_is_case_sensitive ? $sth->{NAME} : $sth->{NAME_lc} };
318 for my $i ( 0 .. $#columns ){
319 my $column_info = {};
320 $column_info->{data_type} = $sth->{TYPE}->[$i];
321 $column_info->{size} = $sth->{PRECISION}->[$i] if $sth->{PRECISION}->[$i];
322 $column_info->{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
324 if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
325 $column_info->{data_type} = $1;
326 $column_info->{size} = $2;
329 my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info) || {};
330 $column_info = { %$column_info, %$extra_info };
332 $result{$columns[$i]} = $column_info;
336 foreach my $col (keys %result) {
337 my $colinfo = $result{$col};
338 my $type_num = $colinfo->{data_type};
340 if(defined $type_num && $type_num =~ /^\d+\z/ && $dbh->can('type_info')) {
341 my $type_info = $dbh->type_info($type_num);
342 $type_name = $type_info->{TYPE_NAME} if $type_info;
343 $colinfo->{data_type} = $type_name if $type_name;
350 # Override this in vendor class to return any additional column
352 sub _extra_column_info {}
356 L<DBIx::Class::Schema::Loader>
360 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
364 This library is free software; you can redistribute it and/or modify it under
365 the same terms as Perl itself.