package Catalyst::Model::DBIC::Schema;
use strict;
-use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
+use base qw/Catalyst::Model/;
use NEXT;
use UNIVERSAL::require;
use Carp;
use Data::Dumper;
require DBIx::Class;
-our $VERSION = '0.16';
-
-__PACKAGE__->mk_classaccessor('composed_schema');
-__PACKAGE__->mk_accessors('schema');
+our $VERSION = '0.17_01';
=head1 NAME
Some examples are given below:
- # to access schema methods directly:
- $c->model('FilmDB')->schema->source(...);
-
- # to access the source object, resultset, and class:
+ # You can access schema-level methods directly from the top-level model:
$c->model('FilmDB')->source(...);
$c->model('FilmDB')->resultset(...);
$c->model('FilmDB')->class(...);
+ $c->model('FilmDB')->any_other_schema_method(...);
# For resultsets, there's an even quicker shortcut:
$c->model('FilmDB::Actor')
# is the same as $c->model('FilmDB')->resultset('Actor')
- # To get the composed schema for making new connections:
- my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
-
- # Or the same thing via a convenience shortcut:
- my $newconn = $c->model('FilmDB')->connect(...);
-
- # or, if your schema works on different storage drivers:
- my $newconn = $c->model('FilmDB')->composed_schema->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
-
- # and again, a convenience shortcut
- my $newconn = $c->model('FilmDB')->clone();
- $newconn->storage_type('::LDAP');
- $newconn->connection(...);
-
=head1 DESCRIPTION
This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
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 more details.
Examples:
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>.
+L<DBIx::Class>).
=back
required in the case that C<schema_class> does not already have connection
information defined for it.
-=item 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
-
-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
-
-Shortcut for ->composed_schema->clone
-
-=item connect
-
-Shortcut for ->composed_schema->connect
-
-=item source
-
-Shortcut for ->schema->source
-
-=item class
-
-Shortcut for ->schema->class
+=item COMPONENT
-=item resultset
-
-Shortcut for ->schema->resultset
-
-=item storage
-
-Provides an accessor for the connected schema's storage object.
-Used often for debugging and controlling transactions.
+Tells the Catalyst component architecture that the encapsulated schema
+object is to be returned for $c->model calls for this model name.
=back
my $schema_class = $self->{schema_class};
$schema_class->require
- or croak "Cannot load schema class '$schema_class': $@";
-
- if( !$self->{connect_info} ) {
- if($schema_class->storage && $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"
- . "Here's what we got:\n"
- . Dumper($self);
- }
- }
-
- $self->composed_schema($schema_class->compose_namespace($class));
- $self->schema($self->composed_schema->clone);
+ or croak "Cannot load schema_class '$schema_class': $@";
- $self->schema->storage_type($self->{storage_type})
- if $self->{storage_type};
+ my $schema_obj = $schema_class->clone;
+ $schema_obj->storage_type($self->{storage_type}) if $self->{storage_type};
+ $schema_obj->connection(@{$self->{connect_info}}) if $self->{connect_info};
- # 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
- # -current 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;
- }
- }
-
- $self->schema->connection(@$connect_info);
-
- 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}
- );
- }
+ if(!$schema_obj->storage) {
+ croak "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);
}
- # XXX end of compatibility block referenced above
+ $self->{schema_obj} = $schema_obj;
no strict 'refs';
foreach my $moniker ($self->schema->sources) {
my $classname = "${class}::$moniker";
+ # XXX -- Does this need to be dynamic, or can it be done w/ COMPONENT too?
*{"${classname}::ACCEPT_CONTEXT"} = sub {
shift;
shift->model($model_name)->resultset($moniker);
return $self;
}
-sub clone { shift->composed_schema->clone(@_); }
-
-sub connect { shift->composed_schema->connect(@_); }
-
-sub storage { shift->schema->storage(@_); }
+sub COMPONENT { shift->{schema_obj} }
=head1 SEE ALSO
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff