You can use the collapse (distinct) feature to collapse the result set based on a specific column when the results of a query contain large amounts of data of a specific type. Data of the specific type is displayed only once in the returned results to ensure the diversity of the result types.
Prerequisites
An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
A data table is created and data is written to the data table. For more information, see Create a data table and Write data.
A search index is created for the data table. For more information, see Create a search index.
Usage notes
If you use the collapse (distinct) feature, you can perform pagination only by specifying the offset and limit parameters.
If you aggregate and collapse a result set at the same time, the result set is aggregated before it is collapsed.
If you collapse the results of a query, the total number of results that are returned is determined by the sum of the values of the offset and limit parameters. A maximum of 100,000 results can be returned.
The total number of rows in the response indicates the number of rows that meet the query conditions before you use the collapse (distinct) feature. After the result set is collapsed, the total number of distinct values cannot be queried.
Parameters
Parameter | Description |
query | The query type. You can set this parameter to any query type. |
collapse | Collapses the result set based on the column that is specified by the fieldName field. fieldName: the name of the column based on which the result set is collapsed. Only columns whose values are of the INTEGER, FLOATING-POINT, or KEYWORD type are supported. |
offset | The position from which the current query starts. |
limit | The maximum number of rows that you want the current query to return. To query only the number of rows that meet the query conditions without specific data, set the limit parameter to 0. |
getTotalCount | Specifies whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which specifies that the total number of rows that meet the query conditions is not returned. If you set this parameter to true, the query performance is compromised. |
tableName | The name of the data table. |
indexName | The name of the search index. |
columnsToGet | Specifies whether to return all columns of each row that meets the query conditions. You can specify the returnAll and columns fields for this parameter. The default value of the returnAll field is false, which specifies that not all columns are returned. In this case, you can use the columns field to specify the columns that you want to return. If you do not specify the columns that you want to return, only the primary key columns are returned. If you set the returnAll field to true, all columns are returned. |
Example
The following sample code provides an example on how to query the rows in which the value of the user_id column matches "00002" and then collapse the result set based on the value of the product_name column:
private static void UseCollapse(SyncClient client){
SearchQuery searchQuery = new SearchQuery(); // Specify the query conditions.
MatchQuery matchQuery = new MatchQuery();
matchQuery.setFieldName("user_id");
matchQuery.setText("00002");
searchQuery.setQuery(matchQuery);
Collapse collapse = new Collapse("product_name"); // Collapse the result set based on the product_name column.
searchQuery.setCollapse(collapse);
//searchQuery.setOffset(1000);// The position from which the current query starts.
searchQuery.setLimit(20);
//searchQuery.setGetTotalCount(true);// Set the GetTotalCount parameter to true to return the total number of rows that meet the query conditions.
SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);// Specify the name of the data table and the name of the search index.
// You can use the columnsToGet parameter to specify the columns that you want to return or specify that all columns are returned. If you do not specify this parameter, only the primary key columns are returned.
//SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
//columnsToGet.setReturnAll(true); // Set the ReturnAll parameter to true to return all columns.
//columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); // Specify the columns that you want to return.
//searchRequest.setColumnsToGet(columnsToGet);
SearchResponse response = client.search(searchRequest);
//System.out.println(response.getTotalCount());
//System.out.println(response.getRows().size()); // Display the number of rows that are returned based on the product_name column.
System.out.println(response.getRows()); // Display the product names that are returned based on the product_name column.
}
FAQ
References
When you use a search index to query data, you can use the following query methods: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, geo query, KNN vector query, Boolean query, nested query, and exists query. After you create a search index, you can use the query methods provided by the search index to query data from multiple dimensions based on your business requirements.
You can sort or paginate rows that meet the query conditions by using the sorting and paging features. For more information, see Perform sorting and paging.
You can use the collapse (distinct) feature to collapse the result set based on a specific column. This way, data of the specified type appears only once in the query results. For more information, see Collapse (distinct).
If you want to analyze data in a table, you can call the Search operation to use the aggregation feature or use the SQL query feature. For example, you can query the maximum and minimum values, the sum of the values, and the number of rows. For more information, see Aggregation and SQL query.
If you want to obtain all rows that meet the query conditions without the need to sort the rows, you can call the ParallelScan and ComputeSplits operations to use the parallel scan feature. For more information, see Parallel scan.