1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
|
package DBIx::Class::Schema::Loader::DBI;
use strict;
use warnings;
use base qw/DBIx::Class::Schema::Loader::Base/;
use Class::C3;
use Carp::Clan qw/^DBIx::Class/;
our $VERSION = '0.07000';
=head1 NAME
DBIx::Class::Schema::Loader::DBI - DBIx::Class::Schema::Loader DBI Implementation.
=head1 SYNOPSIS
See L<DBIx::Class::Schema::Loader::Base>
=head1 DESCRIPTION
This is the base class for L<DBIx::Class::Schema::Loader::Base> classes for
DBI-based storage backends, and implements the common functionality between them.
See L<DBIx::Class::Schema::Loader::Base> for the available options.
=head1 METHODS
=head2 new
Overlays L<DBIx::Class::Schema::Loader::Base/new> to do some DBI-specific
things.
=cut
sub new {
my $self = shift->next::method(@_);
# rebless to vendor-specific class if it exists and loads and we're not in a
# custom class.
if (not $self->loader_class) {
my $dbh = $self->schema->storage->dbh;
my $driver = $dbh->{Driver}->{Name};
my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
if ($self->load_optional_class($subclass)) {
bless $self, $subclass unless $self->isa($subclass);
$self->_rebless;
}
}
# Set up the default quoting character and name seperators
$self->{_quoter} = $self->_build_quoter;
$self->{_namesep} = $self->_build_namesep;
# For our usage as regex matches, concatenating multiple quoter
# values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
if( ref $self->{_quoter} eq 'ARRAY') {
$self->{_quoter} = join(q{}, @{$self->{_quoter}});
}
$self->_setup;
$self;
}
sub _build_quoter {
my $self = shift;
my $dbh = $self->schema->storage->dbh;
return $dbh->get_info(29)
|| $self->schema->storage->sql_maker->quote_char
|| q{"};
}
sub _build_namesep {
my $self = shift;
my $dbh = $self->schema->storage->dbh;
return $dbh->get_info(41)
|| $self->schema->storage->sql_maker->name_sep
|| q{.};
}
# Override this in vendor modules to do things at the end of ->new()
sub _setup { }
# Override this in vendor module to load a subclass if necessary
sub _rebless { }
# Returns an array of table names
sub _tables_list {
my ($self, $opts) = (shift, shift);
my ($table, $type) = @_ ? @_ : ('%', '%');
my $dbh = $self->schema->storage->dbh;
my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
my $qt = qr/[\Q$self->{_quoter}\E"'`\[\]]/;
my $all_tables_quoted = (grep /$qt/, @tables) == @tables;
if ($self->{_quoter} && $all_tables_quoted) {
s/.* $qt (?= .* $qt)//xg for @tables;
} else {
s/^.*\Q$self->{_namesep}\E// for @tables;
}
s/$qt//g for @tables;
return $self->_filter_tables(\@tables, $opts);
}
# apply constraint/exclude and ignore bad tables and views
sub _filter_tables {
my ($self, $tables, $opts) = @_;
my @tables = @$tables;
my @filtered_tables;
$opts ||= {};
my $constraint = $opts->{constraint};
my $exclude = $opts->{exclude};
@tables = grep { /$constraint/ } @$tables if defined $constraint;
@tables = grep { ! /$exclude/ } @$tables if defined $exclude;
for my $table (@tables) {
eval {
my $sth = $self->_sth_for($table, undef, \'1 = 0');
$sth->execute;
};
if (not $@) {
push @filtered_tables, $table;
}
else {
warn "Bad table or view '$table', ignoring: $@\n";
$self->_unregister_source_for_table($table);
}
}
return @filtered_tables;
}
=head2 load
We override L<DBIx::Class::Schema::Loader::Base/load> here to hook in our localized settings for C<$dbh> error handling.
=cut
sub load {
my $self = shift;
local $self->schema->storage->dbh->{RaiseError} = 1;
local $self->schema->storage->dbh->{PrintError} = 0;
$self->next::method(@_);
}
sub _table_as_sql {
my ($self, $table) = @_;
if($self->{db_schema}) {
$table = $self->{db_schema} . $self->{_namesep} .
$self->_quote_table_name($table);
} else {
$table = $self->_quote_table_name($table);
}
return $table;
}
sub _sth_for {
my ($self, $table, $fields, $where) = @_;
my $dbh = $self->schema->storage->dbh;
my $sth = $dbh->prepare($self->schema->storage->sql_maker
->select(\$self->_table_as_sql($table), $fields, $where));
return $sth;
}
# Returns an arrayref of column names
sub _table_columns {
my ($self, $table) = @_;
my $sth = $self->_sth_for($table, undef, \'1 = 0');
$sth->execute;
my $retval = $self->preserve_case ? \@{$sth->{NAME}} : \@{$sth->{NAME_lc}};
$sth->finish;
$retval;
}
# Returns arrayref of pk col names
sub _table_pk_info {
my ($self, $table) = @_;
my $dbh = $self->schema->storage->dbh;
my @primary = map { $self->_lc($_) } $dbh->primary_key('', $self->db_schema, $table);
s/\Q$self->{_quoter}\E//g for @primary;
return \@primary;
}
# Override this for vendor-specific uniq info
sub _table_uniq_info {
my ($self, $table) = @_;
my $dbh = $self->schema->storage->dbh;
if(!$dbh->can('statistics_info')) {
warn "No UNIQUE constraint information can be gathered for this vendor";
return [];
}
my %indices;
my $sth = $dbh->statistics_info(undef, $self->db_schema, $table, 1, 1);
while(my $row = $sth->fetchrow_hashref) {
# skip table-level stats, conditional indexes, and any index missing
# critical fields
next if $row->{TYPE} eq 'table'
|| defined $row->{FILTER_CONDITION}
|| !$row->{INDEX_NAME}
|| !defined $row->{ORDINAL_POSITION}
|| !$row->{COLUMN_NAME};
$indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
}
$sth->finish;
my @retval;
foreach my $index_name (keys %indices) {
my $index = $indices{$index_name};
push(@retval, [ $index_name => [
map { $index->{$_} }
sort keys %$index
]]);
}
return \@retval;
}
# Find relationships
sub _table_fk_info {
my ($self, $table) = @_;
my $dbh = $self->schema->storage->dbh;
my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
'', $self->db_schema, $table );
return [] if !$sth;
my %rels;
my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
while(my $raw_rel = $sth->fetchrow_arrayref) {
my $uk_tbl = $raw_rel->[2];
my $uk_col = $self->_lc($raw_rel->[3]);
my $fk_col = $self->_lc($raw_rel->[7]);
my $relid = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
$uk_tbl =~ s/\Q$self->{_quoter}\E//g;
$uk_col =~ s/\Q$self->{_quoter}\E//g;
$fk_col =~ s/\Q$self->{_quoter}\E//g;
$relid =~ s/\Q$self->{_quoter}\E//g;
$rels{$relid}->{tbl} = $uk_tbl;
$rels{$relid}->{cols}{$uk_col} = $fk_col;
}
$sth->finish;
my @rels;
foreach my $relid (keys %rels) {
push(@rels, {
remote_columns => [ keys %{$rels{$relid}->{cols}} ],
local_columns => [ values %{$rels{$relid}->{cols}} ],
remote_table => $rels{$relid}->{tbl},
});
}
return \@rels;
}
# ported in from DBIx::Class::Storage::DBI:
sub _columns_info_for {
my ($self, $table) = @_;
my $dbh = $self->schema->storage->dbh;
if ($dbh->can('column_info')) {
my %result;
eval {
my $sth = eval { local $SIG{__WARN__} = sub {}; $dbh->column_info( undef, $self->db_schema, $table, '%' ); };
while ( my $info = $sth->fetchrow_hashref() ){
my $column_info = {};
$column_info->{data_type} = lc $info->{TYPE_NAME};
my $size = $info->{COLUMN_SIZE};
if (defined $size && defined $info->{DECIMAL_DIGITS}) {
$column_info->{size} = [$size, $info->{DECIMAL_DIGITS}];
}
elsif (defined $size) {
$column_info->{size} = $size;
}
$column_info->{is_nullable} = $info->{NULLABLE} ? 1 : 0;
$column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
my $col_name = $info->{COLUMN_NAME};
$col_name =~ s/^\"(.*)\"$/$1/;
my $extra_info = $self->_extra_column_info(
$table, $col_name, $column_info, $info
) || {};
$column_info = { %$column_info, %$extra_info };
$result{$col_name} = $column_info;
}
$sth->finish;
};
return \%result if !$@ && scalar keys %result;
}
my %result;
my $sth = $self->_sth_for($table, undef, \'1 = 0');
$sth->execute;
my @columns = @{ $self->preserve_case ? $sth->{NAME} : $sth->{NAME_lc} };
for my $i ( 0 .. $#columns ){
my $column_info = {};
$column_info->{data_type} = lc $sth->{TYPE}->[$i];
my $size = $sth->{PRECISION}[$i];
if (defined $size && defined $sth->{SCALE}[$i]) {
$column_info->{size} = [$size, $sth->{SCALE}[$i]];
}
elsif (defined $size) {
$column_info->{size} = $size;
}
$column_info->{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
$column_info->{data_type} = $1;
$column_info->{size} = $2;
}
my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info) || {};
$column_info = { %$column_info, %$extra_info };
$result{$columns[$i]} = $column_info;
}
$sth->finish;
foreach my $col (keys %result) {
my $colinfo = $result{$col};
my $type_num = $colinfo->{data_type};
my $type_name;
if(defined $type_num && $type_num =~ /^\d+\z/ && $dbh->can('type_info')) {
my $type_info = $dbh->type_info($type_num);
$type_name = $type_info->{TYPE_NAME} if $type_info;
$colinfo->{data_type} = lc $type_name if $type_name;
}
}
return \%result;
}
# Override this in vendor class to return any additional column
# attributes
sub _extra_column_info {}
=head1 SEE ALSO
L<DBIx::Class::Schema::Loader>
=head1 AUTHOR
See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
=head1 LICENSE
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
1;
# vim:et sts=4 sw=4 tw=0:
|