Adds query string query documentation #2427

kolchfa-aws · 2023-01-19T13:52:33Z

Adds query string query documentation

Checklist

[x ] 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>

vagimeli

Great writing. Minimal comments. LGTM

vagimeli · 2023-01-19T14:41:38Z

_opensearch/query-dsl/query-string.md

+
+## Parameters
+
+Query string query supports the following parameters. All parameters except `query` are optional.


Should this follow the same format as the first sentence, that is, "query string query?"

vagimeli · 2023-01-19T14:47:04Z

_opensearch/query-dsl/query-string.md

+`fields` | String array | The list of fields to search (for example, `"fields": ["title^4", "description"]`). Supports wildcards.
+`default_field` | String | The field in which to search if the field is not specified in the query string. Supports wildcards. Defaults to the value specified in the `index.query.default_field` index setting. By default, the `index.query.default_field` is `*`, which means extract all fields eligible for term query and filter the metadata fields. The extracted fields are combined into a query if the `prefix` is not specified. Eligible fields do not include nested documents. Searching all eligible fields could be a resource-intensive operation. The `indices.query.bool.max_clause_count` search setting defines the maximum value for the product of the number of fields and the number of terms that can be queried at one time. The default value for `indices.query.bool.max_clause_count` is 4,096.
+`allow_leading_wildcard` | Boolean | Specifies whether `*` and `?` are allowed as first characters of a search term. Default is `true`.
+`analyze_wildcard` | Boolean | Specifies whether OpenSearch should attempt to analyze wildcard terms. Some analyzers do a poor job at this task, so the default is `false`.


Are we saying that some of OpenSearch analyzers do a poor job? Do we need to qualify why the default is false? Suggestion: Delete the qualifier so the sentence reads "The default is false."

Could not find any justification as to why the default is false, so removing the justification.

_opensearch/query-dsl/query-string.md

hdhalter

Do we say anywhere why they would do this? For example, "You can search your rollup indexes using query string search queries." Or this, taken from the release blog: "OpenSearch users use index rollups to compress older time-series data into summarized indexes, reducing data granularity and offering potential improvements in storage costs and performance. You can use query string queries to search your rollup indexes and find the data you’re looking for."

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

kolchfa-aws · 2023-01-19T16:39:31Z

This PR will be backported to previous versions, so I won't mention rollups here since it's only 2.5 and above. We can add when we enhance this doc in a separate PR

* Adds query string query documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a description Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> (cherry picked from commit a2b3c38)

* Adds query string query documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a description Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> (cherry picked from commit a2b3c38) Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>

* Adds query string query documentation Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Implemented doc review comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Added a description Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

This reverts commit 6603ab4.

This reverts commit 6fb83d8.

Adds query string query documentation

2f02abb

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

kolchfa-aws self-assigned this Jan 19, 2023

kolchfa-aws requested a review from a team as a code owner January 19, 2023 13:52

vagimeli approved these changes Jan 19, 2023

View reviewed changes

hdhalter reviewed Jan 19, 2023

View reviewed changes

kolchfa-aws added 2 commits January 19, 2023 10:45

Implemented doc review comments

7e4452c

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

Added a description

6cd53c9

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

Naarcha-AWS mentioned this pull request Jan 19, 2023

Add Query String for rollups #2428

Merged

1 task

Naarcha-AWS approved these changes Jan 19, 2023

View reviewed changes

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 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 labels Jan 19, 2023

kolchfa-aws merged commit a2b3c38 into main Jan 19, 2023

opensearch-trigger-bot bot mentioned this pull request Jan 19, 2023

[Backport 1.3] Adds query string query documentation #2429

Merged

opensearch-trigger-bot bot mentioned this pull request Jan 19, 2023

[Backport 2.0] Adds query string query documentation #2430

Merged

This was referenced Jan 19, 2023

[Backport 2.1] Adds query string query documentation #2431

Merged

[Backport 2.2] Adds query string query documentation #2432

Merged

opensearch-trigger-bot bot mentioned this pull request Jan 19, 2023

[Backport 2.3] Adds query string query documentation #2433

Merged

opensearch-trigger-bot bot mentioned this pull request Jan 19, 2023

[Backport 2.4] Adds query string query documentation #2434

Merged

vagimeli added a commit that referenced this pull request Jan 26, 2023

Revert "Adds query string query documentation (#2427)"

e4d4db1

This reverts commit 6603ab4.

vagimeli added a commit that referenced this pull request Jan 30, 2023

Revert "Adds query string query documentation (#2427)"

643a5d9

This reverts commit 6fb83d8.

Naarcha-AWS deleted the new-query-string-query branch March 28, 2024 23:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds query string query documentation #2427

Adds query string query documentation #2427

kolchfa-aws commented Jan 19, 2023

vagimeli left a comment

vagimeli Jan 19, 2023

vagimeli Jan 19, 2023

kolchfa-aws Jan 19, 2023

hdhalter left a comment •

edited

Loading

kolchfa-aws commented Jan 19, 2023


		## Parameters

		Query string query supports the following parameters. All parameters except `query` are optional.

Adds query string query documentation #2427

Adds query string query documentation #2427

Conversation

kolchfa-aws commented Jan 19, 2023

Checklist

vagimeli left a comment

Choose a reason for hiding this comment

vagimeli Jan 19, 2023

Choose a reason for hiding this comment

vagimeli Jan 19, 2023

Choose a reason for hiding this comment

kolchfa-aws Jan 19, 2023

Choose a reason for hiding this comment

hdhalter left a comment • edited Loading

Choose a reason for hiding this comment

kolchfa-aws commented Jan 19, 2023

hdhalter left a comment •

edited

Loading