使用CreateSearchIndex接口在数据表上创建一个多元索引。一个数据表可以创建多个多元索引。
前提条件
- 已初始化Client,详情请参见初始化。
- 已创建数据表,且数据表的数据生命周期(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(必选):索引的预排序方式,支持按照主键排序和字段值排序,详情请参见排序和翻页。
|
示例
- 示例1
创建一个多元索引,包含Col_Keyword和Col_Long两列,类型分别设置为字符串(String)和整型(Long)。
private static void createSearchIndex(SyncClient client) { CreateSearchIndexRequest request = new CreateSearchIndexRequest(); request.setTableName(TABLE_NAME); //设置数据表名称。 request.setIndexName(INDEX_NAME); //设置多元索引名称。 IndexSchema indexSchema = new IndexSchema(); indexSchema.setFieldSchemas(Arrays.asList( new FieldSchema("Col_Keyword", FieldType.KEYWORD) //设置字段名和类型。 .setIndex(true) //设置开启索引。 .setEnableSortAndAgg(true), //设置开启排序与统计聚合功能。 new FieldSchema("Col_Long", FieldType.LONG) .setIndex(true) .setEnableSortAndAgg(true))); request.setIndexSchema(indexSchema); client.createSearchIndex(request); //调用client创建多元索引。 }
- 示例2
创建多元索引时指定IndexSort。
private static void createSearchIndexWithIndexSort(SyncClient client) { CreateSearchIndexRequest request = new CreateSearchIndexRequest(); request.setTableName(TABLE_NAME); request.setIndexName(INDEX_NAME); IndexSchema indexSchema = new IndexSchema(); indexSchema.setFieldSchemas(Arrays.asList( new FieldSchema("Col_Keyword", FieldType.KEYWORD).setIndex(true).setEnableSortAndAgg(true), new FieldSchema("Col_Long", FieldType.LONG).setIndex(true).setEnableSortAndAgg(true), new FieldSchema("Col_Text", FieldType.TEXT).setIndex(true), new FieldSchema("Timestamp", FieldType.LONG).setIndex(true).setEnableSortAndAgg(true))); //设置按照Timestamp列进行预排序,Timestamp列必须建立索引且开启enableSortAndAgg。 indexSchema.setIndexSort(new Sort( Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC)))); request.setIndexSchema(indexSchema); client.createSearchIndex(request); }