Type Members

1.  case class ReactiveSearchResult(rows: SFlux[SearchRow], facets: SMono[Map[String, SearchFacetResult]], meta: SMono[SearchMetaData]) extends Product with Serializable

   The results of an FTS query, as returned by the reactive API.

   The results of an FTS query, as returned by the reactive API.

   rows

   a Flux of any returned rows. If the FTS service returns an error while returning the rows, it will be raised on this Flux

   meta

   any additional information related to the FTS query

2.  sealed trait SearchFacetResult extends AnyRef

   Base interface for all facet results.

3.  case class SearchMetaData(metrics: SearchMetrics, errors: Map[String, String]) extends Product with Serializable

   Additional information returned by the FTS service after any rows and errors.

   Additional information returned by the FTS service after any rows and errors.

   metrics

   metrics related to the FTS request, if they are available

   errors

   any errors returned by the request. Note that FTS can return partial success: e.g. some rows in the presence of some errors

4.  case class SearchMetrics(took: Duration, totalRows: Long, maxScore: Double, totalPartitionCount: Long, successPartitionCount: Long, errorPartitionCount: Long) extends Product with Serializable

   Metrics and status of a given FTS request.

   Metrics and status of a given FTS request.

   took

   how long a request took executing on the server side

   totalRows

   number of rows returned

   maxScore

   the largest score amongst the rows.

   totalPartitionCount

   the total number of FTS pindexes that were queried.

   successPartitionCount

   the number of FTS pindexes queried that successfully answered.

   errorPartitionCount

   the number of FTS pindexes queried that gave an error. If > 0,

5.  case class SearchResult(_rows: Seq[SearchRow], facets: Map[String, SearchFacetResult], metaData: SearchMetaData) extends Product with Serializable

   The results of an FTS query.

   The results of an FTS query.

   facets

   any search facets returned

   metaData

   any additional information related to the FTS query

   Since

   1.0.0

6.  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")

   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

7.  case class SearchRowLocation(field: String, term: String, pos: Int, start: Int, end: Int, arrayPositions: Option[Seq[Int]]) extends Product with Serializable

   An FTS result row location indicates at which position a given term occurs inside a given field.

   An FTS result row location indicates at which position a given term occurs inside a given field. In case the field is an array, arrayPositions will indicate which index/indices in the array contain the term.

   Since

   1.0.0

8.  case class SearchRowLocations(locations: Map[String, Map[String, Seq[SearchRowLocation]]]) extends Product with Serializable

   Represents the locations of a search result row.

   Represents the locations of a search result row. Locations show where a given term occurs inside of a given field.

   Since

   1.0.0