.Net: [TINY] [MEVD] Remove SupportsMultipleKeys (#13572)

roji · web-flow · commit 9f2dafca484b · 2026-02-19T19:07:35.000Z
We have the model building option SupportsMultipleKeys to allow multiple
(composite) keys, but no provider uses them at this point (note that
Cosmos NoSQL has a sort of composite key - document + partition key, but
does not go through this support in any case).

Removing this - we can always add it when we actually need to support it
(and providers aren't blocked from implementing composite keys if they
really want to).
diff --git a/dotnet/src/InternalUtilities/connectors/Memory/MongoDB/MongoModelBuilder.cs b/dotnet/src/InternalUtilities/connectors/Memory/MongoDB/MongoModelBuilder.cs
@@ -23,7 +23,6 @@ internal class MongoModelBuilder() : CollectionModelBuilder(s_validationOptions)
     private static readonly CollectionModelBuildingOptions s_validationOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
         UsesExternalSerializer = true,
     };
diff --git a/dotnet/src/VectorData/AzureAISearch/AzureAISearchDynamicModelBuilder.cs b/dotnet/src/VectorData/AzureAISearch/AzureAISearchDynamicModelBuilder.cs
@@ -12,7 +12,6 @@ internal class AzureAISearchDynamicModelBuilder() : CollectionModelBuilder(s_mod
     internal static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
         UsesExternalSerializer = true
     };
diff --git a/dotnet/src/VectorData/AzureAISearch/AzureAISearchModelBuilder.cs b/dotnet/src/VectorData/AzureAISearch/AzureAISearchModelBuilder.cs
@@ -16,7 +16,6 @@ internal class AzureAISearchModelBuilder() : CollectionJsonModelBuilder(s_modelB
     internal static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
         UsesExternalSerializer = true
     };
diff --git a/dotnet/src/VectorData/CosmosNoSql/CosmosNoSqlModelBuilder.cs b/dotnet/src/VectorData/CosmosNoSql/CosmosNoSqlModelBuilder.cs
@@ -15,7 +15,6 @@ internal class CosmosNoSqlModelBuilder() : CollectionJsonModelBuilder(s_modelBui
     private static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
         UsesExternalSerializer = true,
         ReservedKeyStorageName = CosmosNoSqlConstants.ReservedKeyPropertyName
diff --git a/dotnet/src/VectorData/InMemory/InMemoryModelBuilder.cs b/dotnet/src/VectorData/InMemory/InMemoryModelBuilder.cs
@@ -14,7 +14,6 @@ internal class InMemoryModelBuilder() : CollectionModelBuilder(ValidationOptions
     internal static readonly CollectionModelBuildingOptions ValidationOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true
     };
 
diff --git a/dotnet/src/VectorData/PgVector/PostgresModelBuilder.cs b/dotnet/src/VectorData/PgVector/PostgresModelBuilder.cs
@@ -18,7 +18,6 @@ internal class PostgresModelBuilder() : CollectionModelBuilder(PostgresModelBuil
     public static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
     };
 
diff --git a/dotnet/src/VectorData/Pinecone/PineconeModelBuilder.cs b/dotnet/src/VectorData/Pinecone/PineconeModelBuilder.cs
@@ -15,7 +15,6 @@ internal class PineconeModelBuilder() : CollectionModelBuilder(s_validationOptio
     private static readonly CollectionModelBuildingOptions s_validationOptions = new()
     {
         RequiresAtLeastOneVector = true,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = false,
     };
 
diff --git a/dotnet/src/VectorData/Qdrant/QdrantModelBuilder.cs b/dotnet/src/VectorData/Qdrant/QdrantModelBuilder.cs
@@ -16,7 +16,6 @@ private static CollectionModelBuildingOptions GetModelBuildOptions(bool hasNamed
         => new()
         {
             RequiresAtLeastOneVector = !hasNamedVectors,
-            SupportsMultipleKeys = false,
             SupportsMultipleVectors = hasNamedVectors,
         };
 
diff --git a/dotnet/src/VectorData/Redis/RedisHashSetCollection.cs b/dotnet/src/VectorData/Redis/RedisHashSetCollection.cs
@@ -36,7 +36,6 @@ public class RedisHashSetCollection<TKey, TRecord> : VectorStoreCollection<TKey,
     internal static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true
     };
 
diff --git a/dotnet/src/VectorData/Redis/RedisJsonCollection.cs b/dotnet/src/VectorData/Redis/RedisJsonCollection.cs
@@ -39,7 +39,6 @@ public class RedisJsonCollection<TKey, TRecord> : VectorStoreCollection<TKey, TR
     internal static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
         UsesExternalSerializer = true
     };
diff --git a/dotnet/src/VectorData/SqlServer/SqlServerModelBuilder.cs b/dotnet/src/VectorData/SqlServer/SqlServerModelBuilder.cs
@@ -16,7 +16,6 @@ internal class SqlServerModelBuilder() : CollectionModelBuilder(s_modelBuildingO
     private static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
     };
 
diff --git a/dotnet/src/VectorData/SqliteVec/SqliteModelBuilder.cs b/dotnet/src/VectorData/SqliteVec/SqliteModelBuilder.cs
@@ -14,7 +14,6 @@ internal class SqliteModelBuilder() : CollectionModelBuilder(s_modelBuildingOpti
     private static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()
     {
         RequiresAtLeastOneVector = false,
-        SupportsMultipleKeys = false,
         SupportsMultipleVectors = true,
     };
 
diff --git a/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModel.cs b/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModel.cs
@@ -77,7 +77,6 @@ internal CollectionModel(
 
     /// <summary>
     /// Returns the single key property in the model, and throws if there are multiple key properties.
-    /// Suitable for connectors where validation is in place for single keys only (<see cref="CollectionModelBuildingOptions.SupportsMultipleKeys"/>).
     /// </summary>
     public KeyPropertyModel KeyProperty => this._singleKeyProperty ??= this.KeyProperties.Single();
 
diff --git a/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs b/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModelBuilder.cs
@@ -57,14 +57,7 @@ public abstract class CollectionModelBuilder
     /// Constructs a new <see cref="CollectionModelBuilder"/>.
     /// </summary>
     protected CollectionModelBuilder(CollectionModelBuildingOptions options)
-    {
-        if (options.SupportsMultipleKeys && options.ReservedKeyStorageName is not null)
-        {
-            throw new ArgumentException($"{nameof(CollectionModelBuildingOptions.ReservedKeyStorageName)} cannot be set when {nameof(CollectionModelBuildingOptions.SupportsMultipleKeys)} is set.");
-        }
-
-        this.Options = options;
-    }
+        => this.Options = options;
 
     /// <summary>
     /// Builds and returns an <see cref="CollectionModel"/> from the given <paramref name="type"/> and <paramref name="definition"/>.
@@ -419,7 +412,7 @@ protected virtual void Customize()
     /// </summary>
     protected virtual void Validate(Type? type, VectorStoreCollectionDefinition? definition)
     {
-        if (!this.Options.SupportsMultipleKeys && this.KeyProperties.Count > 1)
+        if (this.KeyProperties.Count > 1)
         {
             throw new NotSupportedException($"Multiple key properties found on {TypeMessage()}the provided {nameof(VectorStoreCollectionDefinition)} while only one is supported.");
         }
diff --git a/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs b/dotnet/src/VectorData/VectorData.Abstractions/ProviderServices/CollectionModelBuildingOptions.cs
@@ -11,11 +11,6 @@ namespace Microsoft.Extensions.VectorData.ProviderServices;
 [Experimental("MEVD9001")]
 public sealed class CollectionModelBuildingOptions
 {
-    /// <summary>
-    /// Gets a value that indicates whether multiple key properties are supported.
-    /// </summary>
-    public required bool SupportsMultipleKeys { get; init; }
-
     /// <summary>
     /// Gets a value that indicates whether multiple vector properties are supported.
     /// </summary>
diff --git a/dotnet/src/VectorData/Weaviate/WeaviateModelBuilder.cs b/dotnet/src/VectorData/Weaviate/WeaviateModelBuilder.cs
@@ -18,7 +18,6 @@ private static CollectionModelBuildingOptions GetModelBuildingOptions(bool hasNa
         return new()
         {
             RequiresAtLeastOneVector = !hasNamedVectors,
-            SupportsMultipleKeys = false,
             SupportsMultipleVectors = hasNamedVectors
         };
     }
diff --git a/dotnet/test/VectorData/VectorData.UnitTests/CollectionModelBuilderTests.cs b/dotnet/test/VectorData/VectorData.UnitTests/CollectionModelBuilderTests.cs
@@ -368,7 +368,6 @@ private sealed class CustomModelBuilder(CollectionModelBuildingOptions? options
     {
         private static readonly CollectionModelBuildingOptions s_defaultOptions = new()
         {
-            SupportsMultipleKeys = false,
             SupportsMultipleVectors = true,
             RequiresAtLeastOneVector = false
         };

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ internal class MongoModelBuilder() : CollectionModelBuilder(s_validationOptions)`
`23`	`23`	`private static readonly CollectionModelBuildingOptions s_validationOptions = new()`
`24`	`24`	`{`
`25`	`25`	`RequiresAtLeastOneVector = false,`
`26`		`- SupportsMultipleKeys = false,`
`27`	`26`	`SupportsMultipleVectors = true,`
`28`	`27`	`UsesExternalSerializer = true,`
`29`	`28`	`};`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,6 @@ internal class AzureAISearchDynamicModelBuilder() : CollectionModelBuilder(s_mod`
`12`	`12`	`internal static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()`
`13`	`13`	`{`
`14`	`14`	`RequiresAtLeastOneVector = false,`
`15`		`- SupportsMultipleKeys = false,`
`16`	`15`	`SupportsMultipleVectors = true,`
`17`	`16`	`UsesExternalSerializer = true`
`18`	`17`	`};`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ internal class AzureAISearchModelBuilder() : CollectionJsonModelBuilder(s_modelB`
`16`	`16`	`internal static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()`
`17`	`17`	`{`
`18`	`18`	`RequiresAtLeastOneVector = false,`
`19`		`- SupportsMultipleKeys = false,`
`20`	`19`	`SupportsMultipleVectors = true,`
`21`	`20`	`UsesExternalSerializer = true`
`22`	`21`	`};`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ internal class CosmosNoSqlModelBuilder() : CollectionJsonModelBuilder(s_modelBui`
`15`	`15`	`private static readonly CollectionModelBuildingOptions s_modelBuildingOptions = new()`
`16`	`16`	`{`
`17`	`17`	`RequiresAtLeastOneVector = false,`
`18`		`- SupportsMultipleKeys = false,`
`19`	`18`	`SupportsMultipleVectors = true,`
`20`	`19`	`UsesExternalSerializer = true,`
`21`	`20`	`ReservedKeyStorageName = CosmosNoSqlConstants.ReservedKeyPropertyName`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ internal class InMemoryModelBuilder() : CollectionModelBuilder(ValidationOptions`
`14`	`14`	`internal static readonly CollectionModelBuildingOptions ValidationOptions = new()`
`15`	`15`	`{`
`16`	`16`	`RequiresAtLeastOneVector = false,`
`17`		`- SupportsMultipleKeys = false,`
`18`	`17`	`SupportsMultipleVectors = true`
`19`	`18`	`};`
`20`	`19`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,6 @@ internal class PostgresModelBuilder() : CollectionModelBuilder(PostgresModelBuil`
`18`	`18`	`public static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()`
`19`	`19`	`{`
`20`	`20`	`RequiresAtLeastOneVector = false,`
`21`		`- SupportsMultipleKeys = false,`
`22`	`21`	`SupportsMultipleVectors = true,`
`23`	`22`	`};`
`24`	`23`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,6 @@ internal class PineconeModelBuilder() : CollectionModelBuilder(s_validationOptio`
`15`	`15`	`private static readonly CollectionModelBuildingOptions s_validationOptions = new()`
`16`	`16`	`{`
`17`	`17`	`RequiresAtLeastOneVector = true,`
`18`		`- SupportsMultipleKeys = false,`
`19`	`18`	`SupportsMultipleVectors = false,`
`20`	`19`	`};`
`21`	`20`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ private static CollectionModelBuildingOptions GetModelBuildOptions(bool hasNamed`
`16`	`16`	`=> new()`
`17`	`17`	`{`
`18`	`18`	`RequiresAtLeastOneVector = !hasNamedVectors,`
`19`		`- SupportsMultipleKeys = false,`
`20`	`19`	`SupportsMultipleVectors = hasNamedVectors,`
`21`	`20`	`};`
`22`	`21`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,6 @@ public class RedisHashSetCollection<TKey, TRecord> : VectorStoreCollection<TKey,`
`36`	`36`	`internal static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()`
`37`	`37`	`{`
`38`	`38`	`RequiresAtLeastOneVector = false,`
`39`		`- SupportsMultipleKeys = false,`
`40`	`39`	`SupportsMultipleVectors = true`
`41`	`40`	`};`
`42`	`41`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ public class RedisJsonCollection<TKey, TRecord> : VectorStoreCollection<TKey, TR`
`39`	`39`	`internal static readonly CollectionModelBuildingOptions ModelBuildingOptions = new()`
`40`	`40`	`{`
`41`	`41`	`RequiresAtLeastOneVector = false,`
`42`		`- SupportsMultipleKeys = false,`
`43`	`42`	`SupportsMultipleVectors = true,`
`44`	`43`	`UsesExternalSerializer = true`
`45`	`44`	`};`