IConventionModel Interface

Définition

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

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 créé, IModel représente une vue en lecture seule des mêmes métadonnées.

public interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IModel
type IConventionModel = interface
    interface IModel
    interface IAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionModel
Implements IConventionAnnotatable, IModel
Implémente

Propriétés

Builder

Obtient le générateur qui peut être utilisé pour configurer ce modèle.

Item[String]

Obtient l’annotation de valeur portant le nom donné, en retournant null si elle n’existe pas.

(Hérité de IAnnotatable)

Méthodes

AddAnnotation(String, Object, Boolean)

Ajoute une annotation à cet objet. Lève une exception si une annotation portant le nom spécifié existe déjà.

(Hérité de IConventionAnnotatable)
AddEntityType(String, Boolean)

Ajoute un type d’entité État Shadow au modèle.

Les entités Shadow ne sont actuellement pas prises en charge dans un modèle qui est utilisé au moment de l’exécution avec un DbContext . Par conséquent, les types d’entités d’état d’ombre n’existent que dans les instantanés de modèle de migration, etc.

AddEntityType(String, String, IConventionEntityType, Boolean)

Ajoute un type d’entité avec une navigation qui définit le modèle.

AddEntityType(String, Type, Boolean)

Ajoute un type d’entité de type partagé au modèle.

Le type d’entité de type partagé est un type d’entité qui peut partager le type CLR avec d’autres types dans le modèle, mais qui a un nom unique et qui est toujours identifié par le nom.

AddEntityType(Type, Boolean)

Ajoute un type d’entité au modèle.

AddEntityType(Type, String, IConventionEntityType, Boolean)

Ajoute un type d’entité avec une navigation qui définit le modèle.

AddIgnored(String, Boolean)

Marque le nom du type d’entité donné comme étant ignoré.

FindAnnotation(String)

Obtient l’annotation portant le nom donné, en retournant null si elle n’existe pas.

(Hérité de IConventionAnnotatable)
FindEntityType(String)

Obtient l’entité avec le nom donné. Retourne null si aucun type d’entité portant le nom spécifié n’est trouvé ou si le type CLR donné est utilisé par un 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, IEntityType)

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 la valeur null si aucun type d’entité correspondant n’est trouvé.

(Hérité de IModel)
FindIgnoredConfigurationSource(String)

Indique si le nom du type d’entité donné est ignoré.

GetAnnotations()

Obtient toutes les annotations sur l’objet actuel.

(Hérité de IConventionAnnotatable)
GetEntityTypes()

Obtient tous les types d’entités définis dans le modèle.

IsShared(Type)

Obtient une valeur indiquant si le type CLR est utilisé par les entités de type partagé dans le modèle.

RemoveAnnotation(String)

Supprime l’annotation portant le nom donné à partir de cet objet.

(Hérité de IConventionAnnotatable)
RemoveEntityType(IConventionEntityType)

Supprime un type d’entité du modèle.

RemoveIgnored(String)

Supprime le nom du type d’entité ignoré.

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)

Méthodes d’extension

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Ajoute des annotations à un objet.

GetAnnotation(IConventionAnnotatable, String)

Obtient l’annotation portant le nom donné, en levant si elle n’existe pas.

