IReadOnlyEntityType 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

表示模型中的实体类型。

public interface IReadOnlyEntityType : Microsoft.EntityFrameworkCore.Metadata.IReadOnlyTypeBase

type IReadOnlyEntityType = interface
    interface IReadOnlyTypeBase
    interface IReadOnlyAnnotatable

Public Interface IReadOnlyEntityType
Implements IReadOnlyTypeBase

派生

Microsoft.EntityFrameworkCore.Metadata.IConventionEntityType

Microsoft.EntityFrameworkCore.Metadata.IEntityType

Microsoft.EntityFrameworkCore.Metadata.IMutableEntityType

Microsoft.EntityFrameworkCore.Metadata.RuntimeEntityType

实现

IReadOnlyAnnotatable IReadOnlyTypeBase

注解

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

属性

BaseType	获取此实体类型的基类型。 null如果这不是继承层次结构中的派生类型，则返回 。
ClrType	获取用于表示此类型的实例的 CLR 类。 null如果该类型没有相应的 CLR 类 (称为阴影类型) ，则返回 。 (继承自 IReadOnlyTypeBase)
ContainingEntityType	获取此实体类型或声明复杂属性链的实体类型。 (继承自 IReadOnlyTypeBase)
HasSharedClrType	获取一个值，该值指示此结构类型是否映射到 Type 其他结构类型也映射到的 。 (继承自 IReadOnlyTypeBase)
IsPropertyBag	获取一个值，该值指示此结构类型是否具有能够包含任意属性的索引器和可用于确定给定索引器属性是否包含值的方法。 (继承自 IReadOnlyTypeBase)
Item[String]	获取具有给定名称的批注的值，如果不存在，则返回 null 该值。 (继承自 IReadOnlyAnnotatable)
Model	获取此类型所属的模型。 (继承自 IReadOnlyTypeBase)
Name	获取此类型的名称。 (继承自 IReadOnlyTypeBase)

方法

