表格存储 Node.js SDK 创建数据表_表格存储(Tablestore)-阿里云帮助中心

本文介绍如何通过Node.js SDK创建表格存储的数据表。

注意事项

创建数据表后，请等待数据表加载完成后再进行数据操作，否则数据操作会失败，这个过程通常需要几秒钟。

前提条件

方法说明

 createTable: function createTable(params, callback)

params参数说明

tableMeta（必选）object：表结构信息，包含以下参数。

名称	类型	说明
tableName（必选）	string	数据表名称。
primaryKey（必选）	Array	主键信息。可以设置1~4个主键列，默认按升序进行排序，第一个主键列将作为分区键。主键数据类型包含STRING、INTEGER和BINARY，非分区键中整型的主键列可以设置主键列自增。
definedColumn（可选）	Array	预定义列信息。预定义列是预先定义的属性列，可以用于创建二级索引和多元索引。预定义列数据类型包含STRING、INTEGER、DOUBLE和BOOLEAN。

tableOptions（必选）object：表配置信息，包含以下参数。

名称	类型	说明
timeToLive（必选）	number	数据生命周期，单位为秒。设置为-1时表示数据永不过期，否则取值最低为86400（1天），超出生命周期的数据将会被自动清除。如果要使用多元索引或二级索引功能，必须将数据生命周期设置为-1，或者将allowUpdate参数设置为false。
maxVersions（必选）	number	最大版本数。如果要使用多元索引或二级索引，最大版本数必须设置为1。
maxTimeDeviation（可选）	number	有效版本偏差，单位为秒，默认值为86400（1天）。写入数据的时间戳与系统当前时间的差值必须在有效版本偏差范围内，否则写入数据将会失败。属性列数据的有效版本范围为`[max(数据写入时间-有效版本偏差, 数据写入时间-数据生命周期), 数据写入时间+有效版本偏差)`。
allowUpdate（可选）	boolean	是否允许更新，默认值为true。设置为false时，无法通过`updateRow()`方法更新数据。

indexMetas（可选）Array：二级索引列表，每个索引包含以下参数。

名称	类型	说明
name（必选）	string	索引名称。
primaryKey（必选）	Array	索引的主键列。可以由数据表的主键列和预定义列组成。使用本地二级索引时，索引第一个主键列必须是数据表的第一个主键列。
definedColumn（可选）	Array	索引的预定义列。由数据表的预定义列组成。
indexType（可选）	number	索引类型，取值范围： IT_GLOBAL_INDEX（默认值）：全局二级索引。 IT_LOCAL_INDEX：本地二级索引。
indexUpdateMode（可选）	number	索引更新模式，取值范围： IUM_ASYNC_INDEX（默认值）：异步更新。全局二级索引的更新模式必须设置为异步更新。 IUM_SYNC_INDEX：同步更新。本地二级索引的更新模式必须设置为同步更新。

streamSpecification（可选）object：Stream配置信息，包含以下参数。

名称

类型

说明

enableStream（可选）

boolean

是否开启Stream，默认值为false。

expirationTime（可选）

number

Stream过期时间，表示增量日志过期时长。单位为小时，最大值为168（7天）。

enableStream设置为true时，必须设置expirationTime。

reservedThroughput（必选）object：预留读写吞吐量，单位为CU。仅CU模式的高性能型实例可以设置为非零值且有效。

示例代码

创建数据表

以下示例代码创建了一张test_table表，该表包含1个 String类型的主键。

var params = {
  // 数据表的结构信息
  tableMeta: {
    tableName: 'test_table',
    // 创建数据表至少需要添加一个主键
    primaryKey: [
      {
        name: 'id',
        type: 'STRING'
      }
    ],
    // （可选）添加预定义列
    definedColumn: [
      {
        name: 'name',
        type: TableStore.DefinedColumnType.DCT_STRING
      }
    ]
  },
  // 数据表的配置信息
  tableOptions: {
    // 创建数据表时必须指定数据生命周期，-1表示数据永不过期
    timeToLive: -1,
    // 创建数据表时必须指定最大版本数
    maxVersions: 1,
    // （可选）设置有效版本偏差
    maxTimeDeviation: 86400,
    // （可选）设置是否允许更新
    allowUpdate: true
  },
  // 创建数据表时必须设置预留读写吞吐量（仅CU模式高性能实例支持设置数据表的预留读写吞吐量为非零值）
  reservedThroughput: {
    capacityUnit: {
      read: 0,
      write: 0
    }
  },
  // （可选）设置Stream信息
  streamSpecification: {
    enableStream: true,
    expirationTime: 168
  }
};

client.createTable(params, function (err, data) {
  if (err) {
    console.error('error:', err);
    return;
  }
  console.log('success:', data);
});

创建数据表时配置二级索引

以下示例代码创建数据表并配置二级索引。

var params = {
    // 数据表结构信息
    tableMeta: {
        tableName: 'test_table',
        // 主键
        primaryKey: [
            {
                name: 'id',
                type: 'STRING'
            }
        ],
        // 预定义列
        definedColumn: [
            {
                name: 'name',
                type: TableStore.DefinedColumnType.DCT_STRING
            }
        ]
    },
    // 数据表配置信息
    tableOptions: {
        // 数据生命周期
        timeToLive: -1,
        // 最大版本数
        maxVersions: 1
    },
    // 预留读写吞吐量（仅CU模式高性能实例支持设置数据表的预留读写吞吐量为非零值）
    reservedThroughput: {
        capacityUnit: {
            read: 0,
            write: 0
        }
    },
    // 二级索引信息
    indexMetas: [
        {
            name: 'test_table_index',
            // 索引主键
            primaryKey: ['id'],
            // 索引预定义列
            definedColumn: ['name'],
            //索引类型
            indexType: TableStore.IndexType.IT_LOCAL_INDEX,
            //索引更新模式
            indexUpdateMode: TableStore.IndexUpdateMode.IUM_SYNC_INDEX
        }
    ]
};

client.createTable(params, function (err, data) {
    if (err) {
        console.error('error:', err);
        return;
    }
    console.log('success:', data);
});