IMutableModel 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

程序包:

Microsoft.EntityFrameworkCore v10.0.0

Source:

IMutableModel.cs

有关实体形状、实体之间的关系以及实体映射到数据库的方式的元数据。 模型通常通过重写 OnModelCreating(ModelBuilder) 派生 DbContext的方法来创建。

public interface IMutableModel : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyModel

type IMutableModel = interface
    interface IReadOnlyModel
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable

Public Interface IMutableModel
Implements IMutableAnnotatable, IReadOnlyModel

实现

IMutableAnnotatable IReadOnlyAnnotatable IReadOnlyModel

注解

此接口在创建模型期间使用，并允许修改元数据。 生成模型后， IModel 表示相同元数据的只读视图。

有关详细信息和示例，请参阅 建模实体类型和关系 。

属性

名称	说明
Item[String]	获取具有给定名称的批注的值，如果不存在，则 null 返回该值。 (继承自 IReadOnlyAnnotatable)
ModelId	这是一个内部 API，支持Entity Framework Core基础结构，不受与公共 API 相同的兼容性标准的约束。 可以在任何版本中更改或删除它，而不通知。 只需在代码中直接使用它，并非常谨慎地知道这样做可能会导致应用程序在更新到新的Entity Framework Core版本时失败。 (继承自 IReadOnlyModel)

方法

名称	说明
AddAnnotation(String, Object)	向此对象添加批注。 如果具有指定名称的批注已存在，则引发。 (继承自 IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)	向对象添加批注。 (继承自 IMutableAnnotatable)
AddEntityType(String, String, IMutableEntityType)	向模型添加具有定义导航的自有实体类型。
AddEntityType(String, Type)	向模型添加共享类型实体类型。
AddEntityType(String)	将默认类型的实体类型添加到模型。
AddEntityType(Type, String, IMutableEntityType)	向模型添加具有定义导航的自有实体类型。
AddEntityType(Type)	将实体类型添加到模型。
AddIgnored(String)	将给定的实体类型名称标记为忽略，防止约定向模型添加匹配的实体类型。
AddIgnored(Type)	将给定实体类型标记为忽略，防止约定向模型添加匹配的实体类型。
AddOwned(Type)	将给定的实体类型标记为拥有，指示何时应将发现的匹配实体类型配置为拥有。
AddOwnedEntityType(String, Type)	将拥有的共享类型实体类型添加到模型。
AddOwnedEntityType(String)	将默认类型的自有实体类型添加到模型。
AddOwnedEntityType(Type)	将拥有的实体类型添加到模型。
AddShared(Type)	将给定实体类型标记为共享，指示何时应将发现的匹配实体类型配置为共享类型实体类型。
AnnotationsToDebugString(Int32)	获取针对对象上声明的所有批注的调试字符串。 (继承自 IReadOnlyAnnotatable)
DelayConventions()	防止在修改元数据方面时立即执行约定。 释放返回的对象后，将执行所有延迟约定。
FinalizeModel()	强制在模型上进行后期处理，使其可供运行时使用。 使用 OnModelCreating(ModelBuilder)后处理时会自动发生;此方法允许在无法自动执行的情况下显式运行。
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则 null 返回。 (继承自 IReadOnlyAnnotatable)
FindEntityType(String, String, IMutableEntityType)	获取给定名称的实体类型，定义导航名称和定义实体类型。 如果未找到匹配的实体类型，则返回 null 。
FindEntityType(String, String, IReadOnlyEntityType)	获取给定基名称、定义导航名称和定义实体类型的实体类型。 如果未找到匹配的实体类型，则返回 null 。 (继承自 IReadOnlyModel)
FindEntityType(String)	获取具有给定名称的实体。 如果 null 找不到具有给定名称的实体类型，或者共享类型实体类型或实体类型具有定义导航，则返回给定 CLR 类型。
FindEntityType(Type, String, IMutableEntityType)	获取给定名称的实体类型，定义导航名称和定义实体类型。 如果未找到匹配的实体类型，则返回 null 。
FindEntityType(Type, String, IReadOnlyEntityType)	获取给定类型的实体类型，定义导航名称和定义实体类型。 如果未找到匹配的实体类型，则返回 null 。 (继承自 IReadOnlyModel)
FindEntityType(Type)	获取映射给定实体类的实体。 如果 null 找不到具有给定 CLR 类型的实体类型，或者共享类型实体类型或实体类型具有定义导航，则返回给定 CLR 类型。
FindEntityTypes(Type)	获取与给定类型匹配的实体类型。
FindLeastDerivedEntityTypes(Type, Func<IReadOnlyEntityType,Boolean>)	返回对应于给定类型中最小派生类型的实体类型。
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 IReadOnlyAnnotatable)
GetAnnotations()	获取当前对象上的所有批注。 (继承自 IReadOnlyAnnotatable)
GetChangeTrackingStrategy()	获取用于模型中实体的默认更改跟踪策略。 此策略指示上下文如何检测实体类型的实例的属性更改。 (继承自 IReadOnlyModel)
GetEmbeddedDiscriminatorName()	获取用于 JSON 文档中嵌入的歧视性属性的名称。 默认值为“$type”。 (继承自 IReadOnlyModel)
GetEntityTypes()	获取模型中定义的所有实体类型。
GetProductVersion()	获取用于生成此模型的 EF Core 程序集版本。 (继承自 IReadOnlyModel)
GetPropertyAccessMode()	PropertyAccessMode获取用于此模型中实体类型的属性。 (继承自 IReadOnlyModel)
IsIgnored(String)	指示是否忽略给定实体类型名称。
IsIgnored(Type)	指示是否忽略给定实体类型名称。
IsOwned(Type)	返回一个值，该值指示在约定发现时，是否应将使用给定类型的实体类型配置为拥有的类型。
IsShared(Type)	获取一个值，该值指示是否由模型中的共享类型实体使用 CLR 类型。 (继承自 IReadOnlyModel)
RemoveAnnotation(String)	从此对象中删除给定批注。 (继承自 IMutableAnnotatable)
RemoveEntityType(IMutableEntityType)	从模型中删除实体类型。
RemoveEntityType(String, String, IMutableEntityType)	删除具有给定类型的实体类型、定义导航名称和定义实体类型
RemoveEntityType(String)	删除实体类型，而无需从模型定义导航。
RemoveEntityType(Type, String, IMutableEntityType)	删除具有给定类型的实体类型、定义导航名称和定义实体类型
RemoveEntityType(Type)	从模型中删除实体类型。
RemoveIgnored(String)	删除忽略的实体类型名称。
RemoveIgnored(Type)	删除忽略的实体类型。
RemoveOwned(Type)	删除给定拥有的类型，指示在发现匹配实体类型时不应配置为拥有类型。
RemoveShared(Type)	将给定类型标记为不共享，指示在发现匹配实体类型时不应配置为共享类型实体类型。
SetAnnotation(String, Object)	设置存储在给定键下的批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 IMutableAnnotatable)
SetChangeTrackingStrategy(Nullable<ChangeTrackingStrategy>)	设置要用于模型中实体的默认更改跟踪策略。 此策略指示上下文如何检测实体类型的实例的属性更改。
SetEmbeddedDiscriminatorName(String)	设置用于 JSON 文档中嵌入的歧视性属性的名称。 默认值为“$type”。
SetOrRemoveAnnotation(String, Object)	设置存储在给定名称下的批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 如果 null 已提供，则删除现有批注。 (继承自 IMutableAnnotatable)
SetPropertyAccessMode(Nullable<PropertyAccessMode>)	设置 PropertyAccessMode 用于此模型中所有实体类型的属性。
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，可以在版本之间任意更改。 (继承自 IReadOnlyModel)

