1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast Class::C3::Componentised/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use DBIx::Class::Schema::Loader::RelBuilder;
9 use Data::Dump qw/ dump /;
14 use Lingua::EN::Inflect::Number qw//;
19 our $VERSION = '0.04999_12';
21 __PACKAGE__->mk_ro_accessors(qw/
28 additional_base_classes
43 default_resultset_class
56 __PACKAGE__->mk_accessors(qw/
58 schema_version_to_dump
64 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
68 See L<DBIx::Class::Schema::Loader>
72 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
73 classes, and implements the common functionality between them.
75 =head1 CONSTRUCTOR OPTIONS
77 These constructor options are the base options for
78 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
80 =head2 skip_relationships
82 Skip setting up relationships. The default is to attempt the loading
87 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
88 relationship names and singularized Results, unless you're overwriting an
89 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
90 which case the backward compatible RelBuilder will be activated, and
91 singularization will be turned off.
97 will disable the backward-compatible RelBuilder and use
98 the new-style relationship names along with singularized Results, even when
99 overwriting a dump made with an earlier version.
101 The option also takes a hashref:
103 naming => { relationships => 'v5', monikers => 'v4' }
111 How to name relationship accessors.
115 How to name Result classes.
125 Latest default style, whatever that happens to be.
129 Version 0.05XXX style.
133 Version 0.04XXX style.
137 Dynamic schemas will always default to the 0.04XXX relationship names and won't
138 singularize Results for backward compatibility, to activate the new RelBuilder
139 and singularization put this in your C<Schema.pm> file:
141 __PACKAGE__->naming('current');
143 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
144 next major version upgrade:
146 __PACKAGE__->naming('v5');
150 If set to true, each constructive L<DBIx::Class> statement the loader
151 decides to execute will be C<warn>-ed before execution.
155 Set the name of the schema to load (schema in the sense that your database
156 vendor means it). Does not currently support loading more than one schema
161 Only load tables matching regex. Best specified as a qr// regex.
165 Exclude tables matching regex. Best specified as a qr// regex.
169 Overrides the default table name to moniker translation. Can be either
170 a hashref of table keys and moniker values, or a coderef for a translator
171 function taking a single scalar table name argument and returning
172 a scalar moniker. If the hash entry does not exist, or the function
173 returns a false value, the code falls back to default behavior
176 The default behavior is to singularize the table name, and: C<join '', map
177 ucfirst, split /[\W_]+/, lc $table>, which is to say: lowercase everything,
178 split up the table name into chunks anywhere a non-alpha-numeric character
179 occurs, change the case of first letter of each chunk to upper case, and put
180 the chunks back together. Examples:
182 Table Name | Moniker Name
183 ---------------------------
185 luser_group | LuserGroup
186 luser-opts | LuserOpts
188 =head2 inflect_plural
190 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
191 if hash key does not exist or coderef returns false), but acts as a map
192 for pluralizing relationship names. The default behavior is to utilize
193 L<Lingua::EN::Inflect::Number/to_PL>.
195 =head2 inflect_singular
197 As L</inflect_plural> above, but for singularizing relationship names.
198 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
200 =head2 schema_base_class
202 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
204 =head2 result_base_class
206 Base class for your table classes (aka result classes). Defaults to
209 =head2 additional_base_classes
211 List of additional base classes all of your table classes will use.
213 =head2 left_base_classes
215 List of additional base classes all of your table classes will use
216 that need to be leftmost.
218 =head2 additional_classes
220 List of additional classes which all of your table classes will use.
224 List of additional components to be loaded into all of your table
225 classes. A good example would be C<ResultSetManager>.
227 =head2 resultset_components
229 List of additional ResultSet components to be loaded into your table
230 classes. A good example would be C<AlwaysRS>. Component
231 C<ResultSetManager> will be automatically added to the above
232 C<components> list if this option is set.
234 =head2 use_namespaces
236 Generate result class names suitable for
237 L<DBIx::Class::Schema/load_namespaces> and call that instead of
238 L<DBIx::Class::Schema/load_classes>. When using this option you can also
239 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
240 C<resultset_namespace>, C<default_resultset_class>), and they will be added
241 to the call (and the generated result class names adjusted appropriately).
243 =head2 dump_directory
245 This option is designed to be a tool to help you transition from this
246 loader to a manually-defined schema when you decide it's time to do so.
248 The value of this option is a perl libdir pathname. Within
249 that directory this module will create a baseline manual
250 L<DBIx::Class::Schema> module set, based on what it creates at runtime
253 The created schema class will have the same classname as the one on
254 which you are setting this option (and the ResultSource classes will be
255 based on this name as well).
257 Normally you wouldn't hard-code this setting in your schema class, as it
258 is meant for one-time manual usage.
260 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
261 recommended way to access this functionality.
263 =head2 dump_overwrite
265 Deprecated. See L</really_erase_my_files> below, which does *not* mean
266 the same thing as the old C<dump_overwrite> setting from previous releases.
268 =head2 really_erase_my_files
270 Default false. If true, Loader will unconditionally delete any existing
271 files before creating the new ones from scratch when dumping a schema to disk.
273 The default behavior is instead to only replace the top portion of the
274 file, up to and including the final stanza which contains
275 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
276 leaving any customizations you placed after that as they were.
278 When C<really_erase_my_files> is not set, if the output file already exists,
279 but the aforementioned final stanza is not found, or the checksum
280 contained there does not match the generated contents, Loader will
281 croak and not touch the file.
283 You should really be using version control on your schema classes (and all
284 of the rest of your code for that matter). Don't blame me if a bug in this
285 code wipes something out when it shouldn't have, you've been warned.
289 None of these methods are intended for direct invocation by regular
290 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
291 can also be found via standard L<DBIx::Class::Schema> methods somehow.
295 use constant CURRENT_V => 'v5';
297 # ensure that a peice of object data is a valid arrayref, creating
298 # an empty one or encapsulating whatever's there.
299 sub _ensure_arrayref {
304 $self->{$_} = [ $self->{$_} ]
305 unless ref $self->{$_} eq 'ARRAY';
311 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
312 by L<DBIx::Class::Schema::Loader>.
317 my ( $class, %args ) = @_;
319 my $self = { %args };
321 bless $self => $class;
323 $self->_ensure_arrayref(qw/additional_classes
324 additional_base_classes
330 push(@{$self->{components}}, 'ResultSetManager')
331 if @{$self->{resultset_components}};
333 $self->{monikers} = {};
334 $self->{classes} = {};
335 $self->{_upgrading_classes} = {};
337 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
338 $self->{schema} ||= $self->{schema_class};
340 croak "dump_overwrite is deprecated. Please read the"
341 . " DBIx::Class::Schema::Loader::Base documentation"
342 if $self->{dump_overwrite};
344 $self->{dynamic} = ! $self->{dump_directory};
345 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
350 $self->{dump_directory} ||= $self->{temp_directory};
352 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
353 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
355 if ((not ref $self->naming) && defined $self->naming) {
356 my $naming_ver = $self->naming;
358 relationships => $naming_ver,
359 monikers => $naming_ver,
364 for (values %{ $self->naming }) {
365 $_ = CURRENT_V if $_ eq 'current';
368 $self->{naming} ||= {};
370 $self->_check_back_compat;
375 sub _check_back_compat {
378 # dynamic schemas will always be in 0.04006 mode, unless overridden
379 if ($self->dynamic) {
380 # just in case, though no one is likely to dump a dynamic schema
381 $self->schema_version_to_dump('0.04006');
383 if (not %{ $self->naming }) {
384 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
386 Dynamic schema detected, will run in 0.04006 mode.
388 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
389 to disable this warning.
391 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
396 $self->_upgrading_from('v4');
399 $self->naming->{relationships} ||= 'v4';
400 $self->naming->{monikers} ||= 'v4';
405 # otherwise check if we need backcompat mode for a static schema
406 my $filename = $self->_get_dump_filename($self->schema_class);
407 return unless -e $filename;
409 open(my $fh, '<', $filename)
410 or croak "Cannot open '$filename' for reading: $!";
413 if (/^# Created by DBIx::Class::Schema::Loader v((\d+)\.(\d+))/) {
416 # XXX when we go past .0 this will need fixing
417 my ($v) = $real_ver =~ /([1-9])/;
420 last if $v eq CURRENT_V;
422 if (not %{ $self->naming }) {
423 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
425 Version $real_ver static schema detected, turning on backcompat mode.
427 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
428 to disable this warning.
430 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
435 $self->_upgrading_from($v);
438 $self->naming->{relationships} ||= $v;
439 $self->naming->{monikers} ||= $v;
441 $self->schema_version_to_dump($real_ver);
449 sub _find_file_in_inc {
450 my ($self, $file) = @_;
452 foreach my $prefix (@INC) {
453 my $fullpath = File::Spec->catfile($prefix, $file);
454 return $fullpath if -f $fullpath
455 and Cwd::abs_path($fullpath) ne
456 Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '';
463 my ($self, $class) = @_;
465 my $class_path = $class;
466 $class_path =~ s{::}{/}g;
467 $class_path .= '.pm';
472 sub _find_class_in_inc {
473 my ($self, $class) = @_;
475 return $self->_find_file_in_inc($self->_class_path($class));
479 my ($self, $class) = @_;
481 my $real_inc_path = $self->_find_class_in_inc($class);
483 return if !$real_inc_path;
485 # If we make it to here, we loaded an external definition
486 warn qq/# Loaded external class definition for '$class'\n/
489 open(my $fh, '<', $real_inc_path)
490 or croak "Failed to open '$real_inc_path' for reading: $!";
491 $self->_ext_stmt($class,
492 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
493 .qq|# They are now part of the custom portion of this file\n|
494 .qq|# for you to hand-edit. If you do not either delete\n|
495 .qq|# this section or remove that file from \@INC, this section\n|
496 .qq|# will be repeated redundantly when you re-create this\n|
497 .qq|# file again via Loader!\n|
501 $self->_ext_stmt($class, $_);
503 $self->_ext_stmt($class,
504 qq|# End of lines loaded from '$real_inc_path' |
507 or croak "Failed to close $real_inc_path: $!";
509 if ($self->dynamic) { # load the class too
510 # turn off redefined warnings
511 local $SIG{__WARN__} = sub {};
519 Does the actual schema-construction work.
526 $self->_load_tables($self->_tables_list);
533 Rescan the database for newly added tables. Does
534 not process drops or changes. Returns a list of
535 the newly added table monikers.
537 The schema argument should be the schema class
538 or object to be affected. It should probably
539 be derived from the original schema_class used
545 my ($self, $schema) = @_;
547 $self->{schema} = $schema;
548 $self->_relbuilder->{schema} = $schema;
551 my @current = $self->_tables_list;
552 foreach my $table ($self->_tables_list) {
553 if(!exists $self->{_tables}->{$table}) {
554 push(@created, $table);
558 my $loaded = $self->_load_tables(@created);
560 return map { $self->monikers->{$_} } @$loaded;
564 no warnings 'uninitialized';
567 return if $self->{skip_relationships};
569 if ($self->naming->{relationships} eq 'v4') {
570 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
571 return $self->{relbuilder} ||=
572 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
573 $self->schema, $self->inflect_plural, $self->inflect_singular
577 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new(
578 $self->schema, $self->inflect_plural, $self->inflect_singular
583 my ($self, @tables) = @_;
585 # First, use _tables_list with constraint and exclude
586 # to get a list of tables to operate on
588 my $constraint = $self->constraint;
589 my $exclude = $self->exclude;
591 @tables = grep { /$constraint/ } @tables if $constraint;
592 @tables = grep { ! /$exclude/ } @tables if $exclude;
594 # Save the new tables to the tables list
596 $self->{_tables}->{$_} = 1;
599 $self->_make_src_class($_) for @tables;
600 $self->_setup_src_meta($_) for @tables;
602 if(!$self->skip_relationships) {
603 # The relationship loader needs a working schema
605 local $self->{dump_directory} = $self->{temp_directory};
606 $self->_reload_classes(\@tables);
607 $self->_load_relationships($_) for @tables;
610 # Remove that temp dir from INC so it doesn't get reloaded
611 @INC = grep { $_ ne $self->{dump_directory} } @INC;
614 $self->_load_external($_)
615 for map { $self->classes->{$_} } @tables;
617 # Reload without unloading first to preserve any symbols from external
619 $self->_reload_classes(\@tables, 0);
621 # Drop temporary cache
622 delete $self->{_cache};
627 sub _reload_classes {
628 my ($self, $tables, $unload) = @_;
630 my @tables = @$tables;
631 $unload = 1 unless defined $unload;
633 # so that we don't repeat custom sections
634 @INC = grep $_ ne $self->dump_directory, @INC;
636 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
638 unshift @INC, $self->dump_directory;
641 my %have_source = map { $_ => $self->schema->source($_) }
642 $self->schema->sources;
644 for my $table (@tables) {
645 my $moniker = $self->monikers->{$table};
646 my $class = $self->classes->{$table};
649 no warnings 'redefine';
650 local *Class::C3::reinitialize = sub {};
653 Class::Unload->unload($class) if $unload;
654 my ($source, $resultset_class);
656 ($source = $have_source{$moniker})
657 && ($resultset_class = $source->resultset_class)
658 && ($resultset_class ne 'DBIx::Class::ResultSet')
660 my $has_file = Class::Inspector->loaded_filename($resultset_class);
661 Class::Unload->unload($resultset_class) if $unload;
662 $self->_reload_class($resultset_class) if $has_file;
664 $self->_reload_class($class);
666 push @to_register, [$moniker, $class];
669 Class::C3->reinitialize;
671 $self->schema->register_class(@$_);
675 # We use this instead of ensure_class_loaded when there are package symbols we
678 my ($self, $class) = @_;
680 my $class_path = $self->_class_path($class);
681 delete $INC{ $class_path };
683 # kill redefined warnings
684 local $SIG{__WARN__} = sub {
685 warn @_ unless $_[0] =~ /^Subroutine \S+ redefined/;
688 eval "require $class;";
691 sub _get_dump_filename {
692 my ($self, $class) = (@_);
695 return $self->dump_directory . q{/} . $class . q{.pm};
698 sub _ensure_dump_subdirs {
699 my ($self, $class) = (@_);
701 my @name_parts = split(/::/, $class);
702 pop @name_parts; # we don't care about the very last element,
703 # which is a filename
705 my $dir = $self->dump_directory;
708 mkdir($dir) or croak "mkdir('$dir') failed: $!";
710 last if !@name_parts;
711 $dir = File::Spec->catdir($dir, shift @name_parts);
716 my ($self, @classes) = @_;
718 my $schema_class = $self->schema_class;
719 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
721 my $target_dir = $self->dump_directory;
722 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
723 unless $self->{dynamic} or $self->{quiet};
726 qq|package $schema_class;\n\n|
727 . qq|# Created by DBIx::Class::Schema::Loader\n|
728 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
729 . qq|use strict;\nuse warnings;\n\n|
730 . qq|use base '$schema_base_class';\n\n|;
732 if ($self->use_namespaces) {
733 $schema_text .= qq|__PACKAGE__->load_namespaces|;
734 my $namespace_options;
735 for my $attr (qw(result_namespace
737 default_resultset_class)) {
739 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
742 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
743 $schema_text .= qq|;\n|;
746 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
750 local $self->{version_to_dump} = $self->schema_version_to_dump;
751 $self->_write_classfile($schema_class, $schema_text);
754 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
756 foreach my $src_class (@classes) {
758 qq|package $src_class;\n\n|
759 . qq|# Created by DBIx::Class::Schema::Loader\n|
760 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
761 . qq|use strict;\nuse warnings;\n\n|
762 . qq|use base '$result_base_class';\n\n|;
764 $self->_write_classfile($src_class, $src_text);
767 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
772 my ($self, $version, $ts) = @_;
773 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
776 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
779 sub _write_classfile {
780 my ($self, $class, $text) = @_;
782 my $filename = $self->_get_dump_filename($class);
783 $self->_ensure_dump_subdirs($class);
785 if (-f $filename && $self->really_erase_my_files) {
786 warn "Deleting existing file '$filename' due to "
787 . "'really_erase_my_files' setting\n" unless $self->{quiet};
791 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
793 if ($self->_upgrading_from) {
794 my $old_class = $self->_upgrading_classes->{$class};
796 if ($old_class && ($old_class ne $class)) {
797 my $old_filename = $self->_get_dump_filename($old_class);
799 my ($old_custom_content) = $self->_get_custom_content(
800 $old_class, $old_filename
803 $custom_content .= "\n" . $old_custom_content
804 if $old_custom_content;
806 unlink $old_filename;
811 for @{$self->{_dump_storage}->{$class} || []};
813 # Check and see if the dump is infact differnt
817 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
820 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
825 $text .= $self->_sig_comment(
826 $self->version_to_dump,
827 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
830 open(my $fh, '>', $filename)
831 or croak "Cannot open '$filename' for writing: $!";
833 # Write the top half and its MD5 sum
834 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
836 # Write out anything loaded via external partial class file in @INC
838 for @{$self->{_ext_storage}->{$class} || []};
840 # Write out any custom content the user has added
841 print $fh $custom_content;
844 or croak "Error closing '$filename': $!";
847 sub _default_custom_content {
848 return qq|\n\n# You can replace this text with custom|
849 . qq| content, and it will be preserved on regeneration|
853 sub _get_custom_content {
854 my ($self, $class, $filename) = @_;
856 return ($self->_default_custom_content) if ! -f $filename;
858 open(my $fh, '<', $filename)
859 or croak "Cannot open '$filename' for reading: $!";
862 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
865 my ($md5, $ts, $ver);
867 if(!$md5 && /$mark_re/) {
871 # Pull out the previous version and timestamp
872 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
875 croak "Checksum mismatch in '$filename'"
876 if Digest::MD5::md5_base64($buffer) ne $md5;
885 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
886 . " it does not appear to have been generated by Loader"
889 # Default custom content:
890 $buffer ||= $self->_default_custom_content;
892 return ($buffer, $md5, $ver, $ts);
900 warn "$target: use $_;" if $self->debug;
901 $self->_raw_stmt($target, "use $_;");
908 my $schema_class = $self->schema_class;
910 my $blist = join(q{ }, @_);
911 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
912 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
915 # Create class with applicable bases, setup monikers, etc
916 sub _make_src_class {
917 my ($self, $table) = @_;
919 my $schema = $self->schema;
920 my $schema_class = $self->schema_class;
922 my $table_moniker = $self->_table2moniker($table);
923 my @result_namespace = ($schema_class);
924 if ($self->use_namespaces) {
925 my $result_namespace = $self->result_namespace || 'Result';
926 if ($result_namespace =~ /^\+(.*)/) {
927 # Fully qualified namespace
928 @result_namespace = ($1)
932 push @result_namespace, $result_namespace;
935 my $table_class = join(q{::}, @result_namespace, $table_moniker);
937 if (my $upgrading_v = $self->_upgrading_from) {
938 local $self->naming->{monikers} = $upgrading_v;
940 my $old_class = join(q{::}, @result_namespace,
941 $self->_table2moniker($table));
943 $self->_upgrading_classes->{$table_class} = $old_class;
946 my $table_normalized = lc $table;
947 $self->classes->{$table} = $table_class;
948 $self->classes->{$table_normalized} = $table_class;
949 $self->monikers->{$table} = $table_moniker;
950 $self->monikers->{$table_normalized} = $table_moniker;
952 $self->_use ($table_class, @{$self->additional_classes});
953 $self->_inject($table_class, @{$self->left_base_classes});
955 if (my @components = @{ $self->components }) {
956 $self->_dbic_stmt($table_class, 'load_components', @components);
959 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
960 if @{$self->resultset_components};
961 $self->_inject($table_class, @{$self->additional_base_classes});
964 # Set up metadata (cols, pks, etc)
965 sub _setup_src_meta {
966 my ($self, $table) = @_;
968 my $schema = $self->schema;
969 my $schema_class = $self->schema_class;
971 my $table_class = $self->classes->{$table};
972 my $table_moniker = $self->monikers->{$table};
974 my $table_name = $table;
975 my $name_sep = $self->schema->storage->sql_maker->name_sep;
977 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
978 $table_name = \ $self->_quote_table_name($table_name);
981 $self->_dbic_stmt($table_class,'table',$table_name);
983 my $cols = $self->_table_columns($table);
985 eval { $col_info = $self->_columns_info_for($table) };
987 $self->_dbic_stmt($table_class,'add_columns',@$cols);
990 if ($self->_is_case_sensitive) {
991 for my $col (keys %$col_info) {
992 $col_info->{$col}{accessor} = lc $col
996 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
999 my $fks = $self->_table_fk_info($table);
1001 for my $fkdef (@$fks) {
1002 for my $col (@{ $fkdef->{local_columns} }) {
1003 $col_info->{$col}{is_foreign_key} = 1;
1009 map { $_, ($col_info->{$_}||{}) } @$cols
1013 my %uniq_tag; # used to eliminate duplicate uniqs
1015 my $pks = $self->_table_pk_info($table) || [];
1016 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1017 : carp("$table has no primary key");
1018 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1020 my $uniqs = $self->_table_uniq_info($table) || [];
1022 my ($name, $cols) = @$_;
1023 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1024 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1031 Returns a sorted list of loaded tables, using the original database table
1039 return keys %{$self->_tables};
1042 # Make a moniker from a table
1043 sub _default_table2moniker {
1044 no warnings 'uninitialized';
1045 my ($self, $table) = @_;
1047 if ($self->naming->{monikers} eq 'v4') {
1048 return join '', map ucfirst, split /[\W_]+/, lc $table;
1051 return join '', map ucfirst, split /[\W_]+/,
1052 Lingua::EN::Inflect::Number::to_S(lc $table);
1055 sub _table2moniker {
1056 my ( $self, $table ) = @_;
1060 if( ref $self->moniker_map eq 'HASH' ) {
1061 $moniker = $self->moniker_map->{$table};
1063 elsif( ref $self->moniker_map eq 'CODE' ) {
1064 $moniker = $self->moniker_map->($table);
1067 $moniker ||= $self->_default_table2moniker($table);
1072 sub _load_relationships {
1073 my ($self, $table) = @_;
1075 my $tbl_fk_info = $self->_table_fk_info($table);
1076 foreach my $fkdef (@$tbl_fk_info) {
1077 $fkdef->{remote_source} =
1078 $self->monikers->{delete $fkdef->{remote_table}};
1080 my $tbl_uniq_info = $self->_table_uniq_info($table);
1082 my $local_moniker = $self->monikers->{$table};
1083 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1085 foreach my $src_class (sort keys %$rel_stmts) {
1086 my $src_stmts = $rel_stmts->{$src_class};
1087 foreach my $stmt (@$src_stmts) {
1088 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1093 # Overload these in driver class:
1095 # Returns an arrayref of column names
1096 sub _table_columns { croak "ABSTRACT METHOD" }
1098 # Returns arrayref of pk col names
1099 sub _table_pk_info { croak "ABSTRACT METHOD" }
1101 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1102 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1104 # Returns an arrayref of foreign key constraints, each
1105 # being a hashref with 3 keys:
1106 # local_columns (arrayref), remote_columns (arrayref), remote_table
1107 sub _table_fk_info { croak "ABSTRACT METHOD" }
1109 # Returns an array of lower case table names
1110 sub _tables_list { croak "ABSTRACT METHOD" }
1112 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1117 if ( $method eq 'table' ) {
1119 $self->_pod( $class, "=head1 NAME" );
1120 my $table_descr = $class;
1121 if ( $self->can('_table_comment') ) {
1122 my $comment = $self->_table_comment($table);
1123 $table_descr .= " - " . $comment if $comment;
1125 $self->{_class2table}{ $class } = $table;
1126 $self->_pod( $class, $table_descr );
1127 $self->_pod_cut( $class );
1128 } elsif ( $method eq 'add_columns' ) {
1129 $self->_pod( $class, "=head1 ACCESSORS" );
1134 $self->_pod( $class, '=head2 ' . $_ );
1136 $comment = $self->_column_comment( $self->{_class2table}{$class}, ($i - 1) / 2 + 1 ) if $self->can('_column_comment');
1137 $self->_pod( $class, $comment ) if $comment;
1139 $self->_pod_cut( $class );
1140 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1141 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1142 my ( $accessor, $rel_class ) = @_;
1143 $self->_pod( $class, "=head2 $accessor" );
1144 $self->_pod( $class, 'Type: ' . $method );
1145 $self->_pod( $class, "Related object: L<$rel_class>" );
1146 $self->_pod_cut( $class );
1147 $self->{_relations_started} { $class } = 1;
1149 my $args = dump(@_);
1150 $args = '(' . $args . ')' if @_ < 2;
1151 my $stmt = $method . $args . q{;};
1153 warn qq|$class\->$stmt\n| if $self->debug;
1154 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1158 # Stores a POD documentation
1160 my ($self, $class, $stmt) = @_;
1161 $self->_raw_stmt( $class, "\n" . $stmt );
1165 my ($self, $class ) = @_;
1166 $self->_raw_stmt( $class, "\n=cut\n" );
1170 # Store a raw source line for a class (for dumping purposes)
1172 my ($self, $class, $stmt) = @_;
1173 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1176 # Like above, but separately for the externally loaded stuff
1178 my ($self, $class, $stmt) = @_;
1179 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1182 sub _quote_table_name {
1183 my ($self, $table) = @_;
1185 my $qt = $self->schema->storage->sql_maker->quote_char;
1187 return $table unless $qt;
1190 return $qt->[0] . $table . $qt->[1];
1193 return $qt . $table . $qt;
1196 sub _is_case_sensitive { 0 }
1200 Returns a hashref of loaded table to moniker mappings. There will
1201 be two entries for each table, the original name and the "normalized"
1202 name, in the case that the two are different (such as databases
1203 that like uppercase table names, or preserve your original mixed-case
1204 definitions, or what-have-you).
1208 Returns a hashref of table to class mappings. In some cases it will
1209 contain multiple entries per table for the original and normalized table
1210 names, as above in L</monikers>.
1214 L<DBIx::Class::Schema::Loader>
1218 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1222 This library is free software; you can redistribute it and/or modify it under
1223 the same terms as Perl itself.