IConventionIndexBuilder 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata.Builders

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v8.0.0

提供簡單的 API 介面，以設定 IConventionIndex 來自慣例的 。

資料庫提供者通常會使用這個介面， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。

public interface IConventionIndexBuilder : Microsoft.EntityFrameworkCore.Metadata.Builders.IConventionAnnotatableBuilder

type IConventionIndexBuilder = interface
    interface IConventionAnnotatableBuilder

Public Interface IConventionIndexBuilder
Implements IConventionAnnotatableBuilder

實作

IConventionAnnotatableBuilder

備註

如需詳細資訊和範例，請參閱 模型建置慣例 。

屬性

Metadata	取得正在設定的索引。
ModelBuilder	取得模型產生器。 (繼承來源 IConventionAnnotatableBuilder)

方法

CanRemoveAnnotation(String, Boolean)	傳回值，指出是否可以使用此組態來源移除具有指定名稱的注釋。 (繼承來源 IConventionAnnotatableBuilder)
CanSetAnnotation(String, Object, Boolean)	傳回值，指出是否可以從這個組態來源設定具有指定名稱和值的注釋。 (繼承來源 IConventionAnnotatableBuilder)
CanSetIsDescending(IReadOnlyList<Boolean>, Boolean)	傳回值，指出是否可以從目前的組態來源設定這個索引排序次序。
CanSetIsUnique(Nullable<Boolean>, Boolean)	傳回值，指出是否可以從目前的組態來源設定此索引唯一性。
HasAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則覆寫現有的注釋，其名稱相同或較低 ConfigurationSource 。
HasNoAnnotation(String, Boolean)	從這個 物件中移除具有指定名稱的批註。
HasNonNullAnnotation(String, Object, Boolean)	設定儲存在指定名稱底下的批註。 如果具有指定名稱的注釋已經存在，則覆寫現有的注釋，其名稱相同或較低 ConfigurationSource 。 如果 null 指定值，則會移除批註。
IsDescending(IReadOnlyList<Boolean>, Boolean)	設定此索引資料行的排序次序 () ， (遞增或遞減) 。
IsUnique(Nullable<Boolean>, Boolean)	設定此索引是否為唯一 (，也就是每個值集都必須是唯一的) 。

擴充方法

CanSetDatabaseName(IConventionIndexBuilder, String, Boolean)	傳回值，指出是否可以為索引設定指定的名稱。
CanSetFilter(IConventionIndexBuilder, String, Boolean)	傳回值，指出指定的運算式是否可以設定為索引的篩選準則。
HasDatabaseName(IConventionIndexBuilder, String, Boolean)	以關係資料庫為目標時，設定資料庫中的索引名稱。
HasFilter(IConventionIndexBuilder, String, Boolean)	設定索引的篩選運算式。
CanSetDataCompression(IConventionIndexBuilder, Nullable<DataCompressionType>, Boolean)	傳回值，指出以SQL Server為目標時，是否可以使用資料壓縮選項設定索引。
CanSetFillFactor(IConventionIndexBuilder, Nullable<Int32>, Boolean)	傳回值，指出以SQL Server為目標時，是否可以使用填滿因數選項來設定索引。
CanSetIncludeProperties(IConventionIndexBuilder, IReadOnlyList<String>, Boolean)	傳回值，指出是否可以設定指定的 include 屬性。
CanSetIsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	傳回值，指出是否可以將索引設定為叢集。
CanSetIsCreatedOnline(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	傳回值，指出以SQL Server為目標時，是否可以使用線上選項設定索引。
CanSetSortInTempDb(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	傳回值，指出目標為 SQL Server時，是否可以在 tempdb 選項中使用排序來設定索引。
HasFillFactor(IConventionIndexBuilder, Nullable<Int32>, Boolean)	設定以SQL Server為目標時，是否使用填滿因數選項建立索引。
IncludeProperties(IConventionIndexBuilder, IReadOnlyList<String>, Boolean)	設定目標SQL Server時的索引包含屬性。
IsClustered(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	設定以SQL Server為目標時，索引是否為叢集。
IsCreatedOnline(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	設定以SQL Server為目標時，是否使用線上選項建立索引。
SortInTempDb(IConventionIndexBuilder, Nullable<Boolean>, Boolean)	設定目標為 SQL Server 時，是否以 tempdb 選項排序建立索引。
UseDataCompression(IConventionIndexBuilder, Nullable<DataCompressionType>, Boolean)	設定以SQL Server為目標時，是否使用資料壓縮選項建立索引。