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_12';
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 | LuserOpts
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\.04999/;
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);
481 $self->naming->{relationships} ||= $v;
482 $self->naming->{monikers} ||= $v;
484 $self->schema_version_to_dump($real_ver);
492 sub _find_file_in_inc {
493 my ($self, $file) = @_;
495 foreach my $prefix (@INC) {
496 my $fullpath = File::Spec->catfile($prefix, $file);
497 return $fullpath if -f $fullpath
498 and Cwd::abs_path($fullpath) ne
499 (Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '');
506 my ($self, $class) = @_;
508 my $class_path = $class;
509 $class_path =~ s{::}{/}g;
510 $class_path .= '.pm';
515 sub _find_class_in_inc {
516 my ($self, $class) = @_;
518 return $self->_find_file_in_inc($self->_class_path($class));
522 my ($self, $class) = @_;
524 return if $self->{skip_load_external};
526 # so that we don't load our own classes, under any circumstances
527 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
529 my $real_inc_path = $self->_find_class_in_inc($class);
531 my $old_class = $self->_upgrading_classes->{$class}
532 if $self->_upgrading_from;
534 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
535 if $old_class && $old_class ne $class;
537 return unless $real_inc_path || $old_real_inc_path;
539 if ($real_inc_path) {
540 # If we make it to here, we loaded an external definition
541 warn qq/# Loaded external class definition for '$class'\n/
544 open(my $fh, '<', $real_inc_path)
545 or croak "Failed to open '$real_inc_path' for reading: $!";
546 $self->_ext_stmt($class,
547 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
548 .qq|# They are now part of the custom portion of this file\n|
549 .qq|# for you to hand-edit. If you do not either delete\n|
550 .qq|# this section or remove that file from \@INC, this section\n|
551 .qq|# will be repeated redundantly when you re-create this\n|
552 .qq|# file again via Loader!\n|
556 $self->_ext_stmt($class, $_);
558 $self->_ext_stmt($class,
559 qq|# End of lines loaded from '$real_inc_path' |
562 or croak "Failed to close $real_inc_path: $!";
564 if ($self->dynamic) { # load the class too
565 # kill redefined warnings
566 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
567 local $SIG{__WARN__} = sub {
569 unless $_[0] =~ /^Subroutine \S+ redefined/;
576 if ($old_real_inc_path) {
577 open(my $fh, '<', $old_real_inc_path)
578 or croak "Failed to open '$old_real_inc_path' for reading: $!";
579 $self->_ext_stmt($class, <<"EOF");
581 # These lines were loaded from '$old_real_inc_path', based on the Result class
582 # name that would have been created by an 0.04006 version of the Loader. For a
583 # static schema, this happens only once during upgrade.
585 if ($self->dynamic) {
588 Detected external content in '$old_real_inc_path', a class name that would have
589 been used by an 0.04006 version of the Loader.
591 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
592 new name of the Result.
594 # kill redefined warnings
595 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
596 local $SIG{__WARN__} = sub {
598 unless $_[0] =~ /^Subroutine \S+ redefined/;
601 local ($/, @ARGV) = (undef, $old_real_inc_path); <>
603 $code =~ s/$old_class/$class/g;
610 $self->_ext_stmt($class, $_);
612 $self->_ext_stmt($class,
613 qq|# End of lines loaded from '$old_real_inc_path' |
617 or croak "Failed to close $old_real_inc_path: $!";
623 Does the actual schema-construction work.
630 $self->_load_tables($self->_tables_list);
637 Rescan the database for newly added tables. Does
638 not process drops or changes. Returns a list of
639 the newly added table monikers.
641 The schema argument should be the schema class
642 or object to be affected. It should probably
643 be derived from the original schema_class used
649 my ($self, $schema) = @_;
651 $self->{schema} = $schema;
652 $self->_relbuilder->{schema} = $schema;
655 my @current = $self->_tables_list;
656 foreach my $table ($self->_tables_list) {
657 if(!exists $self->{_tables}->{$table}) {
658 push(@created, $table);
662 my $loaded = $self->_load_tables(@created);
664 return map { $self->monikers->{$_} } @$loaded;
668 no warnings 'uninitialized';
671 return if $self->{skip_relationships};
673 if ($self->naming->{relationships} eq 'v4') {
674 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
675 return $self->{relbuilder} ||=
676 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
677 $self->schema, $self->inflect_plural, $self->inflect_singular
681 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
683 $self->inflect_plural,
684 $self->inflect_singular,
685 $self->relationship_attrs,
690 my ($self, @tables) = @_;
692 # First, use _tables_list with constraint and exclude
693 # to get a list of tables to operate on
695 my $constraint = $self->constraint;
696 my $exclude = $self->exclude;
698 @tables = grep { /$constraint/ } @tables if $constraint;
699 @tables = grep { ! /$exclude/ } @tables if $exclude;
701 # Save the new tables to the tables list
703 $self->{_tables}->{$_} = 1;
706 $self->_make_src_class($_) for @tables;
707 $self->_setup_src_meta($_) for @tables;
709 if(!$self->skip_relationships) {
710 # The relationship loader needs a working schema
712 local $self->{dump_directory} = $self->{temp_directory};
713 $self->_reload_classes(\@tables);
714 $self->_load_relationships($_) for @tables;
717 # Remove that temp dir from INC so it doesn't get reloaded
718 @INC = grep $_ ne $self->dump_directory, @INC;
721 $self->_load_external($_)
722 for map { $self->classes->{$_} } @tables;
724 # Reload without unloading first to preserve any symbols from external
726 $self->_reload_classes(\@tables, 0);
728 # Drop temporary cache
729 delete $self->{_cache};
734 sub _reload_classes {
735 my ($self, $tables, $unload) = @_;
737 my @tables = @$tables;
738 $unload = 1 unless defined $unload;
740 # so that we don't repeat custom sections
741 @INC = grep $_ ne $self->dump_directory, @INC;
743 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
745 unshift @INC, $self->dump_directory;
748 my %have_source = map { $_ => $self->schema->source($_) }
749 $self->schema->sources;
751 for my $table (@tables) {
752 my $moniker = $self->monikers->{$table};
753 my $class = $self->classes->{$table};
756 no warnings 'redefine';
757 local *Class::C3::reinitialize = sub {};
760 Class::Unload->unload($class) if $unload;
761 my ($source, $resultset_class);
763 ($source = $have_source{$moniker})
764 && ($resultset_class = $source->resultset_class)
765 && ($resultset_class ne 'DBIx::Class::ResultSet')
767 my $has_file = Class::Inspector->loaded_filename($resultset_class);
768 Class::Unload->unload($resultset_class) if $unload;
769 $self->_reload_class($resultset_class) if $has_file;
771 $self->_reload_class($class);
773 push @to_register, [$moniker, $class];
776 Class::C3->reinitialize;
778 $self->schema->register_class(@$_);
782 # We use this instead of ensure_class_loaded when there are package symbols we
785 my ($self, $class) = @_;
787 my $class_path = $self->_class_path($class);
788 delete $INC{ $class_path };
790 # kill redefined warnings
791 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
792 local $SIG{__WARN__} = sub {
794 unless $_[0] =~ /^Subroutine \S+ redefined/;
796 eval "require $class;";
799 sub _get_dump_filename {
800 my ($self, $class) = (@_);
803 return $self->dump_directory . q{/} . $class . q{.pm};
806 sub _ensure_dump_subdirs {
807 my ($self, $class) = (@_);
809 my @name_parts = split(/::/, $class);
810 pop @name_parts; # we don't care about the very last element,
811 # which is a filename
813 my $dir = $self->dump_directory;
816 mkdir($dir) or croak "mkdir('$dir') failed: $!";
818 last if !@name_parts;
819 $dir = File::Spec->catdir($dir, shift @name_parts);
824 my ($self, @classes) = @_;
826 my $schema_class = $self->schema_class;
827 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
829 my $target_dir = $self->dump_directory;
830 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
831 unless $self->{dynamic} or $self->{quiet};
834 qq|package $schema_class;\n\n|
835 . qq|# Created by DBIx::Class::Schema::Loader\n|
836 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
837 . qq|use strict;\nuse warnings;\n\n|
838 . qq|use base '$schema_base_class';\n\n|;
840 if ($self->use_namespaces) {
841 $schema_text .= qq|__PACKAGE__->load_namespaces|;
842 my $namespace_options;
843 for my $attr (qw(result_namespace
845 default_resultset_class)) {
847 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
850 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
851 $schema_text .= qq|;\n|;
854 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
858 local $self->{version_to_dump} = $self->schema_version_to_dump;
859 $self->_write_classfile($schema_class, $schema_text);
862 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
864 foreach my $src_class (@classes) {
866 qq|package $src_class;\n\n|
867 . qq|# Created by DBIx::Class::Schema::Loader\n|
868 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
869 . qq|use strict;\nuse warnings;\n\n|
870 . qq|use base '$result_base_class';\n\n|;
872 $self->_write_classfile($src_class, $src_text);
875 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
880 my ($self, $version, $ts) = @_;
881 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
884 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
887 sub _write_classfile {
888 my ($self, $class, $text) = @_;
890 my $filename = $self->_get_dump_filename($class);
891 $self->_ensure_dump_subdirs($class);
893 if (-f $filename && $self->really_erase_my_files) {
894 warn "Deleting existing file '$filename' due to "
895 . "'really_erase_my_files' setting\n" unless $self->{quiet};
899 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
901 if ($self->_upgrading_from) {
902 my $old_class = $self->_upgrading_classes->{$class};
904 if ($old_class && ($old_class ne $class)) {
905 my $old_filename = $self->_get_dump_filename($old_class);
907 my ($old_custom_content) = $self->_get_custom_content(
908 $old_class, $old_filename, 0 # do not add default comment
911 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
913 if ($old_custom_content) {
915 "\n" . $old_custom_content . "\n" . $custom_content;
918 unlink $old_filename;
923 for @{$self->{_dump_storage}->{$class} || []};
925 # Check and see if the dump is infact differnt
929 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
932 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
937 $text .= $self->_sig_comment(
938 $self->version_to_dump,
939 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
942 open(my $fh, '>', $filename)
943 or croak "Cannot open '$filename' for writing: $!";
945 # Write the top half and its MD5 sum
946 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
948 # Write out anything loaded via external partial class file in @INC
950 for @{$self->{_ext_storage}->{$class} || []};
952 # Write out any custom content the user has added
953 print $fh $custom_content;
956 or croak "Error closing '$filename': $!";
959 sub _default_custom_content {
960 return qq|\n\n# You can replace this text with custom|
961 . qq| content, and it will be preserved on regeneration|
965 sub _get_custom_content {
966 my ($self, $class, $filename, $add_default) = @_;
968 $add_default = 1 unless defined $add_default;
970 return ($self->_default_custom_content) if ! -f $filename;
972 open(my $fh, '<', $filename)
973 or croak "Cannot open '$filename' for reading: $!";
976 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
979 my ($md5, $ts, $ver);
981 if(!$md5 && /$mark_re/) {
985 # Pull out the previous version and timestamp
986 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
989 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"
990 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
999 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1000 . " it does not appear to have been generated by Loader"
1003 # Default custom content:
1004 $buffer ||= $self->_default_custom_content if $add_default;
1006 return ($buffer, $md5, $ver, $ts);
1014 warn "$target: use $_;" if $self->debug;
1015 $self->_raw_stmt($target, "use $_;");
1022 my $schema_class = $self->schema_class;
1024 my $blist = join(q{ }, @_);
1025 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1026 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1029 # Create class with applicable bases, setup monikers, etc
1030 sub _make_src_class {
1031 my ($self, $table) = @_;
1033 my $schema = $self->schema;
1034 my $schema_class = $self->schema_class;
1036 my $table_moniker = $self->_table2moniker($table);
1037 my @result_namespace = ($schema_class);
1038 if ($self->use_namespaces) {
1039 my $result_namespace = $self->result_namespace || 'Result';
1040 if ($result_namespace =~ /^\+(.*)/) {
1041 # Fully qualified namespace
1042 @result_namespace = ($1)
1045 # Relative namespace
1046 push @result_namespace, $result_namespace;
1049 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1051 if (my $upgrading_v = $self->_upgrading_from) {
1052 local $self->naming->{monikers} = $upgrading_v;
1054 my $old_class = join(q{::}, @result_namespace,
1055 $self->_table2moniker($table));
1057 $self->_upgrading_classes->{$table_class} = $old_class;
1060 my $table_normalized = lc $table;
1061 $self->classes->{$table} = $table_class;
1062 $self->classes->{$table_normalized} = $table_class;
1063 $self->monikers->{$table} = $table_moniker;
1064 $self->monikers->{$table_normalized} = $table_moniker;
1066 $self->_use ($table_class, @{$self->additional_classes});
1067 $self->_inject($table_class, @{$self->left_base_classes});
1069 if (my @components = @{ $self->components }) {
1070 $self->_dbic_stmt($table_class, 'load_components', @components);
1073 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1074 if @{$self->resultset_components};
1075 $self->_inject($table_class, @{$self->additional_base_classes});
1078 # Set up metadata (cols, pks, etc)
1079 sub _setup_src_meta {
1080 my ($self, $table) = @_;
1082 my $schema = $self->schema;
1083 my $schema_class = $self->schema_class;
1085 my $table_class = $self->classes->{$table};
1086 my $table_moniker = $self->monikers->{$table};
1088 my $table_name = $table;
1089 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1091 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1092 $table_name = \ $self->_quote_table_name($table_name);
1095 $self->_dbic_stmt($table_class,'table',$table_name);
1097 my $cols = $self->_table_columns($table);
1099 eval { $col_info = $self->_columns_info_for($table) };
1101 $self->_dbic_stmt($table_class,'add_columns',@$cols);
1104 if ($self->_is_case_sensitive) {
1105 for my $col (keys %$col_info) {
1106 $col_info->{$col}{accessor} = lc $col
1107 if $col ne lc($col);
1110 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1113 my $fks = $self->_table_fk_info($table);
1115 for my $fkdef (@$fks) {
1116 for my $col (@{ $fkdef->{local_columns} }) {
1117 $col_info->{$col}{is_foreign_key} = 1;
1123 map { $_, ($col_info->{$_}||{}) } @$cols
1127 my %uniq_tag; # used to eliminate duplicate uniqs
1129 my $pks = $self->_table_pk_info($table) || [];
1130 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1131 : carp("$table has no primary key");
1132 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1134 my $uniqs = $self->_table_uniq_info($table) || [];
1136 my ($name, $cols) = @$_;
1137 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1138 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1145 Returns a sorted list of loaded tables, using the original database table
1153 return keys %{$self->_tables};
1156 # Make a moniker from a table
1157 sub _default_table2moniker {
1158 no warnings 'uninitialized';
1159 my ($self, $table) = @_;
1161 if ($self->naming->{monikers} eq 'v4') {
1162 return join '', map ucfirst, split /[\W_]+/, lc $table;
1165 return join '', map ucfirst, split /[\W_]+/,
1166 Lingua::EN::Inflect::Number::to_S(lc $table);
1169 sub _table2moniker {
1170 my ( $self, $table ) = @_;
1174 if( ref $self->moniker_map eq 'HASH' ) {
1175 $moniker = $self->moniker_map->{$table};
1177 elsif( ref $self->moniker_map eq 'CODE' ) {
1178 $moniker = $self->moniker_map->($table);
1181 $moniker ||= $self->_default_table2moniker($table);
1186 sub _load_relationships {
1187 my ($self, $table) = @_;
1189 my $tbl_fk_info = $self->_table_fk_info($table);
1190 foreach my $fkdef (@$tbl_fk_info) {
1191 $fkdef->{remote_source} =
1192 $self->monikers->{delete $fkdef->{remote_table}};
1194 my $tbl_uniq_info = $self->_table_uniq_info($table);
1196 my $local_moniker = $self->monikers->{$table};
1197 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1199 foreach my $src_class (sort keys %$rel_stmts) {
1200 my $src_stmts = $rel_stmts->{$src_class};
1201 foreach my $stmt (@$src_stmts) {
1202 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1207 # Overload these in driver class:
1209 # Returns an arrayref of column names
1210 sub _table_columns { croak "ABSTRACT METHOD" }
1212 # Returns arrayref of pk col names
1213 sub _table_pk_info { croak "ABSTRACT METHOD" }
1215 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1216 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1218 # Returns an arrayref of foreign key constraints, each
1219 # being a hashref with 3 keys:
1220 # local_columns (arrayref), remote_columns (arrayref), remote_table
1221 sub _table_fk_info { croak "ABSTRACT METHOD" }
1223 # Returns an array of lower case table names
1224 sub _tables_list { croak "ABSTRACT METHOD" }
1226 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1231 if ( $method eq 'table' ) {
1233 $self->_pod( $class, "=head1 NAME" );
1234 my $table_descr = $class;
1235 if ( $self->can('_table_comment') ) {
1236 my $comment = $self->_table_comment($table);
1237 $table_descr .= " - " . $comment if $comment;
1239 $self->{_class2table}{ $class } = $table;
1240 $self->_pod( $class, $table_descr );
1241 $self->_pod_cut( $class );
1242 } elsif ( $method eq 'add_columns' ) {
1243 $self->_pod( $class, "=head1 ACCESSORS" );
1244 my $col_counter = 0;
1246 while( my ($name,$attrs) = splice @cols,0,2 ) {
1248 $self->_pod( $class, '=head2 ' . $name );
1249 $self->_pod( $class,
1251 my $s = $attrs->{$_};
1252 $s = !defined $s ? 'undef' :
1253 length($s) == 0 ? '(empty string)' :
1257 } sort keys %$attrs,
1260 if( $self->can('_column_comment')
1261 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1263 $self->_pod( $class, $comment );
1266 $self->_pod_cut( $class );
1267 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1268 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1269 my ( $accessor, $rel_class ) = @_;
1270 $self->_pod( $class, "=head2 $accessor" );
1271 $self->_pod( $class, 'Type: ' . $method );
1272 $self->_pod( $class, "Related object: L<$rel_class>" );
1273 $self->_pod_cut( $class );
1274 $self->{_relations_started} { $class } = 1;
1276 my $args = dump(@_);
1277 $args = '(' . $args . ')' if @_ < 2;
1278 my $stmt = $method . $args . q{;};
1280 warn qq|$class\->$stmt\n| if $self->debug;
1281 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1285 # Stores a POD documentation
1287 my ($self, $class, $stmt) = @_;
1288 $self->_raw_stmt( $class, "\n" . $stmt );
1292 my ($self, $class ) = @_;
1293 $self->_raw_stmt( $class, "\n=cut\n" );
1297 # Store a raw source line for a class (for dumping purposes)
1299 my ($self, $class, $stmt) = @_;
1300 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1303 # Like above, but separately for the externally loaded stuff
1305 my ($self, $class, $stmt) = @_;
1306 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1309 sub _quote_table_name {
1310 my ($self, $table) = @_;
1312 my $qt = $self->schema->storage->sql_maker->quote_char;
1314 return $table unless $qt;
1317 return $qt->[0] . $table . $qt->[1];
1320 return $qt . $table . $qt;
1323 sub _is_case_sensitive { 0 }
1325 # remove the dump dir from @INC on destruction
1329 @INC = grep $_ ne $self->dump_directory, @INC;
1334 Returns a hashref of loaded table to moniker mappings. There will
1335 be two entries for each table, the original name and the "normalized"
1336 name, in the case that the two are different (such as databases
1337 that like uppercase table names, or preserve your original mixed-case
1338 definitions, or what-have-you).
1342 Returns a hashref of table to class mappings. In some cases it will
1343 contain multiple entries per table for the original and normalized table
1344 names, as above in L</monikers>.
1348 L<DBIx::Class::Schema::Loader>
1352 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1356 This library is free software; you can redistribute it and/or modify it under
1357 the same terms as Perl itself.