* Removed dead code (sub _RowNumberOver).
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Storage / TxnScopeGuard.pm
CommitLineData
dd018f09 1package # Hide from pause for now - till we get it working
2 DBIx::Class::Storage::TxnScopeGuard;
1bc193ac 3
4use strict;
5use warnings;
6
7sub new {
8 my ($class, $storage) = @_;
9
10 $storage->txn_begin;
11 bless [ 0, $storage ], ref $class || $class;
12}
13
14sub commit {
15 my $self = shift;
16
17 $self->[1]->txn_commit;
18 $self->[0] = 1;
19}
20
21sub DESTROY {
22 my ($dismiss, $storage) = @{$_[0]};
23
3b7f3eac 24 return if $dismiss;
25
26 my $exception = $@;
a211cb63 27 Carp::cluck("A DBIx::Class::Storage::TxnScopeGuard went out of scope without explicit commit or an error - bad")
a778f387 28 unless $exception;
29 {
30 local $@;
31 eval { $storage->txn_rollback };
32 my $rollback_exception = $@;
33 if($rollback_exception) {
34 my $exception_class = "DBIx::Class::Storage::NESTED_ROLLBACK_EXCEPTION";
35
36 $storage->throw_exception(
37 "Transaction aborted: ${exception}. "
38 . "Rollback failed: ${rollback_exception}"
39 ) unless $rollback_exception =~ /$exception_class/;
40 }
3b7f3eac 41 }
1bc193ac 42}
43
441;
45
46__END__
47
48=head1 NAME
49
a211cb63 50DBIx::Class::Storage::TxnScopeGuard - Experimental
1bc193ac 51
52=head1 SYNOPSIS
53
54 sub foo {
55 my ($self, $schema) = @_;
56
57 my $guard = $schema->txn_scope_guard;
58
59 # Multiple database operations here
60
61 $guard->commit;
62 }
63
64=head1 DESCRIPTION
65
66An object that behaves much like L<Scope::Guard>, but hardcoded to do the
67right thing with transactions in DBIx::Class.
68
69=head1 METHODS
70
71=head2 new
72
73Creating an instance of this class will start a new transaction. Expects a
74L<DBIx::Class::Storage> object as its only argument.
75
76=head2 commit
77
78Commit the transaction, and stop guarding the scope. If this method is not
79called (i.e. an exception is thrown) and this object goes out of scope then
80the transaction is rolled back.
81
82=cut
83
84=head1 SEE ALSO
85
86L<DBIx::Class::Schema/txn_scope_guard>.
87
88=head1 AUTHOR
89
90Ash Berlin, 2008.
91
92Insipred by L<Scope::Guard> by chocolateboy.
93
94This module is free software. It may be used, redistributed and/or modified
95under the same terms as Perl itself.
96
97=cut