1 package Catalyst::Model::DBIC::Schema;
4 use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
6 use UNIVERSAL::require;
10 our $VERSION = '0.14';
12 __PACKAGE__->mk_classaccessor('composed_schema');
13 __PACKAGE__->mk_accessors('schema');
17 Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
21 Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
27 Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
29 package MyApp::Schema::FilmDB;
30 use base qw/DBIx::Class::Schema/;
32 __PACKAGE__->load_classes(qw/Actor Role/);
36 Create some classes for the tables in the database, for example an
37 Actor in MyApp/Schema/FilmDB/Actor.pm:
39 package MyApp::Schema::FilmDB::Actor;
40 use base qw/DBIx::Class/
42 __PACKAGE__->load_components(qw/Core/);
43 __PACKAGE__->table('actor');
47 and a Role in MyApp/Schema/Role.pm:
49 package MyApp::Schema::FilmDB::Role;
50 use base qw/DBIx::Class/
52 __PACKAGE__->load_components(qw/Core/);
53 __PACKAGE__->table('role');
57 Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's
58 usable as a standalone module and you can test/run it without Catalyst.
62 To expose it to Catalyst as a model, you should create a DBIC Model in
63 MyApp/Model/FilmDB.pm:
65 package MyApp::Model::FilmDB;
66 use base qw/Catalyst::Model::DBIC::Schema/;
69 schema_class => 'MyApp::Schema::FilmDB',
78 See below for a full list of the possible config parameters.
82 Now you have a working Model, accessing your separate DBIC Schema. Which can
83 be used/accessed in the normal Catalyst manner, via $c->model():
85 my $actor = $c->model('FilmDB::Actor')->find(1);
87 You can also use it to set up DBIC authentication with
88 Authentication::Store::DBIC in MyApp.pm:
92 use Catalyst qw/... Authentication::Store::DBIC/;
96 __PACKAGE__->config->{authentication}{dbic} = {
97 user_class => 'FilmDB::Actor',
99 password_field => 'password'
102 C<< $c->model() >> returns a L<DBIx::Class::ResultSet> for the source name
103 parameter passed. To find out more about which methods can be called on a
104 ResultSet, or how to add your own methods to it, please see the ResultSet
105 documentation in the L<DBIx::Class> distribution.
107 Some examples are given below:
109 # to access schema methods directly:
110 $c->model('FilmDB')->schema->source(...);
112 # to access the source object, resultset, and class:
113 $c->model('FilmDB')->source(...);
114 $c->model('FilmDB')->resultset(...);
115 $c->model('FilmDB')->class(...);
117 # For resultsets, there's an even quicker shortcut:
118 $c->model('FilmDB::Actor')
119 # is the same as $c->model('FilmDB')->resultset('Actor')
121 # To get the composed schema for making new connections:
122 my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
124 # Or the same thing via a convenience shortcut:
125 my $newconn = $c->model('FilmDB')->connect(...);
127 # or, if your schema works on different storage drivers:
128 my $newconn = $c->model('FilmDB')->composed_schema->clone();
129 $newconn->storage_type('::LDAP');
130 $newconn->connection(...);
132 # and again, a convenience shortcut
133 my $newconn = $c->model('FilmDB')->clone();
134 $newconn->storage_type('::LDAP');
135 $newconn->connection(...);
139 This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
140 the documentation for L<Catalyst::Helper::Model::DBIC::Schema> and
141 L<Catalyst::Helper::Model::DBIC::SchemaLoader> for information
142 on generating these Models via Helper scripts. The latter of the two
143 will also generated a L<DBIx::Class::Schema::Loader>-based Schema class
146 =head1 CONFIG PARAMETERS
152 This is the classname of your L<DBIx::Class::Schema> Schema. It needs
153 to be findable in C<@INC>, but it does not need to be inside the
154 C<Catalyst::Model::> namespace. This parameter is required.
158 This is an arrayref of connection parameters, which are specific to your
159 C<storage_type> (see your storage type documentation for more details).
161 This is not required if C<schema_class> already has connection information
162 defined inside itself (which isn't highly recommended, but can be done)
164 For L<DBIx::Class::Storage::DBI>, which is the only supported
165 C<storage_type> in L<DBIx::Class> at the time of this writing, the
166 parameters are your dsn, username, password, and connect options hashref.
168 If you need to specify the L<DBIx::Class::Storage::DBI> specific parameter
169 C<on_connect_do>, or the related C<sql_maker> options C<limit_dialect>,
170 C<quote_char>, or C<name_sep>, you can place these options into a hashref
171 as the final element of the C<connect_info> arrayref. If in doubt, don't
172 specify these options. You would know it if you needed them.
176 connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
179 'dbi:SQLite:dbname=foo.db',
182 'PRAGMA synchronous = OFF',
188 'dbi:Pg:dbname=mypgdb',
194 'some SQL statement',
195 'another SQL statement',
202 Allows the use of a different C<storage_type> than what is set in your
203 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
204 L<DBIx::Class>). Completely optional, and probably unnecessary for most
205 people until other storage backends become available for L<DBIx::Class>.
215 Instantiates the Model based on the above-documented ->config parameters.
216 The only required parameter is C<schema_class>. C<connect_info> is
217 required in the case that C<schema_class> does not already have connection
218 information defined for it.
222 Accessor which returns the connected schema being used by the this model.
223 There are direct shortcuts on the model class itself for
224 schema->resultset, schema->source, and schema->class.
226 =item composed_schema
228 Accessor which returns the composed schema, which has no connection info,
229 which was used in constructing the C<schema> above. Useful for creating
230 new connections based on the same schema/model. There are direct shortcuts
231 from the model object for composed_schema->clone and composed_schema->connect
235 Shortcut for ->composed_schema->clone
239 Shortcut for ->composed_schema->connect
243 Shortcut for ->schema->source
247 Shortcut for ->schema->class
251 Shortcut for ->schema->resultset
255 Provides an accessor for the connected schema's storage object.
256 Used often for debugging and controlling transactions.
263 my $self = shift->NEXT::new(@_);
265 my $class = ref($self);
266 my $model_name = $class;
267 $model_name =~ s/^[\w:]+::(?:Model|M):://;
269 croak "->config->{schema_class} must be defined for this model"
270 unless $self->{schema_class};
272 my $schema_class = $self->{schema_class};
274 $schema_class->require
275 or croak "Cannot load schema class '$schema_class': $@";
277 if( !$self->{connect_info} ) {
278 if($schema_class->storage && $schema_class->storage->connect_info) {
279 $self->{connect_info} = $schema_class->storage->connect_info;
282 croak "Either ->config->{connect_info} must be defined for $class"
283 . " or $schema_class must have connect info defined on it";
287 $self->composed_schema($schema_class->compose_namespace($class));
288 $self->schema($self->composed_schema->clone);
290 $self->schema->storage_type($self->{storage_type})
291 if $self->{storage_type};
293 # XXX This is temporary, until DBIx::Class::Storage::DBI supports the
294 # same syntax and we switch our requisite to that version somewhere
295 # down the line. This syntax is already committed into DBIx::Class
296 # -current branch post-0.06.
297 # At that time, this whole block can revert back to just being:
298 # $self->schema->connection(@{$self->{connect_info}});
300 my $connect_info = [ @{$self->{connect_info}} ];
301 my ($on_connect_do, %sql_maker_opts);
302 if($DBIx::Class::VERSION < 0.069) {
304 my $last_info = $self->{connect_info}->[-1];
305 if(ref $last_info eq 'HASH') {
306 if($on_connect_do = $last_info->{on_connect_do}) {
309 for my $sql_maker_opt (qw/limit_dialect quote_char name_sep/) {
310 if(my $opt_val = $last_info->{$sql_maker_opt}) {
312 $sql_maker_opts{$sql_maker_opt} = $opt_val;
315 pop(@$connect_info) if $used;
319 $self->schema->connection(@$connect_info);
321 if($DBIx::Class::VERSION < 0.069) {
322 $self->schema->storage->on_connect_do($on_connect_do)
324 foreach my $sql_maker_opt (keys %sql_maker_opts) {
325 $self->schema->storage->sql_maker->$sql_maker_opt(
326 $sql_maker_opts{$sql_maker_opt}
331 # XXX end of compatibility block referenced above
334 foreach my $moniker ($self->schema->sources) {
335 my $classname = "${class}::$moniker";
336 *{"${classname}::ACCEPT_CONTEXT"} = sub {
338 shift->model($model_name)->resultset($moniker);
345 sub clone { shift->composed_schema->clone(@_); }
347 sub connect { shift->composed_schema->connect(@_); }
349 sub storage { shift->schema->storage(@_); }
353 General Catalyst Stuff:
355 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
356 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
358 Stuff related to DBIC and this Model style:
360 L<DBIx::Class>, L<DBIx::Class::Schema>,
361 L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
362 L<Catalyst::Helper::Model::DBIC::SchemaLoader>
366 Brandon L Black, C<blblack@gmail.com>
370 This program is free software, you can redistribute it and/or modify it
371 under the same terms as Perl itself.