Commit | Line | Data |
a02675cd |
1 | package DBIx::Class::Schema; |
2 | |
3 | use strict; |
4 | use warnings; |
aa562407 |
5 | |
4981dc70 |
6 | use DBIx::Class::Exception; |
70c28808 |
7 | use DBIx::Class::Carp; |
9780718f |
8 | use Try::Tiny; |
aea59b74 |
9 | use Scalar::Util qw/weaken blessed/; |
6298a324 |
10 | use Sub::Name 'subname'; |
3b80fa31 |
11 | use B 'svref_2object'; |
d6b39e46 |
12 | use Devel::GlobalDestruction; |
fd323bf1 |
13 | use namespace::clean; |
a02675cd |
14 | |
41a6f8c0 |
15 | use base qw/DBIx::Class/; |
a02675cd |
16 | |
0dc79249 |
17 | __PACKAGE__->mk_classdata('class_mappings' => {}); |
18 | __PACKAGE__->mk_classdata('source_registrations' => {}); |
1e10a11d |
19 | __PACKAGE__->mk_classdata('storage_type' => '::DBI'); |
d7156e50 |
20 | __PACKAGE__->mk_classdata('storage'); |
82cc0386 |
21 | __PACKAGE__->mk_classdata('exception_action'); |
4b946902 |
22 | __PACKAGE__->mk_classdata('stacktrace' => $ENV{DBIC_TRACE} || 0); |
e6c747fd |
23 | __PACKAGE__->mk_classdata('default_resultset_attributes' => {}); |
a02675cd |
24 | |
c2da098a |
25 | =head1 NAME |
26 | |
27 | DBIx::Class::Schema - composable schemas |
28 | |
29 | =head1 SYNOPSIS |
30 | |
24d67825 |
31 | package Library::Schema; |
c2da098a |
32 | use base qw/DBIx::Class::Schema/; |
bab77431 |
33 | |
829517d4 |
34 | # load all Result classes in Library/Schema/Result/ |
35 | __PACKAGE__->load_namespaces(); |
c2da098a |
36 | |
829517d4 |
37 | package Library::Schema::Result::CD; |
d88ecca6 |
38 | use base qw/DBIx::Class::Core/; |
39 | |
40 | __PACKAGE__->load_components(qw/InflateColumn::DateTime/); # for example |
24d67825 |
41 | __PACKAGE__->table('cd'); |
c2da098a |
42 | |
5d9076f2 |
43 | # Elsewhere in your code: |
24d67825 |
44 | my $schema1 = Library::Schema->connect( |
a3d93194 |
45 | $dsn, |
46 | $user, |
47 | $password, |
ef131d82 |
48 | { AutoCommit => 1 }, |
a3d93194 |
49 | ); |
bab77431 |
50 | |
24d67825 |
51 | my $schema2 = Library::Schema->connect($coderef_returning_dbh); |
c2da098a |
52 | |
829517d4 |
53 | # fetch objects using Library::Schema::Result::DVD |
24d67825 |
54 | my $resultset = $schema1->resultset('DVD')->search( ... ); |
55 | my @dvd_objects = $schema2->resultset('DVD')->search( ... ); |
c2da098a |
56 | |
57 | =head1 DESCRIPTION |
58 | |
a3d93194 |
59 | Creates database classes based on a schema. This is the recommended way to |
60 | use L<DBIx::Class> and allows you to use more than one concurrent connection |
61 | with your classes. |
429bd4f1 |
62 | |
03312470 |
63 | NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS> |
2053ab2a |
64 | carefully, as DBIx::Class does things a little differently. Note in |
03312470 |
65 | particular which module inherits off which. |
66 | |
829517d4 |
67 | =head1 SETUP METHODS |
c2da098a |
68 | |
829517d4 |
69 | =head2 load_namespaces |
87c4e602 |
70 | |
27f01d1f |
71 | =over 4 |
72 | |
829517d4 |
73 | =item Arguments: %options? |
27f01d1f |
74 | |
75 | =back |
076652e8 |
76 | |
829517d4 |
77 | __PACKAGE__->load_namespaces(); |
66d9ef6b |
78 | |
829517d4 |
79 | __PACKAGE__->load_namespaces( |
6f731572 |
80 | result_namespace => 'Res', |
81 | resultset_namespace => 'RSet', |
82 | default_resultset_class => '+MyDB::Othernamespace::RSet', |
83 | ); |
84 | |
85 | With no arguments, this method uses L<Module::Find> to load all of the |
86 | Result and ResultSet classes under the namespace of the schema from |
87 | which it is called. For example, C<My::Schema> will by default find |
88 | and load Result classes named C<My::Schema::Result::*> and ResultSet |
89 | classes named C<My::Schema::ResultSet::*>. |
90 | |
91 | ResultSet classes are associated with Result class of the same name. |
92 | For example, C<My::Schema::Result::CD> will get the ResultSet class |
93 | C<My::Schema::ResultSet::CD> if it is present. |
94 | |
95 | Both Result and ResultSet namespaces are configurable via the |
96 | C<result_namespace> and C<resultset_namespace> options. |
076652e8 |
97 | |
6f731572 |
98 | Another option, C<default_resultset_class> specifies a custom default |
99 | ResultSet class for Result classes with no corresponding ResultSet. |
c2da098a |
100 | |
6f731572 |
101 | All of the namespace and classname options are by default relative to |
102 | the schema classname. To specify a fully-qualified name, prefix it |
103 | with a literal C<+>. For example, C<+Other::NameSpace::Result>. |
104 | |
105 | =head3 Warnings |
74b92d9a |
106 | |
672687db |
107 | You will be warned if ResultSet classes are discovered for which there |
829517d4 |
108 | are no matching Result classes like this: |
87c4e602 |
109 | |
829517d4 |
110 | load_namespaces found ResultSet class $classname with no corresponding Result class |
27f01d1f |
111 | |
829517d4 |
112 | If a Result class is found to already have a ResultSet class set using |
113 | L</resultset_class> to some other class, you will be warned like this: |
27f01d1f |
114 | |
fd323bf1 |
115 | We found ResultSet class '$rs_class' for '$result', but it seems |
829517d4 |
116 | that you had already set '$result' to use '$rs_set' instead |
076652e8 |
117 | |
6f731572 |
118 | =head3 Examples |
2a4d9487 |
119 | |
829517d4 |
120 | # load My::Schema::Result::CD, My::Schema::Result::Artist, |
121 | # My::Schema::ResultSet::CD, etc... |
122 | My::Schema->load_namespaces; |
2a4d9487 |
123 | |
829517d4 |
124 | # Override everything to use ugly names. |
125 | # In this example, if there is a My::Schema::Res::Foo, but no matching |
126 | # My::Schema::RSets::Foo, then Foo will have its |
127 | # resultset_class set to My::Schema::RSetBase |
128 | My::Schema->load_namespaces( |
129 | result_namespace => 'Res', |
130 | resultset_namespace => 'RSets', |
131 | default_resultset_class => 'RSetBase', |
132 | ); |
2a4d9487 |
133 | |
829517d4 |
134 | # Put things in other namespaces |
135 | My::Schema->load_namespaces( |
136 | result_namespace => '+Some::Place::Results', |
137 | resultset_namespace => '+Another::Place::RSets', |
138 | ); |
2a4d9487 |
139 | |
6f731572 |
140 | To search multiple namespaces for either Result or ResultSet classes, |
141 | use an arrayref of namespaces for that option. In the case that the |
142 | same result (or resultset) class exists in multiple namespaces, later |
143 | entries in the list of namespaces will override earlier ones. |
2a4d9487 |
144 | |
829517d4 |
145 | My::Schema->load_namespaces( |
146 | # My::Schema::Results_C::Foo takes precedence over My::Schema::Results_B::Foo : |
147 | result_namespace => [ 'Results_A', 'Results_B', 'Results_C' ], |
148 | resultset_namespace => [ '+Some::Place::RSets', 'RSets' ], |
149 | ); |
2a4d9487 |
150 | |
151 | =cut |
152 | |
829517d4 |
153 | # Pre-pends our classname to the given relative classname or |
154 | # class namespace, unless there is a '+' prefix, which will |
155 | # be stripped. |
156 | sub _expand_relative_name { |
157 | my ($class, $name) = @_; |
158 | return if !$name; |
159 | $name = $class . '::' . $name if ! ($name =~ s/^\+//); |
160 | return $name; |
2a4d9487 |
161 | } |
162 | |
f3405058 |
163 | # Finds all modules in the supplied namespace, or if omitted in the |
164 | # namespace of $class. Untaints all findings as they can be assumed |
165 | # to be safe |
166 | sub _findallmod { |
167 | my $proto = shift; |
168 | my $ns = shift || ref $proto || $proto; |
169 | |
3b80fa31 |
170 | require Module::Find; |
f3405058 |
171 | |
aad3158d |
172 | # untaint result |
173 | return map { $_ =~ /(.+)/ } Module::Find::findallmod($ns); |
f3405058 |
174 | } |
175 | |
829517d4 |
176 | # returns a hash of $shortname => $fullname for every package |
b488020e |
177 | # found in the given namespaces ($shortname is with the $fullname's |
178 | # namespace stripped off) |
829517d4 |
179 | sub _map_namespaces { |
180 | my ($class, @namespaces) = @_; |
6eec9003 |
181 | |
829517d4 |
182 | my @results_hash; |
183 | foreach my $namespace (@namespaces) { |
184 | push( |
185 | @results_hash, |
186 | map { (substr($_, length "${namespace}::"), $_) } |
f3405058 |
187 | $class->_findallmod($namespace) |
829517d4 |
188 | ); |
0dc79249 |
189 | } |
27f01d1f |
190 | |
829517d4 |
191 | @results_hash; |
ea20d0fd |
192 | } |
193 | |
b488020e |
194 | # returns the result_source_instance for the passed class/object, |
195 | # or dies with an informative message (used by load_namespaces) |
196 | sub _ns_get_rsrc_instance { |
dee99c24 |
197 | my $me = shift; |
198 | my $rs_class = ref ($_[0]) || $_[0]; |
199 | |
200 | return try { |
201 | $rs_class->result_source_instance |
202 | } catch { |
203 | $me->throw_exception ( |
204 | "Attempt to load_namespaces() class $rs_class failed - are you sure this is a real Result Class?: $_" |
b488020e |
205 | ); |
dee99c24 |
206 | }; |
b488020e |
207 | } |
208 | |
829517d4 |
209 | sub load_namespaces { |
210 | my ($class, %args) = @_; |
0dc79249 |
211 | |
829517d4 |
212 | my $result_namespace = delete $args{result_namespace} || 'Result'; |
213 | my $resultset_namespace = delete $args{resultset_namespace} || 'ResultSet'; |
214 | my $default_resultset_class = delete $args{default_resultset_class}; |
0dc79249 |
215 | |
829517d4 |
216 | $class->throw_exception('load_namespaces: unknown option(s): ' |
217 | . join(q{,}, map { qq{'$_'} } keys %args)) |
218 | if scalar keys %args; |
0dc79249 |
219 | |
829517d4 |
220 | $default_resultset_class |
221 | = $class->_expand_relative_name($default_resultset_class); |
9b1ba0f2 |
222 | |
829517d4 |
223 | for my $arg ($result_namespace, $resultset_namespace) { |
224 | $arg = [ $arg ] if !ref($arg) && $arg; |
9b1ba0f2 |
225 | |
829517d4 |
226 | $class->throw_exception('load_namespaces: namespace arguments must be ' |
227 | . 'a simple string or an arrayref') |
228 | if ref($arg) ne 'ARRAY'; |
9b1ba0f2 |
229 | |
829517d4 |
230 | $_ = $class->_expand_relative_name($_) for (@$arg); |
231 | } |
ea20d0fd |
232 | |
829517d4 |
233 | my %results = $class->_map_namespaces(@$result_namespace); |
234 | my %resultsets = $class->_map_namespaces(@$resultset_namespace); |
27f01d1f |
235 | |
829517d4 |
236 | my @to_register; |
237 | { |
87bf71d5 |
238 | no warnings qw/redefine/; |
239 | local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; |
240 | use warnings qw/redefine/; |
27f01d1f |
241 | |
3988ce40 |
242 | # ensure classes are loaded and attached in inheritance order |
f5ef5fa1 |
243 | for my $res (values %results) { |
244 | $class->ensure_class_loaded($res); |
245 | } |
3988ce40 |
246 | my %inh_idx; |
247 | my @subclass_last = sort { |
248 | |
249 | ($inh_idx{$a} ||= |
250 | scalar @{mro::get_linear_isa( $results{$a} )} |
251 | ) |
252 | |
253 | <=> |
254 | |
255 | ($inh_idx{$b} ||= |
256 | scalar @{mro::get_linear_isa( $results{$b} )} |
257 | ) |
258 | |
259 | } keys(%results); |
260 | |
3d27f771 |
261 | foreach my $result (@subclass_last) { |
829517d4 |
262 | my $result_class = $results{$result}; |
82b01c38 |
263 | |
829517d4 |
264 | my $rs_class = delete $resultsets{$result}; |
b488020e |
265 | my $rs_set = $class->_ns_get_rsrc_instance ($result_class)->resultset_class; |
3988ce40 |
266 | |
829517d4 |
267 | if($rs_set && $rs_set ne 'DBIx::Class::ResultSet') { |
3d27f771 |
268 | if($rs_class && $rs_class ne $rs_set) { |
341d5ede |
269 | carp "We found ResultSet class '$rs_class' for '$result', but it seems " |
829517d4 |
270 | . "that you had already set '$result' to use '$rs_set' instead"; |
271 | } |
272 | } |
273 | elsif($rs_class ||= $default_resultset_class) { |
274 | $class->ensure_class_loaded($rs_class); |
1d3108a4 |
275 | if(!$rs_class->isa("DBIx::Class::ResultSet")) { |
276 | carp "load_namespaces found ResultSet class $rs_class that does not subclass DBIx::Class::ResultSet"; |
277 | } |
278 | |
b488020e |
279 | $class->_ns_get_rsrc_instance ($result_class)->resultset_class($rs_class); |
829517d4 |
280 | } |
82b01c38 |
281 | |
b488020e |
282 | my $source_name = $class->_ns_get_rsrc_instance ($result_class)->source_name || $result; |
0e6c5d58 |
283 | |
284 | push(@to_register, [ $source_name, $result_class ]); |
829517d4 |
285 | } |
286 | } |
ea20d0fd |
287 | |
829517d4 |
288 | foreach (sort keys %resultsets) { |
341d5ede |
289 | carp "load_namespaces found ResultSet class $_ with no " |
829517d4 |
290 | . 'corresponding Result class'; |
291 | } |
ea20d0fd |
292 | |
87bf71d5 |
293 | Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO; |
294 | |
829517d4 |
295 | $class->register_class(@$_) for (@to_register); |
ea20d0fd |
296 | |
829517d4 |
297 | return; |
ea20d0fd |
298 | } |
299 | |
87c4e602 |
300 | =head2 load_classes |
301 | |
27f01d1f |
302 | =over 4 |
303 | |
304 | =item Arguments: @classes?, { $namespace => [ @classes ] }+ |
305 | |
306 | =back |
076652e8 |
307 | |
1ab61457 |
308 | L</load_classes> is an alternative method to L</load_namespaces>, both of |
309 | which serve similar purposes, each with different advantages and disadvantages. |
310 | In the general case you should use L</load_namespaces>, unless you need to |
311 | be able to specify that only specific classes are loaded at runtime. |
829517d4 |
312 | |
82b01c38 |
313 | With no arguments, this method uses L<Module::Find> to find all classes under |
314 | the schema's namespace. Otherwise, this method loads the classes you specify |
315 | (using L<use>), and registers them (using L</"register_class">). |
076652e8 |
316 | |
2053ab2a |
317 | It is possible to comment out classes with a leading C<#>, but note that perl |
318 | will think it's a mistake (trying to use a comment in a qw list), so you'll |
319 | need to add C<no warnings 'qw';> before your load_classes call. |
5ce32fc1 |
320 | |
829517d4 |
321 | If any classes found do not appear to be Result class files, you will |
322 | get the following warning: |
323 | |
fd323bf1 |
324 | Failed to load $comp_class. Can't find source_name method. Is |
829517d4 |
325 | $comp_class really a full DBIC result class? Fix it, move it elsewhere, |
326 | or make your load_classes call more specific. |
327 | |
2053ab2a |
328 | Example: |
82b01c38 |
329 | |
330 | My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist, |
75d07914 |
331 | # etc. (anything under the My::Schema namespace) |
82b01c38 |
332 | |
333 | # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but |
334 | # not Other::Namespace::LinerNotes nor My::Schema::Track |
335 | My::Schema->load_classes(qw/ CD Artist #Track /, { |
336 | Other::Namespace => [qw/ Producer #LinerNotes /], |
337 | }); |
338 | |
076652e8 |
339 | =cut |
340 | |
a02675cd |
341 | sub load_classes { |
5ce32fc1 |
342 | my ($class, @params) = @_; |
bab77431 |
343 | |
5ce32fc1 |
344 | my %comps_for; |
bab77431 |
345 | |
5ce32fc1 |
346 | if (@params) { |
347 | foreach my $param (@params) { |
348 | if (ref $param eq 'ARRAY') { |
349 | # filter out commented entries |
350 | my @modules = grep { $_ !~ /^#/ } @$param; |
bab77431 |
351 | |
5ce32fc1 |
352 | push (@{$comps_for{$class}}, @modules); |
353 | } |
354 | elsif (ref $param eq 'HASH') { |
355 | # more than one namespace possible |
356 | for my $comp ( keys %$param ) { |
357 | # filter out commented entries |
358 | my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; |
359 | |
360 | push (@{$comps_for{$comp}}, @modules); |
361 | } |
362 | } |
363 | else { |
364 | # filter out commented entries |
365 | push (@{$comps_for{$class}}, $param) if $param !~ /^#/; |
366 | } |
367 | } |
368 | } else { |
bc0c9800 |
369 | my @comp = map { substr $_, length "${class}::" } |
f3405058 |
370 | $class->_findallmod; |
5ce32fc1 |
371 | $comps_for{$class} = \@comp; |
41a6f8c0 |
372 | } |
5ce32fc1 |
373 | |
e6efde04 |
374 | my @to_register; |
375 | { |
376 | no warnings qw/redefine/; |
87bf71d5 |
377 | local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; |
378 | use warnings qw/redefine/; |
379 | |
e6efde04 |
380 | foreach my $prefix (keys %comps_for) { |
381 | foreach my $comp (@{$comps_for{$prefix}||[]}) { |
382 | my $comp_class = "${prefix}::${comp}"; |
c037c03a |
383 | $class->ensure_class_loaded($comp_class); |
bab77431 |
384 | |
89271e56 |
385 | my $snsub = $comp_class->can('source_name'); |
386 | if(! $snsub ) { |
341d5ede |
387 | carp "Failed to load $comp_class. Can't find source_name method. Is $comp_class really a full DBIC result class? Fix it, move it elsewhere, or make your load_classes call more specific."; |
89271e56 |
388 | next; |
389 | } |
390 | $comp = $snsub->($comp_class) || $comp; |
391 | |
93405cf0 |
392 | push(@to_register, [ $comp, $comp_class ]); |
bfb2bd4f |
393 | } |
5ce32fc1 |
394 | } |
a02675cd |
395 | } |
87bf71d5 |
396 | Class::C3->reinitialize if DBIx::Class::_ENV_::OLD_MRO; |
e6efde04 |
397 | |
398 | foreach my $to (@to_register) { |
399 | $class->register_class(@$to); |
e6efde04 |
400 | } |
a02675cd |
401 | } |
402 | |
829517d4 |
403 | =head2 storage_type |
2374c5ff |
404 | |
405 | =over 4 |
406 | |
829517d4 |
407 | =item Arguments: $storage_type|{$storage_type, \%args} |
408 | |
fb13a49f |
409 | =item Return Value: $storage_type|{$storage_type, \%args} |
829517d4 |
410 | |
411 | =item Default value: DBIx::Class::Storage::DBI |
2374c5ff |
412 | |
413 | =back |
414 | |
829517d4 |
415 | Set the storage class that will be instantiated when L</connect> is called. |
416 | If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is |
95787afe |
417 | assumed by L</connect>. |
2374c5ff |
418 | |
829517d4 |
419 | You want to use this to set subclasses of L<DBIx::Class::Storage::DBI> |
95787afe |
420 | in cases where the appropriate subclass is not autodetected. |
85bd0538 |
421 | |
829517d4 |
422 | If your storage type requires instantiation arguments, those are |
423 | defined as a second argument in the form of a hashref and the entire |
424 | value needs to be wrapped into an arrayref or a hashref. We support |
425 | both types of refs here in order to play nice with your |
426 | Config::[class] or your choice. See |
427 | L<DBIx::Class::Storage::DBI::Replicated> for an example of this. |
0f4ec1d2 |
428 | |
829517d4 |
429 | =head2 exception_action |
f017c022 |
430 | |
829517d4 |
431 | =over 4 |
0f4ec1d2 |
432 | |
829517d4 |
433 | =item Arguments: $code_reference |
f017c022 |
434 | |
fb13a49f |
435 | =item Return Value: $code_reference |
85bd0538 |
436 | |
829517d4 |
437 | =item Default value: None |
2374c5ff |
438 | |
829517d4 |
439 | =back |
f017c022 |
440 | |
c3e9f718 |
441 | When L</throw_exception> is invoked and L</exception_action> is set to a code |
442 | reference, this reference will be called instead of |
443 | L<DBIx::Class::Exception/throw>, with the exception message passed as the only |
444 | argument. |
f017c022 |
445 | |
c3e9f718 |
446 | Your custom throw code B<must> rethrow the exception, as L</throw_exception> is |
447 | an integral part of DBIC's internal execution control flow. |
f017c022 |
448 | |
829517d4 |
449 | Example: |
f017c022 |
450 | |
829517d4 |
451 | package My::Schema; |
452 | use base qw/DBIx::Class::Schema/; |
453 | use My::ExceptionClass; |
454 | __PACKAGE__->exception_action(sub { My::ExceptionClass->throw(@_) }); |
455 | __PACKAGE__->load_classes; |
2374c5ff |
456 | |
829517d4 |
457 | # or: |
458 | my $schema_obj = My::Schema->connect( .... ); |
459 | $schema_obj->exception_action(sub { My::ExceptionClass->throw(@_) }); |
0f4ec1d2 |
460 | |
829517d4 |
461 | =head2 stacktrace |
f017c022 |
462 | |
829517d4 |
463 | =over 4 |
2374c5ff |
464 | |
829517d4 |
465 | =item Arguments: boolean |
2374c5ff |
466 | |
829517d4 |
467 | =back |
2374c5ff |
468 | |
829517d4 |
469 | Whether L</throw_exception> should include stack trace information. |
470 | Defaults to false normally, but defaults to true if C<$ENV{DBIC_TRACE}> |
471 | is true. |
0f4ec1d2 |
472 | |
829517d4 |
473 | =head2 sqlt_deploy_hook |
0f4ec1d2 |
474 | |
829517d4 |
475 | =over |
0f4ec1d2 |
476 | |
829517d4 |
477 | =item Arguments: $sqlt_schema |
2374c5ff |
478 | |
829517d4 |
479 | =back |
2374c5ff |
480 | |
fd323bf1 |
481 | An optional sub which you can declare in your own Schema class that will get |
829517d4 |
482 | passed the L<SQL::Translator::Schema> object when you deploy the schema via |
483 | L</create_ddl_dir> or L</deploy>. |
0f4ec1d2 |
484 | |
fd323bf1 |
485 | For an example of what you can do with this, see |
829517d4 |
486 | L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To Your SQL>. |
fdcd8145 |
487 | |
2d7d8459 |
488 | Note that sqlt_deploy_hook is called by L</deployment_statements>, which in turn |
489 | is called before L</deploy>. Therefore the hook can be used only to manipulate |
490 | the L<SQL::Translator::Schema> object before it is turned into SQL fed to the |
491 | database. If you want to execute post-deploy statements which can not be generated |
492 | by L<SQL::Translator>, the currently suggested method is to overload L</deploy> |
493 | and use L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>. |
494 | |
829517d4 |
495 | =head1 METHODS |
2374c5ff |
496 | |
829517d4 |
497 | =head2 connect |
87c4e602 |
498 | |
27f01d1f |
499 | =over 4 |
500 | |
829517d4 |
501 | =item Arguments: @connectinfo |
429bd4f1 |
502 | |
d601dc88 |
503 | =item Return Value: $new_schema |
27f01d1f |
504 | |
505 | =back |
076652e8 |
506 | |
829517d4 |
507 | Creates and returns a new Schema object. The connection info set on it |
508 | is used to create a new instance of the storage backend and set it on |
509 | the Schema object. |
1c133e22 |
510 | |
829517d4 |
511 | See L<DBIx::Class::Storage::DBI/"connect_info"> for DBI-specific |
5d52945a |
512 | syntax on the C<@connectinfo> argument, or L<DBIx::Class::Storage> in |
829517d4 |
513 | general. |
1c133e22 |
514 | |
5d52945a |
515 | Note that C<connect_info> expects an arrayref of arguments, but |
faaba25f |
516 | C<connect> does not. C<connect> wraps its arguments in an arrayref |
5d52945a |
517 | before passing them to C<connect_info>. |
518 | |
4c7d99ca |
519 | =head3 Overloading |
520 | |
521 | C<connect> is a convenience method. It is equivalent to calling |
522 | $schema->clone->connection(@connectinfo). To write your own overloaded |
523 | version, overload L</connection> instead. |
524 | |
076652e8 |
525 | =cut |
526 | |
829517d4 |
527 | sub connect { shift->clone->connection(@_) } |
e678398e |
528 | |
829517d4 |
529 | =head2 resultset |
77254782 |
530 | |
27f01d1f |
531 | =over 4 |
532 | |
fb13a49f |
533 | =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> |
82b01c38 |
534 | |
fb13a49f |
535 | =item Return Value: L<$resultset|DBIx::Class::ResultSet> |
27f01d1f |
536 | |
537 | =back |
13765dad |
538 | |
829517d4 |
539 | my $rs = $schema->resultset('DVD'); |
82b01c38 |
540 | |
829517d4 |
541 | Returns the L<DBIx::Class::ResultSet> object for the registered source |
542 | name. |
77254782 |
543 | |
544 | =cut |
545 | |
829517d4 |
546 | sub resultset { |
fb13a49f |
547 | my ($self, $source_name) = @_; |
73d47f9f |
548 | $self->throw_exception('resultset() expects a source name') |
fb13a49f |
549 | unless defined $source_name; |
550 | return $self->source($source_name)->resultset; |
b7951443 |
551 | } |
552 | |
829517d4 |
553 | =head2 sources |
6b43ba5f |
554 | |
555 | =over 4 |
556 | |
fb13a49f |
557 | =item Return Value: L<@source_names|DBIx::Class::ResultSource/source_name> |
6b43ba5f |
558 | |
559 | =back |
560 | |
829517d4 |
561 | my @source_names = $schema->sources; |
6b43ba5f |
562 | |
829517d4 |
563 | Lists names of all the sources registered on this Schema object. |
6b43ba5f |
564 | |
829517d4 |
565 | =cut |
161fb223 |
566 | |
829517d4 |
567 | sub sources { return keys %{shift->source_registrations}; } |
106d5f3b |
568 | |
829517d4 |
569 | =head2 source |
87c4e602 |
570 | |
27f01d1f |
571 | =over 4 |
572 | |
fb13a49f |
573 | =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> |
66d9ef6b |
574 | |
fb13a49f |
575 | =item Return Value: L<$result_source|DBIx::Class::ResultSource> |
27f01d1f |
576 | |
577 | =back |
82b01c38 |
578 | |
829517d4 |
579 | my $source = $schema->source('Book'); |
85f78622 |
580 | |
829517d4 |
581 | Returns the L<DBIx::Class::ResultSource> object for the registered |
582 | source name. |
66d9ef6b |
583 | |
584 | =cut |
585 | |
829517d4 |
586 | sub source { |
f5f2af8f |
587 | my $self = shift; |
588 | |
589 | $self->throw_exception("source() expects a source name") |
590 | unless @_; |
591 | |
fb13a49f |
592 | my $source_name = shift; |
f5f2af8f |
593 | |
829517d4 |
594 | my $sreg = $self->source_registrations; |
fb13a49f |
595 | return $sreg->{$source_name} if exists $sreg->{$source_name}; |
829517d4 |
596 | |
597 | # if we got here, they probably passed a full class name |
fb13a49f |
598 | my $mapped = $self->class_mappings->{$source_name}; |
599 | $self->throw_exception("Can't find source for ${source_name}") |
829517d4 |
600 | unless $mapped && exists $sreg->{$mapped}; |
601 | return $sreg->{$mapped}; |
161fb223 |
602 | } |
603 | |
829517d4 |
604 | =head2 class |
87c4e602 |
605 | |
27f01d1f |
606 | =over 4 |
607 | |
fb13a49f |
608 | =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name> |
66d9ef6b |
609 | |
829517d4 |
610 | =item Return Value: $classname |
27f01d1f |
611 | |
612 | =back |
82b01c38 |
613 | |
829517d4 |
614 | my $class = $schema->class('CD'); |
615 | |
616 | Retrieves the Result class name for the given source name. |
66d9ef6b |
617 | |
618 | =cut |
619 | |
829517d4 |
620 | sub class { |
fb13a49f |
621 | my ($self, $source_name) = @_; |
622 | return $self->source($source_name)->result_class; |
829517d4 |
623 | } |
08b515f1 |
624 | |
4012acd8 |
625 | =head2 txn_do |
08b515f1 |
626 | |
4012acd8 |
627 | =over 4 |
08b515f1 |
628 | |
4012acd8 |
629 | =item Arguments: C<$coderef>, @coderef_args? |
08b515f1 |
630 | |
4012acd8 |
631 | =item Return Value: The return value of $coderef |
08b515f1 |
632 | |
4012acd8 |
633 | =back |
08b515f1 |
634 | |
4012acd8 |
635 | Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically, |
636 | returning its result (if any). Equivalent to calling $schema->storage->txn_do. |
637 | See L<DBIx::Class::Storage/"txn_do"> for more information. |
08b515f1 |
638 | |
4012acd8 |
639 | This interface is preferred over using the individual methods L</txn_begin>, |
640 | L</txn_commit>, and L</txn_rollback> below. |
08b515f1 |
641 | |
f9f06ae0 |
642 | WARNING: If you are connected with C<< AutoCommit => 0 >> the transaction is |
281719d2 |
643 | considered nested, and you will still need to call L</txn_commit> to write your |
f9f06ae0 |
644 | changes when appropriate. You will also want to connect with C<< auto_savepoint => |
645 | 1 >> to get partial rollback to work, if the storage driver for your database |
281719d2 |
646 | supports it. |
647 | |
f9f06ae0 |
648 | Connecting with C<< AutoCommit => 1 >> is recommended. |
281719d2 |
649 | |
4012acd8 |
650 | =cut |
08b515f1 |
651 | |
4012acd8 |
652 | sub txn_do { |
653 | my $self = shift; |
08b515f1 |
654 | |
4012acd8 |
655 | $self->storage or $self->throw_exception |
656 | ('txn_do called on $schema without storage'); |
08b515f1 |
657 | |
4012acd8 |
658 | $self->storage->txn_do(@_); |
659 | } |
66d9ef6b |
660 | |
6936e902 |
661 | =head2 txn_scope_guard |
75c8a7ab |
662 | |
fd323bf1 |
663 | Runs C<txn_scope_guard> on the schema's storage. See |
89028f42 |
664 | L<DBIx::Class::Storage/txn_scope_guard>. |
75c8a7ab |
665 | |
b85be4c1 |
666 | =cut |
667 | |
1bc193ac |
668 | sub txn_scope_guard { |
669 | my $self = shift; |
670 | |
671 | $self->storage or $self->throw_exception |
672 | ('txn_scope_guard called on $schema without storage'); |
673 | |
674 | $self->storage->txn_scope_guard(@_); |
675 | } |
676 | |
4012acd8 |
677 | =head2 txn_begin |
a62cf8d4 |
678 | |
4012acd8 |
679 | Begins a transaction (does nothing if AutoCommit is off). Equivalent to |
680 | calling $schema->storage->txn_begin. See |
8bfce9d5 |
681 | L<DBIx::Class::Storage/"txn_begin"> for more information. |
27f01d1f |
682 | |
4012acd8 |
683 | =cut |
82b01c38 |
684 | |
4012acd8 |
685 | sub txn_begin { |
686 | my $self = shift; |
27f01d1f |
687 | |
4012acd8 |
688 | $self->storage or $self->throw_exception |
689 | ('txn_begin called on $schema without storage'); |
a62cf8d4 |
690 | |
4012acd8 |
691 | $self->storage->txn_begin; |
692 | } |
a62cf8d4 |
693 | |
4012acd8 |
694 | =head2 txn_commit |
a62cf8d4 |
695 | |
4012acd8 |
696 | Commits the current transaction. Equivalent to calling |
8bfce9d5 |
697 | $schema->storage->txn_commit. See L<DBIx::Class::Storage/"txn_commit"> |
4012acd8 |
698 | for more information. |
a62cf8d4 |
699 | |
4012acd8 |
700 | =cut |
a62cf8d4 |
701 | |
4012acd8 |
702 | sub txn_commit { |
703 | my $self = shift; |
a62cf8d4 |
704 | |
4012acd8 |
705 | $self->storage or $self->throw_exception |
706 | ('txn_commit called on $schema without storage'); |
a62cf8d4 |
707 | |
4012acd8 |
708 | $self->storage->txn_commit; |
709 | } |
70634260 |
710 | |
4012acd8 |
711 | =head2 txn_rollback |
a62cf8d4 |
712 | |
4012acd8 |
713 | Rolls back the current transaction. Equivalent to calling |
714 | $schema->storage->txn_rollback. See |
8bfce9d5 |
715 | L<DBIx::Class::Storage/"txn_rollback"> for more information. |
a62cf8d4 |
716 | |
717 | =cut |
718 | |
4012acd8 |
719 | sub txn_rollback { |
720 | my $self = shift; |
a62cf8d4 |
721 | |
19630353 |
722 | $self->storage or $self->throw_exception |
4012acd8 |
723 | ('txn_rollback called on $schema without storage'); |
a62cf8d4 |
724 | |
4012acd8 |
725 | $self->storage->txn_rollback; |
a62cf8d4 |
726 | } |
727 | |
829517d4 |
728 | =head2 storage |
66d9ef6b |
729 | |
829517d4 |
730 | my $storage = $schema->storage; |
04786a4c |
731 | |
829517d4 |
732 | Returns the L<DBIx::Class::Storage> object for this Schema. Grab this |
733 | if you want to turn on SQL statement debugging at runtime, or set the |
734 | quote character. For the default storage, the documentation can be |
735 | found in L<DBIx::Class::Storage::DBI>. |
66d9ef6b |
736 | |
87c4e602 |
737 | =head2 populate |
738 | |
27f01d1f |
739 | =over 4 |
740 | |
44e95db4 |
741 | =item Arguments: L<$source_name|DBIx::Class::ResultSource/source_name>, [ \@column_list, \@row_values+ ] | [ \%col_data+ ] |
27f01d1f |
742 | |
44e95db4 |
743 | =item Return Value: L<\@result_objects|DBIx::Class::Manual::ResultClass> (scalar context) | L<@result_objects|DBIx::Class::Manual::ResultClass> (list context) |
829517d4 |
744 | |
27f01d1f |
745 | =back |
a37a4697 |
746 | |
44e95db4 |
747 | A convenience shortcut to L<DBIx::Class::ResultSet/populate>. Equivalent to: |
748 | |
749 | $schema->resultset($source_name)->populate([...]); |
750 | |
751 | =over 4 |
752 | |
753 | =item NOTE |
754 | |
755 | The context of this method call has an important effect on what is |
756 | submitted to storage. In void context data is fed directly to fastpath |
757 | insertion routines provided by the underlying storage (most often |
758 | L<DBI/execute_for_fetch>), bypassing the L<new|DBIx::Class::Row/new> and |
759 | L<insert|DBIx::Class::Row/insert> calls on the |
760 | L<Result|DBIx::Class::Manual::ResultClass> class, including any |
761 | augmentation of these methods provided by components. For example if you |
762 | are using something like L<DBIx::Class::UUIDColumns> to create primary |
763 | keys for you, you will find that your PKs are empty. In this case you |
764 | will have to explicitly force scalar or list context in order to create |
765 | those values. |
766 | |
767 | =back |
a37a4697 |
768 | |
769 | =cut |
770 | |
771 | sub populate { |
772 | my ($self, $name, $data) = @_; |
c4e67d31 |
773 | if(my $rs = $self->resultset($name)) { |
774 | if(defined wantarray) { |
775 | return $rs->populate($data); |
776 | } else { |
777 | $rs->populate($data); |
54e0bd06 |
778 | } |
c4e67d31 |
779 | } else { |
fd323bf1 |
780 | $self->throw_exception("$name is not a resultset"); |
8b93a938 |
781 | } |
a37a4697 |
782 | } |
783 | |
829517d4 |
784 | =head2 connection |
785 | |
786 | =over 4 |
787 | |
788 | =item Arguments: @args |
789 | |
790 | =item Return Value: $new_schema |
791 | |
792 | =back |
793 | |
794 | Similar to L</connect> except sets the storage object and connection |
795 | data in-place on the Schema class. You should probably be calling |
796 | L</connect> to get a proper Schema object instead. |
797 | |
4c7d99ca |
798 | =head3 Overloading |
799 | |
800 | Overload C<connection> to change the behaviour of C<connect>. |
829517d4 |
801 | |
802 | =cut |
803 | |
804 | sub connection { |
805 | my ($self, @info) = @_; |
806 | return $self if !@info && $self->storage; |
d4daee7b |
807 | |
fd323bf1 |
808 | my ($storage_class, $args) = ref $self->storage_type ? |
829517d4 |
809 | ($self->_normalize_storage_type($self->storage_type),{}) : ($self->storage_type, {}); |
d4daee7b |
810 | |
829517d4 |
811 | $storage_class = 'DBIx::Class::Storage'.$storage_class |
812 | if $storage_class =~ m/^::/; |
9780718f |
813 | try { |
814 | $self->ensure_class_loaded ($storage_class); |
815 | } |
816 | catch { |
817 | $self->throw_exception( |
dee99c24 |
818 | "Unable to load storage class ${storage_class}: $_" |
9780718f |
819 | ); |
820 | }; |
829517d4 |
821 | my $storage = $storage_class->new($self=>$args); |
822 | $storage->connect_info(\@info); |
823 | $self->storage($storage); |
824 | return $self; |
825 | } |
826 | |
827 | sub _normalize_storage_type { |
828 | my ($self, $storage_type) = @_; |
829 | if(ref $storage_type eq 'ARRAY') { |
830 | return @$storage_type; |
831 | } elsif(ref $storage_type eq 'HASH') { |
832 | return %$storage_type; |
833 | } else { |
834 | $self->throw_exception('Unsupported REFTYPE given: '. ref $storage_type); |
835 | } |
836 | } |
837 | |
838 | =head2 compose_namespace |
82cc0386 |
839 | |
840 | =over 4 |
841 | |
829517d4 |
842 | =item Arguments: $target_namespace, $additional_base_class? |
843 | |
844 | =item Retur Value: $new_schema |
845 | |
846 | =back |
847 | |
848 | For each L<DBIx::Class::ResultSource> in the schema, this method creates a |
849 | class in the target namespace (e.g. $target_namespace::CD, |
850 | $target_namespace::Artist) that inherits from the corresponding classes |
851 | attached to the current schema. |
852 | |
853 | It also attaches a corresponding L<DBIx::Class::ResultSource> object to the |
854 | new $schema object. If C<$additional_base_class> is given, the new composed |
48580715 |
855 | classes will inherit from first the corresponding class from the current |
829517d4 |
856 | schema then the base class. |
857 | |
858 | For example, for a schema with My::Schema::CD and My::Schema::Artist classes, |
859 | |
860 | $schema->compose_namespace('My::DB', 'Base::Class'); |
861 | print join (', ', @My::DB::CD::ISA) . "\n"; |
862 | print join (', ', @My::DB::Artist::ISA) ."\n"; |
863 | |
864 | will produce the output |
865 | |
866 | My::Schema::CD, Base::Class |
867 | My::Schema::Artist, Base::Class |
868 | |
869 | =cut |
870 | |
871 | # this might be oversimplified |
872 | # sub compose_namespace { |
873 | # my ($self, $target, $base) = @_; |
874 | |
875 | # my $schema = $self->clone; |
fb13a49f |
876 | # foreach my $source_name ($schema->sources) { |
877 | # my $source = $schema->source($source_name); |
878 | # my $target_class = "${target}::${source_name}"; |
829517d4 |
879 | # $self->inject_base( |
880 | # $target_class => $source->result_class, ($base ? $base : ()) |
881 | # ); |
882 | # $source->result_class($target_class); |
883 | # $target_class->result_source_instance($source) |
884 | # if $target_class->can('result_source_instance'); |
fb13a49f |
885 | # $schema->register_source($source_name, $source); |
829517d4 |
886 | # } |
887 | # return $schema; |
888 | # } |
889 | |
890 | sub compose_namespace { |
891 | my ($self, $target, $base) = @_; |
dee99c24 |
892 | |
829517d4 |
893 | my $schema = $self->clone; |
dee99c24 |
894 | |
895 | $schema->source_registrations({}); |
896 | |
897 | # the original class-mappings must remain - otherwise |
898 | # reverse_relationship_info will not work |
899 | #$schema->class_mappings({}); |
900 | |
829517d4 |
901 | { |
902 | no warnings qw/redefine/; |
87bf71d5 |
903 | local *Class::C3::reinitialize = sub { } if DBIx::Class::_ENV_::OLD_MRO; |
904 | use warnings qw/redefine/; |
905 | |
a8c2c746 |
906 | no strict qw/refs/; |
fb13a49f |
907 | foreach my $source_name ($self->sources) { |
908 | my $orig_source = $self->source($source_name); |
dee99c24 |
909 | |
fb13a49f |
910 | my $target_class = "${target}::${source_name}"; |
dee99c24 |
911 | $self->inject_base($target_class, $orig_source->result_class, ($base || ()) ); |
912 | |
913 | # register_source examines result_class, and then returns us a clone |
fb13a49f |
914 | my $new_source = $schema->register_source($source_name, bless |
dee99c24 |
915 | { %$orig_source, result_class => $target_class }, |
916 | ref $orig_source, |
829517d4 |
917 | ); |
a8c2c746 |
918 | |
dee99c24 |
919 | if ($target_class->can('result_source_instance')) { |
920 | # give the class a schema-less source copy |
921 | $target_class->result_source_instance( bless |
922 | { %$new_source, schema => ref $new_source->{schema} || $new_source->{schema} }, |
923 | ref $new_source, |
924 | ); |
a8c2c746 |
925 | } |
829517d4 |
926 | } |
dee99c24 |
927 | |
829517d4 |
928 | foreach my $meth (qw/class source resultset/) { |
dee99c24 |
929 | no warnings 'redefine'; |
6298a324 |
930 | *{"${target}::${meth}"} = subname "${target}::${meth}" => |
829517d4 |
931 | sub { shift->schema->$meth(@_) }; |
932 | } |
933 | } |
dee99c24 |
934 | |
935 | Class::C3->reinitialize() if DBIx::Class::_ENV_::OLD_MRO; |
936 | |
829517d4 |
937 | return $schema; |
938 | } |
939 | |
940 | sub setup_connection_class { |
941 | my ($class, $target, @info) = @_; |
942 | $class->inject_base($target => 'DBIx::Class::DB'); |
943 | #$target->load_components('DB'); |
944 | $target->connection(@info); |
945 | } |
946 | |
947 | =head2 svp_begin |
948 | |
fd323bf1 |
949 | Creates a new savepoint (does nothing outside a transaction). |
829517d4 |
950 | Equivalent to calling $schema->storage->svp_begin. See |
8bfce9d5 |
951 | L<DBIx::Class::Storage/"svp_begin"> for more information. |
829517d4 |
952 | |
953 | =cut |
954 | |
955 | sub svp_begin { |
956 | my ($self, $name) = @_; |
957 | |
958 | $self->storage or $self->throw_exception |
959 | ('svp_begin called on $schema without storage'); |
960 | |
961 | $self->storage->svp_begin($name); |
962 | } |
963 | |
964 | =head2 svp_release |
965 | |
fd323bf1 |
966 | Releases a savepoint (does nothing outside a transaction). |
829517d4 |
967 | Equivalent to calling $schema->storage->svp_release. See |
8bfce9d5 |
968 | L<DBIx::Class::Storage/"svp_release"> for more information. |
829517d4 |
969 | |
970 | =cut |
971 | |
972 | sub svp_release { |
973 | my ($self, $name) = @_; |
974 | |
975 | $self->storage or $self->throw_exception |
976 | ('svp_release called on $schema without storage'); |
82cc0386 |
977 | |
829517d4 |
978 | $self->storage->svp_release($name); |
979 | } |
82cc0386 |
980 | |
829517d4 |
981 | =head2 svp_rollback |
db5dc233 |
982 | |
fd323bf1 |
983 | Rollback to a savepoint (does nothing outside a transaction). |
829517d4 |
984 | Equivalent to calling $schema->storage->svp_rollback. See |
8bfce9d5 |
985 | L<DBIx::Class::Storage/"svp_rollback"> for more information. |
82cc0386 |
986 | |
829517d4 |
987 | =cut |
82cc0386 |
988 | |
829517d4 |
989 | sub svp_rollback { |
990 | my ($self, $name) = @_; |
82cc0386 |
991 | |
829517d4 |
992 | $self->storage or $self->throw_exception |
993 | ('svp_rollback called on $schema without storage'); |
82cc0386 |
994 | |
829517d4 |
995 | $self->storage->svp_rollback($name); |
996 | } |
db5dc233 |
997 | |
829517d4 |
998 | =head2 clone |
613397e7 |
999 | |
84c5863b |
1000 | =over 4 |
613397e7 |
1001 | |
71829446 |
1002 | =item Arguments: %attrs? |
1003 | |
829517d4 |
1004 | =item Return Value: $new_schema |
613397e7 |
1005 | |
1006 | =back |
1007 | |
829517d4 |
1008 | Clones the schema and its associated result_source objects and returns the |
71829446 |
1009 | copy. The resulting copy will have the same attributes as the source schema, |
1010 | except for those attributes explicitly overriden by the provided C<%attrs>. |
829517d4 |
1011 | |
1012 | =cut |
1013 | |
1014 | sub clone { |
71829446 |
1015 | my $self = shift; |
1016 | |
1017 | my $clone = { |
1018 | (ref $self ? %$self : ()), |
1019 | (@_ == 1 && ref $_[0] eq 'HASH' ? %{ $_[0] } : @_), |
1020 | }; |
829517d4 |
1021 | bless $clone, (ref $self || $self); |
1022 | |
93963f59 |
1023 | $clone->$_(undef) for qw/class_mappings source_registrations storage/; |
1024 | |
1025 | $clone->_copy_state_from($self); |
1026 | |
1027 | return $clone; |
1028 | } |
1029 | |
1030 | # Needed in Schema::Loader - if you refactor, please make a compatibility shim |
1031 | # -- Caelum |
1032 | sub _copy_state_from { |
1033 | my ($self, $from) = @_; |
1034 | |
1035 | $self->class_mappings({ %{$from->class_mappings} }); |
1036 | $self->source_registrations({ %{$from->source_registrations} }); |
1037 | |
fb13a49f |
1038 | foreach my $source_name ($from->sources) { |
1039 | my $source = $from->source($source_name); |
829517d4 |
1040 | my $new = $source->new($source); |
1041 | # we use extra here as we want to leave the class_mappings as they are |
1042 | # but overwrite the source_registrations entry with the new source |
fb13a49f |
1043 | $self->register_extra_source($source_name => $new); |
829517d4 |
1044 | } |
dee99c24 |
1045 | |
93963f59 |
1046 | if ($from->storage) { |
1047 | $self->storage($from->storage); |
1048 | $self->storage->set_schema($self); |
1049 | } |
829517d4 |
1050 | } |
613397e7 |
1051 | |
5160b401 |
1052 | =head2 throw_exception |
701da8c4 |
1053 | |
75d07914 |
1054 | =over 4 |
82b01c38 |
1055 | |
ebc77b53 |
1056 | =item Arguments: $message |
82b01c38 |
1057 | |
1058 | =back |
1059 | |
70c28808 |
1060 | Throws an exception. Obeys the exemption rules of L<DBIx::Class::Carp> to report |
1061 | errors from outer-user's perspective. See L</exception_action> for details on overriding |
4b946902 |
1062 | this method's behavior. If L</stacktrace> is turned on, C<throw_exception>'s |
1063 | default behavior will provide a detailed stack trace. |
701da8c4 |
1064 | |
1065 | =cut |
1066 | |
c3e9f718 |
1067 | my $false_exception_action_warned; |
701da8c4 |
1068 | sub throw_exception { |
82cc0386 |
1069 | my $self = shift; |
4981dc70 |
1070 | |
c3e9f718 |
1071 | if (my $act = $self->exception_action) { |
1072 | if ($act->(@_)) { |
1073 | DBIx::Class::Exception->throw( |
1074 | "Invocation of the exception_action handler installed on $self did *not*" |
1075 | .' result in an exception. DBIx::Class is unable to function without a reliable' |
1076 | .' exception mechanism, ensure that exception_action does not hide exceptions' |
1077 | ." (original error: $_[0])" |
1078 | ); |
1079 | } |
1080 | elsif(! $false_exception_action_warned++) { |
1081 | carp ( |
1082 | "The exception_action handler installed on $self returned false instead" |
1083 | .' of throwing an exception. This behavior has been deprecated, adjust your' |
1084 | .' handler to always rethrow the supplied error.' |
1085 | ); |
1086 | } |
1087 | } |
1088 | |
1089 | DBIx::Class::Exception->throw($_[0], $self->stacktrace); |
701da8c4 |
1090 | } |
1091 | |
dfccde48 |
1092 | =head2 deploy |
1c339d71 |
1093 | |
82b01c38 |
1094 | =over 4 |
1095 | |
10976519 |
1096 | =item Arguments: \%sqlt_args, $dir |
82b01c38 |
1097 | |
1098 | =back |
1099 | |
1100 | Attempts to deploy the schema to the current storage using L<SQL::Translator>. |
ec6704d4 |
1101 | |
10976519 |
1102 | See L<SQL::Translator/METHODS> for a list of values for C<\%sqlt_args>. |
1103 | The most common value for this would be C<< { add_drop_table => 1 } >> |
1104 | to have the SQL produced include a C<DROP TABLE> statement for each table |
1105 | created. For quoting purposes supply C<quote_table_names> and |
3e82fc27 |
1106 | C<quote_field_names>. |
51bace1c |
1107 | |
fd323bf1 |
1108 | Additionally, the DBIx::Class parser accepts a C<sources> parameter as a hash |
1109 | ref or an array ref, containing a list of source to deploy. If present, then |
0e2c6809 |
1110 | only the sources listed will get deployed. Furthermore, you can use the |
1111 | C<add_fk_index> parser parameter to prevent the parser from creating an index for each |
1112 | FK. |
499adf63 |
1113 | |
1c339d71 |
1114 | =cut |
1115 | |
1116 | sub deploy { |
6e73ac25 |
1117 | my ($self, $sqltargs, $dir) = @_; |
1c339d71 |
1118 | $self->throw_exception("Can't deploy without storage") unless $self->storage; |
6e73ac25 |
1119 | $self->storage->deploy($self, undef, $sqltargs, $dir); |
1c339d71 |
1120 | } |
1121 | |
0e0ce6c1 |
1122 | =head2 deployment_statements |
1123 | |
1124 | =over 4 |
1125 | |
10976519 |
1126 | =item Arguments: See L<DBIx::Class::Storage::DBI/deployment_statements> |
0e0ce6c1 |
1127 | |
fb13a49f |
1128 | =item Return Value: $listofstatements |
829517d4 |
1129 | |
0e0ce6c1 |
1130 | =back |
1131 | |
10976519 |
1132 | A convenient shortcut to |
1133 | C<< $self->storage->deployment_statements($self, @args) >>. |
1134 | Returns the SQL statements used by L</deploy> and |
1135 | L<DBIx::Class::Schema::Storage/deploy>. |
0e0ce6c1 |
1136 | |
1137 | =cut |
1138 | |
1139 | sub deployment_statements { |
7ad93f5a |
1140 | my $self = shift; |
0e0ce6c1 |
1141 | |
1142 | $self->throw_exception("Can't generate deployment statements without a storage") |
1143 | if not $self->storage; |
1144 | |
7ad93f5a |
1145 | $self->storage->deployment_statements($self, @_); |
0e0ce6c1 |
1146 | } |
1147 | |
6dfbe2f8 |
1148 | =head2 create_ddl_dir |
c0f61310 |
1149 | |
1150 | =over 4 |
1151 | |
10976519 |
1152 | =item Arguments: See L<DBIx::Class::Storage::DBI/create_ddl_dir> |
c0f61310 |
1153 | |
1154 | =back |
1155 | |
fd323bf1 |
1156 | A convenient shortcut to |
10976519 |
1157 | C<< $self->storage->create_ddl_dir($self, @args) >>. |
c9d2e0a2 |
1158 | |
10976519 |
1159 | Creates an SQL file based on the Schema, for each of the specified |
1160 | database types, in the given directory. |
c9d2e0a2 |
1161 | |
c0f61310 |
1162 | =cut |
1163 | |
6e73ac25 |
1164 | sub create_ddl_dir { |
e673f011 |
1165 | my $self = shift; |
1166 | |
1167 | $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; |
1168 | $self->storage->create_ddl_dir($self, @_); |
1169 | } |
1170 | |
e63a82f7 |
1171 | =head2 ddl_filename |
9b83fccd |
1172 | |
c9d2e0a2 |
1173 | =over 4 |
1174 | |
99a74c4a |
1175 | =item Arguments: $database-type, $version, $directory, $preversion |
c9d2e0a2 |
1176 | |
fb13a49f |
1177 | =item Return Value: $normalised_filename |
829517d4 |
1178 | |
c9d2e0a2 |
1179 | =back |
1180 | |
99a74c4a |
1181 | my $filename = $table->ddl_filename($type, $version, $dir, $preversion) |
c9d2e0a2 |
1182 | |
1183 | This method is called by C<create_ddl_dir> to compose a file name out of |
1184 | the supplied directory, database type and version number. The default file |
1185 | name format is: C<$dir$schema-$version-$type.sql>. |
9b83fccd |
1186 | |
c9d2e0a2 |
1187 | You may override this method in your schema if you wish to use a different |
1188 | format. |
9b83fccd |
1189 | |
1acfef8e |
1190 | WARNING |
1191 | |
1192 | Prior to DBIx::Class version 0.08100 this method had a different signature: |
1193 | |
1194 | my $filename = $table->ddl_filename($type, $dir, $version, $preversion) |
1195 | |
1196 | In recent versions variables $dir and $version were reversed in order to |
fd323bf1 |
1197 | bring the signature in line with other Schema/Storage methods. If you |
1acfef8e |
1198 | really need to maintain backward compatibility, you can do the following |
1199 | in any overriding methods: |
1200 | |
1201 | ($dir, $version) = ($version, $dir) if ($DBIx::Class::VERSION < 0.08100); |
1202 | |
9b83fccd |
1203 | =cut |
1204 | |
6e73ac25 |
1205 | sub ddl_filename { |
99a74c4a |
1206 | my ($self, $type, $version, $dir, $preversion) = @_; |
e673f011 |
1207 | |
3b80fa31 |
1208 | require File::Spec; |
1209 | |
aea59b74 |
1210 | $version = "$preversion-$version" if $preversion; |
d4daee7b |
1211 | |
aea59b74 |
1212 | my $class = blessed($self) || $self; |
1213 | $class =~ s/::/-/g; |
1214 | |
1215 | return File::Spec->catfile($dir, "$class-$version-$type.sql"); |
e673f011 |
1216 | } |
1217 | |
4146e3da |
1218 | =head2 thaw |
1219 | |
fd323bf1 |
1220 | Provided as the recommended way of thawing schema objects. You can call |
4146e3da |
1221 | C<Storable::thaw> directly if you wish, but the thawed objects will not have a |
48580715 |
1222 | reference to any schema, so are rather useless. |
4146e3da |
1223 | |
1224 | =cut |
1225 | |
1226 | sub thaw { |
1227 | my ($self, $obj) = @_; |
1228 | local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; |
3b80fa31 |
1229 | require Storable; |
4146e3da |
1230 | return Storable::thaw($obj); |
1231 | } |
1232 | |
1233 | =head2 freeze |
1234 | |
26148d36 |
1235 | This doesn't actually do anything more than call L<Storable/nfreeze>, it is just |
48580715 |
1236 | provided here for symmetry. |
4146e3da |
1237 | |
d2f3e87b |
1238 | =cut |
1239 | |
4146e3da |
1240 | sub freeze { |
3b80fa31 |
1241 | require Storable; |
26148d36 |
1242 | return Storable::nfreeze($_[1]); |
4146e3da |
1243 | } |
1244 | |
1245 | =head2 dclone |
1246 | |
1477a478 |
1247 | =over 4 |
1248 | |
1249 | =item Arguments: $object |
1250 | |
1251 | =item Return Value: dcloned $object |
1252 | |
1253 | =back |
1254 | |
9e9ecfda |
1255 | Recommended way of dcloning L<DBIx::Class::Row> and L<DBIx::Class::ResultSet> |
1256 | objects so their references to the schema object |
1257 | (which itself is B<not> cloned) are properly maintained. |
4146e3da |
1258 | |
1259 | =cut |
1260 | |
1261 | sub dclone { |
1262 | my ($self, $obj) = @_; |
1263 | local $DBIx::Class::ResultSourceHandle::thaw_schema = $self; |
3b80fa31 |
1264 | require Storable; |
4146e3da |
1265 | return Storable::dclone($obj); |
1266 | } |
1267 | |
93e4d41a |
1268 | =head2 schema_version |
1269 | |
829517d4 |
1270 | Returns the current schema class' $VERSION in a normalised way. |
93e4d41a |
1271 | |
1272 | =cut |
1273 | |
1274 | sub schema_version { |
1275 | my ($self) = @_; |
1276 | my $class = ref($self)||$self; |
1277 | |
1278 | # does -not- use $schema->VERSION |
1279 | # since that varies in results depending on if version.pm is installed, and if |
1280 | # so the perl or XS versions. If you want this to change, bug the version.pm |
1281 | # author to make vpp and vxs behave the same. |
1282 | |
1283 | my $version; |
1284 | { |
1285 | no strict 'refs'; |
1286 | $version = ${"${class}::VERSION"}; |
1287 | } |
1288 | return $version; |
1289 | } |
1290 | |
829517d4 |
1291 | |
1292 | =head2 register_class |
1293 | |
1294 | =over 4 |
1295 | |
fb13a49f |
1296 | =item Arguments: $source_name, $component_class |
829517d4 |
1297 | |
1298 | =back |
1299 | |
fd323bf1 |
1300 | This method is called by L</load_namespaces> and L</load_classes> to install the found classes into your Schema. You should be using those instead of this one. |
829517d4 |
1301 | |
1302 | You will only need this method if you have your Result classes in |
1303 | files which are not named after the packages (or all in the same |
1304 | file). You may also need it to register classes at runtime. |
1305 | |
1306 | Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to |
1307 | calling: |
1308 | |
fb13a49f |
1309 | $schema->register_source($source_name, $component_class->result_source_instance); |
829517d4 |
1310 | |
1311 | =cut |
1312 | |
1313 | sub register_class { |
fb13a49f |
1314 | my ($self, $source_name, $to_register) = @_; |
1315 | $self->register_source($source_name => $to_register->result_source_instance); |
829517d4 |
1316 | } |
1317 | |
1318 | =head2 register_source |
1319 | |
1320 | =over 4 |
1321 | |
fb13a49f |
1322 | =item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource> |
829517d4 |
1323 | |
1324 | =back |
1325 | |
1326 | This method is called by L</register_class>. |
1327 | |
1328 | Registers the L<DBIx::Class::ResultSource> in the schema with the given |
fb13a49f |
1329 | source name. |
829517d4 |
1330 | |
1331 | =cut |
1332 | |
dee99c24 |
1333 | sub register_source { shift->_register_source(@_) } |
829517d4 |
1334 | |
98cabed3 |
1335 | =head2 unregister_source |
1336 | |
1337 | =over 4 |
1338 | |
fb13a49f |
1339 | =item Arguments: $source_name |
98cabed3 |
1340 | |
1341 | =back |
1342 | |
fb13a49f |
1343 | Removes the L<DBIx::Class::ResultSource> from the schema for the given source name. |
98cabed3 |
1344 | |
1345 | =cut |
1346 | |
dee99c24 |
1347 | sub unregister_source { shift->_unregister_source(@_) } |
98cabed3 |
1348 | |
829517d4 |
1349 | =head2 register_extra_source |
1350 | |
1351 | =over 4 |
1352 | |
fb13a49f |
1353 | =item Arguments: $source_name, L<$result_source|DBIx::Class::ResultSource> |
829517d4 |
1354 | |
1355 | =back |
1356 | |
fd323bf1 |
1357 | As L</register_source> but should be used if the result class already |
829517d4 |
1358 | has a source and you want to register an extra one. |
1359 | |
1360 | =cut |
1361 | |
dee99c24 |
1362 | sub register_extra_source { shift->_register_source(@_, { extra => 1 }) } |
829517d4 |
1363 | |
1364 | sub _register_source { |
fb13a49f |
1365 | my ($self, $source_name, $source, $params) = @_; |
829517d4 |
1366 | |
fb13a49f |
1367 | $source = $source->new({ %$source, source_name => $source_name }); |
dee99c24 |
1368 | |
2461ae19 |
1369 | $source->schema($self); |
6298a324 |
1370 | weaken $source->{schema} if ref($self); |
2461ae19 |
1371 | |
829517d4 |
1372 | my %reg = %{$self->source_registrations}; |
fb13a49f |
1373 | $reg{$source_name} = $source; |
829517d4 |
1374 | $self->source_registrations(\%reg); |
1375 | |
dee99c24 |
1376 | return $source if $params->{extra}; |
1377 | |
1378 | my $rs_class = $source->result_class; |
1379 | if ($rs_class and my $rsrc = try { $rs_class->result_source_instance } ) { |
1380 | my %map = %{$self->class_mappings}; |
1381 | if ( |
1382 | exists $map{$rs_class} |
1383 | and |
fb13a49f |
1384 | $map{$rs_class} ne $source_name |
dee99c24 |
1385 | and |
1386 | $rsrc ne $_[2] # orig_source |
1387 | ) { |
1388 | carp |
1389 | "$rs_class already had a registered source which was replaced by this call. " |
1390 | . 'Perhaps you wanted register_extra_source(), though it is more likely you did ' |
1391 | . 'something wrong.' |
1392 | ; |
1393 | } |
1394 | |
fb13a49f |
1395 | $map{$rs_class} = $source_name; |
dee99c24 |
1396 | $self->class_mappings(\%map); |
829517d4 |
1397 | } |
dee99c24 |
1398 | |
1399 | return $source; |
829517d4 |
1400 | } |
1401 | |
a4367b26 |
1402 | my $global_phase_destroy; |
1403 | sub DESTROY { |
1404 | return if $global_phase_destroy ||= in_global_destruction; |
66917da3 |
1405 | |
a4367b26 |
1406 | my $self = shift; |
1407 | my $srcs = $self->source_registrations; |
1408 | |
fb13a49f |
1409 | for my $source_name (keys %$srcs) { |
a4367b26 |
1410 | # find first source that is not about to be GCed (someone other than $self |
1411 | # holds a reference to it) and reattach to it, weakening our own link |
1412 | # |
1413 | # during global destruction (if we have not yet bailed out) this should throw |
1414 | # which will serve as a signal to not try doing anything else |
1415 | # however beware - on older perls the exception seems randomly untrappable |
1416 | # due to some weird race condition during thread joining :((( |
fb13a49f |
1417 | if (ref $srcs->{$source_name} and svref_2object($srcs->{$source_name})->REFCNT > 1) { |
a4367b26 |
1418 | local $@; |
1419 | eval { |
fb13a49f |
1420 | $srcs->{$source_name}->schema($self); |
1421 | weaken $srcs->{$source_name}; |
a4367b26 |
1422 | 1; |
1423 | } or do { |
1424 | $global_phase_destroy = 1; |
1425 | }; |
1426 | |
1427 | last; |
50261284 |
1428 | } |
1429 | } |
1430 | } |
1431 | |
829517d4 |
1432 | sub _unregister_source { |
fb13a49f |
1433 | my ($self, $source_name) = @_; |
fd323bf1 |
1434 | my %reg = %{$self->source_registrations}; |
829517d4 |
1435 | |
fb13a49f |
1436 | my $source = delete $reg{$source_name}; |
829517d4 |
1437 | $self->source_registrations(\%reg); |
1438 | if ($source->result_class) { |
1439 | my %map = %{$self->class_mappings}; |
1440 | delete $map{$source->result_class}; |
1441 | $self->class_mappings(\%map); |
1442 | } |
1443 | } |
1444 | |
1445 | |
1446 | =head2 compose_connection (DEPRECATED) |
1447 | |
1448 | =over 4 |
1449 | |
1450 | =item Arguments: $target_namespace, @db_info |
1451 | |
1452 | =item Return Value: $new_schema |
1453 | |
1454 | =back |
1455 | |
1456 | DEPRECATED. You probably wanted compose_namespace. |
1457 | |
1458 | Actually, you probably just wanted to call connect. |
1459 | |
1460 | =begin hidden |
1461 | |
1462 | (hidden due to deprecation) |
1463 | |
1464 | Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace, |
1465 | calls L<DBIx::Class::Schema/connection> with @db_info on the new schema, |
1466 | then injects the L<DBix::Class::ResultSetProxy> component and a |
1467 | resultset_instance classdata entry on all the new classes, in order to support |
1468 | $target_namespaces::$class->search(...) method calls. |
1469 | |
1470 | This is primarily useful when you have a specific need for class method access |
1471 | to a connection. In normal usage it is preferred to call |
1472 | L<DBIx::Class::Schema/connect> and use the resulting schema object to operate |
1473 | on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for |
1474 | more information. |
1475 | |
1476 | =end hidden |
1477 | |
1478 | =cut |
1479 | |
e42bbd7f |
1480 | sub compose_connection { |
1481 | my ($self, $target, @info) = @_; |
829517d4 |
1482 | |
e42bbd7f |
1483 | carp_once "compose_connection deprecated as of 0.08000" |
1484 | unless $INC{"DBIx/Class/CDBICompat.pm"}; |
d4daee7b |
1485 | |
e42bbd7f |
1486 | my $base = 'DBIx::Class::ResultSetProxy'; |
1487 | try { |
1488 | eval "require ${base};" |
1489 | } |
1490 | catch { |
1491 | $self->throw_exception |
1492 | ("No arguments to load_classes and couldn't load ${base} ($_)") |
1493 | }; |
d4daee7b |
1494 | |
e42bbd7f |
1495 | if ($self eq $target) { |
1496 | # Pathological case, largely caused by the docs on early C::M::DBIC::Plain |
fb13a49f |
1497 | foreach my $source_name ($self->sources) { |
1498 | my $source = $self->source($source_name); |
829517d4 |
1499 | my $class = $source->result_class; |
e42bbd7f |
1500 | $self->inject_base($class, $base); |
829517d4 |
1501 | $class->mk_classdata(resultset_instance => $source->resultset); |
e42bbd7f |
1502 | $class->mk_classdata(class_resolver => $self); |
829517d4 |
1503 | } |
e42bbd7f |
1504 | $self->connection(@info); |
1505 | return $self; |
1506 | } |
1507 | |
1508 | my $schema = $self->compose_namespace($target, $base); |
1509 | { |
1510 | no strict 'refs'; |
1511 | my $name = join '::', $target, 'schema'; |
1512 | *$name = subname $name, sub { $schema }; |
829517d4 |
1513 | } |
e42bbd7f |
1514 | |
1515 | $schema->connection(@info); |
fb13a49f |
1516 | foreach my $source_name ($schema->sources) { |
1517 | my $source = $schema->source($source_name); |
e42bbd7f |
1518 | my $class = $source->result_class; |
fb13a49f |
1519 | #warn "$source_name $class $source ".$source->storage; |
e42bbd7f |
1520 | $class->mk_classdata(result_source_instance => $source); |
1521 | $class->mk_classdata(resultset_instance => $source->resultset); |
1522 | $class->mk_classdata(class_resolver => $schema); |
1523 | } |
1524 | return $schema; |
829517d4 |
1525 | } |
1526 | |
a02675cd |
1527 | 1; |
c2da098a |
1528 | |
0c11ad0e |
1529 | =head1 AUTHOR AND CONTRIBUTORS |
c2da098a |
1530 | |
0c11ad0e |
1531 | See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class |
c2da098a |
1532 | |
1533 | =head1 LICENSE |
1534 | |
1535 | You may distribute this code under the same terms as Perl itself. |
1536 | |
1537 | =cut |