package Catalyst::Model::DBIC::Schema;
use strict;
+use warnings;
+
+our $VERSION = '0.22';
+
use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
use NEXT;
use UNIVERSAL::require;
use Carp;
+use Data::Dumper;
require DBIx::Class;
-our $VERSION = '0.14';
-
__PACKAGE__->mk_classaccessor('composed_schema');
__PACKAGE__->mk_accessors('schema');
package MyApp::Schema::FilmDB::Actor;
use base qw/DBIx::Class/
-
+
__PACKAGE__->load_components(qw/Core/);
__PACKAGE__->table('actor');
-
+
...
-and a Role in MyApp/Schema/Role.pm:
+and a Role in MyApp/Schema/FilmDB/Role.pm:
package MyApp::Schema::FilmDB::Role;
use base qw/DBIx::Class/
-
+
__PACKAGE__->load_components(qw/Core/);
__PACKAGE__->table('role');
-
+
...
Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's
package MyApp::Model::FilmDB;
use base qw/Catalyst::Model::DBIC::Schema/;
-
+
__PACKAGE__->config(
schema_class => 'MyApp::Schema::FilmDB',
connect_info => [
Authentication::Store::DBIC in MyApp.pm:
package MyApp;
-
+
use Catalyst qw/... Authentication::Store::DBIC/;
-
+
...
-
+
__PACKAGE__->config->{authentication}{dbic} = {
user_class => 'FilmDB::Actor',
user_field => 'name',
password_field => 'password'
}
-C<< $c->model() >> returns a L<DBIx::Class::ResultSet> for the source name
-parameter passed. To find out more about which methods can be called on a
-ResultSet, or how to add your own methods to it, please see the ResultSet
-documentation in the L<DBIx::Class> distribution.
+C<< $c->model('Schema::Source') >> returns a L<DBIx::Class::ResultSet> for
+the source name parameter passed. To find out more about which methods can
+be called on a ResultSet, or how to add your own methods to it, please see
+the ResultSet documentation in the L<DBIx::Class> distribution.
Some examples are given below:
- # to access schema methods directly:
- $c->model('FilmDB')->schema->source(...);
+ # to access schema methods directly:
+ $c->model('FilmDB')->schema->source(...);
- # to access the source object, resultset, and class:
- $c->model('FilmDB')->source(...);
- $c->model('FilmDB')->resultset(...);
- $c->model('FilmDB')->class(...);
+ # to access the source object, resultset, and class:
+ $c->model('FilmDB')->source(...);
+ $c->model('FilmDB')->resultset(...);
+ $c->model('FilmDB')->class(...);
- # For resultsets, there's an even quicker shortcut:
- $c->model('FilmDB::Actor')
- # is the same as $c->model('FilmDB')->resultset('Actor')
+ # For resultsets, there's an even quicker shortcut:
+ $c->model('FilmDB::Actor')
+ # is the same as $c->model('FilmDB')->resultset('Actor')
- # To get the composed schema for making new connections:
- my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
+ # To get the composed schema for making new connections:
+ my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
- # Or the same thing via a convenience shortcut:
- my $newconn = $c->model('FilmDB')->connect(...);
+ # Or the same thing via a convenience shortcut:
+ my $newconn = $c->model('FilmDB')->connect(...);
- # or, if your schema works on different storage drivers:
- my $newconn = $c->model('FilmDB')->composed_schema->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ # or, if your schema works on different storage drivers:
+ my $newconn = $c->model('FilmDB')->composed_schema->clone();
+ $newconn->storage_type('::LDAP');
+ $newconn->connection(...);
- # and again, a convenience shortcut
- my $newconn = $c->model('FilmDB')->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ # and again, a convenience shortcut
+ my $newconn = $c->model('FilmDB')->clone();
+ $newconn->storage_type('::LDAP');
+ $newconn->connection(...);
=head1 DESCRIPTION
This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
-the documentation for L<Catalyst::Helper::Model::DBIC::Schema> and
-L<Catalyst::Helper::Model::DBIC::SchemaLoader> for information
-on generating these Models via Helper scripts. The latter of the two
-will also generated a L<DBIx::Class::Schema::Loader>-based Schema class
-for you.
+the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
+information on generating these Models via Helper scripts.
+
+When your Catalyst app starts up, a thin Model layer is created as an
+interface to your DBIC Schema. It should be clearly noted that the model
+object returned by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or
+resultset object, but merely a wrapper proving L<methods|/METHODS> to access
+the underlying schema.
+
+In addition to this model class, a shortcut class is generated for each
+source in the schema, allowing easy and direct access to a resultset of the
+corresponding type. These generated classes are even thinner than the model
+class, providing no public methods but simply hooking into Catalyst's
+model() accessor via the
+L<ACCEPT_CONTEXT|Catalyst::Component/ACCEPT_CONTEXT> mechanism. The complete
+contents of each generated class is roughly equivalent to the following:
+
+ package MyApp::Model::FilmDB::Actor
+ sub ACCEPT_CONTEXT {
+ my ($self, $c) = @_;
+ $c->model('FilmDB')->resultset('Actor');
+ }
+
+In short, there are three techniques available for obtaining a DBIC
+resultset object:
+
+ # the long way
+ my $rs = $c->model('FilmDB')->schema->resultset('Actor');
+
+ # using the shortcut method on the model object
+ my $rs = $c->model('FilmDB')->resultset('Actor');
+
+ # using the generated class directly
+ my $rs = $c->model('FilmDB::Actor');
=head1 CONFIG PARAMETERS
=item connect_info
This is an arrayref of connection parameters, which are specific to your
-C<storage_type> (see your storage type documentation for more details).
+C<storage_type> (see your storage type documentation for more details).
+If you only need one parameter (e.g. the DSN), you can just pass a string
+instead of an arrayref.
This is not required if C<schema_class> already has connection information
defined inside itself (which isn't highly recommended, but can be done)
C<storage_type> in L<DBIx::Class> at the time of this writing, the
parameters are your dsn, username, password, and connect options hashref.
-If you need to specify the L<DBIx::Class::Storage::DBI> specific parameter
-C<on_connect_do>, or the related C<sql_maker> options C<limit_dialect>,
-C<quote_char>, or C<name_sep>, you can place these options into a hashref
-as the final element of the C<connect_info> arrayref. If in doubt, don't
-specify these options. You would know it if you needed them.
+See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
+of the arguments supported.
Examples:
- connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
-
- connect_info => [
- 'dbi:SQLite:dbname=foo.db',
- {
- on_connect_do => [
- 'PRAGMA synchronous = OFF',
- ],
- }
- ],
-
- connect_info => [
- 'dbi:Pg:dbname=mypgdb',
- 'postgres',
- '',
- { AutoCommit => 0 },
- {
- on_connect_do => [
- 'some SQL statement',
- 'another SQL statement',
- ],
- }
- ],
+ connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
+
+ connect_info => [
+ 'dbi:SQLite:dbname=foo.db',
+ {
+ on_connect_do => [
+ 'PRAGMA synchronous = OFF',
+ ],
+ }
+ ],
+
+ connect_info => [
+ 'dbi:Pg:dbname=mypgdb',
+ 'postgres',
+ '',
+ { AutoCommit => 0 },
+ {
+ on_connect_do => [
+ 'some SQL statement',
+ 'another SQL statement',
+ ],
+ }
+ ],
+
+Or using L<Config::General>:
+
+ <Model::FilmDB>
+ schema_class MyApp::Schema::FilmDB
+ connect_info dbi:Pg:dbname=mypgdb
+ connect_info postgres
+ connect_info
+ <connect_info>
+ AutoCommit 0
+ on_connect_do some SQL statement
+ on_connect_do another SQL statement
+ </connect_info>
+ </Model::FilmDB>
+
+or
+
+ <Model::FilmDB>
+ schema_class MyApp::Schema::FilmDB
+ connect_info dbi:SQLite:dbname=foo.db
+ </Model::FilmDB>
+
=item storage_type
}
else {
croak "Either ->config->{connect_info} must be defined for $class"
- . " or $schema_class must have connect info defined on it";
+ . " or $schema_class must have connect info defined on it."
+ . " Here's what we got:\n"
+ . Dumper($self);
}
}
$self->schema->storage_type($self->{storage_type})
if $self->{storage_type};
- # XXX This is temporary, until DBIx::Class::Storage::DBI supports the
- # same syntax and we switch our requisite to that version somewhere
- # down the line. This syntax is already committed into DBIx::Class
- # -current branch post-0.06.
- # At that time, this whole block can revert back to just being:
- # $self->schema->connection(@{$self->{connect_info}});
+ $self->schema->connection(
+ ref $self->{connect_info} eq 'ARRAY' ?
+ @{$self->{connect_info}} :
+ $self->{connect_info}
+ );
- my $connect_info = [ @{$self->{connect_info}} ];
- my ($on_connect_do, %sql_maker_opts);
- if($DBIx::Class::VERSION < 0.069) {
- my $used;
- my $last_info = $self->{connect_info}->[-1];
- if(ref $last_info eq 'HASH') {
- if($on_connect_do = $last_info->{on_connect_do}) {
- $used = 1;
- }
- for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
- if(my $opt_val = $last_info->{$sql_maker_opt}) {
- $used = 1;
- $sql_maker_opts{$sql_maker_opt} = $opt_val;
- }
- }
- pop(@$connect_info) if $used;
- }
- }
-
- $self->schema->connection(@$connect_info);
-
- if($DBIx::Class::VERSION < 0.069) {
- $self->schema->storage->on_connect_do($on_connect_do)
- if $on_connect_do;
- foreach my $sql_maker_opt (keys %sql_maker_opts) {
- $self->schema->storage->sql_maker->$sql_maker_opt(
- $sql_maker_opts{$sql_maker_opt}
- );
- }
- }
-
- # XXX end of compatibility block referenced above
-
no strict 'refs';
foreach my $moniker ($self->schema->sources) {
my $classname = "${class}::$moniker";
Stuff related to DBIC and this Model style:
L<DBIx::Class>, L<DBIx::Class::Schema>,
-L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
-L<Catalyst::Helper::Model::DBIC::SchemaLoader>
+L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>
=head1 AUTHOR
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff