mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
Adds `warnings` syntax to the yaml test that allows you to expect a `Warning` header that looks like: ``` - do: warnings: - '[index] is deprecated' - quotes are not required because yaml - but this argument is always a list, never a single string - no matter how many warnings you expect get: index: test type: test id: 1 ``` These are accessible from the docs with: ``` // TEST[warning:some warning] ``` This should help to force you to update the docs if you deprecate something. You *must* add the warnings marker to the docs or the build will fail. While you are there you *should* update the docs to add deprecation warnings visible in the rendered results.
47 lines
1.2 KiB
Plaintext
47 lines
1.2 KiB
Plaintext
[[query-dsl-prefix-query]]
|
|
=== Prefix Query
|
|
|
|
Matches documents that have fields containing terms with a specified
|
|
prefix (*not analyzed*). The prefix query maps to Lucene `PrefixQuery`.
|
|
The following matches documents where the user field contains a term
|
|
that starts with `ki`:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{ "query": {
|
|
"prefix" : { "user" : "ki" }
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
A boost can also be associated with the query:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{ "query": {
|
|
"prefix" : { "user" : { "value" : "ki", "boost" : 2.0 } }
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
Or with the `prefix` deprecated[5.0.0, Use `value`] syntax:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_search
|
|
{ "query": {
|
|
"prefix" : { "user" : { "prefix" : "ki", "boost" : 2.0 } }
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[warning:Deprecated field [prefix] used, expected [value] instead]
|
|
|
|
This multi term query allows you to control how it gets rewritten using the
|
|
<<query-dsl-multi-term-rewrite,rewrite>>
|
|
parameter.
|