IConventionIndex 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 IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex

Implémente

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

Remarques

Cette interface est utilisée lors de la création du modèle et permet de modifier les métadonnées. Une fois le modèle généré, IIndex représente une vue en lecture seule des mêmes métadonnées.

Pour plus d’informations et d’exemples, consultez Conventions de génération de modèles.

Propriétés

Builder	Obtient le générateur qui peut être utilisé pour configurer cet index.
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 (puisque 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)
IsInModel	Indique si cet objet se trouve dans un modèle, c’est-à-dire s’il n’en a pas été supprimé. (Hérité de IConventionAnnotatable)
IsUnique	Obtient une valeur indiquant si les valeurs attribuées aux propriétés indexées sont uniques. (Hérité de IReadOnlyIndex)
Item[String]	Obtient la valeur de l’annotation avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
Name	Obtient le nom de cet index. (Hérité de IReadOnlyIndex)
Properties	Obtient les propriétés sur laquelle cet index est défini.

Méthodes

AddAnnotation(String, Object, Boolean)	Ajoute une annotation à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Ajoute des annotations à un objet. (Hérité de IConventionAnnotatable)
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é, retournée null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotation(String)	Obtient l’annotation avec le nom donné, en lisant si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
GetAnnotations()	Obtient toutes les annotations sur l’objet actif. (Hérité de IReadOnlyAnnotatable)
GetConfigurationSource()	Retourne la source de configuration de cet index.
GetIsDescendingConfigurationSource()	Retourne la source de configuration pour IsDescending.
GetIsUniqueConfigurationSource()	Retourne la source de configuration pour IsUnique.
RemoveAnnotation(String)	Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)	Définit l’ordre de tri pour cet index (croissant ou décroissant).
SetIsUnique(Nullable<Boolean>, Boolean)	Définit une valeur indiquant si les valeurs attribuées aux propriétés d’index sont uniques.
SetOrRemoveAnnotation(String, Object, Boolean)	Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si null est fournie. (Hérité de IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Crée une représentation lisible par l’homme des métadonnées données. Avertissement : ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement d’une version à l’autre. (Hérité de IReadOnlyIndex)

Méthodes d’extension

FindSharedObjectRootIndex(IConventionIndex, 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 d’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 d’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.
GetDatabaseNameConfigurationSource(IConventionIndex)	Obtient le ConfigurationSource pour 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.
GetFilterConfigurationSource(IConventionIndex)	Obtient le ConfigurationSource pour l’expression de filtre d’index.
SetDatabaseName(IConventionIndex, String, Boolean)	Définit le nom de l’index dans la base de données.
SetFilter(IConventionIndex, String, Boolean)	Définit l’expression de filtre d’index.
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.
GetDataCompressionConfigurationSource(IConventionIndex)	Retourne le ConfigurationSource pour la compression de 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.
GetFillFactorConfigurationSource(IConventionIndex)	Retourne le ConfigurationSource indiquant si l’index utilise le facteur de remplissage.
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.
GetIncludePropertiesConfigurationSource(IConventionIndex)	Retourne le ConfigurationSource pour les noms de propriétés incluses.
GetIsClusteredConfigurationSource(IConventionIndex)	Retourne la ConfigurationSource valeur indiquant si l’index est en cluster.
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	Retourne le ConfigurationSource indiquant si l’index est en ligne.
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.
GetSortInTempDbConfigurationSource(IConventionIndex)	Retourne la ConfigurationSource 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.
SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)	Définit une valeur indiquant la compression des données que l’index utilise.
SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)	Définit une valeur indiquant si l’index utilise le facteur de remplissage.
SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)	Définit les noms de propriétés incluses.
SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)	Définit une valeur indiquant si l’index est cluster.
SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)	Définit une valeur indiquant si l’index est en ligne.
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	Définit une valeur indiquant si l’index est trié dans tempdb.