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/; |
a917fb06 |
7 | use Scalar::Util qw/weaken/; |
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 | |
24d67825 |
22 | package Library::Schema; |
c2da098a |
23 | use base qw/DBIx::Class::Schema/; |
bab77431 |
24 | |
24d67825 |
25 | # load Library::Schema::CD, Library::Schema::Book, Library::Schema::DVD |
26 | __PACKAGE__->load_classes(qw/CD Book DVD/); |
c2da098a |
27 | |
24d67825 |
28 | package Library::Schema::CD; |
03312470 |
29 | use base qw/DBIx::Class/; |
77254782 |
30 | __PACKAGE__->load_components(qw/PK::Auto Core/); # for example |
24d67825 |
31 | __PACKAGE__->table('cd'); |
c2da098a |
32 | |
5d9076f2 |
33 | # Elsewhere in your code: |
24d67825 |
34 | my $schema1 = Library::Schema->connect( |
a3d93194 |
35 | $dsn, |
36 | $user, |
37 | $password, |
24d67825 |
38 | { AutoCommit => 0 }, |
a3d93194 |
39 | ); |
bab77431 |
40 | |
24d67825 |
41 | my $schema2 = Library::Schema->connect($coderef_returning_dbh); |
c2da098a |
42 | |
24d67825 |
43 | # fetch objects using Library::Schema::DVD |
44 | my $resultset = $schema1->resultset('DVD')->search( ... ); |
45 | my @dvd_objects = $schema2->resultset('DVD')->search( ... ); |
c2da098a |
46 | |
47 | =head1 DESCRIPTION |
48 | |
a3d93194 |
49 | Creates database classes based on a schema. This is the recommended way to |
50 | use L<DBIx::Class> and allows you to use more than one concurrent connection |
51 | with your classes. |
429bd4f1 |
52 | |
03312470 |
53 | NB: If you're used to L<Class::DBI> it's worth reading the L</SYNOPSIS> |
2053ab2a |
54 | carefully, as DBIx::Class does things a little differently. Note in |
03312470 |
55 | particular which module inherits off which. |
56 | |
c2da098a |
57 | =head1 METHODS |
58 | |
87c4e602 |
59 | =head2 register_class |
60 | |
27f01d1f |
61 | =over 4 |
62 | |
ebc77b53 |
63 | =item Arguments: $moniker, $component_class |
27f01d1f |
64 | |
65 | =back |
076652e8 |
66 | |
71f9df37 |
67 | Registers a class which isa DBIx::Class::ResultSourceProxy. Equivalent to |
2053ab2a |
68 | calling: |
66d9ef6b |
69 | |
181a28f4 |
70 | $schema->register_source($moniker, $component_class->result_source_instance); |
076652e8 |
71 | |
c2da098a |
72 | =cut |
73 | |
a02675cd |
74 | sub register_class { |
0dc79249 |
75 | my ($self, $moniker, $to_register) = @_; |
76 | $self->register_source($moniker => $to_register->result_source_instance); |
74b92d9a |
77 | } |
78 | |
87c4e602 |
79 | =head2 register_source |
80 | |
27f01d1f |
81 | =over 4 |
82 | |
ebc77b53 |
83 | =item Arguments: $moniker, $result_source |
27f01d1f |
84 | |
85 | =back |
076652e8 |
86 | |
82b01c38 |
87 | Registers the L<DBIx::Class::ResultSource> in the schema with the given |
88 | moniker. |
076652e8 |
89 | |
90 | =cut |
91 | |
0dc79249 |
92 | sub register_source { |
93 | my ($self, $moniker, $source) = @_; |
94 | my %reg = %{$self->source_registrations}; |
95 | $reg{$moniker} = $source; |
96 | $self->source_registrations(\%reg); |
97 | $source->schema($self); |
a917fb06 |
98 | weaken($source->{schema}) if ref($self); |
0dc79249 |
99 | if ($source->result_class) { |
100 | my %map = %{$self->class_mappings}; |
101 | $map{$source->result_class} = $moniker; |
102 | $self->class_mappings(\%map); |
103 | } |
75d07914 |
104 | } |
a02675cd |
105 | |
bfb2bd4f |
106 | =head2 class |
107 | |
27f01d1f |
108 | =over 4 |
82b01c38 |
109 | |
ebc77b53 |
110 | =item Arguments: $moniker |
27f01d1f |
111 | |
d601dc88 |
112 | =item Return Value: $classname |
27f01d1f |
113 | |
114 | =back |
82b01c38 |
115 | |
2053ab2a |
116 | Retrieves the result class name for the given moniker. For example: |
82b01c38 |
117 | |
118 | my $class = $schema->class('CD'); |
bfb2bd4f |
119 | |
120 | =cut |
121 | |
122 | sub class { |
0dc79249 |
123 | my ($self, $moniker) = @_; |
124 | return $self->source($moniker)->result_class; |
bfb2bd4f |
125 | } |
126 | |
ea20d0fd |
127 | =head2 source |
128 | |
27f01d1f |
129 | =over 4 |
130 | |
ebc77b53 |
131 | =item Arguments: $moniker |
27f01d1f |
132 | |
d601dc88 |
133 | =item Return Value: $result_source |
82b01c38 |
134 | |
27f01d1f |
135 | =back |
82b01c38 |
136 | |
24d67825 |
137 | my $source = $schema->source('Book'); |
ea20d0fd |
138 | |
82b01c38 |
139 | Returns the L<DBIx::Class::ResultSource> object for the registered moniker. |
ea20d0fd |
140 | |
141 | =cut |
142 | |
143 | sub source { |
0dc79249 |
144 | my ($self, $moniker) = @_; |
145 | my $sreg = $self->source_registrations; |
146 | return $sreg->{$moniker} if exists $sreg->{$moniker}; |
147 | |
148 | # if we got here, they probably passed a full class name |
149 | my $mapped = $self->class_mappings->{$moniker}; |
701da8c4 |
150 | $self->throw_exception("Can't find source for ${moniker}") |
0dc79249 |
151 | unless $mapped && exists $sreg->{$mapped}; |
152 | return $sreg->{$mapped}; |
ea20d0fd |
153 | } |
154 | |
0dc79249 |
155 | =head2 sources |
156 | |
27f01d1f |
157 | =over 4 |
158 | |
d601dc88 |
159 | =item Return Value: @source_monikers |
27f01d1f |
160 | |
161 | =back |
82b01c38 |
162 | |
163 | Returns the source monikers of all source registrations on this schema. |
2053ab2a |
164 | For example: |
82b01c38 |
165 | |
166 | my @source_monikers = $schema->sources; |
0dc79249 |
167 | |
168 | =cut |
169 | |
170 | sub sources { return keys %{shift->source_registrations}; } |
171 | |
9b1ba0f2 |
172 | =head2 storage |
173 | |
174 | my $storage = $schema->storage; |
175 | |
176 | Returns the L<DBIx::Class::Storage> object for this Schema. |
177 | |
ea20d0fd |
178 | =head2 resultset |
179 | |
27f01d1f |
180 | =over 4 |
181 | |
ebc77b53 |
182 | =item Arguments: $moniker |
27f01d1f |
183 | |
d601dc88 |
184 | =item Return Value: $result_set |
82b01c38 |
185 | |
27f01d1f |
186 | =back |
82b01c38 |
187 | |
24d67825 |
188 | my $rs = $schema->resultset('DVD'); |
ea20d0fd |
189 | |
82b01c38 |
190 | Returns the L<DBIx::Class::ResultSet> object for the registered moniker. |
ea20d0fd |
191 | |
192 | =cut |
193 | |
194 | sub resultset { |
0dc79249 |
195 | my ($self, $moniker) = @_; |
196 | return $self->source($moniker)->resultset; |
ea20d0fd |
197 | } |
198 | |
87c4e602 |
199 | =head2 load_classes |
200 | |
27f01d1f |
201 | =over 4 |
202 | |
203 | =item Arguments: @classes?, { $namespace => [ @classes ] }+ |
204 | |
205 | =back |
076652e8 |
206 | |
82b01c38 |
207 | With no arguments, this method uses L<Module::Find> to find all classes under |
208 | the schema's namespace. Otherwise, this method loads the classes you specify |
209 | (using L<use>), and registers them (using L</"register_class">). |
076652e8 |
210 | |
2053ab2a |
211 | It is possible to comment out classes with a leading C<#>, but note that perl |
212 | will think it's a mistake (trying to use a comment in a qw list), so you'll |
213 | need to add C<no warnings 'qw';> before your load_classes call. |
5ce32fc1 |
214 | |
2053ab2a |
215 | Example: |
82b01c38 |
216 | |
217 | My::Schema->load_classes(); # loads My::Schema::CD, My::Schema::Artist, |
75d07914 |
218 | # etc. (anything under the My::Schema namespace) |
82b01c38 |
219 | |
220 | # loads My::Schema::CD, My::Schema::Artist, Other::Namespace::Producer but |
221 | # not Other::Namespace::LinerNotes nor My::Schema::Track |
222 | My::Schema->load_classes(qw/ CD Artist #Track /, { |
223 | Other::Namespace => [qw/ Producer #LinerNotes /], |
224 | }); |
225 | |
076652e8 |
226 | =cut |
227 | |
a02675cd |
228 | sub load_classes { |
5ce32fc1 |
229 | my ($class, @params) = @_; |
bab77431 |
230 | |
5ce32fc1 |
231 | my %comps_for; |
bab77431 |
232 | |
5ce32fc1 |
233 | if (@params) { |
234 | foreach my $param (@params) { |
235 | if (ref $param eq 'ARRAY') { |
236 | # filter out commented entries |
237 | my @modules = grep { $_ !~ /^#/ } @$param; |
bab77431 |
238 | |
5ce32fc1 |
239 | push (@{$comps_for{$class}}, @modules); |
240 | } |
241 | elsif (ref $param eq 'HASH') { |
242 | # more than one namespace possible |
243 | for my $comp ( keys %$param ) { |
244 | # filter out commented entries |
245 | my @modules = grep { $_ !~ /^#/ } @{$param->{$comp}}; |
246 | |
247 | push (@{$comps_for{$comp}}, @modules); |
248 | } |
249 | } |
250 | else { |
251 | # filter out commented entries |
252 | push (@{$comps_for{$class}}, $param) if $param !~ /^#/; |
253 | } |
254 | } |
255 | } else { |
41a6f8c0 |
256 | eval "require Module::Find;"; |
bc0c9800 |
257 | $class->throw_exception( |
258 | "No arguments to load_classes and couldn't load Module::Find ($@)" |
259 | ) if $@; |
260 | my @comp = map { substr $_, length "${class}::" } |
261 | Module::Find::findallmod($class); |
5ce32fc1 |
262 | $comps_for{$class} = \@comp; |
41a6f8c0 |
263 | } |
5ce32fc1 |
264 | |
e6efde04 |
265 | my @to_register; |
266 | { |
267 | no warnings qw/redefine/; |
268 | local *Class::C3::reinitialize = sub { }; |
269 | foreach my $prefix (keys %comps_for) { |
270 | foreach my $comp (@{$comps_for{$prefix}||[]}) { |
271 | my $comp_class = "${prefix}::${comp}"; |
c037c03a |
272 | $class->ensure_class_loaded($comp_class); |
bab77431 |
273 | $comp_class->source_name($comp) unless $comp_class->source_name; |
274 | |
275 | push(@to_register, [ $comp_class->source_name, $comp_class ]); |
bfb2bd4f |
276 | } |
5ce32fc1 |
277 | } |
a02675cd |
278 | } |
e6efde04 |
279 | Class::C3->reinitialize; |
280 | |
281 | foreach my $to (@to_register) { |
282 | $class->register_class(@$to); |
283 | # if $class->can('result_source_instance'); |
284 | } |
a02675cd |
285 | } |
286 | |
87c4e602 |
287 | =head2 compose_connection |
288 | |
27f01d1f |
289 | =over 4 |
290 | |
ebc77b53 |
291 | =item Arguments: $target_namespace, @db_info |
429bd4f1 |
292 | |
d601dc88 |
293 | =item Return Value: $new_schema |
27f01d1f |
294 | |
295 | =back |
076652e8 |
296 | |
2053ab2a |
297 | Calls L<DBIx::Class::Schema/"compose_namespace"> to the target namespace, |
298 | calls L<DBIx::Class::Schema/connection> with @db_info on the new schema, |
299 | then injects the L<DBix::Class::ResultSetProxy> component and a |
300 | resultset_instance classdata entry on all the new classes, in order to support |
82b01c38 |
301 | $target_namespaces::$class->search(...) method calls. |
302 | |
303 | This is primarily useful when you have a specific need for class method access |
304 | to a connection. In normal usage it is preferred to call |
305 | L<DBIx::Class::Schema/connect> and use the resulting schema object to operate |
306 | on L<DBIx::Class::ResultSet> objects with L<DBIx::Class::Schema/resultset> for |
307 | more information. |
54540863 |
308 | |
076652e8 |
309 | =cut |
310 | |
a02675cd |
311 | sub compose_connection { |
ea20d0fd |
312 | my ($self, $target, @info) = @_; |
80c90f5d |
313 | my $base = 'DBIx::Class::ResultSetProxy'; |
8ef144ff |
314 | eval "require ${base};"; |
bc0c9800 |
315 | $self->throw_exception |
316 | ("No arguments to load_classes and couldn't load ${base} ($@)") |
317 | if $@; |
be381829 |
318 | |
319 | if ($self eq $target) { |
320 | # Pathological case, largely caused by the docs on early C::M::DBIC::Plain |
321 | foreach my $moniker ($self->sources) { |
322 | my $source = $self->source($moniker); |
323 | my $class = $source->result_class; |
324 | $self->inject_base($class, $base); |
325 | $class->mk_classdata(resultset_instance => $source->resultset); |
326 | $class->mk_classdata(class_resolver => $self); |
327 | } |
50041f3c |
328 | $self->connection(@info); |
be381829 |
329 | return $self; |
330 | } |
331 | |
66d9ef6b |
332 | my $schema = $self->compose_namespace($target, $base); |
ecceadff |
333 | { |
334 | no strict 'refs'; |
335 | *{"${target}::schema"} = sub { $schema }; |
336 | } |
337 | |
66d9ef6b |
338 | $schema->connection(@info); |
0dc79249 |
339 | foreach my $moniker ($schema->sources) { |
340 | my $source = $schema->source($moniker); |
341 | my $class = $source->result_class; |
342 | #warn "$moniker $class $source ".$source->storage; |
8c49f629 |
343 | $class->mk_classdata(result_source_instance => $source); |
ea20d0fd |
344 | $class->mk_classdata(resultset_instance => $source->resultset); |
66d9ef6b |
345 | $class->mk_classdata(class_resolver => $schema); |
bfb2bd4f |
346 | } |
347 | return $schema; |
e678398e |
348 | } |
349 | |
77254782 |
350 | =head2 compose_namespace |
351 | |
27f01d1f |
352 | =over 4 |
353 | |
354 | =item Arguments: $target_namespace, $additional_base_class? |
82b01c38 |
355 | |
d601dc88 |
356 | =item Return Value: $new_schema |
27f01d1f |
357 | |
358 | =back |
13765dad |
359 | |
82b01c38 |
360 | For each L<DBIx::Class::ResultSource> in the schema, this method creates a |
361 | class in the target namespace (e.g. $target_namespace::CD, |
362 | $target_namespace::Artist) that inherits from the corresponding classes |
363 | attached to the current schema. |
77254782 |
364 | |
82b01c38 |
365 | It also attaches a corresponding L<DBIx::Class::ResultSource> object to the |
366 | new $schema object. If C<$additional_base_class> is given, the new composed |
367 | classes will inherit from first the corresponding classe from the current |
368 | schema then the base class. |
369 | |
2053ab2a |
370 | For example, for a schema with My::Schema::CD and My::Schema::Artist classes, |
82b01c38 |
371 | |
372 | $schema->compose_namespace('My::DB', 'Base::Class'); |
373 | print join (', ', @My::DB::CD::ISA) . "\n"; |
374 | print join (', ', @My::DB::Artist::ISA) ."\n"; |
375 | |
2053ab2a |
376 | will produce the output |
82b01c38 |
377 | |
378 | My::Schema::CD, Base::Class |
379 | My::Schema::Artist, Base::Class |
77254782 |
380 | |
381 | =cut |
382 | |
e678398e |
383 | sub compose_namespace { |
66d9ef6b |
384 | my ($self, $target, $base) = @_; |
385 | my %reg = %{ $self->source_registrations }; |
11b78bd6 |
386 | my %target; |
387 | my %map; |
66d9ef6b |
388 | my $schema = $self->clone; |
e9100ff7 |
389 | { |
390 | no warnings qw/redefine/; |
391 | local *Class::C3::reinitialize = sub { }; |
392 | foreach my $moniker ($schema->sources) { |
393 | my $source = $schema->source($moniker); |
394 | my $target_class = "${target}::${moniker}"; |
395 | $self->inject_base( |
396 | $target_class => $source->result_class, ($base ? $base : ()) |
397 | ); |
398 | $source->result_class($target_class); |
9d3d5af3 |
399 | $target_class->result_source_instance($source) |
400 | if $target_class->can('result_source_instance'); |
e9100ff7 |
401 | } |
b7951443 |
402 | } |
e9100ff7 |
403 | Class::C3->reinitialize(); |
11b78bd6 |
404 | { |
405 | no strict 'refs'; |
1edaf6fe |
406 | foreach my $meth (qw/class source resultset/) { |
407 | *{"${target}::${meth}"} = |
408 | sub { shift->schema->$meth(@_) }; |
409 | } |
11b78bd6 |
410 | } |
bfb2bd4f |
411 | return $schema; |
b7951443 |
412 | } |
413 | |
87c4e602 |
414 | =head2 setup_connection_class |
415 | |
27f01d1f |
416 | =over 4 |
417 | |
ebc77b53 |
418 | =item Arguments: $target, @info |
27f01d1f |
419 | |
420 | =back |
076652e8 |
421 | |
82b01c38 |
422 | Sets up a database connection class to inject between the schema and the |
423 | subclasses that the schema creates. |
429bd4f1 |
424 | |
076652e8 |
425 | =cut |
426 | |
b7951443 |
427 | sub setup_connection_class { |
428 | my ($class, $target, @info) = @_; |
63e9583a |
429 | $class->inject_base($target => 'DBIx::Class::DB'); |
430 | #$target->load_components('DB'); |
b7951443 |
431 | $target->connection(@info); |
432 | } |
433 | |
6b43ba5f |
434 | =head2 storage_type |
435 | |
436 | =over 4 |
437 | |
438 | =item Arguments: $storage_type |
439 | |
440 | =item Return Value: $storage_type |
441 | |
442 | =back |
443 | |
444 | Set the storage class that will be instantiated when L</connect> is called. |
445 | If the classname starts with C<::>, the prefix C<DBIx::Class::Storage> is |
446 | assumed by L</connect>. Defaults to C<::DBI>, |
447 | which is L<DBIx::Class::Storage::DBI>. |
448 | |
449 | You want to use this to hardcoded subclasses of L<DBIx::Class::Storage::DBI> |
450 | in cases where the appropriate subclass is not autodetected, such as when |
451 | dealing with MSSQL via L<DBD::Sybase>, in which case you'd set it to |
452 | C<::DBI::Sybase::MSSQL>. |
453 | |
87c4e602 |
454 | =head2 connection |
455 | |
27f01d1f |
456 | =over 4 |
457 | |
ebc77b53 |
458 | =item Arguments: @args |
66d9ef6b |
459 | |
d601dc88 |
460 | =item Return Value: $new_schema |
27f01d1f |
461 | |
462 | =back |
82b01c38 |
463 | |
464 | Instantiates a new Storage object of type |
465 | L<DBIx::Class::Schema/"storage_type"> and passes the arguments to |
466 | $storage->connect_info. Sets the connection in-place on the schema. See |
467 | L<DBIx::Class::Storage::DBI/"connect_info"> for more information. |
66d9ef6b |
468 | |
469 | =cut |
470 | |
471 | sub connection { |
472 | my ($self, @info) = @_; |
e59d3e5b |
473 | return $self if !@info && $self->storage; |
1e10a11d |
474 | my $storage_class = $self->storage_type; |
475 | $storage_class = 'DBIx::Class::Storage'.$storage_class |
476 | if $storage_class =~ m/^::/; |
8ef144ff |
477 | eval "require ${storage_class};"; |
bc0c9800 |
478 | $self->throw_exception( |
479 | "No arguments to load_classes and couldn't load ${storage_class} ($@)" |
480 | ) if $@; |
66d9ef6b |
481 | my $storage = $storage_class->new; |
482 | $storage->connect_info(\@info); |
483 | $self->storage($storage); |
484 | return $self; |
485 | } |
486 | |
87c4e602 |
487 | =head2 connect |
488 | |
27f01d1f |
489 | =over 4 |
490 | |
ebc77b53 |
491 | =item Arguments: @info |
66d9ef6b |
492 | |
d601dc88 |
493 | =item Return Value: $new_schema |
27f01d1f |
494 | |
495 | =back |
82b01c38 |
496 | |
497 | This is a convenience method. It is equivalent to calling |
498 | $schema->clone->connection(@info). See L</connection> and L</clone> for more |
499 | information. |
66d9ef6b |
500 | |
501 | =cut |
502 | |
08b515f1 |
503 | sub connect { shift->clone->connection(@_) } |
504 | |
505 | =head2 txn_begin |
506 | |
82b01c38 |
507 | Begins a transaction (does nothing if AutoCommit is off). Equivalent to |
508 | calling $schema->storage->txn_begin. See |
509 | L<DBIx::Class::Storage::DBI/"txn_begin"> for more information. |
08b515f1 |
510 | |
511 | =cut |
512 | |
513 | sub txn_begin { shift->storage->txn_begin } |
514 | |
515 | =head2 txn_commit |
516 | |
82b01c38 |
517 | Commits the current transaction. Equivalent to calling |
518 | $schema->storage->txn_commit. See L<DBIx::Class::Storage::DBI/"txn_commit"> |
519 | for more information. |
08b515f1 |
520 | |
521 | =cut |
522 | |
523 | sub txn_commit { shift->storage->txn_commit } |
524 | |
525 | =head2 txn_rollback |
526 | |
82b01c38 |
527 | Rolls back the current transaction. Equivalent to calling |
528 | $schema->storage->txn_rollback. See |
529 | L<DBIx::Class::Storage::DBI/"txn_rollback"> for more information. |
08b515f1 |
530 | |
531 | =cut |
532 | |
533 | sub txn_rollback { shift->storage->txn_rollback } |
66d9ef6b |
534 | |
a62cf8d4 |
535 | =head2 txn_do |
536 | |
27f01d1f |
537 | =over 4 |
538 | |
ebc77b53 |
539 | =item Arguments: C<$coderef>, @coderef_args? |
82b01c38 |
540 | |
d601dc88 |
541 | =item Return Value: The return value of $coderef |
27f01d1f |
542 | |
543 | =back |
a62cf8d4 |
544 | |
82b01c38 |
545 | Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically, |
546 | returning its result (if any). If an exception is caught, a rollback is issued |
547 | and the exception is rethrown. If the rollback fails, (i.e. throws an |
548 | exception) an exception is thrown that includes a "Rollback failed" message. |
a62cf8d4 |
549 | |
550 | For example, |
551 | |
24d67825 |
552 | my $author_rs = $schema->resultset('Author')->find(1); |
70634260 |
553 | my @titles = qw/Night Day It/; |
a62cf8d4 |
554 | |
555 | my $coderef = sub { |
a62cf8d4 |
556 | # If any one of these fails, the entire transaction fails |
70634260 |
557 | $author_rs->create_related('books', { |
24d67825 |
558 | title => $_ |
559 | }) foreach (@titles); |
a62cf8d4 |
560 | |
24d67825 |
561 | return $author->books; |
a62cf8d4 |
562 | }; |
563 | |
564 | my $rs; |
565 | eval { |
70634260 |
566 | $rs = $schema->txn_do($coderef); |
a62cf8d4 |
567 | }; |
568 | |
70634260 |
569 | if ($@) { # Transaction failed |
570 | die "something terrible has happened!" # |
571 | if ($@ =~ /Rollback failed/); # Rollback failed |
572 | |
573 | deal_with_failed_transaction(); |
a62cf8d4 |
574 | } |
575 | |
82b01c38 |
576 | In a nested transaction (calling txn_do() from within a txn_do() coderef) only |
577 | the outermost transaction will issue a L<DBIx::Class::Schema/"txn_commit"> on |
578 | the Schema's storage, and txn_do() can be called in void, scalar and list |
579 | context and it will behave as expected. |
a62cf8d4 |
580 | |
581 | =cut |
582 | |
583 | sub txn_do { |
584 | my ($self, $coderef, @args) = @_; |
585 | |
19630353 |
586 | $self->storage or $self->throw_exception |
587 | ('txn_do called on $schema without storage'); |
171dadd7 |
588 | ref $coderef eq 'CODE' or $self->throw_exception |
589 | ('$coderef must be a CODE reference'); |
a62cf8d4 |
590 | |
591 | my (@return_values, $return_value); |
592 | |
593 | $self->txn_begin; # If this throws an exception, no rollback is needed |
594 | |
e7f2b7d5 |
595 | my $wantarray = wantarray; # Need to save this since the context |
75d07914 |
596 | # inside the eval{} block is independent |
597 | # of the context that called txn_do() |
a62cf8d4 |
598 | eval { |
82b01c38 |
599 | |
24d67825 |
600 | # Need to differentiate between scalar/list context to allow for |
601 | # returning a list in scalar context to get the size of the list |
a62cf8d4 |
602 | if ($wantarray) { |
eeb34228 |
603 | # list context |
a62cf8d4 |
604 | @return_values = $coderef->(@args); |
eeb34228 |
605 | } elsif (defined $wantarray) { |
606 | # scalar context |
a62cf8d4 |
607 | $return_value = $coderef->(@args); |
eeb34228 |
608 | } else { |
609 | # void context |
610 | $coderef->(@args); |
a62cf8d4 |
611 | } |
612 | $self->txn_commit; |
613 | }; |
614 | |
615 | if ($@) { |
616 | my $error = $@; |
617 | |
618 | eval { |
619 | $self->txn_rollback; |
620 | }; |
621 | |
622 | if ($@) { |
623 | my $rollback_error = $@; |
624 | my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION"; |
625 | $self->throw_exception($error) # propagate nested rollback |
75d07914 |
626 | if $rollback_error =~ /$exception_class/; |
a62cf8d4 |
627 | |
bc0c9800 |
628 | $self->throw_exception( |
629 | "Transaction aborted: $error. Rollback failed: ${rollback_error}" |
630 | ); |
a62cf8d4 |
631 | } else { |
632 | $self->throw_exception($error); # txn failed but rollback succeeded |
633 | } |
634 | } |
635 | |
636 | return $wantarray ? @return_values : $return_value; |
637 | } |
638 | |
66d9ef6b |
639 | =head2 clone |
640 | |
27f01d1f |
641 | =over 4 |
642 | |
d601dc88 |
643 | =item Return Value: $new_schema |
27f01d1f |
644 | |
645 | =back |
82b01c38 |
646 | |
66d9ef6b |
647 | Clones the schema and its associated result_source objects and returns the |
648 | copy. |
649 | |
650 | =cut |
651 | |
652 | sub clone { |
653 | my ($self) = @_; |
04786a4c |
654 | my $clone = { (ref $self ? %$self : ()) }; |
655 | bless $clone, (ref $self || $self); |
656 | |
66d9ef6b |
657 | foreach my $moniker ($self->sources) { |
658 | my $source = $self->source($moniker); |
659 | my $new = $source->new($source); |
660 | $clone->register_source($moniker => $new); |
661 | } |
662 | return $clone; |
663 | } |
664 | |
87c4e602 |
665 | =head2 populate |
666 | |
27f01d1f |
667 | =over 4 |
668 | |
16c5f7d3 |
669 | =item Arguments: $source_name, \@data; |
27f01d1f |
670 | |
671 | =back |
a37a4697 |
672 | |
16c5f7d3 |
673 | Pass this method a resultsource name, and an arrayref of |
674 | arrayrefs. The arrayrefs should contain a list of column names, |
675 | followed by one or many sets of matching data for the given columns. |
676 | |
677 | Each set of data is inserted into the database using |
678 | L<DBIx::Class::ResultSet/create>, and a arrayref of the resulting row |
679 | objects is returned. |
82b01c38 |
680 | |
681 | i.e., |
a37a4697 |
682 | |
24d67825 |
683 | $schema->populate('Artist', [ |
684 | [ qw/artistid name/ ], |
685 | [ 1, 'Popular Band' ], |
686 | [ 2, 'Indie Band' ], |
a62cf8d4 |
687 | ... |
688 | ]); |
a37a4697 |
689 | |
690 | =cut |
691 | |
692 | sub populate { |
693 | my ($self, $name, $data) = @_; |
694 | my $rs = $self->resultset($name); |
695 | my @names = @{shift(@$data)}; |
84e3c114 |
696 | my @created; |
a37a4697 |
697 | foreach my $item (@$data) { |
698 | my %create; |
699 | @create{@names} = @$item; |
84e3c114 |
700 | push(@created, $rs->create(\%create)); |
a37a4697 |
701 | } |
84e3c114 |
702 | return @created; |
a37a4697 |
703 | } |
704 | |
5160b401 |
705 | =head2 throw_exception |
701da8c4 |
706 | |
75d07914 |
707 | =over 4 |
82b01c38 |
708 | |
ebc77b53 |
709 | =item Arguments: $message |
82b01c38 |
710 | |
711 | =back |
712 | |
713 | Throws an exception. Defaults to using L<Carp::Clan> to report errors from |
714 | user's perspective. |
701da8c4 |
715 | |
716 | =cut |
717 | |
718 | sub throw_exception { |
719 | my ($self) = shift; |
720 | croak @_; |
721 | } |
722 | |
ec6704d4 |
723 | =head2 deploy (EXPERIMENTAL) |
1c339d71 |
724 | |
82b01c38 |
725 | =over 4 |
726 | |
6e73ac25 |
727 | =item Arguments: $sqlt_args, $dir |
82b01c38 |
728 | |
729 | =back |
730 | |
731 | Attempts to deploy the schema to the current storage using L<SQL::Translator>. |
ec6704d4 |
732 | |
733 | Note that this feature is currently EXPERIMENTAL and may not work correctly |
734 | across all databases, or fully handle complex relationships. |
1c339d71 |
735 | |
51bace1c |
736 | See L<SQL::Translator/METHODS> for a list of values for C<$sqlt_args>. The most |
737 | common value for this would be C<< { add_drop_table => 1, } >> to have the SQL |
738 | produced include a DROP TABLE statement for each table created. |
739 | |
1c339d71 |
740 | =cut |
741 | |
742 | sub deploy { |
6e73ac25 |
743 | my ($self, $sqltargs, $dir) = @_; |
1c339d71 |
744 | $self->throw_exception("Can't deploy without storage") unless $self->storage; |
6e73ac25 |
745 | $self->storage->deploy($self, undef, $sqltargs, $dir); |
1c339d71 |
746 | } |
747 | |
c0f61310 |
748 | =head2 create_ddl_dir (EXPERIMENTAL) |
749 | |
750 | =over 4 |
751 | |
752 | =item Arguments: \@databases, $version, $directory, $sqlt_args |
753 | |
754 | =back |
755 | |
756 | Creates an SQL file based on the Schema, for each of the specified |
757 | database types, in the given directory. |
758 | |
759 | Note that this feature is currently EXPERIMENTAL and may not work correctly |
760 | across all databases, or fully handle complex relationships. |
761 | |
762 | =cut |
763 | |
6e73ac25 |
764 | sub create_ddl_dir { |
e673f011 |
765 | my $self = shift; |
766 | |
767 | $self->throw_exception("Can't create_ddl_dir without storage") unless $self->storage; |
768 | $self->storage->create_ddl_dir($self, @_); |
769 | } |
770 | |
9b83fccd |
771 | =head2 ddl_filename (EXPERIMENTAL) |
772 | |
773 | my $filename = $table->ddl_filename($type, $dir, $version) |
774 | |
775 | Creates a filename for a SQL file based on the table class name. Not |
776 | intended for direct end user use. |
777 | |
778 | =cut |
779 | |
6e73ac25 |
780 | sub ddl_filename { |
e673f011 |
781 | my ($self, $type, $dir, $version) = @_; |
782 | |
783 | my $filename = ref($self); |
9e7b9292 |
784 | $filename =~ s/::/-/; |
e673f011 |
785 | $filename = "$dir$filename-$version-$type.sql"; |
786 | |
787 | return $filename; |
788 | } |
789 | |
a02675cd |
790 | 1; |
c2da098a |
791 | |
c2da098a |
792 | =head1 AUTHORS |
793 | |
daec44b8 |
794 | Matt S. Trout <mst@shadowcatsystems.co.uk> |
c2da098a |
795 | |
796 | =head1 LICENSE |
797 | |
798 | You may distribute this code under the same terms as Perl itself. |
799 | |
800 | =cut |