使用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)
}常见问题
相关文档
创建多元索引后，您可以选择合适的查询类型进行多维度数据查询。多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、地理位置查询、多条件组合查询、向量检索、嵌套类型查询和列存在性查询。
当通过Search接口查询数据时，如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。
当通过Search接口查询数据时，如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。
如果希望清理多元索引中的历史数据或者希望延长数据保存时间，您可以修改多元索引的数据生命周期。具体操作，请参见生命周期管理。
如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。
如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。
如果要在多元索引中新增、更新或者删除索引列，您可以使用动态修改schema功能实现。具体操作，请参见动态修改schema。
如果要获取某个数据表关联的所有多元索引的列表信息，您可以使用列出多元索引列表功能实现。具体操作，请参见列出多元索引列表。
如果要查询多元索引的描述信息，包括多元索引的字段信息和索引配置等，您可以使用查询多元索引描述信息功能实现。具体操作，请参见查询多元索引描述信息。
如果不再需要使用多元索引，您可以删除多元索引。具体操作，请参见删除多元索引。