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//;
15 use Lingua::EN::Inflect::Phrase qw//;
18 use Class::Inspector ();
19 use Scalar::Util 'looks_like_number';
20 use File::Slurp 'slurp';
21 use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_without_redefine_warnings/;
22 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
27 our $VERSION = '0.07002';
29 __PACKAGE__->mk_group_ro_accessors('simple', qw/
36 additional_base_classes
51 default_resultset_class
55 overwrite_modifications
74 __PACKAGE__->mk_group_accessors('simple', qw/
76 schema_version_to_dump
78 _upgrading_from_load_classes
79 _downgrading_to_load_classes
80 _rewriting_result_namespace
85 pod_comment_spillover_length
91 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
95 See L<DBIx::Class::Schema::Loader>
99 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
100 classes, and implements the common functionality between them.
102 =head1 CONSTRUCTOR OPTIONS
104 These constructor options are the base options for
105 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
107 =head2 skip_relationships
109 Skip setting up relationships. The default is to attempt the loading
112 =head2 skip_load_external
114 Skip loading of other classes in @INC. The default is to merge all other classes
115 with the same name found in @INC into the schema file we are creating.
119 Static schemas (ones dumped to disk) will, by default, use the new-style
120 relationship names and singularized Results, unless you're overwriting an
121 existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
122 which case the backward compatible RelBuilder will be activated, and the
123 appropriate monikerization used.
129 will disable the backward-compatible RelBuilder and use
130 the new-style relationship names along with singularized Results, even when
131 overwriting a dump made with an earlier version.
133 The option also takes a hashref:
135 naming => { relationships => 'v7', monikers => 'v7' }
143 How to name relationship accessors.
147 How to name Result classes.
149 =item column_accessors
151 How to name column accessors in Result classes.
161 Latest style, whatever that happens to be.
165 Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
169 Monikers singularized as whole words, C<might_have> relationships for FKs on
170 C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
172 Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
177 All monikers and relationships are inflected using
178 L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
179 from relationship names.
181 In general, there is very little difference between v5 and v6 schemas.
185 This mode is identical to C<v6> mode, except that monikerization of CamelCase
186 table names is also done correctly.
188 CamelCase column names in case-preserving mode will also be handled correctly
189 for relationship name inflection. See L</preserve_case>.
191 In this mode, CamelCase L</column_accessors> are normalized based on case
192 transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
194 If you don't have any CamelCase table or column names, you can upgrade without
195 breaking any of your code.
199 Dynamic schemas will always default to the 0.04XXX relationship names and won't
200 singularize Results for backward compatibility, to activate the new RelBuilder
201 and singularization put this in your C<Schema.pm> file:
203 __PACKAGE__->naming('current');
205 Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
206 next major version upgrade:
208 __PACKAGE__->naming('v7');
212 By default POD will be generated for columns and relationships, using database
213 metadata for the text if available and supported.
215 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
216 supported for Postgres right now.
218 Set this to C<0> to turn off all POD generation.
220 =head2 pod_comment_mode
222 Controls where table comments appear in the generated POD. Smaller table
223 comments are appended to the C<NAME> section of the documentation, and larger
224 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
225 section to be generated with the comment always, only use C<NAME>, or choose
226 the length threshold at which the comment is forced into the description.
232 Use C<NAME> section only.
236 Force C<DESCRIPTION> always.
240 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
245 =head2 pod_comment_spillover_length
247 When pod_comment_mode is set to C<auto>, this is the length of the comment at
248 which it will be forced into a separate description section.
252 =head2 relationship_attrs
254 Hashref of attributes to pass to each generated relationship, listed
255 by type. Also supports relationship type 'all', containing options to
256 pass to all generated relationships. Attributes set for more specific
257 relationship types override those set in 'all'.
261 relationship_attrs => {
262 belongs_to => { is_deferrable => 0 },
265 use this to turn off DEFERRABLE on your foreign key constraints.
269 If set to true, each constructive L<DBIx::Class> statement the loader
270 decides to execute will be C<warn>-ed before execution.
274 Set the name of the schema to load (schema in the sense that your database
275 vendor means it). Does not currently support loading more than one schema
280 Only load tables matching regex. Best specified as a qr// regex.
284 Exclude tables matching regex. Best specified as a qr// regex.
288 Overrides the default table name to moniker translation. Can be either
289 a hashref of table keys and moniker values, or a coderef for a translator
290 function taking a single scalar table name argument and returning
291 a scalar moniker. If the hash entry does not exist, or the function
292 returns a false value, the code falls back to default behavior
295 The default behavior is to split on case transition and non-alphanumeric
296 boundaries, singularize the resulting phrase, then join the titlecased words
299 Table Name | Moniker Name
300 ---------------------------------
302 luser_group | LuserGroup
303 luser-opts | LuserOpt
304 stations_visited | StationVisited
305 routeChange | RouteChange
307 =head2 inflect_plural
309 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
310 if hash key does not exist or coderef returns false), but acts as a map
311 for pluralizing relationship names. The default behavior is to utilize
312 L<Lingua::EN::Inflect::Number/to_PL>.
314 =head2 inflect_singular
316 As L</inflect_plural> above, but for singularizing relationship names.
317 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
319 =head2 schema_base_class
321 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
323 =head2 result_base_class
325 Base class for your table classes (aka result classes). Defaults to
328 =head2 additional_base_classes
330 List of additional base classes all of your table classes will use.
332 =head2 left_base_classes
334 List of additional base classes all of your table classes will use
335 that need to be leftmost.
337 =head2 additional_classes
339 List of additional classes which all of your table classes will use.
343 List of additional components to be loaded into all of your table
344 classes. A good example would be
345 L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
347 =head2 resultset_components
349 List of additional ResultSet components to be loaded into your table
350 classes. A good example would be C<AlwaysRS>. Component
351 C<ResultSetManager> will be automatically added to the above
352 C<components> list if this option is set.
354 =head2 use_namespaces
356 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
359 Generate result class names suitable for
360 L<DBIx::Class::Schema/load_namespaces> and call that instead of
361 L<DBIx::Class::Schema/load_classes>. When using this option you can also
362 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
363 C<resultset_namespace>, C<default_resultset_class>), and they will be added
364 to the call (and the generated result class names adjusted appropriately).
366 =head2 dump_directory
368 This option is designed to be a tool to help you transition from this
369 loader to a manually-defined schema when you decide it's time to do so.
371 The value of this option is a perl libdir pathname. Within
372 that directory this module will create a baseline manual
373 L<DBIx::Class::Schema> module set, based on what it creates at runtime
376 The created schema class will have the same classname as the one on
377 which you are setting this option (and the ResultSource classes will be
378 based on this name as well).
380 Normally you wouldn't hard-code this setting in your schema class, as it
381 is meant for one-time manual usage.
383 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
384 recommended way to access this functionality.
386 =head2 dump_overwrite
388 Deprecated. See L</really_erase_my_files> below, which does *not* mean
389 the same thing as the old C<dump_overwrite> setting from previous releases.
391 =head2 really_erase_my_files
393 Default false. If true, Loader will unconditionally delete any existing
394 files before creating the new ones from scratch when dumping a schema to disk.
396 The default behavior is instead to only replace the top portion of the
397 file, up to and including the final stanza which contains
398 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
399 leaving any customizations you placed after that as they were.
401 When C<really_erase_my_files> is not set, if the output file already exists,
402 but the aforementioned final stanza is not found, or the checksum
403 contained there does not match the generated contents, Loader will
404 croak and not touch the file.
406 You should really be using version control on your schema classes (and all
407 of the rest of your code for that matter). Don't blame me if a bug in this
408 code wipes something out when it shouldn't have, you've been warned.
410 =head2 overwrite_modifications
412 Default false. If false, when updating existing files, Loader will
413 refuse to modify any Loader-generated code that has been modified
414 since its last run (as determined by the checksum Loader put in its
417 If true, Loader will discard any manual modifications that have been
418 made to Loader-generated code.
420 Again, you should be using version control on your schema classes. Be
421 careful with this option.
423 =head2 custom_column_info
425 Hook for adding extra attributes to the
426 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
428 Must be a coderef that returns a hashref with the extra attributes.
430 Receives the table name, column name and column_info.
434 custom_column_info => sub {
435 my ($table_name, $column_name, $column_info) = @_;
437 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
438 return { is_snoopy => 1 };
442 This attribute can also be used to set C<inflate_datetime> on a non-datetime
443 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
445 =head2 datetime_timezone
447 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
448 columns with the DATE/DATETIME/TIMESTAMP data_types.
450 =head2 datetime_locale
452 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
453 columns with the DATE/DATETIME/TIMESTAMP data_types.
457 File in Perl format, which should return a HASH reference, from which to read
462 Usually column names are lowercased, to make them easier to work with in
463 L<DBIx::Class>. This option lets you turn this behavior off, if the driver
466 Drivers for case sensitive databases like Sybase ASE or MSSQL with a
467 case-sensitive collation will turn this option on unconditionally.
469 Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
472 =head2 qualify_objects
474 Set to true to prepend the L</db_schema> to table names for C<<
475 __PACKAGE__->table >> calls, and to some other things like Oracle sequences.
479 Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and
480 L<namespace::autoclean>. The default content after the md5 sum also makes the
483 It is safe to upgrade your existing Schema to this option.
487 None of these methods are intended for direct invocation by regular
488 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
489 L<DBIx::Class::Schema::Loader>.
493 my $CURRENT_V = 'v7';
496 schema_base_class result_base_class additional_base_classes
497 left_base_classes additional_classes components resultset_components
500 # ensure that a peice of object data is a valid arrayref, creating
501 # an empty one or encapsulating whatever's there.
502 sub _ensure_arrayref {
507 $self->{$_} = [ $self->{$_} ]
508 unless ref $self->{$_} eq 'ARRAY';
514 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
515 by L<DBIx::Class::Schema::Loader>.
520 my ( $class, %args ) = @_;
522 my $self = { %args };
524 # don't lose undef options
525 for (values %$self) {
526 $_ = 0 unless defined $_;
529 bless $self => $class;
531 if (my $config_file = $self->config_file) {
532 my $config_opts = do $config_file;
534 croak "Error reading config from $config_file: $@" if $@;
536 croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH';
538 while (my ($k, $v) = each %$config_opts) {
539 $self->{$k} = $v unless exists $self->{$k};
543 $self->_ensure_arrayref(qw/additional_classes
544 additional_base_classes
550 $self->_validate_class_args;
552 if ($self->use_moose) {
553 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) {
554 die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
555 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose');
559 push(@{$self->{components}}, 'ResultSetManager')
560 if @{$self->{resultset_components}};
562 $self->{monikers} = {};
563 $self->{classes} = {};
564 $self->{_upgrading_classes} = {};
566 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
567 $self->{schema} ||= $self->{schema_class};
569 croak "dump_overwrite is deprecated. Please read the"
570 . " DBIx::Class::Schema::Loader::Base documentation"
571 if $self->{dump_overwrite};
573 $self->{dynamic} = ! $self->{dump_directory};
574 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
579 $self->{dump_directory} ||= $self->{temp_directory};
581 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
582 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
584 if ((not ref $self->naming) && defined $self->naming) {
585 my $naming_ver = $self->naming;
587 relationships => $naming_ver,
588 monikers => $naming_ver,
589 column_accessors => $naming_ver,
594 for (values %{ $self->naming }) {
595 $_ = $CURRENT_V if $_ eq 'current';
598 $self->{naming} ||= {};
600 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
601 croak 'custom_column_info must be a CODE ref';
604 $self->_check_back_compat;
606 $self->use_namespaces(1) unless defined $self->use_namespaces;
607 $self->generate_pod(1) unless defined $self->generate_pod;
608 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
609 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
614 sub _check_back_compat {
617 # dynamic schemas will always be in 0.04006 mode, unless overridden
618 if ($self->dynamic) {
619 # just in case, though no one is likely to dump a dynamic schema
620 $self->schema_version_to_dump('0.04006');
622 if (not %{ $self->naming }) {
623 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
625 Dynamic schema detected, will run in 0.04006 mode.
627 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
628 to disable this warning.
630 Also consider setting 'use_namespaces => 1' if/when upgrading.
632 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
637 $self->_upgrading_from('v4');
640 $self->naming->{relationships} ||= 'v4';
641 $self->naming->{monikers} ||= 'v4';
643 if ($self->use_namespaces) {
644 $self->_upgrading_from_load_classes(1);
647 $self->use_namespaces(0);
653 # otherwise check if we need backcompat mode for a static schema
654 my $filename = $self->_get_dump_filename($self->schema_class);
655 return unless -e $filename;
657 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) =
658 $self->_parse_generated_file($filename);
660 return unless $old_ver;
662 # determine if the existing schema was dumped with use_moose => 1
663 if (! defined $self->use_moose) {
664 $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm;
667 my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0;
668 my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' };
670 if ($load_classes && (not defined $self->use_namespaces)) {
671 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
673 'load_classes;' static schema detected, turning off 'use_namespaces'.
675 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
676 variable to disable this warning.
678 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
681 $self->use_namespaces(0);
683 elsif ($load_classes && $self->use_namespaces) {
684 $self->_upgrading_from_load_classes(1);
686 elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) {
687 $self->_downgrading_to_load_classes(
688 $result_namespace || 'Result'
691 elsif ((not defined $self->use_namespaces) || $self->use_namespaces) {
692 if (not $self->result_namespace) {
693 $self->result_namespace($result_namespace || 'Result');
695 elsif ($result_namespace ne $self->result_namespace) {
696 $self->_rewriting_result_namespace(
697 $result_namespace || 'Result'
702 # XXX when we go past .0 this will need fixing
703 my ($v) = $old_ver =~ /([1-9])/;
706 return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/);
708 if (not %{ $self->naming }) {
709 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
711 Version $old_ver static schema detected, turning on backcompat mode.
713 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
714 to disable this warning.
716 See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
718 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
719 from version 0.04006.
722 $self->naming->{relationships} ||= $v;
723 $self->naming->{monikers} ||= $v;
724 $self->naming->{column_accessors} ||= $v;
726 $self->schema_version_to_dump($old_ver);
729 $self->_upgrading_from($v);
733 sub _validate_class_args {
737 foreach my $k (@CLASS_ARGS) {
738 next unless $self->$k;
740 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
741 foreach my $c (@classes) {
742 # components default to being under the DBIx::Class namespace unless they
743 # are preceeded with a '+'
744 if ( $k =~ m/components$/ && $c !~ s/^\+// ) {
745 $c = 'DBIx::Class::' . $c;
748 # 1 == installed, 0 == not installed, undef == invalid classname
749 my $installed = Class::Inspector->installed($c);
750 if ( defined($installed) ) {
751 if ( $installed == 0 ) {
752 croak qq/$c, as specified in the loader option "$k", is not installed/;
755 croak qq/$c, as specified in the loader option "$k", is an invalid class name/;
761 sub _find_file_in_inc {
762 my ($self, $file) = @_;
764 foreach my $prefix (@INC) {
765 my $fullpath = File::Spec->catfile($prefix, $file);
766 return $fullpath if -f $fullpath
767 # abs_path throws on Windows for nonexistant files
768 and eval { Cwd::abs_path($fullpath) } ne
769 (eval { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) } || '');
776 my ($self, $class) = @_;
778 my $class_path = $class;
779 $class_path =~ s{::}{/}g;
780 $class_path .= '.pm';
785 sub _find_class_in_inc {
786 my ($self, $class) = @_;
788 return $self->_find_file_in_inc($self->_class_path($class));
794 return $self->_upgrading_from
795 || $self->_upgrading_from_load_classes
796 || $self->_downgrading_to_load_classes
797 || $self->_rewriting_result_namespace
801 sub _rewrite_old_classnames {
802 my ($self, $code) = @_;
804 return $code unless $self->_rewriting;
806 my %old_classes = reverse %{ $self->_upgrading_classes };
808 my $re = join '|', keys %old_classes;
811 $code =~ s/$re/$old_classes{$1} || $1/eg;
817 my ($self, $class) = @_;
819 return if $self->{skip_load_external};
821 # so that we don't load our own classes, under any circumstances
822 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
824 my $real_inc_path = $self->_find_class_in_inc($class);
826 my $old_class = $self->_upgrading_classes->{$class}
827 if $self->_rewriting;
829 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
830 if $old_class && $old_class ne $class;
832 return unless $real_inc_path || $old_real_inc_path;
834 if ($real_inc_path) {
835 # If we make it to here, we loaded an external definition
836 warn qq/# Loaded external class definition for '$class'\n/
839 open(my $fh, '<', $real_inc_path)
840 or croak "Failed to open '$real_inc_path' for reading: $!";
841 my $code = do { local $/; <$fh> };
843 or croak "Failed to close $real_inc_path: $!";
844 $code = $self->_rewrite_old_classnames($code);
846 if ($self->dynamic) { # load the class too
847 eval_without_redefine_warnings($code);
850 $self->_ext_stmt($class,
851 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
852 .qq|# They are now part of the custom portion of this file\n|
853 .qq|# for you to hand-edit. If you do not either delete\n|
854 .qq|# this section or remove that file from \@INC, this section\n|
855 .qq|# will be repeated redundantly when you re-create this\n|
856 .qq|# file again via Loader! See skip_load_external to disable\n|
857 .qq|# this feature.\n|
860 $self->_ext_stmt($class, $code);
861 $self->_ext_stmt($class,
862 qq|# End of lines loaded from '$real_inc_path' |
866 if ($old_real_inc_path) {
867 my $code = slurp $old_real_inc_path;
869 $self->_ext_stmt($class, <<"EOF");
871 # These lines were loaded from '$old_real_inc_path',
872 # based on the Result class name that would have been created by an older
873 # version of the Loader. For a static schema, this happens only once during
874 # upgrade. See skip_load_external to disable this feature.
877 $code = $self->_rewrite_old_classnames($code);
879 if ($self->dynamic) {
882 Detected external content in '$old_real_inc_path', a class name that would have
883 been used by an older version of the Loader.
885 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
886 new name of the Result.
888 eval_without_redefine_warnings($code);
892 $self->_ext_stmt($class, $code);
893 $self->_ext_stmt($class,
894 qq|# End of lines loaded from '$old_real_inc_path' |
901 Does the actual schema-construction work.
909 $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude })
917 Rescan the database for changes. Returns a list of the newly added table
920 The schema argument should be the schema class or object to be affected. It
921 should probably be derived from the original schema_class used during L</load>.
926 my ($self, $schema) = @_;
928 $self->{schema} = $schema;
929 $self->_relbuilder->{schema} = $schema;
932 my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude });
934 foreach my $table (@current) {
935 if(!exists $self->{_tables}->{$table}) {
936 push(@created, $table);
941 @current{@current} = ();
942 foreach my $table (keys %{ $self->{_tables} }) {
943 if (not exists $current{$table}) {
944 $self->_unregister_source_for_table($table);
948 delete $self->{_dump_storage};
949 delete $self->{_relations_started};
951 my $loaded = $self->_load_tables(@current);
953 return map { $self->monikers->{$_} } @created;
959 return if $self->{skip_relationships};
961 return $self->{relbuilder} ||= do {
963 no warnings 'uninitialized';
964 my $relbuilder_suff =
970 ->{ $self->naming->{relationships}};
972 my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff;
973 eval "require $relbuilder_class"; die $@ if $@;
974 $relbuilder_class->new( $self );
980 my ($self, @tables) = @_;
982 # Save the new tables to the tables list
984 $self->{_tables}->{$_} = 1;
987 $self->_make_src_class($_) for @tables;
989 # sanity-check for moniker clashes
990 my $inverse_moniker_idx;
991 for (keys %{$self->monikers}) {
992 push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_;
996 for (keys %$inverse_moniker_idx) {
997 my $tables = $inverse_moniker_idx->{$_};
999 push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'",
1000 join (', ', map { "'$_'" } @$tables),
1007 die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. '
1008 . 'Either change the naming style, or supply an explicit moniker_map: '
1009 . join ('; ', @clashes)
1015 $self->_setup_src_meta($_) for @tables;
1017 if(!$self->skip_relationships) {
1018 # The relationship loader needs a working schema
1020 local $self->{dump_directory} = $self->{temp_directory};
1021 $self->_reload_classes(\@tables);
1022 $self->_load_relationships($_) for @tables;
1025 # Remove that temp dir from INC so it doesn't get reloaded
1026 @INC = grep $_ ne $self->dump_directory, @INC;
1029 $self->_load_external($_)
1030 for map { $self->classes->{$_} } @tables;
1032 # Reload without unloading first to preserve any symbols from external
1034 $self->_reload_classes(\@tables, 0);
1036 # Drop temporary cache
1037 delete $self->{_cache};
1042 sub _reload_classes {
1043 my ($self, $tables, $unload) = @_;
1045 my @tables = @$tables;
1046 $unload = 1 unless defined $unload;
1048 # so that we don't repeat custom sections
1049 @INC = grep $_ ne $self->dump_directory, @INC;
1051 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
1053 unshift @INC, $self->dump_directory;
1056 my %have_source = map { $_ => $self->schema->source($_) }
1057 $self->schema->sources;
1059 for my $table (@tables) {
1060 my $moniker = $self->monikers->{$table};
1061 my $class = $self->classes->{$table};
1064 no warnings 'redefine';
1065 local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below
1068 if (my $mc = $self->_moose_metaclass($class)) {
1071 Class::Unload->unload($class) if $unload;
1072 my ($source, $resultset_class);
1074 ($source = $have_source{$moniker})
1075 && ($resultset_class = $source->resultset_class)
1076 && ($resultset_class ne 'DBIx::Class::ResultSet')
1078 my $has_file = Class::Inspector->loaded_filename($resultset_class);
1079 if (my $mc = $self->_moose_metaclass($resultset_class)) {
1082 Class::Unload->unload($resultset_class) if $unload;
1083 $self->_reload_class($resultset_class) if $has_file;
1085 $self->_reload_class($class);
1087 push @to_register, [$moniker, $class];
1090 Class::C3->reinitialize;
1091 for (@to_register) {
1092 $self->schema->register_class(@$_);
1096 sub _moose_metaclass {
1097 return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place
1099 my $mc = Class::MOP::class_of($_[1])
1102 return $mc->isa('Moose::Meta::Class') ? $mc : undef;
1105 # We use this instead of ensure_class_loaded when there are package symbols we
1108 my ($self, $class) = @_;
1110 my $class_path = $self->_class_path($class);
1111 delete $INC{ $class_path };
1113 # kill redefined warnings
1115 eval_without_redefine_warnings ("require $class");
1117 die "Failed to reload class $class: $@" if $@;
1120 sub _get_dump_filename {
1121 my ($self, $class) = (@_);
1123 $class =~ s{::}{/}g;
1124 return $self->dump_directory . q{/} . $class . q{.pm};
1127 sub _ensure_dump_subdirs {
1128 my ($self, $class) = (@_);
1130 my @name_parts = split(/::/, $class);
1131 pop @name_parts; # we don't care about the very last element,
1132 # which is a filename
1134 my $dir = $self->dump_directory;
1137 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1139 last if !@name_parts;
1140 $dir = File::Spec->catdir($dir, shift @name_parts);
1145 my ($self, @classes) = @_;
1147 my $schema_class = $self->schema_class;
1148 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1150 my $target_dir = $self->dump_directory;
1151 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1152 unless $self->{dynamic} or $self->{quiet};
1155 qq|package $schema_class;\n\n|
1156 . qq|# Created by DBIx::Class::Schema::Loader\n|
1157 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1158 . qq|use strict;\nuse warnings;\n\n|;
1159 if ($self->use_moose) {
1160 $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|;
1163 $schema_text .= qq|use base '$schema_base_class';\n\n|;
1166 if ($self->use_namespaces) {
1167 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1168 my $namespace_options;
1170 my @attr = qw/resultset_namespace default_resultset_class/;
1172 unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result';
1174 for my $attr (@attr) {
1176 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1179 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1180 $schema_text .= qq|;\n|;
1183 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1187 local $self->{version_to_dump} = $self->schema_version_to_dump;
1188 $self->_write_classfile($schema_class, $schema_text, 1);
1191 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1193 foreach my $src_class (@classes) {
1195 qq|package $src_class;\n\n|
1196 . qq|# Created by DBIx::Class::Schema::Loader\n|
1197 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1198 . qq|use strict;\nuse warnings;\n\n|;
1199 if ($self->use_moose) {
1200 $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|;
1202 # these options 'use base' which is compile time
1203 if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) {
1204 $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|;
1207 $src_text .= qq|\nextends '$result_base_class';\n\n|;
1211 $src_text .= qq|use base '$result_base_class';\n\n|;
1213 $self->_write_classfile($src_class, $src_text);
1216 # remove Result dir if downgrading from use_namespaces, and there are no
1218 if (my $result_ns = $self->_downgrading_to_load_classes
1219 || $self->_rewriting_result_namespace) {
1220 my $result_namespace = $self->_result_namespace(
1225 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1226 $result_dir = $self->dump_directory . '/' . $result_dir;
1228 unless (my @files = glob "$result_dir/*") {
1233 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1238 my ($self, $version, $ts) = @_;
1239 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1242 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1245 sub _write_classfile {
1246 my ($self, $class, $text, $is_schema) = @_;
1248 my $filename = $self->_get_dump_filename($class);
1249 $self->_ensure_dump_subdirs($class);
1251 if (-f $filename && $self->really_erase_my_files) {
1252 warn "Deleting existing file '$filename' due to "
1253 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1257 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom)
1258 = $self->_parse_generated_file($filename);
1260 if (! $old_gen && -f $filename) {
1261 croak "Cannot overwrite '$filename' without 'really_erase_my_files',"
1262 . " it does not appear to have been generated by Loader"
1265 my $custom_content = $old_custom || '';
1267 # prepend extra custom content from a *renamed* class (singularization effect)
1268 if (my $renamed_class = $self->_upgrading_classes->{$class}) {
1269 my $old_filename = $self->_get_dump_filename($renamed_class);
1271 if (-f $old_filename) {
1272 my $extra_custom = ($self->_parse_generated_file ($old_filename))[4];
1274 $extra_custom =~ s/\n\n# You can replace.*\n1;\n//;
1276 $custom_content = join ("\n", '', $extra_custom, $custom_content)
1279 unlink $old_filename;
1283 $custom_content ||= $self->_default_custom_content;
1285 # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
1286 # If there is already custom content, which does not have the Moose content, add it.
1287 if ($self->use_moose) {
1289 my $non_moose_custom_content = do {
1290 local $self->{use_moose} = 0;
1291 $self->_default_custom_content;
1294 if ($custom_content eq $non_moose_custom_content) {
1295 $custom_content = $self->_default_custom_content;
1297 elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) {
1298 $custom_content .= $self->_default_custom_content;
1301 elsif (defined $self->use_moose && $old_gen) {
1302 croak 'It is not possible to "downgrade" a schema that was loaded with use_moose => 1 to use_moose => 0, due to differing custom content'
1303 if $old_gen =~ /use \s+ MooseX?\b/x;
1306 $custom_content = $self->_rewrite_old_classnames($custom_content);
1309 for @{$self->{_dump_storage}->{$class} || []};
1311 # Check and see if the dump is infact differnt
1315 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1316 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1317 return unless $self->_upgrading_from && $is_schema;
1321 $text .= $self->_sig_comment(
1322 $self->version_to_dump,
1323 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1326 open(my $fh, '>', $filename)
1327 or croak "Cannot open '$filename' for writing: $!";
1329 # Write the top half and its MD5 sum
1330 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1332 # Write out anything loaded via external partial class file in @INC
1334 for @{$self->{_ext_storage}->{$class} || []};
1336 # Write out any custom content the user has added
1337 print $fh $custom_content;
1340 or croak "Error closing '$filename': $!";
1343 sub _default_moose_custom_content {
1344 return qq|\n__PACKAGE__->meta->make_immutable;|;
1347 sub _default_custom_content {
1349 my $default = qq|\n\n# You can replace this text with custom|
1350 . qq| content, and it will be preserved on regeneration|;
1351 if ($self->use_moose) {
1352 $default .= $self->_default_moose_custom_content;
1354 $default .= qq|\n1;\n|;
1358 sub _parse_generated_file {
1359 my ($self, $fn) = @_;
1361 return unless -f $fn;
1363 open(my $fh, '<', $fn)
1364 or croak "Cannot open '$fn' for reading: $!";
1367 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1369 my ($md5, $ts, $ver, $gen);
1375 # Pull out the version and timestamp from the line above
1376 ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m;
1379 croak "Checksum mismatch in '$fn', 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"
1380 if !$self->overwrite_modifications && Digest::MD5::md5_base64($gen) ne $md5;
1389 my $custom = do { local $/; <$fh> }
1394 return ($gen, $md5, $ver, $ts, $custom);
1402 warn "$target: use $_;" if $self->debug;
1403 $self->_raw_stmt($target, "use $_;");
1411 my $blist = join(q{ }, @_);
1413 return unless $blist;
1415 warn "$target: use base qw/$blist/;" if $self->debug;
1416 $self->_raw_stmt($target, "use base qw/$blist/;");
1419 sub _result_namespace {
1420 my ($self, $schema_class, $ns) = @_;
1421 my @result_namespace;
1423 if ($ns =~ /^\+(.*)/) {
1424 # Fully qualified namespace
1425 @result_namespace = ($1)
1428 # Relative namespace
1429 @result_namespace = ($schema_class, $ns);
1432 return wantarray ? @result_namespace : join '::', @result_namespace;
1435 # Create class with applicable bases, setup monikers, etc
1436 sub _make_src_class {
1437 my ($self, $table) = @_;
1439 my $schema = $self->schema;
1440 my $schema_class = $self->schema_class;
1442 my $table_moniker = $self->_table2moniker($table);
1443 my @result_namespace = ($schema_class);
1444 if ($self->use_namespaces) {
1445 my $result_namespace = $self->result_namespace || 'Result';
1446 @result_namespace = $self->_result_namespace(
1451 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1453 if ((my $upgrading_v = $self->_upgrading_from)
1454 || $self->_rewriting) {
1455 local $self->naming->{monikers} = $upgrading_v
1458 my @result_namespace = @result_namespace;
1459 if ($self->_upgrading_from_load_classes) {
1460 @result_namespace = ($schema_class);
1462 elsif (my $ns = $self->_downgrading_to_load_classes) {
1463 @result_namespace = $self->_result_namespace(
1468 elsif ($ns = $self->_rewriting_result_namespace) {
1469 @result_namespace = $self->_result_namespace(
1475 my $old_class = join(q{::}, @result_namespace,
1476 $self->_table2moniker($table));
1478 $self->_upgrading_classes->{$table_class} = $old_class
1479 unless $table_class eq $old_class;
1482 # this was a bad idea, should be ok now without it
1483 # my $table_normalized = lc $table;
1484 # $self->classes->{$table_normalized} = $table_class;
1485 # $self->monikers->{$table_normalized} = $table_moniker;
1487 $self->classes->{$table} = $table_class;
1488 $self->monikers->{$table} = $table_moniker;
1490 $self->_use ($table_class, @{$self->additional_classes});
1491 $self->_inject($table_class, @{$self->left_base_classes});
1493 if (my @components = @{ $self->components }) {
1494 $self->_dbic_stmt($table_class, 'load_components', @components);
1497 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1498 if @{$self->resultset_components};
1499 $self->_inject($table_class, @{$self->additional_base_classes});
1502 sub _resolve_col_accessor_collisions {
1503 my ($self, $col_info) = @_;
1505 my $base = $self->result_base_class || 'DBIx::Class::Core';
1506 my @components = map "DBIx::Class::$_", @{ $self->components || [] };
1510 for my $class ($base, @components, $self->use_moose ? 'Moose::Object' : ()) {
1511 eval "require ${class};";
1514 push @methods, @{ Class::Inspector->methods($class) || [] };
1518 @methods{@methods} = ();
1521 $methods{meta} = undef;
1523 while (my ($col, $info) = each %$col_info) {
1524 my $accessor = $info->{accessor} || $col;
1526 next if $accessor eq 'id'; # special case (very common column)
1528 if (exists $methods{$accessor}) {
1529 $info->{accessor} = undef;
1534 sub _make_column_accessor_name {
1535 my ($self, $column_name) = @_;
1537 return join '_', map lc, split_name $column_name;
1540 # Set up metadata (cols, pks, etc)
1541 sub _setup_src_meta {
1542 my ($self, $table) = @_;
1544 my $schema = $self->schema;
1545 my $schema_class = $self->schema_class;
1547 my $table_class = $self->classes->{$table};
1548 my $table_moniker = $self->monikers->{$table};
1550 my $table_name = $table;
1551 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1553 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1554 $table_name = \ $self->_quote_table_name($table_name);
1557 my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name);
1559 # be careful to not create refs Data::Dump can "optimize"
1560 $full_table_name = \do {"".$full_table_name} if ref $table_name;
1562 $self->_dbic_stmt($table_class, 'table', $full_table_name);
1564 my $cols = $self->_table_columns($table);
1565 my $col_info = $self->__columns_info_for($table);
1567 while (my ($col, $info) = each %$col_info) {
1569 ($info->{accessor} = $col) =~ s/\W+/_/g;
1573 if ($self->preserve_case) {
1574 while (my ($col, $info) = each %$col_info) {
1575 if ($col ne lc($col)) {
1576 if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) {
1577 $info->{accessor} = $self->_make_column_accessor_name($info->{accessor} || $col);
1580 $info->{accessor} = lc($info->{accessor} || $col);
1586 # XXX this needs to go away
1587 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1590 $self->_resolve_col_accessor_collisions($col_info);
1592 my $fks = $self->_table_fk_info($table);
1594 foreach my $fkdef (@$fks) {
1595 for my $col (@{ $fkdef->{local_columns} }) {
1596 $col_info->{$col}{is_foreign_key} = 1;
1600 my $pks = $self->_table_pk_info($table) || [];
1602 foreach my $pkcol (@$pks) {
1603 $col_info->{$pkcol}{is_nullable} = 0;
1609 map { $_, ($col_info->{$_}||{}) } @$cols
1612 my %uniq_tag; # used to eliminate duplicate uniqs
1614 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1615 : carp("$table has no primary key");
1616 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1618 my $uniqs = $self->_table_uniq_info($table) || [];
1620 my ($name, $cols) = @$_;
1621 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1622 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1627 sub __columns_info_for {
1628 my ($self, $table) = @_;
1630 my $result = $self->_columns_info_for($table);
1632 while (my ($col, $info) = each %$result) {
1633 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
1634 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
1636 $result->{$col} = $info;
1644 Returns a sorted list of loaded tables, using the original database table
1652 return keys %{$self->_tables};
1655 # Make a moniker from a table
1656 sub _default_table2moniker {
1657 no warnings 'uninitialized';
1658 my ($self, $table) = @_;
1660 if ($self->naming->{monikers} eq 'v4') {
1661 return join '', map ucfirst, split /[\W_]+/, lc $table;
1663 elsif ($self->naming->{monikers} eq 'v5') {
1664 return join '', map ucfirst, split /[\W_]+/,
1665 Lingua::EN::Inflect::Number::to_S(lc $table);
1667 elsif ($self->naming->{monikers} eq 'v6') {
1668 (my $as_phrase = lc $table) =~ s/_+/ /g;
1669 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1671 return join '', map ucfirst, split /\W+/, $inflected;
1674 my @words = map lc, split_name $table;
1675 my $as_phrase = join ' ', @words;
1677 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1679 return join '', map ucfirst, split /\W+/, $inflected;
1682 sub _table2moniker {
1683 my ( $self, $table ) = @_;
1687 if( ref $self->moniker_map eq 'HASH' ) {
1688 $moniker = $self->moniker_map->{$table};
1690 elsif( ref $self->moniker_map eq 'CODE' ) {
1691 $moniker = $self->moniker_map->($table);
1694 $moniker ||= $self->_default_table2moniker($table);
1699 sub _load_relationships {
1700 my ($self, $table) = @_;
1702 my $tbl_fk_info = $self->_table_fk_info($table);
1703 foreach my $fkdef (@$tbl_fk_info) {
1704 $fkdef->{remote_source} =
1705 $self->monikers->{delete $fkdef->{remote_table}};
1707 my $tbl_uniq_info = $self->_table_uniq_info($table);
1709 my $local_moniker = $self->monikers->{$table};
1710 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1712 foreach my $src_class (sort keys %$rel_stmts) {
1713 my $src_stmts = $rel_stmts->{$src_class};
1714 foreach my $stmt (@$src_stmts) {
1715 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1720 # Overload these in driver class:
1722 # Returns an arrayref of column names
1723 sub _table_columns { croak "ABSTRACT METHOD" }
1725 # Returns arrayref of pk col names
1726 sub _table_pk_info { croak "ABSTRACT METHOD" }
1728 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1729 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1731 # Returns an arrayref of foreign key constraints, each
1732 # being a hashref with 3 keys:
1733 # local_columns (arrayref), remote_columns (arrayref), remote_table
1734 sub _table_fk_info { croak "ABSTRACT METHOD" }
1736 # Returns an array of lower case table names
1737 sub _tables_list { croak "ABSTRACT METHOD" }
1739 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1745 # generate the pod for this statement, storing it with $self->_pod
1746 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
1748 my $args = dump(@_);
1749 $args = '(' . $args . ')' if @_ < 2;
1750 my $stmt = $method . $args . q{;};
1752 warn qq|$class\->$stmt\n| if $self->debug;
1753 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1757 # generates the accompanying pod for a DBIC class method statement,
1758 # storing it with $self->_pod
1764 if ( $method eq 'table' ) {
1766 my $pcm = $self->pod_comment_mode;
1767 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
1768 $comment = $self->__table_comment($table);
1769 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
1770 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
1771 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
1772 $self->_pod( $class, "=head1 NAME" );
1773 my $table_descr = $class;
1774 $table_descr .= " - " . $comment if $comment and $comment_in_name;
1775 $self->{_class2table}{ $class } = $table;
1776 $self->_pod( $class, $table_descr );
1777 if ($comment and $comment_in_desc) {
1778 $self->_pod( $class, "=head1 DESCRIPTION" );
1779 $self->_pod( $class, $comment );
1781 $self->_pod_cut( $class );
1782 } elsif ( $method eq 'add_columns' ) {
1783 $self->_pod( $class, "=head1 ACCESSORS" );
1784 my $col_counter = 0;
1786 while( my ($name,$attrs) = splice @cols,0,2 ) {
1788 $self->_pod( $class, '=head2 ' . $name );
1789 $self->_pod( $class,
1791 my $s = $attrs->{$_};
1792 $s = !defined $s ? 'undef' :
1793 length($s) == 0 ? '(empty string)' :
1794 ref($s) eq 'SCALAR' ? $$s :
1795 ref($s) ? dumper_squashed $s :
1796 looks_like_number($s) ? $s :
1801 } sort keys %$attrs,
1804 if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter)) {
1805 $self->_pod( $class, $comment );
1808 $self->_pod_cut( $class );
1809 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1810 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1811 my ( $accessor, $rel_class ) = @_;
1812 $self->_pod( $class, "=head2 $accessor" );
1813 $self->_pod( $class, 'Type: ' . $method );
1814 $self->_pod( $class, "Related object: L<$rel_class>" );
1815 $self->_pod_cut( $class );
1816 $self->{_relations_started} { $class } = 1;
1820 sub _filter_comment {
1821 my ($self, $txt) = @_;
1823 $txt = '' if not defined $txt;
1825 $txt =~ s/(?:\015?\012|\015\012?)/\n/g;
1830 sub __table_comment {
1833 if (my $code = $self->can('_table_comment')) {
1834 return $self->_filter_comment($self->$code(@_));
1840 sub __column_comment {
1843 if (my $code = $self->can('_column_comment')) {
1844 return $self->_filter_comment($self->$code(@_));
1850 # Stores a POD documentation
1852 my ($self, $class, $stmt) = @_;
1853 $self->_raw_stmt( $class, "\n" . $stmt );
1857 my ($self, $class ) = @_;
1858 $self->_raw_stmt( $class, "\n=cut\n" );
1861 # Store a raw source line for a class (for dumping purposes)
1863 my ($self, $class, $stmt) = @_;
1864 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1867 # Like above, but separately for the externally loaded stuff
1869 my ($self, $class, $stmt) = @_;
1870 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1873 sub _quote_table_name {
1874 my ($self, $table) = @_;
1876 my $qt = $self->schema->storage->sql_maker->quote_char;
1878 return $table unless $qt;
1881 return $qt->[0] . $table . $qt->[1];
1884 return $qt . $table . $qt;
1887 sub _custom_column_info {
1888 my ( $self, $table_name, $column_name, $column_info ) = @_;
1890 if (my $code = $self->custom_column_info) {
1891 return $code->($table_name, $column_name, $column_info) || {};
1896 sub _datetime_column_info {
1897 my ( $self, $table_name, $column_name, $column_info ) = @_;
1899 my $type = $column_info->{data_type} || '';
1900 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
1901 or ($type =~ /date|timestamp/i)) {
1902 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
1903 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
1909 my ($self, $name) = @_;
1911 return $self->preserve_case ? $name : lc($name);
1915 my ($self, $name) = @_;
1917 return $self->preserve_case ? $name : uc($name);
1920 sub _unregister_source_for_table {
1921 my ($self, $table) = @_;
1925 my $schema = $self->schema;
1926 # in older DBIC it's a private method
1927 my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
1928 $schema->$unregister($self->_table2moniker($table));
1929 delete $self->monikers->{$table};
1930 delete $self->classes->{$table};
1931 delete $self->_upgrading_classes->{$table};
1932 delete $self->{_tables}{$table};
1936 # remove the dump dir from @INC on destruction
1940 @INC = grep $_ ne $self->dump_directory, @INC;
1945 Returns a hashref of loaded table to moniker mappings. There will
1946 be two entries for each table, the original name and the "normalized"
1947 name, in the case that the two are different (such as databases
1948 that like uppercase table names, or preserve your original mixed-case
1949 definitions, or what-have-you).
1953 Returns a hashref of table to class mappings. In some cases it will
1954 contain multiple entries per table for the original and normalized table
1955 names, as above in L</monikers>.
1959 L<DBIx::Class::Schema::Loader>
1963 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1967 This library is free software; you can redistribute it and/or modify it under
1968 the same terms as Perl itself.
1973 # vim:et sts=4 sw=4 tw=0: