使用CreateSearchIndex方法在数据表上创建一个多元索引。一个数据表支持创建多个多元索引。创建多元索引时,您需要将要查询的字段添加到多元索引中,您还可以配置多元索引路由键、预排序等高级选项。
前提条件
完成创建数据表,并且数据表同时满足以下条件:
最大版本数必须为1。
数据生命周期为 -1或者数据表为禁止更新状态。
注意事项
参数
创建多元索引时,需要指定数据表名称(tableName)、多元索引名称(indexName)和索引的结构信息(schema),其中schema包含fieldSchemas(Index的所有字段的设置)、indexSetting(索引设置)和indexSort(索引预排序设置)。详细参数说明请参见下表。
参数 | 说明 |
参数 | 说明 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
fieldSchemas | fieldSchemas的列表,每个fieldSchema包含如下内容:
|
indexSetting | 索引设置,包含routingFields设置。 routingFields(可选):自定义路由字段。可以选择部分主键列作为路由字段,一般情况下只需要设置一个。如果设置多个路由键,系统会将多个路由键的值拼接成一个值。 在进行索引数据写入时,系统会根据路由字段的值计算索引数据的分布位置,路由字段的值相同的记录会被索引到相同的数据分区中。 |
indexSort | 索引预排序设置,包含sorters设置。如果不设置,则默认按照主键排序。 含有Nested类型的索引不支持indexSort,没有预排序。 sorters(必选):索引的预排序方式,支持按照主键排序和字段值排序。关于排序的更多信息,请参见排序和翻页。
|
timeToLive | 可选参数。数据生命周期(TTL),即数据的保存时间,单位为秒。 默认值为 -1,表示数据永不过期。数据生命周期的取值最低为 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);
});
常见问题
相关文档
- 本页导读 (1)
- 前提条件
- 注意事项
- 参数
- 示例
- 常见问题
- 相关文档