本文主要为您介绍创建多元索引(CreateSearchIndex)接口。

如果要在某张表上使用Search功能,那么首先需要在这张表上创建一个多元索引。创建多元索引时,需要指定表名(tableName)、索引名(indexName)、索引的结构信息(indexSchema)。

参数说明

  • tableName:要创建的多元索引所属的表名。
  • indexName:要创建的多元索引的名字。
  • schema:包含indexSetting(索引设置)、fieldSchemas(Index的所有字段的设置)、indexSort(indexSort的设置)
    • fieldSchemas:FieldSchema的列表,每个FieldSchema包含以下内容:
      • fieldName(必选):String。要索引的字段名,即列名。可以是主键列,也可以是属性列。
      • fieldType(必选):字段类型,详见SearchIndex字段类型一节。
      • isAnArray(可选):bool值。是否为数组。如果为true,则表示该列是一个数组,在写入时,也必须按照json数组格式写入,比如["a","b","c"]。NESTED类型本身就是一个数组,所以无须设置Array。
      • index(可选):bool值。是否开启索引。
      • indexOptions(可选):索引的配置选项。
      • analyzer(可选):分词器设置。
      • enableSortAndAgg(可选):bool值。是否开启排序与统计功能。
      • store(可选):bool值。是否在多元索引中附加存储该字段的值。开启后,可以直接从多元索引中读取该字段的值,而不必反查主表,可用于查询性能优化。
    • indexSetting(可选):
      • routingFields(高级功能,可选配置):自定义路由字段。可以选择部分主键列作为路由字段,在进行索引数据写入时,会根据路由字段的值计算索引数据的分布位置,路由字段的值相同的记录会被索引到相同的数据分区中。
    • indexSort(可选):默认基于主键做indexSort
      • sorters:索引排序(数组)支持primaryKeySort和fieldSort
        • primaryKeySort:
          • order: 默认正序TableStore.SortOrder.SORT_ORDER_ASC
        • fieldSort:自定义字段做indexSort
          • fieldName: 设置indexSort字段
          • order: 默认正序TableStore.SortOrder.SORT_ORDER_ASC

示例

/**
 *创建一个多元索引,包含Col_Keyword、Col_Long、Col_Text、Col_Nested四列
 *类型分别设置为字符串(KEYWORD)、整型(LONG)、分词字符串(TEXT)以及嵌套文本(NESTED)。
 */
client.createSearchIndex({
    tableName: TABLE_NAME, // 设置表名
    indexName: INDEX_NAME, // 设置索引名
    schema: {
        fieldSchemas: [
            {
                fieldName: "Col_Keyword",
                fieldType: TableStore.FieldType.KEYWORD, // 设置字段名、类型
                index: true, // 设置开启索引
                enableSortAndAgg: true, // 设置开启排序和统计功能
                store: false,
                isAnArray: false
            },
            {
                fieldName: "Col_Long",
                fieldType: TableStore.FieldType.LONG,
                index: true,
                enableSortAndAgg: true,
                store: true,
                isAnArray: false
            },
            {
                fieldName: "Col_Text",
                fieldType: TableStore.FieldType.TEXT,
                index: true,
                enableSortAndAgg: false,
                store: true,
                isAnArray: false,
            },
            // {
            //     fieldName: "Col_Nested",
            //     fieldType: TableStore.FieldType.NESTED,
            //     index: false,
            //     enableSortAndAgg: false,
            //     store: false,
            //     fieldSchemas: [ // 嵌套索引设置子字段索引
            //         {
            //             fieldName: "Sub_Col_KeyWord",
            //             fieldType: TableStore.FieldType.KEYWORD,
            //             index: true,
            //             enableSortAndAgg: true,
            //             store: false,
            //         },
            //         {
            //             fieldName: "Sub_Col_Long",
            //             fieldType: TableStore.FieldType.LONG,
            //             index: true,
            //             enableSortAndAgg: true,
            //             store: false,
            //         }
            //     ]
            // }
        ],
        indexSetting: { //索引的配置选项
            "routingFields": ["Pk_Keyword"], //仅支持将主键设为routingFields
            "routingPartitionSize": null
        },
        indexSort: {//不支持含含NESTED的索引,
            sorters: [
                // { //不设置indexSort时, 默认PrimaryKeySort(正序)
                //     primaryKeySort: {
                //         order: TableStore.SortOrder.SORT_ORDER_ASC
                //     }
                // },
                {
                    fieldSort: {
                        fieldName: "Col_Keyword",
                        order: TableStore.SortOrder.SORT_ORDER_DESC //设置indexSort顺序
                    }
                }
            ]
        }
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});