NestedQuery用于查詢嵌套類型字段中子行的數據。嵌套類型不能直接查詢，需要通過NestedQuery包裝，NestedQuery中需要指定嵌套類型字段的路徑和一個子查詢，其中子查詢可以是任意Query類型。
前提條件
已初始化OTSClient。具體操作，請參見初始化OTSClient。
已在數據表上創建多元索引。具體操作，請參見創建多元索引。
參數
參數 | 說明 |
path | 路徑名，嵌套類型字段的樹狀路徑。例如news.title表示嵌套類型的news字段中的title子列。 |
query | 嵌套類型字段的子列上的查詢，子列上的查詢可以是任意Query類型。 |
scoreMode | 當字段存在多個值時基于哪個值計算分數。 |
getTotalCount | 是否返回匹配的總行數，默認為false，表示不返回。 返回匹配的總行數會影響查詢性能。 |
weight | 查詢權重，用于全文檢索場景中的score排序。查詢時指定列的算分權重，值越大，結果中分數的值會越大。取值范圍為正浮點數。 使用此參數不會影響返回的結果數，只會影響返回的結果中的分數。 |
tableName | 數據表名稱。 |
indexName | 多元索引名稱。 |
columnsToGet | 是否返回所有列，包含returnAll和columns設置。 returnAll默認為false，表示不返回所有列，此時可以通過columns指定返回的列；如果未通過columns指定返回的列，則只返回主鍵列。 當設置returnAll為true時，表示返回所有列。 |
InnerHits | 嵌套類型字段的子列的配置參數。包括如下配置項：
|
示例
使用嵌套類型查詢的示例如下：
單層級嵌套類型查詢示例
以下示例用于查詢col_nested.nested_1為tablestore的數據。其中col_nested為嵌套類型字段，子行中包含nested_1和nested_2兩列。
private static void nestedQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
NestedQuery nestedQuery = new NestedQuery(); //設置查詢類型為NestedQuery。
nestedQuery.setPath("col_nested"); //設置嵌套類型列的路徑。
TermQuery termQuery = new TermQuery(); //構造NestedQuery的子查詢。
termQuery.setFieldName("col_nested.nested_1"); //設置列名，注意帶有嵌套類型列的路徑。
termQuery.setTerm(ColumnValue.fromString("tablestore")); //設置要查詢的值。
nestedQuery.setQuery(termQuery);
nestedQuery.setScoreMode(ScoreMode.None);
searchQuery.setQuery(nestedQuery);
//searchQuery.setGetTotalCount(true);//設置返回匹配的總行數。
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通過設置columnsToGet參數可以指定返回的列或返回所有列，如果不設置此參數，則默認只返回主鍵列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //設置為返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //設置為返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的總行數，非返回行數。
System.out.println("Row: " + resp.getRows());
}多層級嵌套類型查詢示例
以下示例用于查詢col_nested.nested_2.nested_2_2為tablestore的數據。其中col_nested為嵌套類型字段，col_nested的子行中包含nested_1和nested_2兩列，nested_2的子行中又包含nested_2_1和nested_2_2兩列。
private static void nestedQuery(SyncClient client) {
SearchQuery searchQuery = new SearchQuery();
NestedQuery nestedQuery = new NestedQuery(); //設置查詢類型為NestedQuery。
nestedQuery.setPath("col_nested.nested_2"); //設置嵌套類型列的路徑，即要查詢字段的父路徑。
TermQuery termQuery = new TermQuery(); //構造NestedQuery的子查詢。
termQuery.setFieldName("col_nested.nested_2.nested_2_2"); //設置列名，即要查詢字段的完整路徑。
termQuery.setTerm(ColumnValue.fromString("tablestore")); //設置要查詢的值。
nestedQuery.setQuery(termQuery);
nestedQuery.setScoreMode(ScoreMode.None);
searchQuery.setQuery(nestedQuery);
//searchQuery.setGetTotalCount(true);//設置返回匹配的總行數。
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通過設置columnsToGet參數可以指定返回的列或返回所有列，如果不設置此參數，則默認只返回主鍵列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //設置為返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //設置為返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的總行數，非返回行數。
System.out.println("Row: " + resp.getRows());
}嵌套類型組合查詢示例
查詢需求
假設數據表中有col_string（String類型）和col_nested（String類型）兩列，其中col_nested用于存儲JSON格式的數據。數據表的具體數據示例請參見下表。
此處為了便于演示查詢示例，為每行數據添加了行編號列。
行編號 | col_string | col_nested |
1 | a | [{"col_keyword": "tablestore"},{"col_keyword": "searchindex","col_long": 1}] |
2 | b | [{"col_keyword": "tablestore","col_long": 1}] |
3 | c | [{"col_keyword": "searchindex"},{"col_long": 1}] |
假設對col_nested列數據有如下查詢需求：
同一個子行滿足多個查詢條件
例如查詢col_nested列中同一子行同時滿足col_keyword列值為"tablestore"并且col_long列值非空的行數據。
不同子行滿足多個查詢條件
例如查詢col_nested列中只要不同子行能滿足col_keyword值為"tablestore"和col_long值非空兩個條件的行數據。
為了滿足上述查詢需求，您需要執行如下操作：
為數據表創建一個多元索引，并在多元索引中將col_nested列設置為嵌套類型。
其中col_nested列包含col_keyword（Keyword類型）和col_long（Long類型）兩個子字段。
結合查詢需求使用合適的查詢方式進行數據查詢。
如果要實現同一個子行滿足多個查詢條件的查詢需求，您需要在NestedQuery下設置多個BoolQuery進行查詢。
如果要實現不同子行滿足多個查詢條件的查詢需求，您需要在BoolQuery下設置多個NestedQuery進行查詢。
進行數據查詢的示例如下，請根據要實現的查詢需求參考相應示例進行操作。
同一子行滿足多個條件查詢示例
以下示例用于查詢col_nested列的同一子行同時滿足col_nested.col_keyword為"tablestore"并且col_nested.col_long非空條件的行數據。
根據數據表的數據示例可知，只有行編號2對應的行數據滿足查詢條件。
public static void nestedQuery(SyncClient client) {
// 查詢條件一：要求col_nested子行的col_keyword列值為"tablestore"
TermQuery termQuery = new TermQuery();
termQuery.setFieldName("col_nested.col_keyword");
termQuery.setTerm(ColumnValue.fromString("tablestore"));
// 查詢條件二：要求col_nested子行的col_long非空
ExistsQuery existsQuery = new ExistsQuery();
existsQuery.setFieldName("col_nested.col_long");
// 通過BoolQuery的And條件，查詢同時滿足上述條件的子行
List<Query> mustQueries = new ArrayList<>();
mustQueries.add(termQuery);
mustQueries.add(existsQuery);
BoolQuery boolQuery = new BoolQuery();
boolQuery.setMustQueries(mustQueries);
// NestedQuery內部設置BoolQuery，要求某一子行同時滿足多個查詢條件
NestedQuery nestedQuery = new NestedQuery(); //設置查詢類型為NestedQuery。
nestedQuery.setPath("col_nested"); //設置嵌套類型列的路徑，即要查詢字段的父路徑。
nestedQuery.setQuery(boolQuery);
nestedQuery.setScoreMode(ScoreMode.None);
SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(nestedQuery);
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通過設置columnsToGet參數可以指定返回的列或返回所有列，如果不設置此參數，則默認只返回主鍵列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //設置為返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //設置為返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的總行數，非返回行數。
System.out.println("Row: " + resp.getRows());
}不同子行滿足多個條件查詢示例
以下示例用于查詢col_nested的多個子行能滿足col_nested.col_keyword為"tablestore"和col_nested.col_long非空兩個條件的行數據。
根據數據表的數據示例可知，行編號1和行編號2對應的行數據均滿足查詢條件。
public static void nestedQuery(SyncClient client) {
// 查詢條件一：要求col_nested子行的col_keyword列值為"tablestore"
TermQuery termQuery = new TermQuery();
termQuery.setFieldName("col_nested.col_keyword");
termQuery.setTerm(ColumnValue.fromString("tablestore"));
NestedQuery nestedTermQuery = new NestedQuery();
nestedTermQuery.setPath("col_nested");
nestedTermQuery.setScoreMode(ScoreMode.None);
nestedTermQuery.setQuery(termQuery);
// 查詢條件二：要求col_nested子行的col_long非空
ExistsQuery existsQuery = new ExistsQuery();
existsQuery.setFieldName("col_nested.col_long");
NestedQuery nestedExistsQuery = new NestedQuery();
nestedExistsQuery.setPath("col_nested");
nestedExistsQuery.setScoreMode(ScoreMode.None);
nestedExistsQuery.setQuery(existsQuery);
// 通過BoolQuery的And條件，查詢滿足上述條件的行
List<Query> mustQueries = new ArrayList<>();
mustQueries.add(nestedTermQuery);
mustQueries.add(nestedExistsQuery);
// BoolQuery內部包括多個NestedQuery，多個子行分別滿足查詢條件即可
BoolQuery boolQuery = new BoolQuery();
boolQuery.setMustQueries(mustQueries);
SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(boolQuery);
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
//通過設置columnsToGet參數可以指定返回的列或返回所有列，如果不設置此參數，則默認只返回主鍵列。
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); //設置為返回所有列。
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); //設置為返回指定列。
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse resp = client.search(searchRequest);
//System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的總行數，非返回行數。
System.out.println("Row: " + resp.getRows());
}嵌套類型查詢使用查詢摘要與高亮示例
以下示例用于使用NestedQuery功能查詢表中Col_Nested嵌套類型字段中Level1_Col1_Nested子列的值能夠匹配hangzhou shanghai的數據，并在返回結果中對查詢詞進行高亮顯示。
/**
* NestedQuery查詢摘要與高亮，通過innerHits設置參數。
*/
public static void nestedQueryWithHighlighting(SyncClient client) {
SearchRequest searchRequest = SearchRequest.newBuilder()
.tableName("<TABLE_NAME>")
.indexName("<SEARCH_INDEX_NAME>")
.returnAllColumnsFromIndex(true)
.searchQuery(SearchQuery.newBuilder()
.limit(5)
.query(QueryBuilders.nested()
.path("Col_Nested")
.scoreMode(ScoreMode.Min)
.query(QueryBuilders.match("Col_Nested.Level1_Col1_Nested", "hangzhou shanghai"))
.innerHits(InnerHits.newBuilder()
.highlight(Highlight.newBuilder()
.addFieldHighlightParam("Col_Nested.Level1_Col1_Nested", HighlightParameter.newBuilder().build())
.build())
.build()))
.build())
.build();
SearchResponse resp = client.search(searchRequest);
// 打印高亮結果。
printSearchHit(resp.getSearchHits(), "");
}
/**
* 打印searchHit內容。
* @param searchHits searchHits
* @param prefix Nested結構輸出時，增加前綴以打印層次信息。
*/
private static void printSearchHit(List<SearchHit> searchHits, String prefix) {
for (SearchHit searchHit : searchHits) {
if (searchHit.getScore() != null) {
System.out.printf("%s Score: %s\n", prefix, searchHit.getScore());
}
if (searchHit.getOffset() != null) {
System.out.printf("%s Offset: %s\n", prefix, searchHit.getOffset());
}
if (searchHit.getRow() != null) {
System.out.printf("%s Row: %s\n", prefix, searchHit.getRow().toString());
}
// 打印各字段高亮分片結果。
if (searchHit.getHighlightResultItem() != null) {
System.out.printf("%s Highlight: \n", prefix);
StringBuilder strBuilder = new StringBuilder();
for (Map.Entry<String, HighlightField> entry : searchHit.getHighlightResultItem().getHighlightFields().entrySet()) {
strBuilder.append(entry.getKey()).append(":").append("[");
strBuilder.append(StringUtils.join(",", entry.getValue().getFragments())).append("]\n");
}
System.out.printf("%s %s", prefix, strBuilder);
}
// 嵌套類型高亮結果。
for (SearchInnerHit searchInnerHit : searchHit.getSearchInnerHits().values()) {
System.out.printf("%s Path: %s\n", prefix, searchInnerHit.getPath());
System.out.printf("%s InnerHit: \n", prefix);
printSearchHit(searchInnerHit.getSubSearchHits(), prefix + " ");
}
System.out.println();
}
}假設多層級嵌套類型字段Col_Nested中包括Level1_Col1_Text（Text類型）和Level1_Col2_Nested（Nested類型）兩列，其中Level1_Col2_Nested嵌套類型字段包括Level2_Col1_Text子列。
以下示例用于通過在NestedQuery中添加BoolQuery對Col_Nested字段中的Level1_Col1_Text子列和Level1_Col2_Nested下的Level2_Col1_Text子列同時使用查詢摘要與高亮功能。
public static void nestedQueryWithHighlighting(SyncClient client) {
SearchRequest searchRequest = SearchRequest.newBuilder()
.tableName("<TABLE_NAME>")
.indexName("<SEARCH_INDEX_NAME>")
.returnAllColumnsFromIndex(true)
.searchQuery(SearchQuery.newBuilder()
.limit(5)
.query(QueryBuilders.nested()
.path("Col_Nested")
.scoreMode(ScoreMode.Min)
.query(QueryBuilders.bool()
.should(QueryBuilders.match("Col_Nested.Level1_Col1_Text", "hangzhou shanghai"))
.should(QueryBuilders.nested()
.path("Col_Nested.Level1_Col2_Nested")
.scoreMode(ScoreMode.Min)
.query(QueryBuilders.match("Col_Nested.Level1_Col2_Nested.Level2_Col1_Text", "hangzhou shanghai"))
.innerHits(InnerHits.newBuilder()
.highlight(Highlight.newBuilder()
.addFieldHighlightParam("Col_Nested.Level1_Col2_Nested.Level2_Col1_Text", HighlightParameter.newBuilder().build())
.build())
.build())))
.innerHits(InnerHits.newBuilder()
.sort(new Sort(Arrays.asList(
new ScoreSort(),
new DocSort()
)))
.highlight(Highlight.newBuilder()
.addFieldHighlightParam("Col_Nested.Level1_Col1_Text", HighlightParameter.newBuilder().build())
.build())
.build()))
.build())
.build();
SearchResponse resp = client.search(searchRequest);
// 打印高亮結果。
printSearchHit(resp.getSearchHits(), "");
}
/**
* 打印searchHit內容。
* @param searchHits searchHits
* @param prefix Nested結構輸出時，增加前綴以打印層次信息。
*/
private static void printSearchHit(List<SearchHit> searchHits, String prefix) {
for (SearchHit searchHit : searchHits) {
if (searchHit.getScore() != null) {
System.out.printf("%s Score: %s\n", prefix, searchHit.getScore());
}
if (searchHit.getOffset() != null) {
System.out.printf("%s Offset: %s\n", prefix, searchHit.getOffset());
}
if (searchHit.getRow() != null) {
System.out.printf("%s Row: %s\n", prefix, searchHit.getRow().toString());
}
// 打印各字段高亮分片結果。
if (searchHit.getHighlightResultItem() != null) {
System.out.printf("%s Highlight: \n", prefix);
StringBuilder strBuilder = new StringBuilder();
for (Map.Entry<String, HighlightField> entry : searchHit.getHighlightResultItem().getHighlightFields().entrySet()) {
strBuilder.append(entry.getKey()).append(":").append("[");
strBuilder.append(StringUtils.join(",", entry.getValue().getFragments())).append("]\n");
}
System.out.printf("%s %s", prefix, strBuilder);
}
// 嵌套類型高亮結果。
for (SearchInnerHit searchInnerHit : searchHit.getSearchInnerHits().values()) {
System.out.printf("%s Path: %s\n", prefix, searchInnerHit.getPath());
System.out.printf("%s InnerHit: \n", prefix);
printSearchHit(searchInnerHit.getSubSearchHits(), prefix + " ");
}
System.out.println();
}
}
常見問題
相關文檔
多元索引查詢類型包括精確查詢、多詞精確查詢、全匹配查詢、匹配查詢、短語匹配查詢、前綴查詢、范圍查詢、通配符查詢、地理位置查詢、向量檢索、多條件組合查詢、嵌套類型查詢和列存在性查詢，您可以選擇合適的查詢類型進行多維度數據查詢。
如果要對結果集進行排序或者翻頁，您可以使用排序和翻頁功能來實現。具體操作，請參見排序和翻頁。
如果要按照某一列對結果集做折疊，使對應類型的數據在結果展示中只出現一次，您可以使用折疊（去重）功能來實現。具體操作，請參見折疊（去重）。
如果要進行數據分析，例如求最值、求和、統計行數等，您可以使用Search接口的統計聚合功能或者SQL查詢來實現。具體操作，請參見統計聚合和SQL查詢。
如果要快速導出數據，而不關心整個結果集的順序時，您可以使用ParallelScan接口和ComputeSplits接口實現多并發導出數據。具體操作，請參見并發導出數據。