Packages

case class SearchRow(index: String, id: String, score: Double, _explanation: Try[Array[Byte]], locations: Option[SearchRowLocations], fragments: Map[String, Seq[String]], fields: Try[Array[Byte]]) extends Product with Serializable

An FTS row (or "hit")

index

The name of the FTS pindex that gave this result.

id

The id of the matching document.

score

The score of this hit.

locations

This rows's location, as a SearchRowLocations.

fragments

The fragments for each field that was requested as highlighted. A fragment is an extract of the field's value where the matching terms occur. Matching terms are surrounded by a <match> tag.

fields

The value of each requested field, as a map. The key is the field.

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

Instance Constructors

  1. new SearchRow(index: String, id: String, score: Double, _explanation: Try[Array[Byte]], locations: Option[SearchRowLocations], fragments: Map[String, Seq[String]], fields: Try[Array[Byte]])

    index

    The name of the FTS pindex that gave this result.

    id

    The id of the matching document.

    score

    The score of this hit.

    locations

    This rows's location, as a SearchRowLocations.

    fragments

    The fragments for each field that was requested as highlighted. A fragment is an extract of the field's value where the matching terms occur. Matching terms are surrounded by a <match> tag.

    fields

    The value of each requested field, as a map. The key is the field.

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.

    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]
  3. val fragments: Map[String, Seq[String]]
  4. val id: String
  5. val index: String
  6. val locations: Option[SearchRowLocations]
  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. def productIterator: Iterator[Any]
    Definition Classes
    Product
  9. val score: Double