IConventionKey Schnittstelle

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paket:

Microsoft.EntityFrameworkCore v8.0.0

Stellt einen Primär- oder Alternativschlüssel für eine Entität dar.

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IConventionKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKey

Implementiert

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyKey

Hinweise

Diese Schnittstelle wird während der Modellerstellung verwendet und ermöglicht das Ändern der Metadaten. Sobald das Modell erstellt wurde, IKey stellt eine schreibgeschützte Ansicht der gleichen Metadaten dar.

Weitere Informationen und Beispiele finden Sie unter Modellerstellungskonventionen .

Eigenschaften

Builder	Ruft den Generator ab, der zum Konfigurieren dieses Schlüssels verwendet werden kann.
DeclaringEntityType	Ruft den Entitätstyp ab, für den der Schlüssel definiert ist. Dies kann sich von dem Typ unterscheiden, der für definiert wird, Properties wenn der Schlüssel als abgeleiteter Typ in einer Vererbungshierarchie definiert wird (da die Eigenschaften für einen Basistyp definiert werden können).
IsInModel	Gibt an, ob sich dieses Objekt in einem Modell befindet, d. h. nicht aus einem modell entfernt wurde. (Geerbt von IConventionAnnotatable)
Item[String]	Ruft den Wert der Anmerkung mit dem angegebenen Namen ab und gibt zurück null , wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
Properties	Ruft die Eigenschaften ab, aus denen der Schlüssel besteht.

Methoden

AddAnnotation(String, Object, Boolean)	Fügt diesem Objekt eine Anmerkung hinzu. Löst aus, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Fügt einem -Objekt Anmerkungen hinzu. (Geerbt von IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Ruft die Debugzeichenfolge für alle Im -Objekt deklarierten Anmerkungen ab. (Geerbt von IReadOnlyAnnotatable)
FindAnnotation(String)	Ruft die Anmerkung mit dem angegebenen Namen ab und gibt zurück null , wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
GetAnnotation(String)	Ruft die Anmerkung mit dem angegebenen Namen ab und löst aus, wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
GetAnnotations()	Ruft alle Anmerkungen für das aktuelle Objekt ab. (Geerbt von IReadOnlyAnnotatable)
GetConfigurationSource()	Gibt die Konfigurationsquelle für diesen Schlüssel zurück.
GetReferencingForeignKeys()	Ruft alle Fremdschlüssel ab, die auf einen bestimmten Primär- oder Alternativschlüssel ausgerichtet sind.
IsPrimaryKey()	Gibt einen Wert zurück, der angibt, ob der Schlüssel der Primärschlüssel ist. (Geerbt von IReadOnlyKey)
RemoveAnnotation(String)	Entfernt die Anmerkung mit dem angegebenen Namen aus diesem Objekt. (Geerbt von IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Legt die unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)	Legt die unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. Entfernt die vorhandene Anmerkung, wenn null angegeben wird. (Geerbt von IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Es ist nur für das Debuggen konzipiert und kann sich zwischen Releases beliebig ändern. (Geerbt von IReadOnlyKey)

Erweiterungsmethoden

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)	Sucht die erste IConventionKey , die der gleichen Einschränkung in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Es wird in der Regel nicht im Anwendungscode verwendet.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Sucht die erste IKey , die der gleichen Einschränkung in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Es wird in der Regel nicht im Anwendungscode verwendet.
GetDefaultName(IReadOnlyKey)	Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel verwendet wird.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel für eine bestimmte Tabelle verwendet wird.
GetName(IReadOnlyKey)	Gibt den Namen der Schlüsseleinschränkung für diesen Schlüssel zurück.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Gibt den Namen der Schlüsseleinschränkung für diesen Schlüssel für eine bestimmte Tabelle zurück.
GetNameConfigurationSource(IConventionKey)	Ruft den ConfigurationSource für den Einschränkungsnamen ab.
SetName(IConventionKey, String, Boolean)	Legt den Namen der Schlüsseleinschränkung für diesen Schlüssel fest.
GetIsClusteredConfigurationSource(IConventionKey)	Ruft ab, ConfigurationSource ob der Schlüssel gruppiert ist.
IsClustered(IReadOnlyKey)	Gibt einen Wert zurück, der angibt, ob der Schlüssel gruppiert ist.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Gibt einen Wert zurück, der angibt, ob der Schlüssel gruppiert ist.
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	Legt einen Wert fest, der angibt, ob der Schlüssel gruppiert ist.