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 /;
14 our $VERSION = '0.03999_01';
16 __PACKAGE__->mk_ro_accessors(qw/
23 additional_base_classes
35 legacy_default_inflections
45 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
49 See L<DBIx::Class::Schema::Loader>
53 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
54 classes, and implements the common functionality between them.
56 =head1 CONSTRUCTOR OPTIONS
58 These constructor options are the base options for
59 L<DBIx::Class::Schema::Loader/loader_opts>. Available constructor options are:
63 Try to automatically detect/setup has_a and has_many relationships.
67 If set to true, each constructive L<DBIx::Class> statement the loader
68 decides to execute will be C<warn>-ed before execution.
72 Set the name of the schema to load (schema in the sense that your database
73 vendor means it). Does not currently support loading more than one schema
78 Only load tables matching regex. Best specified as a qr// regex.
82 Exclude tables matching regex. Best specified as a qr// regex.
86 Overrides the default table name to moniker translation. Can be either
87 a hashref of table keys and moniker values, or a coderef for a translator
88 function taking a single scalar table name argument and returning
89 a scalar moniker. If the hash entry does not exist, or the function
90 returns a false value, the code falls back to default behavior
93 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
94 which is to say: lowercase everything, split up the table name into chunks
95 anywhere a non-alpha-numeric character occurs, change the case of first letter
96 of each chunk to upper case, and put the chunks back together. Examples:
98 Table Name | Moniker Name
99 ---------------------------
101 luser_group | LuserGroup
102 luser-opts | LuserOpts
104 =head2 inflect_plural
106 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
107 if hash key does not exist or coderef returns false), but acts as a map
108 for pluralizing relationship names. The default behavior is to utilize
109 L<Lingua::EN::Inflect::Number/to_PL>.
111 =head2 inflect_singular
113 As L</inflect_plural> above, but for singularizing relationship names.
114 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
116 =head2 additional_base_classes
118 List of additional base classes all of your table classes will use.
120 =head2 left_base_classes
122 List of additional base classes all of your table classes will use
123 that need to be leftmost.
125 =head2 additional_classes
127 List of additional classes which all of your table classes will use.
131 List of additional components to be loaded into all of your table
132 classes. A good example would be C<ResultSetManager>.
134 =head2 resultset_components
136 List of additional ResultSet components to be loaded into your table
137 classes. A good example would be C<AlwaysRS>. Component
138 C<ResultSetManager> will be automatically added to the above
139 C<components> list if this option is set.
141 =head2 legacy_default_inflections
143 Setting this option changes the default fallback for L</inflect_plural> to
144 utilize L<Lingua::EN::Inflect/PL>, and L</inflect_singular> to a no-op.
145 Those choices produce substandard results, but might be necessary to support
146 your existing code if you started developing on a version prior to 0.03 and
147 don't wish to go around updating all your relationship names to the new
150 This option will continue to be supported until at least version 0.05xxx,
151 but may dissappear sometime thereafter. It is recommended that you update
152 your code to use the newer-style inflections when you have the time.
154 =head2 dump_directory
156 This option is designed to be a tool to help you transition from this
157 loader to a manually-defined schema when you decide it's time to do so.
159 The value of this option is a perl libdir pathname. Within
160 that directory this module will create a baseline manual
161 L<DBIx::Class::Schema> module set, based on what it creates at runtime
164 The created schema class will have the same classname as the one on
165 which you are setting this option (and the ResultSource classes will be
166 based on this name as well). Therefore it is wise to note that if you
167 point the C<dump_directory> option of a schema class at the live libdir
168 where that class is currently located, it will overwrite itself with a
169 manual version of itself. This might be a really good or bad thing
170 depending on your situation and perspective.
172 Normally you wouldn't hard-code this setting in your schema class, as it
173 is meant for one-time manual usage.
175 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
176 recommended way to access this functionality.
178 =head2 dump_overwrite
180 If set to a true value, the dumping code will overwrite existing files.
181 The default is false, which means the dumping code will skip the already
184 =head1 DEPRECATED CONSTRUCTOR OPTIONS
186 B<These will be removed in version 0.04000 !!!>
190 Equivalent to L</inflect_plural>.
194 Equivalent to L</inflect_plural>.
196 =head2 connect_info, dsn, user, password, options
198 You connect these schemas the same way you would any L<DBIx::Class::Schema>,
199 which is by calling either C<connect> or C<connection> on a schema class
200 or object. These options are only supported via the deprecated
201 C<load_from_connection> interface, which is also being removed in 0.04000.
205 None of these methods are intended for direct invocation by regular
206 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
207 can also be found via standard L<DBIx::Class::Schema> methods somehow.
211 # ensure that a peice of object data is a valid arrayref, creating
212 # an empty one or encapsulating whatever's there.
213 sub _ensure_arrayref {
218 $self->{$_} = [ $self->{$_} ]
219 unless ref $self->{$_} eq 'ARRAY';
225 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
226 by L<DBIx::Class::Schema::Loader>.
231 my ( $class, %args ) = @_;
233 my $self = { %args };
235 bless $self => $class;
237 $self->{db_schema} ||= '';
238 $self->_ensure_arrayref(qw/additional_classes
239 additional_base_classes
245 push(@{$self->{components}}, 'ResultSetManager')
246 if @{$self->{resultset_components}};
248 $self->{monikers} = {};
249 $self->{classes} = {};
251 # Support deprecated arguments
252 for(qw/inflect_map inflect/) {
253 warn "Argument $_ is deprecated in favor of 'inflect_plural'"
254 . ", and will be removed in 0.04000"
257 $self->{inflect_plural} ||= $self->{inflect_map} || $self->{inflect};
259 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
260 $self->{schema} ||= $self->{schema_class};
268 foreach my $table_class (values %{$self->classes}) {
269 $table_class->require;
270 if($@ && $@ !~ /^Can't locate /) {
271 croak "Failed to load external class definition"
272 . " for '$table_class': $@";
274 next if $@; # "Can't locate" error
276 # If we make it to here, we loaded an external definition
277 warn qq/# Loaded external class definition for '$table_class'\n/
280 if($self->dump_directory) {
281 my $class_path = $table_class;
282 $class_path =~ s{::}{/}g;
283 $class_path .= '.pm';
284 my $filename = $INC{$class_path};
285 croak 'Failed to locate actual external module file for '
288 open(my $fh, '<', $filename)
289 or croak "Failed to open $filename for reading: $!";
290 $self->_raw_stmt($table_class,
291 q|# These lines loaded from user-supplied external file: |
295 $self->_raw_stmt($table_class, $_);
297 $self->_raw_stmt($table_class,
298 q|# End of lines loaded from user-supplied external file |
301 or croak "Failed to close $filename: $!";
308 Does the actual schema-construction work.
315 $self->_load_classes;
316 $self->_load_relationships if $self->relationships;
317 $self->_load_external;
318 $self->_dump_to_dir if $self->dump_directory;
320 # Drop temporary cache
321 delete $self->{_cache};
326 sub _get_dump_filename {
327 my ($self, $class) = (@_);
330 return $self->dump_directory . q{/} . $class . q{.pm};
333 sub _ensure_dump_subdirs {
334 my ($self, $class) = (@_);
336 my @name_parts = split(/::/, $class);
338 my $dir = $self->dump_directory;
339 foreach (@name_parts) {
342 mkdir($dir) or croak "mkdir('$dir') failed: $!";
350 my $target_dir = $self->dump_directory;
352 my $schema_class = $self->schema_class;
354 croak "Must specify target directory for dumping!" if ! $target_dir;
356 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n";
358 if(! -d $target_dir) {
359 mkdir($target_dir) or croak "mkdir('$target_dir') failed: $!";
362 my $verstr = $DBIx::Class::Schema::Loader::VERSION;
363 my $datestr = POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime);
364 my $tagline = qq|# Created by DBIx::Class::Schema::Loader v$verstr @ $datestr|;
366 $self->_ensure_dump_subdirs($schema_class);
368 my $schema_fn = $self->_get_dump_filename($schema_class);
369 if (-f $schema_fn && !$self->dump_overwrite) {
370 warn "$schema_fn exists, will not overwrite\n";
373 open(my $schema_fh, '>', $schema_fn)
374 or croak "Cannot open $schema_fn for writing: $!";
375 print $schema_fh qq|package $schema_class;\n\n$tagline\n\n|;
376 print $schema_fh qq|use strict;\nuse warnings;\n\n|;
377 print $schema_fh qq|use base 'DBIx::Class::Schema';\n\n|;
378 print $schema_fh qq|__PACKAGE__->load_classes;\n|;
379 print $schema_fh qq|\n1;\n\n|;
381 or croak "Cannot close $schema_fn: $!";
384 foreach my $src_class (sort keys %{$self->{_dump_storage}}) {
385 $self->_ensure_dump_subdirs($src_class);
386 my $src_fn = $self->_get_dump_filename($src_class);
387 if (-f $src_fn && !$self->dump_overwrite) {
388 warn "$src_fn exists, will not overwrite\n";
391 open(my $src_fh, '>', $src_fn)
392 or croak "Cannot open $src_fn for writing: $!";
393 print $src_fh qq|package $src_class;\n\n$tagline\n\n|;
394 print $src_fh qq|use strict;\nuse warnings;\n\n|;
395 print $src_fh qq|use base 'DBIx::Class';\n\n|;
396 print $src_fh qq|$_\n|
397 for @{$self->{_dump_storage}->{$src_class}};
398 print $src_fh qq|\n1;\n\n|;
400 or croak "Cannot close $src_fn: $!";
403 warn "Schema dump completed.\n";
412 warn "$target: use $_;" if $self->debug;
413 $self->_raw_stmt($target, "use $_;");
414 $_->require or croak ($_ . "->require: $@");
415 $evalstr .= "package $target; use $_;";
417 eval $evalstr if $evalstr;
424 my $schema_class = $self->schema_class;
426 my $blist = join(q{ }, @_);
427 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
428 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
430 $_->require or croak ($_ . "->require: $@");
431 $schema_class->inject_base($target, $_);
435 # Load and setup classes
439 my $schema = $self->schema;
440 my $schema_class = $self->schema_class;
441 my $constraint = $self->constraint;
442 my $exclude = $self->exclude;
443 my @tables = sort $self->_tables_list;
445 warn "No tables found in database, nothing to load" if !@tables;
448 @tables = grep { /$constraint/ } @tables if $constraint;
449 @tables = grep { ! /$exclude/ } @tables if $exclude;
451 warn "All tables excluded by constraint/exclude, nothing to load"
455 $self->{_tables} = \@tables;
457 foreach my $table (@tables) {
458 my $table_moniker = $self->_table2moniker($table);
459 my $table_class = $schema_class . q{::} . $table_moniker;
461 my $table_normalized = lc $table;
462 $self->classes->{$table} = $table_class;
463 $self->classes->{$table_normalized} = $table_class;
464 $self->monikers->{$table} = $table_moniker;
465 $self->monikers->{$table_normalized} = $table_moniker;
467 no warnings 'redefine';
468 local *Class::C3::reinitialize = sub { };
471 { no strict 'refs'; @{"${table_class}::ISA"} = qw/DBIx::Class/ }
473 $self->_use ($table_class, @{$self->additional_classes});
474 $self->_inject($table_class, @{$self->additional_base_classes});
476 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, qw/PK::Auto Core/);
478 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
479 if @{$self->resultset_components};
480 $self->_inject($table_class, @{$self->left_base_classes});
483 Class::C3::reinitialize;
485 foreach my $table (@tables) {
486 my $table_class = $self->classes->{$table};
487 my $table_moniker = $self->monikers->{$table};
489 $self->_dbic_stmt($table_class,'table',$table);
491 my $cols = $self->_table_columns($table);
493 eval { $col_info = $schema->storage->columns_info_for($table) };
495 $self->_dbic_stmt($table_class,'add_columns',@$cols);
498 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
502 map { $_, ($col_info_lc{$_}||{}) } @$cols
506 my $pks = $self->_table_pk_info($table) || [];
507 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
508 : carp("$table has no primary key");
510 my $uniqs = $self->_table_uniq_info($table) || [];
511 $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs);
513 $schema_class->register_class($table_moniker, $table_class);
514 $schema->register_class($table_moniker, $table_class) if $schema ne $schema_class;
520 Returns a sorted list of loaded tables, using the original database table
528 return @{$self->_tables};
531 # Make a moniker from a table
533 my ( $self, $table ) = @_;
537 if( ref $self->moniker_map eq 'HASH' ) {
538 $moniker = $self->moniker_map->{$table};
540 elsif( ref $self->moniker_map eq 'CODE' ) {
541 $moniker = $self->moniker_map->($table);
544 $moniker ||= join '', map ucfirst, split /[\W_]+/, lc $table;
549 sub _load_relationships {
552 # Construct the fk_info RelBuilder wants to see, by
553 # translating table names to monikers in the _fk_info output
555 foreach my $table ($self->tables) {
556 my $tbl_fk_info = $self->_table_fk_info($table);
557 foreach my $fkdef (@$tbl_fk_info) {
558 $fkdef->{remote_source} =
559 $self->monikers->{delete $fkdef->{remote_table}};
561 my $moniker = $self->monikers->{$table};
562 $fk_info{$moniker} = $tbl_fk_info;
565 my $relbuilder = DBIx::Class::Schema::Loader::RelBuilder->new(
566 $self->schema_class, \%fk_info, $self->inflect_plural,
567 $self->inflect_singular
570 my $rel_stmts = $relbuilder->generate_code;
571 foreach my $src_class (sort keys %$rel_stmts) {
572 my $src_stmts = $rel_stmts->{$src_class};
573 foreach my $stmt (@$src_stmts) {
574 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
579 # Overload these in driver class:
581 # Returns an arrayref of column names
582 sub _table_columns { croak "ABSTRACT METHOD" }
584 # Returns arrayref of pk col names
585 sub _table_pk_info { croak "ABSTRACT METHOD" }
587 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
588 sub _table_uniq_info { croak "ABSTRACT METHOD" }
590 # Returns an arrayref of foreign key constraints, each
591 # being a hashref with 3 keys:
592 # local_columns (arrayref), remote_columns (arrayref), remote_table
593 sub _table_fk_info { croak "ABSTRACT METHOD" }
595 # Returns an array of lower case table names
596 sub _tables_list { croak "ABSTRACT METHOD" }
598 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
604 if(!$self->debug && !$self->dump_directory) {
610 $args = '(' . $args . ')' if @_ < 2;
611 my $stmt = $method . $args . q{;};
613 warn qq|$class\->$stmt\n| if $self->debug;
615 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
618 # Store a raw source line for a class (for dumping purposes)
620 my ($self, $class, $stmt) = @_;
621 push(@{$self->{_dump_storage}->{$class}}, $stmt) if $self->dump_directory;
626 Returns a hashref of loaded table to moniker mappings. There will
627 be two entries for each table, the original name and the "normalized"
628 name, in the case that the two are different (such as databases
629 that like uppercase table names, or preserve your original mixed-case
630 definitions, or what-have-you).
634 Returns a hashref of table to class mappings. In some cases it will
635 contain multiple entries per table for the original and normalized table
636 names, as above in L</monikers>.
640 L<DBIx::Class::Schema::Loader>