Skip to content

Commit bf863a2

Browse files
committed
Adding documentation for alternate multi-match syntax options.
Signed-off-by: forestmvey <[email protected]>
1 parent 52b8c05 commit bf863a2

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/user/dql/functions.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2931,12 +2931,20 @@ Description
29312931
>>>>>>>>>>>
29322932

29332933
``multi_match([field_expression+], query_expression[, option=<option_value>]*)``
2934+
``multi_match(query=query_expression+, fields=[field_expression+][, option=<option_value>]*)``
29342935

29352936
The multi_match function maps to the multi_match query used in search engine, to return the documents that match a provided text, number, date or boolean value with a given field or fields.
29362937
The **^** lets you *boost* certain fields. Boosts are multipliers that weigh matches in one field more heavily than matches in other fields. The syntax allows to specify the fields in double quotes, single quotes, in backtick or even without any wrap. All fields search using star ``"*"`` is also available (star symbol should be wrapped). The weight is optional and should be specified using after the field name, it could be delimeted by the `caret` character or by whitespace. Please, refer to examples below:
29372938

2939+
2940+
- ``MULTI_MATCH(...)``
2941+
- ``MULTIMATCH(...)``
2942+
- ``MULTIMATCHQUERY(...)``
2943+
29382944
| ``multi_match(["Tags" ^ 2, 'Title' 3.4, `Body`, Comments ^ 0.3], ...)``
29392945
| ``multi_match(["*"], ...)``
2946+
| ``multimatch(query='query value', fields=["Tags^2,Title^3.4,Body"], ...)``
2947+
| ``multimatchquery('query'='query value', 'fields'='Title', ...)``
29402948
29412949
Available parameters include:
29422950

0 commit comments

Comments
 (0)