Share via

CosmosIndexExtensions 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:
CosmosIndexExtensions.cs
Source:
CosmosIndexExtensions.cs

Index extension methods for Azure Cosmos DB-specific metadata.

[System.Runtime.CompilerServices.Nullable(0)]
public static class CosmosIndexExtensions
[System.Runtime.CompilerServices.Nullable(0)]
[System.Diagnostics.CodeAnalysis.Experimental("EF9103")]
public static class CosmosIndexExtensions
[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosIndexExtensions = class
[<System.Runtime.CompilerServices.Nullable(0)>]
[<System.Diagnostics.CodeAnalysis.Experimental("EF9103")>]
type CosmosIndexExtensions = class
Public Module CosmosIndexExtensions
Inheritance
Object
CosmosIndexExtensions
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
GetIsFullTextIndexConfigurationSource(IConventionIndex)

Returns the ConfigurationSource for whether the IsFullTextIndex(IReadOnlyIndex).
GetVectorIndexType(IReadOnlyIndex)

Returns the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
GetVectorIndexTypeConfigurationSource(IConventionIndex)

Returns the ConfigurationSource for whether the GetVectorIndexType(IReadOnlyIndex).
IsFullTextIndex(IReadOnlyIndex)

Returns the value indicating whether the index is configured for full-text search. See Full-text search in Azure Cosmos DB for NoSQL for more information.
SetIsFullTextIndex(IConventionIndex, Nullable<Boolean>, Boolean)

Configures the index for full-text search. See Full-text search in Azure Cosmos DB for NoSQL for more information.
SetIsFullTextIndex(IMutableIndex, Nullable<Boolean>)

Configures the index for full-text search. See Full-text search in Azure Cosmos DB for NoSQL for more information.
SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean)

Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Nullable<Boolean>, Boolean)

Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>, Nullable<Boolean>)

Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.
SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>)

Sets the vector index type to use, such as "flat", "diskANN", or "quantizedFlat". See Vector Search in Azure Cosmos DB for NoSQL for more information.

Applies to