IConventionKey Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt einen Primärschlüssel oder einen alternativen Schlüssel für eine Entität dar.
public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKeypublic interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IKeytype IConventionKey = interface
interface IReadOnlyKey
interface IReadOnlyAnnotatable
interface IConventionAnnotatabletype IConventionKey = interface
interface IConventionAnnotatable
interface IAnnotatable
interface IKeyPublic Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKeyPublic Interface IConventionKey
Implements IConventionAnnotatable, IKey- Implementiert
Hinweise
Diese Schnittstelle wird während der Modellerstellung verwendet und ermöglicht die Änderung der Metadaten. Nachdem das Modell erstellt wurde, IKey stellt sie eine schreibgeschützte Ansicht der gleichen Metadaten dar.
Weitere Informationen und Beispiele finden Sie unter Modellbaukonventionen .
Eigenschaften
| Name | Beschreibung |
|---|---|
| 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 vom Typ unterscheiden, der definiert wird, Properties wenn der Schlüssel einen abgeleiteten Typ in einer Vererbungshierarchie definiert hat (da die Eigenschaften möglicherweise für einen Basistyp definiert werden). |
| IsInModel |
Gibt an, ob sich dieses Objekt in einem Modell befindet, d. h. nicht aus einem Objekt entfernt wurde. (Geerbt von IConventionAnnotatable) |
| Item[String] |
Ruft die Wertanmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| Properties |
Ruft die Eigenschaften ab, aus denen der Schlüssel besteht. |
Methoden
| Name | Beschreibung |
|---|---|
| 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) |
| AddRuntimeAnnotation(String, Object) |
Fügt diesem Objekt eine Laufzeitanmerkung hinzu. Löst aus, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IAnnotatable) |
| AnnotationsToDebugString(Int32) |
Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das Objekt deklariert sind. (Geerbt von IReadOnlyAnnotatable) |
| FindAnnotation(String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| FindRuntimeAnnotation(String) |
Ruft die Laufzeitanmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| FindRuntimeAnnotationValue(String) |
Ruft den Wert der Laufzeitanmerkung mit dem angegebenen Namen ab, der zurückgegeben wird |
| GetAnnotation(String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. (Geerbt von IConventionAnnotatable) |
| GetAnnotations() |
Ruft alle Anmerkungen für das aktuelle Objekt ab. (Geerbt von IAnnotatable) |
| GetConfigurationSource() |
Gibt die Konfigurationsquelle für diesen Schlüssel zurück. |
| GetKeyType() |
Gibt den Typ der Schlüsseleigenschaft für einfache Schlüssel oder ein Objektarray für zusammengesetzte Schlüssel zurück. (Geerbt von IKey) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
Ruft den Wert der Laufzeitanmerkung mit dem angegebenen Namen ab, und fügt ihn hinzu, wenn keine vorhanden ist. (Geerbt von IAnnotatable) |
| GetPrincipalKeyValueFactory() |
Ruft eine Factory für Schlüsselwerte basierend auf den Schlüsselwerten ab, die aus verschiedenen Formen von Entitätsdaten stammen. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. (Geerbt von IKey) |
| GetPrincipalKeyValueFactory<TKey>() |
Ruft eine Factory für Schlüsselwerte basierend auf den Schlüsselwerten ab, die aus verschiedenen Formen von Entitätsdaten stammen. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. (Geerbt von IKey) |
| GetReferencingForeignKeys() |
Ruft alle Fremdschlüssel ab, die auf einen bestimmten Primär- oder Alternativschlüssel abzielen. |
| GetRuntimeAnnotations() |
Ruft alle Laufzeitanmerkungen für das aktuelle Objekt ab. (Geerbt von IAnnotatable) |
| 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) |
| RemoveRuntimeAnnotation(String) |
Entfernt die angegebene Laufzeitanmerkung aus diesem Objekt. (Geerbt von IAnnotatable) |
| 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, falls |
| SetRuntimeAnnotation(String, Object) |
Legt die unter dem angegebenen Schlüssel gespeicherte Laufzeitanmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IAnnotatable) |
| ToDebugString(MetadataDebugStringOptions, Int32) |
Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Sie wurde nur für das Debuggen entwickelt und kann sich willkürlich zwischen Versionen ändern. (Geerbt von IReadOnlyKey) |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean) |
Fügt einem Objekt Anmerkungen hinzu. |
| AnnotationsToDebugString(IAnnotatable, Int32) |
Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das Objekt deklariert sind. |
| FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier) |
Sucht den ersten IConventionKey , der derselben Einschränkung in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| FindSharedObjectRootKey(IKey, StoreObjectIdentifier) |
Sucht den ersten IConventionKey , der derselben Einschränkung in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier) |
Sucht den ersten IKey , der derselben Einschränkung in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| GetAnnotation(IAnnotatable, String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. |
| GetAnnotation(IConventionAnnotatable, String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. |
| GetDefaultName(IKey, StoreObjectIdentifier) |
Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel für eine bestimmte Tabelle verwendet werden würde. |
| GetDefaultName(IKey) |
Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel verwendet werden würde. |
| GetDefaultName(IReadOnlyKey, StoreObjectIdentifier) |
Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel für eine bestimmte Tabelle verwendet werden würde. |
| GetDefaultName(IReadOnlyKey) |
Gibt den Standardnamen der Schlüsseleinschränkung zurück, der für diesen Schlüssel verwendet werden würde. |
| GetFillFactor(IReadOnlyKey, StoreObjectIdentifier) |
Gibt den Füllfaktor zurück, den der Schlüssel verwendet. |
| GetFillFactor(IReadOnlyKey) |
Gibt den Füllfaktor zurück, den der Schlüssel verwendet. |
| GetFillFactorConfigurationSource(IConventionKey) |
Gibt zurück, ConfigurationSource ob der Schlüssel den Füllfaktor verwendet. |
| GetIsClusteredConfigurationSource(IConventionKey) |
Ruft ab ConfigurationSource , ob der Schlüssel gruppiert ist. |
| GetKeyType(IKey) |
Gibt den Typ der Schlüsseleigenschaft für einfache Schlüssel oder ein Objektarray für zusammengesetzte Schlüssel zurück. |
| GetMappedConstraints(IKey) |
Ruft die eindeutigen Einschränkungen ab, denen der Schlüssel zugeordnet wird. |
| GetName(IKey, StoreObjectIdentifier) |
Gibt den Schlüsseleinschränkungsnamen für diesen Schlüssel für eine bestimmte Tabelle zurück. |
| GetName(IKey) |
Gibt den Schlüsseleinschränkungsnamen für diesen Schlüssel zurück. |
| GetName(IReadOnlyKey, StoreObjectIdentifier) |
Gibt den Schlüsseleinschränkungsnamen für diesen Schlüssel für eine bestimmte Tabelle zurück. |
| GetName(IReadOnlyKey) |
Gibt den Schlüsseleinschränkungsnamen für diesen Schlüssel zurück. |
| GetNameConfigurationSource(IConventionKey) |
Ruft den ConfigurationSource Namen der Einschränkung ab. |
| GetPrincipalKeyValueFactory<TKey>(IKey) |
Ruft eine Factory für Schlüsselwerte basierend auf den Indexschlüsselwerten ab, die aus verschiedenen Formen von Entitätsdaten stammen. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| GetReferencingForeignKeys(IConventionKey) |
Ruft alle Fremdschlüssel ab, die auf einen bestimmten Primär- oder Alternativschlüssel abzielen. |
| GetReferencingForeignKeys(IKey) |
Ruft alle Fremdschlüssel ab, die auf einen bestimmten Primär- oder Alternativschlüssel abzielen. |
| IsClustered(IKey, StoreObjectIdentifier) |
Gibt einen Wert zurück, der angibt, ob der Schlüssel gruppiert ist. |
| IsClustered(IKey) |
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. |
| IsClustered(IReadOnlyKey) |
Gibt einen Wert zurück, der angibt, ob der Schlüssel gruppiert ist. |
| IsPrimaryKey(IKey) |
Gibt einen Wert zurück, der angibt, ob der Schlüssel der Primärschlüssel ist. |
| SetFillFactor(IConventionKey, Nullable<Int32>, Boolean) |
Legt einen Wert für den Füllfaktor fest, den der Schlüssel verwendet. |
| SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean) |
Legt einen Wert fest, der angibt, ob der Schlüssel gruppiert ist. |
| SetName(IConventionKey, String, Boolean) |
Legt den Schlüsseleinschränkungsnamen für diesen Schlüssel fest. |
| SetOrRemoveAnnotation(IConventionAnnotatable, 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, falls |
| ToDebugString(IKey, MetadataDebugStringOptions, Int32) |
Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Sie wurde nur für das Debuggen entwickelt und kann sich willkürlich zwischen Versionen ändern. |
