Commit | Line | Data |
a02675cd |
1 | package DBIx::Class::Schema; |
2 | |
3 | use strict; |
4 | use warnings; |
aa562407 |
5 | |
701da8c4 |
6 | use Carp::Clan qw/^DBIx::Class/; |
66d9ef6b |
7 | use UNIVERSAL::require; |
a02675cd |
8 | |
41a6f8c0 |
9 | use base qw/DBIx::Class/; |
a02675cd |
10 | |
0dc79249 |
11 | __PACKAGE__->mk_classdata('class_mappings' => {}); |
12 | __PACKAGE__->mk_classdata('source_registrations' => {}); |
1e10a11d |
13 | __PACKAGE__->mk_classdata('storage_type' => '::DBI'); |
d7156e50 |
14 | __PACKAGE__->mk_classdata('storage'); |
a02675cd |
15 | |
c2da098a |
16 | =head1 NAME |
17 | |
18 | DBIx::Class::Schema - composable schemas |
19 | |
20 | =head1 SYNOPSIS |
21 | |
c2da098a |
22 | package My::Schema; |
c2da098a |
23 | use base qw/DBIx::Class::Schema/; |
a3d93194 |
24 | |
25 | # load My::Schema::Foo, My::Schema::Bar, My::Schema::Baz |
c2da098a |
26 | __PACKAGE__->load_classes(qw/Foo Bar Baz/); |
27 | |
c2da098a |
28 | package My::Schema::Foo; |
03312470 |
29 | use base qw/DBIx::Class/; |
54540863 |
30 | __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example |
c2da098a |
31 | __PACKAGE__->table('foo'); |
c2da098a |
32 | |
a3d93194 |
33 | my $schema1 = My::Schema->connect( |
34 | $dsn, |
35 | $user, |
36 | $password, |
37 | $attrs |
38 | ); |
c2da098a |
39 | |
a3d93194 |
40 | my $schema2 = My::Schema->connect( ... ); |
c2da098a |
41 | |
a3d93194 |
42 | # fetch objects using My::Schema::Foo |
43 | my $resultset = $schema1->resultset('Foo')->search( ... ); |
44 | my @objects = $schema2->resultset('Foo')->search( ... ); |
c2da098a |
45 | |
46 | =head1 DESCRIPTION |
47 | |
a3d93194 |
48 | Creates database classes based on a schema. This is the recommended way to |
49 | use L<DBIx::Class> and allows you to use more than one concurrent connection |
50 | with your classes. |
429bd4f1 |
51 | |
03312470 |
52 | NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS> |
53 | carefully as DBIx::Class does things a little differently. Note in |
54 | particular which module inherits off which. |
55 | |
c2da098a |
56 | =head1 METHODS |
57 | |
0dc79249 |
58 | =head2 register_class <moniker> <component_class> |
076652e8 |
59 | |
80c90f5d |
60 | Registers a class which isa ResultSourceProxy; equivalent to calling |
66d9ef6b |
61 | |
62 | $schema->register_source($moniker, $class->result_source_instance); |
076652e8 |
63 | |
c2da098a |
64 | =cut |
65 | |
a02675cd |
66 | sub register_class { |
0dc79249 |
67 | my ($self, $moniker, $to_register) = @_; |
68 | $self->register_source($moniker => $to_register->result_source_instance); |
74b92d9a |
69 | } |
70 | |
0dc79249 |
71 | =head2 register_source <moniker> <result source> |
076652e8 |
72 | |
0dc79249 |
73 | Registers the result source in the schema with the given moniker |
076652e8 |
74 | |
75 | =cut |
76 | |
0dc79249 |
77 | sub register_source { |
78 | my ($self, $moniker, $source) = @_; |
79 | my %reg = %{$self->source_registrations}; |
80 | $reg{$moniker} = $source; |
81 | $self->source_registrations(\%reg); |
82 | $source->schema($self); |
83 | if ($source->result_class) { |
84 | my %map = %{$self->class_mappings}; |
85 | $map{$source->result_class} = $moniker; |
86 | $self->class_mappings(\%map); |
87 | } |
88 | } |
a02675cd |
89 | |
bfb2bd4f |
90 | =head2 class |
91 | |
92 | my $class = $schema->class('Foo'); |
93 | |
0dc79249 |
94 | Retrieves the result class name for a given result source |
bfb2bd4f |
95 | |
96 | =cut |
97 | |
98 | sub class { |
0dc79249 |
99 | my ($self, $moniker) = @_; |
100 | return $self->source($moniker)->result_class; |
bfb2bd4f |
101 | } |
102 | |
ea20d0fd |
103 | =head2 source |
104 | |
105 | my $source = $schema->source('Foo'); |
106 | |
107 | Returns the result source object for the registered name |
108 | |
109 | =cut |
110 | |
111 | sub source { |
0dc79249 |
112 | my ($self, $moniker) = @_; |
113 | my $sreg = $self->source_registrations; |
114 | return $sreg->{$moniker} if exists $sreg->{$moniker}; |
115 | |
116 | # if we got here, they probably passed a full class name |
117 | my $mapped = $self->class_mappings->{$moniker}; |
701da8c4 |
118 | $self->throw_exception("Can't find source for ${moniker}") |
0dc79249 |
119 | unless $mapped && exists $sreg->{$mapped}; |
120 | return $sreg->{$mapped}; |
ea20d0fd |
121 | } |
122 | |
0dc79249 |
123 | =head2 sources |
124 | |
125 | my @source_monikers = $schema->sources; |
126 | |
127 | Returns the source monikers of all source registrations on this schema |
128 | |
129 | =cut |
130 | |
131 | sub sources { return keys %{shift->source_registrations}; } |
132 | |
ea20d0fd |
133 | =head2 resultset |
134 | |
135 | my $rs = $schema->resultset('Foo'); |
136 | |
0dc79249 |
137 | Returns the resultset for the registered moniker |
ea20d0fd |
138 | |
139 | =cut |
140 | |
141 | sub resultset { |
0dc79249 |
142 | my ($self, $moniker) = @_; |
143 | return $self->source($moniker)->resultset; |
ea20d0fd |
144 | } |
145 | |
130c6439 |
146 | =head2 load_classes [<classes>, (<class>, <class>), {<namespace> => [<classes>]}] |
076652e8 |
147 | |
429bd4f1 |
148 | Uses L<Module::Find> to find all classes under the database class' namespace, |
149 | or uses the classes you select. Then it loads the component (using L<use>), |
150 | and registers them (using B<register_class>); |
076652e8 |
151 | |
5ce32fc1 |
152 | It is possible to comment out classes with a leading '#', but note that perl |
153 | will think it's a mistake (trying to use a comment in a qw list) so you'll |
154 | need to add "no warnings 'qw';" before your load_classes call. |
155 | |
076652e8 |
156 | =cut |
157 | |
a02675cd |
158 | sub load_classes { |
5ce32fc1 |
159 | my ($class, @params) = @_; |
160 | |
161 | my %comps_for; |
162 | |
163 | if (@params) { |
164 | foreach my $param (@params) { |
165 | if (ref $param eq 'ARRAY') { |
166 | # filter out commented entries |
167 | my @modules = grep { $_ !~ /^#/ } @$param; |
168 | |
169 | push (@{$comps_for{$class}}, @modules); |
170 | } |
171 | elsif (ref $param eq 'HASH') { |
172 | # more than one namespace possible |
173 | for my $comp ( keys %$param ) { |
174 | # filter out commented entries |
175 | my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; |
176 | |
177 | push (@{$comps_for{$comp}}, @modules); |
178 | } |
179 | } |
180 | else { |
181 | # filter out commented entries |
182 | push (@{$comps_for{$class}}, $param) if $param !~ /^#/; |
183 | } |
184 | } |
185 | } else { |
41a6f8c0 |
186 | eval "require Module::Find;"; |
701da8c4 |
187 | $class->throw_exception("No arguments to load_classes and couldn't load". |
41a6f8c0 |
188 | " Module::Find ($@)") if $@; |
5ce32fc1 |
189 | my @comp = map { substr $_, length "${class}::" } Module::Find::findallmod($class); |
190 | $comps_for{$class} = \@comp; |
41a6f8c0 |
191 | } |
5ce32fc1 |
192 | |
193 | foreach my $prefix (keys %comps_for) { |
194 | foreach my $comp (@{$comps_for{$prefix}||[]}) { |
195 | my $comp_class = "${prefix}::${comp}"; |
5ce32fc1 |
196 | eval "use $comp_class"; # If it fails, assume the user fixed it |
bfb2bd4f |
197 | if ($@) { |
198 | die $@ unless $@ =~ /Can't locate/; |
199 | } |
5ce32fc1 |
200 | $class->register_class($comp => $comp_class); |
be381829 |
201 | # if $class->can('result_source_instance'); |
5ce32fc1 |
202 | } |
a02675cd |
203 | } |
204 | } |
205 | |
130c6439 |
206 | =head2 compose_connection <target> <@db_info> |
429bd4f1 |
207 | |
208 | This is the most important method in this class. it takes a target namespace, |
209 | as well as dbh connection info, and creates a L<DBIx::Class::DB> class as |
210 | well as subclasses for each of your database classes in this namespace, using |
211 | this connection. |
076652e8 |
212 | |
54540863 |
213 | It will also setup a ->class method on the target class, which lets you |
8c130052 |
214 | resolve database classes based on the schema component name, for example |
215 | |
54540863 |
216 | MyApp::DB->class('Foo') # returns MyApp::DB::Foo, |
8c130052 |
217 | # which ISA MyApp::Schema::Foo |
218 | |
219 | This is the recommended API for accessing Schema generated classes, and |
220 | using it might give you instant advantages with future versions of DBIC. |
221 | |
54540863 |
222 | WARNING: Loading components into Schema classes after compose_connection |
223 | may not cause them to be seen by the classes in your target namespace due |
224 | to the dispatch table approach used by Class::C3. If you do this you may find |
225 | you need to call Class::C3->reinitialize() afterwards to get the behaviour |
226 | you expect. |
227 | |
076652e8 |
228 | =cut |
229 | |
a02675cd |
230 | sub compose_connection { |
ea20d0fd |
231 | my ($self, $target, @info) = @_; |
80c90f5d |
232 | my $base = 'DBIx::Class::ResultSetProxy'; |
66d9ef6b |
233 | $base->require; |
be381829 |
234 | |
235 | if ($self eq $target) { |
236 | # Pathological case, largely caused by the docs on early C::M::DBIC::Plain |
237 | foreach my $moniker ($self->sources) { |
238 | my $source = $self->source($moniker); |
239 | my $class = $source->result_class; |
240 | $self->inject_base($class, $base); |
241 | $class->mk_classdata(resultset_instance => $source->resultset); |
242 | $class->mk_classdata(class_resolver => $self); |
243 | } |
244 | return $self; |
245 | } |
246 | |
66d9ef6b |
247 | my $schema = $self->compose_namespace($target, $base); |
248 | $schema->connection(@info); |
0dc79249 |
249 | foreach my $moniker ($schema->sources) { |
250 | my $source = $schema->source($moniker); |
251 | my $class = $source->result_class; |
252 | #warn "$moniker $class $source ".$source->storage; |
8c49f629 |
253 | $class->mk_classdata(result_source_instance => $source); |
ea20d0fd |
254 | $class->mk_classdata(resultset_instance => $source->resultset); |
66d9ef6b |
255 | $class->mk_classdata(class_resolver => $schema); |
bfb2bd4f |
256 | } |
257 | return $schema; |
e678398e |
258 | } |
259 | |
260 | sub compose_namespace { |
66d9ef6b |
261 | my ($self, $target, $base) = @_; |
262 | my %reg = %{ $self->source_registrations }; |
11b78bd6 |
263 | my %target; |
264 | my %map; |
66d9ef6b |
265 | my $schema = $self->clone; |
266 | foreach my $moniker ($schema->sources) { |
267 | my $source = $schema->source($moniker); |
0dc79249 |
268 | my $target_class = "${target}::${moniker}"; |
66d9ef6b |
269 | $self->inject_base( |
0dc79249 |
270 | $target_class => $source->result_class, ($base ? $base : ()) |
271 | ); |
66d9ef6b |
272 | $source->result_class($target_class); |
b7951443 |
273 | } |
11b78bd6 |
274 | { |
275 | no strict 'refs'; |
bfb2bd4f |
276 | *{"${target}::schema"} = |
277 | sub { $schema }; |
1edaf6fe |
278 | foreach my $meth (qw/class source resultset/) { |
279 | *{"${target}::${meth}"} = |
280 | sub { shift->schema->$meth(@_) }; |
281 | } |
11b78bd6 |
282 | } |
bfb2bd4f |
283 | return $schema; |
b7951443 |
284 | } |
285 | |
130c6439 |
286 | =head2 setup_connection_class <$target> <@info> |
076652e8 |
287 | |
429bd4f1 |
288 | Sets up a database connection class to inject between the schema |
289 | and the subclasses the schema creates. |
290 | |
076652e8 |
291 | =cut |
292 | |
b7951443 |
293 | sub setup_connection_class { |
294 | my ($class, $target, @info) = @_; |
63e9583a |
295 | $class->inject_base($target => 'DBIx::Class::DB'); |
296 | #$target->load_components('DB'); |
b7951443 |
297 | $target->connection(@info); |
298 | } |
299 | |
66d9ef6b |
300 | =head2 connection(@args) |
301 | |
302 | Instantiates a new Storage object of type storage_type and passes the |
19feb86b |
303 | arguments to $storage->connect_info. Sets the connection in-place on |
66d9ef6b |
304 | the schema. |
305 | |
306 | =cut |
307 | |
308 | sub connection { |
309 | my ($self, @info) = @_; |
1e10a11d |
310 | my $storage_class = $self->storage_type; |
311 | $storage_class = 'DBIx::Class::Storage'.$storage_class |
312 | if $storage_class =~ m/^::/; |
66d9ef6b |
313 | $storage_class->require; |
314 | my $storage = $storage_class->new; |
315 | $storage->connect_info(\@info); |
316 | $self->storage($storage); |
317 | return $self; |
318 | } |
319 | |
320 | =head2 connect(@info) |
321 | |
322 | Conveneience method, equivalent to $schema->clone->connection(@info) |
323 | |
324 | =cut |
325 | |
326 | sub connect { shift->clone->connection(@_) }; |
327 | |
328 | =head2 clone |
329 | |
330 | Clones the schema and its associated result_source objects and returns the |
331 | copy. |
332 | |
333 | =cut |
334 | |
335 | sub clone { |
336 | my ($self) = @_; |
337 | my $clone = bless({ (ref $self ? %$self : ()) }, ref $self || $self); |
338 | foreach my $moniker ($self->sources) { |
339 | my $source = $self->source($moniker); |
340 | my $new = $source->new($source); |
341 | $clone->register_source($moniker => $new); |
342 | } |
343 | return $clone; |
344 | } |
345 | |
701da8c4 |
346 | =item throw_exception |
347 | |
348 | Defaults to using Carp::Clan to report errors from user perspective. |
349 | |
350 | =cut |
351 | |
352 | sub throw_exception { |
353 | my ($self) = shift; |
354 | croak @_; |
355 | } |
356 | |
a02675cd |
357 | 1; |
c2da098a |
358 | |
c2da098a |
359 | =head1 AUTHORS |
360 | |
daec44b8 |
361 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
c2da098a |
362 | |
363 | =head1 LICENSE |
364 | |
365 | You may distribute this code under the same terms as Perl itself. |
366 | |
367 | =cut |
368 | |