Commit | Line | Data |
4012acd8 |
1 | package DBIx::Class::Storage; |
a62cf8d4 |
2 | |
3 | use strict; |
4 | use warnings; |
5 | |
046ad905 |
6 | use base qw/DBIx::Class/; |
2ad62d97 |
7 | use mro 'c3'; |
046ad905 |
8 | |
90d7422f |
9 | { |
10 | package # Hide from PAUSE |
11 | DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION; |
12 | use base 'DBIx::Class::Exception'; |
13 | } |
14 | |
15 | use DBIx::Class::Carp; |
9345b14c |
16 | use DBIx::Class::Storage::BlockRunner; |
90d7422f |
17 | use Scalar::Util qw/blessed weaken/; |
1bc193ac |
18 | use DBIx::Class::Storage::TxnScopeGuard; |
ddcc02d1 |
19 | use DBIx::Class::_Util 'dbic_internal_try'; |
f43ea814 |
20 | use Try::Tiny; |
fd323bf1 |
21 | use namespace::clean; |
046ad905 |
22 | |
90d7422f |
23 | __PACKAGE__->mk_group_accessors(simple => qw/debug schema transaction_depth auto_savepoint savepoints/); |
24 | __PACKAGE__->mk_group_accessors(component_class => 'cursor_class'); |
e4eb8ee1 |
25 | |
26 | __PACKAGE__->cursor_class('DBIx::Class::Cursor'); |
27 | |
28 | sub cursor { shift->cursor_class(@_); } |
046ad905 |
29 | |
046ad905 |
30 | =head1 NAME |
31 | |
32 | DBIx::Class::Storage - Generic Storage Handler |
33 | |
34 | =head1 DESCRIPTION |
35 | |
36 | A base implementation of common Storage methods. For specific |
37 | information about L<DBI>-based storage, see L<DBIx::Class::Storage::DBI>. |
38 | |
39 | =head1 METHODS |
40 | |
41 | =head2 new |
42 | |
43 | Arguments: $schema |
44 | |
45 | Instantiates the Storage object. |
46 | |
47 | =cut |
48 | |
49 | sub new { |
50 | my ($self, $schema) = @_; |
51 | |
52 | $self = ref $self if ref $self; |
53 | |
90d7422f |
54 | my $new = bless( { |
90d7422f |
55 | savepoints => [], |
56 | }, $self); |
046ad905 |
57 | |
58 | $new->set_schema($schema); |
4d753fb8 |
59 | $new->debug(1) |
60 | if $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} || $ENV{DBIC_TRACE}; |
046ad905 |
61 | |
62 | $new; |
63 | } |
64 | |
65 | =head2 set_schema |
66 | |
67 | Used to reset the schema class or object which owns this |
68 | storage object, such as during L<DBIx::Class::Schema/clone>. |
69 | |
70 | =cut |
71 | |
72 | sub set_schema { |
73 | my ($self, $schema) = @_; |
74 | $self->schema($schema); |
6298a324 |
75 | weaken $self->{schema} if ref $self->{schema}; |
046ad905 |
76 | } |
77 | |
78 | =head2 connected |
79 | |
80 | Returns true if we have an open storage connection, false |
81 | if it is not (yet) open. |
82 | |
83 | =cut |
84 | |
a62cf8d4 |
85 | sub connected { die "Virtual method!" } |
046ad905 |
86 | |
87 | =head2 disconnect |
88 | |
89 | Closes any open storage connection unconditionally. |
90 | |
91 | =cut |
92 | |
93 | sub disconnect { die "Virtual method!" } |
94 | |
95 | =head2 ensure_connected |
96 | |
97 | Initiate a connection to the storage if one isn't already open. |
98 | |
99 | =cut |
100 | |
a62cf8d4 |
101 | sub ensure_connected { die "Virtual method!" } |
046ad905 |
102 | |
103 | =head2 throw_exception |
104 | |
105 | Throws an exception - croaks. |
106 | |
107 | =cut |
108 | |
109 | sub throw_exception { |
110 | my $self = shift; |
111 | |
2a2a7b23 |
112 | if (ref $self and $self->schema) { |
1a58752c |
113 | $self->schema->throw_exception(@_); |
114 | } |
115 | else { |
116 | DBIx::Class::Exception->throw(@_); |
117 | } |
046ad905 |
118 | } |
a62cf8d4 |
119 | |
4012acd8 |
120 | =head2 txn_do |
a62cf8d4 |
121 | |
4012acd8 |
122 | =over 4 |
a62cf8d4 |
123 | |
4012acd8 |
124 | =item Arguments: C<$coderef>, @coderef_args? |
a62cf8d4 |
125 | |
4012acd8 |
126 | =item Return Value: The return value of $coderef |
127 | |
128 | =back |
129 | |
130 | Executes C<$coderef> with (optional) arguments C<@coderef_args> atomically, |
131 | returning its result (if any). If an exception is caught, a rollback is issued |
132 | and the exception is rethrown. If the rollback fails, (i.e. throws an |
133 | exception) an exception is thrown that includes a "Rollback failed" message. |
134 | |
135 | For example, |
136 | |
137 | my $author_rs = $schema->resultset('Author')->find(1); |
138 | my @titles = qw/Night Day It/; |
139 | |
140 | my $coderef = sub { |
141 | # If any one of these fails, the entire transaction fails |
142 | $author_rs->create_related('books', { |
143 | title => $_ |
144 | }) foreach (@titles); |
145 | |
146 | return $author->books; |
147 | }; |
148 | |
149 | my $rs; |
20674fcd |
150 | try { |
4012acd8 |
151 | $rs = $schema->txn_do($coderef); |
20674fcd |
152 | } catch { |
6b89ee0b |
153 | my $error = shift; |
20674fcd |
154 | # Transaction failed |
90d7422f |
155 | die "something terrible has happened!" |
6b89ee0b |
156 | if ($error =~ /Rollback failed/); # Rollback failed |
4012acd8 |
157 | |
158 | deal_with_failed_transaction(); |
20674fcd |
159 | }; |
4012acd8 |
160 | |
161 | In a nested transaction (calling txn_do() from within a txn_do() coderef) only |
162 | the outermost transaction will issue a L</txn_commit>, and txn_do() can be |
163 | called in void, scalar and list context and it will behave as expected. |
164 | |
05075aee |
165 | Please note that all of the code in your coderef, including non-DBIx::Class |
166 | code, is part of a transaction. This transaction may fail out halfway, or |
167 | it may get partially double-executed (in the case that our DB connection |
168 | failed halfway through the transaction, in which case we reconnect and |
169 | restart the txn). Therefore it is best that any side-effects in your coderef |
170 | are idempotent (that is, can be re-executed multiple times and get the |
171 | same result), and that you check up on your side-effects in the case of |
172 | transaction failure. |
6500d50f |
173 | |
4012acd8 |
174 | =cut |
175 | |
176 | sub txn_do { |
38ed54cd |
177 | my $self = shift; |
4012acd8 |
178 | |
9345b14c |
179 | DBIx::Class::Storage::BlockRunner->new( |
180 | storage => $self, |
9345b14c |
181 | wrap_txn => 1, |
7d534e68 |
182 | retry_handler => sub { |
183 | $_[0]->failed_attempt_count == 1 |
184 | and |
185 | ! $_[0]->storage->connected |
186 | }, |
187 | )->run(@_); |
a62cf8d4 |
188 | } |
189 | |
046ad905 |
190 | =head2 txn_begin |
191 | |
192 | Starts a transaction. |
193 | |
194 | See the preferred L</txn_do> method, which allows for |
195 | an entire code block to be executed transactionally. |
196 | |
197 | =cut |
198 | |
90d7422f |
199 | sub txn_begin { |
200 | my $self = shift; |
201 | |
202 | if($self->transaction_depth == 0) { |
203 | $self->debugobj->txn_begin() |
204 | if $self->debug; |
205 | $self->_exec_txn_begin; |
206 | } |
207 | elsif ($self->auto_savepoint) { |
208 | $self->svp_begin; |
209 | } |
210 | $self->{transaction_depth}++; |
211 | |
212 | } |
046ad905 |
213 | |
214 | =head2 txn_commit |
215 | |
216 | Issues a commit of the current transaction. |
217 | |
be01f1be |
218 | It does I<not> perform an actual storage commit unless there's a DBIx::Class |
219 | transaction currently in effect (i.e. you called L</txn_begin>). |
220 | |
046ad905 |
221 | =cut |
222 | |
90d7422f |
223 | sub txn_commit { |
224 | my $self = shift; |
225 | |
226 | if ($self->transaction_depth == 1) { |
227 | $self->debugobj->txn_commit() if $self->debug; |
228 | $self->_exec_txn_commit; |
229 | $self->{transaction_depth}--; |
398215b1 |
230 | $self->savepoints([]); |
90d7422f |
231 | } |
232 | elsif($self->transaction_depth > 1) { |
233 | $self->{transaction_depth}--; |
234 | $self->svp_release if $self->auto_savepoint; |
235 | } |
236 | else { |
237 | $self->throw_exception( 'Refusing to commit without a started transaction' ); |
238 | } |
239 | } |
046ad905 |
240 | |
241 | =head2 txn_rollback |
242 | |
243 | Issues a rollback of the current transaction. A nested rollback will |
244 | throw a L<DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION> exception, |
245 | which allows the rollback to propagate to the outermost transaction. |
246 | |
247 | =cut |
248 | |
90d7422f |
249 | sub txn_rollback { |
250 | my $self = shift; |
251 | |
252 | if ($self->transaction_depth == 1) { |
253 | $self->debugobj->txn_rollback() if $self->debug; |
90d7422f |
254 | $self->{transaction_depth}--; |
729656c5 |
255 | |
256 | # in case things get really hairy - just disconnect |
ddcc02d1 |
257 | dbic_internal_try { $self->_exec_txn_rollback; 1 } or do { |
729656c5 |
258 | my $rollback_error = $@; |
259 | |
260 | # whatever happens, too low down the stack to care |
261 | # FIXME - revisit if stackable exceptions become a thing |
ddcc02d1 |
262 | dbic_internal_try { $self->disconnect }; |
729656c5 |
263 | |
264 | die $rollback_error; |
265 | }; |
266 | |
398215b1 |
267 | $self->savepoints([]); |
90d7422f |
268 | } |
269 | elsif ($self->transaction_depth > 1) { |
270 | $self->{transaction_depth}--; |
271 | |
272 | if ($self->auto_savepoint) { |
273 | $self->svp_rollback; |
274 | $self->svp_release; |
275 | } |
276 | else { |
277 | DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION->throw( |
278 | "A txn_rollback in nested transaction is ineffective! (depth $self->{transaction_depth})" |
279 | ); |
280 | } |
281 | } |
282 | else { |
283 | $self->throw_exception( 'Refusing to roll back without a started transaction' ); |
284 | } |
285 | } |
046ad905 |
286 | |
84efb6d7 |
287 | # to be called by several internal stacked transaction handler codepaths |
288 | # not for external consumption |
289 | # *DOES NOT* throw exceptions, instead: |
290 | # - returns false on success |
291 | # - returns the exception on failed rollback |
292 | sub __delicate_rollback { |
293 | my $self = shift; |
294 | |
295 | if ( |
729656c5 |
296 | ( $self->transaction_depth || 0 ) > 1 |
84efb6d7 |
297 | and |
298 | # FIXME - the autosvp check here shouldn't be happening, it should be a role-ish thing |
299 | # The entire concept needs to be rethought with the storage layer... or something |
300 | ! $self->auto_savepoint |
301 | and |
302 | # the handle seems healthy, and there is nothing for us to do with it |
303 | # just go ahead and bow out, without triggering the txn_rollback() "nested exception" |
304 | # the unwind will eventually fail somewhere higher up if at all |
305 | # FIXME: a ::Storage::DBI-specific method, not a generic ::Storage one |
306 | $self->_seems_connected |
307 | ) { |
308 | # all above checks out - there is nothing to do on the $dbh itself |
309 | # just a plain soft-decrease of depth |
310 | $self->{transaction_depth}--; |
311 | return; |
312 | } |
313 | |
ddcc02d1 |
314 | my @args = @_; |
84efb6d7 |
315 | my $rbe; |
316 | |
ddcc02d1 |
317 | dbic_internal_try { |
318 | $self->txn_rollback; 1 |
319 | } |
320 | catch { |
84efb6d7 |
321 | |
ddcc02d1 |
322 | $rbe = $_; |
84efb6d7 |
323 | |
324 | # we were passed an existing exception to augment (think DESTROY stacks etc) |
ddcc02d1 |
325 | if (@args) { |
326 | my ($exception) = @args; |
84efb6d7 |
327 | |
328 | # append our text - THIS IS A TEMPORARY FIXUP! |
329 | # |
330 | # If the passed in exception is a reference, or an object we don't know |
331 | # how to augment - flattening it is just damn rude |
332 | if ( |
333 | # FIXME - a better way, not liable to destroy an existing exception needs |
334 | # to be created. For the time being perpetuating the sin below in order |
335 | # to break the deadlock of which yak is being shaved first |
336 | 0 |
337 | and |
338 | length ref $$exception |
339 | and |
340 | ( |
341 | ! defined blessed $$exception |
342 | or |
343 | ! $$exception->isa( 'DBIx::Class::Exception' ) |
344 | ) |
345 | ) { |
346 | |
347 | ################## |
348 | ### FIXME - TODO |
349 | ################## |
350 | |
351 | } |
352 | else { |
353 | |
354 | # SUCH HIDEOUS, MUCH AUGH! (and double WOW on the s/// at the end below) |
355 | $rbe =~ s/ at .+? line \d+$//; |
356 | |
357 | ( |
358 | ( |
359 | defined blessed $$exception |
360 | and |
361 | $$exception->isa( 'DBIx::Class::Exception' ) |
362 | ) |
363 | ? ( |
364 | $$exception->{msg} = |
365 | "Transaction aborted: $$exception->{msg}. Rollback failed: $rbe" |
366 | ) |
367 | : ( |
368 | $$exception = |
369 | "Transaction aborted: $$exception. Rollback failed: $rbe" |
370 | ) |
371 | ) =~ s/Transaction aborted: (?=Transaction aborted:)//; |
372 | } |
373 | } |
ddcc02d1 |
374 | }; |
84efb6d7 |
375 | |
376 | return $rbe; |
377 | } |
378 | |
adb3554a |
379 | =head2 svp_begin |
380 | |
360dc8a5 |
381 | Arguments: $savepoint_name? |
adb3554a |
382 | |
360dc8a5 |
383 | Created a new savepoint using the name provided as argument. If no name |
384 | is provided, a random name will be used. |
adb3554a |
385 | |
386 | =cut |
387 | |
90d7422f |
388 | sub svp_begin { |
389 | my ($self, $name) = @_; |
390 | |
391 | $self->throw_exception ("You can't use savepoints outside a transaction") |
392 | unless $self->transaction_depth; |
393 | |
394 | my $exec = $self->can('_exec_svp_begin') |
395 | or $self->throw_exception ("Your Storage implementation doesn't support savepoints"); |
396 | |
397 | $name = $self->_svp_generate_name |
398 | unless defined $name; |
399 | |
400 | push @{ $self->{savepoints} }, $name; |
401 | |
402 | $self->debugobj->svp_begin($name) if $self->debug; |
403 | |
404 | $exec->($self, $name); |
405 | } |
406 | |
407 | sub _svp_generate_name { |
408 | my ($self) = @_; |
409 | return 'savepoint_'.scalar(@{ $self->{'savepoints'} }); |
410 | } |
411 | |
adb3554a |
412 | |
413 | =head2 svp_release |
414 | |
360dc8a5 |
415 | Arguments: $savepoint_name? |
adb3554a |
416 | |
360dc8a5 |
417 | Release the savepoint provided as argument. If none is provided, |
418 | release the savepoint created most recently. This will implicitly |
419 | release all savepoints created after the one explicitly released as well. |
adb3554a |
420 | |
421 | =cut |
422 | |
90d7422f |
423 | sub svp_release { |
424 | my ($self, $name) = @_; |
425 | |
426 | $self->throw_exception ("You can't use savepoints outside a transaction") |
427 | unless $self->transaction_depth; |
428 | |
429 | my $exec = $self->can('_exec_svp_release') |
430 | or $self->throw_exception ("Your Storage implementation doesn't support savepoints"); |
431 | |
432 | if (defined $name) { |
433 | my @stack = @{ $self->savepoints }; |
434 | my $svp; |
435 | |
436 | do { $svp = pop @stack } until $svp eq $name; |
437 | |
438 | $self->throw_exception ("Savepoint '$name' does not exist") |
439 | unless $svp; |
440 | |
441 | $self->savepoints(\@stack); # put back what's left |
442 | } |
443 | else { |
444 | $name = pop @{ $self->savepoints } |
445 | or $self->throw_exception('No savepoints to release');; |
446 | } |
447 | |
448 | $self->debugobj->svp_release($name) if $self->debug; |
449 | |
450 | $exec->($self, $name); |
451 | } |
adb3554a |
452 | |
453 | =head2 svp_rollback |
454 | |
360dc8a5 |
455 | Arguments: $savepoint_name? |
adb3554a |
456 | |
360dc8a5 |
457 | Rollback to the savepoint provided as argument. If none is provided, |
458 | rollback to the savepoint created most recently. This will implicitly |
459 | release all savepoints created after the savepoint we rollback to. |
adb3554a |
460 | |
461 | =cut |
462 | |
90d7422f |
463 | sub svp_rollback { |
464 | my ($self, $name) = @_; |
465 | |
466 | $self->throw_exception ("You can't use savepoints outside a transaction") |
467 | unless $self->transaction_depth; |
468 | |
469 | my $exec = $self->can('_exec_svp_rollback') |
470 | or $self->throw_exception ("Your Storage implementation doesn't support savepoints"); |
471 | |
472 | if (defined $name) { |
473 | my @stack = @{ $self->savepoints }; |
474 | my $svp; |
475 | |
476 | # a rollback doesn't remove the named savepoint, |
477 | # only everything after it |
478 | while (@stack and $stack[-1] ne $name) { |
479 | pop @stack |
480 | }; |
481 | |
482 | $self->throw_exception ("Savepoint '$name' does not exist") |
483 | unless @stack; |
484 | |
485 | $self->savepoints(\@stack); # put back what's left |
486 | } |
487 | else { |
488 | $name = $self->savepoints->[-1] |
489 | or $self->throw_exception('No savepoints to rollback');; |
490 | } |
491 | |
492 | $self->debugobj->svp_rollback($name) if $self->debug; |
493 | |
494 | $exec->($self, $name); |
495 | } |
adb3554a |
496 | |
11544e1d |
497 | =head2 txn_scope_guard |
3b7f3eac |
498 | |
11544e1d |
499 | An alternative way of transaction handling based on |
500 | L<DBIx::Class::Storage::TxnScopeGuard>: |
1bc193ac |
501 | |
11544e1d |
502 | my $txn_guard = $storage->txn_scope_guard; |
89028f42 |
503 | |
47d7b769 |
504 | $result->col1("val1"); |
505 | $result->update; |
89028f42 |
506 | |
11544e1d |
507 | $txn_guard->commit; |
89028f42 |
508 | |
11544e1d |
509 | If an exception occurs, or the guard object otherwise leaves the scope |
510 | before C<< $txn_guard->commit >> is called, the transaction will be rolled |
511 | back by an explicit L</txn_rollback> call. In essence this is akin to |
512 | using a L</txn_begin>/L</txn_commit> pair, without having to worry |
513 | about calling L</txn_rollback> at the right places. Note that since there |
514 | is no defined code closure, there will be no retries and other magic upon |
515 | database disconnection. If you need such functionality see L</txn_do>. |
1bc193ac |
516 | |
517 | =cut |
518 | |
519 | sub txn_scope_guard { |
520 | return DBIx::Class::Storage::TxnScopeGuard->new($_[0]); |
521 | } |
522 | |
046ad905 |
523 | =head2 sql_maker |
524 | |
525 | Returns a C<sql_maker> object - normally an object of class |
d5dedbd6 |
526 | C<DBIx::Class::SQLMaker>. |
046ad905 |
527 | |
528 | =cut |
529 | |
530 | sub sql_maker { die "Virtual method!" } |
531 | |
532 | =head2 debug |
533 | |
f92a9d79 |
534 | Causes trace information to be emitted on the L</debugobj> object. |
535 | (or C<STDERR> if L</debugobj> has not specifically been set). |
046ad905 |
536 | |
537 | This is the equivalent to setting L</DBIC_TRACE> in your |
538 | shell environment. |
539 | |
540 | =head2 debugfh |
541 | |
4d93345c |
542 | An opportunistic proxy to L<< ->debugobj->debugfh(@_) |
543 | |DBIx::Class::Storage::Statistics/debugfh >> |
544 | If the currently set L</debugobj> does not have a L</debugfh> method, caling |
545 | this is a no-op. |
046ad905 |
546 | |
547 | =cut |
548 | |
549 | sub debugfh { |
550 | my $self = shift; |
551 | |
552 | if ($self->debugobj->can('debugfh')) { |
553 | return $self->debugobj->debugfh(@_); |
554 | } |
555 | } |
556 | |
557 | =head2 debugobj |
558 | |
559 | Sets or retrieves the object used for metric collection. Defaults to an instance |
560 | of L<DBIx::Class::Storage::Statistics> that is compatible with the original |
561 | method of using a coderef as a callback. See the aforementioned Statistics |
562 | class for more information. |
563 | |
4d753fb8 |
564 | =cut |
565 | |
566 | sub debugobj { |
567 | my $self = shift; |
568 | |
569 | if (@_) { |
570 | return $self->{debugobj} = $_[0]; |
571 | } |
572 | |
573 | $self->{debugobj} ||= do { |
574 | if (my $profile = $ENV{DBIC_TRACE_PROFILE}) { |
575 | require DBIx::Class::Storage::Debug::PrettyPrint; |
6e102c8f |
576 | my @pp_args; |
577 | |
4d753fb8 |
578 | if ($profile =~ /^\.?\//) { |
0dd1b736 |
579 | |
18a2903b |
580 | require DBIx::Class::Optional::Dependencies; |
0dd1b736 |
581 | if ( my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('config_file_reader') ) { |
582 | $self->throw_exception("Unable to parse TRACE_PROFILE config file '$profile' without $missing"); |
583 | } |
4d753fb8 |
584 | |
ddcc02d1 |
585 | my $cfg = dbic_internal_try { |
4d753fb8 |
586 | Config::Any->load_files({ files => [$profile], use_ext => 1 }); |
587 | } catch { |
588 | # sanitize the error message a bit |
589 | $_ =~ s/at \s+ .+ Storage\.pm \s line \s \d+ $//x; |
590 | $self->throw_exception("Failure processing \$ENV{DBIC_TRACE_PROFILE}: $_"); |
591 | }; |
592 | |
6e102c8f |
593 | @pp_args = values %{$cfg->[0]}; |
4d753fb8 |
594 | } |
595 | else { |
6e102c8f |
596 | @pp_args = { profile => $profile }; |
597 | } |
598 | |
599 | # FIXME - FRAGILE |
600 | # Hash::Merge is a sorry piece of shit and tramples all over $@ |
601 | # *without* throwing an exception |
602 | # This is a rather serious problem in the debug codepath |
603 | # Insulate the condition here with a try{} until a review of |
604 | # DBIx::Class::Storage::Debug::PrettyPrint takes place |
605 | # we do rethrow the error unconditionally, the only reason |
606 | # to try{} is to preserve the precise state of $@ (down |
607 | # to the scalar (if there is one) address level) |
608 | # |
609 | # Yes I am aware this is fragile and TxnScopeGuard needs |
610 | # a better fix. This is another yak to shave... :( |
ddcc02d1 |
611 | dbic_internal_try { |
6e102c8f |
612 | DBIx::Class::Storage::Debug::PrettyPrint->new(@pp_args); |
613 | } catch { |
614 | $self->throw_exception($_); |
4d753fb8 |
615 | } |
616 | } |
617 | else { |
618 | require DBIx::Class::Storage::Statistics; |
619 | DBIx::Class::Storage::Statistics->new |
620 | } |
621 | }; |
622 | } |
623 | |
046ad905 |
624 | =head2 debugcb |
625 | |
626 | Sets a callback to be executed each time a statement is run; takes a sub |
627 | reference. Callback is executed as $sub->($op, $info) where $op is |
628 | SELECT/INSERT/UPDATE/DELETE and $info is what would normally be printed. |
629 | |
f92a9d79 |
630 | See L</debugobj> for a better way. |
046ad905 |
631 | |
632 | =cut |
633 | |
634 | sub debugcb { |
635 | my $self = shift; |
636 | |
637 | if ($self->debugobj->can('callback')) { |
638 | return $self->debugobj->callback(@_); |
639 | } |
640 | } |
641 | |
e4eb8ee1 |
642 | =head2 cursor_class |
046ad905 |
643 | |
644 | The cursor class for this Storage object. |
645 | |
646 | =cut |
647 | |
046ad905 |
648 | =head2 deploy |
649 | |
650 | Deploy the tables to storage (CREATE TABLE and friends in a SQL-based |
651 | Storage class). This would normally be called through |
652 | L<DBIx::Class::Schema/deploy>. |
653 | |
654 | =cut |
655 | |
656 | sub deploy { die "Virtual method!" } |
657 | |
a3eaff0e |
658 | =head2 connect_info |
659 | |
660 | The arguments of C<connect_info> are always a single array reference, |
661 | and are Storage-handler specific. |
662 | |
663 | This is normally accessed via L<DBIx::Class::Schema/connection>, which |
664 | encapsulates its argument list in an arrayref before calling |
665 | C<connect_info> here. |
666 | |
667 | =cut |
668 | |
046ad905 |
669 | sub connect_info { die "Virtual method!" } |
a3eaff0e |
670 | |
671 | =head2 select |
672 | |
673 | Handle a select statement. |
674 | |
675 | =cut |
676 | |
677 | sub select { die "Virtual method!" } |
678 | |
679 | =head2 insert |
680 | |
681 | Handle an insert statement. |
682 | |
683 | =cut |
684 | |
046ad905 |
685 | sub insert { die "Virtual method!" } |
a3eaff0e |
686 | |
687 | =head2 update |
688 | |
689 | Handle an update statement. |
690 | |
691 | =cut |
692 | |
046ad905 |
693 | sub update { die "Virtual method!" } |
a3eaff0e |
694 | |
695 | =head2 delete |
696 | |
697 | Handle a delete statement. |
698 | |
699 | =cut |
700 | |
046ad905 |
701 | sub delete { die "Virtual method!" } |
a3eaff0e |
702 | |
703 | =head2 select_single |
704 | |
705 | Performs a select, fetch and return of data - handles a single row |
706 | only. |
707 | |
708 | =cut |
709 | |
046ad905 |
710 | sub select_single { die "Virtual method!" } |
a3eaff0e |
711 | |
712 | =head2 columns_info_for |
713 | |
c22c7625 |
714 | Returns metadata for the given source's columns. This |
715 | is *deprecated*, and will be removed before 1.0. You should |
716 | be specifying the metadata yourself if you need it. |
a3eaff0e |
717 | |
718 | =cut |
719 | |
046ad905 |
720 | sub columns_info_for { die "Virtual method!" } |
721 | |
722 | =head1 ENVIRONMENT VARIABLES |
723 | |
724 | =head2 DBIC_TRACE |
725 | |
726 | If C<DBIC_TRACE> is set then trace information |
f92a9d79 |
727 | is produced (as when the L</debug> method is set). |
046ad905 |
728 | |
729 | If the value is of the form C<1=/path/name> then the trace output is |
730 | written to the file C</path/name>. |
731 | |
732 | This environment variable is checked when the storage object is first |
fd323bf1 |
733 | created (when you call connect on your schema). So, run-time changes |
734 | to this environment variable will not take effect unless you also |
046ad905 |
735 | re-connect on your schema. |
736 | |
b6cd6478 |
737 | =head2 DBIC_TRACE_PROFILE |
738 | |
2514a73f |
739 | If C<DBIC_TRACE_PROFILE> is set, L<DBIx::Class::Storage::Debug::PrettyPrint> |
b6cd6478 |
740 | will be used to format the output from C<DBIC_TRACE>. The value it |
741 | is set to is the C<profile> that it will be used. If the value is a |
742 | filename the file is read with L<Config::Any> and the results are |
743 | used as the configuration for tracing. See L<SQL::Abstract::Tree/new> |
744 | for what that structure should look like. |
745 | |
046ad905 |
746 | =head2 DBIX_CLASS_STORAGE_DBI_DEBUG |
747 | |
748 | Old name for DBIC_TRACE |
749 | |
ace385bd |
750 | =head1 SEE ALSO |
751 | |
2f0790c4 |
752 | L<DBIx::Class::Storage::DBI> - reference storage implementation using |
753 | SQL::Abstract and DBI. |
ace385bd |
754 | |
a2bd3796 |
755 | =head1 FURTHER QUESTIONS? |
046ad905 |
756 | |
a2bd3796 |
757 | Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>. |
046ad905 |
758 | |
a2bd3796 |
759 | =head1 COPYRIGHT AND LICENSE |
046ad905 |
760 | |
a2bd3796 |
761 | This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE> |
762 | by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can |
763 | redistribute it and/or modify it under the same terms as the |
764 | L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>. |
046ad905 |
765 | |
766 | =cut |
767 | |
a62cf8d4 |
768 | 1; |