1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Grouped Class::C3::Componentised/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use DBIx::Class::Schema::Loader::RelBuilder;
9 use Data::Dump qw/ dump /;
14 use Lingua::EN::Inflect::Number qw//;
15 use Lingua::EN::Inflect::Phrase qw//;
18 use Class::Inspector ();
19 use Scalar::Util 'looks_like_number';
20 use File::Slurp 'slurp';
21 use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_without_redefine_warnings/;
22 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
25 use Class::Load 'load_class';
28 our $VERSION = '0.07009';
30 __PACKAGE__->mk_group_ro_accessors('simple', qw/
37 additional_base_classes
52 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
92 datetime_undef_if_invalid
98 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
102 See L<DBIx::Class::Schema::Loader>
106 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
107 classes, and implements the common functionality between them.
109 =head1 CONSTRUCTOR OPTIONS
111 These constructor options are the base options for
112 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
114 =head2 skip_relationships
116 Skip setting up relationships. The default is to attempt the loading
119 =head2 skip_load_external
121 Skip loading of other classes in @INC. The default is to merge all other classes
122 with the same name found in @INC into the schema file we are creating.
126 Static schemas (ones dumped to disk) will, by default, use the new-style
127 relationship names and singularized Results, unless you're overwriting an
128 existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
129 which case the backward compatible RelBuilder will be activated, and the
130 appropriate monikerization used.
136 will disable the backward-compatible RelBuilder and use
137 the new-style relationship names along with singularized Results, even when
138 overwriting a dump made with an earlier version.
140 The option also takes a hashref:
142 naming => { relationships => 'v7', monikers => 'v7' }
150 How to name relationship accessors.
154 How to name Result classes.
156 =item column_accessors
158 How to name column accessors in Result classes.
168 Latest style, whatever that happens to be.
172 Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
176 Monikers singularized as whole words, C<might_have> relationships for FKs on
177 C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
179 Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
184 All monikers and relationships are inflected using
185 L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
186 from relationship names.
188 In general, there is very little difference between v5 and v6 schemas.
192 This mode is identical to C<v6> mode, except that monikerization of CamelCase
193 table names is also done correctly.
195 CamelCase column names in case-preserving mode will also be handled correctly
196 for relationship name inflection. See L</preserve_case>.
198 In this mode, CamelCase L</column_accessors> are normalized based on case
199 transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
201 If you don't have any CamelCase table or column names, you can upgrade without
202 breaking any of your code.
206 Dynamic schemas will always default to the 0.04XXX relationship names and won't
207 singularize Results for backward compatibility, to activate the new RelBuilder
208 and singularization put this in your C<Schema.pm> file:
210 __PACKAGE__->naming('current');
212 Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
213 next major version upgrade:
215 __PACKAGE__->naming('v7');
219 By default POD will be generated for columns and relationships, using database
220 metadata for the text if available and supported.
222 Reading database metadata (e.g. C<COMMENT ON TABLE some_table ...>) is only
223 supported for Postgres right now.
225 Set this to C<0> to turn off all POD generation.
227 =head2 pod_comment_mode
229 Controls where table comments appear in the generated POD. Smaller table
230 comments are appended to the C<NAME> section of the documentation, and larger
231 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
232 section to be generated with the comment always, only use C<NAME>, or choose
233 the length threshold at which the comment is forced into the description.
239 Use C<NAME> section only.
243 Force C<DESCRIPTION> always.
247 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
252 =head2 pod_comment_spillover_length
254 When pod_comment_mode is set to C<auto>, this is the length of the comment at
255 which it will be forced into a separate description section.
259 =head2 relationship_attrs
261 Hashref of attributes to pass to each generated relationship, listed
262 by type. Also supports relationship type 'all', containing options to
263 pass to all generated relationships. Attributes set for more specific
264 relationship types override those set in 'all'.
268 relationship_attrs => {
269 belongs_to => { is_deferrable => 0 },
272 use this to turn off DEFERRABLE on your foreign key constraints.
276 If set to true, each constructive L<DBIx::Class> statement the loader
277 decides to execute will be C<warn>-ed before execution.
281 Set the name of the schema to load (schema in the sense that your database
282 vendor means it). Does not currently support loading more than one schema
287 Only load tables matching regex. Best specified as a qr// regex.
291 Exclude tables matching regex. Best specified as a qr// regex.
295 Overrides the default table name to moniker translation. Can be either
296 a hashref of table keys and moniker values, or a coderef for a translator
297 function taking a single scalar table name argument and returning
298 a scalar moniker. If the hash entry does not exist, or the function
299 returns a false value, the code falls back to default behavior
302 The default behavior is to split on case transition and non-alphanumeric
303 boundaries, singularize the resulting phrase, then join the titlecased words
306 Table Name | Moniker Name
307 ---------------------------------
309 luser_group | LuserGroup
310 luser-opts | LuserOpt
311 stations_visited | StationVisited
312 routeChange | RouteChange
314 =head2 col_accessor_map
316 Same as moniker_map, but for column accessor names. If a coderef is
317 passed, the code is called with arguments of
319 the name of the column in the underlying database,
320 default accessor name that DBICSL would ordinarily give this column,
322 table_class => name of the DBIC class we are building,
323 table_moniker => calculated moniker for this table (after moniker_map if present),
324 table_name => name of the database table,
325 full_table_name => schema-qualified name of the database table (RDBMS specific),
326 schema_class => name of the schema class we are building,
327 column_info => hashref of column info (data_type, is_nullable, etc),
330 =head2 inflect_plural
332 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
333 if hash key does not exist or coderef returns false), but acts as a map
334 for pluralizing relationship names. The default behavior is to utilize
335 L<Lingua::EN::Inflect::Phrase/to_PL>.
337 =head2 inflect_singular
339 As L</inflect_plural> above, but for singularizing relationship names.
340 Default behavior is to utilize L<Lingua::EN::Inflect::Phrase/to_S>.
342 =head2 schema_base_class
344 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
346 =head2 result_base_class
348 Base class for your table classes (aka result classes). Defaults to
351 =head2 additional_base_classes
353 List of additional base classes all of your table classes will use.
355 =head2 left_base_classes
357 List of additional base classes all of your table classes will use
358 that need to be leftmost.
360 =head2 additional_classes
362 List of additional classes which all of your table classes will use.
366 List of additional components to be loaded into all of your table
367 classes. A good example would be
368 L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
370 =head2 result_component_map
372 A hashref of moniker keys and component values. Unlike C<components>, which loads the
373 given components into every table class, this option allows you to load certain
374 components for specified tables. For example:
376 result_component_map => {
377 StationVisited => '+YourApp::Schema::Component::StationVisited',
379 '+YourApp::Schema::Component::RouteChange',
380 'InflateColumn::DateTime',
384 You may use this in conjunction with C<components>.
386 =head2 use_namespaces
388 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
391 Generate result class names suitable for
392 L<DBIx::Class::Schema/load_namespaces> and call that instead of
393 L<DBIx::Class::Schema/load_classes>. When using this option you can also
394 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
395 C<resultset_namespace>, C<default_resultset_class>), and they will be added
396 to the call (and the generated result class names adjusted appropriately).
398 =head2 dump_directory
400 The value of this option is a perl libdir pathname. Within
401 that directory this module will create a baseline manual
402 L<DBIx::Class::Schema> module set, based on what it creates at runtime.
404 The created schema class will have the same classname as the one on
405 which you are setting this option (and the ResultSource classes will be
406 based on this name as well).
408 Normally you wouldn't hard-code this setting in your schema class, as it
409 is meant for one-time manual usage.
411 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
412 recommended way to access this functionality.
414 =head2 dump_overwrite
416 Deprecated. See L</really_erase_my_files> below, which does *not* mean
417 the same thing as the old C<dump_overwrite> setting from previous releases.
419 =head2 really_erase_my_files
421 Default false. If true, Loader will unconditionally delete any existing
422 files before creating the new ones from scratch when dumping a schema to disk.
424 The default behavior is instead to only replace the top portion of the
425 file, up to and including the final stanza which contains
426 C<# DO NOT MODIFY THE FIRST PART OF THIS FILE>
427 leaving any customizations you placed after that as they were.
429 When C<really_erase_my_files> is not set, if the output file already exists,
430 but the aforementioned final stanza is not found, or the checksum
431 contained there does not match the generated contents, Loader will
432 croak and not touch the file.
434 You should really be using version control on your schema classes (and all
435 of the rest of your code for that matter). Don't blame me if a bug in this
436 code wipes something out when it shouldn't have, you've been warned.
438 =head2 overwrite_modifications
440 Default false. If false, when updating existing files, Loader will
441 refuse to modify any Loader-generated code that has been modified
442 since its last run (as determined by the checksum Loader put in its
445 If true, Loader will discard any manual modifications that have been
446 made to Loader-generated code.
448 Again, you should be using version control on your schema classes. Be
449 careful with this option.
451 =head2 custom_column_info
453 Hook for adding extra attributes to the
454 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
456 Must be a coderef that returns a hashref with the extra attributes.
458 Receives the table name, column name and column_info.
462 custom_column_info => sub {
463 my ($table_name, $column_name, $column_info) = @_;
465 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
466 return { is_snoopy => 1 };
470 This attribute can also be used to set C<inflate_datetime> on a non-datetime
471 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
473 =head2 datetime_timezone
475 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
476 columns with the DATE/DATETIME/TIMESTAMP data_types.
478 =head2 datetime_locale
480 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
481 columns with the DATE/DATETIME/TIMESTAMP data_types.
483 =head2 datetime_undef_if_invalid
485 Pass a C<0> for this option when using MySQL if you B<DON'T> want C<<
486 datetime_undef_if_invalid => 1 >> in your column info for DATE, DATETIME and
489 The default is recommended to deal with data such as C<00/00/00> which
490 sometimes ends up in such columns in MySQL.
494 File in Perl format, which should return a HASH reference, from which to read
499 Usually column names are lowercased, to make them easier to work with in
500 L<DBIx::Class>. This option lets you turn this behavior off, if the driver
503 Drivers for case sensitive databases like Sybase ASE or MSSQL with a
504 case-sensitive collation will turn this option on unconditionally.
506 Currently the drivers for SQLite, mysql, MSSQL and Firebird/InterBase support
509 =head2 qualify_objects
511 Set to true to prepend the L</db_schema> to table names for C<<
512 __PACKAGE__->table >> calls, and to some other things like Oracle sequences.
516 Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and
517 L<namespace::autoclean>. The default content after the md5 sum also makes the
520 It is safe to upgrade your existing Schema to this option.
522 =head2 col_collision_map
524 This option controls how accessors for column names which collide with perl
525 methods are named. See L</COLUMN ACCESSOR COLLISIONS> for more information.
527 This option takes either a single L<sprintf|perlfunc/sprintf> format or a hashref of
528 strings which are compiled to regular expressions that map to
529 L<sprintf|perlfunc/sprintf> formats.
533 col_collision_map => 'column_%s'
535 col_collision_map => { '(.*)' => 'column_%s' }
537 col_collision_map => { '(foo).*(bar)' => 'column_%s_%s' }
539 =head2 rel_collision_map
541 Works just like L</col_collision_map>, but for relationship names/accessors
542 rather than column names/accessors.
544 The default is to just append C<_rel> to the relationship name, see
545 L</RELATIONSHIP NAME COLLISIONS>.
549 None of these methods are intended for direct invocation by regular
550 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
551 L<DBIx::Class::Schema::Loader>.
555 my $CURRENT_V = 'v7';
558 schema_base_class result_base_class additional_base_classes
559 left_base_classes additional_classes components
562 # ensure that a peice of object data is a valid arrayref, creating
563 # an empty one or encapsulating whatever's there.
564 sub _ensure_arrayref {
569 $self->{$_} = [ $self->{$_} ]
570 unless ref $self->{$_} eq 'ARRAY';
576 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
577 by L<DBIx::Class::Schema::Loader>.
582 my ( $class, %args ) = @_;
584 if (exists $args{column_accessor_map}) {
585 $args{col_accessor_map} = delete $args{column_accessor_map};
588 my $self = { %args };
590 # don't lose undef options
591 for (values %$self) {
592 $_ = 0 unless defined $_;
595 bless $self => $class;
597 if (my $config_file = $self->config_file) {
598 my $config_opts = do $config_file;
600 croak "Error reading config from $config_file: $@" if $@;
602 croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH';
604 while (my ($k, $v) = each %$config_opts) {
605 $self->{$k} = $v unless exists $self->{$k};
609 $self->_ensure_arrayref(qw/additional_classes
610 additional_base_classes
615 $self->_validate_class_args;
617 if ($self->result_component_map) {
618 my %rc_map = %{ $self->result_component_map };
619 foreach my $moniker (keys %rc_map) {
620 $rc_map{$moniker} = [ $rc_map{$moniker} ] unless ref $rc_map{$moniker};
622 $self->result_component_map(\%rc_map);
624 $self->_validate_result_component_map;
626 if ($self->use_moose) {
627 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) {
628 die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
629 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose');
633 $self->{monikers} = {};
634 $self->{classes} = {};
635 $self->{_upgrading_classes} = {};
637 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
638 $self->{schema} ||= $self->{schema_class};
640 croak "dump_overwrite is deprecated. Please read the"
641 . " DBIx::Class::Schema::Loader::Base documentation"
642 if $self->{dump_overwrite};
644 $self->{dynamic} = ! $self->{dump_directory};
645 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
650 $self->{dump_directory} ||= $self->{temp_directory};
652 $self->real_dump_directory($self->{dump_directory});
654 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
655 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
657 if ((not ref $self->naming) && defined $self->naming) {
658 my $naming_ver = $self->naming;
660 relationships => $naming_ver,
661 monikers => $naming_ver,
662 column_accessors => $naming_ver,
667 for (values %{ $self->naming }) {
668 $_ = $CURRENT_V if $_ eq 'current';
671 $self->{naming} ||= {};
673 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
674 croak 'custom_column_info must be a CODE ref';
677 $self->_check_back_compat;
679 $self->use_namespaces(1) unless defined $self->use_namespaces;
680 $self->generate_pod(1) unless defined $self->generate_pod;
681 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
682 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
684 if (my $col_collision_map = $self->col_collision_map) {
685 if (my $reftype = ref $col_collision_map) {
686 if ($reftype ne 'HASH') {
687 croak "Invalid type $reftype for option 'col_collision_map'";
691 $self->col_collision_map({ '(.*)' => $col_collision_map });
698 sub _check_back_compat {
701 # dynamic schemas will always be in 0.04006 mode, unless overridden
702 if ($self->dynamic) {
703 # just in case, though no one is likely to dump a dynamic schema
704 $self->schema_version_to_dump('0.04006');
706 if (not %{ $self->naming }) {
707 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
709 Dynamic schema detected, will run in 0.04006 mode.
711 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
712 to disable this warning.
714 Also consider setting 'use_namespaces => 1' if/when upgrading.
716 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
721 $self->_upgrading_from('v4');
724 $self->naming->{relationships} ||= 'v4';
725 $self->naming->{monikers} ||= 'v4';
727 if ($self->use_namespaces) {
728 $self->_upgrading_from_load_classes(1);
731 $self->use_namespaces(0);
737 # otherwise check if we need backcompat mode for a static schema
738 my $filename = $self->_get_dump_filename($self->schema_class);
739 return unless -e $filename;
741 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) =
742 $self->_parse_generated_file($filename);
744 return unless $old_ver;
746 # determine if the existing schema was dumped with use_moose => 1
747 if (! defined $self->use_moose) {
748 $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm;
751 my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0;
752 my $result_namespace = do { ($old_gen =~ /result_namespace => '([^']+)'/) ? $1 : '' };
754 if ($load_classes && (not defined $self->use_namespaces)) {
755 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
757 'load_classes;' static schema detected, turning off 'use_namespaces'.
759 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
760 variable to disable this warning.
762 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
765 $self->use_namespaces(0);
767 elsif ($load_classes && $self->use_namespaces) {
768 $self->_upgrading_from_load_classes(1);
770 elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) {
771 $self->_downgrading_to_load_classes(
772 $result_namespace || 'Result'
775 elsif ((not defined $self->use_namespaces) || $self->use_namespaces) {
776 if (not $self->result_namespace) {
777 $self->result_namespace($result_namespace || 'Result');
779 elsif ($result_namespace ne $self->result_namespace) {
780 $self->_rewriting_result_namespace(
781 $result_namespace || 'Result'
786 # XXX when we go past .0 this will need fixing
787 my ($v) = $old_ver =~ /([1-9])/;
790 return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/);
792 if (not %{ $self->naming }) {
793 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
795 Version $old_ver static schema detected, turning on backcompat mode.
797 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
798 to disable this warning.
800 See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
802 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
803 from version 0.04006.
806 $self->naming->{relationships} ||= $v;
807 $self->naming->{monikers} ||= $v;
808 $self->naming->{column_accessors} ||= $v;
810 $self->schema_version_to_dump($old_ver);
813 $self->_upgrading_from($v);
817 sub _validate_class_args {
820 foreach my $k (@CLASS_ARGS) {
821 next unless $self->$k;
823 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
824 $self->_validate_classes($k, \@classes);
828 sub _validate_result_component_map {
831 my $map = $self->result_component_map;
832 return unless $map && ref $map eq 'HASH';
834 foreach my $classes (values %$map) {
835 $self->_validate_classes('result_component_map', [@$classes]);
839 sub _validate_classes {
844 foreach my $c (@$classes) {
845 # components default to being under the DBIx::Class namespace unless they
846 # are preceeded with a '+'
847 if ( $key =~ m/component/ && $c !~ s/^\+// ) {
848 $c = 'DBIx::Class::' . $c;
851 # 1 == installed, 0 == not installed, undef == invalid classname
852 my $installed = Class::Inspector->installed($c);
853 if ( defined($installed) ) {
854 if ( $installed == 0 ) {
855 croak qq/$c, as specified in the loader option "$key", is not installed/;
858 croak qq/$c, as specified in the loader option "$key", is an invalid class name/;
864 sub _find_file_in_inc {
865 my ($self, $file) = @_;
867 foreach my $prefix (@INC) {
868 my $fullpath = File::Spec->catfile($prefix, $file);
869 return $fullpath if -f $fullpath
870 # abs_path throws on Windows for nonexistant files
871 and (try { Cwd::abs_path($fullpath) }) ne
872 ((try { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) }) || '');
879 my ($self, $class) = @_;
881 my $class_path = $class;
882 $class_path =~ s{::}{/}g;
883 $class_path .= '.pm';
888 sub _find_class_in_inc {
889 my ($self, $class) = @_;
891 return $self->_find_file_in_inc($self->_class_path($class));
897 return $self->_upgrading_from
898 || $self->_upgrading_from_load_classes
899 || $self->_downgrading_to_load_classes
900 || $self->_rewriting_result_namespace
904 sub _rewrite_old_classnames {
905 my ($self, $code) = @_;
907 return $code unless $self->_rewriting;
909 my %old_classes = reverse %{ $self->_upgrading_classes };
911 my $re = join '|', keys %old_classes;
914 $code =~ s/$re/$old_classes{$1} || $1/eg;
920 my ($self, $class) = @_;
922 return if $self->{skip_load_external};
924 # so that we don't load our own classes, under any circumstances
925 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
927 my $real_inc_path = $self->_find_class_in_inc($class);
929 my $old_class = $self->_upgrading_classes->{$class}
930 if $self->_rewriting;
932 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
933 if $old_class && $old_class ne $class;
935 return unless $real_inc_path || $old_real_inc_path;
937 if ($real_inc_path) {
938 # If we make it to here, we loaded an external definition
939 warn qq/# Loaded external class definition for '$class'\n/
942 my $code = $self->_rewrite_old_classnames(scalar slurp $real_inc_path);
944 if ($self->dynamic) { # load the class too
945 eval_without_redefine_warnings($code);
948 $self->_ext_stmt($class,
949 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
950 .qq|# They are now part of the custom portion of this file\n|
951 .qq|# for you to hand-edit. If you do not either delete\n|
952 .qq|# this section or remove that file from \@INC, this section\n|
953 .qq|# will be repeated redundantly when you re-create this\n|
954 .qq|# file again via Loader! See skip_load_external to disable\n|
955 .qq|# this feature.\n|
958 $self->_ext_stmt($class, $code);
959 $self->_ext_stmt($class,
960 qq|# End of lines loaded from '$real_inc_path' |
964 if ($old_real_inc_path) {
965 my $code = slurp $old_real_inc_path;
967 $self->_ext_stmt($class, <<"EOF");
969 # These lines were loaded from '$old_real_inc_path',
970 # based on the Result class name that would have been created by an older
971 # version of the Loader. For a static schema, this happens only once during
972 # upgrade. See skip_load_external to disable this feature.
975 $code = $self->_rewrite_old_classnames($code);
977 if ($self->dynamic) {
980 Detected external content in '$old_real_inc_path', a class name that would have
981 been used by an older version of the Loader.
983 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
984 new name of the Result.
986 eval_without_redefine_warnings($code);
990 $self->_ext_stmt($class, $code);
991 $self->_ext_stmt($class,
992 qq|# End of lines loaded from '$old_real_inc_path' |
999 Does the actual schema-construction work.
1006 $self->_load_tables(
1007 $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude })
1015 Rescan the database for changes. Returns a list of the newly added table
1018 The schema argument should be the schema class or object to be affected. It
1019 should probably be derived from the original schema_class used during L</load>.
1024 my ($self, $schema) = @_;
1026 $self->{schema} = $schema;
1027 $self->_relbuilder->{schema} = $schema;
1030 my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude });
1032 foreach my $table (@current) {
1033 if(!exists $self->{_tables}->{$table}) {
1034 push(@created, $table);
1039 @current{@current} = ();
1040 foreach my $table (keys %{ $self->{_tables} }) {
1041 if (not exists $current{$table}) {
1042 $self->_unregister_source_for_table($table);
1046 delete $self->{_dump_storage};
1047 delete $self->{_relations_started};
1049 my $loaded = $self->_load_tables(@current);
1051 return map { $self->monikers->{$_} } @created;
1057 return if $self->{skip_relationships};
1059 return $self->{relbuilder} ||= do {
1061 no warnings 'uninitialized';
1062 my $relbuilder_suff =
1068 ->{ $self->naming->{relationships}};
1070 my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff;
1071 load_class $relbuilder_class;
1072 $relbuilder_class->new( $self );
1078 my ($self, @tables) = @_;
1080 # Save the new tables to the tables list
1082 $self->{_tables}->{$_} = 1;
1085 $self->_make_src_class($_) for @tables;
1087 # sanity-check for moniker clashes
1088 my $inverse_moniker_idx;
1089 for (keys %{$self->monikers}) {
1090 push @{$inverse_moniker_idx->{$self->monikers->{$_}}}, $_;
1094 for (keys %$inverse_moniker_idx) {
1095 my $tables = $inverse_moniker_idx->{$_};
1097 push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'",
1098 join (', ', map { "'$_'" } @$tables),
1105 die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. '
1106 . 'Either change the naming style, or supply an explicit moniker_map: '
1107 . join ('; ', @clashes)
1113 $self->_setup_src_meta($_) for @tables;
1115 if(!$self->skip_relationships) {
1116 # The relationship loader needs a working schema
1118 local $self->{dump_directory} = $self->{temp_directory};
1119 $self->_reload_classes(\@tables);
1120 $self->_load_relationships($_) for @tables;
1121 $self->_relbuilder->cleanup;
1124 # Remove that temp dir from INC so it doesn't get reloaded
1125 @INC = grep $_ ne $self->dump_directory, @INC;
1128 $self->_load_external($_)
1129 for map { $self->classes->{$_} } @tables;
1131 # Reload without unloading first to preserve any symbols from external
1133 $self->_reload_classes(\@tables, { unload => 0 });
1135 # Drop temporary cache
1136 delete $self->{_cache};
1141 sub _reload_classes {
1142 my ($self, $tables, $opts) = @_;
1144 my @tables = @$tables;
1146 my $unload = $opts->{unload};
1147 $unload = 1 unless defined $unload;
1149 # so that we don't repeat custom sections
1150 @INC = grep $_ ne $self->dump_directory, @INC;
1152 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
1154 unshift @INC, $self->dump_directory;
1157 my %have_source = map { $_ => $self->schema->source($_) }
1158 $self->schema->sources;
1160 for my $table (@tables) {
1161 my $moniker = $self->monikers->{$table};
1162 my $class = $self->classes->{$table};
1165 no warnings 'redefine';
1166 local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below
1169 if (my $mc = $self->_moose_metaclass($class)) {
1172 Class::Unload->unload($class) if $unload;
1173 my ($source, $resultset_class);
1175 ($source = $have_source{$moniker})
1176 && ($resultset_class = $source->resultset_class)
1177 && ($resultset_class ne 'DBIx::Class::ResultSet')
1179 my $has_file = Class::Inspector->loaded_filename($resultset_class);
1180 if (my $mc = $self->_moose_metaclass($resultset_class)) {
1183 Class::Unload->unload($resultset_class) if $unload;
1184 $self->_reload_class($resultset_class) if $has_file;
1186 $self->_reload_class($class);
1188 push @to_register, [$moniker, $class];
1191 Class::C3->reinitialize;
1192 for (@to_register) {
1193 $self->schema->register_class(@$_);
1197 sub _moose_metaclass {
1198 return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place
1202 my $mc = try { Class::MOP::class_of($class) }
1205 return $mc->isa('Moose::Meta::Class') ? $mc : undef;
1208 # We use this instead of ensure_class_loaded when there are package symbols we
1211 my ($self, $class) = @_;
1213 my $class_path = $self->_class_path($class);
1214 delete $INC{ $class_path };
1216 # kill redefined warnings
1218 eval_without_redefine_warnings ("require $class");
1221 my $source = slurp $self->_get_dump_filename($class);
1222 die "Failed to reload class $class: $_.\n\nCLASS SOURCE:\n\n$source";
1226 sub _get_dump_filename {
1227 my ($self, $class) = (@_);
1229 $class =~ s{::}{/}g;
1230 return $self->dump_directory . q{/} . $class . q{.pm};
1233 =head2 get_dump_filename
1237 Returns the full path to the file for a class that the class has been or will
1238 be dumped to. This is a file in a temp dir for a dynamic schema.
1242 sub get_dump_filename {
1243 my ($self, $class) = (@_);
1245 local $self->{dump_directory} = $self->real_dump_directory;
1247 return $self->_get_dump_filename($class);
1250 sub _ensure_dump_subdirs {
1251 my ($self, $class) = (@_);
1253 my @name_parts = split(/::/, $class);
1254 pop @name_parts; # we don't care about the very last element,
1255 # which is a filename
1257 my $dir = $self->dump_directory;
1260 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1262 last if !@name_parts;
1263 $dir = File::Spec->catdir($dir, shift @name_parts);
1268 my ($self, @classes) = @_;
1270 my $schema_class = $self->schema_class;
1271 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1273 my $target_dir = $self->dump_directory;
1274 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1275 unless $self->{dynamic} or $self->{quiet};
1278 qq|package $schema_class;\n\n|
1279 . qq|# Created by DBIx::Class::Schema::Loader\n|
1280 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|;
1282 if ($self->use_moose) {
1283 $schema_text.= qq|use Moose;\nuse namespace::autoclean;\nextends '$schema_base_class';\n\n|;
1286 $schema_text .= qq|use strict;\nuse warnings;\n\nuse base '$schema_base_class';\n\n|;
1289 if ($self->use_namespaces) {
1290 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1291 my $namespace_options;
1293 my @attr = qw/resultset_namespace default_resultset_class/;
1295 unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result';
1297 for my $attr (@attr) {
1299 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
1302 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1303 $schema_text .= qq|;\n|;
1306 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1310 local $self->{version_to_dump} = $self->schema_version_to_dump;
1311 $self->_write_classfile($schema_class, $schema_text, 1);
1314 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1316 foreach my $src_class (@classes) {
1318 qq|package $src_class;\n\n|
1319 . qq|# Created by DBIx::Class::Schema::Loader\n|
1320 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
1321 . qq|use strict;\nuse warnings;\n\n|;
1322 if ($self->use_moose) {
1323 $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse namespace::autoclean;|;
1325 # these options 'use base' which is compile time
1326 if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) {
1327 $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n\n|;
1330 $src_text .= qq|\nextends '$result_base_class';\n\n|;
1334 $src_text .= qq|use base '$result_base_class';\n\n|;
1336 $self->_write_classfile($src_class, $src_text);
1339 # remove Result dir if downgrading from use_namespaces, and there are no
1341 if (my $result_ns = $self->_downgrading_to_load_classes
1342 || $self->_rewriting_result_namespace) {
1343 my $result_namespace = $self->_result_namespace(
1348 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1349 $result_dir = $self->dump_directory . '/' . $result_dir;
1351 unless (my @files = glob "$result_dir/*") {
1356 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
1361 my ($self, $version, $ts) = @_;
1362 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1365 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1368 sub _write_classfile {
1369 my ($self, $class, $text, $is_schema) = @_;
1371 my $filename = $self->_get_dump_filename($class);
1372 $self->_ensure_dump_subdirs($class);
1374 if (-f $filename && $self->really_erase_my_files) {
1375 warn "Deleting existing file '$filename' due to "
1376 . "'really_erase_my_files' setting\n" unless $self->{quiet};
1380 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom)
1381 = $self->_parse_generated_file($filename);
1383 if (! $old_gen && -f $filename) {
1384 croak "Cannot overwrite '$filename' without 'really_erase_my_files',"
1385 . " it does not appear to have been generated by Loader"
1388 my $custom_content = $old_custom || '';
1390 # prepend extra custom content from a *renamed* class (singularization effect)
1391 if (my $renamed_class = $self->_upgrading_classes->{$class}) {
1392 my $old_filename = $self->_get_dump_filename($renamed_class);
1394 if (-f $old_filename) {
1395 my $extra_custom = ($self->_parse_generated_file ($old_filename))[4];
1397 $extra_custom =~ s/\n\n# You can replace.*\n1;\n//;
1399 $custom_content = join ("\n", '', $extra_custom, $custom_content)
1402 unlink $old_filename;
1406 $custom_content ||= $self->_default_custom_content($is_schema);
1408 # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
1409 # If there is already custom content, which does not have the Moose content, add it.
1410 if ($self->use_moose) {
1412 my $non_moose_custom_content = do {
1413 local $self->{use_moose} = 0;
1414 $self->_default_custom_content;
1417 if ($custom_content eq $non_moose_custom_content) {
1418 $custom_content = $self->_default_custom_content($is_schema);
1420 elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content($is_schema)]}\E/) {
1421 $custom_content .= $self->_default_custom_content($is_schema);
1424 elsif (defined $self->use_moose && $old_gen) {
1425 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'
1426 if $old_gen =~ /use \s+ MooseX?\b/x;
1429 $custom_content = $self->_rewrite_old_classnames($custom_content);
1432 for @{$self->{_dump_storage}->{$class} || []};
1434 # Check and see if the dump is infact differnt
1438 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1439 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
1440 return unless $self->_upgrading_from && $is_schema;
1444 $text .= $self->_sig_comment(
1445 $self->version_to_dump,
1446 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1449 open(my $fh, '>', $filename)
1450 or croak "Cannot open '$filename' for writing: $!";
1452 # Write the top half and its MD5 sum
1453 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
1455 # Write out anything loaded via external partial class file in @INC
1457 for @{$self->{_ext_storage}->{$class} || []};
1459 # Write out any custom content the user has added
1460 print $fh $custom_content;
1463 or croak "Error closing '$filename': $!";
1466 sub _default_moose_custom_content {
1467 my ($self, $is_schema) = @_;
1469 if (not $is_schema) {
1470 return qq|\n__PACKAGE__->meta->make_immutable;|;
1473 return qq|\n__PACKAGE__->meta->make_immutable(inline_constructor => 0);|;
1476 sub _default_custom_content {
1477 my ($self, $is_schema) = @_;
1478 my $default = qq|\n\n# You can replace this text with custom|
1479 . qq| code or comments, and it will be preserved on regeneration|;
1480 if ($self->use_moose) {
1481 $default .= $self->_default_moose_custom_content($is_schema);
1483 $default .= qq|\n1;\n|;
1487 sub _parse_generated_file {
1488 my ($self, $fn) = @_;
1490 return unless -f $fn;
1492 open(my $fh, '<', $fn)
1493 or croak "Cannot open '$fn' for reading: $!";
1496 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
1498 my ($md5, $ts, $ver, $gen);
1504 # Pull out the version and timestamp from the line above
1505 ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\Z/m;
1508 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"
1509 if !$self->overwrite_modifications && Digest::MD5::md5_base64($gen) ne $md5;
1518 my $custom = do { local $/; <$fh> }
1523 return ($gen, $md5, $ver, $ts, $custom);
1531 warn "$target: use $_;" if $self->debug;
1532 $self->_raw_stmt($target, "use $_;");
1540 my $blist = join(q{ }, @_);
1542 return unless $blist;
1544 warn "$target: use base qw/$blist/;" if $self->debug;
1545 $self->_raw_stmt($target, "use base qw/$blist/;");
1548 sub _result_namespace {
1549 my ($self, $schema_class, $ns) = @_;
1550 my @result_namespace;
1552 if ($ns =~ /^\+(.*)/) {
1553 # Fully qualified namespace
1554 @result_namespace = ($1)
1557 # Relative namespace
1558 @result_namespace = ($schema_class, $ns);
1561 return wantarray ? @result_namespace : join '::', @result_namespace;
1564 # Create class with applicable bases, setup monikers, etc
1565 sub _make_src_class {
1566 my ($self, $table) = @_;
1568 my $schema = $self->schema;
1569 my $schema_class = $self->schema_class;
1571 my $table_moniker = $self->_table2moniker($table);
1572 my @result_namespace = ($schema_class);
1573 if ($self->use_namespaces) {
1574 my $result_namespace = $self->result_namespace || 'Result';
1575 @result_namespace = $self->_result_namespace(
1580 my $table_class = join(q{::}, @result_namespace, $table_moniker);
1582 if ((my $upgrading_v = $self->_upgrading_from)
1583 || $self->_rewriting) {
1584 local $self->naming->{monikers} = $upgrading_v
1587 my @result_namespace = @result_namespace;
1588 if ($self->_upgrading_from_load_classes) {
1589 @result_namespace = ($schema_class);
1591 elsif (my $ns = $self->_downgrading_to_load_classes) {
1592 @result_namespace = $self->_result_namespace(
1597 elsif ($ns = $self->_rewriting_result_namespace) {
1598 @result_namespace = $self->_result_namespace(
1604 my $old_class = join(q{::}, @result_namespace,
1605 $self->_table2moniker($table));
1607 $self->_upgrading_classes->{$table_class} = $old_class
1608 unless $table_class eq $old_class;
1611 # this was a bad idea, should be ok now without it
1612 # my $table_normalized = lc $table;
1613 # $self->classes->{$table_normalized} = $table_class;
1614 # $self->monikers->{$table_normalized} = $table_moniker;
1616 $self->classes->{$table} = $table_class;
1617 $self->monikers->{$table} = $table_moniker;
1619 $self->_use ($table_class, @{$self->additional_classes});
1620 $self->_inject($table_class, @{$self->left_base_classes});
1622 my @components = @{ $self->components || [] };
1623 foreach my $moniker (keys %{ $self->result_component_map || {} }) {
1624 next unless $moniker eq $table_moniker;
1625 push @components, @{ $self->result_component_map->{$moniker} };
1627 $self->_dbic_stmt($table_class, 'load_components', @components) if @components;
1629 $self->_inject($table_class, @{$self->additional_base_classes});
1632 sub _is_result_class_method {
1633 my ($self, $name, $table_name) = @_;
1635 my $table_moniker = $table_name ? $self->_table2moniker($table_name) : '';
1637 if (not $self->_result_class_methods) {
1638 my (@methods, %methods);
1639 my $base = $self->result_base_class || 'DBIx::Class::Core';
1640 my @components = map { /^\+/ ? substr($_,1) : "DBIx::Class::$_" } @{ $self->components || [] };
1641 foreach my $moniker (keys %{ $self->result_component_map || {} }) {
1642 next unless $moniker eq $table_moniker;
1643 push @components, @{ $self->result_component_map->{$moniker} };
1646 for my $class ($base, @components, $self->use_moose ? 'Moose::Object' : ()) {
1649 push @methods, @{ Class::Inspector->methods($class) || [] };
1652 push @methods, @{ Class::Inspector->methods('UNIVERSAL') };
1654 @methods{@methods} = ();
1657 $methods{meta} = undef;
1659 $self->_result_class_methods(\%methods);
1661 my $result_methods = $self->_result_class_methods;
1663 return exists $result_methods->{$name};
1666 sub _resolve_col_accessor_collisions {
1667 my ($self, $table, $col_info) = @_;
1669 my $table_name = ref $table ? $$table : $table;
1671 while (my ($col, $info) = each %$col_info) {
1672 my $accessor = $info->{accessor} || $col;
1674 next if $accessor eq 'id'; # special case (very common column)
1676 if ($self->_is_result_class_method($accessor, $table_name)) {
1679 if (my $map = $self->col_collision_map) {
1680 for my $re (keys %$map) {
1681 if (my @matches = $col =~ /$re/) {
1682 $info->{accessor} = sprintf $map->{$re}, @matches;
1690 Column '$col' in table '$table_name' collides with an inherited method.
1691 See "COLUMN ACCESSOR COLLISIONS" in perldoc DBIx::Class::Schema::Loader::Base .
1693 $info->{accessor} = undef;
1699 # use the same logic to run moniker_map, col_accessor_map, and
1700 # relationship_name_map
1702 my ( $self, $map, $default_code, $ident, @extra ) = @_;
1704 my $default_ident = $default_code->( $ident, @extra );
1706 if( $map && ref $map eq 'HASH' ) {
1707 $new_ident = $map->{ $ident };
1709 elsif( $map && ref $map eq 'CODE' ) {
1710 $new_ident = $map->( $ident, $default_ident, @extra );
1713 $new_ident ||= $default_ident;
1718 sub _default_column_accessor_name {
1719 my ( $self, $column_name ) = @_;
1721 my $accessor_name = $column_name;
1722 $accessor_name =~ s/\W+/_/g;
1724 if ((($self->naming->{column_accessors}||'') =~ /(\d+)/ && $1 < 7) || (not $self->preserve_case)) {
1725 # older naming just lc'd the col accessor and that's all.
1726 return lc $accessor_name;
1729 return join '_', map lc, split_name $column_name;
1733 sub _make_column_accessor_name {
1734 my ($self, $column_name, $column_context_info ) = @_;
1736 my $accessor = $self->_run_user_map(
1737 $self->col_accessor_map,
1738 sub { $self->_default_column_accessor_name( shift ) },
1740 $column_context_info,
1746 # Set up metadata (cols, pks, etc)
1747 sub _setup_src_meta {
1748 my ($self, $table) = @_;
1750 my $schema = $self->schema;
1751 my $schema_class = $self->schema_class;
1753 my $table_class = $self->classes->{$table};
1754 my $table_moniker = $self->monikers->{$table};
1756 my $table_name = $table;
1757 my $name_sep = $self->schema->storage->sql_maker->name_sep;
1759 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
1760 $table_name = \ $self->_quote_table_name($table_name);
1763 my $full_table_name = ($self->qualify_objects ? ($self->db_schema . '.') : '') . (ref $table_name ? $$table_name : $table_name);
1765 # be careful to not create refs Data::Dump can "optimize"
1766 $full_table_name = \do {"".$full_table_name} if ref $table_name;
1768 $self->_dbic_stmt($table_class, 'table', $full_table_name);
1770 my $cols = $self->_table_columns($table);
1771 my $col_info = $self->__columns_info_for($table);
1773 ### generate all the column accessor names
1774 while (my ($col, $info) = each %$col_info) {
1775 # hashref of other info that could be used by
1776 # user-defined accessor map functions
1778 table_class => $table_class,
1779 table_moniker => $table_moniker,
1780 table_name => $table_name,
1781 full_table_name => $full_table_name,
1782 schema_class => $schema_class,
1783 column_info => $info,
1786 $info->{accessor} = $self->_make_column_accessor_name( $col, $context );
1789 $self->_resolve_col_accessor_collisions($full_table_name, $col_info);
1791 # prune any redundant accessor names
1792 while (my ($col, $info) = each %$col_info) {
1793 no warnings 'uninitialized';
1794 delete $info->{accessor} if $info->{accessor} eq $col;
1797 my $fks = $self->_table_fk_info($table);
1799 foreach my $fkdef (@$fks) {
1800 for my $col (@{ $fkdef->{local_columns} }) {
1801 $col_info->{$col}{is_foreign_key} = 1;
1805 my $pks = $self->_table_pk_info($table) || [];
1807 foreach my $pkcol (@$pks) {
1808 $col_info->{$pkcol}{is_nullable} = 0;
1814 map { $_, ($col_info->{$_}||{}) } @$cols
1817 my %uniq_tag; # used to eliminate duplicate uniqs
1819 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
1820 : carp("$table has no primary key");
1821 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
1823 my $uniqs = $self->_table_uniq_info($table) || [];
1825 my ($name, $cols) = @$_;
1826 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
1827 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
1832 sub __columns_info_for {
1833 my ($self, $table) = @_;
1835 my $result = $self->_columns_info_for($table);
1837 while (my ($col, $info) = each %$result) {
1838 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
1839 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
1841 $result->{$col} = $info;
1849 Returns a sorted list of loaded tables, using the original database table
1857 return keys %{$self->_tables};
1860 # Make a moniker from a table
1861 sub _default_table2moniker {
1862 no warnings 'uninitialized';
1863 my ($self, $table) = @_;
1865 if ($self->naming->{monikers} eq 'v4') {
1866 return join '', map ucfirst, split /[\W_]+/, lc $table;
1868 elsif ($self->naming->{monikers} eq 'v5') {
1869 return join '', map ucfirst, split /[\W_]+/,
1870 Lingua::EN::Inflect::Number::to_S(lc $table);
1872 elsif ($self->naming->{monikers} eq 'v6') {
1873 (my $as_phrase = lc $table) =~ s/_+/ /g;
1874 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1876 return join '', map ucfirst, split /\W+/, $inflected;
1879 my @words = map lc, split_name $table;
1880 my $as_phrase = join ' ', @words;
1882 my $inflected = Lingua::EN::Inflect::Phrase::to_S($as_phrase);
1884 return join '', map ucfirst, split /\W+/, $inflected;
1887 sub _table2moniker {
1888 my ( $self, $table ) = @_;
1890 $self->_run_user_map(
1892 sub { $self->_default_table2moniker( shift ) },
1897 sub _load_relationships {
1898 my ($self, $table) = @_;
1900 my $tbl_fk_info = $self->_table_fk_info($table);
1901 foreach my $fkdef (@$tbl_fk_info) {
1902 $fkdef->{remote_source} =
1903 $self->monikers->{delete $fkdef->{remote_table}};
1905 my $tbl_uniq_info = $self->_table_uniq_info($table);
1907 my $local_moniker = $self->monikers->{$table};
1908 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
1910 foreach my $src_class (sort keys %$rel_stmts) {
1911 my $src_stmts = $rel_stmts->{$src_class};
1912 foreach my $stmt (@$src_stmts) {
1913 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
1918 # Overload these in driver class:
1920 # Returns an arrayref of column names
1921 sub _table_columns { croak "ABSTRACT METHOD" }
1923 # Returns arrayref of pk col names
1924 sub _table_pk_info { croak "ABSTRACT METHOD" }
1926 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
1927 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1929 # Returns an arrayref of foreign key constraints, each
1930 # being a hashref with 3 keys:
1931 # local_columns (arrayref), remote_columns (arrayref), remote_table
1932 sub _table_fk_info { croak "ABSTRACT METHOD" }
1934 # Returns an array of lower case table names
1935 sub _tables_list { croak "ABSTRACT METHOD" }
1937 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1943 # generate the pod for this statement, storing it with $self->_pod
1944 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
1946 my $args = dump(@_);
1947 $args = '(' . $args . ')' if @_ < 2;
1948 my $stmt = $method . $args . q{;};
1950 warn qq|$class\->$stmt\n| if $self->debug;
1951 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1955 # generates the accompanying pod for a DBIC class method statement,
1956 # storing it with $self->_pod
1962 if ( $method eq 'table' ) {
1964 my $pcm = $self->pod_comment_mode;
1965 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
1966 $comment = $self->__table_comment($table);
1967 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
1968 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
1969 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
1970 $self->_pod( $class, "=head1 NAME" );
1971 my $table_descr = $class;
1972 $table_descr .= " - " . $comment if $comment and $comment_in_name;
1973 $self->{_class2table}{ $class } = $table;
1974 $self->_pod( $class, $table_descr );
1975 if ($comment and $comment_in_desc) {
1976 $self->_pod( $class, "=head1 DESCRIPTION" );
1977 $self->_pod( $class, $comment );
1979 $self->_pod_cut( $class );
1980 } elsif ( $method eq 'add_columns' ) {
1981 $self->_pod( $class, "=head1 ACCESSORS" );
1982 my $col_counter = 0;
1984 while( my ($name,$attrs) = splice @cols,0,2 ) {
1986 $self->_pod( $class, '=head2 ' . $name );
1987 $self->_pod( $class,
1989 my $s = $attrs->{$_};
1990 $s = !defined $s ? 'undef' :
1991 length($s) == 0 ? '(empty string)' :
1992 ref($s) eq 'SCALAR' ? $$s :
1993 ref($s) ? dumper_squashed $s :
1994 looks_like_number($s) ? $s : qq{'$s'};
1997 } sort keys %$attrs,
1999 if (my $comment = $self->__column_comment($self->{_class2table}{$class}, $col_counter, $name)) {
2000 $self->_pod( $class, $comment );
2003 $self->_pod_cut( $class );
2004 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
2005 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
2006 my ( $accessor, $rel_class ) = @_;
2007 $self->_pod( $class, "=head2 $accessor" );
2008 $self->_pod( $class, 'Type: ' . $method );
2009 $self->_pod( $class, "Related object: L<$rel_class>" );
2010 $self->_pod_cut( $class );
2011 $self->{_relations_started} { $class } = 1;
2015 sub _filter_comment {
2016 my ($self, $txt) = @_;
2018 $txt = '' if not defined $txt;
2020 $txt =~ s/(?:\015?\012|\015\012?)/\n/g;
2025 sub __table_comment {
2028 if (my $code = $self->can('_table_comment')) {
2029 return $self->_filter_comment($self->$code(@_));
2035 sub __column_comment {
2038 if (my $code = $self->can('_column_comment')) {
2039 return $self->_filter_comment($self->$code(@_));
2045 # Stores a POD documentation
2047 my ($self, $class, $stmt) = @_;
2048 $self->_raw_stmt( $class, "\n" . $stmt );
2052 my ($self, $class ) = @_;
2053 $self->_raw_stmt( $class, "\n=cut\n" );
2056 # Store a raw source line for a class (for dumping purposes)
2058 my ($self, $class, $stmt) = @_;
2059 push(@{$self->{_dump_storage}->{$class}}, $stmt);
2062 # Like above, but separately for the externally loaded stuff
2064 my ($self, $class, $stmt) = @_;
2065 push(@{$self->{_ext_storage}->{$class}}, $stmt);
2068 sub _quote_table_name {
2069 my ($self, $table) = @_;
2071 my $qt = $self->schema->storage->sql_maker->quote_char;
2073 return $table unless $qt;
2076 return $qt->[0] . $table . $qt->[1];
2079 return $qt . $table . $qt;
2082 sub _custom_column_info {
2083 my ( $self, $table_name, $column_name, $column_info ) = @_;
2085 if (my $code = $self->custom_column_info) {
2086 return $code->($table_name, $column_name, $column_info) || {};
2091 sub _datetime_column_info {
2092 my ( $self, $table_name, $column_name, $column_info ) = @_;
2094 my $type = $column_info->{data_type} || '';
2095 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
2096 or ($type =~ /date|timestamp/i)) {
2097 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
2098 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
2104 my ($self, $name) = @_;
2106 return $self->preserve_case ? $name : lc($name);
2110 my ($self, $name) = @_;
2112 return $self->preserve_case ? $name : uc($name);
2115 sub _unregister_source_for_table {
2116 my ($self, $table) = @_;
2120 my $schema = $self->schema;
2121 # in older DBIC it's a private method
2122 my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
2123 $schema->$unregister($self->_table2moniker($table));
2124 delete $self->monikers->{$table};
2125 delete $self->classes->{$table};
2126 delete $self->_upgrading_classes->{$table};
2127 delete $self->{_tables}{$table};
2131 # remove the dump dir from @INC on destruction
2135 @INC = grep $_ ne $self->dump_directory, @INC;
2140 Returns a hashref of loaded table to moniker mappings. There will
2141 be two entries for each table, the original name and the "normalized"
2142 name, in the case that the two are different (such as databases
2143 that like uppercase table names, or preserve your original mixed-case
2144 definitions, or what-have-you).
2148 Returns a hashref of table to class mappings. In some cases it will
2149 contain multiple entries per table for the original and normalized table
2150 names, as above in L</monikers>.
2152 =head1 COLUMN ACCESSOR COLLISIONS
2154 Occasionally you may have a column name that collides with a perl method, such
2155 as C<can>. In such cases, the default action is to set the C<accessor> of the
2156 column spec to C<undef>.
2158 You can then name the accessor yourself by placing code such as the following
2161 __PACKAGE__->add_column('+can' => { accessor => 'my_can' });
2163 Another option is to use the L</col_collision_map> option.
2165 =head1 RELATIONSHIP NAME COLLISIONS
2167 In very rare cases, you may get a collision between a generated relationship
2168 name and a method in your Result class, for example if you have a foreign key
2169 called C<belongs_to>.
2171 This is a problem because relationship names are also relationship accessor
2172 methods in L<DBIx::Class>.
2174 The default behavior is to append C<_rel> to the relationship name and print
2175 out a warning that refers to this text.
2177 You can also control the renaming with the L</rel_collision_map> option.
2181 L<DBIx::Class::Schema::Loader>
2185 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
2189 This library is free software; you can redistribute it and/or modify it under
2190 the same terms as Perl itself.
2195 # vim:et sts=4 sw=4 tw=0: