Port to Npgsql 8.0.0-rc.2 (#21)

.github/workflows/build.yml

@@ -5,6 +5,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v3
       - uses: ankane/setup-postgres@v1
         with:
           database: pgvector_dotnet_test

global.json

@@ -0,0 +1,7 @@
+{
+  "sdk": {
+    "version": "8.0.100-rc.2.23502.2",
+    "rollForward": "latestMajor",
+    "allowPrerelease": "true"
+  }
+}

src/Pgvector.EntityFrameworkCore/Pgvector.EntityFrameworkCore.csproj

@@ -9,7 +9,7 @@
     <PackageProjectUrl>https://github.com/pgvector/pgvector-dotnet</PackageProjectUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
 
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <LangVersion>latest</LangVersion>
@@ -19,7 +19,7 @@
     <None Include="..\..\LICENSE.txt" Pack="true" PackagePath="\" />
     <None Include="..\..\README.md" Pack="true" PackagePath="\" />
     <ProjectReference Include="..\Pgvector\Pgvector.csproj" />
-    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="7" />
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.0-rc.2" />
   </ItemGroup>
 
 </Project>

src/Pgvector.EntityFrameworkCore/VectorTypeMapping.cs

@@ -4,11 +4,11 @@
 
 namespace Pgvector.EntityFrameworkCore;
 
-public class VectorTypeMapping : NpgsqlTypeMapping
+public class VectorTypeMapping : RelationalTypeMapping
 {
-    public VectorTypeMapping(string storeType) : base(storeType, typeof(Vector), NpgsqlDbType.Unknown) { }
+    public VectorTypeMapping(string storeType) : base(storeType, typeof(Vector)) { }
 
-    protected VectorTypeMapping(RelationalTypeMappingParameters parameters) : base(parameters, NpgsqlDbType.Unknown) { }
+    protected VectorTypeMapping(RelationalTypeMappingParameters parameters) : base(parameters) { }
 
     protected override RelationalTypeMapping Clone(RelationalTypeMappingParameters parameters)
         => new VectorTypeMapping(parameters);

src/Pgvector/Npgsql/VectorConverter.cs

@@ -0,0 +1,91 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using Npgsql.Internal;
+
+namespace Pgvector.Npgsql;
+
+public class VectorConverter : PgStreamingConverter<Vector>
+{
+    public override Vector Read(PgReader reader)
+    {
+        if (reader.ShouldBuffer(2 * sizeof(ushort)))
+            reader.Buffer(2 * sizeof(ushort));
+
+        var dim = reader.ReadUInt16();
+        var unused = reader.ReadUInt16();
+        if (unused != 0)
+            throw new InvalidCastException("expected unused to be 0");
+
+        var vec = new float[dim];
+        for (var i = 0; i < dim; i++)
+        {
+            if (reader.ShouldBuffer(sizeof(float)))
+                reader.Buffer(sizeof(float));
+            vec[i] = reader.ReadFloat();
+        }
+
+        return new Vector(vec);
+    }
+
+    public override async ValueTask<Vector> ReadAsync(PgReader reader, CancellationToken cancellationToken = default)
+    {
+        if (reader.ShouldBuffer(2 * sizeof(ushort)))
+            await reader.BufferAsync(2 * sizeof(ushort), cancellationToken).ConfigureAwait(false);
+
+        var dim = reader.ReadUInt16();
+        var unused = reader.ReadUInt16();
+        if (unused != 0)
+            throw new InvalidCastException("expected unused to be 0");
+
+        var vec = new float[dim];
+        for (var i = 0; i < dim; i++)
+        {
+            if (reader.ShouldBuffer(sizeof(float)))
+                await reader.BufferAsync(sizeof(float), cancellationToken).ConfigureAwait(false);
+            vec[i] = reader.ReadFloat();
+        }
+
+        return new Vector(vec);
+    }
+
+    public override Size GetSize(SizeContext context, Vector value, ref object? writeState)
+        => sizeof(ushort) * 2 + sizeof(float) * value.ToArray().Length;
+
+    public override void Write(PgWriter writer, Vector value)
+    {
+        if (writer.ShouldFlush(sizeof(ushort) * 2))
+            writer.Flush();
+
+        var vec = value.ToArray();
+        var dim = vec.Length;
+        writer.WriteUInt16(Convert.ToUInt16(dim));
+        writer.WriteUInt16(0);
+
+        for (int i = 0; i < dim; i++)
+        {
+            if (writer.ShouldFlush(sizeof(float)))
+                writer.Flush();
+            writer.WriteFloat(vec[i]);
+        }
+    }
+
+    public override async ValueTask WriteAsync(
+        PgWriter writer, Vector value, CancellationToken cancellationToken = default)
+    {
+        if (writer.ShouldFlush(sizeof(ushort) * 2))
+            await writer.FlushAsync(cancellationToken);
+
+        var vec = value.ToArray();
+        var dim = vec.Length;
+        writer.WriteUInt16(Convert.ToUInt16(dim));
+        writer.WriteUInt16(0);
+
+        for (int i = 0; i < dim; i++)
+        {
+            if (writer.ShouldFlush(sizeof(float)))
+                await writer.FlushAsync(cancellationToken);
+            writer.WriteFloat(vec[i]);
+        }
+    }
+}

src/Pgvector/Npgsql/VectorExtensions.cs

@@ -6,7 +6,7 @@ public static class VectorExtensions
 {
     public static INpgsqlTypeMapper UseVector(this INpgsqlTypeMapper mapper)
     {
-        mapper.AddTypeResolverFactory(new VectorTypeHandlerResolverFactory());
+        mapper.AddTypeInfoResolver(new VectorTypeInfoResolver());
         return mapper;
     }
 }

src/Pgvector/Npgsql/VectorTypeInfoResolver.cs

@@ -0,0 +1,28 @@
+using System;
+using Npgsql.Internal;
+using Npgsql.Internal.Postgres;
+
+namespace Pgvector.Npgsql;
+
+public class VectorTypeInfoResolver : IPgTypeInfoResolver
+{
+    TypeInfoMappingCollection Mappings { get; }
+
+    public VectorTypeInfoResolver()
+    {
+        Mappings = new TypeInfoMappingCollection();
+        AddInfos(Mappings);
+        // TODO: Opt-in only
+        AddArrayInfos(Mappings);
+    }
+
+    public PgTypeInfo? GetTypeInfo(Type? type, DataTypeName? dataTypeName, PgSerializerOptions options)
+        => Mappings.Find(type, dataTypeName, options);
+
+    static void AddInfos(TypeInfoMappingCollection mappings)
+        => mappings.AddType<Vector>("vector",
+            static (options, mapping, _) => mapping.CreateInfo(options, new VectorConverter()), isDefault: true);
+
+    static void AddArrayInfos(TypeInfoMappingCollection mappings)
+        => mappings.AddArrayType<Vector>("vector");
+}

src/Pgvector/Pgvector.csproj

@@ -17,7 +17,7 @@
   <ItemGroup>
     <None Include="..\..\LICENSE.txt" Pack="true" PackagePath="\" />
     <None Include="..\..\README.md" Pack="true" PackagePath="\" />
-    <PackageReference Include="Npgsql" Version="7" />
+    <PackageReference Include="Npgsql" Version="8.0.0-rc.2" />
   </ItemGroup>
 
 </Project>

tests/Pgvector.Tests/EntityFrameworkCoreTests.cs

@@ -11,7 +11,7 @@ public class ItemContext : DbContext
     protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
     {
         var connString = "Host=localhost;Database=pgvector_dotnet_test";
-        optionsBuilder.UseNpgsql(connString, o => o.UseVector()).UseSnakeCaseNamingConvention();
+        optionsBuilder.UseNpgsql(connString, o => o.UseVector());
     }
 
     protected override void OnModelCreating(ModelBuilder modelBuilder)
@@ -30,7 +30,7 @@ public class Item
 {
     public int Id { get; set; }
 
-    [Column(TypeName = "vector(3)")]
+    [Column("embedding", TypeName = "vector(3)")]
     public Vector? Embedding { get; set; }
 }
 

tests/Pgvector.Tests/Pgvector.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>