Node.js SDK建立二級索引 - Tablestore

二級索引相當於把資料表的主鍵查詢能力擴充到了不同的列，當需要使用屬性查詢資料時，您可以通過建立二級索引加快資料查詢的效率。設定預定義列後，在建立二級索引時將預定義列作為索引表的索引列或者屬性列。建立二級索引後，您可以使用二級索引進行資料查詢。

說明

二級索引包括全域二級索引和本地二級索引。關於二級索引的更多資訊，請參見二級索引。
您也可以使用CreateTable介面在建立資料表的同時建立一個或者多個索引表。具體操作，請參見建立資料表。

前提條件

已初始化Client。具體操作，請參見初始化Client。
已建立資料表，且資料表的最大版本數（maxVersions）必須為1，資料生命週期（timeToLive）必須滿足如下條件中的任意一個。
- 資料表的資料生命週期為-1（資料永不到期）。
- 資料表的資料生命週期不為-1時，資料表為禁止更新狀態。
資料表已設定預定義列。

注意事項

索引表名稱不能與已存在的時序表名稱和資料表名稱相同。
建立二級索引時，系統會自動將未出現在索引列中的資料表主鍵補齊到索引表主鍵中。
建立本地二級索引時，索引表的第一列主鍵必須與資料表的第一列主鍵相同。

參數

說明

mainTableName

資料表名稱。

indexMeta

索引表的結構資訊，包括如下內容：

name：索引表名稱。
primaryKey：索引表的索引列，索引列為資料表主鍵和預定義列的組合。
使用本地二級索引時，索引表的第一個主鍵列必須與資料表的第一個主鍵列相同。
definedColumn：索引表的屬性列，索引表屬性列為資料表的預定義列的組合。
includeBaseData：索引表中是否包含資料表中已存在的資料。
當設定includeBaseData為true時，表示包含存量資料；設定includeBaseData為false時，表示不包含存量資料。
indexType：索引類型。可選值包括IT_GLOBAL_INDEX和IT_LOCAL_INDEX。
- 當不設定indexType或者設定indexType為IT_GLOBAL_INDEX時，表示使用全域二級索引。
  使用全域索引時，Table Store以非同步方式將資料表中被索引的列和主鍵列的資料自動同步到索引表中，正常情況下同步延遲達到毫秒層級。
- 當設定indexType為IT_LOCAL_INDEX時，表示使用本地二級索引。
  使用本地二級索引時，Table Store以同步方式將資料表中被索引的列和主鍵列的資料自動同步到索引表中，當資料寫入資料表後，即可從索引表中查詢到資料。
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));
});

Tablestore：建立二級索引

前提條件

注意事項

參數

樣本

建立全域二級索引

建立本地二級索引

相關文檔