概述

使用全局索引的API都在类“com.huawei.boostkit.hindex.GlobalIndexAdmin”中,相关接口介绍如下表1所示。

表1 全局索引API

操作

接口

描述

添加索引

addIndices()

以withoutData模式创建索引。调用此接口会将用户指定的索引添加到表中,但会跳过生成索引数据。该接口的使用场景为用户想要为具有大量数据的表(20GB以上)添加索引,然后使用GlobalTableIndexer工具来填充索引数据。

addIndicesWithData()

以withData模式创建索引。调用此接口会将用户指定的索引添加到表中,并会根据已经存在的用户数据填充对应的索引数据。当数据表中存在大量数据(20GB以上)时,不建议使用此接口。

删除索引

dropIndices()

删除索引,索引元数据与索引表均会被删除,在此操作之后,被删除的索引不能用于scan/filter操作。

修改索引状态

alterGlobalIndicesUnusable()

禁用用户指定的索引,使其不再可用于scan/filter操作。

alterGlobalIndicesActive()

启用用户指定的索引,使其可用于scan/filter操作。

alterGlobalIndicesInactive()

禁用用户指定的索引,且该索引表不会正常更新数据,不可用于scan/filter操作,通常用于索引重建流程。

查看已创建的索引

listIndices()

用于列出给定数据表所有索引的相关信息。