Skip to content

Commit 6ba13e9

Browse files
szabostevedebadair
authored andcommitted
[DOCS] Adds search-related query parameters to the common parameters. (#46057)
@szabosteve Merging so I can make some additions. Will incorporate the comments from @jrodewig.
1 parent 47fd1f2 commit 6ba13e9

File tree

1 file changed

+86
-0
lines changed

1 file changed

+86
-0
lines changed

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,34 @@ parameter also applies to <<indices-aliases,index aliases>> that point to a
77
missing or closed index.
88
end::allow-no-indices[]
99

10+
tag::analyzer[]
11+
analyzer`::
12+
(Optional, string) Defines the analyzer to use for the query string.
13+
end::analyzer[]
14+
15+
tag::analyze_wildcard[]
16+
`analyze_wildcard`::
17+
(Optional, boolean) If `true`, wildcard and prefix queries will also be
18+
analyzed. Defaults to `false`.
19+
end::analyze_wildcard[]
20+
1021
tag::bytes[]
1122
`bytes`::
1223
(Optional, <<byte-units,byte size units>>) Unit used to display byte values.
1324
end::bytes[]
1425

26+
tag::default_operator[]
27+
`default_operator`::
28+
(Optional, string) The default operator for query string query: AND or OR.
29+
Defaults to `OR`.
30+
end::default_operator[]
31+
32+
tag::df[]
33+
`df`::
34+
(Optional, string) Defines the field to use as default where no field prefix is
35+
given in the query string.
36+
end::df[]
37+
1538
tag::expand-wildcards[]
1639
`expand_wildcards`::
1740
+
@@ -44,6 +67,11 @@ tag::flat-settings[]
4467
`false`.
4568
end::flat-settings[]
4669

70+
tag::from[]
71+
`from`::
72+
(Optional, integer) Defines the starting offset. Defaults to `0`.
73+
end::from[]
74+
4775
tag::help[]
4876
`help`::
4977
(Optional, boolean) If `true`, the response returns help information. Defaults
@@ -88,6 +116,12 @@ tag::index[]
88116
used to limit the request.
89117
end::index[]
90118

119+
tag::lenient[]
120+
`lenient`::
121+
(Optional, boolean) If `true`, format-based query failures (such as
122+
providing text to a numeric field) will be ignored. Defaults to `false`.
123+
end::lenient[]
124+
91125
tag::local[]
92126
`local`::
93127
(Optional, boolean) If `true`, the request retrieves information from the local
@@ -106,18 +140,70 @@ tag::node-id[]
106140
returned information.
107141
end::node-id[]
108142

143+
tag::search-q[]
144+
`q`::
145+
(Optional, string) Query in the Lucene query string syntax.
146+
end::search-q[]
147+
109148
tag::cat-s[]
110149
`s`::
111150
(Optional, string) Comma-separated list of column names or column aliases used
112151
to sort the response.
113152
end::cat-s[]
114153

154+
tag::search_type[]
155+
`search_type`::
156+
(Optional, string) Defines the type of the search operation. Available options:
157+
* `query_then_fetch`
158+
* `dfs_query_then_fetch`
159+
end::search_type[]
160+
161+
tag::search_timeout[]
162+
`search_timeout`::
163+
(Optional, <<time-units, time units>> Explicit timeout for each search
164+
request. Defaults to no timeout.
165+
end::search_timeout[]
166+
167+
tag::sort[]
168+
`sort`::
169+
(Optional, string) A comma-separated list of <field>:<direction> pairs.
170+
end::sort[]
171+
172+
tag::source[]
173+
`_source`::
174+
(Optional, string) True or false to return the `_source` field or not, or a
175+
list of fields to return.
176+
end::source[]
177+
178+
tag::source_excludes[]
179+
`_source_excludes`::
180+
(Optional, string) A list of fields to exclude from the returned `_source`
181+
field.
182+
end::source_excludes[]
183+
184+
tag::source_includes[]
185+
`_source_includes`::
186+
(Optional, string) A list of fields to extract and return from the `_source`
187+
field.
188+
end::source_includes[]
189+
190+
tag::terminate_after[]
191+
`terminate_after`::
192+
(Optional, integer) The maximum number of documents to collect for each shard,
193+
upon reaching which the query execution will terminate early.
194+
end::terminate_after[]
195+
115196
tag::cat-v[]
116197
`v`::
117198
(Optional, boolean) If `true`, the response includes column headings. Defaults
118199
to `false`.
119200
end::cat-v[]
120201

202+
tag::version[]
203+
`version`::
204+
(Optional, boolean) If `true`, returns the document version as part of a hit.
205+
end::version[]
206+
121207
tag::doc-pipeline[]
122208
`pipeline`::
123209
(Optional, string) ID of the pipeline to use to preprocess incoming documents.

0 commit comments

Comments
 (0)