IConventionKey Interfejs

Definicja

Przestrzeń nazw:

Microsoft.EntityFrameworkCore.Metadata

Zestaw:

Microsoft.EntityFrameworkCore.dll

Pakiet:

Microsoft.EntityFrameworkCore v8.0.0

Reprezentuje klucz podstawowy lub alternatywny w jednostce.

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

Implementuje

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyKey

Uwagi

Ten interfejs jest używany podczas tworzenia modelu i umożliwia modyfikowanie metadanych. Po utworzeniu IKey modelu reprezentuje widok tylko do odczytu tych samych metadanych.

Aby uzyskać więcej informacji i przykładów, zobacz Konwencje tworzenia modeli .

Właściwości

Builder	Pobiera konstruktora, którego można użyć do skonfigurowania tego klucza.
DeclaringEntityType	Pobiera typ jednostki zdefiniowany przez klucz. Może to różnić się od typu Properties zdefiniowanego w przypadku, gdy klucz jest zdefiniowany typ pochodny w hierarchii dziedziczenia (ponieważ właściwości mogą być zdefiniowane w typie podstawowym).
IsInModel	Wskazuje, czy ten obiekt znajduje się w modelu, tj. nie został usunięty z jednego. (Odziedziczone po IConventionAnnotatable)
Item[String]	Pobiera wartość adnotacji o podanej nazwie, zwracając null ją, jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
Properties	Pobiera właściwości tworzące klucz.

Metody

AddAnnotation(String, Object, Boolean)	Dodaje adnotację do tego obiektu. Zgłasza, jeśli adnotacja o określonej nazwie już istnieje. (Odziedziczone po IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Dodaje adnotacje do obiektu. (Odziedziczone po IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Pobiera ciąg debugowania dla wszystkich adnotacji zadeklarowanych w obiekcie . (Odziedziczone po IReadOnlyAnnotatable)
FindAnnotation(String)	Pobiera adnotację o podanej nazwie, zwracając null ją, jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
GetAnnotation(String)	Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
GetAnnotations()	Pobiera wszystkie adnotacje dla bieżącego obiektu. (Odziedziczone po IReadOnlyAnnotatable)
GetConfigurationSource()	Zwraca źródło konfiguracji dla tego klucza.
GetReferencingForeignKeys()	Pobiera wszystkie klucze obce, które są przeznaczone dla danego klucza podstawowego lub alternatywnego.
IsPrimaryKey()	Zwraca wartość wskazującą, czy klucz jest kluczem podstawowym. (Odziedziczone po IReadOnlyKey)
RemoveAnnotation(String)	Usuwa adnotację o podanej nazwie z tego obiektu. (Odziedziczone po IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Ustawia adnotację przechowywaną pod daną nazwą. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje. (Odziedziczone po IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)	Ustawia adnotację przechowywaną pod daną nazwą. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje. Usuwa istniejącą adnotację, jeśli null jest podana. (Odziedziczone po IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Tworzy czytelną dla człowieka reprezentację danych metadanych. Ostrzeżenie: nie należy polegać na formacie zwracanego ciągu. Jest ona przeznaczona tylko do debugowania i może zmieniać się arbitralnie między wersjami. (Odziedziczone po IReadOnlyKey)

Metody rozszerzania

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)	Znajduje pierwszy IConventionKey zamapowany na to samo ograniczenie w udostępnionym obiekcie przypominającym tabelę. Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Znajduje pierwszy IKey zamapowany na to samo ograniczenie w udostępnionym obiekcie przypominającym tabelę. Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.
GetDefaultName(IReadOnlyKey)	Zwraca domyślną nazwę ograniczenia klucza, która będzie używana dla tego klucza.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Zwraca domyślną nazwę ograniczenia klucza, która będzie używana dla tego klucza dla określonej tabeli.
GetName(IReadOnlyKey)	Zwraca nazwę ograniczenia klucza dla tego klucza.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Zwraca nazwę ograniczenia klucza dla tego klucza dla określonej tabeli.
GetNameConfigurationSource(IConventionKey)	Pobiera element ConfigurationSource dla nazwy ograniczenia.
SetName(IConventionKey, String, Boolean)	Ustawia nazwę ograniczenia klucza dla tego klucza.
GetIsClusteredConfigurationSource(IConventionKey)	Pobiera wartość ConfigurationSource dla tego, czy klucz jest klastrowany.
IsClustered(IReadOnlyKey)	Zwraca wartość wskazującą, czy klucz jest klastrowany.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Zwraca wartość wskazującą, czy klucz jest klastrowany.
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	Ustawia wartość wskazującą, czy klucz jest klastrowany.