1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use UNIVERSAL::require;
9 use DBIx::Class::Schema::Loader::RelBuilder;
10 use Data::Dump qw/ dump /;
15 our $VERSION = '0.03999_01';
17 __PACKAGE__->mk_ro_accessors(qw/
24 additional_base_classes
44 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
48 See L<DBIx::Class::Schema::Loader>
52 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
53 classes, and implements the common functionality between them.
55 =head1 CONSTRUCTOR OPTIONS
57 These constructor options are the base options for
58 L<DBIx::Class::Schema::Loader/loader_opts>. Available constructor options are:
60 =head2 skip_relationships
62 Skip setting up relationships. The default is to attempt the loading
67 If set to true, each constructive L<DBIx::Class> statement the loader
68 decides to execute will be C<warn>-ed before execution.
72 Set the name of the schema to load (schema in the sense that your database
73 vendor means it). Does not currently support loading more than one schema
78 Only load tables matching regex. Best specified as a qr// regex.
82 Exclude tables matching regex. Best specified as a qr// regex.
86 Overrides the default table name to moniker translation. Can be either
87 a hashref of table keys and moniker values, or a coderef for a translator
88 function taking a single scalar table name argument and returning
89 a scalar moniker. If the hash entry does not exist, or the function
90 returns a false value, the code falls back to default behavior
93 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
94 which is to say: lowercase everything, split up the table name into chunks
95 anywhere a non-alpha-numeric character occurs, change the case of first letter
96 of each chunk to upper case, and put the chunks back together. Examples:
98 Table Name | Moniker Name
99 ---------------------------
101 luser_group | LuserGroup
102 luser-opts | LuserOpts
104 =head2 inflect_plural
106 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
107 if hash key does not exist or coderef returns false), but acts as a map
108 for pluralizing relationship names. The default behavior is to utilize
109 L<Lingua::EN::Inflect::Number/to_PL>.
111 =head2 inflect_singular
113 As L</inflect_plural> above, but for singularizing relationship names.
114 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
116 =head2 additional_base_classes
118 List of additional base classes all of your table classes will use.
120 =head2 left_base_classes
122 List of additional base classes all of your table classes will use
123 that need to be leftmost.
125 =head2 additional_classes
127 List of additional classes which all of your table classes will use.
131 List of additional components to be loaded into all of your table
132 classes. A good example would be C<ResultSetManager>.
134 =head2 resultset_components
136 List of additional ResultSet components to be loaded into your table
137 classes. A good example would be C<AlwaysRS>. Component
138 C<ResultSetManager> will be automatically added to the above
139 C<components> list if this option is set.
141 =head2 dump_directory
143 This option is designed to be a tool to help you transition from this
144 loader to a manually-defined schema when you decide it's time to do so.
146 The value of this option is a perl libdir pathname. Within
147 that directory this module will create a baseline manual
148 L<DBIx::Class::Schema> module set, based on what it creates at runtime
151 The created schema class will have the same classname as the one on
152 which you are setting this option (and the ResultSource classes will be
153 based on this name as well). Therefore it is wise to note that if you
154 point the C<dump_directory> option of a schema class at the live libdir
155 where that class is currently located, it will overwrite itself with a
156 manual version of itself. This might be a really good or bad thing
157 depending on your situation and perspective.
159 Normally you wouldn't hard-code this setting in your schema class, as it
160 is meant for one-time manual usage.
162 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
163 recommended way to access this functionality.
165 =head2 dump_overwrite
167 If set to a true value, the dumping code will overwrite existing files.
168 The default is false, which means the dumping code will skip the already
173 None of these methods are intended for direct invocation by regular
174 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
175 can also be found via standard L<DBIx::Class::Schema> methods somehow.
179 # ensure that a peice of object data is a valid arrayref, creating
180 # an empty one or encapsulating whatever's there.
181 sub _ensure_arrayref {
186 $self->{$_} = [ $self->{$_} ]
187 unless ref $self->{$_} eq 'ARRAY';
193 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
194 by L<DBIx::Class::Schema::Loader>.
199 my ( $class, %args ) = @_;
201 my $self = { %args };
203 bless $self => $class;
205 $self->{db_schema} ||= '';
206 $self->_ensure_arrayref(qw/additional_classes
207 additional_base_classes
213 push(@{$self->{components}}, 'ResultSetManager')
214 if @{$self->{resultset_components}};
216 $self->{monikers} = {};
217 $self->{classes} = {};
219 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
220 $self->{schema} ||= $self->{schema_class};
230 $abs_dump_dir = File::Spec->rel2abs($self->dump_directory)
231 if $self->dump_directory;
233 foreach my $table_class (values %{$self->classes}) {
234 $table_class->require;
235 if($@ && $@ !~ /^Can't locate /) {
236 croak "Failed to load external class definition"
237 . " for '$table_class': $@";
239 next if $@; # "Can't locate" error
241 # If we make it to here, we loaded an external definition
242 warn qq/# Loaded external class definition for '$table_class'\n/
246 my $class_path = $table_class;
247 $class_path =~ s{::}{/}g;
248 $class_path .= '.pm';
249 my $filename = File::Spec->rel2abs($INC{$class_path});
250 croak 'Failed to locate actual external module file for '
253 next if($filename =~ /^$abs_dump_dir/);
254 open(my $fh, '<', $filename)
255 or croak "Failed to open $filename for reading: $!";
256 $self->_raw_stmt($table_class,
257 q|# These lines loaded from user-supplied external file: |
261 $self->_raw_stmt($table_class, $_);
263 $self->_raw_stmt($table_class,
264 q|# End of lines loaded from user-supplied external file |
267 or croak "Failed to close $filename: $!";
274 Does the actual schema-construction work.
281 $self->_load_classes;
282 $self->_load_relationships if ! $self->skip_relationships;
283 $self->_load_external;
284 $self->_dump_to_dir if $self->dump_directory;
286 # Drop temporary cache
287 delete $self->{_cache};
292 sub _get_dump_filename {
293 my ($self, $class) = (@_);
296 return $self->dump_directory . q{/} . $class . q{.pm};
299 sub _ensure_dump_subdirs {
300 my ($self, $class) = (@_);
302 my @name_parts = split(/::/, $class);
303 pop @name_parts; # we don't care about the very last element,
304 # which is a filename
306 my $dir = $self->dump_directory;
307 foreach (@name_parts) {
308 $dir = File::Spec->catdir($dir,$_);
310 mkdir($dir) or croak "mkdir('$dir') failed: $!";
318 my $target_dir = $self->dump_directory;
320 my $schema_class = $self->schema_class;
322 croak "Must specify target directory for dumping!" if ! $target_dir;
324 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n";
326 if(! -d $target_dir) {
327 mkdir($target_dir) or croak "mkdir('$target_dir') failed: $!";
330 my $verstr = $DBIx::Class::Schema::Loader::VERSION;
331 my $datestr = POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime);
332 my $tagline = qq|# Created by DBIx::Class::Schema::Loader v$verstr @ $datestr|;
334 $self->_ensure_dump_subdirs($schema_class);
336 my $schema_fn = $self->_get_dump_filename($schema_class);
337 if (-f $schema_fn && !$self->dump_overwrite) {
338 warn "$schema_fn exists, will not overwrite\n";
341 open(my $schema_fh, '>', $schema_fn)
342 or croak "Cannot open $schema_fn for writing: $!";
343 print $schema_fh qq|package $schema_class;\n\n$tagline\n\n|;
344 print $schema_fh qq|use strict;\nuse warnings;\n\n|;
345 print $schema_fh qq|use base 'DBIx::Class::Schema';\n\n|;
346 print $schema_fh qq|__PACKAGE__->load_classes;\n|;
347 print $schema_fh qq|\n1;\n\n|;
349 or croak "Cannot close $schema_fn: $!";
352 foreach my $src_class (sort keys %{$self->{_dump_storage}}) {
353 $self->_ensure_dump_subdirs($src_class);
354 my $src_fn = $self->_get_dump_filename($src_class);
355 if (-f $src_fn && !$self->dump_overwrite) {
356 warn "$src_fn exists, will not overwrite\n";
359 open(my $src_fh, '>', $src_fn)
360 or croak "Cannot open $src_fn for writing: $!";
361 print $src_fh qq|package $src_class;\n\n$tagline\n\n|;
362 print $src_fh qq|use strict;\nuse warnings;\n\n|;
363 print $src_fh qq|use base 'DBIx::Class';\n\n|;
364 print $src_fh qq|$_\n|
365 for @{$self->{_dump_storage}->{$src_class}};
366 print $src_fh qq|\n1;\n\n|;
368 or croak "Cannot close $src_fn: $!";
371 warn "Schema dump completed.\n";
380 warn "$target: use $_;" if $self->debug;
381 $self->_raw_stmt($target, "use $_;");
382 $_->require or croak ($_ . "->require: $@");
383 $evalstr .= "package $target; use $_;";
385 eval $evalstr if $evalstr;
392 my $schema_class = $self->schema_class;
394 my $blist = join(q{ }, @_);
395 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
396 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
398 $_->require or croak ($_ . "->require: $@");
399 $schema_class->inject_base($target, $_);
403 # Load and setup classes
407 my $schema = $self->schema;
408 my $schema_class = $self->schema_class;
409 my $constraint = $self->constraint;
410 my $exclude = $self->exclude;
411 my @tables = sort $self->_tables_list;
413 warn "No tables found in database, nothing to load" if !@tables;
416 @tables = grep { /$constraint/ } @tables if $constraint;
417 @tables = grep { ! /$exclude/ } @tables if $exclude;
419 warn "All tables excluded by constraint/exclude, nothing to load"
423 $self->{_tables} = \@tables;
425 foreach my $table (@tables) {
426 my $table_moniker = $self->_table2moniker($table);
427 my $table_class = $schema_class . q{::} . $table_moniker;
429 my $table_normalized = lc $table;
430 $self->classes->{$table} = $table_class;
431 $self->classes->{$table_normalized} = $table_class;
432 $self->monikers->{$table} = $table_moniker;
433 $self->monikers->{$table_normalized} = $table_moniker;
435 no warnings 'redefine';
436 local *Class::C3::reinitialize = sub { };
439 { no strict 'refs'; @{"${table_class}::ISA"} = qw/DBIx::Class/ }
441 $self->_use ($table_class, @{$self->additional_classes});
442 $self->_inject($table_class, @{$self->additional_base_classes});
444 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, qw/PK::Auto Core/);
446 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
447 if @{$self->resultset_components};
448 $self->_inject($table_class, @{$self->left_base_classes});
451 Class::C3::reinitialize;
453 foreach my $table (@tables) {
454 my $table_class = $self->classes->{$table};
455 my $table_moniker = $self->monikers->{$table};
457 $self->_dbic_stmt($table_class,'table',$table);
459 my $cols = $self->_table_columns($table);
461 eval { $col_info = $self->_columns_info_for($table) };
463 $self->_dbic_stmt($table_class,'add_columns',@$cols);
466 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
470 map { $_, ($col_info_lc{$_}||{}) } @$cols
474 my $pks = $self->_table_pk_info($table) || [];
475 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
476 : carp("$table has no primary key");
478 my $uniqs = $self->_table_uniq_info($table) || [];
479 $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs);
481 $schema_class->register_class($table_moniker, $table_class);
482 $schema->register_class($table_moniker, $table_class) if $schema ne $schema_class;
488 Returns a sorted list of loaded tables, using the original database table
496 return @{$self->_tables};
499 # Make a moniker from a table
501 my ( $self, $table ) = @_;
505 if( ref $self->moniker_map eq 'HASH' ) {
506 $moniker = $self->moniker_map->{$table};
508 elsif( ref $self->moniker_map eq 'CODE' ) {
509 $moniker = $self->moniker_map->($table);
512 $moniker ||= join '', map ucfirst, split /[\W_]+/, lc $table;
517 sub _load_relationships {
520 # Construct the fk_info RelBuilder wants to see, by
521 # translating table names to monikers in the _fk_info output
523 foreach my $table ($self->tables) {
524 my $tbl_fk_info = $self->_table_fk_info($table);
525 foreach my $fkdef (@$tbl_fk_info) {
526 $fkdef->{remote_source} =
527 $self->monikers->{delete $fkdef->{remote_table}};
529 my $moniker = $self->monikers->{$table};
530 $fk_info{$moniker} = $tbl_fk_info;
533 my $relbuilder = DBIx::Class::Schema::Loader::RelBuilder->new(
534 $self->schema_class, \%fk_info, $self->inflect_plural,
535 $self->inflect_singular
538 my $rel_stmts = $relbuilder->generate_code;
539 foreach my $src_class (sort keys %$rel_stmts) {
540 my $src_stmts = $rel_stmts->{$src_class};
541 foreach my $stmt (@$src_stmts) {
542 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
547 # Overload these in driver class:
549 # Returns an arrayref of column names
550 sub _table_columns { croak "ABSTRACT METHOD" }
552 # Returns arrayref of pk col names
553 sub _table_pk_info { croak "ABSTRACT METHOD" }
555 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
556 sub _table_uniq_info { croak "ABSTRACT METHOD" }
558 # Returns an arrayref of foreign key constraints, each
559 # being a hashref with 3 keys:
560 # local_columns (arrayref), remote_columns (arrayref), remote_table
561 sub _table_fk_info { croak "ABSTRACT METHOD" }
563 # Returns an array of lower case table names
564 sub _tables_list { croak "ABSTRACT METHOD" }
566 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
572 if(!$self->debug && !$self->dump_directory) {
578 $args = '(' . $args . ')' if @_ < 2;
579 my $stmt = $method . $args . q{;};
581 warn qq|$class\->$stmt\n| if $self->debug;
583 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
586 # Store a raw source line for a class (for dumping purposes)
588 my ($self, $class, $stmt) = @_;
589 push(@{$self->{_dump_storage}->{$class}}, $stmt) if $self->dump_directory;
594 Returns a hashref of loaded table to moniker mappings. There will
595 be two entries for each table, the original name and the "normalized"
596 name, in the case that the two are different (such as databases
597 that like uppercase table names, or preserve your original mixed-case
598 definitions, or what-have-you).
602 Returns a hashref of table to class mappings. In some cases it will
603 contain multiple entries per table for the original and normalized table
604 names, as above in L</monikers>.
608 L<DBIx::Class::Schema::Loader>