NestedQuery用于查询嵌套类型字段中子行的数据。嵌套类型不能直接查询，需要通过NestedQuery包装，NestedQuery中需要指定嵌套类型字段的路径和一个子查询，其中子查询可以是任意Query类型。
前提条件
已初始化Client。具体操作，请参见初始化OTSClient。
已在数据表上创建多元索引。具体操作，请参见创建多元索引。
参数
参数 | 说明 |
tableName | 数据表名称。 |
indexName | 多元索引名称。 |
path | 路径名，嵌套类型的列的树状路径。例如news.title表示嵌套类型的news列中的title子列。 |
query | 嵌套类型的列中子列上的查询，子列上的查询可以是任意Query类型。 |
scoreMode | 当列存在多个值时基于哪个值计算分数。 |
InnerHits | 嵌套类型字段的子列的配置参数。包括如下配置项：
|
示例
单层级嵌套类型查询示例
以下示例用于查询Col_Nested.Sub_Col_Keyword为"开心"的数据。其中Col_Nested为嵌套类型字段，子行中包含Sub_Col_Keyword列。
/**
* 嵌套数据示例Col_Nested: '[{Sub_Col_Keyword: "开心"},{Sub_Col_Keyword: "晴天"}]'
*/
client.search({
tableName: "<TABLE_NAME>",
indexName: "<SEARCH_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_ALL_FROM_INDEX（返回多元索引中的所有列）、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));
});嵌套类型查询使用查询摘要与高亮示例
以下示例用于使用NestedQuery功能查询表中Col_Nested嵌套类型字段中Sub_Col_Text子列的值能够匹配tablestore的数据，并在返回结果中对查询词进行高亮显示。
client.search({
tableName: "<TABLE_NAME>",
indexName: "<SEARCH_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.MATCH_QUERY,
query: {
fieldName: "Col_Nested.Sub_Col_Text",
text: "tablestore"
}
},
innerHits: {
sort: {
sorters: [
{
scoreSort: {
order: TableStore.SortOrder.SORT_ORDER_DESC
}
},
{
docSort: {
order: TableStore.SortOrder.SORT_ORDER_ASC
}
},
],
},
highlight: {
highlightParameters: [
{
fieldName:"Col_Nested.Sub_Col_Text",
preTag: "<b>",
postTag: "</b>",
fragmentsOrder: TableStore.HighlightFragmentOrder.TEXT_SEQUENCE,
fragmentSize: 20,
numberOfFragments: 3,
}
]
}
},
}
},
getTotalCount: true //结果中的TotalCount可以表示表中数据的总行数，默认为false，表示不返回。
},
columnToGet: { //返回列设置，可设置为RETURN_SPECIFIED（自定义返回列）、RETURN_ALL（返回所有列）、RETURN_ALL_FROM_INDEX（返回多元索引中的所有列）、RETURN_NONE（不返回）。
returnType: TableStore.ColumnReturnType.RETURN_ALL
}
}, function (err, data) {
if (err) {
console.log('error:', err);
return;
}
console.log('success:', JSON.stringify(data.rows, null, 2));
printSearchHit(data.searchHits, "");
});
/**
* 打印searchHit内容。
* @param searchHits searchHits
* @param prefix Nested结构输出时，增加前缀以打印层次信息。
*/
function printSearchHit(searchHits, prefix) {
TableStore.util.arrayEach(searchHits, function (searchHit) {
if (searchHit.highlightResultItem != null) {
console.log(prefix + "Highlight: \n");
var strBuilder = ""
for (const [key,val] of searchHit.highlightResultItem.highlightFields.entries()) {
strBuilder += key + ":[";
strBuilder += val.fragments.join(",") + "]\n";
console.log(strBuilder);
}
}
for (const [key,val] of searchHit.searchInnerHits.entries()) {
console.log(prefix + "Path: " + key + "\n");
console.log(prefix + "InnerHit: \n");
printSearchHit(val.subSearchHits, prefix + " ");
}
});
}常见问题
相关文档
多元索引查询类型包括精确查询、多词精确查询、全匹配查询、匹配查询、短语匹配查询、前缀查询、范围查询、通配符查询、多条件组合查询、地理位置查询、嵌套类型查询、向量检索和列存在性查询，您可以选择合适的查询类型进行多维度数据查询。
如果要对结果集进行排序或者翻页，您可以使用排序和翻页功能来实现。具体操作，请参见排序和翻页。
如果要按照某一列对结果集做折叠，使对应类型的数据在结果展示中只出现一次，您可以使用折叠（去重）功能来实现。具体操作，请参见折叠（去重）。
如果要进行数据分析，例如求最值、求和、统计行数等，您可以使用Search接口的统计聚合功能或者SQL查询来实现。具体操作，请参见统计聚合和SQL查询。
如果要快速导出数据，而不关心整个结果集的顺序时，您可以使用ParallelScan接口和ComputeSplits接口实现多并发导出数据。具体操作，请参见并发导出数据。