IIndex 介面

定義

命名空間:

Microsoft.EntityFrameworkCore.Metadata

組件:

Microsoft.EntityFrameworkCore.dll

套件:

Microsoft.EntityFrameworkCore v8.0.0

表示一組屬性上的索引。

public interface IIndex : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IAnnotatable

Public Interface IIndex
Implements IAnnotatable, IReadOnlyIndex

衍生

Microsoft.EntityFrameworkCore.Metadata.RuntimeIndex

實作

IAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

備註

如需詳細資訊和範例，請參閱 模型化實體類型和關聯 性。

屬性

DeclaringEntityType	取得索引定義所在的實體類型。 這可能與在繼承階層中定義衍生型別時所定義的型 Properties 別不同 (，因為屬性可以在基底類型上定義) 。
IsDescending	一組值，指出每個對應的索引資料行是否有遞減排序次序。 (繼承來源 IReadOnlyIndex)
Item[String]	取得具有指定名稱之注釋的值，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
Properties	取得定義這個索引的屬性。

方法

AddRuntimeAnnotation(String, Object)	將執行時間批註新增至這個 物件。 如果具有指定名稱的注釋已經存在，則會擲回 。 (繼承來源 IAnnotatable)
AnnotationsToDebugString(Int32)	取得 物件上宣告之所有注釋的偵錯字串。 (繼承來源 IReadOnlyAnnotatable)
DisplayName()	取得指定 IReadOnlyIndex 之 的易記顯示名稱，如果已定義，則傳回它的 Name ，如果這是未命名的索引，則傳回它的 Properties 字串表示。 (繼承來源 IReadOnlyIndex)
FindAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則傳 null 回 。 (繼承來源 IReadOnlyAnnotatable)
FindRuntimeAnnotation(String)	取得具有指定名稱的執行時間批註，如果不存在，則 null 傳回 。 (繼承來源 IAnnotatable)
FindRuntimeAnnotationValue(String)	取得具有指定名稱的執行時間批註值，如果不存在，則傳 null 回 。 (繼承來源 IAnnotatable)
GetAnnotation(String)	取得具有指定名稱的注釋，如果不存在，則會擲回。 (繼承來源 IReadOnlyAnnotatable)
GetAnnotations()	取得目前 物件上的所有批註。 (繼承來源 IReadOnlyAnnotatable)
GetNullableValueFactory<TKey>()	根據從各種實體資料形式取得的索引鍵值，取得索引鍵值的處理站。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	取得具有指定名稱的執行時間批註值，如果不存在，請加以新增。 (繼承來源 IAnnotatable)
GetRuntimeAnnotations()	取得目前 物件上的所有執行時間批註。 (繼承來源 IAnnotatable)
RemoveRuntimeAnnotation(String)	從這個 物件中移除指定的執行時間批註。 (繼承來源 IAnnotatable)
SetRuntimeAnnotation(String, Object)	設定儲存在指定索引鍵底下的執行時間批註。 如果具有指定名稱的注釋已經存在，則會覆寫現有的批註。 (繼承來源 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	建立人類可讀取的指定中繼資料標記法。 警告：不要依賴傳回字串的格式。 它專為偵錯而設計，而且可能會在發行之間任意變更。 (繼承來源 IReadOnlyIndex)

擴充方法

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)	尋找對應至共用資料表類似物件中相同索引的第一 IConventionIndex 個。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	尋找對應至共用資料表類似物件中相同索引的第一 IIndex 個。 這個方法通常由資料庫提供者使用， (和其他延伸模組) 。 它通常不會用於應用程式程式碼中。
GetDatabaseName(IReadOnlyIndex)	傳回資料庫中索引的名稱。
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	傳回資料庫中索引的名稱。
GetDefaultDatabaseName(IReadOnlyIndex)	傳回用於此索引的預設名稱。
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	傳回用於此索引的預設名稱。
GetFilter(IReadOnlyIndex)	傳回索引篩選運算式。
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	傳回索引篩選運算式。
GetMappedTableIndexes(IIndex)	取得索引所對應的資料表索引。
GetFluentApiCalls(IIndex, IAnnotationCodeGenerator)	取得用來設定索引的 Fluent API 呼叫。
IsHandledByDataAnnotations(IIndex, IAnnotationCodeGenerator)	取得值，指出資料批註是否可以完全重新執行這個索引。
GetDataCompression(IReadOnlyIndex)	傳回索引使用的資料壓縮。
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	傳回索引使用的資料壓縮。
GetFillFactor(IReadOnlyIndex)	傳回索引使用的填滿因數。
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	傳回索引使用的填滿因數。
GetIncludeProperties(IReadOnlyIndex)	傳回包含的屬性名稱，如果尚未指定，則 null 傳回 。
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	傳回包含的屬性名稱，如果尚未指定，則 null 傳回 。
GetSortInTempDb(IReadOnlyIndex)	傳回值，指出索引是否在 tempdb 中排序。
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	傳回值，指出索引是否在 tempdb 中排序。
IsClustered(IReadOnlyIndex)	傳回值，指出索引是否為叢集。
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	傳回值，指出索引是否為叢集。
IsCreatedOnline(IReadOnlyIndex)	傳回值，指出索引是否在線上。
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	傳回值，指出索引是否在線上。