1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast/;
8 use UNIVERSAL::require;
9 use DBIx::Class::Schema::Loader::RelBuilder;
10 use Data::Dump qw/ dump /;
14 __PACKAGE__->mk_ro_accessors(qw/
21 additional_base_classes
32 legacy_default_inflections
42 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
46 See L<DBIx::Class::Schema::Loader>
50 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
51 classes, and implements the common functionality between them.
53 =head1 CONSTRUCTOR OPTIONS
55 These constructor options are the base options for
56 L<DBIx::Class::Schema::Loader/loader_opts>. Available constructor options are:
60 Try to automatically detect/setup has_a and has_many relationships.
64 If set to true, each constructive L<DBIx::Class> statement the loader
65 decides to execute will be C<warn>-ed before execution.
69 Only load tables matching regex. Best specified as a qr// regex.
73 Exclude tables matching regex. Best specified as a qr// regex.
77 Overrides the default table name to moniker translation. Can be either
78 a hashref of table keys and moniker values, or a coderef for a translator
79 function taking a single scalar table name argument and returning
80 a scalar moniker. If the hash entry does not exist, or the function
81 returns a false value, the code falls back to default behavior
84 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
85 which is to say: lowercase everything, split up the table name into chunks
86 anywhere a non-alpha-numeric character occurs, change the case of first letter
87 of each chunk to upper case, and put the chunks back together. Examples:
89 Table Name | Moniker Name
90 ---------------------------
92 luser_group | LuserGroup
93 luser-opts | LuserOpts
97 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
98 if hash key does not exist or coderef returns false), but acts as a map
99 for pluralizing relationship names. The default behavior is to utilize
100 L<Lingua::EN::Inflect::Number/to_PL>.
102 =head2 inflect_singular
104 As L</inflect_plural> above, but for singularizing relationship names.
105 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
107 =head2 additional_base_classes
109 List of additional base classes all of your table classes will use.
111 =head2 left_base_classes
113 List of additional base classes all of your table classes will use
114 that need to be leftmost.
116 =head2 additional_classes
118 List of additional classes which all of your table classes will use.
122 List of additional components to be loaded into all of your table
123 classes. A good example would be C<ResultSetManager>.
125 =head2 resultset_components
127 List of additional ResultSet components to be loaded into your table
128 classes. A good example would be C<AlwaysRS>. Component
129 C<ResultSetManager> will be automatically added to the above
130 C<components> list if this option is set.
132 =head2 legacy_default_inflections
134 Setting this option changes the default fallback for L</inflect_plural> to
135 utilize L<Lingua::EN::Inflect/PL>, and L</inflect_singular> to a no-op.
136 Those choices produce substandard results, but might be necessary to support
137 your existing code if you started developing on a version prior to 0.03 and
138 don't wish to go around updating all your relationship names to the new
141 =head2 dump_directory
143 This option is designed to be a tool to help you transition from this
144 loader to a manually-defined schema when you decide it's time to do so.
146 The value of this option is a perl libdir pathname. Within
147 that directory this module will create a baseline manual
148 L<DBIx::Class::Schema> module set, based on what it creates at runtime
151 The created schema class will have the same classname as the one on
152 which you are setting this option (and the ResultSource classes will be
153 based on this name as well). Therefore it is wise to note that if you
154 point the C<dump_directory> option of a schema class at the live libdir
155 where that class is currently located, it will overwrite itself with a
156 manual version of itself. This might be a really good or bad thing
157 depending on your situation and perspective.
159 Normally you wouldn't hard-code this setting in your schema class, as it
160 is meant for one-time manual usage.
162 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
163 recommended way to access this functionality.
165 =head1 DEPRECATED CONSTRUCTOR OPTIONS
169 Equivalent to L</inflect_plural>.
173 Equivalent to L</inflect_plural>.
175 =head2 connect_info, dsn, user, password, options
177 You connect these schemas the same way you would any L<DBIx::Class::Schema>,
178 which is by calling either C<connect> or C<connection> on a schema class
179 or object. These options are only supported via the deprecated
180 C<load_from_connection> interface, which will be removed in the future.
184 None of these methods are intended for direct invocation by regular
185 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
186 can also be found via standard L<DBIx::Class::Schema> methods somehow.
190 # ensure that a peice of object data is a valid arrayref, creating
191 # an empty one or encapsulating whatever's there.
192 sub _ensure_arrayref {
197 $self->{$_} = [ $self->{$_} ]
198 unless ref $self->{$_} eq 'ARRAY';
204 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
205 by L<DBIx::Class::Schema::Loader>.
210 my ( $class, %args ) = @_;
212 my $self = { %args };
214 bless $self => $class;
216 $self->{db_schema} ||= '';
217 $self->_ensure_arrayref(qw/additional_classes
218 additional_base_classes
224 push(@{$self->{components}}, 'ResultSetManager')
225 if @{$self->{resultset_components}};
227 $self->{monikers} = {};
228 $self->{classes} = {};
230 # Support deprecated arguments
231 for(qw/inflect_map inflect/) {
232 warn "Argument $_ is deprecated in favor of 'inflect_plural'"
235 $self->{inflect_plural} ||= $self->{inflect_map} || $self->{inflect};
237 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
238 $self->{schema} ||= $self->{schema_class};
246 foreach my $table_class (values %{$self->classes}) {
247 $table_class->require;
248 if($@ && $@ !~ /^Can't locate /) {
249 croak "Failed to load external class definition"
250 . " for '$table_class': $@";
252 next if $@; # "Can't locate" error
254 # If we make it to here, we loaded an external definition
255 warn qq/# Loaded external class definition for '$table_class'\n/
258 if($self->dump_directory) {
259 my $class_path = $table_class;
260 $class_path =~ s{::}{/}g;
261 my $filename = $INC{$class_path};
262 croak 'Failed to locate actual external module file for '
265 open(my $fh, '<', $filename)
266 or croak "Failed to open $filename for reading: $!";
267 $self->_raw_stmt($table_class,
268 q|# These lines loaded from user-supplied external file: |
272 $self->_raw_stmt($table_class, $_);
274 $self->_raw_stmt($table_class,
275 q|# End of lines loaded from user-supplied external file |
278 or croak "Failed to close $filename: $!";
285 Does the actual schema-construction work.
292 $self->_load_classes;
293 $self->_load_relationships if $self->relationships;
294 $self->_load_external;
295 $self->_dump_to_dir if $self->dump_directory;
297 # Drop temporary cache
298 delete $self->{_cache};
303 sub _get_dump_filename {
304 my ($self, $class) = (@_);
307 return $self->dump_directory . q{/} . $class . q{.pm};
310 sub _ensure_dump_subdirs {
311 my ($self, $class) = (@_);
313 my @name_parts = split(/::/, $class);
315 my $dir = $self->dump_directory;
316 foreach (@name_parts) {
319 mkdir($dir) or die "mkdir('$dir') failed: $!";
327 my $target_dir = $self->dump_directory;
328 my $schema_class = $self->schema_class;
330 die "Must specify target directory for dumping!" if ! $target_dir;
332 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n";
334 if(! -d $target_dir) {
335 mkdir($target_dir) or die "mkdir('$target_dir') failed: $!";
338 my $verstr = $DBIx::Class::Schema::Loader::VERSION;
339 my $datestr = POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime);
340 my $tagline = qq|# Created by DBIx::Class::Schema::Loader v$verstr @ $datestr|;
342 $self->_ensure_dump_subdirs($schema_class);
344 my $schema_fn = $self->_get_dump_filename($schema_class);
345 open(my $schema_fh, '>', $schema_fn)
346 or die "Cannot open $schema_fn for writing: $!";
347 print $schema_fh qq|package $schema_class;\n\n$tagline\n\n|;
348 print $schema_fh qq|use strict;\nuse warnings;\n\n|;
349 print $schema_fh qq|use base 'DBIx::Class::Schema';\n\n|;
350 print $schema_fh qq|__PACKAGE__->load_classes;\n|;
351 print $schema_fh qq|\n1;\n\n|;
353 or die "Cannot close $schema_fn: $!";
355 foreach my $src_class (sort keys %{$self->{_dump_storage}}) {
356 $self->_ensure_dump_subdirs($src_class);
357 my $src_fn = $self->_get_dump_filename($src_class);
358 open(my $src_fh, '>', $src_fn)
359 or die "Cannot open $src_fn for writing: $!";
360 print $src_fh qq|package $src_class;\n\n$tagline\n\n|;
361 print $src_fh qq|use strict;\nuse warnings;\n\n|;
362 print $src_fh qq|use base 'DBIx::Class';\n\n|;
363 print $src_fh qq|$_\n|
364 for @{$self->{_dump_storage}->{$src_class}};
365 print $src_fh qq|\n1;\n\n|;
367 or die "Cannot close $src_fn: $!";
370 warn "Schema dump completed.\n";
378 $_->require or croak ($_ . "->require: $@");
379 $self->_raw_stmt($target, "use $_;");
380 warn "$target: use $_" if $self->debug;
381 eval "package $target; use $_;";
382 croak "use $_: $@" if $@;
389 my $schema_class = $self->schema_class;
391 my $blist = join(q{ }, @_);
392 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
393 warn "$target: use base qw/ $blist /" if $self->debug;
395 $_->require or croak ($_ . "->require: $@");
396 $schema_class->inject_base($target, $_);
400 # Load and setup classes
404 my $schema = $self->schema;
405 my $schema_class = $self->schema_class;
407 my $constraint = $self->constraint;
408 my $exclude = $self->exclude;
409 my @tables = sort $self->_tables_list;
411 warn "No tables found in database, nothing to load" if !@tables;
414 @tables = grep { /$constraint/ } @tables if $constraint;
415 @tables = grep { ! /$exclude/ } @tables if $exclude;
417 warn "All tables excluded by constraint/exclude, nothing to load"
421 $self->{_tables} = \@tables;
423 foreach my $table (@tables) {
424 my $table_moniker = $self->_table2moniker($table);
425 my $table_class = $schema_class . q{::} . $table_moniker;
427 my $table_normalized = lc $table;
428 $self->classes->{$table} = $table_class;
429 $self->classes->{$table_normalized} = $table_class;
430 $self->monikers->{$table} = $table_moniker;
431 $self->monikers->{$table_normalized} = $table_moniker;
433 no warnings 'redefine';
434 local *Class::C3::reinitialize = sub { };
438 @{"${table_class}::ISA"} = qw/DBIx::Class/;
440 $self->_use ($table_class, @{$self->additional_classes});
441 $self->_inject($table_class, @{$self->additional_base_classes});
443 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, qw/PK::Auto Core/);
445 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
446 if @{$self->resultset_components};
447 $self->_inject($table_class, @{$self->left_base_classes});
450 Class::C3::reinitialize;
452 foreach my $table (@tables) {
453 my $table_class = $self->classes->{$table};
454 my $table_moniker = $self->monikers->{$table};
456 $self->_dbic_stmt($table_class,'table',$table);
458 my $cols = $self->_table_columns($table);
459 $self->_dbic_stmt($table_class,'add_columns',@$cols);
461 my $pks = $self->_table_pk_info($table) || [];
462 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
463 : carp("$table has no primary key");
465 my $uniqs = $self->_table_uniq_info($table) || [];
466 $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs);
468 $schema_class->register_class($table_moniker, $table_class);
469 $schema->register_class($table_moniker, $table_class) if $schema ne $schema_class;
475 Returns a sorted list of loaded tables, using the original database table
483 return @{$self->_tables};
486 # Make a moniker from a table
488 my ( $self, $table ) = @_;
492 if( ref $self->moniker_map eq 'HASH' ) {
493 $moniker = $self->moniker_map->{$table};
495 elsif( ref $self->moniker_map eq 'CODE' ) {
496 $moniker = $self->moniker_map->($table);
499 $moniker ||= join '', map ucfirst, split /[\W_]+/, lc $table;
504 sub _load_relationships {
507 # Construct the fk_info RelBuilder wants to see, by
508 # translating table names to monikers in the _fk_info output
510 foreach my $table ($self->tables) {
511 my $tbl_fk_info = $self->_table_fk_info($table);
512 foreach my $fkdef (@$tbl_fk_info) {
513 $fkdef->{remote_source} =
514 $self->monikers->{delete $fkdef->{remote_table}};
516 my $moniker = $self->monikers->{$table};
517 $fk_info{$moniker} = $tbl_fk_info;
520 my $relbuilder = DBIx::Class::Schema::Loader::RelBuilder->new(
521 $self->schema_class, \%fk_info, $self->inflect_plural,
522 $self->inflect_singular
525 my $rel_stmts = $relbuilder->generate_code;
526 foreach my $src_class (sort keys %$rel_stmts) {
527 my $src_stmts = $rel_stmts->{$src_class};
528 foreach my $stmt (@$src_stmts) {
529 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
534 # Overload these in driver class:
536 # Returns an arrayref of column names
537 sub _table_columns { croak "ABSTRACT METHOD" }
539 # Returns arrayref of pk col names
540 sub _table_pk_info { croak "ABSTRACT METHOD" }
542 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
543 sub _table_uniq_info { croak "ABSTRACT METHOD" }
545 # Returns an arrayref of foreign key constraints, each
546 # being a hashref with 3 keys:
547 # local_columns (arrayref), remote_columns (arrayref), remote_table
548 sub _table_fk_info { croak "ABSTRACT METHOD" }
550 # Returns an array of lower case table names
551 sub _tables_list { croak "ABSTRACT METHOD" }
553 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
559 if(!$self->debug && !$self->dump_directory) {
565 $args = '(' . $args . ')' if @_ < 2;
566 my $stmt = $method . $args . q{;};
568 warn qq|$class\->$stmt\n| if $self->debug;
570 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
573 # Store a raw source line for a class (for dumping purposes)
575 my ($self, $class, $stmt) = @_;
576 push(@{$self->{_dump_storage}->{$class}}, $stmt) if $self->dump_directory;
581 Returns a hashref of loaded table to moniker mappings. There will
582 be two entries for each table, the original name and the "normalized"
583 name, in the case that the two are different (such as databases
584 that like uppercase table names, or preserve your original mixed-case
585 definitions, or what-have-you).
589 Returns a hashref of table to class mappings. In some cases it will
590 contain multiple entries per table for the original and normalized table
591 names, as above in L</monikers>.
595 L<DBIx::Class::Schema::Loader>