You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: _dashboards/query-workbench.md
+12-34
Original file line number
Diff line number
Diff line change
@@ -8,19 +8,14 @@ redirect_from:
8
8
9
9
# Query Workbench
10
10
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/).
12
12
13
-
A view of the Query Workbench interface within OpenSearch Dashboards is shown in the following image.
14
-
15
-
<imgsrc="{{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}
20
15
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
22
17
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:
24
19
25
20
```json
26
21
PUT accounts/_bulk?refresh
@@ -35,9 +30,11 @@ PUT accounts/_bulk?refresh
35
30
```
36
31
{% include copy-curl.html %}
37
32
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.
39
34
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:
41
38
42
39
1. Access Query Workbench.
43
40
- 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
64
61
3. View the results.
65
62
- View the results in the **Results** pane, which presents the query output in tabular format. You can filter and download the results as needed.
66
63
67
-
The following image shows the query editor pane and results pane for the preceding SQL query:
0 commit comments