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 use Lingua::EN::Inflect::Number qw//;
20 our $VERSION = '0.04999_06';
22 __PACKAGE__->mk_ro_accessors(qw/
29 additional_base_classes
44 default_resultset_class
56 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
60 See L<DBIx::Class::Schema::Loader>
64 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
65 classes, and implements the common functionality between them.
67 =head1 CONSTRUCTOR OPTIONS
69 These constructor options are the base options for
70 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
72 =head2 skip_relationships
74 Skip setting up relationships. The default is to attempt the loading
79 If set to true, each constructive L<DBIx::Class> statement the loader
80 decides to execute will be C<warn>-ed before execution.
84 Set the name of the schema to load (schema in the sense that your database
85 vendor means it). Does not currently support loading more than one schema
90 Only load tables matching regex. Best specified as a qr// regex.
94 Exclude tables matching regex. Best specified as a qr// regex.
98 Overrides the default table name to moniker translation. Can be either
99 a hashref of table keys and moniker values, or a coderef for a translator
100 function taking a single scalar table name argument and returning
101 a scalar moniker. If the hash entry does not exist, or the function
102 returns a false value, the code falls back to default behavior
105 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
106 which is to say: lowercase everything, split up the table name into chunks
107 anywhere a non-alpha-numeric character occurs, change the case of first letter
108 of each chunk to upper case, and put the chunks back together. Examples:
110 Table Name | Moniker Name
111 ---------------------------
113 luser_group | LuserGroup
114 luser-opts | LuserOpts
116 =head2 inflect_plural
118 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
119 if hash key does not exist or coderef returns false), but acts as a map
120 for pluralizing relationship names. The default behavior is to utilize
121 L<Lingua::EN::Inflect::Number/to_PL>.
123 =head2 inflect_singular
125 As L</inflect_plural> above, but for singularizing relationship names.
126 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
128 =head2 schema_base_class
130 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
132 =head2 result_base_class
134 Base class for your table classes (aka result classes). Defaults to 'DBIx::Class'.
136 =head2 additional_base_classes
138 List of additional base classes all of your table classes will use.
140 =head2 left_base_classes
142 List of additional base classes all of your table classes will use
143 that need to be leftmost.
145 =head2 additional_classes
147 List of additional classes which all of your table classes will use.
151 List of additional components to be loaded into all of your table
152 classes. A good example would be C<ResultSetManager>.
154 =head2 resultset_components
156 List of additional ResultSet components to be loaded into your table
157 classes. A good example would be C<AlwaysRS>. Component
158 C<ResultSetManager> will be automatically added to the above
159 C<components> list if this option is set.
161 =head2 use_namespaces
163 Generate result class names suitable for
164 L<DBIx::Class::Schema/load_namespaces> and call that instead of
165 L<DBIx::Class::Schema/load_classes>. When using this option you can also
166 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
167 C<resultset_namespace>, C<default_resultset_class>), and they will be added
168 to the call (and the generated result class names adjusted appropriately).
170 =head2 dump_directory
172 This option is designed to be a tool to help you transition from this
173 loader to a manually-defined schema when you decide it's time to do so.
175 The value of this option is a perl libdir pathname. Within
176 that directory this module will create a baseline manual
177 L<DBIx::Class::Schema> module set, based on what it creates at runtime
180 The created schema class will have the same classname as the one on
181 which you are setting this option (and the ResultSource classes will be
182 based on this name as well).
184 Normally you wouldn't hard-code this setting in your schema class, as it
185 is meant for one-time manual usage.
187 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
188 recommended way to access this functionality.
190 =head2 dump_overwrite
192 Deprecated. See L</really_erase_my_files> below, which does *not* mean
193 the same thing as the old C<dump_overwrite> setting from previous releases.
195 =head2 really_erase_my_files
197 Default false. If true, Loader will unconditionally delete any existing
198 files before creating the new ones from scratch when dumping a schema to disk.
200 The default behavior is instead to only replace the top portion of the
201 file, up to and including the final stanza which contains
202 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
203 leaving any customizations you placed after that as they were.
205 When C<really_erase_my_files> is not set, if the output file already exists,
206 but the aforementioned final stanza is not found, or the checksum
207 contained there does not match the generated contents, Loader will
208 croak and not touch the file.
210 You should really be using version control on your schema classes (and all
211 of the rest of your code for that matter). Don't blame me if a bug in this
212 code wipes something out when it shouldn't have, you've been warned.
216 None of these methods are intended for direct invocation by regular
217 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
218 can also be found via standard L<DBIx::Class::Schema> methods somehow.
222 # ensure that a peice of object data is a valid arrayref, creating
223 # an empty one or encapsulating whatever's there.
224 sub _ensure_arrayref {
229 $self->{$_} = [ $self->{$_} ]
230 unless ref $self->{$_} eq 'ARRAY';
236 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
237 by L<DBIx::Class::Schema::Loader>.
242 my ( $class, %args ) = @_;
244 my $self = { %args };
246 bless $self => $class;
248 $self->_ensure_arrayref(qw/additional_classes
249 additional_base_classes
255 push(@{$self->{components}}, 'ResultSetManager')
256 if @{$self->{resultset_components}};
258 $self->{monikers} = {};
259 $self->{classes} = {};
261 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
262 $self->{schema} ||= $self->{schema_class};
264 croak "dump_overwrite is deprecated. Please read the"
265 . " DBIx::Class::Schema::Loader::Base documentation"
266 if $self->{dump_overwrite};
268 $self->{dynamic} = ! $self->{dump_directory};
269 $self->{dump_directory} ||= File::Temp::tempdir( 'dbicXXXX',
274 $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new(
275 $self->schema_class, $self->inflect_plural, $self->inflect_singular
276 ) if !$self->{skip_relationships};
281 sub _find_file_in_inc {
282 my ($self, $file) = @_;
284 foreach my $prefix (@INC) {
285 my $fullpath = File::Spec->catfile($prefix, $file);
286 return $fullpath if -f $fullpath
287 and Cwd::abs_path($fullpath) ne
288 Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '';
295 my ($self, $class) = @_;
297 my $class_path = $class;
298 $class_path =~ s{::}{/}g;
299 $class_path .= '.pm';
301 my $real_inc_path = $self->_find_file_in_inc($class_path);
303 return if !$real_inc_path;
305 # If we make it to here, we loaded an external definition
306 warn qq/# Loaded external class definition for '$class'\n/
309 croak 'Failed to locate actual external module file for '
312 open(my $fh, '<', $real_inc_path)
313 or croak "Failed to open '$real_inc_path' for reading: $!";
314 $self->_ext_stmt($class,
315 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
316 .qq|# They are now part of the custom portion of this file\n|
317 .qq|# for you to hand-edit. If you do not either delete\n|
318 .qq|# this section or remove that file from \@INC, this section\n|
319 .qq|# will be repeated redundantly when you re-create this\n|
320 .qq|# file again via Loader!\n|
324 $self->_ext_stmt($class, $_);
326 $self->_ext_stmt($class,
327 qq|# End of lines loaded from '$real_inc_path' |
330 or croak "Failed to close $real_inc_path: $!";
335 Does the actual schema-construction work.
342 $self->_load_tables($self->_tables_list);
349 Rescan the database for newly added tables. Does
350 not process drops or changes. Returns a list of
351 the newly added table monikers.
353 The schema argument should be the schema class
354 or object to be affected. It should probably
355 be derived from the original schema_class used
361 my ($self, $schema) = @_;
363 $self->{schema} = $schema;
366 my @current = $self->_tables_list;
367 foreach my $table ($self->_tables_list) {
368 if(!exists $self->{_tables}->{$table}) {
369 push(@created, $table);
373 my $loaded = $self->_load_tables(@created);
375 return map { $self->monikers->{$_} } @$loaded;
379 my ($self, @tables) = @_;
381 # First, use _tables_list with constraint and exclude
382 # to get a list of tables to operate on
384 my $constraint = $self->constraint;
385 my $exclude = $self->exclude;
387 @tables = grep { /$constraint/ } @tables if $constraint;
388 @tables = grep { ! /$exclude/ } @tables if $exclude;
390 # Save the new tables to the tables list
392 $self->{_tables}->{$_} = 1;
395 $self->_make_src_class($_) for @tables;
396 $self->_setup_src_meta($_) for @tables;
398 if(!$self->skip_relationships) {
399 # The relationship loader needs a working schema
401 $self->_reload_classes(@tables);
402 $self->_load_relationships($_) for @tables;
406 $self->_load_external($_)
407 for map { $self->classes->{$_} } @tables;
409 $self->_reload_classes(@tables);
411 # Drop temporary cache
412 delete $self->{_cache};
417 sub _reload_classes {
418 my ($self, @tables) = @_;
420 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
422 for my $table (@tables) {
423 my $moniker = $self->monikers->{$table};
424 my $class = $self->classes->{$table};
427 no warnings 'redefine';
428 local *Class::C3::reinitialize = sub {};
431 if ( Class::Unload->unload( $class ) ) {
432 my $resultset_class = ref $self->schema->resultset($moniker);
433 Class::Unload->unload( $resultset_class )
434 if $resultset_class ne 'DBIx::Class::ResultSet';
436 $class->require or die "Can't load $class: $@";
439 $self->schema_class->register_class($moniker, $class);
440 $self->schema->register_class($moniker, $class)
441 if $self->schema ne $self->schema_class;
445 sub _get_dump_filename {
446 my ($self, $class) = (@_);
449 return $self->dump_directory . q{/} . $class . q{.pm};
452 sub _ensure_dump_subdirs {
453 my ($self, $class) = (@_);
455 my @name_parts = split(/::/, $class);
456 pop @name_parts; # we don't care about the very last element,
457 # which is a filename
459 my $dir = $self->dump_directory;
462 mkdir($dir) or croak "mkdir('$dir') failed: $!";
464 last if !@name_parts;
465 $dir = File::Spec->catdir($dir, shift @name_parts);
470 my ($self, @classes) = @_;
472 my $target_dir = $self->dump_directory;
474 my $schema_class = $self->schema_class;
475 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
477 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
478 unless $self->{dynamic} or $self->{quiet};
481 qq|package $schema_class;\n\n|
482 . qq|use strict;\nuse warnings;\n\n|
483 . qq|use base '$schema_base_class';\n\n|;
486 if ($self->use_namespaces) {
487 $schema_text .= qq|__PACKAGE__->load_namespaces|;
488 my $namespace_options;
489 for my $attr (qw(result_namespace
491 default_resultset_class)) {
493 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
496 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
497 $schema_text .= qq|;\n|;
500 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
504 $self->_write_classfile($schema_class, $schema_text);
506 my $result_base_class = $self->result_base_class || 'DBIx::Class';
508 foreach my $src_class (@classes) {
510 qq|package $src_class;\n\n|
511 . qq|use strict;\nuse warnings;\n\n|
512 . qq|use base '$result_base_class';\n\n|;
514 $self->_write_classfile($src_class, $src_text);
517 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
519 unshift @INC, $target_dir;
522 sub _write_classfile {
523 my ($self, $class, $text) = @_;
525 my $filename = $self->_get_dump_filename($class);
526 $self->_ensure_dump_subdirs($class);
528 if (-f $filename && $self->really_erase_my_files) {
529 warn "Deleting existing file '$filename' due to "
530 . "'really_erase_my_files' setting\n" unless $self->{quiet};
535 for @{$self->{_dump_storage}->{$class} || []};
537 $text .= qq|\n\n# Created by DBIx::Class::Schema::Loader|
538 . qq| v| . $DBIx::Class::Schema::Loader::VERSION
539 . q| @ | . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
540 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
542 open(my $fh, '>', $filename)
543 or croak "Cannot open '$filename' for writing: $!";
545 # Write the top half and its MD5 sum
546 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
548 # Write out anything loaded via external partial class file in @INC
550 for @{$self->{_ext_storage}->{$class} || []};
552 # Write out any custom content the user has added
553 my $custom_content = $self->_get_custom_content($class, $filename);
555 $custom_content ||= qq|\n\n# You can replace this text with custom|
556 . qq| content, and it will be preserved on regeneration|
559 print $fh $custom_content;
562 or croak "Cannot close '$filename': $!";
565 sub _get_custom_content {
566 my ($self, $class, $filename) = @_;
568 return if ! -f $filename;
569 open(my $fh, '<', $filename)
570 or croak "Cannot open '$filename' for reading: $!";
573 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
578 if(!$found && /$mark_re/) {
581 croak "Checksum mismatch in '$filename'"
582 if Digest::MD5::md5_base64($buffer) ne $2;
591 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
592 . " it does not appear to have been generated by Loader"
603 warn "$target: use $_;" if $self->debug;
604 $self->_raw_stmt($target, "use $_;");
611 my $schema_class = $self->schema_class;
613 my $blist = join(q{ }, @_);
614 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
615 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
618 # Create class with applicable bases, setup monikers, etc
619 sub _make_src_class {
620 my ($self, $table) = @_;
622 my $schema = $self->schema;
623 my $schema_class = $self->schema_class;
625 my $table_moniker = $self->_table2moniker($table);
626 my @result_namespace = ($schema_class);
627 if ($self->use_namespaces) {
628 my $result_namespace = $self->result_namespace || 'Result';
629 if ($result_namespace =~ /^\+(.*)/) {
630 # Fully qualified namespace
631 @result_namespace = ($1)
635 push @result_namespace, $result_namespace;
638 my $table_class = join(q{::}, @result_namespace, $table_moniker);
640 my $table_normalized = lc $table;
641 $self->classes->{$table} = $table_class;
642 $self->classes->{$table_normalized} = $table_class;
643 $self->monikers->{$table} = $table_moniker;
644 $self->monikers->{$table_normalized} = $table_moniker;
646 $self->_use ($table_class, @{$self->additional_classes});
647 $self->_inject($table_class, @{$self->left_base_classes});
649 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core');
651 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
652 if @{$self->resultset_components};
653 $self->_inject($table_class, @{$self->additional_base_classes});
656 # Set up metadata (cols, pks, etc)
657 sub _setup_src_meta {
658 my ($self, $table) = @_;
660 my $schema = $self->schema;
661 my $schema_class = $self->schema_class;
663 my $table_class = $self->classes->{$table};
664 my $table_moniker = $self->monikers->{$table};
666 $self->_dbic_stmt($table_class,'table',$table);
668 my $cols = $self->_table_columns($table);
670 eval { $col_info = $self->_columns_info_for($table) };
672 $self->_dbic_stmt($table_class,'add_columns',@$cols);
675 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
676 my $fks = $self->_table_fk_info($table);
677 for my $fkdef (@$fks) {
678 for my $col (@{ $fkdef->{local_columns} }) {
679 $col_info_lc{$col}->{is_foreign_key} = 1;
685 map { $_, ($col_info_lc{$_}||{}) } @$cols
689 my %uniq_tag; # used to eliminate duplicate uniqs
691 my $pks = $self->_table_pk_info($table) || [];
692 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
693 : carp("$table has no primary key");
694 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
696 my $uniqs = $self->_table_uniq_info($table) || [];
698 my ($name, $cols) = @$_;
699 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
700 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
707 Returns a sorted list of loaded tables, using the original database table
715 return keys %{$self->_tables};
718 # Make a moniker from a table
720 my ( $self, $table ) = @_;
724 if( ref $self->moniker_map eq 'HASH' ) {
725 $moniker = $self->moniker_map->{$table};
727 elsif( ref $self->moniker_map eq 'CODE' ) {
728 $moniker = $self->moniker_map->($table);
731 $moniker ||= join '', map ucfirst, split /[\W_]+/,
732 Lingua::EN::Inflect::Number::to_S(lc $table);
737 sub _load_relationships {
738 my ($self, $table) = @_;
740 my $tbl_fk_info = $self->_table_fk_info($table);
741 foreach my $fkdef (@$tbl_fk_info) {
742 $fkdef->{remote_source} =
743 $self->monikers->{delete $fkdef->{remote_table}};
745 my $tbl_uniq_info = $self->_table_uniq_info($table);
747 my $local_moniker = $self->monikers->{$table};
748 my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
750 foreach my $src_class (sort keys %$rel_stmts) {
751 my $src_stmts = $rel_stmts->{$src_class};
752 foreach my $stmt (@$src_stmts) {
753 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
758 # Overload these in driver class:
760 # Returns an arrayref of column names
761 sub _table_columns { croak "ABSTRACT METHOD" }
763 # Returns arrayref of pk col names
764 sub _table_pk_info { croak "ABSTRACT METHOD" }
766 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
767 sub _table_uniq_info { croak "ABSTRACT METHOD" }
769 # Returns an arrayref of foreign key constraints, each
770 # being a hashref with 3 keys:
771 # local_columns (arrayref), remote_columns (arrayref), remote_table
772 sub _table_fk_info { croak "ABSTRACT METHOD" }
774 # Returns an array of lower case table names
775 sub _tables_list { croak "ABSTRACT METHOD" }
777 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
784 $args = '(' . $args . ')' if @_ < 2;
785 my $stmt = $method . $args . q{;};
787 warn qq|$class\->$stmt\n| if $self->debug;
788 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
791 # Store a raw source line for a class (for dumping purposes)
793 my ($self, $class, $stmt) = @_;
794 push(@{$self->{_dump_storage}->{$class}}, $stmt);
797 # Like above, but separately for the externally loaded stuff
799 my ($self, $class, $stmt) = @_;
800 push(@{$self->{_ext_storage}->{$class}}, $stmt);
805 Returns a hashref of loaded table to moniker mappings. There will
806 be two entries for each table, the original name and the "normalized"
807 name, in the case that the two are different (such as databases
808 that like uppercase table names, or preserve your original mixed-case
809 definitions, or what-have-you).
813 Returns a hashref of table to class mappings. In some cases it will
814 contain multiple entries per table for the original and normalized table
815 names, as above in L</monikers>.
819 L<DBIx::Class::Schema::Loader>