PropertyBuilder<TProperty> 类

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata.Builders

程序集:

Microsoft.EntityFrameworkCore.dll

包:

Microsoft.EntityFrameworkCore v8.0.0

提供用于配置 的 IMutableProperty简单 API。

public class PropertyBuilder<TProperty> : Microsoft.EntityFrameworkCore.Metadata.Builders.PropertyBuilder

type PropertyBuilder<'Property> = class
    inherit PropertyBuilder

Public Class PropertyBuilder(Of TProperty)
Inherits PropertyBuilder

类型参数

TProperty

继承

Object

PropertyBuilder

PropertyBuilder<TProperty>

注解

此类的实例在使用 API 时从方法返回， ModelBuilder 并且它不是设计为在应用程序代码中直接构造的。

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

构造函数

PropertyBuilder<TProperty>(IMutableProperty)

这是一个支持 Entity Framework Core 基础结构的内部 API，不受与公共 API 相同的兼容性标准的约束。 可能会在任何版本中更改或删除它，恕不另行通知。 应仅在代码中直接使用它，并且非常谨慎，并且知道在更新到新的 Entity Framework Core 版本时，这样做可能会导致应用程序失败。

属性

Metadata

正在配置的属性。 (继承自 PropertyBuilder)

方法

HasAnnotation(String, Object)	在 属性上添加或更新批注。 如果具有 中指定的 annotation 键的批注已存在，则其值将更新。
HasConversion(Type)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion(Type, Type)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion(Type, Type, Type)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion(Type, ValueComparer)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion(Type, ValueComparer, ValueComparer)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion(ValueConverter)	配置 属性，以便使用给定 ValueConverter的 将属性值与数据库进行转换和转换。
HasConversion(ValueConverter, ValueComparer)	配置 属性，以便使用给定 ValueConverter的 将属性值与数据库进行转换和转换。
HasConversion(ValueConverter, ValueComparer, ValueComparer)	配置 属性，以便使用给定 ValueConverter的 将属性值与数据库进行转换和转换。
HasConversion<TConversion,TComparer,TProviderComparer>()	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion<TConversion,TComparer>()	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion<TConversion>()	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion<TConversion>(ValueComparer)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion<TConversion>(ValueComparer, ValueComparer)	配置 属性，以便在写入数据库之前转换属性值，并在从数据库读取数据时转换回来。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>)	配置 属性，以便使用给定的转换表达式将属性值与数据库进行转换和转换。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>, ValueComparer)	配置 属性，以便使用给定的转换表达式将属性值与数据库进行转换和转换。
HasConversion<TProvider>(Expression<Func<TProperty,TProvider>>, Expression<Func<TProvider,TProperty>>, ValueComparer, ValueComparer)	配置 属性，以便使用给定的转换表达式将属性值与数据库进行转换和转换。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>)	配置 属性，以便使用给定 ValueConverter<TModel,TProvider>的 将属性值与数据库进行转换和转换。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>, ValueComparer)	配置 属性，以便使用给定 ValueConverter<TModel,TProvider>的 将属性值与数据库进行转换和转换。
HasConversion<TProvider>(ValueConverter<TProperty,TProvider>, ValueComparer, ValueComparer)	配置 属性，以便使用给定 ValueConverter<TModel,TProvider>的 将属性值与数据库进行转换和转换。
HasField(String)	设置要用于此属性的后备字段。
HasMaxLength(Int32)	配置可以存储在此属性中的数据的最大长度。 只能对数组属性设置最大长度 (包括 String 属性) 。
HasPrecision(Int32)	配置属性的精度。
HasPrecision(Int32, Int32)	配置属性的精度和小数位数。
HasSentinel(Object)	配置值，该值将用于确定是否已设置属性。 如果属性设置为 sentinel 值，则被视为未设置。 默认情况下，sentinel 值是属性类型的 CLR 默认值。
HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>)	配置用于创建 ValueGenerator 的工厂，以用于为此属性生成值。 (继承自 PropertyBuilder)
HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>)	配置用于创建 ValueGenerator 的工厂，以用于为此属性生成值。
HasValueGenerator(Type)	ValueGenerator配置将为此属性生成值的 。
HasValueGenerator<TGenerator>()	ValueGenerator配置将为此属性生成值的 。
HasValueGeneratorFactory(Type)	ValueGeneratorFactory配置 用于创建 ValueGenerator ，以用于为此属性生成值。
HasValueGeneratorFactory<TFactory>()	ValueGeneratorFactory配置 用于创建 ValueGenerator ，以用于为此属性生成值。
IsConcurrencyToken(Boolean)	配置此属性是否应用作并发令牌。 将属性配置为并发令牌时，将在期间 SaveChanges() 更新或删除此实体类型的实例时检查数据库中的值，以确保自从数据库中检索实例以来，该实例未发生更改。 如果已更改，将引发异常，并且更改不会应用于数据库。
IsRequired(Boolean)	配置此属性是否必须分配值，或者 null 是否为有效值。 仅当属性基于可分配 null的 CLR 类型时，才能将其配置为非必需属性。
IsRowVersion()	将 属性配置为 ValueGeneratedOnAddOrUpdate() 和 IsConcurrencyToken(Boolean)。
IsUnicode(Boolean)	将 属性配置为能够持久保存 unicode 字符。 只能在属性上 String 设置。
UsePropertyAccessMode(PropertyAccessMode)	PropertyAccessMode设置要用于此属性的 。
UsePropertyAccessMode(PropertyAccessMode)	PropertyAccessMode设置要用于此属性的 。 默认情况下，在构造新对象时（通常是从数据库查询实体时），将使用后备字段（如果按约定找到或已指定）。 属性用于所有其他访问。 调用此方法会更改此属性的行为，如枚举中所述 PropertyAccessMode 。 调用此方法将覆盖此属性上在实体类型或模型上设置的任何访问模式。 (继承自 PropertyBuilder)
ValueGeneratedNever()	将属性配置为在保存此实体类型的实例时永远不会生成值。
ValueGeneratedOnAdd()	将属性配置为仅在保存新实体时生成值，除非已设置非 null 的非临时值，在这种情况下，将改为保存设置的值。 该值可能由客户端值生成器生成，也可以由数据库生成，作为保存实体的一部分。
ValueGeneratedOnAddOrUpdate()	将属性配置为在保存新实体或现有实体时生成值。
ValueGeneratedOnUpdate()	将属性配置为在保存现有实体时生成值。
ValueGeneratedOnUpdateSometimes()	将属性配置为在保存现有实体时在特定条件下生成值。

显式接口实现

IInfrastructure<IConventionPropertyBuilder>.Instance

用于配置属性的内部生成器。 (继承自 PropertyBuilder)

扩展方法

IsETagConcurrency(PropertyBuilder)	将此属性配置为 etag 并发令牌。
IsETagConcurrency<TProperty>(PropertyBuilder<TProperty>)	将此属性配置为 etag 并发令牌。
ToJsonProperty(PropertyBuilder, String)	配置属性在面向 Azure Cosmos 时映射到的属性名称。
ToJsonProperty<TProperty>(PropertyBuilder<TProperty>, String)	配置属性在面向 Azure Cosmos 时映射到的属性名称。
HasColumnName(PropertyBuilder, String)	配置属性在面向关系数据库时映射到的列。
HasColumnName<TProperty>(PropertyBuilder<TProperty>, String)	配置属性在面向关系数据库时映射到的列。
HasColumnOrder(PropertyBuilder, Nullable<Int32>)	配置属性映射到的列的顺序。
HasColumnOrder<TProperty>(PropertyBuilder<TProperty>, Nullable<Int32>)	配置属性映射到的列的顺序。
HasColumnType(PropertyBuilder, String)	配置属性在面向关系数据库时映射到的列的数据类型。 这应该是完整的类型名称，包括精度、小数位数、长度等。
HasColumnType<TProperty>(PropertyBuilder<TProperty>, String)	配置属性在面向关系数据库时映射到的列的数据类型。 这应该是完整的类型名称，包括精度、小数位数、长度等。
HasComment(PropertyBuilder, String)	配置要应用于列的注释
HasComment<TProperty>(PropertyBuilder<TProperty>, String)	配置要应用于列的注释
HasComputedColumnSql(PropertyBuilder)	将 属性配置为在面向关系数据库时映射到计算列。
HasComputedColumnSql(PropertyBuilder, String)	将 属性配置为在面向关系数据库时映射到计算列。
HasComputedColumnSql(PropertyBuilder, String, Nullable<Boolean>)	将 属性配置为在面向关系数据库时映射到计算列。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>)	将 属性配置为在面向关系数据库时映射到计算列。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>, String)	将 属性配置为在面向关系数据库时映射到计算列。
HasComputedColumnSql<TProperty>(PropertyBuilder<TProperty>, String, Nullable<Boolean>)	将 属性配置为在面向关系数据库时映射到计算列。
HasDefaultValue(PropertyBuilder)	配置属性在面向关系数据库时映射到的列的默认值。
HasDefaultValue(PropertyBuilder, Object)	配置属性在面向关系数据库时映射到的列的默认值。
HasDefaultValue<TProperty>(PropertyBuilder<TProperty>)	配置属性在面向关系数据库时映射到的列的默认值。
HasDefaultValue<TProperty>(PropertyBuilder<TProperty>, Object)	配置属性在面向关系数据库时映射到的列的默认值。
HasDefaultValueSql(PropertyBuilder)	配置属性在面向关系数据库时映射到的列的默认值表达式。
HasDefaultValueSql(PropertyBuilder, String)	配置属性在面向关系数据库时映射到的列的默认值表达式。
HasDefaultValueSql<TProperty>(PropertyBuilder<TProperty>)	配置属性在面向关系数据库时映射到的列的默认值表达式。
HasDefaultValueSql<TProperty>(PropertyBuilder<TProperty>, String)	配置属性在面向关系数据库时映射到的列的默认值表达式。
HasJsonPropertyName(PropertyBuilder, String)	配置映射到 JSON 列的实体的属性，将实体属性映射到特定的 JSON 属性，而不是使用实体属性名称。
HasJsonPropertyName<TProperty>(PropertyBuilder<TProperty>, String)	配置映射到 JSON 列的实体的属性，将实体属性映射到特定的 JSON 属性，而不是使用实体属性名称。
IsFixedLength(PropertyBuilder, Boolean)	将 属性配置为能够仅存储固定长度的数据，例如字符串。
IsFixedLength<TProperty>(PropertyBuilder<TProperty>, Boolean)	将 属性配置为能够仅存储固定长度的数据，例如字符串。
UseCollation(PropertyBuilder, String)	将 属性配置为使用给定的排序规则。 将使用给定的排序规则创建数据库列，并将在所有区分排序规则的操作中隐式使用它。
UseCollation<TProperty>(PropertyBuilder<TProperty>, String)	将 属性配置为使用给定的排序规则。 将使用给定的排序规则创建数据库列，并将在所有区分排序规则的操作中隐式使用它。
HasSrid(PropertyBuilder, Int32)	配置属性在面向 SQLite 时映射到的列的 SRID。
HasSrid<TProperty>(PropertyBuilder<TProperty>, Int32)	配置属性在面向 SQLite 时映射到的列的 SRID。
IsSparse(PropertyBuilder, Boolean)	配置在以 SQL Server 为目标时是否将属性的列创建为稀疏列。
IsSparse<TProperty>(PropertyBuilder<TProperty>, Boolean)	配置在以 SQL Server 为目标时是否将属性的列创建为稀疏列。
UseHiLo(PropertyBuilder, String, String)	将 key 属性配置为在面向SQL Server时使用基于序列的 hi-lo 模式为新实体生成值。 此方法将 属性设置为 OnAdd。
UseHiLo<TProperty>(PropertyBuilder<TProperty>, String, String)	将 key 属性配置为在面向SQL Server时使用基于序列的 hi-lo 模式为新实体生成值。 此方法将 属性设置为 OnAdd。
UseIdentityColumn(PropertyBuilder, Int32, Int32)	将 key 属性配置为在面向SQL Server时使用 SQL Server IDENTITY 功能为新实体生成值。 此方法将 属性设置为 OnAdd。
UseIdentityColumn(PropertyBuilder, Int64, Int32)	将 key 属性配置为在面向SQL Server时使用 SQL Server IDENTITY 功能为新实体生成值。 此方法将 属性设置为 OnAdd。
UseIdentityColumn<TProperty>(PropertyBuilder<TProperty>, Int32, Int32)	将 key 属性配置为在面向SQL Server时使用 SQL Server IDENTITY 功能为新实体生成值。 此方法将 属性设置为 OnAdd。
UseIdentityColumn<TProperty>(PropertyBuilder<TProperty>, Int64, Int32)	将 key 属性配置为在面向SQL Server时使用 SQL Server IDENTITY 功能为新实体生成值。 此方法将 属性设置为 OnAdd。
UseSequence(PropertyBuilder, String, String)	将 key 属性配置为在面向SQL Server时使用基于序列的键值生成模式为新实体生成值。 此方法将 属性设置为 OnAdd。
UseSequence<TProperty>(PropertyBuilder<TProperty>, String, String)	将 key 属性配置为在面向SQL Server时使用基于序列的键值生成模式为新实体生成值。 此方法将 属性设置为 OnAdd。