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)	返回一个值，该值指示索引是否联机。