語言

IConventionPropertyBuilder 介面

定義

提供一個簡單的 API 表面來設定 IConventionProperty from 慣例。

此介面通常由資料庫提供者(及其他擴充)使用。 它通常不被用於應用程式程式碼中。

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
實作

備註

更多資訊與範例請參閱 模型建構慣例 。

屬性

名稱 Description
Metadata

取得正在設定的屬性。

ModelBuilder

會得到模型製作者。

(繼承來源 IConventionAnnotatableBuilder)

方法

名稱 Description
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)

回傳一個值,表示哨兵是否能從目前組態來源設定此屬性。

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)

設定將用來判斷屬性是否已設定的值。 如果屬性設定為哨兵值,則視為未設定。 預設情況下,哨兵值是該屬性類型的 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() 更多資訊與範例。

擴充方法

名稱 Description
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 Server HIDDEN 旗標來設定。

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)
已淘汰.

設定屬性映射到的欄位 SRID,當針對 SQLite 時。

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)

設定屬性映射到的欄位 SRID,當針對 SQLite 時。

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 Server HIDDEN 標誌定義,該欄位將排除在結果之外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)

配置屬性以使用給定的排序。 資料庫欄位將以該排序建立,並隱含用於所有敏感排序操作。

適用於