Added support for MaxLength - #50

Co-authored-by: Shay Rojansky <[email protected]>

Author: ankane

src/Pgvector.EntityFrameworkCore/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 0.2.2 (unreleased)
 
 - Added support for scaffolding
+- Added support for `MaxLength`
 
 ## 0.2.1 (2024-06-25)
 

src/Pgvector.EntityFrameworkCore/VectorTypeMapping.cs

@@ -6,13 +6,18 @@ namespace Pgvector.EntityFrameworkCore;
 
 public class VectorTypeMapping : RelationalTypeMapping
 {
-    public static VectorTypeMapping Default { get; } = new();
+    public static VectorTypeMapping Default { get; } = new("vector", typeof(Vector));
 
-    public VectorTypeMapping() : base("vector", typeof(Vector)) { }
-
-    public VectorTypeMapping(string storeType) : base(storeType, typeof(Vector)) { }
-
-    public VectorTypeMapping(string storeType, Type clrType) : base(storeType, clrType) { }
+    public VectorTypeMapping(string storeType, Type clrType, int? size = null)
+        : this(
+            new RelationalTypeMappingParameters(
+                new CoreTypeMappingParameters(clrType),
+                storeType,
+                StoreTypePostfix.Size,
+                size: size,
+                fixedLength: size is not null))
+    {
+    }
 
     protected VectorTypeMapping(RelationalTypeMappingParameters parameters) : base(parameters) { }
 

src/Pgvector.EntityFrameworkCore/VectorTypeMappingSourcePlugin.cs

@@ -10,18 +10,18 @@ public class VectorTypeMappingSourcePlugin : IRelationalTypeMappingSourcePlugin
         {
             return (mappingInfo.StoreTypeNameBase ?? mappingInfo.StoreTypeName) switch
             {
-                "vector" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "vector", typeof(Vector)),
-                "halfvec" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "halfvec", typeof(HalfVector)),
-                "sparsevec" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "sparsevec", typeof(SparseVector)),
+                "vector" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "vector", typeof(Vector), mappingInfo.Size),
+                "halfvec" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "halfvec", typeof(HalfVector), mappingInfo.Size),
+                "sparsevec" => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "sparsevec", typeof(SparseVector), mappingInfo.Size),
                 _ => null,
             };
         }
 
         return mappingInfo.ClrType switch
         {
-            var t when t == typeof(Vector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "vector", typeof(Vector)),
-            var t when t == typeof(HalfVector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "halfvec", typeof(HalfVector)),
-            var t when t == typeof(SparseVector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "sparsevec", typeof(SparseVector)),
+            var t when t == typeof(Vector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "vector", typeof(Vector), mappingInfo.Size),
+            var t when t == typeof(HalfVector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "halfvec", typeof(HalfVector), mappingInfo.Size),
+            var t when t == typeof(SparseVector) => new VectorTypeMapping(mappingInfo.StoreTypeName ?? "sparsevec", typeof(SparseVector), mappingInfo.Size),
             _ => null,
         };
     }

tests/Pgvector.CSharp.Tests/EntityFrameworkCoreTests.cs

@@ -141,4 +141,44 @@ public async Task Main()
         Assert.Equal(new int[] { 1, 3, 2 }, neighbors.Select(v => v.Entity.Id).ToArray());
         Assert.Equal(new double[] { 0, 1, Math.Sqrt(3) }, neighbors.Select(v => v.Distance).ToArray());
     }
+
+    [Theory]
+    [InlineData(typeof(Vector), null, "vector")]
+    [InlineData(typeof(Vector), 3, "vector(3)")]
+    [InlineData(typeof(HalfVector), null, "halfvec")]
+    [InlineData(typeof(HalfVector), 3, "halfvec(3)")]
+    [InlineData(typeof(BitArray), null, "bit varying")]
+    [InlineData(typeof(BitArray), 3, "bit varying(3)")]
+    [InlineData(typeof(SparseVector), null, "sparsevec")]
+    [InlineData(typeof(SparseVector), 3, "sparsevec(3)")]
+    public void ByStoreType(Type type, int? size, string expectedStoreType)
+    {
+        using var ctx = new ItemContext();
+        var typeMappingSource = ctx.GetService<IRelationalTypeMappingSource>();
+
+        var typeMapping = typeMappingSource.FindMapping(type, storeTypeName: null, size: size)!;
+        Assert.Equal(expectedStoreType, typeMapping.StoreType);
+        Assert.Same(type, typeMapping.ClrType);
+        Assert.Equal(size, typeMapping.Size);
+    }
+
+    [Theory]
+    [InlineData("vector", typeof(Vector), null)]
+    [InlineData("vector(3)", typeof(Vector), 3)]
+    [InlineData("halfvec", typeof(HalfVector), null)]
+    [InlineData("halfvec(3)", typeof(HalfVector), 3)]
+    [InlineData("bit varying", typeof(BitArray), null)]
+    [InlineData("bit(3)", typeof(BitArray), 3)]
+    [InlineData("sparsevec", typeof(SparseVector), null)]
+    [InlineData("sparsevec(3)", typeof(SparseVector), 3)]
+    public void ByClrType(string storeType, Type expectedType, int? expectedSize)
+    {
+        using var ctx = new ItemContext();
+        var typeMappingSource = ctx.GetService<IRelationalTypeMappingSource>();
+
+        var typeMapping = typeMappingSource.FindMapping(storeType)!;
+        Assert.Equal(storeType, typeMapping.StoreType);
+        Assert.Same(expectedType, typeMapping.ClrType);
+        Assert.Equal(expectedSize, typeMapping.Size);
+    }
 }