Skip to content
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.

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

Add DQL guide #5684

Merged
merged 11 commits into from
Dec 12, 2023
Merged

Add DQL guide #5684

merged 11 commits into from
Dec 12, 2023

Conversation

kolchfa-aws
Copy link
Collaborator

@kolchfa-aws kolchfa-aws commented Nov 27, 2023

Add DQL guide

Closes #4063

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.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor edits. Great writing and depth of information. Users now have a much better understanding of DQL.

_dashboards/dql.md Outdated Show resolved Hide resolved
_dashboards/dql.md Outdated Show resolved Hide resolved
kolchfa-aws and others added 3 commits December 11, 2023 11:40
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!

@@ -78,13 +78,9 @@ You'll see a view similar to the one in the following image.

## Searching the data

You can use the search toolbar or enter a [DQL]({{site.url}}{{site.baseurl}}/dashboards/discover/dql/) query using the **DevTools** console to search data. While the search toolbar is best for basic queries, such as field name queries, DQL is best for complex queries, such as term, string, Boolean, date, range, or nested queries. DQL provides suggestions for fields and operators as you type, helping you build structured queries.
You can use the search toolbar to enter a [DQL]({{site.url}}{{site.baseurl}}/dashboards/discover/dql/) or [query string]({{site.url}}{{site.baseurl}}/query-dsl/full-text/query-string/) query. The search toolbar is best for basic queries; for full query and filter capability, use [query DSL]({{site.url}}{{site.baseurl}}/query-dsl/index/) in the [Dev Tools console]({{site.url}}{{site.baseurl}}/dashboards/dev-tools/index-dev/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this is the first appearance of DSL, so please define.

_dashboards/dql.md Outdated Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dql-interface.png" alt="Search term using DQL toolbar in Dashboard" width="500">

Before you can search data in Dashboards, you must index it. In OpenSearch, the basic unit of data is a JSON document. Within an index, OpenSearch identifies each document using a unique ID. To learn more about indexing in OpenSearch, see [Index data]({{site.url}}{{site.baseurl}}/opensearch/index-data).
{: .note purple}
DQL and Query string query (Lucene) language are the two language options for the search bar in Discover and Dashboards. To compare these language options, see [Discover and Dashboard search bar]({{site.url}}{{site.baseurl}}/dashboards/index/#discover-and-dashboard-search-bar).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would switch the order of the languages so that you don't have the odd capitalization.

_dashboards/dql.md Outdated Show resolved Hide resolved
_dashboards/dql.md Outdated Show resolved Hide resolved

The following table compares DQL and Query string query language features.

DQL and Query string query language | DQL | Query string query language
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same

_query-dsl/full-text/query-string.md Outdated Show resolved Hide resolved
![Using query string syntax in OpenSearch Dashboards Discover]({{site.url}}{{site.baseurl}}/images/discover-lucene-syntax.png)
For more information, see [Discover]({{site.url}}{{site.baseurl}}/dashboards/discover/index-discover/).

DQL and Query string query (Lucene) language are the two language options for the search bar in Discover and Dashboards. To compare these language options, see [Discover and Dashboard search bar]({{site.url}}{{site.baseurl}}/dashboards/index/#discover-and-dashboard-search-bar).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would switch the order of the languages so that you don't have the capitalization in the middle of the sentence.

_query-dsl/full-text/query-string.md Outdated Show resolved Hide resolved
_dashboards/dql.md Outdated Show resolved Hide resolved
kolchfa-aws and others added 4 commits December 12, 2023 10:43
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolchfa-aws kolchfa-aws merged commit f989581 into main Dec 12, 2023
4 checks passed
@kolchfa-aws kolchfa-aws added the backport 2.11 PR: Backport label for 2.11 label Dec 12, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 12, 2023
* Add DQL guide

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add all language options and setup steps

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Delete unused images

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revised intro sentences

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Minor rewording

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed query descriptions and added example

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _dashboards/dql.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* More editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
(cherry picked from commit f989581)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws pushed a commit that referenced this pull request Dec 12, 2023
* Add DQL guide



* Add all language options and setup steps



* Delete unused images



* Revised intro sentences



* Apply suggestions from code review




* Minor rewording



* Changed query descriptions and added example



* Apply suggestions from code review




* Update _dashboards/dql.md




* More editorial comments



---------





(cherry picked from commit f989581)

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
vagimeli added a commit that referenced this pull request Dec 21, 2023
* Add DQL guide

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Add all language options and setup steps

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Delete unused images

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Revised intro sentences

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Minor rewording

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Changed query descriptions and added example

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Update _dashboards/dql.md

Co-authored-by: Nathan Bower <nbower@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* More editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

---------

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
Co-authored-by: Melissa Vagi <vagimeli@amazon.com>
Co-authored-by: Nathan Bower <nbower@amazon.com>
@kolchfa-aws kolchfa-aws added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 labels Jan 24, 2024
@kolchfa-aws kolchfa-aws added backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 backport 2.7 PR: Backport label for 2.7 backport 2.8 PR: Backport label for 2.8 backport 2.9 PR: Backport label for 2.9 backport 2.10 PR: Backport label for 2.10 labels Jan 24, 2024
@opensearch-trigger-bot
Copy link

The backport to 2.1 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.1 2.1
# Navigate to the new working tree
pushd ../.worktrees/backport-2.1
# Create a new branch
git switch --create backport/backport-5684-to-2.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.1.

@opensearch-trigger-bot
Copy link

The backport to 2.9 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.9 2.9
# Navigate to the new working tree
pushd ../.worktrees/backport-2.9
# Create a new branch
git switch --create backport/backport-5684-to-2.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.9.

@opensearch-trigger-bot
Copy link

The backport to 2.3 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.3 2.3
# Navigate to the new working tree
pushd ../.worktrees/backport-2.3
# Create a new branch
git switch --create backport/backport-5684-to-2.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.3.

@opensearch-trigger-bot
Copy link

The backport to 2.8 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.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-5684-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.8.

@opensearch-trigger-bot
Copy link

The backport to 2.10 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.10 2.10
# Navigate to the new working tree
pushd ../.worktrees/backport-2.10
# Create a new branch
git switch --create backport/backport-5684-to-2.10
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.10.

@opensearch-trigger-bot
Copy link

The backport to 2.7 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.7 2.7
# Navigate to the new working tree
pushd ../.worktrees/backport-2.7
# Create a new branch
git switch --create backport/backport-5684-to-2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.7.

@opensearch-trigger-bot
Copy link

The backport to 1.3 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-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-5684-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

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

@opensearch-trigger-bot
Copy link

The backport to 2.2 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.2 2.2
# Navigate to the new working tree
pushd ../.worktrees/backport-2.2
# Create a new branch
git switch --create backport/backport-5684-to-2.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.2.

@opensearch-trigger-bot
Copy link

The backport to 2.6 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.6 2.6
# Navigate to the new working tree
pushd ../.worktrees/backport-2.6
# Create a new branch
git switch --create backport/backport-5684-to-2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.6.

@opensearch-trigger-bot
Copy link

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-5684-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.0.

@opensearch-trigger-bot
Copy link

The backport to 2.5 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.5 2.5
# Navigate to the new working tree
pushd ../.worktrees/backport-2.5
# Create a new branch
git switch --create backport/backport-5684-to-2.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.5.

@opensearch-trigger-bot
Copy link

The backport to 2.4 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.4 2.4
# Navigate to the new working tree
pushd ../.worktrees/backport-2.4
# Create a new branch
git switch --create backport/backport-5684-to-2.4
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-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-5684-to-2.4.

@Naarcha-AWS Naarcha-AWS deleted the dql-update branch March 28, 2024 23:22
@kolchfa-aws kolchfa-aws added backport 1.3 PR: Backport label for v1.3.x and removed backport 1.3 PR: Backport label for v1.3.x labels Aug 15, 2024
@opensearch-trigger-bot
Copy link

The backport to 1.3 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-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-5684-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 f989581cd2be402691b3f525509ae63d9b2a3ab4
# Push it to GitHub
git push --set-upstream origin backport/backport-5684-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

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

@kolchfa-aws kolchfa-aws mentioned this pull request Aug 15, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 backport 2.7 PR: Backport label for 2.7 backport 2.8 PR: Backport label for 2.8 backport 2.9 PR: Backport label for 2.9 backport 2.10 PR: Backport label for 2.10 backport 2.11 PR: Backport label for 2.11
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Address feedback on DQL documentation
3 participants