IConventionModel 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

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

[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	这是一个支持 Entity Framework Core 基础结构的内部 API，不受与公共 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设置 要用于模型中未显式设置策略的键属性的 。