IConventionPropertyBuilder Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata.Builders

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Fournit une surface d’API simple pour la configuration d’un à partir de IConventionProperty conventions.

Cette interface 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.

public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>

type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder<IConventionPropertyBuilder>
    interface IConventionAnnotatableBuilder

Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder(Of IConventionPropertyBuilder)

Implémente

IConventionAnnotatableBuilder IConventionPropertyBaseBuilder<IConventionPropertyBuilder>

Remarques

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

Propriétés

Metadata	Obtient la propriété en cours de configuration.
ModelBuilder	Obtient le générateur de modèles. (Hérité de IConventionAnnotatableBuilder)

Méthodes

AfterSave(Nullable<PropertySaveBehavior>, Boolean)	Configure si cette propriété peut être modifiée après l’enregistrement de l’entité dans la base de données.
BeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Configure si cette propriété peut être modifiée avant l’enregistrement de l’entité dans la base de données.
CanRemoveAnnotation(String, Boolean)	Retourne une valeur indiquant si une annotation portant le nom donné peut être supprimée à l’aide de cette source de configuration. (Hérité de IConventionAnnotatableBuilder)
CanSetAfterSave(Nullable<PropertySaveBehavior>, Boolean)	Retourne une valeur indiquant si la possibilité de modifier une fois l’entité enregistrée dans la base de données peut être configurée pour cette propriété à partir de la source de configuration actuelle.
CanSetAnnotation(String, Object, Boolean)	Retourne une valeur indiquant si une annotation avec le nom et la valeur donnés peut être définie à partir de cette source de configuration. (Hérité de IConventionAnnotatableBuilder)
CanSetBeforeSave(Nullable<PropertySaveBehavior>, Boolean)	Retourne une valeur indiquant si la possibilité d’être modifiée avant l’enregistrement de l’entité dans la base de données peut être configurée pour cette propriété à partir de la source de configuration actuelle.
CanSetConversion(Type, Boolean)	Retourne une valeur indiquant si le type donné à convertir des valeurs vers et depuis peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetConversion(ValueConverter, Boolean)	Retourne une valeur indiquant si peut ValueConverter être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetConverter(Type, Boolean)	Retourne une valeur indiquant si peut ValueConverter être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetElementType(Type, Boolean)	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.
CanSetIsConcurrencyToken(Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si la propriété peut être configurée en tant que jeton d’accès concurrentiel à partir de la source de configuration actuelle.
CanSetIsRequired(Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si cette propriété requiredness peut être configurée à partir de la source de configuration actuelle.
CanSetIsUnicode(Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si la propriété peut être configurée comme capable de conserver des caractères Unicode à partir de la source de configuration actuelle.
CanSetMaxLength(Nullable<Int32>, Boolean)	Retourne une valeur indiquant si la longueur maximale autorisée des données peut être définie pour cette propriété à partir de la source de configuration actuelle.
CanSetPrecision(Nullable<Int32>, Boolean)	Retourne une valeur indiquant si la précision des données autorisées peut être définie pour cette propriété à partir de la source de configuration actuelle.
CanSetProviderValueComparer(Type, Boolean)	Retourne une valeur indiquant si le donné ValueComparer peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetProviderValueComparer(ValueComparer, Boolean)	Retourne une valeur indiquant si le donné ValueComparer peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetScale(Nullable<Int32>, Boolean)	Retourne une valeur indiquant si l’échelle de données autorisée peut être définie pour cette propriété à partir de la source de configuration actuelle.
CanSetSentinel(Object, Boolean)	Retourne une valeur indiquant si la sentinel peut être définie pour cette propriété à partir de la source de configuration actuelle.
CanSetTypeMapping(CoreTypeMapping, Boolean)	Retourne une valeur indiquant si le donné CoreTypeMapping peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetValueComparer(Type, Boolean)	Retourne une valeur indiquant si le donné ValueComparer peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetValueComparer(ValueComparer, Boolean)	Retourne une valeur indiquant si le donné ValueComparer peut être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetValueGenerated(Nullable<ValueGenerated>, Boolean)	Retourne une valeur indiquant si la génération de la valeur de propriété peut être configurée à partir de la source de configuration actuelle.
CanSetValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Retourne une valeur indiquant si peut ValueGenerator être configuré pour cette propriété à partir de la source de configuration actuelle.
CanSetValueGeneratorFactory(Type, Boolean)	Retourne une valeur indiquant si peut ValueGeneratorFactory être configuré pour cette propriété à partir de la source de configuration actuelle.
HasAnnotation(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à avec le même ou inférieur ConfigurationSource. (Hérité de IConventionPropertyBaseBuilder<TBuilder>)
HasConversion(Type, Boolean)	Configure la propriété de sorte que la valeur de la propriété soit convertie au type donné avant l’écriture dans la base de données et reconverti lors de la lecture à partir de la base de données.
HasConversion(ValueConverter, Boolean)	Configure la propriété afin que la valeur de la propriété soit convertie vers et à partir de la base de données à l’aide du donné ValueConverter.
HasConverter(Type, Boolean)	Configure la propriété afin que la valeur de la propriété soit convertie vers et à partir de la base de données à l’aide du donné ValueConverter.
HasMaxLength(Nullable<Int32>, Boolean)	Configure la longueur maximale des données pouvant être stockées dans cette propriété.
HasNoAnnotation(String, Boolean)	Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(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à avec le même ou inférieur ConfigurationSource. Supprime l’annotation si null la valeur est spécifiée. (Hérité de IConventionPropertyBaseBuilder<TBuilder>)
HasPrecision(Nullable<Int32>, Boolean)	Configure la précision de la propriété.
HasProviderValueComparer(Type, Boolean)	Configure le ValueComparer à utiliser pour les valeurs de fournisseur pour cette propriété.
HasProviderValueComparer(ValueComparer, Boolean)	Configure le ValueComparer à utiliser pour les valeurs de fournisseur pour cette propriété.
HasScale(Nullable<Int32>, Boolean)	Configure l’échelle de la propriété .
HasSentinel(Object, Boolean)	Configure la valeur qui sera utilisée pour déterminer si la propriété a été définie ou non. Si la propriété est définie sur la valeur sentinelle, elle est considérée comme non définie. Par défaut, la valeur sentinelle est la valeur par défaut du CLR pour le type de la propriété.
HasTypeMapping(CoreTypeMapping, Boolean)	Configure pour CoreTypeMapping cette propriété.
HasValueComparer(Type, Boolean)	Configure pour ValueComparer cette propriété.
HasValueComparer(ValueComparer, Boolean)	Configure pour ValueComparer cette propriété.
HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)	Configure le ValueGenerator qui générera des valeurs pour cette propriété.
HasValueGenerator(Type, Boolean)	Configure le ValueGenerator qui générera des valeurs pour cette propriété.
HasValueGeneratorFactory(Type, Boolean)	Configure le ValueGeneratorFactory pour créer un ValueGenerator qui générera des valeurs pour cette propriété.
IsConcurrencyToken(Nullable<Boolean>, Boolean)	Configure si cette propriété doit être utilisée comme jeton d’accès concurrentiel. Lorsqu’une propriété est configurée en tant que jeton d’accès concurrentiel, la valeur de la base de données est vérifiée lorsqu’une instance de ce type d’entité est mise à jour ou supprimée pendant SaveChanges() pour s’assurer qu’elle n’a pas changé depuis que le instance a été récupéré de la base de données. Si elle a changé, une exception est levée et les modifications ne sont pas appliquées à la base de données.
IsRequired(Nullable<Boolean>, Boolean)	Configure si cette propriété doit avoir une valeur affectée ou null s’il s’agit d’une valeur valide. Une propriété ne peut être configurée comme non obligatoire que si elle est basée sur un type CLR qui peut être affecté null.
IsUnicode(Nullable<Boolean>, Boolean)	Configure si la propriété est capable de conserver des caractères Unicode.
SetElementType(Type, Boolean)	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.
ValueGenerated(Nullable<ValueGenerated>, Boolean)	Définit une valeur indiquant quand une valeur pour cette propriété sera générée par la base de données. Même lorsque la propriété est définie pour être générée par la base de données, EF peut toujours tenter d’enregistrer une valeur spécifique (plutôt que d’en avoir une générée par la base de données) lorsque l’entité est ajoutée et qu’une valeur est affectée, ou que la propriété est marquée comme modifiée pour une entité existante. Pour plus d’informations et d’exemples, consultez GetBeforeSaveBehavior() et GetAfterSaveBehavior() .

Méthodes d’extension

CanSetJsonProperty(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si le nom de propriété donné peut être défini.
ToJsonProperty(IConventionPropertyBuilder, String, Boolean)	Configure le nom de propriété auquel la propriété est mappée lors du ciblage d’Azure Cosmos. Si une chaîne vide est fournie, la propriété n’est pas conservée.
CanSetCollation(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme classement.
CanSetColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Retourne une valeur indiquant si la colonne donnée pour un objet de magasin de type table particulier peut être définie pour la propriété .
CanSetColumnName(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si la colonne donnée peut être définie pour la propriété .
CanSetColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Obtient une valeur indiquant si l’ordre de colonne donné peut être défini pour la propriété .
CanSetColumnType(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si le type de données donné peut être défini pour la propriété .
CanSetComment(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme commentaire pour la colonne.
CanSetComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si l’expression SQL de valeur calculée donnée peut être définie pour la colonne.
CanSetDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme valeur par défaut pour la colonne.
CanSetDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si l’expression de valeur par défaut donnée peut être définie pour la colonne.
CanSetIsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si la propriété peut être configurée comme étant de longueur fixe ou non.
CanSetIsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si le type de colonne calculé donné peut être défini pour la colonne.
CanSetJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être utilisée comme nom de propriété JSON pour une propriété d’entité donnée.
HasColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)	Configure la colonne à laquelle la propriété est mappée dans un objet de magasin de type table particulier.
HasColumnName(IConventionPropertyBuilder, String, Boolean)	Configure la colonne à laquelle la propriété est mappée lors du ciblage d’une base de données relationnelle.
HasColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configure l’ordre de la colonne à laquelle la propriété est mappée.
HasColumnType(IConventionPropertyBuilder, String, Boolean)	Configure le type de données de la colonne à laquelle la propriété est mappée lors du ciblage d’une base de données relationnelle. Il doit s’agir du nom de type complet, y compris la précision, l’échelle, la longueur, etc.
HasComment(IConventionPropertyBuilder, String, Boolean)	Configure un commentaire à appliquer à la colonne
HasComputedColumnSql(IConventionPropertyBuilder, String, Boolean)	Configure la propriété pour qu’elle soit mappée à une colonne calculée lors du ciblage d’une base de données relationnelle.
HasDefaultValue(IConventionPropertyBuilder, Object, Boolean)	Configure la valeur par défaut pour la colonne à laquelle la propriété est mappée lors du ciblage d’une base de données relationnelle.
HasDefaultValueSql(IConventionPropertyBuilder, String, Boolean)	Configure l’expression de valeur par défaut pour la colonne à laquelle la propriété est mappée lors du ciblage d’une base de données relationnelle.
HasJsonPropertyName(IConventionPropertyBuilder, String, Boolean)	Configure la propriété d’une entité mappée à une colonne JSON, en mappant la propriété d’entité à une propriété JSON spécifique, plutôt que d’utiliser le nom de la propriété d’entité.
IsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configure la propriété comme capable de stocker uniquement des données de longueur fixe, telles que des chaînes.
IsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configure la propriété pour qu’elle soit mappée à une colonne calculée du type donné lors du ciblage d’une base de données relationnelle.
UseCollation(IConventionPropertyBuilder, String, Boolean)	Configure la propriété pour utiliser le classement donné. La colonne de base de données sera créée avec le classement donné et sera utilisée implicitement dans toutes les opérations sensibles au classement.
CanSetSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme SRID pour la colonne.
HasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configure le SRID de la colonne à laquelle la propriété est mappée lors du ciblage de SQLite.
CanSetHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Retourne une valeur indiquant si le nom et le schéma donnés peuvent être définis pour la séquence hi-lo.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme incrément pour SQL Server IDENTITY pour une table particulière.
CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme incrément pour SQL Server IDENTITY.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme valeur initiale pour SQL Server IDENTITY pour une table particulière.
CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme valeur initiale pour SQL Server IDENTITY.
CanSetIsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Retourne une valeur indiquant si la colonne de la propriété peut être configurée comme éparse lors du ciblage de SQL Server.
CanSetSequence(IConventionPropertyBuilder, String, String, Boolean)	Retourne une valeur indiquant si le nom et le schéma donnés peuvent être définis pour la séquence de génération de valeur de clé.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme stratégie de génération de valeur pour une table particulière.
CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Retourne une valeur indiquant si la valeur donnée peut être définie comme stratégie de génération de valeur.
HasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)	Configure la séquence de base de données utilisée pour le modèle hi-lo afin de générer des valeurs pour la propriété de clé, lors du ciblage de SQL Server.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)	Configure l’incrément pour SQL Server IDENTITY pour une table particulière.
HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)	Configure l’incrément pour SQL Server IDENTITY.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)	Configure le seed pour SQL Server IDENTITY pour une table particulière.
HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)	Configure le seed pour SQL Server IDENTITY.
HasSequence(IConventionPropertyBuilder, String, String, Boolean)	Configure la séquence de base de données utilisée pour le modèle de génération de valeur de clé afin de générer des valeurs pour la propriété key, lors du ciblage de SQL Server.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)	Configure la stratégie de génération de valeur pour la propriété clé, lors du ciblage de SQL Server pour une table particulière.
HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)	Configure la stratégie de génération de valeur pour la propriété de clé, lors du ciblage de SQL Server.
IsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)	Configure si la colonne de la propriété est créée comme partiellement éparse lors du ciblage de SQL Server.