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_11';
21 __PACKAGE__->mk_ro_accessors(qw/
28 additional_base_classes
43 default_resultset_class
54 __PACKAGE__->mk_accessors(qw/
56 schema_version_to_dump
61 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
65 See L<DBIx::Class::Schema::Loader>
69 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
70 classes, and implements the common functionality between them.
72 =head1 CONSTRUCTOR OPTIONS
74 These constructor options are the base options for
75 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
77 =head2 skip_relationships
79 Skip setting up relationships. The default is to attempt the loading
84 Static schemas (ones dumped to disk) will, by default, use the new-style 0.05XXX
85 relationship names and singularized Results, unless you're overwriting an
86 existing dump made by a 0.04XXX version of L<DBIx::Class::Schema::Loader>, in
87 which case the backward compatible RelBuilder will be activated, and
88 singularization will be turned off.
94 will disable the backward-compatible RelBuilder and use
95 the new-style relationship names along with singularized Results, even when
96 overwriting a dump made with an earlier version.
98 The option also takes a hashref:
100 naming => { relationships => 'v5', results => 'v4' }
108 Latest default style, whatever that happens to be.
112 Version 0.05XXX style.
116 Version 0.04XXX style.
120 Dynamic schemas will always default to the 0.04XXX relationship names and won't
121 singularize Results for backward compatibility, to activate the new RelBuilder
122 and singularization put this in your C<Schema.pm> file:
124 __PACKAGE__->naming('current');
126 Or if you prefer to use 0.05XXX features but insure that nothing breaks in the
127 next major version upgrade:
129 __PACKAGE__->naming('v5');
133 If set to true, each constructive L<DBIx::Class> statement the loader
134 decides to execute will be C<warn>-ed before execution.
138 Set the name of the schema to load (schema in the sense that your database
139 vendor means it). Does not currently support loading more than one schema
144 Only load tables matching regex. Best specified as a qr// regex.
148 Exclude tables matching regex. Best specified as a qr// regex.
152 Overrides the default table name to moniker translation. Can be either
153 a hashref of table keys and moniker values, or a coderef for a translator
154 function taking a single scalar table name argument and returning
155 a scalar moniker. If the hash entry does not exist, or the function
156 returns a false value, the code falls back to default behavior
159 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
160 which is to say: lowercase everything, split up the table name into chunks
161 anywhere a non-alpha-numeric character occurs, change the case of first letter
162 of each chunk to upper case, and put the chunks back together. Examples:
164 Table Name | Moniker Name
165 ---------------------------
167 luser_group | LuserGroup
168 luser-opts | LuserOpts
170 =head2 inflect_plural
172 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
173 if hash key does not exist or coderef returns false), but acts as a map
174 for pluralizing relationship names. The default behavior is to utilize
175 L<Lingua::EN::Inflect::Number/to_PL>.
177 =head2 inflect_singular
179 As L</inflect_plural> above, but for singularizing relationship names.
180 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
182 =head2 schema_base_class
184 Base class for your schema classes. Defaults to 'DBIx::Class::Schema'.
186 =head2 result_base_class
188 Base class for your table classes (aka result classes). Defaults to 'DBIx::Class'.
190 =head2 additional_base_classes
192 List of additional base classes all of your table classes will use.
194 =head2 left_base_classes
196 List of additional base classes all of your table classes will use
197 that need to be leftmost.
199 =head2 additional_classes
201 List of additional classes which all of your table classes will use.
205 List of additional components to be loaded into all of your table
206 classes. A good example would be C<ResultSetManager>.
208 =head2 resultset_components
210 List of additional ResultSet components to be loaded into your table
211 classes. A good example would be C<AlwaysRS>. Component
212 C<ResultSetManager> will be automatically added to the above
213 C<components> list if this option is set.
215 =head2 use_namespaces
217 Generate result class names suitable for
218 L<DBIx::Class::Schema/load_namespaces> and call that instead of
219 L<DBIx::Class::Schema/load_classes>. When using this option you can also
220 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
221 C<resultset_namespace>, C<default_resultset_class>), and they will be added
222 to the call (and the generated result class names adjusted appropriately).
224 =head2 dump_directory
226 This option is designed to be a tool to help you transition from this
227 loader to a manually-defined schema when you decide it's time to do so.
229 The value of this option is a perl libdir pathname. Within
230 that directory this module will create a baseline manual
231 L<DBIx::Class::Schema> module set, based on what it creates at runtime
234 The created schema class will have the same classname as the one on
235 which you are setting this option (and the ResultSource classes will be
236 based on this name as well).
238 Normally you wouldn't hard-code this setting in your schema class, as it
239 is meant for one-time manual usage.
241 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
242 recommended way to access this functionality.
244 =head2 dump_overwrite
246 Deprecated. See L</really_erase_my_files> below, which does *not* mean
247 the same thing as the old C<dump_overwrite> setting from previous releases.
249 =head2 really_erase_my_files
251 Default false. If true, Loader will unconditionally delete any existing
252 files before creating the new ones from scratch when dumping a schema to disk.
254 The default behavior is instead to only replace the top portion of the
255 file, up to and including the final stanza which contains
256 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
257 leaving any customizations you placed after that as they were.
259 When C<really_erase_my_files> is not set, if the output file already exists,
260 but the aforementioned final stanza is not found, or the checksum
261 contained there does not match the generated contents, Loader will
262 croak and not touch the file.
264 You should really be using version control on your schema classes (and all
265 of the rest of your code for that matter). Don't blame me if a bug in this
266 code wipes something out when it shouldn't have, you've been warned.
270 None of these methods are intended for direct invocation by regular
271 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
272 can also be found via standard L<DBIx::Class::Schema> methods somehow.
276 # ensure that a peice of object data is a valid arrayref, creating
277 # an empty one or encapsulating whatever's there.
278 sub _ensure_arrayref {
283 $self->{$_} = [ $self->{$_} ]
284 unless ref $self->{$_} eq 'ARRAY';
290 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
291 by L<DBIx::Class::Schema::Loader>.
296 my ( $class, %args ) = @_;
298 my $self = { %args };
300 bless $self => $class;
302 $self->_ensure_arrayref(qw/additional_classes
303 additional_base_classes
309 push(@{$self->{components}}, 'ResultSetManager')
310 if @{$self->{resultset_components}};
312 $self->{monikers} = {};
313 $self->{classes} = {};
315 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
316 $self->{schema} ||= $self->{schema_class};
318 croak "dump_overwrite is deprecated. Please read the"
319 . " DBIx::Class::Schema::Loader::Base documentation"
320 if $self->{dump_overwrite};
322 $self->{dynamic} = ! $self->{dump_directory};
323 $self->{temp_directory} ||= File::Temp::tempdir( 'dbicXXXX',
328 $self->{dump_directory} ||= $self->{temp_directory};
330 $self->version_to_dump($DBIx::Class::Schema::Loader::VERSION);
331 $self->schema_version_to_dump($DBIx::Class::Schema::Loader::VERSION);
333 $self->_check_back_compat;
338 sub _check_back_compat {
341 # dynamic schemas will always be in 0.04006 mode
342 if ($self->dynamic) {
344 my $class = ref $self || $self;
345 require DBIx::Class::Schema::Loader::Compat::v0_040;
347 @{"${class}::ISA"} = map {
348 $_ eq 'DBIx::Class::Schema::Loader::Base' ?
349 'DBIx::Class::Schema::Loader::Compat::v0_040' :
351 } @{"${class}::ISA"};
353 Class::C3::reinitialize;
354 # just in case, though no one is likely to dump a dynamic schema
355 $self->schema_version_to_dump('0.04006');
359 # otherwise check if we need backcompat mode for a static schema
360 my $filename = $self->_get_dump_filename($self->schema_class);
361 return unless -e $filename;
363 open(my $fh, '<', $filename)
364 or croak "Cannot open '$filename' for reading: $!";
367 if (/^# Created by DBIx::Class::Schema::Loader v((\d+)\.(\d+))/) {
369 my $ver = "v${2}_${3}";
371 my $compat_class = "DBIx::Class::Schema::Loader::Compat::${ver}";
372 if ($self->load_optional_class($compat_class)) {
374 my $class = ref $self || $self;
376 @{"${class}::ISA"} = map {
377 $_ eq 'DBIx::Class::Schema::Loader::Base' ?
379 } @{"${class}::ISA"};
381 Class::C3::reinitialize;
382 $self->schema_version_to_dump($real_ver);
385 $ver =~ s/\d\z// or last;
393 sub _find_file_in_inc {
394 my ($self, $file) = @_;
396 foreach my $prefix (@INC) {
397 my $fullpath = File::Spec->catfile($prefix, $file);
398 return $fullpath if -f $fullpath
399 and Cwd::abs_path($fullpath) ne
400 Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '';
407 my ($self, $class) = @_;
409 my $class_path = $class;
410 $class_path =~ s{::}{/}g;
411 $class_path .= '.pm';
416 sub _find_class_in_inc {
417 my ($self, $class) = @_;
419 return $self->_find_file_in_inc($self->_class_path($class));
423 my ($self, $class) = @_;
425 my $real_inc_path = $self->_find_class_in_inc($class);
427 return if !$real_inc_path;
429 # If we make it to here, we loaded an external definition
430 warn qq/# Loaded external class definition for '$class'\n/
433 open(my $fh, '<', $real_inc_path)
434 or croak "Failed to open '$real_inc_path' for reading: $!";
435 $self->_ext_stmt($class,
436 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
437 .qq|# They are now part of the custom portion of this file\n|
438 .qq|# for you to hand-edit. If you do not either delete\n|
439 .qq|# this section or remove that file from \@INC, this section\n|
440 .qq|# will be repeated redundantly when you re-create this\n|
441 .qq|# file again via Loader!\n|
445 $self->_ext_stmt($class, $_);
447 $self->_ext_stmt($class,
448 qq|# End of lines loaded from '$real_inc_path' |
451 or croak "Failed to close $real_inc_path: $!";
453 if ($self->dynamic) { # load the class too
454 # turn off redefined warnings
455 local $SIG{__WARN__} = sub {};
463 Does the actual schema-construction work.
470 $self->_load_tables($self->_tables_list);
477 Rescan the database for newly added tables. Does
478 not process drops or changes. Returns a list of
479 the newly added table monikers.
481 The schema argument should be the schema class
482 or object to be affected. It should probably
483 be derived from the original schema_class used
489 my ($self, $schema) = @_;
491 $self->{schema} = $schema;
492 $self->_relbuilder->{schema} = $schema;
495 my @current = $self->_tables_list;
496 foreach my $table ($self->_tables_list) {
497 if(!exists $self->{_tables}->{$table}) {
498 push(@created, $table);
502 my $loaded = $self->_load_tables(@created);
504 return map { $self->monikers->{$_} } @$loaded;
510 return if $self->{skip_relationships};
512 $self->{relbuilder} ||= DBIx::Class::Schema::Loader::RelBuilder->new(
513 $self->schema, $self->inflect_plural, $self->inflect_singular
518 my ($self, @tables) = @_;
520 # First, use _tables_list with constraint and exclude
521 # to get a list of tables to operate on
523 my $constraint = $self->constraint;
524 my $exclude = $self->exclude;
526 @tables = grep { /$constraint/ } @tables if $constraint;
527 @tables = grep { ! /$exclude/ } @tables if $exclude;
529 # Save the new tables to the tables list
531 $self->{_tables}->{$_} = 1;
534 $self->_make_src_class($_) for @tables;
535 $self->_setup_src_meta($_) for @tables;
537 if(!$self->skip_relationships) {
538 # The relationship loader needs a working schema
540 local $self->{dump_directory} = $self->{temp_directory};
541 $self->_reload_classes(\@tables);
542 $self->_load_relationships($_) for @tables;
545 # Remove that temp dir from INC so it doesn't get reloaded
546 @INC = grep { $_ ne $self->{dump_directory} } @INC;
549 $self->_load_external($_)
550 for map { $self->classes->{$_} } @tables;
552 # Reload without unloading first to preserve any symbols from external
554 $self->_reload_classes(\@tables, 0);
556 # Drop temporary cache
557 delete $self->{_cache};
562 sub _reload_classes {
563 my ($self, $tables, $unload) = @_;
565 my @tables = @$tables;
566 $unload = 1 unless defined $unload;
568 # so that we don't repeat custom sections
569 @INC = grep $_ ne $self->dump_directory, @INC;
571 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
573 unshift @INC, $self->dump_directory;
576 my %have_source = map { $_ => $self->schema->source($_) }
577 $self->schema->sources;
579 for my $table (@tables) {
580 my $moniker = $self->monikers->{$table};
581 my $class = $self->classes->{$table};
584 no warnings 'redefine';
585 local *Class::C3::reinitialize = sub {};
588 Class::Unload->unload($class) if $unload;
589 my ($source, $resultset_class);
591 ($source = $have_source{$moniker})
592 && ($resultset_class = $source->resultset_class)
593 && ($resultset_class ne 'DBIx::Class::ResultSet')
595 my $has_file = Class::Inspector->loaded_filename($resultset_class);
596 Class::Unload->unload($resultset_class) if $unload;
597 $self->_reload_class($resultset_class) if $has_file;
599 $self->_reload_class($class);
601 push @to_register, [$moniker, $class];
604 Class::C3->reinitialize;
606 $self->schema->register_class(@$_);
610 # We use this instead of ensure_class_loaded when there are package symbols we
613 my ($self, $class) = @_;
615 my $class_path = $self->_class_path($class);
616 delete $INC{ $class_path };
617 eval "require $class;";
620 sub _get_dump_filename {
621 my ($self, $class) = (@_);
624 return $self->dump_directory . q{/} . $class . q{.pm};
627 sub _ensure_dump_subdirs {
628 my ($self, $class) = (@_);
630 my @name_parts = split(/::/, $class);
631 pop @name_parts; # we don't care about the very last element,
632 # which is a filename
634 my $dir = $self->dump_directory;
637 mkdir($dir) or croak "mkdir('$dir') failed: $!";
639 last if !@name_parts;
640 $dir = File::Spec->catdir($dir, shift @name_parts);
645 my ($self, @classes) = @_;
647 my $schema_class = $self->schema_class;
648 my $schema_base_class = $self->schema_base_class || 'DBIx::Class::Schema';
650 my $target_dir = $self->dump_directory;
651 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
652 unless $self->{dynamic} or $self->{quiet};
655 qq|package $schema_class;\n\n|
656 . qq|# Created by DBIx::Class::Schema::Loader\n|
657 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
658 . qq|use strict;\nuse warnings;\n\n|
659 . qq|use base '$schema_base_class';\n\n|;
661 if ($self->use_namespaces) {
662 $schema_text .= qq|__PACKAGE__->load_namespaces|;
663 my $namespace_options;
664 for my $attr (qw(result_namespace
666 default_resultset_class)) {
668 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
671 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
672 $schema_text .= qq|;\n|;
675 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
679 local $self->{version_to_dump} = $self->schema_version_to_dump;
680 $self->_write_classfile($schema_class, $schema_text);
683 my $result_base_class = $self->result_base_class || 'DBIx::Class';
685 foreach my $src_class (@classes) {
687 qq|package $src_class;\n\n|
688 . qq|# Created by DBIx::Class::Schema::Loader\n|
689 . qq|# DO NOT MODIFY THE FIRST PART OF THIS FILE\n\n|
690 . qq|use strict;\nuse warnings;\n\n|
691 . qq|use base '$result_base_class';\n\n|;
693 $self->_write_classfile($src_class, $src_text);
696 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
701 my ($self, $version, $ts) = @_;
702 return qq|\n\n# Created by DBIx::Class::Schema::Loader|
705 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
708 sub _write_classfile {
709 my ($self, $class, $text) = @_;
711 my $filename = $self->_get_dump_filename($class);
712 $self->_ensure_dump_subdirs($class);
714 if (-f $filename && $self->really_erase_my_files) {
715 warn "Deleting existing file '$filename' due to "
716 . "'really_erase_my_files' setting\n" unless $self->{quiet};
720 my ($custom_content, $old_md5, $old_ver, $old_ts) = $self->_get_custom_content($class, $filename);
723 for @{$self->{_dump_storage}->{$class} || []};
725 # Check and see if the dump is infact differnt
729 $compare_to = $text . $self->_sig_comment($old_ver, $old_ts);
732 if (Digest::MD5::md5_base64($compare_to) eq $old_md5) {
737 $text .= $self->_sig_comment(
738 $self->version_to_dump,
739 POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
742 open(my $fh, '>', $filename)
743 or croak "Cannot open '$filename' for writing: $!";
745 # Write the top half and its MD5 sum
746 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
748 # Write out anything loaded via external partial class file in @INC
750 for @{$self->{_ext_storage}->{$class} || []};
752 # Write out any custom content the user has added
753 print $fh $custom_content;
756 or croak "Error closing '$filename': $!";
759 sub _default_custom_content {
760 return qq|\n\n# You can replace this text with custom|
761 . qq| content, and it will be preserved on regeneration|
765 sub _get_custom_content {
766 my ($self, $class, $filename) = @_;
768 return ($self->_default_custom_content) if ! -f $filename;
770 open(my $fh, '<', $filename)
771 or croak "Cannot open '$filename' for reading: $!";
774 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
777 my ($md5, $ts, $ver);
779 if(!$md5 && /$mark_re/) {
783 # Pull out the previous version and timestamp
784 ($ver, $ts) = $buffer =~ m/# Created by DBIx::Class::Schema::Loader v(.*?) @ (.*?)$/s;
787 croak "Checksum mismatch in '$filename'"
788 if Digest::MD5::md5_base64($buffer) ne $md5;
797 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
798 . " it does not appear to have been generated by Loader"
801 # Default custom content:
802 $buffer ||= $self->_default_custom_content;
804 return ($buffer, $md5, $ver, $ts);
812 warn "$target: use $_;" if $self->debug;
813 $self->_raw_stmt($target, "use $_;");
820 my $schema_class = $self->schema_class;
822 my $blist = join(q{ }, @_);
823 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
824 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
827 # Create class with applicable bases, setup monikers, etc
828 sub _make_src_class {
829 my ($self, $table) = @_;
831 my $schema = $self->schema;
832 my $schema_class = $self->schema_class;
834 my $table_moniker = $self->_table2moniker($table);
835 my @result_namespace = ($schema_class);
836 if ($self->use_namespaces) {
837 my $result_namespace = $self->result_namespace || 'Result';
838 if ($result_namespace =~ /^\+(.*)/) {
839 # Fully qualified namespace
840 @result_namespace = ($1)
844 push @result_namespace, $result_namespace;
847 my $table_class = join(q{::}, @result_namespace, $table_moniker);
849 my $table_normalized = lc $table;
850 $self->classes->{$table} = $table_class;
851 $self->classes->{$table_normalized} = $table_class;
852 $self->monikers->{$table} = $table_moniker;
853 $self->monikers->{$table_normalized} = $table_moniker;
855 $self->_use ($table_class, @{$self->additional_classes});
856 $self->_inject($table_class, @{$self->left_base_classes});
858 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core');
860 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
861 if @{$self->resultset_components};
862 $self->_inject($table_class, @{$self->additional_base_classes});
865 # Set up metadata (cols, pks, etc)
866 sub _setup_src_meta {
867 my ($self, $table) = @_;
869 my $schema = $self->schema;
870 my $schema_class = $self->schema_class;
872 my $table_class = $self->classes->{$table};
873 my $table_moniker = $self->monikers->{$table};
875 my $table_name = $table;
876 my $name_sep = $self->schema->storage->sql_maker->name_sep;
878 if ($name_sep && $table_name =~ /\Q$name_sep\E/) {
879 $table_name = \ $self->_quote_table_name($table_name);
882 $self->_dbic_stmt($table_class,'table',$table_name);
884 my $cols = $self->_table_columns($table);
886 eval { $col_info = $self->_columns_info_for($table) };
888 $self->_dbic_stmt($table_class,'add_columns',@$cols);
891 if ($self->_is_case_sensitive) {
892 for my $col (keys %$col_info) {
893 $col_info->{$col}{accessor} = lc $col
897 $col_info = { map { lc($_), $col_info->{$_} } keys %$col_info };
900 my $fks = $self->_table_fk_info($table);
902 for my $fkdef (@$fks) {
903 for my $col (@{ $fkdef->{local_columns} }) {
904 $col_info->{$col}{is_foreign_key} = 1;
910 map { $_, ($col_info->{$_}||{}) } @$cols
914 my %uniq_tag; # used to eliminate duplicate uniqs
916 my $pks = $self->_table_pk_info($table) || [];
917 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
918 : carp("$table has no primary key");
919 $uniq_tag{ join("\0", @$pks) }++ if @$pks; # pk is a uniq
921 my $uniqs = $self->_table_uniq_info($table) || [];
923 my ($name, $cols) = @$_;
924 next if $uniq_tag{ join("\0", @$cols) }++; # skip duplicates
925 $self->_dbic_stmt($table_class,'add_unique_constraint', $name, $cols);
932 Returns a sorted list of loaded tables, using the original database table
940 return keys %{$self->_tables};
943 # Make a moniker from a table
944 sub _default_table2moniker {
945 my ($self, $table) = @_;
947 return join '', map ucfirst, split /[\W_]+/,
948 Lingua::EN::Inflect::Number::to_S(lc $table);
952 my ( $self, $table ) = @_;
956 if( ref $self->moniker_map eq 'HASH' ) {
957 $moniker = $self->moniker_map->{$table};
959 elsif( ref $self->moniker_map eq 'CODE' ) {
960 $moniker = $self->moniker_map->($table);
963 $moniker ||= $self->_default_table2moniker($table);
968 sub _load_relationships {
969 my ($self, $table) = @_;
971 my $tbl_fk_info = $self->_table_fk_info($table);
972 foreach my $fkdef (@$tbl_fk_info) {
973 $fkdef->{remote_source} =
974 $self->monikers->{delete $fkdef->{remote_table}};
976 my $tbl_uniq_info = $self->_table_uniq_info($table);
978 my $local_moniker = $self->monikers->{$table};
979 my $rel_stmts = $self->_relbuilder->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
981 foreach my $src_class (sort keys %$rel_stmts) {
982 my $src_stmts = $rel_stmts->{$src_class};
983 foreach my $stmt (@$src_stmts) {
984 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
989 # Overload these in driver class:
991 # Returns an arrayref of column names
992 sub _table_columns { croak "ABSTRACT METHOD" }
994 # Returns arrayref of pk col names
995 sub _table_pk_info { croak "ABSTRACT METHOD" }
997 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
998 sub _table_uniq_info { croak "ABSTRACT METHOD" }
1000 # Returns an arrayref of foreign key constraints, each
1001 # being a hashref with 3 keys:
1002 # local_columns (arrayref), remote_columns (arrayref), remote_table
1003 sub _table_fk_info { croak "ABSTRACT METHOD" }
1005 # Returns an array of lower case table names
1006 sub _tables_list { croak "ABSTRACT METHOD" }
1008 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
1013 if ( $method eq 'table' ) {
1015 $self->_pod( $class, "=head1 NAME" );
1016 my $table_descr = $class;
1017 if ( $self->can('_table_comment') ) {
1018 my $comment = $self->_table_comment($table);
1019 $table_descr .= " - " . $comment if $comment;
1021 $self->{_class2table}{ $class } = $table;
1022 $self->_pod( $class, $table_descr );
1023 $self->_pod_cut( $class );
1024 } elsif ( $method eq 'add_columns' ) {
1025 $self->_pod( $class, "=head1 ACCESSORS" );
1030 $self->_pod( $class, '=head2 ' . $_ );
1032 $comment = $self->_column_comment( $self->{_class2table}{$class}, ($i - 1) / 2 + 1 ) if $self->can('_column_comment');
1033 $self->_pod( $class, $comment ) if $comment;
1035 $self->_pod_cut( $class );
1036 } elsif ( $method =~ /^(belongs_to|has_many|might_have)$/ ) {
1037 $self->_pod( $class, "=head1 RELATIONS" ) unless $self->{_relations_started} { $class } ;
1038 my ( $accessor, $rel_class ) = @_;
1039 $self->_pod( $class, "=head2 $accessor" );
1040 $self->_pod( $class, 'Type: ' . $method );
1041 $self->_pod( $class, "Related object: L<$rel_class>" );
1042 $self->_pod_cut( $class );
1043 $self->{_relations_started} { $class } = 1;
1045 my $args = dump(@_);
1046 $args = '(' . $args . ')' if @_ < 2;
1047 my $stmt = $method . $args . q{;};
1049 warn qq|$class\->$stmt\n| if $self->debug;
1050 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
1054 # Stores a POD documentation
1056 my ($self, $class, $stmt) = @_;
1057 $self->_raw_stmt( $class, "\n" . $stmt );
1061 my ($self, $class ) = @_;
1062 $self->_raw_stmt( $class, "\n=cut\n" );
1066 # Store a raw source line for a class (for dumping purposes)
1068 my ($self, $class, $stmt) = @_;
1069 push(@{$self->{_dump_storage}->{$class}}, $stmt);
1072 # Like above, but separately for the externally loaded stuff
1074 my ($self, $class, $stmt) = @_;
1075 push(@{$self->{_ext_storage}->{$class}}, $stmt);
1078 sub _quote_table_name {
1079 my ($self, $table) = @_;
1081 my $qt = $self->schema->storage->sql_maker->quote_char;
1083 return $table unless $qt;
1086 return $qt->[0] . $table . $qt->[1];
1089 return $qt . $table . $qt;
1092 sub _is_case_sensitive { 0 }
1096 Returns a hashref of loaded table to moniker mappings. There will
1097 be two entries for each table, the original name and the "normalized"
1098 name, in the case that the two are different (such as databases
1099 that like uppercase table names, or preserve your original mixed-case
1100 definitions, or what-have-you).
1104 Returns a hashref of table to class mappings. In some cases it will
1105 contain multiple entries per table for the original and normalized table
1106 names, as above in L</monikers>.
1110 L<DBIx::Class::Schema::Loader>
1114 See L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
1118 This library is free software; you can redistribute it and/or modify it under
1119 the same terms as Perl itself.