1 package Catalyst::Model::DBIC::Schema;
5 extends 'Catalyst::Model';
6 with 'CatalystX::Component::Traits';
10 use namespace::autoclean;
11 use Carp::Clan '^Catalyst::Model::DBIC::Schema';
16 use Catalyst::Model::DBIC::Schema::Types
17 qw/ConnectInfo LoadedClass/;
19 use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
23 Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
27 Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
33 Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
35 package MyApp::Schema::FilmDB;
36 use base qw/DBIx::Class::Schema/;
38 __PACKAGE__->load_classes(qw/Actor Role/);
42 Create some classes for the tables in the database, for example an
43 Actor in MyApp/Schema/FilmDB/Actor.pm:
45 package MyApp::Schema::FilmDB::Actor;
46 use base qw/DBIx::Class/
48 __PACKAGE__->load_components(qw/Core/);
49 __PACKAGE__->table('actor');
53 and a Role in MyApp/Schema/FilmDB/Role.pm:
55 package MyApp::Schema::FilmDB::Role;
56 use base qw/DBIx::Class/
58 __PACKAGE__->load_components(qw/Core/);
59 __PACKAGE__->table('role');
63 Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's
64 usable as a standalone module and you can test/run it without Catalyst.
68 To expose it to Catalyst as a model, you should create a DBIC Model in
69 MyApp/Model/FilmDB.pm:
71 package MyApp::Model::FilmDB;
72 use base qw/Catalyst::Model::DBIC::Schema/;
75 schema_class => 'MyApp::Schema::FilmDB',
79 password => "password",
83 See below for a full list of the possible config parameters.
87 Now you have a working Model which accesses your separate DBIC Schema. This can
88 be used/accessed in the normal Catalyst manner, via $c->model():
90 my $actor = $c->model('FilmDB::Actor')->find(1);
92 You can also use it to set up DBIC authentication with
93 L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
97 use Catalyst qw/... Authentication .../;
101 __PACKAGE__->config->{authentication} =
103 default_realm => 'members',
108 password_field => 'password',
109 password_type => 'hashed'
110 password_hash_type => 'SHA-256'
113 class => 'DBIx::Class',
114 user_model => 'DB::User',
115 role_relation => 'roles',
116 role_field => 'rolename',
122 C<< $c->model('Schema::Source') >> returns a L<DBIx::Class::ResultSet> for
123 the source name parameter passed. To find out more about which methods can
124 be called on a ResultSet, or how to add your own methods to it, please see
125 the ResultSet documentation in the L<DBIx::Class> distribution.
127 Some examples are given below:
129 # to access schema methods directly:
130 $c->model('FilmDB')->schema->source(...);
132 # to access the source object, resultset, and class:
133 $c->model('FilmDB')->source(...);
134 $c->model('FilmDB')->resultset(...);
135 $c->model('FilmDB')->class(...);
137 # For resultsets, there's an even quicker shortcut:
138 $c->model('FilmDB::Actor')
139 # is the same as $c->model('FilmDB')->resultset('Actor')
141 # To get the composed schema for making new connections:
142 my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
144 # Or the same thing via a convenience shortcut:
145 my $newconn = $c->model('FilmDB')->connect(...);
147 # or, if your schema works on different storage drivers:
148 my $newconn = $c->model('FilmDB')->composed_schema->clone();
149 $newconn->storage_type('::LDAP');
150 $newconn->connection(...);
152 # and again, a convenience shortcut
153 my $newconn = $c->model('FilmDB')->clone();
154 $newconn->storage_type('::LDAP');
155 $newconn->connection(...);
159 This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
160 the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
161 information on generating these Models via Helper scripts.
163 When your Catalyst app starts up, a thin Model layer is created as an
164 interface to your DBIC Schema. It should be clearly noted that the model
165 object returned by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or
166 resultset object, but merely a wrapper proving L<methods|/METHODS> to access
167 the underlying schema.
169 In addition to this model class, a shortcut class is generated for each
170 source in the schema, allowing easy and direct access to a resultset of the
171 corresponding type. These generated classes are even thinner than the model
172 class, providing no public methods but simply hooking into Catalyst's
173 model() accessor via the
174 L<ACCEPT_CONTEXT|Catalyst::Component/ACCEPT_CONTEXT> mechanism. The complete
175 contents of each generated class is roughly equivalent to the following:
177 package MyApp::Model::FilmDB::Actor
180 $c->model('FilmDB')->resultset('Actor');
183 In short, there are three techniques available for obtaining a DBIC
187 my $rs = $c->model('FilmDB')->schema->resultset('Actor');
189 # using the shortcut method on the model object
190 my $rs = $c->model('FilmDB')->resultset('Actor');
192 # using the generated class directly
193 my $rs = $c->model('FilmDB::Actor');
195 In order to add methods to a DBIC resultset, you cannot simply add them to
196 the source (row, table) definition class; you must define a separate custom
197 resultset class. See L<DBIx::Class::Manual::Cookbook/"Predefined searches">
200 =head1 CONFIG PARAMETERS
204 This is the classname of your L<DBIx::Class::Schema> Schema. It needs
205 to be findable in C<@INC>, but it does not need to be inside the
206 C<Catalyst::Model::> namespace. This parameter is required.
210 This is an arrayref of connection parameters, which are specific to your
211 C<storage_type> (see your storage type documentation for more details).
212 If you only need one parameter (e.g. the DSN), you can just pass a string
213 instead of an arrayref.
215 This is not required if C<schema_class> already has connection information
216 defined inside itself (which isn't highly recommended, but can be done)
218 For L<DBIx::Class::Storage::DBI>, which is the only supported
219 C<storage_type> in L<DBIx::Class> at the time of this writing, the
220 parameters are your dsn, username, password, and connect options hashref.
222 See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
223 of the arguments supported.
228 dsn => 'dbi:Pg:dbname=mypgdb',
234 dsn => 'dbi:SQLite:dbname=foo.db',
236 'PRAGMA synchronous = OFF',
241 dsn => 'dbi:Pg:dbname=mypgdb',
246 'some SQL statement',
247 'another SQL statement',
251 Or using L<Config::General>:
254 schema_class MyApp::Schema::FilmDB
257 dsn dbi:Pg:dbname=mypgdb
262 on_connect_do some SQL statement
263 on_connect_do another SQL statement
270 schema_class MyApp::Schema::FilmDB
271 connect_info dbi:SQLite:dbname=foo.db
284 on_connect_do: [ "alter session set nls_date_format = 'YYYY-MM-DD HH24:MI:SS'" ]
285 cursor_class: 'DBIx::Class::Cursor::Cached'
288 The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
292 'dbi:Pg:dbname=mypgdb',
301 'some SQL statement',
302 'another SQL statement',
309 Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
311 They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then the C<<
312 Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless prefixed with C<+>
313 in which case they are taken to be a fully qualified name. E.g.:
316 traits +MyApp::TraitFor::Model::Foo
318 A new instance is created at application time, so any consumed required
319 attributes, coercions and modifiers will work.
321 Traits are applied at L<Catalyst::Component/COMPONENT> time using
322 L<CatalystX::Component::Traits>.
324 C<ref $self> will be an anon class if any traits are applied, C<<
325 $self->_original_class_name >> will be the original class.
327 When writing a Trait, interesting points to modify are C<BUILD>, L</setup> and
330 Traits that come with the distribution:
334 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
336 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
342 Allows the use of a different C<storage_type> than what is set in your
343 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
344 L<DBIx::Class>). Completely optional, and probably unnecessary for most
345 people until other storage backends become available for L<DBIx::Class>.
349 The keys you pass in the model configuration are available as attributes.
351 Other attributes available:
355 Your connect_info args normalized to hashref form (with dsn/user/password.) See
356 L<DBIx::Class::Storage::DBI/connect_info> for more info on the hashref form of
361 The model name L<Catalyst> uses to resolve this model, the part after
362 C<::Model::> or C<::M::> in your class name. E.g. if your class name is
363 C<MyApp::Model::DB> the L</model_name> will be C<DB>.
365 =head2 _default_cursor_class
367 What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
368 doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
370 =head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
372 =head2 _original_class_name
374 The class name of your model before any L</traits> are applied. E.g.
379 Unresolved arrayref of traits passed in the config.
381 =head2 _resolved_traits
383 Traits you used resolved to full class names.
389 Instantiates the Model based on the above-documented ->config parameters.
390 The only required parameter is C<schema_class>. C<connect_info> is
391 required in the case that C<schema_class> does not already have connection
392 information defined for it.
396 Accessor which returns the connected schema being used by the this model.
397 There are direct shortcuts on the model class itself for
398 schema->resultset, schema->source, and schema->class.
400 =head2 composed_schema
402 Accessor which returns the composed schema, which has no connection info,
403 which was used in constructing the C<schema> above. Useful for creating
404 new connections based on the same schema/model. There are direct shortcuts
405 from the model object for composed_schema->clone and composed_schema->connect
409 Shortcut for ->composed_schema->clone
413 Shortcut for ->composed_schema->connect
417 Shortcut for ->schema->source
421 Shortcut for ->schema->class
425 Shortcut for ->schema->resultset
429 Provides an accessor for the connected schema's storage object.
430 Used often for debugging and controlling transactions.
434 has schema => (is => 'rw', isa => 'DBIx::Class::Schema');
436 has schema_class => (
443 has storage_type => (is => 'rw', isa => Str);
445 has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
454 has _default_cursor_class => (
457 default => 'DBIx::Class::Storage::DBI::Cursor',
463 my $class = $self->_original_class_name;
464 my $schema_class = $self->schema_class;
466 if( !$self->connect_info ) {
467 if($schema_class->storage && $schema_class->storage->connect_info) {
468 $self->connect_info($schema_class->storage->connect_info);
471 die "Either ->config->{connect_info} must be defined for $class"
472 . " or $schema_class must have connect info defined on it."
473 . " Here's what we got:\n"
478 if (exists $self->connect_info->{cursor_class}) {
479 eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
480 or croak "invalid connect_info: Cannot load your cursor_class"
481 . " ".$self->connect_info->{cursor_class}.": $@";
486 $self->composed_schema($schema_class->compose_namespace($class));
488 $self->schema($self->composed_schema->clone);
490 $self->schema->storage_type($self->storage_type)
491 if $self->storage_type;
493 $self->schema->connection($self->connect_info);
495 $self->_install_rs_models;
498 sub clone { shift->composed_schema->clone(@_); }
500 sub connect { shift->composed_schema->connect(@_); }
502 sub storage { shift->schema->storage(@_); }
504 sub resultset { shift->schema->resultset(@_); }
508 Called at C<BUILD>> time before configuration, but after L</connect_info> is
509 set. To do something after configuuration use C<< after BUILD => >>.
515 =head2 ACCEPT_CONTEXT
517 Point of extension for doing things at C<< $c->model >> time with context,
518 returns the model instance, see L<Catalyst::Manual::Intro/ACCEPT_CONTEXT> for
523 sub ACCEPT_CONTEXT { shift }
525 sub _install_rs_models {
527 my $class = $self->_original_class_name;
531 my @sources = $self->schema->sources;
533 die "No sources found (did you forget to define your tables?)"
536 foreach my $moniker (@sources) {
537 my $classname = "${class}::$moniker";
538 *{"${classname}::ACCEPT_CONTEXT"} = sub {
540 shift->model($self->model_name)->resultset($moniker);
545 sub _reset_cursor_class {
548 if ($self->storage->can('cursor_class')) {
549 $self->storage->cursor_class($self->_default_cursor_class)
550 if $self->storage->cursor_class ne $self->_default_cursor_class;
557 sub composed_schema {
559 my $class = $self->_original_class_name;
560 my $store = \$COMPOSED_CACHE{$class}{$self->schema_class};
562 $$store = shift if @_;
568 sub _build_model_name {
570 my $class = $self->_original_class_name;
571 (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
576 __PACKAGE__->meta->make_immutable;
580 General Catalyst Stuff:
582 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
583 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
585 Stuff related to DBIC and this Model style:
587 L<DBIx::Class>, L<DBIx::Class::Schema>,
588 L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
589 L<MooseX::Object::Pluggable>
593 L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
594 L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
598 Brandon L Black, C<blblack at gmail.com>
602 Rafael Kitover, C<rkitover at cpan.org>
606 This program is free software, you can redistribute it and/or modify it
607 under the same terms as Perl itself.