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.05003';
22 __PACKAGE__->mk_group_ro_accessors('simple', qw/
29 additional_base_classes
44 default_resultset_class
47 overwrite_modifications
63 __PACKAGE__->mk_group_accessors('simple', qw/
65 schema_version_to_dump
67 _upgrading_from_load_classes
68 _downgrading_to_load_classes
69 _rewriting_result_namespace
74 pod_comment_spillover_length
79 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
83 See L<DBIx::Class::Schema::Loader>
87 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
88 classes, and implements the common functionality between them.
90 =head1 CONSTRUCTOR OPTIONS
92 These constructor options are the base options for
93 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
95 =head2 skip_relationships
97 Skip setting up relationships. The default is to attempt the loading
100 =head2 skip_load_external
102 Skip loading of other classes in @INC. The default is to merge all other classes
103 with the same name found in @INC into the schema file we are creating.
107 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
108 relationship names and singularized Results, unless you're overwriting an
109 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
110 which case the backward compatible RelBuilder will be activated, and
111 singularization will be turned off.
117 will disable the backward-compatible RelBuilder and use
118 the new-style relationship names along with singularized Results, even when
119 overwriting a dump made with an earlier version.
121 The option also takes a hashref:
123 naming => { relationships => 'v5', monikers => 'v4' }
131 How to name relationship accessors.
135 How to name Result classes.
145 Latest default style, whatever that happens to be.
149 Version 0.05XXX style.
153 Version 0.04XXX style.
157 Dynamic schemas will always default to the 0.04XXX relationship names and won't
158 singularize Results for backward compatibility, to activate the new RelBuilder
159 and singularization put this in your C<Schema.pm> file:
161 __PACKAGE__->naming('current');
163 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
164 next major version upgrade:
166 __PACKAGE__->naming('v5');
170 By default POD will be generated for columns and relationships, using database
171 metadata for the text if available and supported.
173 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
174 supported for Postgres right now.
176 Set this to C<0> to turn off all POD generation.
178 =head2 pod_comment_mode
180 Controls where table comments appear in the generated POD. Smaller table
181 comments are appended to the C<NAME> section of the documentation, and larger
182 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
183 section to be generated with the comment always, only use C<NAME>, or choose
184 the length threshold at which the comment is forced into the description.
190 Use C<NAME> section only.
194 Force C<DESCRIPTION> always.
198 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
203 =head2 pod_comment_spillover_length
205 When pod_comment_mode is set to C<auto>, this is the length of the comment at
206 which it will be forced into a separate description section.
210 =head2 relationship_attrs
212 Hashref of attributes to pass to each generated relationship, listed
213 by type. Also supports relationship type 'all', containing options to
214 pass to all generated relationships. Attributes set for more specific
215 relationship types override those set in 'all'.
219 relationship_attrs => {
220 all => { cascade_delete => 0 },
221 has_many => { cascade_delete => 1 },
224 will set the C<cascade_delete> option to 0 for all generated relationships,
225 except for C<has_many>, which will have cascade_delete as 1.
227 NOTE: this option is not supported if v4 backward-compatible naming is
228 set either globally (naming => 'v4') or just for relationships.
232 If set to true, each constructive L<DBIx::Class> statement the loader
233 decides to execute will be C<warn>-ed before execution.
237 Set the name of the schema to load (schema in the sense that your database
238 vendor means it). Does not currently support loading more than one schema
243 Only load tables matching regex. Best specified as a qr// regex.
247 Exclude tables matching regex. Best specified as a qr// regex.
251 Overrides the default table name to moniker translation. Can be either
252 a hashref of table keys and moniker values, or a coderef for a translator
253 function taking a single scalar table name argument and returning
254 a scalar moniker. If the hash entry does not exist, or the function
255 returns a false value, the code falls back to default behavior
258 The default behavior is to singularize the table name, and: C<join '', map
259 ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
260 split up the table name into chunks anywhere a non-alpha-numeric character
261 occurs, change the case of first letter of each chunk to upper case, and put
262 the chunks back together. Examples:
264 Table Name | Moniker Name
265 ---------------------------
267 luser_group | LuserGroup
268 luser-opts | LuserOpt
270 =head2 inflect_plural
272 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
273 if hash key does not exist or coderef returns false), but acts as a map
274 for pluralizing relationship names. The default behavior is to utilize
275 L<Lingua::EN::Inflect::Number/to_PL>.
277 =head2 inflect_singular
279 As L</inflect_plural> above, but for singularizing relationship names.
280 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
282 =head2 schema_base_class
284 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
286 =head2 result_base_class
288 Base class for your table classes (aka result classes). Defaults to
291 =head2 additional_base_classes
293 List of additional base classes all of your table classes will use.
295 =head2 left_base_classes
297 List of additional base classes all of your table classes will use
298 that need to be leftmost.
300 =head2 additional_classes
302 List of additional classes which all of your table classes will use.
306 List of additional components to be loaded into all of your table
307 classes. A good example would be C<ResultSetManager>.
309 =head2 resultset_components
311 List of additional ResultSet components to be loaded into your table
312 classes. A good example would be C<AlwaysRS>. Component
313 C<ResultSetManager> will be automatically added to the above
314 C<components> list if this option is set.
316 =head2 use_namespaces
318 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
321 Generate result class names suitable for
322 L<DBIx::Class::Schema/load_namespaces> and call that instead of
323 L<DBIx::Class::Schema/load_classes>. When using this option you can also
324 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
325 C<resultset_namespace>, C<default_resultset_class>), and they will be added
326 to the call (and the generated result class names adjusted appropriately).
328 =head2 dump_directory
330 This option is designed to be a tool to help you transition from this
331 loader to a manually-defined schema when you decide it's time to do so.
333 The value of this option is a perl libdir pathname. Within
334 that directory this module will create a baseline manual
335 L<DBIx::Class::Schema> module set, based on what it creates at runtime
338 The created schema class will have the same classname as the one on
339 which you are setting this option (and the ResultSource classes will be
340 based on this name as well).
342 Normally you wouldn't hard-code this setting in your schema class, as it
343 is meant for one-time manual usage.
345 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
346 recommended way to access this functionality.
348 =head2 dump_overwrite
350 Deprecated. See L</really_erase_my_files> below, which does *not* mean
351 the same thing as the old C<dump_overwrite> setting from previous releases.
353 =head2 really_erase_my_files
355 Default false. If true, Loader will unconditionally delete any existing
356 files before creating the new ones from scratch when dumping a schema to disk.
358 The default behavior is instead to only replace the top portion of the
359 file, up to and including the final stanza which contains
360 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
361 leaving any customizations you placed after that as they were.
363 When C<really_erase_my_files> is not set, if the output file already exists,
364 but the aforementioned final stanza is not found, or the checksum
365 contained there does not match the generated contents, Loader will
366 croak and not touch the file.
368 You should really be using version control on your schema classes (and all
369 of the rest of your code for that matter). Don't blame me if a bug in this
370 code wipes something out when it shouldn't have, you've been warned.
372 =head2 overwrite_modifications
374 Default false. If false, when updating existing files, Loader will
375 refuse to modify any Loader-generated code that has been modified
376 since its last run (as determined by the checksum Loader put in its
379 If true, Loader will discard any manual modifications that have been
380 made to Loader-generated code.
382 Again, you should be using version control on your schema classes. Be
383 careful with this option.
385 =head2 custom_column_info
387 Hook for adding extra attributes to the
388 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
390 Must be a coderef that returns a hashref with the extra attributes.
392 Receives the table name, column name and column_info.
396 custom_column_info => sub {
397 my ($table_name, $column_name, $column_info) = @_;
399 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
400 return { is_snoopy => 1 };
404 This attribute can also be used to set C<inflate_datetime> on a non-datetime
405 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
407 =head2 datetime_timezone
409 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
410 columns with the DATE/DATETIME/TIMESTAMP data_types.
412 =head2 datetime_locale
414 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
415 columns with the DATE/DATETIME/TIMESTAMP data_types.
419 None of these methods are intended for direct invocation by regular
420 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
421 L<DBIx::Class::Schema::Loader>.
425 use constant CURRENT_V => 'v5';
427 use constant CLASS_ARGS => qw(
428 schema_base_class result_base_class additional_base_classes
429 left_base_classes additional_classes components resultset_components
432 # ensure that a peice of object data is a valid arrayref, creating
433 # an empty one or encapsulating whatever's there.
434 sub _ensure_arrayref {
439 $self->{$_} = [ $self->{$_} ]
440 unless ref $self->{$_} eq 'ARRAY';
446 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
447 by L<DBIx::Class::Schema::Loader>.
452 my ( $class, %args ) = @_;
454 my $self = { %args };
456 bless $self => $class;
458 $self->_ensure_arrayref(qw/additional_classes
459 additional_base_classes
465 $self->_validate_class_args;
467 push(@{$self->{components}}, 'ResultSetManager')
468 if @{$self->{resultset_components}};
470 $self->{monikers} = {};
471 $self->{classes} = {};
472 $self->{_upgrading_classes} = {};
474 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
475 $self->{schema} ||= $self->{schema_class};
477 croak "dump_overwrite is deprecated. Please read the"
478 . " DBIx::Class::Schema::Loader::Base documentation"
479 if $self->{dump_overwrite};
481 $self->{dynamic} = ! $self->{dump_directory};
482 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
487 $self->{dump_directory} ||= $self->{temp_directory};
489 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
490 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
492 if ((not ref $self->naming) && defined $self->naming) {
493 my $naming_ver = $self->naming;
495 relationships => $naming_ver,
496 monikers => $naming_ver,
501 for (values %{ $self->naming }) {
502 $_ = CURRENT_V if $_ eq 'current';
505 $self->{naming} ||= {};
507 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
508 croak 'custom_column_info must be a CODE ref';
511 $self->_check_back_compat;
513 $self->use_namespaces(1) unless defined $self->use_namespaces;
514 $self->generate_pod(1) unless defined $self->generate_pod;
515 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
516 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
521 sub _check_back_compat {
524 # dynamic schemas will always be in 0.04006 mode, unless overridden
525 if ($self->dynamic) {
526 # just in case, though no one is likely to dump a dynamic schema
527 $self->schema_version_to_dump('0.04006');
529 if (not %{ $self->naming }) {
530 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
532 Dynamic schema detected, will run in 0.04006 mode.
534 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
535 to disable this warning.
537 Also consider setting 'use_namespaces => 1' if/when upgrading.
539 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
544 $self->_upgrading_from('v4');
547 $self->naming->{relationships} ||= 'v4';
548 $self->naming->{monikers} ||= 'v4';
550 if ($self->use_namespaces) {
551 $self->_upgrading_from_load_classes(1);
554 $self->use_namespaces(0);
560 # otherwise check if we need backcompat mode for a static schema
561 my $filename = $self->_get_dump_filename($self->schema_class);
562 return unless -e $filename;
564 open(my $fh, '<', $filename)
565 or croak "Cannot open '$filename' for reading: $!";
567 my $load_classes = 0;
568 my $result_namespace = '';
571 if (/^__PACKAGE__->load_classes;/) {
573 } elsif (/result_namespace => '([^']+)'/) {
574 $result_namespace = $1;
575 } elsif (my ($real_ver) =
576 /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) {
578 if ($load_classes && (not defined $self->use_namespaces)) {
579 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
581 'load_classes;' static schema detected, turning off 'use_namespaces'.
583 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
584 variable to disable this warning.
586 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
589 $self->use_namespaces(0);
591 elsif ($load_classes && $self->use_namespaces) {
592 $self->_upgrading_from_load_classes(1);
594 elsif ((not $load_classes) && defined $self->use_namespaces
595 && (not $self->use_namespaces)) {
596 $self->_downgrading_to_load_classes(
597 $result_namespace || 'Result'
600 elsif ((not defined $self->use_namespaces)
601 || $self->use_namespaces) {
602 if (not $self->result_namespace) {
603 $self->result_namespace($result_namespace || 'Result');
605 elsif ($result_namespace ne $self->result_namespace) {
606 $self->_rewriting_result_namespace(
607 $result_namespace || 'Result'
612 # XXX when we go past .0 this will need fixing
613 my ($v) = $real_ver =~ /([1-9])/;
616 last if $v eq CURRENT_V || $real_ver =~ /^0\.\d\d999/;
618 if (not %{ $self->naming }) {
619 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
621 Version $real_ver static schema detected, turning on backcompat mode.
623 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
624 to disable this warning.
626 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
631 $self->_upgrading_from($v);
635 $self->naming->{relationships} ||= $v;
636 $self->naming->{monikers} ||= $v;
638 $self->schema_version_to_dump($real_ver);
646 sub _validate_class_args {
650 foreach my $k (CLASS_ARGS) {
651 next unless $self->$k;
653 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
654 foreach my $c (@classes) {
655 # components default to being under the DBIx::Class namespace unless they
656 # are preceeded with a '+'
657 if ( $k =~ m/components$/ && $c !~ s/^\+// ) {
658 $c = 'DBIx::Class::' . $c;
661 # 1 == installed, 0 == not installed, undef == invalid classname
662 my $installed = Class::Inspector->installed($c);
663 if ( defined($installed) ) {
664 if ( $installed == 0 ) {
665 croak qq/$c, as specified in the loader option "$k", is not installed/;
668 croak qq/$c, as specified in the loader option "$k", is an invalid class name/;
674 sub _find_file_in_inc {
675 my ($self, $file) = @_;
677 foreach my $prefix (@INC) {
678 my $fullpath = File::Spec->catfile($prefix, $file);
679 return $fullpath if -f $fullpath
680 # abs_path throws on Windows for nonexistant files
681 and eval { Cwd::abs_path($fullpath) } ne
682 (eval { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) } || '');
689 my ($self, $class) = @_;
691 my $class_path = $class;
692 $class_path =~ s{::}{/}g;
693 $class_path .= '.pm';
698 sub _find_class_in_inc {
699 my ($self, $class) = @_;
701 return $self->_find_file_in_inc($self->_class_path($class));
707 return $self->_upgrading_from
708 || $self->_upgrading_from_load_classes
709 || $self->_downgrading_to_load_classes
710 || $self->_rewriting_result_namespace
714 sub _rewrite_old_classnames {
715 my ($self, $code) = @_;
717 return $code unless $self->_rewriting;
719 my %old_classes = reverse %{ $self->_upgrading_classes };
721 my $re = join '|', keys %old_classes;
724 $code =~ s/$re/$old_classes{$1} || $1/eg;
730 my ($self, $class) = @_;
732 return if $self->{skip_load_external};
734 # so that we don't load our own classes, under any circumstances
735 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
737 my $real_inc_path = $self->_find_class_in_inc($class);
739 my $old_class = $self->_upgrading_classes->{$class}
740 if $self->_rewriting;
742 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
743 if $old_class && $old_class ne $class;
745 return unless $real_inc_path || $old_real_inc_path;
747 if ($real_inc_path) {
748 # If we make it to here, we loaded an external definition
749 warn qq/# Loaded external class definition for '$class'\n/
752 open(my $fh, '<', $real_inc_path)
753 or croak "Failed to open '$real_inc_path' for reading: $!";
754 my $code = do { local $/; <$fh> };
756 or croak "Failed to close $real_inc_path: $!";
757 $code = $self->_rewrite_old_classnames($code);
759 if ($self->dynamic) { # load the class too
760 # kill redefined warnings
761 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
762 local $SIG{__WARN__} = sub {
764 unless $_[0] =~ /^Subroutine \S+ redefined/;
770 $self->_ext_stmt($class,
771 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
772 .qq|# They are now part of the custom portion of this file\n|
773 .qq|# for you to hand-edit. If you do not either delete\n|
774 .qq|# this section or remove that file from \@INC, this section\n|
775 .qq|# will be repeated redundantly when you re-create this\n|
776 .qq|# file again via Loader! See skip_load_external to disable\n|
777 .qq|# this feature.\n|
780 $self->_ext_stmt($class, $code);
781 $self->_ext_stmt($class,
782 qq|# End of lines loaded from '$real_inc_path' |
786 if ($old_real_inc_path) {
787 open(my $fh, '<', $old_real_inc_path)
788 or croak "Failed to open '$old_real_inc_path' for reading: $!";
789 $self->_ext_stmt($class, <<"EOF");
791 # These lines were loaded from '$old_real_inc_path',
792 # based on the Result class name that would have been created by an 0.04006
793 # version of the Loader. For a static schema, this happens only once during
794 # upgrade. See skip_load_external to disable this feature.
798 local ($/, @ARGV) = (undef, $old_real_inc_path); <>
800 $code = $self->_rewrite_old_classnames($code);
802 if ($self->dynamic) {
805 Detected external content in '$old_real_inc_path', a class name that would have
806 been used by an 0.04006 version of the Loader.
808 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
809 new name of the Result.
811 # kill redefined warnings
812 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
813 local $SIG{__WARN__} = sub {
815 unless $_[0] =~ /^Subroutine \S+ redefined/;
822 $self->_ext_stmt($class, $code);
823 $self->_ext_stmt($class,
824 qq|# End of lines loaded from '$old_real_inc_path' |
831 Does the actual schema-construction work.
838 $self->_load_tables($self->_tables_list);
845 Rescan the database for newly added tables. Does
846 not process drops or changes. Returns a list of
847 the newly added table monikers.
849 The schema argument should be the schema class
850 or object to be affected. It should probably
851 be derived from the original schema_class used
857 my ($self, $schema) = @_;
859 $self->{schema} = $schema;
860 $self->_relbuilder->{schema} = $schema;
863 my @current = $self->_tables_list;
864 foreach my $table ($self->_tables_list) {
865 if(!exists $self->{_tables}->{$table}) {
866 push(@created, $table);
870 my $loaded = $self->_load_tables(@created);
872 return map { $self->monikers->{$_} } @$loaded;
876 no warnings 'uninitialized';
879 return if $self->{skip_relationships};
881 if ($self->naming->{relationships} eq 'v4') {
882 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
883 return $self->{relbuilder} ||=
884 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
885 $self->schema, $self->inflect_plural, $self->inflect_singular
889 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
891 $self->inflect_plural,
892 $self->inflect_singular,
893 $self->relationship_attrs,
898 my ($self, @tables) = @_;
900 # First, use _tables_list with constraint and exclude
901 # to get a list of tables to operate on
903 my $constraint = $self->constraint;
904 my $exclude = $self->exclude;
906 @tables = grep { /$constraint/ } @tables if $constraint;
907 @tables = grep { ! /$exclude/ } @tables if $exclude;
909 # Save the new tables to the tables list
911 $self->{_tables}->{$_} = 1;
914 $self->_make_src_class($_) for @tables;
915 $self->_setup_src_meta($_) for @tables;
917 if(!$self->skip_relationships) {
918 # The relationship loader needs a working schema
920 local $self->{dump_directory} = $self->{temp_directory};
921 $self->_reload_classes(\@tables);
922 $self->_load_relationships($_) for @tables;
925 # Remove that temp dir from INC so it doesn't get reloaded
926 @INC = grep $_ ne $self->dump_directory, @INC;
929 $self->_load_external($_)
930 for map { $self->classes->{$_} } @tables;
932 # Reload without unloading first to preserve any symbols from external
934 $self->_reload_classes(\@tables, 0);
936 # Drop temporary cache
937 delete $self->{_cache};
942 sub _reload_classes {
943 my ($self, $tables, $unload) = @_;
945 my @tables = @$tables;
946 $unload = 1 unless defined $unload;
948 # so that we don't repeat custom sections
949 @INC = grep $_ ne $self->dump_directory, @INC;
951 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
953 unshift @INC, $self->dump_directory;
956 my %have_source = map { $_ => $self->schema->source($_) }
957 $self->schema->sources;
959 for my $table (@tables) {
960 my $moniker = $self->monikers->{$table};
961 my $class = $self->classes->{$table};
964 no warnings 'redefine';
965 local *Class::C3::reinitialize = sub {};
968 Class::Unload->unload($class) if $unload;
969 my ($source, $resultset_class);
971 ($source = $have_source{$moniker})
972 && ($resultset_class = $source->resultset_class)
973 && ($resultset_class ne 'DBIx::Class::ResultSet')
975 my $has_file = Class::Inspector->loaded_filename($resultset_class);
976 Class::Unload->unload($resultset_class) if $unload;
977 $self->_reload_class($resultset_class) if $has_file;
979 $self->_reload_class($class);
981 push @to_register, [$moniker, $class];
984 Class::C3->reinitialize;
986 $self->schema->register_class(@$_);
990 # We use this instead of ensure_class_loaded when there are package symbols we
993 my ($self, $class) = @_;
995 my $class_path = $self->_class_path($class);
996 delete $INC{ $class_path };
998 # kill redefined warnings
999 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
1000 local $SIG{__WARN__} = sub {
1002 unless $_[0] =~ /^Subroutine \S+ redefined/;
1004 eval "require $class;";
1007 sub _get_dump_filename {
1008 my ($self, $class) = (@_);
1010 $class =~ s{::}{/}g;
1011 return $self->dump_directory . q{/} . $class . q{.pm};
1014 sub _ensure_dump_subdirs {
1015 my ($self, $class) = (@_);
1017 my @name_parts = split(/::/, $class);
1018 pop @name_parts; # we don't care about the very last element,
1019 # which is a filename
1021 my $dir = $self->dump_directory;
1024 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1026 last if !@name_parts;
1027 $dir = File::Spec->catdir($dir, shift @name_parts);
1032 my ($self, @classes) = @_;
1034 my $schema_class = $self->schema_class;
1035 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1037 my $target_dir = $self->dump_directory;
1038 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1039 unless $self->{dynamic} or $self->{quiet};
1042 qq|package $schema_class;\n\n|
1043 . qq|# Created by DBIx::Class::Schema::Loader\n|
1044 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1045 . qq|use strict;\nuse warnings;\n\n|
1046 . qq|use base '$schema_base_class';\n\n|;
1048 if ($self->use_namespaces) {
1049 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1050 my $namespace_options;
1051 for my $attr (qw(result_namespace
1053 default_resultset_class)) {
1055 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1058 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1059 $schema_text .= qq|;\n|;
1062 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1066 local $self->{version_to_dump} = $self->schema_version_to_dump;
1067 $self->_write_classfile($schema_class, $schema_text, 1);
1070 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1072 foreach my $src_class (@classes) {
1074 qq|package $src_class;\n\n|
1075 . qq|# Created by DBIx::Class::Schema::Loader\n|
1076 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1077 . qq|use strict;\nuse warnings;\n\n|
1078 . qq|use base '$result_base_class';\n\n|;
1080 $self->_write_classfile($src_class, $src_text);
1083 # remove Result dir if downgrading from use_namespaces, and there are no
1085 if (my $result_ns = $self->_downgrading_to_load_classes
1086 || $self->_rewriting_result_namespace) {
1087 my $result_namespace = $self->_result_namespace(
1092 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1093 $result_dir = $self->dump_directory . '/' . $result_dir;
1095 unless (my @files = glob "$result_dir/*") {
1100 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1105 my ($self, $version, $ts) = @_;
1106 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1109 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1112 sub _write_classfile {
1113 my ($self, $class, $text, $is_schema) = @_;
1115 my $filename = $self->_get_dump_filename($class);
1116 $self->_ensure_dump_subdirs($class);
1118 if (-f $filename && $self->really_erase_my_files) {
1119 warn "Deleting existing file '$filename' due to "
1120 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1124 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
1126 if (my $old_class = $self->_upgrading_classes->{$class}) {
1127 my $old_filename = $self->_get_dump_filename($old_class);
1129 my ($old_custom_content) = $self->_get_custom_content(
1130 $old_class, $old_filename, 0 # do not add default comment
1133 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
1135 if ($old_custom_content) {
1137 "\n" . $old_custom_content . "\n" . $custom_content;
1140 unlink $old_filename;
1143 $custom_content = $self->_rewrite_old_classnames($custom_content);
1146 for @{$self->{_dump_storage}->{$class} || []};
1148 # Check and see if the dump is infact differnt
1152 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1155 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1156 return unless $self->_upgrading_from && $is_schema;
1160 $text .= $self->_sig_comment(
1161 $self->version_to_dump,
1162 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1165 open(my $fh, '>', $filename)
1166 or croak "Cannot open '$filename' for writing: $!";
1168 # Write the top half and its MD5 sum
1169 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1171 # Write out anything loaded via external partial class file in @INC
1173 for @{$self->{_ext_storage}->{$class} || []};
1175 # Write out any custom content the user has added
1176 print $fh $custom_content;
1179 or croak "Error closing '$filename': $!";
1182 sub _default_custom_content {
1183 return qq|\n\n# You can replace this text with custom|
1184 . qq| content, and it will be preserved on regeneration|
1188 sub _get_custom_content {
1189 my ($self, $class, $filename, $add_default) = @_;
1191 $add_default = 1 unless defined $add_default;
1193 return ($self->_default_custom_content) if ! -f $filename;
1195 open(my $fh, '<', $filename)
1196 or croak "Cannot open '$filename' for reading: $!";
1199 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1202 my ($md5, $ts, $ver);
1204 if(!$md5 && /$mark_re/) {
1208 # Pull out the previous version and timestamp
1209 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
1212 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"
1213 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
1222 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1223 . " it does not appear to have been generated by Loader"
1226 # Default custom content:
1227 $buffer ||= $self->_default_custom_content if $add_default;
1229 return ($buffer, $md5, $ver, $ts);
1237 warn "$target: use $_;" if $self->debug;
1238 $self->_raw_stmt($target, "use $_;");
1245 my $schema_class = $self->schema_class;
1247 my $blist = join(q{ }, @_);
1248 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1249 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1252 sub _result_namespace {
1253 my ($self, $schema_class, $ns) = @_;
1254 my @result_namespace;
1256 if ($ns =~ /^\+(.*)/) {
1257 # Fully qualified namespace
1258 @result_namespace = ($1)
1261 # Relative namespace
1262 @result_namespace = ($schema_class, $ns);
1265 return wantarray ? @result_namespace : join '::', @result_namespace;
1268 # Create class with applicable bases, setup monikers, etc
1269 sub _make_src_class {
1270 my ($self, $table) = @_;
1272 my $schema = $self->schema;
1273 my $schema_class = $self->schema_class;
1275 my $table_moniker = $self->_table2moniker($table);
1276 my @result_namespace = ($schema_class);
1277 if ($self->use_namespaces) {
1278 my $result_namespace = $self->result_namespace || 'Result';
1279 @result_namespace = $self->_result_namespace(
1284 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1286 if ((my $upgrading_v = $self->_upgrading_from)
1287 || $self->_rewriting) {
1288 local $self->naming->{monikers} = $upgrading_v
1291 my @result_namespace = @result_namespace;
1292 if ($self->_upgrading_from_load_classes) {
1293 @result_namespace = ($schema_class);
1295 elsif (my $ns = $self->_downgrading_to_load_classes) {
1296 @result_namespace = $self->_result_namespace(
1301 elsif ($ns = $self->_rewriting_result_namespace) {
1302 @result_namespace = $self->_result_namespace(
1308 my $old_class = join(q{::}, @result_namespace,
1309 $self->_table2moniker($table));
1311 $self->_upgrading_classes->{$table_class} = $old_class
1312 unless $table_class eq $old_class;
1315 my $table_normalized = lc $table;
1316 $self->classes->{$table} = $table_class;
1317 $self->classes->{$table_normalized} = $table_class;
1318 $self->monikers->{$table} = $table_moniker;
1319 $self->monikers->{$table_normalized} = $table_moniker;
1321 $self->_use ($table_class, @{$self->additional_classes});
1322 $self->_inject($table_class, @{$self->left_base_classes});
1324 if (my @components = @{ $self->components }) {
1325 $self->_dbic_stmt($table_class, 'load_components', @components);
1328 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1329 if @{$self->resultset_components};
1330 $self->_inject($table_class, @{$self->additional_base_classes});
1333 # Set up metadata (cols, pks, etc)
1334 sub _setup_src_meta {
1335 my ($self, $table) = @_;
1337 my $schema = $self->schema;
1338 my $schema_class = $self->schema_class;
1340 my $table_class = $self->classes->{$table};
1341 my $table_moniker = $self->monikers->{$table};
1343 my $table_name = $table;
1344 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1346 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1347 $table_name = \ $self->_quote_table_name($table_name);
1350 $self->_dbic_stmt($table_class,'table',$table_name);
1352 my $cols = $self->_table_columns($table);
1354 eval { $col_info = $self->__columns_info_for($table) };
1356 $self->_dbic_stmt($table_class,'add_columns',@$cols);
1359 if ($self->_is_case_sensitive) {
1360 for my $col (keys %$col_info) {
1361 $col_info->{$col}{accessor} = lc $col
1362 if $col ne lc($col);
1365 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1368 my $fks = $self->_table_fk_info($table);
1370 for my $fkdef (@$fks) {
1371 for my $col (@{ $fkdef->{local_columns} }) {
1372 $col_info->{$col}{is_foreign_key} = 1;
1378 map { $_, ($col_info->{$_}||{}) } @$cols
1382 my %uniq_tag; # used to eliminate duplicate uniqs
1384 my $pks = $self->_table_pk_info($table) || [];
1385 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1386 : carp("$table has no primary key");
1387 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1389 my $uniqs = $self->_table_uniq_info($table) || [];
1391 my ($name, $cols) = @$_;
1392 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1393 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1398 sub __columns_info_for {
1399 my ($self, $table) = @_;
1401 my $result = $self->_columns_info_for($table);
1403 while (my ($col, $info) = each %$result) {
1404 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
1405 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
1407 $result->{$col} = $info;
1415 Returns a sorted list of loaded tables, using the original database table
1423 return keys %{$self->_tables};
1426 # Make a moniker from a table
1427 sub _default_table2moniker {
1428 no warnings 'uninitialized';
1429 my ($self, $table) = @_;
1431 if ($self->naming->{monikers} eq 'v4') {
1432 return join '', map ucfirst, split /[\W_]+/, lc $table;
1435 return join '', map ucfirst, split /[\W_]+/,
1436 Lingua::EN::Inflect::Number::to_S(lc $table);
1439 sub _table2moniker {
1440 my ( $self, $table ) = @_;
1444 if( ref $self->moniker_map eq 'HASH' ) {
1445 $moniker = $self->moniker_map->{$table};
1447 elsif( ref $self->moniker_map eq 'CODE' ) {
1448 $moniker = $self->moniker_map->($table);
1451 $moniker ||= $self->_default_table2moniker($table);
1456 sub _load_relationships {
1457 my ($self, $table) = @_;
1459 my $tbl_fk_info = $self->_table_fk_info($table);
1460 foreach my $fkdef (@$tbl_fk_info) {
1461 $fkdef->{remote_source} =
1462 $self->monikers->{delete $fkdef->{remote_table}};
1464 my $tbl_uniq_info = $self->_table_uniq_info($table);
1466 my $local_moniker = $self->monikers->{$table};
1467 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1469 foreach my $src_class (sort keys %$rel_stmts) {
1470 my $src_stmts = $rel_stmts->{$src_class};
1471 foreach my $stmt (@$src_stmts) {
1472 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1477 # Overload these in driver class:
1479 # Returns an arrayref of column names
1480 sub _table_columns { croak "ABSTRACT METHOD" }
1482 # Returns arrayref of pk col names
1483 sub _table_pk_info { croak "ABSTRACT METHOD" }
1485 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1486 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1488 # Returns an arrayref of foreign key constraints, each
1489 # being a hashref with 3 keys:
1490 # local_columns (arrayref), remote_columns (arrayref), remote_table
1491 sub _table_fk_info { croak "ABSTRACT METHOD" }
1493 # Returns an array of lower case table names
1494 sub _tables_list { croak "ABSTRACT METHOD" }
1496 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1502 # generate the pod for this statement, storing it with $self->_pod
1503 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
1505 my $args = dump(@_);
1506 $args = '(' . $args . ')' if @_ < 2;
1507 my $stmt = $method . $args . q{;};
1509 warn qq|$class\->$stmt\n| if $self->debug;
1510 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1514 # generates the accompanying pod for a DBIC class method statement,
1515 # storing it with $self->_pod
1521 if ( $method eq 'table' ) {
1523 my $pcm = $self->pod_comment_mode;
1524 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
1525 if ( $self->can('_table_comment') ) {
1526 $comment = $self->_table_comment($table);
1527 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
1528 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
1529 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
1531 $self->_pod( $class, "=head1 NAME" );
1532 my $table_descr = $class;
1533 $table_descr .= " - " . $comment if $comment and $comment_in_name;
1534 $self->{_class2table}{ $class } = $table;
1535 $self->_pod( $class, $table_descr );
1536 if ($comment and $comment_in_desc) {
1537 $self->_pod( $class, "=head1 DESCRIPTION" );
1538 $self->_pod( $class, $comment );
1540 $self->_pod_cut( $class );
1541 } elsif ( $method eq 'add_columns' ) {
1542 $self->_pod( $class, "=head1 ACCESSORS" );
1543 my $col_counter = 0;
1545 while( my ($name,$attrs) = splice @cols,0,2 ) {
1547 $self->_pod( $class, '=head2 ' . $name );
1548 $self->_pod( $class,
1550 my $s = $attrs->{$_};
1551 $s = !defined $s ? 'undef' :
1552 length($s) == 0 ? '(empty string)' :
1553 ref($s) eq 'SCALAR' ? $$s :
1558 } sort keys %$attrs,
1561 if( $self->can('_column_comment')
1562 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1564 $self->_pod( $class, $comment );
1567 $self->_pod_cut( $class );
1568 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1569 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1570 my ( $accessor, $rel_class ) = @_;
1571 $self->_pod( $class, "=head2 $accessor" );
1572 $self->_pod( $class, 'Type: ' . $method );
1573 $self->_pod( $class, "Related object: L<$rel_class>" );
1574 $self->_pod_cut( $class );
1575 $self->{_relations_started} { $class } = 1;
1579 # Stores a POD documentation
1581 my ($self, $class, $stmt) = @_;
1582 $self->_raw_stmt( $class, "\n" . $stmt );
1586 my ($self, $class ) = @_;
1587 $self->_raw_stmt( $class, "\n=cut\n" );
1590 # Store a raw source line for a class (for dumping purposes)
1592 my ($self, $class, $stmt) = @_;
1593 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1596 # Like above, but separately for the externally loaded stuff
1598 my ($self, $class, $stmt) = @_;
1599 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1602 sub _quote_table_name {
1603 my ($self, $table) = @_;
1605 my $qt = $self->schema->storage->sql_maker->quote_char;
1607 return $table unless $qt;
1610 return $qt->[0] . $table . $qt->[1];
1613 return $qt . $table . $qt;
1616 sub _is_case_sensitive { 0 }
1618 sub _custom_column_info {
1619 my ( $self, $table_name, $column_name, $column_info ) = @_;
1621 if (my $code = $self->custom_column_info) {
1622 return $code->($table_name, $column_name, $column_info) || {};
1627 sub _datetime_column_info {
1628 my ( $self, $table_name, $column_name, $column_info ) = @_;
1630 my $type = $column_info->{data_type} || '';
1631 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
1632 or ($type =~ /date|timestamp/i)) {
1633 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
1634 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
1639 # remove the dump dir from @INC on destruction
1643 @INC = grep $_ ne $self->dump_directory, @INC;
1648 Returns a hashref of loaded table to moniker mappings. There will
1649 be two entries for each table, the original name and the "normalized"
1650 name, in the case that the two are different (such as databases
1651 that like uppercase table names, or preserve your original mixed-case
1652 definitions, or what-have-you).
1656 Returns a hashref of table to class mappings. In some cases it will
1657 contain multiple entries per table for the original and normalized table
1658 names, as above in L</monikers>.
1662 L<DBIx::Class::Schema::Loader>
1666 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1670 This library is free software; you can redistribute it and/or modify it under
1671 the same terms as Perl itself.