← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transactions.py

Update news and readme

- better explanation of dependencies

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/transactions.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005 by Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#
4
4
# This program is free software; you can redistribute it and/or modify
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. 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.
 
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.
25
26
 
26
27
Read only transactions raise an assert when objects are listed as dirty
27
 
against them - preventing unintended writes.
 
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.
28
31
 
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.
 
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.
32
36
 
33
37
Both read and write transactions *may* flush unchanged objects out of 
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.
 
38
memory, unless they are marked as 'preserve' which indicates that 
 
39
repeated reads cannot be obtained if the object is ejected.
37
40
"""
38
41
 
39
42
import sys
46
49
class ReadOnlyTransaction(object):
47
50
    """A read only unit of work for data objects."""
48
51
 
 
52
    def commit(self):
 
53
        """ReadOnlyTransactions cannot commit."""
 
54
        raise errors.CommitNotPossible('In a read only transaction')
 
55
 
49
56
    def finish(self):
50
 
        """Clean up this transaction."""
 
57
        """Clean up this transaction
 
58
 
 
59
        This will rollback on transactions that can if they have nto been
 
60
        committed.
 
61
        """
51
62
 
52
63
    def __init__(self):
53
64
        super(ReadOnlyTransaction, self).__init__()
57
68
        self._limit = -1
58
69
        self._precious_objects = set()
59
70
 
60
 
    def is_clean(self, an_object):
61
 
        """Return True if an_object is clean."""
62
 
        return (an_object in self._clean_objects)
63
 
 
64
71
    def register_clean(self, an_object, precious=False):
65
72
        """Register an_object as being clean.
66
73
        
75
82
 
76
83
    def register_dirty(self, an_object):
77
84
        """Register an_object as being dirty."""
78
 
        raise errors.ReadOnlyObjectDirtiedError(an_object)
 
85
        raise errors.ReadOnlyError(
 
86
            "Cannot dirty objects in a read only transaction")
 
87
 
 
88
    def rollback(self):
 
89
        """Let people call this even though nothing has to happen."""
79
90
 
80
91
    def set_cache_size(self, size):
81
92
        """Set a new cache size."""
109
120
            else:
110
121
                offset += 1
111
122
 
112
 
    def writeable(self):
113
 
        """Read only transactions do not allow writes."""
114
 
 
115
 
 
116
 
class WriteTransaction(ReadOnlyTransaction):
117
 
    """A write transaction
118
 
 
119
 
    - caches domain objects
120
 
    - clean objects can be removed from the cache
121
 
    - dirty objects are retained.
122
 
    """
123
 
 
124
 
    def finish(self):
125
 
        """Clean up this transaction."""
126
 
        for thing in self._dirty_objects:
127
 
            callback = getattr(thing, 'transaction_finished', None)
128
 
            if callback is not None:
129
 
                callback()
130
 
 
131
 
    def __init__(self):
132
 
        super(WriteTransaction, self).__init__()
133
 
        self._dirty_objects = set()
134
 
 
135
 
    def is_dirty(self, an_object):
136
 
        """Return True if an_object is dirty."""
137
 
        return (an_object in self._dirty_objects)
138
 
 
139
 
    def register_dirty(self, an_object):
140
 
        """Register an_object as being dirty.
141
 
        
142
 
        Dirty objects are not ejected from the identity map
143
 
        until the transaction finishes and get informed
144
 
        when the transaction finishes.
145
 
        """
146
 
        self._dirty_objects.add(an_object)
147
 
        if self.is_clean(an_object):
148
 
            self._clean_objects.remove(an_object)
149
 
            del self._clean_queue[self._clean_queue.index(an_object)]
150
 
        self._trim()
151
 
 
152
 
    def writeable(self):
153
 
        """Write transactions allow writes."""
154
 
        return True
155
123
 
156
124
        
157
125
class PassThroughTransaction(object):
158
126
    """A pass through transaction
159
127
    
160
 
    - nothing is cached.
161
 
    - nothing ever gets into the identity map.
 
128
    - all actions are committed immediately.
 
129
    - rollback is not supported.
 
130
    - commit() is a no-op.
162
131
    """
163
132
 
 
133
    def commit(self):
 
134
        """PassThroughTransactions have nothing to do."""
 
135
 
164
136
    def finish(self):
165
 
        """Clean up this transaction."""
166
 
        for thing in self._dirty_objects:
167
 
            callback = getattr(thing, 'transaction_finished', None)
168
 
            if callback is not None:
169
 
                callback()
 
137
        """Clean up this transaction
 
138
 
 
139
        This will rollback on transactions that can if they have nto been
 
140
        committed.
 
141
        """
170
142
 
171
143
    def __init__(self):
172
144
        super(PassThroughTransaction, self).__init__()
173
145
        self.map = NullIdentityMap()
174
 
        self._dirty_objects = set()
175
146
 
176
147
    def register_clean(self, an_object, precious=False):
177
148
        """Register an_object as being clean.
181
152
        """
182
153
 
183
154
    def register_dirty(self, an_object):
184
 
        """Register an_object as being dirty.
185
 
        
186
 
        Dirty objects get informed
187
 
        when the transaction finishes.
188
 
        """
189
 
        self._dirty_objects.add(an_object)
 
155
        """Register an_object as being dirty."""
 
156
 
 
157
    def rollback(self):
 
158
        """Cannot rollback a pass through transaction."""
 
159
        raise errors.AlreadyCommitted
190
160
 
191
161
    def set_cache_size(self, ignored):
192
162
        """Do nothing, we are passing through."""
193
 
 
194
 
    def writeable(self):
195
 
        """Pass through transactions allow writes."""
196
 
        return True