语言

IIndex 接口

定义

表示一组属性的索引。

public interface IIndex : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable
public interface IIndex : Microsoft.EntityFrameworkCore.Infrastructure.IAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex
type IIndex = interface
    interface IAnnotatable
type IIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IAnnotatable
Public Interface IIndex
Implements IAnnotatable
Public Interface IIndex
Implements IAnnotatable, IReadOnlyIndex
派生
实现

注解

有关详细信息和示例,请参阅 建模实体类型和关系 。

属性

名称 说明
CollectionIndices

获取遍历以访问每个索引属性的复杂集合索引。

(继承自 IReadOnlyIndex)
DeclaringEntityType

获取定义索引的实体类型。 这可能与在继承层次结构中定义索引时定义的类型 Properties 不同(因为属性可能在基类型上定义)。

IsDescending

一组值,该值指示每个对应的索引列是否具有降序排序顺序。

(继承自 IReadOnlyIndex)
IsUnique

获取一个值,该值指示分配给索引属性的值是否唯一。

Item[String]

获取具有给定名称的批注的值,如果不存在,则 null 返回该值。

(继承自 IReadOnlyAnnotatable)
Name

获取此索引的名称。

Properties

获取定义此索引的属性。

方法

名称 说明
AddRuntimeAnnotation(String, Object)

向此对象添加运行时批注。 如果具有指定名称的批注已存在,则引发。

(继承自 IAnnotatable)
AnnotationsToDebugString(Int32)

获取针对对象上声明的所有批注的调试字符串。

(继承自 IReadOnlyAnnotatable)
DisplayName()

获取给定IReadOnlyIndex的友好显示名称,如果定义了它,则返回它的NameProperties字符串表示形式(如果这是未命名的索引)。

(继承自 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)

扩展方法

名称 说明
AnnotationsToDebugString(IAnnotatable, Int32)

获取针对对象上声明的所有批注的调试字符串。

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)

查找映射到共享表类似对象中的同一索引的第 IConventionIndex 一个索引。

此方法通常由数据库提供程序(和其他扩展)使用。 它通常不用于应用程序代码。

FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)

查找映射到共享表类似对象中的同一索引的第 IIndex 一个索引。

此方法通常由数据库提供程序(和其他扩展)使用。 它通常不用于应用程序代码。

GetAnnotation(IAnnotatable, 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)

返回索引筛选器表达式。

GetFluentApiCalls(IIndex, IAnnotationCodeGenerator)

获取用于配置索引的 Fluent API 调用。

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)

根据从各种实体数据形式获取的索引键值获取键值的工厂。

此方法通常由数据库提供程序(和其他扩展)使用。 它通常不用于应用程序代码。

GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)

返回一个值,该值指示索引是否在 tempdb 中排序。

GetSortInTempDb(IReadOnlyIndex)

返回一个值,该值指示索引是否在 tempdb 中排序。

GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier)

返回向量索引的类型。

GetVectorIndexType(IReadOnlyIndex)

返回要使用的向量索引类型,例如“flat”、“diskANN”或“quantizedFlat”。 有关详细信息,请参阅Azure Cosmos DB中的矢量搜索,了解NoSQL。

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)

返回索引是否为全文索引。

IsHandledByDataAnnotations(IIndex, IAnnotationCodeGenerator)

获取一个值,该值指示此索引是否可以完全由数据注释重新显示。

IsVectorIndex(IReadOnlyIndex)

返回索引是否为向量索引。

Relational(IIndex)

获取索引的关系数据库特定元数据。

Sqlite(IIndex)

获取索引的 SQLite 特定元数据。

SqlServer(IIndex)

获取索引的SQL Server特定元数据。

ToDebugString(IIndex, MetadataDebugStringOptions, Int32)

创建给定元数据的可读表示形式。

警告:不要依赖于返回的字符串的格式。 它仅用于调试,可以在版本之间任意更改。

适用于