Язык

ModelBuilder Класс

Определение

Предоставляет простую область API для настройки IMutableModel , которая определяет форму сущностей, связи между ними и их сопоставление с базой данных.

public class ModelBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalModelBuilder>
[System.Runtime.CompilerServices.Nullable(0)]
public class ModelBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionModelBuilder>
public class ModelBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionModelBuilder>
type ModelBuilder = class
    interface IInfrastructure<InternalModelBuilder>
[<System.Runtime.CompilerServices.Nullable(0)>]
type ModelBuilder = class
    interface IInfrastructure<IConventionModelBuilder>
type ModelBuilder = class
    interface IInfrastructure<IConventionModelBuilder>
Public Class ModelBuilder
Implements IInfrastructure(Of InternalModelBuilder)
Public Class ModelBuilder
Implements IInfrastructure(Of IConventionModelBuilder)
Наследование
ModelBuilder
Атрибуты
Реализации
IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalModelBuilder> IInfrastructure<IConventionModelBuilder>

Комментарии

Можно использовать ModelBuilder для создания модели для контекста, переопределив OnModelCreating(ModelBuilder) производный контекст. Кроме того, можно создать модель внешне и задать ее на экземпляре DbContextOptions , который передается конструктору контекста.

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

Конструкторы

Имя. Описание
ModelBuilder()

Инициализирует новый экземпляр класса без соглашений ModelBuilder .

Предупреждение. Для создания правильной модели необходимы соглашения.

ModelBuilder(ConventionSet, ModelDependencies, ModelConfiguration)

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

ModelBuilder(ConventionSet, ModelDependencies)

Инициализирует новый экземпляр ModelBuilder класса, который будет применять набор соглашений.

ModelBuilder(ConventionSet)

Инициализирует новый экземпляр ModelBuilder класса, который будет применять набор соглашений.

ModelBuilder(IMutableModel)
Устаревшие.

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

Свойства

Имя. Описание
Model

Настраиваемая модель.

Методы

Имя. Описание
ApplyConfiguration<TEntity>(IEntityTypeConfiguration<TEntity>)

Применяет конфигурацию, определенную в экземпляре IEntityTypeConfiguration<TEntity> .

ApplyConfiguration<TQuery>(IQueryTypeConfiguration<TQuery>)
Устаревшие.

Применяет конфигурацию, определенную в экземпляре IQueryTypeConfiguration<TQuery> .

ApplyConfigurationsFromAssembly(Assembly, Func<Type,Boolean>)

Применяет конфигурацию со всех IEntityTypeConfiguration<TEntity> экземпляров, определенных в предоставленной сборке.

Entity(String, Action<EntityTypeBuilder>)

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

Entity(String)

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

Entity(Type, Action<EntityTypeBuilder>)

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

Entity(Type)

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

Entity<TEntity>()

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

Entity<TEntity>(Action<EntityTypeBuilder<TEntity>>)

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

FinalizeModel()

Принудительно выполняет постобработку модели, чтобы она была готова к использованию средой выполнения. Эта после обработки выполняется автоматически при использовании OnModelCreating(ModelBuilder); этот метод позволяет выполняться явно в случаях, когда автоматическое выполнение невозможно.

HasAnnotation(String, Object)

Добавляет или обновляет заметку в модели. Если заметка с ключом, указанным в annotation уже существующем значении, будет обновлена.

HasChangeTrackingStrategy(ChangeTrackingStrategy)

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

HasChangeTrackingStrategy(ChangeTrackingStrategy)

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

HasEmbeddedDiscriminatorName(String)

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

Ignore(String)

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

Ignore(Type)

Исключает тип сущности с заданным типом СРЕДЫ CLR из модели. Этот метод обычно используется для удаления типов из модели, добавленной по соглашению.

Ignore<TEntity>()

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

Owned(Type)

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

Owned<T>()

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

Query(Type, Action<EntityTypeBuilder>)
Устаревшие.

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

Эта перегрузка позволяет выполнять настройку типа запроса в строке вызова метода, а не цепочку после вызова Query<TQuery>(). Это позволяет создать дополнительную конфигурацию на уровне модели после настройки для типа запроса.

Query(Type, Action<QueryTypeBuilder>)

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

Эта перегрузка позволяет выполнять настройку типа запроса в строке вызова метода, а не цепочку после вызова Query<TQuery>(). Это позволяет создать дополнительную конфигурацию на уровне модели после настройки для типа запроса.

Query(Type)
Устаревшие.

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

Query<TQuery>()
Устаревшие.

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

Query<TQuery>(Action<QueryTypeBuilder<TQuery>>)
Устаревшие.

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

Эта перегрузка позволяет выполнять настройку типа запроса в строке вызова метода, а не цепочку после вызова Query<TQuery>(). Это позволяет создать дополнительную конфигурацию на уровне модели после настройки для типа запроса.

SharedTypeEntity(String, Type, Action<EntityTypeBuilder>)

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

SharedTypeEntity(String, Type)

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

SharedTypeEntity<TEntity>(String, Action<EntityTypeBuilder<TEntity>>)

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

SharedTypeEntity<TEntity>(String)

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

UsePropertyAccessMode(PropertyAccessMode)

PropertyAccessMode Задает для всех свойств этого типа сущности.

По умолчанию резервное поле, если оно найдено по соглашению или было указано, используется при создании новых объектов, как правило, когда сущности запрашиваются из базы данных. Свойства используются для всех других доступа. Вызов этого метода witll изменяет это поведение для всех свойств в модели, как описано в перечислении PropertyAccessMode .

