Node.js SDK创建二级索引-表格存储 Tablestore(Tablestore)-阿里云帮助中心

二级索引相当于把数据表的主键查询能力扩展到了不同的列，当需要使用属性查询数据时，您可以通过创建二级索引加快数据查询的效率。设置预定义列后，在创建二级索引时将预定义列作为索引表的索引列或者属性列。创建二级索引后，您可以使用二级索引进行数据查询。

说明

二级索引包括全局二级索引和本地二级索引。关于二级索引的更多信息，请参见二级索引。
您也可以使用CreateTable接口在创建数据表的同时创建一个或者多个索引表。具体操作，请参见创建数据表。

前提条件

已初始化Client。具体操作，请参见初始化Tablestore Client。
已创建数据表，且数据表的最大版本数（maxVersions）必须为1，数据生命周期（timeToLive）必须满足如下条件中的任意一个。
- 数据表的数据生命周期为-1（数据永不过期）。
- 数据表的数据生命周期不为-1时，数据表为禁止更新状态。
数据表已设置预定义列。

功能说明

二级索引通过重新组合数据表的主键列和预定义列，为数据表提供不同于原主键的查询维度。二级索引分为全局二级索引和本地二级索引，两种索引的数据同步方式和主键要求不同。更多信息，请参见二级索引。

调用 createIndex 为已有数据表创建二级索引。如果需要在创建数据表时同时创建一个或多个二级索引，可在 createTable 请求中配置索引结构。具体操作，请参见创建数据表。

public CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest)
        throws TableStoreException, ClientException

以下示例为 example_table 创建全局二级索引 example_global_index。索引表包含存量数据。

IndexMeta indexMeta = new IndexMeta("example_global_index");
indexMeta.addPrimaryKeyColumn("category");
indexMeta.addDefinedColumn("status");

CreateIndexRequest request =
        new CreateIndexRequest("example_table", indexMeta, true);
client.createIndex(request);

参数

说明

mainTableName

数据表名称。

indexMeta

索引表的结构信息，包括如下内容：

name：索引表名称。
primaryKey：索引表的索引列，索引列为数据表主键和预定义列的组合。
使用本地二级索引时，索引表的第一个主键列必须与数据表的第一个主键列相同。
definedColumn：索引表的属性列，索引表属性列为数据表的预定义列的组合。
includeBaseData：索引表中是否包含数据表中已存在的数据。
当设置includeBaseData为true时，表示包含存量数据；设置includeBaseData为false时，表示不包含存量数据。
indexType：索引类型。可选值包括IT_GLOBAL_INDEX和IT_LOCAL_INDEX。
- 当不设置indexType或者设置indexType为IT_GLOBAL_INDEX时，表示使用全局二级索引。
  使用全局索引时，表格存储以异步方式将数据表中被索引的列和主键列的数据自动同步到索引表中，正常情况下同步延迟达到毫秒级别。
- 当设置indexType为IT_LOCAL_INDEX时，表示使用本地二级索引。
  使用本地二级索引时，表格存储以同步方式将数据表中被索引的列和主键列的数据自动同步到索引表中，当数据写入数据表后，即可从索引表中查询到数据。
indexUpdateMode：索引更新模式。可选值包括IUM_ASYNC_INDEX和IUM_SYNC_INDEX。
- 当不设置indexUpdateMode或者设置indexUpdateMode为IUM_ASYNC_INDEX时，表示异步更新。
  使用全局二级索引时，索引更新模式必须设置为异步更新（IUM_ASYNC_INDEX）。
- 当设置indexUpdateMode为IUM_SYNC_INDEX时，表示同步更新。
  使用本地二级索引时，索引更新模式必须设置为同步更新（IUM_SYNC_INDEX）。

示例

创建全局二级索引

以下示例用于在主键为pk1、pk2的数据表上创建主键列为col1，属性列为col2的索引表。该索引为全局二级索引且不包含存量数据。该索引表的完整主键为col1、pk1、pk2，属性列为col2。

var client = require('./client');
var TableStore = require('./index.js');

client.createIndex({
    mainTableName: "<TABLE_NAME>", //设置数据表名称。
    indexMeta: {
        name: "<INDEX_NAME>", //设置索引表名称。
        primaryKey: ["col1"], //为索引表添加主键列。
        definedColumn: ["col2"], //为索引表添加属性列。
        includeBaseData: false, //不包含存量数据。如果需要包含存量数据，请设置此参数为true。
        indexUpdateMode: TableStore.IndexUpdateMode.IUM_ASYNC_INDEX,//索引更新模式默认为异步更新（IUM_ASYNC_INDEX）。
        indexType: TableStore.IndexType.IT_GLOBAL_INDEX,//索引类型默认为全局二级索引（IT_GLOBAL_INDEX）。
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

创建本地二级索引

以下示例用于在主键为pk1、pk2的数据表上创建主键列为pk1、col1，属性列为col2的索引表。该索引为本地二级索引且不包括存量数据。该索引表的完整主键为pk1、col1、pk2，属性列为col2。

var client = require('./client');
var TableStore = require('./index.js');

client.createIndex({
    mainTableName: "<TABLE_NAME>", //设置数据表名称。
    indexMeta: {
        name: "<INDEX_TABLE>", //设置索引表名称。
        primaryKey: ["pk1","col1"], //为索引表添加主键列。索引表的第一列主键必须与数据表的第一列主键相同。
        definedColumn: ["col2"], //为索引表添加属性列。
        includeBaseData: false,  //不包含存量数据。如果需要包含存量数据，请设置此参数为true。
        indexUpdateMode: TableStore.IndexUpdateMode.IUM_SYNC_INDEX,//设置索引更新模式为同步更新（IUM_SYNC_INDEX）。当索引类型为本地二级索引时，索引更新模式必须为同步更新。
        indexType: TableStore.IndexType.IT_LOCAL_INDEX,//设置索引类型为本地二级索引（IT_LOCAL_INDEX）。
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

前提条件

功能说明

参数

示例

创建全局二级索引

创建本地二级索引

相关文档