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 \
36 quote_char='`' name_sep='.'
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 an arrayref of connection parameters, which are specific to your
173 C<storage_type> (see your storage type documentation for more details).
174 If you only need one parameter (e.g. the DSN), you can just pass a string
175 instead of an arrayref.
177 This is not required if C<schema_class> already has connection information
178 defined inside itself (which isn't highly recommended, but can be done)
180 For L<DBIx::Class::Storage::DBI>, which is the only supported
181 C<storage_type> in L<DBIx::Class> at the time of this writing, the
182 parameters are your dsn, username, password, and connect options hashref.
184 See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
185 of the arguments supported.
190 dsn => 'dbi:Pg:dbname=mypgdb',
196 dsn => 'dbi:SQLite:dbname=foo.db',
198 'PRAGMA synchronous = OFF',
203 dsn => 'dbi:Pg:dbname=mypgdb',
208 'some SQL statement',
209 'another SQL statement',
213 Or using L<Config::General>:
216 schema_class MyApp::Schema::FilmDB
219 dsn dbi:Pg:dbname=mypgdb
224 on_connect_do some SQL statement
225 on_connect_do another SQL statement
227 user_defined_schema_accessor foo
233 schema_class MyApp::Schema::FilmDB
234 connect_info dbi:SQLite:dbname=foo.db
248 on_connect_call: 'datetime_setup'
251 The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
255 'dbi:Pg:dbname=mypgdb',
264 'some SQL statement',
265 'another SQL statement',
272 Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
274 They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then
275 the C<< Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless
276 prefixed with C<+> in which case they are taken to be a fully qualified name.
280 traits +MyApp::TraitFor::Model::Foo
282 A new instance is created at application time, so any consumed required
283 attributes, coercions and modifiers will work.
285 Traits are applied at L<Catalyst::Component/COMPONENT> time using
286 L<CatalystX::Component::Traits>.
288 C<ref $self> will be an anon class if any traits are applied, C<<
289 $self->_original_class_name >> will be the original class.
291 When writing a Trait, interesting points to modify are C<BUILD>, L</setup> and
294 Traits that come with the distribution:
298 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>
300 =item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
302 =item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
308 Allows the use of a different C<storage_type> than what is set in your
309 C<schema_class> (which in turn defaults to C<::DBI> if not set in current
310 L<DBIx::Class>). Completely optional, and probably unnecessary for most
311 people until other storage backends become available for L<DBIx::Class>.
315 The keys you pass in the model configuration are available as attributes.
317 Other attributes available:
321 Your connect_info args normalized to hashref form (with dsn/user/password.) See
322 L<DBIx::Class::Storage::DBI/connect_info> for more info on the hashref form of
327 The model name L<Catalyst> uses to resolve this model, the part after
328 C<::Model::> or C<::M::> in your class name. E.g. if your class name is
329 C<MyApp::Model::DB> the L</model_name> will be C<DB>.
331 =head2 _default_cursor_class
333 What to reset your L<DBIx::Class::Storage::DBI/cursor_class> to if a custom one
334 doesn't work out. Defaults to L<DBIx::Class::Storage::DBI::Cursor>.
336 =head1 ATTRIBUTES FROM L<MooseX::Traits::Pluggable>
338 =head2 _original_class_name
340 The class name of your model before any L</traits> are applied. E.g.
345 Unresolved arrayref of traits passed in the config.
347 =head2 _resolved_traits
349 Traits you used resolved to full class names.
351 =head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
353 See the documentation for
354 L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
355 to pass config values from your L<Catalyst> config to your
356 L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
362 Instantiates the Model based on the above-documented ->config parameters.
363 The only required parameter is C<schema_class>. C<connect_info> is
364 required in the case that C<schema_class> does not already have connection
365 information defined for it.
369 Accessor which returns the connected schema being used by the this model.
370 There are direct shortcuts on the model class itself for
371 schema->resultset, schema->source, and schema->class.
373 =head2 composed_schema
375 Accessor which returns the composed schema, which has no connection info,
376 which was used in constructing the C<schema> above. Useful for creating
377 new connections based on the same schema/model. There are direct shortcuts
378 from the model object for composed_schema->clone and composed_schema->connect
382 Shortcut for ->composed_schema->clone
386 Shortcut for ->composed_schema->connect
390 Shortcut for ->schema->source
394 Shortcut for ->schema->class
398 Shortcut for ->schema->resultset
402 Shortcut for ->schema->txn_do
404 =head2 txn_scope_guard
406 Shortcut for ->schema->txn_scope_guard
410 Provides an accessor for the connected schema's storage object.
412 See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
416 has schema_class => (
423 has storage_type => (is => 'rw', isa => Str);
425 has connect_info => (is => 'rw', isa => ConnectInfo, coerce => 1);
434 has _default_cursor_class => (
437 default => 'DBIx::Class::Storage::DBI::Cursor',
441 has schema => (is => 'rw', isa => Schema);
445 before COMPONENT => sub {
446 $app_class = ref $_[1] || $_[1];
449 sub app_class { $app_class }
452 my ($self, $args) = @_;
453 my $class = $self->_original_class_name;
454 my $schema_class = $self->schema_class;
456 if( !$self->connect_info ) {
457 if($schema_class->storage && $schema_class->storage->connect_info) {
458 $self->connect_info($schema_class->storage->connect_info);
461 die "Either ->config->{connect_info} must be defined for $class"
462 . " or $schema_class must have connect info defined on it."
463 . " Here's what we got:\n"
468 if (exists $self->connect_info->{cursor_class}) {
469 eval { Class::MOP::load_class($self->connect_info->{cursor_class}) }
470 or croak "invalid connect_info: Cannot load your cursor_class"
471 . " ".$self->connect_info->{cursor_class}.": $@";
476 my $is_installed = defined $self->composed_schema;
478 $self->composed_schema($schema_class->compose_namespace($class))
479 unless $is_installed;
481 $self->schema($self->composed_schema->clone)
482 unless $self->schema;
484 $self->schema->storage_type($self->storage_type)
485 if $self->storage_type;
487 $self->schema->connection($self->connect_info);
489 $self->_install_rs_models unless $is_installed;
492 sub clone { shift->composed_schema->clone(@_); }
494 sub connect { shift->composed_schema->connect(@_); }
496 # some proxy methods, see also SchemaProxy
498 sub resultset { shift->schema->resultset(@_); }
500 sub txn_do { shift->schema->txn_do(@_); }
502 sub txn_scope_guard { shift->schema->txn_scope_guard(@_); }
504 sub storage { shift->schema->storage(@_); }
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 => >>.
511 Receives a hashref of args passed to C<BUILD>.
517 =head2 ACCEPT_CONTEXT
519 Point of extension for doing things at C<< $c->model >> time with context,
520 returns the model instance, see L<Catalyst::Manual::Intro/ACCEPT_CONTEXT> for
525 sub ACCEPT_CONTEXT { shift }
527 sub _install_rs_models {
529 my $class = $self->_original_class_name;
533 my @sources = $self->schema->sources;
536 warn <<'EOF' unless $ENV{CMDS_NO_SOURCES};
537 ******************************* WARNING ***************************************
538 * No sources found (did you forget to define your tables?) *
540 * To turn off this warning, set the CMDS_NO_SOURCES environment variable. *
541 *******************************************************************************
545 foreach my $moniker (@sources) {
546 my $classname = "${class}::$moniker";
547 *{"${classname}::ACCEPT_CONTEXT"} = sub {
549 shift->model($self->model_name)->resultset($moniker);
554 sub _reset_cursor_class {
557 if ($self->storage->can('cursor_class')) {
558 $self->storage->cursor_class($self->_default_cursor_class)
559 if $self->storage->cursor_class ne $self->_default_cursor_class;
566 sub composed_schema {
568 my $class = $self->_original_class_name;
569 my $store = \$COMPOSED_CACHE{$class}{$self->schema_class};
571 $$store = shift if @_;
577 sub _build_model_name {
579 my $class = $self->_original_class_name;
580 (my $model_name = $class) =~ s/^[\w:]+::(?:Model|M):://;
585 __PACKAGE__->meta->make_immutable;
591 =item CMDS_NO_SOURCES
593 Set this variable if you will be using schemas with no sources (Result classes)
594 to disable the warning. The warning is there because having no Result classes
595 is usually a mistake.
599 =head1 Setting up DBIC authentication
601 You can set this up with
602 L<Catalyst::Authentication::Store::DBIx::Class> in MyApp.pm:
606 use Catalyst qw/... Authentication .../;
610 __PACKAGE__->config('Plugin::Authentication' =>
612 default_realm => 'members',
616 password_field => 'password',
617 password_type => 'hashed'
618 password_hash_type => 'SHA-256'
621 class => 'DBIx::Class',
622 user_model => 'DB::User',
623 role_relation => 'roles',
624 role_field => 'rolename',
629 =head1 METHOD PROXYING
631 The automatic proxying to the underlying L<DBIx::Class::Schema> has been
632 removed as of version C<0.34>, to enable this feature add C<SchemaProxy> to
635 See L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>.
639 General Catalyst Stuff:
641 L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
642 L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
644 Stuff related to DBIC and this Model style:
646 L<DBIx::Class>, L<DBIx::Class::Schema>,
647 L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>,
648 L<CatalystX::Component::Traits>, L<MooseX::Traits::Pluggable>
652 L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
653 L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>,
654 L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
655 L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
659 Brandon L Black C<blblack at gmail.com>
663 caelum: Rafael Kitover C<rkitover at cpan.org>
665 dandv: Dan Dascalescu C<dandv at cpan.org>
667 bluefeet: Aran Deltac C<bluefeet@cpan.org>
669 t0m: Tomas Doran C<bobtfish@bobtfish.net>
671 osfameron: C<osfameron@cpan.org>
673 ozum: Ozum Eldogan C<ozum@ozum.net>
675 Pavel I. Shaydo C<zwon@trinitum.org>
679 Copyright (c) 2006 - 2010
680 the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
685 This program is free software. You can redistribute it and/or modify it
686 under the same terms as Perl itself.
691 # vim:sts=4 sw=4 et tw=80: