kotlin-client/com.couchbase.client.kotlin.search/SearchQuery/Companion

Companion

Types

enum MatchOperator : Enum<SearchQuery.Companion.MatchOperator>

Functions

fun boolean(must: ConjunctionQuery? = null, should: DisjunctionQuery? = null, mustNot: DisjunctionQuery? = null): SearchQuery

A Boolean query

booleanField

fun booleanField(bool: Boolean, field: String): SearchQuery

A Boolean Field query. Searches for documents where field has the value bool.

conjunction

fun conjunction(conjuncts: List<SearchQuery>): ConjunctionQuery

fun conjunction(firstConjunct: SearchQuery, vararg remainingConjuncts: SearchQuery): ConjunctionQuery

A Conjunction query

custom

fun custom(customizer: MutableMap<String, Any?>.() -> Unit): SearchQuery

Escape hatch for specifying a custom query condition supported by Couchbase Server but not by this version of the SDK.

dateRange

fun dateRange(field: String = "_all", start: Instant? = null, inclusiveStart: Boolean = true, end: Instant? = null, inclusiveEnd: Boolean = false): SearchQuery

A Date Range query

disjunction

fun disjunction(disjuncts: List<SearchQuery>, min: Int = 1): DisjunctionQuery

fun disjunction(firstDisjunct: SearchQuery, vararg remainingDisjuncts: SearchQuery, min: Int = 1): DisjunctionQuery

A Disjunction query

documentId

fun documentId(ids: List<String>): SearchQuery

A DocId query. Searches for documents whose ID is one of ids.

geoDistance

fun geoDistance(location: GeoPoint, distance: GeoDistance, field: String = "_all"): SearchQuery

A Geo Point Distance query

geoShape

fun geoShape(shape: GeoShape, field: String = "_all"): SearchQuery

A Geo Bounded Rectangle query or Geo Bounded Polygon query. May also be used with GeoCircle.

match

fun match(match: String, field: String = "_all", analyzer: String? = null, operator: SearchQuery.Companion.MatchOperator = MatchOperator.OR, fuzziness: Int = 0, prefixLength: Int = 0): SearchQuery

A Match query.

matchAll

fun matchAll(): SearchQuery

A Match All query

matchNone

fun matchNone(): SearchQuery

A Match None query

matchPhrase

fun matchPhrase(matchPhrase: String, field: String = "_all", analyzer: String? = null): SearchQuery

A Match Phrase query

negation

fun negation(query: SearchQuery): SearchQuery

Searches for documents that don't match query.

numericRange

fun numericRange(field: String = "_all", min: Number? = null, inclusiveMin: Boolean = true, max: Number? = null, inclusiveMax: Boolean = false): SearchQuery

A Numeric Range query

phrase

fun phrase(terms: List<String>, field: String = "_all"): SearchQuery

A Phrase query

prefix

fun prefix(prefix: String, field: String = "_all"): SearchQuery

A Prefix query

queryString

fun queryString(queryString: String): SearchQuery

A Query String query.

regexp

fun regexp(regexp: String, field: String = "_all"): SearchQuery

A Regexp query

term

fun term(term: String, field: String = "_all", fuzziness: Int = 0, prefixLength: Int = 0): SearchQuery

A Term query

termRange

fun termRange(field: String = "_all", min: String? = null, inclusiveMin: Boolean = true, max: String? = null, inclusiveMax: Boolean = false): SearchQuery

A Term Range query

wildcard

fun wildcard(term: String, field: String = "_all"): SearchQuery

A Wildcard query