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
366 lines (311 loc) · 13.4 KB
/
NpgsqlTransaction.cs
File metadata and controls
366 lines (311 loc) · 13.4 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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
using System;
using System.Data;
using System.Data.Common;
using System.Diagnostics;
using System.Threading;
using System.Threading.Tasks;
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>
public new NpgsqlConnection? Connection
{
get
{
CheckReady();
return _connector.Connection;
}
}
// 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.
readonly NpgsqlConnector _connector;
/// <summary>
/// Specifies the <see cref="NpgsqlConnection"/> object associated with the transaction.
/// </summary>
/// <value>The <see cref="NpgsqlConnection"/> object associated with the transaction.</value>
protected override DbConnection? DbConnection => Connection;
/// <summary>
/// If true, the transaction has been committed/rolled back, but not disposed.
/// </summary>
internal bool IsCompleted => _connector.TransactionStatus == TransactionStatus.Idle;
internal 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;
}
}
IsolationLevel _isolationLevel;
static readonly NpgsqlLogger Log = NpgsqlLogManager.CreateLogger(nameof(NpgsqlTransaction));
const IsolationLevel DefaultIsolationLevel = IsolationLevel.ReadCommitted;
#endregion
#region Initialization
internal NpgsqlTransaction(NpgsqlConnector connector)
=> _connector = connector;
internal void Init(IsolationLevel isolationLevel = DefaultIsolationLevel)
{
Debug.Assert(isolationLevel != IsolationLevel.Chaos);
if (!_connector.DatabaseInfo.SupportsTransactions)
return;
Log.Debug($"Beginning transaction with isolation level {isolationLevel}", _connector.Id);
switch (isolationLevel)
{
case IsolationLevel.RepeatableRead:
case IsolationLevel.Snapshot:
_connector.PrependInternalMessage(PregeneratedMessages.BeginTransRepeatableRead, 2);
break;
case IsolationLevel.Serializable:
_connector.PrependInternalMessage(PregeneratedMessages.BeginTransSerializable, 2);
break;
case IsolationLevel.ReadUncommitted:
// PG doesn't really support ReadUncommitted, it's the same as ReadCommitted. But we still
// send as if.
_connector.PrependInternalMessage(PregeneratedMessages.BeginTransReadUncommitted, 2);
break;
case IsolationLevel.ReadCommitted:
_connector.PrependInternalMessage(PregeneratedMessages.BeginTransReadCommitted, 2);
break;
case IsolationLevel.Unspecified:
isolationLevel = DefaultIsolationLevel;
goto case DefaultIsolationLevel;
default:
throw new NotSupportedException("Isolation level not supported: " + isolationLevel);
}
_connector.TransactionStatus = TransactionStatus.Pending;
_isolationLevel = isolationLevel;
IsDisposed = false;
}
#endregion
#region Commit
/// <summary>
/// Commits the database transaction.
/// </summary>
public override void Commit() => Commit(false).GetAwaiter().GetResult();
async Task Commit(bool async)
{
CheckReady();
if (!_connector.DatabaseInfo.SupportsTransactions)
return;
using (_connector.StartUserAction())
{
Log.Debug("Committing transaction", _connector.Id);
await _connector.ExecuteInternalCommand(PregeneratedMessages.CommitTransaction, async);
}
}
/// <summary>
/// Commits the database transaction.
/// </summary>
/// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None"/>.</param>
#if !NET461 && !NETSTANDARD2_0
public override Task CommitAsync(CancellationToken cancellationToken = default)
#else
public Task CommitAsync(CancellationToken cancellationToken = default)
#endif
{
if (cancellationToken.IsCancellationRequested)
return Task.FromCanceled(cancellationToken);
using (NoSynchronizationContextScope.Enter())
return Commit(true);
}
#endregion
#region Rollback
/// <summary>
/// Rolls back a transaction from a pending state.
/// </summary>
public override void Rollback() => Rollback(false).GetAwaiter().GetResult();
Task Rollback(bool async)
{
CheckReady();
return _connector.DatabaseInfo.SupportsTransactions
? _connector.Rollback(async)
: Task.CompletedTask;
}
/// <summary>
/// Rolls back a transaction from a pending state.
/// </summary>
/// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None"/>.</param>
#if !NET461 && !NETSTANDARD2_0
public override Task RollbackAsync(CancellationToken cancellationToken = default)
#else
public Task RollbackAsync(CancellationToken cancellationToken = default)
#endif
{
if (cancellationToken.IsCancellationRequested)
return Task.FromCanceled(cancellationToken);
using (NoSynchronizationContextScope.Enter())
return Rollback(true);
}
#endregion
#region Savepoints
async Task Save(string name, bool async)
{
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();
if (!_connector.DatabaseInfo.SupportsTransactions)
return;
using (_connector.StartUserAction())
{
Log.Debug($"Creating savepoint {name}", _connector.Id);
await _connector.ExecuteInternalCommand($"SAVEPOINT {name}", async);
}
}
/// <summary>
/// Creates a transaction save point.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
public void Save(string name) => Save(name, false).GetAwaiter().GetResult();
/// <summary>
/// Creates a transaction save point.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None"/>.</param>
public Task SaveAsync(string name, CancellationToken cancellationToken = default)
{
if (cancellationToken.IsCancellationRequested)
return Task.FromCanceled(cancellationToken);
using (NoSynchronizationContextScope.Enter())
return Save(name, true);
}
async Task Rollback(string name, bool async)
{
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();
if (!_connector.DatabaseInfo.SupportsTransactions)
return;
using (_connector.StartUserAction())
{
Log.Debug($"Rolling back savepoint {name}", _connector.Id);
await _connector.ExecuteInternalCommand($"ROLLBACK TO SAVEPOINT {name}", async);
}
}
/// <summary>
/// Rolls back a transaction from a pending savepoint state.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
public void Rollback(string name) => Rollback(name, false).GetAwaiter().GetResult();
/// <summary>
/// Rolls back a transaction from a pending savepoint state.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None"/>.</param>
public Task RollbackAsync(string name, CancellationToken cancellationToken = default)
{
if (cancellationToken.IsCancellationRequested)
return Task.FromCanceled(cancellationToken);
using (NoSynchronizationContextScope.Enter())
return Rollback(name, true);
}
async Task Release(string name, bool async)
{
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();
if (!_connector.DatabaseInfo.SupportsTransactions)
return;
using (_connector.StartUserAction())
{
Log.Debug($"Releasing savepoint {name}", _connector.Id);
await _connector.ExecuteInternalCommand($"RELEASE SAVEPOINT {name}", async);
}
}
/// <summary>
/// Releases a transaction from a pending savepoint state.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
public void Release(string name) => Release(name, false).GetAwaiter().GetResult();
/// <summary>
/// Releases a transaction from a pending savepoint state.
/// </summary>
/// <param name="name">The name of the savepoint.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="CancellationToken.None"/>.</param>
public Task ReleaseAsync(string name, CancellationToken cancellationToken = default)
{
if (cancellationToken.IsCancellationRequested)
return Task.FromCanceled(cancellationToken);
using (NoSynchronizationContextScope.Enter())
return Release(name, true);
}
#endregion
#region Dispose
/// <summary>
/// Disposes the transaction, rolling it back if it is still pending.
/// </summary>
protected override void Dispose(bool disposing)
{
if (IsDisposed)
return;
if (disposing && !IsCompleted)
{
_connector.CloseOngoingOperations(async: false).GetAwaiter().GetResult();
Rollback();
}
IsDisposed = true;
}
/// <summary>
/// Disposes the transaction, rolling it back if it is still pending.
/// </summary>
#if !NET461 && !NETSTANDARD2_0
public override async ValueTask DisposeAsync()
#else
public async ValueTask DisposeAsync()
#endif
{
if (IsDisposed)
return;
if (!IsCompleted)
{
using (NoSynchronizationContextScope.Enter())
{
await _connector.CloseOngoingOperations(async: true);
await Rollback(async: true);
}
}
IsDisposed = true;
}
/// <summary>
/// Disposes the transaction, without rolling back. Used only in special circumstances, e.g. when
/// the connection is broken.
/// </summary>
internal void DisposeImmediately() => IsDisposed = true;
#endregion
#region Checks
void CheckReady()
{
if (IsDisposed)
throw new ObjectDisposedException(typeof(NpgsqlTransaction).Name);
if (IsCompleted)
throw new InvalidOperationException("This NpgsqlTransaction has completed; it is no longer usable.");
}
#endregion
}
}