← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-03-08 00:37:41 UTC
  • mfrom: (1594.2.4 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060308003741-08afccbf89005e87
Merge in :
 * Knit repositories use knits
 * Nested progress bar support.
 * Ghost aware graph api.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
19
19
 
20
20
Transactions provide hooks to allow data objects (i.e. inventory weaves or
21
21
the revision-history file) to be placed in a registry and retrieved later
22
 
during the same transaction.  This allows for repeated read isolation. At
23
 
the end of a transaction, a callback is issued to each registered changed
24
 
item informing it whether it should commit or not. We provide a two layer
25
 
facility - domain objects are notified first, then data objects.
 
22
during the same transaction. Transactions in bzr are not atomic - they
 
23
depend on data ordering of writes, so we do not have commit or rollback
 
24
facilities at the transaction level.
26
25
 
27
26
Read only transactions raise an assert when objects are listed as dirty
28
 
against them - preventing unintended writes. Once all the data storage is
29
 
hooked into this facility, it might be nice to have a readonly transaction
30
 
that just excepts on commit, for testing or simulating of things.
 
27
against them - preventing unintended writes.
31
28
 
32
 
Write transactions queue all changes in the transaction (which may in the 
33
 
future involve writing them to uncommitted atomic files in preparation 
34
 
for commit - i.e. on network connections where latency matters) and then
35
 
notify each object of commit or rollback.
 
29
Write transactions preserve dirty objects in the cache, though due to the
 
30
write ordering approach we use for consistency 'dirty' is a misleading term.
 
31
A dirty object is one we have modified.
36
32
 
37
33
Both read and write transactions *may* flush unchanged objects out of 
38
 
memory, unless they are marked as 'preserve' which indicates that 
39
 
repeated reads cannot be obtained if the object is ejected.
 
34
memory, unless they are marked as 'precious' which indicates that 
 
35
repeated reads cannot be obtained if the object is ejected, or that
 
36
the object is an expensive one for obtaining.
40
37
"""
41
38
 
42
39
import sys
49
46
class ReadOnlyTransaction(object):
50
47
    """A read only unit of work for data objects."""
51
48
 
52
 
    def commit(self):
53
 
        """ReadOnlyTransactions cannot commit."""
54
 
        raise errors.CommitNotPossible()
55
 
 
56
49
    def finish(self):
57
 
        """Clean up this transaction
58
 
 
59
 
        This will rollback on transactions that can if they have nto been
60
 
        committed.
61
 
        """
 
50
        """Clean up this transaction."""
62
51
 
63
52
    def __init__(self):
64
53
        super(ReadOnlyTransaction, self).__init__()
68
57
        self._limit = -1
69
58
        self._precious_objects = set()
70
59
 
 
60
    def is_clean(self, an_object):
 
61
        """Return True if an_object is clean."""
 
62
        return an_object in self._clean_objects
 
63
 
71
64
    def register_clean(self, an_object, precious=False):
72
65
        """Register an_object as being clean.
73
66
        
84
77
        """Register an_object as being dirty."""
85
78
        raise errors.ReadOnlyObjectDirtiedError(an_object)
86
79
 
87
 
    def rollback(self):
88
 
        """Let people call this even though nothing has to happen."""
89
 
 
90
80
    def set_cache_size(self, size):
91
81
        """Set a new cache size."""
92
82
        assert -1 <= size
120
110
                offset += 1
121
111
 
122
112
 
 
113
class WriteTransaction(ReadOnlyTransaction):
 
114
    """A write transaction
 
115
 
 
116
    - caches domain objects
 
117
    - clean objects can be removed from the cache
 
118
    - dirty objects are retained.
 
119
    """
 
120
 
 
121
    def __init__(self):
 
122
        super(WriteTransaction, self).__init__()
 
123
        self._dirty_objects = set()
 
124
 
 
125
    def is_dirty(self, an_object):
 
126
        """Return True if an_object is dirty."""
 
127
        return an_object in self._dirty_objects
 
128
 
 
129
    def register_dirty(self, an_object):
 
130
        """Register an_object as being dirty.
 
131
        
 
132
        Dirty objects are not ejected from the identity map
 
133
        until the transaction finishes.
 
134
        """
 
135
        self._dirty_objects.add(an_object)
 
136
        if self.is_clean(an_object):
 
137
            self._clean_objects.remove(an_object)
 
138
            del self._clean_queue[self._clean_queue.index(an_object)]
 
139
        self._trim()
 
140
 
123
141
        
124
142
class PassThroughTransaction(object):
125
143
    """A pass through transaction
126
144
    
127
 
    - all actions are committed immediately.
128
 
    - rollback is not supported.
129
 
    - commit() is a no-op.
 
145
    - nothing is cached.
 
146
    - nothing ever gets into the identity map.
130
147
    """
131
148
 
132
 
    def commit(self):
133
 
        """PassThroughTransactions have nothing to do."""
134
 
 
135
149
    def finish(self):
136
 
        """Clean up this transaction
137
 
 
138
 
        This will rollback on transactions that can if they have nto been
139
 
        committed.
140
 
        """
 
150
        """Clean up this transaction."""
141
151
 
142
152
    def __init__(self):
143
153
        super(PassThroughTransaction, self).__init__()
153
163
    def register_dirty(self, an_object):
154
164
        """Register an_object as being dirty."""
155
165
 
156
 
    def rollback(self):
157
 
        """Cannot rollback a pass through transaction."""
158
 
        raise errors.AlreadyCommitted
159
 
 
160
166
    def set_cache_size(self, ignored):
161
167
        """Do nothing, we are passing through."""