All Products
Search
Document Center

OpenSearch:Query test

Last Updated:Jan 26, 2025

Following a successful cluster deployment, you can initiate the search experience. The console's retrieval engine edition features a "Query Test" tool to assist with user query testing. This tool offers a variety of search clause configurations, enabling clients to tailor query requests for search testing based on specific requirements.

Usage method

  1. Navigate to the retrieval engine edition console > Instance management > Management > Feature extension > Query test page

  2. Click on Query test to select a clause type (SQL/HA3/RESTAPI query). The system supports SQL clauses, Ha3 clauses, and RESTAPI syntax for search. First, choose the clause type, click Search, and the search results will be displayed. Additional clauses can be included as needed

HA3 query

Choose HA3 query from the query test dropdown. Then, the necessary input fields appear, including the query string and clause. The platform automatically includes the config statement and cluster statement by default, and you can add other clauses as required.

SQL query

Select SQL query from the query test dropdown, enter the required query statement, and click Search.

You can add a kvpair clause as needed

Important

Note: Fields of type date, time, and timestamp cannot be retrieved using SELECT SQL statements.

RESTAPI query

Select RESTAPI query from the query test dropdown, choose the index table, enter the query statement in the left input box, and click Search

Input the RESTAPI query string and click Search to display the retrieval results on the right:

{
  "query": "index_id:12"
}

Query syntax

Query syntax

Query clause

Retrieval engine edition RESTFUL API syntax description