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_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("sampleTable", "sampleSearchIndex", 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(termQuery);
// 通過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("sampleTable", "sampleSearchIndex", 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 NestedQueryQueryWithHighlighting1(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_Colqia1_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();
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介面實現多並發匯出資料。具體操作,請參見並發匯出資料。