package Catalyst::Model::DBIC::Schema;
use Moose;
-no warnings 'uninitialized';
-
-our $VERSION = '0.24';
-
use mro 'c3';
extends 'Catalyst::Model';
with 'MooseX::Object::Pluggable';
+our $VERSION = '0.24';
+
use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
use DBIx::Class ();
use MooseX::ClassAttribute;
use Moose::Autobox;
-use Catalyst::Model::DBIC::Schema::Types qw/ConnectInfo SchemaClass/;
+use Catalyst::Model::DBIC::Schema::Types
+ qw/ConnectInfo SchemaClass CursorClass/;
+
+use MooseX::Types::Moose qw/ArrayRef Str ClassName/;
use namespace::clean -except => 'meta';
=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).
<Model::FilmDB>
schema_class MyApp::Schema::FilmDB
+ traits Caching
<connect_info>
dsn dbi:Pg:dbname=mypgdb
user postgres
- password ''
+ password ""
auto_savepoint 1
+ quote_char """
on_connect_do some SQL statement
on_connect_do another SQL statement
</connect_info>
LongTruncOk: 1
on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
cursor_class: 'DBIx::Class::Cursor::Cached'
+ quote_char: '"'
The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
supported:
}
]
-=item roles
+=head2 traits
-Array of Roles to apply at BUILD time. Roles are relative to the
-C<<MyApp::Model::DB::Role::> then C<<Catalyst::Model::DBIC::Schema::Role::>>
+Array of Traits to apply at BUILD time. Traits are relative to the
+C<<MyApp::Model::DB::Trait::> then C<<Catalyst::Model::DBIC::Schema::Trait::>>
namespaces, unless prefixed with C<+> in which case they are taken to be a
fully qualified name. E.g.:
- roles Caching
- roles +MyApp::DB::Role::Foo
+ traits Caching
+ traits +MyApp::DB::Trait::Foo
This is done using L<MooseX::Object::Pluggable>.
A new instance is created at application time, so any consumed required
attributes, coercions and modifiers will work.
-Roles are applied before setup, schema and connection are set, and have a chance
-to modify C<connect_info>.
+Traits are applied before setup, schema and connection are set.
+
+C<ref $self> will be an anon class if any traits are applied.
-C<ref $self> will not be what you expect.
+You cannot modify C<new> or C<BUILD>, modify C<setup> instead.
-WARNING: you cannot modify C<new>, modify C<setup> instead.
+L</ACCEPT_CONTEXT> and L</finalize> can also be modified.
-Roles that come with the distribution:
+Traits that come with the distribution:
=over 4
-=item L<Catalyst::Model::DBIC::Schema::Role::Caching>
+=item L<Catalyst::Model::DBIC::Schema::Trait::Caching>
+
+=item L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
=back
-=item storage_type
+=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 METHODS
-=over 4
-
-=item new
+=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 storage
Provides an accessor for the connected schema's storage object.
Used often for debugging and controlling transactions.
=cut
-class_has 'composed_schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
-
-has 'schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+has schema => (is => 'rw', isa => 'DBIx::Class::Schema');
-has 'schema_class' => (
+has schema_class => (
is => 'ro',
isa => SchemaClass,
coerce => 1,
required => 1
);
-has 'storage_type' => (is => 'ro', isa => 'Str');
+has storage_type => (is => 'rw', isa => Str);
-has 'connect_info' => (is => 'ro', isa => ConnectInfo, coerce => 1);
+has connect_info => (is => 'ro', isa => ConnectInfo, coerce => 1);
-# ref $self changes to anon after roles are applied, and _original_class_name is
-# broken in MX::O::P 0.0009
-has '_class_name' => (is => 'ro', isa => 'ClassName', default => sub {
- ref shift
-});
-
-has 'model_name' => (is => 'ro', isa => 'Str', default => sub {
+has model_name => (is => 'ro', isa => Str, default => sub {
my $self = shift;
my $class = ref $self;
$model_name
});
-has 'roles' => (is => 'ro', isa => 'ArrayRef|Str');
+has traits => (is => 'ro', isa => ArrayRef|Str);
+
+has _default_cursor_class => (
+ is => 'ro',
+ isa => CursorClass,
+ default => 'DBIx::Class::Storage::DBI::Cursor',
+ coerce => 1
+);
sub BUILD {
my $self = shift;
$self->connect_info($schema_class->storage->connect_info);
}
else {
- croak "Either ->config->{connect_info} must be defined for $class"
+ 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($self);
. " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->_plugin_ns('Role');
+ $self->_plugin_ns('Trait');
- $self->load_plugins($self->roles->flatten) if $self->roles;
+ $self->load_plugins($self->traits->flatten) if $self->traits;
$self->setup;
$self->schema->connection($self->connect_info);
$self->_install_rs_models;
+
+ $self->finalize;
}
sub clone { shift->composed_schema->clone(@_); }
sub storage { shift->schema->storage(@_); }
-=item setup
+sub resultset { shift->schema->resultset(@_); }
-Called at C<<BUILD>> time, for modifying in roles/subclasses.
+=head2 setup
+
+Called at C<<BUILD>> time before configuration.
=cut
sub setup { 1 }
-=item ACCEPT_CONTEXT
+=head2 finalize
+
+Called at the end of C<BUILD> after everything has been configured.
+
+=cut
+
+sub finalize { 1 }
+
+=head2 ACCEPT_CONTEXT
Point of extension for doing things at C<<$c->model>> time, returns the model
instance, see L<Catalyst::Manual::Intro> for more information.
sub _install_rs_models {
my $self = shift;
- my $class = $self->_class_name;
+ my $class = $self->_original_class_name;
no strict 'refs';
- foreach my $moniker ($self->schema->sources) {
+
+ my @sources = $self->schema->sources;
+
+ die "No sources found (did you forget to define your tables?)"
+ unless @sources;
+
+ foreach my $moniker (@sources) {
my $classname = "${class}::$moniker";
*{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
}
}
-__PACKAGE__->meta->make_immutable;
+sub _reset_cursor_class {
+ my $self = shift;
-=back
+ if ($self->storage->can('cursor_class')) {
+ $self->storage->cursor_class($self->_default_cursor_class)
+ if $self->storage->cursor_class ne $self->_default_cursor_class;
+ }
+}
+
+{
+ my %COMPOSED_CACHE;
+
+ sub composed_schema {
+ my $self = shift;
+ my $class = $self->_original_class_name;
+ my $store = \$COMPOSED_CACHE{$class}{$self->schema_class};
+
+ $$store = shift if @_;
+
+ return $$store
+ }
+}
+
+__PACKAGE__->meta->make_immutable;
=head1 SEE ALSO
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<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
+L<MooseX::Object::Pluggable>
+
+Traits:
+
+L<Catalyst::Model::DBIC::Schema::Trait::Caching>,
+L<Catalyst::Model::DBIC::Schema::Trait::Replicated>
=head1 AUTHOR
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff