Geo support (#34)

* Temp

* Geometry support.

* Fix providers

* Remove  nettopoloy for sqlite for now.

* Try to install sqlite spatial.

* Seperate tests for geo stuff.

* Remove spatial.

* Another test

* Another test

* Fix fixtures.

* Fix provider.

* Easier fixture.

* Test

* Fix dependencies.

Author: SebastianStehle

.github/workflows/dotnet-test.yml

@@ -16,17 +16,22 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
     - name: Setup .NET 8.0
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 8.0.x
+
     - name: Setup .NET 9.0
       uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 9.0.x
+
     - name: Restore dependencies
       run: dotnet restore
+
     - name: Build
       run: dotnet build --no-restore
+
     - name: Test
       run: dotnet test --no-build --verbosity normal

src/PhenX.EntityFrameworkCore.BulkInsert.MySql/MySqlBulkInsertProvider.cs

@@ -22,7 +22,10 @@ internal class MySqlBulkInsertProvider(ILogger<MySqlBulkInsertProvider> logger)
     protected override string GetTempTableName(string tableName) => $"#_temp_bulk_insert_{tableName}";
 
     /// <inheritdoc />
-    protected override MySqlBulkInsertOptions CreateDefaultOptions() => new();
+    protected override MySqlBulkInsertOptions CreateDefaultOptions() => new()
+    {
+        Converters = [MySqlGeometryConverter.Instance]
+    };
 
     /// <inheritdoc />
     protected override IAsyncEnumerable<T> BulkInsertReturnEntities<T>(
@@ -71,11 +74,11 @@ CancellationToken ctk
         if (sync)
         {
             // ReSharper disable once MethodHasAsyncOverloadWithCancellation
-            bulkCopy.WriteToServer(new EnumerableDataReader<T>(entities, properties));
+            bulkCopy.WriteToServer(new EnumerableDataReader<T>(entities, properties, options.Converters));
         }
         else
         {
-            await bulkCopy.WriteToServerAsync(new EnumerableDataReader<T>(entities, properties), ctk);
+            await bulkCopy.WriteToServerAsync(new EnumerableDataReader<T>(entities, properties, options.Converters), ctk);
         }
     }
 }

src/PhenX.EntityFrameworkCore.BulkInsert.MySql/MySqlGeometryConverter.cs

@@ -0,0 +1,28 @@
+using MySqlConnector;
+
+using NetTopologySuite.Geometries;
+
+using PhenX.EntityFrameworkCore.BulkInsert.Abstractions;
+
+namespace PhenX.EntityFrameworkCore.BulkInsert.MySql;
+
+internal sealed class MySqlGeometryConverter : IBulkValueConverter
+{
+    public static readonly MySqlGeometryConverter Instance = new();
+
+    private MySqlGeometryConverter()
+    {
+    }
+
+    public bool TryConvertValue(object source, out object result)
+    {
+        if (source is Geometry geometry)
+        {
+            result = MySqlGeometry.FromWkb(geometry.SRID, geometry.ToBinary());
+            return true;
+        }
+
+        result = source;
+        return false;
+    }
+}

src/PhenX.EntityFrameworkCore.BulkInsert.MySql/PhenX.EntityFrameworkCore.BulkInsert.MySql.csproj

@@ -9,6 +9,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="NetTopologySuite" Version="2.6.0" />
     <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Condition="'$(TargetFramework)' == 'net8.0'" Version="8.0.3" />
     <PackageReference Include="Pomelo.EntityFrameworkCore.MySql" Condition="'$(TargetFramework)' == 'net9.0'" Version="9.0.0-preview.3.efcore.9.0.0" />
   </ItemGroup>

src/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql/IPostgresTypeProvider.cs

@@ -0,0 +1,19 @@
+using Microsoft.EntityFrameworkCore.Metadata;
+
+using NpgsqlTypes;
+
+namespace PhenX.EntityFrameworkCore.BulkInsert.PostgreSql;
+
+/// <summary>
+/// Provides the type to write.
+/// </summary>
+public interface IPostgresTypeProvider
+{
+    /// <summary>
+    /// Gets the type of a value before written to the output.
+    /// </summary>
+    /// <param name="property">The source property.</param>
+    /// <param name="result">The result type.</param>
+    /// <returns>Indicates if an object should be written.</returns>
+    bool TryGetType(IProperty property, out NpgsqlDbType result);
+}

src/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql.csproj

@@ -5,6 +5,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <PackageReference Include="NetTopologySuite" Version="2.6.0" />
       <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Condition="'$(TargetFramework)' == 'net8.0'" Version="8.0.11" />
       <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Condition="'$(TargetFramework)' == 'net9.0'" Version="9.0.4" />
     </ItemGroup>

src/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql/PostgreSqlBulkInsertOptions.cs

@@ -0,0 +1,14 @@
+using PhenX.EntityFrameworkCore.BulkInsert.Options;
+
+namespace PhenX.EntityFrameworkCore.BulkInsert.PostgreSql;
+
+/// <summary>
+/// Options specific to SQL Server bulk insert.
+/// </summary>
+public class PostgreSqlBulkInsertOptions : BulkInsertOptions
+{
+    /// <summary>
+    /// A list of type providers.
+    /// </summary>
+    public List<IPostgresTypeProvider>? TypeProviders { get; set; }
+}

src/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql/PostgreSqlBulkInsertProvider.cs

