IMutableKey Interface

  • Référence

Définition

Espace de noms:
Microsoft.EntityFrameworkCore.Metadata
Assembly:
Microsoft.EntityFrameworkCore.dll
Paquet:
Microsoft.EntityFrameworkCore v1.0.6
Paquet:
Microsoft.EntityFrameworkCore v1.1.6
Paquet:
Microsoft.EntityFrameworkCore v2.0.3
Paquet:
Microsoft.EntityFrameworkCore v2.1.11
Paquet:
Microsoft.EntityFrameworkCore v2.2.6
Paquet:
Microsoft.EntityFrameworkCore v3.0.0
Paquet:
Microsoft.EntityFrameworkCore v3.1.0
Paquet:
Microsoft.EntityFrameworkCore v5.0.0
Paquet:
Microsoft.EntityFrameworkCore v6.0.0
Paquet:
Microsoft.EntityFrameworkCore v7.0.0
Paquet:
Microsoft.EntityFrameworkCore v8.0.0

Représente une clé primaire ou alternative sur une entité.

public interface IMutableKey : Microsoft.EntityFrameworkCore.Metadata.IKey, Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable
public interface IMutableKey : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey
type IMutableKey = interface
    interface IMutableAnnotatable
    interface IAnnotatable
    interface IKey
type IMutableKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable
Public Interface IMutableKey
Implements IKey, IMutableAnnotatable
Public Interface IMutableKey
Implements IMutableAnnotatable, IReadOnlyKey
Implémente
IAnnotatable IKey IMutableAnnotatable IReadOnlyAnnotatable IReadOnlyKey

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

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

Propriétés

DeclaringEntityType

Obtient le type d’entité sur lequel la clé est définie. Cela peut être différent du type défini Properties sur lorsque la clé est définie comme type dérivé dans une hiérarchie d’héritage (car les propriétés peuvent être définies sur un type de base).
Item[String]

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

(Hérité de IReadOnlyAnnotatable)
Properties

Obtient les propriétés qui composent la clé.

Méthodes

AddAnnotation(String, Object)

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

(Hérité de IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)

Ajoute des annotations à un objet .

(Hérité de IMutableAnnotatable)
AddRuntimeAnnotation(String, Object)

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

(Hérité de IAnnotatable)
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é, en retournant null si elle n’existe pas.

(Hérité de IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Obtient l’annotation d’exécution avec le nom donné, en retournant null si elle n’existe pas.

(Hérité de IAnnotatable)
FindRuntimeAnnotationValue(String)

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

(Hérité de IAnnotatable)
GetAnnotation(String)

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

(Hérité de IReadOnlyAnnotatable)
GetAnnotations()

Obtient toutes les annotations sur l’objet actuel.

(Hérité de IReadOnlyAnnotatable)
GetKeyType()

Retourne le type de la propriété key pour les clés simples, ou un tableau d’objets pour les clés composites.

(Hérité de IKey)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Obtient la valeur de l’annotation runtime avec le nom donné, en l’ajoutant si elle n’existe pas.

(Hérité de IAnnotatable)
GetPrincipalKeyValueFactory()

Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé extraites de différentes formes de données d’entité.

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.

(Hérité de IKey)
GetPrincipalKeyValueFactory<TKey>()

Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé extraites de différentes formes de données d’entité.

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.

(Hérité de IKey)
GetReferencingForeignKeys()

Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
GetRuntimeAnnotations()

Obtient toutes les annotations d’exécution sur l’objet actuel.

(Hérité de IAnnotatable)
IsPrimaryKey()

Retourne une valeur indiquant si la clé est la clé primaire.

(Hérité de IReadOnlyKey)
RemoveAnnotation(String)

Supprime l’annotation donnée de cet objet.

(Hérité de IMutableAnnotatable)
RemoveRuntimeAnnotation(String)

Supprime l’annotation d’exécution donnée de cet objet.

(Hérité de IAnnotatable)
SetAnnotation(String, Object)

Définit l’annotation stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà.

(Hérité de IMutableAnnotatable)
SetOrRemoveAnnotation(String, Object)

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 IMutableAnnotatable)
SetRuntimeAnnotation(String, Object)

