kmongo / org.litote.kmongo / kotlin.reflect.KProperty / regex

regex

infix fun KProperty<String?>.regex(regex: String): Bson (source)
infix fun KProperty<String?>.regex(regex: Pattern): Bson (source)
@JvmName("regexIterable") infix fun KProperty<Iterable<String?>>.regex(regex: String): Bson (source)
@JvmName("regexIterable") infix fun KProperty<Iterable<String?>>.regex(regex: Pattern): Bson (source)

Creates a filter that matches all documents where the value of the property matches the given regular expression pattern.

Parameters

pattern - the pattern

Return
the filter

Mongodb
.driver.manual reference/operator/query/regex $regex

fun KProperty<String?>.regex(pattern: String, options: String): Bson (source)
@JvmName("regexIterable") fun KProperty<Iterable<String?>>.regex(pattern: String, options: String): Bson (source)

Creates a filter that matches all documents where the value of the option matches the given regular expression pattern with the given options applied.

Parameters

pattern - the pattern

options - the options

Return
the filter

Mongodb
.driver.manual reference/operator/query/regex $regex

infix fun KProperty<String?>.regex(regex: Regex): Bson (source)
@JvmName("regexIterable") infix fun KProperty<Iterable<String?>>.regex(regex: Regex): Bson (source)

Creates a filter that matches all documents where the value of the property matches the given regular expression pattern.

Parameters

regex - the regex

Return
the filter

Mongodb
.driver.manual reference/operator/query/regex $regex