case class PhraseQuery(terms: Seq[String], field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches several terms (a "phrase") as is. The order of the terms matter and no further processing is applied to them, so they must appear in the index exactly as provided. Usually for debugging purposes, prefer MatchPhraseQuery.

terms

The mandatory list of terms that must exactly match in the index. Must contain at least one term.

Since

1.0.0

Linear Supertypes
Serializable, Serializable, Product, Equals, SearchQuery, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PhraseQuery
  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 PhraseQuery(terms: Seq[String], field: Option[String] = None, boost: Option[Double] = None)

    terms

    The mandatory list of terms that must exactly match in the index. Must contain at least one term.

Value Members

  1. def boost(boost: Double): PhraseQuery

    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

  2. def field(field: String): PhraseQuery

    If specified, only this field will be matched.

    If specified, only this field will be matched.

    returns

    a copy of this, for chaining

  3. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any