Prefix Query

A prefix query returns documents that contain terms starting with the specified prefix in a given field.

Example

import (
    es "github.com/elastic/go-elasticsearch/v8"

    "github.com/sdqri/effdsl/v2"
    mppq "github.com/sdqri/effdsl/v2/queries/matchphraseprefixquery"
)

query, err := effdsl.Define(
    effdsl.WithQuery(
        mppq.MatchPhrasePrefixQuery(
            "field_name",
            "some phrase prefix query",
            mppq.WithAnalyzer("my_analyzer"),
            mppq.WithSlop(2),
            mppq.WithMaxExpansions(10),
        ),
    ),
)

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

Parameters

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

• Query (string)
  (Required, positional) The text to search for 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.

• WithSlop (int)
  (Optional, Functional option) Maximum number of positions allowed between matching tokens for phrases. Defaults to 0.

• WithMaxExpansions (int)
  (Optional, Functional option) Maximum number of terms to which the last provided term will expand. Defaults to not expanding terms.

• WithZeroTermsQuery (ZeroTerms)
  (Optional, Functional option) Indicates what to do when the analyzed text contains no terms. Valid values are:

  • none (Default): No documents are returned if the analyzer removes all tokens.
  • all: Returns all documents, similar to a match_all query.

Additional Information

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

"github.com/sdqri/effdsl/v2"
pq "github.com/sdqri/effdsl/v2/queries/prefixquery"

)

query, err := effdsl.Define( effdsl.WithQuery( pq.PrefixQuery( "name", "al", ), ), )

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.

• Value (string)
  (Required, positional) The prefix you wish to match against terms in the provided field. This is a required parameter.

• WithRewrite (Rewrite)
  (Optional, Functional option) The method used to rewrite the query. Valid values are:

  • constant_score: Query is rewritten to a constant score query.
  • scoring_boolean: Query is rewritten to a scoring boolean query.
  • constant_score_boolean: Query is rewritten to a constant score boolean query.
  • top_terms_N: Query is rewritten to match the top N scoring terms.
  • top_terms_boost_N: Query is rewritten to match the top N scoring terms with boosting.
  • top_terms_blended_freqs_N: Query is rewritten to match the top N scoring terms with blended frequencies.

• WithCaseInsensitive (bool)
  (Optional, Functional option) Whether the query is case insensitive. Defaults to false.

Additional Information

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