IReadOnlyProperty Interface

Définition

Espace de noms:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paquet:

Microsoft.EntityFrameworkCore v8.0.0

Représente une propriété scalaire d’un type structurel.

public interface IReadOnlyProperty : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyPropertyBase

type IReadOnlyProperty = interface
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyProperty
Implements IReadOnlyPropertyBase

Dérivé

Microsoft.EntityFrameworkCore.Metadata.IConventionProperty

Microsoft.EntityFrameworkCore.Metadata.IMutableProperty

Microsoft.EntityFrameworkCore.Metadata.IProperty

Microsoft.EntityFrameworkCore.Metadata.RuntimeProperty

Implémente

IReadOnlyAnnotatable IReadOnlyPropertyBase

Remarques

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

Propriétés

ClrType	Obtient le type de valeur que cet objet de type propriété contient. (Hérité de IReadOnlyPropertyBase)
DeclaringEntityType	Obsolète.. Obtient le type d’entité auquel cette propriété appartient.
DeclaringType	Obtient le type auquel cet objet de type propriété appartient. (Hérité de IReadOnlyPropertyBase)
FieldInfo	Obtient le FieldInfo pour le champ CLR sous-jacent pour cet objet de type propriété. Il peut s’agir null de propriétés d’ombre ou si le champ de stockage n’est pas connu. (Hérité de IReadOnlyPropertyBase)
IsConcurrencyToken	Obtient une valeur indiquant si cette propriété est 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é à partir 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.
IsNullable	Obtient une valeur indiquant si cette propriété peut contenir null.
IsPrimitiveCollection	Une propriété est une collection primitive si elle a un type d’élément qui correspond au type d’élément du type CLR.
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 objet de type propriété. (Hérité de IReadOnlyPropertyBase)
PropertyInfo	Obtient le PropertyInfo pour la propriété CLR sous-jacente pour cet objet de type propriété. Il peut s’agir null de propriétés d’ombre ou s’ils sont mappés directement à un champ. (Hérité de IReadOnlyPropertyBase)
Sentinel	Obtient la valeur sentinelle qui indique que cette propriété n’est pas définie. (Hérité de IReadOnlyPropertyBase)
ValueGenerated	Obtient 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() pour plus d’informations.

Méthodes

AnnotationsToDebugString(Int32)	Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet. (Hérité de IReadOnlyAnnotatable)
FindAnnotation(String)	Obtient l’annotation avec le nom donné, retournée null si elle n’existe pas. (Hérité de IReadOnlyAnnotatable)
FindContainingPrimaryKey()	Obtient la clé primaire qui utilise cette propriété (y compris une clé primaire composite dans laquelle cette propriété est incluse).
FindFirstPrincipal()	Recherche la première propriété principale par laquelle la propriété donnée est limitée si la propriété donnée fait partie d’une clé étrangère.
FindTypeMapping()	Retourne le mappage de type pour cette propriété.
GetAfterSaveBehavior()	Obtient une valeur indiquant si cette propriété peut être modifiée après l’enregistrement de l’entité dans la base de données.
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)
GetBeforeSaveBehavior()	Obtient une valeur indiquant si cette propriété peut être modifiée avant l’enregistrement de l’entité dans la base de données.
GetContainingForeignKeys()	Obtient toutes les clés étrangères qui utilisent cette propriété (y compris les clés étrangères composites dans lesquelles cette propriété est incluse).
GetContainingIndexes()	Obtient tous les index qui utilisent cette propriété (y compris les index composites dans lesquels cette propriété est incluse).
GetContainingKeys()	Obtient toutes les clés primaires ou secondaires qui utilisent cette propriété (y compris les clés composites dans lesquelles cette propriété est incluse).
GetElementType()	Obtient la configuration des éléments de la collection primitive représentée par cette propriété.
GetFieldName()	Obtient le nom du champ de stockage pour cette propriété, ou null si le champ de sauvegarde n’est pas connu. (Hérité de IReadOnlyPropertyBase)
GetJsonValueReaderWriter()	Obtient le JsonValueReaderWriter pour cette propriété, ou null si aucun n’est défini.
GetKeyValueComparer()	Obtient le ValueComparer à utiliser avec les clés pour cette propriété, ou null si aucune n’est définie.
GetMaxLength()	Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est un String , il s’agit du nombre maximal de caractères.
GetPrecision()	Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de chiffres.
GetPrincipals()	Recherche la liste des propriétés principales, y compris la propriété donnée par laquelle la propriété donnée est limitée si la propriété donnée fait partie d’une clé étrangère.
GetPrincipals<T>()	Recherche la liste des propriétés principales, y compris la propriété donnée par laquelle la propriété donnée est limitée si la propriété donnée fait partie d’une clé étrangère.
GetPropertyAccessMode()	Obtient le PropertyAccessMode qui est utilisé pour cet objet de type propriété. (Hérité de IReadOnlyPropertyBase)
GetProviderClrType()	Obtient le type vers lequel la valeur de propriété sera convertie avant d’être envoyée au fournisseur de base de données.
GetProviderValueComparer()	Obtient le ValueComparer à utiliser pour les valeurs de fournisseur pour cette propriété.
GetScale()	Obtient l’échelle des données autorisée dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de décimales.
GetTypeMapping()	Retourne le CoreTypeMapping pour la propriété donnée à partir d’un modèle finalisé.
GetValueComparer()	Obtient le ValueComparer pour cette propriété, ou null si aucun n’est défini.
GetValueConverter()	Obtient le jeu personnalisé ValueConverter pour cette propriété.
GetValueGeneratorFactory()	Obtient la fabrique qui a été définie pour générer des valeurs pour cette propriété, le cas échéant.
IsForeignKey()	Obtient une valeur indiquant si cette propriété est utilisée en tant que clé étrangère (ou partie d’une clé étrangère composite).
IsIndex()	Obtient une valeur indiquant si cette propriété est utilisée comme index (ou partie d’un index composite).
IsIndexerProperty()	Obtient une valeur indiquant s’il s’agit d’une propriété d’indexeur. Une propriété d’indexeur est accessible via un indexeur sur la classe d’entité. (Hérité de IReadOnlyPropertyBase)
IsKey()	Obtient une valeur indiquant si cette propriété est utilisée comme clé primaire ou comme clé secondaire (ou partie d’une clé primaire composite ou secondaire).
IsPrimaryKey()	Obtient une valeur indiquant si cette propriété est utilisée comme clé primaire (ou partie d’une clé primaire composite).
IsShadowProperty()	Obtient une valeur indiquant s’il s’agit d’une propriété d’ombre. Une propriété d’ombre est une propriété qui n’a pas de propriété correspondante dans la classe d’entité. La valeur actuelle de la propriété est stockée dans plutôt que dans les ChangeTracker instances de la classe d’entité. (Hérité de IReadOnlyPropertyBase)
IsUnicode()	Obtient une valeur indiquant si la propriété peut ou non conserver des caractères Unicode.
IsUniqueIndex()	Obtient une valeur indiquant si cette propriété est utilisée comme index unique (ou partie d’un index composite unique).
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.

Méthodes d’extension

