package Catalyst::Model::DBIC::Schema;
-use strict;
-use warnings;
+use Moose;
+no warnings 'uninitialized';
-our $VERSION = '0.22';
+our $VERSION = '0.24';
-use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
-use NEXT;
-use UNIVERSAL::require;
-use Carp;
+use mro 'c3';
+extends 'Catalyst::Model';
+with 'MooseX::Object::Pluggable';
+
+use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
-require DBIx::Class;
+use DBIx::Class ();
+use Scalar::Util 'reftype';
+use MooseX::ClassAttribute;
+use Moose::Autobox;
+
+use Catalyst::Model::DBIC::Schema::Types qw/ConnectInfo SchemaClass/;
-__PACKAGE__->mk_classaccessor('composed_schema');
-__PACKAGE__->mk_accessors('schema');
+use namespace::clean -except => 'meta';
=head1 NAME
__PACKAGE__->config(
schema_class => 'MyApp::Schema::FilmDB',
- connect_info => [
- "DBI:...",
- "username",
- "password",
- {AutoCommit => 1}
- ]
+ connect_info => {
+ dsn => "DBI:...",
+ user => "username",
+ password => "password",
+ }
);
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
+Now you have a working Model which accesses your separate DBIC Schema. This can
be used/accessed in the normal Catalyst manner, via $c->model():
my $actor = $c->model('FilmDB::Actor')->find(1);
# using the generated class directly
my $rs = $c->model('FilmDB::Actor');
+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. See L<DBIx::Class::Manual::Cookbook/"Predefined searches">
+for more info.
+
=head1 CONFIG PARAMETERS
=over 4
Examples:
- connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
+ connect_info => {
+ dsn => 'dbi:Pg:dbname=mypgdb',
+ user => 'postgres',
+ password => ''
+ }
- connect_info => [
- 'dbi:SQLite:dbname=foo.db',
- {
- on_connect_do => [
- 'PRAGMA synchronous = OFF',
- ],
- }
- ],
+ connect_info => {
+ dsn => '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 => {
+ 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
- connect_info dbi:Pg:dbname=mypgdb
- connect_info postgres
- connect_info
<connect_info>
- AutoCommit 0
+ dsn dbi:Pg:dbname=mypgdb
+ user postgres
+ password ''
+ auto_savepoint 1
on_connect_do some SQL statement
on_connect_do another SQL statement
</connect_info>
connect_info dbi:SQLite:dbname=foo.db
</Model::FilmDB>
+Or using L<YAML>:
+
+ Model::MyDB:
+ schema_class: MyDB
+ connect_info:
+ dsn: dbi:Oracle:mydb
+ user: mtfnpy
+ password: mypass
+ LongReadLen: 1000000
+ LongTruncOk: 1
+ on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
+ cursor_class: 'DBIx::Class::Cursor::Cached'
+
+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',
+ ],
+ }
+ ]
+
+=item roles
+
+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::>>
+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
+
+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>.
+
+C<ref $self> will not be what you expect.
+
+WARNING: you cannot modify C<new>, modify C<setup> instead.
+
+Roles that come with the distribution:
+
+=over 4
+
+=item L<Catalyst::Model::DBIC::Schema::Role::Caching>
+
+=back
=item storage_type
Provides an accessor for the connected schema's storage object.
Used often for debugging and controlling transactions.
-=back
-
=cut
-sub new {
- my $self = shift->NEXT::new(@_);
-
- my $class = ref($self);
- my $model_name = $class;
- $model_name =~ s/^[\w:]+::(?:Model|M):://;
+class_has 'composed_schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema' => (is => 'rw', isa => 'DBIx::Class::Schema');
+
+has 'schema_class' => (
+ is => 'ro',
+ isa => SchemaClass,
+ coerce => 1,
+ required => 1
+);
+
+has 'storage_type' => (is => 'ro', isa => 'Str');
+
+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 {
+ my $self = shift;
- croak "->config->{schema_class} must be defined for this model"
- unless $self->{schema_class};
+ my $class = ref $self;
+ (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
- my $schema_class = $self->{schema_class};
+ $model_name
+});
- $schema_class->require
- or croak "Cannot load schema class '$schema_class': $@";
+has 'roles' => (is => 'ro', isa => 'ArrayRef|Str');
- if( !$self->{connect_info} ) {
+sub BUILD {
+ my $self = shift;
+ my $class = ref $self;
+ 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"
}
}
+ 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->_plugin_ns('Role');
+
+ $self->load_plugins($self->roles->flatten) if $self->roles;
+
+ $self->setup;
+
$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->storage_type($self->storage_type)
+ if $self->storage_type;
+
+ $self->schema->connection($self->connect_info);
+
+ $self->_install_rs_models;
+}
+
+sub clone { shift->composed_schema->clone(@_); }
+
+sub connect { shift->composed_schema->connect(@_); }
+
+sub storage { shift->schema->storage(@_); }
+
+=item setup
+
+Called at C<<BUILD>> time, for modifying in roles/subclasses.
+
+=cut
+
+sub setup { 1 }
+
+=item 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.
+
+=cut
+
+sub ACCEPT_CONTEXT { shift }
+
+sub _install_rs_models {
+ my $self = shift;
+ my $class = $self->_class_name;
- $self->schema->connection(
- ref $self->{connect_info} eq 'ARRAY' ?
- @{$self->{connect_info}} :
- $self->{connect_info}
- );
-
no strict 'refs';
foreach my $moniker ($self->schema->sources) {
my $classname = "${class}::$moniker";
*{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
- shift->model($model_name)->resultset($moniker);
+ shift->model($self->model_name)->resultset($moniker);
}
}
-
- return $self;
}
-sub clone { shift->composed_schema->clone(@_); }
-
-sub connect { shift->composed_schema->connect(@_); }
+__PACKAGE__->meta->make_immutable;
-sub storage { shift->schema->storage(@_); }
+=back
=head1 SEE ALSO
Brandon L Black, C<blblack@gmail.com>
+Contributors:
+
+Rafael Kitover, C<<rkitover at cpan.org>>
+
=head1 COPYRIGHT
This program is free software, you can redistribute it and/or modify it
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff