1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Grouped Class::C3::Componentised/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use DBIx::Class::Schema::Loader::RelBuilder;
9 use Data::Dump qw/ dump /;
14 use Lingua::EN::Inflect::Number qw//;
19 our $VERSION = '0.04999_13';
21 __PACKAGE__->mk_group_ro_accessors('simple', qw/
28 additional_base_classes
44 default_resultset_class
47 overwrite_modifications
61 __PACKAGE__->mk_group_accessors('simple', qw/
63 schema_version_to_dump
69 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
73 See L<DBIx::Class::Schema::Loader>
77 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
78 classes, and implements the common functionality between them.
80 =head1 CONSTRUCTOR OPTIONS
82 These constructor options are the base options for
83 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
85 =head2 skip_relationships
87 Skip setting up relationships. The default is to attempt the loading
90 =head2 skip_load_external
92 Skip loading of other classes in @INC. The default is to merge all other classes
93 with the same name found in @INC into the schema file we are creating.
97 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
98 relationship names and singularized Results, unless you're overwriting an
99 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
100 which case the backward compatible RelBuilder will be activated, and
101 singularization will be turned off.
107 will disable the backward-compatible RelBuilder and use
108 the new-style relationship names along with singularized Results, even when
109 overwriting a dump made with an earlier version.
111 The option also takes a hashref:
113 naming => { relationships => 'v5', monikers => 'v4' }
121 How to name relationship accessors.
125 How to name Result classes.
135 Latest default style, whatever that happens to be.
139 Version 0.05XXX style.
143 Version 0.04XXX style.
147 Dynamic schemas will always default to the 0.04XXX relationship names and won't
148 singularize Results for backward compatibility, to activate the new RelBuilder
149 and singularization put this in your C<Schema.pm> file:
151 __PACKAGE__->naming('current');
153 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
154 next major version upgrade:
156 __PACKAGE__->naming('v5');
158 =head2 relationship_attrs
160 Hashref of attributes to pass to each generated relationship, listed
161 by type. Also supports relationship type 'all', containing options to
162 pass to all generated relationships. Attributes set for more specific
163 relationship types override those set in 'all'.
167 relationship_attrs => {
168 all => { cascade_delete => 0 },
169 has_many => { cascade_delete => 1 },
172 will set the C<cascade_delete> option to 0 for all generated relationships,
173 except for C<has_many>, which will have cascade_delete as 1.
175 NOTE: this option is not supported if v4 backward-compatible naming is
176 set either globally (naming => 'v4') or just for relationships.
180 If set to true, each constructive L<DBIx::Class> statement the loader
181 decides to execute will be C<warn>-ed before execution.
185 Set the name of the schema to load (schema in the sense that your database
186 vendor means it). Does not currently support loading more than one schema
191 Only load tables matching regex. Best specified as a qr// regex.
195 Exclude tables matching regex. Best specified as a qr// regex.
199 Overrides the default table name to moniker translation. Can be either
200 a hashref of table keys and moniker values, or a coderef for a translator
201 function taking a single scalar table name argument and returning
202 a scalar moniker. If the hash entry does not exist, or the function
203 returns a false value, the code falls back to default behavior
206 The default behavior is to singularize the table name, and: C<join '', map
207 ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
208 split up the table name into chunks anywhere a non-alpha-numeric character
209 occurs, change the case of first letter of each chunk to upper case, and put
210 the chunks back together. Examples:
212 Table Name | Moniker Name
213 ---------------------------
215 luser_group | LuserGroup
216 luser-opts | LuserOpt
218 =head2 inflect_plural
220 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
221 if hash key does not exist or coderef returns false), but acts as a map
222 for pluralizing relationship names. The default behavior is to utilize
223 L<Lingua::EN::Inflect::Number/to_PL>.
225 =head2 inflect_singular
227 As L</inflect_plural> above, but for singularizing relationship names.
228 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
230 =head2 schema_base_class
232 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
234 =head2 result_base_class
236 Base class for your table classes (aka result classes). Defaults to
239 =head2 additional_base_classes
241 List of additional base classes all of your table classes will use.
243 =head2 left_base_classes
245 List of additional base classes all of your table classes will use
246 that need to be leftmost.
248 =head2 additional_classes
250 List of additional classes which all of your table classes will use.
254 List of additional components to be loaded into all of your table
255 classes. A good example would be C<ResultSetManager>.
257 =head2 resultset_components
259 List of additional ResultSet components to be loaded into your table
260 classes. A good example would be C<AlwaysRS>. Component
261 C<ResultSetManager> will be automatically added to the above
262 C<components> list if this option is set.
264 =head2 use_namespaces
266 Generate result class names suitable for
267 L<DBIx::Class::Schema/load_namespaces> and call that instead of
268 L<DBIx::Class::Schema/load_classes>. When using this option you can also
269 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
270 C<resultset_namespace>, C<default_resultset_class>), and they will be added
271 to the call (and the generated result class names adjusted appropriately).
273 =head2 dump_directory
275 This option is designed to be a tool to help you transition from this
276 loader to a manually-defined schema when you decide it's time to do so.
278 The value of this option is a perl libdir pathname. Within
279 that directory this module will create a baseline manual
280 L<DBIx::Class::Schema> module set, based on what it creates at runtime
283 The created schema class will have the same classname as the one on
284 which you are setting this option (and the ResultSource classes will be
285 based on this name as well).
287 Normally you wouldn't hard-code this setting in your schema class, as it
288 is meant for one-time manual usage.
290 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
291 recommended way to access this functionality.
293 =head2 dump_overwrite
295 Deprecated. See L</really_erase_my_files> below, which does *not* mean
296 the same thing as the old C<dump_overwrite> setting from previous releases.
298 =head2 really_erase_my_files
300 Default false. If true, Loader will unconditionally delete any existing
301 files before creating the new ones from scratch when dumping a schema to disk.
303 The default behavior is instead to only replace the top portion of the
304 file, up to and including the final stanza which contains
305 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
306 leaving any customizations you placed after that as they were.
308 When C<really_erase_my_files> is not set, if the output file already exists,
309 but the aforementioned final stanza is not found, or the checksum
310 contained there does not match the generated contents, Loader will
311 croak and not touch the file.
313 You should really be using version control on your schema classes (and all
314 of the rest of your code for that matter). Don't blame me if a bug in this
315 code wipes something out when it shouldn't have, you've been warned.
317 =head2 overwrite_modifications
319 Default false. If false, when updating existing files, Loader will
320 refuse to modify any Loader-generated code that has been modified
321 since its last run (as determined by the checksum Loader put in its
324 If true, Loader will discard any manual modifications that have been
325 made to Loader-generated code.
327 Again, you should be using version control on your schema classes. Be
328 careful with this option.
332 None of these methods are intended for direct invocation by regular
333 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
334 can also be found via standard L<DBIx::Class::Schema> methods somehow.
338 use constant CURRENT_V => 'v5';
340 # ensure that a peice of object data is a valid arrayref, creating
341 # an empty one or encapsulating whatever's there.
342 sub _ensure_arrayref {
347 $self->{$_} = [ $self->{$_} ]
348 unless ref $self->{$_} eq 'ARRAY';
354 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
355 by L<DBIx::Class::Schema::Loader>.
360 my ( $class, %args ) = @_;
362 my $self = { %args };
364 bless $self => $class;
366 $self->_ensure_arrayref(qw/additional_classes
367 additional_base_classes
373 push(@{$self->{components}}, 'ResultSetManager')
374 if @{$self->{resultset_components}};
376 $self->{monikers} = {};
377 $self->{classes} = {};
378 $self->{_upgrading_classes} = {};
380 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
381 $self->{schema} ||= $self->{schema_class};
383 croak "dump_overwrite is deprecated. Please read the"
384 . " DBIx::Class::Schema::Loader::Base documentation"
385 if $self->{dump_overwrite};
387 $self->{dynamic} = ! $self->{dump_directory};
388 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
393 $self->{dump_directory} ||= $self->{temp_directory};
395 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
396 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
398 if ((not ref $self->naming) && defined $self->naming) {
399 my $naming_ver = $self->naming;
401 relationships => $naming_ver,
402 monikers => $naming_ver,
407 for (values %{ $self->naming }) {
408 $_ = CURRENT_V if $_ eq 'current';
411 $self->{naming} ||= {};
413 $self->_check_back_compat;
418 sub _check_back_compat {
421 # dynamic schemas will always be in 0.04006 mode, unless overridden
422 if ($self->dynamic) {
423 # just in case, though no one is likely to dump a dynamic schema
424 $self->schema_version_to_dump('0.04006');
426 if (not %{ $self->naming }) {
427 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
429 Dynamic schema detected, will run in 0.04006 mode.
431 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
432 to disable this warning.
434 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
439 $self->_upgrading_from('v4');
442 $self->naming->{relationships} ||= 'v4';
443 $self->naming->{monikers} ||= 'v4';
448 # otherwise check if we need backcompat mode for a static schema
449 my $filename = $self->_get_dump_filename($self->schema_class);
450 return unless -e $filename;
452 open(my $fh, '<', $filename)
453 or croak "Cannot open '$filename' for reading: $!";
456 if (/^# Created by DBIx::Class::Schema::Loader v((\d+)\.(\d+))/) {
459 # XXX when we go past .0 this will need fixing
460 my ($v) = $real_ver =~ /([1-9])/;
463 last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/;
465 if (not %{ $self->naming }) {
466 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
468 Version $real_ver static schema detected, turning on backcompat mode.
470 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
471 to disable this warning.
473 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
478 $self->_upgrading_from($v);
482 $self->naming->{relationships} ||= $v;
483 $self->naming->{monikers} ||= $v;
485 $self->schema_version_to_dump($real_ver);
493 sub _find_file_in_inc {
494 my ($self, $file) = @_;
496 foreach my $prefix (@INC) {
497 my $fullpath = File::Spec->catfile($prefix, $file);
498 return $fullpath if -f $fullpath
499 and Cwd::abs_path($fullpath) ne
500 (Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '');
507 my ($self, $class) = @_;
509 my $class_path = $class;
510 $class_path =~ s{::}{/}g;
511 $class_path .= '.pm';
516 sub _find_class_in_inc {
517 my ($self, $class) = @_;
519 return $self->_find_file_in_inc($self->_class_path($class));
522 sub _rewrite_old_classnames {
523 my ($self, $code) = @_;
525 return $code unless $self->_upgrading_from;
527 my %old_classes = reverse %{ $self->_upgrading_classes };
529 my $re = join '|', keys %old_classes;
532 $code =~ s/$re/$old_classes{$1} || $1/eg;
538 my ($self, $class) = @_;
540 return if $self->{skip_load_external};
542 # so that we don't load our own classes, under any circumstances
543 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
545 my $real_inc_path = $self->_find_class_in_inc($class);
547 my $old_class = $self->_upgrading_classes->{$class}
548 if $self->_upgrading_from;
550 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
551 if $old_class && $old_class ne $class;
553 return unless $real_inc_path || $old_real_inc_path;
555 if ($real_inc_path) {
556 # If we make it to here, we loaded an external definition
557 warn qq/# Loaded external class definition for '$class'\n/
560 open(my $fh, '<', $real_inc_path)
561 or croak "Failed to open '$real_inc_path' for reading: $!";
562 my $code = do { local $/; <$fh> };
564 or croak "Failed to close $real_inc_path: $!";
565 $code = $self->_rewrite_old_classnames($code);
567 if ($self->dynamic) { # load the class too
568 # kill redefined warnings
569 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
570 local $SIG{__WARN__} = sub {
572 unless $_[0] =~ /^Subroutine \S+ redefined/;
578 $self->_ext_stmt($class,
579 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
580 .qq|# They are now part of the custom portion of this file\n|
581 .qq|# for you to hand-edit. If you do not either delete\n|
582 .qq|# this section or remove that file from \@INC, this section\n|
583 .qq|# will be repeated redundantly when you re-create this\n|
584 .qq|# file again via Loader! See skip_load_external to disable\n|
585 .qq|# this feature.\n|
588 $self->_ext_stmt($class, $code);
589 $self->_ext_stmt($class,
590 qq|# End of lines loaded from '$real_inc_path' |
594 if ($old_real_inc_path) {
595 open(my $fh, '<', $old_real_inc_path)
596 or croak "Failed to open '$old_real_inc_path' for reading: $!";
597 $self->_ext_stmt($class, <<"EOF");
599 # These lines were loaded from '$old_real_inc_path',
600 # based on the Result class name that would have been created by an 0.04006
601 # version of the Loader. For a static schema, this happens only once during
602 # upgrade. See skip_load_external to disable this feature.
606 local ($/, @ARGV) = (undef, $old_real_inc_path); <>
608 $code = $self->_rewrite_old_classnames($code);
610 if ($self->dynamic) {
613 Detected external content in '$old_real_inc_path', a class name that would have
614 been used by an 0.04006 version of the Loader.
616 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
617 new name of the Result.
619 # kill redefined warnings
620 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
621 local $SIG{__WARN__} = sub {
623 unless $_[0] =~ /^Subroutine \S+ redefined/;
630 $self->_ext_stmt($class, $code);
631 $self->_ext_stmt($class,
632 qq|# End of lines loaded from '$old_real_inc_path' |
639 Does the actual schema-construction work.
646 $self->_load_tables($self->_tables_list);
653 Rescan the database for newly added tables. Does
654 not process drops or changes. Returns a list of
655 the newly added table monikers.
657 The schema argument should be the schema class
658 or object to be affected. It should probably
659 be derived from the original schema_class used
665 my ($self, $schema) = @_;
667 $self->{schema} = $schema;
668 $self->_relbuilder->{schema} = $schema;
671 my @current = $self->_tables_list;
672 foreach my $table ($self->_tables_list) {
673 if(!exists $self->{_tables}->{$table}) {
674 push(@created, $table);
678 my $loaded = $self->_load_tables(@created);
680 return map { $self->monikers->{$_} } @$loaded;
684 no warnings 'uninitialized';
687 return if $self->{skip_relationships};
689 if ($self->naming->{relationships} eq 'v4') {
690 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
691 return $self->{relbuilder} ||=
692 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
693 $self->schema, $self->inflect_plural, $self->inflect_singular
697 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
699 $self->inflect_plural,
700 $self->inflect_singular,
701 $self->relationship_attrs,
706 my ($self, @tables) = @_;
708 # First, use _tables_list with constraint and exclude
709 # to get a list of tables to operate on
711 my $constraint = $self->constraint;
712 my $exclude = $self->exclude;
714 @tables = grep { /$constraint/ } @tables if $constraint;
715 @tables = grep { ! /$exclude/ } @tables if $exclude;
717 # Save the new tables to the tables list
719 $self->{_tables}->{$_} = 1;
722 $self->_make_src_class($_) for @tables;
723 $self->_setup_src_meta($_) for @tables;
725 if(!$self->skip_relationships) {
726 # The relationship loader needs a working schema
728 local $self->{dump_directory} = $self->{temp_directory};
729 $self->_reload_classes(\@tables);
730 $self->_load_relationships($_) for @tables;
733 # Remove that temp dir from INC so it doesn't get reloaded
734 @INC = grep $_ ne $self->dump_directory, @INC;
737 $self->_load_external($_)
738 for map { $self->classes->{$_} } @tables;
740 # Reload without unloading first to preserve any symbols from external
742 $self->_reload_classes(\@tables, 0);
744 # Drop temporary cache
745 delete $self->{_cache};
750 sub _reload_classes {
751 my ($self, $tables, $unload) = @_;
753 my @tables = @$tables;
754 $unload = 1 unless defined $unload;
756 # so that we don't repeat custom sections
757 @INC = grep $_ ne $self->dump_directory, @INC;
759 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
761 unshift @INC, $self->dump_directory;
764 my %have_source = map { $_ => $self->schema->source($_) }
765 $self->schema->sources;
767 for my $table (@tables) {
768 my $moniker = $self->monikers->{$table};
769 my $class = $self->classes->{$table};
772 no warnings 'redefine';
773 local *Class::C3::reinitialize = sub {};
776 Class::Unload->unload($class) if $unload;
777 my ($source, $resultset_class);
779 ($source = $have_source{$moniker})
780 && ($resultset_class = $source->resultset_class)
781 && ($resultset_class ne 'DBIx::Class::ResultSet')
783 my $has_file = Class::Inspector->loaded_filename($resultset_class);
784 Class::Unload->unload($resultset_class) if $unload;
785 $self->_reload_class($resultset_class) if $has_file;
787 $self->_reload_class($class);
789 push @to_register, [$moniker, $class];
792 Class::C3->reinitialize;
794 $self->schema->register_class(@$_);
798 # We use this instead of ensure_class_loaded when there are package symbols we
801 my ($self, $class) = @_;
803 my $class_path = $self->_class_path($class);
804 delete $INC{ $class_path };
806 # kill redefined warnings
807 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
808 local $SIG{__WARN__} = sub {
810 unless $_[0] =~ /^Subroutine \S+ redefined/;
812 eval "require $class;";
815 sub _get_dump_filename {
816 my ($self, $class) = (@_);
819 return $self->dump_directory . q{/} . $class . q{.pm};
822 sub _ensure_dump_subdirs {
823 my ($self, $class) = (@_);
825 my @name_parts = split(/::/, $class);
826 pop @name_parts; # we don't care about the very last element,
827 # which is a filename
829 my $dir = $self->dump_directory;
832 mkdir($dir) or croak "mkdir('$dir') failed: $!";
834 last if !@name_parts;
835 $dir = File::Spec->catdir($dir, shift @name_parts);
840 my ($self, @classes) = @_;
842 my $schema_class = $self->schema_class;
843 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
845 my $target_dir = $self->dump_directory;
846 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
847 unless $self->{dynamic} or $self->{quiet};
850 qq|package $schema_class;\n\n|
851 . qq|# Created by DBIx::Class::Schema::Loader\n|
852 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
853 . qq|use strict;\nuse warnings;\n\n|
854 . qq|use base '$schema_base_class';\n\n|;
856 if ($self->use_namespaces) {
857 $schema_text .= qq|__PACKAGE__->load_namespaces|;
858 my $namespace_options;
859 for my $attr (qw(result_namespace
861 default_resultset_class)) {
863 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
866 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
867 $schema_text .= qq|;\n|;
870 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
874 local $self->{version_to_dump} = $self->schema_version_to_dump;
875 $self->_write_classfile($schema_class, $schema_text, 1);
878 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
880 foreach my $src_class (@classes) {
882 qq|package $src_class;\n\n|
883 . qq|# Created by DBIx::Class::Schema::Loader\n|
884 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
885 . qq|use strict;\nuse warnings;\n\n|
886 . qq|use base '$result_base_class';\n\n|;
888 $self->_write_classfile($src_class, $src_text);
891 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
896 my ($self, $version, $ts) = @_;
897 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
900 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
903 sub _write_classfile {
904 my ($self, $class, $text, $is_schema) = @_;
906 my $filename = $self->_get_dump_filename($class);
907 $self->_ensure_dump_subdirs($class);
909 if (-f $filename && $self->really_erase_my_files) {
910 warn "Deleting existing file '$filename' due to "
911 . "'really_erase_my_files' setting\n" unless $self->{quiet};
915 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
917 if (my $old_class = $self->_upgrading_classes->{$class}) {
918 my $old_filename = $self->_get_dump_filename($old_class);
920 my ($old_custom_content) = $self->_get_custom_content(
921 $old_class, $old_filename, 0 # do not add default comment
924 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
926 if ($old_custom_content) {
928 "\n" . $old_custom_content . "\n" . $custom_content;
931 unlink $old_filename;
934 $custom_content = $self->_rewrite_old_classnames($custom_content);
937 for @{$self->{_dump_storage}->{$class} || []};
939 # Check and see if the dump is infact differnt
943 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
946 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
947 return unless $self->_upgrading_from && $is_schema;
951 $text .= $self->_sig_comment(
952 $self->version_to_dump,
953 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
956 open(my $fh, '>', $filename)
957 or croak "Cannot open '$filename' for writing: $!";
959 # Write the top half and its MD5 sum
960 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
962 # Write out anything loaded via external partial class file in @INC
964 for @{$self->{_ext_storage}->{$class} || []};
966 # Write out any custom content the user has added
967 print $fh $custom_content;
970 or croak "Error closing '$filename': $!";
973 sub _default_custom_content {
974 return qq|\n\n# You can replace this text with custom|
975 . qq| content, and it will be preserved on regeneration|
979 sub _get_custom_content {
980 my ($self, $class, $filename, $add_default) = @_;
982 $add_default = 1 unless defined $add_default;
984 return ($self->_default_custom_content) if ! -f $filename;
986 open(my $fh, '<', $filename)
987 or croak "Cannot open '$filename' for reading: $!";
990 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
993 my ($md5, $ts, $ver);
995 if(!$md5 && /$mark_re/) {
999 # Pull out the previous version and timestamp
1000 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
1003 croak "Checksum mismatch in '$filename', the auto-generated part of the file has been modified outside of this loader. Aborting.\nIf you want to overwrite these modifications, set the 'overwrite_modifications' loader option.\n"
1004 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
1013 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1014 . " it does not appear to have been generated by Loader"
1017 # Default custom content:
1018 $buffer ||= $self->_default_custom_content if $add_default;
1020 return ($buffer, $md5, $ver, $ts);
1028 warn "$target: use $_;" if $self->debug;
1029 $self->_raw_stmt($target, "use $_;");
1036 my $schema_class = $self->schema_class;
1038 my $blist = join(q{ }, @_);
1039 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1040 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1043 # Create class with applicable bases, setup monikers, etc
1044 sub _make_src_class {
1045 my ($self, $table) = @_;
1047 my $schema = $self->schema;
1048 my $schema_class = $self->schema_class;
1050 my $table_moniker = $self->_table2moniker($table);
1051 my @result_namespace = ($schema_class);
1052 if ($self->use_namespaces) {
1053 my $result_namespace = $self->result_namespace || 'Result';
1054 if ($result_namespace =~ /^\+(.*)/) {
1055 # Fully qualified namespace
1056 @result_namespace = ($1)
1059 # Relative namespace
1060 push @result_namespace, $result_namespace;
1063 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1065 if (my $upgrading_v = $self->_upgrading_from) {
1066 local $self->naming->{monikers} = $upgrading_v;
1068 my $old_class = join(q{::}, @result_namespace,
1069 $self->_table2moniker($table));
1071 $self->_upgrading_classes->{$table_class} = $old_class
1072 unless $table_class eq $old_class;
1075 my $table_normalized = lc $table;
1076 $self->classes->{$table} = $table_class;
1077 $self->classes->{$table_normalized} = $table_class;
1078 $self->monikers->{$table} = $table_moniker;
1079 $self->monikers->{$table_normalized} = $table_moniker;
1081 $self->_use ($table_class, @{$self->additional_classes});
1082 $self->_inject($table_class, @{$self->left_base_classes});
1084 if (my @components = @{ $self->components }) {
1085 $self->_dbic_stmt($table_class, 'load_components', @components);
1088 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1089 if @{$self->resultset_components};
1090 $self->_inject($table_class, @{$self->additional_base_classes});
1093 # Set up metadata (cols, pks, etc)
1094 sub _setup_src_meta {
1095 my ($self, $table) = @_;
1097 my $schema = $self->schema;
1098 my $schema_class = $self->schema_class;
1100 my $table_class = $self->classes->{$table};
1101 my $table_moniker = $self->monikers->{$table};
1103 my $table_name = $table;
1104 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1106 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1107 $table_name = \ $self->_quote_table_name($table_name);
1110 $self->_dbic_stmt($table_class,'table',$table_name);
1112 my $cols = $self->_table_columns($table);
1114 eval { $col_info = $self->_columns_info_for($table) };
1116 $self->_dbic_stmt($table_class,'add_columns',@$cols);
1119 if ($self->_is_case_sensitive) {
1120 for my $col (keys %$col_info) {
1121 $col_info->{$col}{accessor} = lc $col
1122 if $col ne lc($col);
1125 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1128 my $fks = $self->_table_fk_info($table);
1130 for my $fkdef (@$fks) {
1131 for my $col (@{ $fkdef->{local_columns} }) {
1132 $col_info->{$col}{is_foreign_key} = 1;
1138 map { $_, ($col_info->{$_}||{}) } @$cols
1142 my %uniq_tag; # used to eliminate duplicate uniqs
1144 my $pks = $self->_table_pk_info($table) || [];
1145 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1146 : carp("$table has no primary key");
1147 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1149 my $uniqs = $self->_table_uniq_info($table) || [];
1151 my ($name, $cols) = @$_;
1152 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1153 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1160 Returns a sorted list of loaded tables, using the original database table
1168 return keys %{$self->_tables};
1171 # Make a moniker from a table
1172 sub _default_table2moniker {
1173 no warnings 'uninitialized';
1174 my ($self, $table) = @_;
1176 if ($self->naming->{monikers} eq 'v4') {
1177 return join '', map ucfirst, split /[\W_]+/, lc $table;
1180 return join '', map ucfirst, split /[\W_]+/,
1181 Lingua::EN::Inflect::Number::to_S(lc $table);
1184 sub _table2moniker {
1185 my ( $self, $table ) = @_;
1189 if( ref $self->moniker_map eq 'HASH' ) {
1190 $moniker = $self->moniker_map->{$table};
1192 elsif( ref $self->moniker_map eq 'CODE' ) {
1193 $moniker = $self->moniker_map->($table);
1196 $moniker ||= $self->_default_table2moniker($table);
1201 sub _load_relationships {
1202 my ($self, $table) = @_;
1204 my $tbl_fk_info = $self->_table_fk_info($table);
1205 foreach my $fkdef (@$tbl_fk_info) {
1206 $fkdef->{remote_source} =
1207 $self->monikers->{delete $fkdef->{remote_table}};
1209 my $tbl_uniq_info = $self->_table_uniq_info($table);
1211 my $local_moniker = $self->monikers->{$table};
1212 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1214 foreach my $src_class (sort keys %$rel_stmts) {
1215 my $src_stmts = $rel_stmts->{$src_class};
1216 foreach my $stmt (@$src_stmts) {
1217 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1222 # Overload these in driver class:
1224 # Returns an arrayref of column names
1225 sub _table_columns { croak "ABSTRACT METHOD" }
1227 # Returns arrayref of pk col names
1228 sub _table_pk_info { croak "ABSTRACT METHOD" }
1230 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1231 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1233 # Returns an arrayref of foreign key constraints, each
1234 # being a hashref with 3 keys:
1235 # local_columns (arrayref), remote_columns (arrayref), remote_table
1236 sub _table_fk_info { croak "ABSTRACT METHOD" }
1238 # Returns an array of lower case table names
1239 sub _tables_list { croak "ABSTRACT METHOD" }
1241 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1247 # generate the pod for this statement, storing it with $self->_pod
1248 $self->_make_pod( $class, $method, @_ );
1250 my $args = dump(@_);
1251 $args = '(' . $args . ')' if @_ < 2;
1252 my $stmt = $method . $args . q{;};
1254 warn qq|$class\->$stmt\n| if $self->debug;
1255 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1259 # generates the accompanying pod for a DBIC class method statement,
1260 # storing it with $self->_pod
1266 if ( $method eq 'table' ) {
1268 $self->_pod( $class, "=head1 NAME" );
1269 my $table_descr = $class;
1270 if ( $self->can('_table_comment') ) {
1271 my $comment = $self->_table_comment($table);
1272 $table_descr .= " - " . $comment if $comment;
1274 $self->{_class2table}{ $class } = $table;
1275 $self->_pod( $class, $table_descr );
1276 $self->_pod_cut( $class );
1277 } elsif ( $method eq 'add_columns' ) {
1278 $self->_pod( $class, "=head1 ACCESSORS" );
1279 my $col_counter = 0;
1281 while( my ($name,$attrs) = splice @cols,0,2 ) {
1283 $self->_pod( $class, '=head2 ' . $name );
1284 $self->_pod( $class,
1286 my $s = $attrs->{$_};
1287 $s = !defined $s ? 'undef' :
1288 length($s) == 0 ? '(empty string)' :
1292 } sort keys %$attrs,
1295 if( $self->can('_column_comment')
1296 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1298 $self->_pod( $class, $comment );
1301 $self->_pod_cut( $class );
1302 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1303 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1304 my ( $accessor, $rel_class ) = @_;
1305 $self->_pod( $class, "=head2 $accessor" );
1306 $self->_pod( $class, 'Type: ' . $method );
1307 $self->_pod( $class, "Related object: L<$rel_class>" );
1308 $self->_pod_cut( $class );
1309 $self->{_relations_started} { $class } = 1;
1313 # Stores a POD documentation
1315 my ($self, $class, $stmt) = @_;
1316 $self->_raw_stmt( $class, "\n" . $stmt );
1320 my ($self, $class ) = @_;
1321 $self->_raw_stmt( $class, "\n=cut\n" );
1325 # Store a raw source line for a class (for dumping purposes)
1327 my ($self, $class, $stmt) = @_;
1328 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1331 # Like above, but separately for the externally loaded stuff
1333 my ($self, $class, $stmt) = @_;
1334 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1337 sub _quote_table_name {
1338 my ($self, $table) = @_;
1340 my $qt = $self->schema->storage->sql_maker->quote_char;
1342 return $table unless $qt;
1345 return $qt->[0] . $table . $qt->[1];
1348 return $qt . $table . $qt;
1351 sub _is_case_sensitive { 0 }
1353 # remove the dump dir from @INC on destruction
1357 @INC = grep $_ ne $self->dump_directory, @INC;
1362 Returns a hashref of loaded table to moniker mappings. There will
1363 be two entries for each table, the original name and the "normalized"
1364 name, in the case that the two are different (such as databases
1365 that like uppercase table names, or preserve your original mixed-case
1366 definitions, or what-have-you).
1370 Returns a hashref of table to class mappings. In some cases it will
1371 contain multiple entries per table for the original and normalized table
1372 names, as above in L</monikers>.
1376 L<DBIx::Class::Schema::Loader>
1380 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1384 This library is free software; you can redistribute it and/or modify it under
1385 the same terms as Perl itself.