使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表可以创建多个多元索引。
前提条件
- 已初始化Client。具体操作,请参见初始化。
- 已创建数据表,且数据表的数据生命周期(timeToLive)必须为-1,最大版本数(maxVersions)必须为1。
参数
创建多元索引时,需要指定数据表名称(tableName)、多元索引名称(indexName)和索引的结构信息(indexSchema),其中indexSchema包含fieldSchemas(Index的所有字段的设置)、indexSetting(索引设置)、indexSort(索引预排序设置)和timeToLive(数据生命周期)。详细参数说明请参见下表。
参数 | 说明 |
---|---|
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
fieldSchemas | fieldSchema的列表,每个fieldSchema包含如下内容:
|
indexSetting | 索引设置,包含routingFields设置。
routingFields(可选):自定义路由字段。可以选择部分主键列作为路由字段,在进行索引数据写入时,会根据路由字段的值计算索引数据的分布位置,路由字段的值相同的记录会被索引到相同的数据分区中。 |
indexSort | 索引预排序设置,包含sorters设置。如果不设置,则默认按照主键排序。
说明 含有Nested类型的索引不支持indexSort,没有预排序。
sorters(可选):索引的预排序方式,支持按照主键排序和字段值排序。关于排序的更多信息,请参见排序和翻页。
|
timeToLive | 可选参数,默认值为-1。数据生命周期(TTL),即数据的保存时间。
当数据的保存时间超过设置的数据生命周期时,系统会自动清理超过数据生命周期的数据。 数据生命周期至少为86400秒(一天)或-1(数据永不过期)。 多元索引生命周期的使用方式,请参见多元索引生命周期。 |
示例
- 创建多元索引。
创建一个多元索引,包含Col_Keyword和Col_Long两列,类型分别设置为字符串(String)和整型(Long)。
private static void createSearchIndex(SyncClient client) { CreateSearchIndexRequest request = new CreateSearchIndexRequest(); request.setTableName(tableName); //设置数据表名称。 request.setIndexName(indexName); //设置多元索引名称。 IndexSchema indexSchema = new IndexSchema(); indexSchema.setFieldSchemas(Arrays.asList( new FieldSchema("Col_Keyword", FieldType.KEYWORD), //设置字段名和类型。 new FieldSchema("Col_Long", FieldType.LONG))); request.setIndexSchema(indexSchema); client.createSearchIndex(request); //调用client创建多元索引。 }
- 创建多元索引时指定IndexSort。
private static void createSearchIndexWithIndexSort(SyncClient client) { CreateSearchIndexRequest request = new CreateSearchIndexRequest(); request.setTableName(tableName); //设置数据表名称。 request.setIndexName(indexName); //设置多元索引名称。 IndexSchema indexSchema = new IndexSchema(); indexSchema.setFieldSchemas(Arrays.asList( new FieldSchema("Col_Keyword", FieldType.KEYWORD), new FieldSchema("Col_Long", FieldType.LONG), new FieldSchema("Col_Text", FieldType.TEXT), new FieldSchema("Timestamp", FieldType.LONG))); //设置按照Timestamp列进行预排序。 indexSchema.setIndexSort(new Sort( Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC)))); request.setIndexSchema(indexSchema); client.createSearchIndex(request); }
- 创建多元索引时设置生命周期。
注意 请确保数据表的更新状态为禁止。
// 请使用5.12.0及以上版本的Java SDK。 public void createIndexWithTTL(SyncClient client) { int days = 7; CreateSearchIndexRequest createRequest = new CreateSearchIndexRequest(); createRequest.setTableName(tableName); createRequest.setIndexName(indexName); createRequest.setIndexSchema(indexSchema); // 设置多元索引TTL。 createRequest.setTimeToLiveInDays(days); client.createSearchIndex(createRequest); }
- 创建多元索引时指定虚拟列。
创建一个多元索引,多元索引包含Col_Keyword和Col_Long两列,同时创建虚拟列Col_Keyword_Virtual_Long和Col_Long_Virtual_Keyword。Col_Keyword_Virtual_Long映射为数据表中Col_Keyword列,虚拟列Col_Long_Virtual_Keyword映射为数据表中Col_Long列。
private static void createSearchIndex(SyncClient client) { CreateSearchIndexRequest request = new CreateSearchIndexRequest(); request.setTableName(tableName); //设置数据表名称。 request.setIndexName(indexName); //设置多元索引名称。 IndexSchema indexSchema = new IndexSchema(); indexSchema.setFieldSchemas(Arrays.asList( new FieldSchema("Col_Keyword", FieldType.KEYWORD), //设置字段名和类型。 new FieldSchema("Col_Keyword_Virtual_Long", FieldType.LONG) //设置字段名和类型。 .setVirtualField(true) //设置字段是否为虚拟列。 .setSourceFieldName("Col_Keyword"), //虚拟列对应的数据表中字段。 new FieldSchema("Col_Long", FieldType.LONG), new FieldSchema("Col_Long_Virtual_Keyword", FieldType.KEYWORD) .setVirtualField(true) .setSourceFieldName("Col_Long"))); request.setIndexSchema(indexSchema); client.createSearchIndex(request); //调用client创建多元索引。 }