case class MatchPhraseQuery(matchPhrase: String, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches several given terms (a "phrase"), applying further processing like analyzers to them.

matchPhrase

The input phrase to be matched against.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MatchPhraseQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SearchQuery
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MatchPhraseQuery(matchPhrase: String, analyzer: Option[String] = None, field: Option[String] = None, boost: Option[Double] = None)

    matchPhrase

    The input phrase to be matched against.

Value Members

  1. def analyzer(analyzer: String): MatchPhraseQuery

    Analyzers are used to transform input text into a stream of tokens for indexing.

    Analyzers are used to transform input text into a stream of tokens for indexing. The Server comes with built-in analyzers and the users can create their own.

    analyzer

    The string here is the name of the analyzer used.

    returns

    a copy of this, for chaining

  2. def boost(boost: Double): MatchPhraseQuery

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight (with a boost between 0 and 1)

    boost

    the boost parameter, which must be >= 0

    returns

    a copy of this, for chaining

  3. def field(field: String): MatchPhraseQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  4. def toString(): String

    returns

    the String representation of the FTS query, which is its JSON representation without global parameters.

    Definition Classes
    SearchQuery → AnyRef → Any