1 package Catalyst::Model::DBIC::Schema;
5 extends 'Catalyst::Model';
6 with 'CatalystX::Component::Traits';
9 $VERSION = eval $VERSION;
11 use namespace::autoclean;
12 use Carp::Clan '^Catalyst::Model::DBIC::Schema';
16 use Catalyst::Model::DBIC::Schema::Types
17 qw/ConnectInfo LoadedClass SchemaClass Schema/;
19 use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
23 Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
27 First, prepare your database schema using L<DBIx::Class>, see
28 L<Catalyst::Helper::Model::DBIC::Schema> for how to generate a
29 L<DBIx::Class::Schema> from your database using the Helper script, and
30 L<DBIx::Class::Schema::Loader::Base>.
32 A typical usage of the helper script would be:
34 script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB \
35 create=static dbi:mysql:filmdb dbusername dbpass \
38 If you are unfamiliar with L<DBIx::Class>, see L<DBIx::Class::Manual::Intro>
41 These examples assume that you already have a schema called
42 C<MyApp::Schema::FilmDB>, which defines some Result classes for tables in
43 C<MyApp::Schema::FilmDB::Result::Actor> and
44 C<MyApp::Schema::FilmDB::Result::Film>. Either created by the helper script (as
45 shown above) or manually.
47 The helper also creates a Model in C<lib/MyApp/Model/FilmDB.pm>, if you already
48 have a schema you can create just the Model using:
50 script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB
51 dbi:mysql:filmdb dbusername dbpass
53 The connect_info is optional and will be hardcoded into the Model if provided.
54 It's better to configure it in your L<Catalyst> config file, which will also
55 override any hardcoded config, see L</connect_info> for examples.
57 Now you have a working Model which accesses your separate DBIC Schema. This can
58 be used/accessed in the normal Catalyst manner, via C<< $c->model() >>:
60 my $db_model = $c->model('FilmDB'); # a Catalyst::Model
61 my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object
63 There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
64 instead of a L<Catalyst::Model>:
66 my $rs = $c->model('FilmDB::Actor');
68 See L<DBIx::Class::ResultSet> to find out more about which methods can be
71 You can also define your own ResultSet methods to encapsulate the
72 database/business logic of your applications. These go into, for example,
73 C<lib/MyApp/Schema/FilmDB/ResultSet/Actor.pm>. The class must inherit from
74 L<DBIx::Class::ResultSet> and is automatically loaded.
76 Then call your methods like any other L<DBIx::Class::ResultSet> method:
78 $c->model('FilmDB::Actor')->SAG_members
82 # to access schema methods directly:
83 $c->model('FilmDB')->schema->source(...);
85 # to access the source object, resultset, and class:
86 $c->model('FilmDB')->source(...);
87 $c->model('FilmDB')->resultset(...);
88 $c->model('FilmDB')->class(...);
90 # For resultsets, there's an even quicker shortcut:
91 $c->model('FilmDB::Actor')
92 # is the same as $c->model('FilmDB')->resultset('Actor')
94 # To get the composed schema for making new connections:
95 my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
97 # Or the same thing via a convenience shortcut:
98 my $newconn = $c->model('FilmDB')->connect(...);
100 # or, if your schema works on different storage drivers:
101 my $newconn = $c->model('FilmDB')->composed_schema->clone();
102 $newconn->storage_type('::LDAP');
103 $newconn->connection(...);
105 # and again, a convenience shortcut
106 my $newconn = $c->model('FilmDB')->clone();
107 $newconn->storage_type('::LDAP');
108 $newconn->connection(...);
110 To set up authentication, see L</"Setting up DBIC authentication"> below.
114 This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
115 the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
116 information on generating these Models via Helper scripts.
118 When your Catalyst app starts up, a thin Model layer is created as an interface
119 to your DBIC Schema. It should be clearly noted that the model object returned
120 by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or resultset object,
121 but merely a wrapper proving L<methods|/METHODS> to access the underlying
124 In addition to this model class, a shortcut class is generated for each
125 source in the schema, allowing easy and direct access to a resultset of the
126 corresponding type. These generated classes are even thinner than the model
127 class, providing no public methods but simply hooking into Catalyst's
128 model() accessor via the
129 L<ACCEPT_CONTEXT|Catalyst::Component/ACCEPT_CONTEXT> mechanism. The complete
130 contents of each generated class is roughly equivalent to the following:
132 package MyApp::Model::FilmDB::Actor
135 $c->model('FilmDB')->resultset('Actor');
138 In short, there are three techniques available for obtaining a DBIC
142 my $rs = $c->model('FilmDB')->schema->resultset('Actor');
144 # using the shortcut method on the model object
145 my $rs = $c->model('FilmDB')->resultset('Actor');
147 # using the generated class directly
148 my $rs = $c->model('FilmDB::Actor');
150 In order to add methods to a DBIC resultset, you cannot simply add them to
151 the source (row, table) definition class; you must define a separate custom
152 resultset class. This is just a matter of making a
153 C<lib/MyApp/Schema/ResultSet/Actor.pm> class that inherits from
154 L<DBIx::Class::ResultSet>, if you are using
155 L<DBIx::Class::Schema/load_namespaces>, the default for helper script generated
158 See L<DBIx::Class::Manual::Cookbook/"Predefined searches">
159 for information on definining your own L<DBIx::Class::ResultSet> classes for
160 use with L<DBIx::Class::Schema/load_classes>, the old default.
162 =head1 CONFIG PARAMETERS
166 This is the classname of your L<DBIx::Class::Schema> Schema. It needs
167 to be findable in C<@INC>, but it does not need to be inside the
168 C<Catalyst::Model::> namespace. This parameter is required.
172 This is a hashref or arrayref of connection parameters, which are specific to
173 your C<storage_type> (see your storage type documentation for more details). If
174 you only need one parameter (e.g. the DSN), you can just pass a string.
176 This is not required if C<schema_class> already has connection information
177 defined inside itself (which isn't highly recommended, but can be done.)
179 For L<DBIx::Class::Storage::DBI>, which is the only supported
180 C<storage_type> in L<DBIx::Class> at the time of this writing, the
181 parameters are your dsn, username, password, and connect options hashref.
183 See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
184 of the arguments supported.
189 dsn => 'dbi:Pg:dbname=mypgdb',
195 dsn => 'dbi:SQLite:dbname=foo.db',
197 'PRAGMA synchronous = OFF',
202 dsn => 'dbi:Pg:dbname=mypgdb',
207 'some SQL statement',
208 'another SQL statement',
212 Or using L<Config::General>:
215 schema_class MyApp::Schema::FilmDB
218 dsn dbi:Pg:dbname=mypgdb
223 on_connect_do some SQL statement
224 on_connect_do another SQL statement
226 user_defined_schema_accessor foo
232 schema_class MyApp::Schema::FilmDB
233 connect_info dbi:SQLite:dbname=foo.db
247 on_connect_call: 'datetime_setup'
250 The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
254 'dbi:Pg:dbname=mypgdb',
263 'some SQL statement',
264 'another SQL statement',
271 Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
273 They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then
274 the C<< Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless
275 prefixed with C<+> in which case they are taken to be a fully qualified name.
279 traits +MyApp::TraitFor::Model::Foo
281 A new instance is created at application time, so any consumed required
282 attributes, coercions and modifiers will work.
284 Traits are applied at L<Catalyst::Component/COMPONENT> time using
285 L<CatalystX::Component::Traits>.
287 C<ref $self> will be an anon class if any traits are applied, C<<
288 $self->_original_class_name >> will be the original class.
290 When writing a Trait, interesting points to modify are C<BUILD>, L</setup> and
293 Traits that come with the distribution:
297 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
299 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
301 =item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
307 Allows the use of a different C<storage_type> than what is set in your
308 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
309 L<DBIx::Class>). Completely optional, and probably unnecessary for most
310 people until other storage backends become available for L<DBIx::Class>.
314 The keys you pass in the model configuration are available as attributes.
316 Other attributes available:
320 Your connect_info args normalized to hashref form (with dsn/user/password.) See
321 L<DBIx::Class::Storage::DBI/connect_info> for more info on the hashref form of
326 The model name L<Catalyst> uses to resolve this model, the part after
327 C<::Model::> or C<::M::> in your class name. E.g. if your class name is
328 C<MyApp::Model::DB> the L</model_name> will be C<DB>.
330 =head2 _default_cursor_class
332 What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
333 doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
335 =head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
337 =head2 _original_class_name
339 The class name of your model before any L</traits> are applied. E.g.
344 Unresolved arrayref of traits passed in the config.
346 =head2 _resolved_traits
348 Traits you used resolved to full class names.
350 =head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
352 See the documentation for
353 L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
354 to pass config values from your L<Catalyst> config to your
355 L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
361 Instantiates the Model based on the above-documented ->config parameters.
362 The only required parameter is C<schema_class>. C<connect_info> is
363 required in the case that C<schema_class> does not already have connection
364 information defined for it.
368 Accessor which returns the connected schema being used by the this model.
369 There are direct shortcuts on the model class itself for
370 schema->resultset, schema->source, and schema->class.
372 =head2 composed_schema
374 Accessor which returns the composed schema, which has no connection info,
375 which was used in constructing the C<schema> above. Useful for creating
376 new connections based on the same schema/model. There are direct shortcuts
377 from the model object for composed_schema->clone and composed_schema->connect
381 Shortcut for ->composed_schema->clone
385 Shortcut for ->composed_schema->connect
389 Shortcut for ->schema->source
393 Shortcut for ->schema->class
397 Shortcut for ->schema->resultset
401 Shortcut for ->schema->txn_do
403 =head2 txn_scope_guard
405 Shortcut for ->schema->txn_scope_guard
409 Provides an accessor for the connected schema's storage object.
411 See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
415 has schema_class => (
422 has storage_type => (is => 'rw', isa => Str);
424 has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
433 has _default_cursor_class => (
436 default => 'DBIx::Class::Storage::DBI::Cursor',
440 has schema => (is => 'rw', isa => Schema);
444 before COMPONENT => sub {
445 $app_class = ref $_[1] || $_[1];
448 sub app_class { $app_class }
451 my ($self, $args) = @_;
452 my $class = $self->_original_class_name;
453 my $schema_class = $self->schema_class;
455 if( !$self->connect_info ) {
456 if($schema_class->storage && $schema_class->storage->connect_info) {
457 $self->connect_info($schema_class->storage->connect_info);
460 die "Either ->config->{connect_info} must be defined for $class"
461 . " or $schema_class must have connect info defined on it."
462 . " Here's what we got:\n"
467 if (exists $self->connect_info->{cursor_class}) {
468 eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
469 or croak "invalid connect_info: Cannot load your cursor_class"
470 . " ".$self->connect_info->{cursor_class}.": $@";
475 my $is_installed = defined $self->composed_schema;
477 $self->composed_schema($schema_class->compose_namespace($class))
478 unless $is_installed;
480 $self->schema($self->composed_schema->clone)
481 unless $self->schema;
483 $self->schema->storage_type($self->storage_type)
484 if $self->storage_type;
486 $self->schema->connection($self->connect_info);
488 $self->_install_rs_models unless $is_installed;
491 sub clone { shift->composed_schema->clone(@_); }
493 sub connect { shift->composed_schema->connect(@_); }
495 # some proxy methods, see also SchemaProxy
497 sub resultset { shift->schema->resultset(@_); }
499 sub txn_do { shift->schema->txn_do(@_); }
501 sub txn_scope_guard { shift->schema->txn_scope_guard(@_); }
503 sub storage { shift->schema->storage(@_); }
507 Called at C<BUILD> time before configuration, but after L</connect_info> is
508 set. To do something after configuuration use C<< after BUILD => >>.
510 Receives a hashref of args passed to C<BUILD>.
516 =head2 ACCEPT_CONTEXT
518 Point of extension for doing things at C<< $c->model >> time with context,
519 returns the model instance, see L<Catalyst::Manual::Intro/ACCEPT_CONTEXT> for
524 sub ACCEPT_CONTEXT { shift }
526 sub _install_rs_models {
528 my $class = $self->_original_class_name;
532 my @sources = $self->schema->sources;
535 warn <<'EOF' unless $ENV{CMDS_NO_SOURCES};
536 ******************************* WARNING ***************************************
537 * No sources found (did you forget to define your tables?) *
539 * To turn off this warning, set the CMDS_NO_SOURCES environment variable. *
540 *******************************************************************************
544 foreach my $moniker (@sources) {
545 my $classname = "${class}::$moniker";
546 *{"${classname}::ACCEPT_CONTEXT"} = sub {
548 shift->model($self->model_name)->resultset($moniker);
553 sub _reset_cursor_class {
556 if ($self->storage->can('cursor_class')) {
557 $self->storage->cursor_class($self->_default_cursor_class)
558 if $self->storage->cursor_class ne $self->_default_cursor_class;
565 sub composed_schema {
567 my $class = $self->_original_class_name;
568 my $store = \$COMPOSED_CACHE{$class}{$self->schema_class};
570 $$store = shift if @_;
576 sub _build_model_name {
578 my $class = $self->_original_class_name;
579 (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
584 __PACKAGE__->meta->make_immutable;
590 =item CMDS_NO_SOURCES
592 Set this variable if you will be using schemas with no sources (Result classes)
593 to disable the warning. The warning is there because having no Result classes
594 is usually a mistake.
598 =head1 Setting up DBIC authentication
600 You can set this up with
601 L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
605 use Catalyst qw/... Authentication .../;
609 __PACKAGE__->config('Plugin::Authentication' =>
611 default_realm => 'members',
615 password_field => 'password',
616 password_type => 'hashed'
617 password_hash_type => 'SHA-256'
620 class => 'DBIx::Class',
621 user_model => 'DB::User',
622 role_relation => 'roles',
623 role_field => 'rolename',
628 =head1 METHOD PROXYING
630 The automatic proxying to the underlying L<DBIx::Class::Schema> has been
631 removed as of version C<0.34>, to enable this feature add C<SchemaProxy> to
634 See L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>.
638 General Catalyst Stuff:
640 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
641 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
643 Stuff related to DBIC and this Model style:
645 L<DBIx::Class>, L<DBIx::Class::Schema>,
646 L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
647 L<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
651 L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
652 L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>,
653 L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
654 L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
658 Brandon L Black C<blblack at gmail.com>
662 caelum: Rafael Kitover C<rkitover at cpan.org>
664 dandv: Dan Dascalescu C<dandv at cpan.org>
666 bluefeet: Aran Deltac C<bluefeet@cpan.org>
668 t0m: Tomas Doran C<bobtfish@bobtfish.net>
670 osfameron: C<osfameron@cpan.org>
672 ozum: Ozum Eldogan C<ozum@ozum.net>
674 Pavel I. Shaydo C<zwon@trinitum.org>
678 Copyright (c) 2006 - 2010
679 the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
684 This program is free software. You can redistribute it and/or modify it
685 under the same terms as Perl itself.
690 # vim:sts=4 sw=4 et tw=80: