语言

IConventionPropertyBuilder 接口

定义

提供用于配置约定的 IConventionProperty 简单 API 图面。

此接口通常由数据库提供程序(和其他扩展)使用。 它通常不用于应用程序代码。

public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder
public interface IConventionPropertyBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBaseBuilder
type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder<IConventionPropertyBuilder>
    interface IConventionAnnotatableBuilder
type IConventionPropertyBuilder = interface
    interface IConventionAnnotatableBuilder
type IConventionPropertyBuilder = interface
    interface IConventionPropertyBaseBuilder
    interface IConventionAnnotatableBuilder
Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder(Of IConventionPropertyBuilder)
Public Interface IConventionPropertyBuilder
Implements IConventionAnnotatableBuilder
Public Interface IConventionPropertyBuilder
Implements IConventionPropertyBaseBuilder
实现

注解

有关详细信息和示例,请参阅 模型生成约定 。

属性

名称 说明
Metadata

获取正在配置的属性。

ModelBuilder

获取模型生成器。

(继承自 IConventionAnnotatableBuilder)

方法

名称 说明
AfterSave(Nullable<PropertySaveBehavior>, Boolean)

配置将实体保存到数据库后是否可以修改此属性。

BeforeSave(Nullable<PropertySaveBehavior>, Boolean)

配置在实体保存到数据库之前是否可以修改此属性。

CanRemoveAnnotation(String, Boolean)

返回一个值,该值指示是否可以使用此配置源删除具有给定名称的批注。

(继承自 IConventionAnnotatableBuilder)
CanSetAfterSave(Nullable<PropertySaveBehavior>, Boolean)

返回一个值,该值指示在将实体保存到数据库后是否可以从当前配置源为此属性配置该属性。

CanSetAnnotation(String, Object, Boolean)

返回一个值,该值指示是否可以从此配置源设置具有给定名称和值的批注。

(继承自 IConventionAnnotatableBuilder)
CanSetBeforeSave(Nullable<PropertySaveBehavior>, Boolean)

返回一个值,该值指示在将实体保存到数据库之前是否能够针对当前配置源的此属性配置该属性。

CanSetConversion(Type, Boolean)

返回一个值,该值指示是否可以为当前配置源中的此属性配置要转换值的给定类型。

CanSetConversion(ValueConverter, Boolean)

返回一个值,该值指示是否可以 ValueConverter 从当前配置源为此属性配置此属性。

CanSetConverter(Type, Boolean)

返回一个值,该值指示是否可以 ValueConverter 从当前配置源为此属性配置此属性。

CanSetElementType(Type, Boolean)

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

CanSetField(FieldInfo, Boolean)

返回一个值,该值指示是否可以为当前配置源中的此属性设置支持字段。

CanSetField(String, Boolean)

返回一个值,该值指示是否可以为当前配置源中的此属性设置支持字段。

CanSetIsAutoLoaded(Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以将属性配置为从当前配置源自动加载。

CanSetIsConcurrencyToken(Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以将属性配置为当前配置源中的并发令牌。

CanSetIsRequired(Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以从当前配置源配置此属性必需。

CanSetIsUnicode(Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以将属性配置为能够保留当前配置源中的 unicode 字符。

CanSetKeyValueComparer(ValueComparer, Boolean)
已过时.

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetMaxLength(Nullable<Int32>, Boolean)

返回一个值,该值指示是否可从当前配置源为此属性设置允许的最大数据长度。

CanSetPrecision(Nullable<Int32>, Boolean)

返回一个值,该值指示是否可从当前配置源为此属性设置允许的数据的精度。

CanSetPropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

返回一个值,该值指示是否可以 PropertyAccessMode 从当前配置源为此属性设置此属性。

CanSetProviderValueComparer(Type, Boolean)

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetProviderValueComparer(ValueComparer, Boolean)

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetScale(Nullable<Int32>, Boolean)

返回一个值,该值指示是否可从当前配置源为此属性设置允许的数据规模。

CanSetSentinel(Object, Boolean)

返回一个值,该值指示是否可以为当前配置源中的此属性设置 sentinel。

CanSetStructuralValueComparer(ValueComparer, Boolean)
已过时.

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetTypeMapping(CoreTypeMapping, Boolean)

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 CoreTypeMapping 值。

CanSetValueComparer(Type, Boolean)

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetValueComparer(ValueComparer, Boolean)

返回一个值,该值指示是否可以从当前配置源为此属性配置给定 ValueComparer 值。

CanSetValueGenerated(Nullable<ValueGenerated>, Boolean)

返回一个值,该值指示是否可以从当前配置源配置属性值生成。

CanSetValueGenerator(Func<IProperty,IEntityType,ValueGenerator>, Boolean)

返回一个值,该值指示是否可以 ValueGenerator 从当前配置源为此属性配置此属性。

CanSetValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)

返回一个值,该值指示是否可以 ValueGenerator 从当前配置源为此属性配置此属性。

CanSetValueGeneratorFactory(Type, Boolean)

返回一个值,该值指示是否可以 ValueGeneratorFactory 从当前配置源为此属性配置此属性。

HasAnnotation(String, Object, Boolean)

设置存储在给定名称下的批注。 如果具有指定名称的批注已存在且相同或更低 ConfigurationSource,则覆盖现有批注。

(继承自 IConventionPropertyBaseBuilder<TBuilder>)
HasConversion(Type, Boolean)

配置属性,以便在写入数据库之前将属性值转换为给定类型,并在从数据库读取时转换回。

HasConversion(ValueConverter, Boolean)

配置属性,以便使用给定 ValueConverter的属性值转换到数据库和从数据库转换。

HasConverter(Type, Boolean)

配置属性,以便使用给定 ValueConverter的属性值转换到数据库和从数据库转换。

HasField(FieldInfo, Boolean)

设置要用于此属性的后盾字段。

HasField(String, Boolean)

设置要用于此属性的后盾字段。

HasKeyValueComparer(ValueComparer, Boolean)
已过时.

配置 ValueComparer 要用于此属性的关键比较。

HasMaxLength(Nullable<Int32>, Boolean)

配置可存储在此属性中的数据的最大长度。

HasNoAnnotation(String, Boolean)

从此对象中删除具有给定名称的批注。

(继承自 IConventionPropertyBaseBuilder<TBuilder>)
HasNonNullAnnotation(String, Object, Boolean)

设置存储在给定名称下的批注。 如果具有指定名称的批注已存在且相同或更低 ConfigurationSource,则覆盖现有批注。 如果 null 指定了值,则删除批注。

(继承自 IConventionPropertyBaseBuilder<TBuilder>)
HasPrecision(Nullable<Int32>, Boolean)

配置属性的精度。

HasProviderValueComparer(Type, Boolean)

配置 ValueComparer 要用于此属性的提供程序值。

HasProviderValueComparer(ValueComparer, Boolean)

配置 ValueComparer 要用于此属性的提供程序值。

HasScale(Nullable<Int32>, Boolean)

配置属性的规模。

HasSentinel(Object, Boolean)

配置将用于确定属性是否已设置的值。 如果属性设置为 sentinel 值,则被视为未设置。 默认情况下,sentinel 值是属性类型的 CLR 默认值。

HasStructuralValueComparer(ValueComparer, Boolean)
已过时.

配置 ValueComparer 要用于此属性的结构比较。

HasTypeMapping(CoreTypeMapping, Boolean)

配置 CoreTypeMapping 此属性。

HasValueComparer(Type, Boolean)

配置 ValueComparer 此属性。

HasValueComparer(ValueComparer, Boolean)

配置 ValueComparer 此属性。

HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>, Boolean)

配置 ValueGenerator 将生成此属性的值。

HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>, Boolean)

配置 ValueGenerator 将生成此属性的值。

HasValueGenerator(Type, Boolean)

配置 ValueGenerator 将生成此属性的值。

HasValueGeneratorFactory(Type, Boolean)

配置 ValueGeneratorFactory 用于创建 ValueGenerator 将生成此属性值的值。

IsAutoLoaded(Nullable<Boolean>, Boolean)

配置从数据库查询实体时是否自动加载此属性。

IsConcurrencyToken(Nullable<Boolean>, Boolean)

配置此属性是否应用作并发令牌。 当属性配置为并发令牌时,在更新或删除此实体类型的实例时 SaveChanges() ,将检查数据库中的值,以确保该实例从数据库中检索到该实例后未更改。 如果已更改,将引发异常,并且不会将更改应用于数据库。

IsRequired(Nullable<Boolean>, Boolean)

配置此属性是必须分配值还是 null 有效值。 仅当属性基于可分配 null的 CLR 类型时,才能将其配置为非必需属性。

IsUnicode(Nullable<Boolean>, Boolean)

配置属性是否能够持久保存 unicode 字符。

RemoveAnnotation(String, Boolean)
已过时.

从此对象中删除具有给定名称的批注。

(继承自 IConventionAnnotatableBuilder)
SetElementType(Type, Boolean)

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

SetOrRemoveAnnotation(String, Object, Boolean)
已过时.

设置或删除存储在给定名称下的批注。

(继承自 IConventionAnnotatableBuilder)
UsePropertyAccessMode(Nullable<PropertyAccessMode>, Boolean)

PropertyAccessMode设置要用于此属性的项。

ValueGenerated(Nullable<ValueGenerated>, Boolean)

设置一个值,该值指示数据库将生成此属性的值。 即使属性设置为由数据库生成,EF 在添加实体并分配值时仍可能尝试保存特定值(而不是由数据库生成一个值),或者该属性被标记为已修改现有实体。 有关详细信息和示例,请参阅 GetBeforeSaveBehavior() 和 GetAfterSaveBehavior() 示例。

扩展方法

名称 说明
CanSetCollation(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以将给定值设置为排序规则。

CanSetColumnName(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以为属性设置给定列。

CanSetColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)

返回一个值,该值指示是否可以为该属性设置特定类似表的存储对象的给定列。

CanSetColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

获取一个值,该值指示是否可以为属性设置给定的列顺序。

CanSetColumnType(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以为属性设置给定数据类型。

CanSetComment(IConventionPropertyBuilder, Object, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的注释。

CanSetComment(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的注释。

CanSetComputedColumnSql(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以为列设置给定的计算值 SQL 表达式。

CanSetDefaultValue(IConventionPropertyBuilder, Object, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的默认值。

CanSetDefaultValue(IConventionPropertyBuilder, Object, String, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的默认值。

CanSetDefaultValueSql(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以为列设置给定的默认值表达式。

CanSetDefaultValueSql(IConventionPropertyBuilder, String, String, Boolean)

返回一个值,该值指示是否可以为列设置给定的默认值表达式。

CanSetEnableFullTextSearch(IConventionPropertyBuilder, String, Boolean, Boolean)

返回一个值,该值指示是否可以使用指定语言为此属性启用全文搜索。

CanSetGeometricDimension(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的维度。

CanSetHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)

返回一个值,该值指示是否可以为 hi-lo 序列设置给定名称和架构。

CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

返回一个值,该值指示是否可以将给定值设置为SQL Server IDENTITY 的增量。

CanSetIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)

返回一个值,该值指示是否可以将给定值设置为特定表的 SQL Server IDENTITY 的增量。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

返回一个值,该值指示是否可以将给定值设置为 SQL Server IDENTITY 的种子。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)

返回一个值,该值指示是否可以将给定值设置为 SQL Server IDENTITY 的种子。

CanSetIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)

返回一个值,该值指示是否可以将给定值设置为特定表的 SQL Server IDENTITY 的种子。

CanSetIsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以将属性配置为固定长度。

CanSetIsHidden(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以使用SQL ServerHIDDEN标志配置属性的列。

CanSetIsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

返回一个值,该值指示在定位SQL Server时是否可以将属性的列配置为稀疏。

CanSetIsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

返回一个值,该值指示是否可以为该列设置给定的计算列类型。

CanSetIsVector(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)

返回一个值,该值指示是否可以设置向量类型。

CanSetIsVectorProperty(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)

返回一个值,该值指示是否可以设置矢量距离函数和维度。

CanSetJsonProperty(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示是否可以设置给定的属性名称。

CanSetJsonPropertyName(IConventionPropertyBuilder, String, Boolean)

返回一个值,该值指示给定值是否可以用作给定实体属性的 JSON 属性名称。

CanSetSequence(IConventionPropertyBuilder, String, String, Boolean)

返回一个值,该值指示是否可以为键值生成序列设置给定名称和架构。

CanSetSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

返回一个值,该值指示是否可以将给定值设置为列的 SRID。

CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqliteValueGenerationStrategy>, Boolean)

返回一个值,该值指示是否可以为属性设置给定的值生成策略。

CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)

返回一个值,该值指示是否可以将给定值设置为值生成策略。

CanSetValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)

返回一个值,该值指示是否可以将给定值设置为特定表的值生成策略。

EnableFullTextSearch(IConventionPropertyBuilder, String, Boolean, Boolean)

使用指定语言启用对此属性的全文搜索。

ForSqliteHasDimension(IConventionPropertyBuilder, String, Boolean)
已过时.

配置属性在面向 SQLite 时映射到的列的维度。

ForSqliteHasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
已过时.

配置属性在面向 SQLite 时映射到的列的 SRID。

ForSqlServerHasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)
已过时.

配置用于 hi-lo 模式的数据库序列,以便在针对SQL Server时为键属性生成值。

ForSqlServerHasIdentityIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
已过时.

为 SQL Server IDENTITY 配置增量。

ForSqlServerHasIdentitySeed(IConventionPropertyBuilder, Nullable<Int32>, Boolean)
已过时.

为 SQL Server IDENTITY 配置种子。

ForSqlServerHasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)
已过时.

针对SQL Server时,配置键属性的值生成策略。

HasColumnName(IConventionPropertyBuilder, String, Boolean)

配置属性在定位关系数据库时映射到的列。

HasColumnName(IConventionPropertyBuilder, String, StoreObjectIdentifier, Boolean)

配置属性映射到特定表类似存储对象的列。

HasColumnOrder(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

配置属性映射到的列的顺序。

HasColumnType(IConventionPropertyBuilder, String, Boolean)

配置属性在定位关系数据库时映射到的列的数据类型。 这应该是完整的类型名称,包括精度、刻度、长度等。

HasComment(IConventionPropertyBuilder, String, Boolean)

配置要应用于列的注释

HasComputedColumnSql(IConventionPropertyBuilder, String, Boolean)

将属性配置为在面向关系数据库时映射到计算列。

HasDefaultValue(IConventionPropertyBuilder, Object, Boolean)

配置属性在定位关系数据库时映射到的列的默认值。

HasDefaultValue(IConventionPropertyBuilder, Object, String, Boolean)

配置属性在定位SQL Server时映射到的列的默认值。

HasDefaultValueSql(IConventionPropertyBuilder, String, Boolean)

配置属性在面向关系数据库时映射到的列的默认值表达式。

HasDefaultValueSql(IConventionPropertyBuilder, String, String, Boolean)

配置属性在定位SQL Server时映射到的列的默认值表达式。

HasGeometricDimension(IConventionPropertyBuilder, String, Boolean)

配置属性在面向 SQLite 时映射到的列的维度。

HasHiLoSequence(IConventionPropertyBuilder, String, String, Boolean)

配置用于 hi-lo 模式的数据库序列,以便在针对SQL Server时为键属性生成值。

HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

为 SQL Server IDENTITY 配置增量。

HasIdentityColumnIncrement(IConventionPropertyBuilder, Nullable<Int32>, StoreObjectIdentifier, Boolean)

为特定表配置SQL Server IDENTITY 的增量。

HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

为 SQL Server IDENTITY 配置种子。

HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, Boolean)

为 SQL Server IDENTITY 配置种子。

HasIdentityColumnSeed(IConventionPropertyBuilder, Nullable<Int64>, StoreObjectIdentifier, Boolean)

为特定表配置 SQL Server IDENTITY 的种子。

HasJsonPropertyName(IConventionPropertyBuilder, String, Boolean)

配置映射到 JSON 列的实体的属性,将实体属性映射到特定的 JSON 属性,而不是使用实体属性名称。

HasSequence(IConventionPropertyBuilder, String, String, Boolean)

配置用于键值生成模式的数据库序列,以便在针对SQL Server时为键属性生成值。

HasSrid(IConventionPropertyBuilder, Nullable<Int32>, Boolean)

配置属性在面向 SQLite 时映射到的列的 SRID。

HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqliteValueGenerationStrategy>, Boolean)

针对 SQLite 配置属性的值生成策略。

HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, Boolean)

针对SQL Server时,配置键属性的值生成策略。

HasValueGenerationStrategy(IConventionPropertyBuilder, Nullable<SqlServerValueGenerationStrategy>, StoreObjectIdentifier, Boolean)

针对特定表的SQL Server时,为键属性配置值生成策略。

IsFixedLength(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

将属性配置为仅存储固定长度的数据,例如字符串。

IsHidden(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

配置属性的列是否使用SQL ServerHIDDEN标志定义,这会从结果中SELECT *排除该列。 这适用于生成的列,例如临时表句点列。

IsSparse(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

配置在以SQL Server为目标时是否将属性的列创建为稀疏。

IsStoredComputedColumn(IConventionPropertyBuilder, Nullable<Boolean>, Boolean)

将属性配置为在面向关系数据库时映射到给定类型的计算列。

IsVector(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)

将属性配置为Azure Cosmos DB的向量。

IsVectorProperty(IConventionPropertyBuilder, DistanceFunction, Int32, Boolean)

将属性配置为Azure Cosmos DB的向量。

ToJsonProperty(IConventionPropertyBuilder, String, Boolean)

配置属性在目标Azure Cosmos 时映射到的属性名称。 如果提供了空字符串,则不会保留该属性。

UseCollation(IConventionPropertyBuilder, String, Boolean)

将属性配置为使用给定的排序规则。 数据库列将使用给定的排序规则创建,并且将在所有区分排序规则的操作中隐式使用。

适用于