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

dayOfWeekUS

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

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

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

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

@get:JvmName(name = "dayOfWeekUSOfObjectId")

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

@get:JvmName(name = "dayOfWeekUSOfObjectId")

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

@get:JvmName(name = "dayOfWeekUSOfObjectId")

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

@get:JvmName(name = "dayOfWeekUSOfObjectId")

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

@get:JvmName(name = "dayOfWeekUSOfTimestamp")

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

@get:JvmName(name = "dayOfWeekUSOfTimestamp")

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

@get:JvmName(name = "dayOfWeekUSOfTimestamp")

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

@get:JvmName(name = "dayOfWeekUSOfTimestamp")

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

Returns the day of the week for a date as a number between 1 (Sunday) and 7 (Saturday).

To use ISO 8601 day-of-week numbering (1 for Monday to 7 for Sunday), see dayOfWeekISO.

The accepted date types are Instant, ObjectId and Timestamp.

Example

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

users.updateManyWithPipeline {
    set {
        User::birthdayOfWeekUS set User::birthdate.dayOfWeekUS
    }
}

External resources

Official documentation