UsePropertyAccessMode(PropertyAccessMode)

PropertyAccessMode Задает для всех свойств этого типа сущности.

Явные реализации интерфейса

Имя. Описание
IInfrastructure<IConventionModelBuilder>.Instance

Внутреннее ModelBuilder использование для настройки этой модели.

IInfrastructure<InternalModelBuilder>.Instance

Внутреннее ModelBuilder использование для настройки этой модели.

Это свойство предназначено для использования методами расширения для настройки модели. Он не предназначен для использования в коде приложения.

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

Имя. Описание
ForSqlServerHasSequence(ModelBuilder, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence(ModelBuilder, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence(ModelBuilder, String, String)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence(ModelBuilder, Type, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence(ModelBuilder, Type, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence(ModelBuilder, Type, String, String)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence<T>(ModelBuilder, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence<T>(ModelBuilder, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerHasSequence<T>(ModelBuilder, String, String)

Настраивает последовательность базы данных при выборе SQL Server.

ForSqlServerUseIdentityColumns(ModelBuilder, Int32, Int32)
Устаревшие.

Настраивает модель для использования функции SQL Server IDENTITY для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server. Это поведение по умолчанию при выборе SQL Server.

ForSqlServerUseIdentityColumns(ModelBuilder)

Настраивает модель для использования функции SQL Server IDENTITY для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server. Это поведение по умолчанию при выборе SQL Server.

ForSqlServerUseSequenceHiLo(ModelBuilder, String, String)
Устаревшие.

Настраивает модель для использования шаблона на основе последовательности hi-lo для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server.

GetInfrastructure<T>(IInfrastructure<T>)

Возвращает значение из свойства, скрытого с помощью IInfrastructure<T>.

Этот метод обычно используется поставщиками баз данных (и другими расширениями). Обычно он не используется в коде приложения.

HasAutoscaleThroughput(ModelBuilder, Nullable<Int32>)

Настраивает предложение подготовленной пропускной способности автомасштабирования.

HasDatabaseMaxSize(ModelBuilder, String)

Настраивает максимальный размер для База данных SQL Azure.

HasDbFunction(ModelBuilder, MethodInfo, Action<DbFunctionBuilder>)

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

HasDbFunction(ModelBuilder, MethodInfo)

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

HasDbFunction<TResult>(ModelBuilder, Expression<Func<TResult>>)

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

HasDefaultContainer(ModelBuilder, String)

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

HasDefaultFullTextLanguage(ModelBuilder, String)

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

HasDefaultSchema(ModelBuilder, String)

Настраивает схему по умолчанию, в которую должны быть созданы объекты базы данных, если схема не настроена явным образом.

HasDiscriminatorInJsonIds(ModelBuilder, Nullable<Boolean>)

Включает дискриминационные значения типа сущности в значении JSON "id". Это было поведением по умолчанию до EF Core 9.

HasFullTextCatalog(ModelBuilder, String)

Настраивает полнотекстовый каталог в модели.

HasManualThroughput(ModelBuilder, Nullable<Int32>)

Настраивает предложение подготовленной вручную пропускной способности.

HasPerformanceLevel(ModelBuilder, String)

Настраивает уровень производительности (SERVICE_OBJECTIVE) для База данных SQL Azure в виде строкового литерала.

HasPerformanceLevelSql(ModelBuilder, String)

Настраивает уровень производительности (SERVICE_OBJECTIVE) для База данных SQL Azure в виде выражения SQL.

HasRootDiscriminatorInJsonId(ModelBuilder, Nullable<Boolean>)

Включает дискриминационный тип корневой сущности в значении JSON "id". Это позволяет сохранять типы с тем же первичным ключом в том же контейнере, но по-прежнему разрешать использовать ReadItem для поиска неизвестного типа.

HasSequence(ModelBuilder, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, String, String)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence(ModelBuilder, Type, String, String)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, String, Action<RelationalSequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, String, Action<SequenceBuilder>)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasSequence<T>(ModelBuilder, String, String)

Настраивает последовательность баз данных при выборе реляционной базы данных.

HasServiceTier(ModelBuilder, String)

Настраивает уровень служб (EDITION) для База данных SQL Azure в виде строкового литерала.

HasServiceTierSql(ModelBuilder, String)

Настраивает уровень служб (EDITION) для База данных SQL Azure в виде выражения SQL.

HasShadowIds(ModelBuilder, Nullable<Boolean>)

Принудительно создает модель для создания теневого свойства __id, сопоставленного с идентификатором JSON. Это было поведение по умолчанию до EF Core 9.0.

UseCollation(ModelBuilder, String)

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

UseHiLo(ModelBuilder, String, String)

Настраивает модель для использования шаблона на основе последовательности hi-lo для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server.

UseIdentityColumns(ModelBuilder, Int32, Int32)

Настраивает модель для использования функции SQL Server IDENTITY для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server. Это поведение по умолчанию при выборе SQL Server.

UseIdentityColumns(ModelBuilder, Int64, Int32)

Настраивает модель для использования функции SQL Server IDENTITY для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server. Это поведение по умолчанию при выборе SQL Server.

UseKeySequences(ModelBuilder, String, String)

Настраивает модель для использования последовательности для каждой иерархии для создания значений для ключевых свойств, помеченных как OnAddпри целевом SQL Server.

UseNamedDefaultConstraints(ModelBuilder, Boolean)

Настраивает модель для использования именованных ограничений по умолчанию.

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