：建立多元索引

參數

說明

tableName

資料表名稱。

indexName

多元索引名稱。

fieldSchemas

fieldSchemas的列表，每個fieldSchema包含如下內容：

• fieldName（必選）：建立多元索引的欄位名，即列名，類型為String。

  多元索引中的欄位可以是主鍵列或者屬性列。

• fieldType（必選）：欄位類型，類型為TableStore.FieldType.XXX。更多資訊，請參見基礎資料類型及映射。

• index（可選）：是否開啟索引，類型為Boolean。

  預設為true，表示對該列構建倒排索引或者空間索引；如果設定為false，則不會對該列構建索引。

• analyzer（可選）：分詞器類型。當欄位類型為Text時，可以設定此參數；如果不設定，則預設分詞器類型為單字分詞。關於分詞的更多資訊，請參見分詞。

• analyzerParameter（可選）：分詞參數配置，請根據不同分詞器類型設定相應參數。更多資訊，請參見分詞。當為欄位配置了analyzer時，必須設定此參數。

• enableSortAndAgg（可選）：是否開啟排序與統計彙總功能，類型為Boolean。

  只有enableSortAndAgg設定為true的欄位才能進行排序。關於排序的更多資訊，請參見排序和翻頁。

  重要

  Nested類型的欄位不支援開啟排序與統計彙總功能，但是Nested類型內部的子列支援開啟排序與統計彙總功能。

• store（可選）：是否在多元索引中附加儲存該欄位的值，類型為Boolean。

  開啟後，可以直接從多元索引中讀取該欄位的值，而不必反查資料表，可用於查詢效能最佳化。

• isAnArray（可選）：是否為數組，類型為Boolean。

  如果設定為true，則表示該列是一個數組，在寫入時，必須按照JSON數組格式寫入，例如["a","b","c"]。

  由於Nested類型是一個數組，當fieldType為Nested類型時，無需設定此參數。

• fieldSchemas（可選）：當欄位類型為Nested類型時，需要通過此參數設定嵌套文檔中子列的索引類型，類型為fieldSchema的列表。

• isVirtualField（可選）：該欄位是否為虛擬列，類型為Boolean類型，預設值為false。如果要使用虛擬列，請設定此參數為true。關於虛擬列的更多資訊，請參見虛擬列。

• sourceFieldName（可選）：資料表中的欄位名稱，類型為String。當設定isVirtualField為true時，必須設定此參數。

• dateFormats（可選）：日期的格式，類型為String。當欄位類型為Date時，必須設定此參數。更多資訊，請參見日期時間類型。

• enableHighlighting（可選）：是否開啟查詢高亮功能，類型為Boolean。預設值為false，表示不開啟查詢高亮。如果要使用查詢高亮，請設定此參數為true。僅Text類型欄位支援查詢高亮功能。關於查詢高亮的更多資訊，請參見查詢高亮。

  重要

  • 目前此參數只支援通過SDK方式進行配置。

  • Table StoreNode.js SDK從5.5.0版本開始支援此功能。

• vectorOptions（可選）：向量欄位類型的屬性參數。當欄位類型為Vector時，必須設定此參數。包括如下內容：

  • dataType：向量資料類型。當前僅支援float32。如果有其他類型需求，請提交工單聯絡我們。

  • dimension：向量維度。關於維度限制說明請參見多元索引限制。

  • metricType：向量之間距離度量的演算法，支援歐氏距離（euclidean）、餘弦相似性（cosine）、點積（dot_product）。

    • 歐氏距離（euclidean）：多維空間中兩個向量之間的直線距離。出於效能考慮，Table Store中的歐氏距離演算法未進行最後的平方根計算。歐氏距離的評分越大表示兩個向量的相似性越大。

    • 餘弦相似性（cosine）：向量空間中兩個向量間夾角的餘弦值。餘弦相似性的評分越高表示兩個向量的相似性越大。常用於文本資料的相似性計算。

    • 點積（dot_product）：維度相同的兩個向量的對應座標相乘，然後將結果相加。點積的評分越高標識兩個向量的相似性越大。

    關於如何選用距離度量演算法的更多資訊，請參見附錄：距離度量演算法說明。

indexSetting

索引設定，包含routingFields設定。

routingFields（可選）：自訂路由欄位。可以選擇部分主鍵列作為路由欄位，在進行索引資料寫入時，會根據路由欄位的值計算索引資料的分布位置，路由欄位的值相同的記錄會被索引到相同的資料分區中。

indexSort

索引預排序設定，包含sorters設定。如果不設定，則預設按照主鍵排序。

timeToLive

選擇性參數，預設值為-1。資料生命週期（TTL），即資料的儲存時間。

當資料的儲存時間超過設定的資料生命週期時，系統會自動清理超過資料生命週期的資料。

資料生命週期至少為86400秒（一天）或-1（資料永不到期）。