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_07';
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->schema->storage->sql_maker->quote_char
53 $self->{_namesep} = $self->schema->storage->sql_maker->name_sep
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}});
68 # Override this in vendor modules to do things at the end of ->new()
71 # Override this in vendor module to load a subclass if necessary
74 # Returns an array of table names
78 my $dbh = $self->schema->storage->dbh;
79 my @tables = $dbh->tables(undef, $self->db_schema, '%', '%');
80 s/\Q$self->{_quoter}\E//g for @tables;
81 s/^.*\Q$self->{_namesep}\E// for @tables;
88 We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
95 local $self->schema->storage->dbh->{RaiseError} = 1;
96 local $self->schema->storage->dbh->{PrintError} = 0;
97 $self->next::method(@_);
100 # Returns an arrayref of column names
102 my ($self, $table) = @_;
104 my $dbh = $self->schema->storage->dbh;
106 if($self->{db_schema}) {
107 $table = $self->{db_schema} . $self->{_namesep} . $table;
110 my $sth = $dbh->prepare($self->schema->storage->sql_maker->select($table, undef, \'1 = 0'));
112 my $retval = \@{$sth->{NAME_lc}};
118 # Returns arrayref of pk col names
120 my ($self, $table) = @_;
122 my $dbh = $self->schema->storage->dbh;
124 my @primary = map { lc } $dbh->primary_key('', $self->db_schema, $table);
125 s/\Q$self->{_quoter}\E//g for @primary;
130 # Override this for vendor-specific uniq info
131 sub _table_uniq_info {
132 my ($self, $table) = @_;
134 my $dbh = $self->schema->storage->dbh;
135 if(!$dbh->can('statistics_info')) {
136 warn "No UNIQUE constraint information can be gathered for this vendor";
141 my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
142 while(my $row = $sth->fetchrow_hashref) {
143 # skip table-level stats, conditional indexes, and any index missing
145 next if $row->{TYPE} eq 'table'
146 || defined $row->{FILTER_CONDITION}
147 || !$row->{INDEX_NAME}
148 || !defined $row->{ORDINAL_POSITION}
149 || !$row->{COLUMN_NAME};
151 $indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
156 foreach my $index_name (keys %indices) {
157 my $index = $indices{$index_name};
158 push(@retval, [ $index_name => [
169 my ($self, $table) = @_;
171 my $dbh = $self->schema->storage->dbh;
172 my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
173 '', $self->db_schema, $table );
178 my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
179 while(my $raw_rel = $sth->fetchrow_arrayref) {
180 my $uk_tbl = $raw_rel->[2];
181 my $uk_col = lc $raw_rel->[3];
182 my $fk_col = lc $raw_rel->[7];
183 my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
184 $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
185 $uk_col =~ s/\Q$self->{_quoter}\E//g;
186 $fk_col =~ s/\Q$self->{_quoter}\E//g;
187 $relid =~ s/\Q$self->{_quoter}\E//g;
188 $rels{$relid}->{tbl} = $uk_tbl;
189 $rels{$relid}->{cols}->{$uk_col} = $fk_col;
194 foreach my $relid (keys %rels) {
196 remote_columns => [ keys %{$rels{$relid}->{cols}} ],
197 local_columns => [ values %{$rels{$relid}->{cols}} ],
198 remote_table => $rels{$relid}->{tbl},
205 # ported in from DBIx::Class::Storage::DBI:
206 sub _columns_info_for {
207 my ($self, $table) = @_;
209 my $dbh = $self->schema->storage->dbh;
211 if ($dbh->can('column_info')) {
214 my $sth = $dbh->column_info( undef, $self->db_schema, $table, '%' );
215 while ( my $info = $sth->fetchrow_hashref() ){
217 $column_info{data_type} = $info->{TYPE_NAME};
218 $column_info{size} = $info->{COLUMN_SIZE};
219 $column_info{is_nullable} = $info->{NULLABLE} ? 1 : 0;
220 $column_info{default_value} = $info->{COLUMN_DEF};
221 my $col_name = $info->{COLUMN_NAME};
222 $col_name =~ s/^\"(.*)\"$/$1/;
224 my $extra_info = $self->_extra_column_info($info) || {};
226 $result{$col_name} = { %column_info, %$extra_info };
230 return \%result if !$@ && scalar keys %result;
233 if($self->db_schema) {
234 $table = $self->db_schema . $self->{_namesep} . $table;
237 my $sth = $dbh->prepare($self->schema->storage->sql_maker->select($table, undef, \'1 = 0'));
239 my @columns = @{$sth->{NAME_lc}};
240 for my $i ( 0 .. $#columns ){
242 $column_info{data_type} = $sth->{TYPE}->[$i];
243 $column_info{size} = $sth->{PRECISION}->[$i];
244 $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
246 if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
247 $column_info{data_type} = $1;
248 $column_info{size} = $2;
251 my $extra_info = $self->_extra_column_info($table, $columns[$i], $sth, $i) || {};
253 $result{$columns[$i]} = { %column_info, %$extra_info };
257 foreach my $col (keys %result) {
258 my $colinfo = $result{$col};
259 my $type_num = $colinfo->{data_type};
261 if(defined $type_num && $dbh->can('type_info')) {
262 my $type_info = $dbh->type_info($type_num);
263 $type_name = $type_info->{TYPE_NAME} if $type_info;
264 $colinfo->{data_type} = $type_name if $type_name;
271 # Override this in vendor class to return any additional column
273 sub _extra_column_info {}
277 L<DBIx::Class::Schema::Loader>