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

An FTS query that matches on Couchbase document IDs. Useful to restrict the search space to a list of keys (by using this in an AbstractCompoundQuery compound query).

docIds

list of document IDs to be restricted against. At least one ID is required.

Since

1.0.0

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

    docIds

    list of document IDs to be restricted against. At least one ID is required.

Value Members

  1. def boost(boost: Double): DocIdQuery

    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 productElementNames: Iterator[String]
    Definition Classes
    Product
  3. def productIterator: Iterator[Any]
    Definition Classes
    Product
  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