use strict;
use warnings;
+use DBIx::Class::DB;
-use base qw/Class::Data::Inheritable/;
use base qw/DBIx::Class/;
-__PACKAGE__->load_components(qw/Exception Componentised/);
+__PACKAGE__->load_components(qw/Exception/);
__PACKAGE__->mk_classdata('class_registrations' => {});
=head1 NAME
=head1 SYNOPSIS
- in My/Schema.pm
+in My/Schema.pm
package My::Schema;
__PACKAGE__->load_classes(qw/Foo Bar Baz/);
- in My/Schema/Foo.pm
+in My/Schema/Foo.pm
package My::Schema::Foo;
- use base qw/DBIx::Class::Core/;
+ use base qw/DBIx::Class/;
+ __PACKAGE__->load_components(qw/Core PK::Auto::Pg/); # for example
__PACKAGE__->table('foo');
...
- in My/DB.pm
+in My/DB.pm
use My::Schema;
My::Schema->compose_connection('My::DB', $dsn, $user, $pass, $attrs);
- then in app code
+then in app code
my @obj = My::DB::Foo->search({}); # My::DB::Foo isa My::Schema::Foo My::DB
=head1 DESCRIPTION
+Creates database classes based on a schema. This allows you to have more than
+one concurrent connection using the same database classes, by making
+subclasses under a new namespace for each connection. If you only need one
+class, you should probably use L<DBIx::Class::DB> directly instead.
+
+NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS>
+carefully as DBIx::Class does things a little differently. Note in
+particular which module inherits off which.
+
=head1 METHODS
=over 4
=item register_class <component> <component_class>
Registers the class in the schema's class_registrations. This is a hash
-containing components, and their representative classes. It's used by
+containing database classes, keyed by their monikers. It's used by
compose_connection to create/modify all the existing database classes.
=cut
=item load_classes [<classes>}
-Uses L<Module::Find> to find all components, unless specified explicitly.
-Then it loads the component (using L<use>), and registers them (using
-B<register_class>
+Uses L<Module::Find> to find all classes under the database class' namespace,
+or uses the classes you select. Then it loads the component (using L<use>),
+and registers them (using B<register_class>);
=cut
}
}
-=item compose_connection
+=item compose_connection <target> <@db_info>
+
+This is the most important method in this class. it takes a target namespace,
+as well as dbh connection info, and creates a L<DBIx::Class::DB> class as
+well as subclasses for each of your database classes in this namespace, using
+this connection.
+
+It will also setup a ->table method on the target class, which lets you
+resolve database classes based on the schema component name, for example
+
+ MyApp::DB->table('Foo') # returns MyApp::DB::Foo,
+ # which ISA MyApp::Schema::Foo
+
+This is the recommended API for accessing Schema generated classes, and
+using it might give you instant advantages with future versions of DBIC.
=cut
my %map;
while (my ($comp, $comp_class) = each %reg) {
my $target_class = "${target}::${comp}";
- $class->inject_base($target_class, $conn_class, $comp_class);
+ $class->inject_base($target_class, $comp_class, $conn_class);
$target_class->table($comp_class->table);
@map{$comp, $comp_class} = ($target_class, $target_class);
}
=item setup_connection_class <$target> <@info>
+Sets up a database connection class to inject between the schema
+and the subclasses the schema creates.
+
=cut
sub setup_connection_class {
my ($class, $target, @info) = @_;
- $class->inject_base($target => 'DBIx::Class');
- $target->load_components('DB');
+ $class->inject_base($target => 'DBIx::Class::DB');
+ #$target->load_components('DB');
$target->connection(@info);
}