Package com.couchbase.client.kotlin.search

Types

Link copied to clipboard
interface Category
Link copied to clipboard
class CategoryResult<T : Category>
Link copied to clipboard
class ConjunctionQuery : SearchQuery

Create an instance using SearchQuery.conjunction.

Link copied to clipboard
class DateFacet : SearchFacet
Link copied to clipboard
class DateFacetResult : FacetResult<DateRange>
Link copied to clipboard
class DateRange : Category

A named date range. May be unbounded at the start or end, but not both.

Link copied to clipboard
enum Direction : Enum<Direction>
Link copied to clipboard
class DisjunctionQuery : SearchQuery

Create an instance using SearchQuery.disjunction.

Link copied to clipboard
interface FacetResult<T : Category>
Link copied to clipboard
interface FacetResultAccessor
Link copied to clipboard
enum FieldType : Enum<FieldType>
Link copied to clipboard
class FrequentTerm(name: String) : Category

A term facet category returned by the server.

Link copied to clipboard
class GeoCircle(center: GeoPoint, radius: GeoDistance) : GeoShape
Link copied to clipboard
class GeoCoordinates : GeoPoint
Link copied to clipboard
class GeoDistance(value: Int, unit: GeoDistanceUnit)

Create instances using the Int extensions. Example:

Link copied to clipboard
enum GeoDistanceUnit : Enum<GeoDistanceUnit>
Link copied to clipboard
@SinceCouchbase(value = "6.5")
class GeoHash : GeoPoint
Link copied to clipboard
sealed class GeoPoint

No matter where you go, there you are.

Link copied to clipboard
@SinceCouchbase(value = "6.5.1")
class GeoPolygon(vertices: List<GeoPoint>) : GeoShape
Link copied to clipboard
class GeoRectangle(topLeft: GeoPoint, bottomRight: GeoPoint) : GeoShape
Link copied to clipboard
sealed class GeoShape
Link copied to clipboard
sealed class Highlight
Link copied to clipboard
class HighlightStyle
Link copied to clipboard
enum Missing : Enum<Missing>
Link copied to clipboard
enum Mode : Enum<Mode>
Link copied to clipboard
class NumericFacet : SearchFacet
Link copied to clipboard
class NumericFacetResult : FacetResult<NumericRange>
Link copied to clipboard
class NumericRange : Category

A named numeric range. May be unbounded on one end or the other, but not both.

Link copied to clipboard
sealed class Score
Link copied to clipboard
sealed class SearchFacet

A facet is like a histogram. For each document matching the search query, the server inspects a field of the document to see which bin (or "category") the field value belongs to.

Link copied to clipboard
sealed class SearchFlowItem
Link copied to clipboard
class SearchKeyset

Identifies a row in the result set, for use with keyset pagination.

Link copied to clipboard
class SearchMetadata(meta: CoreSearchMetaData, coreFacets: Map<String, CoreSearchFacetResult>) : SearchFlowItem, FacetResultAccessor

Metadata about query execution. Always the last item in the flow.

Link copied to clipboard
class SearchMetrics
Link copied to clipboard
sealed class SearchPage

Specifies the page to be returned by a search query.

Link copied to clipboard
sealed class SearchQuery : SearchSpec
Link copied to clipboard
class SearchResult(rows: List<SearchRow>, metadata: SearchMetadata) : FacetResultAccessor
Link copied to clipboard
class SearchRow : SearchFlowItem

One row of a Full-Text Search result.

Link copied to clipboard
class SearchRowLocation
Link copied to clipboard
sealed class SearchScanConsistency

Create instances using the consistentWith or notBounded factory methods.

Link copied to clipboard
class SearchSort

Specifies how to sort the results of a search query.

Link copied to clipboard
sealed class SearchSpec

A search specification ("spec" for short) that tells the server what to look for during a Full-Text Search.

Link copied to clipboard
class TermFacet : SearchFacet
Link copied to clipboard
class TermFacetResult : FacetResult<FrequentTerm>
Link copied to clipboard
sealed class VectorQuery : VectorSearchSpec
Link copied to clipboard
sealed class VectorSearchSpec : SearchSpec

A single vector query, or a compound vector query.

Functions

Link copied to clipboard
suspend fun Flow<SearchFlowItem>.execute(): SearchResult

Collects a search Flow into a QueryResult. Should only be called if the search results are expected to fit in memory.

inline suspend fun Flow<SearchFlowItem>.execute(crossinline rowAction: suspend (SearchRow) -> Unit): SearchMetadata

Collects a search Flow, passing each result row to the given lambda. Returns metadata about the query.