v0.2.3

Author: ivanvoyager

src/NuExt.System.Data.csproj

@@ -16,7 +16,7 @@ System.Data.DataTableExtensions
 System.Data.DalBase
 System.Data.DbConverter<TDbConnection>
 System.Data.IDbContext</Description>
-    <Version>0.2.2</Version>
+    <Version>0.2.3</Version>
     <RootNamespace />
     <GenerateDocumentationFile>True</GenerateDocumentationFile>
     <NoWarn>$(NoWarn);1591</NoWarn>

src/System/Data/DbConverter.cs

@@ -23,26 +23,29 @@ public abstract class DbConverter<TDbConnection> where TDbConnection : IDbConnec
         /// Retrieves the current version of the database schema from the specified database connection.
         /// </summary>
         /// <param name="connection">The database connection to use for retrieving the version.</param>
+        /// <param name="cancellationToken">Cancellation token to cancel the execution.</param>
         /// <returns>The current version of the database schema.</returns>
-        public abstract Version GetDbVersion(TDbConnection connection);
+        public abstract Version GetDbVersion(TDbConnection connection, CancellationToken cancellationToken);
 
         /// <summary>
         /// Determines whether the database requires an update to match the version specified by this converter.
         /// </summary>
         /// <param name="connection">The database connection to check.</param>
+        /// <param name="cancellationToken">Cancellation token to cancel the execution.</param>
         /// <returns><c>true</c> if the database requires an update; otherwise, <c>false</c>.</returns>
-        public virtual bool RequiresUpdate(TDbConnection connection)
+        public virtual bool RequiresUpdate(TDbConnection connection, CancellationToken cancellationToken)
         {
-            Version dbVersion = GetDbVersion(connection);
+            Version dbVersion = GetDbVersion(connection, cancellationToken);
             return dbVersion < Version;
         }
 
         /// <summary>
         /// Applies the necessary updates to the database to bring it in line with the version specified by this converter.
         /// </summary>
         /// <param name="connection">The database connection to update.</param>
+        /// <param name="cancellationToken">Cancellation token to cancel the execution.</param>
         /// <returns><c>true</c> if the update was successful; otherwise, <c>false</c>.</returns>
-        public abstract bool Update(TDbConnection connection);
+        public abstract bool Update(TDbConnection connection, CancellationToken cancellationToken);
 
         #endregion
     }

src/System/Data/DbConverterExtensions.cs

@@ -4,7 +4,7 @@ namespace System.Data
 {
     public static class DbConverterExtensions
     {
-        private static void CheckDbVersion<TDbConnection>(TDbConnection connection, Func<TDbConnection, Version> getDbVersion, Version dbVersion) where TDbConnection : IDbConnection
+        private static void CheckDbVersion<TDbConnection>(TDbConnection connection, Func<TDbConnection, CancellationToken, Version> getDbVersion, Version dbVersion, CancellationToken cancellationToken) where TDbConnection : IDbConnection
         {
 #if NET6_0_OR_GREATER
             ArgumentNullException.ThrowIfNull(connection);
@@ -15,14 +15,14 @@ private static void CheckDbVersion<TDbConnection>(TDbConnection connection, Func
             Throw.IfNull(getDbVersion);
             Throw.IfNull(dbVersion);
 #endif
-            var version = getDbVersion(connection);
+            var version = getDbVersion(connection, cancellationToken);
             if (version > dbVersion)
             {
                 throw new DataException("File created in a later version of the program. Install the new version to open this file.");
             }
         }
 
-        public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, IDbContext context) where TDbConnection : IDbConnection
+        public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, IDbContext context, CancellationToken cancellationToken) where TDbConnection : IDbConnection
         {
 #if NET6_0_OR_GREATER
             ArgumentNullException.ThrowIfNull(converters);
@@ -31,10 +31,10 @@ public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbC
             Throw.IfNull(converters);
             Throw.IfNull(context);
 #endif
-            converters.Initialize((TDbConnection)context.Connection);
+            converters.Initialize((TDbConnection)context.Connection, cancellationToken);
         }
 
-        public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection) where TDbConnection : IDbConnection
+        public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection, CancellationToken cancellationToken) where TDbConnection : IDbConnection
         {
 #if NET6_0_OR_GREATER
             ArgumentNullException.ThrowIfNull(converters);
@@ -57,15 +57,15 @@ public static void Initialize<TDbConnection>(this IReadOnlyList<DbConverter<TDbC
 #else
                 var dbVersion = converters[^1].Version;
 #endif
-                if (converters.RequiresUpdate(connection))
+                if (converters.RequiresUpdate(connection, cancellationToken))
                 {
-                    bool result = converters.Update(connection, dbVersion);
+                    bool result = converters.Update(connection, dbVersion, cancellationToken);
                     Debug.Assert(result);
                 }
 #if NETFRAMEWORK || NETSTANDARD2_0
-                CheckDbVersion(connection, converters[converters.Count - 1].GetDbVersion, dbVersion);
+                CheckDbVersion(connection, converters[converters.Count - 1].GetDbVersion, dbVersion, cancellationToken);
 #else
-                CheckDbVersion(connection, converters[^1].GetDbVersion, dbVersion);
+                CheckDbVersion(connection, converters[^1].GetDbVersion, dbVersion, cancellationToken);
 #endif
             }
             catch (Exception ex)
@@ -88,7 +88,7 @@ private static bool IsOrderedByAscending<TDbConnection>(this IReadOnlyList<DbCon
             return true;
         }
 
-        private static bool RequiresUpdate<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection) where TDbConnection : IDbConnection
+        private static bool RequiresUpdate<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection, CancellationToken cancellationToken) where TDbConnection : IDbConnection
         {
 #if NET6_0_OR_GREATER
             ArgumentNullException.ThrowIfNull(converters);
@@ -104,14 +104,14 @@ private static bool RequiresUpdate<TDbConnection>(this IReadOnlyList<DbConverter
 #else
                 converters[^1]
 #endif
-                .RequiresUpdate(connection))
+                .RequiresUpdate(connection, cancellationToken))
             {
                 return true;
             }
             return false;
         }
 
-        private static bool Update<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection, Version dbVersion, bool forceUpdate = false) where TDbConnection : IDbConnection
+        private static bool Update<TDbConnection>(this IReadOnlyList<DbConverter<TDbConnection>> converters, TDbConnection connection, Version dbVersion, CancellationToken cancellationToken) where TDbConnection : IDbConnection
         {
             Debug.Assert(converters != null);
             Debug.Assert(connection is { State: ConnectionState.Open });
@@ -120,9 +120,9 @@ private static bool Update<TDbConnection>(this IReadOnlyList<DbConverter<TDbConn
             Version? latestVersion = null;
             foreach (var converter in converters!)
             {
-                if (forceUpdate || converter.RequiresUpdate(connection))
+                if (/*forceUpdate || */converter.RequiresUpdate(connection, cancellationToken))
                 {
-                    bool updated = converter.Update(connection);
+                    bool updated = converter.Update(connection, cancellationToken);
                     Debug.Assert(updated);
                     if (!updated)
                     {