AnnotationsToDebugString(Int32)	获取对象上声明的所有注释的调试字符串。 (继承自 IReadOnlyAnnotatable)
DisplayName()	获取此结构类型的友好显示名称。 (继承自 IReadOnlyTypeBase)
DisplayName(Boolean)	获取给定 IReadOnlyTypeBase的友好显示名称。 (继承自 IReadOnlyTypeBase)
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则返回 null 。 (继承自 IReadOnlyAnnotatable)
FindClosestCommonParent(IReadOnlyEntityType)	返回作为两个给定实体类型的父级的最近实体类型。 如果其中一个给定实体是另一个实体的父实体，则返回该父实体。 null如果两个实体类型不在同一层次结构中，则返回 。
FindComplexProperty(MemberInfo)	获取具有给定成员信息的复杂属性。 null如果未找到任何属性，则返回 。 (继承自 IReadOnlyTypeBase)
FindComplexProperty(String)	获取具有给定名称的复杂属性。 null如果未定义具有给定名称的属性，则返回 。 (继承自 IReadOnlyTypeBase)
FindDeclaredComplexProperty(String)	查找在具有给定名称的类型上声明的属性。 不返回在基类型上定义的属性。 (继承自 IReadOnlyTypeBase)
FindDeclaredForeignKeys(IReadOnlyList<IReadOnlyProperty>)	使用给定属性获取在此实体类型上声明的外键。
FindDeclaredNavigation(String)	获取给定实体类型上的导航属性。 不返回在基类型上定义的导航属性。 null如果未找到导航属性，则返回 。
FindDeclaredSkipNavigation(String)	获取此实体类型上的 skip 导航属性。
FindDeclaredTrigger(String)	查找具有给定名称的触发器。
FindDiscriminatorProperty()	返回将用于存储鉴别器值的属性。
FindForeignKey(IReadOnlyList<IReadOnlyProperty>, IReadOnlyKey, IReadOnlyEntityType)	获取指向给定主键或备用键的给定属性的外键。 null如果未找到外键，则返回 。
FindForeignKey(IReadOnlyProperty, IReadOnlyKey, IReadOnlyEntityType)	获取指向给定主键或备用键的给定属性的外键。 null如果未找到外键，则返回 。
FindForeignKeys(IReadOnlyList<IReadOnlyProperty>)	获取在给定属性上定义的外键。 仅返回在指定属性集上定义的外键。
FindForeignKeys(IReadOnlyProperty)	获取在给定属性上定义的外键。 仅返回在指定属性上定义的外键。 不会返回包含指定属性的复合外键。
FindIndex(IReadOnlyList<IReadOnlyProperty>)	获取在给定属性上定义的未命名索引。 null如果未定义此类索引，则返回 。
FindIndex(IReadOnlyProperty)	获取在给定属性上定义的未命名索引。 null如果未定义此类索引，则返回 。
FindIndex(String)	获取具有给定名称的索引。 null如果不存在此类索引，则返回 。
FindIndexerPropertyInfo()	PropertyInfo返回关联 CLR 类型的索引器的 （如果存在）。 (继承自 IReadOnlyTypeBase)
FindKey(IReadOnlyList<IReadOnlyProperty>)	获取在给定属性上定义的主键或备用键。 null如果未为给定属性定义键，则返回 。
FindKey(IReadOnlyProperty)	获取在给定属性上定义的主键或备用键。 null如果未为给定属性定义任何键，则返回 。
FindMember(String)	获取具有给定名称的成员。 null如果未定义具有给定名称的成员，则返回 。 (继承自 IReadOnlyTypeBase)
FindMembersInHierarchy(String)	获取此类型、基类型或派生类型上具有给定名称的成员。 (继承自 IReadOnlyTypeBase)
FindNavigation(MemberInfo)	获取给定实体类型上的导航属性。 null如果未找到导航属性，则返回 。
FindNavigation(String)	获取给定实体类型上的导航属性。 null如果未找到导航属性，则返回 。
FindOwnership()	如果这是拥有的类型，则返回所有者的关系，否则 null 返回给所有者。
FindPrimaryKey()	获取此实体类型的主键。 null如果未定义主键，则返回 。
FindServiceProperty(String)	获取具有给定名称的服务属性。 null如果未定义具有给定名称的属性，则返回 。
FindSkipNavigation(MemberInfo)	获取此实体类型上的 skip 导航属性。 null如果未找到导航属性，则返回 。
FindSkipNavigation(String)	获取此实体类型上的 skip 导航属性。 null如果未找到跳过导航属性，则返回 。
GetAllBaseTypes()	从根开始，获取从中派生此实体类型的所有类型。
GetAllBaseTypesAscending()	获取从此实体类型派生的模型中的所有类型，从最近的类型开始。
GetAllBaseTypesInclusive()	从上到下返回此实体类型的所有基类型，包括类型本身。
GetAllBaseTypesInclusiveAscending()	从下到上返回此实体类型的所有基类型，包括类型本身。
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 IReadOnlyAnnotatable)
GetAnnotations()	获取当前对象上的所有批注。 (继承自 IReadOnlyAnnotatable)
GetComplexProperties()	获取在此类型和基类型上定义的复杂属性。 (继承自 IReadOnlyTypeBase)
GetConcreteDerivedTypesInclusive()	返回此实体类型的所有派生类型，包括类型本身，它们不是 abstract。
GetDeclaredComplexProperties()	获取在此类型上声明的复杂属性。 (继承自 IReadOnlyTypeBase)
GetDeclaredForeignKeys()	获取在此实体类型上声明的所有外键。
GetDeclaredIndexes()	获取在此实体类型上声明的所有索引。
GetDeclaredKeys()	获取在此实体类型上声明的所有键。
GetDeclaredMembers()	获取在此类型上声明的成员。 (继承自 IReadOnlyTypeBase)
GetDeclaredNavigations()	获取在此实体类型上声明的所有导航属性。
GetDeclaredReferencingForeignKeys()	获取面向给定实体类型的所有外键 (即，其中给定实体类型是主体) 的外键。
GetDeclaredServiceProperties()	获取在此实体类型上声明的所有服务属性。
GetDeclaredSkipNavigations()	获取在此实体类型上声明的所有跳过导航属性。
GetDeclaredTriggers()	返回实体类型上声明的触发器。
GetDefaultDiscriminatorValue()	返回将用于此实体类型的默认鉴别器值。
GetDerivedComplexProperties()	获取对派生自此类型的类型声明的复杂属性。 (继承自 IReadOnlyTypeBase)
GetDerivedForeignKeys()	获取对派生自此实体类型的类型声明的所有外键。
GetDerivedIndexes()	获取针对派生自此实体类型的类型声明的所有索引。
GetDerivedNavigations()	获取对派生自此实体类型的类型声明的所有导航属性。
GetDerivedServiceProperties()	获取针对派生自此实体类型的类型声明的所有服务属性。
GetDerivedSkipNavigations()	获取对派生自此实体类型的类型声明的所有跳过导航属性。
GetDerivedTypes()	获取模型中派生自此实体类型的所有类型。
GetDerivedTypesInclusive()	返回此实体类型的所有派生类型，包括类型本身。
GetDirectlyDerivedTypes()	获取模型中直接派生自此实体类型的所有类型。
GetDiscriminatorPropertyName()	返回将用于存储鉴别器值的属性的名称。
GetDiscriminatorValue()	返回此实体类型的鉴别器值。
GetForeignKeys()	获取在此实体类型上定义的外键。
GetIndexes()	获取在此实体类型上定义的索引。
GetIsDiscriminatorMappingComplete()	返回值，该值指示此实体类型的鉴别器映射是否完整。
GetKeys()	获取此实体类型的主键和备用键。
GetMembers()	获取在此类型和基类型上定义的成员。 (继承自 IReadOnlyTypeBase)
GetNavigationAccessMode()	PropertyAccessMode获取用于此实体类型的导航的 。
GetNavigations()	获取给定实体类型上的所有导航属性。
GetOrCreateEmptyMaterializer(IEntityMaterializerSource)	这是一个支持 Entity Framework Core 基础结构的内部 API，不受与公共 API 相同的兼容性标准的约束。 可能会在任何版本中更改或删除它，而无需通知。 仅应在代码中非常谨慎地直接使用它，并且知道在更新到新的 Entity Framework Core 版本时这样做可能会导致应用程序失败。
GetOrCreateMaterializer(IEntityMaterializerSource)	这是一个支持 Entity Framework Core 基础结构的内部 API，不受与公共 API 相同的兼容性标准的约束。 可能会在任何版本中更改或删除它，而无需通知。 仅应在代码中非常谨慎地直接使用它，并且知道在更新到新的 Entity Framework Core 版本时这样做可能会导致应用程序失败。
GetPropertyAccessMode()	PropertyAccessMode获取用于此类型的属性和导航的 。 (继承自 IReadOnlyTypeBase)
GetQueryFilter()	获取 LINQ 表达式筛选器自动应用于此实体类型的查询。
GetReferencingForeignKeys()	获取面向给定实体类型的所有外键 (即，其中给定实体类型或基类型是主体) 的外键。
GetRootType()	获取给定实体类型的根基类型。
GetSeedData(Boolean)	获取存储在模型中的给定实体类型的数据。
GetServiceProperties()	获取此实体类型上定义的所有 IReadOnlyServiceProperty 。
GetSkipNavigations()	获取此实体类型上的跳过导航属性。
HasServiceProperties()	检查此实体类型是否有任何 IServiceProperty 定义。
IsAbstract()	获取一个值，该值指示此结构类型是否表示抽象类型。 (继承自 IReadOnlyTypeBase)
IsAssignableFrom(IReadOnlyEntityType)	确定此实体类型是派生自 (，还是与给定实体类型) 相同。
IsAssignableFrom(IReadOnlyTypeBase)	确定此类型是派生自 (还是与给定类型) 相同。 (继承自 IReadOnlyTypeBase)
IsInOwnershipPath(IReadOnlyEntityType)	获取一个值，该值指示给定的实体类型是否在此实体类型的所有权路径中。
IsOwned()	获取一个值，该值指示此实体类型是否由另一个实体类型拥有。
IsStrictlyDerivedFrom(IReadOnlyTypeBase)	确定此类型是否派生自 (但与给定类型) 不同。 (继承自 IReadOnlyTypeBase)
LeastDerivedType(IReadOnlyEntityType)	获取指定两个值之间的最小派生类型。
ShortName()	获取给定的 IReadOnlyTypeBase 短名称，该名称可用于其他标识符。 (继承自 IReadOnlyTypeBase)
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，可能会在发布之间任意更改。

显式接口实现

IReadOnlyTypeBase.IsAssignableFrom(IReadOnlyTypeBase)

确定此类型是派生自 (还是与给定类型) 相同。

扩展方法

GetAnalyticalStoreTimeToLive(IReadOnlyEntityType)	返回容器范围内分析存储的生存时间（以秒为单位）。
GetContainer(IReadOnlyEntityType)	返回实体类型映射到的容器的名称。
GetContainingPropertyName(IReadOnlyEntityType)	返回实体类型映射到的父属性的名称。
GetDefaultTimeToLive(IReadOnlyEntityType)	返回容器范围的默认生存时间（以秒为单位）。
GetETagProperty(IReadOnlyEntityType)	获取此实体上映射到 Cosmos ETag（如果存在）的属性。
GetETagPropertyName(IReadOnlyEntityType)	返回用于存储 ETag 的属性的名称。
GetPartitionKeyProperty(IReadOnlyEntityType)	返回用于存储分区键的属性。
GetPartitionKeyPropertyName(IReadOnlyEntityType)	返回用于存储分区键的属性的名称。
GetThroughput(IReadOnlyEntityType)	返回容器范围内预配的吞吐量。
GetInMemoryQuery(IReadOnlyEntityType)	获取用作此类型查询的默认源的 LINQ 查询。
FindCheckConstraint(IReadOnlyEntityType, String)	查找 IReadOnlyCheckConstraint 具有给定名称的 。
FindMappingFragment(IReadOnlyEntityType, StoreObjectIdentifier)	返回特定类似表的存储对象的实体类型映射。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
FindRowInternalForeignKeys(IReadOnlyEntityType, StoreObjectIdentifier)	获取给定实体类型的外键，这些外键指向共享同一表类似存储对象的其他实体类型。
GetCheckConstraints(IReadOnlyEntityType)	返回实体类型中包含的所有检查约束。
GetComment(IReadOnlyEntityType)	返回此实体映射到的表的注释。
GetContainerColumnName(IReadOnlyEntityType)	获取实体类型映射到的容器列名称。
GetContainerColumnTypeMapping(IReadOnlyEntityType)	已过时。. 获取实体类型映射到的容器列类型映射。
GetDeclaredCheckConstraints(IReadOnlyEntityType)	返回对实体类型声明的所有检查约束。
GetDefaultSchema(IReadOnlyEntityType)	返回将用于此实体类型的默认数据库架构。
GetDefaultSqlQueryName(IReadOnlyEntityType)	获取使用 映射 RelationalEntityTypeBuilderExtensions.ToSqlQuery时将用于此实体类型的默认 SQL 查询名称。
GetDefaultTableName(IReadOnlyEntityType, Boolean)	返回将用于此实体类型的默认表名称。
GetDefaultViewName(IReadOnlyEntityType)	返回将用于此实体类型的默认视图名称。
GetDefaultViewSchema(IReadOnlyEntityType)	返回将用于此实体视图的默认数据库架构。
GetDeleteStoredProcedure(IReadOnlyEntityType)	返回实体类型映射到以删除或 null 未映射到存储过程的存储过程。
GetFunctionName(IReadOnlyEntityType)	返回实体类型映射到 null 的函数的名称，如果未映射到函数，则返回该函数的名称。
GetInsertStoredProcedure(IReadOnlyEntityType)	返回实体类型映射到的存储过程（如果未映射到存储过程），以便插入或 null 。
GetJsonPropertyName(IReadOnlyEntityType)	获取用于映射到 JSON 列的给定实体的 JSON 属性值。
GetMappingFragments(IReadOnlyEntityType)	返回所有配置的实体类型映射片段。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetMappingFragments(IReadOnlyEntityType, StoreObjectType)	返回给定类型的所有已配置的实体类型映射片段。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetMappingStrategy(IReadOnlyEntityType)	获取派生类型的映射策略。
GetSchema(IReadOnlyEntityType)	返回包含映射表的数据库架构。
GetSchemaQualifiedTableName(IReadOnlyEntityType)	返回实体类型映射到的表的名称（如果未映射到表），则由架构 null 前面附加。
GetSchemaQualifiedViewName(IReadOnlyEntityType)	返回实体类型映射到的视图的名称（如果未映射到视图），则由架构 null 前面附加。
GetSqlQuery(IReadOnlyEntityType)	返回用于为实体类型提供数据的 SQL 字符串，如果未 null 映射到 SQL 字符串，则返回 。
GetTableName(IReadOnlyEntityType)	返回实体类型映射到的表的名称，如果未 null 映射到表，则返回该表的名称。
GetUpdateStoredProcedure(IReadOnlyEntityType)	返回实体类型为更新映射到的存储过程，如果未 null 映射到存储过程，则返回该存储过程。
GetViewName(IReadOnlyEntityType)	返回实体类型映射到的视图的名称，如果未 null 映射到视图，则返回该视图的名称。
GetViewSchema(IReadOnlyEntityType)	返回包含映射视图的数据库架构。
IsMappedToJson(IReadOnlyEntityType)	获取一个值，该值指示指定的实体是否映射到 JSON 列。
IsTableExcludedFromMigrations(IReadOnlyEntityType)	获取一个值，该值指示迁移是否忽略关联的表。
IsTableExcludedFromMigrations(IReadOnlyEntityType, StoreObjectIdentifier)	获取一个值，该值指示迁移是否忽略指定的表。
FindMappingFragment(IReadOnlyTypeBase, StoreObjectIdentifier)	返回特定类似表的存储对象的类型映射。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetContainerColumnName(IReadOnlyTypeBase)	获取类型映射到的容器列名称。
GetDeleteStoredProcedure(IReadOnlyTypeBase)	返回类型映射到的存储过程，以便删除; null 如果未映射到存储过程，则返回该存储过程。
GetFunctionName(IReadOnlyTypeBase)	返回类型映射到 null 的函数的名称，如果未映射到函数，则返回 。
GetInsertStoredProcedure(IReadOnlyTypeBase)	返回类型为插入 null 映射到的存储过程，如果未映射到存储过程，则返回该存储过程。
GetJsonPropertyName(IReadOnlyTypeBase)	获取用于映射到 JSON 列的给定实体的 JSON 属性值。
GetMappingFragments(IReadOnlyTypeBase)	返回所有配置的类型映射片段。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetMappingFragments(IReadOnlyTypeBase, StoreObjectType)	返回给定类型的所有已配置类型映射片段。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不用于应用程序代码。
GetMappingStrategy(IReadOnlyTypeBase)	获取派生类型的映射策略。
GetSchema(IReadOnlyTypeBase)	返回包含映射表的数据库架构。
GetSqlQuery(IReadOnlyTypeBase)	返回用于为类型提供数据的 SQL 字符串， null 如果未映射到 SQL 字符串，则返回 。
GetTableName(IReadOnlyTypeBase)	返回类型映射到的表的名称，如果未 null 映射到表，则返回该名称。
GetUpdateStoredProcedure(IReadOnlyTypeBase)	返回类型为更新 null 映射到的存储过程，如果未映射到存储过程，则返回该存储过程。
GetViewName(IReadOnlyTypeBase)	返回类型映射到 null 的视图的名称，如果未映射到视图，则返回该视图的名称。
GetViewSchema(IReadOnlyTypeBase)	返回包含映射视图的数据库架构。
IsMappedToJson(IReadOnlyTypeBase)	获取一个值，该值指示指定的实体是否映射到 JSON 列。
GetDbSetName(IReadOnlyEntityType)	获取应用于 DbSet<TEntity> 此实体类型的 类上的 DbContext 属性的名称。
IsSqlReturningClauseUsed(IReadOnlyEntityType)	返回一个值，该值指示在对表保存更改时是否使用 SQL RETURNING 子句。 RETURNING 子句与某些 Sqlite 功能不兼容，例如虚拟表或具有 AFTER 触发器的表。
IsSqlReturningClauseUsed(IReadOnlyEntityType, StoreObjectIdentifier)	返回一个值，该值指示在对表保存更改时是否使用 SQL RETURNING 子句。 RETURNING 子句与某些 Sqlite 功能不兼容，例如虚拟表或具有 AFTER 触发器的表。
GetHistoryTableName(IReadOnlyEntityType)	返回一个值，该值表示与映射到临时表的实体关联的历史记录表的名称。
GetHistoryTableSchema(IReadOnlyEntityType)	返回一个值，该值表示与映射到临时表的实体关联的历史记录表的架构。
GetPeriodEndPropertyName(IReadOnlyEntityType)	返回一个值，该值表示映射到临时表的实体的句点结束属性的名称。
GetPeriodStartPropertyName(IReadOnlyEntityType)	返回一个值，该值表示映射到临时表的实体的句点开始属性的名称。
IsMemoryOptimized(IReadOnlyEntityType)	返回一个值，该值指示实体类型是否映射到内存优化表。
IsSqlOutputClauseUsed(IReadOnlyEntityType)	返回一个值，该值指示在保存对表所做的更改时是否使用 SQL OUTPUT 子句。 OUTPUT 子句与某些SQL Server功能不兼容，例如具有触发器的表。
IsSqlOutputClauseUsed(IReadOnlyEntityType, StoreObjectIdentifier)	返回一个值，该值指示在保存对指定表所做的更改时是否使用 SQL OUTPUT 子句。 OUTPUT 子句与某些SQL Server功能不兼容，例如具有触发器的表。
IsTemporal(IReadOnlyEntityType)	返回一个值，该值指示实体类型是否映射到临时表。