Язык

IForeignKey Интерфейс

Определение

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

public interface IForeignKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
public interface IForeignKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyForeignKey
type IForeignKey = interface
    interface IAnnotatable
type IForeignKey = interface
    interface IReadOnlyForeignKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable
Public Interface IForeignKey
Implements IAnnotatable
Public Interface IForeignKey
Implements IAnnotatable, IReadOnlyForeignKey
Производный
Реализации

Комментарии

Дополнительные сведения и примеры см. в разделе " Типы сущностей моделирования" и "Связи ".

Свойства

Имя. Описание
DeclaringEntityType

Возвращает тип зависимой сущности. Это может отличаться от типа, Properties определенного при определении связи производного типа в иерархии наследования (так как свойства могут быть определены в базовом типе).

DeleteBehavior

Возвращает значение, указывающее, как операция удаления применяется к зависимым сущностям в связи, когда субъект удаляется или связь отрезается.

DependentToPrincipal

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

IsConstrained

Возвращает значение, указывающее, ограничена ли связь, т. е. гарантией (например, ограничением внешнего ключа базы данных), что соответствующий ключ субъекта существует для каждого заданного значения внешнего ключа. Если falseограничение внешнего ключа базы данных не создается, а запросы обрабатывают связь как необязательную, даже если свойства внешнего ключа не имеют значения NULL, субъект загружается с левым соединением и никогда не предполагается существовать. Это не влияет на отслеживание изменений: требуемаяIsRequired () связь по-прежнему каскадирует или создает концептуальное значение NULL при отрезано независимо от этого значения.

(Унаследовано от IReadOnlyForeignKey)
IsOwnership

Возвращает или задает значение, указывающее, определяет ли эта связь владение. Если trueзависимые сущности всегда должны быть доступны через навигацию из основной сущности.

IsRequired

Возвращает значение, указывающее, требуется ли основная сущность. Если trueзависимые сущности всегда должны быть назначены допустимой сущности субъекта.

IsRequiredDependent

Возвращает значение, указывающее, требуется ли зависимый объект. Если trueосновной сущности всегда должен быть назначена действительная зависимые сущности.

IsUnique

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

Item[String]

Возвращает значение заметки с заданным именем, возвращая null , если она не существует.

(Унаследовано от IReadOnlyAnnotatable)
PrincipalEntityType

Возвращает тип основной сущности, целевой для этой связи. Это может отличаться от типа, определенного в том случае, PrincipalKey если отношение предназначено для производного типа в иерархии наследования (так как ключ определен в базовом типе иерархии).

PrincipalKey

Возвращает первичный или альтернативный ключ, предназначенный для связи.

PrincipalToDependent

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

Properties

Возвращает свойства внешнего ключа в зависимой сущности.

Методы

Имя. Описание
AddRuntimeAnnotation(String, Object)

Добавляет заметку среды выполнения к этому объекту. Вызывает, если заметка с указанным именем уже существует.

(Унаследовано от IAnnotatable)
AnnotationsToDebugString(Int32)

Возвращает строку отладки для всех заметок, объявленных в объекте.

(Унаследовано от IReadOnlyAnnotatable)
FindAnnotation(String)

Возвращает заметку с заданным именем, возвращая null , если она не существует.

(Унаследовано от IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)

Возвращает заметку среды выполнения с заданным именем, возвращая null , если она не существует.

(Унаследовано от IAnnotatable)
FindRuntimeAnnotationValue(String)

Возвращает значение заметки среды выполнения с заданным именем, возвращая null , если она не существует.

(Унаследовано от IAnnotatable)
GetAnnotation(String)

Получает заметку с заданным именем, вызывая, если она не существует.

(Унаследовано от IReadOnlyAnnotatable)
GetAnnotations()

Возвращает все заметки для текущего объекта.

(Унаследовано от IReadOnlyAnnotatable)
GetDependentKeyValueFactory()

Создает фабрику для ключевых значений на основе значений внешнего ключа, взятых из различных форм данных сущности.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

GetDependentKeyValueFactory<TKey>()

Создает фабрику для ключевых значений на основе значений внешнего ключа, взятых из различных форм данных сущности.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

GetNavigation(Boolean)

Возвращает навигацию, связанную с этим внешним ключом.

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

Возвращает значение заметки среды выполнения с заданным именем, добавив его, если он не существует.

(Унаследовано от IAnnotatable)
GetReferencingSkipNavigations()

Получает все пропускать навигации с помощью этого внешнего ключа.

GetRelatedEntityType(IReadOnlyEntityType)

Возвращает тип сущности, связанный с заданным.

GetRuntimeAnnotations()

Возвращает все заметки среды выполнения для текущего объекта.

(Унаследовано от IAnnotatable)
IsBaseLinking()

Возвращает значение, указывающее, определен ли внешний ключ на первичный ключ и указывает на тот же первичный ключ.

(Унаследовано от IReadOnlyForeignKey)
IsEffectivelyRequired()

Возвращает значение, указывающее, является ли заданное значение для этого внешнего ключа гарантированно ссылаться на существующий субъект, то есть связь является обязательной (IsRequired) и ограниченной (IsConstrained). Запросы обращаются к этому, чтобы решить, можно ли развернуть навигацию зависимых от субъекта с помощью внутреннего соединения (и можно ли запустить такое соединение); Неограниченные отношения всегда рассматриваются как необязательные, даже если его свойства внешнего ключа не имеют значения NULL.

(Унаследовано от IReadOnlyForeignKey)
RemoveRuntimeAnnotation(String)

Удаляет указанную заметку среды выполнения из этого объекта.

(Унаследовано от IAnnotatable)
SetRuntimeAnnotation(String, Object)

Задает заметку среды выполнения, хранящуюся под заданным ключом. Перезаписывает существующую заметку, если заметка с указанным именем уже существует.

(Унаследовано от IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Создает удобочитаемое представление заданных метаданных.

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

(Унаследовано от IReadOnlyForeignKey)

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

Имя. Описание
AnnotationsToDebugString(IAnnotatable, Int32)

Возвращает строку отладки для всех заметок, объявленных в объекте.

FindSharedObjectRootForeignKey(IForeignKey, StoreObjectIdentifier)

Находит первое IForeignKey , которое сопоставляется с тем же ограничением в общем объекте, как таблица.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

FindSharedObjectRootForeignKey(IReadOnlyForeignKey, StoreObjectIdentifier)

Находит первое IForeignKey , которое сопоставляется с тем же ограничением в общем объекте, как таблица.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

GetAnnotation(IAnnotatable, String)

Получает заметку с заданным именем, вызывая, если она не существует.

GetConstraintName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Возвращает имя ограничения внешнего ключа.

GetConstraintName(IForeignKey)

Возвращает имя ограничения внешнего ключа.

GetConstraintName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

Возвращает имя ограничения внешнего ключа.

GetConstraintName(IReadOnlyForeignKey)

Возвращает имя ограничения внешнего ключа.

GetDefaultName(IForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

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

GetDefaultName(IForeignKey)

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

GetDefaultName(IReadOnlyForeignKey, StoreObjectIdentifier, StoreObjectIdentifier)

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

GetDefaultName(IReadOnlyForeignKey)

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

GetDependentKeyValueFactory<TKey>(IForeignKey)

Создает фабрику для ключевых значений на основе значений внешнего ключа, взятых из различных форм данных сущности.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

GetFluentApiCalls(IForeignKey, IAnnotationCodeGenerator, Boolean)

Возвращает вызовы api fluent для настройки внешнего ключа.

GetMappedConstraints(IForeignKey)

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

GetNavigation(IForeignKey, Boolean)

Возвращает навигацию, связанную с этим внешним ключом.

GetRelatedEntityType(IForeignKey, IEntityType)

Возвращает тип сущности, связанный с заданным.

IsBaseLinking(IForeignKey)

Возвращает значение, указывающее, определен ли внешний ключ на первичный ключ и указывает на тот же первичный ключ.

IsExcludedFromMigrations(IReadOnlyForeignKey)

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

IsRowInternal(IReadOnlyForeignKey, StoreObjectIdentifier)

Возвращает значение, указывающее, является ли этот внешний ключ между двумя типами сущностей совместно использовать один и тот же объект хранилища, аналогичный таблице.

Relational(IForeignKey)

Возвращает определенные метаданные реляционной базы данных для внешнего ключа.

Sqlite(IForeignKey)

Возвращает определенные метаданные SQLite для внешнего ключа.

SqlServer(IForeignKey)

Возвращает SQL Server определенные метаданные внешнего ключа.

ToDebugString(IForeignKey, MetadataDebugStringOptions, Int32)

Создает удобочитаемое представление заданных метаданных.

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

Применяется к