Définit l’annotation d’exécution stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà.

(Hérité de IAnnotatable)
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 IReadOnlyKey)

Méthodes d’extension

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 lisant si elle n’existe pas.
GetKeyType(IKey)

Retourne le type de la propriété key pour les clés simples, ou un tableau d’objets pour les clés composites.
GetPrincipalKeyValueFactory<TKey>(IKey)

Obtient une fabrique pour les valeurs de clé basées sur les valeurs de clé d’index extraites de différentes formes de données d’entité.

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.

GetReferencingForeignKeys(IKey)

Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
IsPrimaryKey(IKey)

Retourne une valeur indiquant si la clé est la clé primaire.
ToDebugString(IKey, 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.

AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)

Ajoute des annotations à un objet .
GetAnnotation(IMutableAnnotatable, String)

Obtient l’annotation portant le nom donné, en lisant si elle n’existe pas.
GetOrAddAnnotation(IMutableAnnotatable, String, String)

Obtient l’annotation existante avec une clé donnée ou ajoute une nouvelle annotation si elle n’existe pas.
SetOrRemoveAnnotation(IMutableAnnotatable, String, Object)

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.
GetReferencingForeignKeys(IMutableKey)

Obtient toutes les clés étrangères qui ciblent une clé primaire ou secondaire donnée.
FindSharedObjectRootKey(IKey, StoreObjectIdentifier)

Recherche la première IConventionKey qui est mappée à la même contrainte 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 de l’application.

FindSharedObjectRootKey(IMutableKey, StoreObjectIdentifier)

Recherche la première IMutableKey qui est mappée à la même contrainte 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 de l’application.

FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)

Recherche la première IKey qui est mappée à la même contrainte 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 de l’application.

GetDefaultName(IKey)

Retourne le nom de la contrainte de clé par défaut qui serait utilisé pour cette clé.
GetDefaultName(IKey, StoreObjectIdentifier)

Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé pour une table particulière.
GetDefaultName(IReadOnlyKey)

Retourne le nom de la contrainte de clé par défaut qui serait utilisé pour cette clé.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)

Retourne le nom de contrainte de clé par défaut qui serait utilisé pour cette clé pour une table particulière.
GetMappedConstraints(IKey)

Obtient les contraintes uniques auxquelles la clé est mappée.
GetName(IKey)

Retourne le nom de la contrainte de clé pour cette clé.
GetName(IKey, StoreObjectIdentifier)

Retourne le nom de la contrainte de clé pour cette clé pour une table particulière.
GetName(IReadOnlyKey)

Retourne le nom de la contrainte de clé pour cette clé.
GetName(IReadOnlyKey, StoreObjectIdentifier)

Retourne le nom de la contrainte de clé pour cette clé pour une table particulière.
SetName(IMutableKey, String)

Définit le nom de la contrainte de clé pour cette clé.
Relational(IKey)

Obtient les métadonnées spécifiques à la base de données relationnelle pour une clé.
Relational(IMutableKey)

Obtient les métadonnées spécifiques à la base de données relationnelle pour une clé.
Sqlite(IKey)

Obtient les métadonnées spécifiques à SQLite pour une clé.
Sqlite(IMutableKey)

Obtient les métadonnées spécifiques à SQLite pour une clé.
IsClustered(IKey)

Retourne une valeur indiquant si la clé est en cluster.
IsClustered(IKey, StoreObjectIdentifier)

Retourne une valeur indiquant si la clé est en cluster.
IsClustered(IReadOnlyKey)

Retourne une valeur indiquant si la clé est en cluster.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)

Retourne une valeur indiquant si la clé est en cluster.
SetIsClustered(IMutableKey, Nullable<Boolean>)

Définit une valeur indiquant si la clé est en cluster.
SqlServer(IKey)

Obtient le SQL Server métadonnées spécifiques d’une clé.
SqlServer(IMutableKey)

Obtient le SQL Server métadonnées spécifiques d’une clé.

S’applique à