Index 操作

更新时间：2025-01-14

创建索引

功能介绍

为指定数据表和指定字段新建索引，当前仅支持新建向量索引。

请求示例

                Typescript
                
            

                import {
    MochowClient,
    IndexSchema,
    IndexType,
    MetricType,
} from "@mochow/mochow-sdk-node";

const mochowClient = new MochowClient({
    credential: {
        account: "root",
        apiKey: "您的账户API密钥",
    },
    endpoint: "您的实例访问端点", // 例如：'http://127.0.0.1:5287'
});

let indexSchema: IndexSchema = {
    indexName: "vector_idx",
    field: "vector",
    indexType: IndexType.HNSW,
    metricType: MetricType.L2,
    params: {
        "M": 16,
        "efConstruction": 200
    }
}
let resp = await mochowClient.createIndex("db_test", "table_test", [indexSchema])
            

请求参数

参数	参数类型	是否必选	参数含义
database	String	是	库名。
table	String	是	表名。
indexes	List	是	索引定义。

删除索引

功能介绍

删除指定索引。

请求示例

                Typescript
                
            

                import {
    MochowClient,
} from "@mochow/mochow-sdk-node";

const mochowClient = new MochowClient({
    credential: {
        account: "root",
        apiKey: "您的账户API密钥",
    },
    endpoint: "您的实例访问端点", // 例如：'http://127.0.0.1:5287'
});

let resp = await mochowClient.dropIndex("db_test", "table_test", "idx_test")
            

请求参数

参数	参数类型	是否必选	参数含义
database	String	是	库名。
table	String	是	表名。
indexName	String	是	索引名称。

重建索引

功能介绍

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

请求示例

                Typescript
                
            

                import {
    MochowClient,
} from "@mochow/mochow-sdk-node";

const mochowClient = new MochowClient({
    credential: {
        account: "root",
        apiKey: "您的账户API密钥",
    },
    endpoint: "您的实例访问端点", // 例如：'http://127.0.0.1:5287'
});

let resp = await mochowClient.rebuildIndex("db_test", "table_test", "idx_test")
            

请求参数

参数	参数类型	是否必选	参数含义
database	String	是	库名。
table	String	是	表名。
indexName	String	是	索引名称。

查询索引详情

功能介绍

查询指定索引的详情。

请求示例

                Typescript
                
            

                import {
    MochowClient,
} from "@mochow/mochow-sdk-node";

const mochowClient = new MochowClient({
    credential: {
        account: "root",
        apiKey: "您的账户API密钥",
    },
    endpoint: "您的实例访问端点", // 例如：'http://127.0.0.1:5287'
});

let resp = await mochowClient.descIndex("db_test", "table_test", "idx_test")
            

请求参数

参数	参数类型	是否必选	参数含义
database	String	是	库名。
table	String	是	表名。
indexName	String	是	索引名称。

返回参数

参数	参数类型	参数含义
index	IndexSchema	Index对象。

IndexSchema

参数名称	参数类型	描述
indexName	String	索引名称。
indexType	String	索引类型。
metricType	String	向量索引的距离度量算法。
params	VectorIndexParams	向量构建索引所需参数。 HNSW索引构建参数，主要包含如下两个参数： 1. m：表示每个节点在检索构图中可以连接多少个邻居节点。取值为[4, 128]； 2. efconstruction：搜索时，指定寻找节点邻居遍历的范围。数值越大构图效果越好，构图时间越长。取值为[8, 1024]。 FLAT索引不含构建参数。 PUCK索引构建参数，主要包含如下两个参数： 1. coarseClusterCount：索引中粗聚类中心的个数； 2. fineClusterCount：每个粗聚类中心下细聚类中心个数。 HNSWPQ索引构建参数，主要包含如下四个参数： 1. m：表示每个节点在检索构图中可以连接多少个邻居节点。取值为[4, 128]； 2. efconstruction：搜索时，指定寻找节点邻居遍历的范围。数值越大构图效果越好，构图时间越长。取值为[8, 1024]； 3. NSQ：表示量化子空间个数，取值为[1, dim]，并且要求NSQ \| dim； 4. sampleRate：kmeans训练原始数据的抽样比率，取值为[0.0, 1.0]，抽样总数 10000 + (rowCount - 10000)*sampleRate
autoBuild	Boolean	是否自动构建索引，默认为False。
autoBuildPolicy	AutoBuildPolicy	自动构建索引策略，当前支持如下策略: AutoBuildTiming：定时构建，指定构建的时间，构建一次，不会重复构建。例如AutoBuildTiming("2026-09-11 23:07:00")，时间格式支持UTC及LOCAL。注意：此参数在 1.2 之后才支持。 AutoBuildPeriodical：周期性构建，每过period_s秒构建一次索引，可重复构建。可以指定从某个时间点开始，例如AutoBuildPeriodical(24 * 3600, "2026-09-11 23:07:00")。周期不能低于3600，时间格式支持LOCAL以及UTC。 AutoBuildRowCountIncrement：增量行数构建。Tablet（不是table）增加或者减少指定的行数时会自动构建一次索引，可重复构建，支持具体行数以及百分比，只需传入一种即可，也可传入两种，触发其中之一便会开始构建。例如AutoBuildRowCountIncrement(row_count_increment = 10000, row_count_increment_ratio = 0.5)。增量行数不低于10000，增量行数百分比需要大于0。
field	String	索引作用于的目标字段名称。
invertedIndexFields	List	倒排索引作用于的目标字段名称。
invertedIndexFieldAttributes	List	指定建立倒排索引的列是否需要分词(默认是会分词)，参数顺序应与'fields'里列名一一对应。目前支持以下选项: ATTRIBUTE_ANALYZED ATTRIBUTE_NOT_ANALYZED
filterIndexFields	List	Filtering索引作用于的目标字段名称。
state	IndexState	索引状态，返回值如下： BUILDING：表示索引正在构建中 NORMAL：表示索引已完成构建并处于正常状态

Row 操作

Java SDK

百度智能云

向量数据库 VectorDB

向量数据库 VectorDB

Index 操作

创建索引

功能介绍

请求示例

请求参数

删除索引

功能介绍

请求示例

请求参数

重建索引

功能介绍

请求示例

请求参数

查询索引详情

功能介绍

请求示例

请求参数

返回参数