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.04999_13';
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;
51 # For our usage as regex matches, concatenating multiple quoter
52 # values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
53 if( ref $self->{_quoter} eq 'ARRAY') {
54 $self->{_quoter} = join(q{}, @{$self->{_quoter}});
64 my $dbh = $self->schema->storage->dbh;
65 return $dbh->get_info(29)
66 || $self->schema->storage->sql_maker->quote_char
72 my $dbh = $self->schema->storage->dbh;
73 return $dbh->get_info(41)
74 || $self->schema->storage->sql_maker->name_sep
78 # Override this in vendor modules to do things at the end of ->new()
81 # Override this in vendor module to load a subclass if necessary
84 # Returns an array of table names
88 my ($table, $type) = @_ ? @_ : ('%', '%');
90 my $dbh = $self->schema->storage->dbh;
91 my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
93 my $qt = qr/\Q$self->{_quoter}\E/;
95 if ($self->{_quoter} && $tables[0] =~ /$qt/) {
96 s/.* $qt (?= .* $qt)//xg for @tables;
98 s/^.*\Q$self->{_namesep}\E// for @tables;
100 s/$qt//g for @tables;
102 return $self->_filter_tables(@tables);
105 # ignore bad tables and views
107 my ($self, @tables) = @_;
111 for my $table (@tables) {
113 my $sth = $self->_sth_for($table, undef, \'1 = 0');
117 push @filtered_tables, $table;
120 warn "Bad table or view '$table', ignoring: $@\n";
123 my $schema = $self->schema;
124 # in older DBIC it's a private method
125 my $unregister = $schema->can('unregister_source')
126 || $schema->can('_unregister_source');
127 $schema->$unregister($self->_table2moniker($table));
132 return @filtered_tables;
137 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
144 local $self->schema->storage->dbh->{RaiseError} = 1;
145 local $self->schema->storage->dbh->{PrintError} = 0;
146 $self->next::method(@_);
150 my ($self, $table) = @_;
152 if($self->{db_schema}) {
153 $table = $self->{db_schema} . $self->{_namesep} .
154 $self->_quote_table_name($table);
156 $table = $self->_quote_table_name($table);
163 my ($self, $table, $fields, $where) = @_;
165 my $dbh = $self->schema->storage->dbh;
167 my $sth = $dbh->prepare($self->schema->storage->sql_maker
168 ->select(\$self->_table_as_sql($table), $fields, $where));
173 # Returns an arrayref of column names
175 my ($self, $table) = @_;
177 my $sth = $self->_sth_for($table, undef, \'1 = 0');
179 my $retval = \@{$sth->{NAME_lc}};
185 # Returns arrayref of pk col names
187 my ($self, $table) = @_;
189 my $dbh = $self->schema->storage->dbh;
191 my @primary = map { lc } $dbh->primary_key('', $self->db_schema, $table);
192 s/\Q$self->{_quoter}\E//g for @primary;
197 # Override this for vendor-specific uniq info
198 sub _table_uniq_info {
199 my ($self, $table) = @_;
201 my $dbh = $self->schema->storage->dbh;
202 if(!$dbh->can('statistics_info')) {
203 warn "No UNIQUE constraint information can be gathered for this vendor";
208 my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
209 while(my $row = $sth->fetchrow_hashref) {
210 # skip table-level stats, conditional indexes, and any index missing
212 next if $row->{TYPE} eq 'table'
213 || defined $row->{FILTER_CONDITION}
214 || !$row->{INDEX_NAME}
215 || !defined $row->{ORDINAL_POSITION}
216 || !$row->{COLUMN_NAME};
218 $indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
223 foreach my $index_name (keys %indices) {
224 my $index = $indices{$index_name};
225 push(@retval, [ $index_name => [
236 my ($self, $table) = @_;
238 my $dbh = $self->schema->storage->dbh;
239 my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
240 '', $self->db_schema, $table );
245 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
246 while(my $raw_rel = $sth->fetchrow_arrayref) {
247 my $uk_tbl = $raw_rel->[2];
248 my $uk_col = lc $raw_rel->[3];
249 my $fk_col = lc $raw_rel->[7];
250 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
251 $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
252 $uk_col =~ s/\Q$self->{_quoter}\E//g;
253 $fk_col =~ s/\Q$self->{_quoter}\E//g;
254 $relid =~ s/\Q$self->{_quoter}\E//g;
255 $rels{$relid}->{tbl} = $uk_tbl;
256 $rels{$relid}->{cols}->{$uk_col} = $fk_col;
261 foreach my $relid (keys %rels) {
263 remote_columns => [ keys %{$rels{$relid}->{cols}} ],
264 local_columns => [ values %{$rels{$relid}->{cols}} ],
265 remote_table => $rels{$relid}->{tbl},
272 # ported in from DBIx::Class::Storage::DBI:
273 sub _columns_info_for {
274 my ($self, $table) = @_;
276 my $dbh = $self->schema->storage->dbh;
278 if ($dbh->can('column_info')) {
281 my $sth = $dbh->column_info( undef, $self->db_schema, $table, '%' );
282 while ( my $info = $sth->fetchrow_hashref() ){
284 $column_info{data_type} = $info->{TYPE_NAME};
285 $column_info{size} = $info->{COLUMN_SIZE};
286 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
287 $column_info{default_value} = $info->{COLUMN_DEF};
288 my $col_name = $info->{COLUMN_NAME};
289 $col_name =~ s/^\"(.*)\"$/$1/;
291 my $extra_info = $self->_extra_column_info($info) || {};
293 $result{$col_name} = { %column_info, %$extra_info };
297 return \%result if !$@ && scalar keys %result;
301 my $sth = $self->_sth_for($table, undef, \'1 = 0');
303 my @columns = @{$sth->{NAME_lc}};
304 for my $i ( 0 .. $#columns ){
306 $column_info{data_type} = $sth->{TYPE}->[$i];
307 $column_info{size} = $sth->{PRECISION}->[$i];
308 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
310 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
311 $column_info{data_type} = $1;
312 $column_info{size} = $2;
315 my $extra_info = $self->_extra_column_info($table, $columns[$i], $sth, $i) || {};
317 $result{$columns[$i]} = { %column_info, %$extra_info };
321 foreach my $col (keys %result) {
322 my $colinfo = $result{$col};
323 my $type_num = $colinfo->{data_type};
325 if(defined $type_num && $dbh->can('type_info')) {
326 my $type_info = $dbh->type_info($type_num);
327 $type_name = $type_info->{TYPE_NAME} if $type_info;
328 $colinfo->{data_type} = $type_name if $type_name;
335 # Override this in vendor class to return any additional column
337 sub _extra_column_info {}
341 L<DBIx::Class::Schema::Loader>
345 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
349 This library is free software; you can redistribute it and/or modify it under
350 the same terms as Perl itself.