-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Adds search-related query parameters to the common parameters #46057
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -7,11 +7,34 @@ parameter also applies to <<indices-aliases,index aliases>> that point to a | |||||
missing or closed index. | ||||||
end::allow-no-indices[] | ||||||
|
||||||
tag::analyzer[] | ||||||
analyzer`:: | ||||||
(Optional, string) Defines the analyzer to use for the query string. | ||||||
end::analyzer[] | ||||||
|
||||||
tag::analyze_wildcard[] | ||||||
`analyze_wildcard`:: | ||||||
(Optional, boolean) If `true`, wildcard and prefix queries will also be | ||||||
analyzed. Defaults to `false`. | ||||||
end::analyze_wildcard[] | ||||||
|
||||||
tag::bytes[] | ||||||
`bytes`:: | ||||||
(Optional, <<byte-units,byte size units>>) Unit used to display byte values. | ||||||
end::bytes[] | ||||||
|
||||||
tag::default_operator[] | ||||||
`default_operator`:: | ||||||
(Optional, string) The default operator for query string query: AND or OR. | ||||||
Defaults to `OR`. | ||||||
end::default_operator[] | ||||||
|
||||||
tag::df[] | ||||||
`df`:: | ||||||
(Optional, string) Defines the field to use as default where no field prefix is | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
given in the query string. | ||||||
end::df[] | ||||||
|
||||||
tag::expand-wildcards[] | ||||||
`expand_wildcards`:: | ||||||
+ | ||||||
|
@@ -44,6 +67,11 @@ tag::flat-settings[] | |||||
`false`. | ||||||
end::flat-settings[] | ||||||
|
||||||
tag::from[] | ||||||
`from`:: | ||||||
(Optional, integer) Defines the starting offset. Defaults to `0`. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
end::from[] | ||||||
|
||||||
tag::help[] | ||||||
`help`:: | ||||||
(Optional, boolean) If `true`, the response returns help information. Defaults | ||||||
|
@@ -88,6 +116,12 @@ tag::index[] | |||||
used to limit the request. | ||||||
end::index[] | ||||||
|
||||||
tag::lenient[] | ||||||
`lenient`:: | ||||||
(Optional, boolean) If `true`, format-based query failures (such as | ||||||
providing text to a numeric field) will be ignored. Defaults to `false`. | ||||||
end::lenient[] | ||||||
|
||||||
tag::local[] | ||||||
`local`:: | ||||||
(Optional, boolean) If `true`, the request retrieves information from the local | ||||||
|
@@ -106,18 +140,70 @@ tag::node-id[] | |||||
returned information. | ||||||
end::node-id[] | ||||||
|
||||||
tag::search-q[] | ||||||
`q`:: | ||||||
(Optional, string) Query in the Lucene query string syntax. | ||||||
end::search-q[] | ||||||
|
||||||
tag::cat-s[] | ||||||
`s`:: | ||||||
(Optional, string) Comma-separated list of column names or column aliases used | ||||||
to sort the response. | ||||||
end::cat-s[] | ||||||
|
||||||
tag::search_type[] | ||||||
`search_type`:: | ||||||
(Optional, string) Defines the type of the search operation. Available options: | ||||||
* `query_then_fetch` | ||||||
* `dfs_query_then_fetch` | ||||||
end::search_type[] | ||||||
|
||||||
tag::search_timeout[] | ||||||
`search_timeout`:: | ||||||
(Optional, <<time-units, time units>> Explicit timeout for each search | ||||||
request. Defaults to no timeout. | ||||||
end::search_timeout[] | ||||||
|
||||||
tag::sort[] | ||||||
`sort`:: | ||||||
(Optional, string) A comma-separated list of <field>:<direction> pairs. | ||||||
end::sort[] | ||||||
|
||||||
tag::source[] | ||||||
`_source`:: | ||||||
(Optional, string) True or false to return the `_source` field or not, or a | ||||||
list of fields to return. | ||||||
end::source[] | ||||||
|
||||||
tag::source_excludes[] | ||||||
`_source_excludes`:: | ||||||
(Optional, string) A list of fields to exclude from the returned `_source` | ||||||
field. | ||||||
end::source_excludes[] | ||||||
|
||||||
tag::source_includes[] | ||||||
`_source_includes`:: | ||||||
(Optional, string) A list of fields to extract and return from the `_source` | ||||||
field. | ||||||
end::source_includes[] | ||||||
|
||||||
tag::terminate_after[] | ||||||
`terminate_after`:: | ||||||
(Optional, integer) The maximum number of documents to collect for each shard, | ||||||
upon reaching which the query execution will terminate early. | ||||||
end::terminate_after[] | ||||||
|
||||||
tag::cat-v[] | ||||||
`v`:: | ||||||
(Optional, boolean) If `true`, the response includes column headings. Defaults | ||||||
to `false`. | ||||||
end::cat-v[] | ||||||
|
||||||
tag::version[] | ||||||
`version`:: | ||||||
(Optional, boolean) If `true`, returns the document version as part of a hit. | ||||||
end::version[] | ||||||
|
||||||
tag::doc-pipeline[] | ||||||
`pipeline`:: | ||||||
(Optional, string) ID of the pipeline to use to preprocess incoming documents. | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.