IMutableIndex 接口

定义

命名空间:

Microsoft.EntityFrameworkCore.Metadata

程序集:

Microsoft.EntityFrameworkCore.dll

程序包:

Microsoft.EntityFrameworkCore v10.0.0

Source:

IMutableIndex.cs

表示一组属性的索引。

public interface IMutableIndex : Microsoft.EntityFrameworkCore.Metadata.IMutableAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IMutableIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IMutableAnnotatable

Public Interface IMutableIndex
Implements IMutableAnnotatable, IReadOnlyIndex

实现

IMutableAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

注解

此接口在创建模型期间使用，并允许修改元数据。 生成模型后， IIndex 表示相同元数据的只读视图。

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

属性

名称	说明
DeclaringEntityType	获取定义索引的实体类型。 这可能与在继承层次结构中定义索引时定义的类型 Properties 不同（因为属性可能在基类型上定义）。
IsDescending	一组值，该值指示每个对应的索引列是否具有降序排序顺序。
IsUnique	获取或设置一个值，该值指示分配给索引属性的值是否唯一。
Item[String]	获取具有给定名称的批注的值，如果不存在，则 null 返回该值。 (继承自 IReadOnlyAnnotatable)
Name	获取此索引的名称。 (继承自 IReadOnlyIndex)
Properties	获取定义此索引的属性。

方法

名称	说明
AddAnnotation(String, Object)	向此对象添加批注。 如果具有指定名称的批注已存在，则引发。 (继承自 IMutableAnnotatable)
AddAnnotations(IEnumerable<IAnnotation>)	向对象添加批注。 (继承自 IMutableAnnotatable)
AnnotationsToDebugString(Int32)	获取针对对象上声明的所有批注的调试字符串。 (继承自 IReadOnlyAnnotatable)
DisplayName()	获取给定IReadOnlyIndex的友好显示名称，如果定义了它，则返回它的NameProperties字符串表示形式（如果这是未命名的索引）。 (继承自 IReadOnlyIndex)
FindAnnotation(String)	获取具有给定名称的批注，如果不存在，则 null 返回。 (继承自 IReadOnlyAnnotatable)
GetAnnotation(String)	获取具有给定名称的批注，如果不存在，则引发该批注。 (继承自 IReadOnlyAnnotatable)
GetAnnotations()	获取当前对象上的所有批注。 (继承自 IReadOnlyAnnotatable)
RemoveAnnotation(String)	从此对象中删除给定批注。 (继承自 IMutableAnnotatable)
SetAnnotation(String, Object)	设置存储在给定键下的批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 (继承自 IMutableAnnotatable)
SetOrRemoveAnnotation(String, Object)	设置存储在给定名称下的批注。 如果已存在具有指定名称的批注，则覆盖现有批注。 如果 null 已提供，则删除现有批注。 (继承自 IMutableAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	创建给定元数据的可读表示形式。 警告：不要依赖于返回的字符串的格式。 它仅用于调试，可以在版本之间任意更改。 (继承自 IReadOnlyIndex)

扩展方法

名称	说明
FindSharedObjectRootIndex(IMutableIndex, StoreObjectIdentifier)	查找映射到共享表类似对象中的同一索引的第 IMutableIndex 一个索引。 此方法通常由数据库提供程序（和其他扩展）使用。 它通常不用于应用程序代码。
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	查找映射到共享表类似对象中的同一索引的第 IIndex 一个索引。 此方法通常由数据库提供程序（和其他扩展）使用。 它通常不用于应用程序代码。
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	返回数据库中索引的名称。
GetDatabaseName(IReadOnlyIndex)	返回数据库中索引的名称。
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	返回索引使用的数据压缩。
GetDataCompression(IReadOnlyIndex)	返回索引使用的数据压缩。
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	返回将用于此索引的默认名称。
GetDefaultDatabaseName(IReadOnlyIndex)	返回将用于此索引的默认名称。
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	返回索引使用的填充因子。
GetFillFactor(IReadOnlyIndex)	返回索引使用的填充因子。
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	返回索引筛选器表达式。
GetFilter(IReadOnlyIndex)	返回索引筛选器表达式。
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	返回包含的属性名称，或者 null 未指定它们。
GetIncludeProperties(IReadOnlyIndex)	返回包含的属性名称，或者 null 未指定它们。
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	返回一个值，该值指示索引是否在 tempdb 中排序。
GetSortInTempDb(IReadOnlyIndex)	返回一个值，该值指示索引是否在 tempdb 中排序。
GetVectorIndexType(IReadOnlyIndex)	返回要使用的向量索引类型，例如“flat”、“diskANN”或“quantizedFlat”。 有关详细信息，请参阅Azure Cosmos DB中的矢量搜索，了解NoSQL。
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	返回一个值，该值指示索引是否聚集。
IsClustered(IReadOnlyIndex)	返回一个值，该值指示索引是否聚集。
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	返回一个值，该值指示索引是否处于联机状态。
IsCreatedOnline(IReadOnlyIndex)	返回一个值，该值指示索引是否处于联机状态。
IsFullTextIndex(IReadOnlyIndex)	返回一个值，该值指示是否为全文搜索配置了索引。 有关详细信息，请参阅Azure Cosmos DB中的全文搜索，了解NoSQL。
SetDatabaseName(IMutableIndex, String)	设置数据库中索引的名称。
SetDataCompression(IMutableIndex, Nullable<DataCompressionType>)	设置一个值，该值指示索引使用的数据压缩。
SetFillFactor(IMutableIndex, Nullable<Int32>)	设置一个值，该值指示索引是否使用填充因子。
SetFilter(IMutableIndex, String)	设置索引筛选器表达式。
SetIncludeProperties(IMutableIndex, IReadOnlyList<String>)	设置包含的属性名称。
SetIsClustered(IMutableIndex, Nullable<Boolean>)	设置一个值，该值指示索引是否聚集。
SetIsCreatedOnline(IMutableIndex, Nullable<Boolean>)	设置一个值，该值指示索引是否处于联机状态。
SetIsFullTextIndex(IMutableIndex, Nullable<Boolean>)	配置全文搜索的索引。 有关详细信息，请参阅Azure Cosmos DB中的全文搜索，了解NoSQL。
SetSortInTempDb(IMutableIndex, Nullable<Boolean>)	设置一个值，该值指示索引是否在 tempdb 中排序。
SetVectorIndexType(IMutableIndex, Nullable<VectorIndexType>, Nullable<Boolean>)	设置要使用的向量索引类型，例如“flat”、“diskANN”或“quantizedFlat”。 有关详细信息，请参阅Azure Cosmos DB中的矢量搜索，了解NoSQL。