Add basic support for Oracle

fabien.menager · fabien.menager · commit 4ce4dfa7592f · 2025-06-01T19:05:48.000+02:00
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # PhenX.EntityFrameworkCore.BulkInsert
 
-A high-performance, provider-agnostic bulk insert extension for Entity Framework Core 8+. Supports SQL Server, PostgreSQL, SQLite and MySQL.
+A high-performance, provider-agnostic bulk insert extension for Entity Framework Core 8+. Supports SQL Server, PostgreSQL, SQLite, MySQL and Oracle.
 
 Its main purpose is to provide a fast way to perform simple bulk inserts in Entity Framework Core applications.
 
@@ -21,6 +21,7 @@ but they are in [the roadmap](#roadmap).
 | `PhenX.EntityFrameworkCore.BulkInsert.PostgreSql` | For PostgreSQL | [![NuGet](https://img.shields.io/nuget/v/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql.svg)](https://www.nuget.org/packages/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql) |
 | `PhenX.EntityFrameworkCore.BulkInsert.Sqlite`     | For SQLite     | [![NuGet](https://img.shields.io/nuget/v/PhenX.EntityFrameworkCore.BulkInsert.Sqlite.svg)](https://www.nuget.org/packages/PhenX.EntityFrameworkCore.BulkInsert.Sqlite)         |
 | `PhenX.EntityFrameworkCore.BulkInsert.MySql`      | For MySql      | [![NuGet](https://img.shields.io/nuget/v/PhenX.EntityFrameworkCore.BulkInsert.Sqlite.svg)](https://www.nuget.org/packages/PhenX.EntityFrameworkCore.BulkInsert.MySql)          |
+| `PhenX.EntityFrameworkCore.BulkInsert.Oracle`     | For Oracle      | [![NuGet](https://img.shields.io/nuget/v/PhenX.EntityFrameworkCore.BulkInsert.Oracle.svg)](https://www.nuget.org/packages/PhenX.EntityFrameworkCore.BulkInsert.Oracle)         |
 | `PhenX.EntityFrameworkCore.BulkInsert`            | Common library | [![NuGet](https://img.shields.io/nuget/v/PhenX.EntityFrameworkCore.BulkInsert.svg)](https://www.nuget.org/packages/PhenX.EntityFrameworkCore.BulkInsert)                       |
 
 ## Installation
@@ -39,6 +40,9 @@ Install-Package PhenX.EntityFrameworkCore.BulkInsert.Sqlite
 
 # For MySql
 Install-Package PhenX.EntityFrameworkCore.BulkInsert.MySql
+
+# For Oracle
+Install-Package PhenX.EntityFrameworkCore.BulkInsert.Oracle
 ```
 
 ## Usage
@@ -58,6 +62,8 @@ services.AddDbContext<MyDbContext>(options =>
         .UseBulkInsertSqlite()
         // OR
         .UseBulkInsertMySql()
+        // OR
+        .UseBulkInsertOracle()
         ;
 });
 ```
@@ -148,6 +154,10 @@ MySQL results with 500 000 rows :
 
 ![bench-mysql.png](https://raw.githubusercontent.com/PhenX/PhenX.EntityFrameworkCore.BulkInsert/refs/heads/main/images/bench-mysql.png)
 
+Oracle results with 500 000 rows :
+
+![bench-oracle.png](https://raw.githubusercontent.com/PhenX/PhenX.EntityFrameworkCore.BulkInsert/refs/heads/main/images/bench-oracle.png)
+
 ## Contributing
 
 Contributions are welcome! Please open issues or submit pull requests for bug fixes, features, or documentation improvements.
diff --git a/images/bench-oracle.png b/images/bench-oracle.png
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleBulkInsertProvider.cs b/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleBulkInsertProvider.cs
@@ -6,25 +6,40 @@
 using Oracle.ManagedDataAccess.Client;
 
 using PhenX.EntityFrameworkCore.BulkInsert.Metadata;
+using PhenX.EntityFrameworkCore.BulkInsert.Options;
 
 namespace PhenX.EntityFrameworkCore.BulkInsert.Oracle;
 
 [UsedImplicitly]
 internal class OracleBulkInsertProvider(ILogger<OracleBulkInsertProvider>? logger) : BulkInsertProviderBase<OracleDialectBuilder, OracleBulkInsertOptions>(logger)
 {
-    //language=sql
     /// <inheritdoc />
-    protected override string AddTableCopyBulkInsertId => $"ALTER TABLE {{0}} ADD {BulkInsertId} INT IDENTITY PRIMARY KEY;";
+    protected override string BulkInsertId => "ROWID";
 
     /// <inheritdoc />
-    protected override string GetTempTableName(string tableName) => $"#_temp_bulk_insert_{tableName}";
+    protected override string AddTableCopyBulkInsertId => ""; // No need to add an ID column in Oracle
+
+    /// <inheritdoc />
+    protected override string GetTempTableName(string tableName) => $"#temp_bulk_insert_{Guid.NewGuid().ToString("N")[..8]}";
 
     protected override OracleBulkInsertOptions CreateDefaultOptions() => new()
     {
         BatchSize = 50_000,
-        Converters = [OracleGeometryConverter.Instance]
     };
 
+    /// <inheritdoc />
+    protected override IAsyncEnumerable<T> BulkInsertReturnEntities<T>(
+        bool sync,
+        DbContext context,
+        TableMetadata tableInfo,
+        IEnumerable<T> entities,
+        OracleBulkInsertOptions options,
+        OnConflictOptions<T>? onConflict,
+        CancellationToken ctk)
+    {
+        throw new NotSupportedException("Provider does not support returning entities.");
+    }
+
     /// <inheritdoc />
     protected override Task BulkInsert<T>(
         bool sync,
@@ -40,7 +55,7 @@ protected override Task BulkInsert<T>(
 
         using var bulkCopy = new OracleBulkCopy(connection, options.CopyOptions);
 
-        bulkCopy.DestinationTableName = tableName;
+        bulkCopy.DestinationTableName = tableInfo.QuotedTableName;
         bulkCopy.BatchSize = options.BatchSize;
         bulkCopy.BulkCopyTimeout = options.GetCopyTimeoutInSeconds();
 
@@ -55,4 +70,10 @@ protected override Task BulkInsert<T>(
 
         return Task.CompletedTask;
     }
+
+    /// <inheritdoc />
+    protected override Task DropTempTableAsync(bool sync, DbContext dbContext, string tableName)
+    {
+        return ExecuteAsync(sync, dbContext, $"DROP TABLE IF EXISTS {tableName}", default);
+    }
 }
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleDialectBuilder.cs b/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleDialectBuilder.cs
@@ -44,11 +44,6 @@ public override string BuildMoveDataSql<T>(
     {
         var q = new StringBuilder();
 
-        if (options.CopyGeneratedColumns)
-        {
-            q.AppendLine($"SET IDENTITY_INSERT {target.QuotedTableName} ON;");
-        }
-
         // Merge handling
         if (onConflict is OnConflictOptions<T> onConflictTyped)
         {
@@ -109,28 +104,24 @@ public override string BuildMoveDataSql<T>(
             q.Append($"INSERT INTO {target.QuotedTableName} (");
             q.AppendColumns(insertedColumns);
             q.AppendLine(")");
-
-            if (returnedColumns.Count != 0)
-            {
-                q.Append("OUTPUT ");
-                q.AppendJoin(", ", returnedColumns, (b, col) => b.Append($"INSERTED.{col.QuotedColumName} AS {col.QuotedColumName}"));
-                q.AppendLine();
-            }
-
             q.Append("SELECT ");
             q.AppendColumns(insertedColumns);
             q.AppendLine();
             q.Append($"FROM {source}");
             q.AppendLine();
+
+            if (returnedColumns.Count != 0)
+            {
+                q.Append("RETURNING ");
+                q.AppendJoin(", ", returnedColumns, (b, col) => b.Append(col.QuotedColumName));
+                q.Append(" INTO ");
+                q.AppendJoin(", ", returnedColumns, (b, col) => b.Append($":{col.ColumnName}"));
+                q.AppendLine();
+            }
         }
 
         q.AppendLine(";");
 
-        if (options.CopyGeneratedColumns)
-        {
-            q.AppendLine($"SET IDENTITY_INSERT {target.QuotedTableName} OFF;");
-        }
-
         var result = q.ToString();
         return result;
     }
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleGeometryConverter.cs b/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/OracleGeometryConverter.cs
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/PhenX.EntityFrameworkCore.BulkInsert.Oracle.csproj b/src/PhenX.EntityFrameworkCore.BulkInsert.Oracle/PhenX.EntityFrameworkCore.BulkInsert.Oracle.csproj
@@ -5,7 +5,6 @@
     </ItemGroup>
 
     <ItemGroup>
-      <PackageReference Include="NetTopologySuite" Version="2.6.0" />
       <PackageReference Include="Oracle.EntityFrameworkCore" Condition="'$(TargetFramework)' == 'net8.0'" Version="8.23.80" />
       <PackageReference Include="Oracle.EntityFrameworkCore" Condition="'$(TargetFramework)' == 'net9.0'" Version="9.23.80" />
     </ItemGroup>
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert.Sqlite/SqliteBulkInsertProvider.cs b/src/PhenX.EntityFrameworkCore.BulkInsert.Sqlite/SqliteBulkInsertProvider.cs
@@ -24,7 +24,7 @@ internal class SqliteBulkInsertProvider(ILogger<SqliteBulkInsertProvider>? logge
     protected override string AddTableCopyBulkInsertId => "--"; // No need to add an ID column in SQLite
 
     /// <inheritdoc />
-    protected override string GetTempTableName(string tableName) => $"_temp_bulk_insert_test_entity_{Guid.NewGuid():N}";
+    protected override string GetTempTableName(string tableName) => $"_temp_bulk_insert_{Guid.NewGuid():N}";
 
     /// <inheritdoc />
     protected override BulkInsertOptions CreateDefaultOptions() => new()
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert/BulkInsertProviderBase.cs b/src/PhenX.EntityFrameworkCore.BulkInsert/BulkInsertProviderBase.cs
@@ -185,6 +185,12 @@ protected virtual async Task AddBulkInsertIdColumn<T>(
         string tempTableName,
         CancellationToken ctk) where T : class
     {
+        if (string.IsNullOrEmpty(AddTableCopyBulkInsertId))
+        {
+            // No need to add an ID column in this provider
+            return;
+        }
+
         var alterQuery = string.Format(AddTableCopyBulkInsertId, tempTableName);
 
         await ExecuteAsync(sync, context, alterQuery, ctk);
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert/Enums/ProviderType.cs b/src/PhenX.EntityFrameworkCore.BulkInsert/Enums/ProviderType.cs
@@ -24,4 +24,9 @@ public enum ProviderType
     /// MySQL provider.
     /// </summary>
     MySql,
+
+    /// <summary>
+    /// Oracle provider.
+    /// </summary>
+    Oracle,
 }
diff --git a/src/PhenX.EntityFrameworkCore.BulkInsert/Extensions/InternalExtensions.cs b/src/PhenX.EntityFrameworkCore.BulkInsert/Extensions/InternalExtensions.cs
@@ -74,13 +74,13 @@ internal static async Task<ConnectionInfo> GetConnection(
     /// <summary>
     /// Tells if the current provider is the specified provider type.
     /// </summary>
-    internal static bool IsProvider(this DbContext context, ProviderType providerType)
+    internal static bool IsProvider(this DbContext context, params ProviderType[] providerType)
     {
         if (context.Database.ProviderName == null)
         {
             throw new InvalidOperationException("Database provider name is null.");
         }
 
-        return context.Database.ProviderName.Contains(providerType.ToString(), StringComparison.OrdinalIgnoreCase);
+        return providerType.Any(p => context.Database.ProviderName.Contains(p.ToString(), StringComparison.OrdinalIgnoreCase));
     }
 }
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Benchmark/GetValueComparator.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Benchmark/GetValueComparator.cs
@@ -30,7 +30,7 @@ public void IterationSetup()
 
     private static Dictionary<string, Expression<Func<object?, object?>>> Converters = new()
     {
-        { nameof(TestEntity.NumericEnumValue), v => (int) v},
+        { nameof(TestEntity.NumericEnumValue), v => (int) (v ?? 0)},
     };
 
     private static readonly PropertyInfo[] PropertyInfos = typeof(TestEntity).GetProperties();
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Benchmark/Program.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Benchmark/Program.cs
@@ -14,7 +14,7 @@ public static void Main(string[] args)
             .WithOptions(ConfigOptions.DisableOptimizationsValidator);
 
         // Micro benchmark for value getters
-        BenchmarkRunner.Run<GetValueComparator>(config);
+        // BenchmarkRunner.Run<GetValueComparator>(config);
 
         // Library comparison benchmarks
         var comparators = new[]
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/DbContainer/TestDbContainerOracle.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/DbContainer/TestDbContainerOracle.cs
@@ -2,8 +2,6 @@
 
 using Microsoft.EntityFrameworkCore;
 
-using Oracle.ManagedDataAccess.Client;
-
 using PhenX.EntityFrameworkCore.BulkInsert.Oracle;
 
 using Testcontainers.Oracle;
@@ -23,6 +21,7 @@ public class TestDbContainerOracle : TestDbContainer
     protected override IDatabaseContainer? GetDbContainer()
     {
         return new OracleBuilder()
+            .WithImage("gvenzl/oracle-free:23-slim-faststart")
             .WithReuse(true)
             .Build();
     }
@@ -44,20 +43,8 @@ protected override string GetConnectionString(string databaseName)
             return string.Empty;
         }
 
-        var builder = new OracleConnectionStringBuilder
-        {
-            ConnectionString = DbContainer.GetConnectionString(),
-            DataSource = databaseName,
-        };
-
-        return builder.ToString();
-    }
-
-    protected override async Task EnsureConnectedAsync<TDbContext>(TDbContext context, string databaseName)
-    {
-        var container = (OracleContainer)DbContainer!;
+        var port = DbContainer.GetMappedPublicPort(1521);
 
-        await container.ExecScriptAsync($"CREATE DATABASE \"{databaseName}\";");
-        await base.EnsureConnectedAsync(context, databaseName);
+        return $"Data Source=(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = localhost)(PORT = {port})) ) (CONNECT_DATA = (SERVICE_NAME = FREEPDB1) ) );User ID=oracle;Password=oracle";
     }
 }
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/DbContext/TestEntity.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/DbContext/TestEntity.cs
@@ -22,9 +22,9 @@ public class TestEntity : TestEntityBase
     [Column("the_identifier")]
     public Guid Identifier { get; set; }
 
-    [Column("string_enum_value", TypeName = "text")]
+    [Column("string_enum_value")]
     public StringEnum StringEnumValue { get; set; }
 
-    [Column("num_enum_value", TypeName = "text")]
+    [Column("num_enum_value")]
     public NumericEnum NumericEnumValue { get; set; }
 }
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/TestHelpers.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/TestHelpers.cs
@@ -27,7 +27,12 @@ public static async Task<List<T>> InsertWithStrategyAsync<T>(
         OnConflictOptions<T>? onConflict = null)
         where T : TestEntityBase
     {
-        Skip.If(strategy is InsertStrategy.InsertReturn or InsertStrategy.InsertReturnAsync && dbContext.IsProvider(ProviderType.MySql));
+        ProviderType[] returningNotSupported = [
+            ProviderType.MySql,
+            ProviderType.Oracle,
+        ];
+
+        Skip.If(strategy is InsertStrategy.InsertReturn or InsertStrategy.InsertReturnAsync && dbContext.IsProvider(returningNotSupported));
 
         var runId = Guid.NewGuid();
         if (entities.Any(x => x.TestRun == default))
diff --git a/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/Tests/Basic/BasicTestsBase.cs b/tests/PhenX.EntityFrameworkCore.BulkInsert.Tests/Tests/Basic/BasicTestsBase.cs
@@ -69,7 +69,7 @@ public async Task InsertEntities_WithJson(InsertStrategy strategy)
     [SkippableFact]
     public async Task InsertEntities_AndReturn_AsyncEnumerable()
     {
-        Skip.If(_context.IsProvider(ProviderType.MySql));
+        Skip.If(_context.IsProvider(ProviderType.MySql, ProviderType.Oracle));
 
         // Arrange
         var entities = new List<TestEntity>

Original file line number	Diff line number	Diff line change
`@@ -74,13 +74,13 @@ internal static async Task<ConnectionInfo> GetConnection(`
`74`	`74`	`/// <summary>`
`75`	`75`	`/// Tells if the current provider is the specified provider type.`
`76`	`76`	`/// </summary>`
`77`		`- internal static bool IsProvider(this DbContext context, ProviderType providerType)`
	`77`	`+ internal static bool IsProvider(this DbContext context, params ProviderType[] providerType)`
`78`	`78`	`{`
`79`	`79`	`if (context.Database.ProviderName == null)`
`80`	`80`	`{`
`81`	`81`	`throw new InvalidOperationException("Database provider name is null.");`
`82`	`82`	`}`
`83`	`83`
`84`		`- return context.Database.ProviderName.Contains(providerType.ToString(), StringComparison.OrdinalIgnoreCase);`
	`84`	`+ return providerType.Any(p => context.Database.ProviderName.Contains(p.ToString(), StringComparison.OrdinalIgnoreCase));`
`85`	`85`	`}`
`86`	`86`	`}`