New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Add new documentation about Query Workbench #5378

Merged

vagimeli merged 24 commits into main from consolidated-dev-tools

Nov 2, 2023

Contributor

vagimeli commented Oct 23, 2023

Description

Add new documentation about query workbench

Issues Resolved

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.


          Add new documentation

6e5f517

Signed-off-by: Melissa Vagi <[email protected]>

vagimeli requested review from hdhalter, kolchfa-aws, Naarcha-AWS, ananzh, seanneumann, AMoo-Miki and natebower as code owners

October 23, 2023 21:34

vagimeli self-assigned this

vagimeli added 2 - In progress Content gap labels


          Update Query Workbench

01c5921

Signed-off-by: Melissa Vagi <[email protected]>

vagimeli mentioned this pull request

[DOC] Consolidated Dev Tools #2156

Closed

4 tasks

vagimeli linked an issue

that may be closed by this pull request

[DOC] Consolidated Dev Tools #2156

Closed

4 tasks

vagimeli added 3 commits

October 24, 2023 16:12


          Revise SQL, PPL, and Query Workbench content

585067b

Signed-off-by: Melissa Vagi <[email protected]>


          Merge branch 'main' into consolidated-dev-tools

40a7c59

Signed-off-by: Melissa Vagi <[email protected]>


          Revise SQL, PPL, and Query Workbench content

0d217e7

Signed-off-by: Melissa Vagi <[email protected]>

vagimeli commented

View reviewed changes

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

vagimeli commented

View reviewed changes

_dashboards/query-workbench.md Outdated


		<img src="{{site.url}}{{site.baseurl}}/images/dashboards/query-explain.png" alt="Query Workbench SQL query explanation pane" width="500">

		### Viewing indexes

Contributor Author

vagimeli Oct 24, 2023

Is there an option to save SQL and PPL queries?


          Merge branch 'main' into consolidated-dev-tools

4004ee8

Signed-off-by: Melissa Vagi <[email protected]>

Contributor Author

vagimeli commented Oct 25, 2023

@brijos Please review the Query Workbench draft content. I rewrote the currently published content and expanded on the tutorial. Who else should I tag for technical review? Thanks!

vagimeli added 8 commits

October 25, 2023 13:20


          Merge branch 'main' into consolidated-dev-tools

61d9308

Signed-off-by: Melissa Vagi <[email protected]>


          Edit PPL to remove redundant info

f7f69b4

Signed-off-by: Melissa Vagi <[email protected]>


          Fix link

2b8b515

Signed-off-by: Melissa Vagi <[email protected]>


          Fix link

285ab33

Signed-off-by: Melissa Vagi <[email protected]>


          Fix link

33c3da4

Signed-off-by: Melissa Vagi <[email protected]>


          Fix link

875803b

Signed-off-by: Melissa Vagi <[email protected]>


          Add dev doc section

8cea6f8

Signed-off-by: Melissa Vagi <[email protected]>


          Merge branch 'main' into consolidated-dev-tools

92ee945

Signed-off-by: Melissa Vagi <[email protected]>

kolchfa-aws reviewed

View reviewed changes

Collaborator

kolchfa-aws left a comment

Nice flow. Left some comments.

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated

+              ```sql
+              SELECT *
+              FROM <index_name>
+              WHERE <field_name> = <field_value>

Collaborator

kolchfa-aws Oct 31, 2023

WHERE can be more complex than this (this is the simplest example). I would use an actual example here because we're not teaching SQL, we're just showing how to run queries. For example,
SELECT *
FROM accounts
WHERE account_number = 1

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated Show resolved Hide resolved

_dashboards/query-workbench.md Outdated


		### Deleting data

		To delete a document from an index, run a `DELETE` statement with the `WHERE` clause. The following is the basic SQL syntax to delete a document from an index:

Collaborator

kolchfa-aws Oct 31, 2023

Same as above. The WHERE clause can be more complicated. Maybe remove this section altogether and make the previous section parallel to PPL?

Contributor Author

vagimeli Oct 31, 2023

Deleted the SQL sections about listing, retrieving, and deleting. If a developer wants to include this moving forward, we can have them write that information from the dev POV.

vagimeli added backport 2.8 backport 2.9 backport 2.10 backport 2.11 labels

vagimeli merged commit 9973d84 into main

vagimeli deleted the consolidated-dev-tools branch

November 2, 2023 22:39

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.0 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.0 2.0
# Navigate to the new working tree
pushd ../.worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-5378-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.0
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.0

Then, create a pull request where the base branch is 2.0 and the compare/head branch is backport/backport-5378-to-2.0.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.1 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.1 2.1
# Navigate to the new working tree
pushd ../.worktrees/backport-2.1
# Create a new branch
git switch --create backport/backport-5378-to-2.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.1
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.1

Then, create a pull request where the base branch is 2.1 and the compare/head branch is backport/backport-5378-to-2.1.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.2 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.2 2.2
# Navigate to the new working tree
pushd ../.worktrees/backport-2.2
# Create a new branch
git switch --create backport/backport-5378-to-2.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.2
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.2

Then, create a pull request where the base branch is 2.2 and the compare/head branch is backport/backport-5378-to-2.2.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.3 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.3 2.3
# Navigate to the new working tree
pushd ../.worktrees/backport-2.3
# Create a new branch
git switch --create backport/backport-5378-to-2.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.3

Then, create a pull request where the base branch is 2.3 and the compare/head branch is backport/backport-5378-to-2.3.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.4 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.4 2.4
# Navigate to the new working tree
pushd ../.worktrees/backport-2.4
# Create a new branch
git switch --create backport/backport-5378-to-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.4
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.4

Then, create a pull request where the base branch is 2.4 and the compare/head branch is backport/backport-5378-to-2.4.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.5 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.5 2.5
# Navigate to the new working tree
pushd ../.worktrees/backport-2.5
# Create a new branch
git switch --create backport/backport-5378-to-2.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.5
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.5

Then, create a pull request where the base branch is 2.5 and the compare/head branch is backport/backport-5378-to-2.5.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.6 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.6 2.6
# Navigate to the new working tree
pushd ../.worktrees/backport-2.6
# Create a new branch
git switch --create backport/backport-5378-to-2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.6
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.6

Then, create a pull request where the base branch is 2.6 and the compare/head branch is backport/backport-5378-to-2.6.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.7 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.7 2.7
# Navigate to the new working tree
pushd ../.worktrees/backport-2.7
# Create a new branch
git switch --create backport/backport-5378-to-2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.7
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.7

Then, create a pull request where the base branch is 2.7 and the compare/head branch is backport/backport-5378-to-2.7.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.8 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-5378-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8

Then, create a pull request where the base branch is 2.8 and the compare/head branch is backport/backport-5378-to-2.8.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.9 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.9 2.9
# Navigate to the new working tree
pushd ../.worktrees/backport-2.9
# Create a new branch
git switch --create backport/backport-5378-to-2.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.9
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.9

Then, create a pull request where the base branch is 2.9 and the compare/head branch is backport/backport-5378-to-2.9.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.10 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.10 2.10
# Navigate to the new working tree
pushd ../.worktrees/backport-2.10
# Create a new branch
git switch --create backport/backport-5378-to-2.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.10
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.10

Then, create a pull request where the base branch is 2.10 and the compare/head branch is backport/backport-5378-to-2.10.

Contributor

opensearch-trigger-bot bot commented Nov 2, 2023

The backport to 2.11 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.11 2.11
# Navigate to the new working tree
pushd ../.worktrees/backport-2.11
# Create a new branch
git switch --create backport/backport-5378-to-2.11
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 9973d8470ee30f9708ff1781165b1897355d5bdc
# Push it to GitHub
git push --set-upstream origin backport/backport-5378-to-2.11
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.11

Then, create a pull request where the base branch is 2.11 and the compare/head branch is backport/backport-5378-to-2.11.

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

cbc58b1

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378) (#5498)

4645bb8

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

8b15b5d

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

d6df57c

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378) (#5500)

1a51847

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

ca326c4

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378) (#5501)

c56e176

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

66b5197

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

stephen-crawford pushed a commit to stephen-crawford/documentation-website that referenced this pull request


          [DOC] Add new documentation about Query Workbench (opensearch-project…

0b4cffd

…#5378)

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378) (#5502)

63e80ce

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378) (#5503)

bbdd0a3

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
(cherry picked from commit 9973d84)

vagimeli added a commit that referenced this pull request


          [DOC] Add new documentation about Query Workbench (#5378)

32a1af4

* Rewrite Query Workbench

---------

Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

kolchfa-aws kolchfa-aws approved these changes

hdhalter Awaiting requested review from hdhalter

Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

ananzh Awaiting requested review from ananzh

seanneumann Awaiting requested review from seanneumann

AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

natebower Awaiting requested review from natebower natebower is a code owner

Labels

3 - Done backport 2.0 backport 2.1 backport 2.2 backport 2.3 backport 2.4 backport 2.5 backport 2.6 backport 2.7 backport 2.8 backport 2.9 backport 2.10 backport 2.11 Content gap