IReadOnlyIndex Interface

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Package:

Microsoft.EntityFrameworkCore v9.0.0

Source:

IReadOnlyIndex.cs

Represents an index on a set of properties.

public interface IReadOnlyIndex : Microsoft.EntityFrameworkCore.Infrastructure.IReadOnlyAnnotatable

type IReadOnlyIndex = interface
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyIndex
Implements IReadOnlyAnnotatable

Derived

Microsoft.EntityFrameworkCore.Metadata.IConventionIndex

Microsoft.EntityFrameworkCore.Metadata.IIndex

Microsoft.EntityFrameworkCore.Metadata.IMutableIndex

Microsoft.EntityFrameworkCore.Metadata.RuntimeIndex

Implements

IReadOnlyAnnotatable

Remarks

See Modeling entity types and relationships for more information and examples.

Properties

DeclaringEntityType	Gets the entity type the index is defined on. This may be different from the type that Properties are defined on when the index is defined a derived type in an inheritance hierarchy (since the properties may be defined on a base type).
IsDescending	A set of values indicating whether each corresponding index column has descending sort order.
IsUnique	Gets a value indicating whether the values assigned to the indexed properties are unique.
Item[String]	Gets the value of the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
Name	Gets the name of this index.
Properties	Gets the properties that this index is defined on.

Methods

AnnotationsToDebugString(Int32)	Gets the debug string for all annotations declared on the object. (Inherited from IReadOnlyAnnotatable)
DisplayName()	Gets the friendly display name for the given IReadOnlyIndex, returning its Name if one is defined, or a string representation of its Properties if this is an unnamed index.
FindAnnotation(String)	Gets the annotation with the given name, returning null if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotation(String)	Gets the annotation with the given name, throwing if it does not exist. (Inherited from IReadOnlyAnnotatable)
GetAnnotations()	Gets all annotations on the current object. (Inherited from IReadOnlyAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Creates a human-readable representation of the given metadata. Warning: Do not rely on the format of the returned string. It is designed for debugging only and may change arbitrarily between releases.

Extension Methods

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.
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	Finds the first IIndex that is mapped to the same index in a shared table-like object. This method is typically used by database providers (and other extensions). It is generally not used in application code.
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Returns the name of the index in the database.
GetDatabaseName(IReadOnlyIndex)	Returns the name of the index in the database.
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Returns the default name that would be used for this index.
GetDefaultDatabaseName(IReadOnlyIndex)	Returns the default name that would be used for this index.
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	Returns the index filter expression.
GetFilter(IReadOnlyIndex)	Returns the index filter expression.
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	Returns the data compression that the index uses.
GetDataCompression(IReadOnlyIndex)	Returns the data compression that the index uses.
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	Returns the fill factor that the index uses.
GetFillFactor(IReadOnlyIndex)	Returns the fill factor that the index uses.
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	Returns included property names, or null if they have not been specified.
GetIncludeProperties(IReadOnlyIndex)	Returns included property names, or null if they have not been specified.
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	Returns a value indicating whether the index is sorted in tempdb.
GetSortInTempDb(IReadOnlyIndex)	Returns a value indicating whether the index is sorted in tempdb.
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	Returns a value indicating whether the index is clustered.
IsClustered(IReadOnlyIndex)	Returns a value indicating whether the index is clustered.
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	Returns a value indicating whether the index is online.
IsCreatedOnline(IReadOnlyIndex)	Returns a value indicating whether the index is online.