use NEXT;
use UNIVERSAL::require;
use Carp;
+require DBIx::Class;
-our $VERSION = '0.09';
+our $VERSION = '0.15';
__PACKAGE__->mk_classaccessor('composed_schema');
__PACKAGE__->mk_accessors('schema');
=head1 SYNOPSIS
- package MyApp::Model::Foo;
- use strict;
- use base 'Catalyst::Model::DBIC::Schema';
+Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
- __PACKAGE__->config(
- schema_class => 'Foo::SchemaClass',
- connect_info => [ 'dbi:Pg:dbname=foodb',
- 'postgres',
- '',
- { AutoCommit => 1 },
- ],
- );
+=over
- 1;
+=item 1.
- # In controller code:
+Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
- # ->schema To access schema methods:
- $c->model('Foo')->schema->source(...);
+ package MyApp::Schema::FilmDB;
+ use base qw/DBIx::Class::Schema/;
- # certain ->schema methods (source, resultset, class) have shortcuts
- $c->model('Foo')->source(...);
- $c->model('Foo')->resultset(...);
- $c->model('Foo')->class(...);
+ __PACKAGE__->load_classes(qw/Actor Role/);
- # For resultsets, there's an even quicker shortcut:
- $c->model('Foo::Bar')
- # is the same as $c->model('Foo')->resultset('Bar')
+=item 2.
- # To get the composed schema for making new connections:
- my $newconn = $c->model('Foo')->composed_schema->connect(...);
+Create some classes for the tables in the database, for example an
+Actor in MyApp/Schema/FilmDB/Actor.pm:
- # Or the same thing via a convenience shortcut:
- my $newconn = $c->model('Foo')->connect(...);
+ package MyApp::Schema::FilmDB::Actor;
+ use base qw/DBIx::Class/
- # or, if your schema works on different storage drivers:
- my $newconn = $c->model('Foo')->composed_schema->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ __PACKAGE__->load_components(qw/Core/);
+ __PACKAGE__->table('actor');
- # and again, a convenience shortcut
- my $newconn = $c->model('Foo')->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ ...
-=head1 DESCRIPTION
+and a Role in MyApp/Schema/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/;
+
+ ...
+
+ __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.
-NOTE: This is the first public release, there's probably a higher than
-average chance of random bugs and shortcomings: you've been warned.
+Some examples are given below:
+
+ # 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(...);
+
+ # 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(...);
+
+ # 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(...);
+
+ # 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.
=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).
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.
+
+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.
+
+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',
+ ],
+ }
+ ],
=item storage_type
=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
$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->connection(@{$self->{connect_info}});
+
+ $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}});
+
+ 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) {
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