扩展方法

名称	说明
AddDbFunction(IMutableModel, MethodInfo)	IMutableDbFunction创建映射到给定方法的映射。
AddDbFunction(IMutableModel, String, Type)	创建函数。
AddSequence(IMutableModel, String, String)	返回给定架构中具有给定名称的现有 IMutableSequence 名称，或者创建具有给定名称和架构的新序列。
AreNamedDefaultConstraintsUsed(IReadOnlyModel)	返回一个值，该值指示是否应使用命名的默认约束。
FindDbFunction(IMutableModel, MethodInfo)	查找映射到由给定 MethodInfo表示的方法的函数。
FindDbFunction(IMutableModel, String)	查找映射到由给定名称表示的方法的函数。
FindDbFunction(IReadOnlyModel, MethodInfo)	查找映射到由给定 MethodInfo表示的方法的函数。
FindDbFunction(IReadOnlyModel, String)	查找映射到由给定名称表示的方法的函数。
FindSequence(IMutableModel, String, String)	查找具有给定名称的序列。
FindSequence(IReadOnlyModel, String, String)	查找具有给定名称的序列。
GetCollation(IReadOnlyModel)	返回数据库排序规则。
GetDatabaseMaxSize(IReadOnlyModel)	返回数据库的最大大小。
GetDbFunctions(IMutableModel)	返回模型中包含的所有函数。
GetDbFunctions(IReadOnlyModel)	返回模型中包含的所有函数。
GetDefaultContainer(IReadOnlyModel)	返回默认容器名称。
GetDefaultFullTextSearchLanguage(IReadOnlyModel)	返回数据库范围内全文搜索的默认语言。
GetDefaultSchema(IReadOnlyModel)	返回要用于模型的默认架构，或者 null 如果未设置任何架构。
GetDiscriminatorInKey(IReadOnlyModel)	返回一个值，该值指示实体类型鉴别器是否应包含在 JSON“id”值中。 在 EF Core 9 之前，始终包含它。 从 EF Core 9 开始，默认情况下不包括它。
GetHasShadowIds(IReadOnlyModel)	返回一个值，该值指示是否可以从当前配置源设置始终创建“__id”属性的设置
GetHiLoSequenceName(IReadOnlyModel)	返回要用于默认 hi-lo 序列的名称。
GetHiLoSequenceSchema(IReadOnlyModel)	返回要用于默认 hi-lo 序列的架构。 UseHiLo(PropertyBuilder, String, String)
GetIdentityIncrement(IReadOnlyModel)	返回默认标识增量。
GetIdentitySeed(IReadOnlyModel)	返回默认标识种子。
GetMaxIdentifierLength(IReadOnlyModel)	返回存储标识符允许的最大长度。
GetPerformanceLevelSql(IReadOnlyModel)	返回数据库的性能级别。
GetSequenceNameSuffix(IReadOnlyModel)	返回要追加到自动创建序列的名称的后缀。
GetSequences(IMutableModel)	返回模型中包含的所有序列。
GetSequences(IReadOnlyModel)	返回模型中包含的所有序列。
GetSequenceSchema(IReadOnlyModel)	返回要用于默认值生成序列的架构。 UseSequence(PropertyBuilder, String, String)
GetServiceTierSql(IReadOnlyModel)	返回数据库的服务层。
GetThroughput(IReadOnlyModel)	返回数据库范围内的预配吞吐量。
GetValueGenerationStrategy(IReadOnlyModel)	返回 SqlServerValueGenerationStrategy 要用于模型中键的属性，除非属性具有显式设置的策略。
RemoveDbFunction(IMutableModel, MethodInfo)	删除映射到由给定 MethodInfo表示的方法的函数。
RemoveDbFunction(IMutableModel, String)	删除映射到由给定 MethodInfo表示的方法的函数。
RemoveSequence(IMutableModel, String, String)	删除 IMutableSequence 具有给定名称的
SetCollation(IMutableModel, String)	设置数据库排序规则。
SetDatabaseMaxSize(IMutableModel, String)	设置数据库的最大大小。
SetDefaultContainer(IMutableModel, String)	设置默认容器名称。
SetDefaultFullTextSearchLanguage(IMutableModel, String)	设置数据库范围内全文搜索的默认语言。
SetDefaultSchema(IMutableModel, String)	设置默认架构。
SetDiscriminatorInKey(IMutableModel, Nullable<IdDiscriminatorMode>)	在 JSON“id”中包含实体类型鉴别器。
SetHasShadowIds(IMutableModel, Nullable<Boolean>)	强制模型生成始终创建映射到 JSON“id”的“__id”阴影属性。 这是 EF Core 9.0 之前的默认行为。
SetHiLoSequenceName(IMutableModel, String)	设置要用于默认 hi-lo 序列的名称。
SetHiLoSequenceSchema(IMutableModel, String)	设置要用于默认 hi-lo 序列的架构。
SetIdentityIncrement(IMutableModel, Nullable<Int32>)	设置默认标识增量。
SetIdentitySeed(IMutableModel, Nullable<Int64>)	设置默认标识种子。
SetMaxIdentifierLength(IMutableModel, Nullable<Int32>)	设置存储标识符允许的最大长度。
SetPerformanceLevelSql(IMutableModel, String)	设置数据库的性能级别。
SetSequenceNameSuffix(IMutableModel, String)	设置要追加到自动创建的序列名称的后缀。
SetSequenceSchema(IMutableModel, String)	设置要用于默认键值生成序列的架构。
SetServiceTierSql(IMutableModel, String)	设置数据库的服务层。
SetThroughput(IMutableModel, Nullable<Int32>, Nullable<Boolean>)	设置数据库范围内的预配吞吐量。
SetValueGenerationStrategy(IMutableModel, Nullable<SqlServerValueGenerationStrategy>)	设置 SqlServerValueGenerationStrategy 用于模型中未显式设置策略的键的属性。
UseNamedDefaultConstraints(IMutableModel, Boolean)	设置一个值，该值指示是否应使用命名的默认约束。