Index 操作

更新时间：2026-09-01

创建索引

功能介绍

为指定表和指定字段新建索引。Table.create_indexes() 支持一次创建多个向量索引、标量二级索引、FILTERING 索引、PERSISTENT_BITMAP 索引、PERSISTENT_AGGREGATED_BITMAP 索引或倒排索引。

请求示例

                Python
                
            

                import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration
from pymochow.model.enum import IndexType, MetricType
from pymochow.model.schema import (
    AutoBuildPeriodical,
    HNSWParams,
    SecondaryIndex,
    VectorIndex,
)

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"  # 例如："http://127.0.0.1:5287"

config = Configuration(
    credentials=BceCredentials(account, api_key),
    endpoint=endpoint,
)
client = pymochow.MochowClient(config)
db = client.database("db_test")
table = db.table("book_vector")

indexes = [
    VectorIndex(
        index_name="vector_idx",
        index_type=IndexType.HNSW,
        field="vector",
        metric_type=MetricType.L2,
        params=HNSWParams(m=32, efconstruction=200),
        auto_build=True,
        auto_build_index_policy=AutoBuildPeriodical(
            5000, "2026-01-01 12:00:00"
        ),
        truncation_dimension=[0, 4],
    ),
    SecondaryIndex(index_name="book_name_idx", field="bookName"),
]
table.create_indexes(indexes)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
indexes	List<IndexField>	是	索引列表。支持 VectorIndex、SecondaryIndex、FilteringIndex、PersistentBitmapIndex、PersistentAggregatedBitmapIndex 和 InvertedIndex。
config	Configuration	否	本次请求使用的配置。

Index 参数

索引对象、字段类型和构建参数的完整说明请参见“Table 操作”的“创建表”章节。当前 SDK 的向量索引类型包括 FLAT、HNSW、HNSWPQ、HNSWSQ、HNSWRABITQ、PUCK、IVF、IVFSQ、IVFPQ、IVFRABITQ、DISKANN 和 SPARSE_OPTIMIZED_FLAT。

向量索引注意事项

HNSWRABITQ 使用 IndexType.HNSWRABITQ 和 HNSWRABITQParams(m, efconstruction)。
IVFSQ 使用 IVFSQParams(nlist, qtBits)，qtBits 支持 4、8、16。
VectorIndex.truncation_dimension 是与 params 同级的顶层参数，格式为 [begin, end)；需满足 0 <= begin < end <= dimension，有效维度为 end - begin。
truncation_dimension 仅支持 FLOAT_VECTOR 字段和 HNSW、HNSWRABITQ、HNSWPQ、HNSWSQ、IVF、IVFPQ、IVFSQ；HNSWPQ、IVFPQ 还要求有效维度能被 NSQ 整除。

FILTERING 与持久化 BITMAP 索引示例

                Python
                
            

                import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration
from pymochow.model.enum import IndexStructureType
from pymochow.model.schema import (
    FilteringIndex,
    PersistentAggregatedBitmapIndex,
    PersistentBitmapIndex,
)

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"

client = pymochow.MochowClient(
    Configuration(
        credentials=BceCredentials(account, api_key),
        endpoint=endpoint,
    )
)
table = client.database("db_test").table("book_vector")
table.create_indexes(
    [
        FilteringIndex.from_dict_list(
            index_name="filtering_idx",
            fields=[
                {
                    "field": "status",
                    "indexStructureType": IndexStructureType.BITMAP,
                },
                {
                    "field": "publishTime",
                    "indexStructureType": IndexStructureType.AGGREGATED_BITMAP,
                },
            ],
        ),
        PersistentBitmapIndex(
            index_name="status_persistent_bitmap_idx",
            field="status",
        ),
        PersistentAggregatedBitmapIndex(
            index_name="publish_time_persistent_aggregated_bitmap_idx",
            field="publishTime",
            fanout_bits=4,
            max_depth=10,
        ),
    ]
)

client.close()
            

索引	参数与约束
FILTERING DEFAULT / BITMAP	FILTERING 的内存结构；BITMAP 适用于值种类较少的列。
FILTERING AGGREGATED_BITMAP	内存结构，除等值过滤外还可加速 `>`、`>=`、`<`、`<=`；仅支持 INT8、UINT8、INT16、UINT16、INT32、UINT32、INT64、UINT64、FLOAT、DOUBLE、DATE、DATETIME、TIMESTAMP。
PERSISTENT_BITMAP	独立的持久化索引类型，不是 FILTERING 的结构选项，适用于等值过滤。
PERSISTENT_AGGREGATED_BITMAP	独立的持久化聚合索引类型，不是 FILTERING 的结构选项，支持等值和范围过滤。必须指定 `field`、`fanout_bits`、`max_depth`；后二者范围分别为 `[1, 10]`、`[2, 30]`，且满足 `fanout_bits * (max_depth - 1) <= 64`。

创建倒排索引

倒排索引用于 BM25 全文检索和 Hybrid 混合检索。

                Python
                
            

                import time

import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration
from pymochow.model.enum import (
    IndexState,
    InvertedIndexAnalyzer,
    InvertedIndexFieldAttribute,
    InvertedIndexParseMode,
    StopWordsMode,
)
from pymochow.model.schema import (
    InvertedIndex,
    InvertedIndexParams,
    StopWordsParams,
)

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"

client = pymochow.MochowClient(
    Configuration(
        credentials=BceCredentials(account, api_key),
        endpoint=endpoint,
    )
)
table = client.database("db_test").table("book_vector")
index_name = "segment_inverted_idx"

table.create_indexes(
    [
        InvertedIndex(
            index_name=index_name,
            fields=["segment"],
            params=InvertedIndexParams(
                analyzer=InvertedIndexAnalyzer.DEFAULT_ANALYZER,
                parse_mode=InvertedIndexParseMode.COARSE_MODE,
                case_sensitive=True,
                stop_words=StopWordsParams(
                    mode=StopWordsMode.CUSTOM,
                    words=["呀", "啊", "哦"],
                ),
            ),
            field_attributes=[InvertedIndexFieldAttribute.ANALYZED],
        )
    ]
)

# 倒排索引异步构建完成后才能进行 BM25/Hybrid 检索。
while True:
    index = table.describe_index(index_name)
    if index.state == IndexState.NORMAL:
        break
    time.sleep(2)

client.close()
            

InvertedIndex 参数

参数	参数类型	是否必选	参数含义
index_name	String	是	索引名称。
fields	List<String>	是	目标字段。协议支持 TEXT、TEXT_GBK、TEXT_GB18030、ARRAY<TEXT> 和 JSON；当前 SDK 的属性枚举仅暴露文本字段属性。
params	InvertedIndexParams	是	分词器、分词模式、大小写和停用词配置。
field_attributes	List<InvertedIndexFieldAttribute>	否	与 `fields` 一一对应；支持 ANALYZED、NOT_ANALYZED。

InvertedIndexParams 参数

参数	参数类型	是否必选	参数含义
analyzer	InvertedIndexAnalyzer	否	ENGLISH_ANALYZER、CHINESE_ANALYZER 或 DEFAULT_ANALYZER。
parse_mode	InvertedIndexParseMode	否	COARSE_MODE 或 FINE_MODE。
case_sensitive	Boolean	否	是否大小写敏感，默认值为 `True`。
stop_words	StopWordsParams	否	停用词配置。

StopWordsParams.mode 支持 DEFAULT、CUSTOM、NONE。CUSTOM 必须提供非空 words，每项为单个 term；未配置等价于 DEFAULT。停用词只能在建表或创建索引时设置，不能原地修改，检索时也不能临时覆盖。

倒排索引异步构建：

IndexState.BUILDING：不能用于 BM25/Hybrid，检索返回错误码 95（Index Building），并且索引不可删除。
IndexState.NORMAL：构建完成，可以用于 BM25/Hybrid。

删除索引

功能介绍

删除指定索引。支持向量索引、SECONDARY、FILTERING、PERSISTENT_BITMAP、PERSISTENT_AGGREGATED_BITMAP 和倒排索引，也支持删除 2.4 之前创建的旧全文索引。BUILDING 状态的索引不能删除。

请求示例

                Python
                
            

                import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"  # 例如："http://127.0.0.1:5287"

config = Configuration(
    credentials=BceCredentials(account, api_key),
    endpoint=endpoint,
)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
table.drop_index("vector_idx")

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
index_name	String	是	指定索引的名称。
config	Configuration	否	本次请求使用的配置。

重建向量索引

功能介绍

重建指定索引，当前仅支持重建向量索引。

请求示例

                Python
                
            

                import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"  # 例如："http://127.0.0.1:5287"

config = Configuration(
    credentials=BceCredentials(account, api_key),
    endpoint=endpoint,
)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
table.rebuild_index(index_name="vector_idx")

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
index_name	String	是	向量索引的名称。
config	Configuration	否	本次请求使用的配置。

查询索引详情

功能介绍

查询指定索引的详情，返回与索引类型对应的 SDK 对象。

请求示例

                Python
                
            

                import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"  # 例如："http://127.0.0.1:5287"

config = Configuration(
    credentials=BceCredentials(account, api_key),
    endpoint=endpoint,
)
client = pymochow.MochowClient(config)

db = client.database("db_test")
table = db.table("book_vector")
index = table.describe_index(index_name="vector_idx")
print(index.index_name, index.index_type)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
index_name	String	是	指定索引的名称。
config	Configuration	否	本次请求使用的配置。

返回参数

参数	参数类型	参数含义
index	IndexField	与索引类型对应的 SDK 索引对象。

Index 参数

索引类型	返回对象	当前 SDK 实际解析的参数
向量索引	VectorIndex	`index_name`、`index_type`、`field`、`metric_type`、`params`、`auto_build`、`auto_build_index_policy`、`state`。
SECONDARY	SecondaryIndex	`index_name`、`index_type`、`field`。
FILTERING	FilteringIndex	`index_name`、`index_type`、字段定义；字段可通过 `to_dict()["fields"]` 查看。
PERSISTENT_BITMAP	PersistentBitmapIndex	`index_name`、`index_type`、`field`。
PERSISTENT_AGGREGATED_BITMAP	PersistentAggregatedBitmapIndex	`index_name`、`index_type`、`field`，以及服务端返回的 `fanoutBits`、`maxDepth`（可通过 `to_dict()` 查看）。
INVERTED	InvertedIndex	`index_name`、`index_type`、字段、基础 `analyzer` / `parse_mode` 参数对象和 `state`。

VectorIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
index_type	IndexType	索引类型。
field	String	索引作用于的字段名称。
metric_type	MetricType	向量距离度量类型：L2、IP 或 COSINE。
params	Params	向量索引构建参数。
auto_build	Boolean	是否启用自动构建。
auto_build_index_policy	AutoBuildPolicy	自动构建索引策略。
state	IndexState	BUILDING 表示正在构建；NORMAL 表示构建完成并处于正常状态。

SecondaryIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
field	String	索引作用于的字段名称。

FilteringIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
fields	List<Dict>	索引字段及其 `indexStructureType`；通过 `to_dict()["fields"]` 查看。

PersistentBitmapIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
field	String	索引作用于的字段名称。

PersistentAggregatedBitmapIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
field	String	索引作用于的字段名称。
fanoutBits	Int	服务端返回的扇出位数；通过 `to_dict()` 查看。
maxDepth	Int	服务端返回的最大深度；通过 `to_dict()` 查看。

InvertedIndex 参数

参数	参数类型	参数含义
index_name	String	索引名称。
fields	List<String>	索引作用于的字段名称；包含在对象序列化结果中。
params	InvertedIndexParams	当前 SDK 仅从返回值解析基础 `analyzer` 和 `parse_mode`。
state	IndexState	BUILDING 或 NORMAL。

当前 Python SDK 的 describe_index() 不会恢复倒排索引的 stop_words、case_sensitive 和 field_attributes，请勿依赖该方法读取这些创建参数。它在构造向量索引对象时也不会恢复 truncation_dimension；该参数可用于创建索引，但不能通过当前返回对象读取。

修改索引

功能介绍

修改向量索引信息，目前支持修改 auto_build 属性和自动构建策略。

请求示例

                Python
                
            

                import time

import pymochow
from pymochow.auth.bce_credentials import BceCredentials
from pymochow.configuration import Configuration
from pymochow.model.enum import (
    FieldType,
    IndexType,
    MetricType,
    TableState,
)
from pymochow.model.schema import (
    AutoBuildTiming,
    Field,
    HNSWParams,
    Schema,
    VectorIndex,
)
from pymochow.model.table import Partition

account = "root"
api_key = "您的账户API密钥"
endpoint = "您的实例访问端点"  # 例如："http://127.0.0.1:5287"

config = Configuration(
    credentials=BceCredentials(account, api_key),
    endpoint=endpoint,
)
client = pymochow.MochowClient(config)

database_name = "book"
table_name = "book_segments"
db = client.create_database(database_name)

fields = [
    Field(
        "id",
        FieldType.STRING,
        primary_key=True,
        partition_key=True,
        auto_increment=False,
        not_null=True,
    ),
    Field("bookName", FieldType.STRING, not_null=True),
    Field("vector", FieldType.FLOAT_VECTOR, not_null=True, dimension=3),
]
db.create_table(
    table_name=table_name,
    replication=2,
    partition=Partition(partition_num=3),
    schema=Schema(fields=fields, indexes=[]),
)

while True:
    time.sleep(2)
    table = db.describe_table(table_name)
    if table.state == TableState.NORMAL:
        break

table = db.table(table_name)
indexes = [
    VectorIndex(
        index_name="vector_idx",
        index_type=IndexType.HNSW,
        field="vector",
        metric_type=MetricType.L2,
        params=HNSWParams(m=32, efconstruction=200),
    )
]
table.create_indexes(indexes)
table.modify_index(
    index_name="vector_idx",
    auto_build=True,
    auto_build_index_policy=AutoBuildTiming("2026-09-11 23:07:00"),
)

client.close()
            

请求参数

参数	参数类型	是否必选	参数含义
index_name	String	是	向量索引名称。
auto_build	Boolean	是	是否自动构建索引。
auto_build_index_policy	AutoBuildPolicy	否	自动构建策略。支持 AutoBuildTiming、AutoBuildPeriodical 和 AutoBuildRowCountIncrement；`auto_build=True` 时发送。未传时使用 SDK 默认的 24 小时周期策略。
config	Configuration	否	本次请求使用的配置。

评价此篇文章

有帮助没帮助

Row 操作

Go SDK

百度智能云

向量数据库 VectorDB

向量数据库 VectorDB

Index 操作

创建索引

功能介绍

请求示例

请求参数

向量索引注意事项

FILTERING 与持久化 BITMAP 索引示例

创建倒排索引

删除索引

功能介绍

请求示例

请求参数

重建向量索引

功能介绍

请求示例

请求参数

查询索引详情

功能介绍

请求示例

请求参数

返回参数

修改索引

功能介绍

请求示例

请求参数