IConventionForeignKey Интерфейс

Определение

Пространство имен:

Microsoft.EntityFrameworkCore.Metadata

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

Представляет связь, в которой свойства внешнего ключа в зависимом типе сущности ссылаются на соответствующий первичный или альтернативный ключ в основном типе сущности.

public interface IConventionForeignKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey

type IConventionForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionForeignKey
Implements IConventionAnnotatable, IReadOnlyForeignKey

Реализации

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyForeignKey

Комментарии

Этот интерфейс используется во время создания модели и позволяет изменять метаданные. После построения IForeignKey модели представляет доступное только для чтения представление одних и того же метаданных.

Дополнительные сведения и примеры см. в разделе Соглашения о создании моделей .

Свойства

Builder	Возвращает построитель, который можно использовать для настройки этого внешнего ключа.
DeclaringEntityType	Возвращает зависимый тип сущности. Это может отличаться от типа, Properties определенного в , когда связь определяется производным типом в иерархии наследования (так как свойства могут быть определены для базового типа).
DeleteBehavior	Возвращает значение, указывающее, как операция удаления применяется к зависимым сущностям в связи при удалении субъекта или разрыва связи. (Унаследовано от IReadOnlyForeignKey)
DependentToPrincipal	Возвращает свойство навигации для зависимого типа сущности, указывающего на сущность-субъект.
IsInModel	Указывает, находится ли этот объект в модели, т. е. не был удален из нее. (Унаследовано от IConventionAnnotatable)
IsOwnership	Возвращает значение, указывающее, определяет ли эта связь владение. Если trueзадано значение , доступ к зависимой сущности всегда должен осуществляться с помощью навигации из основной сущности. (Унаследовано от IReadOnlyForeignKey)
IsRequired	Возвращает значение, указывающее, является ли сущность субъекта обязательной. Если trueзадано значение , зависимая сущность всегда должна быть назначена допустимой сущности субъекта. (Унаследовано от IReadOnlyForeignKey)
IsRequiredDependent	Возвращает значение, указывающее, требуется ли зависимая сущность. Если trueзадано значение , основной сущности всегда должна быть назначена допустимая зависимая сущность. (Унаследовано от IReadOnlyForeignKey)
IsUnique	Возвращает значение, указывающее, являются ли значения, назначенные свойствам внешнего ключа, уникальными. (Унаследовано от IReadOnlyForeignKey)
Item[String]	Возвращает значение заметки с заданным именем, возвращая null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
PrincipalEntityType	Возвращает тип основной сущности, на который нацелена эта связь. Это может отличаться от типа, определенного PrincipalKey в , когда отношение предназначено для производного типа в иерархии наследования (так как ключ определяется в базовом типе иерархии).
PrincipalKey	Возвращает первичный или альтернативный ключ, предназначенный для связи.
PrincipalToDependent	Возвращает свойство навигации для типа основной сущности, указывающего на зависимую сущность.
Properties	Возвращает свойства внешнего ключа в зависимой сущности.

Методы

AddAnnotation(String, Object, Boolean)	Добавляет заметку к этому объекту. Вызывает исключение, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Добавляет заметки в объект . (Унаследовано от IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Возвращает отладочную строку для всех заметок, объявленных в объекте . (Унаследовано от IReadOnlyAnnotatable)
FindAnnotation(String)	Возвращает заметку с заданным именем, возвращающую null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotation(String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotations()	Возвращает все заметки для текущего объекта. (Унаследовано от IReadOnlyAnnotatable)
GetConfigurationSource()	Возвращает источник конфигурации для этого свойства.
GetDeleteBehaviorConfigurationSource()	Возвращает источник конфигурации для DeleteBehavior.
GetDependentToPrincipalConfigurationSource()	Возвращает источник конфигурации для DependentToPrincipal.
GetIsOwnershipConfigurationSource()	Возвращает источник конфигурации для IsOwnership.
GetIsRequiredConfigurationSource()	Возвращает источник конфигурации для IsRequired.
GetIsRequiredDependentConfigurationSource()	Возвращает источник конфигурации для IsRequiredDependent.
GetIsUniqueConfigurationSource()	Возвращает источник конфигурации для IsUnique.
GetNavigation(Boolean)	Возвращает навигацию, связанную с этим внешним ключом.
GetPrincipalEndConfigurationSource()	Возвращает источник конфигурации для PrincipalEntityType.
GetPrincipalKeyConfigurationSource()	Возвращает источник конфигурации для PrincipalKey.
GetPrincipalToDependentConfigurationSource()	Возвращает источник конфигурации для PrincipalToDependent.
GetPropertiesConfigurationSource()	Возвращает источник конфигурации для Properties.
GetReferencingSkipNavigations()	Получает все переходы пропуска, использующие этот внешний ключ.
GetRelatedEntityType(IReadOnlyEntityType)	Возвращает тип сущности, связанный с данным типом.
IsBaseLinking()	Возвращает значение, указывающее, определен ли внешний ключ для первичного ключа и указывает на тот же первичный ключ. (Унаследовано от IReadOnlyForeignKey)
RemoveAnnotation(String)	Удаляет заметку с заданным именем из этого объекта. (Унаследовано от IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
SetDeleteBehavior(Nullable<DeleteBehavior>, Boolean)	Задает значение, указывающее, как операция удаления применяется к зависимым сущностям в связи при удалении субъекта или разрыва связи.
SetDependentToPrincipal(MemberInfo, Boolean)	Задает свойство навигации для типа зависимой сущности, указывающего на основную сущность.
SetDependentToPrincipal(String, Boolean)	Задает свойство навигации для типа зависимой сущности, указывающего на основную сущность.
SetIsOwnership(Nullable<Boolean>, Boolean)	Задает значение, указывающее, определяет ли эта связь владение. Если trueзадано значение , доступ к зависимой сущности всегда должен осуществляться с помощью навигации из основной сущности.
SetIsRequired(Nullable<Boolean>, Boolean)	Задает значение, указывающее, является ли сущность субъекта обязательной. Если trueзадано значение , зависимая сущность всегда должна быть назначена допустимой сущности субъекта.
SetIsRequiredDependent(Nullable<Boolean>, Boolean)	Задает значение, указывающее, требуется ли зависимая сущность. При trueзначении основной сущности всегда должна быть назначена допустимая зависимая сущность.
SetIsUnique(Nullable<Boolean>, Boolean)	Задает значение, указывающее, являются ли значения, назначенные свойствам внешнего ключа, уникальными.
SetOrRemoveAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. Удаляет существующую заметку, если null она указана. (Унаследовано от IConventionAnnotatable)
SetPrincipalToDependent(MemberInfo, Boolean)	Задает свойство навигации для типа основной сущности, указывающего на зависимую сущность.
SetPrincipalToDependent(String, Boolean)	Задает свойство навигации для типа основной сущности, указывающего на зависимую сущность.
SetProperties(IReadOnlyList<IConventionProperty>, IConventionKey, Boolean)	Задает свойства внешнего ключа и целевой основной ключ.
ToDebugString(MetadataDebugStringOptions, Int32)	Создает удобочитаемое представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками. (Унаследовано от IReadOnlyForeignKey)

Методы расширения

FindSharedObjectRootForeignKey(IConventionForeignKey, StoreObjectIdentifier)	Находит первый IConventionForeignKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)	Находит первый IForeignKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetConstraintName(IReadOnlyForeignKey)	Возвращает имя ограничения внешнего ключа.
GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	Возвращает имя ограничения внешнего ключа.
GetConstraintNameConfigurationSource(IConventionForeignKey)	Возвращает для ConfigurationSource имени ограничения.
GetDefaultName(IReadOnlyForeignKey)	Возвращает имя ограничения по умолчанию, которое будет использоваться для этого внешнего ключа.
GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)	Возвращает имя ограничения по умолчанию, которое будет использоваться для этого внешнего ключа.
IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)	Возвращает значение, указывающее, находится ли этот внешний ключ между двумя типами сущностей, совместно использующие один и тот же табличный объект хранилища.
SetConstraintName(IConventionForeignKey, String, Boolean)	Задает имя ограничения внешнего ключа.