GetJsonPropertyName(IReadOnlyProperty)	Retourne le nom de propriété auquel la propriété est mappée lors du ciblage de Cosmos.
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	Retourne les remplacements de la facette de propriété pour un objet de magasin de type table particulier. 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.
FindRelationalTypeMapping(IReadOnlyProperty)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	Recherche la première IProperty qui est mappée à la même colonne 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.
GetCollation(IReadOnlyProperty)	Retourne le classement à utiliser pour la colonne.
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le classement à utiliser pour la colonne.
GetColumnBaseName(IReadOnlyProperty)	Obsolète.. Retourne le nom de base de la colonne à laquelle la propriété serait mappée.
GetColumnName(IReadOnlyProperty)	Retourne le nom de la colonne à laquelle la propriété doit être mappée.
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom de la colonne à laquelle la propriété est mappée pour une table particulière.
GetColumnOrder(IReadOnlyProperty)	Retourne l’ordre de la colonne à laquelle cette propriété est mappée.
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’ordre de la colonne à laquelle cette propriété est mappée pour une table particulière.
GetColumnType(IReadOnlyProperty)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou null si le type de base de données est introuvable.
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le type de base de données de la colonne à laquelle la propriété est mappée, ou null si le type de base de données est introuvable.
GetComment(IReadOnlyProperty)	Retourne le commentaire de la colonne à laquelle cette propriété est mappée.
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le commentaire de la colonne à laquelle cette propriété est mappée.
GetComputedColumnSql(IReadOnlyProperty)	Retourne l’expression SQL utilisée comme valeur calculée pour la colonne à laquelle cette propriété est mappée.
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’expression SQL utilisée comme valeur calculée pour la colonne à laquelle cette propriété est mappée.
GetDefaultColumnBaseName(IReadOnlyProperty)	Obsolète.. Retourne le nom de base par défaut de la colonne à laquelle la propriété serait mappée
GetDefaultColumnName(IReadOnlyProperty)	Retourne le nom de base par défaut de la colonne à laquelle la propriété serait mappée
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom de colonne par défaut auquel la propriété doit être mappée.
GetDefaultValue(IReadOnlyProperty)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValueSql(IReadOnlyProperty)	Retourne l’expression SQL utilisée comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’expression SQL utilisée comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetIsStored(IReadOnlyProperty)	Obtient si la valeur de la colonne calculée à laquelle cette propriété est mappée est stockée dans la base de données ou calculée lors de sa lecture.
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	Obtient si la valeur de la colonne calculée à laquelle cette propriété est mappée est stockée dans la base de données ou calculée lors de sa lecture.
GetJsonPropertyName(IReadOnlyProperty)	Obtient la valeur du nom de propriété JSON utilisé pour la propriété donnée d’une entité mappée à une colonne JSON.
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	Retourne les objets de magasin de type table auxquels cette propriété est mappée. 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.
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	Obtient la longueur maximale des données autorisées dans cette propriété. Par exemple, si la propriété est un String , il s’agit du nombre maximal de caractères.
GetOverrides(IReadOnlyProperty)	Retourne tous les remplacements de la facette de propriété. 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.
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	Obtient la précision des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de chiffres.
GetRelationalTypeMapping(IReadOnlyProperty)	Retourne le RelationalTypeMapping pour la propriété donnée sur un modèle finalisé.
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	Obtient l’échelle des données autorisées dans cette propriété. Par exemple, si la propriété est un Decimal , il s’agit du nombre maximal de décimales.
IsColumnNullable(IReadOnlyProperty)	Vérifie si la colonne mappée au donné IProperty peut avoir la valeur Null lors de sa création dans la base de données.
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	Vérifie si la colonne mappée à la propriété donnée peut avoir la valeur Null lors de sa création dans la base de données.
IsFixedLength(IReadOnlyProperty)	Retourne un indicateur indiquant si la propriété est capable de stocker uniquement des données de longueur fixe, telles que des chaînes.
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	Retourne un indicateur indiquant si la propriété est capable de stocker uniquement des données de longueur fixe, telles que des chaînes.
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	Obtient une valeur indiquant si la propriété peut conserver les caractères Unicode.
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
TryGetDefaultValue(IReadOnlyProperty, Object)	Retourne l’objet utilisé comme valeur par défaut pour la colonne à laquelle cette propriété est mappée.
GetSrid(IReadOnlyProperty)	Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété.
GetSrid(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le SRID à utiliser lors de la création d’une colonne pour cette propriété.
FindHiLoSequence(IReadOnlyProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle hi-lo.
FindSequence(IReadOnlyProperty)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
FindSequence(IReadOnlyProperty, StoreObjectIdentifier)	Recherche dans le ISequence modèle à utiliser pour le modèle de génération de valeur de clé.
GetHiLoSequenceName(IReadOnlyProperty)	Retourne le nom à utiliser pour la séquence hi-lo.
GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom à utiliser pour la séquence hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty)	Retourne le schéma à utiliser pour la séquence hi-lo.
GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le schéma à utiliser pour la séquence hi-lo.
GetIdentityIncrement(IReadOnlyProperty)	Retourne l’incrément d’identité.
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	Retourne l’incrément d’identité.
GetIdentitySeed(IReadOnlyProperty)	Retourne la valeur initiale de l’identité.
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	Retourne la valeur initiale de l’identité.
GetSequenceName(IReadOnlyProperty)	Retourne le nom à utiliser pour la séquence de génération de valeur de clé.
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le nom à utiliser pour la séquence de génération de valeur de clé.
GetSequenceSchema(IReadOnlyProperty)	Retourne le schéma à utiliser pour la séquence de génération de valeur de clé.
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le schéma à utiliser pour la séquence de génération de valeur de clé.
GetValueGenerationStrategy(IReadOnlyProperty)	Retourne le SqlServerValueGenerationStrategy à utiliser pour la propriété .
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	Retourne le SqlServerValueGenerationStrategy à utiliser pour la propriété .
IsSparse(IReadOnlyProperty)	Retourne une valeur indiquant si la colonne de la propriété est éparse.
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	Retourne une valeur indiquant si la colonne de la propriété est éparse.