1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast 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//;
19 our $VERSION = '0.04999_07';
21 __PACKAGE__->mk_ro_accessors(qw/
28 additional_base_classes
43 default_resultset_class
55 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
59 See L<DBIx::Class::Schema::Loader>
63 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
64 classes, and implements the common functionality between them.
66 =head1 CONSTRUCTOR OPTIONS
68 These constructor options are the base options for
69 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
71 =head2 skip_relationships
73 Skip setting up relationships. The default is to attempt the loading
78 If set to true, each constructive L<DBIx::Class> statement the loader
79 decides to execute will be C<warn>-ed before execution.
83 Set the name of the schema to load (schema in the sense that your database
84 vendor means it). Does not currently support loading more than one schema
89 Only load tables matching regex. Best specified as a qr// regex.
93 Exclude tables matching regex. Best specified as a qr// regex.
97 Overrides the default table name to moniker translation. Can be either
98 a hashref of table keys and moniker values, or a coderef for a translator
99 function taking a single scalar table name argument and returning
100 a scalar moniker. If the hash entry does not exist, or the function
101 returns a false value, the code falls back to default behavior
104 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
105 which is to say: lowercase everything, split up the table name into chunks
106 anywhere a non-alpha-numeric character occurs, change the case of first letter
107 of each chunk to upper case, and put the chunks back together. Examples:
109 Table Name | Moniker Name
110 ---------------------------
112 luser_group | LuserGroup
113 luser-opts | LuserOpts
115 =head2 inflect_plural
117 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
118 if hash key does not exist or coderef returns false), but acts as a map
119 for pluralizing relationship names. The default behavior is to utilize
120 L<Lingua::EN::Inflect::Number/to_PL>.
122 =head2 inflect_singular
124 As L</inflect_plural> above, but for singularizing relationship names.
125 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
127 =head2 schema_base_class
129 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
131 =head2 result_base_class
133 Base class for your table classes (aka result classes). Defaults to 'DBIx::Class'.
135 =head2 additional_base_classes
137 List of additional base classes all of your table classes will use.
139 =head2 left_base_classes
141 List of additional base classes all of your table classes will use
142 that need to be leftmost.
144 =head2 additional_classes
146 List of additional classes which all of your table classes will use.
150 List of additional components to be loaded into all of your table
151 classes. A good example would be C<ResultSetManager>.
153 =head2 resultset_components
155 List of additional ResultSet components to be loaded into your table
156 classes. A good example would be C<AlwaysRS>. Component
157 C<ResultSetManager> will be automatically added to the above
158 C<components> list if this option is set.
160 =head2 use_namespaces
162 Generate result class names suitable for
163 L<DBIx::Class::Schema/load_namespaces> and call that instead of
164 L<DBIx::Class::Schema/load_classes>. When using this option you can also
165 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
166 C<resultset_namespace>, C<default_resultset_class>), and they will be added
167 to the call (and the generated result class names adjusted appropriately).
169 =head2 dump_directory
171 This option is designed to be a tool to help you transition from this
172 loader to a manually-defined schema when you decide it's time to do so.
174 The value of this option is a perl libdir pathname. Within
175 that directory this module will create a baseline manual
176 L<DBIx::Class::Schema> module set, based on what it creates at runtime
179 The created schema class will have the same classname as the one on
180 which you are setting this option (and the ResultSource classes will be
181 based on this name as well).
183 Normally you wouldn't hard-code this setting in your schema class, as it
184 is meant for one-time manual usage.
186 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
187 recommended way to access this functionality.
189 =head2 dump_overwrite
191 Deprecated. See L</really_erase_my_files> below, which does *not* mean
192 the same thing as the old C<dump_overwrite> setting from previous releases.
194 =head2 really_erase_my_files
196 Default false. If true, Loader will unconditionally delete any existing
197 files before creating the new ones from scratch when dumping a schema to disk.
199 The default behavior is instead to only replace the top portion of the
200 file, up to and including the final stanza which contains
201 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
202 leaving any customizations you placed after that as they were.
204 When C<really_erase_my_files> is not set, if the output file already exists,
205 but the aforementioned final stanza is not found, or the checksum
206 contained there does not match the generated contents, Loader will
207 croak and not touch the file.
209 You should really be using version control on your schema classes (and all
210 of the rest of your code for that matter). Don't blame me if a bug in this
211 code wipes something out when it shouldn't have, you've been warned.
215 None of these methods are intended for direct invocation by regular
216 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
217 can also be found via standard L<DBIx::Class::Schema> methods somehow.
221 # ensure that a peice of object data is a valid arrayref, creating
222 # an empty one or encapsulating whatever's there.
223 sub _ensure_arrayref {
228 $self->{$_} = [ $self->{$_} ]
229 unless ref $self->{$_} eq 'ARRAY';
235 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
236 by L<DBIx::Class::Schema::Loader>.
241 my ( $class, %args ) = @_;
243 my $self = { %args };
245 bless $self => $class;
247 $self->_ensure_arrayref(qw/additional_classes
248 additional_base_classes
254 push(@{$self->{components}}, 'ResultSetManager')
255 if @{$self->{resultset_components}};
257 $self->{monikers} = {};
258 $self->{classes} = {};
260 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
261 $self->{schema} ||= $self->{schema_class};
263 croak "dump_overwrite is deprecated. Please read the"
264 . " DBIx::Class::Schema::Loader::Base documentation"
265 if $self->{dump_overwrite};
267 $self->{dynamic} = ! $self->{dump_directory};
268 $self->{dump_directory} ||= File::Temp::tempdir( 'dbicXXXX',
273 $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new(
274 $self->schema, $self->inflect_plural, $self->inflect_singular
275 ) if !$self->{skip_relationships};
280 sub _find_file_in_inc {
281 my ($self, $file) = @_;
283 foreach my $prefix (@INC) {
284 my $fullpath = File::Spec->catfile($prefix, $file);
285 return $fullpath if -f $fullpath
286 and Cwd::abs_path($fullpath) ne
287 Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '';
294 my ($self, $class) = @_;
296 my $class_path = $class;
297 $class_path =~ s{::}{/}g;
298 $class_path .= '.pm';
300 my $real_inc_path = $self->_find_file_in_inc($class_path);
302 return if !$real_inc_path;
304 # If we make it to here, we loaded an external definition
305 warn qq/# Loaded external class definition for '$class'\n/
308 croak 'Failed to locate actual external module file for '
311 open(my $fh, '<', $real_inc_path)
312 or croak "Failed to open '$real_inc_path' for reading: $!";
313 $self->_ext_stmt($class,
314 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
315 .qq|# They are now part of the custom portion of this file\n|
316 .qq|# for you to hand-edit. If you do not either delete\n|
317 .qq|# this section or remove that file from \@INC, this section\n|
318 .qq|# will be repeated redundantly when you re-create this\n|
319 .qq|# file again via Loader!\n|
323 $self->_ext_stmt($class, $_);
325 $self->_ext_stmt($class,
326 qq|# End of lines loaded from '$real_inc_path' |
329 or croak "Failed to close $real_inc_path: $!";
334 Does the actual schema-construction work.
341 $self->_load_tables($self->_tables_list);
348 Rescan the database for newly added tables. Does
349 not process drops or changes. Returns a list of
350 the newly added table monikers.
352 The schema argument should be the schema class
353 or object to be affected. It should probably
354 be derived from the original schema_class used
360 my ($self, $schema) = @_;
362 $self->{schema} = $schema;
363 $self->{relbuilder}{schema} = $schema;
366 my @current = $self->_tables_list;
367 foreach my $table ($self->_tables_list) {
368 if(!exists $self->{_tables}->{$table}) {
369 push(@created, $table);
373 my $loaded = $self->_load_tables(@created);
375 return map { $self->monikers->{$_} } @$loaded;
379 my ($self, @tables) = @_;
381 # First, use _tables_list with constraint and exclude
382 # to get a list of tables to operate on
384 my $constraint = $self->constraint;
385 my $exclude = $self->exclude;
387 @tables = grep { /$constraint/ } @tables if $constraint;
388 @tables = grep { ! /$exclude/ } @tables if $exclude;
390 # Save the new tables to the tables list
392 $self->{_tables}->{$_} = 1;
395 $self->_make_src_class($_) for @tables;
396 $self->_setup_src_meta($_) for @tables;
398 if(!$self->skip_relationships) {
399 # The relationship loader needs a working schema
401 $self->_reload_classes(@tables);
402 $self->_load_relationships($_) for @tables;
406 $self->_load_external($_)
407 for map { $self->classes->{$_} } @tables;
409 $self->_reload_classes(@tables);
411 # Drop temporary cache
412 delete $self->{_cache};
417 sub _reload_classes {
418 my ($self, @tables) = @_;
420 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
422 unshift @INC, $self->dump_directory;
425 my %have_source = map { $_ => $self->schema->source($_) }
426 $self->schema->sources;
428 for my $table (@tables) {
429 my $moniker = $self->monikers->{$table};
430 my $class = $self->classes->{$table};
433 no warnings 'redefine';
434 local *Class::C3::reinitialize = sub {};
437 Class::Unload->unload($class);
438 my ($source, $resultset_class);
440 ($source = $have_source{$moniker})
441 && ($resultset_class = $source->resultset_class)
442 && ($resultset_class ne 'DBIx::Class::ResultSet')
444 my $has_file = Class::Inspector->loaded_filename($resultset_class);
445 Class::Unload->unload($resultset_class);
446 $self->ensure_class_loaded($resultset_class) if $has_file;
448 $self->ensure_class_loaded($class);
450 push @to_register, [$moniker, $class];
453 Class::C3->reinitialize;
455 $self->schema->register_class(@$_);
459 sub _get_dump_filename {
460 my ($self, $class) = (@_);
463 return $self->dump_directory . q{/} . $class . q{.pm};
466 sub _ensure_dump_subdirs {
467 my ($self, $class) = (@_);
469 my @name_parts = split(/::/, $class);
470 pop @name_parts; # we don't care about the very last element,
471 # which is a filename
473 my $dir = $self->dump_directory;
476 mkdir($dir) or croak "mkdir('$dir') failed: $!";
478 last if !@name_parts;
479 $dir = File::Spec->catdir($dir, shift @name_parts);
484 my ($self, @classes) = @_;
486 my $schema_class = $self->schema_class;
487 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
489 my $target_dir = $self->dump_directory;
490 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
491 unless $self->{dynamic} or $self->{quiet};
494 qq|package $schema_class;\n\n|
495 . qq|use strict;\nuse warnings;\n\n|
496 . qq|use base '$schema_base_class';\n\n|;
498 if ($self->use_namespaces) {
499 $schema_text .= qq|__PACKAGE__->load_namespaces|;
500 my $namespace_options;
501 for my $attr (qw(result_namespace
503 default_resultset_class)) {
505 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
508 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
509 $schema_text .= qq|;\n|;
512 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
515 $self->_write_classfile($schema_class, $schema_text);
517 my $result_base_class = $self->result_base_class || 'DBIx::Class';
519 foreach my $src_class (@classes) {
521 qq|package $src_class;\n\n|
522 . qq|use strict;\nuse warnings;\n\n|
523 . qq|use base '$result_base_class';\n\n|;
525 $self->_write_classfile($src_class, $src_text);
528 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
532 sub _write_classfile {
533 my ($self, $class, $text) = @_;
535 my $filename = $self->_get_dump_filename($class);
536 $self->_ensure_dump_subdirs($class);
538 if (-f $filename && $self->really_erase_my_files) {
539 warn "Deleting existing file '$filename' due to "
540 . "'really_erase_my_files' setting\n" unless $self->{quiet};
544 my $custom_content = $self->_get_custom_content($class, $filename);
545 $custom_content ||= qq|\n\n# You can replace this text with custom|
546 . qq| content, and it will be preserved on regeneration|
550 for @{$self->{_dump_storage}->{$class} || []};
552 $text .= qq|\n\n# Created by DBIx::Class::Schema::Loader|
553 . qq| v| . $DBIx::Class::Schema::Loader::VERSION
554 . q| @ | . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
555 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
557 open(my $fh, '>', $filename)
558 or croak "Cannot open '$filename' for writing: $!";
560 # Write the top half and its MD5 sum
561 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
563 # Write out anything loaded via external partial class file in @INC
565 for @{$self->{_ext_storage}->{$class} || []};
567 # Write out any custom content the user has added
568 print $fh $custom_content;
571 or croak "Error closing '$filename': $!";
574 sub _get_custom_content {
575 my ($self, $class, $filename) = @_;
577 return if ! -f $filename;
578 open(my $fh, '<', $filename)
579 or croak "Cannot open '$filename' for reading: $!";
582 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
587 if(!$found && /$mark_re/) {
590 croak "Checksum mismatch in '$filename'"
591 if Digest::MD5::md5_base64($buffer) ne $2;
600 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
601 . " it does not appear to have been generated by Loader"
612 warn "$target: use $_;" if $self->debug;
613 $self->_raw_stmt($target, "use $_;");
620 my $schema_class = $self->schema_class;
622 my $blist = join(q{ }, @_);
623 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
624 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
627 # Create class with applicable bases, setup monikers, etc
628 sub _make_src_class {
629 my ($self, $table) = @_;
631 my $schema = $self->schema;
632 my $schema_class = $self->schema_class;
634 my $table_moniker = $self->_table2moniker($table);
635 my @result_namespace = ($schema_class);
636 if ($self->use_namespaces) {
637 my $result_namespace = $self->result_namespace || 'Result';
638 if ($result_namespace =~ /^\+(.*)/) {
639 # Fully qualified namespace
640 @result_namespace = ($1)
644 push @result_namespace, $result_namespace;
647 my $table_class = join(q{::}, @result_namespace, $table_moniker);
649 my $table_normalized = lc $table;
650 $self->classes->{$table} = $table_class;
651 $self->classes->{$table_normalized} = $table_class;
652 $self->monikers->{$table} = $table_moniker;
653 $self->monikers->{$table_normalized} = $table_moniker;
655 $self->_use ($table_class, @{$self->additional_classes});
656 $self->_inject($table_class, @{$self->left_base_classes});
658 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core');
660 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
661 if @{$self->resultset_components};
662 $self->_inject($table_class, @{$self->additional_base_classes});
665 # Set up metadata (cols, pks, etc)
666 sub _setup_src_meta {
667 my ($self, $table) = @_;
669 my $schema = $self->schema;
670 my $schema_class = $self->schema_class;
672 my $table_class = $self->classes->{$table};
673 my $table_moniker = $self->monikers->{$table};
675 my $table_name = $table;
676 my $name_sep = $self->schema->storage->sql_maker->name_sep;
678 if ($table_name =~ /\Q$name_sep\E/) {
679 $table_name = \ $self->_quote_table_name($table_name);
682 $self->_dbic_stmt($table_class,'table',$table_name);
684 my $cols = $self->_table_columns($table);
686 eval { $col_info = $self->_columns_info_for($table) };
688 $self->_dbic_stmt($table_class,'add_columns',@$cols);
691 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
692 my $fks = $self->_table_fk_info($table);
693 for my $fkdef (@$fks) {
694 for my $col (@{ $fkdef->{local_columns} }) {
695 $col_info_lc{$col}->{is_foreign_key} = 1;
701 map { $_, ($col_info_lc{$_}||{}) } @$cols
705 my %uniq_tag; # used to eliminate duplicate uniqs
707 my $pks = $self->_table_pk_info($table) || [];
708 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
709 : carp("$table has no primary key");
710 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
712 my $uniqs = $self->_table_uniq_info($table) || [];
714 my ($name, $cols) = @$_;
715 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
716 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
723 Returns a sorted list of loaded tables, using the original database table
731 return keys %{$self->_tables};
734 # Make a moniker from a table
735 sub _default_table2moniker {
736 my ($self, $table) = @_;
738 return join '', map ucfirst, split /[\W_]+/,
739 Lingua::EN::Inflect::Number::to_S(lc $table);
743 my ( $self, $table ) = @_;
747 if( ref $self->moniker_map eq 'HASH' ) {
748 $moniker = $self->moniker_map->{$table};
750 elsif( ref $self->moniker_map eq 'CODE' ) {
751 $moniker = $self->moniker_map->($table);
754 $moniker ||= $self->_default_table2moniker($table);
759 sub _load_relationships {
760 my ($self, $table) = @_;
762 my $tbl_fk_info = $self->_table_fk_info($table);
763 foreach my $fkdef (@$tbl_fk_info) {
764 $fkdef->{remote_source} =
765 $self->monikers->{delete $fkdef->{remote_table}};
767 my $tbl_uniq_info = $self->_table_uniq_info($table);
769 my $local_moniker = $self->monikers->{$table};
770 my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
772 foreach my $src_class (sort keys %$rel_stmts) {
773 my $src_stmts = $rel_stmts->{$src_class};
774 foreach my $stmt (@$src_stmts) {
775 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
780 # Overload these in driver class:
782 # Returns an arrayref of column names
783 sub _table_columns { croak "ABSTRACT METHOD" }
785 # Returns arrayref of pk col names
786 sub _table_pk_info { croak "ABSTRACT METHOD" }
788 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
789 sub _table_uniq_info { croak "ABSTRACT METHOD" }
791 # Returns an arrayref of foreign key constraints, each
792 # being a hashref with 3 keys:
793 # local_columns (arrayref), remote_columns (arrayref), remote_table
794 sub _table_fk_info { croak "ABSTRACT METHOD" }
796 # Returns an array of lower case table names
797 sub _tables_list { croak "ABSTRACT METHOD" }
799 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
806 $args = '(' . $args . ')' if @_ < 2;
807 my $stmt = $method . $args . q{;};
809 warn qq|$class\->$stmt\n| if $self->debug;
810 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
813 # Store a raw source line for a class (for dumping purposes)
815 my ($self, $class, $stmt) = @_;
816 push(@{$self->{_dump_storage}->{$class}}, $stmt);
819 # Like above, but separately for the externally loaded stuff
821 my ($self, $class, $stmt) = @_;
822 push(@{$self->{_ext_storage}->{$class}}, $stmt);
827 Returns a hashref of loaded table to moniker mappings. There will
828 be two entries for each table, the original name and the "normalized"
829 name, in the case that the two are different (such as databases
830 that like uppercase table names, or preserve your original mixed-case
831 definitions, or what-have-you).
835 Returns a hashref of table to class mappings. In some cases it will
836 contain multiple entries per table for the original and normalized table
837 names, as above in L</monikers>.
841 L<DBIx::Class::Schema::Loader>