CosmosIndexBuilderExtensions Class

Definition

Namespace:: Microsoft.EntityFrameworkCore

Assembly:: Microsoft.EntityFrameworkCore.Cosmos.dll

Package:: Microsoft.EntityFrameworkCore.Cosmos v10.0.0

Package:: Microsoft.EntityFrameworkCore.Cosmos v9.0.0

Source:: CosmosIndexBuilderExtensions.cs

Source:: CosmosIndexBuilderExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Azure Cosmos DB-specific extension methods for IndexBuilder.

[System.Runtime.CompilerServices.Nullable(0)]
public static class CosmosIndexBuilderExtensions

[System.Runtime.CompilerServices.Nullable(0)]
[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static class CosmosIndexBuilderExtensions

[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosIndexBuilderExtensions = class

[<System.Runtime.CompilerServices.Nullable(0)>]
[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
type CosmosIndexBuilderExtensions = class

Public Module CosmosIndexBuilderExtensions

Inheritance: Object
CosmosIndexBuilderExtensions

Attributes: NullableAttribute ExperimentalAttribute

Remarks

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

Methods

Name	Description
CanSetIsFullTextIndex(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	Returns a value indicating whether the index can be configured as a full-text index.
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.
IsFullTextIndex(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	Configures the index as a full-text index. See Full-text search in Azure Cosmos DB for NoSQL for more information.
IsFullTextIndex(IndexBuilder, Boolean)	Configures the index as a full-text index. See Full-text search in Azure Cosmos DB for NoSQL for more information.
IsFullTextIndex<TEntity>(IndexBuilder<TEntity>, Boolean)	Configures the index as a full-text index. See Full-text search in Azure Cosmos DB for NoSQL for more information.
IsVectorIndex(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.
IsVectorIndex(IndexBuilder, Nullable<VectorIndexType>, Boolean)	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.
IsVectorIndex<TEntity>(IndexBuilder<TEntity>, 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.

Applies to

Feedback

Was this page helpful?