MicrosoftSQL.BulkInsert - Added column mapping feature

Frends.MicrosoftSQL.BulkInsert/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [3.0.0] - 2025-01-15
+### Added
+- [Breaking] Added parameters ColumnMapping and ManualColumnMapping.
+- Added column mapping feature which allows user to select from JsonPropertyNames, JsonPropertyOrder and ManualColumnMapping options how the column mapping is handled in bulk insert. Default behavior will remain the same JsonPropertyOrder.
+
 ## [2.2.0] - 2024-09-10
 ### Changed
 - Updated Options.NotifyAfter property to be set dynamically based on the total row count, with a minimum value of 1, ensuring rowsCopied is updated correctly.

Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert.Tests/UnitTests.cs

@@ -420,6 +420,64 @@ public async Task TestBulkInsert_NotifyAfterOne()
         }
     }
 
+    [TestMethod]
+    public async Task TestBulkInsert_ColumnMapping()
+    {
+        var columnMappings = new List<ColumnMapping>()
+        {
+            ColumnMapping.JsonPropertyOrder,
+            ColumnMapping.JsonPropertyNames,
+            ColumnMapping.ManualColumnMapping
+        };
+
+        var options = new Options()
+        {
+            SqlTransactionIsolationLevel = SqlTransactionIsolationLevel.ReadCommitted,
+            CommandTimeoutSeconds = 60,
+            FireTriggers = false,
+            KeepIdentity = true,
+            NotifyAfter = 0,
+            ConvertEmptyPropertyValuesToNull = true,
+            KeepNulls = false,
+            TableLock = false,
+        };
+
+        var json = @"[
+                  {
+                    ""Id"": 1,
+                    ""FirstName"": ""Etu"",
+                    ""LastName"": ""Suku""
+                  },
+                  {
+                    ""Id"": 2,
+                    ""LastName"": ""Suku"",
+                    ""FirstName"": ""Etu""
+                  },
+                  {
+                    ""FirstName"": ""First"",
+                    ""LastName"": ""Last"",
+                    ""Id"": 3
+                  }
+                ]";
+
+        var manualMapping = @"{ ""Id"":""Id"", ""FirstName"": ""FirstName"", ""LastName"": ""LastName"" }";
+
+        foreach (var columnMapping in columnMappings)
+        {
+            var input = new Input
+            {
+                ConnectionString = _connString,
+                TableName = _tableName,
+                InputData = json,
+                ColumnMapping = columnMapping,
+                ManualColumnMapping = manualMapping
+            };
+
+            var result = await MicrosoftSQL.BulkInsert(input, options, default);
+            Assert.IsTrue(result.Success);
+        }
+    }
+
     private static int GetRowCount()
     {
         using var connection = new SqlConnection(_connString);

Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/BulkInsert.cs

@@ -1,12 +1,11 @@
 using Frends.MicrosoftSQL.BulkInsert.Definitions;
 using Microsoft.Data.SqlClient;
+using Microsoft.IdentityModel.Abstractions;
 using Newtonsoft.Json.Linq;
 using System;
 using System.ComponentModel;
 using System.Data;
 using System.Linq;
-using System.Reflection;
-using System.Runtime.Loader;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -17,15 +16,6 @@ namespace Frends.MicrosoftSQL.BulkInsert;
 /// </summary>
 public class MicrosoftSQL
 {
-    /// Mem cleanup.
-    static MicrosoftSQL()
-    {
-        var currentAssembly = Assembly.GetExecutingAssembly();
-        var currentContext = AssemblyLoadContext.GetLoadContext(currentAssembly);
-        if (currentContext != null)
-            currentContext.Unloading += OnPluginUnloadingRequested;
-    }
-
     /// <summary>
     /// Execute bulk insert JSON data to Microsoft SQL Server.
     /// [Documentation](https://tasks.frends.com/tasks/frends-tasks/Frends.MicrosoftSQL.BulkInsert)
@@ -57,7 +47,7 @@ public static async Task<Result> BulkInsert([PropertyTab] Input input, [Property
             {
                 try
                 {
-                    var result = await ExecuteHandler(options, input.TableName, dataSet, new SqlBulkCopy(connection, GetSqlBulkCopyOptions(options), null), cancellationToken);
+                    var result = await ExecuteHandler(options, input, dataSet, new SqlBulkCopy(connection, GetSqlBulkCopyOptions(options), null), cancellationToken);
                     return new Result(true, result, null);
                 }
                 catch (Exception ex)
@@ -74,7 +64,7 @@ public static async Task<Result> BulkInsert([PropertyTab] Input input, [Property
 
             try
             {
-                var result = await ExecuteHandler(options, input.TableName, dataSet, new SqlBulkCopy(connection, GetSqlBulkCopyOptions(options), transaction), cancellationToken);
+                var result = await ExecuteHandler(options, input, dataSet, new SqlBulkCopy(connection, GetSqlBulkCopyOptions(options), transaction), cancellationToken);
                 await transaction.CommitAsync(cancellationToken);
                 return new Result(true, result, null);
             }
@@ -111,15 +101,29 @@ public static async Task<Result> BulkInsert([PropertyTab] Input input, [Property
         }
     }
 
-    private static async Task<long> ExecuteHandler(Options options, string tableName, DataSet dataSet, SqlBulkCopy sqlBulkCopy, CancellationToken cancellationToken)
+    private static async Task<long> ExecuteHandler(Options options, Input input, DataSet dataSet, SqlBulkCopy sqlBulkCopy, CancellationToken cancellationToken)
     {
         var rowsCopied = 0L;
+
+        // JsonPropertyOrder is handled implicitly (default behavior) by not adding any column mappings,
+        // which means the columns will be mapped based on their order in the input JSON.
+        if (input.ColumnMapping == ColumnMapping.JsonPropertyNames)
+        {
+            foreach (var column in dataSet.Tables[0].Columns)
+                sqlBulkCopy.ColumnMappings.Add(new SqlBulkCopyColumnMapping(column.ToString(), column.ToString()));
+        }
+        else if (input.ColumnMapping == ColumnMapping.ManualColumnMapping)
+        {
+            foreach (var column in JObject.Parse(input.ManualColumnMapping).Properties())
+                sqlBulkCopy.ColumnMappings.Add(new SqlBulkCopyColumnMapping(column.Name, column.Name));
+        }
+
         try
         {
             using (sqlBulkCopy)
             {
                 sqlBulkCopy.BulkCopyTimeout = options.CommandTimeoutSeconds;
-                sqlBulkCopy.DestinationTableName = tableName;
+                sqlBulkCopy.DestinationTableName = input.TableName;
                 sqlBulkCopy.SqlRowsCopied += (s, e) => rowsCopied = e.RowsCopied;
 
                 if (options.NotifyAfter == 0)
@@ -189,9 +193,4 @@ private static IsolationLevel GetIsolationLevel(Options options)
             _ => IsolationLevel.ReadCommitted,
         };
     }
-
-    private static void OnPluginUnloadingRequested(AssemblyLoadContext obj)
-    {
-        obj.Unloading -= OnPluginUnloadingRequested;
-    }
 }

Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Definitions/ColumnMapping.cs

@@ -0,0 +1,22 @@
+namespace Frends.MicrosoftSQL.BulkInsert.Definitions;
+
+/// <summary>
+/// Selection of column mapping options for bulk insert.
+/// </summary>
+public enum ColumnMapping
+{
+    /// <summary>
+    /// Column mapping is disabled and the bulk insert will insert the data based on the order of the properties in input JSON.
+    /// </summary>
+    JsonPropertyOrder,
+
+    /// <summary>
+    /// Input JSON property names will be used with bulk insert to create column mapping. Column mapping is case sensitive.
+    /// </summary>
+    JsonPropertyNames,
+
+    /// <summary>
+    /// Manual column mapping JSON will be used with bulk insert to create column mapping. Column mapping is case sensitive.
+    /// </summary>
+    ManualColumnMapping,
+}

Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Definitions/Input.cs

@@ -22,6 +22,27 @@ public class Input
     /// <example>TestTable</example>
     public string TableName { get; set; }
 
+    /// <summary>
+    /// Selection for column mapping operation.
+    /// </summary>
+    /// <example>ColumnMapping.JsonPropertyNames</example>
+    [DefaultValue(ColumnMapping.JsonPropertyOrder)]
+    public ColumnMapping ColumnMapping { get; set; }
+
+    /// <summary>
+    /// Column mapping JSON for manual column mapping.
+    /// JSON property cannot be a nested one. Only top level properties are supported.
+    /// </summary>
+    /// <example>
+    /// {
+    ///     "json_property_1": "db_column_1",
+    ///     "json_property_2": "db_column_2",
+    ///     "json_property_3": "db_column_3"
+    /// }
+    /// </example>
+    [UIHint(nameof(ColumnMapping), "", ColumnMapping.ManualColumnMapping)]
+    public string ManualColumnMapping { get; set; }
+
     /// <summary>
     /// Json Array of objects. All object property names need to match with the destination table column names.
     /// </summary>

Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert/Frends.MicrosoftSQL.BulkInsert.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
 	<TargetFrameworks>net6.0</TargetFrameworks>
-	<Version>2.2.0</Version>
+	<Version>3.0.0</Version>
 	<Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>