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_14';
21 __PACKAGE__->mk_group_ro_accessors('simple', qw/
28 additional_base_classes
42 default_resultset_class
45 overwrite_modifications
59 __PACKAGE__->mk_group_accessors('simple', qw/
61 schema_version_to_dump
63 _upgrading_from_load_classes
64 _downgrading_to_load_classes
65 _rewriting_result_namespace
73 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
77 See L<DBIx::Class::Schema::Loader>
81 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
82 classes, and implements the common functionality between them.
84 =head1 CONSTRUCTOR OPTIONS
86 These constructor options are the base options for
87 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
89 =head2 skip_relationships
91 Skip setting up relationships. The default is to attempt the loading
94 =head2 skip_load_external
96 Skip loading of other classes in @INC. The default is to merge all other classes
97 with the same name found in @INC into the schema file we are creating.
101 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
102 relationship names and singularized Results, unless you're overwriting an
103 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
104 which case the backward compatible RelBuilder will be activated, and
105 singularization will be turned off.
111 will disable the backward-compatible RelBuilder and use
112 the new-style relationship names along with singularized Results, even when
113 overwriting a dump made with an earlier version.
115 The option also takes a hashref:
117 naming => { relationships => 'v5', monikers => 'v4' }
125 How to name relationship accessors.
129 How to name Result classes.
139 Latest default style, whatever that happens to be.
143 Version 0.05XXX style.
147 Version 0.04XXX style.
151 Dynamic schemas will always default to the 0.04XXX relationship names and won't
152 singularize Results for backward compatibility, to activate the new RelBuilder
153 and singularization put this in your C<Schema.pm> file:
155 __PACKAGE__->naming('current');
157 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
158 next major version upgrade:
160 __PACKAGE__->naming('v5');
164 By default POD will be generated for columns and relationships, using database
165 metadata for the text if available and supported.
167 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
168 supported for Postgres right now.
170 Set this to C<0> to turn off all POD generation.
172 =head2 relationship_attrs
174 Hashref of attributes to pass to each generated relationship, listed
175 by type. Also supports relationship type 'all', containing options to
176 pass to all generated relationships. Attributes set for more specific
177 relationship types override those set in 'all'.
181 relationship_attrs => {
182 all => { cascade_delete => 0 },
183 has_many => { cascade_delete => 1 },
186 will set the C<cascade_delete> option to 0 for all generated relationships,
187 except for C<has_many>, which will have cascade_delete as 1.
189 NOTE: this option is not supported if v4 backward-compatible naming is
190 set either globally (naming => 'v4') or just for relationships.
194 If set to true, each constructive L<DBIx::Class> statement the loader
195 decides to execute will be C<warn>-ed before execution.
199 Set the name of the schema to load (schema in the sense that your database
200 vendor means it). Does not currently support loading more than one schema
205 Only load tables matching regex. Best specified as a qr// regex.
209 Exclude tables matching regex. Best specified as a qr// regex.
213 Overrides the default table name to moniker translation. Can be either
214 a hashref of table keys and moniker values, or a coderef for a translator
215 function taking a single scalar table name argument and returning
216 a scalar moniker. If the hash entry does not exist, or the function
217 returns a false value, the code falls back to default behavior
220 The default behavior is to singularize the table name, and: C<join '', map
221 ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
222 split up the table name into chunks anywhere a non-alpha-numeric character
223 occurs, change the case of first letter of each chunk to upper case, and put
224 the chunks back together. Examples:
226 Table Name | Moniker Name
227 ---------------------------
229 luser_group | LuserGroup
230 luser-opts | LuserOpt
232 =head2 inflect_plural
234 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
235 if hash key does not exist or coderef returns false), but acts as a map
236 for pluralizing relationship names. The default behavior is to utilize
237 L<Lingua::EN::Inflect::Number/to_PL>.
239 =head2 inflect_singular
241 As L</inflect_plural> above, but for singularizing relationship names.
242 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
244 =head2 schema_base_class
246 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
248 =head2 result_base_class
250 Base class for your table classes (aka result classes). Defaults to
253 =head2 additional_base_classes
255 List of additional base classes all of your table classes will use.
257 =head2 left_base_classes
259 List of additional base classes all of your table classes will use
260 that need to be leftmost.
262 =head2 additional_classes
264 List of additional classes which all of your table classes will use.
268 List of additional components to be loaded into all of your table
269 classes. A good example would be C<ResultSetManager>.
271 =head2 resultset_components
273 List of additional ResultSet components to be loaded into your table
274 classes. A good example would be C<AlwaysRS>. Component
275 C<ResultSetManager> will be automatically added to the above
276 C<components> list if this option is set.
278 =head2 use_namespaces
280 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
283 Generate result class names suitable for
284 L<DBIx::Class::Schema/load_namespaces> and call that instead of
285 L<DBIx::Class::Schema/load_classes>. When using this option you can also
286 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
287 C<resultset_namespace>, C<default_resultset_class>), and they will be added
288 to the call (and the generated result class names adjusted appropriately).
290 =head2 dump_directory
292 This option is designed to be a tool to help you transition from this
293 loader to a manually-defined schema when you decide it's time to do so.
295 The value of this option is a perl libdir pathname. Within
296 that directory this module will create a baseline manual
297 L<DBIx::Class::Schema> module set, based on what it creates at runtime
300 The created schema class will have the same classname as the one on
301 which you are setting this option (and the ResultSource classes will be
302 based on this name as well).
304 Normally you wouldn't hard-code this setting in your schema class, as it
305 is meant for one-time manual usage.
307 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
308 recommended way to access this functionality.
310 =head2 dump_overwrite
312 Deprecated. See L</really_erase_my_files> below, which does *not* mean
313 the same thing as the old C<dump_overwrite> setting from previous releases.
315 =head2 really_erase_my_files
317 Default false. If true, Loader will unconditionally delete any existing
318 files before creating the new ones from scratch when dumping a schema to disk.
320 The default behavior is instead to only replace the top portion of the
321 file, up to and including the final stanza which contains
322 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
323 leaving any customizations you placed after that as they were.
325 When C<really_erase_my_files> is not set, if the output file already exists,
326 but the aforementioned final stanza is not found, or the checksum
327 contained there does not match the generated contents, Loader will
328 croak and not touch the file.
330 You should really be using version control on your schema classes (and all
331 of the rest of your code for that matter). Don't blame me if a bug in this
332 code wipes something out when it shouldn't have, you've been warned.
334 =head2 overwrite_modifications
336 Default false. If false, when updating existing files, Loader will
337 refuse to modify any Loader-generated code that has been modified
338 since its last run (as determined by the checksum Loader put in its
341 If true, Loader will discard any manual modifications that have been
342 made to Loader-generated code.
344 Again, you should be using version control on your schema classes. Be
345 careful with this option.
349 None of these methods are intended for direct invocation by regular
350 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
351 can also be found via standard L<DBIx::Class::Schema> methods somehow.
355 use constant CURRENT_V => 'v5';
357 # ensure that a peice of object data is a valid arrayref, creating
358 # an empty one or encapsulating whatever's there.
359 sub _ensure_arrayref {
364 $self->{$_} = [ $self->{$_} ]
365 unless ref $self->{$_} eq 'ARRAY';
371 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
372 by L<DBIx::Class::Schema::Loader>.
377 my ( $class, %args ) = @_;
379 my $self = { %args };
381 bless $self => $class;
383 $self->_ensure_arrayref(qw/additional_classes
384 additional_base_classes
390 push(@{$self->{components}}, 'ResultSetManager')
391 if @{$self->{resultset_components}};
393 $self->{monikers} = {};
394 $self->{classes} = {};
395 $self->{_upgrading_classes} = {};
397 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
398 $self->{schema} ||= $self->{schema_class};
400 croak "dump_overwrite is deprecated. Please read the"
401 . " DBIx::Class::Schema::Loader::Base documentation"
402 if $self->{dump_overwrite};
404 $self->{dynamic} = ! $self->{dump_directory};
405 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
410 $self->{dump_directory} ||= $self->{temp_directory};
412 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
413 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
415 if ((not ref $self->naming) && defined $self->naming) {
416 my $naming_ver = $self->naming;
418 relationships => $naming_ver,
419 monikers => $naming_ver,
424 for (values %{ $self->naming }) {
425 $_ = CURRENT_V if $_ eq 'current';
428 $self->{naming} ||= {};
430 $self->_check_back_compat;
432 $self->use_namespaces(1) unless defined $self->use_namespaces;
433 $self->generate_pod(1) unless defined $self->generate_pod;
438 sub _check_back_compat {
441 # dynamic schemas will always be in 0.04006 mode, unless overridden
442 if ($self->dynamic) {
443 # just in case, though no one is likely to dump a dynamic schema
444 $self->schema_version_to_dump('0.04006');
446 if (not %{ $self->naming }) {
447 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
449 Dynamic schema detected, will run in 0.04006 mode.
451 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
452 to disable this warning.
454 Also consider setting 'use_namespaces => 1' if/when upgrading.
456 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
461 $self->_upgrading_from('v4');
464 $self->naming->{relationships} ||= 'v4';
465 $self->naming->{monikers} ||= 'v4';
467 if ($self->use_namespaces) {
468 $self->_upgrading_from_load_classes(1);
471 $self->use_namespaces(0);
477 # otherwise check if we need backcompat mode for a static schema
478 my $filename = $self->_get_dump_filename($self->schema_class);
479 return unless -e $filename;
481 open(my $fh, '<', $filename)
482 or croak "Cannot open '$filename' for reading: $!";
484 my $load_classes = 0;
485 my $result_namespace = '';
488 if (/^__PACKAGE__->load_classes;/) {
490 } elsif (/result_namespace => '([^']+)'/) {
491 $result_namespace = $1;
492 } elsif (my ($real_ver) =
493 /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) {
495 if ($load_classes && (not defined $self->use_namespaces)) {
496 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
498 'load_classes;' static schema detected, turning off 'use_namespaces'.
500 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
501 variable to disable this warning.
503 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
506 $self->use_namespaces(0);
508 elsif ($load_classes && $self->use_namespaces) {
509 $self->_upgrading_from_load_classes(1);
511 elsif ((not $load_classes) && defined $self->use_namespaces
512 && (not $self->use_namespaces)) {
513 $self->_downgrading_to_load_classes(
514 $result_namespace || 'Result'
517 elsif ((not defined $self->use_namespaces)
518 || $self->use_namespaces) {
519 if (not $self->result_namespace) {
520 $self->result_namespace($result_namespace || 'Result');
522 elsif ($result_namespace ne $self->result_namespace) {
523 $self->_rewriting_result_namespace(
524 $result_namespace || 'Result'
529 # XXX when we go past .0 this will need fixing
530 my ($v) = $real_ver =~ /([1-9])/;
533 last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/;
535 if (not %{ $self->naming }) {
536 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
538 Version $real_ver static schema detected, turning on backcompat mode.
540 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
541 to disable this warning.
543 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
548 $self->_upgrading_from($v);
552 $self->naming->{relationships} ||= $v;
553 $self->naming->{monikers} ||= $v;
555 $self->schema_version_to_dump($real_ver);
563 sub _find_file_in_inc {
564 my ($self, $file) = @_;
566 foreach my $prefix (@INC) {
567 my $fullpath = File::Spec->catfile($prefix, $file);
568 return $fullpath if -f $fullpath
569 and Cwd::abs_path($fullpath) ne
570 (Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '');
577 my ($self, $class) = @_;
579 my $class_path = $class;
580 $class_path =~ s{::}{/}g;
581 $class_path .= '.pm';
586 sub _find_class_in_inc {
587 my ($self, $class) = @_;
589 return $self->_find_file_in_inc($self->_class_path($class));
595 return $self->_upgrading_from
596 || $self->_upgrading_from_load_classes
597 || $self->_downgrading_to_load_classes
598 || $self->_rewriting_result_namespace
602 sub _rewrite_old_classnames {
603 my ($self, $code) = @_;
605 return $code unless $self->_rewriting;
607 my %old_classes = reverse %{ $self->_upgrading_classes };
609 my $re = join '|', keys %old_classes;
612 $code =~ s/$re/$old_classes{$1} || $1/eg;
618 my ($self, $class) = @_;
620 return if $self->{skip_load_external};
622 # so that we don't load our own classes, under any circumstances
623 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
625 my $real_inc_path = $self->_find_class_in_inc($class);
627 my $old_class = $self->_upgrading_classes->{$class}
628 if $self->_rewriting;
630 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
631 if $old_class && $old_class ne $class;
633 return unless $real_inc_path || $old_real_inc_path;
635 if ($real_inc_path) {
636 # If we make it to here, we loaded an external definition
637 warn qq/# Loaded external class definition for '$class'\n/
640 open(my $fh, '<', $real_inc_path)
641 or croak "Failed to open '$real_inc_path' for reading: $!";
642 my $code = do { local $/; <$fh> };
644 or croak "Failed to close $real_inc_path: $!";
645 $code = $self->_rewrite_old_classnames($code);
647 if ($self->dynamic) { # load the class too
648 # kill redefined warnings
649 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
650 local $SIG{__WARN__} = sub {
652 unless $_[0] =~ /^Subroutine \S+ redefined/;
658 $self->_ext_stmt($class,
659 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
660 .qq|# They are now part of the custom portion of this file\n|
661 .qq|# for you to hand-edit. If you do not either delete\n|
662 .qq|# this section or remove that file from \@INC, this section\n|
663 .qq|# will be repeated redundantly when you re-create this\n|
664 .qq|# file again via Loader! See skip_load_external to disable\n|
665 .qq|# this feature.\n|
668 $self->_ext_stmt($class, $code);
669 $self->_ext_stmt($class,
670 qq|# End of lines loaded from '$real_inc_path' |
674 if ($old_real_inc_path) {
675 open(my $fh, '<', $old_real_inc_path)
676 or croak "Failed to open '$old_real_inc_path' for reading: $!";
677 $self->_ext_stmt($class, <<"EOF");
679 # These lines were loaded from '$old_real_inc_path',
680 # based on the Result class name that would have been created by an 0.04006
681 # version of the Loader. For a static schema, this happens only once during
682 # upgrade. See skip_load_external to disable this feature.
686 local ($/, @ARGV) = (undef, $old_real_inc_path); <>
688 $code = $self->_rewrite_old_classnames($code);
690 if ($self->dynamic) {
693 Detected external content in '$old_real_inc_path', a class name that would have
694 been used by an 0.04006 version of the Loader.
696 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
697 new name of the Result.
699 # kill redefined warnings
700 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
701 local $SIG{__WARN__} = sub {
703 unless $_[0] =~ /^Subroutine \S+ redefined/;
710 $self->_ext_stmt($class, $code);
711 $self->_ext_stmt($class,
712 qq|# End of lines loaded from '$old_real_inc_path' |
719 Does the actual schema-construction work.
726 $self->_load_tables($self->_tables_list);
733 Rescan the database for newly added tables. Does
734 not process drops or changes. Returns a list of
735 the newly added table monikers.
737 The schema argument should be the schema class
738 or object to be affected. It should probably
739 be derived from the original schema_class used
745 my ($self, $schema) = @_;
747 $self->{schema} = $schema;
748 $self->_relbuilder->{schema} = $schema;
751 my @current = $self->_tables_list;
752 foreach my $table ($self->_tables_list) {
753 if(!exists $self->{_tables}->{$table}) {
754 push(@created, $table);
758 my $loaded = $self->_load_tables(@created);
760 return map { $self->monikers->{$_} } @$loaded;
764 no warnings 'uninitialized';
767 return if $self->{skip_relationships};
769 if ($self->naming->{relationships} eq 'v4') {
770 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
771 return $self->{relbuilder} ||=
772 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
773 $self->schema, $self->inflect_plural, $self->inflect_singular
777 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
779 $self->inflect_plural,
780 $self->inflect_singular,
781 $self->relationship_attrs,
786 my ($self, @tables) = @_;
788 # First, use _tables_list with constraint and exclude
789 # to get a list of tables to operate on
791 my $constraint = $self->constraint;
792 my $exclude = $self->exclude;
794 @tables = grep { /$constraint/ } @tables if $constraint;
795 @tables = grep { ! /$exclude/ } @tables if $exclude;
797 # Save the new tables to the tables list
799 $self->{_tables}->{$_} = 1;
802 $self->_make_src_class($_) for @tables;
803 $self->_setup_src_meta($_) for @tables;
805 if(!$self->skip_relationships) {
806 # The relationship loader needs a working schema
808 local $self->{dump_directory} = $self->{temp_directory};
809 $self->_reload_classes(\@tables);
810 $self->_load_relationships($_) for @tables;
813 # Remove that temp dir from INC so it doesn't get reloaded
814 @INC = grep $_ ne $self->dump_directory, @INC;
817 $self->_load_external($_)
818 for map { $self->classes->{$_} } @tables;
820 # Reload without unloading first to preserve any symbols from external
822 $self->_reload_classes(\@tables, 0);
824 # Drop temporary cache
825 delete $self->{_cache};
830 sub _reload_classes {
831 my ($self, $tables, $unload) = @_;
833 my @tables = @$tables;
834 $unload = 1 unless defined $unload;
836 # so that we don't repeat custom sections
837 @INC = grep $_ ne $self->dump_directory, @INC;
839 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
841 unshift @INC, $self->dump_directory;
844 my %have_source = map { $_ => $self->schema->source($_) }
845 $self->schema->sources;
847 for my $table (@tables) {
848 my $moniker = $self->monikers->{$table};
849 my $class = $self->classes->{$table};
852 no warnings 'redefine';
853 local *Class::C3::reinitialize = sub {};
856 Class::Unload->unload($class) if $unload;
857 my ($source, $resultset_class);
859 ($source = $have_source{$moniker})
860 && ($resultset_class = $source->resultset_class)
861 && ($resultset_class ne 'DBIx::Class::ResultSet')
863 my $has_file = Class::Inspector->loaded_filename($resultset_class);
864 Class::Unload->unload($resultset_class) if $unload;
865 $self->_reload_class($resultset_class) if $has_file;
867 $self->_reload_class($class);
869 push @to_register, [$moniker, $class];
872 Class::C3->reinitialize;
874 $self->schema->register_class(@$_);
878 # We use this instead of ensure_class_loaded when there are package symbols we
881 my ($self, $class) = @_;
883 my $class_path = $self->_class_path($class);
884 delete $INC{ $class_path };
886 # kill redefined warnings
887 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
888 local $SIG{__WARN__} = sub {
890 unless $_[0] =~ /^Subroutine \S+ redefined/;
892 eval "require $class;";
895 sub _get_dump_filename {
896 my ($self, $class) = (@_);
899 return $self->dump_directory . q{/} . $class . q{.pm};
902 sub _ensure_dump_subdirs {
903 my ($self, $class) = (@_);
905 my @name_parts = split(/::/, $class);
906 pop @name_parts; # we don't care about the very last element,
907 # which is a filename
909 my $dir = $self->dump_directory;
912 mkdir($dir) or croak "mkdir('$dir') failed: $!";
914 last if !@name_parts;
915 $dir = File::Spec->catdir($dir, shift @name_parts);
920 my ($self, @classes) = @_;
922 my $schema_class = $self->schema_class;
923 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
925 my $target_dir = $self->dump_directory;
926 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
927 unless $self->{dynamic} or $self->{quiet};
930 qq|package $schema_class;\n\n|
931 . qq|# Created by DBIx::Class::Schema::Loader\n|
932 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
933 . qq|use strict;\nuse warnings;\n\n|
934 . qq|use base '$schema_base_class';\n\n|;
936 if ($self->use_namespaces) {
937 $schema_text .= qq|__PACKAGE__->load_namespaces|;
938 my $namespace_options;
939 for my $attr (qw(result_namespace
941 default_resultset_class)) {
943 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
946 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
947 $schema_text .= qq|;\n|;
950 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
954 local $self->{version_to_dump} = $self->schema_version_to_dump;
955 $self->_write_classfile($schema_class, $schema_text, 1);
958 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
960 foreach my $src_class (@classes) {
962 qq|package $src_class;\n\n|
963 . qq|# Created by DBIx::Class::Schema::Loader\n|
964 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
965 . qq|use strict;\nuse warnings;\n\n|
966 . qq|use base '$result_base_class';\n\n|;
968 $self->_write_classfile($src_class, $src_text);
971 # remove Result dir if downgrading from use_namespaces, and there are no
973 if (my $result_ns = $self->_downgrading_to_load_classes
974 || $self->_rewriting_result_namespace) {
975 my $result_namespace = $self->_result_namespace(
980 (my $result_dir = $result_namespace) =~ s{::}{/}g;
981 $result_dir = $self->dump_directory . '/' . $result_dir;
983 unless (my @files = glob "$result_dir/*") {
988 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
993 my ($self, $version, $ts) = @_;
994 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
997 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1000 sub _write_classfile {
1001 my ($self, $class, $text, $is_schema) = @_;
1003 my $filename = $self->_get_dump_filename($class);
1004 $self->_ensure_dump_subdirs($class);
1006 if (-f $filename && $self->really_erase_my_files) {
1007 warn "Deleting existing file '$filename' due to "
1008 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1012 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
1014 if (my $old_class = $self->_upgrading_classes->{$class}) {
1015 my $old_filename = $self->_get_dump_filename($old_class);
1017 my ($old_custom_content) = $self->_get_custom_content(
1018 $old_class, $old_filename, 0 # do not add default comment
1021 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
1023 if ($old_custom_content) {
1025 "\n" . $old_custom_content . "\n" . $custom_content;
1028 unlink $old_filename;
1031 $custom_content = $self->_rewrite_old_classnames($custom_content);
1034 for @{$self->{_dump_storage}->{$class} || []};
1036 # Check and see if the dump is infact differnt
1040 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1043 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1044 return unless $self->_upgrading_from && $is_schema;
1048 $text .= $self->_sig_comment(
1049 $self->version_to_dump,
1050 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1053 open(my $fh, '>', $filename)
1054 or croak "Cannot open '$filename' for writing: $!";
1056 # Write the top half and its MD5 sum
1057 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1059 # Write out anything loaded via external partial class file in @INC
1061 for @{$self->{_ext_storage}->{$class} || []};
1063 # Write out any custom content the user has added
1064 print $fh $custom_content;
1067 or croak "Error closing '$filename': $!";
1070 sub _default_custom_content {
1071 return qq|\n\n# You can replace this text with custom|
1072 . qq| content, and it will be preserved on regeneration|
1076 sub _get_custom_content {
1077 my ($self, $class, $filename, $add_default) = @_;
1079 $add_default = 1 unless defined $add_default;
1081 return ($self->_default_custom_content) if ! -f $filename;
1083 open(my $fh, '<', $filename)
1084 or croak "Cannot open '$filename' for reading: $!";
1087 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1090 my ($md5, $ts, $ver);
1092 if(!$md5 && /$mark_re/) {
1096 # Pull out the previous version and timestamp
1097 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
1100 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"
1101 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
1110 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1111 . " it does not appear to have been generated by Loader"
1114 # Default custom content:
1115 $buffer ||= $self->_default_custom_content if $add_default;
1117 return ($buffer, $md5, $ver, $ts);
1125 warn "$target: use $_;" if $self->debug;
1126 $self->_raw_stmt($target, "use $_;");
1133 my $schema_class = $self->schema_class;
1135 my $blist = join(q{ }, @_);
1136 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1137 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1140 sub _result_namespace {
1141 my ($self, $schema_class, $ns) = @_;
1142 my @result_namespace;
1144 if ($ns =~ /^\+(.*)/) {
1145 # Fully qualified namespace
1146 @result_namespace = ($1)
1149 # Relative namespace
1150 @result_namespace = ($schema_class, $ns);
1153 return wantarray ? @result_namespace : join '::', @result_namespace;
1156 # Create class with applicable bases, setup monikers, etc
1157 sub _make_src_class {
1158 my ($self, $table) = @_;
1160 my $schema = $self->schema;
1161 my $schema_class = $self->schema_class;
1163 my $table_moniker = $self->_table2moniker($table);
1164 my @result_namespace = ($schema_class);
1165 if ($self->use_namespaces) {
1166 my $result_namespace = $self->result_namespace || 'Result';
1167 @result_namespace = $self->_result_namespace(
1172 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1174 if ((my $upgrading_v = $self->_upgrading_from)
1175 || $self->_rewriting) {
1176 local $self->naming->{monikers} = $upgrading_v
1179 my @result_namespace = @result_namespace;
1180 if ($self->_upgrading_from_load_classes) {
1181 @result_namespace = ($schema_class);
1183 elsif (my $ns = $self->_downgrading_to_load_classes) {
1184 @result_namespace = $self->_result_namespace(
1189 elsif ($ns = $self->_rewriting_result_namespace) {
1190 @result_namespace = $self->_result_namespace(
1196 my $old_class = join(q{::}, @result_namespace,
1197 $self->_table2moniker($table));
1199 $self->_upgrading_classes->{$table_class} = $old_class
1200 unless $table_class eq $old_class;
1203 my $table_normalized = lc $table;
1204 $self->classes->{$table} = $table_class;
1205 $self->classes->{$table_normalized} = $table_class;
1206 $self->monikers->{$table} = $table_moniker;
1207 $self->monikers->{$table_normalized} = $table_moniker;
1209 $self->_use ($table_class, @{$self->additional_classes});
1210 $self->_inject($table_class, @{$self->left_base_classes});
1212 if (my @components = @{ $self->components }) {
1213 $self->_dbic_stmt($table_class, 'load_components', @components);
1216 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1217 if @{$self->resultset_components};
1218 $self->_inject($table_class, @{$self->additional_base_classes});
1221 # Set up metadata (cols, pks, etc)
1222 sub _setup_src_meta {
1223 my ($self, $table) = @_;
1225 my $schema = $self->schema;
1226 my $schema_class = $self->schema_class;
1228 my $table_class = $self->classes->{$table};
1229 my $table_moniker = $self->monikers->{$table};
1231 my $table_name = $table;
1232 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1234 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1235 $table_name = \ $self->_quote_table_name($table_name);
1238 $self->_dbic_stmt($table_class,'table',$table_name);
1240 my $cols = $self->_table_columns($table);
1242 eval { $col_info = $self->_columns_info_for($table) };
1244 $self->_dbic_stmt($table_class,'add_columns',@$cols);
1247 if ($self->_is_case_sensitive) {
1248 for my $col (keys %$col_info) {
1249 $col_info->{$col}{accessor} = lc $col
1250 if $col ne lc($col);
1253 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1256 my $fks = $self->_table_fk_info($table);
1258 for my $fkdef (@$fks) {
1259 for my $col (@{ $fkdef->{local_columns} }) {
1260 $col_info->{$col}{is_foreign_key} = 1;
1266 map { $_, ($col_info->{$_}||{}) } @$cols
1270 my %uniq_tag; # used to eliminate duplicate uniqs
1272 my $pks = $self->_table_pk_info($table) || [];
1273 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1274 : carp("$table has no primary key");
1275 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1277 my $uniqs = $self->_table_uniq_info($table) || [];
1279 my ($name, $cols) = @$_;
1280 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1281 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1288 Returns a sorted list of loaded tables, using the original database table
1296 return keys %{$self->_tables};
1299 # Make a moniker from a table
1300 sub _default_table2moniker {
1301 no warnings 'uninitialized';
1302 my ($self, $table) = @_;
1304 if ($self->naming->{monikers} eq 'v4') {
1305 return join '', map ucfirst, split /[\W_]+/, lc $table;
1308 return join '', map ucfirst, split /[\W_]+/,
1309 Lingua::EN::Inflect::Number::to_S(lc $table);
1312 sub _table2moniker {
1313 my ( $self, $table ) = @_;
1317 if( ref $self->moniker_map eq 'HASH' ) {
1318 $moniker = $self->moniker_map->{$table};
1320 elsif( ref $self->moniker_map eq 'CODE' ) {
1321 $moniker = $self->moniker_map->($table);
1324 $moniker ||= $self->_default_table2moniker($table);
1329 sub _load_relationships {
1330 my ($self, $table) = @_;
1332 my $tbl_fk_info = $self->_table_fk_info($table);
1333 foreach my $fkdef (@$tbl_fk_info) {
1334 $fkdef->{remote_source} =
1335 $self->monikers->{delete $fkdef->{remote_table}};
1337 my $tbl_uniq_info = $self->_table_uniq_info($table);
1339 my $local_moniker = $self->monikers->{$table};
1340 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1342 foreach my $src_class (sort keys %$rel_stmts) {
1343 my $src_stmts = $rel_stmts->{$src_class};
1344 foreach my $stmt (@$src_stmts) {
1345 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1350 # Overload these in driver class:
1352 # Returns an arrayref of column names
1353 sub _table_columns { croak "ABSTRACT METHOD" }
1355 # Returns arrayref of pk col names
1356 sub _table_pk_info { croak "ABSTRACT METHOD" }
1358 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1359 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1361 # Returns an arrayref of foreign key constraints, each
1362 # being a hashref with 3 keys:
1363 # local_columns (arrayref), remote_columns (arrayref), remote_table
1364 sub _table_fk_info { croak "ABSTRACT METHOD" }
1366 # Returns an array of lower case table names
1367 sub _tables_list { croak "ABSTRACT METHOD" }
1369 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1375 # generate the pod for this statement, storing it with $self->_pod
1376 $self->_make_pod( $class, $method, @_ );
1378 my $args = dump(@_);
1379 $args = '(' . $args . ')' if @_ < 2;
1380 my $stmt = $method . $args . q{;};
1382 warn qq|$class\->$stmt\n| if $self->debug;
1383 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1387 # generates the accompanying pod for a DBIC class method statement,
1388 # storing it with $self->_pod
1394 return unless $self->generate_pod;
1396 if ( $method eq 'table' ) {
1398 $self->_pod( $class, "=head1 NAME" );
1399 my $table_descr = $class;
1400 if ( $self->can('_table_comment') ) {
1401 my $comment = $self->_table_comment($table);
1402 $table_descr .= " - " . $comment if $comment;
1404 $self->{_class2table}{ $class } = $table;
1405 $self->_pod( $class, $table_descr );
1406 $self->_pod_cut( $class );
1407 } elsif ( $method eq 'add_columns' ) {
1408 $self->_pod( $class, "=head1 ACCESSORS" );
1409 my $col_counter = 0;
1411 while( my ($name,$attrs) = splice @cols,0,2 ) {
1413 $self->_pod( $class, '=head2 ' . $name );
1414 $self->_pod( $class,
1416 my $s = $attrs->{$_};
1417 $s = !defined $s ? 'undef' :
1418 length($s) == 0 ? '(empty string)' :
1422 } sort keys %$attrs,
1425 if( $self->can('_column_comment')
1426 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1428 $self->_pod( $class, $comment );
1431 $self->_pod_cut( $class );
1432 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1433 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1434 my ( $accessor, $rel_class ) = @_;
1435 $self->_pod( $class, "=head2 $accessor" );
1436 $self->_pod( $class, 'Type: ' . $method );
1437 $self->_pod( $class, "Related object: L<$rel_class>" );
1438 $self->_pod_cut( $class );
1439 $self->{_relations_started} { $class } = 1;
1443 # Stores a POD documentation
1445 my ($self, $class, $stmt) = @_;
1446 $self->_raw_stmt( $class, "\n" . $stmt );
1450 my ($self, $class ) = @_;
1451 $self->_raw_stmt( $class, "\n=cut\n" );
1454 # Store a raw source line for a class (for dumping purposes)
1456 my ($self, $class, $stmt) = @_;
1457 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1460 # Like above, but separately for the externally loaded stuff
1462 my ($self, $class, $stmt) = @_;
1463 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1466 sub _quote_table_name {
1467 my ($self, $table) = @_;
1469 my $qt = $self->schema->storage->sql_maker->quote_char;
1471 return $table unless $qt;
1474 return $qt->[0] . $table . $qt->[1];
1477 return $qt . $table . $qt;
1480 sub _is_case_sensitive { 0 }
1482 # remove the dump dir from @INC on destruction
1486 @INC = grep $_ ne $self->dump_directory, @INC;
1491 Returns a hashref of loaded table to moniker mappings. There will
1492 be two entries for each table, the original name and the "normalized"
1493 name, in the case that the two are different (such as databases
1494 that like uppercase table names, or preserve your original mixed-case
1495 definitions, or what-have-you).
1499 Returns a hashref of table to class mappings. In some cases it will
1500 contain multiple entries per table for the original and normalized table
1501 names, as above in L</monikers>.
1505 L<DBIx::Class::Schema::Loader>
1509 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1513 This library is free software; you can redistribute it and/or modify it under
1514 the same terms as Perl itself.