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

dayOfYear

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

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

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

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

@get:JvmName(name = "dayOfYearOfObjectId")

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

@get:JvmName(name = "dayOfYearOfObjectId")

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

@get:JvmName(name = "dayOfYearOfObjectId")

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

@get:JvmName(name = "dayOfYearOfObjectId")

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

@get:JvmName(name = "dayOfYearOfTimestamp")

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

@get:JvmName(name = "dayOfYearOfTimestamp")

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

@get:JvmName(name = "dayOfYearOfTimestamp")

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

@get:JvmName(name = "dayOfYearOfTimestamp")

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

Returns the day of the year for a date as a number between 1 and 366.

The year starts on January 1st, so January 1st is day 1, and December 31st is day 365 (or 366 in a leap year).

The accepted date types are Instant, ObjectId and Timestamp.

Example

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

users.updateManyWithPipeline {
    set {
        User::birthdayOfYear set User::birthdate.dayOfYear
    }
}

External resources

Official documentation