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
- Alphabetic
- By Inheritance
- SearchRow
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
explanationAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]
If
explain
was set on theSearchQuery
this will return an explanation of the match.If
explain
was set on theSearchQuery
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 - def fieldsAs[T](implicit deserializer: JsonDeserializer[T]): Try[T]
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val fragments: Map[String, Seq[String]]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val id: String
- val index: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val locations: Option[SearchRowLocations]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val score: Double
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()