使用CreateSearchIndex方法在資料表上建立一個多元索引。一個資料表支援建立多個多元索引。建立多元索引時，您需要將要查詢的欄位添加到多元索引中，您還可以配置多元索引路由鍵、預排序等進階選項。
前提條件
完成建立資料表，並且資料表同時滿足以下條件：
最大版本數必須為1。
資料生命週期為-1或者資料表為禁止更新狀態。
注意事項
介面
public class CreateSearchIndexRequest implements Request {
/**資料表名稱。*/
private String tableName;
/**多元索引名稱。*/
private String indexName;
/**多元索引的 schema 結構。*/
private IndexSchema indexSchema;
/**
* 一般情況下，不需要設定本欄位。
* 僅在動態修改多元索引 schema 的情境下，通過 setter 方法進行設定本欄位，作為重建索引的源索引名字。
*/
private String sourceIndexName;
/**索引資料的 TTL 時間，單位為秒。在多元索引建立後，該配置項可通過調用 UpdateSearchIndex 介面動態更改。*/
private Integer timeToLive;
}
public class IndexSchema implements Jsonizable {
/**關於某個 index 的設定。*/
private IndexSetting indexSetting;
/**該 index 的所有欄位的設定。*/
private List<FieldSchema> fieldSchemas;
/**自訂索引的預排序方式。*/
private Sort indexSort;
}參數
建立多元索引時，需要指定資料表名稱（tableName）、多元索引名稱（indexName）和索引的結構資訊（indexSchema），其中 indexSchema 包含 fieldSchemas（Index 所有欄位的設定）、indexSetting（索引設定）和 indexSort（索引預排序設定）。詳細參數說明請參見下表。
參數 | 說明 |
tableName | 資料表名稱。 |
indexName | 多元索引名稱。 |
fieldSchemas | 索引欄位列表，每個 fieldSchema 包含如下內容：
|
indexSetting | 索引設定，包含 routingFields 設定。 routingFields（可選）：自訂路由欄位。可以選擇部分主鍵列作為路由欄位，一般情況下只需要設定一個。如果設定多個路由鍵，系統會將多個路由鍵的值拼接成一個值。 在進行索引資料寫入時，系統會根據路由欄位的值計算索引資料的分布位置，路由欄位的值相同的記錄會被索引到相同的資料分區中。 |
indexSort | 索引預排序設定，包含 sorters 設定。如果不設定，則預設按照主鍵排序。 說明 含有 Nested 類型的索引不支援 indexSort，沒有預排序。 sorters（可選）：索引預排序方式的列表，支援按照主鍵排序和欄位值排序。關於排序的更多資訊，請參見排序和翻頁。
|
sourceIndexName | 選擇性參數。一般情況下，不需要設定本欄位。 僅在動態修改多元索引 schema 的情境下，通過 setter 方法設定本欄位，作為重建索引的源索引名字。 |
timeToLive | 選擇性參數。資料生命週期（TTL），即資料的儲存時間，單位為秒。 預設值為 -1，表示資料永不到期。資料生命週期的取值最低為 86400 秒（一天），也可設定為 -1（永不到期）。 當資料的儲存時間超過設定的資料生命週期時，系統會自動清理超過資料生命週期的資料。 關於多元索引生命週期的使用方式，請參見生命週期管理。 |
樣本
建立多元索引時使用預設配置
以下樣本用於建立一個多元索引。該多元索引包含 Col_Keyword（KEYWORD 類型）、Col_Long（LONG 類型）和 Col_Vector（VECTOR 類型）三列，按照資料表主鍵進行預排序且資料永不到期。
private static void createSearchIndex(SyncClient client) {
CreateSearchIndexRequest request = new CreateSearchIndexRequest();
//設定資料表名稱。
request.setTableName("<TABLE_NAME>");
//設定多元索引名稱。
request.setIndexName("<SEARCH_INDEX_NAME>");
IndexSchema indexSchema = new IndexSchema();
indexSchema.setFieldSchemas(Arrays.asList(
//設定欄位名和類型。
new FieldSchema("Col_Keyword", FieldType.KEYWORD),
new FieldSchema("Col_Long", FieldType.LONG),
// 設定向量類型。
new FieldSchema("Col_Vector", FieldType.VECTOR).setIndex(true)
// 向量維度為 4，相似性演算法為點積。
.setVectorOptions(new VectorOptions(VectorDataType.FLOAT_32, 4, VectorMetricType.DOT_PRODUCT))
));
request.setIndexSchema(indexSchema);
//調用 client 建立多元索引。
client.createSearchIndex(request);
}建立多元索引時指定IndexSort
以下樣本用於建立一個多元索引，該多元索引包含 Col_Keyword（KEYWORD 類型）、Col_Long（LONG 類型）、Col_Text（TEXT 類型）和 Timestamp（LONG 類型）四列，同時配置按照 Timestamp 列進行預排序。
private static void createSearchIndexWithIndexSort(SyncClient client) {
CreateSearchIndexRequest request = new CreateSearchIndexRequest();
//設定資料表名稱。
request.setTableName("<TABLE_NAME>");
//設定多元索引名稱。
request.setIndexName("<SEARCH_INDEX_NAME>");
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)
.setEnableSortAndAgg(true)));
//設定按照 Timestamp 列進行預排序。
indexSchema.setIndexSort(new Sort(
Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC))));
request.setIndexSchema(indexSchema);
//調用 client 建立多元索引。
client.createSearchIndex(request);
}建立多元索引時設定生命週期
請確保資料表的更新狀態為禁止。
以下樣本用於建立一個多元索引，該多元索引包含 Col_Keyword（KEYWORD 類型）和 Col_Long（LONG 類型）兩列，同時指定多元索引生命週期為 7 天。
// 請使用 5.12.0 及以上版本的 Java SDK。
public static void createIndexWithTTL(SyncClient client) {
int days = 7;
CreateSearchIndexRequest request = new CreateSearchIndexRequest();
//設定資料表名稱。
request.setTableName("<TABLE_NAME>");
//設定多元索引名稱。
request.setIndexName("<SEARCH_INDEX_NAME>");
IndexSchema indexSchema = new IndexSchema();
indexSchema.setFieldSchemas(Arrays.asList(
//設定欄位名和類型。
new FieldSchema("Col_Keyword", FieldType.KEYWORD),
new FieldSchema("Col_Long", FieldType.LONG)));
request.setIndexSchema(indexSchema);
//設定多元索引 TTL。
request.setTimeToLiveInDays(days);
//調用 client 建立多元索引。
client.createSearchIndex(request);
}建立多元索引時指定虛擬列
以下樣本用於建立一個多元索引，該多元索引包含 Col_Keyword（KEYWORD 類型）和 Col_Long（LONG 類型）兩列，同時建立虛擬列 Col_Keyword_Virtual_Long（LONG 類型）和 Col_Long_Virtual_Keyword（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("<TABLE_NAME>");
//設定多元索引名稱。
request.setIndexName("<SEARCH_INDEX_NAME>");
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 建立多元索引。
client.createSearchIndex(request);
}建立多元索引時開啟摘要與高亮
以下樣本用於建立一個多元索引，該多元索引包含Col_Keyword（KEYWORD 類型）、Col_Long（LONG 類型）和 Col_Text（TEXT 類型）三列，同時為 Col_Text 列開啟摘要與高亮功能。
private static void createSearchIndexwithHighlighting(SyncClient client) {
CreateSearchIndexRequest request = new CreateSearchIndexRequest();
//設定資料表名稱。
request.setTableName("<TABLE_NAME>");
//設定多元索引名稱。
request.setIndexName("<SEARCH_INDEX_NAME>");
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).setIndex(true).setEnableHighlighting(true)
));
request.setIndexSchema(indexSchema);
//調用 client 建立多元索引。
client.createSearchIndex(request);
}