IConventionIndex インターフェイス

定義

名前空間:

Microsoft.EntityFrameworkCore.Metadata

アセンブリ:

Microsoft.EntityFrameworkCore.dll

パッケージ:

Microsoft.EntityFrameworkCore v8.0.0

プロパティのセットのインデックスを表します。

public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex

実装

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

注釈

このインターフェイスはモデルの作成時に使用され、メタデータを変更できます。 モデルが構築されると、 IIndex は同じメタデータの読み取り専用ビューを表します。

詳細と例については、「 モデルの構築規則 」を参照してください。

プロパティ

Builder	このインデックスの構成に使用できるビルダーを取得します。
DeclaringEntityType	インデックスが定義されているエンティティ型を取得します。 これは、インデックスが Properties 継承階層で派生型を定義するときに定義される型とは異なる場合があります (プロパティは基本型で定義される可能性があるため)。
IsDescending	対応する各インデックス列に降順の並べ替え順序があるかどうかを示す値のセット。 (継承元 IReadOnlyIndex)
IsInModel	このオブジェクトがモデル内にあるかどうか、つまり、モデルから削除されていないかどうかを示します。 (継承元 IConventionAnnotatable)
IsUnique	インデックス付きプロパティに割り当てられた値が一意かどうかを示す値を取得します。 (継承元 IReadOnlyIndex)
Item[String]	指定した名前の注釈の値を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
Name	このインデックスの名前を取得します。 (継承元 IReadOnlyIndex)
Properties	このインデックスが定義されているプロパティを取得します。

メソッド

AddAnnotation(String, Object, Boolean)	このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合は をスローします。 (継承元 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	オブジェクトに注釈を追加します。 (継承元 IConventionAnnotatable)
AnnotationsToDebugString(Int32)	オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable)
DisplayName()	指定 IReadOnlyIndexされた のフレンドリ表示名を取得し、定義されている場合は を Name 返し、名前のないインデックスの場合は の Properties 文字列表現を返します。 (継承元 IReadOnlyIndex)
FindAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は を null 返します。 (継承元 IReadOnlyAnnotatable)
GetAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は をスローします。 (継承元 IReadOnlyAnnotatable)
GetAnnotations()	現在の オブジェクトのすべての注釈を取得します。 (継承元 IReadOnlyAnnotatable)
GetConfigurationSource()	このインデックスの構成ソースを返します。
GetIsDescendingConfigurationSource()	の構成ソースを IsDescending返します。
GetIsUniqueConfigurationSource()	の構成ソースを IsUnique返します。
RemoveAnnotation(String)	指定した名前の注釈をこのオブジェクトから削除します。 (継承元 IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)	このインデックスの並べ替え順序 (昇順または降順) を設定します。
SetIsUnique(Nullable<Boolean>, Boolean)	インデックス プロパティに割り当てられた値が一意かどうかを示す値を設定します。
SetOrRemoveAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 が指定されている場合 null は、既存の注釈を削除します。 (継承元 IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyIndex)

拡張メソッド

FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初 IConventionIndex の インデックスを検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初 IIndex の インデックスを検索します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。
GetDatabaseName(IReadOnlyIndex)	データベース内のインデックスの名前を返します。
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	データベース内のインデックスの名前を返します。
GetDatabaseNameConfigurationSource(IConventionIndex)	データベース内 ConfigurationSource のインデックスの名前の を取得します。
GetDefaultDatabaseName(IReadOnlyIndex)	このインデックスに使用される既定の名前を返します。
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	このインデックスに使用される既定の名前を返します。
GetFilter(IReadOnlyIndex)	インデックス フィルター式を返します。
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	インデックス フィルター式を返します。
GetFilterConfigurationSource(IConventionIndex)	インデックス フィルター式の を ConfigurationSource 取得します。
SetDatabaseName(IConventionIndex, String, Boolean)	データベース内のインデックスの名前を設定します。
SetFilter(IConventionIndex, String, Boolean)	インデックス フィルター式を設定します。
GetDataCompression(IReadOnlyIndex)	インデックスで使用されるデータ圧縮を返します。
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	インデックスで使用されるデータ圧縮を返します。
GetDataCompressionConfigurationSource(IConventionIndex)	インデックスで ConfigurationSource 使用されるデータ圧縮の を返します。
GetFillFactor(IReadOnlyIndex)	インデックスで使用される塗りつぶし係数を返します。
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	インデックスで使用される塗りつぶし係数を返します。
GetFillFactorConfigurationSource(IConventionIndex)	インデックスで ConfigurationSource 塗りつぶし係数を使用するかどうかを示す を返します。
GetIncludeProperties(IReadOnlyIndex)	含まれているプロパティ名を返します。指定 null されていない場合は を返します。
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	含まれているプロパティ名を返します。指定 null されていない場合は を返します。
GetIncludePropertiesConfigurationSource(IConventionIndex)	ConfigurationSource含まれているプロパティ名の を返します。
GetIsClusteredConfigurationSource(IConventionIndex)	インデックスが ConfigurationSource クラスター化されているかどうかを示す を返します。
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	インデックスが ConfigurationSource オンラインかどうかを示す を返します。
GetSortInTempDb(IReadOnlyIndex)	インデックスが tempdb で並べ替えられているかどうかを示す値を返します。
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	インデックスが tempdb で並べ替えられているかどうかを示す値を返します。
GetSortInTempDbConfigurationSource(IConventionIndex)	インデックスが ConfigurationSource tempdb で並べ替えられているかどうかを示す を返します。
IsClustered(IReadOnlyIndex)	インデックスがクラスター化されているかどうかを示す値を返します。
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	インデックスがクラスター化されているかどうかを示す値を返します。
IsCreatedOnline(IReadOnlyIndex)	インデックスがオンラインかどうかを示す値を返します。
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	インデックスがオンラインかどうかを示す値を返します。
SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)	インデックスで使用されるデータ圧縮を示す値を設定します。
SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)	インデックスで塗りつぶし係数を使用するかどうかを示す値を定義します。
SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)	含まれているプロパティ名を設定します。
SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスがクラスター化されているかどうかを示す値を設定します。
SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスがオンラインかどうかを示す値を設定します。
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスを tempdb で並べ替えるかどうかを示す値を設定します。