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