IConventionIndex インターフェイス

定義

名前空間:: Microsoft.EntityFrameworkCore.Metadata

アセンブリ:: Microsoft.EntityFrameworkCore.dll

パッケージ:: Microsoft.EntityFrameworkCore v10.0.0

パッケージ:: Microsoft.EntityFrameworkCore v11.0.0

パッケージ:: Microsoft.EntityFrameworkCore v3.0.0

パッケージ:: Microsoft.EntityFrameworkCore v3.1.0

パッケージ:: Microsoft.EntityFrameworkCore v5.0.0

パッケージ:: Microsoft.EntityFrameworkCore v6.0.0

パッケージ:: Microsoft.EntityFrameworkCore v7.0.0

パッケージ:: Microsoft.EntityFrameworkCore v8.0.0

パッケージ:: Microsoft.EntityFrameworkCore v9.0.0

ソース:: IConventionIndex.cs

ソース:: IConventionIndex.cs

ソース:: IConventionIndex.cs

ソース:: IConventionIndex.cs

ソース:: IConventionIndex.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

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

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

type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

type IConventionIndex = interface
    interface IIndex
    interface IAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex

Public Interface IConventionIndex
Implements IConventionAnnotatable, IIndex

実装: IReadOnlyAnnotatable IConventionAnnotatable IReadOnlyIndex IAnnotatable IIndex

注釈

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

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

プロパティ

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

メソッド

