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

year

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

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

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

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

@get:JvmName(name = "yearOfObjectId")

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

@get:JvmName(name = "yearOfObjectId")

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

@get:JvmName(name = "yearOfObjectId")

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

@get:JvmName(name = "yearOfObjectId")

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

@get:JvmName(name = "yearOfTimestamp")

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

@get:JvmName(name = "yearOfTimestamp")

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

@get:JvmName(name = "yearOfTimestamp")

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

@get:JvmName(name = "yearOfTimestamp")

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

Returns the year portion of a date.

The accepted date types are Instant, ObjectId and Timestamp.

Example

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

users.updateManyWithPipeline {
    set {
        User::birthyear set User::birthdate.year
    }
}

External resources

Official documentation