case class TermQuery(term: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, field: Option[String] = None, boost: Option[Double] = None) extends SearchQuery with Product with Serializable

An FTS query that matches terms (without further analysis). Usually for debugging purposes, prefer using MatchQuery.

term

the exact string that will be searched for in the index

Since

1.0.0

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

Instance Constructors

  1. new TermQuery(term: String, fuzziness: Option[Int] = None, prefixLength: Option[Int] = None, field: Option[String] = None, boost: Option[Double] = None)

    term

    the exact string that will be searched for in the index

Value Members

  1. def boost(boost: Double): TermQuery

    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): TermQuery

    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 fuzziness(fuzziness: Int): TermQuery

    If a fuzziness is specified, variations of the term can be searched.

    If a fuzziness is specified, variations of the term can be searched. Additionally, if fuzziness is enabled then the prefix_length parameter is also taken into account (see below).

    For now the server interprets the fuzziness factor as a "Levenshtein edit distance" to apply on the term.

    returns

    a copy of this, for chaining

  4. def prefixLength(prefixLength: Int): TermQuery

    The prefix length only makes sense when fuzziness is enabled (see above).

    The prefix length only makes sense when fuzziness is enabled (see above). It allows to apply the fuzziness only on the part of the term that is after the prefix_length character mark.

    For example, with the term "something" and a prefix length of 4, only the "thing" part of the term will be fuzzy-searched, and rows must start with "some".

    returns

    a copy of this, for chaining

  5. def productElementNames: Iterator[String]
    Definition Classes
    Product
  6. def toString(): String

    returns

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

    Definition Classes
    SearchQuery → AnyRef → Any