Язык

IModel Интерфейс

Определение

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

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

Комментарии

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

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

Свойства

Имя. Описание
Item[String]

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

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

Зависимости службы среды выполнения.

ModelId

Это внутренний API, который поддерживает инфраструктуру Entity Framework Core и не соответствует тем же стандартам совместимости, что и общедоступные API. Его можно изменить или удалить без уведомления в любом выпуске. Его следует использовать непосредственно в коде с крайней осторожностью и зная, что это может привести к сбоям приложений при обновлении до нового выпуска Entity Framework Core.

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

Методы

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

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

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

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

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

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

(Унаследовано от IReadOnlyAnnotatable)
FindEntityType(String, String, IEntityType)

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

FindEntityType(String, String, IReadOnlyEntityType)

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

(Унаследовано от IReadOnlyModel)
FindEntityType(String)

Возвращает сущность с заданным именем. Возвращает, null если тип сущности с заданным именем найден или заданный тип СРЕДЫ CLR используется типом сущности общего типа или типом сущности имеет определяющую навигацию.

FindEntityType(Type, String, IEntityType)

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

FindEntityType(Type, String, IReadOnlyEntityType)

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

(Унаследовано от IReadOnlyModel)
FindEntityType(Type)

Возвращает сущность, которая сопоставляет заданный класс сущности. Возвращает, null если тип сущности с заданным типом СРЕДЫ CLR не найден или данный тип СРЕДЫ CLR используется типом сущности общего типа или типом сущности имеет определяющую навигацию.

FindEntityTypes(Type)

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

FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)

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

FindRuntimeAnnotation(String)

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

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

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

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

Возвращает сущность, сопоставляющую заданный класс сущности, где класс может быть прокси-сервером, производным от фактического типа сущности. Возвращает, null если тип сущности с заданным типом СРЕДЫ CLR не найден или данный тип СРЕДЫ CLR используется типом сущности общего типа или типом сущности имеет определяющую навигацию.

FindTypeMappingConfiguration(Type)

Находит конфигурацию предварительного соглашения для заданного скалярного Type.

GetAnnotation(String)

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

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

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

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

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

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

Возвращает имя, используемое для дискриминационных свойств, внедренных в документы JSON. Значение по умолчанию — "$type".

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

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

GetModelDependencies()

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

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

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

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

Возвращает версию сборки EF Core, используемую для сборки этой модели.

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

Возвращает значение, используемое PropertyAccessMode для свойств типов сущностей в этой модели.

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

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

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

Возвращает все конфигурации предварительного соглашения.

IsIndexerMethod(MethodInfo)

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

IsShared(Type)

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

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

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

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

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

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

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

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

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

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

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

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

AreNamedDefaultConstraintsUsed(IReadOnlyModel)

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

FindDbFunction(IModel, MethodInfo)

Находит функцию, сопоставленную с методом, представленным заданным MethodInfo.

FindDbFunction(IModel, String)

Находит функцию, сопоставленную с методом, представленным заданным именем.

FindDbFunction(IReadOnlyModel, MethodInfo)

Находит функцию, сопоставленную с методом, представленным заданным MethodInfo.

FindDbFunction(IReadOnlyModel, String)

Находит функцию, сопоставленную с методом, представленным заданным именем.

FindEntityType(IModel, Type, String, IEntityType)

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

FindEntityType(IModel, Type)
Устаревшие.

Возвращает сущность, которая сопоставляет заданный класс сущности. Возвращает, null если тип сущности с заданным типом СРЕДЫ CLR не найден или данный тип СРЕДЫ CLR используется типом сущности общего типа или типом сущности имеет определяющую навигацию.

FindFullTextCatalog(IModel, String)

Находит полнотекстовый каталог в модели или возвращается null , если он не найден.

FindFullTextCatalog(IReadOnlyModel, String)

Находит полнотекстовый каталог в модели или возвращается null , если он не найден.

FindRuntimeEntityType(IModel, Type)

Возвращает сущность, сопоставляющую заданный класс сущности, где класс может быть прокси-сервером, производным от фактического типа сущности. Возвращает, null если тип сущности с заданным типом СРЕДЫ CLR не найден или данный тип СРЕДЫ CLR используется типом сущности общего типа или типом сущности имеет определяющую навигацию.

FindSequence(IModel, String, String)

Находит последовательность с заданным именем.

FindSequence(IReadOnlyModel, String, String)

Находит последовательность с заданным именем.

GetAnnotation(IAnnotatable, String)

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

GetChangeTrackingStrategy(IModel)

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

GetCollation(IModel)

Возвращает параметры сортировки базы данных.

GetCollation(IReadOnlyModel)

Возвращает параметры сортировки базы данных.

