-
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDatabaseClientBase.cs
More file actions
1396 lines (1291 loc) · 57.6 KB
/
Copy pathDatabaseClientBase.cs
File metadata and controls
1396 lines (1291 loc) · 57.6 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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Collections.Generic;
using System.Data;
using System.Data.Common;
using System.Runtime.ExceptionServices;
using System.Threading;
using System.Threading.Tasks;
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_0_OR_GREATER
using System.Runtime.CompilerServices;
#endif
namespace DBAClientX;
/// <summary>
/// Provides a common foundation for database client implementations, including
/// retry logic, parameter handling, and result materialization helpers.
/// </summary>
public abstract class DatabaseClientBase : IDisposable, IAsyncDisposable
{
private readonly object _syncRoot = new();
private ReturnType _returnType;
private int _commandTimeout;
private int _maxRetryAttempts = 3;
private TimeSpan _retryDelay = TimeSpan.FromMilliseconds(200);
private bool _retryNonQueryOperations;
private int _disposeSignaled;
private const int MaxBackoffMilliseconds = 30000; // cap backoff to 30s
private static readonly ThreadLocal<Random> _rand = new(() => new Random(unchecked(Environment.TickCount * 31 + Thread.CurrentThread.ManagedThreadId)));
/// <summary>
/// Gets or sets the desired return type for query executions.
/// </summary>
public ReturnType ReturnType
{
get { lock (_syncRoot) { return _returnType; } }
set { lock (_syncRoot) { _returnType = value; } }
}
/// <summary>
/// Gets or sets the command timeout applied to database commands, in seconds.
/// Specify <c>0</c> to use the provider default.
/// </summary>
public int CommandTimeout
{
get { lock (_syncRoot) { return _commandTimeout; } }
set { lock (_syncRoot) { _commandTimeout = value; } }
}
/// <summary>
/// Gets or sets the maximum number of retry attempts for transient failures.
/// A value lower than <c>1</c> is treated as a single attempt.
/// </summary>
public int MaxRetryAttempts
{
get { lock (_syncRoot) { return _maxRetryAttempts; } }
set
{
if (value < 0)
{
throw new ArgumentOutOfRangeException(nameof(value), "MaxRetryAttempts cannot be negative.");
}
lock (_syncRoot) { _maxRetryAttempts = value; }
}
}
/// <summary>
/// Gets or sets the base delay between retry attempts. Exponential backoff
/// with jitter is derived from this value.
/// </summary>
public TimeSpan RetryDelay
{
get { lock (_syncRoot) { return _retryDelay; } }
set
{
if (value < TimeSpan.Zero)
{
throw new ArgumentOutOfRangeException(nameof(value), "RetryDelay cannot be negative.");
}
lock (_syncRoot) { _retryDelay = value; }
}
}
/// <summary>
/// Gets or sets whether mutating commands such as INSERT/UPDATE/DELETE should use automatic retries.
/// Defaults to <see langword="false"/> to avoid replaying non-idempotent writes after partial success.
/// </summary>
public bool RetryNonQueryOperations
{
get { lock (_syncRoot) { return _retryNonQueryOperations; } }
set { lock (_syncRoot) { _retryNonQueryOperations = value; } }
}
/// <summary>
/// Determines whether an exception represents a transient failure that warrants a retry.
/// </summary>
/// <param name="ex">The exception encountered during execution.</param>
/// <returns><c>true</c> when the exception is transient; otherwise, <c>false</c>.</returns>
protected virtual bool IsTransient(Exception ex) => false;
/// <summary>
/// Executes an operation with retry logic for transient failures.
/// </summary>
/// <typeparam name="T">The type of the result produced by the operation.</typeparam>
/// <param name="operation">The operation to execute.</param>
/// <returns>The result of the successful operation.</returns>
/// <exception cref="Exception">Thrown when all retry attempts fail.</exception>
protected T ExecuteWithRetry<T>(Func<T> operation)
{
var attempts = 0;
Exception? lastException = null;
var maxAttempts = MaxRetryAttempts < 1 ? 1 : MaxRetryAttempts;
while (attempts < maxAttempts)
{
try
{
return operation();
}
catch (Exception ex) when (IsTransient(ex))
{
lastException = ex;
attempts++;
if (attempts >= maxAttempts)
{
break;
}
var delay = ComputeBackoffDelay(attempts);
if (delay > TimeSpan.Zero)
{
Thread.Sleep(delay);
}
}
}
throw lastException ?? new Exception("Operation failed.");
}
/// <summary>
/// Asynchronously executes an operation with retry logic for transient failures.
/// </summary>
/// <typeparam name="T">The type of the result produced by the operation.</typeparam>
/// <param name="operation">The asynchronous operation to execute.</param>
/// <param name="cancellationToken">Token used to cancel the retries.</param>
/// <returns>The result of the successful operation.</returns>
/// <exception cref="Exception">Thrown when all retry attempts fail.</exception>
protected async Task<T> ExecuteWithRetryAsync<T>(Func<Task<T>> operation, CancellationToken cancellationToken = default)
{
var attempts = 0;
Exception? lastException = null;
var maxAttempts = MaxRetryAttempts < 1 ? 1 : MaxRetryAttempts;
while (attempts < maxAttempts)
{
cancellationToken.ThrowIfCancellationRequested();
try
{
return await operation().ConfigureAwait(false);
}
catch (Exception ex) when (IsTransient(ex))
{
lastException = ex;
attempts++;
if (attempts >= maxAttempts)
{
break;
}
var delay = ComputeBackoffDelay(attempts);
if (delay > TimeSpan.Zero)
{
await Task.Delay(delay, cancellationToken).ConfigureAwait(false);
}
}
}
throw lastException ?? new Exception("Operation failed.");
}
/// <summary>
/// Asynchronously disposes a resource only when the current operation owns it.
/// </summary>
/// <typeparam name="TResource">The resource type.</typeparam>
/// <param name="resource">The resource instance to dispose.</param>
/// <param name="ownsResource"><see langword="true"/> when the caller created and owns the resource.</param>
/// <param name="disposeAsync">Asynchronous disposal callback for the resource.</param>
protected static async ValueTask DisposeOwnedResourceAsync<TResource>(TResource? resource, bool ownsResource, Func<TResource, ValueTask> disposeAsync)
where TResource : class
{
if (!ownsResource || resource == null)
{
return;
}
await disposeAsync(resource).ConfigureAwait(false);
}
/// <summary>
/// Disposes a pair of resources in order, skipping any <see langword="null"/> values.
/// </summary>
/// <typeparam name="TPrimary">The primary resource type.</typeparam>
/// <typeparam name="TSecondary">The secondary resource type.</typeparam>
/// <param name="primary">The primary resource instance.</param>
/// <param name="disposePrimary">Synchronous disposal callback for the primary resource.</param>
/// <param name="secondary">The secondary resource instance.</param>
/// <param name="disposeSecondary">Synchronous disposal callback for the secondary resource.</param>
protected static void DisposeResourcePair<TPrimary, TSecondary>(
TPrimary? primary,
Action<TPrimary> disposePrimary,
TSecondary? secondary,
Action<TSecondary> disposeSecondary)
where TPrimary : class
where TSecondary : class
{
if (primary != null)
{
disposePrimary(primary);
}
if (secondary != null)
{
disposeSecondary(secondary);
}
}
/// <summary>
/// Asynchronously disposes a pair of resources in order, skipping any <see langword="null"/> values.
/// </summary>
/// <typeparam name="TPrimary">The primary resource type.</typeparam>
/// <typeparam name="TSecondary">The secondary resource type.</typeparam>
/// <param name="primary">The primary resource instance.</param>
/// <param name="disposePrimaryAsync">Asynchronous disposal callback for the primary resource.</param>
/// <param name="secondary">The secondary resource instance.</param>
/// <param name="disposeSecondaryAsync">Asynchronous disposal callback for the secondary resource.</param>
protected static async ValueTask DisposeResourcePairAsync<TPrimary, TSecondary>(
TPrimary? primary,
Func<TPrimary, ValueTask> disposePrimaryAsync,
TSecondary? secondary,
Func<TSecondary, ValueTask> disposeSecondaryAsync)
where TPrimary : class
where TSecondary : class
{
if (primary != null)
{
await disposePrimaryAsync(primary).ConfigureAwait(false);
}
if (secondary != null)
{
await disposeSecondaryAsync(secondary).ConfigureAwait(false);
}
}
/// <summary>
/// Detaches the current transaction state and clears the stored references.
/// </summary>
/// <typeparam name="TTransaction">The provider transaction type.</typeparam>
/// <typeparam name="TConnection">The provider connection type.</typeparam>
/// <param name="transaction">Reference to the stored transaction field.</param>
/// <param name="connection">Reference to the stored connection field.</param>
/// <param name="connectionString">Reference to the stored normalized connection string field.</param>
/// <param name="transactionInitializing">Reference to the transaction initialization flag.</param>
/// <param name="requireActiveTransaction"><see langword="true"/> to throw when no transaction is active.</param>
/// <returns>The detached transaction and connection pair.</returns>
/// <exception cref="DbaTransactionException">Thrown when <paramref name="requireActiveTransaction"/> is <see langword="true"/> and no transaction is active.</exception>
protected static (TTransaction? Transaction, TConnection? Connection) DetachTransactionState<TTransaction, TConnection>(
ref TTransaction? transaction,
ref TConnection? connection,
ref string? connectionString,
ref bool transactionInitializing,
bool requireActiveTransaction = false)
where TTransaction : class
where TConnection : class
{
if (requireActiveTransaction && transaction == null)
{
throw new DbaTransactionException("No active transaction.");
}
var detachedTransaction = transaction;
var detachedConnection = connection;
transaction = null;
connection = null;
connectionString = null;
transactionInitializing = false;
return (detachedTransaction, detachedConnection);
}
/// <summary>
/// Throws when a transaction is already active or currently being initialized.
/// </summary>
/// <typeparam name="TTransaction">The provider transaction type.</typeparam>
/// <param name="transaction">The currently stored transaction reference.</param>
/// <param name="transactionInitializing">The transaction initialization flag.</param>
/// <exception cref="DbaTransactionException">Thrown when a transaction is already active or being initialized.</exception>
protected static void EnsureTransactionStartAllowed<TTransaction>(TTransaction? transaction, bool transactionInitializing)
where TTransaction : class
{
if (transaction != null || transactionInitializing)
{
throw new DbaTransactionException("Transaction already started.");
}
}
/// <summary>
/// Reserves transaction initialization after confirming that no transaction is active.
/// </summary>
/// <typeparam name="TTransaction">The provider transaction type.</typeparam>
/// <param name="transaction">The currently stored transaction reference.</param>
/// <param name="transactionInitializing">Reference to the transaction initialization flag.</param>
protected static void ReserveTransactionStart<TTransaction>(TTransaction? transaction, ref bool transactionInitializing)
where TTransaction : class
{
EnsureTransactionStartAllowed(transaction, transactionInitializing);
transactionInitializing = true;
}
/// <summary>
/// Stores a successfully started transaction and clears the initialization reservation.
/// </summary>
/// <typeparam name="TTransaction">The provider transaction type.</typeparam>
/// <typeparam name="TConnection">The provider connection type.</typeparam>
/// <param name="transactionField">Reference to the stored transaction field.</param>
/// <param name="connectionField">Reference to the stored connection field.</param>
/// <param name="connectionStringField">Reference to the stored normalized connection string field.</param>
/// <param name="transactionInitializing">Reference to the transaction initialization flag.</param>
/// <param name="transaction">The started transaction instance.</param>
/// <param name="connection">The opened connection instance.</param>
/// <param name="normalizedConnectionString">The normalized connection string associated with the transaction.</param>
protected static void StoreStartedTransaction<TTransaction, TConnection>(
ref TTransaction? transactionField,
ref TConnection? connectionField,
ref string? connectionStringField,
ref bool transactionInitializing,
TTransaction transaction,
TConnection connection,
string normalizedConnectionString)
where TTransaction : class
where TConnection : class
{
if (transactionField != null)
{
transactionInitializing = false;
throw new DbaTransactionException("Transaction already started.");
}
connectionField = connection;
transactionField = transaction;
connectionStringField = normalizedConnectionString;
transactionInitializing = false;
}
/// <summary>
/// Clears the transaction initialization reservation when no active transaction was stored.
/// </summary>
/// <typeparam name="TTransaction">The provider transaction type.</typeparam>
/// <param name="transaction">The currently stored transaction reference.</param>
/// <param name="transactionInitializing">Reference to the transaction initialization flag.</param>
protected static void ReleaseTransactionStartReservationIfNeeded<TTransaction>(TTransaction? transaction, ref bool transactionInitializing)
where TTransaction : class
{
if (transaction == null)
{
transactionInitializing = false;
}
}
/// <summary>
/// Computes the capped exponential backoff delay with jitter for a retry attempt.
/// </summary>
/// <param name="attempt">The one-based retry attempt number.</param>
/// <returns>The delay before the next retry attempt.</returns>
protected TimeSpan ComputeBackoffDelay(int attempt)
{
var baseDelay = RetryDelay;
if (baseDelay <= TimeSpan.Zero)
{
return TimeSpan.Zero;
}
// Exponential backoff with jitter (full jitter)
var factor = Math.Pow(2, Math.Max(0, attempt - 1));
var baseMilliseconds = baseDelay.TotalMilliseconds;
var ms = baseMilliseconds * factor;
var jitter = _rand.Value!.NextDouble() * baseMilliseconds; // 0..base
var total = Math.Min(ms + jitter, MaxBackoffMilliseconds);
return TimeSpan.FromMilliseconds(total);
}
/// <summary>
/// Adds parameters created from dictionaries of values, types, and directions to the supplied command.
/// </summary>
/// <param name="command">The command receiving the parameters.</param>
/// <param name="parameters">Parameter values keyed by parameter name.</param>
/// <param name="parameterTypes">Explicit database types keyed by parameter name.</param>
/// <param name="parameterDirections">Explicit directions keyed by parameter name.</param>
protected virtual void AddParameters(DbCommand command, IDictionary<string, object?>? parameters, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
if (parameters == null)
{
return;
}
foreach (var pair in parameters)
{
var value = pair.Value ?? DBNull.Value;
var parameter = command.CreateParameter();
parameter.ParameterName = pair.Key;
parameter.Value = value;
if (TryGetDictionaryValue(parameterTypes, pair.Key, out var explicitType))
{
parameter.DbType = explicitType;
}
else
{
parameter.DbType = InferDbType(value);
}
if (TryGetDictionaryValue(parameterDirections, pair.Key, out var direction))
{
parameter.Direction = direction;
}
command.Parameters.Add(parameter);
}
}
/// <summary>
/// Copies the values of output parameters back into the supplied dictionary.
/// </summary>
/// <param name="command">The command that was executed.</param>
/// <param name="parameters">The dictionary receiving updated parameter values.</param>
protected virtual void UpdateOutputParameters(DbCommand command, IDictionary<string, object?>? parameters)
{
if (parameters == null)
{
return;
}
foreach (DbParameter p in command.Parameters)
{
if (p.Direction != ParameterDirection.Input)
{
var targetKey = FindExistingKey(parameters, p.ParameterName) ?? p.ParameterName;
parameters[targetKey] = p.Value == DBNull.Value ? null : p.Value;
}
}
}
/// <summary>
/// Adds pre-created parameters to the supplied command.
/// </summary>
/// <param name="command">The command receiving the parameters.</param>
/// <param name="parameters">The parameters to add.</param>
protected virtual void AddParameters(DbCommand command, IEnumerable<DbParameter>? parameters)
{
if (parameters == null)
{
return;
}
foreach (var parameter in parameters)
{
command.Parameters.Add(parameter);
}
}
private static DbType InferDbType(object? value)
{
if (value == null || value == DBNull.Value) return DbType.Object;
if (value is Guid) return DbType.Guid;
if (value is byte[]) return DbType.Binary;
if (value is TimeSpan) return DbType.Time;
if (value is DateTimeOffset) return DbType.DateTimeOffset;
return Type.GetTypeCode(value.GetType()) switch
{
TypeCode.Byte => DbType.Byte,
TypeCode.SByte => DbType.SByte,
TypeCode.Int16 => DbType.Int16,
TypeCode.Int32 => DbType.Int32,
TypeCode.Int64 => DbType.Int64,
TypeCode.UInt16 => DbType.UInt16,
TypeCode.UInt32 => DbType.UInt32,
TypeCode.UInt64 => DbType.UInt64,
TypeCode.Decimal => DbType.Decimal,
TypeCode.Double => DbType.Double,
TypeCode.Single => DbType.Single,
TypeCode.Boolean => DbType.Boolean,
TypeCode.String => DbType.String,
TypeCode.Char => DbType.StringFixedLength,
TypeCode.DateTime => DbType.DateTime,
_ => DbType.Object
};
}
/// <summary>
/// Looks up a dictionary value using the supplied key, falling back to a case-insensitive comparison.
/// </summary>
/// <typeparam name="TValue">The dictionary value type.</typeparam>
/// <param name="dictionary">The dictionary to inspect.</param>
/// <param name="key">The key to find.</param>
/// <param name="value">The value when a matching key is found.</param>
/// <returns><c>true</c> when the key is present; otherwise, <c>false</c>.</returns>
protected static bool TryGetDictionaryValue<TValue>(IDictionary<string, TValue>? dictionary, string key, out TValue value)
{
value = default!;
if (dictionary == null)
{
return false;
}
if (dictionary.TryGetValue(key, out var foundValue))
{
value = foundValue;
return true;
}
foreach (var pair in dictionary)
{
if (string.Equals(pair.Key, key, StringComparison.OrdinalIgnoreCase))
{
value = pair.Value;
return true;
}
}
return false;
}
private static string? FindExistingKey(IDictionary<string, object?> dictionary, string key)
{
if (dictionary.ContainsKey(key))
{
return key;
}
foreach (var pair in dictionary)
{
if (string.Equals(pair.Key, key, StringComparison.OrdinalIgnoreCase))
{
return pair.Key;
}
}
return null;
}
/// <summary>
/// Executes a query and materializes the result according to <see cref="ReturnType"/>.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The query to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The query result shaped according to <see cref="ReturnType"/>.</returns>
protected virtual object? ExecuteQuery(DbConnection connection, DbTransaction? transaction, string query, IDictionary<string, object?>? parameters = null, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
return ExecuteWithRetry<object?>(() =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
object? result;
using (var reader = command.ExecuteReader(CommandBehavior.SequentialAccess))
{
var returnType = ReturnType;
if (returnType == ReturnType.DataRow)
{
if (reader.Read())
{
var table = new DataTable("Table0");
for (int i = 0; i < reader.FieldCount; i++)
{
table.Columns.Add(reader.GetName(i), reader.GetFieldType(i));
}
var row = table.NewRow();
for (int i = 0; i < reader.FieldCount; i++)
{
row[i] = reader.IsDBNull(i) ? DBNull.Value : reader.GetValue(i);
}
result = row;
}
else
{
result = null;
}
}
else if (returnType == ReturnType.DataTable || returnType == ReturnType.PSObject)
{
result = ReadDataTable(reader, "Table0");
}
else
{
var dataSet = new DataSet();
var tableIndex = 0;
do
{
var table = ReadDataTable(reader, $"Table{tableIndex}");
dataSet.Tables.Add(table);
tableIndex++;
} while (!reader.IsClosed && reader.NextResult());
result = BuildResult(dataSet);
}
}
UpdateOutputParameters(command, parameters);
return result;
});
}
/// <summary>
/// Executes a query and maps each row with a caller-provided mapper.
/// </summary>
/// <typeparam name="T">The row result type produced by <paramref name="map"/>.</typeparam>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The query to execute.</param>
/// <param name="map">A mapper that converts the current data record into a result value.</param>
/// <param name="initialize">Optional callback invoked once after the reader opens and before the first row is read.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The mapped result rows.</returns>
protected virtual IReadOnlyList<T> ExecuteMappedQuery<T>(
DbConnection connection,
DbTransaction? transaction,
string query,
Func<IDataRecord, T> map,
Action<IDataRecord>? initialize = null,
IDictionary<string, object?>? parameters = null,
IDictionary<string, DbType>? parameterTypes = null,
IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
if (map == null)
{
throw new ArgumentNullException(nameof(map));
}
return ExecuteWithRetry<IReadOnlyList<T>>(() =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var rows = new List<T>();
using (var reader = command.ExecuteReader(CommandBehavior.Default))
{
initialize?.Invoke(reader);
while (reader.Read())
{
rows.Add(map(reader));
}
}
UpdateOutputParameters(command, parameters);
return rows;
});
}
/// <summary>
/// Executes a non-query command (INSERT/UPDATE/DELETE) with retry support.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The command text to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The number of rows affected.</returns>
protected virtual int ExecuteNonQuery(DbConnection connection, DbTransaction? transaction, string query, IDictionary<string, object?>? parameters = null, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
int ExecuteOperation()
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var affected = command.ExecuteNonQuery();
UpdateOutputParameters(command, parameters);
return affected;
}
return RetryNonQueryOperations
? ExecuteWithRetry(ExecuteOperation)
: ExecuteOperation();
}
/// <summary>
/// Executes a scalar command and returns the first column of the first row.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The command text to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The scalar result.</returns>
protected virtual object? ExecuteScalar(DbConnection connection, DbTransaction? transaction, string query, IDictionary<string, object?>? parameters = null, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
return ExecuteWithRetry<object?>(() =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var result = command.ExecuteScalar();
UpdateOutputParameters(command, parameters);
return result;
});
}
/// <summary>
/// Asynchronously executes a query and materializes the result according to <see cref="ReturnType"/>.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The query to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="cancellationToken">Token used to cancel the operation.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The query result shaped according to <see cref="ReturnType"/>.</returns>
protected virtual async Task<object?> ExecuteQueryAsync(DbConnection connection, DbTransaction? transaction, string query, IDictionary<string, object?>? parameters = null, CancellationToken cancellationToken = default, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
return await ExecuteWithRetryAsync(async () =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
object? result;
using (var reader = await command.ExecuteReaderAsync(CommandBehavior.SequentialAccess, cancellationToken).ConfigureAwait(false))
{
var returnType = ReturnType;
if (returnType == ReturnType.DataRow)
{
if (await reader.ReadAsync(cancellationToken).ConfigureAwait(false))
{
var table = new DataTable("Table0");
for (int i = 0; i < reader.FieldCount; i++)
{
table.Columns.Add(reader.GetName(i), reader.GetFieldType(i));
}
var row = table.NewRow();
for (int i = 0; i < reader.FieldCount; i++)
{
row[i] = reader.IsDBNull(i) ? DBNull.Value : reader.GetValue(i);
}
result = row;
}
else
{
result = null;
}
}
else if (returnType == ReturnType.DataTable || returnType == ReturnType.PSObject)
{
result = await ReadDataTableAsync(reader, "Table0", cancellationToken).ConfigureAwait(false);
}
else
{
var dataSet = new DataSet();
var tableIndex = 0;
do
{
var table = await ReadDataTableAsync(reader, $"Table{tableIndex}", cancellationToken).ConfigureAwait(false);
dataSet.Tables.Add(table);
tableIndex++;
} while (!reader.IsClosed && await reader.NextResultAsync(cancellationToken).ConfigureAwait(false));
result = BuildResult(dataSet);
}
}
UpdateOutputParameters(command, parameters);
return result;
}, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Asynchronously executes a query and maps each row with a caller-provided mapper.
/// </summary>
/// <typeparam name="T">The row result type produced by <paramref name="map"/>.</typeparam>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The query to execute.</param>
/// <param name="map">A mapper that converts the current data record into a result value.</param>
/// <param name="initialize">Optional callback invoked once after the reader opens and before the first row is read.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="cancellationToken">Token used to cancel the operation.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The mapped result rows.</returns>
protected virtual async Task<IReadOnlyList<T>> ExecuteMappedQueryAsync<T>(
DbConnection connection,
DbTransaction? transaction,
string query,
Func<IDataRecord, T> map,
Action<IDataRecord>? initialize = null,
IDictionary<string, object?>? parameters = null,
CancellationToken cancellationToken = default,
IDictionary<string, DbType>? parameterTypes = null,
IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
if (map == null)
{
throw new ArgumentNullException(nameof(map));
}
return await ExecuteWithRetryAsync(async () =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var rows = new List<T>();
using (var reader = await command.ExecuteReaderAsync(CommandBehavior.Default, cancellationToken).ConfigureAwait(false))
{
initialize?.Invoke(reader);
while (await reader.ReadAsync(cancellationToken).ConfigureAwait(false))
{
rows.Add(map(reader));
}
}
UpdateOutputParameters(command, parameters);
return (IReadOnlyList<T>)rows;
}, cancellationToken).ConfigureAwait(false);
}
/// <summary>
/// Asynchronously executes a non-query command (INSERT/UPDATE/DELETE) with retry support.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The command text to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="cancellationToken">Token used to cancel the operation.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The number of rows affected.</returns>
protected virtual async Task<int> ExecuteNonQueryAsync(
DbConnection connection,
DbTransaction? transaction,
string query,
IDictionary<string, object?>? parameters = null,
CancellationToken cancellationToken = default,
IDictionary<string, DbType>? parameterTypes = null,
IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
async Task<int> ExecuteOperationAsync()
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var affected = await command.ExecuteNonQueryAsync(cancellationToken).ConfigureAwait(false);
UpdateOutputParameters(command, parameters);
return affected;
}
if (RetryNonQueryOperations)
{
return await ExecuteWithRetryAsync(ExecuteOperationAsync, cancellationToken).ConfigureAwait(false);
}
return await ExecuteOperationAsync().ConfigureAwait(false);
}
/// <summary>
/// Asynchronously executes a scalar command and returns the first column of the first row.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The command text to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="cancellationToken">Token used to cancel the operation.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <returns>The scalar result.</returns>
protected virtual async Task<object?> ExecuteScalarAsync(DbConnection connection, DbTransaction? transaction, string query, IDictionary<string, object?>? parameters = null, CancellationToken cancellationToken = default, IDictionary<string, DbType>? parameterTypes = null, IDictionary<string, ParameterDirection>? parameterDirections = null)
{
ValidateCommandText(query);
return await ExecuteWithRetryAsync(async () =>
{
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
AddParameters(command, parameters, parameterTypes, parameterDirections);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
var result = await command.ExecuteScalarAsync(cancellationToken).ConfigureAwait(false);
UpdateOutputParameters(command, parameters);
return result;
}, cancellationToken).ConfigureAwait(false);
}
#if NETSTANDARD2_1_OR_GREATER || NETCOREAPP3_0_OR_GREATER
/// <summary>
/// Asynchronously executes a query and streams rows using <see cref="IAsyncEnumerable{T}"/>.
/// </summary>
/// <param name="connection">The open database connection.</param>
/// <param name="transaction">The transaction to enlist in, if any.</param>
/// <param name="query">The query to execute.</param>
/// <param name="parameters">Optional parameter values.</param>
/// <param name="cancellationToken">Token used to cancel the iteration.</param>
/// <param name="parameterTypes">Optional parameter types.</param>
/// <param name="parameterDirections">Optional parameter directions.</param>
/// <param name="dbParameters">Provider-specific parameters to attach directly to the command.</param>
/// <param name="commandType">Command type to use (Text or StoredProcedure).</param>
/// <returns>An asynchronous stream of <see cref="DataRow"/> instances.</returns>
protected virtual async IAsyncEnumerable<DataRow> ExecuteQueryStreamAsync(
DbConnection connection,
DbTransaction? transaction,
string query,
IDictionary<string, object?>? parameters = null,
[EnumeratorCancellation] CancellationToken cancellationToken = default,
IDictionary<string, DbType>? parameterTypes = null,
IDictionary<string, ParameterDirection>? parameterDirections = null,
IEnumerable<DbParameter>? dbParameters = null,
CommandType commandType = CommandType.Text)
{
ValidateCommandText(query, commandType);
var maxAttempts = MaxRetryAttempts < 1 ? 1 : MaxRetryAttempts;
var attempt = 0;
using var command = connection.CreateCommand();
command.CommandText = query;
command.Transaction = transaction;
command.CommandType = commandType;
AddParameters(command, parameters, parameterTypes, parameterDirections);
AddParameters(command, dbParameters);
var commandTimeout = CommandTimeout;
if (commandTimeout > 0)
{
command.CommandTimeout = commandTimeout;
}
async Task<DbDataReader> OpenReaderAsync()
{
while (true)
{
try
{
return await command.ExecuteReaderAsync(CommandBehavior.SequentialAccess, cancellationToken).ConfigureAwait(false);
}
catch (Exception ex) when (IsTransient(ex) && ++attempt < maxAttempts)
{
var delay = ComputeBackoffDelay(attempt);
if (delay > TimeSpan.Zero)
{