1 package DBIx::Class::Schema::Loader;
5 use base qw/DBIx::Class::Schema Class::Accessor::Grouped/;
6 use Carp::Clan qw/^DBIx::Class/;
8 use Scalar::Util qw/ weaken /;
10 # Always remember to do all digits for the version even if they're 0
11 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
12 # brain damage and presumably various other packaging systems too
13 our $VERSION = '0.05001';
15 __PACKAGE__->mk_group_accessors('inherited', qw/
24 __PACKAGE__->_loader_args({});
28 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
32 ### use this module to generate a set of class files
35 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
39 dump_directory => './lib',
41 [ 'dbi:Pg:dbname="foo"', 'myuser', 'mypassword' ],
44 # from the command line or a shell script with dbicdump (distributed
45 # with this module). Do `perldoc dbicdump` for usage.
46 dbicdump -o dump_directory=./lib \
53 ### or generate and load classes at runtime
54 # note: this technique is not recommended
55 # for use in production code
58 use base qw/DBIx::Class::Schema::Loader/;
60 __PACKAGE__->loader_options(
61 constraint => '^foo.*',
65 #### in application code elsewhere:
69 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
71 my $schema1 = "My::Schema"; $schema1->connection(as above);
75 DBIx::Class::Schema::Loader automates the definition of a
76 L<DBIx::Class::Schema> by scanning database table definitions and
77 setting up the columns, primary keys, and relationships.
79 DBIx::Class::Schema::Loader currently supports only the DBI storage type. It
80 has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>,
81 L<DBD::SQLite>, L<DBD::Sybase> (for Sybase ASE and MSSSQL), L<DBD::ODBC> (for
82 MSSQL) and L<DBD::Oracle>. Other DBI drivers may function to a greater or
83 lesser degree with this loader, depending on how much of the DBI spec they
84 implement, and how standard their implementation is.
86 Patches to make other DBDs work correctly welcome.
88 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
89 your own vendor-specific subclass for an unsupported DBD driver.
91 This module requires L<DBIx::Class> 0.07006 or later, and obsoletes
92 the older L<DBIx::Class::Loader>.
94 This module is designed more to get you up and running quickly against
95 an existing database, or to be effective for simple situations, rather
96 than to be what you use in the long term for a complex database/project.
98 That being said, transitioning your code from a Schema generated by this
99 module to one that doesn't use this module should be straightforward and
100 painless, so don't shy away from it just for fears of the transition down
109 =item Argument: $loader_class
113 Set the loader class to be instantiated when L</connection> is called.
114 If the classname starts with "::", "DBIx::Class::Schema::Loader" is
115 prepended. Defaults to L<DBIx::Class::Schema/storage_type> (which must
116 start with "::" when using L<DBIx::Class::Schema::Loader>).
118 This is mostly useful for subclassing existing loaders or in conjunction
119 with L</dump_to_dir>.
121 =head2 loader_options
125 =item Argument: \%loader_options
129 Example in Synopsis above demonstrates a few common arguments. For
130 detailed information on all of the arguments, most of which are
131 only useful in fairly complex scenarios, see the
132 L<DBIx::Class::Schema::Loader::Base> documentation.
134 If you intend to use C<loader_options>, you must call
135 C<loader_options> before any connection is made, or embed the
136 C<loader_options> in the connection information itself as shown
137 below. Setting C<loader_options> after the connection has
138 already been made is useless.
145 my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
146 $self->_validate_loader_options(\%args);
147 $self->_loader_args(\%args);
152 sub _validate_loader_options {
157 schema_base_class result_base_class additional_base_classes
158 left_base_classes additional_classes components resultset_components
160 foreach my $k ( grep { exists $args->{$_} } @class_keys ) {
161 my @classes = ref( $args->{$k} ) eq 'ARRAY' ? @{ $args->{$k} } : $args->{$k};
162 foreach my $c (@classes) {
164 # components default to being under the DBIx::Class namespace unless they
165 # are preceeded with a '+'
166 if ( $k =~ m/components$/ && $c !~ s/^\+// ) {
167 $c = 'DBIx::Class::' . $c;
170 # 1 == installed, 0 == not installed, undef == invalid classname
171 my $installed = Class::Inspector->installed($c);
172 if ( defined($installed) ) {
173 if ( $installed == 0 ) {
174 croak qq/$c, as specified in the loader option "$k", is not installed/;
177 croak qq/$c, as specified in the loader option "$k", is an invalid class name/;
187 my $class = ref $self || $self;
189 my $args = $self->_loader_args;
191 # set up the schema/schema_class arguments
192 $args->{schema} = $self;
193 $args->{schema_class} = $class;
194 weaken($args->{schema}) if ref $self;
195 $args->{dump_directory} ||= $self->dump_to_dir;
196 $args->{naming} = $self->naming if $self->naming;
197 $args->{use_namespaces} = $self->use_namespaces if $self->use_namespaces;
199 # XXX this only works for relative storage_type, like ::DBI ...
200 my $impl = $self->loader_class
201 || "DBIx::Class::Schema::Loader" . $self->storage_type;
202 $impl = "DBIx::Class::Schema::Loader${impl}" if $impl =~ /^::/;
203 eval { $self->ensure_class_loaded($impl) };
204 croak qq/Could not load storage_type loader "$impl": "$@"/ if $@;
206 $self->_loader($impl->new(%$args));
207 $self->_loader->load;
208 $self->_loader_invoked(1);
217 =item Arguments: @args
219 =item Return Value: $new_schema
223 See L<DBIx::Class::Schema/connection> for basic usage.
225 If the final argument is a hashref, and it contains the keys C<loader_options>
226 or C<loader_class>, those keys will be deleted, and their values value will be
227 used for the loader options or class, respectively, just as if set via the
228 L</loader_options> or L</loader_class> methods above.
230 The actual auto-loading operation (the heart of this module) will be invoked
231 as soon as the connection information is defined.
238 if($_[-1] && ref $_[-1] eq 'HASH') {
239 for my $option (qw/ loader_class loader_options result_base_class schema_base_class/) {
240 if(my $value = delete $_[-1]->{$option}) {
241 $self->$option($value);
244 pop @_ if !keys %{$_[-1]};
247 $self = $self->next::method(@_);
249 my $class = ref $self || $self;
250 if(!$class->_loader_invoked) {
251 $self->_invoke_loader
259 See L<DBIx::Class::Schema/clone>.
266 my $clone = $self->next::method(@_);
268 if($clone->_loader_args) {
269 $clone->_loader_args->{schema} = $clone;
270 weaken($clone->_loader_args->{schema});
280 =item Argument: $directory
284 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
285 or any derived schema class will cause all schemas to dump
286 manual versions of themselves to the named directory when they are
287 loaded. In order to be effective, this must be set before defining a
288 connection on this schema class or any derived object (as the loading
289 happens as soon as both a connection and loader_options are set, and
290 only once per class).
292 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
293 details on the dumping mechanism.
295 This can also be set at module import time via the import option
296 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
297 C</foo/bar> is the target directory.
301 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
302 # hardcoded in the class itself:
303 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
305 # Same, but no hard-coded connection, so we must provide one:
306 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
308 # Or as a class method, as long as you get it done *before* defining a
309 # connection on this schema class or any derived object:
311 My::Schema->dump_to_dir('/foo/bar');
312 My::Schema->connection(........);
314 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
318 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
319 My::Schema->connection(.......);
320 My::OtherSchema->connection(.......);
322 # Another alternative to the above:
323 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
326 My::Schema->connection(.......);
327 My::OtherSchema->connection(.......);
336 my $cpkg = (caller)[0];
338 foreach my $opt (@_) {
339 if($opt =~ m{^dump_to_dir:(.*)$}) {
340 $self->dump_to_dir($1)
342 elsif($opt eq 'make_schema_at') {
344 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
346 elsif($opt eq 'naming') {
348 *{"${cpkg}::naming"} = sub { $self->naming(@_) };
350 elsif($opt eq 'use_namespaces') {
352 *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) };
357 =head2 make_schema_at
361 =item Arguments: $schema_class_name, \%loader_options, \@connect_info
363 =item Return Value: $schema_class_name
367 This function creates a DBIx::Class schema from an existing RDBMS
368 schema. With the C<dump_directory> option, generates a set of
369 DBIx::Class classes from an existing database schema read from the
370 given dsn. Without a C<dump_directory>, creates schema classes in
371 memory at runtime without generating on-disk class files.
373 For a complete list of supported loader_options, see
374 L<DBIx::Class::Schema::Loader::Base>
376 This function can be imported in the usual way, as illustrated in
379 # Simple example, creates as a new class 'New::Schema::Name' in
380 # memory in the running perl interpreter.
381 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
385 [ 'dbi:Pg:dbname="foo"','postgres' ],
388 # Inside a script, specifying a dump directory in which to write
390 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
393 { debug => 1, dump_directory => './lib' },
394 [ 'dbi:Pg:dbname="foo"','postgres' ],
400 my ($target, $opts, $connect_info) = @_;
404 @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
407 $target->loader_options($opts);
408 $target->connection(@$connect_info);
415 =item Return Value: @new_monikers
419 Re-scans the database for newly added tables since the initial
420 load, and adds them to the schema at runtime, including relationships,
421 etc. Does not process drops or changes.
423 Returns a list of the new monikers added.
427 sub rescan { my $self = shift; $self->_loader->rescan($self) }
433 =item Arguments: \%opts | $ver
437 Controls the naming options for backward compatibility, see
438 L<DBIx::Class::Schema::Loader::Base/naming> for details.
440 To upgrade a dynamic schema, use:
442 __PACKAGE__->naming('current');
444 Can be imported into your dump script and called as a function as well:
448 =head2 use_namespaces
456 Controls the use_namespaces options for backward compatibility, see
457 L<DBIx::Class::Schema::Loader::Base/use_namespaces> for details.
459 To upgrade a dynamic schema, use:
461 __PACKAGE__->use_namespaces(1);
463 Can be imported into your dump script and called as a function as well:
469 =head2 Multiple Database Schemas
471 Currently the loader is limited to working within a single schema
472 (using the underlying RDBMS's definition of "schema"). If you have a
473 multi-schema database with inter-schema relationships (which is easy
474 to do in PostgreSQL or DB2 for instance), you currently can only
475 automatically load the tables of one schema, and relationships to
476 tables in other schemas will be silently ignored.
478 At some point in the future, an intelligent way around this might be
479 devised, probably by allowing the C<db_schema> option to be an
480 arrayref of schemas to load.
482 In "normal" L<DBIx::Class::Schema> usage, manually-defined
483 source classes and relationships have no problems crossing vendor schemas.
485 =head1 ACKNOWLEDGEMENTS
487 Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
488 in a bug report or suggestion.
490 Based on L<DBIx::Class::Loader> by Sebastian Riedel
492 Based upon the work of IKEBE Tomohiro
496 blblack: Brandon Black <blblack@gmail.com>
500 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
502 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
504 ash: Ash Berlin <ash@cpan.org>
506 Caelum: Rafael Kitover <rkitover@cpan.org>
508 TSUNODA Kazuya <drk@drk7.jp>
510 rbo: Robert Bohne <rbo@cpan.org>
512 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
514 gugu: Andrey Kostenko <a.kostenko@rambler-co.ru>
516 jhannah: Jay Hannah <jay@jays.net>
518 rbuels: Robert Buels <rmb32@cornell.edu>
520 timbunce: Tim Bunce <timb@cpan.org>
522 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
524 kane: Jos Boumans <kane@cpan.org>
526 waawaamilk: Nigel McNie <nigel@mcnie.name>
528 acmoore: Andrew Moore <amoore@cpan.org>
530 bphillips: Brian Phillips <bphillips@cpan.org>
532 ... and lots of other folks. If we forgot you, please write the current
535 =head1 COPYRIGHT & LICENSE
537 Copyright (c) 2006 - 2009 by the aforementioned
538 L<DBIx::Class::Schema::Loader/AUTHOR> and
539 L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
541 This library is free software; you can redistribute it and/or modify it under
542 the same terms as Perl itself.
546 L<DBIx::Class>, L<DBIx::Class::Manual::ExampleSchema>