GetDatabaseMaxSize(IModel)

Возвращает максимальный размер базы данных.

GetDatabaseMaxSize(IReadOnlyModel)

Возвращает максимальный размер базы данных.

GetDbFunctions(IModel)

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

GetDbFunctions(IReadOnlyModel)

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

GetDefaultContainer(IModel)

Возвращает имя контейнера по умолчанию.

GetDefaultContainer(IReadOnlyModel)

Возвращает имя контейнера по умолчанию.

GetDefaultFullTextSearchLanguage(IReadOnlyModel)

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

GetDefaultSchema(IModel)

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

GetDefaultSchema(IReadOnlyModel)

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

GetDiscriminatorInKey(IReadOnlyModel)

Возвращает значение, указывающее, должен ли тип сущности быть включен в значение JSON "id". До EF Core 9 она всегда включалась. Начиная с EF Core 9, он не включен по умолчанию.

GetEntityTypes(IModel, String)
Устаревшие.

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

GetEntityTypes(IModel, Type)
Устаревшие.

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

GetFluentApiCalls(IModel, IAnnotationCodeGenerator)

Получает вызовы api fluent для настройки модели.

GetFullTextCatalogs(IModel)

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

GetFullTextCatalogs(IReadOnlyModel)

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

GetHasShadowIds(IReadOnlyModel)

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

GetHiLoSequenceName(IModel)

Возвращает имя, используемое для последовательности hi-lo по умолчанию.

GetHiLoSequenceName(IReadOnlyModel)

Возвращает имя, используемое для последовательности hi-lo по умолчанию.

GetHiLoSequenceSchema(IModel)

Возвращает схему, используемую для последовательности hi-lo по умолчанию. UseHiLo(PropertyBuilder, String, String)

GetHiLoSequenceSchema(IReadOnlyModel)

Возвращает схему, используемую для последовательности hi-lo по умолчанию. UseHiLo(PropertyBuilder, String, String)

GetIdentityIncrement(IModel)

Возвращает добавочное удостоверение по умолчанию.

GetIdentityIncrement(IReadOnlyModel)

Возвращает добавочное удостоверение по умолчанию.

GetIdentitySeed(IModel)

Возвращает начальное значение удостоверения по умолчанию.

GetIdentitySeed(IReadOnlyModel)

Возвращает начальное значение удостоверения по умолчанию.

GetMaxIdentifierLength(IModel)

Возвращает максимальную длину, допустимую для идентификаторов хранилища.

GetMaxIdentifierLength(IReadOnlyModel)

Возвращает максимальную длину, допустимую для идентификаторов хранилища.

GetPerformanceLevelSql(IModel)

Возвращает уровень производительности базы данных.

GetPerformanceLevelSql(IReadOnlyModel)

Возвращает уровень производительности базы данных.

GetProductVersion(IModel)

Возвращает версию сборки EF Core, используемую для сборки этой модели.

GetPropertyAccessMode(IModel)

Возвращает значение, используемое PropertyAccessMode для свойств типов сущностей в этой модели.

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

GetRelationalDependencies(IModel, String)

Возвращает зависимости реляционной службы.

GetRelationalModel(IModel)

Возвращает модель базы данных.

GetSequenceNameSuffix(IReadOnlyModel)

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

GetSequences(IModel)

Возвращает все последовательности, содержащиеся в модели.

GetSequences(IReadOnlyModel)

Возвращает все последовательности, содержащиеся в модели.

GetSequenceSchema(IReadOnlyModel)

Возвращает схему, используемую для последовательности создания значений по умолчанию. UseSequence(PropertyBuilder, String, String)

GetServiceTierSql(IModel)

Возвращает уровень служб базы данных.

GetServiceTierSql(IReadOnlyModel)

Возвращает уровень служб базы данных.

GetThroughput(IReadOnlyModel)

Возвращает подготовленную пропускную способность в области базы данных.

GetValueGenerationStrategy(IModel)

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

GetValueGenerationStrategy(IReadOnlyModel)

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

HasEntityTypeWithDefiningNavigation(IModel, String)
Устаревшие.

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

HasEntityTypeWithDefiningNavigation(IModel, Type)
Устаревшие.

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

IsIndexerMethod(IModel, MethodInfo)

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

IsShared(IModel, Type)

Возвращает, используется ли тип СРЕДЫ CLR сущностями общего типа в модели.

Relational(IModel)

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

Scaffolding(IModel)

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

Sqlite(IModel)

Возвращает определенные метаданные SQLite для модели.

SqlServer(IModel)

Возвращает SQL Server определенные метаданные для модели.

ToDebugString(IModel, MetadataDebugStringOptions, Int32)

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

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

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