IIndex Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente un index sur un ensemble de propriétés.

public interface IIndex : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IIndex
Implements IAnnotatable, IReadOnlyIndex

Dérivé

Microsoft.EntityFrameworkCore.Metadata.RuntimeIndex

Implémente

IAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

Remarques

Pour plus d’informations et d’exemples, consultez Modélisation des types d’entités et des relations .

Propriétés

DeclaringEntityType	Obtient le type d’entité sur lequel l’index est défini. Cela peut être différent du type défini Properties sur lorsque l’index est défini comme type dérivé dans une hiérarchie d’héritage (car les propriétés peuvent être définies sur un type de base).
IsDescending	Ensemble de valeurs indiquant si chaque colonne d’index correspondante a un ordre de tri décroissant. (Hérité de IReadOnlyIndex)
Item[String]	Obtient la valeur de l’annotation portant le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
Properties	Obtient les propriétés sur laquelle cet index est défini.

Méthodes

AddRuntimeAnnotation(String, Object)	Ajoute une annotation d’exécution à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
AnnotationsToDebugString(Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet . (Hérité de IReadOnlyAnnotatable)
DisplayName()	Obtient le nom d’affichage convivial pour le donné IReadOnlyIndex, en retournant son Name si un est défini, ou une représentation sous forme de chaîne de son Properties s’il s’agit d’un index sans nom. (Hérité de IReadOnlyIndex)
FindAnnotation(String)	Obtient l’annotation avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	Obtient l’annotation d’exécution avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
FindRuntimeAnnotationValue(String)	Obtient la valeur de l’annotation runtime avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IAnnotatable)
GetAnnotation(String)	Obtient l’annotation portant le nom donné, en lisant si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotations()	Obtient toutes les annotations sur l’objet actuel. (Hérité de IReadOnlyAnnotatable)
GetNullableValueFactory<TKey>()	Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé d’index extraites de différentes formes de données d’entité. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Obtient la valeur de l’annotation runtime avec le nom donné, en l’ajoutant si elle n’existe pas. (Hérité de IAnnotatable)
GetRuntimeAnnotations()	Obtient toutes les annotations d’exécution sur l’objet actuel. (Hérité de IAnnotatable)
RemoveRuntimeAnnotation(String)	Supprime l’annotation d’exécution donnée de cet objet. (Hérité de IAnnotatable)
SetRuntimeAnnotation(String, Object)	Définit l’annotation d’exécution stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Crée une représentation lisible des métadonnées données. Avertissement : ne vous fiez pas au format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. (Hérité de IReadOnlyIndex)

Méthodes d’extension

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)	Recherche le premier IConventionIndex mappé au même index dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	Recherche le premier IIndex mappé au même index dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code de l’application.
GetDatabaseName(IReadOnlyIndex)	Retourne le nom de l’index dans la base de données.
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Retourne le nom de l’index dans la base de données.
GetDefaultDatabaseName(IReadOnlyIndex)	Retourne le nom par défaut qui serait utilisé pour cet index.
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Retourne le nom par défaut qui serait utilisé pour cet index.
GetFilter(IReadOnlyIndex)	Retourne l’expression de filtre d’index.
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	Retourne l’expression de filtre d’index.
GetMappedTableIndexes(IIndex)	Obtient les index de table auxquels l’index est mappé.
GetFluentApiCalls(IIndex, IAnnotationCodeGenerator)	Obtient les appels d’API Fluent pour configurer un index.
IsHandledByDataAnnotations(IIndex, IAnnotationCodeGenerator)	Obtient une valeur indiquant si cet index peut être entièrement réperesté par une annotation de données.
GetDataCompression(IReadOnlyIndex)	Retourne la compression des données que l’index utilise.
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	Retourne la compression des données que l’index utilise.
GetFillFactor(IReadOnlyIndex)	Retourne le facteur de remplissage utilisé par l’index.
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	Retourne le facteur de remplissage utilisé par l’index.
GetIncludeProperties(IReadOnlyIndex)	Retourne les noms de propriétés incluses, ou null s’ils n’ont pas été spécifiés.
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	Retourne les noms de propriétés incluses, ou null s’ils n’ont pas été spécifiés.
GetSortInTempDb(IReadOnlyIndex)	Retourne une valeur indiquant si l’index est trié dans tempdb.
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	Retourne une valeur indiquant si l’index est trié dans tempdb.
IsClustered(IReadOnlyIndex)	Retourne une valeur indiquant si l’index est cluster.
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	Retourne une valeur indiquant si l’index est cluster.
IsCreatedOnline(IReadOnlyIndex)	Retourne une valeur indiquant si l’index est en ligne.
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	Retourne une valeur indiquant si l’index est en ligne.