使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表支持创建多个多元索引。创建多元索引时，您需要将要查询的字段添加到多元索引中，您还可以配置多元索引路由键、预排序等高级选项。
前提条件
已初始化Client。具体操作，请参见初始化OTSClient。
已创建数据表，并且数据表的最大版本数（max Versions）必须为1，数据生命周期（Time to Live）必须满足如下条件中的任意一个。具体操作，请参见创建数据表。
数据表的数据生命周期为-1（数据永不过期）。
数据表的数据生命周期不为-1时，数据表为禁止更新状态（即是否允许更新为否）。
注意事项
创建多元索引时，多元索引中字段的数据类型必须与数据表中字段的数据类型相匹配。更多信息，请参见基础数据类型及映射。
如果要修改多元索引为指定数据生命周期（即取值不为-1），则您必须禁用数据表的UpdateRow更新写入功能。同时多元索引的TTL值必须小于或等于数据表的TTL值。更多信息，请参见生命周期管理。
参数
创建多元索引时，需要指定数据表名称（tableName）、多元索引名称（indexName）和索引的结构信息（schema），其中schema包含fieldSchemas（Index的所有字段的设置）、indexSetting（索引设置）和indexSort（索引预排序设置）。详细参数说明请参见下表。
参数 | 说明 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
fieldSchemas | fieldSchemas的列表，每个fieldSchema包含如下内容：
|
indexSetting | 索引设置，包含routingFields设置。 routingFields（可选）：自定义路由字段。可以选择部分主键列作为路由字段，在进行索引数据写入时，会根据路由字段的值计算索引数据的分布位置，路由字段的值相同的记录会被索引到相同的数据分区中。 |
indexSort | 索引预排序设置，包含sorters设置。如果不设置，则默认按照主键排序。 说明 含有Nested类型的索引不支持indexSort，没有预排序。 sorters（必选）：索引的预排序方式，支持按照主键排序和字段值排序。关于排序的更多信息，请参见排序和翻页。
|
timeToLive | 可选参数，默认值为-1。数据生命周期（TTL），即数据的保存时间。 当数据的保存时间超过设置的数据生命周期时，系统会自动清理超过数据生命周期的数据。 数据生命周期至少为86400秒（一天）或-1（数据永不过期）。 |
示例
创建多元索引时设置分词
以下示例用于创建一个多元索引。该多元索引包括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>", //设置数据表名称。
indexName: "<INDEX_NAME>", //设置多元索引名称。
schema: {
fieldSchemas: [
{
fieldName: "pic_id",
fieldType: TableStore.FieldType.KEYWORD, // 设置字段名和字段类型。
index: true, // 设置开启索引。
enableSortAndAgg: true, // 设置开启排序和统计功能。
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"], //只支持将主键列设置为routingFields。
"routingPartitionSize": null
},
//indexSort: {//含有Nested类型的索引不支持indexSort，没有预排序。
//sorters: [
// { //不设置indexSort时，默认为PrimaryKeySort（升序）排序。
// primaryKeySort: {
// order: TableStore.SortOrder.SORT_ORDER_ASC
// }
// },
//{
// fieldSort: {
// fieldName: "Col_Keyword",
// order: TableStore.SortOrder.SORT_ORDER_DESC //设置indexSort排序的顺序。
// }
//}
//]
//},
timeToLive: 1000000, //单位为秒。
}
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:',data);
});创建多元索引时开启查询高
以下示例用于在创建多元索引时开启查询高亮。该多元索引包括k（Keyword类型）、t（Text类型）和n（Nested类型）三个字段，其中n字段包括nk（Keyword类型）、nl（Long类型）和nt（Text类型）三个子字段。同时为t字段和n字段中的nt子字段开启查询高亮功能。
client.createSearchIndex({
tableName: "<TABLE_NAME>", //设置数据表名称。
indexName: "<SEARCH_INDEX_NAME>", //设置多元索引名称。
schema: {
fieldSchemas: [
{
fieldName: "k",
fieldType: TableStore.FieldType.KEYWORD, // 设置字段名和字段类型。
index: true, // 设置开启索引。
enableSortAndAgg: true, // 设置开启排序和统计功能。
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"], //只支持将主键列设置为routingFields。
"routingPartitionSize": null
},
//indexSort: {//含有Nested类型的索引不支持indexSort，没有预排序。
//sorters: [
// { //不设置indexSort时，默认为PrimaryKeySort（升序）排序。
// primaryKeySort: {
// order: TableStore.SortOrder.SORT_ORDER_ASC
// }
// },
//{
// fieldSort: {
// fieldName: "Col_Keyword",
// order: TableStore.SortOrder.SORT_ORDER_DESC //设置indexSort排序的顺序。
// }
//}
//]
//},
timeToLive: 1000000, //单位为秒。
}
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:',data);
});常见问题
多元索引路由字段的使用
使用GetRange接口和Search接口范围查询数据时的区别
表格存储是否支持存储JSON数据？
使用多元索引Search接口查不到数据
如何查看表的总行数
表格存储是否支持类似关系数据库的in和between...and查询
如何将多元索引Search接口查询数据的limit提高到1000
如何批量删除数据
使用多元索引时出现field:xx must enable enable_sort_and_agg异常
相关文档
创建多元索引后，您可以选择合适的查询类型进行多维度数据查询。多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、地理位置查询、多条件组合查询、向量检索、嵌套类型查询和列存在性查询。
当通过Search接口查询数据时，如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。
当通过Search接口查询数据时，如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。
如果希望清理多元索引中的历史数据或者希望延长数据保存时间，您可以修改多元索引的数据生命周期。具体操作，请参见更新多元索引信息。
如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。
如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。
如果要在多元索引中新增、更新或者删除索引列，您可以使用动态修改schema功能实现。具体操作，请参见动态修改schema。
如果要获取某个数据表关联的所有多元索引的列表信息，您可以使用列出多元索引列表功能实现。具体操作，请参见列出多元索引列表。
如果要查询多元索引的描述信息，包括多元索引的字段信息和索引配置等，您可以使用查询多元索引描述信息功能实现。具体操作，请参见查询多元索引描述信息。
如果不再需要使用多元索引，您可以删除多元索引。具体操作，请参见删除多元索引。