KtMongo: MongoDB request DSL/opensavvy.ktmongo.dsl.aggregation.operators/DateTimeValueOperators/month

month

open val <R : Any> Value<R, Instant>.month: Value<R, Int>(source)

open val <R : Any> Field<R, Instant>.month: Value<R, Int>(source)

open val <R : Any> KProperty1<R, Instant>.month: Value<R, Int>(source)

open val Instant.month: Value<Any, Int>(source)

@get:JvmName(name = "monthOfObjectId")

val <R : Any> Value<R, ObjectId>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfObjectId")

val <R : Any> Field<R, ObjectId>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfObjectId")

val <R : Any> KProperty1<R, ObjectId>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfObjectId")

val ObjectId.month: Value<Any, Int>(source)

@get:JvmName(name = "monthOfTimestamp")

val <R : Any> Value<R, Timestamp>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfTimestamp")

val <R : Any> Field<R, Timestamp>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfTimestamp")

val <R : Any> KProperty1<R, Timestamp>.month: Value<R, Int>(source)

@get:JvmName(name = "monthOfTimestamp")

val Timestamp.month: Value<Any, Int>(source)

Returns the month of a date as a number between 1 and 12.

The accepted date types are Instant, ObjectId and Timestamp.

Example

class User(
    val name: String,
    val birthdate: Instant,
    val birthmonth: Int? = null,
)

users.updateManyWithPipeline {
    set {
        User::birthmonth set User::birthdate.month
    }
}

External resources

Official documentation