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.07036_03';
21 __PACKAGE__->mk_group_accessors('inherited', qw/
30 __PACKAGE__->_loader_args({});
36 DBIx::Class::Schema::Loader - Create a DBIx::Class::Schema based on a database
40 ### use this module to generate a set of class files
43 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
47 dump_directory => './lib',
49 [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword',
50 { loader_class => 'MyLoader' } # optionally
54 # from the command line or a shell script with dbicdump (distributed
55 # with this module). Do `perldoc dbicdump` for usage.
56 dbicdump -o dump_directory=./lib \
57 -o components='["InflateColumn::DateTime"]' \
64 ### or generate and load classes at runtime
65 # note: this technique is not recommended
66 # for use in production code
69 use base qw/DBIx::Class::Schema::Loader/;
71 __PACKAGE__->loader_options(
72 constraint => '^foo.*',
76 #### in application code elsewhere:
80 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
82 my $schema1 = "My::Schema"; $schema1->connection(as above);
86 DBIx::Class::Schema::Loader automates the definition of a
87 L<DBIx::Class::Schema> by scanning database table definitions and setting up
88 the columns, primary keys, unique constraints and relationships.
90 See L<dbicdump> for the C<dbicdump> utility.
92 DBIx::Class::Schema::Loader currently supports only the DBI storage type. It
93 has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
94 L<DBD::Firebird>, L<DBD::InterBase>, L<DBD::Informix>, L<DBD::SQLAnywhere>,
95 L<DBD::SQLite>, L<DBD::Sybase> (for Sybase ASE and MSSSQL), L<DBD::ODBC> (for
96 MSSQL, MSAccess, Firebird and SQL Anywhere) L<DBD::ADO> (for MSSQL and
97 MSAccess) and L<DBD::Oracle>. Other DBI drivers may function to a greater or
98 lesser degree with this loader, depending on how much of the DBI spec they
99 implement, and how standard their implementation is.
101 Patches to make other DBDs work correctly welcome.
103 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
104 your own vendor-specific subclass for an unsupported DBD driver.
106 This module requires L<DBIx::Class> 0.08127 or later, and obsoletes the older
107 L<DBIx::Class::Loader>.
109 See L<DBIx::Class::Schema::Loader::Base> for available options.
115 The loader object, as class data on your Schema. For methods available see
116 L<DBIx::Class::Schema::Loader::Base> and L<DBIx::Class::Schema::Loader::DBI>.
129 =item Argument: $loader_class
133 Set the loader class to be instantiated when L</connection> is called.
134 If the classname starts with "::", "DBIx::Class::Schema::Loader" is
135 prepended. Defaults to L<DBIx::Class::Schema/storage_type> (which must
136 start with "::" when using L<DBIx::Class::Schema::Loader>).
138 This is mostly useful for subclassing existing loaders or in conjunction
139 with L</dump_to_dir>.
141 =head2 loader_options
145 =item Argument: \%loader_options
149 Example in Synopsis above demonstrates a few common arguments. For
150 detailed information on all of the arguments, most of which are
151 only useful in fairly complex scenarios, see the
152 L<DBIx::Class::Schema::Loader::Base> documentation.
154 If you intend to use C<loader_options>, you must call
155 C<loader_options> before any connection is made, or embed the
156 C<loader_options> in the connection information itself as shown
157 below. Setting C<loader_options> after the connection has
158 already been made is useless.
165 my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
166 $self->_loader_args(\%args);
173 my $class = ref $self || $self;
175 my $args = $self->_loader_args;
177 # temporarily copy $self's storage to class
178 my $class_storage = $class->storage;
180 $class->storage($self->storage);
181 $class->storage->set_schema($class);
184 $args->{schema} = $class;
185 $args->{schema_class} = $class;
186 $args->{dump_directory} ||= $self->dump_to_dir;
187 $args->{naming} = $self->naming if $self->naming;
188 $args->{use_namespaces} = $self->use_namespaces if defined $self->use_namespaces;
190 # XXX this only works for relative storage_type, like ::DBI ...
191 my $loader_class = $self->loader_class;
193 $loader_class = "DBIx::Class::Schema::Loader${loader_class}" if $loader_class =~ /^::/;
194 $args->{loader_class} = $loader_class;
197 my $impl = $loader_class || "DBIx::Class::Schema::Loader" . $self->storage_type;
199 $self->ensure_class_loaded($impl)
202 croak qq/Could not load loader_class "$impl": "$_"/;
205 $class->loader($impl->new(%$args));
206 $class->loader->load;
207 $class->_loader_invoked(1);
211 $self->loader($class->loader);
212 $self->_loader_invoked(1);
214 $self->_merge_state_from($class);
217 # restore $class's storage
218 $class->storage($class_storage);
223 # FIXME This needs to be moved into DBIC at some point, otherwise we are
224 # maintaining things to do with DBIC guts, which we have no business of
225 # maintaining. But at the moment it would be just dead code in DBIC, so we'll
227 sub _merge_state_from {
228 my ($self, $from) = @_;
230 my $orig_class_mappings = $self->class_mappings;
231 my $orig_source_registrations = $self->source_registrations;
233 $self->_copy_state_from($from);
235 $self->class_mappings(merge($orig_class_mappings, $self->class_mappings))
236 if $orig_class_mappings;
238 $self->source_registrations(merge($orig_source_registrations, $self->source_registrations))
239 if $orig_source_registrations;
242 sub _copy_state_from {
246 # older DBIC's do not have this method
247 if (try { DBIx::Class->VERSION('0.08197'); 1 }) {
248 return $self->next::method(@_);
251 # this is a copy from DBIC git master pre 0.08197
252 $self->class_mappings({ %{$from->class_mappings} });
253 $self->source_registrations({ %{$from->source_registrations} });
255 foreach my $moniker ($from->sources) {
256 my $source = $from->source($moniker);
257 my $new = $source->new($source);
258 # we use extra here as we want to leave the class_mappings as they are
259 # but overwrite the source_registrations entry with the new source
260 $self->register_extra_source($moniker => $new);
263 if ($from->storage) {
264 $self->storage($from->storage);
265 $self->storage->set_schema($self);
274 =item Arguments: @args
276 =item Return Value: $new_schema
280 See L<DBIx::Class::Schema/connection> for basic usage.
282 If the final argument is a hashref, and it contains the keys C<loader_options>
283 or C<loader_class>, those keys will be deleted, and their values value will be
284 used for the loader options or class, respectively, just as if set via the
285 L</loader_options> or L</loader_class> methods above.
287 The actual auto-loading operation (the heart of this module) will be invoked
288 as soon as the connection information is defined.
294 my $class = ref $self || $self;
296 if($_[-1] && ref $_[-1] eq 'HASH') {
297 for my $option (qw/loader_class loader_options/) {
298 if(my $value = delete $_[-1]->{$option}) {
299 $self->$option($value);
302 pop @_ if !keys %{$_[-1]};
305 # Make sure we inherit from schema_base_class and load schema_components
307 require DBIx::Class::Schema::Loader::Base;
308 my $temp_loader = DBIx::Class::Schema::Loader::Base->new(
309 %{ $self->_loader_args },
318 if ($temp_loader->schema_base_class || $temp_loader->schema_components) {
319 @components = @{ $temp_loader->schema_components }
320 if $temp_loader->schema_components;
322 push @components, ('+'.$temp_loader->schema_base_class)
323 if $temp_loader->schema_base_class;
330 my @component_classes = map {
331 /^\+/ ? substr($_, 1, length($_) - 1) : "DBIx::Class::$_"
334 $modify_isa++ if not array_eq([ @$class_isa[0..(@components-1)] ], \@component_classes)
338 $class->load_components(@components);
340 # This hack is necessary because we changed @ISA of $self through
341 # ->load_components and we are now in a different place in the mro.
342 no warnings 'redefine';
344 local *connection = subname __PACKAGE__.'::connection' => sub {
346 $self->next::method(@_);
349 my @linear_isa = @{ mro::get_linear_isa($class) };
353 foreach my $i (1..$#linear_isa) {
355 $next_method = *{$linear_isa[$i].'::connection'}{CODE};
356 last if $next_method;
359 $self = $self->$next_method(@_);
362 $self = $self->next::method(@_);
365 if(!$class->_loader_invoked) {
366 $self->_invoke_loader
374 See L<DBIx::Class::Schema/clone>.
381 my $clone = $self->next::method(@_);
383 if($clone->_loader_args) {
384 $clone->_loader_args->{schema} = $clone;
385 weaken($clone->_loader_args->{schema});
395 =item Argument: $directory
399 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
400 or any derived schema class will cause all schemas to dump
401 manual versions of themselves to the named directory when they are
402 loaded. In order to be effective, this must be set before defining a
403 connection on this schema class or any derived object (as the loading
404 happens as soon as both a connection and loader_options are set, and
405 only once per class).
407 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
408 details on the dumping mechanism.
410 This can also be set at module import time via the import option
411 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
412 C</foo/bar> is the target directory.
416 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
417 # hardcoded in the class itself:
418 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
420 # Same, but no hard-coded connection, so we must provide one:
421 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
423 # Or as a class method, as long as you get it done *before* defining a
424 # connection on this schema class or any derived object:
426 My::Schema->dump_to_dir('/foo/bar');
427 My::Schema->connection(........);
429 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
433 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
434 My::Schema->connection(.......);
435 My::OtherSchema->connection(.......);
437 # Another alternative to the above:
438 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
441 My::Schema->connection(.......);
442 My::OtherSchema->connection(.......);
451 my $cpkg = (caller)[0];
453 foreach my $opt (@_) {
454 if($opt =~ m{^dump_to_dir:(.*)$}) {
455 $self->dump_to_dir($1)
457 elsif($opt eq 'make_schema_at') {
459 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
461 elsif($opt eq 'naming') {
463 *{"${cpkg}::naming"} = sub { $self->naming(@_) };
465 elsif($opt eq 'use_namespaces') {
467 *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) };
472 =head2 make_schema_at
476 =item Arguments: $schema_class_name, \%loader_options, \@connect_info
478 =item Return Value: $schema_class_name
482 This function creates a DBIx::Class schema from an existing RDBMS
483 schema. With the C<dump_directory> option, generates a set of
484 DBIx::Class classes from an existing database schema read from the
485 given dsn. Without a C<dump_directory>, creates schema classes in
486 memory at runtime without generating on-disk class files.
488 For a complete list of supported loader_options, see
489 L<DBIx::Class::Schema::Loader::Base>
491 The last hashref in the C<\@connect_info> can specify the L</loader_class>.
493 This function can be imported in the usual way, as illustrated in
496 # Simple example, creates as a new class 'New::Schema::Name' in
497 # memory in the running perl interpreter.
498 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
502 [ 'dbi:Pg:dbname="foo"','postgres','',
503 { loader_class => 'MyLoader' } # optionally
507 # Inside a script, specifying a dump directory in which to write
509 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
512 { debug => 1, dump_directory => './lib' },
513 [ 'dbi:Pg:dbname="foo"','postgres','',
514 { loader_class => 'MyLoader' } # optionally
518 The last hashref in the C<\@connect_info> is checked for loader arguments such
519 as C<loader_options> and C<loader_class>, see L</connection> for more details.
524 my ($target, $opts, $connect_info) = @_;
528 @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
531 $target->_loader_invoked(0);
533 $target->loader_options($opts);
535 my $temp_schema = $target->connect(@$connect_info);
537 $target->storage($temp_schema->storage);
538 $target->storage->set_schema($target);
547 =item Return Value: @new_monikers
551 Re-scans the database for newly added tables since the initial
552 load, and adds them to the schema at runtime, including relationships,
553 etc. Does not process drops or changes.
555 Returns a list of the new monikers added.
559 sub rescan { my $self = shift; $self->loader->rescan($self) }
565 =item Arguments: \%opts | $ver
569 Controls the naming options for backward compatibility, see
570 L<DBIx::Class::Schema::Loader::Base/naming> for details.
572 To upgrade a dynamic schema, use:
574 __PACKAGE__->naming('current');
576 Can be imported into your dump script and called as a function as well:
580 =head2 use_namespaces
588 Controls the use_namespaces options for backward compatibility, see
589 L<DBIx::Class::Schema::Loader::Base/use_namespaces> for details.
591 To upgrade a dynamic schema, use:
593 __PACKAGE__->use_namespaces(1);
595 Can be imported into your dump script and called as a function as well:
601 =head2 Multiple Database Schemas
603 See L<DBIx::Class::Schema::Loader::Base/db_schema>.
605 =head1 ACKNOWLEDGEMENTS
607 Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
608 in a bug report or suggestion.
610 Based on L<DBIx::Class::Loader> by Sebastian Riedel
612 Based upon the work of IKEBE Tomohiro
616 blblack: Brandon Black <blblack@gmail.com>
620 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
622 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
624 ash: Ash Berlin <ash@cpan.org>
626 btilly: Ben Tilly <btilly@gmail.com>
628 Caelum: Rafael Kitover <rkitover@cpan.org>
630 TSUNODA Kazuya <drk@drk7.jp>
632 rbo: Robert Bohne <rbo@cpan.org>
634 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
636 gugu: Andrey Kostenko <a.kostenko@rambler-co.ru>
638 jhannah: Jay Hannah <jay@jays.net>
640 jnap: John Napiorkowski <jjn1056@yahoo.com>
642 rbuels: Robert Buels <rbuels@gmail.com>
644 timbunce: Tim Bunce <timb@cpan.org>
646 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
648 mstratman: Mark A. Stratman <stratman@gmail.com>
650 kane: Jos Boumans <kane@cpan.org>
652 waawaamilk: Nigel McNie <nigel@mcnie.name>
654 acmoore: Andrew Moore <amoore@cpan.org>
656 bphillips: Brian Phillips <bphillips@cpan.org>
658 schwern: Michael G. Schwern <mschwern@cpan.org>
660 SineSwiper: Brendan Byrd <byrd.b@insightcom.com>
662 hobbs: Andrew Rodland <arodland@cpan.org>
664 domm: Thomas Klausner <domm@plix.at>
666 spb: Stephen Bennett <spb@exherbo.org>
668 Matias E. Fernandez <mfernandez@pisco.ch>
670 alnewkirk: Al Newkirk <awncorp@cpan.org>
672 angelixd: Paul C. Mantz <pcmantz@cpan.org>
674 andrewalker: André Walker <andre@andrewalker.net>
676 ... and lots of other folks. If we forgot you, please write the current
679 =head1 COPYRIGHT & LICENSE
681 Copyright (c) 2006 - 2009 by the aforementioned
682 L<DBIx::Class::Schema::Loader/AUTHOR> and
683 L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
685 This library is free software; you can redistribute it and/or modify it under
686 the same terms as Perl itself.
690 L<DBIx::Class>, L<DBIx::Class::Manual::Intro>, L<DBIx::Class::Tutorial>,
691 L<DBIx::Class::Schema::Loader::Base>
696 # vim:et sts=4 sw=4 tw=0: