query-workbench.md

layout	title	nav_order	redirect_from
default	Query Workbench	125	/search-plugins/sql/workbench/

Query Workbench

Query Workbench is a tool within OpenSearch Dashboards. You can use Query Workbench to run on-demand SQL and PPL queries, translate queries into their equivalent REST API calls, and view and save results in different response formats.

A view of the Query Workbench interface within OpenSearch Dashboards is shown in the following image.

Prerequisites

Before getting started, make sure you have indexed your data.

For this tutorial, you can index the following sample documents. Alternatively, you can use the OpenSearch Playground, which has preloaded indexes that you can use to try out Query Workbench.

To index sample documents, send the following Bulk API request:

PUT accounts/_bulk?refresh
{"index":{"_id":"1"}}
{"account_number":1,"balance":39225,"firstname":"Amber","lastname":"Duke","age":32,"gender":"M","address":"880 Holmes Lane","employer":"Pyrami","email":"[email protected]","city":"Brogan","state":"IL"}
{"index":{"_id":"6"}}
{"account_number":6,"balance":5686,"firstname":"Hattie","lastname":"Bond","age":36,"gender":"M","address":"671 Bristol Street","employer":"Netagy","email":"[email protected]","city":"Dante","state":"TN"}
{"index":{"_id":"13"}}
{"account_number":13,"balance":32838,"firstname":"Nanette","lastname":"Bates","age":28,"gender":"F","address":"789 Madison Street","employer":"Quility","email":"[email protected]","city":"Nogal","state":"VA"}
{"index":{"_id":"18"}}
{"account_number":18,"balance":4180,"firstname":"Dale","lastname":"Adams","age":33,"gender":"M","address":"467 Hutchinson Court","email":"[email protected]","city":"Orick","state":"MD"}

{% include copy-curl.html %}

Running SQL queries within Query Workbench

Follow these steps to learn how to run SQL queries against your OpenSearch data using Query Workbench:

1. Access Query Workbench.

   • To access Query Workbench, go to OpenSearch Dashboards and choose OpenSearch Plugins > Query Workbench from the main menu.

2. Run a query.

   • Select the SQL button. In the query editor, type a SQL expression and then select the Run button to run the query.

   The following example query retrieves the first name, last name, and balance from the accounts index for accounts with a balance greater than 10,000 and sorts by balance in descending order:

   SELECT
     firstname,
     lastname,
     balance
   FROM
     accounts
   WHERE
     balance > 10000
   ORDER BY
     balance DESC;

   {% include copy.html %}

3. View the results.

   • View the results in the Results pane, which presents the query output in tabular format. You can filter and download the results as needed.

   The following image shows the query editor pane and results pane for the preceding SQL query:

   

4. Clear the query editor.

   • Select the Clear button to clear the query editor and run a new query.

5. Examine how the query is processed.

   • Select the Explain button to examine how OpenSearch processes the query, including the steps involved and order of operations.

   The following image shows the explanation of the SQL query that was run in step 2.

   

Running PPL queries within Query Workbench

Follow these steps to learn how to run PPL queries against your OpenSearch data using Query Workbench:

1. Access Query Workbench.

   • To access Query Workbench, go to OpenSearch Dashboards and choose OpenSearch Plugins > Query Workbench from the main menu.

2. Run a query.

   • Select the PPL button. In the query editor, type a PPL query and then select the Run button to run the query.

   The following is an example query that retrieves the firstname and lastname fields for documents in the accounts index with age greater than 18:

   search source=accounts
   | where age > 18
   | fields firstname, lastname

   {% include copy.html %}

3. View the results.

   • View the results in the Results pane, which presents the query output in tabular format.

   The following image shows the query editor pane and results pane for the PPL query that was run in step 2:

   

4. Clear the query editor.

   • Select the Clear button to clear the query editor and run a new query.

5. Examine how the query is processed.

   • Select the Explain button to examine how OpenSearch processes the query, including the steps involved and order of operations.

   The following image shows the explanation of the PPL query that was run in step 2.

   

Query Workbench does not support delete or update operations through SQL or PPL. Access to data is read-only. {: .important}