extends 'Catalyst::Model';
with 'CatalystX::Component::Traits';
-our $VERSION = '0.24';
+our $VERSION = '0.65';
+$VERSION = eval $VERSION;
use namespace::autoclean;
use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
use DBIx::Class ();
-use Moose::Autobox;
+use Module::Runtime qw/use_module/;
use Catalyst::Model::DBIC::Schema::Types
- qw/ConnectInfo SchemaClass CursorClass/;
+ qw/ConnectInfo SchemaClass Schema/;
-use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
+use MooseX::Types::Moose qw/Str Bool/;
+use MooseX::Types::LoadableClass qw/LoadableClass/;
=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_names=1
-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:
-
- 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 => {
- dsn => "DBI:...",
- user => "username",
- password => "password",
- }
- );
-
-See below for a full list of the possible config parameters.
-
-=back
+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.
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():
+be used/accessed in the normal Catalyst manner, via C<< $c->model() >>:
- my $actor = $c->model('FilmDB::Actor')->find(1);
+ my $db_model = $c->model('FilmDB'); # a Catalyst::Model
+ my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object
-You can also use it to set up DBIC authentication with
-L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
+There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
+instead of a L<Catalyst::Model>:
- package MyApp;
+ my $rs = $c->model('FilmDB::Actor');
- use Catalyst qw/... Authentication .../;
+See L<DBIx::Class::ResultSet> to find out more about which methods can be
+called on ResultSets.
- ...
+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__->config->{authentication} =
- {
- default_realm => 'members',
- realms => {
- 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',
- }
- }
- }
- };
+Then call your methods like any other L<DBIx::Class::ResultSet> method:
-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.
+ $c->model('FilmDB::Actor')->SAG_members
-Some examples are given below:
+=head2 Some examples:
# to access schema methods directly:
$c->model('FilmDB')->schema->source(...);
$newconn->storage_type('::LDAP');
$newconn->connection(...);
+To set up authentication, see L</"Setting up DBIC authentication"> below.
+
=head1 DESCRIPTION
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.
+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
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.
+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.
+
+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
=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).
-If you only need one parameter (e.g. the DSN), you can just pass a string
-instead of an arrayref.
+This is a hashref or arrayref of connection parameters, which are specific to
+your 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.
This is not required if C<schema_class> already has connection information
-defined inside itself (which isn't highly recommended, but can be done)
+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
user postgres
password ""
auto_savepoint 1
- quote_char """
+ quote_names 1
on_connect_do some SQL statement
on_connect_do another SQL statement
</connect_info>
+ user_defined_schema_accessor foo
</Model::FilmDB>
or
Model::MyDB:
schema_class: MyDB
+ traits: Caching
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'
- quote_char: '"'
+ on_connect_call: 'datetime_setup'
+ quote_names: 1
The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
supported:
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.:
+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
=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>
+
=back
+=head2 compose_namespaces
+
+This model calls L<DBIx::Class::Schema/compose_namespaces> by default to
+install classes into the model namespaces. You can turn that off by
+setting this attribute to false. Default is true.
+
+=head2 install_model_shortcuts
+
+If you don't want shortcut models so you can do e.g. C<< $c->model('DB::Book')
+>> set this attribute to false, Default is true.
+
=head2 storage_type
Allows the use of a different C<storage_type> than what is set in your
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
=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
+which was used in constructing the L</schema>. 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
+If L</compose_namespaces> is not true, L</composed_schema> is equivalent to
+C<< $model->schema_class->clone >>.
+
=head2 clone
Shortcut for ->composed_schema->clone
Shortcut for ->schema->resultset
+=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.
-=cut
+See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
-has schema => (is => 'rw', isa => 'DBIx::Class::Schema');
+=cut
has schema_class => (
is => 'ro',
isa => SchemaClass,
- coerce => 1,
required => 1
);
+has compose_namespaces => (is => 'ro', isa => Bool, default => 1 );
+
+has install_model_shortcuts => (is => 'ro', isa => Bool, default => 1 );
+
has storage_type => (is => 'rw', isa => Str);
-has connect_info => (is => 'ro', isa => ConnectInfo, coerce => 1);
+has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
has model_name => (
is => 'ro',
has _default_cursor_class => (
is => 'ro',
- isa => CursorClass,
+ isa => LoadableClass,
default => 'DBIx::Class::Storage::DBI::Cursor',
- coerce => 1
);
+has schema => (is => 'rw', isa => Schema);
+
+my $app_class;
+
+before COMPONENT => sub {
+ $app_class = ref $_[1] || $_[1];
+};
+
+sub app_class { $app_class }
+
sub BUILD {
- my $self = shift;
+ my ($self, $args) = @_;
my $class = $self->_original_class_name;
my $schema_class = $self->schema_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);
+ . Dumper($args);
}
}
if (exists $self->connect_info->{cursor_class}) {
- eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
+ eval { use_module($self->connect_info->{cursor_class}) }
or croak "invalid connect_info: Cannot load your cursor_class"
. " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->setup;
+ $self->setup($args);
- $self->composed_schema($schema_class->compose_namespace($class));
+ my $is_installed = defined $self->composed_schema;
- $self->schema($self->composed_schema->clone);
+ if (not $is_installed) {
+ $self->composed_schema($self->compose_namespaces ?
+ $schema_class->compose_namespace($class)
+ :
+ $schema_class->clone
+ );
+ }
+
+ $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;
+ if ((not $is_installed) && $self->install_model_shortcuts) {
+ $self->_install_rs_models;
+ }
}
sub clone { shift->composed_schema->clone(@_); }
sub connect { shift->composed_schema->connect(@_); }
-sub storage { shift->schema->storage(@_); }
+# 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
-Called at C<BUILD>> time before configuration, but after L</connect_info> is
+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 }
my @sources = $self->schema->sources;
- die "No sources found (did you forget to define your tables?)"
- unless @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";
__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
General Catalyst Stuff:
L<DBIx::Class>, L<DBIx::Class::Schema>,
L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
-L<MooseX::Object::Pluggable>
+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::Replicated>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
=head1 AUTHOR
-Brandon L Black, C<blblack at 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>
-Contributors:
+t0m: Tomas Doran C<bobtfish@bobtfish.net>
-Rafael Kitover, C<rkitover at cpan.org>
+osfameron: C<osfameron@cpan.org>
+
+ozum: Ozum Eldogan C<ozum@ozum.net>
+
+Pavel I. Shaydo C<zwon@trinitum.org>
+
+SineSwiper: Brendan Byrd <byrd.b@insightcom.com>
=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:
+# vim:sts=4 sw=4 et tw=80:
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff