1 package DBIx::Class::Schema::Loader;
6 use UNIVERSAL::require;
8 use base qw/DBIx::Class::Schema/;
9 use base qw/Class::Data::Accessor/;
11 __PACKAGE__->mk_classaccessor('loader');
13 use vars qw($VERSION);
15 # Always remember to do all digits for the version even if they're 0
16 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
17 # brain damage and presumably various other packaging systems too
22 DBIx::Class::Schema::Loader - Dynamic definition of a DBIx::Class::Schema
27 use base qw/DBIx::Class::Schema::Loader/;
29 __PACKAGE__->load_from_connection(
30 dsn => "dbi:mysql:dbname",
33 additional_classes => [qw/DBIx::Class::Foo/],
34 additional_base_classes => [qw/My::Stuff/],
35 left_base_classes => [qw/DBIx::Class::Bar/],
36 constraint => '^foo.*',
38 options => { AutoCommit => 1 },
39 inflect => { child => 'children' },
43 # in seperate application code ...
47 my $schema1 = My::Schema->connect( $dsn, $user, $password, $attrs);
49 my $schema1 = "My::Schema";
50 # ^^ defaults to dsn/user/pass from load_from_connection()
52 # Get a list of the original (database) names of the tables that
54 my @tables = $schema1->loader->tables;
56 # Get a hashref of table_name => 'TableName' table-to-moniker
58 my $monikers = $schema1->loader->monikers;
60 # Get a hashref of table_name => 'My::Schema::TableName'
61 # table-to-classname mappings.
62 my $classes = $schema1->loader->classes;
64 # Use the schema as per normal for L<DBIx::Class::Schema>
65 my $rs = $schema1->resultset($monikers->{table_table})->search(...);
69 THIS IS A DEVELOPMENT RELEASE. This is 0.01000, the first public
70 release. Expect things to be broken in various ways. Expect the
71 entire design to be fatally flawed. Expect the interfaces to change if
72 it becomes neccessary. It's mostly here for people to poke at it and
73 find the flaws in it. 0.02 will hopefully have some sanity when we get
76 DBIx::Class::Schema::Loader automates the definition of a
77 DBIx::Class::Schema by scanning table schemas and setting up
78 columns and primary keys.
80 DBIx::Class::Schema::Loader supports MySQL, Postgres, SQLite and DB2. See
81 L<DBIx::Class::Schema::Loader::Generic> for more, and
82 L<DBIx::Class::Schema::Loader::Writing> for notes on writing your own
83 db-specific subclass for an unsupported db.
85 This module requires DBIx::Class::Loader 0.5 or later, and obsoletes
86 L<DBIx::Class::Loader> for L<DBIx::Class> version 0.5 and later.
92 =head2 load_from_connection
94 Example in Synopsis above demonstrates the available arguments. For
95 detailed information on the arguments, see the
96 L<DBIx::Class::Schema::Loader::Generic> documentation.
100 sub load_from_connection {
101 my ( $class, %args ) = @_;
103 croak 'dsn argument is required' if ! $args{dsn};
104 my $dsn = $args{dsn};
105 my ($driver) = $dsn =~ m/^dbi:(\w*?)(?:\((.*?)\))?:/i;
106 $driver = 'SQLite' if $driver eq 'SQLite2';
107 my $impl = "DBIx::Class::Schema::Loader::" . $driver;
110 croak qq/Couldn't require loader class "$impl",/ .
111 qq/"$UNIVERSAL::require::ERROR"/;
113 $args{schema} = $class;
115 $class->loader($impl->new(%args));
116 $class->loader->load;
121 Brandon Black, C<bblack@gmail.com>
123 Based on L<DBIx::Class::Loader> by Sebastian Riedel
125 Based upon the work of IKEBE Tomohiro
129 Adam Anderson, Andy Grundman, Autrijus Tang, Dan Kubb, David Naughton,
130 Randal Schwartz, Simon Flack and all the others who've helped.
134 This library is free software; you can redistribute it and/or modify it under
135 the same terms as Perl itself.