Język

IConventionForeignKey Interfejs

Definicja

Reprezentuje relację, w której właściwości klucza obcego w typie jednostki zależnej odwołują się do odpowiedniego klucza podstawowego lub alternatywnego w typie jednostki głównej.

public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey
public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IForeignKey
type IConventionForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
type IConventionForeignKey = interface
    interface IForeignKey
    interface IAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IReadOnlyForeignKey
Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IForeignKey
Implementuje

Uwagi

Ten interfejs jest używany podczas tworzenia modelu i umożliwia modyfikowanie metadanych. Gdy model zostanie skompilowany, IForeignKey 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

Nazwisko Opis
Builder

Pobiera konstruktora, którego można użyć do skonfigurowania tego klucza obcego.

DeclaringEntityType

Pobiera zależny typ jednostki. Może to różnić się od typu Properties zdefiniowanego podczas definiowania typu pochodnego w hierarchii dziedziczenia (ponieważ właściwości mogą być zdefiniowane w typie podstawowym).

DeleteBehavior

Pobiera wartość wskazującą sposób stosowania operacji usuwania do jednostek zależnych w relacji po usunięciu podmiotu zabezpieczeń lub zerwaniu relacji.

(Odziedziczone po IForeignKey)
DependentToPrincipal

Pobiera właściwość nawigacji dla typu jednostki zależnej, która wskazuje jednostkę główną.

IsConstrained

Pobiera wartość wskazującą, czy relacja jest ograniczona, czyli poparta gwarancją (na przykład ograniczeniem klucza obcego bazy danych), że istnieje pasujący klucz podmiotu zabezpieczeń dla każdej ustawionej wartości klucza obcego. Gdy falseprogram nie tworzy żadnego ograniczenia klucza obcego bazy danych, a zapytania traktują relację jako opcjonalną, nawet jeśli właściwości klucza obcego nie są dopuszczające wartości null — podmiot zabezpieczeń jest ładowany z lewego sprzężenia i nigdy nie zakłada się, że istnieje. Nie ma to wpływu na śledzenie zmian: wymagana relacja (IsRequired) nadal kaskadowo lub tworzy koncepcyjną wartość null po zerwaniu, niezależnie od tej wartości.

(Odziedziczone po IReadOnlyForeignKey)
IsInModel

Wskazuje, czy ten obiekt znajduje się w modelu, tj. nie został usunięty z jednego.

(Odziedziczone po IConventionAnnotatable)
IsOwnership

Pobiera lub ustawia wartość wskazującą, czy ta relacja definiuje własność. Jeśli truejednostka zależna musi być zawsze dostępna za pośrednictwem nawigacji z jednostki głównej.

(Odziedziczone po IForeignKey)
IsRequired

Pobiera wartość wskazującą, czy jednostka główna jest wymagana. Jeśli truejednostka zależna musi być zawsze przypisana do prawidłowej jednostki głównej.

(Odziedziczone po IForeignKey)
IsRequiredDependent

Pobiera wartość wskazującą, czy jednostka zależna jest wymagana. Jeśli truejednostka główna musi mieć zawsze przypisaną prawidłową jednostkę zależną.

(Odziedziczone po IForeignKey)
IsUnique

Pobiera wartość wskazującą, czy wartości przypisane do właściwości klucza obcego są unikatowe.

(Odziedziczone po IForeignKey)
Item[String]

Pobiera adnotację wartości z daną nazwą, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
PrincipalEntityType

Pobiera typ jednostki głównej, który jest przeznaczony dla tej relacji. Może to różnić się od typu PrincipalKey zdefiniowanego w przypadku, gdy relacja jest przeznaczona dla typu pochodnego w hierarchii dziedziczenia (ponieważ klucz jest zdefiniowany w podstawowym typie hierarchii).

PrincipalKey

Pobiera klucz podstawowy lub alternatywny przeznaczony dla relacji.

PrincipalToDependent

Pobiera właściwość nawigacji dla typu jednostki głównej, która wskazuje jednostkę zależną.

Properties

Pobiera właściwości klucza obcego w jednostce zależnej.

Metody

Nazwisko Opis
AddAnnotation(String, Object, Boolean)

Dodaje adnotację do tego obiektu. Zgłasza, czy adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Dodaje adnotacje do obiektu.

(Odziedziczone po IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)

Dodaje adnotację środowiska uruchomieniowego do tego obiektu. Zgłasza, czy adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IAnnotatable)
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 IAnnotatable)
FindRuntimeAnnotation(String)

Pobiera adnotację środowiska uruchomieniowego o podanej nazwie, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
FindRuntimeAnnotationValue(String)

Pobiera wartość adnotacji środowiska uruchomieniowego o podanej nazwie, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
GetAnnotation(String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

(Odziedziczone po IConventionAnnotatable)
GetAnnotations()

Pobiera wszystkie adnotacje w bieżącym obiekcie.

(Odziedziczone po IAnnotatable)
GetConfigurationSource()

Zwraca źródło konfiguracji dla tej właściwości.

GetDeleteBehaviorConfigurationSource()

Zwraca źródło konfiguracji dla elementu DeleteBehavior.

GetDependentKeyValueFactory()

Tworzy fabrykę wartości kluczy na podstawie wartości klucza obcego pobranych z różnych form danych jednostki.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

(Odziedziczone po IForeignKey)
GetDependentKeyValueFactory<TKey>()

Tworzy fabrykę wartości kluczy na podstawie wartości klucza obcego pobranych z różnych form danych jednostki.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

(Odziedziczone po IForeignKey)
GetDependentToPrincipalConfigurationSource()

Zwraca źródło konfiguracji dla elementu DependentToPrincipal.

GetIsConstrainedConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsConstrained.

GetIsOwnershipConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsOwnership.

GetIsRequiredConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsRequired.

GetIsRequiredDependentConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsRequiredDependent.

GetIsUniqueConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsUnique.

GetNavigation(Boolean)

Zwraca nawigację skojarzona z tym kluczem obcym.

GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Pobiera wartość adnotacji środowiska uruchomieniowego o podanej nazwie, dodając ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
GetPrincipalEndConfigurationSource()

Zwraca źródło konfiguracji dla elementu PrincipalEntityType.

GetPrincipalKeyConfigurationSource()

Zwraca źródło konfiguracji dla elementu PrincipalKey.

GetPrincipalToDependentConfigurationSource()

Zwraca źródło konfiguracji dla elementu PrincipalToDependent.

GetPropertiesConfigurationSource()

Zwraca źródło konfiguracji dla elementu Properties.

GetReferencingSkipNavigations()

Pobiera wszystkie nawigacje pomijane przy użyciu tego klucza obcego.

GetRelatedEntityType(IReadOnlyEntityType)

Pobiera typ jednostki powiązany z danym.

GetRuntimeAnnotations()

Pobiera wszystkie adnotacje środowiska uruchomieniowego w bieżącym obiekcie.

(Odziedziczone po IAnnotatable)
HasDependentToPrincipal(MemberInfo, Boolean)
Przestarzałe.

Ustawia właściwość nawigacji na typie jednostki zależnej wskazującym jednostkę główną.

HasDependentToPrincipal(String, Boolean)
Przestarzałe.

Ustawia właściwość nawigacji na typie jednostki zależnej wskazującym jednostkę główną.

HasPrincipalToDependent(MemberInfo, Boolean)
Przestarzałe.

Ustawia właściwość nawigacji dla typu jednostki głównej, która wskazuje jednostkę zależną.

HasPrincipalToDependent(String, Boolean)
Przestarzałe.

Ustawia właściwość nawigacji dla typu jednostki głównej, która wskazuje jednostkę zależną.

IsBaseLinking()

Zwraca wartość wskazującą, czy klucz obcy jest zdefiniowany na kluczu podstawowym i wskazuje ten sam klucz podstawowy.

(Odziedziczone po IReadOnlyForeignKey)
IsEffectivelyRequired()

Zwraca wartość wskazującą, czy ustawiona wartość dla tego klucza obcego ma gwarancję odwołania się do istniejącego podmiotu zabezpieczeń — czyli relacja jest wymagana (IsRequired) i ograniczona (IsConstrained). Zapytanie sprawdza to, czy można rozszerzyć nawigację zależną do podmiotu zabezpieczeń za pomocą sprzężenia wewnętrznego (i czy takie sprzężenie można przycinać); relacja bez ograniczeń jest zawsze traktowana jako opcjonalna, nawet jeśli jej właściwości klucza obcego nie są dopuszczane do wartości null.

(Odziedziczone po IReadOnlyForeignKey)
RemoveAnnotation(String)

Usuwa adnotację o podanej nazwie z tego obiektu.

(Odziedziczone po IConventionAnnotatable)
RemoveRuntimeAnnotation(String)

Usuwa daną adnotację środowiska uruchomieniowego z tego obiektu.

(Odziedziczone po IAnnotatable)
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)
SetDeleteBehavior(Nullable<DeleteBehavior>, Boolean)

Ustawia wartość wskazującą sposób stosowania operacji usuwania do jednostek zależnych w relacji po usunięciu podmiotu zabezpieczeń lub zerwaniu relacji.

SetDependentToPrincipal(MemberInfo, Boolean)

Ustawia właściwość nawigacji na typie jednostki zależnej wskazującym jednostkę główną.

SetDependentToPrincipal(String, Boolean)

Ustawia właściwość nawigacji na typie jednostki zależnej wskazującym jednostkę główną.

SetIsConstrained(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy relacja jest ograniczona.

SetIsOwnership(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy ta relacja definiuje własność. Jeśli truejednostka zależna musi być zawsze dostępna za pośrednictwem nawigacji z jednostki głównej.

SetIsRequired(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy jednostka główna jest wymagana. Jeśli truejednostka zależna musi być zawsze przypisana do prawidłowej jednostki głównej.

SetIsRequiredDependent(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy jednostka zależna jest wymagana. Jeśli truejednostka główna musi mieć zawsze przypisaną prawidłową jednostkę zależną.

SetIsUnique(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy wartości przypisane do właściwości klucza obcego są unikatowe.

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)
SetPrincipalToDependent(MemberInfo, Boolean)

Ustawia właściwość nawigacji dla typu jednostki głównej, która wskazuje jednostkę zależną.

SetPrincipalToDependent(String, Boolean)

Ustawia właściwość nawigacji dla typu jednostki głównej, która wskazuje jednostkę zależną.

SetProperties(IReadOnlyList<IConventionProperty>, IConventionKey, Boolean)

Ustawia właściwości klucza obcego i ten docelowy klucz główny.

SetRuntimeAnnotation(String, Object)

Ustawia adnotację środowiska uruchomieniowego przechowywaną w ramach danego klucza. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Tworzy czytelną dla człowieka reprezentację podanych metadanych.

Ostrzeżenie: nie należy polegać na formacie zwracanego ciągu. Jest przeznaczony tylko do debugowania i może zmieniać się dowolnie między wydaniami.

(Odziedziczone po IReadOnlyForeignKey)

Metody rozszerzania

Nazwisko Opis
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Dodaje adnotacje do obiektu.

AnnotationsToDebugString(IAnnotatable, Int32)

Pobiera ciąg debugowania dla wszystkich adnotacji zadeklarowanych w obiekcie.

FindSharedObjectRootForeignKey(IConventionForeignKey, StoreObjectIdentifier)

Znajduje pierwszy IConventionForeignKey mapowany 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.

FindSharedObjectRootForeignKey(IForeignKey, StoreObjectIdentifier)

Znajduje pierwszy IForeignKey mapowany 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.

FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)

Znajduje pierwszy IForeignKey mapowany 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.

GetAnnotation(IAnnotatable, String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

GetAnnotation(IConventionAnnotatable, String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

GetConstraintName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Zwraca nazwę ograniczenia klucza obcego.

GetConstraintName(IForeignKey)

Zwraca nazwę ograniczenia klucza obcego.

GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Zwraca nazwę ograniczenia klucza obcego.

GetConstraintName(IReadOnlyForeignKey)

Zwraca nazwę ograniczenia klucza obcego.

GetConstraintNameConfigurationSource(IConventionForeignKey)

Pobiera parametr ConfigurationSource dla nazwy ograniczenia.

GetDefaultName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Zwraca domyślną nazwę ograniczenia, która będzie używana dla tego klucza obcego.

GetDefaultName(IForeignKey)

Zwraca domyślną nazwę ograniczenia, która będzie używana dla tego klucza obcego.

GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Zwraca domyślną nazwę ograniczenia, która będzie używana dla tego klucza obcego.

GetDefaultName(IReadOnlyForeignKey)

Zwraca domyślną nazwę ograniczenia, która będzie używana dla tego klucza obcego.

GetDependentKeyValueFactory<TKey>(IForeignKey)

Tworzy fabrykę wartości kluczy na podstawie wartości klucza obcego pobranych z różnych form danych jednostki.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

GetIsExcludedFromMigrationsConfigurationSource(IConventionForeignKey)

Pobiera wartość ConfigurationSource dla wykluczenia klucza obcego z migracji.

GetMappedConstraints(IForeignKey)

Pobiera ograniczenia klucza obcego, do których jest mapowany klucz obcy.

GetNavigation(IConventionForeignKey, Boolean)

Zwraca nawigację skojarzona z tym kluczem obcym.

GetNavigation(IForeignKey, Boolean)

Zwraca nawigację skojarzona z tym kluczem obcym.

GetRelatedEntityType(IConventionForeignKey, IConventionEntityType)

Pobiera typ jednostki powiązany z danym.

GetRelatedEntityType(IForeignKey, IEntityType)

Pobiera typ jednostki powiązany z danym.

IsBaseLinking(IForeignKey)

Zwraca wartość wskazującą, czy klucz obcy jest zdefiniowany na kluczu podstawowym i wskazuje ten sam klucz podstawowy.

IsExcludedFromMigrations(IReadOnlyForeignKey)

Zwraca wartość wskazującą, czy ograniczenie klucza obcego jest wykluczone z migracji.

IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)

Zwraca wartość wskazującą, czy ten klucz obcy znajduje się między dwoma typami jednostek współużytkowania tego samego obiektu magazynu przypominającego tabelę.

SetConstraintName(IConventionForeignKey, String, Boolean)

Ustawia nazwę ograniczenia klucza obcego.

SetIsExcludedFromMigrations(IConventionForeignKey, Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy ograniczenie klucza obcego jest wykluczone z migracji.

SetOrRemoveAnnotation(IConventionAnnotatable, 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.

ToDebugString(IForeignKey, MetadataDebugStringOptions, Int32)

Tworzy czytelną dla człowieka reprezentację podanych metadanych.

Ostrzeżenie: nie należy polegać na formacie zwracanego ciągu. Jest przeznaczony tylko do debugowania i może zmieniać się dowolnie między wydaniami.

Dotyczy