1 package Catalyst::Model::DBIC::Schema;
4 use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
6 use UNIVERSAL::require;
11 __PACKAGE__->mk_classaccessor('composed_schema');
12 __PACKAGE__->mk_accessors('schema');
16 Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
20 package MyApp::Model::Foo;
22 use base 'Catalyst::Model::DBIC::Schema';
25 schema_class => 'Foo::SchemaClass',
26 connect_info => [ 'dbi:Pg:dbname=foodb',
37 # ->schema To access schema methods:
38 $c->model('Foo')->schema->source(...);
40 # certain ->schema methods (source, resultset, class) have shortcuts
41 $c->model('Foo')->source(...);
42 $c->model('Foo')->resultset(...);
43 $c->model('Foo')->class(...);
45 # For resultsets, there's an even quicker shortcut:
47 # is the same as $c->model('Foo')->resultset('Bar')
49 # To get the composed schema for making new connections:
50 my $newconn = $c->model('Foo')->composed_schema->connect(...);
52 # Or the same thing via a convenience shortcut:
53 my $newconn = $c->model('Foo')->connect(...);
55 # or, if your schema works on different storage drivers:
56 my $newconn = $c->model('Foo')->composed_schema->clone();
57 $newconn->storage_type('::LDAP');
58 $newconn->connect(...);
60 # and again, a convenience shortcut
61 my $newconn = $c->model('Foo')->clone();
62 $newconn->storage_type('::LDAP');
63 $newconn->connect(...);
67 This is a Catalyst Model for L<DBIx::Class::Schema>-based Models.
69 =head1 CONFIG PARAMETERS
75 This is the classname of your L<DBIx::Class::Schema> Schema. It needs
76 to be findable in C<@INC>, but it does not need to be underneath
77 C<Catalyst::Model::>. This parameter is required.
81 This is an arrayref of connection parameters, which are specific to your
82 C<storage_type>. For C<::DBI>, which is the only supported C<storage_type>
83 in L<DBIx::Class> at the time of this writing, the 4 parameters are your
84 dsn, username, password, and connect options hashref.
86 This is not required if C<schema_class> already has connection information
87 defined in itself (which would be the case for a Schema defined by
88 L<DBIx::Class::Schema::Loader>, for instance).
92 Allows the use of a different C<storage_type> than what is set in your
93 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
94 L<DBIx::Class>). Completely optional, and probably unneccesary for most
95 people, until other storage backends become available for L<DBIx::Class>.
105 Instantiates the Model based on the above-documented ->config parameters.
106 The only required parameter is C<schema_class>. C<connect_info> is
107 required in the case that C<schema_class> does not already have connection
108 information defined for it.
112 Accessor which returns the connected schema being used by the this model.
113 There are already direct shortcuts on the model class itself for
114 schema->resultset, schema->source, and schema->class.
116 =item composed_schema
118 Accessor which returns the composed schema, which has no connection info,
119 which was used in constructing the C<schema> above. Useful for creating
120 new connections based on the same schema/model. There are direct shortcuts
121 from the model object for composed_schema->clone and composed_schema->connect
125 Shortcut for ->composed_schema->clone
129 Shortcut for ->composed_schema->connect
133 Shortcut for ->schema->source
137 Shortcut for ->schema->class
141 Shortcut for ->schema->resultset
148 my $self = shift->NEXT::new(@_);
150 my $class = ref($self);
151 my $model_name = $class;
152 $model_name =~ s/^[\w:]+::(?:Model|M):://;
154 croak "->config->{schema_class} must be defined for this model"
155 unless $self->{schema_class};
157 my $schema_class = $self->{schema_class};
159 $schema_class->require
160 or croak "Cannot load schema class '$schema_class': $@";
162 if( !$self->{connect_info} ) {
163 if($schema_class->storage && $schema_class->storage->connect_info) {
164 $self->{connect_info} = $schema_class->storage->connect_info;
167 croak "Either ->config->{connect_info} must be defined for $class"
168 . " or $schema_class must have connection defined on it";
172 $self->composed_schema($schema_class->compose_namespace($class));
173 $self->schema($self->composed_schema->clone);
174 $self->schema->storage_type($self->{storage_type}) if $self->{storage_type};
175 $self->schema->connection(@{$self->{connect_info}});
178 foreach my $moniker ($self->schema->sources) {
179 *{"${class}::${moniker}::ACCEPT_CONTEXT"} = sub {
181 shift->model($model_name)->resultset($moniker);
188 sub clone { shift->composed_schema->clone(@_); }
190 sub connect { shift->composed_schema->connect(@_); }
194 L<Catalyst>, L<DBIx::Class>, L<DBIx::Class::Schema>,
195 L<DBIx::Class::Schema::Loader>
199 Brandon L Black, C<blblack@gmail.com>
203 This program is free software, you can redistribute it and/or modify it
204 under the same terms as Perl itself.