package Catalyst::Model::DBIC::Schema;
use strict;
-use base qw/Catalyst::Base Class::Accessor::Fast Class::Data::Accessor/;
+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.01';
-
-__PACKAGE__->mk_classdata('composed_schema');
+__PACKAGE__->mk_classaccessor('composed_schema');
__PACKAGE__->mk_accessors('schema');
=head1 NAME
=head1 SYNOPSIS
- package MyApp::Model::Foo;
- use strict;
- use base 'Catalyst::Model::DBIC::Schema';
-
- __PACKAGE__->config(
- schema_class => 'Foo::SchemaClass',
- connect_info => [ 'dbi:Pg:dbname=foodb',
- 'postgres',
- '',
- { AutoCommit => 1 },
- ],
- );
+Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
+
+=over
+
+=item 1.
+
+Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
+
+ package MyApp::Schema::FilmDB;
+ use base qw/DBIx::Class::Schema/;
+
+ __PACKAGE__->load_classes(qw/Actor Role/);
+
+=item 2.
+
+Create some classes for the tables in the database, for example an
+Actor in MyApp/Schema/FilmDB/Actor.pm:
+
+ package MyApp::Schema::FilmDB::Actor;
+ use base qw/DBIx::Class/
+
+ __PACKAGE__->load_components(qw/Core/);
+ __PACKAGE__->table('actor');
+
+ ...
+
+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
+usable as a standalone module and you can test/run it without Catalyst.
+
+=item 3.
+
+To expose it to Catalyst as a model, you should create a DBIC Model in
+MyApp/Model/FilmDB.pm:
+
+ package MyApp::Model::FilmDB;
+ use base qw/Catalyst::Model::DBIC::Schema/;
+
+ __PACKAGE__->config(
+ schema_class => 'MyApp::Schema::FilmDB',
+ connect_info => [
+ "DBI:...",
+ "username",
+ "password",
+ {AutoCommit => 1}
+ ]
+ );
+
+See below for a full list of the possible config parameters.
+
+=back
+
+Now you have a working Model, accessing your separate DBIC Schema. Which can
+be used/accessed in the normal Catalyst manner, via $c->model():
+
+ my $actor = $c->model('FilmDB::Actor')->find(1);
+
+You can also use it to set up DBIC authentication with
+Authentication::Store::DBIC in MyApp.pm:
+
+ package MyApp;
+
+ use Catalyst qw/... Authentication::Store::DBIC/;
+
+ ...
- 1;
+ __PACKAGE__->config->{authentication}{dbic} = {
+ user_class => 'FilmDB::Actor',
+ user_field => 'name',
+ password_field => 'password'
+ }
- # In controller code:
+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.
- # ->schema To access schema methods:
- $c->model('Foo')->schema->source(...);
+Some examples are given below:
- # certain ->schema methods (source, resultset, class) have shortcuts
- $c->model('Foo')->source(...);
- $c->model('Foo')->resultset(...);
- $c->model('Foo')->class(...);
+ # to access schema methods directly:
+ $c->model('FilmDB')->schema->source(...);
- # For resultsets, there's an even quicker shortcut:
- $c->model('Foo::Bar')
- # is the same as $c->model('Foo')->resultset('Bar')
+ # to access the source object, resultset, and class:
+ $c->model('FilmDB')->source(...);
+ $c->model('FilmDB')->resultset(...);
+ $c->model('FilmDB')->class(...);
- # To get the composed schema for making new connections:
- my $newconn = $c->model('Foo')->composed_schema->connect(...);
+ # For resultsets, there's an even quicker shortcut:
+ $c->model('FilmDB::Actor')
+ # is the same as $c->model('FilmDB')->resultset('Actor')
- # Or the same thing via a convenience shortcut:
- my $newconn = $c->model('Foo')->connect(...);
+ # To get the composed schema for making new connections:
+ my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
- # or, if your schema works on different storage drivers:
- my $newconn = $c->model('Foo')->composed_schema->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connect(...);
+ # Or the same thing via a convenience shortcut:
+ my $newconn = $c->model('FilmDB')->connect(...);
- # and again, a convenience shortcut
- my $newconn = $c->model('Foo')->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connect(...);
+ # 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(...);
=head1 DESCRIPTION
-This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
+This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
+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 schema_class
This is the classname of your L<DBIx::Class::Schema> Schema. It needs
-to be findable in C<@INC>, but it does not need to be underneath
-C<Catalyst::Model::>. This parameter is required.
+to be findable in C<@INC>, but it does not need to be inside the
+C<Catalyst::Model::> namespace. This parameter is required.
=item connect_info
This is an arrayref of connection parameters, which are specific to your
-C<storage_type>. For C<::DBI>, which is the only supported C<storage_type>
-in L<DBIx::Class> at the time of this writing, the 4 parameters are your
-dsn, username, password, and connect options hashref.
+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 in itself (which would be the case for a Schema defined by
-L<DBIx::Class::Schema::Loader>, for instance).
+defined inside itself (which isn't highly recommended, but can be done)
+
+For L<DBIx::Class::Storage::DBI>, which is the only supported
+C<storage_type> in L<DBIx::Class> at the time of this writing, the
+parameters are your dsn, username, password, and connect options hashref.
+
+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',
+ ],
+ }
+ ],
+
+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
Allows the use of a different C<storage_type> than what is set in your
C<schema_class> (which in turn defaults to C<::DBI> if not set in current
-L<DBIx::Class>). Completely optional, and probably unneccesary for most
-people, until other storage backends become available for L<DBIx::Class>.
+L<DBIx::Class>). Completely optional, and probably unnecessary for most
+people until other storage backends become available for L<DBIx::Class>.
=back
=item schema
Accessor which returns the connected schema being used by the this model.
-There are already direct shortcuts on the model class itself for
+There are direct shortcuts on the model class itself for
schema->resultset, schema->source, and schema->class.
=item composed_schema
Shortcut for ->schema->resultset
+=item storage
+
+Provides an accessor for the connected schema's storage object.
+Used often for debugging and controlling transactions.
+
=back
=cut
sub new {
- my ( $self, $c ) = @_;
- $self = $self->NEXT::new($c);
+ my $self = shift->NEXT::new(@_);
my $class = ref($self);
my $model_name = $class;
}
else {
croak "Either ->config->{connect_info} must be defined for $class"
- . " or $schema_class must have connection defined on it";
+ . " or $schema_class must have connect info defined on it."
+ . " Here's what we got:\n"
+ . Dumper($self);
}
}
$self->composed_schema($schema_class->compose_namespace($class));
$self->schema($self->composed_schema->clone);
- $self->schema->storage_type($self->{storage_type}) if $self->{storage_type};
- $self->schema->connect(@{$self->{connect_info}});
+ $self->schema->storage_type($self->{storage_type})
+ if $self->{storage_type};
+
+ $self->schema->connection(
+ ref $self->{connect_info} eq 'ARRAY' ?
+ @{$self->{connect_info}} :
+ $self->{connect_info}
+ );
+
no strict 'refs';
foreach my $moniker ($self->schema->sources) {
- *{"${class}::${moniker}::ACCEPT_CONTEXT"} = sub {
+ my $classname = "${class}::$moniker";
+ *{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
shift->model($model_name)->resultset($moniker);
}
sub connect { shift->composed_schema->connect(@_); }
+sub storage { shift->schema->storage(@_); }
+
=head1 SEE ALSO
-L<Catalyst>, L<DBIx::Class>, L<DBIx::Class::Schema>,
-L<DBIx::Class::Schema::Loader>
+General Catalyst Stuff:
+
+L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
+L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
+
+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>
=head1 AUTHOR
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff