IConventionModel Интерфейс

Определение

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

Microsoft.EntityFrameworkCore.Metadata

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

Метаданные о форме сущностей, связях между ними и их сопоставлении с базой данных. Модель обычно создается путем переопределения OnModelCreating(ModelBuilder) метода в производном DbContextобъекте .

[System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")]
public interface IConventionModel : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel

[<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2072", Justification="TODO")>]
type IConventionModel = interface
    interface IReadOnlyModel
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionModel
Implements IConventionAnnotatable, IReadOnlyModel

Атрибуты

UnconditionalSuppressMessageAttribute

Реализации

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyModel

Комментарии

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

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

Свойства

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

Методы

AddAnnotation(String, Object, Boolean)	Добавляет заметку к этому объекту. Вызывает исключение, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Добавляет заметки в объект . (Унаследовано от IConventionAnnotatable)
AddEntityType(String, Boolean)	Добавляет в модель тип сущности состояния типа по умолчанию.
AddEntityType(String, String, IConventionEntityType, Boolean)	Добавляет собственный тип сущности с определяющей навигацией в модель.
AddEntityType(String, Type, Boolean)	Добавляет тип сущности общего типа в модель.
AddEntityType(Type, Boolean)	Добавляет тип сущности в модель.
AddEntityType(Type, String, IConventionEntityType, Boolean)	Добавляет собственный тип сущности с определяющей навигацией в модель.
AddIgnored(String, Boolean)	Помечает заданное имя типа сущности как игнорируемое.
AddIgnored(Type, Boolean)	Помечает данный тип сущности как игнорируемый.
AddOwned(Type, Boolean)	Помечает данный тип сущности как принадлежащий, указывая, что при обнаружении типов сущностей, использующих данный тип, следует настроить как принадлежащий.
AddOwnedEntityType(String, Boolean)	Добавляет собственный тип сущности типа по умолчанию в модель.
AddOwnedEntityType(String, Type, Boolean)	Добавляет собственный тип сущности общего типа в модель.
AddOwnedEntityType(Type, Boolean)	Добавляет собственный тип сущности в модель.
AddShared(Type, Boolean)	Помечает данный тип сущности как общий, указывая, что при обнаружении соответствующих типов сущностей следует настроить как тип сущности общего типа.
AnnotationsToDebugString(Int32)	Возвращает отладочную строку для всех заметок, объявленных в объекте . (Унаследовано от IReadOnlyAnnotatable)
DelayConventions()	Предотвращает немедленное выполнение соглашений при изменении аспекта метаданных. Все отложенные соглашения будут выполнены после удаления возвращенного объекта.
FinalizeModel()	Принудительно выполняет постобработку модели таким образом, чтобы она была готова к использованию средой выполнения. Эта постобработка выполняется автоматически при использовании OnModelCreating(ModelBuilder); этот метод позволяет выполнять ее явным образом в случаях, когда автоматическое выполнение невозможно.
FindAnnotation(String)	Возвращает заметку с заданным именем, возвращающую null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
FindEntityType(String)	Возвращает сущность с заданным именем. Возвращает значение null , если тип сущности с указанным именем не найден или заданный тип СРЕДЫ CLR используется типом сущности общего типа или тип сущности имеет определяющую навигацию.
FindEntityType(String, String, IConventionEntityType)	Возвращает тип сущности для заданного имени, определяющего имя навигации и определяющий тип сущности. Возвращает значение null , если соответствующий тип сущности не найден.
FindEntityType(String, String, IReadOnlyEntityType)	Возвращает тип сущности для заданного базового имени, определяющего имя навигации и определяющий тип сущности. Возвращает значение null , если соответствующий тип сущности не найден. (Унаследовано от IReadOnlyModel)
FindEntityType(Type)	Возвращает сущность, которая сопоставляет заданный класс сущностей. Возвращает значение null , если тип сущности с заданным именем не найден.
FindEntityType(Type, String, IConventionEntityType)	Возвращает тип сущности для заданного имени, определяющего имя навигации и определяющий тип сущности. Возвращает значение null , если соответствующий тип сущности не найден.
FindEntityType(Type, String, IReadOnlyEntityType)	Возвращает тип сущности для заданного типа, определяющий имя навигации и определяющий тип сущности. Возвращает значение null , если соответствующий тип сущности не найден. (Унаследовано от IReadOnlyModel)
FindEntityTypes(Type)	Возвращает типы сущностей, соответствующие заданному типу.
FindIgnoredConfigurationSource(String)	Указывает, игнорируется ли заданное имя типа сущности.
FindIgnoredConfigurationSource(Type)	Указывает, игнорируется ли данный тип сущности.
FindIsOwnedConfigurationSource(Type)	Возвращает источник конфигурации, если данный тип помечен как принадлежащий.
FindIsSharedConfigurationSource(Type)	Возвращает источник конфигурации, если данный тип помечен как общий.
FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)	Возвращает типы сущностей, соответствующие наименее производным типам из заданного.
GetAnnotation(String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotations()	Возвращает все заметки для текущего объекта. (Унаследовано от IReadOnlyAnnotatable)
GetChangeTrackingStrategy()	Возвращает стратегию отслеживания изменений по умолчанию, используемую для сущностей в модели. Эта стратегия показывает, как контекст обнаруживает изменения свойств для экземпляра типа сущности. (Унаследовано от IReadOnlyModel)
GetChangeTrackingStrategyConfigurationSource()	Возвращает источник конфигурации для GetChangeTrackingStrategy().
GetEntityTypes()	Возвращает все типы сущностей, определенные в модели.
GetProductVersion()	Возвращает версию сборки EF Core, используемую для сборки этой модели. (Унаследовано от IReadOnlyModel)
GetPropertyAccessMode()	Возвращает объект , используемый PropertyAccessMode для свойств типов сущностей в этой модели. (Унаследовано от IReadOnlyModel)
GetPropertyAccessModeConfigurationSource()	Возвращает источник конфигурации для GetPropertyAccessMode().
IsIgnored(String)	Указывает, игнорируется ли заданное имя типа сущности.
IsIgnored(Type)	Указывает, игнорируется ли данный тип сущности.
IsIgnoredType(Type)	Указывает, следует ли игнорировать типы сущностей и свойства с заданным типом. Эта конфигурация не зависит от IsIgnored(Type)
IsOwned(Type)	Возвращает значение, указывающее, следует ли при обнаружении настроить типы сущностей, использующие данный тип, в качестве принадлежащих типов.
RemoveAnnotation(String)	Удаляет заметку с заданным именем из этого объекта. (Унаследовано от IConventionAnnotatable)
RemoveEntityType(IConventionEntityType)	Удаляет тип сущности из модели.
RemoveEntityType(String)	Удаляет тип сущности без определяющей навигации из модели.
RemoveEntityType(String, String, IConventionEntityType)	Удаляет тип сущности с заданным типом, определяющий имя навигации и определяющий тип сущности.
RemoveEntityType(Type)	Удаляет тип сущности из модели.
RemoveEntityType(Type, String, IConventionEntityType)	Удаляет тип сущности с заданным типом, определяющий имя навигации и определяющий тип сущности.
RemoveIgnored(String)	Удаляет игнорируемое имя типа сущности.
RemoveOwned(Type)	Удаляет заданный тип, указывающий, что при обнаружении соответствующих типов сущностей не следует настраивать как принадлежащие.
RemoveShared(Type)	Помечает данный тип как не общий, указывая, что при обнаружении соответствующих типов сущностей не следует настраивать как типы сущностей общего типа.
SetAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>, Boolean)	Задает стратегию отслеживания изменений по умолчанию, используемую для сущностей в модели. Эта стратегия показывает, как контекст обнаруживает изменения свойств для экземпляра типа сущности.
SetOrRemoveAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. Удаляет существующую заметку, если null она указана. (Унаследовано от IConventionAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)	Задает для PropertyAccessMode использования для свойств всех типов сущностей в этой модели.
ToDebugString(MetadataDebugStringOptions, Int32)	Создает понятное представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками. (Унаследовано от IReadOnlyModel)

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

GetDefaultContainer(IReadOnlyModel)	Возвращает имя контейнера по умолчанию.
GetDefaultContainerConfigurationSource(IConventionModel)	Возвращает источник конфигурации для имени контейнера по умолчанию.
GetThroughput(IReadOnlyModel)	Возвращает подготовленную пропускную способность в область базы данных.
GetThroughputConfigurationSource(IConventionModel)	ConfigurationSource Возвращает для подготовленной пропускной способности в область базы данных.
SetDefaultContainer(IConventionModel, String, Boolean)	Задает имя контейнера по умолчанию.
SetThroughput(IConventionModel, Nullable<Int32>, Nullable<Boolean>, Boolean)	Задает подготовленную пропускную способность на область базы данных.
AddDbFunction(IConventionModel, MethodInfo, Boolean)	Создает функцию, сопоставленную с заданным методом.
AddDbFunction(IConventionModel, String, Type, Boolean)	Создает функцию.
AddSequence(IConventionModel, String, String, Boolean)	Либо возвращает существующий IMutableSequence объект с заданным именем в заданной схеме, либо создает новую последовательность с заданным именем и схемой.
FindDbFunction(IConventionModel, MethodInfo)	Находит функцию, сопоставленную с методом, представленным заданным MethodInfo.
FindDbFunction(IConventionModel, String)	Находит функцию, сопоставленную с методом, представленным заданным именем.
FindDbFunction(IReadOnlyModel, MethodInfo)	Находит функцию, сопоставленную с методом, представленным заданным MethodInfo.
FindDbFunction(IReadOnlyModel, String)	Находит функцию, сопоставленную с методом, представленным заданным именем.
FindSequence(IConventionModel, String, String)	Находит последовательность с заданным именем.
FindSequence(IReadOnlyModel, String, String)	Находит последовательность с заданным именем.
GetCollation(IReadOnlyModel)	Возвращает параметры сортировки базы данных.
GetCollationConfigurationSource(IConventionModel)	Возвращает источник конфигурации для параметров сортировки.
GetDbFunctions(IConventionModel)	Возвращает все функции, содержащиеся в модели.
GetDbFunctions(IReadOnlyModel)	Возвращает все функции, содержащиеся в модели.
GetDefaultSchema(IReadOnlyModel)	Возвращает схему по умолчанию, используемую для модели, или null значение , если она не была задана.
GetDefaultSchemaConfigurationSource(IConventionModel)	Возвращает источник конфигурации для схемы по умолчанию.
GetMaxIdentifierLength(IReadOnlyModel)	Возвращает максимальную длину, разрешенную для идентификаторов хранилища.
GetMaxIdentifierLengthConfigurationSource(IConventionModel)	Возвращает источник конфигурации для GetMaxIdentifierLength(IReadOnlyModel).
GetSequences(IConventionModel)	Возвращает все последовательности, содержащиеся в модели.
GetSequences(IReadOnlyModel)	Возвращает все последовательности, содержащиеся в модели.
RemoveDbFunction(IConventionModel, MethodInfo)	Удаляет функцию, сопоставленную с методом, представленным заданным MethodInfo.
RemoveDbFunction(IConventionModel, String)	Удаляет функцию, сопоставленную с методом, представленным заданным MethodInfo.
RemoveSequence(IConventionModel, String, String)	Удаляет объект IConventionSequence с заданным именем.
SetCollation(IConventionModel, String, Boolean)	Задает параметры сортировки базы данных.
SetDefaultSchema(IConventionModel, String, Boolean)	Задает схему по умолчанию.
SetMaxIdentifierLength(IConventionModel, Nullable<Int32>, Boolean)	Задает максимальную длину, допустимую для идентификаторов хранилища.
GetDatabaseMaxSize(IReadOnlyModel)	Возвращает максимальный размер базы данных.
GetDatabaseMaxSizeConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource максимального размера базы данных.
GetHiLoSequenceName(IReadOnlyModel)	Возвращает имя, используемое для последовательности hi-lo по умолчанию.
GetHiLoSequenceNameConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource имени последовательности hi-lo по умолчанию.
GetHiLoSequenceSchema(IReadOnlyModel)	Возвращает схему, используемую для последовательности hi-lo по умолчанию. UseHiLo(PropertyBuilder, String, String)
GetHiLoSequenceSchemaConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource схемы последовательности hi-lo по умолчанию.
GetIdentityIncrement(IReadOnlyModel)	Возвращает приращение удостоверения по умолчанию.
GetIdentityIncrementConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource приращения удостоверения по умолчанию.
GetIdentitySeed(IReadOnlyModel)	Возвращает начальное значение идентификатора по умолчанию.
GetIdentitySeedConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource схемы по умолчанию.
GetPerformanceLevelSql(IReadOnlyModel)	Возвращает уровень производительности базы данных.
GetPerformanceLevelSqlConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource уровня производительности базы данных.
GetSequenceNameSuffix(IReadOnlyModel)	Возвращает суффикс, добавляемый к имени автоматически создаваемых последовательностей.
GetSequenceNameSuffixConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource суффикса имени последовательности создания значений по умолчанию.
GetSequenceSchema(IReadOnlyModel)	Возвращает схему, используемую для последовательности создания значений по умолчанию. UseSequence(PropertyBuilder, String, String)
GetSequenceSchemaConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource схемы последовательности создания значения ключа по умолчанию.
GetServiceTierSql(IReadOnlyModel)	Возвращает уровень служб базы данных.
GetServiceTierSqlConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource уровня служб базы данных.
GetValueGenerationStrategy(IReadOnlyModel)	Возвращает объект , используемый SqlServerValueGenerationStrategy для свойств ключей в модели, если свойство не имеет явно заданную стратегию.
GetValueGenerationStrategyConfigurationSource(IConventionModel)	Возвращает для ConfigurationSource по умолчанию SqlServerValueGenerationStrategy.
SetDatabaseMaxSize(IConventionModel, String, Boolean)	Задает максимальный размер базы данных.
SetHiLoSequenceName(IConventionModel, String, Boolean)	Задает имя, используемое для последовательности hi-lo по умолчанию.
SetHiLoSequenceSchema(IConventionModel, String, Boolean)	Задает схему, используемую для последовательности hi-lo по умолчанию.
SetIdentityIncrement(IConventionModel, Nullable<Int32>, Boolean)	Задает приращение удостоверения по умолчанию.
SetIdentitySeed(IConventionModel, Nullable<Int64>, Boolean)	Задает начальное значение идентификатора по умолчанию.
SetPerformanceLevelSql(IConventionModel, String, Boolean)	Задает уровень производительности базы данных.
SetSequenceNameSuffix(IConventionModel, String, Boolean)	Задает суффикс для добавления к имени автоматически создаваемых последовательностей.
SetSequenceSchema(IConventionModel, String, Boolean)	Задает схему, используемую для последовательности создания значения ключа по умолчанию.
SetServiceTierSql(IConventionModel, String, Boolean)	Задает уровень служб базы данных.
SetValueGenerationStrategy(IConventionModel, Nullable<SqlServerValueGenerationStrategy>, Boolean)	SqlServerValueGenerationStrategy Задает для использования для свойств ключей в модели, для которых явно не задана стратегия.