IProperty 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

表示结构类型的标量属性。

public interface IProperty : Microsoft.EntityFrameworkCore.Metadata.IPropertyBase, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyProperty

type IProperty = interface
    interface IReadOnlyProperty
    interface IReadOnlyPropertyBase
    interface IReadOnlyAnnotatable
    interface IPropertyBase
    interface IAnnotatable

Public Interface IProperty
Implements IPropertyBase, IReadOnlyProperty

派生

Microsoft.EntityFrameworkCore.Metadata.RuntimeProperty

实现

IAnnotatable IPropertyBase IReadOnlyAnnotatable IReadOnlyProperty IReadOnlyPropertyBase

注解

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

属性

DeclaringEntityType	已过时。. 获取此属性所属的实体类型。
DeclaringType	获取类似于此属性的对象所属的类型。 (继承自 IReadOnlyPropertyBase)
FieldInfo	获取 FieldInfo 此属性类似对象的基础 CLR 字段的 。 这可能 null 适用于阴影属性，或者如果支持字段未知，则为 。 (继承自 IReadOnlyPropertyBase)
IsPrimitiveCollection	如果属性具有与 CLR 类型的元素类型匹配的元素类型，则属性是基元集合。 (继承自 IReadOnlyProperty)
Item[String]	获取具有给定名称的批注的值，如果不存在，则返回 null 。 (继承自 IReadOnlyAnnotatable)
Name	获取类似于此属性的对象的名称。 (继承自 IReadOnlyPropertyBase)
PropertyInfo	获取 PropertyInfo 类似于此属性的对象的基础 CLR 属性的 。 这可能 null 适用于阴影属性，或者如果直接映射到字段，则为 。 (继承自 IReadOnlyPropertyBase)
Sentinel	获取指示未设置此属性的 sentinel 值。 (继承自 IReadOnlyPropertyBase)

方法

AddRuntimeAnnotation(String, Object)	向此对象添加运行时批注。 如果已存在具有指定名称的批注，则引发 。 (继承自 IAnnotatable)
AnnotationsToDebugString(Int32)	获取对象上声明的所有注释的调试字符串。 (继承自 IReadOnlyAnnotatable)
CreateKeyEqualityComparer<TProperty>()	IEqualityComparer<T>为给定属性类型的值创建 。
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则返回 null 。 (继承自 IReadOnlyAnnotatable)
FindContainingPrimaryKey()	获取使用此属性的主键 (包括一个复合主键，其中此属性包含在) 。
FindFirstPrincipal()	如果给定属性是外键的一部分，则查找给定属性受约束的第一个主体属性。
FindRuntimeAnnotation(String)	获取具有给定名称的运行时注释，如果不存在，则返回 null 。 (继承自 IAnnotatable)
FindRuntimeAnnotationValue(String)	获取具有给定名称的运行时注释的值，如果不存在，则返回 null 。 (继承自 IAnnotatable)
FindTypeMapping()	返回此属性的类型映射。 (继承自 IReadOnlyProperty)
GetAfterSaveBehavior()	获取一个值，该值指示在实体保存到数据库后是否可以修改此属性。 (继承自 IReadOnlyProperty)
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 IReadOnlyAnnotatable)
GetAnnotations()	获取当前 对象上的所有注释。 (继承自 IReadOnlyAnnotatable)
GetBeforeSaveBehavior()	获取一个值，该值指示在实体保存到数据库之前是否可以修改此属性。 (继承自 IReadOnlyProperty)
GetContainingForeignKeys()	获取使用此属性的所有外键 (包括) 包含此属性的复合外键。
GetContainingIndexes()	获取使用此属性的所有索引 (包括包含此属性的复合索引) 。
GetContainingKeys()	获取使用此属性的所有主键或备用键 (包括此属性包含在) 的组合键。
GetCurrentValueComparer()	IComparer<T>获取用于比较跟踪IUpdateEntry条目中的值的 。 (继承自 IPropertyBase)
GetElementType()	获取由此属性表示的基元集合的元素的配置。
GetFieldName()	获取此属性的后备字段的名称;如果支持字段未知， null 则为 。 (继承自 IReadOnlyPropertyBase)
GetGetter()	获取 IClrPropertyGetter 用于读取此属性的值的 。 (继承自 IPropertyBase)
GetIndex()	获取此属性的属性索引。 (继承自 IPropertyBase)
GetJsonValueReaderWriter()	JsonValueReaderWriter获取此属性的 ;如果未设置此属性，null则获取 。 (继承自 IReadOnlyProperty)
GetKeyValueComparer()	获取 ValueComparer 要与此属性的键一起使用的 。
GetMaxLength()	获取此属性中允许的最大数据长度。 例如，如果 属性为 ， String 则这是最大字符数。 (继承自 IReadOnlyProperty)
GetMemberInfo(Boolean, Boolean)	PropertyInfo获取应用于获取或设置给定属性的值的 或 FieldInfo 。 (继承自 IPropertyBase)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	获取具有给定名称的运行时注释的值，如果不存在，则添加该值。 (继承自 IAnnotatable)
GetPrecision()	获取此属性中允许的数据的精度。 例如，如果 属性为 ， Decimal 则这是最大位数。 (继承自 IReadOnlyProperty)
GetPrincipals()	如果给定属性是外键的一部分，则查找主体属性的列表，包括给定属性受其约束的给定属性。
GetPrincipals<T>()	如果给定属性是外键的一部分，则查找主体属性的列表，包括给定属性受其约束的给定属性。 (继承自 IReadOnlyProperty)
GetPropertyAccessMode()	获取 PropertyAccessMode 用于此属性类似对象的 。 (继承自 IReadOnlyPropertyBase)
GetProviderClrType()	获取属性值在发送到数据库提供程序之前将转换为的类型。 (继承自 IReadOnlyProperty)
GetProviderValueComparer()	获取 ValueComparer 要用于此属性的提供程序值的 。
GetRuntimeAnnotations()	获取当前 对象上的所有运行时注释。 (继承自 IAnnotatable)
GetScale()	获取此属性中允许的数据小数位数。 例如，如果 属性为 ， Decimal 则这是小数位数的最大位数。 (继承自 IReadOnlyProperty)
GetTypeMapping()	从 CoreTypeMapping 最终的模型中返回给定属性的 。 (继承自 IReadOnlyProperty)
GetValueComparer()	ValueComparer获取此属性的 。
GetValueConverter()	获取此属性的自定义 ValueConverter 集。 (继承自 IReadOnlyProperty)
GetValueGeneratorFactory()	获取已设置为为此属性生成值的工厂（如果有）。 (继承自 IReadOnlyProperty)
IsForeignKey()	获取一个值，该值指示此属性是用作外键 (还是复合外键) 的一部分。 (继承自 IReadOnlyProperty)
IsIndex()	获取一个值，该值指示此属性是用作索引 (还是用作组合索引) 的一部分。 (继承自 IReadOnlyProperty)
IsIndexerProperty()	获取一个值，该值指示这是否为索引器属性。 索引器属性是通过实体类上的索引器访问的属性。 (继承自 IReadOnlyPropertyBase)
IsKey()	获取一个值，该值指示此属性是用作主键或备用键 (还是复合主键或备用键) 的一部分。 (继承自 IReadOnlyProperty)
IsPrimaryKey()	获取一个值，该值指示此属性是用作主键 (还是用作复合主键) 的一部分。 (继承自 IReadOnlyProperty)
IsUnicode()	获取一个值，该值指示属性是否可以保留 Unicode 字符。 (继承自 IReadOnlyProperty)
IsUniqueIndex()	获取一个值，该值指示此属性是用作唯一索引 (还是用作唯一组合索引) 的一部分。 (继承自 IReadOnlyProperty)
RemoveRuntimeAnnotation(String)	从此 对象中删除给定的运行时批注。 (继承自 IAnnotatable)
SetRuntimeAnnotation(String, Object)	设置存储在给定键下的运行时注释。 如果具有指定名称的批注已存在，则覆盖现有批注。 (继承自 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，并且可能会在版本之间任意更改。 (继承自 IReadOnlyProperty)

扩展方法

GetJsonPropertyName(IReadOnlyProperty)	返回以 Cosmos 为目标时属性映射到的属性名称。
FindColumn(IProperty, StoreObjectIdentifier)	如果此属性映射到给定的类似表的存储对象，则返回与此属性对应的列。
FindOverrides(IProperty, StoreObjectIdentifier)	返回特定类似表的存储对象的属性方面重写。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
FindOverrides(IReadOnlyProperty, StoreObjectIdentifier)	返回特定类似表的存储对象的属性方面重写。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
FindRelationalTypeMapping(IReadOnlyProperty)	返回 RelationalTypeMapping 最终模型上给定属性的 。
FindRelationalTypeMapping(IReadOnlyProperty, StoreObjectIdentifier)	返回 RelationalTypeMapping 最终模型上给定属性的 。
FindSharedStoreObjectRootProperty(IProperty, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一列的第 IProperty 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
FindSharedStoreObjectRootProperty(IReadOnlyProperty, StoreObjectIdentifier)	查找映射到类似共享表的 对象中的同一列的第 IProperty 一个 。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
GetCollation(IReadOnlyProperty)	返回要用于列的排序规则。
GetCollation(IReadOnlyProperty, StoreObjectIdentifier)	返回要用于列的排序规则。
GetColumnBaseName(IReadOnlyProperty)	已过时。. 返回属性将映射到的列的基名称。
GetColumnName(IReadOnlyProperty)	返回属性将映射到的列的名称。
GetColumnName(IReadOnlyProperty, StoreObjectIdentifier)	返回特定表的属性映射到的列的名称。
GetColumnOrder(IReadOnlyProperty)	返回此属性映射到的列的顺序。
GetColumnOrder(IReadOnlyProperty, StoreObjectIdentifier)	返回此属性针对特定表映射到的列的顺序。
GetColumnType(IProperty)	返回属性映射到的列的数据库类型。
GetColumnType(IProperty, StoreObjectIdentifier)	返回属性映射到的列的数据库类型。
GetColumnType(IReadOnlyProperty)	如果找不到数据库类型， null 则返回属性映射到的列的数据库类型。
GetColumnType(IReadOnlyProperty, StoreObjectIdentifier)	如果找不到数据库类型， null 则返回属性映射到的列的数据库类型。
GetComment(IReadOnlyProperty)	返回此属性映射到的列的注释。
GetComment(IReadOnlyProperty, StoreObjectIdentifier)	返回此属性映射到的列的注释。
GetComputedColumnSql(IReadOnlyProperty)	返回用作此属性映射到的列的计算值的 SQL 表达式。
GetComputedColumnSql(IReadOnlyProperty, StoreObjectIdentifier)	返回用作此属性映射到的列的计算值的 SQL 表达式。
GetDefaultColumnBaseName(IReadOnlyProperty)	已过时。. 返回属性将映射到的列的默认基名称
GetDefaultColumnMappings(IProperty)	返回属性将映射到的默认列。
GetDefaultColumnName(IReadOnlyProperty)	返回属性将映射到的列的默认基名称
GetDefaultColumnName(IReadOnlyProperty, StoreObjectIdentifier)	返回属性将映射到的默认列名。
GetDefaultValue(IReadOnlyProperty)	返回对象，该对象用作此属性映射到的列的默认值。
GetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier)	返回对象，该对象用作此属性映射到的列的默认值。
GetDefaultValueSql(IReadOnlyProperty)	返回用作此属性映射到的列的默认值的 SQL 表达式。
GetDefaultValueSql(IReadOnlyProperty, StoreObjectIdentifier)	返回用作此属性映射到的列的默认值的 SQL 表达式。
GetDeleteStoredProcedureParameterMappings(IProperty)	返回属性映射到的删除存储过程参数。
GetFunctionColumnMappings(IProperty)	返回属性映射到的函数列。
GetInsertStoredProcedureParameterMappings(IProperty)	返回属性映射到的插入存储过程参数。
GetInsertStoredProcedureResultColumnMappings(IProperty)	返回属性映射到的插入存储过程结果列。
GetIsStored(IReadOnlyProperty)	获取此属性映射到的计算列的值是存储在数据库中，还是在读取时计算。
GetIsStored(IReadOnlyProperty, StoreObjectIdentifier)	获取此属性映射到的计算列的值是存储在数据库中，还是在读取时计算。
GetJsonPropertyName(IReadOnlyProperty)	获取用于映射到 JSON 列的实体的给定属性的 JSON 属性值。
GetMappedStoreObjects(IReadOnlyProperty, StoreObjectType)	返回此属性映射到的类似表的存储对象。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
GetMaxLength(IReadOnlyProperty, StoreObjectIdentifier)	获取此属性中允许的最大数据长度。 例如，如果 属性为 ， String 则这是最大字符数。
GetOverrides(IProperty)	返回所有属性方面重写。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
GetOverrides(IReadOnlyProperty)	返回所有属性方面重写。 此方法通常由数据库提供程序 (和其他扩展) 使用。 它通常不在应用程序代码中使用。
GetPrecision(IReadOnlyProperty, StoreObjectIdentifier)	获取此属性中允许的数据的精度。 例如，如果 属性为 ， Decimal 则这是最大位数。
GetReaderFieldValue(IProperty, RelationalDataReader, Int32, Boolean)	从给定 relationalReader的 读取此属性的值。
GetRelationalTypeMapping(IReadOnlyProperty)	返回 RelationalTypeMapping 最终模型上给定属性的 。
GetScale(IReadOnlyProperty, StoreObjectIdentifier)	获取此属性中允许的数据小数位数。 例如，如果 属性为 ， Decimal 则这是小数位数的最大位数。
GetSqlQueryColumnMappings(IProperty)	返回属性映射到的 SQL 查询列。
GetTableColumnMappings(IProperty)	返回属性映射到的表列。
GetUpdateStoredProcedureParameterMappings(IProperty)	返回属性映射到的更新存储过程参数。
GetUpdateStoredProcedureResultColumnMappings(IProperty)	返回属性映射到的更新存储过程结果列。
GetViewColumnMappings(IProperty)	返回属性映射到的视图列。
IsColumnNullable(IReadOnlyProperty)	检查在数据库中创建时，映射到给定 IProperty 的列是否可为 null。
IsColumnNullable(IReadOnlyProperty, StoreObjectIdentifier)	检查映射到给定属性的列在数据库中创建时是否可为 null。
IsFixedLength(IReadOnlyProperty)	返回一个标志，该标志指示属性是否能够仅存储固定长度的数据，如字符串。
IsFixedLength(IReadOnlyProperty, StoreObjectIdentifier)	返回一个标志，该标志指示属性是否能够仅存储固定长度的数据，如字符串。
IsUnicode(IReadOnlyProperty, StoreObjectIdentifier)	获取一个值，该值指示属性是否可以保留 Unicode 字符。
TryGetDefaultValue(IReadOnlyProperty, StoreObjectIdentifier, Object)	返回对象，该对象用作此属性映射到的列的默认值。
TryGetDefaultValue(IReadOnlyProperty, Object)	返回对象，该对象用作此属性映射到的列的默认值。
GetDataAnnotations(IProperty, IAnnotationCodeGenerator)	获取用于配置属性的数据注释。
GetFluentApiCalls(IProperty, IAnnotationCodeGenerator)	获取用于配置属性的 Fluent API 调用。
GetSrid(IReadOnlyProperty)	返回为此属性创建列时要使用的 SRID。
GetSrid(IReadOnlyProperty, StoreObjectIdentifier)	返回为此属性创建列时要使用的 SRID。
FindHiLoSequence(IProperty)	ISequence在模型中查找要用于 hi-lo 模式的 。
FindHiLoSequence(IProperty, StoreObjectIdentifier)	ISequence在模型中查找要用于 hi-lo 模式的 。
FindHiLoSequence(IReadOnlyProperty)	ISequence在模型中查找要用于 hi-lo 模式的 。
FindHiLoSequence(IReadOnlyProperty, StoreObjectIdentifier)	ISequence在模型中查找要用于 hi-lo 模式的 。
FindSequence(IProperty)	ISequence在模型中查找要用于键值生成模式的 。
FindSequence(IProperty, StoreObjectIdentifier)	ISequence在模型中查找要用于键值生成模式的 。
FindSequence(IReadOnlyProperty)	ISequence在模型中查找要用于键值生成模式的 。
FindSequence(IReadOnlyProperty, StoreObjectIdentifier)	ISequence在模型中查找要用于键值生成模式的 。
GetHiLoSequenceName(IReadOnlyProperty)	返回要用于 hi-lo 序列的名称。
GetHiLoSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	返回要用于 hi-lo 序列的名称。
GetHiLoSequenceSchema(IReadOnlyProperty)	返回用于 hi-lo 序列的架构。
GetHiLoSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	返回用于 hi-lo 序列的架构。
GetIdentityIncrement(IReadOnlyProperty)	返回标识增量。
GetIdentityIncrement(IReadOnlyProperty, StoreObjectIdentifier)	返回标识增量。
GetIdentitySeed(IReadOnlyProperty)	返回标识种子。
GetIdentitySeed(IReadOnlyProperty, StoreObjectIdentifier)	返回标识种子。
GetSequenceName(IReadOnlyProperty)	返回要用于键值生成序列的名称。
GetSequenceName(IReadOnlyProperty, StoreObjectIdentifier)	返回要用于键值生成序列的名称。
GetSequenceSchema(IReadOnlyProperty)	返回用于键值生成序列的架构。
GetSequenceSchema(IReadOnlyProperty, StoreObjectIdentifier)	返回用于键值生成序列的架构。
GetValueGenerationStrategy(IReadOnlyProperty)	返回 SqlServerValueGenerationStrategy 要用于 属性的 。
GetValueGenerationStrategy(IReadOnlyProperty, StoreObjectIdentifier)	返回 SqlServerValueGenerationStrategy 要用于 属性的 。
IsSparse(IReadOnlyProperty)	返回一个值，该值指示属性的列是否稀疏。
IsSparse(IReadOnlyProperty, StoreObjectIdentifier)	返回一个值，该值指示属性的列是否稀疏。