IConventionModel Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Métadonnées relatives à la forme des entités, aux relations entre elles et à la façon dont elles sont mappées à la base de données. Un modèle est généralement créé en remplaçant la OnModelCreating(ModelBuilder) méthode sur un dérivé DbContext.

[System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")]
public interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel

[<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")>]
type IConventionModel = interface
    interface IReadOnlyModel
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionModel
Implements IConventionAnnotatable, IReadOnlyModel

Attributs

UnconditionalSuppressMessageAttribute

Implémente

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyModel

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é, IModel 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 ce modèle.
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)
Item[String]	Obtient la valeur de l’annotation avec le nom donné, en retournant null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
ModelId	Il s’agit d’une API interne qui prend en charge l’infrastructure Entity Framework Core et qui n’est pas soumise aux mêmes normes de compatibilité que les API publiques. Il peut être modifié ou supprimé sans préavis dans n’importe quelle version. Vous devez uniquement l’utiliser directement dans votre code avec une extrême prudence et en sachant que cela peut entraîner des échecs d’application lors de la mise à jour vers une nouvelle version d’Entity Framework Core. (Hérité de IReadOnlyModel)

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)
AddEntityType(String, Boolean)	Ajoute un type d’entité d’état de type par défaut au modèle.
AddEntityType(String, String, IConventionEntityType, Boolean)	Ajoute un type d’entité appartenant avec une navigation définissant le modèle.
AddEntityType(String, Type, Boolean)	Ajoute un type d’entité de type partagé au modèle.
AddEntityType(Type, Boolean)	Ajoute un type d’entité au modèle.
AddEntityType(Type, String, IConventionEntityType, Boolean)	Ajoute un type d’entité appartenant avec une navigation définissant le modèle.
AddIgnored(String, Boolean)	Marque le nom de type d’entité donné comme étant ignoré.
AddIgnored(Type, Boolean)	Marque le type d’entité donné comme ignoré.
AddOwned(Type, Boolean)	Marque le type d’entité donné comme appartenant, indiquant que lorsque les types d’entités découverts à l’aide du type donné doivent être configurés comme appartenant.
AddOwnedEntityType(String, Boolean)	Ajoute au modèle un type d’entité appartenant au type par défaut.
AddOwnedEntityType(String, Type, Boolean)	Ajoute un type d’entité de type partagé appartenant au modèle.
AddOwnedEntityType(Type, Boolean)	Ajoute un type d’entité appartenant au modèle.
AddShared(Type, Boolean)	Marque le type d’entité donné comme partagé, indiquant qu’une fois découverts, les types d’entités correspondants doivent être configurés en tant que type d’entité de type partagé.
AnnotationsToDebugString(Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet. (Hérité de IReadOnlyAnnotatable)
DelayConventions()	Empêche l’exécution immédiate de conventions lorsqu’un aspect de métadonnées est modifié. Toutes les conventions différées seront exécutées une fois l’objet retourné supprimé.
FinalizeModel()	Force le post-traitement sur le modèle afin qu’il soit prêt à être utilisé par le runtime. Ce post-traitement se produit automatiquement lors de l’utilisation OnModelCreating(ModelBuilder); cette méthode permet de l’exécuter explicitement dans les cas où l’exécution automatique n’est pas possible.
FindAnnotation(String)	Obtient l’annotation avec le nom donné, retournée null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindEntityType(String)	Obtient l’entité portant le nom donné. Retourne null si aucun type d’entité portant le nom donné n’est trouvé ou si le type CLR donné est utilisé par le type d’entité de type partagé ou si le type d’entité a une navigation de définition.
FindEntityType(String, String, IConventionEntityType)	Obtient le type d’entité pour le nom donné, en définissant le nom de navigation et le type d’entité de définition. Retourne null si aucun type d’entité correspondant n’est trouvé.
FindEntityType(String, String, IReadOnlyEntityType)	Obtient le type d’entité pour le nom de base donné, en définissant le nom de navigation et le type d’entité de définition. Retourne null si aucun type d’entité correspondant n’est trouvé. (Hérité de IReadOnlyModel)
FindEntityType(Type)	Obtient l’entité qui mappe la classe d’entité donnée. Retourne null si aucun type d’entité portant le nom donné n’est trouvé.
FindEntityType(Type, String, IConventionEntityType)	Obtient le type d’entité pour le nom donné, en définissant le nom de navigation et le type d’entité de définition. Retourne null si aucun type d’entité correspondant n’est trouvé.
FindEntityType(Type, String, IReadOnlyEntityType)	Obtient le type d’entité pour le type donné, en définissant le nom de navigation et le type d’entité de définition. Retourne null si aucun type d’entité correspondant n’est trouvé. (Hérité de IReadOnlyModel)
FindEntityTypes(Type)	Obtient les types d’entités correspondant au type donné.
FindIgnoredConfigurationSource(String)	Indique si le nom du type d’entité donné est ignoré.
FindIgnoredConfigurationSource(Type)	Indique si le type d’entité donné est ignoré.
FindIsOwnedConfigurationSource(Type)	Retourne la source de configuration si le type donné est marqué comme appartenant.
FindIsSharedConfigurationSource(Type)	Retourne la source de configuration si le type donné est marqué comme partagé.
FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)	Retourne les types d’entité correspondant aux types les moins dérivés du type donné.
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)
GetChangeTrackingStrategy()	Obtient la stratégie de suivi des modifications par défaut utilisée pour les entités dans le modèle. Cette stratégie indique comment le contexte détecte les modifications apportées aux propriétés d’une instance d’un type d’entité. (Hérité de IReadOnlyModel)
GetChangeTrackingStrategyConfigurationSource()	Retourne la source de configuration pour GetChangeTrackingStrategy().
GetEntityTypes()	Obtient tous les types d’entités définis dans le modèle.
GetProductVersion()	Obtient la version de l’assembly EF Core utilisée pour générer ce modèle. (Hérité de IReadOnlyModel)
GetPropertyAccessMode()	Obtient le utilisé pour les PropertyAccessMode propriétés des types d’entités dans ce modèle. (Hérité de IReadOnlyModel)
GetPropertyAccessModeConfigurationSource()	Retourne la source de configuration pour GetPropertyAccessMode().
IsIgnored(String)	Indique si le nom du type d’entité donné est ignoré.
IsIgnored(Type)	Indique si le type d’entité donné est ignoré.
IsIgnoredType(Type)	Indique si les types d’entité et les propriétés avec le type donné doivent être ignorés. Cette configuration est indépendante de IsIgnored(Type)
IsOwned(Type)	Retourne une valeur indiquant si les types d’entité utilisant le type donné doivent être configurés en tant que types détenus lors de leur découverte.
RemoveAnnotation(String)	Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionAnnotatable)
RemoveEntityType(IConventionEntityType)	Supprime un type d’entité du modèle.
RemoveEntityType(String)	Supprime un type d’entité sans définition de navigation du modèle.
RemoveEntityType(String, String, IConventionEntityType)	Supprime un type d’entité avec le type donné, en définissant le nom de navigation et le type d’entité définissant.
RemoveEntityType(Type)	Supprime un type d’entité du modèle.
RemoveEntityType(Type, String, IConventionEntityType)	Supprime un type d’entité avec le type donné, en définissant le nom de navigation et le type d’entité définissant.
RemoveIgnored(String)	Supprime le nom du type d’entité ignoré.
RemoveOwned(Type)	Supprime le type détenu donné, ce qui indique que lorsque les types d’entités correspondants sont découverts, ils ne doivent pas être configurés comme étant détenus.
RemoveShared(Type)	Marque le type donné comme non partagé, indiquant qu’en cas de découverte, les types d’entités correspondants ne doivent pas être configurés en tant que types d’entités de type partagé.
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)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean)	Définit la stratégie de suivi des modifications par défaut à utiliser pour les entités dans le modèle. Cette stratégie indique comment le contexte détecte les modifications apportées aux propriétés d’une instance d’un type d’entité.
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)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Définit le PropertyAccessMode à utiliser pour les propriétés de tous les types d’entités dans ce modèle.
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 IReadOnlyModel)

