Skip to content

Match Query

A match query returns documents that match a provided text, number, date, or boolean value. The provided text is analyzed before matching.

Example

import (
    es "github.com/elastic/go-elasticsearch/v8"
    "github.com/sdqri/effdsl/v2"
    mq "github.com/sdqri/effdsl/queries/matchquery"
)

query, err := effdsl.Define(
    effdsl.WithQuery(
        mq.MatchQuery(
            "field_name",
            "some match query",
            mq.WithOperator(mq.AND),
            mq.WithFuzzinessParameter(mq.FuzzinessAUTO),
        ),
    ),
)

res, err := es.Search(
    es.Search.WithBody(strings.NewReader(query)),
)

Parameters

  • Field (string)
    (Required, positional) The field you wish to search. This is a required parameter.

  • Query (string)
    (Required, positional) The text, number, boolean value, or date you wish to find in the provided field. This is a required parameter.

  • WithAnalyzer (string)
    (Optional, Functional option) Analyzer used to convert the text in the query value into tokens. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.

  • WithAutoGenerateSynonymsPhrase (bool)
    (Optional, Functional option) If true, match phrase queries are automatically created for multi-term synonyms.

  • WithBoost (float64)
    (Optional, Functional option) Floating-point number used to decrease or increase the relevance scores of the query.

  • WithFuzzinessParameter (int)
    (Optional, Functional option) Maximum number of terms to which the query will expand.

  • WithMaxExpansions (int)
    (Optional, Functional option) Maximum number of terms to which the query will expand. Defaults to 50.

  • WithPrefixLength (int)
    (Optional, Functional option) Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

  • WithFuzzyTranspositions (bool)
    (Optional, Functional option) If true, edits for fuzzy matching include transpositions of two adjacent characters.

  • WithFuzzyRewrite (FuzzyRewrite)
    (Optional, Functional option) Method used to rewrite the query. See the rewrite parameter for valid values and more information.

  • WithOperator (Operator)
    (Optional, Functional option) Boolean logic used to interpret text in the query value. Valid values are:

    • OR (Default): For example, a query value of "capital of Hungary" is interpreted as "capital OR of OR Hungary".
    • AND: For example, a query value of "capital of Hungary" is interpreted as "capital AND of AND Hungary".

  • WithMinimumShouldMatch (string)
    (Optional, Functional option) Minimum number of clauses that must match for a document to be returned.

Additional Information

For more details on the match query and its parameters, refer to the official Elasticsearch documentation on match queries.