1 package DBIx::Class::Schema::Loader;
5 use base qw/DBIx::Class::Schema Class::Accessor::Grouped/;
8 use Carp::Clan qw/^DBIx::Class/;
9 use Scalar::Util 'weaken';
10 use Sub::Name 'subname';
11 use DBIx::Class::Schema::Loader::Utils 'array_eq';
13 use Hash::Merge 'merge';
16 # Always remember to do all digits for the version even if they're 0
17 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
18 # brain damage and presumably various other packaging systems too
19 our $VERSION = '0.07020';
21 __PACKAGE__->mk_group_accessors('inherited', qw/
30 __PACKAGE__->_loader_args({});
34 DBIx::Class::Schema::Loader - Create a DBIx::Class::Schema based on a database
38 ### use this module to generate a set of class files
41 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
45 dump_directory => './lib',
47 [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword',
48 { loader_class => 'MyLoader' } # optionally
52 # from the command line or a shell script with dbicdump (distributed
53 # with this module). Do `perldoc dbicdump` for usage.
54 dbicdump -o dump_directory=./lib \
55 -o components='["InflateColumn::DateTime"]' \
62 ### or generate and load classes at runtime
63 # note: this technique is not recommended
64 # for use in production code
67 use base qw/DBIx::Class::Schema::Loader/;
69 __PACKAGE__->loader_options(
70 constraint => '^foo.*',
74 #### in application code elsewhere:
78 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
80 my $schema1 = "My::Schema"; $schema1->connection(as above);
84 DBIx::Class::Schema::Loader automates the definition of a
85 L<DBIx::Class::Schema> by scanning database table definitions and setting up
86 the columns, primary keys, unique constraints and relationships.
88 See L<dbicdump> for the C<dbicdump> utility.
90 DBIx::Class::Schema::Loader currently supports only the DBI storage type. It
91 has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
92 L<DBD::Firebird>, L<DBD::InterBase>, L<DBD::Informix>, L<DBD::SQLAnywhere>,
93 L<DBD::SQLite>, L<DBD::Sybase> (for Sybase ASE and MSSSQL), L<DBD::ODBC> (for
94 MSSQL, MSAccess, Firebird and SQL Anywhere) L<DBD::ADO> (for MSSQL and
95 MSAccess) and L<DBD::Oracle>. Other DBI drivers may function to a greater or
96 lesser degree with this loader, depending on how much of the DBI spec they
97 implement, and how standard their implementation is.
99 Patches to make other DBDs work correctly welcome.
101 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
102 your own vendor-specific subclass for an unsupported DBD driver.
104 This module requires L<DBIx::Class> 0.08127 or later, and obsoletes the older
105 L<DBIx::Class::Loader>.
107 See L<DBIx::Class::Schema::Loader::Base> for available options.
113 The loader object, as class data on your Schema. For methods available see
114 L<DBIx::Class::Schema::Loader::Base> and L<DBIx::Class::Schema::Loader::DBI>.
127 =item Argument: $loader_class
131 Set the loader class to be instantiated when L</connection> is called.
132 If the classname starts with "::", "DBIx::Class::Schema::Loader" is
133 prepended. Defaults to L<DBIx::Class::Schema/storage_type> (which must
134 start with "::" when using L<DBIx::Class::Schema::Loader>).
136 This is mostly useful for subclassing existing loaders or in conjunction
137 with L</dump_to_dir>.
139 =head2 loader_options
143 =item Argument: \%loader_options
147 Example in Synopsis above demonstrates a few common arguments. For
148 detailed information on all of the arguments, most of which are
149 only useful in fairly complex scenarios, see the
150 L<DBIx::Class::Schema::Loader::Base> documentation.
152 If you intend to use C<loader_options>, you must call
153 C<loader_options> before any connection is made, or embed the
154 C<loader_options> in the connection information itself as shown
155 below. Setting C<loader_options> after the connection has
156 already been made is useless.
163 my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
164 $self->_loader_args(\%args);
171 my $class = ref $self || $self;
173 my $args = $self->_loader_args;
175 # temporarily copy $self's storage to class
176 my $class_storage = $class->storage;
178 $class->storage($self->storage);
179 $class->storage->set_schema($class);
182 $args->{schema} = $class;
183 $args->{schema_class} = $class;
184 $args->{dump_directory} ||= $self->dump_to_dir;
185 $args->{naming} = $self->naming if $self->naming;
186 $args->{use_namespaces} = $self->use_namespaces if defined $self->use_namespaces;
188 # XXX this only works for relative storage_type, like ::DBI ...
189 my $loader_class = $self->loader_class;
191 $loader_class = "DBIx::Class::Schema::Loader${loader_class}" if $loader_class =~ /^::/;
192 $args->{loader_class} = $loader_class;
195 my $impl = $loader_class || "DBIx::Class::Schema::Loader" . $self->storage_type;
197 $self->ensure_class_loaded($impl)
200 croak qq/Could not load loader_class "$impl": "$_"/;
203 $class->loader($impl->new(%$args));
204 $class->loader->load;
205 $class->_loader_invoked(1);
209 $self->loader($class->loader);
210 $self->_loader_invoked(1);
212 $self->_merge_state_from($class);
215 # restore $class's storage
216 $class->storage($class_storage);
221 # FIXME This needs to be moved into DBIC at some point, otherwise we are
222 # maintaining things to do with DBIC guts, which we have no business of
223 # maintaining. But at the moment it would be just dead code in DBIC, so we'll
225 sub _merge_state_from {
226 my ($self, $from) = @_;
228 my $orig_class_mappings = $self->class_mappings;
229 my $orig_source_registrations = $self->source_registrations;
231 $self->_copy_state_from($from);
233 $self->class_mappings(merge($orig_class_mappings, $self->class_mappings))
234 if $orig_class_mappings;
236 $self->source_registrations(merge($orig_source_registrations, $self->source_registrations))
237 if $orig_source_registrations;
240 sub _copy_state_from {
244 # older DBIC's do not have this method
245 if (try { DBIx::Class->VERSION('0.08197'); 1 }) {
246 return $self->next::method(@_);
249 # this is a copy from DBIC git master pre 0.08197
250 $self->class_mappings({ %{$from->class_mappings} });
251 $self->source_registrations({ %{$from->source_registrations} });
253 foreach my $moniker ($from->sources) {
254 my $source = $from->source($moniker);
255 my $new = $source->new($source);
256 # we use extra here as we want to leave the class_mappings as they are
257 # but overwrite the source_registrations entry with the new source
258 $self->register_extra_source($moniker => $new);
261 if ($from->storage) {
262 $self->storage($from->storage);
263 $self->storage->set_schema($self);
272 =item Arguments: @args
274 =item Return Value: $new_schema
278 See L<DBIx::Class::Schema/connection> for basic usage.
280 If the final argument is a hashref, and it contains the keys C<loader_options>
281 or C<loader_class>, those keys will be deleted, and their values value will be
282 used for the loader options or class, respectively, just as if set via the
283 L</loader_options> or L</loader_class> methods above.
285 The actual auto-loading operation (the heart of this module) will be invoked
286 as soon as the connection information is defined.
292 my $class = ref $self || $self;
294 if($_[-1] && ref $_[-1] eq 'HASH') {
295 for my $option (qw/loader_class loader_options/) {
296 if(my $value = delete $_[-1]->{$option}) {
297 $self->$option($value);
300 pop @_ if !keys %{$_[-1]};
303 # Make sure we inherit from schema_base_class and load schema_components
305 require DBIx::Class::Schema::Loader::Base;
306 my $temp_loader = DBIx::Class::Schema::Loader::Base->new(
307 %{ $self->_loader_args },
316 if ($temp_loader->schema_base_class || $temp_loader->schema_components) {
317 @components = @{ $temp_loader->schema_components }
318 if $temp_loader->schema_components;
320 push @components, ('+'.$temp_loader->schema_base_class)
321 if $temp_loader->schema_base_class;
328 my @component_classes = map {
329 /^\+/ ? substr($_, 1, length($_) - 1) : "DBIx::Class::$_"
332 $modify_isa++ if not array_eq([ @$class_isa[0..(@components-1)] ], \@component_classes)
336 $class->load_components(@components);
338 # This hack is necessary because we changed @ISA of $self through
339 # ->load_components and we are now in a different place in the mro.
340 no warnings 'redefine';
342 local *connection = subname __PACKAGE__.'::connection' => sub {
344 $self->next::method(@_);
347 my @linear_isa = @{ mro::get_linear_isa($class) };
351 foreach my $i (1..$#linear_isa) {
353 $next_method = *{$linear_isa[$i].'::connection'}{CODE};
354 last if $next_method;
357 $self = $self->$next_method(@_);
360 $self = $self->next::method(@_);
363 if(!$class->_loader_invoked) {
364 $self->_invoke_loader
372 See L<DBIx::Class::Schema/clone>.
379 my $clone = $self->next::method(@_);
381 if($clone->_loader_args) {
382 $clone->_loader_args->{schema} = $clone;
383 weaken($clone->_loader_args->{schema});
393 =item Argument: $directory
397 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
398 or any derived schema class will cause all schemas to dump
399 manual versions of themselves to the named directory when they are
400 loaded. In order to be effective, this must be set before defining a
401 connection on this schema class or any derived object (as the loading
402 happens as soon as both a connection and loader_options are set, and
403 only once per class).
405 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
406 details on the dumping mechanism.
408 This can also be set at module import time via the import option
409 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
410 C</foo/bar> is the target directory.
414 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
415 # hardcoded in the class itself:
416 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
418 # Same, but no hard-coded connection, so we must provide one:
419 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
421 # Or as a class method, as long as you get it done *before* defining a
422 # connection on this schema class or any derived object:
424 My::Schema->dump_to_dir('/foo/bar');
425 My::Schema->connection(........);
427 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
431 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
432 My::Schema->connection(.......);
433 My::OtherSchema->connection(.......);
435 # Another alternative to the above:
436 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
439 My::Schema->connection(.......);
440 My::OtherSchema->connection(.......);
449 my $cpkg = (caller)[0];
451 foreach my $opt (@_) {
452 if($opt =~ m{^dump_to_dir:(.*)$}) {
453 $self->dump_to_dir($1)
455 elsif($opt eq 'make_schema_at') {
457 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
459 elsif($opt eq 'naming') {
461 *{"${cpkg}::naming"} = sub { $self->naming(@_) };
463 elsif($opt eq 'use_namespaces') {
465 *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) };
470 =head2 make_schema_at
474 =item Arguments: $schema_class_name, \%loader_options, \@connect_info
476 =item Return Value: $schema_class_name
480 This function creates a DBIx::Class schema from an existing RDBMS
481 schema. With the C<dump_directory> option, generates a set of
482 DBIx::Class classes from an existing database schema read from the
483 given dsn. Without a C<dump_directory>, creates schema classes in
484 memory at runtime without generating on-disk class files.
486 For a complete list of supported loader_options, see
487 L<DBIx::Class::Schema::Loader::Base>
489 The last hashref in the C<\@connect_info> can specify the L</loader_class>.
491 This function can be imported in the usual way, as illustrated in
494 # Simple example, creates as a new class 'New::Schema::Name' in
495 # memory in the running perl interpreter.
496 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
500 [ 'dbi:Pg:dbname="foo"','postgres','',
501 { loader_class => 'MyLoader' } # optionally
505 # Inside a script, specifying a dump directory in which to write
507 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
510 { debug => 1, dump_directory => './lib' },
511 [ 'dbi:Pg:dbname="foo"','postgres','',
512 { loader_class => 'MyLoader' } # optionally
516 The last hashref in the C<\@connect_info> is checked for loader arguments such
517 as C<loader_options> and C<loader_class>, see L</connection> for more details.
522 my ($target, $opts, $connect_info) = @_;
526 @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
529 $target->_loader_invoked(0);
531 $target->loader_options($opts);
533 my $temp_schema = $target->connect(@$connect_info);
535 $target->storage($temp_schema->storage);
536 $target->storage->set_schema($target);
545 =item Return Value: @new_monikers
549 Re-scans the database for newly added tables since the initial
550 load, and adds them to the schema at runtime, including relationships,
551 etc. Does not process drops or changes.
553 Returns a list of the new monikers added.
557 sub rescan { my $self = shift; $self->loader->rescan($self) }
563 =item Arguments: \%opts | $ver
567 Controls the naming options for backward compatibility, see
568 L<DBIx::Class::Schema::Loader::Base/naming> for details.
570 To upgrade a dynamic schema, use:
572 __PACKAGE__->naming('current');
574 Can be imported into your dump script and called as a function as well:
578 =head2 use_namespaces
586 Controls the use_namespaces options for backward compatibility, see
587 L<DBIx::Class::Schema::Loader::Base/use_namespaces> for details.
589 To upgrade a dynamic schema, use:
591 __PACKAGE__->use_namespaces(1);
593 Can be imported into your dump script and called as a function as well:
599 =head2 Multiple Database Schemas
601 See L<DBIx::Class::Schema::Loader::Base/db_schema>.
603 =head1 ACKNOWLEDGEMENTS
605 Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
606 in a bug report or suggestion.
608 Based on L<DBIx::Class::Loader> by Sebastian Riedel
610 Based upon the work of IKEBE Tomohiro
614 blblack: Brandon Black <blblack@gmail.com>
618 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
620 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
622 ash: Ash Berlin <ash@cpan.org>
624 btilly: Ben Tilly <btilly@gmail.com>
626 Caelum: Rafael Kitover <rkitover@cpan.org>
628 TSUNODA Kazuya <drk@drk7.jp>
630 rbo: Robert Bohne <rbo@cpan.org>
632 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
634 gugu: Andrey Kostenko <a.kostenko@rambler-co.ru>
636 jhannah: Jay Hannah <jay@jays.net>
638 jnap: John Napiorkowski <jjn1056@yahoo.com>
640 rbuels: Robert Buels <rmb32@cornell.edu>
642 timbunce: Tim Bunce <timb@cpan.org>
644 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
646 mstratman: Mark A. Stratman <stratman@gmail.com>
648 kane: Jos Boumans <kane@cpan.org>
650 waawaamilk: Nigel McNie <nigel@mcnie.name>
652 acmoore: Andrew Moore <amoore@cpan.org>
654 bphillips: Brian Phillips <bphillips@cpan.org>
656 schwern: Michael G. Schwern <mschwern@cpan.org>
658 SineSwiper: Brendan Byrd <byrd.b@insightcom.com>
660 hobbs: Andrew Rodland <arodland@cpan.org>
662 domm: Thomas Klausner <domm@plix.at>
664 spb: Stephen Bennett <spb@exherbo.org>
666 Matias E. Fernandez <mfernandez@pisco.ch>
668 alnewkirk: Al Newkirk <awncorp@cpan.org>
670 ... and lots of other folks. If we forgot you, please write the current
673 =head1 COPYRIGHT & LICENSE
675 Copyright (c) 2006 - 2009 by the aforementioned
676 L<DBIx::Class::Schema::Loader/AUTHOR> and
677 L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
679 This library is free software; you can redistribute it and/or modify it under
680 the same terms as Perl itself.
684 L<DBIx::Class>, L<DBIx::Class::Manual::Intro>, L<DBIx::Class::Tutorial>,
685 L<DBIx::Class::Schema::Loader::Base>
690 # vim:et sts=4 sw=4 tw=0: