CosmosIndexBuilderExtensions Class

Definition

Namespace:

Microsoft.EntityFrameworkCore

Assembly:

Microsoft.EntityFrameworkCore.Cosmos.dll

Package:

Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Source:

CosmosIndexBuilderExtensions.cs

Azure Cosmos DB-specific extension methods for IndexBuilder.

C#

[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static class CosmosIndexBuilderExtensions

Inheritance

Object

CosmosIndexBuilderExtensions

Attributes

ExperimentalAttribute

Remarks

See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.

Methods

CanSetVectorIndexType(IConventionIndexBuilder, Nullable<VectorIndexType>, Boolean)	Returns a value indicating whether the vector index can be configured for vectors.
ForVectors(IConventionIndexBuilder, Nullable<VectorIndexType>, Boolean)	Configures whether the index as a vector index with the given vector index type, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
ForVectors(IndexBuilder, Nullable<VectorIndexType>)	Configures the index as a vector index with the given vector index type, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
ForVectors<TEntity>(IndexBuilder<TEntity>, Nullable<VectorIndexType>)	Configures whether the index as a vector index with the given vector index type, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.

Applies to