kdrant-core/dev.kdrant.dsl/ClauseBuilder

ClauseBuilder

DSL for the conditions inside a filter clause. Offers both function-style (match("city", "London"), range("price", gte = 100.0)) and infix-style ("city" eq "London", "price" between 100.0..450.0) entry points.

Constructors

ClauseBuilder

constructor()

Functions

between

infix fun String.between(bounds: ClosedFloatingPointRange<Double>)

Inclusive numeric range, e.g. "price" between 100.0..450.0.

datetimeRange

fun datetimeRange(key: String, gt: String? = null, gte: String? = null, lt: String? = null, lte: String? = null)

RFC 3339 datetime range condition; provide any subset of bounds.

infix fun String.eq(value: Any)

Infix form of match.

filter

fun filter(configure: FilterBuilder.() -> Unit)

A nested boolean sub-filter as a single condition (for grouping / de Morgan expressions).

geoBoundingBox

fun geoBoundingBox(key: String, topLeft: GeoPoint, bottomRight: GeoPoint)

Points within the given bounding box.

geoPolygon

fun geoPolygon(key: String, exterior: List<GeoPoint>, interiors: List<List<GeoPoint>> = emptyList())

Points inside exterior and outside every ring in interiors.

geoRadius

fun geoRadius(key: String, center: GeoPoint, radius: Double)

Points within radius metres of center.

infix fun String.gt(value: Number)

gte

infix fun String.gte(value: Number)

hasId

fun hasId(ids: List<PointId>)

fun hasId(vararg ids: PointId)

Point id is one of ids.

hasVector

fun hasVector(name: String)

The named vector is present ("" for the anonymous vector).

isEmpty

fun isEmpty(key: String)

Field missing, null, or an empty array.

isNull

fun isNull(key: String)

Field present but null.

infix fun String.lt(value: Number)

lte

infix fun String.lte(value: Number)

match

fun match(key: String, value: Any)

Exact value match. value must be a String, Number or Boolean.

matchAny

fun matchAny(key: String, values: Collection<Any>)

Value-in-set (any). Each value must be a String, Number or Boolean.

fun matchAny(key: String, vararg values: Any)

Value-in-set (any).

matchExcept

fun matchExcept(key: String, values: Collection<Any>)

fun matchExcept(key: String, vararg values: Any)

Value-not-in-set (except).

matchPhrase

fun matchPhrase(key: String, text: String)

Exact phrase match (order matters).

matchText

fun matchText(key: String, text: String)

Full-text match: all tokens present.

matchTextAny

fun matchTextAny(key: String, text: String)

Full-text match: at least one token present.

nested

fun nested(key: String, configure: FilterBuilder.() -> Unit)

Sub-filter evaluated per element of the array field key.

range

fun range(key: String, gt: Number? = null, gte: Number? = null, lt: Number? = null, lte: Number? = null)

Numeric range condition; provide any subset of bounds.

valuesCount

fun valuesCount(key: String, gt: Int? = null, gte: Int? = null, lt: Int? = null, lte: Int? = null)

Condition on the number of values in an array field.