1 package DBIx::Class::Schema::Loader;
5 use base qw/DBIx::Class::Schema/;
6 use base qw/Class::Data::Accessor/;
8 use UNIVERSAL::require;
10 use Data::Dump qw/ dump /;
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.02999_10';
17 __PACKAGE__->mk_classaccessor('dump_to_dir');
18 __PACKAGE__->mk_classaccessor('loader');
19 __PACKAGE__->mk_classaccessor('_loader_args');
23 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
28 use base qw/DBIx::Class::Schema::Loader/;
30 __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);
44 DBIx::Class::Schema::Loader automates the definition of a
45 L<DBIx::Class::Schema> by scanning database table definitions and
46 setting up the columns and primary keys.
48 DBIx::Class::Schema::Loader currently supports DBI for MySQL,
49 Postgres, SQLite and DB2.
51 See L<DBIx::Class::Schema::Loader::DBI::Writing> for notes on writing
52 your own vendor-specific subclass for an unsupported DBD driver.
54 This module requires L<DBIx::Class> 0.06 or later, and obsoletes
55 the older L<DBIx::Class::Loader>.
57 This module is designed more to get you up and running quickly against
58 an existing database, or to be effective for simple situations, rather
59 than to be what you use in the long term for a complex database/project.
61 That being said, transitioning your code from a Schema generated by this
62 module to one that doesn't use this module should be straightforward and
63 painless (as long as you're not using any methods that are now deprecated
64 in this document), so don't shy away from it just for fears of the
65 transition down the road.
71 Example in Synopsis above demonstrates a few common arguments. For
72 detailed information on all of the arguments, most of which are
73 only useful in fairly complex scenarios, see the
74 L<DBIx::Class::Schema::Loader::Base> documentation.
76 This method is *required*, for backwards compatibility reasons. If
77 you do not wish to change any options, just call it with an empty
78 argument list during schema class initialization.
86 if(ref $_[0] eq 'HASH') {
93 my $class = ref $self || $self;
94 $args{schema} = $self;
95 $args{schema_class} = $class;
96 $self->_loader_args(\%args);
97 $self->_invoke_loader if $self->storage && !$class->loader;
104 my $class = ref $self || $self;
106 $self->_loader_args->{dump_directory} ||= $self->dump_to_dir;
108 # XXX this only works for relative storage_type, like ::DBI ...
109 my $impl = "DBIx::Class::Schema::Loader" . $self->storage_type;
111 croak qq/Could not load storage_type loader "$impl": / .
112 qq/"$UNIVERSAL::require::ERROR"/;
114 # XXX in the future when we get rid of ->loader, the next two
115 # lines can be replaced by "$impl->new(%{$self->_loader_args})->load;"
116 $class->loader($impl->new(%{$self->_loader_args}));
117 $class->loader->load;
125 See L<DBIx::Class::Schema>. Our local override here is to
126 hook in the main functionality of the loader, which occurs at the time
127 the connection is specified for a given schema class/object.
132 my $self = shift->next::method(@_);
134 my $class = ref $self || $self;
135 $self->_invoke_loader if $self->_loader_args && !$class->loader;
142 See L<DBIx::Class::Schema>. Our local override here is to
143 make sure cloned schemas can still be loaded at runtime by
144 copying and altering a few things here.
151 my $clone = $self->next::method(@_);
153 $clone->_loader_args($self->_loader_args);
154 $clone->_loader_args->{schema} = $clone;
161 Argument: directory name.
163 Calling this as a class method on either L<DBIx::Class::Schema::Loader>
164 or any derived schema class will cause all affected schemas to dump
165 manual versions of themselves to the named directory when they are
166 loaded. In order to be effective, this must be set before defining a
167 connection on this schema class or any derived object (as the loading
168 happens at connection time, and only once per class).
170 See L<DBIx::Class::Schema::Loader::Base/dump_directory> for more
171 details on the dumping mechanism.
173 This can also be set at module import time via the import option
174 C<dump_to_dir:/foo/bar> to L<DBIx::Class::Schema::Loader>, where
175 C</foo/bar> is the target directory.
179 # My::Schema isa DBIx::Class::Schema::Loader, and has connection info
180 # hardcoded in the class itself:
181 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e1
183 # Same, but no hard-coded connection, so we must provide one:
184 perl -MDBIx::Class::Schema::Loader=dump_to_dir:/foo/bar -MMy::Schema -e 'My::Schema->connection("dbi:Pg:dbname=foo", ...)'
186 # Or as a class method, as long as you get it done *before* defining a
187 # connection on this schema class or any derived object:
189 My::Schema->dump_to_dir('/foo/bar');
190 My::Schema->connection(........);
192 # Or as a class method on the DBIx::Class::Schema::Loader itself, which affects all
196 DBIx::Class::Schema::Loader->dump_to_dir('/foo/bar');
197 My::Schema->connection(.......);
198 My::OtherSchema->connection(.......);
200 # Another alternative to the above:
201 use DBIx::Class::Schema::Loader qw| dump_to_dir:/foo/bar |;
204 My::Schema->connection(.......);
205 My::OtherSchema->connection(.......);
212 foreach my $opt (@_) {
213 if($opt =~ m{^dump_to_dir:(.*)$}) {
214 $self->dump_to_dir($1)
216 elsif($opt eq 'make_schema_at') {
218 my $cpkg = (caller)[0];
219 *{"${cpkg}::make_schema_at"} = \&make_schema_at;
224 =head2 make_schema_at
226 This simple function allows one to create a Loader-based schema
227 in-memory on the fly without any on-disk class files of any
228 kind. When used with the C<dump_directory> option, you can
229 use this to generate a rought draft manual schema from a dsn
230 without the intermediate step of creating a physical Loader-based
233 This function can be exported/imported by the normal means, as
234 illustrated in these Examples:
237 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
240 { relationships => 1, debug => 1 },
241 [ 'dbi:Pg:dbname="foo"','postgres' ],
244 # Complex: dump loaded schema to disk, all from the commandline:
245 perl -MDBIx::Class::Schema::Loader=make_schema_at,dump_to_dir:./lib -e 'make_schema_at("New::Schema::Name", { relationships => 1 }, [ 'dbi:Pg:dbname="foo"','postgres' ])'
247 # Same, but inside a script, and using a different way to specify the
249 use DBIx::Class::Schema::Loader qw/ make_schema_at /;
252 { relationships => 1, debug => 1, dump_directory => './lib' },
253 [ 'dbi:Pg:dbname="foo"','postgres' ],
259 my ($target, $opts, $connect_info) = @_;
261 my $opts_dumped = dump($opts);
262 my $cinfo_dumped = dump(@$connect_info);
265 use base qw/DBIx::Class::Schema::Loader/;
266 __PACKAGE__->loader_options($opts_dumped);
267 __PACKAGE__->connection($cinfo_dumped);
273 Using the example in L<DBIx::Class::Manual::ExampleSchema> as a basis
274 replace the DB::Main with the following code:
278 use base qw/DBIx::Class::Schema::Loader/;
280 __PACKAGE__->loader_options(
284 __PACKAGE__->connection('dbi:SQLite:example.db');
288 and remove the Main directory tree (optional). Every thing else
291 =head1 DEPRECATED METHODS
293 You don't need to read anything in this section unless you're upgrading
294 code that was written against pre-0.03 versions of this module. This
295 version is intended to be backwards-compatible with pre-0.03 code, but
296 will issue warnings about your usage of deprecated features/methods.
298 =head2 load_from_connection
300 This deprecated method is now roughly an alias for L</loader_options>.
302 In the past it was a common idiom to invoke this method
303 after defining a connection on the schema class. That usage is now
304 deprecated. The correct way to do things from now forward is to
305 always do C<loader_options> on the class before C<connect> or
306 C<connection> is invoked on the class or any derived object.
308 This method *will* dissappear in a future version.
310 For now, using this method will invoke the legacy behavior for
311 backwards compatibility, and merely emit a warning about upgrading
314 It also reverts the default inflection scheme to
315 use L<Lingua::EN::Inflect> just like pre-0.03 versions of this
318 You can force these legacy inflections with the
319 option C<legacy_default_inflections>, even after switch over
320 to the preferred L</loader_options> way of doing things.
322 See the source of this method for more details.
326 sub load_from_connection {
327 my ($self, %args) = @_;
328 warn 'load_from_connection deprecated, please [re-]read the'
329 . ' [new] DBIx::Class::Schema::Loader documentation';
331 # Support the old connect_info / dsn / etc args...
332 $args{connect_info} = [
335 delete $args{password},
336 delete $args{options},
339 $self->connection(@{delete $args{connect_info}})
340 if $args{connect_info};
342 $self->loader_options('legacy_default_inflections' => 1, %args);
347 This is an accessor in the generated Schema class for accessing
348 the L<DBIx::Class::Schema::Loader::Base> -based loader object
349 that was used during construction. See the
350 L<DBIx::Class::Schema::Loader::Base> docs for more information
351 on the available loader methods there.
353 This accessor is deprecated. Do not use it. Anything you can
354 get from C<loader>, you can get via the normal L<DBIx::Class::Schema>
355 methods, and your code will be more robust and forward-thinking
358 If you're already using C<loader> in your code, make an effort
359 to get rid of it. If you think you've found a situation where it
360 is neccesary, let me know and we'll see what we can do to remedy
363 In some future version, this accessor *will* disappear. It was
364 apparently quite a design/API mistake to ever have exposed it to
365 user-land in the first place, all things considered.
369 =head2 Multiple Database Schemas
371 Currently the loader is limited to working within a single schema
372 (using the database vendors' definition of "schema"). If you
373 have a multi-schema database with inter-schema relationships (which
374 is easy to do in Postgres or DB2 for instance), you only get to
375 automatically load the tables of one schema, and any relationships
376 to tables in other schemas will be silently ignored.
378 At some point in the future, an intelligent way around this might be
379 devised, probably by allowing the C<db_schema> option to be an
380 arrayref of schemas to load, or perhaps even offering schema
381 constraint/exclusion options just like the table ones.
383 In "normal" L<DBIx::Class::Schema> usage, manually-defined
384 source classes and relationships have no problems crossing vendor schemas.
388 Brandon Black, C<blblack@gmail.com>
390 Based on L<DBIx::Class::Loader> by Sebastian Riedel
392 Based upon the work of IKEBE Tomohiro
396 Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton,
397 Randal Schwartz, Simon Flack, Matt S Trout, everyone on #dbix-class, and
398 all the others who've helped.
402 This library is free software; you can redistribute it and/or modify it under
403 the same terms as Perl itself.
407 L<DBIx::Class>, L<DBIx::Class::Manual::ExampleSchema>