Name	説明
AddAnnotation(String, Object, Boolean)	このオブジェクトに注釈を追加します。指定した名前の注釈が既に存在する場合にスローします。 (継承元 IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	オブジェクトに注釈を追加します。 (継承元 IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)	このオブジェクトにランタイム注釈を追加します。指定した名前の注釈が既に存在する場合にスローします。 (継承元 IAnnotatable)
AnnotationsToDebugString(Int32)	オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。 (継承元 IReadOnlyAnnotatable)
DisplayName()	指定した IReadOnlyIndexの表示名を取得し、定義されている場合は Name を返し、名前のないインデックスの場合は Properties の文字列表現を取得します。 (継承元 IReadOnlyIndex)
FindAnnotation(String)	指定した名前の注釈を取得し、存在しない場合は `null` 返します。 (継承元 IAnnotatable)
FindRuntimeAnnotation(String)	指定された名前のランタイム注釈を取得し、存在しない場合は `null` を返します。 (継承元 IAnnotatable)
FindRuntimeAnnotationValue(String)	指定した名前のランタイム注釈の値を取得し、存在しない場合は `null` 返します。 (継承元 IAnnotatable)
GetAnnotation(String)	指定した名前の注釈を取得し、存在しない場合はスローします。 (継承元 IConventionAnnotatable)
GetAnnotations()	現在のオブジェクトのすべての注釈を取得します。 (継承元 IAnnotatable)
GetConfigurationSource()	このインデックスの構成ソースを返します。
GetIsDescendingConfigurationSource()	IsDescendingの構成ソースを返します。
GetIsUniqueConfigurationSource()	IsUniqueの構成ソースを返します。
GetNullableValueFactory<TKey>()	さまざまな形式のエンティティデータから取得されたインデックスキー値に基づいて、キー値のファクトリを取得します。このメソッドは、通常、データベースプロバイダー (およびその他の拡張機能) によって使用されます。通常、アプリケーションコードでは使用されません。 (継承元 IIndex)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)	指定された名前を持つランタイム注釈の値を取得し、存在しない場合は追加します。 (継承元 IAnnotatable)
GetRuntimeAnnotations()	現在のオブジェクトのすべてのランタイム注釈を取得します。 (継承元 IAnnotatable)
RemoveAnnotation(String)	指定した名前の注釈をこのオブジェクトから削除します。 (継承元 IConventionAnnotatable)
RemoveRuntimeAnnotation(String)	指定されたランタイム注釈をこのオブジェクトから削除します。 (継承元 IAnnotatable)
SetAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)	このインデックスの並べ替え順序を設定します (昇順または降順)。
SetIsUnique(Nullable<Boolean>, Boolean)	インデックスプロパティに割り当てられた値が一意かどうかを示す値を設定します。
SetOrRemoveAnnotation(String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 `null`が指定されている場合は、既存の注釈を削除します。 (継承元 IConventionAnnotatable)
SetRuntimeAnnotation(String, Object)	指定されたキーの下に格納されているランタイム注釈を設定します。指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 (継承元 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	指定されたメタデータの人間が判読できる表現を作成します。警告: 返される文字列の形式に依存しないでください。デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 (継承元 IReadOnlyIndex)

拡張メソッド

Name	説明
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)	オブジェクトに注釈を追加します。
AnnotationsToDebugString(IAnnotatable, Int32)	オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。
FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IConventionIndex を検索します。このメソッドは、通常、データベースプロバイダー (およびその他の拡張機能) によって使用されます。通常、アプリケーションコードでは使用されません。
FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IConventionIndex を検索します。このメソッドは、通常、データベースプロバイダー (およびその他の拡張機能) によって使用されます。通常、アプリケーションコードでは使用されません。
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IIndex を検索します。このメソッドは、通常、データベースプロバイダー (およびその他の拡張機能) によって使用されます。通常、アプリケーションコードでは使用されません。
GetAnnotation(IAnnotatable, String)	指定した名前の注釈を取得し、存在しない場合はスローします。
GetAnnotation(IConventionAnnotatable, String)	指定した名前の注釈を取得し、存在しない場合はスローします。
GetDatabaseName(IIndex, StoreObjectIdentifier)	データベース内のインデックスの名前を返します。
GetDatabaseName(IIndex)	データベース内のインデックスの名前を返します。
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	データベース内のインデックスの名前を返します。
GetDatabaseName(IReadOnlyIndex)	データベース内のインデックスの名前を返します。
GetDatabaseNameConfigurationSource(IConventionIndex)	データベース内のインデックスの名前の ConfigurationSource を取得します。
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	インデックスで使用されるデータ圧縮を返します。
GetDataCompression(IReadOnlyIndex)	インデックスで使用されるデータ圧縮を返します。
GetDataCompressionConfigurationSource(IConventionIndex)	インデックスで使用されるデータ圧縮の ConfigurationSource を返します。
GetDefaultDatabaseName(IIndex, StoreObjectIdentifier)	このインデックスに使用される既定の名前を返します。
GetDefaultDatabaseName(IIndex)	このインデックスに使用される既定の名前を返します。
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	このインデックスに使用される既定の名前を返します。
GetDefaultDatabaseName(IReadOnlyIndex)	このインデックスに使用される既定の名前を返します。
GetDefaultName(IIndex)	古い. このインデックスに使用される既定の名前を返します。
GetFillFactor(IIndex)	インデックスが塗りつぶし係数を使用するかどうかを示す値を返します。
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	インデックスで使用される塗りつぶし係数を返します。
GetFillFactor(IReadOnlyIndex)	インデックスで使用される塗りつぶし係数を返します。
GetFillFactorConfigurationSource(IConventionIndex)	インデックスで塗りつぶし係数を使用するかどうかを示す ConfigurationSource を返します。
GetFilter(IIndex, StoreObjectIdentifier)	インデックスフィルター式を返します。
GetFilter(IIndex)	インデックスフィルター式を返します。
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	インデックスフィルター式を返します。
GetFilter(IReadOnlyIndex)	インデックスフィルター式を返します。
GetFilterConfigurationSource(IConventionIndex)	インデックスフィルター式の ConfigurationSource を取得します。
GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier)	フルテキストインデックスのフルテキストカタログ名を返します。
GetFullTextCatalog(IReadOnlyIndex)	フルテキストインデックスのフルテキストカタログ名を返します。
GetFullTextCatalogConfigurationSource(IConventionIndex)	フルテキストインデックスのフルテキストカタログの ConfigurationSource を返します。
GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier)	フルテキストインデックスの変更追跡モードを返します。
GetFullTextChangeTracking(IReadOnlyIndex)	フルテキストインデックスの変更追跡モードを返します。
GetFullTextChangeTrackingConfigurationSource(IConventionIndex)	フルテキストインデックスの変更追跡モードの ConfigurationSource を返します。
GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier)	フルテキストインデックスの KEY INDEX 名を返します。
GetFullTextKeyIndex(IReadOnlyIndex)	フルテキストインデックスの KEY INDEX 名を返します。
GetFullTextKeyIndexConfigurationSource(IConventionIndex)	フルテキストインデックスの KEY INDEX の ConfigurationSource を返します。
GetFullTextLanguage(IReadOnlyIndex, String)	フルテキストインデックス内の特定のプロパティのフルテキスト言語を返します。
GetFullTextLanguages(IReadOnlyIndex)	フルテキストインデックス用に構成されているすべてのフルテキスト言語を返します。
GetFullTextLanguagesConfigurationSource(IConventionIndex)	フルテキストインデックスのフルテキスト言語の ConfigurationSource を返します。
GetIncludeProperties(IIndex)	含まれているプロパティ名を返します。指定されていない場合は `null` を返します。
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	含まれているプロパティ名を返します。指定されていない場合は `null` を返します。
GetIncludeProperties(IReadOnlyIndex)	含まれているプロパティ名を返します。指定されていない場合は `null` を返します。
GetIncludePropertiesConfigurationSource(IConventionIndex)	含まれるプロパティ名の ConfigurationSource を返します。
GetIsClusteredConfigurationSource(IConventionIndex)	インデックスがクラスター化されているかどうかを示す ConfigurationSource を返します。
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	インデックスがオンラインかどうかを示す ConfigurationSource を返します。
GetIsFullTextIndexConfigurationSource(IConventionIndex)	IsFullTextIndex(IReadOnlyIndex)のConfigurationSourceを返します。
GetMappedTableIndexes(IIndex)	インデックスがマップされるテーブルインデックスを取得します。
GetName(IIndex)	古い. データベース内のインデックスの名前を返します。
GetNameConfigurationSource(IConventionIndex)	古い. データベース内のインデックスの名前の ConfigurationSource を取得します。
GetNullableValueFactory<TKey>(IIndex)	さまざまな形式のエンティティデータから取得されたインデックスキー値に基づいて、キー値のファクトリを取得します。このメソッドは、通常、データベースプロバイダー (およびその他の拡張機能) によって使用されます。通常、アプリケーションコードでは使用されません。
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	インデックスが tempdb で並べ替えられているかどうかを示す値を返します。
GetSortInTempDb(IReadOnlyIndex)	インデックスが tempdb で並べ替えられているかどうかを示す値を返します。
GetSortInTempDbConfigurationSource(IConventionIndex)	インデックスを tempdb で並べ替えるかどうかを示す ConfigurationSource を返します。
GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier)	ベクターインデックスの型を返します。
GetVectorIndexType(IReadOnlyIndex)	使用するベクターインデックスの種類 ("flat"、"diskANN"、"quantizedFlat" など) を返します。詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。
GetVectorIndexType(IReadOnlyIndex)	ベクターインデックスの型を返します。
GetVectorIndexTypeConfigurationSource(IConventionIndex)	GetVectorIndexType(IReadOnlyIndex)のConfigurationSourceを返します。
GetVectorIndexTypeConfigurationSource(IConventionIndex)	ベクターインデックスの型の ConfigurationSource を返します。
GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier)	ベクターインデックスの類似性メトリックを返します。
GetVectorMetric(IReadOnlyIndex)	ベクターインデックスの類似性メトリックを返します。
GetVectorMetricConfigurationSource(IConventionIndex)	ベクトルインデックスの類似性メトリックの ConfigurationSource を返します。
IsClustered(IIndex, StoreObjectIdentifier)	インデックスがクラスター化されているかどうかを示す値を返します。
IsClustered(IIndex)	インデックスがクラスター化されているかどうかを示す値を返します。
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	インデックスがクラスター化されているかどうかを示す値を返します。
IsClustered(IReadOnlyIndex)	インデックスがクラスター化されているかどうかを示す値を返します。
IsCreatedOnline(IIndex)	インデックスがオンラインかどうかを示す値を返します。
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	インデックスがオンラインかどうかを示す値を返します。
IsCreatedOnline(IReadOnlyIndex)	インデックスがオンラインかどうかを示す値を返します。
IsFullTextIndex(IReadOnlyIndex)	インデックスがフルテキスト検索用に構成されているかどうかを示す値を返します。詳細については、Azure Cosmos DBのフルテキスト検索でNoSQLを参照してください。
IsFullTextIndex(IReadOnlyIndex)	インデックスがフルテキストインデックスかどうかを返します。
IsVectorIndex(IReadOnlyIndex)	インデックスがベクターインデックスかどうかを返します。
SetDatabaseName(IConventionIndex, String, Boolean)	データベース内のインデックスの名前を設定します。
SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)	インデックスで使用されるデータ圧縮を示す値を設定します。
SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)	インデックスで塗りつぶし係数を使用するかどうかを示す値を定義します。
SetFilter(IConventionIndex, String, Boolean)	インデックスフィルター式を設定します。
SetFullTextCatalog(IConventionIndex, String, Boolean)	フルテキストインデックスのフルテキストカタログ名を設定します。
SetFullTextChangeTracking(IConventionIndex, Nullable<FullTextChangeTracking>, Boolean)	フルテキストインデックスの変更追跡モードを設定します。
SetFullTextKeyIndex(IConventionIndex, String, Boolean)	フルテキストインデックスの KEY INDEX 名を設定します。 null 以外の値を設定すると、このインデックスがフルテキストインデックスとしてマークされます。
SetFullTextLanguage(IConventionIndex, String, String, Boolean)	フルテキストインデックス内の特定のプロパティのフルテキスト言語を設定します。
SetFullTextLanguages(IConventionIndex, IReadOnlyDictionary<String,String>, Boolean)	フルテキストインデックス内のすべてのプロパティのフルテキスト言語を設定します。
SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)	含まれるプロパティ名を設定します。
SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスがクラスター化されているかどうかを示す値を設定します。
SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスがオンラインかどうかを示す値を設定します。
SetIsFullTextIndex(IConventionIndex, Nullable<Boolean>, Boolean)	フルテキスト検索のインデックスを構成します。詳細については、Azure Cosmos DBのフルテキスト検索でNoSQLを参照してください。
SetName(IConventionIndex, String, Boolean)	古い. データベース内のインデックスの名前を設定します。
SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)	指定した名前の下に格納されている注釈を設定します。指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 `null`が指定されている場合は、既存の注釈を削除します。
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	インデックスを tempdb で並べ替えるかどうかを示す値を設定します。
SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean)	"flat"、"diskANN"、"quantizedFlat" など、使用するベクターインデックスの種類を設定します。詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。
SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Nullable<Boolean>, Boolean)	"flat"、"diskANN"、"quantizedFlat" など、使用するベクターインデックスの種類を設定します。詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。
SetVectorIndexType(IConventionIndex, String, Boolean)	ベクターインデックスの型を設定します。
SetVectorMetric(IConventionIndex, String, Boolean)	ベクトルインデックスの類似性メトリックを設定します。
ToDebugString(IIndex, MetadataDebugStringOptions, Int32)	指定されたメタデータの人間が判読できる表現を作成します。警告: 返される文字列の形式に依存しないでください。デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

適用対象

フィードバック

このページはお役に立ちましたか?