forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlTransaction.cs
More file actions
321 lines (270 loc) · 11.3 KB
/
NpgsqlTransaction.cs
File metadata and controls
321 lines (270 loc) · 11.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
#region License
// The PostgreSQL License
//
// Copyright (C) 2017 The Npgsql Development Team
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#endregion
using System;
using System.Data;
using System.Data.Common;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Npgsql.FrontendMessages;
using Npgsql.Logging;
namespace Npgsql
{
/// <summary>
/// Represents a transaction to be made in a PostgreSQL database. This class cannot be inherited.
/// </summary>
public sealed class NpgsqlTransaction : DbTransaction
{
#region Fields and Properties
/// <summary>
/// Specifies the <see cref="NpgsqlConnection"/> object associated with the transaction.
/// </summary>
/// <value>The <see cref="NpgsqlConnection"/> object associated with the transaction.</value>
[CanBeNull]
public new NpgsqlConnection Connection { get; internal set; }
// Note that with ambient transactions, it's possible for a transaction to be pending after its connection
// is already closed. So we capture the connector and perform everything directly on it.
NpgsqlConnector _connector;
/// <summary>
/// Specifies the completion state of the transaction.
/// </summary>
/// <value>The completion state of the transaction.</value>
public bool IsCompleted => _connector == null;
/// <summary>
/// Specifies the <see cref="NpgsqlConnection"/> object associated with the transaction.
/// </summary>
/// <value>The <see cref="NpgsqlConnection"/> object associated with the transaction.</value>
[CanBeNull]
protected override DbConnection DbConnection => Connection;
bool _isDisposed;
/// <summary>
/// Specifies the <see cref="System.Data.IsolationLevel">IsolationLevel</see> for this transaction.
/// </summary>
/// <value>The <see cref="System.Data.IsolationLevel">IsolationLevel</see> for this transaction.
/// The default is <b>ReadCommitted</b>.</value>
public override IsolationLevel IsolationLevel
{
get
{
CheckReady();
return _isolationLevel;
}
}
readonly IsolationLevel _isolationLevel;
static readonly NpgsqlLogger Log = NpgsqlLogManager.GetCurrentClassLogger();
const IsolationLevel DefaultIsolationLevel = IsolationLevel.ReadCommitted;
#endregion
#region Constructors
internal NpgsqlTransaction(NpgsqlConnection conn, IsolationLevel isolationLevel = DefaultIsolationLevel)
{
Debug.Assert(conn != null);
Debug.Assert(isolationLevel != IsolationLevel.Chaos);
Connection = conn;
_connector = Connection.CheckReadyAndGetConnector();
Log.Debug($"Beginning transaction with isolation level {isolationLevel}", _connector.Id);
_connector.Transaction = this;
_connector.TransactionStatus = TransactionStatus.Pending;
switch (isolationLevel) {
case IsolationLevel.RepeatableRead:
_connector.PrependInternalMessage(PregeneratedMessage.BeginTrans);
_connector.PrependInternalMessage(PregeneratedMessage.SetTransRepeatableRead);
break;
case IsolationLevel.Serializable:
case IsolationLevel.Snapshot:
_connector.PrependInternalMessage(PregeneratedMessage.BeginTrans);
_connector.PrependInternalMessage(PregeneratedMessage.SetTransSerializable);
break;
case IsolationLevel.ReadUncommitted:
// PG doesn't really support ReadUncommitted, it's the same as ReadCommitted. But we still
// send as if.
_connector.PrependInternalMessage(PregeneratedMessage.BeginTrans);
_connector.PrependInternalMessage(PregeneratedMessage.SetTransReadUncommitted);
break;
case IsolationLevel.ReadCommitted:
_connector.PrependInternalMessage(PregeneratedMessage.BeginTrans);
_connector.PrependInternalMessage(PregeneratedMessage.SetTransReadCommitted);
break;
case IsolationLevel.Unspecified:
isolationLevel = DefaultIsolationLevel;
goto case DefaultIsolationLevel;
default:
throw new NotSupportedException("Isolation level not supported: " + isolationLevel);
}
_isolationLevel = isolationLevel;
}
#endregion
#region Commit
/// <summary>
/// Commits the database transaction.
/// </summary>
public override void Commit() => Commit(false, CancellationToken.None).GetAwaiter().GetResult();
async Task Commit(bool async, CancellationToken cancellationToken)
{
CheckReady();
using (_connector.StartUserAction())
{
Log.Debug("Committing transaction", _connector.Id);
await _connector.ExecuteInternalCommand(PregeneratedMessage.CommitTransaction, async, cancellationToken);
Clear();
}
}
/// <summary>
/// Commits the database transaction.
/// </summary>
[PublicAPI]
public Task CommitAsync(CancellationToken cancellationToken)
=> SynchronizationContextSwitcher.NoContext(async () =>
{
cancellationToken.ThrowIfCancellationRequested();
await Commit(true, cancellationToken);
});
/// <summary>
/// Commits the database transaction.
/// </summary>
[PublicAPI]
public Task CommitAsync() => CommitAsync(CancellationToken.None);
#endregion
#region Rollback
/// <summary>
/// Rolls back a transaction from a pending state.
/// </summary>
public override void Rollback() => Rollback(false, CancellationToken.None).GetAwaiter().GetResult();
async Task Rollback(bool async, CancellationToken cancellationToken)
{
CheckReady();
await _connector.Rollback(async, cancellationToken);
Clear();
}
/// <summary>
/// Rolls back a transaction from a pending state.
/// </summary>
[PublicAPI]
public Task RollbackAsync(CancellationToken cancellationToken)
=> SynchronizationContextSwitcher.NoContext(async () =>
{
cancellationToken.ThrowIfCancellationRequested();
await Rollback(true, cancellationToken);
});
/// <summary>
/// Rolls back a transaction from a pending state.
/// </summary>
[PublicAPI]
public Task RollbackAsync() => RollbackAsync(CancellationToken.None);
#endregion
#region Savepoints
/// <summary>
/// Creates a transaction save point.
/// </summary>
public void Save(string name)
{
if (name == null)
throw new ArgumentNullException(nameof(name));
if (string.IsNullOrWhiteSpace(name))
throw new ArgumentException("name can't be empty", nameof(name));
if (name.Contains(";"))
throw new ArgumentException("name can't contain a semicolon");
CheckReady();
using (_connector.StartUserAction())
{
Log.Debug($"Creating savepoint {name}", _connector.Id);
_connector.ExecuteInternalCommand($"SAVEPOINT {name}");
}
}
/// <summary>
/// Rolls back a transaction from a pending savepoint state.
/// </summary>
public void Rollback(string name)
{
if (name == null)
throw new ArgumentNullException(nameof(name));
if (string.IsNullOrWhiteSpace(name))
throw new ArgumentException("name can't be empty", nameof(name));
if (name.Contains(";"))
throw new ArgumentException("name can't contain a semicolon");
CheckReady();
using (_connector.StartUserAction())
{
Log.Debug($"Rolling back savepoint {name}", _connector.Id);
_connector.ExecuteInternalCommand($"ROLLBACK TO SAVEPOINT {name}");
}
}
/// <summary>
/// Rolls back a transaction from a pending savepoint state.
/// </summary>
public void Release(string name)
{
if (name == null)
throw new ArgumentNullException(nameof(name));
if (string.IsNullOrWhiteSpace(name))
throw new ArgumentException("name can't be empty", nameof(name));
if (name.Contains(";"))
throw new ArgumentException("name can't contain a semicolon");
CheckReady();
using (_connector.StartUserAction())
{
Log.Debug($"Releasing savepoint {name}", _connector.Id);
_connector.ExecuteInternalCommand($"RELEASE SAVEPOINT {name}");
}
}
#endregion
#region Dispose
/// <summary>
/// Dispose.
/// </summary>
/// <param name="disposing"></param>
protected override void Dispose(bool disposing) => Dispose(disposing, true);
internal void Dispose(bool disposing, bool doRollbackIfNeeded)
{
if (_isDisposed) { return; }
if (disposing && doRollbackIfNeeded && !IsCompleted)
Rollback();
Clear();
base.Dispose(disposing);
_isDisposed = true;
}
internal void Clear()
{
_connector = null;
Connection = null;
}
#endregion
#region Checks
void CheckReady()
{
CheckDisposed();
CheckCompleted();
}
void CheckCompleted()
{
if (IsCompleted)
throw new InvalidOperationException("This NpgsqlTransaction has completed; it is no longer usable.");
}
void CheckDisposed()
{
if (_isDisposed)
throw new ObjectDisposedException(typeof(NpgsqlTransaction).Name);
}
#endregion
}
}