1 package DBIx::Class::Schema::Loader;
5 use base qw/DBIx::Class::Schema/;
6 use base qw/Class::Data::Accessor/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use UNIVERSAL::require;
10 use Scalar::Util qw/ weaken /;
12 # Always remember to do all digits for the version even if they're 0
13 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
14 # brain damage and presumably various other packaging systems too
15 our $VERSION = '0.03999_01';
17 __PACKAGE__->mk_classaccessor('dump_to_dir');
18 __PACKAGE__->mk_classaccessor('_loader_args' => {});
19 __PACKAGE__->mk_classaccessor('_loader_invoked');
20 __PACKAGE__->mk_classaccessor('_loader');
24 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
29 use base qw/DBIx::Class::Schema::Loader/;
31 __PACKAGE__->loader_options(
32 constraint => '^foo.*',
36 # in seperate application code ...
40 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
42 my $schema1 = "My::Schema"; $schema1->connection(as above);
46 DBIx::Class::Schema::Loader automates the definition of a
47 L<DBIx::Class::Schema> by scanning database table definitions and
48 setting up the columns, primary keys, and relationships.
50 DBIx::Class::Schema::Loader currently supports only the DBI storage type.
51 It has explicit support for L<DBD::Pg>, L<DBD::mysql>, L<DBD::DB2>, and
52 L<DBD::SQLite>. Other DBI drivers may function to a greater or lesser
53 degree with this loader, depending on how much of the DBI spec they
54 implement, and how standard their implementation is. Patches to make
55 other DBDs work correctly welcome.
57 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
58 your own vendor-specific subclass for an unsupported DBD driver.
60 This module requires L<DBIx::Class> 0.06 or later, and obsoletes
61 the older L<DBIx::Class::Loader>.
63 This module is designed more to get you up and running quickly against
64 an existing database, or to be effective for simple situations, rather
65 than to be what you use in the long term for a complex database/project.
67 That being said, transitioning your code from a Schema generated by this
68 module to one that doesn't use this module should be straightforward and
69 painless, so don't shy away from it just for fears of the transition down
76 Example in Synopsis above demonstrates a few common arguments. For
77 detailed information on all of the arguments, most of which are
78 only useful in fairly complex scenarios, see the
79 L<DBIx::Class::Schema::Loader::Base> documentation.
81 One must call C<loader_options> before any connection is made,
82 or embed the C<loader_options> in the connection information itself
83 as shown below. Setting C<loader_options> after the connection has
84 already been made is useless.
91 my %args = (ref $_[0] eq 'HASH') ? %{$_[0]} : @_;
92 $self->_loader_args(\%args);
99 my $class = ref $self || $self;
101 my $args = $self->_loader_args;
103 # set up the schema/schema_class arguments
104 $args->{schema} = $self;
105 $args->{schema_class} = $class;
106 weaken($args->{schema}) if ref $self;
107 $args->{dump_directory} ||= $self->dump_to_dir;
109 # XXX this only works for relative storage_type, like ::DBI ...
110 my $impl = "DBIx::Class::Schema::Loader" . $self->storage_type;
112 croak qq/Could not load storage_type loader "$impl": / .
113 qq/"$UNIVERSAL::require::ERROR"/;
115 $self->_loader($impl->new(%$args));
116 $self->_loader->load;
117 $self->_loader_invoked(1);
124 See L<DBIx::Class::Schema> for basic usage.
126 If the final argument is a hashref, and it contains a key C<loader_options>,
127 that key will be deleted, and its value will be used for the loader options,
128 just as if set via the L</loader_options> method above.
130 The actual auto-loading operation (the heart of this module) will be invoked
131 as soon as the connection information is defined.
138 if($_[-1] && ref $_[-1] eq 'HASH') {
139 if(my $loader_opts = delete $_[-1]->{loader_options}) {
140 $self->loader_options($loader_opts);
141 pop @_ if !keys %{$_[-1]};
145 $self = $self->next::method(@_);
147 my $class = ref $self || $self;
148 if(!$class->_loader_invoked) {
149 $self->_invoke_loader
157 See L<DBIx::Class::Schema>.
164 my $clone = $self->next::method(@_);
166 if($clone->_loader_args) {
167 $clone->_loader_args->{schema} = $clone;
168 weaken($clone->_loader_args->{schema});
176 Argument: directory name.
178 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
179 or any derived schema class will cause all affected schemas to dump
180 manual versions of themselves to the named directory when they are
181 loaded. In order to be effective, this must be set before defining a
182 connection on this schema class or any derived object (as the loading
183 happens as soon as both a connection and loader_options are set, and
184 only once per class).
186 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
187 details on the dumping mechanism.
189 This can also be set at module import time via the import option
190 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
191 C</foo/bar> is the target directory.
195 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
196 # hardcoded in the class itself:
197 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
199 # Same, but no hard-coded connection, so we must provide one:
200 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
202 # Or as a class method, as long as you get it done *before* defining a
203 # connection on this schema class or any derived object:
205 My::Schema->dump_to_dir('/foo/bar');
206 My::Schema->connection(........);
208 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
212 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
213 My::Schema->connection(.......);
214 My::OtherSchema->connection(.......);
216 # Another alternative to the above:
217 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
220 My::Schema->connection(.......);
221 My::OtherSchema->connection(.......);
228 foreach my $opt (@_) {
229 if($opt =~ m{^dump_to_dir:(.*)$}) {
230 $self->dump_to_dir($1)
232 elsif($opt eq 'make_schema_at') {
234 my $cpkg = (caller)[0];
235 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
240 =head2 make_schema_at
242 This simple function allows one to create a Loader-based schema
243 in-memory on the fly without any on-disk class files of any
244 kind. When used with the C<dump_directory> option, you can
245 use this to generate a rough draft manual schema from a dsn
246 without the intermediate step of creating a physical Loader-based
249 The return value is the input class name.
251 This function can be exported/imported by the normal means, as
252 illustrated in these Examples:
254 # Simple example, creates as a new class 'New::Schema::Name' in
255 # memory in the running perl interpreter.
256 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
260 [ 'dbi:Pg:dbname="foo"','postgres' ],
263 # Complex: dump loaded schema to disk, all from the commandline:
264 perl -MDBIx::Class::Schema::Loader=make_schema_at,dump_to_dir:./lib -e 'make_schema_at("New::Schema::Name", { debug => 1 }, [ "dbi:Pg:dbname=foo","postgres" ])'
266 # Same, but inside a script, and using a different way to specify the
268 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
271 { debug => 1, dump_directory => './lib' },
272 [ 'dbi:Pg:dbname="foo"','postgres' ],
278 my ($target, $opts, $connect_info) = @_;
282 @{$target . '::ISA'} = qw/DBIx::Class::Schema::Loader/;
285 $target->loader_options($opts);
286 $target->connection(@$connect_info);
291 Re-scans the database for newly added tables since the initial
292 load, and adds them to the schema at runtime, including relationships,
293 etc. Does not process drops or changes.
297 sub rescan { shift->_loader->rescan }
301 Using the example in L<DBIx::Class::Manual::ExampleSchema> as a basis
302 replace the DB::Main with the following code:
306 use base qw/DBIx::Class::Schema::Loader/;
308 __PACKAGE__->loader_options(
311 __PACKAGE__->connection('dbi:SQLite:example.db');
315 and remove the Main directory tree (optional). Every thing else
320 =head2 Multiple Database Schemas
322 Currently the loader is limited to working within a single schema
323 (using the database vendors' definition of "schema"). If you
324 have a multi-schema database with inter-schema relationships (which
325 is easy to do in PostgreSQL or DB2 for instance), you only get to
326 automatically load the tables of one schema, and any relationships
327 to tables in other schemas will be silently ignored.
329 At some point in the future, an intelligent way around this might be
330 devised, probably by allowing the C<db_schema> option to be an
331 arrayref of schemas to load.
333 In "normal" L<DBIx::Class::Schema> usage, manually-defined
334 source classes and relationships have no problems crossing vendor schemas.
338 Brandon Black, C<blblack@gmail.com>
340 Based on L<DBIx::Class::Loader> by Sebastian Riedel
342 Based upon the work of IKEBE Tomohiro
346 Matt S Trout, all of the #dbix-class folks, and everyone who's ever sent
347 in a bug report or suggestion.
351 This library is free software; you can redistribute it and/or modify it under
352 the same terms as Perl itself.
356 L<DBIx::Class>, L<DBIx::Class::Manual::ExampleSchema>