Language

IMutableIndex インターフェイス

定義

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

public interface IMutableIndex : Microsoft.EntityFrameworkCore.Metadata.IIndex, Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable
public interface IMutableIndex : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex
type IMutableIndex = interface
    interface IIndex
    interface IAnnotatable
    interface IMutableAnnotatable
type IMutableIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable
Public Interface IMutableIndex
Implements IIndex, IMutableAnnotatable
Public Interface IMutableIndex
Implements IMutableAnnotatable, IReadOnlyIndex
実装

注釈

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

詳細と例については、 エンティティの型とリレーションシップのモデル化 を参照してください。

プロパティ

Name 説明
CollectionIndices

各インデックス付きプロパティに到達するために走査される複合コレクション インデックスを取得します。 値の構造については、 CollectionIndices を参照してください。

DeclaringEntityType

インデックスが定義されているエンティティ型を取得します。 これは、インデックスが継承階層で派生型を定義するときに定義 Properties 型とは異なる場合があります (プロパティは基本型で定義される可能性があるため)。

IsDescending

対応する各インデックス列に降順の並べ替え順序があるかどうかを示す値のセット。

IsUnique

インデックス付きプロパティに割り当てられた値が一意かどうかを示す値を取得または設定します。

Item[String]

指定した名前の注釈の値を取得し、存在しない場合は null 返します。

(継承元 IReadOnlyAnnotatable)
Name

このインデックスの名前を取得します。

(継承元 IReadOnlyIndex)
Properties

このインデックスが定義されているプロパティを取得します。

メソッド

Name 説明
AddAnnotation(String, Object)

このオブジェクトに注釈を追加します。 指定した名前の注釈が既に存在する場合にスローします。

(継承元 IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)

オブジェクトに注釈を追加します。

(継承元 IMutableAnnotatable)
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>()

さまざまな形式のエンティティ データから取得されたインデックス キー値に基づいて、キー値のファクトリを取得します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

(継承元 IIndex)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

指定された名前を持つランタイム注釈の値を取得し、存在しない場合は追加します。

(継承元 IAnnotatable)
GetRuntimeAnnotations()

現在のオブジェクトのすべてのランタイム注釈を取得します。

(継承元 IAnnotatable)
RemoveAnnotation(String)

このオブジェクトから指定された注釈を削除します。

(継承元 IMutableAnnotatable)
RemoveRuntimeAnnotation(String)

指定されたランタイム注釈をこのオブジェクトから削除します。

(継承元 IAnnotatable)
SetAnnotation(String, Object)

指定したキーの下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IMutableAnnotatable)
SetOrRemoveAnnotation(String, Object)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

(継承元 IMutableAnnotatable)
SetRuntimeAnnotation(String, Object)

指定されたキーの下に格納されているランタイム注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。

(継承元 IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

(継承元 IReadOnlyIndex)

拡張メソッド

Name 説明
AddAnnotations(IMutableAnnotatable, IEnumerable<IAnnotation>)

オブジェクトに注釈を追加します。

AnnotationsToDebugString(IAnnotatable, Int32)

オブジェクトで宣言されているすべての注釈のデバッグ文字列を取得します。

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IConventionIndex を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

FindSharedObjectRootIndex(IMutableIndex, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IMutableIndex を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)

共有テーブルに似たオブジェクト内の同じインデックスにマップされている最初の IIndex を検索します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

GetAnnotation(IAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetAnnotation(IMutableAnnotatable, String)

指定した名前の注釈を取得し、存在しない場合はスローします。

GetDatabaseName(IIndex, StoreObjectIdentifier)

データベース内のインデックスの名前を返します。

GetDatabaseName(IIndex)

データベース内のインデックスの名前を返します。

GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

データベース内のインデックスの名前を返します。

GetDatabaseName(IReadOnlyIndex)

データベース内のインデックスの名前を返します。

GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)

インデックスで使用されるデータ圧縮を返します。

GetDataCompression(IReadOnlyIndex)

インデックスで使用されるデータ圧縮を返します。

GetDefaultDatabaseName(IIndex, StoreObjectIdentifier)

このインデックスに使用される既定の名前を返します。

GetDefaultDatabaseName(IIndex)

このインデックスに使用される既定の名前を返します。

GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

このインデックスに使用される既定の名前を返します。

GetDefaultDatabaseName(IReadOnlyIndex)

このインデックスに使用される既定の名前を返します。

GetDefaultName(IIndex)
古い.

このインデックスに使用される既定の名前を返します。

GetFillFactor(IIndex)

インデックスが塗りつぶし係数を使用するかどうかを示す値を返します。

GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)

インデックスで使用される塗りつぶし係数を返します。

GetFillFactor(IReadOnlyIndex)

インデックスで使用される塗りつぶし係数を返します。

GetFilter(IIndex, StoreObjectIdentifier)

インデックス フィルター式を返します。

GetFilter(IIndex)

インデックス フィルター式を返します。

GetFilter(IReadOnlyIndex, StoreObjectIdentifier)

インデックス フィルター式を返します。

GetFilter(IReadOnlyIndex)

インデックス フィルター式を返します。

GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier)

フルテキスト インデックスのフルテキスト カタログ名を返します。

GetFullTextCatalog(IReadOnlyIndex)

フルテキスト インデックスのフルテキスト カタログ名を返します。

GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier)

フルテキスト インデックスの変更追跡モードを返します。

GetFullTextChangeTracking(IReadOnlyIndex)

フルテキスト インデックスの変更追跡モードを返します。

GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier)

フルテキスト インデックスの KEY INDEX 名を返します。

GetFullTextKeyIndex(IReadOnlyIndex)

フルテキスト インデックスの KEY INDEX 名を返します。

GetFullTextLanguage(IReadOnlyIndex, String)

フルテキスト インデックス内の特定のプロパティのフルテキスト言語を返します。

GetFullTextLanguages(IReadOnlyIndex)

フルテキスト インデックス用に構成されているすべてのフルテキスト言語を返します。

GetIncludeProperties(IIndex)

含まれているプロパティ名を返します。指定されていない場合は null を返します。

GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)

含まれているプロパティ名を返します。指定されていない場合は null を返します。

GetIncludeProperties(IReadOnlyIndex)

含まれているプロパティ名を返します。指定されていない場合は null を返します。

GetMappedTableIndexes(IIndex)

インデックスがマップされるテーブル インデックスを取得します。

GetName(IIndex)
古い.

データベース内のインデックスの名前を返します。

GetNullableValueFactory<TKey>(IIndex)

さまざまな形式のエンティティ データから取得されたインデックス キー値に基づいて、キー値のファクトリを取得します。

このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。

GetOrAddAnnotation(IMutableAnnotatable, String, String)

特定のキーを持つ既存の注釈を取得するか、存在しない場合は新しい注釈を追加します。

GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)

インデックスが tempdb で並べ替えられているかどうかを示す値を返します。

GetSortInTempDb(IReadOnlyIndex)

インデックスが tempdb で並べ替えられているかどうかを示す値を返します。

GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier)

ベクター インデックスの型を返します。

GetVectorIndexType(IReadOnlyIndex)

使用するベクター インデックスの種類 ("flat"、"diskANN"、"quantizedFlat" など) を返します。 詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。

GetVectorIndexType(IReadOnlyIndex)

ベクター インデックスの型を返します。

GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier)

ベクター インデックスの類似性メトリックを返します。

GetVectorMetric(IReadOnlyIndex)

ベクター インデックスの類似性メトリックを返します。

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)

インデックスがベクター インデックスかどうかを返します。

Relational(IIndex)

インデックスのリレーショナル データベース固有のメタデータを取得します。

Relational(IMutableIndex)

インデックスのリレーショナル データベース固有のメタデータを取得します。

SetDatabaseName(IMutableIndex, String)

データベース内のインデックスの名前を設定します。

SetDataCompression(IMutableIndex, Nullable<DataCompressionType>)

インデックスで使用されるデータ圧縮を示す値を設定します。

SetFillFactor(IMutableIndex, Nullable<Int32>)

インデックスで塗りつぶし係数を使用するかどうかを示す値を設定します。

SetFilter(IMutableIndex, String)

インデックス フィルター式を設定します。

SetFullTextCatalog(IMutableIndex, String)

フルテキスト インデックスのフルテキスト カタログ名を設定します。

SetFullTextChangeTracking(IMutableIndex, Nullable<FullTextChangeTracking>)

フルテキスト インデックスの変更追跡モードを設定します。

SetFullTextKeyIndex(IMutableIndex, String)

フルテキスト インデックスの KEY INDEX 名を設定します。 null 以外の値を設定すると、このインデックスがフルテキスト インデックスとしてマークされます。

SetFullTextLanguage(IMutableIndex, String, String)

フルテキスト インデックス内の特定のプロパティのフルテキスト言語を設定します。

SetFullTextLanguages(IMutableIndex, IReadOnlyDictionary<String,String>)

フルテキスト インデックス内のすべてのプロパティのフルテキスト言語を設定します。

SetIncludeProperties(IMutableIndex, IReadOnlyList<String>)

含まれるプロパティ名を設定します。

SetIsClustered(IMutableIndex, Nullable<Boolean>)

インデックスがクラスター化されているかどうかを示す値を設定します。

SetIsCreatedOnline(IMutableIndex, Nullable<Boolean>)

インデックスがオンラインかどうかを示す値を設定します。

SetIsFullTextIndex(IMutableIndex, Nullable<Boolean>)

フルテキスト検索のインデックスを構成します。 詳細については、Azure Cosmos DBのフルテキスト検索でNoSQLを参照してください。

SetName(IMutableIndex, String)
古い.

データベース内のインデックスの名前を設定します。

SetOrRemoveAnnotation(IMutableAnnotatable, String, Object)

指定した名前の下に格納されている注釈を設定します。 指定した名前の注釈が既に存在する場合は、既存の注釈を上書きします。 nullが指定されている場合は、既存の注釈を削除します。

SetSortInTempDb(IMutableIndex, Nullable<Boolean>)

インデックスを tempdb で並べ替えるかどうかを示す値を設定します。

SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>, Nullable<Boolean>)

"flat"、"diskANN"、"quantizedFlat" など、使用するベクター インデックスの種類を設定します。 詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。

SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>)

"flat"、"diskANN"、"quantizedFlat" など、使用するベクター インデックスの種類を設定します。 詳細については、「NoSQLのAzure Cosmos DBでのベクター検索」を参照してください。

SetVectorIndexType(IMutableIndex, String)

ベクター インデックスの型を設定します。

SetVectorMetric(IMutableIndex, String)

ベクトル インデックスの類似性メトリックを設定します。

Sqlite(IIndex)

インデックスの SQLite 固有のメタデータを取得します。

Sqlite(IMutableIndex)

インデックスの SQLite 固有のメタデータを取得します。

SqlServer(IIndex)

インデックスのSQL Server固有のメタデータを取得します。

SqlServer(IMutableIndex)

インデックスのSQL Server固有のメタデータを取得します。

ToDebugString(IIndex, MetadataDebugStringOptions, Int32)

指定されたメタデータの人間が判読できる表現を作成します。

警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。

適用対象