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

weekISO

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

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

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

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

@get:JvmName(name = "weekISOOfObjectId")

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

@get:JvmName(name = "weekISOOfObjectId")

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

@get:JvmName(name = "weekISOOfObjectId")

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

@get:JvmName(name = "weekISOOfObjectId")

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

@get:JvmName(name = "weekISOOfTimestamp")

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

@get:JvmName(name = "weekISOOfTimestamp")

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

@get:JvmName(name = "weekISOOfTimestamp")

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

@get:JvmName(name = "weekISOOfTimestamp")

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

Returns the week number in ISO 8601 format, ranging from 1 to 53.

Week numbers start at 1 with the week (Monday through Sunday) that contains the year's first Thursday.

The accepted date types are Instant, ObjectId and Timestamp.

Example

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

users.updateManyWithPipeline {
    set {
        User::birthweekISO set User::birthdate.weekISO
    }
}

External resources

Official documentation