Packages

case class SearchRow extends Product with Serializable

An FTS row (or "hit").

Since

1.0.0

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

Value Members

  1. def explanationAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]

    If explain was set on the SearchQuery this will return an explanation of the match.

    If explain was set on the SearchQuery this will return an explanation of the match.

    The structure of the returned JSON is unspecified, and is not part of the public committed API.

    It can be returned in any supported JSON type, e.g. com.couchbase.client.scala.json.JsonObject. See a full list at these JSON docs

  2. def fieldsAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]

    The value of each requested field.

    The value of each requested field.

    It can be returned in any supported JSON type, e.g. com.couchbase.client.scala.json.JsonObject. See a full list at these JSON docs

  3. def fragments: Map[String, Seq[String]]

    Fragments contain the results of any requested highlighting.

  4. def id: String

    The id of the matching document.

  5. def index: String

    The name of the FTS index that gave this result.

  6. def locations: Option[SearchRowLocations]

    The location of this hit, if it was requested with com.couchbase.client.scala.search.SearchOptions.includeLocations.

  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. def score: Double

    The score of this hit.