NestedQuery用于查询嵌套类型的列中子行的数据。嵌套类型不能直接查询,需要通过NestedQuery包装,NestedQuery中需要指定嵌套类型的列的路径和一个子查询,其中子查询可以是任意Query类型。

前提条件

  • 已初始化Client,详情请参见初始化
  • 已创建数据表并写入数据。
  • 已在数据表上创建多元索引,详情请参见创建多元索引

参数

参数 说明
tableName 数据表名称。
indexName 多元索引名称。
path 路径名,嵌套类型的列的树状路径。例如news.title表示嵌套类型的news列中的title子列。
query 嵌套类型的列中子列上的查询,子列上的查询可以是任意Query类型。
scoreMode 当列存在多个值时基于哪个值计算分数。

示例

查询表中Col_Nested.Sub_Col_Keyword列值为"开心"的数据。

/**
 * 嵌套数据示例Col_Nested: '[{Sub_Col_Keyword: "开心"},{Sub_Col_Keyword: "晴天"}]'
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, //如果只为了获取行数,无需获取具体数据,可以设置limit=0,即不返回任意一行数据。
        query: { //设置查询类型为TableStore.QueryType.NESTED_QUERY。
            queryType: TableStore.QueryType.NESTED_QUERY,
            query: {
                path: "Col_Nested",
                query: {
                    queryType: TableStore.QueryType.TERM_QUERY,
                    query: {
                        fieldName: "Col_Nested.Sub_Col_Keyword",
                        term: "开心"
                    }
                },
            }
        },
        getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数,默认为false,表示不返回。
    },
    columnToGet: { //返回列设置RETURN_SPECIFIED(自定义)、RETURN_ALL(所有列)和RETURN_NONE(不返回)。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});