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_package_without_redefine_warnings class_path/;
22 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
27 our $VERSION = '0.07010';
29 __PACKAGE__->mk_group_ro_accessors('simple', qw/
36 additional_base_classes
51 default_resultset_class
56 overwrite_modifications
75 __PACKAGE__->mk_group_accessors('simple', qw/
77 schema_version_to_dump
79 _upgrading_from_load_classes
80 _downgrading_to_load_classes
81 _rewriting_result_namespace
86 pod_comment_spillover_length
93 datetime_undef_if_invalid
99 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
103 See L<DBIx::Class::Schema::Loader>
107 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
108 classes, and implements the common functionality between them.
110 =head1 CONSTRUCTOR OPTIONS
112 These constructor options are the base options for
113 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
115 =head2 skip_relationships
117 Skip setting up relationships. The default is to attempt the loading
120 =head2 skip_load_external
122 Skip loading of other classes in @INC. The default is to merge all other classes
123 with the same name found in @INC into the schema file we are creating.
127 Static schemas (ones dumped to disk) will, by default, use the new-style
128 relationship names and singularized Results, unless you're overwriting an
129 existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
130 which case the backward compatible RelBuilder will be activated, and the
131 appropriate monikerization used.
137 will disable the backward-compatible RelBuilder and use
138 the new-style relationship names along with singularized Results, even when
139 overwriting a dump made with an earlier version.
141 The option also takes a hashref:
143 naming => { relationships => 'v7', monikers => 'v7' }
151 How to name relationship accessors.
155 How to name Result classes.
157 =item column_accessors
159 How to name column accessors in Result classes.
169 Latest style, whatever that happens to be.
173 Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
177 Monikers singularized as whole words, C<might_have> relationships for FKs on
178 C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
180 Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
185 All monikers and relationships are inflected using
186 L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
187 from relationship names.
189 In general, there is very little difference between v5 and v6 schemas.
193 This mode is identical to C<v6> mode, except that monikerization of CamelCase
194 table names is also done correctly.
196 CamelCase column names in case-preserving mode will also be handled correctly
197 for relationship name inflection. See L</preserve_case>.
199 In this mode, CamelCase L</column_accessors> are normalized based on case
200 transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
202 If you don't have any CamelCase table or column names, you can upgrade without
203 breaking any of your code.
207 Dynamic schemas will always default to the 0.04XXX relationship names and won't
208 singularize Results for backward compatibility, to activate the new RelBuilder
209 and singularization put this in your C<Schema.pm> file:
211 __PACKAGE__->naming('current');
213 Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
214 next major version upgrade:
216 __PACKAGE__->naming('v7');
220 By default POD will be generated for columns and relationships, using database
221 metadata for the text if available and supported.
223 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
224 supported for Postgres right now.
226 Set this to C<0> to turn off all POD generation.
228 =head2 pod_comment_mode
230 Controls where table comments appear in the generated POD. Smaller table
231 comments are appended to the C<NAME> section of the documentation, and larger
232 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
233 section to be generated with the comment always, only use C<NAME>, or choose
234 the length threshold at which the comment is forced into the description.
240 Use C<NAME> section only.
244 Force C<DESCRIPTION> always.
248 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
253 =head2 pod_comment_spillover_length
255 When pod_comment_mode is set to C<auto>, this is the length of the comment at
256 which it will be forced into a separate description section.
260 =head2 relationship_attrs
262 Hashref of attributes to pass to each generated relationship, listed
263 by type. Also supports relationship type 'all', containing options to
264 pass to all generated relationships. Attributes set for more specific
265 relationship types override those set in 'all'.
269 relationship_attrs => {
270 belongs_to => { is_deferrable => 0 },
273 use this to turn off DEFERRABLE on your foreign key constraints.
277 If set to true, each constructive L<DBIx::Class> statement the loader
278 decides to execute will be C<warn>-ed before execution.
282 Set the name of the schema to load (schema in the sense that your database
283 vendor means it). Does not currently support loading more than one schema
288 Only load tables matching regex. Best specified as a qr// regex.
292 Exclude tables matching regex. Best specified as a qr// regex.
296 Overrides the default table name to moniker translation. Can be either
297 a hashref of table keys and moniker values, or a coderef for a translator
298 function taking a single scalar table name argument and returning
299 a scalar moniker. If the hash entry does not exist, or the function
300 returns a false value, the code falls back to default behavior
303 The default behavior is to split on case transition and non-alphanumeric
304 boundaries, singularize the resulting phrase, then join the titlecased words
307 Table Name | Moniker Name
308 ---------------------------------
310 luser_group | LuserGroup
311 luser-opts | LuserOpt
312 stations_visited | StationVisited
313 routeChange | RouteChange
315 =head2 col_accessor_map
317 Same as moniker_map, but for column accessor names. If a coderef is
318 passed, the code is called with arguments of
320 the name of the column in the underlying database,
321 default accessor name that DBICSL would ordinarily give this column,
323 table_class => name of the DBIC class we are building,
324 table_moniker => calculated moniker for this table (after moniker_map if present),
325 table_name => name of the database table,
326 full_table_name => schema-qualified name of the database table (RDBMS specific),
327 schema_class => name of the schema class we are building,
328 column_info => hashref of column info (data_type, is_nullable, etc),
331 =head2 inflect_plural
333 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
334 if hash key does not exist or coderef returns false), but acts as a map
335 for pluralizing relationship names. The default behavior is to utilize
336 L<Lingua::EN::Inflect::Phrase/to_PL>.
338 =head2 inflect_singular
340 As L</inflect_plural> above, but for singularizing relationship names.
341 Default behavior is to utilize L<Lingua::EN::Inflect::Phrase/to_S>.
343 =head2 schema_base_class
345 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
347 =head2 result_base_class
349 Base class for your table classes (aka result classes). Defaults to
352 =head2 additional_base_classes
354 List of additional base classes all of your table classes will use.
356 =head2 left_base_classes
358 List of additional base classes all of your table classes will use
359 that need to be leftmost.
361 =head2 additional_classes
363 List of additional classes which all of your table classes will use.
367 List of additional components to be loaded into all of your table
368 classes. A good example would be
369 L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
371 =head2 result_components_map
373 A hashref of moniker keys and component values. Unlike C<components>, which
374 loads the given components into every Result class, this option allows you to
375 load certain components for specified Result classes. For example:
377 result_components_map => {
378 StationVisited => '+YourApp::Schema::Component::StationVisited',
380 '+YourApp::Schema::Component::RouteChange',
381 'InflateColumn::DateTime',
385 You may use this in conjunction with C<components>.
389 List of L<Moose> roles to be applied to all of your Result classes.
391 =head2 result_roles_map
393 A hashref of moniker keys and role values. Unlike C<result_roles>, which
394 applies the given roles to every Result class, this option allows you to apply
395 certain roles for specified Result classes. For example:
397 result_roles_map => {
399 'YourApp::Role::Building',
400 'YourApp::Role::Destination',
402 RouteChange => 'YourApp::Role::TripEvent',
405 You may use this in conjunction with C<components>.
407 =head2 use_namespaces
409 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
412 Generate result class names suitable for
413 L<DBIx::Class::Schema/load_namespaces> and call that instead of
414 L<DBIx::Class::Schema/load_classes>. When using this option you can also
415 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
416 C<resultset_namespace>, C<default_resultset_class>), and they will be added
417 to the call (and the generated result class names adjusted appropriately).
419 =head2 dump_directory
421 The value of this option is a perl libdir pathname. Within
422 that directory this module will create a baseline manual
423 L<DBIx::Class::Schema> module set, based on what it creates at runtime.
425 The created schema class will have the same classname as the one on
426 which you are setting this option (and the ResultSource classes will be
427 based on this name as well).
429 Normally you wouldn't hard-code this setting in your schema class, as it
430 is meant for one-time manual usage.
432 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
433 recommended way to access this functionality.
435 =head2 dump_overwrite
437 Deprecated. See L</really_erase_my_files> below, which does *not* mean
438 the same thing as the old C<dump_overwrite> setting from previous releases.
440 =head2 really_erase_my_files
442 Default false. If true, Loader will unconditionally delete any existing
443 files before creating the new ones from scratch when dumping a schema to disk.
445 The default behavior is instead to only replace the top portion of the
446 file, up to and including the final stanza which contains
447 C<# DO NOT MODIFY THE FIRST PART OF THIS FILE>
448 leaving any customizations you placed after that as they were.
450 When C<really_erase_my_files> is not set, if the output file already exists,
451 but the aforementioned final stanza is not found, or the checksum
452 contained there does not match the generated contents, Loader will
453 croak and not touch the file.
455 You should really be using version control on your schema classes (and all
456 of the rest of your code for that matter). Don't blame me if a bug in this
457 code wipes something out when it shouldn't have, you've been warned.
459 =head2 overwrite_modifications
461 Default false. If false, when updating existing files, Loader will
462 refuse to modify any Loader-generated code that has been modified
463 since its last run (as determined by the checksum Loader put in its
466 If true, Loader will discard any manual modifications that have been
467 made to Loader-generated code.
469 Again, you should be using version control on your schema classes. Be
470 careful with this option.
472 =head2 custom_column_info
474 Hook for adding extra attributes to the
475 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
477 Must be a coderef that returns a hashref with the extra attributes.
479 Receives the table name, column name and column_info.
483 custom_column_info => sub {
484 my ($table_name, $column_name, $column_info) = @_;
486 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
487 return { is_snoopy => 1 };
491 This attribute can also be used to set C<inflate_datetime> on a non-datetime
492 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
494 =head2 datetime_timezone
496 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
497 columns with the DATE/DATETIME/TIMESTAMP data_types.
499 =head2 datetime_locale
501 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
502 columns with the DATE/DATETIME/TIMESTAMP data_types.
504 =head2 datetime_undef_if_invalid
506 Pass a C<0> for this option when using MySQL if you B<DON'T> want C<<
507 datetime_undef_if_invalid => 1 >> in your column info for DATE, DATETIME and
510 The default is recommended to deal with data such as C<00/00/00> which
511 sometimes ends up in such columns in MySQL.
515 File in Perl format, which should return a HASH reference, from which to read
520 Usually column names are lowercased, to make them easier to work with in
521 L<DBIx::Class>. This option lets you turn this behavior off, if the driver
524 Drivers for case sensitive databases like Sybase ASE or MSSQL with a
525 case-sensitive collation will turn this option on unconditionally.
527 Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
530 =head2 qualify_objects
532 Set to true to prepend the L</db_schema> to table names for C<<
533 __PACKAGE__->table >> calls, and to some other things like Oracle sequences.
537 Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and
538 L<namespace::autoclean>. The default content after the md5 sum also makes the
541 It is safe to upgrade your existing Schema to this option.
543 =head2 col_collision_map
545 This option controls how accessors for column names which collide with perl
546 methods are named. See L</COLUMN ACCESSOR COLLISIONS> for more information.
548 This option takes either a single L<sprintf|perlfunc/sprintf> format or a hashref of
549 strings which are compiled to regular expressions that map to
550 L<sprintf|perlfunc/sprintf> formats.
554 col_collision_map => 'column_%s'
556 col_collision_map => { '(.*)' => 'column_%s' }
558 col_collision_map => { '(foo).*(bar)' => 'column_%s_%s' }
560 =head2 rel_collision_map
562 Works just like L</col_collision_map>, but for relationship names/accessors
563 rather than column names/accessors.
565 The default is to just append C<_rel> to the relationship name, see
566 L</RELATIONSHIP NAME COLLISIONS>.
570 None of these methods are intended for direct invocation by regular
571 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
572 L<DBIx::Class::Schema::Loader>.
576 my $CURRENT_V = 'v7';
579 schema_base_class result_base_class additional_base_classes
580 left_base_classes additional_classes components result_roles
583 # ensure that a peice of object data is a valid arrayref, creating
584 # an empty one or encapsulating whatever's there.
585 sub _ensure_arrayref {
590 $self->{$_} = [ $self->{$_} ]
591 unless ref $self->{$_} eq 'ARRAY';
597 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
598 by L<DBIx::Class::Schema::Loader>.
603 my ( $class, %args ) = @_;
605 if (exists $args{column_accessor_map}) {
606 $args{col_accessor_map} = delete $args{column_accessor_map};
609 my $self = { %args };
611 # don't lose undef options
612 for (values %$self) {
613 $_ = 0 unless defined $_;
616 bless $self => $class;
618 if (my $config_file = $self->config_file) {
619 my $config_opts = do $config_file;
621 croak "Error reading config from $config_file: $@" if $@;
623 croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH';
625 while (my ($k, $v) = each %$config_opts) {
626 $self->{$k} = $v unless exists $self->{$k};
630 $self->result_components_map($self->{result_component_map})
631 if defined $self->{result_component_map};
633 $self->result_roles_map($self->{result_role_map})
634 if defined $self->{result_role_map};
636 croak "the result_roles and result_roles_map options may only be used in conjunction with use_moose=1"
637 if ((not defined $self->use_moose) || (not $self->use_moose))
638 && ((defined $self->result_roles) || (defined $self->result_roles_map));
640 $self->_ensure_arrayref(qw/additional_classes
641 additional_base_classes
647 $self->_validate_class_args;
649 croak "result_components_map must be a hash"
650 if defined $self->result_components_map
651 && ref $self->result_components_map ne 'HASH';
653 if ($self->result_components_map) {
654 my %rc_map = %{ $self->result_components_map };
655 foreach my $moniker (keys %rc_map) {
656 $rc_map{$moniker} = [ $rc_map{$moniker} ] unless ref $rc_map{$moniker};
658 $self->result_components_map(\%rc_map);
661 $self->result_components_map({});
663 $self->_validate_result_components_map;
665 croak "result_roles_map must be a hash"
666 if defined $self->result_roles_map
667 && ref $self->result_roles_map ne 'HASH';
669 if ($self->result_roles_map) {
670 my %rr_map = %{ $self->result_roles_map };
671 foreach my $moniker (keys %rr_map) {
672 $rr_map{$moniker} = [ $rr_map{$moniker} ] unless ref $rr_map{$moniker};
674 $self->result_roles_map(\%rr_map);
676 $self->result_roles_map({});
678 $self->_validate_result_roles_map;
680 if ($self->use_moose) {
681 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) {
682 die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
683 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose');
687 $self->{monikers} = {};
688 $self->{classes} = {};
689 $self->{_upgrading_classes} = {};
691 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
692 $self->{schema} ||= $self->{schema_class};
694 croak "dump_overwrite is deprecated. Please read the"
695 . " DBIx::Class::Schema::Loader::Base documentation"
696 if $self->{dump_overwrite};
698 $self->{dynamic} = ! $self->{dump_directory};
699 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
704 $self->{dump_directory} ||= $self->{temp_directory};
706 $self->real_dump_directory($self->{dump_directory});
708 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
709 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
711 if ((not ref $self->naming) && defined $self->naming) {
712 my $naming_ver = $self->naming;
714 relationships => $naming_ver,
715 monikers => $naming_ver,
716 column_accessors => $naming_ver,
721 for (values %{ $self->naming }) {
722 $_ = $CURRENT_V if $_ eq 'current';
725 $self->{naming} ||= {};
727 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
728 croak 'custom_column_info must be a CODE ref';
731 $self->_check_back_compat;
733 $self->use_namespaces(1) unless defined $self->use_namespaces;
734 $self->generate_pod(1) unless defined $self->generate_pod;
735 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
736 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
738 if (my $col_collision_map = $self->col_collision_map) {
739 if (my $reftype = ref $col_collision_map) {
740 if ($reftype ne 'HASH') {
741 croak "Invalid type $reftype for option 'col_collision_map'";
745 $self->col_collision_map({ '(.*)' => $col_collision_map });
752 sub _check_back_compat {
755 # dynamic schemas will always be in 0.04006 mode, unless overridden
756 if ($self->dynamic) {
757 # just in case, though no one is likely to dump a dynamic schema
758 $self->schema_version_to_dump('0.04006');
760 if (not %{ $self->naming }) {
761 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
763 Dynamic schema detected, will run in 0.04006 mode.
765 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
766 to disable this warning.
768 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
773 $self->_upgrading_from('v4');
776 $self->naming->{relationships} ||= 'v4';
777 $self->naming->{monikers} ||= 'v4';
779 if ((not defined $self->use_namespaces)
780 && $self->naming->{monikers} ne 'v4') {
781 $self->use_namespaces(1);
784 if ($self->use_namespaces) {
785 $self->_upgrading_from_load_classes(1);
788 $self->use_namespaces(0);
794 # otherwise check if we need backcompat mode for a static schema
795 my $filename = $self->_get_dump_filename($self->schema_class);
796 return unless -e $filename;
798 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) =
799 $self->_parse_generated_file($filename);
801 return unless $old_ver;
803 # determine if the existing schema was dumped with use_moose => 1
804 if (! defined $self->use_moose) {
805 $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm;
808 my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0;
809 my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' };
811 if ($load_classes && (not defined $self->use_namespaces)) {
812 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
814 'load_classes;' static schema detected, turning off 'use_namespaces'.
816 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
817 variable to disable this warning.
819 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
822 $self->use_namespaces(0);
824 elsif ($load_classes && $self->use_namespaces) {
825 $self->_upgrading_from_load_classes(1);
827 elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) {
828 $self->_downgrading_to_load_classes(
829 $result_namespace || 'Result'
832 elsif ((not defined $self->use_namespaces) || $self->use_namespaces) {
833 if (not $self->result_namespace) {
834 $self->result_namespace($result_namespace || 'Result');
836 elsif ($result_namespace ne $self->result_namespace) {
837 $self->_rewriting_result_namespace(
838 $result_namespace || 'Result'
843 # XXX when we go past .0 this will need fixing
844 my ($v) = $old_ver =~ /([1-9])/;
847 return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/);
849 if (not %{ $self->naming }) {
850 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
852 Version $old_ver static schema detected, turning on backcompat mode.
854 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
855 to disable this warning.
857 See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
859 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
860 from version 0.04006.
863 $self->naming->{relationships} ||= $v;
864 $self->naming->{monikers} ||= $v;
865 $self->naming->{column_accessors} ||= $v;
867 $self->schema_version_to_dump($old_ver);
870 $self->_upgrading_from($v);
874 sub _validate_class_args {
877 foreach my $k (@CLASS_ARGS) {
878 next unless $self->$k;
880 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
881 $self->_validate_classes($k, \@classes);
885 sub _validate_result_components_map {
888 foreach my $classes (values %{ $self->result_components_map }) {
889 $self->_validate_classes('result_components_map', $classes);
893 sub _validate_result_roles_map {
896 foreach my $classes (values %{ $self->result_roles_map }) {
897 $self->_validate_classes('result_roles_map', $classes);
901 sub _validate_classes {
906 # make a copy to not destroy original
907 my @classes = @$classes;
909 foreach my $c (@classes) {
910 # components default to being under the DBIx::Class namespace unless they
911 # are preceeded with a '+'
912 if ( $key =~ m/component/ && $c !~ s/^\+// ) {
913 $c = 'DBIx::Class::' . $c;
916 # 1 == installed, 0 == not installed, undef == invalid classname
917 my $installed = Class::Inspector->installed($c);
918 if ( defined($installed) ) {
919 if ( $installed == 0 ) {
920 croak qq/$c, as specified in the loader option "$key", is not installed/;
923 croak qq/$c, as specified in the loader option "$key", is an invalid class name/;
929 sub _find_file_in_inc {
930 my ($self, $file) = @_;
932 foreach my $prefix (@INC) {
933 my $fullpath = File::Spec->catfile($prefix, $file);
934 return $fullpath if -f $fullpath
935 # abs_path throws on Windows for nonexistant files
936 and (try { Cwd::abs_path($fullpath) }) ne
937 ((try { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) }) || '');
943 sub _find_class_in_inc {
944 my ($self, $class) = @_;
946 return $self->_find_file_in_inc(class_path($class));
952 return $self->_upgrading_from
953 || $self->_upgrading_from_load_classes
954 || $self->_downgrading_to_load_classes
955 || $self->_rewriting_result_namespace
959 sub _rewrite_old_classnames {
960 my ($self, $code) = @_;
962 return $code unless $self->_rewriting;
964 my %old_classes = reverse %{ $self->_upgrading_classes };
966 my $re = join '|', keys %old_classes;
969 $code =~ s/$re/$old_classes{$1} || $1/eg;
975 my ($self, $class) = @_;
977 return if $self->{skip_load_external};
979 # so that we don't load our own classes, under any circumstances
980 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
982 my $real_inc_path = $self->_find_class_in_inc($class);
984 my $old_class = $self->_upgrading_classes->{$class}
985 if $self->_rewriting;
987 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
988 if $old_class && $old_class ne $class;
990 return unless $real_inc_path || $old_real_inc_path;
992 if ($real_inc_path) {
993 # If we make it to here, we loaded an external definition
994 warn qq/# Loaded external class definition for '$class'\n/
997 my $code = $self->_rewrite_old_classnames(scalar slurp $real_inc_path);
999 if ($self->dynamic) { # load the class too
1000 eval_package_without_redefine_warnings($class, $code);
1003 $self->_ext_stmt($class,
1004 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
1005 .qq|# They are now part of the custom portion of this file\n|
1006 .qq|# for you to hand-edit. If you do not either delete\n|
1007 .qq|# this section or remove that file from \@INC, this section\n|
1008 .qq|# will be repeated redundantly when you re-create this\n|
1009 .qq|# file again via Loader! See skip_load_external to disable\n|
1010 .qq|# this feature.\n|
1013 $self->_ext_stmt($class, $code);
1014 $self->_ext_stmt($class,
1015 qq|# End of lines loaded from '$real_inc_path' |
1019 if ($old_real_inc_path) {
1020 my $code = slurp $old_real_inc_path;
1022 $self->_ext_stmt($class, <<"EOF");
1024 # These lines were loaded from '$old_real_inc_path',
1025 # based on the Result class name that would have been created by an older
1026 # version of the Loader. For a static schema, this happens only once during
1027 # upgrade. See skip_load_external to disable this feature.
1030 $code = $self->_rewrite_old_classnames($code);
1032 if ($self->dynamic) {
1035 Detected external content in '$old_real_inc_path', a class name that would have
1036 been used by an older version of the Loader.
1038 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
1039 new name of the Result.
1041 eval_package_without_redefine_warnings($class, $code);
1045 $self->_ext_stmt($class, $code);
1046 $self->_ext_stmt($class,
1047 qq|# End of lines loaded from '$old_real_inc_path' |
1054 Does the actual schema-construction work.
1061 $self->_load_tables(
1062 $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude })
1070 Rescan the database for changes. Returns a list of the newly added table
1073 The schema argument should be the schema class or object to be affected. It
1074 should probably be derived from the original schema_class used during L</load>.
1079 my ($self, $schema) = @_;
1081 $self->{schema} = $schema;
1082 $self->_relbuilder->{schema} = $schema;
1085 my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude });
1087 foreach my $table (@current) {
1088 if(!exists $self->{_tables}->{$table}) {
1089 push(@created, $table);
1094 @current{@current} = ();
1095 foreach my $table (keys %{ $self->{_tables} }) {
1096 if (not exists $current{$table}) {
1097 $self->_unregister_source_for_table($table);
1101 delete $self->{_dump_storage};
1102 delete $self->{_relations_started};
1104 my $loaded = $self->_load_tables(@current);
1106 return map { $self->monikers->{$_} } @created;
1112 return if $self->{skip_relationships};
1114 return $self->{relbuilder} ||= do {
1116 no warnings 'uninitialized';
1117 my $relbuilder_suff =
1123 ->{ $self->naming->{relationships}};
1125 my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff;
1126 $self->ensure_class_loaded($relbuilder_class);
1127 $relbuilder_class->new( $self );
1133 my ($self, @tables) = @_;
1135 # Save the new tables to the tables list
1137 $self->{_tables}->{$_} = 1;
1140 $self->_make_src_class($_) for @tables;
1142 # sanity-check for moniker clashes
1143 my $inverse_moniker_idx;
1144 for (keys %{$self->monikers}) {
1145 push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_;
1149 for (keys %$inverse_moniker_idx) {
1150 my $tables = $inverse_moniker_idx->{$_};
1152 push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'",
1153 join (', ', map { "'$_'" } @$tables),
1160 die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. '
1161 . 'Either change the naming style, or supply an explicit moniker_map: '
1162 . join ('; ', @clashes)
1168 $self->_setup_src_meta($_) for @tables;
1170 if(!$self->skip_relationships) {
1171 # The relationship loader needs a working schema
1173 local $self->{dump_directory} = $self->{temp_directory};
1174 $self->_reload_classes(\@tables);
1175 $self->_load_relationships($_) for @tables;
1176 $self->_relbuilder->cleanup;
1179 # Remove that temp dir from INC so it doesn't get reloaded
1180 @INC = grep $_ ne $self->dump_directory, @INC;
1183 $self->_load_external($_)
1184 for map { $self->classes->{$_} } @tables;
1186 # Reload without unloading first to preserve any symbols from external
1188 $self->_reload_classes(\@tables, { unload => 0 });
1190 # Drop temporary cache
1191 delete $self->{_cache};
1196 sub _reload_classes {
1197 my ($self, $tables, $opts) = @_;
1199 my @tables = @$tables;
1201 my $unload = $opts->{unload};
1202 $unload = 1 unless defined $unload;
1204 # so that we don't repeat custom sections
1205 @INC = grep $_ ne $self->dump_directory, @INC;
1207 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
1209 unshift @INC, $self->dump_directory;
1212 my %have_source = map { $_ => $self->schema->source($_) }
1213 $self->schema->sources;
1215 for my $table (@tables) {
1216 my $moniker = $self->monikers->{$table};
1217 my $class = $self->classes->{$table};
1220 no warnings 'redefine';
1221 local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below
1224 if (my $mc = $self->_moose_metaclass($class)) {
1227 Class::Unload->unload($class) if $unload;
1228 my ($source, $resultset_class);
1230 ($source = $have_source{$moniker})
1231 && ($resultset_class = $source->resultset_class)
1232 && ($resultset_class ne 'DBIx::Class::ResultSet')
1234 my $has_file = Class::Inspector->loaded_filename($resultset_class);
1235 if (my $mc = $self->_moose_metaclass($resultset_class)) {
1238 Class::Unload->unload($resultset_class) if $unload;
1239 $self->_reload_class($resultset_class) if $has_file;
1241 $self->_reload_class($class);
1243 push @to_register, [$moniker, $class];
1246 Class::C3->reinitialize;
1247 for (@to_register) {
1248 $self->schema->register_class(@$_);
1252 sub _moose_metaclass {
1253 return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place
1257 my $mc = try { Class::MOP::class_of($class) }
1260 return $mc->isa('Moose::Meta::Class') ? $mc : undef;
1263 # We use this instead of ensure_class_loaded when there are package symbols we
1266 my ($self, $class) = @_;
1268 delete $INC{ +class_path($class) };
1271 eval_package_without_redefine_warnings ($class, "require $class");
1274 my $source = slurp $self->_get_dump_filename($class);
1275 die "Failed to reload class $class: $_.\n\nCLASS SOURCE:\n\n$source";
1279 sub _get_dump_filename {
1280 my ($self, $class) = (@_);
1282 $class =~ s{::}{/}g;
1283 return $self->dump_directory . q{/} . $class . q{.pm};
1286 =head2 get_dump_filename
1290 Returns the full path to the file for a class that the class has been or will
1291 be dumped to. This is a file in a temp dir for a dynamic schema.
1295 sub get_dump_filename {
1296 my ($self, $class) = (@_);
1298 local $self->{dump_directory} = $self->real_dump_directory;
1300 return $self->_get_dump_filename($class);
1303 sub _ensure_dump_subdirs {
1304 my ($self, $class) = (@_);
1306 my @name_parts = split(/::/, $class);
1307 pop @name_parts; # we don't care about the very last element,
1308 # which is a filename
1310 my $dir = $self->dump_directory;
1313 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1315 last if !@name_parts;
1316 $dir = File::Spec->catdir($dir, shift @name_parts);
1321 my ($self, @classes) = @_;
1323 my $schema_class = $self->schema_class;
1324 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1326 my $target_dir = $self->dump_directory;
1327 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1328 unless $self->{dynamic} or $self->{quiet};
1331 qq|package $schema_class;\n\n|
1332 . qq|# Created by DBIx::Class::Schema::Loader\n|
1333 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|;
1335 if ($self->use_moose) {
1336 $schema_text.= qq|use Moose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|;
1339 $schema_text .= qq|use strict;\nuse warnings;\n\nuse base '$schema_base_class';\n\n|;
1342 if ($self->use_namespaces) {
1343 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1344 my $namespace_options;
1346 my @attr = qw/resultset_namespace default_resultset_class/;
1348 unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result';
1350 for my $attr (@attr) {
1352 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1355 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1356 $schema_text .= qq|;\n|;
1359 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1363 local $self->{version_to_dump} = $self->schema_version_to_dump;
1364 $self->_write_classfile($schema_class, $schema_text, 1);
1367 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1369 foreach my $src_class (@classes) {
1371 qq|package $src_class;\n\n|
1372 . qq|# Created by DBIx::Class::Schema::Loader\n|
1373 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1374 . qq|use strict;\nuse warnings;\n\n|;
1375 if ($self->use_moose) {
1376 $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|;
1378 # these options 'use base' which is compile time
1379 if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) {
1380 $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|;
1383 $src_text .= qq|\nextends '$result_base_class';\n\n|;
1387 $src_text .= qq|use base '$result_base_class';\n\n|;
1389 $self->_write_classfile($src_class, $src_text);
1392 # remove Result dir if downgrading from use_namespaces, and there are no
1394 if (my $result_ns = $self->_downgrading_to_load_classes
1395 || $self->_rewriting_result_namespace) {
1396 my $result_namespace = $self->_result_namespace(
1401 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1402 $result_dir = $self->dump_directory . '/' . $result_dir;
1404 unless (my @files = glob "$result_dir/*") {
1409 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1414 my ($self, $version, $ts) = @_;
1415 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1418 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1421 sub _write_classfile {
1422 my ($self, $class, $text, $is_schema) = @_;
1424 my $filename = $self->_get_dump_filename($class);
1425 $self->_ensure_dump_subdirs($class);
1427 if (-f $filename && $self->really_erase_my_files) {
1428 warn "Deleting existing file '$filename' due to "
1429 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1433 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom)
1434 = $self->_parse_generated_file($filename);
1436 if (! $old_gen && -f $filename) {
1437 croak "Cannot overwrite '$filename' without 'really_erase_my_files',"
1438 . " it does not appear to have been generated by Loader"
1441 my $custom_content = $old_custom || '';
1443 # prepend extra custom content from a *renamed* class (singularization effect)
1444 if (my $renamed_class = $self->_upgrading_classes->{$class}) {
1445 my $old_filename = $self->_get_dump_filename($renamed_class);
1447 if (-f $old_filename) {
1448 my $extra_custom = ($self->_parse_generated_file ($old_filename))[4];
1450 $extra_custom =~ s/\n\n# You can replace.*\n1;\n//;
1452 $custom_content = join ("\n", '', $extra_custom, $custom_content)
1455 unlink $old_filename;
1459 $custom_content ||= $self->_default_custom_content($is_schema);
1461 # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
1462 # If there is already custom content, which does not have the Moose content, add it.
1463 if ($self->use_moose) {
1465 my $non_moose_custom_content = do {
1466 local $self->{use_moose} = 0;
1467 $self->_default_custom_content;
1470 if ($custom_content eq $non_moose_custom_content) {
1471 $custom_content = $self->_default_custom_content($is_schema);
1473 elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content($is_schema)]}\E/) {
1474 $custom_content .= $self->_default_custom_content($is_schema);
1477 elsif (defined $self->use_moose && $old_gen) {
1478 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'
1479 if $old_gen =~ /use \s+ MooseX?\b/x;
1482 $custom_content = $self->_rewrite_old_classnames($custom_content);
1485 for @{$self->{_dump_storage}->{$class} || []};
1487 # Check and see if the dump is infact differnt
1491 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1492 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1493 return unless $self->_upgrading_from && $is_schema;
1497 $text .= $self->_sig_comment(
1498 $self->version_to_dump,
1499 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1502 open(my $fh, '>', $filename)
1503 or croak "Cannot open '$filename' for writing: $!";
1505 # Write the top half and its MD5 sum
1506 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1508 # Write out anything loaded via external partial class file in @INC
1510 for @{$self->{_ext_storage}->{$class} || []};
1512 # Write out any custom content the user has added
1513 print $fh $custom_content;
1516 or croak "Error closing '$filename': $!";
1519 sub _default_moose_custom_content {
1520 my ($self, $is_schema) = @_;
1522 if (not $is_schema) {
1523 return qq|\n__PACKAGE__->meta->make_immutable;|;
1526 return qq|\n__PACKAGE__->meta->make_immutable(inline_constructor => 0);|;
1529 sub _default_custom_content {
1530 my ($self, $is_schema) = @_;
1531 my $default = qq|\n\n# You can replace this text with custom|
1532 . qq| code or comments, and it will be preserved on regeneration|;
1533 if ($self->use_moose) {
1534 $default .= $self->_default_moose_custom_content($is_schema);
1536 $default .= qq|\n1;\n|;
1540 sub _parse_generated_file {
1541 my ($self, $fn) = @_;
1543 return unless -f $fn;
1545 open(my $fh, '<', $fn)
1546 or croak "Cannot open '$fn' for reading: $!";
1549 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1551 my ($md5, $ts, $ver, $gen);
1557 # Pull out the version and timestamp from the line above
1558 ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m;
1561 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"
1562 if !$self->overwrite_modifications && Digest::MD5::md5_base64($gen) ne $md5;
1571 my $custom = do { local $/; <$fh> }
1576 return ($gen, $md5, $ver, $ts, $custom);
1584 warn "$target: use $_;" if $self->debug;
1585 $self->_raw_stmt($target, "use $_;");
1593 my $blist = join(q{ }, @_);
1595 return unless $blist;
1597 warn "$target: use base qw/$blist/;" if $self->debug;
1598 $self->_raw_stmt($target, "use base qw/$blist/;");
1605 my $rlist = join(q{, }, map { qq{'$_'} } @_);
1607 return unless $rlist;
1609 warn "$target: with $rlist;" if $self->debug;
1610 $self->_raw_stmt($target, "\nwith $rlist;");
1613 sub _result_namespace {
1614 my ($self, $schema_class, $ns) = @_;
1615 my @result_namespace;
1617 if ($ns =~ /^\+(.*)/) {
1618 # Fully qualified namespace
1619 @result_namespace = ($1)
1622 # Relative namespace
1623 @result_namespace = ($schema_class, $ns);
1626 return wantarray ? @result_namespace : join '::', @result_namespace;
1629 # Create class with applicable bases, setup monikers, etc
1630 sub _make_src_class {
1631 my ($self, $table) = @_;
1633 my $schema = $self->schema;
1634 my $schema_class = $self->schema_class;
1636 my $table_moniker = $self->_table2moniker($table);
1637 my @result_namespace = ($schema_class);
1638 if ($self->use_namespaces) {
1639 my $result_namespace = $self->result_namespace || 'Result';
1640 @result_namespace = $self->_result_namespace(
1645 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1647 if ((my $upgrading_v = $self->_upgrading_from)
1648 || $self->_rewriting) {
1649 local $self->naming->{monikers} = $upgrading_v
1652 my @result_namespace = @result_namespace;
1653 if ($self->_upgrading_from_load_classes) {
1654 @result_namespace = ($schema_class);
1656 elsif (my $ns = $self->_downgrading_to_load_classes) {
1657 @result_namespace = $self->_result_namespace(
1662 elsif ($ns = $self->_rewriting_result_namespace) {
1663 @result_namespace = $self->_result_namespace(
1669 my $old_class = join(q{::}, @result_namespace,
1670 $self->_table2moniker($table));
1672 $self->_upgrading_classes->{$table_class} = $old_class
1673 unless $table_class eq $old_class;
1676 $self->classes->{$table} = $table_class;
1677 $self->monikers->{$table} = $table_moniker;
1679 $self->_use ($table_class, @{$self->additional_classes});
1680 $self->_inject($table_class, @{$self->left_base_classes});
1682 my @components = @{ $self->components || [] };
1684 push @components, @{ $self->result_components_map->{$table_moniker} }
1685 if exists $self->result_components_map->{$table_moniker};
1687 $self->_dbic_stmt($table_class, 'load_components', @components) if @components;
1689 $self->_inject($table_class, @{$self->additional_base_classes});
1691 my @roles = @{ $self->result_roles || [] };
1692 push @roles, @{ $self->result_roles_map->{$table_moniker} }
1693 if exists $self->result_roles_map->{$table_moniker};
1695 $self->_with($table_class, @roles) if @roles;
1698 sub _is_result_class_method {
1699 my ($self, $name, $table_name) = @_;
1701 my $table_moniker = $table_name ? $self->_table2moniker($table_name) : '';
1703 $self->_result_class_methods({})
1704 if not defined $self->_result_class_methods;
1706 if (not exists $self->_result_class_methods->{$table_moniker}) {
1707 my (@methods, %methods);
1708 my $base = $self->result_base_class || 'DBIx::Class::Core';
1710 my @components = @{ $self->components || [] };
1712 push @components, @{ $self->result_components_map->{$table_moniker} }
1713 if exists $self->result_components_map->{$table_moniker};
1715 for my $c (@components) {
1716 $c = $c =~ /^\+/ ? substr($c,1) : "DBIx::Class::$c";
1719 my @roles = @{ $self->result_roles || [] };
1721 push @roles, @{ $self->result_roles_map->{$table_moniker} }
1722 if exists $self->result_roles_map->{$table_moniker};
1724 for my $class ($base, @components,
1725 ($self->use_moose ? 'Moose::Object' : ()), @roles) {
1726 $self->ensure_class_loaded($class);
1728 push @methods, @{ Class::Inspector->methods($class) || [] };
1731 push @methods, @{ Class::Inspector->methods('UNIVERSAL') };
1733 @methods{@methods} = ();
1735 $self->_result_class_methods->{$table_moniker} = \%methods;
1737 my $result_methods = $self->_result_class_methods->{$table_moniker};
1739 return exists $result_methods->{$name};
1742 sub _resolve_col_accessor_collisions {
1743 my ($self, $table, $col_info) = @_;
1745 my $table_name = ref $table ? $$table : $table;
1747 while (my ($col, $info) = each %$col_info) {
1748 my $accessor = $info->{accessor} || $col;
1750 next if $accessor eq 'id'; # special case (very common column)
1752 if ($self->_is_result_class_method($accessor, $table_name)) {
1755 if (my $map = $self->col_collision_map) {
1756 for my $re (keys %$map) {
1757 if (my @matches = $col =~ /$re/) {
1758 $info->{accessor} = sprintf $map->{$re}, @matches;
1766 Column '$col' in table '$table_name' collides with an inherited method.
1767 See "COLUMN ACCESSOR COLLISIONS" in perldoc DBIx::Class::Schema::Loader::Base .
1769 $info->{accessor} = undef;
1775 # use the same logic to run moniker_map, col_accessor_map, and
1776 # relationship_name_map
1778 my ( $self, $map, $default_code, $ident, @extra ) = @_;
1780 my $default_ident = $default_code->( $ident, @extra );
1782 if( $map && ref $map eq 'HASH' ) {
1783 $new_ident = $map->{ $ident };
1785 elsif( $map && ref $map eq 'CODE' ) {
1786 $new_ident = $map->( $ident, $default_ident, @extra );
1789 $new_ident ||= $default_ident;
1794 sub _default_column_accessor_name {
1795 my ( $self, $column_name ) = @_;
1797 my $accessor_name = $column_name;
1798 $accessor_name =~ s/\W+/_/g;
1800 if ((($self->naming->{column_accessors}||'') =~ /(\d+)/ && $1 < 7) || (not $self->preserve_case)) {
1801 # older naming just lc'd the col accessor and that's all.
1802 return lc $accessor_name;
1805 return join '_', map lc, split_name $column_name;
1809 sub _make_column_accessor_name {
1810 my ($self, $column_name, $column_context_info ) = @_;
1812 my $accessor = $self->_run_user_map(
1813 $self->col_accessor_map,
1814 sub { $self->_default_column_accessor_name( shift ) },
1816 $column_context_info,
1822 # Set up metadata (cols, pks, etc)
1823 sub _setup_src_meta {
1824 my ($self, $table) = @_;
1826 my $schema = $self->schema;
1827 my $schema_class = $self->schema_class;
1829 my $table_class = $self->classes->{$table};
1830 my $table_moniker = $self->monikers->{$table};
1832 my $table_name = $table;
1833 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1835 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1836 $table_name = \ $self->_quote_table_name($table_name);
1839 my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name);
1841 # be careful to not create refs Data::Dump can "optimize"
1842 $full_table_name = \do {"".$full_table_name} if ref $table_name;
1844 $self->_dbic_stmt($table_class, 'table', $full_table_name);
1846 my $cols = $self->_table_columns($table);
1847 my $col_info = $self->__columns_info_for($table);
1849 ### generate all the column accessor names
1850 while (my ($col, $info) = each %$col_info) {
1851 # hashref of other info that could be used by
1852 # user-defined accessor map functions
1854 table_class => $table_class,
1855 table_moniker => $table_moniker,
1856 table_name => $table_name,
1857 full_table_name => $full_table_name,
1858 schema_class => $schema_class,
1859 column_info => $info,
1862 $info->{accessor} = $self->_make_column_accessor_name( $col, $context );
1865 $self->_resolve_col_accessor_collisions($full_table_name, $col_info);
1867 # prune any redundant accessor names
1868 while (my ($col, $info) = each %$col_info) {
1869 no warnings 'uninitialized';
1870 delete $info->{accessor} if $info->{accessor} eq $col;
1873 my $fks = $self->_table_fk_info($table);
1875 foreach my $fkdef (@$fks) {
1876 for my $col (@{ $fkdef->{local_columns} }) {
1877 $col_info->{$col}{is_foreign_key} = 1;
1881 my $pks = $self->_table_pk_info($table) || [];
1883 foreach my $pkcol (@$pks) {
1884 $col_info->{$pkcol}{is_nullable} = 0;
1890 map { $_, ($col_info->{$_}||{}) } @$cols
1893 my %uniq_tag; # used to eliminate duplicate uniqs
1895 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1896 : carp("$table has no primary key");
1897 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1899 my $uniqs = $self->_table_uniq_info($table) || [];
1901 my ($name, $cols) = @$_;
1902 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1903 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1908 sub __columns_info_for {
1909 my ($self, $table) = @_;
1911 my $result = $self->_columns_info_for($table);
1913 while (my ($col, $info) = each %$result) {
1914 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
1915 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
1917 $result->{$col} = $info;
1925 Returns a sorted list of loaded tables, using the original database table
1933 return keys %{$self->_tables};
1936 # Make a moniker from a table
1937 sub _default_table2moniker {
1938 no warnings 'uninitialized';
1939 my ($self, $table) = @_;
1941 if ($self->naming->{monikers} eq 'v4') {
1942 return join '', map ucfirst, split /[\W_]+/, lc $table;
1944 elsif ($self->naming->{monikers} eq 'v5') {
1945 return join '', map ucfirst, split /[\W_]+/,
1946 Lingua::EN::Inflect::Number::to_S(lc $table);
1948 elsif ($self->naming->{monikers} eq 'v6') {
1949 (my $as_phrase = lc $table) =~ s/_+/ /g;
1950 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1952 return join '', map ucfirst, split /\W+/, $inflected;
1955 my @words = map lc, split_name $table;
1956 my $as_phrase = join ' ', @words;
1958 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1960 return join '', map ucfirst, split /\W+/, $inflected;
1963 sub _table2moniker {
1964 my ( $self, $table ) = @_;
1966 $self->_run_user_map(
1968 sub { $self->_default_table2moniker( shift ) },
1973 sub _load_relationships {
1974 my ($self, $table) = @_;
1976 my $tbl_fk_info = $self->_table_fk_info($table);
1977 foreach my $fkdef (@$tbl_fk_info) {
1978 $fkdef->{remote_source} =
1979 $self->monikers->{delete $fkdef->{remote_table}};
1981 my $tbl_uniq_info = $self->_table_uniq_info($table);
1983 my $local_moniker = $self->monikers->{$table};
1984 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1986 foreach my $src_class (sort keys %$rel_stmts) {
1987 my $src_stmts = $rel_stmts->{$src_class};
1988 foreach my $stmt (@$src_stmts) {
1989 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1994 # Overload these in driver class:
1996 # Returns an arrayref of column names
1997 sub _table_columns { croak "ABSTRACT METHOD" }
1999 # Returns arrayref of pk col names
2000 sub _table_pk_info { croak "ABSTRACT METHOD" }
2002 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
2003 sub _table_uniq_info { croak "ABSTRACT METHOD" }
2005 # Returns an arrayref of foreign key constraints, each
2006 # being a hashref with 3 keys:
2007 # local_columns (arrayref), remote_columns (arrayref), remote_table
2008 sub _table_fk_info { croak "ABSTRACT METHOD" }
2010 # Returns an array of lower case table names
2011 sub _tables_list { croak "ABSTRACT METHOD" }
2013 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
2019 # generate the pod for this statement, storing it with $self->_pod
2020 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
2022 my $args = dump(@_);
2023 $args = '(' . $args . ')' if @_ < 2;
2024 my $stmt = $method . $args . q{;};
2026 warn qq|$class\->$stmt\n| if $self->debug;
2027 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
2031 # generates the accompanying pod for a DBIC class method statement,
2032 # storing it with $self->_pod
2038 if ( $method eq 'table' ) {
2040 my $pcm = $self->pod_comment_mode;
2041 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
2042 $comment = $self->__table_comment($table);
2043 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
2044 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
2045 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
2046 $self->_pod( $class, "=head1 NAME" );
2047 my $table_descr = $class;
2048 $table_descr .= " - " . $comment if $comment and $comment_in_name;
2049 $self->{_class2table}{ $class } = $table;
2050 $self->_pod( $class, $table_descr );
2051 if ($comment and $comment_in_desc) {
2052 $self->_pod( $class, "=head1 DESCRIPTION" );
2053 $self->_pod( $class, $comment );
2055 $self->_pod_cut( $class );
2056 } elsif ( $method eq 'add_columns' ) {
2057 $self->_pod( $class, "=head1 ACCESSORS" );
2058 my $col_counter = 0;
2060 while( my ($name,$attrs) = splice @cols,0,2 ) {
2062 $self->_pod( $class, '=head2 ' . $name );
2063 $self->_pod( $class,
2065 my $s = $attrs->{$_};
2066 $s = !defined $s ? 'undef' :
2067 length($s) == 0 ? '(empty string)' :
2068 ref($s) eq 'SCALAR' ? $$s :
2069 ref($s) ? dumper_squashed $s :
2070 looks_like_number($s) ? $s : qq{'$s'};
2073 } sort keys %$attrs,
2075 if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter, $name)) {
2076 $self->_pod( $class, $comment );
2079 $self->_pod_cut( $class );
2080 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
2081 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
2082 my ( $accessor, $rel_class ) = @_;
2083 $self->_pod( $class, "=head2 $accessor" );
2084 $self->_pod( $class, 'Type: ' . $method );
2085 $self->_pod( $class, "Related object: L<$rel_class>" );
2086 $self->_pod_cut( $class );
2087 $self->{_relations_started} { $class } = 1;
2091 sub _filter_comment {
2092 my ($self, $txt) = @_;
2094 $txt = '' if not defined $txt;
2096 $txt =~ s/(?:\015?\012|\015\012?)/\n/g;
2101 sub __table_comment {
2104 if (my $code = $self->can('_table_comment')) {
2105 return $self->_filter_comment($self->$code(@_));
2111 sub __column_comment {
2114 if (my $code = $self->can('_column_comment')) {
2115 return $self->_filter_comment($self->$code(@_));
2121 # Stores a POD documentation
2123 my ($self, $class, $stmt) = @_;
2124 $self->_raw_stmt( $class, "\n" . $stmt );
2128 my ($self, $class ) = @_;
2129 $self->_raw_stmt( $class, "\n=cut\n" );
2132 # Store a raw source line for a class (for dumping purposes)
2134 my ($self, $class, $stmt) = @_;
2135 push(@{$self->{_dump_storage}->{$class}}, $stmt);
2138 # Like above, but separately for the externally loaded stuff
2140 my ($self, $class, $stmt) = @_;
2141 push(@{$self->{_ext_storage}->{$class}}, $stmt);
2144 sub _quote_table_name {
2145 my ($self, $table) = @_;
2147 my $qt = $self->schema->storage->sql_maker->quote_char;
2149 return $table unless $qt;
2152 return $qt->[0] . $table . $qt->[1];
2155 return $qt . $table . $qt;
2158 sub _custom_column_info {
2159 my ( $self, $table_name, $column_name, $column_info ) = @_;
2161 if (my $code = $self->custom_column_info) {
2162 return $code->($table_name, $column_name, $column_info) || {};
2167 sub _datetime_column_info {
2168 my ( $self, $table_name, $column_name, $column_info ) = @_;
2170 my $type = $column_info->{data_type} || '';
2171 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
2172 or ($type =~ /date|timestamp/i)) {
2173 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
2174 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
2180 my ($self, $name) = @_;
2182 return $self->preserve_case ? $name : lc($name);
2186 my ($self, $name) = @_;
2188 return $self->preserve_case ? $name : uc($name);
2191 sub _unregister_source_for_table {
2192 my ($self, $table) = @_;
2196 my $schema = $self->schema;
2197 # in older DBIC it's a private method
2198 my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
2199 $schema->$unregister($self->_table2moniker($table));
2200 delete $self->monikers->{$table};
2201 delete $self->classes->{$table};
2202 delete $self->_upgrading_classes->{$table};
2203 delete $self->{_tables}{$table};
2207 # remove the dump dir from @INC on destruction
2211 @INC = grep $_ ne $self->dump_directory, @INC;
2216 Returns a hashref of loaded table to moniker mappings. There will
2217 be two entries for each table, the original name and the "normalized"
2218 name, in the case that the two are different (such as databases
2219 that like uppercase table names, or preserve your original mixed-case
2220 definitions, or what-have-you).
2224 Returns a hashref of table to class mappings. In some cases it will
2225 contain multiple entries per table for the original and normalized table
2226 names, as above in L</monikers>.
2228 =head1 COLUMN ACCESSOR COLLISIONS
2230 Occasionally you may have a column name that collides with a perl method, such
2231 as C<can>. In such cases, the default action is to set the C<accessor> of the
2232 column spec to C<undef>.
2234 You can then name the accessor yourself by placing code such as the following
2237 __PACKAGE__->add_column('+can' => { accessor => 'my_can' });
2239 Another option is to use the L</col_collision_map> option.
2241 =head1 RELATIONSHIP NAME COLLISIONS
2243 In very rare cases, you may get a collision between a generated relationship
2244 name and a method in your Result class, for example if you have a foreign key
2245 called C<belongs_to>.
2247 This is a problem because relationship names are also relationship accessor
2248 methods in L<DBIx::Class>.
2250 The default behavior is to append C<_rel> to the relationship name and print
2251 out a warning that refers to this text.
2253 You can also control the renaming with the L</rel_collision_map> option.
2257 L<DBIx::Class::Schema::Loader>
2261 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
2265 This library is free software; you can redistribute it and/or modify it under
2266 the same terms as Perl itself.
2271 # vim:et sts=4 sw=4 tw=0: