IKey Интерфейс

Определение

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

Microsoft.EntityFrameworkCore.Metadata

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

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

public interface IKey : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IKey
Implements IAnnotatable, IReadOnlyKey

Производный

Microsoft.EntityFrameworkCore.Metadata.RuntimeKey

Реализации

IAnnotatable IReadOnlyAnnotatable IReadOnlyKey

Комментарии

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

Свойства

DeclaringEntityType	Возвращает тип сущности, для который определен ключ. Это может отличаться от типа, Properties определенного в , когда ключ определен как производный тип в иерархии наследования (так как свойства могут быть определены в базовом типе).
Item[String]	Возвращает значение заметки с заданным именем, возвращая null значение , если оно не существует. (Унаследовано от IReadOnlyAnnotatable)
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)
GetKeyType()	Возвращает тип свойства ключа для простых ключей или массив объектов для составных ключей.
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	Возвращает значение заметки среды выполнения с заданным именем, добавляя ее, если она не существует. (Унаследовано от IAnnotatable)
GetPrincipalKeyValueFactory()	Возвращает фабрику для значений ключей на основе значений ключей, взятых из различных форм данных сущности. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetPrincipalKeyValueFactory<TKey>()	Возвращает фабрику для значений ключей на основе значений ключей, взятых из различных форм данных сущности. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetReferencingForeignKeys()	Возвращает все внешние ключи, предназначенные для заданного первичного или альтернативного ключа.
GetRuntimeAnnotations()	Возвращает все заметки среды выполнения для текущего объекта . (Унаследовано от IAnnotatable)
IsPrimaryKey()	Возвращает значение, указывающее, является ли ключ первичным. (Унаследовано от IReadOnlyKey)
RemoveRuntimeAnnotation(String)	Удаляет заданную заметку среды выполнения из этого объекта. (Унаследовано от IAnnotatable)
SetRuntimeAnnotation(String, Object)	Задает заметку среды выполнения, хранящуюся в заданном ключе. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. (Унаследовано от IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Создает удобочитаемое представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками. (Унаследовано от IReadOnlyKey)

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

FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	Находит первый IConventionKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Находит первый IKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetDefaultName(IReadOnlyKey)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа для конкретной таблицы.
GetMappedConstraints(IKey)	Возвращает уникальные ограничения, с которыми сопоставлен ключ.
GetName(IReadOnlyKey)	Возвращает имя ограничения ключа для этого ключа.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа для этого ключа для конкретной таблицы.
GetFluentApiCalls(IKey, IAnnotationCodeGenerator)	Возвращает вызовы текучих API для настройки ключа.
IsHandledByConvention(IKey)	Возвращает значение, указывающее, будет ли ключ настроен в соответствии с соглашениями.
IsClustered(IReadOnlyKey)	Возвращает значение, указывающее, является ли ключ кластеризованным.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Возвращает значение, указывающее, является ли ключ кластеризованным.