Skip to content

[DOCS] Reformat query string query#45296

Merged
jrodewig merged 5 commits intomasterfrom
query-string-query
Aug 12, 2019
Merged

[DOCS] Reformat query string query#45296
jrodewig merged 5 commits intomasterfrom
query-string-query

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Aug 7, 2019 •
edited
Loading

Updates the query_string query to use the new query format.

This creates separate sections for the example request, parameters, and notes.

This is part of #40977, an effort to standardize documentation for query types.

Preview

http://elasticsearch_45296.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/query-dsl-query-string-query.html

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.0.2 v7.1.2 v7.2.1 v7.4.0 v7.3.1 labels Aug 7, 2019
@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Aug 7, 2019

Pinging @elastic/es-docs

@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Aug 7, 2019

Pinging @elastic/es-search

@jrodewig jrodewig mentioned this pull request Aug 7, 2019
Closed
62 tasks
jrodewig
jrodewig commented Aug 7, 2019
View reviewed changes
docs/reference/query-dsl/match-query.asciidoc Outdated
Copy link
Copy Markdown
Contributor Author

@jrodewig jrodewig Aug 7, 2019

Choose a reason for hiding this comment

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

Reworded and moved to query-string-query.asciidoc:
https://github.com/elastic/elasticsearch/pull/45296/files#diff-d1da0885c6d0812eedd305523174ba5cR19

@jrodewig jrodewig force-pushed the query-string-query branch 4 times, most recently from 62bf3a6 to ecdd7d8 Compare August 7, 2019 18:13
@jrodewig jrodewig force-pushed the query-string-query branch from ecdd7d8 to 941e6a3 Compare August 7, 2019 18:45
mayya-sharipova
mayya-sharipova reviewed Aug 12, 2019
View reviewed changes
docs/reference/query-dsl/query-string-query.asciidoc Outdated
==== Example request

When running the following search, the `query_string` query splits `(new york
city) OR (big apple)` into two terms: `new york city` and `big apple`. The
Copy link
Copy Markdown
Contributor

@mayya-sharipova mayya-sharipova Aug 12, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

into two terms

term has another special meaning in ES/Lucene; a term is a unit of search - usually a token + field name . Let call these "into two parts"/"into two pieces of text" or something like this.

mayya-sharipova
mayya-sharipova reviewed Aug 12, 2019
View reviewed changes
docs/reference/query-dsl/query-string-query.asciidoc Outdated

When running the following search, the `query_string` query splits `(new york
city) OR (big apple)` into two terms: `new york city` and `big apple`. The
`content` field's analyzer then independently converts each term into tokens
Copy link
Copy Markdown
Contributor

@mayya-sharipova mayya-sharipova Aug 12, 2019

Choose a reason for hiding this comment

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

"term" - similarly here, it is better to call it something else.

mayya-sharipova
mayya-sharipova approved these changes Aug 12, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

@mayya-sharipova mayya-sharipova left a comment

Choose a reason for hiding this comment

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

Thanks @jrodewig. Nice work!

@jrodewig jrodewig merged commit c4bc45f into master Aug 12, 2019
@jrodewig jrodewig deleted the query-string-query branch August 12, 2019 15:17
@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Aug 12, 2019

Thanks for your review @mayya-sharipova!

jrodewig added a commit that referenced this pull request Aug 12, 2019
@jrodewig
[DOCS] Reformat query string query (#45296)
e3f618e
jrodewig added a commit that referenced this pull request Aug 12, 2019
@jrodewig
[DOCS] Reformat query string query (#45296)
ebdb195
jrodewig added a commit that referenced this pull request Aug 12, 2019
@jrodewig
[DOCS] Reformat query string query (#45296)
fa372a2
@jrodewig jrodewig mentioned this pull request Apr 28, 2020
Merged
jrodewig added a commit that referenced this pull request Apr 28, 2020
@jrodewig @geekpete
[DOCS] Warn about searching across all fields wt. query_string (#55853
3791a92 
)

Warn about potential performance impact when a large number of fields
is used with query string query and no default field.

Re-adds content from #35570.
That content was erroneously removed in #45296.

Co-authored-by: Peter Dyson <peter.dyson@geekpete.com>
jrodewig added a commit that referenced this pull request Apr 28, 2020
@jrodewig @geekpete
[DOCS] Warn about searching across all fields wt. query_string (#55853
452be22 
)

Warn about potential performance impact when a large number of fields
is used with query string query and no default field.

Re-adds content from #35570.
That content was erroneously removed in #45296.

Co-authored-by: Peter Dyson <peter.dyson@geekpete.com>
jrodewig added a commit that referenced this pull request Apr 28, 2020
@jrodewig @geekpete
[DOCS] Warn about searching across all fields wt. query_string (#55853
7da7fd0 
)

Warn about potential performance impact when a large number of fields
is used with query string query and no default field.

Re-adds content from #35570.
That content was erroneously removed in #45296.

Co-authored-by: Peter Dyson <peter.dyson@geekpete.com>
jrodewig added a commit that referenced this pull request Apr 28, 2020
@jrodewig @geekpete
[DOCS] Warn about searching across all fields wt. query_string (#55853
80177d8 
)

Warn about potential performance impact when a large number of fields
is used with query string query and no default field.

Re-adds content from #35570.
That content was erroneously removed in #45296.

Co-authored-by: Peter Dyson <peter.dyson@geekpete.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mayya-sharipova mayya-sharipova mayya-sharipova approved these changes

Assignees

No one assigned

Labels

>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.2.1 v7.3.1 v7.4.0 v8.0.0-alpha1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jrodewig @elasticmachine @mayya-sharipova @jakelandis