使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表支持创建多个多元索引。创建多元索引时，您需要将要查询的字段添加到多元索引中，您还可以配置多元索引路由键、预排序等高级选项。
前提条件
已初始化Client。具体操作，请参见初始化OTSClient。
已创建数据表，且数据表的数据生命周期（TimeToLive）必须为-1，最大版本数（MaxVersions）必须为1。
注意事项
创建多元索引时，多元索引中字段的数据类型必须与数据表中字段的数据类型相匹配。更多信息，请参见数据类型映射。
参数
创建多元索引时，需要指定数据表名称（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（数据永不过期）。 |
示例
创建多元索引时使用默认配置
以下示例用于创建一个多元索引。该多元索引包含Keyword_type_col（Keyword类型）、Long_type_col（Long类型）和Text_type_col（TEXT类型）三列。并且开启排序与统计聚合功能。
/// <summary>
/// 创建一个多元索引，包含Keyword_type_col、Long_type_col、Text_type_col三个属性列，类型分别设置为不分词字符串(Keyword)、整型(Long)、分词字符串(Text)。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndex(OTSClient otsClient)
{
//设置数据表名称和多元索引名称。
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
List<FieldSchema> FieldSchemas = new List<FieldSchema>() {
new FieldSchema(Keyword_type_col,FieldType.KEYWORD){ //设置字段名和字段类型。
index =true, //设置开启索引。
EnableSortAndAgg =true //设置开启排序与统计聚合功能。
},
new FieldSchema(Long_type_col,FieldType.LONG){ index=true,EnableSortAndAgg=true},
new FieldSchema(Text_type_col,FieldType.TEXT){ index=true}
};
request.IndexSchame = new IndexSchema()
{
FieldSchemas = FieldSchemas
};
//调用client创建多元索引。
CreateSearchIndexResponse response = otsClient.CreateSearchIndex(request);
Console.WriteLine("Searchindex is created: " + IndexName);
}创建多元索引时指定IndexSort
以下示例用于创建一个多元索引，多元索引包含Keyword_type_col、Long_type_col、Text_type_col三列，类型分别设置为字符串（Keyword）、整型（Long）、分词字符串（TEXT）。同时配置按照Long_type_col列进行预排序。
/// <summary>
/// 创建一个多元索引，包含Keyword_type_col、Long_type_col、Text_type_col三个属性列，类型分别设置为不分词字符串(Keyword)、整型(Long)、分词字符串(Text)。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndexWithIndexSort(OTSClient otsClient)
{
//设置数据表名称和多元索引名称。
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
List<FieldSchema> FieldSchemas = new List<FieldSchema>() {
new FieldSchema(Keyword_type_col,FieldType.KEYWORD){ //设置字段名和字段类型。
index =true, //设置开启索引。
EnableSortAndAgg =true //设置开启排序与统计聚合功能。
},
new FieldSchema(Long_type_col,FieldType.LONG){ index=true,EnableSortAndAgg=true},
new FieldSchema(Text_type_col,FieldType.TEXT){ index=true}
};
request.IndexSchame = new IndexSchema()
{
FieldSchemas = FieldSchemas,
//按照Long_type_col列进行预排序，Long_type_col列必须建立索引且开启EnableSortAndAgg。
IndexSort = new DataModel.Search.Sort.Sort()
{
Sorters = new List<DataModel.Search.Sort.ISorter>
{
new DataModel.Search.Sort.FieldSort(Long_type_col, DataModel.Search.Sort.SortOrder.ASC)
}
}
};
CreateSearchIndexResponse response = otsClient.CreateSearchIndex(request);
Console.WriteLine("Searchindex is created: " + IndexName);
}创建一个包含日期列和虚拟列的多元索引
以下示例用于创建一个多元索引，该多元索引包含pk0（Keyword类型）、pk1（Long类型）、date_col（Date类型）、geo_col（Geo-Point类型）和col0_v1（Text类）字段。其中虚拟列col0_v1的原始列为col0。返回结果按照pk1列进行升序排序。
/// <summary>
/// 创建一个包含日期列和虚拟列的多元索引。
/// </summary>
/// <param name="otsClient"></param>
public static void CreateSearchIndex(OTSClient otsClient)
{
List<FieldSchema> fieldSchemas = new List<FieldSchema> {
new FieldSchema("pk0", FieldType.KEYWORD)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("pk1", FieldType.LONG)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("date_col", FieldType.DATE)
{
index = true,
DateFormats = new List<string>(){
"yyyy-MM-dd'T'HH:mm:ss.SSSSSS",
"yyyy-MM-dd'T'HH:mm:ss.SSS"
}
},
new FieldSchema("geo_col", FieldType.GEO_POINT)
{
index = true,
EnableSortAndAgg = true
},
new FieldSchema("col0_v1", FieldType.TEXT)
{
index = true,
Analyzer = Analyzer.Split,
AnalyzerParameter = new SingleWordAnalyzerParameter(true, true),
IsVirtualField = true,
SourceFieldNames = new List<string> { "col0" }
},
};
CreateSearchIndexRequest request = new CreateSearchIndexRequest(TableName, IndexName);
request.IndexSchame = new IndexSchema()
{
FieldSchemas = fieldSchemas,
IndexSort = new Sort(new List<ISorter> { new FieldSort("pk1", SortOrder.ASC) })
};
request.TimeToLive = -1;
otsClient.CreateSearchIndex(request);
}常见问题
相关文档
创建多元索引后，您可以选择合适的查询类型进行多维度数据查询。多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、地理位置查询、多条件组合查询、嵌套类型查询和列存在性查询。
当通过Search接口查询数据时，如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。
当通过Search接口查询数据时，如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。
如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。
如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。
如果要在多元索引中新增、更新或者删除索引列，您可以使用动态修改schema功能实现。具体操作，请参见动态修改schema。
如果要获取某个数据表关联的所有多元索引的列表信息，您可以使用列出多元索引列表功能实现。具体操作，请参见列出多元索引列表。
如果要查询多元索引的描述信息，包括多元索引的字段信息和索引配置等，您可以使用查询多元索引描述信息功能实现。具体操作，请参见查询多元索引描述信息。
如果不再需要使用多元索引，您可以删除多元索引。具体操作，请参见删除多元索引。