IConventionKey Интерфейс

Ссылка

Определение

Пространство имен:: Microsoft.EntityFrameworkCore.Metadata

Сборка:: Microsoft.EntityFrameworkCore.dll

Пакет:: Microsoft.EntityFrameworkCore v3.0.0

Пакет:: Microsoft.EntityFrameworkCore v3.1.0

Пакет:: Microsoft.EntityFrameworkCore v5.0.0

Пакет:: Microsoft.EntityFrameworkCore v6.0.0

Пакет:: Microsoft.EntityFrameworkCore v7.0.0

Пакет:: Microsoft.EntityFrameworkCore v8.0.0

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

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

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IKey

public interface IConventionKey : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyKey

type IConventionKey = interface
    interface IConventionAnnotatable
    interface IAnnotatable
    interface IKey

type IConventionKey = interface
    interface IReadOnlyKey
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionKey
Implements IConventionAnnotatable, IKey

Public Interface IConventionKey
Implements IConventionAnnotatable, IReadOnlyKey

Реализации: IAnnotatable IConventionAnnotatable IKey IReadOnlyAnnotatable IReadOnlyKey

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

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

Свойства

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

Методы

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

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

AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)	Добавляет заметки к объекту .
GetAnnotation(IConventionAnnotatable, String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует.
SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. Удаляет существующую заметку, если `null` она указана.
GetReferencingForeignKeys(IConventionKey)	Возвращает все внешние ключи, предназначенные для заданного первичного или альтернативного ключа.
AnnotationsToDebugString(IAnnotatable, Int32)	Возвращает строку отладки для всех заметок, объявленных в объекте .
GetAnnotation(IAnnotatable, String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует.
GetKeyType(IKey)	Возвращает тип свойства ключа для простых ключей или массив объектов для составных ключей.
GetPrincipalKeyValueFactory<TKey>(IKey)	Возвращает фабрику для значений ключей на основе значений ключа индекса, взятых из различных форм данных сущностей. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetReferencingForeignKeys(IKey)	Возвращает все внешние ключи, предназначенные для заданного первичного или альтернативного ключа.
IsPrimaryKey(IKey)	Возвращает значение, указывающее, является ли ключ первичным.
ToDebugString(IKey, MetadataDebugStringOptions, Int32)	Создает удобочитаемое представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками.
FindSharedObjectRootKey(IConventionKey, StoreObjectIdentifier)	Находит первый IConventionKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
FindSharedObjectRootKey(IKey, StoreObjectIdentifier)	Находит первый IConventionKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
FindSharedObjectRootKey(IReadOnlyKey, StoreObjectIdentifier)	Находит первый IKey объект, сопоставленный с тем же ограничением в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.
GetDefaultName(IKey)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа.
GetDefaultName(IKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа для конкретной таблицы.
GetDefaultName(IReadOnlyKey)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа.
GetDefaultName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа по умолчанию, которое будет использоваться для этого ключа для конкретной таблицы.
GetMappedConstraints(IKey)	Возвращает уникальные ограничения, с которыми сопоставлен ключ.
GetName(IKey)	Возвращает имя ограничения ключа для этого ключа.
GetName(IKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа для этого ключа для конкретной таблицы.
GetName(IReadOnlyKey)	Возвращает имя ограничения ключа для этого ключа.
GetName(IReadOnlyKey, StoreObjectIdentifier)	Возвращает имя ограничения ключа для этого ключа для конкретной таблицы.
GetNameConfigurationSource(IConventionKey)	Возвращает для ConfigurationSource имени ограничения.
SetName(IConventionKey, String, Boolean)	Задает имя ограничения ключа для этого ключа.
GetIsClusteredConfigurationSource(IConventionKey)	Возвращает значение , ConfigurationSource указывающее, является ли ключ кластеризованным.
IsClustered(IKey)	Возвращает значение, указывающее, является ли ключ кластеризованным.
IsClustered(IKey, StoreObjectIdentifier)	Возвращает значение, указывающее, является ли ключ кластеризованным.
IsClustered(IReadOnlyKey)	Возвращает значение, указывающее, является ли ключ кластеризованным.
IsClustered(IReadOnlyKey, StoreObjectIdentifier)	Возвращает значение, указывающее, является ли ключ кластеризованным.
SetIsClustered(IConventionKey, Nullable<Boolean>, Boolean)	Задает значение, указывающее, кластеризован ли ключ.

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

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через