IIndex Interface

Definition

Represents an index on a set of properties.

public interface IIndex : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
type IIndex = interface
    interface IAnnotatable
Public Interface IIndex
Implements IAnnotatable
Derived
Implements

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).

IsUnique

Gets a value indicating whether the values assigned to the indexed properties are unique.

Item[String]

Gets the value annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
Name

Gets the name of this index.

Properties

Gets the properties that this index is defined on.

Methods

FindAnnotation(String)

Gets the annotation with the given name, returning null if it does not exist.

(Inherited from IAnnotatable)
GetAnnotations()

Gets all annotations on the current object.

(Inherited from IAnnotatable)

Extension Methods

GetNullableValueFactory<TKey>(IIndex)

Gets a factory for key values based on the index key values taken from various forms of entity data.

This method is typically used by database providers (and other extensions). It is generally not used in application code.

ToDebugString(IIndex, 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.

AnnotationsToDebugString(IAnnotatable, Int32)

Gets the debug string for all annotations declared on the object.

GetAnnotation(IAnnotatable, String)

Gets the annotation with the given name, throwing if it does not exist.

FindSharedObjectRootIndex(IIndex, 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(IIndex)

Returns the name of the index in the database.

GetDatabaseName(IIndex, StoreObjectIdentifier)

Returns the name of the index in the database.

GetDefaultDatabaseName(IIndex)

Returns the default name that would be used for this index.

GetDefaultDatabaseName(IIndex, StoreObjectIdentifier)

Returns the default name that would be used for this index.

GetDefaultName(IIndex)
Obsolete.

Returns the default name that would be used for this index.

GetFilter(IIndex)

Returns the index filter expression.

GetFilter(IIndex, StoreObjectIdentifier)

Returns the index filter expression.

GetMappedTableIndexes(IIndex)

Gets the table indexes to which the index is mapped.

GetName(IIndex)
Obsolete.

Returns the name of the index in the database.

Relational(IIndex)

Gets the relational database specific metadata for an index.

Sqlite(IIndex)

Gets the SQLite specific metadata for an index.

GetFillFactor(IIndex)

Returns a value indicating whether the index uses the fill factor.

GetIncludeProperties(IIndex)

Returns included property names, or null if they have not been specified.

IsClustered(IIndex)

Returns a value indicating whether the index is clustered.

IsClustered(IIndex, StoreObjectIdentifier)

Returns a value indicating whether the index is clustered.

IsCreatedOnline(IIndex)

Returns a value indicating whether the index is online.

SqlServer(IIndex)

Gets the SQL Server specific metadata for an index.

Applies to