Use Tablestore SDK for Node.js to create a data table - Tablestore

This topic describes how to use Tablestore SDK for Node.js to create a data table by using parameters and sample code. When you create a data table, you must specify the schema information and configuration information about the data table. You can specify the reserved read and write throughput for a data table in a high-performance instance.

Usage notes

After you create a data table, a few seconds are required to load the data table. During this period, all read and write operations on the data table fail. Perform operations on the data table after the data table is loaded.
In scenarios that require an auto-increment primary key column, such as item IDs on e-commerce websites and post IDs in forums, you can specify an auto-increment primary key column when you create a data table. For more information, see Configure an auto-increment primary key column.

Prerequisites

An instance is created in the Tablestore console. For more information, see Create an instance.
An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.

API operation

/**
 * Description: Create a data table based on the specified table schema. 
 * After you create a data table, several seconds are required to load the partitions in the data table. You can perform operations on the data table only after the partitions are loaded. 
 */
createTable(params, callback)

Parameters

The following table describes the parameters that are included in params.

Parameter	Description
tableMeta (required)	The schema information about the data table. You can configure the following parameters to specify the schema information: tableName: This parameter is required and specifies the name of the data table. primaryKey: This parameter is required and specifies the schema of the primary key for the data table. For more information, see Core components. The type of a primary key column can be String, Integer, or Binary. You can specify one to four primary key columns. Tablestore generates the primary key in the order in which the primary key columns are specified. By default, the rows in a data table are sorted in descending order by primary key. The first primary key column is the partition key. definedColumn: This parameter is optional and specifies the predefined columns of the data table. The type of a predefined column can be String, Integer, Double, or Boolean. Note Predefined columns are non-primary key columns that can be used as primary key columns or predefined columns of a secondary index that is created for the data table to accelerate data queries. You do not need to specify the schema of attribute columns when you create a data table. You can specify different numbers of attribute columns and different attribute column names for each row when you write data to a data table.
tableOptions (required)	The configuration information about the data table. You can configure the following parameters to specify the configuration information: timeToLive: This parameter is required and specifies the retention period of data in the data table. Unit: seconds. You can set this parameter to a value that is greater than or equal to 86400 or -1. A value of 86400 specifies one day. A value of -1 specifies that the data never expires. Important If you want to create a search index or secondary index for the data table, you must set this parameter to -1 or set the allowUpdate parameter to false. maxVersions: This parameter is required and specifies the maximum number of versions that can be retained for the data in each attribute column. Important If you want to create a search index or secondary index for the data table, you must set this parameter to 1. maxTimeDeviation: This parameter is optional and specifies the maximum difference between the current system time and the timestamp of the written data. Unit: seconds. Default value: 86400. The valid version range of data in an attribute column is a left-closed, right-open interval, which is calculated by using the following formula: Valid version range = `[max{Data write time - Max version offset, Data write time - TTL value}, Data write time + Max version offset)`. allowUpdate: This parameter is optional and specifies whether to allow update operations on the data table. Default value: true. Important If you want to use the time to live (TTL) feature of the search index that is created for the data table, you must set this parameter to false. If you want to update data in the data table, you can call the PutRow operation to write data to the data table.
indexMetas (optional)	The list of indexes. You can configure the following parameters for each index: name: This parameter is required and specifies the name of the index. primaryKey: This parameter is required and specifies the primary key columns of the index. The primary key columns of an index are a combination of primary key columns and predefined columns of the data table for which the index is created. Important If you want to create a local secondary index, the first primary key column of the index must be the first primary key column of the data table. definedColumn: This parameter is optional and specifies the predefined columns of the index. The predefined columns of an index are a combination of predefined columns of the data table for which the index is created. indexType: This parameter is optional and specifies the type of the index. Valid values: IT_GLOBAL_INDEX: global secondary index. This is the default value. IT_LOCAL_INDEX: local secondary index. indexUpdateMode: This parameter is optional and specifies the update mode of the index. Valid values: IUM_ASYNC_INDEX: asynchronous update mode. This is the default value. Note If you want to use the global secondary index feature, you must set the indexUpdateMode parameter to IUM_ASYNC_INDEX. IUM_SYNC_INDEX: synchronous update mode. Note If you want to use the local secondary index feature, you must set the indexUpdateMode parameter to IUM_SYNC_INDEX.
reservedThroughput (required)	The reserved read and write throughput. Unit: capacity unit (CU). Default value: 0. Important You can set the reserved read or write throughput to a value other than 0 only for a data table in a high-performance instance.
streamSpecification (optional)	The Stream configuration information about the data table. You can configure the following parameters to specify the Stream configuration information: enableStream: This parameter is optional and specifies whether to enable the Stream feature. Default value: false. A value of false specifies that the Stream feature is disabled. expirationTime: This parameter is optional and specifies the validity period of incremental logs. Unit: hours. Maximum value: 168. A value of 168 specifies seven days. Note When the Stream feature is enabled, you must configure the expirationTime parameter.

Examples

Create a data table

The following sample code provides an example on how to create a data table:

var params = {
  tableMeta: {
    // Specify the name of the data table. 
    tableName: '<TABLE_NAME>',
    // Specify the primary key columns of the data table. The table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type. The pk1 primary key column is the partition key. The pk2 primary key column is an auto-increment primary key column. 
    primaryKey: [
      {
        name: 'pk1',
        type: 'STRING'
      },
      {
        name: 'pk2',
        type: 'INTEGER',
        option: 'AUTO_INCREMENT'
      }
    ]
  },
  tableOptions: {
    // Specify the time to live (TTL) of data in the data table. A value of -1 specifies that data in the data table never expires. 
    timeToLive: -1,
    // Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column. 
    maxVersions: 1,
    // Specify the maximum difference between the current system time and the timestamp of the written data. In this example, the maximum difference is set to 86,400 seconds (one day). 
    maxTimeDeviation: 86400
  },
  // Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance. 
  reservedThroughput: {
    capacityUnit: {
      read: 0,
      write: 0
    }
  }
};

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

Create a data table and a secondary index

Create a data table and a global secondary index

The following sample code provides an example on how to create a data table and a global secondary index for the data table at the same time:

var params = {
  tableMeta: {
    // Specify the name of the data table.   
    tableName: '<TABLE_NAME>',
    // Specify the primary key columns of the data table. The data table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type. 
    primaryKey: [
      {
        name: 'pk1',
        type: 'STRING'
      },
      {
        name: 'pk2',
        type: 'INTEGER'
      }
    ],
    // Specify the predefined columns of the data table. The predefined columns of the data table are the defcol1 column of the String type and the defcol2 column of the Integer type. 
    definedColumn: [
      {
        name: 'defcol1',
        type: TableStore.DefinedColumnType.DCT_STRING
      },
      {
        name: 'defcol2',
        type: TableStore.DefinedColumnType.DCT_INTEGER
      }
    ],
  },
  tableOptions: {
    // Specify the TTL of data in the data table. A value of -1 specifies that data in the data table never expires. 
    timeToLive: -1,
    // Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column. 
    maxVersions: 1
  },
  // Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance. 
  reservedThroughput: {
    capacityUnit: {
      read: 0,
      write: 0
    }
  },
  indexMetas: [
    // By default, a global secondary index is created.
    {
      // Specify the name of the index. 
      name: '<INDEX_NAME>',
      // Add primary key columns to the index. The primary key columns of the index are defcol1, pk1, and pk2. 
      primaryKey: ['defcol1', 'pk1', 'pk2'],
      // Add predefined columns to the index. The predefined column of the index is defcol2. 
      definedColumn: ['defcol2']
    }
  ]
};

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

Create a data table and a local secondary index

The following sample code provides an example on how to create a data table and a local secondary index for the data table at the same time:

var params = {
  tableMeta: {
    // Specify the name of the data table.   
    tableName: '<TABLE_NAME>',
    // Specify the primary key columns of the data table. The data table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type. 
    primaryKey: [
      {
        name: 'pk1',
        type: 'STRING'
      },
      {
        name: 'pk2',
        type: 'INTEGER'
      }
    ],
    // Specify the predefined columns of the data table. The predefined columns of the data table are the defcol1 column of the String type and the defcol2 column of the Integer type. 
    definedColumn: [
      {
        name: 'defcol1',
        type: TableStore.DefinedColumnType.DCT_STRING
      },
      {
        name: 'defcol2',
        type: TableStore.DefinedColumnType.DCT_INTEGER
      }
    ],
  },
  tableOptions: {
    // Specify the TTL of data in the data table. A value of -1 specifies that data in the data table never expires. 
    timeToLive: -1,
    // Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column. 
    maxVersions: 1,
  },
  // Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance. 
  reservedThroughput: {
    capacityUnit: {
      read: 0,
      write: 0
    }
  },
  indexMetas: [
    // Specify the configurations of the local secondary index.
    {
      // Specify the name of the index. 
      name: '<INDEX_NAME>',
      // Add primary key columns to the index. The primary key columns of the index are pk1, defcol1, and pk2. 
      primaryKey: ['pk1', 'defcol1', 'pk2'],
      // Add predefined columns to the index. The predefined column of the index is defcol2. 
      definedColumn: ['defcol2'],
      // Set the index type to IT_LOCAL_INDEX. 
      indexType: TableStore.IndexType.IT_LOCAL_INDEX,
      // Set the index update mode to IUM_SYNC_INDEX. If you set the indexType parameter to IT_LOCAL_INDEX, you must set the indexUpdateMode parameter to IUM_SYNC_INDEX. 
      indexUpdateMode: TableStore.IndexUpdateMode.IUM_SYNC_INDEX
    }
  ]
};

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

References

For information about the API operation that you can call to create a data table, see CreateTable.
For information about data versions and TTL, secondary indexes, and reserved read and write throughput, see Data versions and TTL, Overview, and What is reserved read and write throughput?
After you create a data table, you can perform the following operations:
- Operations on the table. For more information, see Operations on tables.
- Operations on data. For more information, see Basic operations on data.