extends 'Catalyst::Model';
with 'CatalystX::Component::Traits';
-our $VERSION = '0.26';
+our $VERSION = '0.32';
+$VERSION = eval $VERSION;
use namespace::autoclean;
use Carp::Clan '^Catalyst::Model::DBIC::Schema';
use Data::Dumper;
use DBIx::Class ();
-use Moose::Autobox;
-use Class::Inspector ();
use Catalyst::Model::DBIC::Schema::Types
- qw/ConnectInfo LoadedClass/;
+ qw/ConnectInfo LoadedClass SchemaClass/;
use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
=head1 SYNOPSIS
-Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
-
-=over
+=over 4
=item 1.
-Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
+First, prepare your database schema using C<DBIx::Class>.
- package MyApp::Schema::FilmDB;
- use base qw/DBIx::Class::Schema/;
+(If you're not sure how to do this, then read L<DBIx::Class::Manual::Intro> first!)
- __PACKAGE__->load_classes(qw/Actor Role/);
+This example assumes that you already have a schema called
+C<MyApp::Schema::FilmDB>,
+which defines some tables in C<MyApp::Schema::FilmDB::Actor> and
+C<MyApp::Schema::FilmDB::Film>.
=item 2.
-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:
+Now, to expose it to Catalyst as a model, you should create a DBIC Model in
+MyApp/Model/FilmDB.pm:
- package MyApp::Schema::FilmDB::Role;
- use base qw/DBIx::Class/
+=over 8
- __PACKAGE__->load_components(qw/Core/);
- __PACKAGE__->table('role');
+You can do this:
- ...
+=item * With the helper script
-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.
+ script/create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB ...options...
-=item 3.
+See L<Catalyst::Helper::Model::DBIC::Schema> for details.
-To expose it to Catalyst as a model, you should create a DBIC Model in
-MyApp/Model/FilmDB.pm:
+=item * Manually
package MyApp::Model::FilmDB;
use base qw/Catalyst::Model::DBIC::Schema/;
=back
-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():
+=back
- my $actor = $c->model('FilmDB::Actor')->find(1);
+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() >>:
-You can also use it to set up DBIC authentication with
-L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
+ my $db_model = $c->model('FilmDB'); # a Catalyst::Model
+ my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object
- package MyApp;
+The Model proxies the DBIC instance so you can do
- use Catalyst qw/... Authentication .../;
+ my $rs = $db_model->resultset('Actor'); # ... or ...
+ my $rs = $dbic ->resultset('Actor'); # same!
- ...
+There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
+instead of a L<Catalyst::Model>:
- __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',
- }
- }
- }
- };
+ my $rs = $c->model('FilmDB::Actor');
-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.
+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.
-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
=head1 CONFIG PARAMETERS
+Any options in your config not listed here are passed to your schema.
+
=head2 schema_class
This is the classname of your L<DBIx::Class::Schema> Schema. It needs
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'
+ on_connect_call: 'datetime_setup'
quote_char: '"'
The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
has schema_class => (
is => 'ro',
- isa => LoadedClass,
+ isa => SchemaClass,
coerce => 1,
required => 1
);
);
sub BUILD {
- my $self = shift;
+ my ($self, $args) = @_;
my $class = $self->_original_class_name;
my $schema_class = $self->schema_class;
$self->schema($self->composed_schema->clone);
- $self->_pass_options_to_schema;
+ $self->_pass_options_to_schema($args);
$self->schema->storage_type($self->storage_type)
if $self->storage_type;
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";
sub _delegates {
my $self = shift;
-# XXX change this to CMOP once CAG is updated
- my @schema_methods = @{ Class::Inspector->methods($self->schema_class) };
+ my $schema_meta = Class::MOP::Class->initialize($self->schema_class);
+ my @schema_methods = $schema_meta->get_all_method_names;
# combine with any already added by other schemas
my @handles = eval {
};
# now kill the attribute, otherwise add_attribute in BUILD will not do the right
-# thing. May be a Moose bug.
+# thing (it clears the handles for some reason.) May be a Moose bug.
eval { $self->meta->remove_attribute('schema') };
my %schema_methods;
}
sub _pass_options_to_schema {
- my $self = shift;
+ my ($self, $args) = @_;
+
+ my @attributes = map {
+ $_->init_arg || ()
+ } $self->meta->get_all_attributes;
- my @attributes = map $_->name, $self->meta->get_all_attributes;
my %attributes;
@attributes{@attributes} = ();
- for my $opt (keys %$self) {
+ for my $opt (keys %$args) {
if (not exists $attributes{$opt}) {
- die "Invalid schema option: $opt" unless $self->schema->can($opt);
-
+ next unless $self->schema->can($opt);
$self->schema->$opt($self->{$opt});
}
}
__PACKAGE__->meta->make_immutable;
+=head1 ENVIRONMENT
+
+=over 4
+
+=item CMDS_NO_SOURCES
+
+Set this variable if you will be using schemas with no sources (tables) to
+disable the warning. The warning is there because this 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 SEE ALSO
General Catalyst Stuff:
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 Eldogan C<ozum@ozum.net>
+
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify it
+Copyright (c) 2006 - 2009
+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
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff