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->_loader_args(\%args);
153 my $class = ref $self || $self;
155 my $args = $self->_loader_args;
157 # set up the schema/schema_class arguments
158 $args->{schema} = $self;
159 $args->{schema_class} = $class;
160 weaken($args->{schema}) if ref $self;
161 $args->{dump_directory} ||= $self->dump_to_dir;
162 $args->{naming} = $self->naming if $self->naming;
163 $args->{use_namespaces} = $self->use_namespaces if $self->use_namespaces;
165 # XXX this only works for relative storage_type, like ::DBI ...
166 my $impl = $self->loader_class
167 || "DBIx::Class::Schema::Loader" . $self->storage_type;
168 $impl = "DBIx::Class::Schema::Loader${impl}" if $impl =~ /^::/;
169 eval { $self->ensure_class_loaded($impl) };
170 croak qq/Could not load storage_type loader "$impl": "$@"/ if $@;
172 $self->_loader($impl->new(%$args));
173 $self->_loader->load;
174 $self->_loader_invoked(1);
183 =item Arguments: @args
185 =item Return Value: $new_schema
189 See L<DBIx::Class::Schema/connection> for basic usage.
191 If the final argument is a hashref, and it contains the keys C<loader_options>
192 or C<loader_class>, those keys will be deleted, and their values value will be
193 used for the loader options or class, respectively, just as if set via the
194 L</loader_options> or L</loader_class> methods above.
196 The actual auto-loading operation (the heart of this module) will be invoked
197 as soon as the connection information is defined.
204 if($_[-1] && ref $_[-1] eq 'HASH') {
205 for my $option (qw/ loader_class loader_options result_base_class schema_base_class/) {
206 if(my $value = delete $_[-1]->{$option}) {
207 $self->$option($value);
210 pop @_ if !keys %{$_[-1]};
213 $self = $self->next::method(@_);
215 my $class = ref $self || $self;
216 if(!$class->_loader_invoked) {
217 $self->_invoke_loader
225 See L<DBIx::Class::Schema/clone>.
232 my $clone = $self->next::method(@_);
234 if($clone->_loader_args) {
235 $clone->_loader_args->{schema} = $clone;
236 weaken($clone->_loader_args->{schema});
246 =item Argument: $directory
250 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
251 or any derived schema class will cause all schemas to dump
252 manual versions of themselves to the named directory when they are
253 loaded. In order to be effective, this must be set before defining a
254 connection on this schema class or any derived object (as the loading
255 happens as soon as both a connection and loader_options are set, and
256 only once per class).
258 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
259 details on the dumping mechanism.
261 This can also be set at module import time via the import option
262 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
263 C</foo/bar> is the target directory.
267 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
268 # hardcoded in the class itself:
269 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
271 # Same, but no hard-coded connection, so we must provide one:
272 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
274 # Or as a class method, as long as you get it done *before* defining a
275 # connection on this schema class or any derived object:
277 My::Schema->dump_to_dir('/foo/bar');
278 My::Schema->connection(........);
280 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
284 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
285 My::Schema->connection(.......);
286 My::OtherSchema->connection(.......);
288 # Another alternative to the above:
289 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
292 My::Schema->connection(.......);
293 My::OtherSchema->connection(.......);
302 my $cpkg = (caller)[0];
304 foreach my $opt (@_) {
305 if($opt =~ m{^dump_to_dir:(.*)$}) {
306 $self->dump_to_dir($1)
308 elsif($opt eq 'make_schema_at') {
310 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
312 elsif($opt eq 'naming') {
314 *{"${cpkg}::naming"} = sub { $self->naming(@_) };
316 elsif($opt eq 'use_namespaces') {
318 *{"${cpkg}::use_namespaces"} = sub { $self->use_namespaces(@_) };
323 =head2 make_schema_at
327 =item Arguments: $schema_class_name, \%loader_options, \@connect_info
329 =item Return Value: $schema_class_name
333 This function creates a DBIx::Class schema from an existing RDBMS
334 schema. With the C<dump_directory> option, generates a set of
335 DBIx::Class classes from an existing database schema read from the
336 given dsn. Without a C<dump_directory>, creates schema classes in
337 memory at runtime without generating on-disk class files.
339 For a complete list of supported loader_options, see
340 L<DBIx::Class::Schema::Loader::Base>
342 This function can be imported in the usual way, as illustrated in
345 # Simple example, creates as a new class 'New::Schema::Name' in
346 # memory in the running perl interpreter.
347 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
351 [ 'dbi:Pg:dbname="foo"','postgres' ],
354 # Inside a script, specifying a dump directory in which to write
356 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
359 { debug => 1, dump_directory => './lib' },
360 [ 'dbi:Pg:dbname="foo"','postgres' ],
366 my ($target, $opts, $connect_info) = @_;
370 @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
373 $target->loader_options($opts);
374 $target->connection(@$connect_info);
381 =item Return Value: @new_monikers
385 Re-scans the database for newly added tables since the initial
386 load, and adds them to the schema at runtime, including relationships,
387 etc. Does not process drops or changes.
389 Returns a list of the new monikers added.
393 sub rescan { my $self = shift; $self->_loader->rescan($self) }
399 =item Arguments: \%opts | $ver
403 Controls the naming options for backward compatibility, see
404 L<DBIx::Class::Schema::Loader::Base/naming> for details.
406 To upgrade a dynamic schema, use:
408 __PACKAGE__->naming('current');
410 Can be imported into your dump script and called as a function as well:
414 =head2 use_namespaces
422 Controls the use_namespaces options for backward compatibility, see
423 L<DBIx::Class::Schema::Loader::Base/use_namespaces> for details.
425 To upgrade a dynamic schema, use:
427 __PACKAGE__->use_namespaces(1);
429 Can be imported into your dump script and called as a function as well:
435 =head2 Multiple Database Schemas
437 Currently the loader is limited to working within a single schema
438 (using the underlying RDBMS's definition of "schema"). If you have a
439 multi-schema database with inter-schema relationships (which is easy
440 to do in PostgreSQL or DB2 for instance), you currently can only
441 automatically load the tables of one schema, and relationships to
442 tables in other schemas will be silently ignored.
444 At some point in the future, an intelligent way around this might be
445 devised, probably by allowing the C<db_schema> option to be an
446 arrayref of schemas to load.
448 In "normal" L<DBIx::Class::Schema> usage, manually-defined
449 source classes and relationships have no problems crossing vendor schemas.
451 =head1 ACKNOWLEDGEMENTS
453 Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
454 in a bug report or suggestion.
456 Based on L<DBIx::Class::Loader> by Sebastian Riedel
458 Based upon the work of IKEBE Tomohiro
462 blblack: Brandon Black <blblack@gmail.com>
466 ilmari: Dagfinn Ilmari MannsE<aring>ker <ilmari@ilmari.org>
468 arcanez: Justin Hunter <justin.d.hunter@gmail.com>
470 ash: Ash Berlin <ash@cpan.org>
472 Caelum: Rafael Kitover <rkitover@cpan.org>
474 TSUNODA Kazuya <drk@drk7.jp>
476 rbo: Robert Bohne <rbo@cpan.org>
478 ribasushi: Peter Rabbitson <ribasushi@cpan.org>
480 gugu: Andrey Kostenko <a.kostenko@rambler-co.ru>
482 jhannah: Jay Hannah <jay@jays.net>
484 rbuels: Robert Buels <rmb32@cornell.edu>
486 timbunce: Tim Bunce <timb@cpan.org>
488 mst: Matt S. Trout <mst@shadowcatsystems.co.uk>
490 kane: Jos Boumans <kane@cpan.org>
492 waawaamilk: Nigel McNie <nigel@mcnie.name>
494 acmoore: Andrew Moore <amoore@cpan.org>
496 bphillips: Brian Phillips <bphillips@cpan.org>
498 ... and lots of other folks. If we forgot you, please write the current
501 =head1 COPYRIGHT & LICENSE
503 Copyright (c) 2006 - 2009 by the aforementioned
504 L<DBIx::Class::Schema::Loader/AUTHOR> and
505 L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
507 This library is free software; you can redistribute it and/or modify it under
508 the same terms as Perl itself.
512 L<DBIx::Class>, L<DBIx::Class::Manual::ExampleSchema>