@@ -11,12 +11,11 @@
 using NpgsqlTypes;
 
 using PhenX.EntityFrameworkCore.BulkInsert.Metadata;
-using PhenX.EntityFrameworkCore.BulkInsert.Options;
 
 namespace PhenX.EntityFrameworkCore.BulkInsert.PostgreSql;
 
 [UsedImplicitly]
-internal class PostgreSqlBulkInsertProvider(ILogger<PostgreSqlBulkInsertProvider>? logger) : BulkInsertProviderBase<PostgreSqlDialectBuilder, BulkInsertOptions>(logger)
+internal class PostgreSqlBulkInsertProvider(ILogger<PostgreSqlBulkInsertProvider>? logger) : BulkInsertProviderBase<PostgreSqlDialectBuilder, PostgreSqlBulkInsertOptions>(logger)
 {
     //language=sql
     /// <inheritdoc />
@@ -32,9 +31,11 @@ private static string GetBinaryImportCommand(IReadOnlyList<ColumnMetadata> prope
     }
 
     /// <inheritdoc />
-    protected override BulkInsertOptions CreateDefaultOptions() => new()
+    protected override PostgreSqlBulkInsertOptions CreateDefaultOptions() => new()
     {
         BatchSize = 50_000,
+        Converters = [PostgreSqlGeometryConverter.Instance],
+        TypeProviders = [PostgreSqlGeometryConverter.Instance],
     };
 
     /// <inheritdoc />
@@ -45,7 +46,7 @@ protected override async Task BulkInsert<T>(
         IEnumerable<T> entities,
         string tableName,
         IReadOnlyList<ColumnMetadata> columns,
-        BulkInsertOptions options,
+        PostgreSqlBulkInsertOptions options,
         CancellationToken ctk)
     {
         var connection = (NpgsqlConnection)context.Database.GetDbConnection();
@@ -57,7 +58,7 @@ protected override async Task BulkInsert<T>(
             : await connection.BeginBinaryImportAsync(command, ctk);
 
         // The type mapping can be null for obvious types like string.
-        var columnTypes = columns.Select(GetPostgreSqlType).ToArray();
+        var columnTypes = columns.Select(c => GetPostgreSqlType(c, options)).ToArray();
 
         foreach (var entity in entities)
         {
@@ -74,7 +75,7 @@ protected override async Task BulkInsert<T>(
             var columnIndex = 0;
             foreach (var column in columns)
             {
-                var value = column.GetValue(entity);
+                var value = column.GetValue(entity, options.Converters);
 
                 // Get the actual type, so that the writer can do the conversation to the target type automatically.
                 var type = columnTypes[columnIndex];
@@ -122,8 +123,20 @@ protected override async Task BulkInsert<T>(
         }
     }
 
-    private static NpgsqlDbType? GetPostgreSqlType(ColumnMetadata column)
+    private static NpgsqlDbType? GetPostgreSqlType(ColumnMetadata column, PostgreSqlBulkInsertOptions options)
     {
+        var typeProviders = options.TypeProviders;
+        if (typeProviders is { Count: > 0 }) 
+        {
+            foreach (var typeProvider in typeProviders)
+            {
+                if (typeProvider.TryGetType(column.Property, out var type))
+                {
+                    return type;
+                }
+            }
+        }
+
         var mapping = column.Property.GetRelationalTypeMapping() as NpgsqlTypeMapping;
 
         return mapping?.NpgsqlDbType;

src/PhenX.EntityFrameworkCore.BulkInsert.PostgreSql/PostgreSqlGeometryConverter.cs

@@ -0,0 +1,42 @@
+using Microsoft.EntityFrameworkCore.Metadata;
+
+using NetTopologySuite.Geometries;
+
+using NpgsqlTypes;
+
+using PhenX.EntityFrameworkCore.BulkInsert.Abstractions;
+
+namespace PhenX.EntityFrameworkCore.BulkInsert.PostgreSql;
+
+internal sealed class PostgreSqlGeometryConverter : IBulkValueConverter, IPostgresTypeProvider
+{
+    public static readonly PostgreSqlGeometryConverter Instance = new();
+
+    private PostgreSqlGeometryConverter()
+    {
+    }
+
+    public bool TryConvertValue(object source, out object result)
+    {
+        if (source is Geometry geometry)
+        {
+            result = geometry.ToBinary();
+            return true;
+        }
+
+        result = source;
+        return false;
+    }
+
+    public bool TryGetType(IProperty property, out NpgsqlDbType result)
+    {
+        if (property.ClrType.IsAssignableTo(typeof(Geometry)))
+        {
+            result = NpgsqlDbType.Bytea;
+            return true;
+        }
+
+        result = default;
+        return false;
+    }
+}

src/PhenX.EntityFrameworkCore.BulkInsert.SqlServer/PhenX.EntityFrameworkCore.BulkInsert.SqlServer.csproj

@@ -5,6 +5,8 @@
     </ItemGroup>
 
     <ItemGroup>
+      <PackageReference Include="Microsoft.SqlServer.Types" Version="160.1000.6" />
+      <PackageReference Include="NetTopologySuite" Version="2.6.0" />
       <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Condition="'$(TargetFramework)' == 'net8.0'" Version="8.0.16" />
       <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Condition="'$(TargetFramework)' == 'net9.0'" Version="9.0.5" />
     </ItemGroup>