kotlin-client/com.couchbase.client.kotlin.search/SearchRow

SearchRow

class SearchRow : SearchFlowItem

One row of a Full-Text Search result.

Represents a document matching the query condition.

Types

object Companion

Properties

val explanation: ByteArray

Bytes of a JSON Object explaining how the score was calculated, or an empty array if the explain parameter was false.

val fields: ByteArray?

The bytes of a JSON Object that has the requested document fields, or null if no fields were requested (or none of the requested fields are stored).

val fragments: Map<String, List<String>>

A map from field name to a list of text fragments from that field containing one or more highlighted match terms.

Document ID.

val index: String

Name of this index this row came from.

val keyset: SearchKeyset

Identifies this row's position in the full, unpaginated search results. In order for this to be useful, the query's sort must impose a total ordering on the result set. This is typically done by including byId() as the last sort tier.

val locations: List<SearchRowLocation>

Where the match terms appear in the document.

val score: Double

Score assigned to this document (higher means better match).

Functions

inline fun <T> fieldsAs(serializer: JsonSerializer? = null): T?

Returns fields deserialized into an object of the requested type, or null if there are no fields.

open override fun toString(): String