使用CreateSearchIndex接口在數據表上創建一個多元索引。一個數據表支持創建多個多元索引。創建多元索引時,您需要將要查詢的字段添加到多元索引中,您還可以配置多元索引路由鍵、預排序等高級選項。
前提條件
已初始化Client。具體操作,請參見初始化OTSClient。
已創建數據表,并且數據表的最大版本數(max Versions)必須為1,數據生命周期(Time to Live)必須滿足如下條件中的任意一個。具體操作,請參見創建數據表。
數據表的數據生命周期為-1(數據永不過期)。
數據表的數據生命周期不為-1時,數據表為禁止更新狀態(即是否允許更新為否)。
注意事項
創建多元索引時,多元索引中字段的數據類型必須與數據表中字段的數據類型相匹配。更多信息,請參見基礎數據類型及映射。
如果要修改多元索引為指定數據生命周期(即取值不為-1),則您必須禁用數據表的UpdateRow更新寫入功能。同時多元索引的TTL值必須小于或等于數據表的TTL值。更多信息,請參見生命周期管理。
參數
創建多元索引時,需要指定數據表名稱(TableName)、多元索引名稱(IndexName)和索引的結構信息(IndexSchema),其中IndexSchema包含FieldSchemas(Index的所有字段的設置)、IndexSetting(索引設置)和IndexSort(索引預排序設置)。詳細參數說明請參見下表。
參數 | 說明 |
TableName | 數據表名稱。 |
IndexName | 多元索引名稱。 |
FieldSchemas | FieldSchema的列表,每個FieldSchema包含如下內容:
|
IndexSetting | 索引設置,包含RoutingFields設置。 RoutingFields(可選):自定義路由字段。可以選擇部分主鍵列作為路由字段,在進行索引數據寫入時,會根據路由字段的值計算索引數據的分布位置,路由字段的值相同的記錄會被索引到相同的數據分區中。 |
IndexSort | 索引預排序設置,包含Sorters設置。如果不設置,則默認按照主鍵排序。 說明 含有Nested類型的索引不支持IndexSort,沒有預排序。 Sorters(必選):索引的預排序方式,支持按照主鍵排序和字段值排序。關于排序的更多信息,請參見排序和翻頁。
|
TimeToLive | 可選參數,默認值為-1。數據生命周期(TTL),即數據的保存時間。 當數據的保存時間超過設置的數據生命周期時,系統會自動清理超過數據生命周期的數據。 數據生命周期至少為86400秒(一天)或-1(數據永不過期)。 多元索引生命周期的使用方式,請參見生命周期管理。 |
示例
創建多元索引時使用默認配置
以下示例用于創建一個多元索引。該多元索引包含col_keyword(Keyword類型)、col_long(Long類型)和col_vector(Vector類型)三列。
func createSearchIndex(client *tablestore.TableStoreClient) {
request := &tablestore.CreateSearchIndexRequest{}
request.TableName = "<TABLE_NAME>"
request.IndexName = "<SEARCH_INDEX_NAME>"
request.IndexSchema = &tablestore.IndexSchema{
FieldSchemas: []*tablestore.FieldSchema{
{
FieldName: proto.String("col_keyword"),
FieldType: tablestore.FieldType_KEYWORD, // 字符串類型
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
},
{
FieldName: proto.String("col_long"),
FieldType: tablestore.FieldType_LONG, // 數字類型
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
},
{
FieldName: proto.String("col_vector"),
FieldType: tablestore.FieldType_VECTOR, // 向量類型
Index: proto.Bool(true),
VectorOptions: &tablestore.VectorOptions{
VectorDataType: tablestore.VectorDataType_FLOAT_32.Enum(),
Dimension: proto.Int32(4), // 向量維度為4,相似度算法為點積
VectorMetricType: tablestore.VectorMetricType_DOT_PRODUCT.Enum(),
},
},
},
}
_, err := client.CreateSearchIndex(request)
if err != nil {
fmt.Println("Failed to create searchIndex with error:", err)
return
}
}
創建多元索引時指定IndexSort
以下示例用于創建一個多元索引,同時指定索引預排序。該多元索引包含col1(Keyword類型)和col2(Long類型)兩列。
func createSearchIndex_withIndexSort(client *tablestore.TableStoreClient){
request := &tablestore.CreateSearchIndexRequest{}
request.TableName = "<TABLE_NAME>" //設置數據表名稱。
request.IndexName = "<SEARCH_INDEX_NAME>" //設置多元索引名稱。
schemas := []*tablestore.FieldSchema{}
field1 := &tablestore.FieldSchema{
FieldName: proto.String("col1"), //設置字段名,使用proto.String用于獲取字符串指針。
FieldType: tablestore.FieldType_KEYWORD, //設置字段類型。
Index: proto.Bool(true), //設置開啟索引。
EnableSortAndAgg: proto.Bool(true), //設置開啟排序與統計聚合功能。
}
field2 := &tablestore.FieldSchema{
FieldName: proto.String("col2"),
FieldType: tablestore.FieldType_LONG,
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
}
schemas = append(schemas, field1, field2)
request.IndexSchema = &tablestore.IndexSchema{
FieldSchemas: schemas, //設置多元索引包含的字段。
IndexSort: &search.Sort{ // 指定索引預排序。先按照col2升序,再按照col1降序排序。
Sorters: []search.Sorter{
&search.FieldSort{
FieldName: "col2",
Order: search.SortOrder_ASC.Enum(),
},
&search.FieldSort{
FieldName: "col1",
Order: search.SortOrder_DESC.Enum(),
},
},
},
}
resp, err := client.CreateSearchIndex(request) //調用client創建多元索引。
if err != nil {
fmt.Println("error :", err)
return
}
fmt.Println("CreateSearchIndex finished, requestId:", resp.ResponseInfo.RequestId)
}
創建多元索引時設置數據生命周期
請確保數據表的更新狀態為禁止。
func createIndexWithTTL(client *tablestore.TableStoreClient) {
request := &tablestore.CreateSearchIndexRequest{}
request.TableName = "<TABLE_NAME>"
request.IndexName = "<SEARCH_INDEX_NAME>"
schemas := []*tablestore.FieldSchema{}
field1 := &tablestore.FieldSchema{
FieldName: proto.String("col1"), //設置字段名,使用proto.String用于獲取字符串指針。
FieldType: tablestore.FieldType_KEYWORD, //設置字段類型。
Index: proto.Bool(true), //設置開啟索引。
EnableSortAndAgg: proto.Bool(true), //設置開啟排序與統計聚合功能。
}
field2 := &tablestore.FieldSchema{
FieldName: proto.String("col2"),
FieldType: tablestore.FieldType_LONG,
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
}
schemas = append(schemas, field1, field2)
request.IndexSchema = &tablestore.IndexSchema{
FieldSchemas: schemas, //設置多元索引包含的字段。
}
request.TimeToLive = proto.Int32(3600 * 24 * 7) // 設置多元索引TTL為7天過期。
resp, err := client.CreateSearchIndex(request)
if err != nil {
fmt.Println("error :", err)
return
}
fmt.Println("createIndexWithTTL finished, requestId:", resp.ResponseInfo.RequestId)
}
創建多元索引時開啟查詢高亮
以下示例用于創建一個多元索引。該多元索引包含col_keyword(Keyword類型)、col_long(Long類型)、col_text(Text類型)和col_nested(Nested類型)四列,其中col_nested包括level1_text(Text類型)和level1_nested(Nested類型)兩個子列,level1_nested子列還包含了level2_text(Text類型)一個子列。同時為col_text列、col_nested中的level1_text列、col_nested.level1_nested中的level2_text列開啟查詢高亮功能。
func createSearchIndexwithHighlighting(client *tablestore.TableStoreClient) {
request := &tablestore.CreateSearchIndexRequest{}
request.TableName = "<TABLE_NAME>"
request.IndexName = "<SEARCH_INDEX_NAME>"
request.IndexSchema = &tablestore.IndexSchema{
FieldSchemas: []*tablestore.FieldSchema{
{
FieldName: proto.String("col_keyword"),
FieldType: tablestore.FieldType_KEYWORD, // 字符串類型。
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
},
{
FieldName: proto.String("col_long"),
FieldType: tablestore.FieldType_LONG, // 數字類型。
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
},
{//為非嵌套類型開啟查詢高亮功能。
FieldName: proto.String("col_text"),
FieldType: tablestore.FieldType_TEXT, // 可分詞字符串類型。
Index: proto.Bool(true),
EnableSortAndAgg: proto.Bool(true),
EnableHighlighting: proto.Bool(true),
},
{//為嵌套類型字段中的子列開啟查詢高亮功能。
FieldName: proto.String("col_nested"),
FieldType: tablestore.FieldType_NESTED,
FieldSchemas: []*tablestore.FieldSchema{
{
FieldName: proto.String("level1_text"),
FieldType: tablestore.FieldType_TEXT,
Index: proto.Bool(true),
EnableHighlighting: proto.Bool(true),
},
{
FieldName: proto.String("level1_nested"),
FieldType: tablestore.FieldType_NESTED,
FieldSchemas: []*tablestore.FieldSchema{
{
FieldName: proto.String("level2_text"),
FieldType: tablestore.FieldType_TEXT,
Index: proto.Bool(true),
EnableHighlighting: proto.Bool(true),
},
},
},
},
},
},
}
_, err := client.CreateSearchIndex(request)
if err != nil {
fmt.Println("Failed to create searchIndex with error:", err)
return
}
}
常見問題
相關文檔
創建多元索引后,您可以選擇合適的查詢類型進行多維度數據查詢。多元索引查詢類型包括精確查詢、多詞精確查詢、全匹配查詢、匹配查詢、短語匹配查詢、前綴查詢、范圍查詢、通配符查詢、地理位置查詢、多條件組合查詢、向量檢索、嵌套類型查詢和列存在性查詢。
當通過Search接口查詢數據時,如果要對結果集進行排序或者翻頁,您可以使用排序和翻頁功能來實現。具體操作,請參見排序和翻頁。
當通過Search接口查詢數據時,如果要按照某一列對結果集做折疊,使對應類型的數據在結果展示中只出現一次,您可以使用折疊(去重)功能來實現。具體操作,請參見折疊(去重)。
如果希望清理多元索引中的歷史數據或者希望延長數據保存時間,您可以修改多元索引的數據生命周期。具體操作,請參見生命周期管理。
如果要進行數據分析,例如求最值、求和、統計行數等,您可以使用Search接口的統計聚合功能或者SQL查詢來實現。具體操作,請參見統計聚合和SQL查詢。
如果要快速導出數據,而不關心整個結果集的順序時,您可以使用ParallelScan接口和ComputeSplits接口實現多并發導出數據。具體操作,請參見并發導出數據。
如果要在多元索引中新增、更新或者刪除索引列,您可以使用動態修改schema功能實現。具體操作,請參見動態修改schema。
如果要獲取某個數據表關聯的所有多元索引的列表信息,您可以使用列出多元索引列表功能實現。具體操作,請參見列出多元索引列表。
如果要查詢多元索引的描述信息,包括多元索引的字段信息和索引配置等,您可以使用查詢多元索引描述信息功能實現。具體操作,請參見查詢多元索引描述信息。
如果不再需要使用多元索引,您可以刪除多元索引。具體操作,請參見刪除多元索引。