SetOrRemoveAnnotation(IConventionAnnotatable, 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 fourni.

AddIgnored(IConventionModel, Type, Boolean)

Marque le type d’entité donné comme étant ignoré.

AddOwned(IConventionModel, Type, Boolean)

Marque le type d’entité donné comme détenu, indiquant que lorsque les types d’entités détectés à l’aide du type donné doivent être configurés comme appartenant.

AddShared(IConventionModel, Type, Boolean)

Marque le type d’entité donné comme Shared, indiquant ainsi que lorsque les types d’entité correspondants détectés doivent être configurés en tant que type d’entité de type partagé.

FinalizeModel(IConventionModel)

Force le suivi du traitement sur le modèle de sorte qu’il soit prêt à être utilisé par le Runtime. Ce traitement de publication s’effectue automatiquement lors de l’utilisation OnModelCreating(ModelBuilder) de ; cette méthode lui permet d’être exécutée explicitement dans les cas où l’exécution automatique n’est pas possible.

FindEntityType(IConventionModel, Type)

Obtient l’entité qui mappe la classe d’entité donnée. Retourne null si aucun type d’entité portant le nom spécifié n’est trouvé.

FindEntityType(IConventionModel, 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é.

FindIgnoredConfigurationSource(IConventionModel, Type)

Indique si le type d’entité donné est ignoré.

FindIsOwnedConfigurationSource(IConventionModel, Type)

Retourne une valeur indiquant si les types d’entités qui utilisent le type donné doivent être configurés en tant que types détenus lorsqu’ils sont découverts.

FindLeastDerivedEntityTypes(IConventionModel, Type, Func<IConventionEntityType,Boolean>)

Retourne les types d’entités correspondant aux types les moins dérivés du donné.

GetChangeTrackingStrategyConfigurationSource(IConventionModel)

Retourne la source de configuration pour GetChangeTrackingStrategy(IModel) .

GetEntityTypes(IConventionModel, String)

Obtient les types d’entités correspondant au nom donné.

GetEntityTypes(IConventionModel, Type)

Obtient les types d’entités correspondant au type donné.

GetPropertyAccessModeConfigurationSource(IConventionModel)

Retourne la source de configuration pour GetPropertyAccessMode(IModel) .

IsIgnored(IConventionModel, String)

Indique si le nom du type d’entité donné est ignoré.

IsIgnored(IConventionModel, Type)

Indique si le type d’entité donné est ignoré.

IsOwned(IConventionModel, Type)

Retourne une valeur indiquant si les types d’entités qui utilisent le type donné doivent être configurés en tant que types détenus lorsqu’ils sont découverts.

RemoveEntityType(IConventionModel, String)

Supprime un type d’entité sans la définition de la navigation à partir du modèle.

RemoveEntityType(IConventionModel, String, String, IConventionEntityType)

Supprime un type d’entité avec un qui définit la navigation à partir du modèle.

RemoveEntityType(IConventionModel, Type)

Supprime un type d’entité du modèle.

RemoveEntityType(IConventionModel, Type, String, IConventionEntityType)

Supprime un type d’entité avec un qui définit la navigation à partir du modèle.

RemoveOwned(IConventionModel, Type)

Supprime le type détenu donné, indiquant que lorsque les types d’entités correspondants détectés ne doivent pas être configurés comme appartenant.

SetChangeTrackingStrategy(IConventionModel, 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é.

SetPropertyAccessMode(IConventionModel, Nullable<PropertyAccessMode>, Boolean)

Définit le PropertyAccessMode à utiliser pour les propriétés de tous les types d’entités de ce modèle.

Notez que les types d’entités individuels peuvent remplacer ce mode d’accès, et les propriétés individuelles des types d’entité peuvent remplacer le mode d’accès défini sur le type d’entité. La valeur définie ici sera utilisée pour toute propriété pour laquelle aucune substitution n’a été spécifiée.

GetDefaultContainer(IModel)

Retourne le nom du conteneur par défaut.

GetDefaultContainerConfigurationSource(IConventionModel)

Retourne la source de configuration pour le nom de conteneur par défaut.

SetDefaultContainer(IConventionModel, String, Boolean)

Définit le nom du conteneur par défaut.

AnnotationsToDebugString(IAnnotatable, Int32)

Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet.

GetAnnotation(IAnnotatable, String)

Obtient l’annotation portant le nom donné, en levant si elle n’existe pas.

FindEntityType(IModel, Type)

Obtient l’entité qui mappe la classe d’entité donnée. Retourne null si aucun type d’entité avec le type CLR 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(IModel, Type, String, IEntityType)

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

FindRuntimeEntityType(IModel, Type)

Obtient l’entité qui mappe la classe d’entité donnée, où la classe peut être un proxy dérivé du type d’entité réel. Retourne null si aucun type d’entité avec le type CLR 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.

GetChangeTrackingStrategy(IModel)

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

GetEntityTypes(IModel, String)

Obtient les types d’entités correspondant au nom donné.

GetEntityTypes(IModel, Type)

Obtient les types d’entités correspondant au type donné.

GetProductVersion(IModel)

Obtient la version de l’assembly de EF Core utilisée pour générer ce modèle

GetPropertyAccessMode(IModel)

Obtient le PropertyAccessMode utilisé pour les propriétés des types d’entités dans ce modèle.

Notez que les types d’entités individuels peuvent remplacer ce mode d’accès, et les propriétés individuelles des types d’entité peuvent remplacer le mode d’accès défini sur le type d’entité. La valeur retournée ici sera utilisée pour toute propriété pour laquelle aucune substitution n’a été spécifiée.

HasEntityTypeWithDefiningNavigation(IModel, String)

Obtient une valeur indiquant si le modèle contient un type d’entité correspondant avec une navigation de définition.

HasEntityTypeWithDefiningNavigation(IModel, Type)

Obtient une valeur indiquant si le modèle contient un type d’entité correspondant avec une navigation de définition.

IsIndexerMethod(IModel, MethodInfo)

Obtient une valeur indiquant si le MethodInfo donné reprensent un accès à un indexeur.

IsShared(IModel, Type)

Obtient une valeur indiquant si le type CLR est utilisé par les entités de type partagé dans le modèle.

ToDebugString(IModel, MetadataDebugStringOptions, Int32)

Crée une représentation explicite des métadonnées données.

AVERTISSEMENT : ne comptez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions.

AddDbFunction(IConventionModel, MethodInfo, Boolean)

Crée un IConventionDbFunction mappé à la méthode donnée.

AddDbFunction(IConventionModel, String, Type, Boolean)

Crée un objet IConventionDbFunction.

AddSequence(IConventionModel, String, String, Boolean)

Retourne le existant IMutableSequence avec le nom donné dans le schéma donné ou crée une nouvelle séquence avec le nom et le schéma donnés.

FindDbFunction(IConventionModel, MethodInfo)

Recherche un IConventionDbFunction qui est mappé à la méthode représentée par le donné MethodInfo .

FindDbFunction(IConventionModel, String)

Recherche un IConventionDbFunction qui est mappé à la méthode représentée par le nom donné.

FindDbFunction(IModel, MethodInfo)

Recherche un IDbFunction qui est mappé à la méthode représentée par le donné MethodInfo .

FindDbFunction(IModel, String)

Recherche un IDbFunction qui est mappé à la méthode représentée par le nom donné.

FindSequence(IConventionModel, String, String)

Recherche un IConventionSequence avec le nom donné.

FindSequence(IModel, String, String)

Recherche un ISequence avec le nom donné.

GetCollation(IModel)

Retourne le classement de base de données.

GetCollationConfigurationSource(IConventionModel)

Retourne la source de configuration pour le classement.

GetDbFunctions(IConventionModel)

Retourne tous les IConventionDbFunction contenus dans le modèle.

GetDbFunctions(IModel)

Retourne tous les IDbFunction contenus dans le modèle.

GetDefaultSchema(IModel)

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(IModel)

Retourne la longueur maximale autorisée pour les identificateurs de magasin.

GetMaxIdentifierLengthConfigurationSource(IConventionModel)

Retourne la source de configuration pour GetMaxIdentifierLength(IModel) .

GetRelationalModel(IModel)

Retourne le modèle de base de données.

GetSequences(IConventionModel)

Retourne tous les IConventionSequence contenus dans le modèle.

GetSequences(IModel)

Retourne tous les ISequence contenus dans le modèle.

RemoveDbFunction(IConventionModel, MethodInfo)

Supprime le IConventionDbFunction qui est mappé à la méthode représentée par le donné MethodInfo .

RemoveDbFunction(IConventionModel, String)

Supprime le IConventionDbFunction qui est mappé à 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 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(IModel)

Retourne la taille maximale de la base de données.

GetDatabaseMaxSizeConfigurationSource(IConventionModel)

Retourne ConfigurationSource pour la taille maximale de la base de données.

GetHiLoSequenceName(IModel)

Retourne le nom à utiliser pour la séquence Hi-Lo par défaut.

GetHiLoSequenceNameConfigurationSource(IConventionModel)

Retourne ConfigurationSource pour le nom de la séquence Hi-Lo par défaut.

GetHiLoSequenceSchema(IModel)

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(IModel)

Retourne l’incrément d’identité par défaut.

GetIdentityIncrementConfigurationSource(IConventionModel)

Retourne ConfigurationSource pour l’incrément d’identité par défaut.

GetIdentitySeed(IModel)

Retourne la valeur initiale d’identité par défaut.

GetIdentitySeedConfigurationSource(IConventionModel)

Retourne le ConfigurationSource pour le schéma par défaut.

GetPerformanceLevelSql(IModel)

Retourne le niveau de performance de la base de données.

GetPerformanceLevelSqlConfigurationSource(IConventionModel)

Retourne le ConfigurationSource pour le niveau de performance de la base de données.

GetServiceTierSql(IModel)

Retourne le niveau de service de la base de données.

GetServiceTierSqlConfigurationSource(IConventionModel)

Retourne le ConfigurationSource pour la couche de service de la base de données.

GetValueGenerationStrategy(IModel)

Retourne le SqlServerValueGenerationStrategy à utiliser pour les propriétés des clés dans le modèle, à moins que la propriété ait une stratégie définie explicitement.

GetValueGenerationStrategyConfigurationSource(IConventionModel)

Retourne 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<Int32>, Boolean)

Définit la valeur initiale d’identité par défaut.

SetPerformanceLevelSql(IConventionModel, String, Boolean)

Définit le niveau de performance de la base de données.

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.

S’applique à