package Catalyst::Model::DBIC::Schema;
-use strict;
-use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
-use NEXT;
-use UNIVERSAL::require;
-use Carp;
-require DBIx::Class;
+use Moose;
+use mro 'c3';
+extends 'Catalyst::Model';
+with 'CatalystX::Component::Traits';
-our $VERSION = '0.12';
+our $VERSION = '0.46';
+$VERSION = eval $VERSION;
-__PACKAGE__->mk_classaccessor('composed_schema');
-__PACKAGE__->mk_accessors('schema');
+use namespace::autoclean;
+use Carp::Clan '^Catalyst::Model::DBIC::Schema';
+use Data::Dumper;
+use DBIx::Class ();
+
+use Catalyst::Model::DBIC::Schema::Types
+ qw/ConnectInfo LoadedClass SchemaClass Schema/;
+
+use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
=head1 NAME
=head1 SYNOPSIS
-Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
+First, prepare your database schema using L<DBIx::Class>, see
+L<Catalyst::Helper::Model::DBIC::Schema> for how to generate a
+L<DBIx::Class::Schema> from your database using the Helper script, and
+L<DBIx::Class::Schema::Loader::Base>.
-=over
+A typical usage of the helper script would be:
-=item 1.
+ script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB \
+ create=static dbi:mysql:filmdb dbusername dbpass \
+ quote_char='`' name_sep='.'
-Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
+If you are unfamiliar with L<DBIx::Class>, see L<DBIx::Class::Manual::Intro>
+first.
- package MyApp::Schema::FilmDB;
- use base qw/DBIx::Class::Schema/;
+These examples assume that you already have a schema called
+C<MyApp::Schema::FilmDB>, which defines some Result classes for tables in
+C<MyApp::Schema::FilmDB::Result::Actor> and
+C<MyApp::Schema::FilmDB::Result::Film>. Either created by the helper script (as
+shown above) or manually.
- __PACKAGE__->load_classes(qw/Actor Role/);
+The helper also creates a Model in C<lib/MyApp/Model/FilmDB.pm>, if you already
+have a schema you can create just the Model using:
-=item 2.
+ script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB
+ dbi:mysql:filmdb dbusername dbpass
-Create some classes for the tables in the database, for example an
-Actor in MyApp/Schema/FilmDB/Actor.pm:
+The connect_info is optional and will be hardcoded into the Model if provided.
+It's better to configure it in your L<Catalyst> config file, which will also
+override any hardcoded config, see L</connect_info> for examples.
- package MyApp::Schema::FilmDB::Actor;
- use base qw/DBIx::Class/
-
- __PACKAGE__->load_components(qw/Core/);
- __PACKAGE__->table('actor');
-
- ...
+Now you have a working Model which accesses your separate DBIC Schema. This can
+be used/accessed in the normal Catalyst manner, via C<< $c->model() >>:
-and a Role in MyApp/Schema/Role.pm:
+ my $db_model = $c->model('FilmDB'); # a Catalyst::Model
+ my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object
- package MyApp::Schema::FilmDB::Role;
- use base qw/DBIx::Class/
-
- __PACKAGE__->load_components(qw/Core/);
- __PACKAGE__->table('actor');
-
- ...
+There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
+instead of a L<Catalyst::Model>:
-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.
+ my $rs = $c->model('FilmDB::Actor');
-=item 3.
+See L<DBIx::Class::ResultSet> to find out more about which methods can be
+called on ResultSets.
-To expose it to Catalyst as a model, you should create a DBIC Model in
-MyApp/Model/FilmDB.pm:
+You can also define your own ResultSet methods to encapsulate the
+database/business logic of your applications. These go into, for example,
+C<lib/MyApp/Schema/FilmDB/ResultSet/Actor.pm>. The class must inherit from
+L<DBIx::Class::ResultSet> and is automatically loaded.
- 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}
- ]
- );
+Then call your methods like any other L<DBIx::Class::ResultSet> method:
-See below for a full list of the possible config parameters.
+ $c->model('FilmDB::Actor')->SAG_members
-=back
+=head2 Some examples:
-Now you have a working Model, accessing your separate DBIC Schema. Which can
-be used/accessed in the normal Catalyst manner, via $c->model():
+ # to access schema methods directly:
+ $c->model('FilmDB')->schema->source(...);
- my $actor = $c->model('FilmDB::Actor')->find(1);
+ # to access the source object, resultset, and class:
+ $c->model('FilmDB')->source(...);
+ $c->model('FilmDB')->resultset(...);
+ $c->model('FilmDB')->class(...);
-You can also use it to set up DBIC authentication with
-Authentication::Store::DBIC in MyApp.pm:
+ # For resultsets, there's an even quicker shortcut:
+ $c->model('FilmDB::Actor')
+ # is the same as $c->model('FilmDB')->resultset('Actor')
- package MyApp;
-
- use Catalyst qw/... Authentication::Store::DBIC/;
-
- ...
-
- __PACKAGE__->config->{authentication}{dbic} = {
- user_class => 'FilmDB::Actor',
- user_field => 'name',
- password_field => 'password'
- }
+ # To get the composed schema for making new connections:
+ my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
-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.
+ # Or the same thing via a convenience shortcut:
+ my $newconn = $c->model('FilmDB')->connect(...);
-Some examples are given below:
+ # or, if your schema works on different storage drivers:
+ my $newconn = $c->model('FilmDB')->composed_schema->clone();
+ $newconn->storage_type('::LDAP');
+ $newconn->connection(...);
- # to access schema methods directly:
- $c->model('FilmDB')->schema->source(...);
+ # and again, a convenience shortcut
+ my $newconn = $c->model('FilmDB')->clone();
+ $newconn->storage_type('::LDAP');
+ $newconn->connection(...);
- # to access the source object, resultset, and class:
- $c->model('FilmDB')->source(...);
- $c->model('FilmDB')->resultset(...);
- $c->model('FilmDB')->class(...);
+To set up authentication, see L</"Setting up DBIC authentication"> below.
+
+=head1 DESCRIPTION
- # For resultsets, there's an even quicker shortcut:
- $c->model('FilmDB::Actor')
- # is the same as $c->model('FilmDB')->resultset('Actor')
+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');
+ }
- # To get the composed schema for making new connections:
- my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
+In short, there are three techniques available for obtaining a DBIC
+resultset object:
- # Or the same thing via a convenience shortcut:
- my $newconn = $c->model('FilmDB')->connect(...);
+ # the long way
+ my $rs = $c->model('FilmDB')->schema->resultset('Actor');
- # or, if your schema works on different storage drivers:
- my $newconn = $c->model('FilmDB')->composed_schema->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ # using the shortcut method on the model object
+ my $rs = $c->model('FilmDB')->resultset('Actor');
- # and again, a convenience shortcut
- my $newconn = $c->model('FilmDB')->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
+ # using the generated class directly
+ my $rs = $c->model('FilmDB::Actor');
-=head1 DESCRIPTION
+In order to add methods to a DBIC resultset, you cannot simply add them to
+the source (row, table) definition class; you must define a separate custom
+resultset class. This is just a matter of making a
+C<lib/MyApp/Schema/ResultSet/Actor.pm> class that inherits from
+L<DBIx::Class::ResultSet>, if you are using
+L<DBIx::Class::Schema/load_namespaces>, the default for helper script generated
+schemas.
-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.
+See L<DBIx::Class::Manual::Cookbook/"Predefined searches">
+for information on definining your own L<DBIx::Class::ResultSet> classes for
+use with L<DBIx::Class::Schema/load_classes>, the old default.
=head1 CONFIG PARAMETERS
-=over 4
-
-=item schema_class
+=head2 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 inside the
C<Catalyst::Model::> namespace. This parameter is required.
-=item connect_info
+=head2 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 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.
+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',
- ],
- }
- ],
-
-=item storage_type
+ connect_info => {
+ dsn => 'dbi:Pg:dbname=mypgdb',
+ user => 'postgres',
+ password => ''
+ }
+
+ connect_info => {
+ dsn => 'dbi:SQLite:dbname=foo.db',
+ on_connect_do => [
+ 'PRAGMA synchronous = OFF',
+ ]
+ }
+
+ connect_info => {
+ dsn => 'dbi:Pg:dbname=mypgdb',
+ user => 'postgres',
+ password => '',
+ pg_enable_utf8 => 1,
+ on_connect_do => [
+ 'some SQL statement',
+ 'another SQL statement',
+ ],
+ }
+
+Or using L<Config::General>:
+
+ <Model::FilmDB>
+ schema_class MyApp::Schema::FilmDB
+ traits Caching
+ <connect_info>
+ dsn dbi:Pg:dbname=mypgdb
+ user postgres
+ password ""
+ auto_savepoint 1
+ quote_char """
+ on_connect_do some SQL statement
+ on_connect_do another SQL statement
+ </connect_info>
+ user_defined_schema_accessor foo
+ </Model::FilmDB>
+
+or
+
+ <Model::FilmDB>
+ schema_class MyApp::Schema::FilmDB
+ connect_info dbi:SQLite:dbname=foo.db
+ </Model::FilmDB>
+
+Or using L<YAML>:
+
+ Model::MyDB:
+ schema_class: MyDB
+ traits: Caching
+ connect_info:
+ dsn: dbi:Oracle:mydb
+ user: mtfnpy
+ password: mypass
+ LongReadLen: 1000000
+ LongTruncOk: 1
+ on_connect_call: 'datetime_setup'
+ quote_char: '"'
+
+The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
+supported:
+
+ connect_info => [
+ 'dbi:Pg:dbname=mypgdb',
+ 'postgres',
+ '',
+ {
+ pg_enable_utf8 => 1,
+ },
+ {
+ auto_savepoint => 1,
+ on_connect_do => [
+ 'some SQL statement',
+ 'another SQL statement',
+ ],
+ }
+ ]
+
+=head2 traits
+
+Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
+
+They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then
+the C<< Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless
+prefixed with C<+> in which case they are taken to be a fully qualified name.
+E.g.:
+
+ traits Caching
+ traits +MyApp::TraitFor::Model::Foo
+
+A new instance is created at application time, so any consumed required
+attributes, coercions and modifiers will work.
+
+Traits are applied at L<Catalyst::Component/COMPONENT> time using
+L<CatalystX::Component::Traits>.
+
+C<ref $self> will be an anon class if any traits are applied, C<<
+$self->_original_class_name >> will be the original class.
+
+When writing a Trait, interesting points to modify are C<BUILD>, L</setup> and
+L</ACCEPT_CONTEXT>.
+
+Traits that come with the distribution:
+
+=over 4
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
+
+=back
+
+=head2 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 unnecessary for most
people until other storage backends become available for L<DBIx::Class>.
-=back
+=head1 ATTRIBUTES
-=head1 METHODS
+The keys you pass in the model configuration are available as attributes.
-=over 4
+Other attributes available:
+
+=head2 connect_info
+
+Your connect_info args normalized to hashref form (with dsn/user/password.) See
+L<DBIx::Class::Storage::DBI/connect_info> for more info on the hashref form of
+L</connect_info>.
+
+=head2 model_name
+
+The model name L<Catalyst> uses to resolve this model, the part after
+C<::Model::> or C<::M::> in your class name. E.g. if your class name is
+C<MyApp::Model::DB> the L</model_name> will be C<DB>.
+
+=head2 _default_cursor_class
+
+What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
+doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
+
+=head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
+
+=head2 _original_class_name
+
+The class name of your model before any L</traits> are applied. E.g.
+C<MyApp::Model::DB>.
+
+=head2 _traits
+
+Unresolved arrayref of traits passed in the config.
+
+=head2 _resolved_traits
-=item new
+Traits you used resolved to full class names.
+
+=head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
+
+See the documentation for
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
+to pass config values from your L<Catalyst> config to your
+L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
+
+=head1 METHODS
+
+=head2 new
Instantiates the Model based on the above-documented ->config parameters.
The only required parameter is C<schema_class>. C<connect_info> is
required in the case that C<schema_class> does not already have connection
information defined for it.
-=item schema
+=head2 schema
Accessor which returns the connected schema being used by the this model.
There are direct shortcuts on the model class itself for
schema->resultset, schema->source, and schema->class.
-=item composed_schema
+=head2 composed_schema
Accessor which returns the composed schema, which has no connection info,
which was used in constructing the C<schema> above. Useful for creating
new connections based on the same schema/model. There are direct shortcuts
from the model object for composed_schema->clone and composed_schema->connect
-=item clone
+=head2 clone
Shortcut for ->composed_schema->clone
-=item connect
+=head2 connect
Shortcut for ->composed_schema->connect
-=item source
+=head2 source
Shortcut for ->schema->source
-=item class
+=head2 class
Shortcut for ->schema->class
-=item resultset
+=head2 resultset
Shortcut for ->schema->resultset
-=item storage
+=head2 txn_do
+
+Shortcut for ->schema->txn_do
+
+=head2 txn_scope_guard
+
+Shortcut for ->schema->txn_scope_guard
+
+=head2 storage
Provides an accessor for the connected schema's storage object.
-Used often for debugging and controlling transactions.
-=back
+See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
=cut
-sub new {
- my $self = shift->NEXT::new(@_);
-
- my $class = ref($self);
- my $model_name = $class;
- $model_name =~ s/^[\w:]+::(?:Model|M):://;
+has schema_class => (
+ is => 'ro',
+ isa => SchemaClass,
+ coerce => 1,
+ required => 1
+);
+
+has storage_type => (is => 'rw', isa => Str);
+
+has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
+
+has model_name => (
+ is => 'ro',
+ isa => Str,
+ required => 1,
+ lazy_build => 1,
+);
+
+has _default_cursor_class => (
+ is => 'ro',
+ isa => LoadedClass,
+ default => 'DBIx::Class::Storage::DBI::Cursor',
+ coerce => 1
+);
- croak "->config->{schema_class} must be defined for this model"
- unless $self->{schema_class};
+has schema => (is => 'rw', isa => Schema);
- my $schema_class = $self->{schema_class};
+my $app_class;
- $schema_class->require
- or croak "Cannot load schema class '$schema_class': $@";
+before COMPONENT => sub {
+ $app_class = ref $_[1] || $_[1];
+};
- if( !$self->{connect_info} ) {
+sub app_class { $app_class }
+
+sub BUILD {
+ my ($self, $args) = @_;
+ my $class = $self->_original_class_name;
+ my $schema_class = $self->schema_class;
+
+ if( !$self->connect_info ) {
if($schema_class->storage && $schema_class->storage->connect_info) {
- $self->{connect_info} = $schema_class->storage->connect_info;
+ $self->connect_info($schema_class->storage->connect_info);
}
else {
- croak "Either ->config->{connect_info} must be defined for $class"
- . " or $schema_class must have connect info defined on it";
+ die "Either ->config->{connect_info} must be defined for $class"
+ . " or $schema_class must have connect info defined on it."
+ . " Here's what we got:\n"
+ . Dumper($args);
}
}
- $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};
-
- # 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
- # dev 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;
- }
+ if (exists $self->connect_info->{cursor_class}) {
+ eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
+ or croak "invalid connect_info: Cannot load your cursor_class"
+ . " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->schema->connection(@$connect_info);
+ $self->setup($args);
- 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}
- );
- }
- }
+ my $is_installed = defined $self->composed_schema;
+
+ $self->composed_schema($schema_class->compose_namespace($class))
+ unless $is_installed;
+
+ $self->schema($self->composed_schema->clone)
+ unless $self->schema;
+
+ $self->schema->storage_type($self->storage_type)
+ if $self->storage_type;
+
+ $self->schema->connection($self->connect_info);
+
+ $self->_install_rs_models unless $is_installed;
+}
+
+sub clone { shift->composed_schema->clone(@_); }
+
+sub connect { shift->composed_schema->connect(@_); }
+
+# some proxy methods, see also SchemaProxy
+
+sub resultset { shift->schema->resultset(@_); }
+
+sub txn_do { shift->schema->txn_do(@_); }
+
+sub txn_scope_guard { shift->schema->txn_scope_guard(@_); }
+
+sub storage { shift->schema->storage(@_); }
+
+=head2 setup
- # XXX end of compatibility block referenced above
+Called at C<BUILD> time before configuration, but after L</connect_info> is
+set. To do something after configuuration use C<< after BUILD => >>.
+
+Receives a hashref of args passed to C<BUILD>.
+
+=cut
+
+sub setup { 1 }
+
+=head2 ACCEPT_CONTEXT
+
+Point of extension for doing things at C<< $c->model >> time with context,
+returns the model instance, see L<Catalyst::Manual::Intro/ACCEPT_CONTEXT> for
+more information.
+
+=cut
+
+sub ACCEPT_CONTEXT { shift }
+
+sub _install_rs_models {
+ my $self = shift;
+ my $class = $self->_original_class_name;
no strict 'refs';
- foreach my $moniker ($self->schema->sources) {
+
+ my @sources = $self->schema->sources;
+
+ unless (@sources) {
+ warn <<'EOF' unless $ENV{CMDS_NO_SOURCES};
+******************************* WARNING ***************************************
+* No sources found (did you forget to define your tables?) *
+* *
+* To turn off this warning, set the CMDS_NO_SOURCES environment variable. *
+*******************************************************************************
+EOF
+ }
+
+ foreach my $moniker (@sources) {
my $classname = "${class}::$moniker";
*{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
- shift->model($model_name)->resultset($moniker);
+ shift->model($self->model_name)->resultset($moniker);
}
}
+}
+
+sub _reset_cursor_class {
+ my $self = shift;
- return $self;
+ if ($self->storage->can('cursor_class')) {
+ $self->storage->cursor_class($self->_default_cursor_class)
+ if $self->storage->cursor_class ne $self->_default_cursor_class;
+ }
}
-sub clone { shift->composed_schema->clone(@_); }
+{
+ my %COMPOSED_CACHE;
-sub connect { shift->composed_schema->connect(@_); }
+ sub composed_schema {
+ my $self = shift;
+ my $class = $self->_original_class_name;
+ my $store = \$COMPOSED_CACHE{$class}{$self->schema_class};
-sub storage { shift->schema->storage(@_); }
+ $$store = shift if @_;
+
+ return $$store
+ }
+}
+
+sub _build_model_name {
+ my $self = shift;
+ my $class = $self->_original_class_name;
+ (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
+
+ return $model_name;
+}
+
+__PACKAGE__->meta->make_immutable;
+
+=head1 ENVIRONMENT
+
+=over 4
+
+=item CMDS_NO_SOURCES
+
+Set this variable if you will be using schemas with no sources (Result classes)
+to disable the warning. The warning is there because having no Result classes
+is usually a mistake.
+
+=back
+
+=head1 Setting up DBIC authentication
+
+You can set this up with
+L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
+
+ package MyApp;
+
+ use Catalyst qw/... Authentication .../;
+
+ ...
+
+ __PACKAGE__->config('Plugin::Authentication' =>
+ {
+ default_realm => 'members',
+ members => {
+ credential => {
+ class => 'Password',
+ password_field => 'password',
+ password_type => 'hashed'
+ password_hash_type => 'SHA-256'
+ },
+ store => {
+ class => 'DBIx::Class',
+ user_model => 'DB::User',
+ role_relation => 'roles',
+ role_field => 'rolename',
+ }
+ }
+ });
+
+=head1 METHOD PROXYING
+
+The automatic proxying to the underlying L<DBIx::Class::Schema> has been
+removed as of version C<0.34>, to enable this feature add C<SchemaProxy> to
+L</traits>.
+
+See L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>.
=head1 SEE ALSO
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<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
+
+Traits:
+
+L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
=head1 AUTHOR
-Brandon L Black, C<blblack@gmail.com>
+Brandon L Black C<blblack at gmail.com>
+
+=head1 CONTRIBUTORS
+
+caelum: Rafael Kitover C<rkitover at cpan.org>
+
+dandv: Dan Dascalescu C<dandv at cpan.org>
+
+bluefeet: Aran Deltac C<bluefeet@cpan.org>
+
+t0m: Tomas Doran C<bobtfish@bobtfish.net>
+
+osfameron: C<osfameron@cpan.org>
+
+ozum: Ozum Eldogan C<ozum@ozum.net>
+
+Pavel I. Shaydo C<zwon@trinitum.org>
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it
+Copyright (c) 2006 - 2010
+the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
+as listed above.
+
+=head1 LICENSE
+
+This program is free software. You can redistribute it and/or modify it
under the same terms as Perl itself.
=cut
1;
+# vim:sts=4 sw=4 et tw=80: