1 package DBIx::Class::Schema::Loader;
7 use vars qw($VERSION @ISA);
8 use UNIVERSAL::require;
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
18 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
23 use base qw/DBIx::Class::Schema::Loader/;
25 __PACKAGE__->load_from_connection(
26 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";
46 # ^^ defaults to dsn/user/pass from load_from_connection()
50 DBIx::Class::Schema::Loader automates 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 This module requires DBIx::Class::Loader 0.5 or later, and obsoletes
60 L<DBIx::Class::Loader> for L<DBIx::Class> version 0.5 and later.
66 =head2 load_from_connection
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 croak 'dsn argument is required' if ! $args{dsn};
80 my ($driver) = $dsn =~ m/^dbi:(\w*?)(?:\((.*?)\))?:/i;
81 $driver = 'SQLite' if $driver eq 'SQLite2';
82 my $impl = "DBIx::Class::Schema::Loader::" . $driver;
85 croak qq/Couldn't require loader class "$impl",/ .
86 qq/"$UNIVERSAL::require::ERROR"/;
89 $class->_load_from_connection(%args);
94 Brandon Black, C<bblack@gmail.com>
96 Sebastian Riedel, C<sri@oook.de> (DBIx::Class::Loader, which this module is branched from)
98 Based upon the work of IKEBE Tomohiro
102 Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton,
103 Randal Schwartz, Simon Flack and all the others who've helped.
107 This library is free software; you can redistribute it and/or modify it under
108 the same terms as Perl itself.