1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Grouped Class::C3::Componentised/;
6 use namespace::autoclean;
8 use Carp::Clan qw/^DBIx::Class/;
9 use DBIx::Class::Schema::Loader::RelBuilder;
10 use Data::Dump qw/ dump /;
15 use Lingua::EN::Inflect::Number qw//;
16 use Lingua::EN::Inflect::Phrase qw//;
19 use Class::Inspector ();
20 use Data::Dumper::Concise;
21 use Scalar::Util 'looks_like_number';
22 use File::Slurp 'slurp';
23 use DBIx::Class::Schema::Loader::Utils 'split_name';
26 our $VERSION = '0.07001';
28 __PACKAGE__->mk_group_ro_accessors('simple', qw/
35 additional_base_classes
50 default_resultset_class
54 overwrite_modifications
73 __PACKAGE__->mk_group_accessors('simple', qw/
75 schema_version_to_dump
77 _upgrading_from_load_classes
78 _downgrading_to_load_classes
79 _rewriting_result_namespace
84 pod_comment_spillover_length
90 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
94 See L<DBIx::Class::Schema::Loader>
98 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
99 classes, and implements the common functionality between them.
101 =head1 CONSTRUCTOR OPTIONS
103 These constructor options are the base options for
104 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
106 =head2 skip_relationships
108 Skip setting up relationships. The default is to attempt the loading
111 =head2 skip_load_external
113 Skip loading of other classes in @INC. The default is to merge all other classes
114 with the same name found in @INC into the schema file we are creating.
118 Static schemas (ones dumped to disk) will, by default, use the new-style
119 relationship names and singularized Results, unless you're overwriting an
120 existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
121 which case the backward compatible RelBuilder will be activated, and the
122 appropriate monikerization used.
128 will disable the backward-compatible RelBuilder and use
129 the new-style relationship names along with singularized Results, even when
130 overwriting a dump made with an earlier version.
132 The option also takes a hashref:
134 naming => { relationships => 'v7', monikers => 'v7' }
142 How to name relationship accessors.
146 How to name Result classes.
148 =item column_accessors
150 How to name column accessors in Result classes.
160 Latest style, whatever that happens to be.
164 Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
168 Monikers singularized as whole words, C<might_have> relationships for FKs on
169 C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
171 Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
176 All monikers and relationships are inflected using
177 L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
178 from relationship names.
180 In general, there is very little difference between v5 and v6 schemas.
184 This mode is identical to C<v6> mode, except that monikerization of CamelCase
185 table names is also done correctly.
187 CamelCase column names in case-preserving mode will also be handled correctly
188 for relationship name inflection. See L</preserve_case>.
190 In this mode, CamelCase L</column_accessors> are normalized based on case
191 transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
193 If you don't have any CamelCase table or column names, you can upgrade without
194 breaking any of your code.
198 Dynamic schemas will always default to the 0.04XXX relationship names and won't
199 singularize Results for backward compatibility, to activate the new RelBuilder
200 and singularization put this in your C<Schema.pm> file:
202 __PACKAGE__->naming('current');
204 Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
205 next major version upgrade:
207 __PACKAGE__->naming('v7');
211 By default POD will be generated for columns and relationships, using database
212 metadata for the text if available and supported.
214 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
215 supported for Postgres right now.
217 Set this to C<0> to turn off all POD generation.
219 =head2 pod_comment_mode
221 Controls where table comments appear in the generated POD. Smaller table
222 comments are appended to the C<NAME> section of the documentation, and larger
223 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
224 section to be generated with the comment always, only use C<NAME>, or choose
225 the length threshold at which the comment is forced into the description.
231 Use C<NAME> section only.
235 Force C<DESCRIPTION> always.
239 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
244 =head2 pod_comment_spillover_length
246 When pod_comment_mode is set to C<auto>, this is the length of the comment at
247 which it will be forced into a separate description section.
251 =head2 relationship_attrs
253 Hashref of attributes to pass to each generated relationship, listed
254 by type. Also supports relationship type 'all', containing options to
255 pass to all generated relationships. Attributes set for more specific
256 relationship types override those set in 'all'.
260 relationship_attrs => {
261 belongs_to => { is_deferrable => 1 },
264 use this to make your foreign key constraints DEFERRABLE.
268 If set to true, each constructive L<DBIx::Class> statement the loader
269 decides to execute will be C<warn>-ed before execution.
273 Set the name of the schema to load (schema in the sense that your database
274 vendor means it). Does not currently support loading more than one schema
279 Only load tables matching regex. Best specified as a qr// regex.
283 Exclude tables matching regex. Best specified as a qr// regex.
287 Overrides the default table name to moniker translation. Can be either
288 a hashref of table keys and moniker values, or a coderef for a translator
289 function taking a single scalar table name argument and returning
290 a scalar moniker. If the hash entry does not exist, or the function
291 returns a false value, the code falls back to default behavior
294 The default behavior is to split on case transition and non-alphanumeric
295 boundaries, singularize the resulting phrase, then join the titlecased words
298 Table Name | Moniker Name
299 ---------------------------------
301 luser_group | LuserGroup
302 luser-opts | LuserOpt
303 stations_visited | StationVisited
304 routeChange | RouteChange
306 =head2 inflect_plural
308 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
309 if hash key does not exist or coderef returns false), but acts as a map
310 for pluralizing relationship names. The default behavior is to utilize
311 L<Lingua::EN::Inflect::Number/to_PL>.
313 =head2 inflect_singular
315 As L</inflect_plural> above, but for singularizing relationship names.
316 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
318 =head2 schema_base_class
320 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
322 =head2 result_base_class
324 Base class for your table classes (aka result classes). Defaults to
327 =head2 additional_base_classes
329 List of additional base classes all of your table classes will use.
331 =head2 left_base_classes
333 List of additional base classes all of your table classes will use
334 that need to be leftmost.
336 =head2 additional_classes
338 List of additional classes which all of your table classes will use.
342 List of additional components to be loaded into all of your table
343 classes. A good example would be
344 L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
346 =head2 resultset_components
348 List of additional ResultSet components to be loaded into your table
349 classes. A good example would be C<AlwaysRS>. Component
350 C<ResultSetManager> will be automatically added to the above
351 C<components> list if this option is set.
353 =head2 use_namespaces
355 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
358 Generate result class names suitable for
359 L<DBIx::Class::Schema/load_namespaces> and call that instead of
360 L<DBIx::Class::Schema/load_classes>. When using this option you can also
361 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
362 C<resultset_namespace>, C<default_resultset_class>), and they will be added
363 to the call (and the generated result class names adjusted appropriately).
365 =head2 dump_directory
367 This option is designed to be a tool to help you transition from this
368 loader to a manually-defined schema when you decide it's time to do so.
370 The value of this option is a perl libdir pathname. Within
371 that directory this module will create a baseline manual
372 L<DBIx::Class::Schema> module set, based on what it creates at runtime
375 The created schema class will have the same classname as the one on
376 which you are setting this option (and the ResultSource classes will be
377 based on this name as well).
379 Normally you wouldn't hard-code this setting in your schema class, as it
380 is meant for one-time manual usage.
382 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
383 recommended way to access this functionality.
385 =head2 dump_overwrite
387 Deprecated. See L</really_erase_my_files> below, which does *not* mean
388 the same thing as the old C<dump_overwrite> setting from previous releases.
390 =head2 really_erase_my_files
392 Default false. If true, Loader will unconditionally delete any existing
393 files before creating the new ones from scratch when dumping a schema to disk.
395 The default behavior is instead to only replace the top portion of the
396 file, up to and including the final stanza which contains
397 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
398 leaving any customizations you placed after that as they were.
400 When C<really_erase_my_files> is not set, if the output file already exists,
401 but the aforementioned final stanza is not found, or the checksum
402 contained there does not match the generated contents, Loader will
403 croak and not touch the file.
405 You should really be using version control on your schema classes (and all
406 of the rest of your code for that matter). Don't blame me if a bug in this
407 code wipes something out when it shouldn't have, you've been warned.
409 =head2 overwrite_modifications
411 Default false. If false, when updating existing files, Loader will
412 refuse to modify any Loader-generated code that has been modified
413 since its last run (as determined by the checksum Loader put in its
416 If true, Loader will discard any manual modifications that have been
417 made to Loader-generated code.
419 Again, you should be using version control on your schema classes. Be
420 careful with this option.
422 =head2 custom_column_info
424 Hook for adding extra attributes to the
425 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
427 Must be a coderef that returns a hashref with the extra attributes.
429 Receives the table name, column name and column_info.
433 custom_column_info => sub {
434 my ($table_name, $column_name, $column_info) = @_;
436 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
437 return { is_snoopy => 1 };
441 This attribute can also be used to set C<inflate_datetime> on a non-datetime
442 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
444 =head2 datetime_timezone
446 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
447 columns with the DATE/DATETIME/TIMESTAMP data_types.
449 =head2 datetime_locale
451 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
452 columns with the DATE/DATETIME/TIMESTAMP data_types.
456 File in Perl format, which should return a HASH reference, from which to read
461 Usually column names are lowercased, to make them easier to work with in
462 L<DBIx::Class>. This option lets you turn this behavior off, if the driver
465 Drivers for case sensitive databases like Sybase ASE or MSSQL with a
466 case-sensitive collation will turn this option on unconditionally.
468 Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
471 =head2 qualify_objects
473 Set to true to prepend the L</db_schema> to table names for C<<
474 __PACKAGE__->table >> calls, and to some other things like Oracle sequences.
478 None of these methods are intended for direct invocation by regular
479 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
480 L<DBIx::Class::Schema::Loader>.
484 my $CURRENT_V = 'v7';
487 schema_base_class result_base_class additional_base_classes
488 left_base_classes additional_classes components resultset_components
491 # ensure that a peice of object data is a valid arrayref, creating
492 # an empty one or encapsulating whatever's there.
493 sub _ensure_arrayref {
498 $self->{$_} = [ $self->{$_} ]
499 unless ref $self->{$_} eq 'ARRAY';
505 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
506 by L<DBIx::Class::Schema::Loader>.
511 my ( $class, %args ) = @_;
513 my $self = { %args };
515 bless $self => $class;
517 if (my $config_file = $self->config_file) {
518 my $config_opts = do $config_file;
520 croak "Error reading config from $config_file: $@" if $@;
522 croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH';
524 while (my ($k, $v) = each %$config_opts) {
525 $self->{$k} = $v unless exists $self->{$k};
529 $self->_ensure_arrayref(qw/additional_classes
530 additional_base_classes
536 $self->_validate_class_args;
538 if ($self->use_moose) {
540 package __DBICSL__DUMMY;
542 use MooseX::NonMoose;
543 use namespace::autoclean;
546 die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
547 "Moose, MooseX::NonMoose and namespace::autoclean";
551 push(@{$self->{components}}, 'ResultSetManager')
552 if @{$self->{resultset_components}};
554 $self->{monikers} = {};
555 $self->{classes} = {};
556 $self->{_upgrading_classes} = {};
558 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
559 $self->{schema} ||= $self->{schema_class};
561 croak "dump_overwrite is deprecated. Please read the"
562 . " DBIx::Class::Schema::Loader::Base documentation"
563 if $self->{dump_overwrite};
565 $self->{dynamic} = ! $self->{dump_directory};
566 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
571 $self->{dump_directory} ||= $self->{temp_directory};
573 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
574 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
576 if ((not ref $self->naming) && defined $self->naming) {
577 my $naming_ver = $self->naming;
579 relationships => $naming_ver,
580 monikers => $naming_ver,
581 column_accessors => $naming_ver,
586 for (values %{ $self->naming }) {
587 $_ = $CURRENT_V if $_ eq 'current';
590 $self->{naming} ||= {};
592 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
593 croak 'custom_column_info must be a CODE ref';
596 $self->_check_back_compat;
598 $self->use_namespaces(1) unless defined $self->use_namespaces;
599 $self->generate_pod(1) unless defined $self->generate_pod;
600 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
601 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
606 sub _check_back_compat {
609 # dynamic schemas will always be in 0.04006 mode, unless overridden
610 if ($self->dynamic) {
611 # just in case, though no one is likely to dump a dynamic schema
612 $self->schema_version_to_dump('0.04006');
614 if (not %{ $self->naming }) {
615 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
617 Dynamic schema detected, will run in 0.04006 mode.
619 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
620 to disable this warning.
622 Also consider setting 'use_namespaces => 1' if/when upgrading.
624 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
629 $self->_upgrading_from('v4');
632 $self->naming->{relationships} ||= 'v4';
633 $self->naming->{monikers} ||= 'v4';
635 if ($self->use_namespaces) {
636 $self->_upgrading_from_load_classes(1);
639 $self->use_namespaces(0);
645 # otherwise check if we need backcompat mode for a static schema
646 my $filename = $self->_get_dump_filename($self->schema_class);
647 return unless -e $filename;
649 open(my $fh, '<', $filename)
650 or croak "Cannot open '$filename' for reading: $!";
652 my $load_classes = 0;
653 my $result_namespace = '';
656 if (/^__PACKAGE__->load_classes;/) {
658 } elsif (/result_namespace => '([^']+)'/) {
659 $result_namespace = $1;
660 } elsif (my ($real_ver) =
661 /^# Created by DBIx::Class::Schema::Loader v(\d+\.\d+)/) {
663 if ($load_classes && (not defined $self->use_namespaces)) {
664 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
666 'load_classes;' static schema detected, turning off 'use_namespaces'.
668 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
669 variable to disable this warning.
671 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
674 $self->use_namespaces(0);
676 elsif ($load_classes && $self->use_namespaces) {
677 $self->_upgrading_from_load_classes(1);
679 elsif ((not $load_classes) && defined $self->use_namespaces
680 && (not $self->use_namespaces)) {
681 $self->_downgrading_to_load_classes(
682 $result_namespace || 'Result'
685 elsif ((not defined $self->use_namespaces)
686 || $self->use_namespaces) {
687 if (not $self->result_namespace) {
688 $self->result_namespace($result_namespace || 'Result');
690 elsif ($result_namespace ne $self->result_namespace) {
691 $self->_rewriting_result_namespace(
692 $result_namespace || 'Result'
697 # XXX when we go past .0 this will need fixing
698 my ($v) = $real_ver =~ /([1-9])/;
701 last if $v eq $CURRENT_V || $real_ver =~ /^0\.\d\d999/;
703 if (not %{ $self->naming }) {
704 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
706 Version $real_ver static schema detected, turning on backcompat mode.
708 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
709 to disable this warning.
711 See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
713 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
714 from version 0.04006.
718 $self->_upgrading_from($v);
722 $self->naming->{relationships} ||= $v;
723 $self->naming->{monikers} ||= $v;
724 $self->naming->{column_accessors} ||= $v;
726 $self->schema_version_to_dump($real_ver);
734 sub _validate_class_args {
738 foreach my $k (@CLASS_ARGS) {
739 next unless $self->$k;
741 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
742 foreach my $c (@classes) {
743 # components default to being under the DBIx::Class namespace unless they
744 # are preceeded with a '+'
745 if ( $k =~ m/components$/ && $c !~ s/^\+// ) {
746 $c = 'DBIx::Class::' . $c;
749 # 1 == installed, 0 == not installed, undef == invalid classname
750 my $installed = Class::Inspector->installed($c);
751 if ( defined($installed) ) {
752 if ( $installed == 0 ) {
753 croak qq/$c, as specified in the loader option "$k", is not installed/;
756 croak qq/$c, as specified in the loader option "$k", is an invalid class name/;
762 sub _find_file_in_inc {
763 my ($self, $file) = @_;
765 foreach my $prefix (@INC) {
766 my $fullpath = File::Spec->catfile($prefix, $file);
767 return $fullpath if -f $fullpath
768 # abs_path throws on Windows for nonexistant files
769 and eval { Cwd::abs_path($fullpath) } ne
770 (eval { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) } || '');
777 my ($self, $class) = @_;
779 my $class_path = $class;
780 $class_path =~ s{::}{/}g;
781 $class_path .= '.pm';
786 sub _find_class_in_inc {
787 my ($self, $class) = @_;
789 return $self->_find_file_in_inc($self->_class_path($class));
795 return $self->_upgrading_from
796 || $self->_upgrading_from_load_classes
797 || $self->_downgrading_to_load_classes
798 || $self->_rewriting_result_namespace
802 sub _rewrite_old_classnames {
803 my ($self, $code) = @_;
805 return $code unless $self->_rewriting;
807 my %old_classes = reverse %{ $self->_upgrading_classes };
809 my $re = join '|', keys %old_classes;
812 $code =~ s/$re/$old_classes{$1} || $1/eg;
818 my ($self, $class) = @_;
820 return if $self->{skip_load_external};
822 # so that we don't load our own classes, under any circumstances
823 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
825 my $real_inc_path = $self->_find_class_in_inc($class);
827 my $old_class = $self->_upgrading_classes->{$class}
828 if $self->_rewriting;
830 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
831 if $old_class && $old_class ne $class;
833 return unless $real_inc_path || $old_real_inc_path;
835 if ($real_inc_path) {
836 # If we make it to here, we loaded an external definition
837 warn qq/# Loaded external class definition for '$class'\n/
840 open(my $fh, '<', $real_inc_path)
841 or croak "Failed to open '$real_inc_path' for reading: $!";
842 my $code = do { local $/; <$fh> };
844 or croak "Failed to close $real_inc_path: $!";
845 $code = $self->_rewrite_old_classnames($code);
847 if ($self->dynamic) { # load the class too
848 # kill redefined warnings
849 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
850 local $SIG{__WARN__} = sub {
852 unless $_[0] =~ /^Subroutine \S+ redefined/;
858 $self->_ext_stmt($class,
859 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
860 .qq|# They are now part of the custom portion of this file\n|
861 .qq|# for you to hand-edit. If you do not either delete\n|
862 .qq|# this section or remove that file from \@INC, this section\n|
863 .qq|# will be repeated redundantly when you re-create this\n|
864 .qq|# file again via Loader! See skip_load_external to disable\n|
865 .qq|# this feature.\n|
868 $self->_ext_stmt($class, $code);
869 $self->_ext_stmt($class,
870 qq|# End of lines loaded from '$real_inc_path' |
874 if ($old_real_inc_path) {
875 my $code = slurp $old_real_inc_path;
877 $self->_ext_stmt($class, <<"EOF");
879 # These lines were loaded from '$old_real_inc_path',
880 # based on the Result class name that would have been created by an older
881 # version of the Loader. For a static schema, this happens only once during
882 # upgrade. See skip_load_external to disable this feature.
885 $code = $self->_rewrite_old_classnames($code);
887 if ($self->dynamic) {
890 Detected external content in '$old_real_inc_path', a class name that would have
891 been used by an older version of the Loader.
893 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
894 new name of the Result.
896 # kill redefined warnings
897 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
898 local $SIG{__WARN__} = sub {
900 unless $_[0] =~ /^Subroutine \S+ redefined/;
907 $self->_ext_stmt($class, $code);
908 $self->_ext_stmt($class,
909 qq|# End of lines loaded from '$old_real_inc_path' |
916 Does the actual schema-construction work.
924 $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude })
932 Rescan the database for changes. Returns a list of the newly added table
935 The schema argument should be the schema class or object to be affected. It
936 should probably be derived from the original schema_class used during L</load>.
941 my ($self, $schema) = @_;
943 $self->{schema} = $schema;
944 $self->_relbuilder->{schema} = $schema;
947 my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude });
949 foreach my $table (@current) {
950 if(!exists $self->{_tables}->{$table}) {
951 push(@created, $table);
956 @current{@current} = ();
957 foreach my $table (keys %{ $self->{_tables} }) {
958 if (not exists $current{$table}) {
959 $self->_unregister_source_for_table($table);
963 delete $self->{_dump_storage};
964 delete $self->{_relations_started};
966 my $loaded = $self->_load_tables(@current);
968 return map { $self->monikers->{$_} } @created;
972 no warnings 'uninitialized';
975 return if $self->{skip_relationships};
977 if ($self->naming->{relationships} eq 'v4') {
978 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040;
979 return $self->{relbuilder} ||=
980 DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_040->new(
982 $self->inflect_plural,
983 $self->inflect_singular,
984 $self->relationship_attrs,
987 elsif ($self->naming->{relationships} eq 'v5') {
988 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05;
989 return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_05->new (
991 $self->inflect_plural,
992 $self->inflect_singular,
993 $self->relationship_attrs,
996 elsif ($self->naming->{relationships} eq 'v6') {
997 require DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06;
998 return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder::Compat::v0_06->new (
1000 $self->inflect_plural,
1001 $self->inflect_singular,
1002 $self->relationship_attrs,
1006 return $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new (
1008 $self->inflect_plural,
1009 $self->inflect_singular,
1010 $self->relationship_attrs,
1015 my ($self, @tables) = @_;
1017 # Save the new tables to the tables list
1019 $self->{_tables}->{$_} = 1;
1022 $self->_make_src_class($_) for @tables;
1024 # sanity-check for moniker clashes
1025 my $inverse_moniker_idx;
1026 for (keys %{$self->monikers}) {
1027 push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_;
1031 for (keys %$inverse_moniker_idx) {
1032 my $tables = $inverse_moniker_idx->{$_};
1034 push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'",
1035 join (', ', map { "'$_'" } @$tables),
1042 die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. '
1043 . 'Either change the naming style, or supply an explicit moniker_map: '
1044 . join ('; ', @clashes)
1050 $self->_setup_src_meta($_) for @tables;
1052 if(!$self->skip_relationships) {
1053 # The relationship loader needs a working schema
1055 local $self->{dump_directory} = $self->{temp_directory};
1056 $self->_reload_classes(\@tables);
1057 $self->_load_relationships($_) for @tables;
1060 # Remove that temp dir from INC so it doesn't get reloaded
1061 @INC = grep $_ ne $self->dump_directory, @INC;
1064 $self->_load_external($_)
1065 for map { $self->classes->{$_} } @tables;
1067 # Reload without unloading first to preserve any symbols from external
1069 $self->_reload_classes(\@tables, 0);
1071 # Drop temporary cache
1072 delete $self->{_cache};
1077 sub _reload_classes {
1078 my ($self, $tables, $unload) = @_;
1080 my @tables = @$tables;
1081 $unload = 1 unless defined $unload;
1083 # so that we don't repeat custom sections
1084 @INC = grep $_ ne $self->dump_directory, @INC;
1086 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
1088 unshift @INC, $self->dump_directory;
1091 my %have_source = map { $_ => $self->schema->source($_) }
1092 $self->schema->sources;
1094 for my $table (@tables) {
1095 my $moniker = $self->monikers->{$table};
1096 my $class = $self->classes->{$table};
1099 no warnings 'redefine';
1100 local *Class::C3::reinitialize = sub {};
1103 if ($class->can('meta')) {
1104 $class->meta->make_mutable;
1106 Class::Unload->unload($class) if $unload;
1107 my ($source, $resultset_class);
1109 ($source = $have_source{$moniker})
1110 && ($resultset_class = $source->resultset_class)
1111 && ($resultset_class ne 'DBIx::Class::ResultSet')
1113 my $has_file = Class::Inspector->loaded_filename($resultset_class);
1114 if ($resultset_class->can('meta')) {
1115 $resultset_class->meta->make_mutable;
1117 Class::Unload->unload($resultset_class) if $unload;
1118 $self->_reload_class($resultset_class) if $has_file;
1120 $self->_reload_class($class);
1122 push @to_register, [$moniker, $class];
1125 Class::C3->reinitialize;
1126 for (@to_register) {
1127 $self->schema->register_class(@$_);
1131 # We use this instead of ensure_class_loaded when there are package symbols we
1134 my ($self, $class) = @_;
1136 my $class_path = $self->_class_path($class);
1137 delete $INC{ $class_path };
1139 # kill redefined warnings
1140 my $warn_handler = $SIG{__WARN__} || sub { warn @_ };
1141 local $SIG{__WARN__} = sub {
1143 unless $_[0] =~ /^Subroutine \S+ redefined/;
1145 eval "require $class;";
1146 die "Failed to reload class $class: $@" if $@;
1149 sub _get_dump_filename {
1150 my ($self, $class) = (@_);
1152 $class =~ s{::}{/}g;
1153 return $self->dump_directory . q{/} . $class . q{.pm};
1156 sub _ensure_dump_subdirs {
1157 my ($self, $class) = (@_);
1159 my @name_parts = split(/::/, $class);
1160 pop @name_parts; # we don't care about the very last element,
1161 # which is a filename
1163 my $dir = $self->dump_directory;
1166 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1168 last if !@name_parts;
1169 $dir = File::Spec->catdir($dir, shift @name_parts);
1174 my ($self, @classes) = @_;
1176 my $schema_class = $self->schema_class;
1177 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1179 my $target_dir = $self->dump_directory;
1180 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1181 unless $self->{dynamic} or $self->{quiet};
1184 qq|package $schema_class;\n\n|
1185 . qq|# Created by DBIx::Class::Schema::Loader\n|
1186 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1187 . qq|use strict;\nuse warnings;\n\n|;
1188 if ($self->use_moose) {
1189 $schema_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|;
1192 $schema_text .= qq|use base '$schema_base_class';\n\n|;
1195 if ($self->use_namespaces) {
1196 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1197 my $namespace_options;
1199 my @attr = qw/resultset_namespace default_resultset_class/;
1201 unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result';
1203 for my $attr (@attr) {
1205 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1208 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1209 $schema_text .= qq|;\n|;
1212 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1216 local $self->{version_to_dump} = $self->schema_version_to_dump;
1217 $self->_write_classfile($schema_class, $schema_text, 1);
1220 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1222 foreach my $src_class (@classes) {
1224 qq|package $src_class;\n\n|
1225 . qq|# Created by DBIx::Class::Schema::Loader\n|
1226 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1227 . qq|use strict;\nuse warnings;\n\n|;
1228 if ($self->use_moose) {
1229 $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;\nextends '$result_base_class';\n\n|;
1232 $src_text .= qq|use base '$result_base_class';\n\n|;
1234 $self->_write_classfile($src_class, $src_text);
1237 # remove Result dir if downgrading from use_namespaces, and there are no
1239 if (my $result_ns = $self->_downgrading_to_load_classes
1240 || $self->_rewriting_result_namespace) {
1241 my $result_namespace = $self->_result_namespace(
1246 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1247 $result_dir = $self->dump_directory . '/' . $result_dir;
1249 unless (my @files = glob "$result_dir/*") {
1254 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1259 my ($self, $version, $ts) = @_;
1260 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1263 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1266 sub _write_classfile {
1267 my ($self, $class, $text, $is_schema) = @_;
1269 my $filename = $self->_get_dump_filename($class);
1270 $self->_ensure_dump_subdirs($class);
1272 if (-f $filename && $self->really_erase_my_files) {
1273 warn "Deleting existing file '$filename' due to "
1274 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1278 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
1280 # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
1281 # If there is already custom content, which does not have the Moose content, add it.
1282 if ($self->use_moose) {
1283 local $self->{use_moose} = 0;
1285 if ($custom_content eq $self->_default_custom_content) {
1286 local $self->{use_moose} = 1;
1288 $custom_content = $self->_default_custom_content;
1291 local $self->{use_moose} = 1;
1293 if ($custom_content !~ /\Q@{[$self->_default_moose_custom_content]}\E/) {
1294 $custom_content .= $self->_default_custom_content;
1299 if (my $old_class = $self->_upgrading_classes->{$class}) {
1300 my $old_filename = $self->_get_dump_filename($old_class);
1302 my ($old_custom_content) = $self->_get_custom_content(
1303 $old_class, $old_filename, 0 # do not add default comment
1306 $old_custom_content =~ s/\n\n# You can replace.*\n1;\n//;
1308 if ($old_custom_content) {
1310 "\n" . $old_custom_content . "\n" . $custom_content;
1313 unlink $old_filename;
1316 $custom_content = $self->_rewrite_old_classnames($custom_content);
1319 for @{$self->{_dump_storage}->{$class} || []};
1321 # Check and see if the dump is infact differnt
1325 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1328 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1329 return unless $self->_upgrading_from && $is_schema;
1333 $text .= $self->_sig_comment(
1334 $self->version_to_dump,
1335 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1338 open(my $fh, '>', $filename)
1339 or croak "Cannot open '$filename' for writing: $!";
1341 # Write the top half and its MD5 sum
1342 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1344 # Write out anything loaded via external partial class file in @INC
1346 for @{$self->{_ext_storage}->{$class} || []};
1348 # Write out any custom content the user has added
1349 print $fh $custom_content;
1352 or croak "Error closing '$filename': $!";
1355 sub _default_moose_custom_content {
1356 return qq|\n__PACKAGE__->meta->make_immutable;|;
1359 sub _default_custom_content {
1361 my $default = qq|\n\n# You can replace this text with custom|
1362 . qq| content, and it will be preserved on regeneration|;
1363 if ($self->use_moose) {
1364 $default .= $self->_default_moose_custom_content;
1366 $default .= qq|\n1;\n|;
1370 sub _get_custom_content {
1371 my ($self, $class, $filename, $add_default) = @_;
1373 $add_default = 1 unless defined $add_default;
1375 return ($self->_default_custom_content) if ! -f $filename;
1377 open(my $fh, '<', $filename)
1378 or croak "Cannot open '$filename' for reading: $!";
1381 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1384 my ($md5, $ts, $ver);
1386 if(!$md5 && /$mark_re/) {
1390 # Pull out the previous version and timestamp
1391 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
1394 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"
1395 if !$self->overwrite_modifications && Digest::MD5::md5_base64($buffer) ne $md5;
1404 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
1405 . " it does not appear to have been generated by Loader"
1408 # Default custom content:
1409 $buffer ||= $self->_default_custom_content if $add_default;
1411 return ($buffer, $md5, $ver, $ts);
1419 warn "$target: use $_;" if $self->debug;
1420 $self->_raw_stmt($target, "use $_;");
1427 my $schema_class = $self->schema_class;
1429 my $blist = join(q{ }, @_);
1430 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
1431 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
1434 sub _result_namespace {
1435 my ($self, $schema_class, $ns) = @_;
1436 my @result_namespace;
1438 if ($ns =~ /^\+(.*)/) {
1439 # Fully qualified namespace
1440 @result_namespace = ($1)
1443 # Relative namespace
1444 @result_namespace = ($schema_class, $ns);
1447 return wantarray ? @result_namespace : join '::', @result_namespace;
1450 # Create class with applicable bases, setup monikers, etc
1451 sub _make_src_class {
1452 my ($self, $table) = @_;
1454 my $schema = $self->schema;
1455 my $schema_class = $self->schema_class;
1457 my $table_moniker = $self->_table2moniker($table);
1458 my @result_namespace = ($schema_class);
1459 if ($self->use_namespaces) {
1460 my $result_namespace = $self->result_namespace || 'Result';
1461 @result_namespace = $self->_result_namespace(
1466 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1468 if ((my $upgrading_v = $self->_upgrading_from)
1469 || $self->_rewriting) {
1470 local $self->naming->{monikers} = $upgrading_v
1473 my @result_namespace = @result_namespace;
1474 if ($self->_upgrading_from_load_classes) {
1475 @result_namespace = ($schema_class);
1477 elsif (my $ns = $self->_downgrading_to_load_classes) {
1478 @result_namespace = $self->_result_namespace(
1483 elsif ($ns = $self->_rewriting_result_namespace) {
1484 @result_namespace = $self->_result_namespace(
1490 my $old_class = join(q{::}, @result_namespace,
1491 $self->_table2moniker($table));
1493 $self->_upgrading_classes->{$table_class} = $old_class
1494 unless $table_class eq $old_class;
1497 # this was a bad idea, should be ok now without it
1498 # my $table_normalized = lc $table;
1499 # $self->classes->{$table_normalized} = $table_class;
1500 # $self->monikers->{$table_normalized} = $table_moniker;
1502 $self->classes->{$table} = $table_class;
1503 $self->monikers->{$table} = $table_moniker;
1505 $self->_use ($table_class, @{$self->additional_classes});
1506 $self->_inject($table_class, @{$self->left_base_classes});
1508 if (my @components = @{ $self->components }) {
1509 $self->_dbic_stmt($table_class, 'load_components', @components);
1512 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
1513 if @{$self->resultset_components};
1514 $self->_inject($table_class, @{$self->additional_base_classes});
1517 sub _resolve_col_accessor_collisions {
1518 my ($self, $col_info) = @_;
1520 my $base = $self->result_base_class || 'DBIx::Class::Core';
1521 my @components = map "DBIx::Class::$_", @{ $self->components || [] };
1525 for my $class ($base, @components) {
1526 eval "require ${class};";
1529 push @methods, @{ Class::Inspector->methods($class) || [] };
1533 @methods{@methods} = ();
1535 while (my ($col, $info) = each %$col_info) {
1536 my $accessor = $info->{accessor} || $col;
1538 next if $accessor eq 'id'; # special case (very common column)
1540 if (exists $methods{$accessor}) {
1541 $info->{accessor} = undef;
1546 sub _make_column_accessor_name {
1547 my ($self, $column_name) = @_;
1549 return join '_', map lc, split_name $column_name;
1552 # Set up metadata (cols, pks, etc)
1553 sub _setup_src_meta {
1554 my ($self, $table) = @_;
1556 my $schema = $self->schema;
1557 my $schema_class = $self->schema_class;
1559 my $table_class = $self->classes->{$table};
1560 my $table_moniker = $self->monikers->{$table};
1562 my $table_name = $table;
1563 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1565 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1566 $table_name = \ $self->_quote_table_name($table_name);
1569 my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name);
1571 # be careful to not create refs Data::Dump can "optimize"
1572 $full_table_name = \do {"".$full_table_name} if ref $table_name;
1574 $self->_dbic_stmt($table_class, 'table', $full_table_name);
1576 my $cols = $self->_table_columns($table);
1577 my $col_info = $self->__columns_info_for($table);
1579 while (my ($col, $info) = each %$col_info) {
1581 ($info->{accessor} = $col) =~ s/\W+/_/g;
1585 if ($self->preserve_case) {
1586 while (my ($col, $info) = each %$col_info) {
1587 if ($col ne lc($col)) {
1588 if ((not exists $self->naming->{column_accessors}) || (($self->naming->{column_accessors} =~ /(\d+)/)[0] >= 7)) {
1589 $info->{accessor} = $self->_make_column_accessor_name($info->{accessor} || $col);
1592 $info->{accessor} = lc($info->{accessor} || $col);
1598 # XXX this needs to go away
1599 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
1602 $self->_resolve_col_accessor_collisions($col_info);
1604 my $fks = $self->_table_fk_info($table);
1606 foreach my $fkdef (@$fks) {
1607 for my $col (@{ $fkdef->{local_columns} }) {
1608 $col_info->{$col}{is_foreign_key} = 1;
1612 my $pks = $self->_table_pk_info($table) || [];
1614 foreach my $pkcol (@$pks) {
1615 $col_info->{$pkcol}{is_nullable} = 0;
1621 map { $_, ($col_info->{$_}||{}) } @$cols
1624 my %uniq_tag; # used to eliminate duplicate uniqs
1626 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1627 : carp("$table has no primary key");
1628 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1630 my $uniqs = $self->_table_uniq_info($table) || [];
1632 my ($name, $cols) = @$_;
1633 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1634 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1639 sub __columns_info_for {
1640 my ($self, $table) = @_;
1642 my $result = $self->_columns_info_for($table);
1644 while (my ($col, $info) = each %$result) {
1645 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
1646 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
1648 $result->{$col} = $info;
1656 Returns a sorted list of loaded tables, using the original database table
1664 return keys %{$self->_tables};
1667 # Make a moniker from a table
1668 sub _default_table2moniker {
1669 no warnings 'uninitialized';
1670 my ($self, $table) = @_;
1672 if ($self->naming->{monikers} eq 'v4') {
1673 return join '', map ucfirst, split /[\W_]+/, lc $table;
1675 elsif ($self->naming->{monikers} eq 'v5') {
1676 return join '', map ucfirst, split /[\W_]+/,
1677 Lingua::EN::Inflect::Number::to_S(lc $table);
1679 elsif ($self->naming->{monikers} eq 'v6') {
1680 (my $as_phrase = lc $table) =~ s/_+/ /g;
1681 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1683 return join '', map ucfirst, split /\W+/, $inflected;
1686 my @words = map lc, split_name $table;
1687 my $as_phrase = join ' ', @words;
1689 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1691 return join '', map ucfirst, split /\W+/, $inflected;
1694 sub _table2moniker {
1695 my ( $self, $table ) = @_;
1699 if( ref $self->moniker_map eq 'HASH' ) {
1700 $moniker = $self->moniker_map->{$table};
1702 elsif( ref $self->moniker_map eq 'CODE' ) {
1703 $moniker = $self->moniker_map->($table);
1706 $moniker ||= $self->_default_table2moniker($table);
1711 sub _load_relationships {
1712 my ($self, $table) = @_;
1714 my $tbl_fk_info = $self->_table_fk_info($table);
1715 foreach my $fkdef (@$tbl_fk_info) {
1716 $fkdef->{remote_source} =
1717 $self->monikers->{delete $fkdef->{remote_table}};
1719 my $tbl_uniq_info = $self->_table_uniq_info($table);
1721 my $local_moniker = $self->monikers->{$table};
1722 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1724 foreach my $src_class (sort keys %$rel_stmts) {
1725 my $src_stmts = $rel_stmts->{$src_class};
1726 foreach my $stmt (@$src_stmts) {
1727 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1732 # Overload these in driver class:
1734 # Returns an arrayref of column names
1735 sub _table_columns { croak "ABSTRACT METHOD" }
1737 # Returns arrayref of pk col names
1738 sub _table_pk_info { croak "ABSTRACT METHOD" }
1740 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1741 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1743 # Returns an arrayref of foreign key constraints, each
1744 # being a hashref with 3 keys:
1745 # local_columns (arrayref), remote_columns (arrayref), remote_table
1746 sub _table_fk_info { croak "ABSTRACT METHOD" }
1748 # Returns an array of lower case table names
1749 sub _tables_list { croak "ABSTRACT METHOD" }
1751 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1757 # generate the pod for this statement, storing it with $self->_pod
1758 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
1760 my $args = dump(@_);
1761 $args = '(' . $args . ')' if @_ < 2;
1762 my $stmt = $method . $args . q{;};
1764 warn qq|$class\->$stmt\n| if $self->debug;
1765 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1769 # generates the accompanying pod for a DBIC class method statement,
1770 # storing it with $self->_pod
1776 if ( $method eq 'table' ) {
1778 my $pcm = $self->pod_comment_mode;
1779 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
1780 if ( $self->can('_table_comment') ) {
1781 $comment = $self->_table_comment($table);
1782 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
1783 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
1784 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
1786 $self->_pod( $class, "=head1 NAME" );
1787 my $table_descr = $class;
1788 $table_descr .= " - " . $comment if $comment and $comment_in_name;
1789 $self->{_class2table}{ $class } = $table;
1790 $self->_pod( $class, $table_descr );
1791 if ($comment and $comment_in_desc) {
1792 $self->_pod( $class, "=head1 DESCRIPTION" );
1793 $self->_pod( $class, $comment );
1795 $self->_pod_cut( $class );
1796 } elsif ( $method eq 'add_columns' ) {
1797 $self->_pod( $class, "=head1 ACCESSORS" );
1798 my $col_counter = 0;
1800 while( my ($name,$attrs) = splice @cols,0,2 ) {
1802 $self->_pod( $class, '=head2 ' . $name );
1803 $self->_pod( $class,
1805 my $s = $attrs->{$_};
1806 $s = !defined $s ? 'undef' :
1807 length($s) == 0 ? '(empty string)' :
1808 ref($s) eq 'SCALAR' ? $$s :
1815 looks_like_number($s) ? $s :
1820 } sort keys %$attrs,
1823 if( $self->can('_column_comment')
1824 and my $comment = $self->_column_comment( $self->{_class2table}{$class}, $col_counter)
1826 $self->_pod( $class, $comment );
1829 $self->_pod_cut( $class );
1830 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1831 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1832 my ( $accessor, $rel_class ) = @_;
1833 $self->_pod( $class, "=head2 $accessor" );
1834 $self->_pod( $class, 'Type: ' . $method );
1835 $self->_pod( $class, "Related object: L<$rel_class>" );
1836 $self->_pod_cut( $class );
1837 $self->{_relations_started} { $class } = 1;
1841 # Stores a POD documentation
1843 my ($self, $class, $stmt) = @_;
1844 $self->_raw_stmt( $class, "\n" . $stmt );
1848 my ($self, $class ) = @_;
1849 $self->_raw_stmt( $class, "\n=cut\n" );
1852 # Store a raw source line for a class (for dumping purposes)
1854 my ($self, $class, $stmt) = @_;
1855 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1858 # Like above, but separately for the externally loaded stuff
1860 my ($self, $class, $stmt) = @_;
1861 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1864 sub _quote_table_name {
1865 my ($self, $table) = @_;
1867 my $qt = $self->schema->storage->sql_maker->quote_char;
1869 return $table unless $qt;
1872 return $qt->[0] . $table . $qt->[1];
1875 return $qt . $table . $qt;
1878 sub _custom_column_info {
1879 my ( $self, $table_name, $column_name, $column_info ) = @_;
1881 if (my $code = $self->custom_column_info) {
1882 return $code->($table_name, $column_name, $column_info) || {};
1887 sub _datetime_column_info {
1888 my ( $self, $table_name, $column_name, $column_info ) = @_;
1890 my $type = $column_info->{data_type} || '';
1891 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
1892 or ($type =~ /date|timestamp/i)) {
1893 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
1894 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
1900 my ($self, $name) = @_;
1902 return $self->preserve_case ? $name : lc($name);
1906 my ($self, $name) = @_;
1908 return $self->preserve_case ? $name : uc($name);
1911 sub _unregister_source_for_table {
1912 my ($self, $table) = @_;
1916 my $schema = $self->schema;
1917 # in older DBIC it's a private method
1918 my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
1919 $schema->$unregister($self->_table2moniker($table));
1920 delete $self->monikers->{$table};
1921 delete $self->classes->{$table};
1922 delete $self->_upgrading_classes->{$table};
1923 delete $self->{_tables}{$table};
1927 # remove the dump dir from @INC on destruction
1931 @INC = grep $_ ne $self->dump_directory, @INC;
1936 Returns a hashref of loaded table to moniker mappings. There will
1937 be two entries for each table, the original name and the "normalized"
1938 name, in the case that the two are different (such as databases
1939 that like uppercase table names, or preserve your original mixed-case
1940 definitions, or what-have-you).
1944 Returns a hashref of table to class mappings. In some cases it will
1945 contain multiple entries per table for the original and normalized table
1946 names, as above in L</monikers>.
1950 L<DBIx::Class::Schema::Loader>
1954 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1958 This library is free software; you can redistribute it and/or modify it under
1959 the same terms as Perl itself.
1964 # vim:et sts=4 sw=4 tw=0: