語言

PropertyBuilder 類別

定義

提供一個簡單的 API 來設定 IMutableProperty.

public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.IMutableModel>, Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder>
[System.Runtime.CompilerServices.Nullable(0)]
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder>
public class PropertyBuilder : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionPropertyBuilder>
type PropertyBuilder = class
    interface IInfrastructure<IMutableModel>
    interface IInfrastructure<InternalPropertyBuilder>
[<System.Runtime.CompilerServices.Nullable(0)>]
type PropertyBuilder = class
    interface IInfrastructure<IConventionPropertyBuilder>
type PropertyBuilder = class
    interface IInfrastructure<InternalPropertyBuilder>
type PropertyBuilder = class
    interface IInfrastructure<IConventionPropertyBuilder>
Public Class PropertyBuilder
Implements IInfrastructure(Of IMutableModel), IInfrastructure(Of InternalPropertyBuilder)
Public Class PropertyBuilder
Implements IInfrastructure(Of IConventionPropertyBuilder)
Public Class PropertyBuilder
Implements IInfrastructure(Of InternalPropertyBuilder)
繼承
PropertyBuilder
衍生
屬性
實作
IInfrastructure<IMutableModel> IInfrastructure<Microsoft.EntityFrameworkCore.Metadata.Internal.InternalPropertyBuilder> IInfrastructure<IConventionPropertyBuilder>

備註

這個類別的實例會在使用 ModelBuilder API 時從方法回傳,且並非設計成直接在應用程式程式碼中建構。

更多資訊與範例請參閱 建模實體類型與關係 。

建構函式

名稱 Description
PropertyBuilder(IMutableProperty)

這是一個內部 API,支援 Entity Framework Core 基礎架構,且不受公開 API 相同的相容性標準約束。 該內容可能會在任何新聞稿中未經通知而更改或移除。 你應該只在程式碼中直接使用它,並且要非常謹慎,並且要知道這樣做可能會導致更新到新的 Entity Framework Core 版本時應用程式失敗。

PropertyBuilder(InternalPropertyBuilder)

此 API 支援 Entity Framework Core 基礎架構,並非設計用來直接從您的程式碼中使用。 此 API 可能會在未來版本中變更或移除。

屬性

名稱 Description
Metadata

正在設定的屬性。

方法

名稱 Description
HasAnnotation(String, Object)

新增或更新該物業上的註解。 如果已有標註中指定的 annotation 鍵,其值會被更新。

HasConversion(Type, Type, Type)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion(Type, Type)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion(Type, ValueComparer, ValueComparer)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion(Type, ValueComparer)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion(Type)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion(ValueConverter, ValueComparer, ValueComparer)

設定屬性,使屬性值能利用給定 ValueConverter的 與資料庫 之間轉換。

HasConversion(ValueConverter, ValueComparer)

設定屬性,使屬性值能利用給定 ValueConverter的 與資料庫 之間轉換。

HasConversion(ValueConverter)

設定屬性,使屬性值能利用給定 ValueConverter的 與資料庫 之間轉換。

HasConversion<TConversion,TComparer,TProviderComparer>()

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion<TConversion,TComparer>()

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion<TConversion>()

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion<TConversion>(ValueComparer, ValueComparer)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasConversion<TConversion>(ValueComparer)

設定屬性,使得在寫入資料庫前先轉換屬性值,讀取資料庫時又會再轉換回來。

HasField(String)

設定用於此屬性的背景欄位。

HasMaxLength(Int32)

設定此屬性中可儲存的最大資料長度。 最大長度只能設定在陣列屬性(包括 String 屬性)上。

HasPrecision(Int32, Int32)

配置物業的精確度與規模。

HasPrecision(Int32)

設定屬性的精確度。

HasSentinel(Object)

設定將用來判斷屬性是否已設定的值。 如果屬性設定為哨兵值,則視為未設定。 預設情況下,哨兵值是該屬性類型的 CLR 預設值。

HasValueGenerator(Func<IProperty,IEntityType,ValueGenerator>)

設定一個工廠來建立 , ValueGenerator 用來產生該屬性的值。

HasValueGenerator(Func<IProperty,ITypeBase,ValueGenerator>)

設定一個工廠來建立 , ValueGenerator 用來產生該屬性的值。

HasValueGenerator(Type)

設定 ValueGenerator 該屬性會產生該屬性的值。

HasValueGenerator<TGenerator>()

設定 ValueGenerator 該屬性會產生該屬性的值。

HasValueGeneratorFactory(Type)

設定 以 ValueGeneratorFactory 建立 a ValueGenerator 來產生此屬性的值。

HasValueGeneratorFactory<TFactory>()

設定 以 ValueGeneratorFactory 建立 a ValueGenerator 來產生此屬性的值。

IsConcurrencyToken(Boolean)

配置此屬性是否應作為並行標記使用。 當屬性被設定為並行標記時,當該實體類型的實例在更新或刪除時 SaveChanges() ,會檢查資料庫中的值,以確保自從從資料庫檢索後該值沒有改變。 若變更,將拋出例外,且該變更不會套用到資料庫。

IsRequired(Boolean)

設定此屬性是否必須被賦予值或 null 為有效值。 只有當該屬性基於可指派 null的 CLR 類型時,才能設定為非必需。

IsRowVersion()

將屬性配置為 ValueGeneratedOnAddOrUpdate() 和 IsConcurrencyToken(Boolean)。

IsUnicode(Boolean)

設定該屬性是否能持久化 Unicode 字元。 只能設定在 String 屬性上。

UsePropertyAccessMode(PropertyAccessMode)

設定 使用 這個 PropertyAccessMode 屬性。

預設情況下,如果依慣例找到或已指定,則在建構新物件時會使用該欄位,通常是從資料庫查詢實體時。 所有其他進出通道皆使用物業。 呼叫此方法會改變該屬性的行為,如列舉中 PropertyAccessMode 所述。

呼叫此方法會覆蓋該屬性中任何在實體類型或模型上設定的存取模式。

UsePropertyAccessMode(PropertyAccessMode)

設定 使用 這個 PropertyAccessMode 屬性。

ValueGeneratedNever()

設定一個屬性,當儲存該實體類型的實例時,資料庫永遠不會產生該值。

ValueGeneratedOnAdd()

設定屬性僅在儲存新實體時產生值,除非設定了非空值、非暫時值,此時將儲存該值。 該值可能由用戶端的值產生器產生,或由資料庫作為儲存實體的一部分產生。

ValueGeneratedOnAddOrUpdate()

設定資產在儲存新舊實體時產生價值。

ValueGeneratedOnUpdate()

設定一個物業,使其在儲存現有實體時產生價值。

ValueGeneratedOnUpdateSometimes()

在保存現有實體時,設定資產在特定條件下產生價值。

明確介面實作

名稱 Description
IInfrastructure<IConventionPropertyBuilder>.Instance

內部建築商正在配置該物業。

IInfrastructure<IMutableModel>.Instance

該房產所屬的模型。

IInfrastructure<InternalPropertyBuilder>.Instance

內部建築商正在配置該物業。

擴充方法

名稱 Description
EnableFullTextSearch(PropertyBuilder, String, Boolean)

可使用指定語言對此屬性進行全文搜尋。

ForSqliteHasColumnName(PropertyBuilder, String)

設定屬性在定位 SQLite 時所對應的欄位。

ForSqliteHasColumnType(PropertyBuilder, String)

設定該屬性在針對 SQLite 時所對應的欄位資料型態。

ForSqliteHasDefaultValue(PropertyBuilder, Object)

設定屬性對應到的欄位預設值,以設定 SQLite 為目標。

ForSqliteHasDefaultValueSql(PropertyBuilder, String)

設定屬性映射到的欄位預設值表達式,當目標 SQLite 時。

ForSqliteHasDimension(PropertyBuilder, Ordinates)

在針對 SQLite 時,設定屬性所對應的欄位維度。

ForSqliteHasDimension(PropertyBuilder, Ordinates)
已淘汰.

在針對 SQLite 時,設定屬性所對應的欄位維度。

ForSqliteHasSrid(PropertyBuilder, Int32)
已淘汰.

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

ForSqlServerHasColumnName(PropertyBuilder, String)

設定屬性在針對 SQL Server 時所對應的欄位。

ForSqlServerHasColumnType(PropertyBuilder, String)

設定屬性對應至 SQL Server 時所對應的欄位資料型態。 這應該是完整的類型名稱,包括精度、比例、長度等。

ForSqlServerHasComputedColumnSql(PropertyBuilder, String)

設定屬性在針對 SQL Server 時對應到計算欄位。

ForSqlServerHasDefaultValue(PropertyBuilder, Object)

設定屬性對應欄位的預設值,以設定 SQL Server 為目標。

ForSqlServerHasDefaultValueSql(PropertyBuilder, String)

設定屬性在針對 SQL Server 時所對應的欄位預設值表達式。

ForSqlServerUseSequenceHiLo(PropertyBuilder, String, String)
已淘汰.

設定關鍵屬性,使其使用基於序列的 hi-lo 模式來產生新實體的值,以針對SQL Server。 此方法將性質設定為 OnAdd。

GetInfrastructure<T>(IInfrastructure<T>)

從一個被隱藏的屬性中取得價值 IInfrastructure<T>。

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

HasColumnName(PropertyBuilder, String)

設定屬性在指向關聯式資料庫時所對應的欄位。

HasColumnOrder(PropertyBuilder, Nullable<Int32>)

配置屬性所映射到的欄位順序。

HasColumnType(PropertyBuilder, String)

在針對關聯式資料庫時,設定屬性所對應的欄位資料型態。 這應該是完整的類型名稱,包括精度、比例、長度等。

HasComment(PropertyBuilder, String)

配置一則評論以套用於該專欄

HasComputedColumnSql(PropertyBuilder, String, Nullable<Boolean>)

設定屬性在針對關聯式資料庫時,對應到計算出的欄位。

HasComputedColumnSql(PropertyBuilder, String)

設定屬性在針對關聯式資料庫時,對應到計算出的欄位。

HasComputedColumnSql(PropertyBuilder)

設定屬性在針對關聯式資料庫時,對應到計算出的欄位。

HasDefaultValue(PropertyBuilder, Object, String)

設定屬性對應欄位的預設值,以設定 SQL Server 為目標。

HasDefaultValue(PropertyBuilder, Object)

設定屬性對應的欄位預設值,當針對關聯式資料庫時。

HasDefaultValue(PropertyBuilder)

設定屬性對應的欄位預設值,當針對關聯式資料庫時。

HasDefaultValueSql(PropertyBuilder, String, String)

設定屬性在針對 SQL Server 時所對應的欄位預設值表達式。

HasDefaultValueSql(PropertyBuilder, String)

設定屬性在針對關聯式資料庫時所映射欄位的預設值表達式。

HasDefaultValueSql(PropertyBuilder)

設定屬性在針對關聯式資料庫時所映射欄位的預設值表達式。

HasGeometricDimension(PropertyBuilder, Ordinates)

在針對 SQLite 時,設定屬性所對應的欄位維度。

HasJsonPropertyName(PropertyBuilder, String)

設定映射到 JSON 欄位的實體屬性,將實體屬性映射到特定的 JSON 屬性,而非使用實體屬性名稱。

HasSrid(PropertyBuilder, Int32)

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

IsETagConcurrency(PropertyBuilder)

將此屬性配置為 etag 並行標記。

IsFixedLength(PropertyBuilder, Boolean)

將屬性配置為僅能儲存固定長度的資料,例如字串。

IsSparse(PropertyBuilder, Boolean)

設定屬性欄位在針對 SQL Server 時是否被建立為稀疏。

IsVector(PropertyBuilder, DistanceFunction, Int32)

將該屬性配置為 Azure Cosmos DB 的向量。

IsVectorProperty(PropertyBuilder, DistanceFunction, Int32)

將該屬性配置為 Azure Cosmos DB 的向量。

ToJsonProperty(PropertyBuilder, String)

設定該物件在針對 Azure Cosmos 時所映射的屬性名稱。

UseAutoincrement(PropertyBuilder)

設定屬性以使用 SQLite AUTOINCREMENT 功能來產生新實體的值,針對 SQLite 進行目標。 此方法將性質設定為 OnAdd。

UseCollation(PropertyBuilder, String)

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

UseHiLo(PropertyBuilder, String, String)

設定關鍵屬性,使其使用基於序列的 hi-lo 模式來產生新實體的值,以針對SQL Server。 此方法將性質設定為 OnAdd。

UseIdentityColumn(PropertyBuilder, Int32, Int32)

設定 key 屬性以使用 SQL Server IDENTITY 功能來產生新實體的值,針對 SQL Server。 此方法將性質設定為 OnAdd。

UseIdentityColumn(PropertyBuilder, Int64, Int32)

設定 key 屬性以使用 SQL Server IDENTITY 功能來產生新實體的值,針對 SQL Server。 此方法將性質設定為 OnAdd。

UseSequence(PropertyBuilder, String, String)

設定鍵屬性,使其使用基於序列的鍵值產生模式,以產生新實體的值,針對 SQL Server。 此方法將性質設定為 OnAdd。

UseSqlServerIdentityColumn(PropertyBuilder, Int32, Int32)
已淘汰.

設定 key 屬性以使用 SQL Server IDENTITY 功能來產生新實體的值,針對 SQL Server。 此方法將性質設定為 OnAdd。

UseSqlServerIdentityColumn(PropertyBuilder)

設定 key 屬性以使用 SQL Server IDENTITY 功能來產生新實體的值,針對 SQL Server。 此方法將性質設定為 OnAdd。

適用於