Méthodes d’extension

GetDefaultContainer(IReadOnlyModel)	Retourne le nom du conteneur par défaut.
GetDefaultContainerConfigurationSource(IConventionModel)	Retourne la source de configuration pour le nom de conteneur par défaut.
GetThroughput(IReadOnlyModel)	Retourne le débit provisionné à l’étendue de la base de données.
GetThroughputConfigurationSource(IConventionModel)	Obtient le ConfigurationSource pour le débit provisionné à l’étendue de la base de données.
SetDefaultContainer(IConventionModel, String, Boolean)	Définit le nom du conteneur par défaut.
SetThroughput(IConventionModel, Nullable<Int32>, Nullable<Boolean>, Boolean)	Définit le débit provisionné au niveau de l’étendue de la base de données.
AddDbFunction(IConventionModel, MethodInfo, Boolean)	Crée une fonction mappée à la méthode donnée.
AddDbFunction(IConventionModel, String, Type, Boolean)	Crée une fonction.
AddSequence(IConventionModel, String, String, Boolean)	Retourne l’existant IMutableSequence avec le nom donné dans le schéma donné ou crée une séquence avec le nom et le schéma donnés.
FindDbFunction(IConventionModel, MethodInfo)	Recherche une fonction mappée à la méthode représentée par le donné MethodInfo.
FindDbFunction(IConventionModel, String)	Recherche une fonction mappée à la méthode représentée par le nom donné.
FindDbFunction(IReadOnlyModel, MethodInfo)	Recherche une fonction mappée à la méthode représentée par le donné MethodInfo.
FindDbFunction(IReadOnlyModel, String)	Recherche une fonction mappée à la méthode représentée par le nom donné.
FindSequence(IConventionModel, String, String)	Recherche une séquence avec le nom donné.
FindSequence(IReadOnlyModel, String, String)	Recherche une séquence avec le nom donné.
GetCollation(IReadOnlyModel)	Retourne le classement de la base de données.
GetCollationConfigurationSource(IConventionModel)	Retourne la source de configuration du classement.
GetDbFunctions(IConventionModel)	Retourne toutes les fonctions contenues dans le modèle.
GetDbFunctions(IReadOnlyModel)	Retourne toutes les fonctions contenues dans le modèle.
GetDefaultSchema(IReadOnlyModel)	Retourne le schéma par défaut à utiliser pour le modèle, ou null si aucun n’a été défini.
GetDefaultSchemaConfigurationSource(IConventionModel)	Retourne la source de configuration pour le schéma par défaut.
GetMaxIdentifierLength(IReadOnlyModel)	Retourne la longueur maximale autorisée pour les identificateurs de magasin.
GetMaxIdentifierLengthConfigurationSource(IConventionModel)	Retourne la source de configuration pour GetMaxIdentifierLength(IReadOnlyModel).
GetSequences(IConventionModel)	Retourne toutes les séquences contenues dans le modèle.
GetSequences(IReadOnlyModel)	Retourne toutes les séquences contenues dans le modèle.
RemoveDbFunction(IConventionModel, MethodInfo)	Supprime la fonction mappée à la méthode représentée par le donné MethodInfo.
RemoveDbFunction(IConventionModel, String)	Supprime la fonction mappée à la méthode représentée par le donné MethodInfo.
RemoveSequence(IConventionModel, String, String)	Supprime le IConventionSequence avec le nom donné.
SetCollation(IConventionModel, String, Boolean)	Définit le classement de la base de données.
SetDefaultSchema(IConventionModel, String, Boolean)	Définit le schéma par défaut.
SetMaxIdentifierLength(IConventionModel, Nullable<Int32>, Boolean)	Définit la longueur maximale autorisée pour les identificateurs de magasin.
GetDatabaseMaxSize(IReadOnlyModel)	Retourne la taille maximale de la base de données.
GetDatabaseMaxSizeConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour la taille maximale de la base de données.
GetHiLoSequenceName(IReadOnlyModel)	Retourne le nom à utiliser pour la séquence hi-lo par défaut.
GetHiLoSequenceNameConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le nom de séquence hi-lo par défaut.
GetHiLoSequenceSchema(IReadOnlyModel)	Retourne le schéma à utiliser pour la séquence hi-lo par défaut. UseHiLo(PropertyBuilder, String, String)
GetHiLoSequenceSchemaConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le schéma de séquence hi-lo par défaut.
GetIdentityIncrement(IReadOnlyModel)	Retourne l’incrément d’identité par défaut.
GetIdentityIncrementConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour l’incrément d’identité par défaut.
GetIdentitySeed(IReadOnlyModel)	Retourne la valeur initiale d’identité par défaut.
GetIdentitySeedConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le schéma par défaut.
GetPerformanceLevelSql(IReadOnlyModel)	Retourne le niveau de performance de la base de données.
GetPerformanceLevelSqlConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le niveau de performances de la base de données.
GetSequenceNameSuffix(IReadOnlyModel)	Retourne le suffixe à ajouter au nom des séquences créées automatiquement.
GetSequenceNameSuffixConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le suffixe de nom de séquence de génération de valeur par défaut.
GetSequenceSchema(IReadOnlyModel)	Retourne le schéma à utiliser pour la séquence de génération de valeur par défaut. UseSequence(PropertyBuilder, String, String)
GetSequenceSchemaConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le schéma de séquence de génération de valeur de clé par défaut.
GetServiceTierSql(IReadOnlyModel)	Retourne le niveau de service de la base de données.
GetServiceTierSqlConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour le niveau de service de la base de données.
GetValueGenerationStrategy(IReadOnlyModel)	Retourne le SqlServerValueGenerationStrategy à utiliser pour les propriétés des clés dans le modèle, sauf si la propriété a une stratégie définie explicitement.
GetValueGenerationStrategyConfigurationSource(IConventionModel)	Retourne le ConfigurationSource pour la valeur par défaut SqlServerValueGenerationStrategy.
SetDatabaseMaxSize(IConventionModel, String, Boolean)	Définit la taille maximale de la base de données.
SetHiLoSequenceName(IConventionModel, String, Boolean)	Définit le nom à utiliser pour la séquence hi-lo par défaut.
SetHiLoSequenceSchema(IConventionModel, String, Boolean)	Définit le schéma à utiliser pour la séquence hi-lo par défaut.
SetIdentityIncrement(IConventionModel, Nullable<Int32>, Boolean)	Définit l’incrément d’identité par défaut.
SetIdentitySeed(IConventionModel, Nullable<Int64>, Boolean)	Définit la valeur initiale d’identité par défaut.
SetPerformanceLevelSql(IConventionModel, String, Boolean)	Définit le niveau de performances de la base de données.
SetSequenceNameSuffix(IConventionModel, String, Boolean)	Définit le suffixe à ajouter au nom des séquences créées automatiquement.
SetSequenceSchema(IConventionModel, String, Boolean)	Définit le schéma à utiliser pour la séquence de génération de valeur de clé par défaut.
SetServiceTierSql(IConventionModel, String, Boolean)	Définit le niveau de service de la base de données.
SetValueGenerationStrategy(IConventionModel, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Définit le SqlServerValueGenerationStrategy à utiliser pour les propriétés des clés dans le modèle qui n’ont pas de stratégie définie explicitement.