1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use UNIVERSAL::require;
9 use DBIx::Class::Schema::Loader::RelBuilder;
10 use Data::Dump qw/ dump /;
17 our $VERSION = '0.04004';
19 __PACKAGE__->mk_ro_accessors(qw/
26 additional_base_classes
41 default_resultset_class
51 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
55 See L<DBIx::Class::Schema::Loader>
59 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
60 classes, and implements the common functionality between them.
62 =head1 CONSTRUCTOR OPTIONS
64 These constructor options are the base options for
65 L<DBIx::Class::Schema::Loader/loader_opts>. Available constructor options are:
67 =head2 skip_relationships
69 Skip setting up relationships. The default is to attempt the loading
74 If set to true, each constructive L<DBIx::Class> statement the loader
75 decides to execute will be C<warn>-ed before execution.
79 Set the name of the schema to load (schema in the sense that your database
80 vendor means it). Does not currently support loading more than one schema
85 Only load tables matching regex. Best specified as a qr// regex.
89 Exclude tables matching regex. Best specified as a qr// regex.
93 Overrides the default table name to moniker translation. Can be either
94 a hashref of table keys and moniker values, or a coderef for a translator
95 function taking a single scalar table name argument and returning
96 a scalar moniker. If the hash entry does not exist, or the function
97 returns a false value, the code falls back to default behavior
100 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
101 which is to say: lowercase everything, split up the table name into chunks
102 anywhere a non-alpha-numeric character occurs, change the case of first letter
103 of each chunk to upper case, and put the chunks back together. Examples:
105 Table Name | Moniker Name
106 ---------------------------
108 luser_group | LuserGroup
109 luser-opts | LuserOpts
111 =head2 inflect_plural
113 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
114 if hash key does not exist or coderef returns false), but acts as a map
115 for pluralizing relationship names. The default behavior is to utilize
116 L<Lingua::EN::Inflect::Number/to_PL>.
118 =head2 inflect_singular
120 As L</inflect_plural> above, but for singularizing relationship names.
121 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
123 =head2 additional_base_classes
125 List of additional base classes all of your table classes will use.
127 =head2 left_base_classes
129 List of additional base classes all of your table classes will use
130 that need to be leftmost.
132 =head2 additional_classes
134 List of additional classes which all of your table classes will use.
138 List of additional components to be loaded into all of your table
139 classes. A good example would be C<ResultSetManager>.
141 =head2 resultset_components
143 List of additional ResultSet components to be loaded into your table
144 classes. A good example would be C<AlwaysRS>. Component
145 C<ResultSetManager> will be automatically added to the above
146 C<components> list if this option is set.
148 =head2 use_namespaces
150 Generate result class names suitable for
151 L<DBIx::Class::Schema/load_namespaces> and call that instead of
152 L<DBIx::Class::Schema/load_classes>. When using this option you can also
153 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
154 C<resultset_namespace>, C<default_resultset_class>), and they will be added
155 to the call (and the generated result class names adjusted appropriately).
157 =head2 dump_directory
159 This option is designed to be a tool to help you transition from this
160 loader to a manually-defined schema when you decide it's time to do so.
162 The value of this option is a perl libdir pathname. Within
163 that directory this module will create a baseline manual
164 L<DBIx::Class::Schema> module set, based on what it creates at runtime
167 The created schema class will have the same classname as the one on
168 which you are setting this option (and the ResultSource classes will be
169 based on this name as well).
171 Normally you wouldn't hard-code this setting in your schema class, as it
172 is meant for one-time manual usage.
174 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
175 recommended way to access this functionality.
177 =head2 dump_overwrite
179 Deprecated. See L</really_erase_my_files> below, which does *not* mean
180 the same thing as the old C<dump_overwrite> setting from previous releases.
182 =head2 really_erase_my_files
184 Default false. If true, Loader will unconditionally delete any existing
185 files before creating the new ones from scratch when dumping a schema to disk.
187 The default behavior is instead to only replace the top portion of the
188 file, up to and including the final stanza which contains
189 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
190 leaving any customizations you placed after that as they were.
192 When C<really_erase_my_files> is not set, if the output file already exists,
193 but the aforementioned final stanza is not found, or the checksum
194 contained there does not match the generated contents, Loader will
195 croak and not touch the file.
197 You should really be using version control on your schema classes (and all
198 of the rest of your code for that matter). Don't blame me if a bug in this
199 code wipes something out when it shouldn't have, you've been warned.
203 None of these methods are intended for direct invocation by regular
204 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
205 can also be found via standard L<DBIx::Class::Schema> methods somehow.
209 # ensure that a peice of object data is a valid arrayref, creating
210 # an empty one or encapsulating whatever's there.
211 sub _ensure_arrayref {
216 $self->{$_} = [ $self->{$_} ]
217 unless ref $self->{$_} eq 'ARRAY';
223 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
224 by L<DBIx::Class::Schema::Loader>.
229 my ( $class, %args ) = @_;
231 my $self = { %args };
233 bless $self => $class;
235 $self->_ensure_arrayref(qw/additional_classes
236 additional_base_classes
242 push(@{$self->{components}}, 'ResultSetManager')
243 if @{$self->{resultset_components}};
245 $self->{monikers} = {};
246 $self->{classes} = {};
248 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
249 $self->{schema} ||= $self->{schema_class};
251 croak "dump_overwrite is deprecated. Please read the"
252 . " DBIx::Class::Schema::Loader::Base documentation"
253 if $self->{dump_overwrite};
255 $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new(
256 $self->schema_class, $self->inflect_plural, $self->inflect_singular
257 ) if !$self->{skip_relationships};
262 sub _find_file_in_inc {
263 my ($self, $file) = @_;
265 foreach my $prefix (@INC) {
266 my $fullpath = $prefix . '/' . $file;
267 return $fullpath if -f $fullpath;
274 my ($self, $class) = @_;
276 my $class_path = $class;
277 $class_path =~ s{::}{/}g;
278 $class_path .= '.pm';
280 my $inc_path = $self->_find_file_in_inc($class_path);
282 return if !$inc_path;
284 my $real_dump_path = $self->dump_directory
286 File::Spec->catfile($self->dump_directory, $class_path)
289 my $real_inc_path = Cwd::abs_path($inc_path);
290 return if $real_inc_path eq $real_dump_path;
293 croak "Failed to load external class definition"
294 . " for '$class': $@"
297 # If we make it to here, we loaded an external definition
298 warn qq/# Loaded external class definition for '$class'\n/
301 # The rest is only relevant when dumping
302 return if !$self->dump_directory;
304 croak 'Failed to locate actual external module file for '
307 open(my $fh, '<', $real_inc_path)
308 or croak "Failed to open '$real_inc_path' for reading: $!";
309 $self->_ext_stmt($class,
310 qq|# These lines were loaded from '$real_inc_path' found in \@INC.|
311 .q|# They are now part of the custom portion of this file|
312 .q|# for you to hand-edit. If you do not either delete|
313 .q|# this section or remove that file from @INC, this section|
314 .q|# will be repeated redundantly when you re-create this|
315 .q|# file again via Loader!|
319 $self->_ext_stmt($class, $_);
321 $self->_ext_stmt($class,
322 qq|# End of lines loaded from '$real_inc_path' |
325 or croak "Failed to close $real_inc_path: $!";
330 Does the actual schema-construction work.
337 $self->_load_tables($self->_tables_list);
344 Rescan the database for newly added tables. Does
345 not process drops or changes. Returns a list of
346 the newly added table monikers.
348 The schema argument should be the schema class
349 or object to be affected. It should probably
350 be derived from the original schema_class used
356 my ($self, $schema) = @_;
358 $self->{schema} = $schema;
361 my @current = $self->_tables_list;
362 foreach my $table ($self->_tables_list) {
363 if(!exists $self->{_tables}->{$table}) {
364 push(@created, $table);
368 my $loaded = $self->_load_tables(@created);
370 return map { $self->monikers->{$_} } @$loaded;
374 my ($self, @tables) = @_;
376 # First, use _tables_list with constraint and exclude
377 # to get a list of tables to operate on
379 my $constraint = $self->constraint;
380 my $exclude = $self->exclude;
382 @tables = grep { /$constraint/ } @tables if $constraint;
383 @tables = grep { ! /$exclude/ } @tables if $exclude;
385 # Save the new tables to the tables list
387 $self->{_tables}->{$_} = 1;
390 # Set up classes/monikers
392 no warnings 'redefine';
393 local *Class::C3::reinitialize = sub { };
396 $self->_make_src_class($_) for @tables;
399 Class::C3::reinitialize;
401 $self->_setup_src_meta($_) for @tables;
403 if(!$self->skip_relationships) {
404 $self->_load_relationships($_) for @tables;
407 $self->_load_external($_)
408 for map { $self->classes->{$_} } @tables;
410 $self->_dump_to_dir if $self->dump_directory;
412 # Drop temporary cache
413 delete $self->{_cache};
418 sub _get_dump_filename {
419 my ($self, $class) = (@_);
422 return $self->dump_directory . q{/} . $class . q{.pm};
425 sub _ensure_dump_subdirs {
426 my ($self, $class) = (@_);
428 my @name_parts = split(/::/, $class);
429 pop @name_parts; # we don't care about the very last element,
430 # which is a filename
432 my $dir = $self->dump_directory;
435 mkdir($dir) or croak "mkdir('$dir') failed: $!";
437 last if !@name_parts;
438 $dir = File::Spec->catdir($dir, shift @name_parts);
445 my $target_dir = $self->dump_directory;
447 my $schema_class = $self->schema_class;
449 croak "Must specify target directory for dumping!" if ! $target_dir;
451 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n";
454 qq|package $schema_class;\n\n|
455 . qq|use strict;\nuse warnings;\n\n|
456 . qq|use base 'DBIx::Class::Schema';\n\n|;
459 if ($self->use_namespaces) {
460 $schema_text .= qq|__PACKAGE__->load_namespaces|;
461 my $namespace_options;
462 for my $attr (qw(result_namespace
464 default_resultset_class)) {
466 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
469 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
470 $schema_text .= qq|;\n|;
473 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
477 $self->_write_classfile($schema_class, $schema_text);
479 foreach my $src_class (sort keys %{$self->{_dump_storage}}) {
481 qq|package $src_class;\n\n|
482 . qq|use strict;\nuse warnings;\n\n|
483 . qq|use base 'DBIx::Class';\n\n|;
485 $self->_write_classfile($src_class, $src_text);
488 warn "Schema dump completed.\n";
491 sub _write_classfile {
492 my ($self, $class, $text) = @_;
494 my $filename = $self->_get_dump_filename($class);
495 $self->_ensure_dump_subdirs($class);
497 if (-f $filename && $self->really_erase_my_files) {
498 warn "Deleting existing file '$filename' due to "
499 . "'really_erase_my_files' setting\n";
503 my $custom_content = $self->_get_custom_content($class, $filename);
505 $custom_content ||= qq|\n\n# You can replace this text with custom|
506 . qq| content, and it will be preserved on regeneration|
510 for @{$self->{_dump_storage}->{$class} || []};
512 $text .= qq|\n\n# Created by DBIx::Class::Schema::Loader|
513 . qq| v| . $DBIx::Class::Schema::Loader::VERSION
514 . q| @ | . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
515 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
517 open(my $fh, '>', $filename)
518 or croak "Cannot open '$filename' for writing: $!";
520 # Write the top half and its MD5 sum
521 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
523 # Write out anything loaded via external partial class file in @INC
525 for @{$self->{_ext_storage}->{$class} || []};
527 print $fh $custom_content;
530 or croak "Cannot close '$filename': $!";
533 sub _get_custom_content {
534 my ($self, $class, $filename) = @_;
536 return if ! -f $filename;
537 open(my $fh, '<', $filename)
538 or croak "Cannot open '$filename' for reading: $!";
541 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
546 if(!$found && /$mark_re/) {
549 croak "Checksum mismatch in '$filename'"
550 if Digest::MD5::md5_base64($buffer) ne $2;
559 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
560 . " it does not appear to have been generated by Loader"
572 warn "$target: use $_;" if $self->debug;
573 $self->_raw_stmt($target, "use $_;");
574 $_->require or croak ($_ . "->require: $@");
575 $evalstr .= "package $target; use $_;";
577 eval $evalstr if $evalstr;
584 my $schema_class = $self->schema_class;
586 my $blist = join(q{ }, @_);
587 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
588 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
590 $_->require or croak ($_ . "->require: $@");
591 $schema_class->inject_base($target, $_);
595 # Create class with applicable bases, setup monikers, etc
596 sub _make_src_class {
597 my ($self, $table) = @_;
599 my $schema = $self->schema;
600 my $schema_class = $self->schema_class;
602 my $table_moniker = $self->_table2moniker($table);
603 my @result_namespace = ($schema_class);
604 if ($self->use_namespaces) {
605 my $result_namespace = $self->result_namespace || 'Result';
606 if ($result_namespace =~ /^\+(.*)/) {
607 # Fully qualified namespace
608 @result_namespace = ($1)
612 push @result_namespace, $result_namespace;
615 my $table_class = join(q{::}, @result_namespace, $table_moniker);
617 my $table_normalized = lc $table;
618 $self->classes->{$table} = $table_class;
619 $self->classes->{$table_normalized} = $table_class;
620 $self->monikers->{$table} = $table_moniker;
621 $self->monikers->{$table_normalized} = $table_moniker;
623 { no strict 'refs'; @{"${table_class}::ISA"} = qw/DBIx::Class/ }
625 $self->_use ($table_class, @{$self->additional_classes});
626 $self->_inject($table_class, @{$self->additional_base_classes});
628 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core');
630 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
631 if @{$self->resultset_components};
632 $self->_inject($table_class, @{$self->left_base_classes});
635 # Set up metadata (cols, pks, etc) and register the class with the schema
636 sub _setup_src_meta {
637 my ($self, $table) = @_;
639 my $schema = $self->schema;
640 my $schema_class = $self->schema_class;
642 my $table_class = $self->classes->{$table};
643 my $table_moniker = $self->monikers->{$table};
645 $self->_dbic_stmt($table_class,'table',$table);
647 my $cols = $self->_table_columns($table);
649 eval { $col_info = $self->_columns_info_for($table) };
651 $self->_dbic_stmt($table_class,'add_columns',@$cols);
654 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
658 map { $_, ($col_info_lc{$_}||{}) } @$cols
662 my $pks = $self->_table_pk_info($table) || [];
663 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
664 : carp("$table has no primary key");
666 my $uniqs = $self->_table_uniq_info($table) || [];
667 $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs);
669 $schema_class->register_class($table_moniker, $table_class);
670 $schema->register_class($table_moniker, $table_class) if $schema ne $schema_class;
675 Returns a sorted list of loaded tables, using the original database table
683 return keys %{$self->_tables};
686 # Make a moniker from a table
688 my ( $self, $table ) = @_;
692 if( ref $self->moniker_map eq 'HASH' ) {
693 $moniker = $self->moniker_map->{$table};
695 elsif( ref $self->moniker_map eq 'CODE' ) {
696 $moniker = $self->moniker_map->($table);
699 $moniker ||= join '', map ucfirst, split /[\W_]+/, lc $table;
704 sub _load_relationships {
705 my ($self, $table) = @_;
707 my $tbl_fk_info = $self->_table_fk_info($table);
708 foreach my $fkdef (@$tbl_fk_info) {
709 $fkdef->{remote_source} =
710 $self->monikers->{delete $fkdef->{remote_table}};
713 my $local_moniker = $self->monikers->{$table};
714 my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info);
716 foreach my $src_class (sort keys %$rel_stmts) {
717 my $src_stmts = $rel_stmts->{$src_class};
718 foreach my $stmt (@$src_stmts) {
719 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
724 # Overload these in driver class:
726 # Returns an arrayref of column names
727 sub _table_columns { croak "ABSTRACT METHOD" }
729 # Returns arrayref of pk col names
730 sub _table_pk_info { croak "ABSTRACT METHOD" }
732 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
733 sub _table_uniq_info { croak "ABSTRACT METHOD" }
735 # Returns an arrayref of foreign key constraints, each
736 # being a hashref with 3 keys:
737 # local_columns (arrayref), remote_columns (arrayref), remote_table
738 sub _table_fk_info { croak "ABSTRACT METHOD" }
740 # Returns an array of lower case table names
741 sub _tables_list { croak "ABSTRACT METHOD" }
743 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
749 if(!$self->debug && !$self->dump_directory) {
755 $args = '(' . $args . ')' if @_ < 2;
756 my $stmt = $method . $args . q{;};
758 warn qq|$class\->$stmt\n| if $self->debug;
760 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
763 # Store a raw source line for a class (for dumping purposes)
765 my ($self, $class, $stmt) = @_;
766 push(@{$self->{_dump_storage}->{$class}}, $stmt) if $self->dump_directory;
769 # Like above, but separately for the externally loaded stuff
771 my ($self, $class, $stmt) = @_;
772 push(@{$self->{_ext_storage}->{$class}}, $stmt) if $self->dump_directory;
777 Returns a hashref of loaded table to moniker mappings. There will
778 be two entries for each table, the original name and the "normalized"
779 name, in the case that the two are different (such as databases
780 that like uppercase table names, or preserve your original mixed-case
781 definitions, or what-have-you).
785 Returns a hashref of table to class mappings. In some cases it will
786 contain multiple entries per table for the original and normalized table
787 names, as above in L</monikers>.
791 L<DBIx::Class::Schema::Loader>