C::M::DBIC::Schema -- better defaults for create=static, with backcompat
[catagits/Catalyst-Model-DBIC-Schema.git] / lib / Catalyst / Model / DBIC / Schema.pm
CommitLineData
ad91060a 1package Catalyst::Model::DBIC::Schema;
2
3use strict;
018eb0e2 4use warnings;
5
1d155058 6our $VERSION = '0.23';
018eb0e2 7
f1613faa 8use base qw/Catalyst::Model Class::Accessor::Fast Class::Data::Accessor/;
ad91060a 9use NEXT;
10use UNIVERSAL::require;
11use Carp;
bfcd6e3d 12use Data::Dumper;
7db6da78 13require DBIx::Class;
ad91060a 14
f1613faa 15__PACKAGE__->mk_classaccessor('composed_schema');
16__PACKAGE__->mk_accessors('schema');
17
ad91060a 18=head1 NAME
19
20Catalyst::Model::DBIC::Schema - DBIx::Class::Schema Model Class
21
22=head1 SYNOPSIS
23
aabc1d75 24Manual creation of a DBIx::Class::Schema and a Catalyst::Model::DBIC::Schema:
25
26=over
27
28=item 1.
29
30Create the DBIx:Class schema in MyApp/Schema/FilmDB.pm:
31
32 package MyApp::Schema::FilmDB;
33 use base qw/DBIx::Class::Schema/;
34
35 __PACKAGE__->load_classes(qw/Actor Role/);
36
37=item 2.
38
39Create some classes for the tables in the database, for example an
40Actor in MyApp/Schema/FilmDB/Actor.pm:
41
42 package MyApp::Schema::FilmDB::Actor;
43 use base qw/DBIx::Class/
07edc53e 44
aabc1d75 45 __PACKAGE__->load_components(qw/Core/);
46 __PACKAGE__->table('actor');
07edc53e 47
aabc1d75 48 ...
49
c8ae74f8 50and a Role in MyApp/Schema/FilmDB/Role.pm:
aabc1d75 51
52 package MyApp::Schema::FilmDB::Role;
53 use base qw/DBIx::Class/
07edc53e 54
aabc1d75 55 __PACKAGE__->load_components(qw/Core/);
4a3e80e9 56 __PACKAGE__->table('role');
07edc53e 57
aabc1d75 58 ...
59
60Notice that the schema is in MyApp::Schema, not in MyApp::Model. This way it's
61usable as a standalone module and you can test/run it without Catalyst.
62
63=item 3.
64
65To expose it to Catalyst as a model, you should create a DBIC Model in
66MyApp/Model/FilmDB.pm:
67
68 package MyApp::Model::FilmDB;
69 use base qw/Catalyst::Model::DBIC::Schema/;
07edc53e 70
aabc1d75 71 __PACKAGE__->config(
72 schema_class => 'MyApp::Schema::FilmDB',
73 connect_info => [
74 "DBI:...",
75 "username",
76 "password",
77 {AutoCommit => 1}
78 ]
79 );
80
81See below for a full list of the possible config parameters.
82
83=back
84
6dec11b7 85Now you have a working Model which accesses your separate DBIC Schema. This can
aabc1d75 86be used/accessed in the normal Catalyst manner, via $c->model():
87
88 my $actor = $c->model('FilmDB::Actor')->find(1);
89
90You can also use it to set up DBIC authentication with
91Authentication::Store::DBIC in MyApp.pm:
92
93 package MyApp;
07edc53e 94
aabc1d75 95 use Catalyst qw/... Authentication::Store::DBIC/;
07edc53e 96
aabc1d75 97 ...
07edc53e 98
aabc1d75 99 __PACKAGE__->config->{authentication}{dbic} = {
100 user_class => 'FilmDB::Actor',
101 user_field => 'name',
102 password_field => 'password'
103 }
104
d52bc376 105C<< $c->model('Schema::Source') >> returns a L<DBIx::Class::ResultSet> for
106the source name parameter passed. To find out more about which methods can
107be called on a ResultSet, or how to add your own methods to it, please see
108the ResultSet documentation in the L<DBIx::Class> distribution.
aabc1d75 109
110Some examples are given below:
111
f1613faa 112 # to access schema methods directly:
113 $c->model('FilmDB')->schema->source(...);
114
115 # to access the source object, resultset, and class:
07edc53e 116 $c->model('FilmDB')->source(...);
117 $c->model('FilmDB')->resultset(...);
118 $c->model('FilmDB')->class(...);
c12b7310 119
07edc53e 120 # For resultsets, there's an even quicker shortcut:
121 $c->model('FilmDB::Actor')
122 # is the same as $c->model('FilmDB')->resultset('Actor')
ad91060a 123
f1613faa 124 # To get the composed schema for making new connections:
125 my $newconn = $c->model('FilmDB')->composed_schema->connect(...);
126
127 # Or the same thing via a convenience shortcut:
128 my $newconn = $c->model('FilmDB')->connect(...);
129
130 # or, if your schema works on different storage drivers:
131 my $newconn = $c->model('FilmDB')->composed_schema->clone();
132 $newconn->storage_type('::LDAP');
133 $newconn->connection(...);
134
135 # and again, a convenience shortcut
136 my $newconn = $c->model('FilmDB')->clone();
137 $newconn->storage_type('::LDAP');
138 $newconn->connection(...);
139
ad91060a 140=head1 DESCRIPTION
141
7b39f3f0 142This is a Catalyst Model for L<DBIx::Class::Schema>-based Models. See
ef91bcf9 143the documentation for L<Catalyst::Helper::Model::DBIC::Schema> for
144information on generating these Models via Helper scripts.
ad91060a 145
d52bc376 146When your Catalyst app starts up, a thin Model layer is created as an
147interface to your DBIC Schema. It should be clearly noted that the model
148object returned by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or
149resultset object, but merely a wrapper proving L<methods|/METHODS> to access
150the underlying schema.
151
152In addition to this model class, a shortcut class is generated for each
153source in the schema, allowing easy and direct access to a resultset of the
154corresponding type. These generated classes are even thinner than the model
155class, providing no public methods but simply hooking into Catalyst's
156model() accessor via the
157L<ACCEPT_CONTEXT|Catalyst::Component/ACCEPT_CONTEXT> mechanism. The complete
158contents of each generated class is roughly equivalent to the following:
159
160 package MyApp::Model::FilmDB::Actor
161 sub ACCEPT_CONTEXT {
162 my ($self, $c) = @_;
163 $c->model('FilmDB')->resultset('Actor');
164 }
165
166In short, there are three techniques available for obtaining a DBIC
167resultset object:
168
169 # the long way
170 my $rs = $c->model('FilmDB')->schema->resultset('Actor');
171
172 # using the shortcut method on the model object
173 my $rs = $c->model('FilmDB')->resultset('Actor');
174
175 # using the generated class directly
176 my $rs = $c->model('FilmDB::Actor');
177
c082639a 178In order to add methods to a DBIC resultset, you cannot simply add them to
179the source (row, table) definition class; you must define a separate custom
180resultset class. See L<DBIx::Class::Manual::Cookbook/"Predefined searches">
181for more info.
182
ad91060a 183=head1 CONFIG PARAMETERS
184
185=over 4
186
187=item schema_class
188
189This is the classname of your L<DBIx::Class::Schema> Schema. It needs
aabc1d75 190to be findable in C<@INC>, but it does not need to be inside the
191C<Catalyst::Model::> namespace. This parameter is required.
ad91060a 192
193=item connect_info
194
195This is an arrayref of connection parameters, which are specific to your
b9a72351 196C<storage_type> (see your storage type documentation for more details).
197If you only need one parameter (e.g. the DSN), you can just pass a string
198instead of an arrayref.
ad91060a 199
0f2fd2c0 200This is not required if C<schema_class> already has connection information
d89e6c8a 201defined inside itself (which isn't highly recommended, but can be done)
0f2fd2c0 202
7db6da78 203For L<DBIx::Class::Storage::DBI>, which is the only supported
204C<storage_type> in L<DBIx::Class> at the time of this writing, the
205parameters are your dsn, username, password, and connect options hashref.
206
018eb0e2 207See L<DBIx::Class::Storage::DBI/connect_info> for a detailed explanation
208of the arguments supported.
7db6da78 209
210Examples:
211
07edc53e 212 connect_info => [ 'dbi:Pg:dbname=mypgdb', 'postgres', '' ],
213
214 connect_info => [
215 'dbi:SQLite:dbname=foo.db',
216 {
217 on_connect_do => [
218 'PRAGMA synchronous = OFF',
219 ],
220 }
221 ],
222
223 connect_info => [
224 'dbi:Pg:dbname=mypgdb',
225 'postgres',
226 '',
227 { AutoCommit => 0 },
228 {
229 on_connect_do => [
230 'some SQL statement',
231 'another SQL statement',
232 ],
233 }
234 ],
7db6da78 235
8281c933 236Or using L<Config::General>:
237
238 <Model::FilmDB>
239 schema_class MyApp::Schema::FilmDB
240 connect_info dbi:Pg:dbname=mypgdb
241 connect_info postgres
242 connect_info
243 <connect_info>
244 AutoCommit 0
245 on_connect_do some SQL statement
246 on_connect_do another SQL statement
247 </connect_info>
248 </Model::FilmDB>
249
250or
251
252 <Model::FilmDB>
253 schema_class MyApp::Schema::FilmDB
254 connect_info dbi:SQLite:dbname=foo.db
255 </Model::FilmDB>
256
257
ad91060a 258=item storage_type
259
260Allows the use of a different C<storage_type> than what is set in your
261C<schema_class> (which in turn defaults to C<::DBI> if not set in current
f1613faa 262L<DBIx::Class>). Completely optional, and probably unnecessary for most
263people until other storage backends become available for L<DBIx::Class>.
ad91060a 264
265=back
266
267=head1 METHODS
268
269=over 4
270
271=item new
272
273Instantiates the Model based on the above-documented ->config parameters.
0f2fd2c0 274The only required parameter is C<schema_class>. C<connect_info> is
275required in the case that C<schema_class> does not already have connection
276information defined for it.
ad91060a 277
f1613faa 278=item schema
279
280Accessor which returns the connected schema being used by the this model.
281There are direct shortcuts on the model class itself for
282schema->resultset, schema->source, and schema->class.
283
284=item composed_schema
285
286Accessor which returns the composed schema, which has no connection info,
287which was used in constructing the C<schema> above. Useful for creating
288new connections based on the same schema/model. There are direct shortcuts
289from the model object for composed_schema->clone and composed_schema->connect
290
291=item clone
292
293Shortcut for ->composed_schema->clone
294
295=item connect
296
297Shortcut for ->composed_schema->connect
298
299=item source
c12b7310 300
f1613faa 301Shortcut for ->schema->source
302
303=item class
304
305Shortcut for ->schema->class
306
307=item resultset
308
309Shortcut for ->schema->resultset
310
311=item storage
312
313Provides an accessor for the connected schema's storage object.
314Used often for debugging and controlling transactions.
b8427e0b 315
ad91060a 316=back
317
318=cut
319
320sub new {
46878f2e 321 my $self = shift->NEXT::new(@_);
ad91060a 322
323 my $class = ref($self);
324 my $model_name = $class;
325 $model_name =~ s/^[\w:]+::(?:Model|M):://;
326
0f2fd2c0 327 croak "->config->{schema_class} must be defined for this model"
328 unless $self->{schema_class};
ad91060a 329
330 my $schema_class = $self->{schema_class};
331
1aeb6e1e 332 $schema_class->require
f1613faa 333 or croak "Cannot load schema class '$schema_class': $@";
7db6da78 334
f1613faa 335 if( !$self->{connect_info} ) {
336 if($schema_class->storage && $schema_class->storage->connect_info) {
337 $self->{connect_info} = $schema_class->storage->connect_info;
338 }
339 else {
340 croak "Either ->config->{connect_info} must be defined for $class"
460e3ac8 341 . " or $schema_class must have connect info defined on it."
342 . " Here's what we got:\n"
f1613faa 343 . Dumper($self);
344 }
7db6da78 345 }
346
f1613faa 347 $self->composed_schema($schema_class->compose_namespace($class));
348 $self->schema($self->composed_schema->clone);
349
350 $self->schema->storage_type($self->{storage_type})
351 if $self->{storage_type};
7db6da78 352
b9a72351 353 $self->schema->connection(
354 ref $self->{connect_info} eq 'ARRAY' ?
355 @{$self->{connect_info}} :
356 $self->{connect_info}
357 );
f1613faa 358
ad91060a 359 no strict 'refs';
360 foreach my $moniker ($self->schema->sources) {
0b2a7108 361 my $classname = "${class}::$moniker";
7db6da78 362 *{"${classname}::ACCEPT_CONTEXT"} = sub {
ad91060a 363 shift;
c12b7310 364 shift->model($model_name)->resultset($moniker);
ad91060a 365 }
366 }
367
368 return $self;
369}
370
f1613faa 371sub clone { shift->composed_schema->clone(@_); }
372
373sub connect { shift->composed_schema->connect(@_); }
374
375sub storage { shift->schema->storage(@_); }
b8427e0b 376
ad91060a 377=head1 SEE ALSO
378
7b39f3f0 379General Catalyst Stuff:
380
381L<Catalyst::Manual>, L<Catalyst::Test>, L<Catalyst::Request>,
382L<Catalyst::Response>, L<Catalyst::Helper>, L<Catalyst>,
383
384Stuff related to DBIC and this Model style:
385
386L<DBIx::Class>, L<DBIx::Class::Schema>,
ef91bcf9 387L<DBIx::Class::Schema::Loader>, L<Catalyst::Helper::Model::DBIC::Schema>
ad91060a 388
389=head1 AUTHOR
390
391Brandon L Black, C<blblack@gmail.com>
392
393=head1 COPYRIGHT
394
395This program is free software, you can redistribute it and/or modify it
396under the same terms as Perl itself.
397
398=cut
399
4001;