1 package DBIx::Class::Schema::Loader;
6 use vars qw($VERSION @ISA);
7 use UNIVERSAL::require;
9 # Always remember to do all digits for the version even if they're 0
10 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
11 # brain damage and presumably various other packaging systems too
17 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
22 use base qw/DBIx::Class::Schema::Loader/;
24 __PACKAGE__->load_from_connection(
25 dsn => "dbi:mysql:dbname",
29 additional_classes => [qw/DBIx::Class::Foo/],
30 additional_base_classes => [qw/My::Stuff/],
31 left_base_classes => [qw/DBIx::Class::Bar/],
32 constraint => '^foo.*',
34 options => { AutoCommit => 1 },
35 inflect => { child => 'children' },
39 # in seperate application code ...
43 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
45 my $schema1 = My::Schema->connect();
46 # ^^ defaults to dsn/user/pass from load_from_connection()
50 DBIx::Class::Schema::Loader automate the definition of a
51 DBIx::Class::Schema by scanning table schemas and setting up
52 columns and primary keys.
54 DBIx::Class::Schema::Loader supports MySQL, Postgres, SQLite and DB2. See
55 L<DBIx::Class::Schema::Loader::Generic> for more, and
56 L<DBIx::Class::Schema::Loader::Writing> for notes on writing your own
57 db-specific subclass for an unsupported db.
59 L<Class::DBI::Loader>, L<Class::DBI>, and L<DBIx::Class::Loader> are now
60 obsolete, use L<DBIx::Class> and this module instead. ;)
68 Example in Synopsis above demonstrates the available arguments. For
69 detailed information on the arguments, see the
70 L<DBIx::Class::Schema::Loader::Generic> documentation.
74 sub load_from_connection {
75 my ( $class, %args ) = @_;
77 foreach (qw/namespace dsn/) {
78 die qq/Argument $_ is required/ if ! $args{$_};
81 $args{namespace} =~ s/(.*)::$/$1/;
84 my ($driver) = $dsn =~ m/^dbi:(\w*?)(?:\((.*?)\))?:/i;
85 $driver = 'SQLite' if $driver eq 'SQLite2';
86 my $impl = "DBIx::Class::Schema::Loader::" . $driver;
89 die qq/Couldn't require loader class "$impl", "$UNIVERSAL::require::ERROR"/;
92 $class->_load_from_connection(%args);
97 Sebastian Riedel, C<sri@oook.de>
99 Based upon the work of IKEBE Tomohiro
103 Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton,
104 Randal Schwartz, Simon Flack and all the others who've helped.
108 This library is free software; you can redistribute it and/or modify it under
109 the same terms as Perl itself.