mongodb-driver-kotlin-extensions/com.mongodb.kotlin.client.model/Filters/regex

regex

@JvmName(name = "regexExt")
infix fun KProperty<String?>.regex(pattern: String): Bson
@JvmName(name = "regexExt")
infix fun KProperty<String?>.regex(pattern: Pattern): Bson
@JvmName(name = "regexIterableExt")
infix fun KProperty<Iterable<String?>>.regex(pattern: String): Bson
@JvmName(name = "regexIterableExt")
infix fun KProperty<Iterable<String?>>.regex(pattern: Pattern): Bson

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

Return

the filter

Parameters

pattern

the pattern

fun regex(property: KProperty<String?>, pattern: String): Bson
fun regex(property: KProperty<String?>, pattern: Pattern): Bson
@JvmName(name = "regexIterable")
fun regex(property: KProperty<Iterable<String?>>, pattern: String): Bson
@JvmName(name = "regexIterable")
fun regex(property: KProperty<Iterable<String?>>, pattern: Pattern): Bson

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

Return

the filter

Parameters

property

the data class property

pattern

the pattern

@JvmName(name = "regexExt")
fun KProperty<String?>.regex(pattern: String, options: String): Bson

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

Return

the filter

Parameters

pattern

the pattern

options

the options

fun regex(property: KProperty<String?>, pattern: String, options: String): Bson

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

Return

the filter

Parameters

property

the data class property

pattern

the pattern

options

the options

@JvmName(name = "regexExt")
infix fun KProperty<String?>.regex(regex: Regex): Bson
@JvmName(name = "regexIterableExt")
infix fun KProperty<Iterable<String?>>.regex(regex: Regex): Bson

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

Return

the filter

Parameters

regex

the regex

fun regex(property: KProperty<String?>, regex: Regex): Bson
@JvmName(name = "regexIterable")
fun regex(property: KProperty<Iterable<String?>>, regex: Regex): Bson

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

Return

the filter

Parameters

property

the data class property

regex

the regex

@JvmName(name = "regexIterableExt")
fun KProperty<Iterable<String?>>.regex(regex: String, options: String): Bson

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

Return

the filter

Parameters

regex

the regex pattern

options

the options

@JvmName(name = "regexIterable")
fun regex(property: KProperty<Iterable<String?>>, regex: String, options: String): Bson

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

Return

the filter

Parameters

property

the data class property

regex

the regex pattern

options

the options