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 ();
14 use Lingua::EN::Inflect::Number ();
15 use Lingua::EN::Inflect::Phrase ();
16 use String::ToIdentifier::EN ();
17 use String::ToIdentifier::EN::Unicode ();
20 use Class::Inspector ();
21 use Scalar::Util 'looks_like_number';
22 use DBIx::Class::Schema::Loader::Utils qw/split_name dumper_squashed eval_package_without_redefine_warnings class_path slurp_file/;
23 use DBIx::Class::Schema::Loader::Optional::Dependencies ();
26 use Encode qw/encode decode/;
27 use List::MoreUtils qw/all firstidx/;
32 our $VERSION = '0.07010';
34 __PACKAGE__->mk_group_ro_accessors('simple', qw/
41 additional_base_classes
57 default_resultset_class
63 overwrite_modifications
86 __PACKAGE__->mk_group_accessors('simple', qw/
88 schema_version_to_dump
90 _upgrading_from_load_classes
91 _downgrading_to_load_classes
92 _rewriting_result_namespace
97 pod_comment_spillover_length
103 result_components_map
105 datetime_undef_if_invalid
106 _result_class_methods
108 filter_generated_code
114 my $CURRENT_V = 'v7';
117 schema_components schema_base_class result_base_class
118 additional_base_classes left_base_classes additional_classes components
124 my $CRLF = "\x0d\x0a";
128 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
132 See L<DBIx::Class::Schema::Loader>.
136 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
137 classes, and implements the common functionality between them.
139 =head1 CONSTRUCTOR OPTIONS
141 These constructor options are the base options for
142 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
144 =head2 skip_relationships
146 Skip setting up relationships. The default is to attempt the loading
149 =head2 skip_load_external
151 Skip loading of other classes in @INC. The default is to merge all other classes
152 with the same name found in @INC into the schema file we are creating.
156 Static schemas (ones dumped to disk) will, by default, use the new-style
157 relationship names and singularized Results, unless you're overwriting an
158 existing dump made by an older version of L<DBIx::Class::Schema::Loader>, in
159 which case the backward compatible RelBuilder will be activated, and the
160 appropriate monikerization used.
166 will disable the backward-compatible RelBuilder and use
167 the new-style relationship names along with singularized Results, even when
168 overwriting a dump made with an earlier version.
170 The option also takes a hashref:
173 relationships => 'v8',
175 column_accessors => 'v8',
181 naming => { ALL => 'v8', force_ascii => 1 }
189 Set L</relationships>, L</monikers> and L</column_accessors> to the specified
194 How to name relationship accessors.
198 How to name Result classes.
200 =item column_accessors
202 How to name column accessors in Result classes.
206 For L</v8> mode and later, uses L<String::ToIdentifier::EN> instead of
207 L<String::ToIdentifier::EM::Unicode> to force monikers and other identifiers to
218 Latest style, whatever that happens to be.
222 Unsingularlized monikers, C<has_many> only relationships with no _id stripping.
226 Monikers singularized as whole words, C<might_have> relationships for FKs on
227 C<UNIQUE> constraints, C<_id> stripping for belongs_to relationships.
229 Some of the C<_id> stripping edge cases in C<0.05003> have been reverted for
234 All monikers and relationships are inflected using
235 L<Lingua::EN::Inflect::Phrase>, and there is more aggressive C<_id> stripping
236 from relationship names.
238 In general, there is very little difference between v5 and v6 schemas.
242 This mode is identical to C<v6> mode, except that monikerization of CamelCase
243 table names is also done correctly.
245 CamelCase column names in case-preserving mode will also be handled correctly
246 for relationship name inflection. See L</preserve_case>.
248 In this mode, CamelCase L</column_accessors> are normalized based on case
249 transition instead of just being lowercased, so C<FooId> becomes C<foo_id>.
251 If you don't have any CamelCase table or column names, you can upgrade without
252 breaking any of your code.
258 The default mode is L</v7>, to get L</v8> mode, you have to specify it in
259 L</naming> explictly until C<0.08> comes out.
261 L</monikers> and L</column_accessors> are created using
262 L<String::ToIdentifier::EN::Unicode> or L<String::ToIdentifier::EN> if
263 L</force_ascii> is set; this is only significant for names with non-C<\w>
264 characters such as C<.>.
266 CamelCase identifiers with words in all caps, e.g. C<VLANValidID> are supported
267 correctly in this mode.
269 For relationships, belongs_to accessors are made from column names by stripping
270 postfixes other than C<_id> as well, for example just C<Id>, C<_?ref>, C<_?cd>,
271 C<_?code> and C<_?num>, case insensitively.
275 For L</monikers>, this option does not inflect the table names but makes
276 monikers based on the actual name. For L</column_accessors> this option does
277 not normalize CamelCase column names to lowercase column accessors, but makes
278 accessors that are the same names as the columns (with any non-\w chars
279 replaced with underscores.)
283 For L</monikers>, singularizes the names using the most current inflector. This
284 is the same as setting the option to L</current>.
288 For L</monikers>, pluralizes the names, using the most current inflector.
292 Dynamic schemas will always default to the 0.04XXX relationship names and won't
293 singularize Results for backward compatibility, to activate the new RelBuilder
294 and singularization put this in your C<Schema.pm> file:
296 __PACKAGE__->naming('current');
298 Or if you prefer to use 0.07XXX features but insure that nothing breaks in the
299 next major version upgrade:
301 __PACKAGE__->naming('v7');
305 If true, will not print the usual C<Dumping manual schema ... Schema dump
306 completed.> messages. Does not affect warnings (except for warnings related to
307 L</really_erase_my_files>.)
311 By default POD will be generated for columns and relationships, using database
312 metadata for the text if available and supported.
314 Comment metadata can be stored in two ways.
316 The first is that you can create two tables named C<table_comments> and
317 C<column_comments> respectively. These tables must exist in the same database
318 and schema as the tables they describe. They both need to have columns named
319 C<table_name> and C<comment_text>. The second one needs to have a column named
320 C<column_name>. Then data stored in these tables will be used as a source of
321 metadata about tables and comments.
323 (If you wish you can change the name of these tables with the parameters
324 L</table_comments_table> and L</column_comments_table>.)
326 As a fallback you can use built-in commenting mechanisms. Currently this is
327 only supported for PostgreSQL, Oracle and MySQL. To create comments in
328 PostgreSQL you add statements of the form C<COMMENT ON TABLE some_table IS
329 '...'>, the same syntax is used in Oracle. To create comments in MySQL you add
330 C<COMMENT '...'> to the end of the column or table definition. Note that MySQL
331 restricts the length of comments, and also does not handle complex Unicode
334 Set this to C<0> to turn off all POD generation.
336 =head2 pod_comment_mode
338 Controls where table comments appear in the generated POD. Smaller table
339 comments are appended to the C<NAME> section of the documentation, and larger
340 ones are inserted into C<DESCRIPTION> instead. You can force a C<DESCRIPTION>
341 section to be generated with the comment always, only use C<NAME>, or choose
342 the length threshold at which the comment is forced into the description.
348 Use C<NAME> section only.
352 Force C<DESCRIPTION> always.
356 Use C<DESCRIPTION> if length > L</pod_comment_spillover_length>, this is the
361 =head2 pod_comment_spillover_length
363 When pod_comment_mode is set to C<auto>, this is the length of the comment at
364 which it will be forced into a separate description section.
368 =head2 table_comments_table
370 The table to look for comments about tables in. By default C<table_comments>.
371 See L</generate_pod> for details.
373 This must not be a fully qualified name, the table will be looked for in the
374 same database and schema as the table whose comment is being retrieved.
376 =head2 column_comments_table
378 The table to look for comments about columns in. By default C<column_comments>.
379 See L</generate_pod> for details.
381 This must not be a fully qualified name, the table will be looked for in the
382 same database and schema as the table/column whose comment is being retrieved.
384 =head2 relationship_attrs
386 Hashref of attributes to pass to each generated relationship, listed
387 by type. Also supports relationship type 'all', containing options to
388 pass to all generated relationships. Attributes set for more specific
389 relationship types override those set in 'all'.
393 relationship_attrs => {
394 belongs_to => { is_deferrable => 0 },
397 use this to turn off DEFERRABLE on your foreign key constraints.
401 If set to true, each constructive L<DBIx::Class> statement the loader
402 decides to execute will be C<warn>-ed before execution.
406 Set the name of the schema to load (schema in the sense that your database
409 Can be set to an arrayref of schema names for multiple schemas, or the special
410 value C<%> for all schemas.
412 For MSSQL, Sybase ASE, and Informix can be set to a hashref of databases as
413 keys and arrays of owners as values, set to the value:
417 for all owners in all databases.
419 You may need to control naming of monikers with L</moniker_parts> if you have
420 name clashes for tables in different schemas/databases.
424 The database table names are represented by the
425 L<DBIx::Class::Schema::Loader::Table> class in the loader, the
426 L<DBIx::Class::Schema::Loader::Table::Sybase> class for Sybase ASE and
427 L<DBIx::Class::Schema::Loader::Table::Informix> for Informix.
429 Monikers are created normally based on just the
430 L<name|DBIx::Class::Schema::Loader::DBObject/name> property, corresponding to
431 the table name, but can consist of other parts of the fully qualified name of
434 The L</moniker_parts> option is an arrayref of methods on the table class
435 corresponding to parts of the fully qualified table name, defaulting to
436 C<['name']>, in the order those parts are used to create the moniker name.
438 The C<'name'> entry B<must> be present.
440 Below is a table of supported databases and possible L</moniker_parts>.
444 =item * DB2, Firebird, mysql, Oracle, Pg, SQLAnywhere, SQLite, MS Access
448 =item * Informix, MSSQL, Sybase ASE
450 C<database>, C<schema>, C<name>
456 Only load tables matching regex. Best specified as a qr// regex.
460 Exclude tables matching regex. Best specified as a qr// regex.
464 Overrides the default table name to moniker translation. Can be either
465 a hashref of table keys and moniker values, or a coderef for a translator
466 function taking a single scalar table name argument and returning
467 a scalar moniker. If the hash entry does not exist, or the function
468 returns a false value, the code falls back to default behavior
471 The default behavior is to split on case transition and non-alphanumeric
472 boundaries, singularize the resulting phrase, then join the titlecased words
475 Table Name | Moniker Name
476 ---------------------------------
478 luser_group | LuserGroup
479 luser-opts | LuserOpt
480 stations_visited | StationVisited
481 routeChange | RouteChange
483 =head2 col_accessor_map
485 Same as moniker_map, but for column accessor names. If a coderef is
486 passed, the code is called with arguments of
488 the name of the column in the underlying database,
489 default accessor name that DBICSL would ordinarily give this column,
491 table_class => name of the DBIC class we are building,
492 table_moniker => calculated moniker for this table (after moniker_map if present),
493 table_name => name of the database table,
494 full_table_name => schema-qualified name of the database table (RDBMS specific),
495 schema_class => name of the schema class we are building,
496 column_info => hashref of column info (data_type, is_nullable, etc),
501 Similar in idea to moniker_map, but different in the details. It can be
502 a hashref or a code ref.
504 If it is a hashref, keys can be either the default relationship name, or the
505 moniker. The keys that are the default relationship name should map to the
506 name you want to change the relationship to. Keys that are monikers should map
507 to hashes mapping relationship names to their translation. You can do both at
508 once, and the more specific moniker version will be picked up first. So, for
509 instance, you could have
518 and relationships that would have been named C<bar> will now be named C<baz>
519 except that in the table whose moniker is C<Foo> it will be named C<blat>.
521 If it is a coderef, the argument passed will be a hashref of this form:
524 name => default relationship name,
525 type => the relationship type eg: C<has_many>,
526 local_class => name of the DBIC class we are building,
527 local_moniker => moniker of the DBIC class we are building,
528 local_columns => columns in this table in the relationship,
529 remote_class => name of the DBIC class we are related to,
530 remote_moniker => moniker of the DBIC class we are related to,
531 remote_columns => columns in the other table in the relationship,
534 DBICSL will try to use the value returned as the relationship name.
536 =head2 inflect_plural
538 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
539 if hash key does not exist or coderef returns false), but acts as a map
540 for pluralizing relationship names. The default behavior is to utilize
541 L<Lingua::EN::Inflect::Phrase/to_PL>.
543 =head2 inflect_singular
545 As L</inflect_plural> above, but for singularizing relationship names.
546 Default behavior is to utilize L<Lingua::EN::Inflect::Phrase/to_S>.
548 =head2 schema_base_class
550 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
552 =head2 schema_components
554 List of components to load into the Schema class.
556 =head2 result_base_class
558 Base class for your table classes (aka result classes). Defaults to
561 =head2 additional_base_classes
563 List of additional base classes all of your table classes will use.
565 =head2 left_base_classes
567 List of additional base classes all of your table classes will use
568 that need to be leftmost.
570 =head2 additional_classes
572 List of additional classes which all of your table classes will use.
576 List of additional components to be loaded into all of your Result
577 classes. A good example would be
578 L<InflateColumn::DateTime|DBIx::Class::InflateColumn::DateTime>
580 =head2 result_components_map
582 A hashref of moniker keys and component values. Unlike L</components>, which
583 loads the given components into every Result class, this option allows you to
584 load certain components for specified Result classes. For example:
586 result_components_map => {
587 StationVisited => '+YourApp::Schema::Component::StationVisited',
589 '+YourApp::Schema::Component::RouteChange',
590 'InflateColumn::DateTime',
594 You may use this in conjunction with L</components>.
598 List of L<Moose> roles to be applied to all of your Result classes.
600 =head2 result_roles_map
602 A hashref of moniker keys and role values. Unlike L</result_roles>, which
603 applies the given roles to every Result class, this option allows you to apply
604 certain roles for specified Result classes. For example:
606 result_roles_map => {
608 'YourApp::Role::Building',
609 'YourApp::Role::Destination',
611 RouteChange => 'YourApp::Role::TripEvent',
614 You may use this in conjunction with L</result_roles>.
616 =head2 use_namespaces
618 This is now the default, to go back to L<DBIx::Class::Schema/load_classes> pass
621 Generate result class names suitable for
622 L<DBIx::Class::Schema/load_namespaces> and call that instead of
623 L<DBIx::Class::Schema/load_classes>. When using this option you can also
624 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
625 C<resultset_namespace>, C<default_resultset_class>), and they will be added
626 to the call (and the generated result class names adjusted appropriately).
628 =head2 dump_directory
630 The value of this option is a perl libdir pathname. Within
631 that directory this module will create a baseline manual
632 L<DBIx::Class::Schema> module set, based on what it creates at runtime.
634 The created schema class will have the same classname as the one on
635 which you are setting this option (and the ResultSource classes will be
636 based on this name as well).
638 Normally you wouldn't hard-code this setting in your schema class, as it
639 is meant for one-time manual usage.
641 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
642 recommended way to access this functionality.
644 =head2 dump_overwrite
646 Deprecated. See L</really_erase_my_files> below, which does *not* mean
647 the same thing as the old C<dump_overwrite> setting from previous releases.
649 =head2 really_erase_my_files
651 Default false. If true, Loader will unconditionally delete any existing
652 files before creating the new ones from scratch when dumping a schema to disk.
654 The default behavior is instead to only replace the top portion of the
655 file, up to and including the final stanza which contains
656 C<# DO NOT MODIFY THE FIRST PART OF THIS FILE>
657 leaving any customizations you placed after that as they were.
659 When C<really_erase_my_files> is not set, if the output file already exists,
660 but the aforementioned final stanza is not found, or the checksum
661 contained there does not match the generated contents, Loader will
662 croak and not touch the file.
664 You should really be using version control on your schema classes (and all
665 of the rest of your code for that matter). Don't blame me if a bug in this
666 code wipes something out when it shouldn't have, you've been warned.
668 =head2 overwrite_modifications
670 Default false. If false, when updating existing files, Loader will
671 refuse to modify any Loader-generated code that has been modified
672 since its last run (as determined by the checksum Loader put in its
675 If true, Loader will discard any manual modifications that have been
676 made to Loader-generated code.
678 Again, you should be using version control on your schema classes. Be
679 careful with this option.
681 =head2 custom_column_info
683 Hook for adding extra attributes to the
684 L<column_info|DBIx::Class::ResultSource/column_info> for a column.
686 Must be a coderef that returns a hashref with the extra attributes.
688 Receives the table name, column name and column_info.
692 custom_column_info => sub {
693 my ($table_name, $column_name, $column_info) = @_;
695 if ($column_name eq 'dog' && $column_info->{default_value} eq 'snoopy') {
696 return { is_snoopy => 1 };
700 This attribute can also be used to set C<inflate_datetime> on a non-datetime
701 column so it also receives the L</datetime_timezone> and/or L</datetime_locale>.
703 =head2 datetime_timezone
705 Sets the timezone attribute for L<DBIx::Class::InflateColumn::DateTime> for all
706 columns with the DATE/DATETIME/TIMESTAMP data_types.
708 =head2 datetime_locale
710 Sets the locale attribute for L<DBIx::Class::InflateColumn::DateTime> for all
711 columns with the DATE/DATETIME/TIMESTAMP data_types.
713 =head2 datetime_undef_if_invalid
715 Pass a C<0> for this option when using MySQL if you B<DON'T> want C<<
716 datetime_undef_if_invalid => 1 >> in your column info for DATE, DATETIME and
719 The default is recommended to deal with data such as C<00/00/00> which
720 sometimes ends up in such columns in MySQL.
724 File in Perl format, which should return a HASH reference, from which to read
729 Normally database names are lowercased and split by underscore, use this option
730 if you have CamelCase database names.
732 Drivers for case sensitive databases like Sybase ASE or MSSQL with a
733 case-sensitive collation will turn this option on unconditionally.
735 B<NOTE:> L</naming> = C<v8> is highly recommended with this option as the
736 semantics of this mode are much improved for CamelCase database names.
738 L</naming> = C<v7> or greater is required with this option.
740 =head2 qualify_objects
742 Set to true to prepend the L</db_schema> to table names for C<<
743 __PACKAGE__->table >> calls, and to some other things like Oracle sequences.
747 Creates Schema and Result classes that use L<Moose>, L<MooseX::NonMoose> and
748 L<MooseX::MarkAsMethods> (or L<namespace::autoclean>, see below). The default
749 content after the md5 sum also makes the classes immutable.
751 It is safe to upgrade your existing Schema to this option.
753 =head2 only_autoclean
755 By default, we use L<MooseX::MarkAsMethods> to remove imported functions from
756 your generated classes. It uses L<namespace::autoclean> to do this, after
757 telling your object's metaclass that any operator L<overload>s in your class
758 are methods, which will cause namespace::autoclean to spare them from removal.
760 This prevents the "Hey, where'd my overloads go?!" effect.
762 If you don't care about operator overloads, enabling this option falls back to
763 just using L<namespace::autoclean> itself.
765 If none of the above made any sense, or you don't have some pressing need to
766 only use L<namespace::autoclean>, leaving this set to the default is
769 =head2 col_collision_map
771 This option controls how accessors for column names which collide with perl
772 methods are named. See L</COLUMN ACCESSOR COLLISIONS> for more information.
774 This option takes either a single L<sprintf|perlfunc/sprintf> format or a hashref of
775 strings which are compiled to regular expressions that map to
776 L<sprintf|perlfunc/sprintf> formats.
780 col_collision_map => 'column_%s'
782 col_collision_map => { '(.*)' => 'column_%s' }
784 col_collision_map => { '(foo).*(bar)' => 'column_%s_%s' }
786 =head2 rel_collision_map
788 Works just like L</col_collision_map>, but for relationship names/accessors
789 rather than column names/accessors.
791 The default is to just append C<_rel> to the relationship name, see
792 L</RELATIONSHIP NAME COLLISIONS>.
794 =head2 uniq_to_primary
796 Automatically promotes the largest unique constraints with non-nullable columns
797 on tables to primary keys, assuming there is only one largest unique
800 =head2 filter_generated_code
802 An optional hook that lets you filter the generated text for various classes
803 through a function that change it in any way that you want. The function will
804 receive the type of file, C<schema> or C<result>, class and code; and returns
805 the new code to use instead. For instance you could add custom comments, or do
806 anything else that you want.
808 The option can also be set to a string, which is then used as a filter program,
811 If this exists but fails to return text matching C</\bpackage\b/>, no file will
814 filter_generated_code => sub {
815 my ($type, $class, $text) = @_;
822 None of these methods are intended for direct invocation by regular
823 users of L<DBIx::Class::Schema::Loader>. Some are proxied via
824 L<DBIx::Class::Schema::Loader>.
828 # ensure that a peice of object data is a valid arrayref, creating
829 # an empty one or encapsulating whatever's there.
830 sub _ensure_arrayref {
835 $self->{$_} = [ $self->{$_} ]
836 unless ref $self->{$_} eq 'ARRAY';
842 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
843 by L<DBIx::Class::Schema::Loader>.
848 my ( $class, %args ) = @_;
850 if (exists $args{column_accessor_map}) {
851 $args{col_accessor_map} = delete $args{column_accessor_map};
854 my $self = { %args };
856 # don't lose undef options
857 for (values %$self) {
858 $_ = 0 unless defined $_;
861 bless $self => $class;
863 if (my $config_file = $self->config_file) {
864 my $config_opts = do $config_file;
866 croak "Error reading config from $config_file: $@" if $@;
868 croak "Config file $config_file must be a hashref" unless ref($config_opts) eq 'HASH';
870 while (my ($k, $v) = each %$config_opts) {
871 $self->{$k} = $v unless exists $self->{$k};
875 if (defined $self->{result_component_map}) {
876 if (defined $self->result_components_map) {
877 croak "Specify only one of result_components_map or result_component_map";
879 $self->result_components_map($self->{result_component_map})
882 if (defined $self->{result_role_map}) {
883 if (defined $self->result_roles_map) {
884 croak "Specify only one of result_roles_map or result_role_map";
886 $self->result_roles_map($self->{result_role_map})
889 croak "the result_roles and result_roles_map options may only be used in conjunction with use_moose=1"
890 if ((not defined $self->use_moose) || (not $self->use_moose))
891 && ((defined $self->result_roles) || (defined $self->result_roles_map));
893 $self->_ensure_arrayref(qw/schema_components
895 additional_base_classes
901 $self->_validate_class_args;
903 croak "result_components_map must be a hash"
904 if defined $self->result_components_map
905 && ref $self->result_components_map ne 'HASH';
907 if ($self->result_components_map) {
908 my %rc_map = %{ $self->result_components_map };
909 foreach my $moniker (keys %rc_map) {
910 $rc_map{$moniker} = [ $rc_map{$moniker} ] unless ref $rc_map{$moniker};
912 $self->result_components_map(\%rc_map);
915 $self->result_components_map({});
917 $self->_validate_result_components_map;
919 croak "result_roles_map must be a hash"
920 if defined $self->result_roles_map
921 && ref $self->result_roles_map ne 'HASH';
923 if ($self->result_roles_map) {
924 my %rr_map = %{ $self->result_roles_map };
925 foreach my $moniker (keys %rr_map) {
926 $rr_map{$moniker} = [ $rr_map{$moniker} ] unless ref $rr_map{$moniker};
928 $self->result_roles_map(\%rr_map);
930 $self->result_roles_map({});
932 $self->_validate_result_roles_map;
934 if ($self->use_moose) {
935 if (not DBIx::Class::Schema::Loader::Optional::Dependencies->req_ok_for('use_moose')) {
936 die sprintf "You must install the following CPAN modules to enable the use_moose option: %s.\n",
937 DBIx::Class::Schema::Loader::Optional::Dependencies->req_missing_for('use_moose');
941 $self->{_tables} = {};
942 $self->{monikers} = {};
943 $self->{moniker_to_table} = {};
944 $self->{class_to_table} = {};
945 $self->{classes} = {};
946 $self->{_upgrading_classes} = {};
948 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
949 $self->{schema} ||= $self->{schema_class};
950 $self->{table_comments_table} ||= 'table_comments';
951 $self->{column_comments_table} ||= 'column_comments';
953 croak "dump_overwrite is deprecated. Please read the"
954 . " DBIx::Class::Schema::Loader::Base documentation"
955 if $self->{dump_overwrite};
957 $self->{dynamic} = ! $self->{dump_directory};
958 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
963 $self->{dump_directory} ||= $self->{temp_directory};
965 $self->real_dump_directory($self->{dump_directory});
967 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
968 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
970 if (not defined $self->naming) {
971 $self->naming_set(0);
974 $self->naming_set(1);
977 if ((not ref $self->naming) && defined $self->naming) {
978 my $naming_ver = $self->naming;
980 relationships => $naming_ver,
981 monikers => $naming_ver,
982 column_accessors => $naming_ver,
985 elsif (ref $self->naming eq 'HASH' && exists $self->naming->{ALL}) {
986 my $val = delete $self->naming->{ALL};
988 $self->naming->{$_} = $val
989 foreach qw/relationships monikers column_accessors/;
993 foreach my $key (qw/relationships monikers column_accessors/) {
994 $self->naming->{$key} = $CURRENT_V if ($self->naming->{$key}||'') eq 'current';
997 $self->{naming} ||= {};
999 if ($self->custom_column_info && ref $self->custom_column_info ne 'CODE') {
1000 croak 'custom_column_info must be a CODE ref';
1003 $self->_check_back_compat;
1005 $self->use_namespaces(1) unless defined $self->use_namespaces;
1006 $self->generate_pod(1) unless defined $self->generate_pod;
1007 $self->pod_comment_mode('auto') unless defined $self->pod_comment_mode;
1008 $self->pod_comment_spillover_length(60) unless defined $self->pod_comment_spillover_length;
1010 if (my $col_collision_map = $self->col_collision_map) {
1011 if (my $reftype = ref $col_collision_map) {
1012 if ($reftype ne 'HASH') {
1013 croak "Invalid type $reftype for option 'col_collision_map'";
1017 $self->col_collision_map({ '(.*)' => $col_collision_map });
1021 if (my $rel_collision_map = $self->rel_collision_map) {
1022 if (my $reftype = ref $rel_collision_map) {
1023 if ($reftype ne 'HASH') {
1024 croak "Invalid type $reftype for option 'rel_collision_map'";
1028 $self->rel_collision_map({ '(.*)' => $rel_collision_map });
1032 if (defined(my $rel_name_map = $self->rel_name_map)) {
1033 my $reftype = ref $rel_name_map;
1034 if ($reftype ne 'HASH' && $reftype ne 'CODE') {
1035 croak "Invalid type $reftype for option 'rel_name_map', must be HASH or CODE";
1039 if (defined(my $filter = $self->filter_generated_code)) {
1040 my $reftype = ref $filter;
1041 if ($reftype && $reftype ne 'CODE') {
1042 croak "Invalid type $reftype for option 'filter_generated_code, must be a scalar or a CODE reference";
1046 if (defined $self->db_schema) {
1047 if (ref $self->db_schema eq 'ARRAY') {
1048 if (@{ $self->db_schema } > 1) {
1049 $self->{qualify_objects} = 1;
1051 elsif (@{ $self->db_schema } == 0) {
1052 $self->{db_schema} = undef;
1055 elsif (not ref $self->db_schema) {
1056 if ($self->db_schema eq '%') {
1057 $self->{qualify_objects} = 1;
1060 $self->{db_schema} = [ $self->db_schema ];
1064 if (not $self->moniker_parts) {
1065 $self->moniker_parts(['name']);
1068 if (not ref $self->moniker_parts) {
1069 $self->moniker_parts([ $self->moniker_parts ]);
1071 if (ref $self->moniker_parts ne 'ARRAY') {
1072 croak 'moniker_parts must be an arrayref';
1074 if ((firstidx { $_ eq 'name' } @{ $self->moniker_parts }) == -1) {
1075 croak "moniker_parts option *must* contain 'name'";
1082 sub _check_back_compat {
1085 # dynamic schemas will always be in 0.04006 mode, unless overridden
1086 if ($self->dynamic) {
1087 # just in case, though no one is likely to dump a dynamic schema
1088 $self->schema_version_to_dump('0.04006');
1090 if (not $self->naming_set) {
1091 warn <<EOF unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
1093 Dynamic schema detected, will run in 0.04006 mode.
1095 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
1096 to disable this warning.
1098 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
1103 $self->_upgrading_from('v4');
1106 if ((not defined $self->use_namespaces) && ($self->naming_set)) {
1107 $self->use_namespaces(1);
1110 $self->naming->{relationships} ||= 'v4';
1111 $self->naming->{monikers} ||= 'v4';
1113 if ($self->use_namespaces) {
1114 $self->_upgrading_from_load_classes(1);
1117 $self->use_namespaces(0);
1123 # otherwise check if we need backcompat mode for a static schema
1124 my $filename = $self->get_dump_filename($self->schema_class);
1125 return unless -e $filename;
1127 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom) =
1128 $self->_parse_generated_file($filename);
1130 return unless $old_ver;
1132 # determine if the existing schema was dumped with use_moose => 1
1133 if (! defined $self->use_moose) {
1134 $self->{use_moose} = 1 if $old_gen =~ /^ (?!\s*\#) use \s+ Moose/xm;
1137 my $load_classes = ($old_gen =~ /^__PACKAGE__->load_classes;/m) ? 1 : 0;
1139 my $result_namespace = do { ($old_gen =~ /result_namespace => (.+)/) ? $1 : '' };
1140 my $ds = eval $result_namespace;
1142 Could not eval expression '$result_namespace' for result_namespace from
1145 $result_namespace = $ds || '';
1147 if ($load_classes && (not defined $self->use_namespaces)) {
1148 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
1150 'load_classes;' static schema detected, turning off 'use_namespaces'.
1152 Set the 'use_namespaces' attribute or the SCHEMA_LOADER_BACKCOMPAT environment
1153 variable to disable this warning.
1155 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 for more
1158 $self->use_namespaces(0);
1160 elsif ($load_classes && $self->use_namespaces) {
1161 $self->_upgrading_from_load_classes(1);
1163 elsif ((not $load_classes) && defined $self->use_namespaces && ! $self->use_namespaces) {
1164 $self->_downgrading_to_load_classes(
1165 $result_namespace || 'Result'
1168 elsif ((not defined $self->use_namespaces) || $self->use_namespaces) {
1169 if (not $self->result_namespace) {
1170 $self->result_namespace($result_namespace || 'Result');
1172 elsif ($result_namespace ne $self->result_namespace) {
1173 $self->_rewriting_result_namespace(
1174 $result_namespace || 'Result'
1179 # XXX when we go past .0 this will need fixing
1180 my ($v) = $old_ver =~ /([1-9])/;
1183 return if ($v eq $CURRENT_V || $old_ver =~ /^0\.\d\d999/);
1185 if (not %{ $self->naming }) {
1186 warn <<"EOF" unless $ENV{SCHEMA_LOADER_BACKCOMPAT};
1188 Version $old_ver static schema detected, turning on backcompat mode.
1190 Set the 'naming' attribute or the SCHEMA_LOADER_BACKCOMPAT environment variable
1191 to disable this warning.
1193 See: 'naming' in perldoc DBIx::Class::Schema::Loader::Base .
1195 See perldoc DBIx::Class::Schema::Loader::Manual::UpgradingFromV4 if upgrading
1196 from version 0.04006.
1199 $self->naming->{relationships} ||= $v;
1200 $self->naming->{monikers} ||= $v;
1201 $self->naming->{column_accessors} ||= $v;
1203 $self->schema_version_to_dump($old_ver);
1206 $self->_upgrading_from($v);
1210 sub _validate_class_args {
1213 foreach my $k (@CLASS_ARGS) {
1214 next unless $self->$k;
1216 my @classes = ref $self->$k eq 'ARRAY' ? @{ $self->$k } : $self->$k;
1217 $self->_validate_classes($k, \@classes);
1221 sub _validate_result_components_map {
1224 foreach my $classes (values %{ $self->result_components_map }) {
1225 $self->_validate_classes('result_components_map', $classes);
1229 sub _validate_result_roles_map {
1232 foreach my $classes (values %{ $self->result_roles_map }) {
1233 $self->_validate_classes('result_roles_map', $classes);
1237 sub _validate_classes {
1240 my $classes = shift;
1242 # make a copy to not destroy original
1243 my @classes = @$classes;
1245 foreach my $c (@classes) {
1246 # components default to being under the DBIx::Class namespace unless they
1247 # are preceeded with a '+'
1248 if ( $key =~ m/component/ && $c !~ s/^\+// ) {
1249 $c = 'DBIx::Class::' . $c;
1252 # 1 == installed, 0 == not installed, undef == invalid classname
1253 my $installed = Class::Inspector->installed($c);
1254 if ( defined($installed) ) {
1255 if ( $installed == 0 ) {
1256 croak qq/$c, as specified in the loader option "$key", is not installed/;
1259 croak qq/$c, as specified in the loader option "$key", is an invalid class name/;
1265 sub _find_file_in_inc {
1266 my ($self, $file) = @_;
1268 foreach my $prefix (@INC) {
1269 my $fullpath = File::Spec->catfile($prefix, $file);
1270 return $fullpath if -f $fullpath
1271 # abs_path throws on Windows for nonexistant files
1272 and (try { Cwd::abs_path($fullpath) }) ne
1273 ((try { Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) }) || '');
1279 sub _find_class_in_inc {
1280 my ($self, $class) = @_;
1282 return $self->_find_file_in_inc(class_path($class));
1288 return $self->_upgrading_from
1289 || $self->_upgrading_from_load_classes
1290 || $self->_downgrading_to_load_classes
1291 || $self->_rewriting_result_namespace
1295 sub _rewrite_old_classnames {
1296 my ($self, $code) = @_;
1298 return $code unless $self->_rewriting;
1300 my %old_classes = reverse %{ $self->_upgrading_classes };
1302 my $re = join '|', keys %old_classes;
1303 $re = qr/\b($re)\b/;
1305 $code =~ s/$re/$old_classes{$1} || $1/eg;
1310 sub _load_external {
1311 my ($self, $class) = @_;
1313 return if $self->{skip_load_external};
1315 # so that we don't load our own classes, under any circumstances
1316 local *INC = [ grep $_ ne $self->dump_directory, @INC ];
1318 my $real_inc_path = $self->_find_class_in_inc($class);
1320 my $old_class = $self->_upgrading_classes->{$class}
1321 if $self->_rewriting;
1323 my $old_real_inc_path = $self->_find_class_in_inc($old_class)
1324 if $old_class && $old_class ne $class;
1326 return unless $real_inc_path || $old_real_inc_path;
1328 if ($real_inc_path) {
1329 # If we make it to here, we loaded an external definition
1330 warn qq/# Loaded external class definition for '$class'\n/
1333 my $code = $self->_rewrite_old_classnames(slurp_file $real_inc_path);
1335 if ($self->dynamic) { # load the class too
1336 eval_package_without_redefine_warnings($class, $code);
1339 $self->_ext_stmt($class,
1340 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
1341 .qq|# They are now part of the custom portion of this file\n|
1342 .qq|# for you to hand-edit. If you do not either delete\n|
1343 .qq|# this section or remove that file from \@INC, this section\n|
1344 .qq|# will be repeated redundantly when you re-create this\n|
1345 .qq|# file again via Loader! See skip_load_external to disable\n|
1346 .qq|# this feature.\n|
1349 $self->_ext_stmt($class, $code);
1350 $self->_ext_stmt($class,
1351 qq|# End of lines loaded from '$real_inc_path' |
1355 if ($old_real_inc_path) {
1356 my $code = slurp_file $old_real_inc_path;
1358 $self->_ext_stmt($class, <<"EOF");
1360 # These lines were loaded from '$old_real_inc_path',
1361 # based on the Result class name that would have been created by an older
1362 # version of the Loader. For a static schema, this happens only once during
1363 # upgrade. See skip_load_external to disable this feature.
1366 $code = $self->_rewrite_old_classnames($code);
1368 if ($self->dynamic) {
1371 Detected external content in '$old_real_inc_path', a class name that would have
1372 been used by an older version of the Loader.
1374 * PLEASE RENAME THIS CLASS: from '$old_class' to '$class', as that is the
1375 new name of the Result.
1377 eval_package_without_redefine_warnings($class, $code);
1381 $self->_ext_stmt($class, $code);
1382 $self->_ext_stmt($class,
1383 qq|# End of lines loaded from '$old_real_inc_path' |
1390 Does the actual schema-construction work.
1397 $self->_load_tables(
1398 $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude })
1406 Rescan the database for changes. Returns a list of the newly added table
1409 The schema argument should be the schema class or object to be affected. It
1410 should probably be derived from the original schema_class used during L</load>.
1415 my ($self, $schema) = @_;
1417 $self->{schema} = $schema;
1418 $self->_relbuilder->{schema} = $schema;
1421 my @current = $self->_tables_list({ constraint => $self->constraint, exclude => $self->exclude });
1423 foreach my $table (@current) {
1424 if(!exists $self->_tables->{$table->sql_name}) {
1425 push(@created, $table);
1430 @current{map $_->sql_name, @current} = ();
1431 foreach my $table (values %{ $self->_tables }) {
1432 if (not exists $current{$table->sql_name}) {
1433 $self->_remove_table($table);
1437 delete @$self{qw/_dump_storage _relations_started _uniqs_started/};
1439 my $loaded = $self->_load_tables(@current);
1441 foreach my $table (@created) {
1442 $self->monikers->{$table->sql_name} = $self->_table2moniker($table);
1445 return map { $self->monikers->{$_->sql_name} } @created;
1451 return if $self->{skip_relationships};
1453 return $self->{relbuilder} ||= do {
1454 my $relbuilder_suff =
1461 ->{$self->naming->{relationships}||$CURRENT_V} || '';
1463 my $relbuilder_class = 'DBIx::Class::Schema::Loader::RelBuilder'.$relbuilder_suff;
1464 $self->ensure_class_loaded($relbuilder_class);
1465 $relbuilder_class->new($self);
1470 my ($self, @tables) = @_;
1472 # Save the new tables to the tables list
1474 $self->_tables->{$_->sql_name} = $_;
1477 $self->_make_src_class($_) for @tables;
1479 # sanity-check for moniker clashes
1480 my $inverse_moniker_idx;
1481 foreach my $table (values %{ $self->_tables }) {
1482 push @{ $inverse_moniker_idx->{$self->monikers->{$table->sql_name}} }, $table;
1486 foreach my $moniker (keys %$inverse_moniker_idx) {
1487 my $tables = $inverse_moniker_idx->{$moniker};
1489 push @clashes, sprintf ("tables %s reduced to the same source moniker '%s'",
1490 join (', ', map $_->sql_name, @$tables),
1497 die 'Unable to load schema - chosen moniker/class naming style results in moniker clashes. '
1498 . 'In multi db_schema configurations you may need to set moniker_parts, '
1499 . 'otherwise change the naming style, or supply an explicit moniker_map: '
1500 . join ('; ', @clashes)
1505 $self->_setup_src_meta($_) for @tables;
1507 if(!$self->skip_relationships) {
1508 # The relationship loader needs a working schema
1509 local $self->{quiet} = 1;
1510 local $self->{dump_directory} = $self->{temp_directory};
1511 $self->_reload_classes(\@tables);
1512 $self->_load_relationships(\@tables);
1514 # Remove that temp dir from INC so it doesn't get reloaded
1515 @INC = grep $_ ne $self->dump_directory, @INC;
1518 $self->_load_roles($_) for @tables;
1520 $self->_load_external($_)
1521 for map { $self->classes->{$_->sql_name} } @tables;
1523 # Reload without unloading first to preserve any symbols from external
1525 $self->_reload_classes(\@tables, { unload => 0 });
1527 # Drop temporary cache
1528 delete $self->{_cache};
1533 sub _reload_classes {
1534 my ($self, $tables, $opts) = @_;
1536 my @tables = @$tables;
1538 my $unload = $opts->{unload};
1539 $unload = 1 unless defined $unload;
1541 # so that we don't repeat custom sections
1542 @INC = grep $_ ne $self->dump_directory, @INC;
1544 $self->_dump_to_dir(map { $self->classes->{$_->sql_name} } @tables);
1546 unshift @INC, $self->dump_directory;
1549 my %have_source = map { $_ => $self->schema->source($_) }
1550 $self->schema->sources;
1552 for my $table (@tables) {
1553 my $moniker = $self->monikers->{$table->sql_name};
1554 my $class = $self->classes->{$table->sql_name};
1557 no warnings 'redefine';
1558 local *Class::C3::reinitialize = sub {}; # to speed things up, reinitialized below
1561 if (my $mc = $self->_moose_metaclass($class)) {
1564 Class::Unload->unload($class) if $unload;
1565 my ($source, $resultset_class);
1567 ($source = $have_source{$moniker})
1568 && ($resultset_class = $source->resultset_class)
1569 && ($resultset_class ne 'DBIx::Class::ResultSet')
1571 my $has_file = Class::Inspector->loaded_filename($resultset_class);
1572 if (my $mc = $self->_moose_metaclass($resultset_class)) {
1575 Class::Unload->unload($resultset_class) if $unload;
1576 $self->_reload_class($resultset_class) if $has_file;
1578 $self->_reload_class($class);
1580 push @to_register, [$moniker, $class];
1583 Class::C3->reinitialize;
1584 for (@to_register) {
1585 $self->schema->register_class(@$_);
1589 sub _moose_metaclass {
1590 return undef unless $INC{'Class/MOP.pm'}; # if CMOP is not loaded the class could not have loaded in the 1st place
1594 my $mc = try { Class::MOP::class_of($class) }
1597 return $mc->isa('Moose::Meta::Class') ? $mc : undef;
1600 # We use this instead of ensure_class_loaded when there are package symbols we
1603 my ($self, $class) = @_;
1605 delete $INC{ +class_path($class) };
1608 eval_package_without_redefine_warnings ($class, "require $class");
1611 my $source = slurp_file $self->_get_dump_filename($class);
1612 die "Failed to reload class $class: $_.\n\nCLASS SOURCE:\n\n$source";
1616 sub _get_dump_filename {
1617 my ($self, $class) = (@_);
1619 $class =~ s{::}{/}g;
1620 return $self->dump_directory . q{/} . $class . q{.pm};
1623 =head2 get_dump_filename
1627 Returns the full path to the file for a class that the class has been or will
1628 be dumped to. This is a file in a temp dir for a dynamic schema.
1632 sub get_dump_filename {
1633 my ($self, $class) = (@_);
1635 local $self->{dump_directory} = $self->real_dump_directory;
1637 return $self->_get_dump_filename($class);
1640 sub _ensure_dump_subdirs {
1641 my ($self, $class) = (@_);
1643 my @name_parts = split(/::/, $class);
1644 pop @name_parts; # we don't care about the very last element,
1645 # which is a filename
1647 my $dir = $self->dump_directory;
1650 mkdir($dir) or croak "mkdir('$dir') failed: $!";
1652 last if !@name_parts;
1653 $dir = File::Spec->catdir($dir, shift @name_parts);
1658 my ($self, @classes) = @_;
1660 my $schema_class = $self->schema_class;
1661 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
1663 my $target_dir = $self->dump_directory;
1664 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
1665 unless $self->dynamic or $self->quiet;
1669 . qq|package $schema_class;\n\n|
1670 . qq|# Created by DBIx::Class::Schema::Loader\n|
1671 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|;
1674 = $self->only_autoclean
1675 ? 'namespace::autoclean'
1676 : 'MooseX::MarkAsMethods autoclean => 1'
1679 if ($self->use_moose) {
1681 $schema_text.= qq|use Moose;\nuse $autoclean;\nextends '$schema_base_class';\n\n|;
1684 $schema_text .= qq|use strict;\nuse warnings;\n\nuse base '$schema_base_class';\n\n|;
1687 my @schema_components = @{ $self->schema_components || [] };
1689 if (@schema_components) {
1690 my $schema_components = dump @schema_components;
1691 $schema_components = "($schema_components)" if @schema_components == 1;
1693 $schema_text .= "__PACKAGE__->load_components${schema_components};\n\n";
1696 if ($self->use_namespaces) {
1697 $schema_text .= qq|__PACKAGE__->load_namespaces|;
1698 my $namespace_options;
1700 my @attr = qw/resultset_namespace default_resultset_class/;
1702 unshift @attr, 'result_namespace' unless (not $self->result_namespace) || $self->result_namespace eq 'Result';
1704 for my $attr (@attr) {
1706 my $code = dumper_squashed $self->$attr;
1707 $namespace_options .= qq| $attr => $code,\n|
1710 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
1711 $schema_text .= qq|;\n|;
1714 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
1718 local $self->{version_to_dump} = $self->schema_version_to_dump;
1719 $self->_write_classfile($schema_class, $schema_text, 1);
1722 my $result_base_class = $self->result_base_class || 'DBIx::Class::Core';
1724 foreach my $src_class (@classes) {
1727 . qq|package $src_class;\n\n|
1728 . qq|# Created by DBIx::Class::Schema::Loader\n|
1729 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|;
1731 $src_text .= $self->_make_pod_heading($src_class);
1733 $src_text .= qq|use strict;\nuse warnings;\n\n|;
1735 $src_text .= $self->_base_class_pod($result_base_class)
1736 unless $result_base_class eq 'DBIx::Class::Core';
1738 if ($self->use_moose) {
1739 $src_text.= qq|use Moose;\nuse MooseX::NonMoose;\nuse $autoclean;|;
1741 # these options 'use base' which is compile time
1742 if (@{ $self->left_base_classes } || @{ $self->additional_base_classes }) {
1743 $src_text .= qq|\nBEGIN { extends '$result_base_class' }\n|;
1746 $src_text .= qq|\nextends '$result_base_class';\n|;
1750 $src_text .= qq|use base '$result_base_class';\n|;
1753 $self->_write_classfile($src_class, $src_text);
1756 # remove Result dir if downgrading from use_namespaces, and there are no
1758 if (my $result_ns = $self->_downgrading_to_load_classes
1759 || $self->_rewriting_result_namespace) {
1760 my $result_namespace = $self->_result_namespace(
1765 (my $result_dir = $result_namespace) =~ s{::}{/}g;
1766 $result_dir = $self->dump_directory . '/' . $result_dir;
1768 unless (my @files = glob "$result_dir/*") {
1773 warn "Schema dump completed.\n" unless $self->dynamic or $self->quiet;
1777 my ($self, $version, $ts) = @_;
1778 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
1781 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
1784 sub _write_classfile {
1785 my ($self, $class, $text, $is_schema) = @_;
1787 my $filename = $self->_get_dump_filename($class);
1788 $self->_ensure_dump_subdirs($class);
1790 if (-f $filename && $self->really_erase_my_files) {
1791 warn "Deleting existing file '$filename' due to "
1792 . "'really_erase_my_files' setting\n" unless $self->quiet;
1796 my ($old_gen, $old_md5, $old_ver, $old_ts, $old_custom)
1797 = $self->_parse_generated_file($filename);
1799 if (! $old_gen && -f $filename) {
1800 croak "Cannot overwrite '$filename' without 'really_erase_my_files',"
1801 . " it does not appear to have been generated by Loader"
1804 my $custom_content = $old_custom || '';
1806 # prepend extra custom content from a *renamed* class (singularization effect)
1807 if (my $renamed_class = $self->_upgrading_classes->{$class}) {
1808 my $old_filename = $self->_get_dump_filename($renamed_class);
1810 if (-f $old_filename) {
1811 my $extra_custom = ($self->_parse_generated_file ($old_filename))[4];
1813 $extra_custom =~ s/\n\n# You can replace.*\n1;\n//;
1815 $custom_content = join ("\n", '', $extra_custom, $custom_content)
1818 unlink $old_filename;
1822 $custom_content ||= $self->_default_custom_content($is_schema);
1824 # If upgrading to use_moose=1 replace default custom content with default Moose custom content.
1825 # If there is already custom content, which does not have the Moose content, add it.
1826 if ($self->use_moose) {
1828 my $non_moose_custom_content = do {
1829 local $self->{use_moose} = 0;
1830 $self->_default_custom_content;
1833 if ($custom_content eq $non_moose_custom_content) {
1834 $custom_content = $self->_default_custom_content($is_schema);
1836 elsif ($custom_content !~ /\Q@{[$self->_default_moose_custom_content($is_schema)]}\E/) {
1837 $custom_content .= $self->_default_custom_content($is_schema);
1840 elsif (defined $self->use_moose && $old_gen) {
1841 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'
1842 if $old_gen =~ /use \s+ MooseX?\b/x;
1845 $custom_content = $self->_rewrite_old_classnames($custom_content);
1848 for @{$self->{_dump_storage}->{$class} || []};
1850 if ($self->filter_generated_code) {
1851 my $filter = $self->filter_generated_code;
1853 if (ref $filter eq 'CODE') {
1855 ($is_schema ? 'schema' : 'result'),
1861 my ($out, $in) = (gensym, gensym);
1863 my $pid = open2($out, $in, $filter)
1864 or croak "Could not open pipe to $filter: $!";
1870 $text = decode('UTF-8', do { local $/; <$out> });
1872 $text =~ s/$CR?$LF/\n/g;
1876 my $exit_code = $? >> 8;
1878 if ($exit_code != 0) {
1879 croak "filter '$filter' exited non-zero: $exit_code";
1882 if (not $text or not $text =~ /\bpackage\b/) {
1883 warn("$class skipped due to filter") if $self->debug;
1888 # Check and see if the dump is in fact different
1892 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
1893 if (Digest::MD5::md5_base64(encode 'UTF-8', $compare_to) eq $old_md5) {
1894 return unless $self->_upgrading_from && $is_schema;
1898 $text .= $self->_sig_comment(
1899 $self->version_to_dump,
1900 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
1903 open(my $fh, '>:encoding(UTF-8)', $filename)
1904 or croak "Cannot open '$filename' for writing: $!";
1906 # Write the top half and its MD5 sum
1907 print $fh $text . Digest::MD5::md5_base64(encode 'UTF-8', $text) . "\n";
1909 # Write out anything loaded via external partial class file in @INC
1911 for @{$self->{_ext_storage}->{$class} || []};
1913 # Write out any custom content the user has added
1914 print $fh $custom_content;
1917 or croak "Error closing '$filename': $!";
1920 sub _default_moose_custom_content {
1921 my ($self, $is_schema) = @_;
1923 if (not $is_schema) {
1924 return qq|\n__PACKAGE__->meta->make_immutable;|;
1927 return qq|\n__PACKAGE__->meta->make_immutable(inline_constructor => 0);|;
1930 sub _default_custom_content {
1931 my ($self, $is_schema) = @_;
1932 my $default = qq|\n\n# You can replace this text with custom|
1933 . qq| code or comments, and it will be preserved on regeneration|;
1934 if ($self->use_moose) {
1935 $default .= $self->_default_moose_custom_content($is_schema);
1937 $default .= qq|\n1;\n|;
1941 sub _parse_generated_file {
1942 my ($self, $fn) = @_;
1944 return unless -f $fn;
1946 open(my $fh, '<:encoding(UTF-8)', $fn)
1947 or croak "Cannot open '$fn' for reading: $!";
1950 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\r?\n};
1952 my ($md5, $ts, $ver, $gen);
1958 # Pull out the version and timestamp from the line above
1959 ($ver, $ts) = $gen =~ m/^# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)\r?\Z/m;
1962 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"
1963 if !$self->overwrite_modifications && Digest::MD5::md5_base64(encode 'UTF-8', $gen) ne $md5;
1972 my $custom = do { local $/; <$fh> }
1976 $custom =~ s/$CRLF|$LF/\n/g;
1980 return ($gen, $md5, $ver, $ts, $custom);
1988 warn "$target: use $_;" if $self->debug;
1989 $self->_raw_stmt($target, "use $_;");
1997 my $blist = join(q{ }, @_);
1999 return unless $blist;
2001 warn "$target: use base qw/$blist/;" if $self->debug;
2002 $self->_raw_stmt($target, "use base qw/$blist/;");
2009 my $rlist = join(q{, }, map { qq{'$_'} } @_);
2011 return unless $rlist;
2013 warn "$target: with $rlist;" if $self->debug;
2014 $self->_raw_stmt($target, "\nwith $rlist;");
2017 sub _result_namespace {
2018 my ($self, $schema_class, $ns) = @_;
2019 my @result_namespace;
2021 $ns = $ns->[0] if ref $ns;
2023 if ($ns =~ /^\+(.*)/) {
2024 # Fully qualified namespace
2025 @result_namespace = ($1)
2028 # Relative namespace
2029 @result_namespace = ($schema_class, $ns);
2032 return wantarray ? @result_namespace : join '::', @result_namespace;
2035 # Create class with applicable bases, setup monikers, etc
2036 sub _make_src_class {
2037 my ($self, $table) = @_;
2039 my $schema = $self->schema;
2040 my $schema_class = $self->schema_class;
2042 my $table_moniker = $self->_table2moniker($table);
2043 my @result_namespace = ($schema_class);
2044 if ($self->use_namespaces) {
2045 my $result_namespace = $self->result_namespace || 'Result';
2046 @result_namespace = $self->_result_namespace(
2051 my $table_class = join(q{::}, @result_namespace, $table_moniker);
2053 if ((my $upgrading_v = $self->_upgrading_from)
2054 || $self->_rewriting) {
2055 local $self->naming->{monikers} = $upgrading_v
2058 my @result_namespace = @result_namespace;
2059 if ($self->_upgrading_from_load_classes) {
2060 @result_namespace = ($schema_class);
2062 elsif (my $ns = $self->_downgrading_to_load_classes) {
2063 @result_namespace = $self->_result_namespace(
2068 elsif ($ns = $self->_rewriting_result_namespace) {
2069 @result_namespace = $self->_result_namespace(
2075 my $old_table_moniker = do {
2076 local $self->naming->{monikers} = $upgrading_v;
2077 $self->_table2moniker($table);
2080 my $old_class = join(q{::}, @result_namespace, $old_table_moniker);
2082 $self->_upgrading_classes->{$table_class} = $old_class
2083 unless $table_class eq $old_class;
2086 $self->classes->{$table->sql_name} = $table_class;
2087 $self->monikers->{$table->sql_name} = $table_moniker;
2088 $self->moniker_to_table->{$table_moniker} = $table;
2089 $self->class_to_table->{$table_class} = $table;
2091 $self->_pod_class_list($table_class, 'ADDITIONAL CLASSES USED', @{$self->additional_classes});
2093 $self->_use ($table_class, @{$self->additional_classes});
2095 $self->_pod_class_list($table_class, 'LEFT BASE CLASSES', @{$self->left_base_classes});
2097 $self->_inject($table_class, @{$self->left_base_classes});
2099 my @components = @{ $self->components || [] };
2101 push @components, @{ $self->result_components_map->{$table_moniker} }
2102 if exists $self->result_components_map->{$table_moniker};
2104 my @fq_components = @components;
2105 foreach my $component (@fq_components) {
2106 if ($component !~ s/^\+//) {
2107 $component = "DBIx::Class::$component";
2111 $self->_pod_class_list($table_class, 'COMPONENTS LOADED', @fq_components);
2113 $self->_dbic_stmt($table_class, 'load_components', @components) if @components;
2115 $self->_pod_class_list($table_class, 'ADDITIONAL BASE CLASSES', @{$self->additional_base_classes});
2117 $self->_inject($table_class, @{$self->additional_base_classes});
2120 sub _is_result_class_method {
2121 my ($self, $name, $table) = @_;
2123 my $table_moniker = $table ? $self->monikers->{$table->sql_name} : '';
2125 $self->_result_class_methods({})
2126 if not defined $self->_result_class_methods;
2128 if (not exists $self->_result_class_methods->{$table_moniker}) {
2129 my (@methods, %methods);
2130 my $base = $self->result_base_class || 'DBIx::Class::Core';
2132 my @components = @{ $self->components || [] };
2134 push @components, @{ $self->result_components_map->{$table_moniker} }
2135 if exists $self->result_components_map->{$table_moniker};
2137 for my $c (@components) {
2138 $c = $c =~ /^\+/ ? substr($c,1) : "DBIx::Class::$c";
2141 my @roles = @{ $self->result_roles || [] };
2143 push @roles, @{ $self->result_roles_map->{$table_moniker} }
2144 if exists $self->result_roles_map->{$table_moniker};
2146 for my $class ($base, @components,
2147 ($self->use_moose ? 'Moose::Object' : ()), @roles) {
2148 $self->ensure_class_loaded($class);
2150 push @methods, @{ Class::Inspector->methods($class) || [] };
2153 push @methods, @{ Class::Inspector->methods('UNIVERSAL') };
2155 @methods{@methods} = ();
2157 $self->_result_class_methods->{$table_moniker} = \%methods;
2159 my $result_methods = $self->_result_class_methods->{$table_moniker};
2161 return exists $result_methods->{$name};
2164 sub _resolve_col_accessor_collisions {
2165 my ($self, $table, $col_info) = @_;
2167 while (my ($col, $info) = each %$col_info) {
2168 my $accessor = $info->{accessor} || $col;
2170 next if $accessor eq 'id'; # special case (very common column)
2172 if ($self->_is_result_class_method($accessor, $table)) {
2175 if (my $map = $self->col_collision_map) {
2176 for my $re (keys %$map) {
2177 if (my @matches = $col =~ /$re/) {
2178 $info->{accessor} = sprintf $map->{$re}, @matches;
2186 Column '$col' in table '$table' collides with an inherited method.
2187 See "COLUMN ACCESSOR COLLISIONS" in perldoc DBIx::Class::Schema::Loader::Base .
2189 $info->{accessor} = undef;
2195 # use the same logic to run moniker_map, col_accessor_map
2197 my ( $self, $map, $default_code, $ident, @extra ) = @_;
2199 my $default_ident = $default_code->( $ident, @extra );
2201 if( $map && ref $map eq 'HASH' ) {
2202 $new_ident = $map->{ $ident };
2204 elsif( $map && ref $map eq 'CODE' ) {
2205 $new_ident = $map->( $ident, $default_ident, @extra );
2208 $new_ident ||= $default_ident;
2213 sub _default_column_accessor_name {
2214 my ( $self, $column_name ) = @_;
2216 my $preserve = ($self->naming->{column_accessors}||'') eq 'preserve';
2218 my $v = $self->_get_naming_v('column_accessors');
2220 my $accessor_name = $preserve ?
2221 $self->_to_identifier('column_accessors', $column_name) # assume CamelCase
2223 $self->_to_identifier('column_accessors', $column_name, '_');
2225 $accessor_name =~ s/\W+/_/g; # only if naming < v8, otherwise to_identifier
2229 return $accessor_name;
2231 elsif ($v < 7 || (not $self->preserve_case)) {
2232 # older naming just lc'd the col accessor and that's all.
2233 return lc $accessor_name;
2236 return join '_', map lc, split_name $column_name, $v;
2239 sub _make_column_accessor_name {
2240 my ($self, $column_name, $column_context_info ) = @_;
2242 my $accessor = $self->_run_user_map(
2243 $self->col_accessor_map,
2244 sub { $self->_default_column_accessor_name( shift ) },
2246 $column_context_info,
2252 # Set up metadata (cols, pks, etc)
2253 sub _setup_src_meta {
2254 my ($self, $table) = @_;
2256 my $schema = $self->schema;
2257 my $schema_class = $self->schema_class;
2259 my $table_class = $self->classes->{$table->sql_name};
2260 my $table_moniker = $self->monikers->{$table->sql_name};
2262 $self->_dbic_stmt($table_class, 'table', $table->dbic_name);
2264 my $cols = $self->_table_columns($table);
2265 my $col_info = $self->__columns_info_for($table);
2267 ### generate all the column accessor names
2268 while (my ($col, $info) = each %$col_info) {
2269 # hashref of other info that could be used by
2270 # user-defined accessor map functions
2272 table_class => $table_class,
2273 table_moniker => $table_moniker,
2274 table_name => $table,
2275 full_table_name => $table->dbic_name,
2276 schema_class => $schema_class,
2277 column_info => $info,
2280 $info->{accessor} = $self->_make_column_accessor_name( $col, $context );
2283 $self->_resolve_col_accessor_collisions($table, $col_info);
2285 # prune any redundant accessor names
2286 while (my ($col, $info) = each %$col_info) {
2287 no warnings 'uninitialized';
2288 delete $info->{accessor} if $info->{accessor} eq $col;
2291 my $fks = $self->_table_fk_info($table);
2293 foreach my $fkdef (@$fks) {
2294 for my $col (@{ $fkdef->{local_columns} }) {
2295 $col_info->{$col}{is_foreign_key} = 1;
2299 my $pks = $self->_table_pk_info($table) || [];
2301 my %uniq_tag; # used to eliminate duplicate uniqs
2303 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
2305 my $uniqs = $self->_table_uniq_info($table) || [];
2308 foreach my $uniq (@$uniqs) {
2309 my ($name, $cols) = @$uniq;
2310 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
2311 push @uniqs, [$name, $cols];
2314 my @non_nullable_uniqs = grep {
2315 all { $col_info->{$_}{is_nullable} == 0 } @{ $_->[1] }
2318 if ($self->uniq_to_primary && (not @$pks) && @non_nullable_uniqs) {
2319 my @by_colnum = sort { $b->[0] <=> $a->[0] }
2320 map [ scalar @{ $_->[1] }, $_ ], @non_nullable_uniqs;
2322 if (not (@by_colnum > 1 && $by_colnum[0][0] == $by_colnum[1][0])) {
2323 my @keys = map $_->[1], @by_colnum;
2327 # remove the uniq from list
2328 @uniqs = grep { $_->[0] ne $pk->[0] } @uniqs;
2334 foreach my $pkcol (@$pks) {
2335 $col_info->{$pkcol}{is_nullable} = 0;
2341 map { $_, ($col_info->{$_}||{}) } @$cols
2344 $self->_dbic_stmt($table_class, 'set_primary_key', @$pks)
2347 # Sort unique constraints by constraint name for repeatable results (rels
2348 # are sorted as well elsewhere.)
2349 @uniqs = sort { $a->[0] cmp $b->[0] } @uniqs;
2351 foreach my $uniq (@uniqs) {
2352 my ($name, $cols) = @$uniq;
2353 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
2357 sub __columns_info_for {
2358 my ($self, $table) = @_;
2360 my $result = $self->_columns_info_for($table);
2362 while (my ($col, $info) = each %$result) {
2363 $info = { %$info, %{ $self->_custom_column_info ($table, $col, $info) } };
2364 $info = { %$info, %{ $self->_datetime_column_info($table, $col, $info) } };
2366 $result->{$col} = $info;
2374 Returns a sorted list of loaded tables, using the original database table
2382 return values %{$self->_tables};
2386 my ($self, $naming_key) = @_;
2390 if (($self->naming->{$naming_key}||'') =~ /^v(\d+)\z/) {
2394 ($v) = $CURRENT_V =~ /^v(\d+)\z/;
2400 sub _to_identifier {
2401 my ($self, $naming_key, $name, $sep_char, $force) = @_;
2403 my $v = $self->_get_naming_v($naming_key);
2405 my $to_identifier = $self->naming->{force_ascii} ?
2406 \&String::ToIdentifier::EN::to_identifier
2407 : \&String::ToIdentifier::EN::Unicode::to_identifier;
2409 return $v >= 8 || $force ? $to_identifier->($name, $sep_char) : $name;
2412 # Make a moniker from a table
2413 sub _default_table2moniker {
2414 my ($self, $table) = @_;
2416 my $v = $self->_get_naming_v('monikers');
2418 my @name_parts = map $table->$_, @{ $self->moniker_parts };
2420 my $name_idx = firstidx { $_ eq 'name' } @{ $self->moniker_parts };
2424 foreach my $i (0 .. $#name_parts) {
2425 my $part = $name_parts[$i];
2427 if ($i != $name_idx || $v >= 8) {
2428 $part = $self->_to_identifier('monikers', $part, '_', 1);
2431 if ($i == $name_idx && $v == 5) {
2432 $part = Lingua::EN::Inflect::Number::to_S($part);
2435 my @part_parts = map lc, $v > 6 ?
2436 # use v8 semantics for all moniker parts except name
2437 ($i == $name_idx ? split_name $part, $v : split_name $part)
2438 : split /[\W_]+/, $part;
2440 if ($i == $name_idx && $v >= 6) {
2441 my $as_phrase = join ' ', @part_parts;
2443 my $inflected = ($self->naming->{monikers}||'') eq 'plural' ?
2444 Lingua::EN::Inflect::Phrase::to_PL($as_phrase)
2446 ($self->naming->{monikers}||'') eq 'preserve' ?
2449 Lingua::EN::Inflect::Phrase::to_S($as_phrase);
2451 @part_parts = split /\s+/, $inflected;
2454 push @all_parts, map ucfirst, @part_parts;
2457 return join '', @all_parts;
2460 sub _table2moniker {
2461 my ( $self, $table ) = @_;
2463 $self->_run_user_map(
2465 sub { $self->_default_table2moniker( shift ) },
2470 sub _load_relationships {
2471 my ($self, $tables) = @_;
2475 foreach my $table (@$tables) {
2476 my $local_moniker = $self->monikers->{$table->sql_name};
2478 my $tbl_fk_info = $self->_table_fk_info($table);
2480 foreach my $fkdef (@$tbl_fk_info) {
2481 $fkdef->{local_table} = $table;
2482 $fkdef->{local_moniker} = $local_moniker;
2483 $fkdef->{remote_source} =
2484 $self->monikers->{$fkdef->{remote_table}->sql_name};
2486 my $tbl_uniq_info = $self->_table_uniq_info($table);
2488 push @tables, [ $local_moniker, $tbl_fk_info, $tbl_uniq_info ];
2491 my $rel_stmts = $self->_relbuilder->generate_code(\@tables);
2493 foreach my $src_class (sort keys %$rel_stmts) {
2495 my @src_stmts = map $_->[1],
2496 sort { $a->[0] cmp $b->[0] }
2497 map [ $_->{args}[0], $_ ], @{ $rel_stmts->{$src_class} };
2499 foreach my $stmt (@src_stmts) {
2500 $self->_dbic_stmt($src_class,$stmt->{method}, @{$stmt->{args}});
2506 my ($self, $table) = @_;
2508 my $table_moniker = $self->monikers->{$table->sql_name};
2509 my $table_class = $self->classes->{$table->sql_name};
2511 my @roles = @{ $self->result_roles || [] };
2512 push @roles, @{ $self->result_roles_map->{$table_moniker} }
2513 if exists $self->result_roles_map->{$table_moniker};
2516 $self->_pod_class_list($table_class, 'L<Moose> ROLES APPLIED', @roles);
2518 $self->_with($table_class, @roles);
2522 # Overload these in driver class:
2524 # Returns an arrayref of column names
2525 sub _table_columns { croak "ABSTRACT METHOD" }
2527 # Returns arrayref of pk col names
2528 sub _table_pk_info { croak "ABSTRACT METHOD" }
2530 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
2531 sub _table_uniq_info { croak "ABSTRACT METHOD" }
2533 # Returns an arrayref of foreign key constraints, each
2534 # being a hashref with 3 keys:
2535 # local_columns (arrayref), remote_columns (arrayref), remote_table
2536 sub _table_fk_info { croak "ABSTRACT METHOD" }
2538 # Returns an array of lower case table names
2539 sub _tables_list { croak "ABSTRACT METHOD" }
2541 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
2547 # generate the pod for this statement, storing it with $self->_pod
2548 $self->_make_pod( $class, $method, @_ ) if $self->generate_pod;
2550 my $args = dump(@_);
2551 $args = '(' . $args . ')' if @_ < 2;
2552 my $stmt = $method . $args . q{;};
2554 warn qq|$class\->$stmt\n| if $self->debug;
2555 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
2559 sub _make_pod_heading {
2560 my ($self, $class) = @_;
2562 return '' if not $self->generate_pod;
2564 my $table = $self->class_to_table->{$class};
2567 my $pcm = $self->pod_comment_mode;
2568 my ($comment, $comment_overflows, $comment_in_name, $comment_in_desc);
2569 $comment = $self->__table_comment($table);
2570 $comment_overflows = ($comment and length $comment > $self->pod_comment_spillover_length);
2571 $comment_in_name = ($pcm eq 'name' or ($pcm eq 'auto' and !$comment_overflows));
2572 $comment_in_desc = ($pcm eq 'description' or ($pcm eq 'auto' and $comment_overflows));
2574 $pod .= "=head1 NAME\n\n";
2576 my $table_descr = $class;
2577 $table_descr .= " - " . $comment if $comment and $comment_in_name;
2579 $pod .= "$table_descr\n\n";
2581 if ($comment and $comment_in_desc) {
2582 $pod .= "=head1 DESCRIPTION\n\n${comment}\n\n";
2589 # generates the accompanying pod for a DBIC class method statement,
2590 # storing it with $self->_pod
2596 if ($method eq 'table') {
2598 $table = $$table if ref $table eq 'SCALAR';
2599 $self->_pod($class, "=head1 TABLE: C<$table>");
2600 $self->_pod_cut($class);
2602 elsif ( $method eq 'add_columns' ) {
2603 $self->_pod( $class, "=head1 ACCESSORS" );
2604 my $col_counter = 0;
2606 while( my ($name,$attrs) = splice @cols,0,2 ) {
2608 $self->_pod( $class, '=head2 ' . $name );
2609 $self->_pod( $class,
2611 my $s = $attrs->{$_};
2612 $s = !defined $s ? 'undef' :
2613 length($s) == 0 ? '(empty string)' :
2614 ref($s) eq 'SCALAR' ? $$s :
2615 ref($s) ? dumper_squashed $s :
2616 looks_like_number($s) ? $s : qq{'$s'};
2619 } sort keys %$attrs,
2621 if (my $comment = $self->__column_comment($self->class_to_table->{$class}, $col_counter, $name)) {
2622 $self->_pod( $class, $comment );
2625 $self->_pod_cut( $class );
2626 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
2627 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
2628 my ( $accessor, $rel_class ) = @_;
2629 $self->_pod( $class, "=head2 $accessor" );
2630 $self->_pod( $class, 'Type: ' . $method );
2631 $self->_pod( $class, "Related object: L<$rel_class>" );
2632 $self->_pod_cut( $class );
2633 $self->{_relations_started} { $class } = 1;
2635 elsif ($method eq 'add_unique_constraint') {
2636 $self->_pod($class, '=head1 UNIQUE CONSTRAINTS')
2637 unless $self->{_uniqs_started}{$class};
2639 my ($name, $cols) = @_;
2641 $self->_pod($class, "=head2 C<$name>");
2642 $self->_pod($class, '=over 4');
2644 foreach my $col (@$cols) {
2645 $self->_pod($class, "=item \* L</$col>");
2648 $self->_pod($class, '=back');
2649 $self->_pod_cut($class);
2651 $self->{_uniqs_started}{$class} = 1;
2653 elsif ($method eq 'set_primary_key') {
2654 $self->_pod($class, "=head1 PRIMARY KEY");
2655 $self->_pod($class, '=over 4');
2657 foreach my $col (@_) {
2658 $self->_pod($class, "=item \* L</$col>");
2661 $self->_pod($class, '=back');
2662 $self->_pod_cut($class);
2666 sub _pod_class_list {
2667 my ($self, $class, $title, @classes) = @_;
2669 return unless @classes && $self->generate_pod;
2671 $self->_pod($class, "=head1 $title");
2672 $self->_pod($class, '=over 4');
2674 foreach my $link (@classes) {
2675 $self->_pod($class, "=item * L<$link>");
2678 $self->_pod($class, '=back');
2679 $self->_pod_cut($class);
2682 sub _base_class_pod {
2683 my ($self, $base_class) = @_;
2685 return '' unless $self->generate_pod;
2688 =head1 BASE CLASS: L<$base_class>
2695 sub _filter_comment {
2696 my ($self, $txt) = @_;
2698 $txt = '' if not defined $txt;
2700 $txt =~ s/(?:\015?\012|\015\012?)/\n/g;
2705 sub __table_comment {
2708 if (my $code = $self->can('_table_comment')) {
2709 return $self->_filter_comment($self->$code(@_));
2715 sub __column_comment {
2718 if (my $code = $self->can('_column_comment')) {
2719 return $self->_filter_comment($self->$code(@_));
2725 # Stores a POD documentation
2727 my ($self, $class, $stmt) = @_;
2728 $self->_raw_stmt( $class, "\n" . $stmt );
2732 my ($self, $class ) = @_;
2733 $self->_raw_stmt( $class, "\n=cut\n" );
2736 # Store a raw source line for a class (for dumping purposes)
2738 my ($self, $class, $stmt) = @_;
2739 push(@{$self->{_dump_storage}->{$class}}, $stmt);
2742 # Like above, but separately for the externally loaded stuff
2744 my ($self, $class, $stmt) = @_;
2745 push(@{$self->{_ext_storage}->{$class}}, $stmt);
2748 sub _custom_column_info {
2749 my ( $self, $table_name, $column_name, $column_info ) = @_;
2751 if (my $code = $self->custom_column_info) {
2752 return $code->($table_name, $column_name, $column_info) || {};
2757 sub _datetime_column_info {
2758 my ( $self, $table_name, $column_name, $column_info ) = @_;
2760 my $type = $column_info->{data_type} || '';
2761 if ((grep $_, @{ $column_info }{map "inflate_$_", qw/date datetime timestamp/})
2762 or ($type =~ /date|timestamp/i)) {
2763 $result->{timezone} = $self->datetime_timezone if $self->datetime_timezone;
2764 $result->{locale} = $self->datetime_locale if $self->datetime_locale;
2770 my ($self, $name) = @_;
2772 return $self->preserve_case ? $name : lc($name);
2776 my ($self, $name) = @_;
2778 return $self->preserve_case ? $name : uc($name);
2782 my ($self, $table) = @_;
2785 my $schema = $self->schema;
2786 # in older DBIC it's a private method
2787 my $unregister = $schema->can('unregister_source') || $schema->can('_unregister_source');
2788 $schema->$unregister(delete $self->monikers->{$table->sql_name});
2789 delete $self->_upgrading_classes->{delete $self->classes->{$table->sql_name}};
2790 delete $self->_tables->{$table->sql_name};
2794 # remove the dump dir from @INC on destruction
2798 @INC = grep $_ ne $self->dump_directory, @INC;
2803 Returns a hashref of loaded table to moniker mappings. There will
2804 be two entries for each table, the original name and the "normalized"
2805 name, in the case that the two are different (such as databases
2806 that like uppercase table names, or preserve your original mixed-case
2807 definitions, or what-have-you).
2811 Returns a hashref of table to class mappings. In some cases it will
2812 contain multiple entries per table for the original and normalized table
2813 names, as above in L</monikers>.
2815 =head1 NON-ENGLISH DATABASES
2817 If you use the loader on a database with table and column names in a language
2818 other than English, you will want to turn off the English language specific
2821 To do so, use something like this in your laoder options:
2823 naming => { monikers => 'v4' },
2824 inflect_singular => sub { "$_[0]_rel" },
2825 inflect_plural => sub { "$_[0]_rel" },
2827 =head1 COLUMN ACCESSOR COLLISIONS
2829 Occasionally you may have a column name that collides with a perl method, such
2830 as C<can>. In such cases, the default action is to set the C<accessor> of the
2831 column spec to C<undef>.
2833 You can then name the accessor yourself by placing code such as the following
2836 __PACKAGE__->add_column('+can' => { accessor => 'my_can' });
2838 Another option is to use the L</col_collision_map> option.
2840 =head1 RELATIONSHIP NAME COLLISIONS
2842 In very rare cases, you may get a collision between a generated relationship
2843 name and a method in your Result class, for example if you have a foreign key
2844 called C<belongs_to>.
2846 This is a problem because relationship names are also relationship accessor
2847 methods in L<DBIx::Class>.
2849 The default behavior is to append C<_rel> to the relationship name and print
2850 out a warning that refers to this text.
2852 You can also control the renaming with the L</rel_collision_map> option.
2856 L<DBIx::Class::Schema::Loader>
2860 See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
2864 This library is free software; you can redistribute it and/or modify it under
2865 the same terms as Perl itself.
2870 # vim:et sts=4 sw=4 tw=0: