創(chuàng)建多元索引
使用CreateSearchIndex接口在數(shù)據(jù)表上創(chuàng)建一個多元索引。一個數(shù)據(jù)表支持創(chuàng)建多個多元索引。創(chuàng)建多元索引時，您需要將要查詢的字段添加到多元索引中，您還可以配置多元索引路由鍵、預(yù)排序等高級選項。
前提條件
已初始化Client。具體操作，請參見初始化OTSClient。
已創(chuàng)建數(shù)據(jù)表，并且數(shù)據(jù)表的最大版本數(shù)（max Versions）必須為1，數(shù)據(jù)生命周期（Time to Live）必須滿足如下條件中的任意一個。具體操作，請參見創(chuàng)建數(shù)據(jù)表。
數(shù)據(jù)表的數(shù)據(jù)生命周期為-1（數(shù)據(jù)永不過期）。
數(shù)據(jù)表的數(shù)據(jù)生命周期不為-1時，數(shù)據(jù)表為禁止更新狀態(tài)（即是否允許更新為否）。
注意事項
創(chuàng)建多元索引時，多元索引中字段的數(shù)據(jù)類型必須與數(shù)據(jù)表中字段的數(shù)據(jù)類型相匹配。更多信息，請參見基礎(chǔ)數(shù)據(jù)類型及映射。
如果要修改多元索引為指定數(shù)據(jù)生命周期（即取值不為-1），則您必須禁用數(shù)據(jù)表的UpdateRow更新寫入功能。同時多元索引的TTL值必須小于或等于數(shù)據(jù)表的TTL值。更多信息，請參見生命周期管理。
參數(shù)
創(chuàng)建多元索引時，需要指定數(shù)據(jù)表名稱（tableName）、多元索引名稱（indexName）和索引的結(jié)構(gòu)信息（schema），其中schema包含fieldSchemas（Index的所有字段的設(shè)置）、indexSetting（索引設(shè)置）和indexSort（索引預(yù)排序設(shè)置）。詳細參數(shù)說明請參見下表。
參數(shù) | 說明 |
tableName | 數(shù)據(jù)表名稱。 |
indexName | 多元索引名稱。 |
fieldSchemas | fieldSchemas的列表，每個fieldSchema包含如下內(nèi)容：
|
indexSetting | 索引設(shè)置，包含routingFields設(shè)置。 routingFields（可選）：自定義路由字段。可以選擇部分主鍵列作為路由字段，在進行索引數(shù)據(jù)寫入時，會根據(jù)路由字段的值計算索引數(shù)據(jù)的分布位置，路由字段的值相同的記錄會被索引到相同的數(shù)據(jù)分區(qū)中。 |
indexSort | 索引預(yù)排序設(shè)置，包含sorters設(shè)置。如果不設(shè)置，則默認按照主鍵排序。 說明 含有Nested類型的索引不支持indexSort，沒有預(yù)排序。 sorters（必選）：索引的預(yù)排序方式，支持按照主鍵排序和字段值排序。關(guān)于排序的更多信息，請參見排序和翻頁。
|
timeToLive | 可選參數(shù)，默認值為-1。數(shù)據(jù)生命周期（TTL），即數(shù)據(jù)的保存時間。 當數(shù)據(jù)的保存時間超過設(shè)置的數(shù)據(jù)生命周期時，系統(tǒng)會自動清理超過數(shù)據(jù)生命周期的數(shù)據(jù)。 數(shù)據(jù)生命周期至少為86400秒（一天）或-1（數(shù)據(jù)永不過期）。 |
示例
創(chuàng)建多元索引時設(shè)置分詞
以下示例用于創(chuàng)建一個多元索引。該多元索引包括pic_id（Keyword類型）、count（Long類型）、time_stamp（Long類型）、pic_description（Text類型）、col_vector（Vector類型）、pos（Geo-point類型）、pic_tag（Nested類型）、date（Date類型）、analyzer_single_word（Text類型）、analyzer_split（Text類型）、analyzer_fuzzy（Text類型）列。其中pic_tag包括sub_tag_name（Keyword類型）和tag_name（Keyword類型）兩列，analyzer_single_word列使用的分詞類型為單字分詞，analyzer_split列使用的分詞類型為分隔符分詞，analyzer_fuzzy列使用的分詞類型為模糊分詞。
client.createSearchIndex({
tableName: "<TABLE_NAME>", //設(shè)置數(shù)據(jù)表名稱。
indexName: "<INDEX_NAME>", //設(shè)置多元索引名稱。
schema: {
fieldSchemas: [
{
fieldName: "pic_id",
fieldType: TableStore.FieldType.KEYWORD, // 設(shè)置字段名和字段類型。
index: true, // 設(shè)置開啟索引。
enableSortAndAgg: true, // 設(shè)置開啟排序和統(tǒng)計功能。
store: false,
isAnArray: false
},
{
fieldName: "count",
fieldType: TableStore.FieldType.LONG,
index: true,
enableSortAndAgg: true,
store: true,
isAnArray: false
},
{
fieldName: "time_stamp",
fieldType: TableStore.FieldType.LONG,
index: true,
enableSortAndAgg: false,
store: true,
isAnArray: false,
},
{
fieldName: "pic_description",
fieldType: TableStore.FieldType.TEXT,
index: true,
enableSortAndAgg: false,
store: true,
isAnArray: false,
},
{
fieldName: "col_vector",
fieldType: TableStore.FieldType.VECTOR,
index: true,
isAnArray: false,
vectorOptions: {
dataType: TableStore.VectorDataType.VD_FLOAT_32,
dimension: 4,
metricType: TableStore.VectorMetricType.VM_COSINE,
}
},
{
fieldName: "pos",
fieldType: TableStore.FieldType.GEO_POINT,
index: true,
enableSortAndAgg: true,
store: true,
isAnArray: false,
},
{
fieldName: "pic_tag",
fieldType: TableStore.FieldType.NESTED,
index: false,
enableSortAndAgg: false,
store: false,
fieldSchemas: [
{
fieldName: "sub_tag_name",
fieldType: TableStore.FieldType.KEYWORD,
index: true,
enableSortAndAgg: true,
store: false,
},
{
fieldName: "tag_name",
fieldType: TableStore.FieldType.KEYWORD,
index: true,
enableSortAndAgg: true,
store: false,
}
]
},
{
fieldName: "date",
fieldType: TableStore.FieldType.DATE,
index: true,
enableSortAndAgg: true,
store: true,
isAnArray: false,
dateFormats: ["yyyy-MM-dd'T'HH:mm:ss.SSSSSS"],
},
{
fieldName: "analyzer_single_word",
fieldType: TableStore.FieldType.TEXT,
analyzer: "single_word",
index: true,
enableSortAndAgg: false,
store: true,
isAnArray: false,
analyzerParameter: {
caseSensitive: true,
delimitWord: false,
}
},
{
fieldName: "analyzer_split",
fieldType: TableStore.FieldType.TEXT,
analyzer: "split",
index: true,
enableSortAndAgg: false,
store: true,
isAnArray: false,
analyzerParameter: {
delimiter: ",",
}
},
{
fieldName: "analyzer_fuzzy",
fieldType: TableStore.FieldType.TEXT,
analyzer: "fuzzy",
index: true,
enableSortAndAgg: false,
store: true,
isAnArray: false,
analyzerParameter: {
minChars: 1,
maxChars: 5,
}
},
],
indexSetting: { //索引的配置選項。
"routingFields": ["count", "pic_id"], //只支持將主鍵列設(shè)置為routingFields。
"routingPartitionSize": null
},
//indexSort: {//含有Nested類型的索引不支持indexSort，沒有預(yù)排序。
//sorters: [
// { //不設(shè)置indexSort時，默認為PrimaryKeySort（升序）排序。
// primaryKeySort: {
// order: TableStore.SortOrder.SORT_ORDER_ASC
// }
// },
//{
// fieldSort: {
// fieldName: "Col_Keyword",
// order: TableStore.SortOrder.SORT_ORDER_DESC //設(shè)置indexSort排序的順序。
// }
//}
//]
//},
timeToLive: 1000000, //單位為秒。
}
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:',data);
});創(chuàng)建多元索引時開啟查詢高
以下示例用于在創(chuàng)建多元索引時開啟查詢高亮。該多元索引包括k（Keyword類型）、t（Text類型）和n（Nested類型）三個字段，其中n字段包括nk（Keyword類型）、nl（Long類型）和nt（Text類型）三個子字段。同時為t字段和n字段中的nt子字段開啟查詢高亮功能。
client.createSearchIndex({
tableName: "<TABLE_NAME>", //設(shè)置數(shù)據(jù)表名稱。
indexName: "<SEARCH_INDEX_NAME>", //設(shè)置多元索引名稱。
schema: {
fieldSchemas: [
{
fieldName: "k",
fieldType: TableStore.FieldType.KEYWORD, // 設(shè)置字段名和字段類型。
index: true, // 設(shè)置開啟索引。
enableSortAndAgg: true, // 設(shè)置開啟排序和統(tǒng)計功能。
store: false,
isAnArray: false
},
{
fieldName: "t",
fieldType: TableStore.FieldType.TEXT,
index: true,
enableSortAndAgg: false,
enableHighlighting: true, //為字段開啟查詢高亮功能。
store: true,
isAnArray: false,
},
{
fieldName: "n",
fieldType: TableStore.FieldType.NESTED,
index: false,
enableSortAndAgg: false,
store: false,
fieldSchemas: [
{
fieldName: "nk",
fieldType: TableStore.FieldType.KEYWORD,
index: true,
enableSortAndAgg: true,
store: false,
},
{
fieldName: "nl",
fieldType: TableStore.FieldType.LONG,
index: true,
enableSortAndAgg: true,
store: false,
},
{
fieldName: "nt",
fieldType: TableStore.FieldType.TEXT,
index: true,
enableSortAndAgg: false,
enableHighlighting: true, //為字段開啟查詢高亮功能。
store: false,
},
]
},
],
indexSetting: { //索引的配置選項。
"routingFields": ["id"], //只支持將主鍵列設(shè)置為routingFields。
"routingPartitionSize": null
},
//indexSort: {//含有Nested類型的索引不支持indexSort，沒有預(yù)排序。
//sorters: [
// { //不設(shè)置indexSort時，默認為PrimaryKeySort（升序）排序。
// primaryKeySort: {
// order: TableStore.SortOrder.SORT_ORDER_ASC
// }
// },
//{
// fieldSort: {
// fieldName: "Col_Keyword",
// order: TableStore.SortOrder.SORT_ORDER_DESC //設(shè)置indexSort排序的順序。
// }
//}
//]
//},
timeToLive: 1000000, //單位為秒。
}
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:',data);
});常見問題
相關(guān)文檔
創(chuàng)建多元索引后，您可以選擇合適的查詢類型進行多維度數(shù)據(jù)查詢。多元索引查詢類型包括精確查詢、多詞精確查詢、全匹配查詢、匹配查詢、短語匹配查詢、前綴查詢、范圍查詢、通配符查詢、地理位置查詢、多條件組合查詢、向量檢索、嵌套類型查詢和列存在性查詢。
當通過Search接口查詢數(shù)據(jù)時，如果要對結(jié)果集進行排序或者翻頁，您可以使用排序和翻頁功能來實現(xiàn)。具體操作，請參見排序和翻頁。
當通過Search接口查詢數(shù)據(jù)時，如果要按照某一列對結(jié)果集做折疊，使對應(yīng)類型的數(shù)據(jù)在結(jié)果展示中只出現(xiàn)一次，您可以使用折疊（去重）功能來實現(xiàn)。具體操作，請參見折疊（去重）。
如果希望清理多元索引中的歷史數(shù)據(jù)或者希望延長數(shù)據(jù)保存時間，您可以修改多元索引的數(shù)據(jù)生命周期。具體操作，請參見更新多元索引信息。
如果要進行數(shù)據(jù)分析，例如求最值、求和、統(tǒng)計行數(shù)等，您可以使用Search接口的統(tǒng)計聚合功能或者SQL查詢來實現(xiàn)。具體操作，請參見統(tǒng)計聚合和SQL查詢。
如果要快速導(dǎo)出數(shù)據(jù)，而不關(guān)心整個結(jié)果集的順序時，您可以使用ParallelScan接口和ComputeSplits接口實現(xiàn)多并發(fā)導(dǎo)出數(shù)據(jù)。具體操作，請參見并發(fā)導(dǎo)出數(shù)據(jù)。
如果要在多元索引中新增、更新或者刪除索引列，您可以使用動態(tài)修改schema功能實現(xiàn)。具體操作，請參見動態(tài)修改schema。
如果要獲取某個數(shù)據(jù)表關(guān)聯(lián)的所有多元索引的列表信息，您可以使用列出多元索引列表功能實現(xiàn)。具體操作，請參見列出多元索引列表。
如果要查詢多元索引的描述信息，包括多元索引的字段信息和索引配置等，您可以使用查詢多元索引描述信息功能實現(xiàn)。具體操作，請參見查詢多元索引描述信息。
如果不再需要使用多元索引，您可以刪除多元索引。具體操作，請參見刪除多元索引。