Database Manual / Reference / Query Language / Update / Fields

$currentDate

Definition定义

$currentDate
The $currentDate operator sets the value of a field to the current date, either as a Date or a timestamp. $currentDate运算符将字段的值设置为当前日期,可以是DatetimestampThe default type is Date.默认类型为日期

Compatibility兼容性

You can use $currentDate for deployments hosted in the following environments:您可以将$currentDate用于在以下环境中托管的部署:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud:云中MongoDB部署的完全托管服务
  • MongoDB Enterprise: The subscription-based, self-managed version of MongoDB:MongoDB的基于订阅的自我管理版本
  • MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB:MongoDB的源代码可用、免费使用和自我管理版本

Syntax语法

The $currentDate operator has the form:$currentDate运算符的格式为:

{ $currentDate: { <field1>: <typeSpecification1>, ... } }

<typeSpecification> can be either:可以是:

  • a boolean true to set the field value to the current date as a Date, or布尔值true,将字段值设置为当前日期作为日期,或
  • a document { $type: "timestamp" } or { $type: "date" } which explicitly specifies the type. 明确指定类型的文档{ $type: "timestamp" }{ $type: "date" }The operator is case-sensitive and accepts only the lowercase "timestamp" or the lowercase "date".运算符区分大小写,只接受小写的"timestamp"或小写的"date"

To specify a <field> in an embedded document or in an array, use dot notation.要在嵌入式文档或数组中指定<field>,请使用点符号

Behavior行为

Starting in MongoDB 5.0, update operators process document fields with string-based names in lexicographic order. Fields with numeric names are processed in numeric order. See Update Operators Behavior for details.

$currentDate sets the specified field to the date when $currentDate was run.

If the field does not exist, $currentDate adds the field to a document.

Starting in MongoDB 5.0, mongod no longer raises an error when you use an update operator like $currentDate with an empty operand expression ( { } ). An empty update results in no changes and no oplog entry is created (meaning that the operation is a no-op).

Example示例

Create a sample collection customers with the following document:

db.customers.insertOne(
{ _id: 1, status: "a", lastModified: ISODate("2013-10-02T01:11:18.965Z") }
)

The following operation updates the lastModified field to the current date, the "cancellation.date" field to the current timestamp as well as updating the status field to "D" and the "cancellation.reason" to "user request".

db.customers.updateOne(
{ _id: 1 },
{
$currentDate: {
lastModified: true,
"cancellation.date": { $type: "timestamp" }
},
$set: {
"cancellation.reason": "user request",
status: "D"
}
}
)

$currentDate sets the specified field to the date when $currentDate was run.

To verify the update:

db.customers.find()

The updated document resembles:

{
"_id" : 1,
"status" : "D",
"lastModified" : ISODate("2020-01-22T21:21:41.052Z"),
"cancellation" : {
"date" : Timestamp(1579728101, 1),
"reason" : "user request"
}
}

The lastModified field is set to the date when $currentDate was run in the update example shown earlier.

Aggregation Alternative to $currentDate

Update methods can accept an aggregation pipeline. Specifically, the previous example can be rewritten as the following using the aggregation stage $set and the aggregation variables NOW (for the current datetime) and CLUSTER_TIME (for the current timestamp):

Tip

  • To access aggregation variables, prefix the variable with double dollar signs $$ and enclose in quotes.
  • CLUSTER_TIME is available only on replica sets and sharded clusters.
  • The NOW and CLUSTER_TIME values remain the same throughout the pipeline.
db.customers.updateOne(
{ _id: 1 },
[
{ $set: { lastModified: "$$NOW", cancellation: {date: "$$CLUSTER_TIME", reason: "user request"}, status: "D" } }
]
)

After the operation, you can query the collection to verify the update:

db.customers.find().pretty()

The query should return the following document:

{
"_id" : 1,
"status" : "D",
"lastModified" : ISODate("2020-01-22T21:02:18.994Z"),
"cancellation" : {
"date" : Timestamp(1579726934, 2),
"reason" : "user request"
}
}