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//;
17 use Class::Inspector ();
20 our $VERSION = '0.05002';
22 __PACKAGE__->mk_group_ro_accessors('simple', qw/
29 additional_base_classes
44 default_resultset_class
47 overwrite_modifications
61 __PACKAGE__->mk_group_accessors('simple', qw/
63 schema_version_to_dump
65 _upgrading_from_load_classes
66 _downgrading_to_load_classes
67 _rewriting_result_namespace
72 pod_comment_spillover_length
77 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
81 See L<DBIx::Class::Schema::Loader>
85 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
86 classes, and implements the common functionality between them.
88 =head1 CONSTRUCTOR OPTIONS
90 These constructor options are the base options for
91 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
93 =head2 skip_relationships
95 Skip setting up relationships. The default is to attempt the loading
98 =head2 skip_load_external
100 Skip loading of other classes in @INC. The default is to merge all other classes
101 with the same name found in @INC into the schema file we are creating.
105 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
106 relationship names and singularized Results, unless you're overwriting an
107 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
108 which case the backward compatible RelBuilder will be activated, and
109 singularization will be turned off.
115 will disable the backward-compatible RelBuilder and use
116 the new-style relationship names along with singularized Results, even when
117 overwriting a dump made with an earlier version.
119 The option also takes a hashref:
121 naming => { relationships => 'v5', monikers => 'v4' }
129 How to name relationship accessors.
133 How to name Result classes.
143 Latest default style, whatever that happens to be.
147 Version 0.05XXX style.
151 Version 0.04XXX style.
155 Dynamic schemas will always default to the 0.04XXX relationship names and won't
156 singularize Results for backward compatibility, to activate the new RelBuilder
157 and singularization put this in your C<Schema.pm> file:
159 __PACKAGE__->naming('current');
161 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
162 next major version upgrade:
164 __PACKAGE__->naming('v5');
168 By default POD will be generated for columns and relationships, using database
169 metadata for the text if available and supported.
171 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
172 supported for Postgres right now.
174 Set this to C<0> to turn off all POD generation.
176 =head2 pod_comment_mode
178 Controls where table comments appear in the generated POD. Smaller table
179 comments are appended to the C<NAME> section of the documentation, and larger
180 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
181 section to be generated with the comment always, only use C<NAME>, or choose
182 the length threshold at which the comment is forced into the description.
188 Use C<NAME> section only.
192 Force C<DESCRIPTION> always.
196 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
201 =head2 pod_comment_spillover_length
203 When pod_comment_mode is set to C<auto>, this is the length of the comment at
204 which it will be forced into a separate description section.
208 =head2 relationship_attrs
210 Hashref of attributes to pass to each generated relationship, listed
211 by type. Also supports relationship type 'all', containing options to
212 pass to all generated relationships. Attributes set for more specific
213 relationship types override those set in 'all'.
217 relationship_attrs => {
218 all => { cascade_delete => 0 },
219 has_many => { cascade_delete => 1 },
222 will set the C<cascade_delete> option to 0 for all generated relationships,
223 except for C<has_many>, which will have cascade_delete as 1.
225 NOTE: this option is not supported if v4 backward-compatible naming is
226 set either globally (naming => 'v4') or just for relationships.
230 If set to true, each constructive L<DBIx::Class> statement the loader
231 decides to execute will be C<warn>-ed before execution.
235 Set the name of the schema to load (schema in the sense that your database
236 vendor means it). Does not currently support loading more than one schema
241 Only load tables matching regex. Best specified as a qr// regex.
245 Exclude tables matching regex. Best specified as a qr// regex.
249 Overrides the default table name to moniker translation. Can be either
250 a hashref of table keys and moniker values, or a coderef for a translator
251 function taking a single scalar table name argument and returning
252 a scalar moniker. If the hash entry does not exist, or the function
253 returns a false value, the code falls back to default behavior
256 The default behavior is to singularize the table name, and: C<join '', map
257 ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
258 split up the table name into chunks anywhere a non-alpha-numeric character
259 occurs, change the case of first letter of each chunk to upper case, and put
260 the chunks back together. Examples:
262 Table Name | Moniker Name
263 ---------------------------
265 luser_group | LuserGroup
266 luser-opts | LuserOpt
268 =head2 inflect_plural
270 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
271 if hash key does not exist or coderef returns false), but acts as a map
272 for pluralizing relationship names. The default behavior is to utilize
273 L<Lingua::EN::Inflect::Number/to_PL>.
275 =head2 inflect_singular
277 As L</inflect_plural> above, but for singularizing relationship names.
278 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
280 =head2 schema_base_class
282 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
284 =head2 result_base_class
286 Base class for your table classes (aka result classes). Defaults to
289 =head2 additional_base_classes
291 List of additional base classes all of your table classes will use.
293 =head2 left_base_classes
295 List of additional base classes all of your table classes will use
296 that need to be leftmost.
298 =head2 additional_classes
300 List of additional classes which all of your table classes will use.
304 List of additional components to be loaded into all of your table
305 classes. A good example would be C<ResultSetManager>.
307 =head2 resultset_components
309 List of additional ResultSet components to be loaded into your table
310 classes. A good example would be C<AlwaysRS>. Component
311 C<ResultSetManager> will be automatically added to the above
312 C<components> list if this option is set.
314 =head2 use_namespaces
316 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
319 Generate result class names suitable for
320 L<DBIx::Class::Schema/load_namespaces> and call that instead of
321 L<DBIx::Class::Schema/load_classes>. When using this option you can also
322 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
323 C<resultset_namespace>, C<default_resultset_class>), and they will be added
324 to the call (and the generated result class names adjusted appropriately).
326 =head2 dump_directory
328 This option is designed to be a tool to help you transition from this
329 loader to a manually-defined schema when you decide it's time to do so.
331 The value of this option is a perl libdir pathname. Within
332 that directory this module will create a baseline manual
333 L<DBIx::Class::Schema> module set, based on what it creates at runtime
336 The created schema class will have the same classname as the one on
337 which you are setting this option (and the ResultSource classes will be
338 based on this name as well).
340 Normally you wouldn't hard-code this setting in your schema class, as it
341 is meant for one-time manual usage.
343 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
344 recommended way to access this functionality.
346 =head2 dump_overwrite
348 Deprecated. See L</really_erase_my_files> below, which does *not* mean
349 the same thing as the old C<dump_overwrite> setting from previous releases.
351 =head2 really_erase_my_files
353 Default false. If true, Loader will unconditionally delete any existing
354 files before creating the new ones from scratch when dumping a schema to disk.
356 The default behavior is instead to only replace the top portion of the
357 file, up to and including the final stanza which contains
358 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
359 leaving any customizations you placed after that as they were.
361 When C<really_erase_my_files> is not set, if the output file already exists,
362 but the aforementioned final stanza is not found, or the checksum
363 contained there does not match the generated contents, Loader will
364 croak and not touch the file.
366 You should really be using version control on your schema classes (and all
367 of the rest of your code for that matter). Don't blame me if a bug in this
368 code wipes something out when it shouldn't have, you've been warned.
370 =head2 overwrite_modifications
372 Default false. If false, when updating existing files, Loader will
373 refuse to modify any Loader-generated code that has been modified
374 since its last run (as determined by the checksum Loader put in its
377 If true, Loader will discard any manual modifications that have been
378 made to Loader-generated code.
380 Again, you should be using version control on your schema classes. Be
381 careful with this option.
385 None of these methods are intended for direct invocation by regular
386 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
387 can also be found via standard L<DBIx::Class::Schema> methods somehow.
391 use constant CURRENT_V => 'v5';
393 use constant CLASS_ARGS => qw(
394 schema_base_class result_base_class additional_base_classes
395 left_base_classes additional_classes components resultset_components
398 # ensure that a peice of object data is a valid arrayref, creating
399 # an empty one or encapsulating whatever's there.
400 sub _ensure_arrayref {
405 $self->{$_} = [ $self->{$_} ]
406 unless ref $self->{$_} eq 'ARRAY';
412 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
413 by L<DBIx::Class::Schema::Loader>.
418 my ( $class, %args ) = @_;
420 my $self = { %args };
422 bless $self => $class;
424 $self->_ensure_arrayref(qw/additional_classes
425 additional_base_classes
431 $self->_validate_class_args;
433 push(@{$self->{components}}, 'ResultSetManager')
434 if @{$self->{resultset_components}};
436 $self->{monikers} = {};
437 $self->{classes} = {};
438 $self->{_upgrading_classes} = {};
440 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
441 $self->{schema} ||= $self->{schema_class};
443 croak "dump_overwrite is deprecated. Please read the"
444 . " DBIx::Class::Schema::Loader::Base documentation"
445 if $self->{dump_overwrite};
447 $self->{dynamic} = ! $self->{dump_directory};
448 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
453 $self->{dump_directory} ||= $self->{temp_directory};
455 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
456 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
458 if ((not ref $self->naming) && defined $self->naming) {
459 my $naming_ver = $self->naming;
461 relationships => $naming_ver,
462 monikers => $naming_ver,
467 for (values %{ $self->naming }) {
468 $_ = CURRENT_V if $_ eq 'current';
471 $self->{naming} ||= {};
473 $self->_check_back_compat;
475 $self->use_namespaces(1) unless defined $self->use_namespaces;
476 $self->generate_pod(1) unless defined $self->generate_pod;
477 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
478 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
483 sub _check_back_compat {
486 # dynamic schemas will always be in 0.04006 mode, unless overridden
487 if ($self->dynamic) {
488 # just in case, though no one is likely to dump a dynamic schema
489 $self->schema_version_to_dump('0.04006');
491 if (not %{ $self->naming }) {
492 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
494 Dynamic schema detected, will run in 0.04006 mode.
496 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
497 to disable this warning.
499 Also consider setting 'use_namespaces => 1' if/when upgrading.
501 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
506 $self->_upgrading_from('v4');
509 $self->naming->{relationships} ||= 'v4';
510 $self->naming->{monikers} ||= 'v4';
512 if ($self->use_namespaces) {
513 $self->_upgrading_from_load_classes(1);
516 $self->use_namespaces(0);
522 # otherwise check if we need backcompat mode for a static schema
523 my $filename = $self->_get_dump_filename($self->schema_class);
524 return unless -e $filename;
526 open(my $fh, '<', $filename)
527 or croak "Cannot open '$filename' for reading: $!";
529 my $load_classes = 0;
530 my $result_namespace = '';
533 if (/^__PACKAGE__->load_classes;/) {
535 } elsif (/result_namespace => '([^']+)'/) {
536 $result_namespace = $1;
537 } elsif (my ($real_ver) =
538 /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) {
540 if ($load_classes && (not defined $self->use_namespaces)) {
541 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
543 'load_classes;' static schema detected, turning off 'use_namespaces'.
545 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
546 variable to disable this warning.
548 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
551 $self->use_namespaces(0);
553 elsif ($load_classes && $self->use_namespaces) {
554 $self->_upgrading_from_load_classes(1);
556 elsif ((not $load_classes) && defined $self->use_namespaces
557 && (not $self->use_namespaces)) {
558 $self->_downgrading_to_load_classes(
559 $result_namespace || 'Result'
562 elsif ((not defined $self->use_namespaces)
563 || $self->use_namespaces) {
564 if (not $self->result_namespace) {
565 $self->result_namespace($result_namespace || 'Result');
567 elsif ($result_namespace ne $self->result_namespace) {
568 $self->_rewriting_result_namespace(
569 $result_namespace || 'Result'
574 # XXX when we go past .0 this will need fixing
575 my ($v) = $real_ver =~ /([1-9])/;
578 last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/;
580 if (not %{ $self->naming }) {
581 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
583 Version $real_ver static schema detected, turning on backcompat mode.
585 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
586 to disable this warning.
588 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
593 $self->_upgrading_from($v);
597 $self->naming->{relationships} ||= $v;
598 $self->naming->{monikers} ||= $v;
600 $self->schema_version_to_dump($real_ver);
608 sub _validate_class_args {
612 foreach my $k (CLASS_ARGS) {
613 next unless $self->$k;
615 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
616 foreach my $c (@classes) {
617 # components default to being under the DBIx::Class namespace unless they
618 # are preceeded with a '+'
619 if ( $k =~ m/components$/ && $c !~ s/^\+// ) {
620 $c = 'DBIx::Class::' . $c;
623 # 1 == installed, 0 == not installed, undef == invalid classname
624 my $installed = Class::Inspector->installed($c);
625 if ( defined($installed) ) {
626 if ( $installed == 0 ) {
627 croak qq/$c, as specified in the loader option "$k", is not installed/;
630 croak qq/$c, as specified in the loader option "$k", is an invalid class name/;
636 sub _find_file_in_inc {
637 my ($self, $file) = @_;
639 foreach my $prefix (@INC) {
640 my $fullpath = File::Spec->catfile($prefix, $file);
641 return $fullpath if -f $fullpath
642 # abs_path throws on Windows for nonexistant files
643 and eval { Cwd::abs_path($fullpath) } ne
644 (eval { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) } || '');
651 my ($self, $class) = @_;
653 my $class_path = $class;
654 $class_path =~ s{::}{/}g;
655 $class_path .= '.pm';
660 sub _find_class_in_inc {
661 my ($self, $class) = @_;
663 return $self->_find_file_in_inc($self->_class_path($class));
669 return $self->_upgrading_from
670 || $self->_upgrading_from_load_classes
671 || $self->_downgrading_to_load_classes
672 || $self->_rewriting_result_namespace
676 sub _rewrite_old_classnames {
677 my ($self, $code) = @_;
679 return $code unless $self->_rewriting;
681 my %old_classes = reverse %{ $self->_upgrading_classes };
683 my $re = join '|', keys %old_classes;
686 $code =~ s/$re/$old_classes{$1} || $1/eg;
692 my ($self, $class) = @_;
694 return if $self->{skip_load_external};
696 # so that we don't load our own classes, under any circumstances
697 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
699 my $real_inc_path = $self->_find_class_in_inc($class);
701 my $old_class = $self->_upgrading_classes->{$class}
702 if $self->_rewriting;
704 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
705 if $old_class && $old_class ne $class;
707 return unless $real_inc_path || $old_real_inc_path;
709 if ($real_inc_path) {
710 # If we make it to here, we loaded an external definition
711 warn qq/# Loaded external class definition for '$class'\n/
714 open(my $fh, '<', $real_inc_path)
715 or croak "Failed to open '$real_inc_path' for reading: $!";
716 my $code = do { local $/; <$fh> };
718 or croak "Failed to close $real_inc_path: $!";
719 $code = $self->_rewrite_old_classnames($code);
721 if ($self->dynamic) { # load the class too
722 # kill redefined warnings
723 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
724 local $SIG{__WARN__} = sub {
726 unless $_[0] =~ /^Subroutine \S+ redefined/;
732 $self->_ext_stmt($class,
733 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
734 .qq|# They are now part of the custom portion of this file\n|
735 .qq|# for you to hand-edit. If you do not either delete\n|
736 .qq|# this section or remove that file from \@INC, this section\n|
737 .qq|# will be repeated redundantly when you re-create this\n|
738 .qq|# file again via Loader! See skip_load_external to disable\n|
739 .qq|# this feature.\n|
742 $self->_ext_stmt($class, $code);
743 $self->_ext_stmt($class,
744 qq|# End of lines loaded from '$real_inc_path' |
748 if ($old_real_inc_path) {
749 open(my $fh, '<', $old_real_inc_path)
750 or croak "Failed to open '$old_real_inc_path' for reading: $!";
751 $self->_ext_stmt($class, <<"EOF");
753 # These lines were loaded from '$old_real_inc_path',
754 # based on the Result class name that would have been created by an 0.04006
755 # version of the Loader. For a static schema, this happens only once during
756 # upgrade. See skip_load_external to disable this feature.
760 local ($/, @ARGV) = (undef, $old_real_inc_path); <>
762 $code = $self->_rewrite_old_classnames($code);
764 if ($self->dynamic) {
767 Detected external content in '$old_real_inc_path', a class name that would have
768 been used by an 0.04006 version of the Loader.
770 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
771 new name of the Result.
773 # kill redefined warnings
774 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
775 local $SIG{__WARN__} = sub {
777 unless $_[0] =~ /^Subroutine \S+ redefined/;
784 $self->_ext_stmt($class, $code);
785 $self->_ext_stmt($class,
786 qq|# End of lines loaded from '$old_real_inc_path' |
793 Does the actual schema-construction work.
800 $self->_load_tables($self->_tables_list);
807 Rescan the database for newly added tables. Does
808 not process drops or changes. Returns a list of
809 the newly added table monikers.
811 The schema argument should be the schema class
812 or object to be affected. It should probably
813 be derived from the original schema_class used
819 my ($self, $schema) = @_;
821 $self->{schema} = $schema;
822 $self->_relbuilder->{schema} = $schema;
825 my @current = $self->_tables_list;
826 foreach my $table ($self->_tables_list) {
827 if(!exists $self->{_tables}->{$table}) {
828 push(@created, $table);
832 my $loaded = $self->_load_tables(@created);
834 return map { $self->monikers->{$_} } @$loaded;
838 no warnings 'uninitialized';
841 return if $self->{skip_relationships};
843 if ($self->naming->{relationships} eq 'v4') {
844 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
845 return $self->{relbuilder} ||=
846 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
847 $self->schema, $self->inflect_plural, $self->inflect_singular
851 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
853 $self->inflect_plural,
854 $self->inflect_singular,
855 $self->relationship_attrs,
860 my ($self, @tables) = @_;
862 # First, use _tables_list with constraint and exclude
863 # to get a list of tables to operate on
865 my $constraint = $self->constraint;
866 my $exclude = $self->exclude;
868 @tables = grep { /$constraint/ } @tables if $constraint;
869 @tables = grep { ! /$exclude/ } @tables if $exclude;
871 # Save the new tables to the tables list
873 $self->{_tables}->{$_} = 1;
876 $self->_make_src_class($_) for @tables;
877 $self->_setup_src_meta($_) for @tables;
879 if(!$self->skip_relationships) {
880 # The relationship loader needs a working schema
882 local $self->{dump_directory} = $self->{temp_directory};
883 $self->_reload_classes(\@tables);
884 $self->_load_relationships($_) for @tables;
887 # Remove that temp dir from INC so it doesn't get reloaded
888 @INC = grep $_ ne $self->dump_directory, @INC;
891 $self->_load_external($_)
892 for map { $self->classes->{$_} } @tables;
894 # Reload without unloading first to preserve any symbols from external
896 $self->_reload_classes(\@tables, 0);
898 # Drop temporary cache
899 delete $self->{_cache};
904 sub _reload_classes {
905 my ($self, $tables, $unload) = @_;
907 my @tables = @$tables;
908 $unload = 1 unless defined $unload;
910 # so that we don't repeat custom sections
911 @INC = grep $_ ne $self->dump_directory, @INC;
913 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
915 unshift @INC, $self->dump_directory;
918 my %have_source = map { $_ => $self->schema->source($_) }
919 $self->schema->sources;
921 for my $table (@tables) {
922 my $moniker = $self->monikers->{$table};
923 my $class = $self->classes->{$table};
926 no warnings 'redefine';
927 local *Class::C3::reinitialize = sub {};
930 Class::Unload->unload($class) if $unload;
931 my ($source, $resultset_class);
933 ($source = $have_source{$moniker})
934 && ($resultset_class = $source->resultset_class)
935 && ($resultset_class ne 'DBIx::Class::ResultSet')
937 my $has_file = Class::Inspector->loaded_filename($resultset_class);
938 Class::Unload->unload($resultset_class) if $unload;
939 $self->_reload_class($resultset_class) if $has_file;
941 $self->_reload_class($class);
943 push @to_register, [$moniker, $class];
946 Class::C3->reinitialize;
948 $self->schema->register_class(@$_);
952 # We use this instead of ensure_class_loaded when there are package symbols we
955 my ($self, $class) = @_;
957 my $class_path = $self->_class_path($class);
958 delete $INC{ $class_path };
960 # kill redefined warnings
961 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
962 local $SIG{__WARN__} = sub {
964 unless $_[0] =~ /^Subroutine \S+ redefined/;
966 eval "require $class;";
969 sub _get_dump_filename {
970 my ($self, $class) = (@_);
973 return $self->dump_directory . q{/} . $class . q{.pm};
976 sub _ensure_dump_subdirs {
977 my ($self, $class) = (@_);
979 my @name_parts = split(/::/, $class);
980 pop @name_parts; # we don't care about the very last element,
981 # which is a filename
983 my $dir = $self->dump_directory;
986 mkdir($dir) or croak "mkdir('$dir') failed: $!";
988 last if !@name_parts;
989 $dir = File::Spec->catdir($dir, shift @name_parts);
994 my ($self, @classes) = @_;
996 my $schema_class = $self->schema_class;
997 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
999 my $target_dir = $self->dump_directory;
1000 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1001 unless $self->{dynamic} or $self->{quiet};
1004 qq|package $schema_class;\n\n|
1005 . qq|# Created by DBIx::Class::Schema::Loader\n|
1006 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1007 . qq|use strict;\nuse warnings;\n\n|
1008 . qq|use base '$schema_base_class';\n\n|;
1010 if ($self->use_namespaces) {
1011 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1012 my $namespace_options;
1013 for my $attr (qw(result_namespace
1015 default_resultset_class)) {
1017 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1020 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1021 $schema_text .= qq|;\n|;
1024 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1028 local $self->{version_to_dump} = $self->schema_version_to_dump;
1029 $self->_write_classfile($schema_class, $schema_text, 1);
1032 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1034 foreach my $src_class (@classes) {
1036 qq|package $src_class;\n\n|
1037 . qq|# Created by DBIx::Class::Schema::Loader\n|
1038 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1039 . qq|use strict;\nuse warnings;\n\n|
1040 . qq|use base '$result_base_class';\n\n|;
1042 $self->_write_classfile($src_class, $src_text);
1045 # remove Result dir if downgrading from use_namespaces, and there are no
1047 if (my $result_ns = $self->_downgrading_to_load_classes
1048 || $self->_rewriting_result_namespace) {
1049 my $result_namespace = $self->_result_namespace(
1054 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1055 $result_dir = $self->dump_directory . '/' . $result_dir;
1057 unless (my @files = glob "$result_dir/*") {
1062 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1067 my ($self, $version, $ts) = @_;
1068 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1071 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1074 sub _write_classfile {
1075 my ($self, $class, $text, $is_schema) = @_;
1077 my $filename = $self->_get_dump_filename($class);
1078 $self->_ensure_dump_subdirs($class);
1080 if (-f $filename && $self->really_erase_my_files) {
1081 warn "Deleting existing file '$filename' due to "
1082 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1086 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
1088 if (my $old_class = $self->_upgrading_classes->{$class}) {
1089 my $old_filename = $self->_get_dump_filename($old_class);
1091 my ($old_custom_content) = $self->_get_custom_content(
1092 $old_class, $old_filename, 0 # do not add default comment
1095 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
1097 if ($old_custom_content) {
1099 "\n" . $old_custom_content . "\n" . $custom_content;
1102 unlink $old_filename;
1105 $custom_content = $self->_rewrite_old_classnames($custom_content);
1108 for @{$self->{_dump_storage}->{$class} || []};
1110 # Check and see if the dump is infact differnt
1114 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1117 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1118 return unless $self->_upgrading_from && $is_schema;
1122 $text .= $self->_sig_comment(
1123 $self->version_to_dump,
1124 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1127 open(my $fh, '>', $filename)
1128 or croak "Cannot open '$filename' for writing: $!";
1130 # Write the top half and its MD5 sum
1131 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1133 # Write out anything loaded via external partial class file in @INC
1135 for @{$self->{_ext_storage}->{$class} || []};
1137 # Write out any custom content the user has added
1138 print $fh $custom_content;
1141 or croak "Error closing '$filename': $!";
1144 sub _default_custom_content {
1145 return qq|\n\n# You can replace this text with custom|
1146 . qq| content, and it will be preserved on regeneration|
1150 sub _get_custom_content {
1151 my ($self, $class, $filename, $add_default) = @_;
1153 $add_default = 1 unless defined $add_default;
1155 return ($self->_default_custom_content) if ! -f $filename;
1157 open(my $fh, '<', $filename)
1158 or croak "Cannot open '$filename' for reading: $!";
1161 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1164 my ($md5, $ts, $ver);
1166 if(!$md5 && /$mark_re/) {
1170 # Pull out the previous version and timestamp
1171 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
1174 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"
1175 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
1184 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1185 . " it does not appear to have been generated by Loader"
1188 # Default custom content:
1189 $buffer ||= $self->_default_custom_content if $add_default;
1191 return ($buffer, $md5, $ver, $ts);
1199 warn "$target: use $_;" if $self->debug;
1200 $self->_raw_stmt($target, "use $_;");
1207 my $schema_class = $self->schema_class;
1209 my $blist = join(q{ }, @_);
1210 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1211 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1214 sub _result_namespace {
1215 my ($self, $schema_class, $ns) = @_;
1216 my @result_namespace;
1218 if ($ns =~ /^\+(.*)/) {
1219 # Fully qualified namespace
1220 @result_namespace = ($1)
1223 # Relative namespace
1224 @result_namespace = ($schema_class, $ns);
1227 return wantarray ? @result_namespace : join '::', @result_namespace;
1230 # Create class with applicable bases, setup monikers, etc
1231 sub _make_src_class {
1232 my ($self, $table) = @_;
1234 my $schema = $self->schema;
1235 my $schema_class = $self->schema_class;
1237 my $table_moniker = $self->_table2moniker($table);
1238 my @result_namespace = ($schema_class);
1239 if ($self->use_namespaces) {
1240 my $result_namespace = $self->result_namespace || 'Result';
1241 @result_namespace = $self->_result_namespace(
1246 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1248 if ((my $upgrading_v = $self->_upgrading_from)
1249 || $self->_rewriting) {
1250 local $self->naming->{monikers} = $upgrading_v
1253 my @result_namespace = @result_namespace;
1254 if ($self->_upgrading_from_load_classes) {
1255 @result_namespace = ($schema_class);
1257 elsif (my $ns = $self->_downgrading_to_load_classes) {
1258 @result_namespace = $self->_result_namespace(
1263 elsif ($ns = $self->_rewriting_result_namespace) {
1264 @result_namespace = $self->_result_namespace(
1270 my $old_class = join(q{::}, @result_namespace,
1271 $self->_table2moniker($table));
1273 $self->_upgrading_classes->{$table_class} = $old_class
1274 unless $table_class eq $old_class;
1277 my $table_normalized = lc $table;
1278 $self->classes->{$table} = $table_class;
1279 $self->classes->{$table_normalized} = $table_class;
1280 $self->monikers->{$table} = $table_moniker;
1281 $self->monikers->{$table_normalized} = $table_moniker;
1283 $self->_use ($table_class, @{$self->additional_classes});
1284 $self->_inject($table_class, @{$self->left_base_classes});
1286 if (my @components = @{ $self->components }) {
1287 $self->_dbic_stmt($table_class, 'load_components', @components);
1290 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1291 if @{$self->resultset_components};
1292 $self->_inject($table_class, @{$self->additional_base_classes});
1295 # Set up metadata (cols, pks, etc)
1296 sub _setup_src_meta {
1297 my ($self, $table) = @_;
1299 my $schema = $self->schema;
1300 my $schema_class = $self->schema_class;
1302 my $table_class = $self->classes->{$table};
1303 my $table_moniker = $self->monikers->{$table};
1305 my $table_name = $table;
1306 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1308 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1309 $table_name = \ $self->_quote_table_name($table_name);
1312 $self->_dbic_stmt($table_class,'table',$table_name);
1314 my $cols = $self->_table_columns($table);
1316 eval { $col_info = $self->_columns_info_for($table) };
1318 $self->_dbic_stmt($table_class,'add_columns',@$cols);
1321 if ($self->_is_case_sensitive) {
1322 for my $col (keys %$col_info) {
1323 $col_info->{$col}{accessor} = lc $col
1324 if $col ne lc($col);
1327 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1330 my $fks = $self->_table_fk_info($table);
1332 for my $fkdef (@$fks) {
1333 for my $col (@{ $fkdef->{local_columns} }) {
1334 $col_info->{$col}{is_foreign_key} = 1;
1340 map { $_, ($col_info->{$_}||{}) } @$cols
1344 my %uniq_tag; # used to eliminate duplicate uniqs
1346 my $pks = $self->_table_pk_info($table) || [];
1347 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1348 : carp("$table has no primary key");
1349 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1351 my $uniqs = $self->_table_uniq_info($table) || [];
1353 my ($name, $cols) = @$_;
1354 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1355 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1362 Returns a sorted list of loaded tables, using the original database table
1370 return keys %{$self->_tables};
1373 # Make a moniker from a table
1374 sub _default_table2moniker {
1375 no warnings 'uninitialized';
1376 my ($self, $table) = @_;
1378 if ($self->naming->{monikers} eq 'v4') {
1379 return join '', map ucfirst, split /[\W_]+/, lc $table;
1382 return join '', map ucfirst, split /[\W_]+/,
1383 Lingua::EN::Inflect::Number::to_S(lc $table);
1386 sub _table2moniker {
1387 my ( $self, $table ) = @_;
1391 if( ref $self->moniker_map eq 'HASH' ) {
1392 $moniker = $self->moniker_map->{$table};
1394 elsif( ref $self->moniker_map eq 'CODE' ) {
1395 $moniker = $self->moniker_map->($table);
1398 $moniker ||= $self->_default_table2moniker($table);
1403 sub _load_relationships {
1404 my ($self, $table) = @_;
1406 my $tbl_fk_info = $self->_table_fk_info($table);
1407 foreach my $fkdef (@$tbl_fk_info) {
1408 $fkdef->{remote_source} =
1409 $self->monikers->{delete $fkdef->{remote_table}};
1411 my $tbl_uniq_info = $self->_table_uniq_info($table);
1413 my $local_moniker = $self->monikers->{$table};
1414 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1416 foreach my $src_class (sort keys %$rel_stmts) {
1417 my $src_stmts = $rel_stmts->{$src_class};
1418 foreach my $stmt (@$src_stmts) {
1419 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1424 # Overload these in driver class:
1426 # Returns an arrayref of column names
1427 sub _table_columns { croak "ABSTRACT METHOD" }
1429 # Returns arrayref of pk col names
1430 sub _table_pk_info { croak "ABSTRACT METHOD" }
1432 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1433 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1435 # Returns an arrayref of foreign key constraints, each
1436 # being a hashref with 3 keys:
1437 # local_columns (arrayref), remote_columns (arrayref), remote_table
1438 sub _table_fk_info { croak "ABSTRACT METHOD" }
1440 # Returns an array of lower case table names
1441 sub _tables_list { croak "ABSTRACT METHOD" }
1443 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1449 # generate the pod for this statement, storing it with $self->_pod
1450 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
1452 my $args = dump(@_);
1453 $args = '(' . $args . ')' if @_ < 2;
1454 my $stmt = $method . $args . q{;};
1456 warn qq|$class\->$stmt\n| if $self->debug;
1457 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1461 # generates the accompanying pod for a DBIC class method statement,
1462 # storing it with $self->_pod
1468 if ( $method eq 'table' ) {
1470 my $pcm = $self->pod_comment_mode;
1471 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
1472 if ( $self->can('_table_comment') ) {
1473 $comment = $self->_table_comment($table);
1474 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
1475 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
1476 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
1478 $self->_pod( $class, "=head1 NAME" );
1479 my $table_descr = $class;
1480 $table_descr .= " - " . $comment if $comment and $comment_in_name;
1481 $self->{_class2table}{ $class } = $table;
1482 $self->_pod( $class, $table_descr );
1483 if ($comment and $comment_in_desc) {
1484 $self->_pod( $class, "=head1 DESCRIPTION" );
1485 $self->_pod( $class, $comment );
1487 $self->_pod_cut( $class );
1488 } elsif ( $method eq 'add_columns' ) {
1489 $self->_pod( $class, "=head1 ACCESSORS" );
1490 my $col_counter = 0;
1492 while( my ($name,$attrs) = splice @cols,0,2 ) {
1494 $self->_pod( $class, '=head2 ' . $name );
1495 $self->_pod( $class,
1497 my $s = $attrs->{$_};
1498 $s = !defined $s ? 'undef' :
1499 length($s) == 0 ? '(empty string)' :
1503 } sort keys %$attrs,
1506 if( $self->can('_column_comment')
1507 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1509 $self->_pod( $class, $comment );
1512 $self->_pod_cut( $class );
1513 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1514 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1515 my ( $accessor, $rel_class ) = @_;
1516 $self->_pod( $class, "=head2 $accessor" );
1517 $self->_pod( $class, 'Type: ' . $method );
1518 $self->_pod( $class, "Related object: L<$rel_class>" );
1519 $self->_pod_cut( $class );
1520 $self->{_relations_started} { $class } = 1;
1524 # Stores a POD documentation
1526 my ($self, $class, $stmt) = @_;
1527 $self->_raw_stmt( $class, "\n" . $stmt );
1531 my ($self, $class ) = @_;
1532 $self->_raw_stmt( $class, "\n=cut\n" );
1535 # Store a raw source line for a class (for dumping purposes)
1537 my ($self, $class, $stmt) = @_;
1538 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1541 # Like above, but separately for the externally loaded stuff
1543 my ($self, $class, $stmt) = @_;
1544 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1547 sub _quote_table_name {
1548 my ($self, $table) = @_;
1550 my $qt = $self->schema->storage->sql_maker->quote_char;
1552 return $table unless $qt;
1555 return $qt->[0] . $table . $qt->[1];
1558 return $qt . $table . $qt;
1561 sub _is_case_sensitive { 0 }
1563 sub _custom_column_info {
1564 my ( $self, $info ) = @_;
1566 if( ref $self->custom_column_info eq 'HASH' ) {
1568 } elsif( ref $self->custom_column_info eq 'CODE' ) {
1569 return $self->custom_column_info->($info);
1573 # remove the dump dir from @INC on destruction
1577 @INC = grep $_ ne $self->dump_directory, @INC;
1582 Returns a hashref of loaded table to moniker mappings. There will
1583 be two entries for each table, the original name and the "normalized"
1584 name, in the case that the two are different (such as databases
1585 that like uppercase table names, or preserve your original mixed-case
1586 definitions, or what-have-you).
1590 Returns a hashref of table to class mappings. In some cases it will
1591 contain multiple entries per table for the original and normalized table
1592 names, as above in L</monikers>.
1596 L<DBIx::Class::Schema::Loader>
1600 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1604 This library is free software; you can redistribute it and/or modify it under
1605 the same terms as Perl itself.