IConventionKey Интерфейс

Определение

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

Microsoft.EntityFrameworkCore.Metadata

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

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

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

Реализации

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyKey

Комментарии

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

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

Свойства

Builder	Возвращает построитель, который можно использовать для настройки этого ключа.
DeclaringEntityType	Возвращает тип сущности, для который определен ключ. Это может отличаться от типа, Properties определенного в , когда ключ определен как производный тип в иерархии наследования (так как свойства могут быть определены в базовом типе).
IsInModel	Указывает, находится ли этот объект в модели, т. е. не был удален из нее. (Унаследовано от IConventionAnnotatable)
Item[String]	Возвращает значение заметки с заданным именем, возвращая null значение , если оно не существует. (Унаследовано от IReadOnlyAnnotatable)
Properties	Возвращает свойства, составляющие ключ.

Методы

AddAnnotation(String, Object, Boolean)	Добавляет заметку к этому объекту. Вызывает исключение, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Добавляет заметки к объекту . (Унаследовано от IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Возвращает строку отладки для всех заметок, объявленных в объекте . (Унаследовано от IReadOnlyAnnotatable)
FindAnnotation(String)	Возвращает заметку с заданным именем, возвращающую null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotation(String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotations()	Возвращает все заметки к текущему объекту. (Унаследовано от IReadOnlyAnnotatable)
GetConfigurationSource()	Возвращает источник конфигурации для этого ключа.
GetReferencingForeignKeys()	Возвращает все внешние ключи, предназначенные для заданного первичного или альтернативного ключа.
IsPrimaryKey()	Возвращает значение, указывающее, является ли ключ первичным. (Унаследовано от IReadOnlyKey)
RemoveAnnotation(String)	Удаляет заметку с заданным именем из этого объекта. (Унаследовано от IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
SetOrRemoveAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. Удаляет существующую заметку, если null она указана. (Унаследовано от IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Создает удобочитаемое представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками. (Унаследовано от IReadOnlyKey)

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

FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)	Находит первый IConventionKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Находит первый IKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetDefaultName(IReadOnlyKey)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа для конкретной таблицы.
GetName(IReadOnlyKey)	Возвращает имя ограничения ключа для этого ключа.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа для этого ключа для конкретной таблицы.
GetNameConfigurationSource(IConventionKey)	Возвращает для ConfigurationSource имени ограничения.
SetName(IConventionKey, String, Boolean)	Задает имя ограничения ключа для этого ключа.
GetIsClusteredConfigurationSource(IConventionKey)	Возвращает значение , ConfigurationSource указывающее, является ли ключ кластеризованным.
IsClustered(IReadOnlyKey)	Возвращает значение, указывающее, является ли ключ кластеризованным.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Возвращает значение, указывающее, является ли ключ кластеризованным.
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	Задает значение, указывающее, кластеризован ли ключ.