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

hour

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

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

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

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

@get:JvmName(name = "hourOfObjectId")

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

@get:JvmName(name = "hourOfObjectId")

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

@get:JvmName(name = "hourOfObjectId")

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

@get:JvmName(name = "hourOfObjectId")

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

@get:JvmName(name = "hourOfTimestamp")

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

@get:JvmName(name = "hourOfTimestamp")

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

@get:JvmName(name = "hourOfTimestamp")

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

@get:JvmName(name = "hourOfTimestamp")

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

Returns the hour portion of a date as a number between 0 and 23.

The accepted date types are Instant, ObjectId and Timestamp.

Example

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

users.updateManyWithPipeline {
    set {
        User::birthhour set User::birthdate.hour
    }
}

External resources

Official documentation