Skip to content

Commit ad0d76e

Browse files
authored
Delete graphs and copy edit (opensearch-project#8188)
* Delete graphs and copy edit Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Delete graphs and copy edit Signed-off-by: Melissa Vagi <vagimeli@amazon.com> * Delete graphs and copy edit Signed-off-by: Melissa Vagi <vagimeli@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com>
1 parent 12d82fa commit ad0d76e

File tree

1 file changed

+12
-34
lines changed

1 file changed

+12
-34
lines changed

_dashboards/query-workbench.md

+12-34
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,14 @@ redirect_from:
88

99
# Query Workbench
1010

11-
Query Workbench is a tool within OpenSearch Dashboards. You can use Query Workbench to run on-demand [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/sql/index/) and [PPL]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index/) queries, translate queries into their equivalent REST API calls, and view and save results in different [response formats]({{site.url}}{{site.baseurl}}/search-plugins/sql/response-formats/).
11+
You can use Query Workbench in OpenSearch Dashboards to run on-demand [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/sql/index/) and [PPL]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/index/) queries, translate queries into their equivalent REST API calls, and view and save results in different [response formats]({{site.url}}{{site.baseurl}}/search-plugins/sql/response-formats/).
1212

13-
A view of the Query Workbench interface within OpenSearch Dashboards is shown in the following image.
14-
15-
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-workbench-ui.png" alt="Query Workbench interface within OpenSearch Dashboards" width="700">
16-
17-
## Prerequisites
18-
19-
Before getting started, make sure you have [indexed your data]({{site.url}}{{site.baseurl}}/im-plugin/index/).
13+
Query Workbench does not support delete or update operations through SQL or PPL. Access to data is read-only.
14+
{: .important}
2015

21-
For this tutorial, you can index the following sample documents. Alternatively, you can use the [OpenSearch Playground](https://playground.opensearch.org/app/opensearch-query-workbench#/), which has preloaded indexes that you can use to try out Query Workbench.
16+
## Prerequisites
2217

23-
To index sample documents, send the following [Bulk API]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/) request:
18+
Before getting started with this tutorial, index the sample documents by sending the following [Bulk API]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/) request:
2419

2520
```json
2621
PUT accounts/_bulk?refresh
@@ -35,9 +30,11 @@ PUT accounts/_bulk?refresh
3530
```
3631
{% include copy-curl.html %}
3732

38-
## Running SQL queries within Query Workbench
33+
See [Managing indexes]({{site.url}}{{site.baseurl}}/im-plugin/index/) to learn about indexing your own data.
3934

40-
Follow these steps to learn how to run SQL queries against your OpenSearch data using Query Workbench:
35+
## Running SQL queries within Query Workbench
36+
37+
The following steps guide you through running SQL queries against OpenSearch data:
4138

4239
1. Access Query Workbench.
4340
- To access Query Workbench, go to OpenSearch Dashboards and choose **OpenSearch Plugins** > **Query Workbench** from the main menu.
@@ -64,23 +61,15 @@ Follow these steps to learn how to run SQL queries against your OpenSearch data
6461
3. View the results.
6562
- View the results in the **Results** pane, which presents the query output in tabular format. You can filter and download the results as needed.
6663

67-
The following image shows the query editor pane and results pane for the preceding SQL query:
68-
69-
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-workbench-query-step2.png" alt="Query Workbench SQL query input and results output panes" width="800">
70-
7164
4. Clear the query editor.
7265
- Select the **Clear** button to clear the query editor and run a new query.
7366

7467
5. Examine how the query is processed.
75-
- Select the **Explain** button to examine how OpenSearch processes the query, including the steps involved and order of operations.
76-
77-
The following image shows the explanation of the SQL query that was run in step 2.
78-
79-
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-explain.png" alt="Query Workbench SQL query explanation pane" width="500">
68+
- Select the **Explain** button to examine how OpenSearch processes the query, including the steps involved and order of operations.
8069

8170
## Running PPL queries within Query Workbench
8271

83-
Follow these steps to learn how to run PPL queries against your OpenSearch data using Query Workbench:
72+
Follow these steps to learn how to run PPL queries against OpenSearch data:
8473

8574
1. Access Query Workbench.
8675
- To access Query Workbench, go to OpenSearch Dashboards and choose **OpenSearch Plugins** > **Query Workbench** from the main menu.
@@ -100,19 +89,8 @@ Follow these steps to learn how to run PPL queries against your OpenSearch data
10089
3. View the results.
10190
- View the results in the **Results** pane, which presents the query output in tabular format.
10291

103-
The following image shows the query editor pane and results pane for the PPL query that was run in step 2:
104-
105-
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-workbench-ppl.png" alt="Query Workbench PPL query input and results output panes">
106-
10792
4. Clear the query editor.
10893
- Select the **Clear** button to clear the query editor and run a new query.
10994

11095
5. Examine how the query is processed.
111-
- Select the **Explain** button to examine how OpenSearch processes the query, including the steps involved and order of operations.
112-
113-
The following image shows the explanation of the PPL query that was run in step 2.
114-
115-
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-PPL-explain.png" alt="Query Workbench PPL query explanation pane" width="500">
116-
117-
Query Workbench does not support delete or update operations through SQL or PPL. Access to data is read-only.
118-
{: .important}
96+
- Select the **Explain** button to examine how OpenSearch processes the query, including the steps involved and order of operations.

0 commit comments

Comments
 (0)