建立多元索引 - Tablestore

使用CreateSearchIndex介面在資料表上建立一個多元索引。一個資料表可以建立多個多元索引。

前提條件

已初始化Client。具體操作，請參見初始化。
已建立資料表，且資料表的資料生命週期（timeToLive）必須為-1，最大版本數（maxVersions）必須為1。

參數

建立多元索引時，需要指定資料表名稱（tableName）、多元索引名稱（indexName）和索引的結構資訊（indexSchema），其中indexSchema包含fieldSchemas（Index的所有欄位的設定）、indexSetting（索引設定）、indexSort（索引預排序設定）和timeToLive（資料生命週期）。詳細參數說明請參見下表。


參數	說明
tableName	資料表名稱。
indexName	多元索引名稱。
fieldSchemas	fieldSchema的列表，每個fieldSchema包含如下內容： fieldName（必選）：建立多元索引的欄位名，即列名，類型為String。多元索引中的欄位可以是主鍵列或者屬性列。 fieldType（必選）：欄位類型，類型為FieldType.XXX。更多資訊，請參見資料類型映射。 array（可選）：是否為數組，類型為Boolean。如果設定為true，則表示該列是一個數組，在寫入時，必須按照JSON數組格式寫入，例如["a","b","c"]。由於Nested類型是一個數組，當fieldType為Nested類型時，無需設定此參數。 analyzer（可選）：分詞器類型。當欄位類型為Text時，可以設定此參數；如果不設定，則預設分詞器類型為單字分詞。關於分詞的更多資訊，請參見分詞。 isVirtualField（可選）：該欄位是否為虛擬列，類型為Boolean類型，預設值為false。只有使用虛擬列時，才需要設定此參數。關於虛擬列的更多資訊，請參見虛擬列。 sourceFieldName（可選）：資料表中的欄位名稱，類型為String。當設定isVirtualField為true時，必須設定此參數。 dateFormats（可選）：日期的格式，類型為String。當欄位類型為Date時，必須設定此參數。更多資訊，請參見日期資料類型。
indexSetting	索引設定，包含routingFields設定。 routingFields（可選）：自訂路由欄位。可以選擇部分主鍵列作為路由欄位，在進行索引資料寫入時，會根據路由欄位的值計算索引資料的分布位置，路由欄位的值相同的記錄會被索引到相同的資料分區中。
indexSort	索引預排序設定，包含sorters設定。如果不設定，則預設按照主鍵排序。说明含有Nested類型的索引不支援indexSort，沒有預排序。 sorters（可選）：索引的預排序方式，支援按照主鍵排序和欄位值排序。關於排序的更多資訊，請參見排序和翻頁。 PrimaryKeySort表示按照主鍵排序，包含如下設定： order：排序的順序，可按升序或者降序排序，預設為升序（SortOrder.ASC）。 FieldSort表示按照欄位值排序，包含如下設定：只有建立索引且開啟排序與統計彙總功能的欄位才能進行預排序。 fieldName：排序的欄位名。 order：排序的順序，可按照升序或者降序排序，預設為升序（SortOrder.ASC）。 mode：當欄位存在多個值時的排序方式。
timeToLive	選擇性參數，預設值為-1。資料生命週期（TTL），即資料的儲存時間。當資料的儲存時間超過設定的資料生命週期時，系統會自動清理超過資料生命週期的資料。資料生命週期至少為86400秒（一天）或-1（資料永不到期）。多元索引生命週期的使用方式，請參見多元索引生命週期。

樣本

建立多元索引。

建立一個多元索引，包含Col_Keyword和Col_Long兩列，類型分別設定為字串（String）和整型（Long）。

private static void createSearchIndex(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    request.setTableName(tableName); //設定資料表名稱。
    request.setIndexName(indexName); //設定多元索引名稱。
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            new FieldSchema("Col_Keyword", FieldType.KEYWORD), //設定欄位名和類型。
            new FieldSchema("Col_Long", FieldType.LONG)));
    request.setIndexSchema(indexSchema);
    client.createSearchIndex(request); //調用client建立多元索引。
}

建立多元索引時指定IndexSort。

private static void createSearchIndexWithIndexSort(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    request.setTableName(tableName); //設定資料表名稱。
    request.setIndexName(indexName); //設定多元索引名稱。
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            new FieldSchema("Col_Keyword", FieldType.KEYWORD),
            new FieldSchema("Col_Long", FieldType.LONG),
            new FieldSchema("Col_Text", FieldType.TEXT),
            new FieldSchema("Timestamp", FieldType.LONG)));
    //設定按照Timestamp列進行預排序。
    indexSchema.setIndexSort(new Sort(
            Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC))));
    request.setIndexSchema(indexSchema);
    client.createSearchIndex(request);
}

建立多元索引時設定生命週期

注意請確保資料表的更新狀態為禁止。

// 請使用5.12.0及以上版本的Java SDK。
public void createIndexWithTTL(SyncClient client) {
    int days = 7;
    CreateSearchIndexRequest createRequest = new CreateSearchIndexRequest();
    createRequest.setTableName(tableName);
    createRequest.setIndexName(indexName);
    createRequest.setIndexSchema(indexSchema);
    // 設定多元索引TTL。
    createRequest.setTimeToLiveInDays(days);
    client.createSearchIndex(createRequest);
}

建立多元索引時指定虛擬列。

建立一個多元索引，多元索引包含Col_Keyword和Col_Long兩列，同時建立虛擬列Col_Keyword_Virtual_Long和Col_Long_Virtual_Keyword。Col_Keyword_Virtual_Long映射為資料表中Col_Keyword列，虛擬列Col_Long_Virtual_Keyword映射為資料表中Col_Long列。

private static void createSearchIndex(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    request.setTableName(tableName); //設定資料表名稱。
    request.setIndexName(indexName); //設定多元索引名稱。
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
        new FieldSchema("Col_Keyword", FieldType.KEYWORD), //設定欄位名和類型。
        new FieldSchema("Col_Keyword_Virtual_Long", FieldType.LONG) //設定欄位名和類型。
            .setVirtualField(true) //設定欄位是否為虛擬列。
            .setSourceFieldName("Col_Keyword"), //虛擬列對應的資料表中欄位。
        new FieldSchema("Col_Long", FieldType.LONG),
        new FieldSchema("Col_Long_Virtual_Keyword", FieldType.KEYWORD)
            .setVirtualField(true)
            .setSourceFieldName("Col_Long")));
    request.setIndexSchema(indexSchema);
    client.createSearchIndex(request); //調用client建立多元索引。
}