Definition定义
$toObjectIdConverts a value to an将值转换为ObjectId(). If the value cannot be converted to an ObjectId,$toObjectIderrors. If the value is null or missing,$toObjectIdreturns null.ObjectId()。如果该值无法转换为ObjectId,则$toObjectId错误。如果该值为null或缺失,$toObjectId将返回null。$toObjectIdhas the following syntax:具有以下语法:{
$toObjectId: <expression>
}The$toObjectIdtakes any valid expression.$toObjectId接受任何有效表达式。The$toObjectIdis a shorthand for the following$convertexpression:$toObjectId是以下$convert表达式的简写:{ $convert: { input: <expression>, to: "objectId" } }Tip
Behavior行为
The following table lists the input types that can be converted to an ObjectId:下表列出了可以转换为ObjectId的输入类型:
|
The following table lists some conversion to date examples:下表列出了一些迄今为止的转换示例:
{$toObjectId: "5ab9cbfa31c2ab715d42129e"} | ObjectId("5ab9cbfa31c2ab715d42129e") |
{$toObjectId: "5ab9cbfa31c2ab715d42129"} | Error |
Example示例
Create a collection 使用以下文档创建集合orders with the following documents:orders:
db.orders.insertMany( [
{ _id: "5ab9cbe531c2ab715d42129a", item: "apple", qty: 10 },
{ _id: ObjectId("5ab9d0b831c2ab715d4212a8"), item: "pie", qty: 5 },
{ _id: ObjectId("5ab9d2d331c2ab715d4212b3"), item: "ice cream", qty: 20 },
{ _id: "5ab9e16431c2ab715d4212b4", item: "almonds", qty: 50 },
] )
The following aggregation operation on the orders collection converts the _id to ObjectId before sorting by the value:orders集合上的以下聚合操作在按值排序之前将_id转换为ObjectId:
// Define stage to add convertedId field with converted _id value定义阶段以添加具有转换_id值的convertedId字段
idConversionStage = {
$addFields: {
convertedId: { $toObjectId: "$_id" }
}
};
// Define stage to sort documents by the converted qty values定义按转换后的数量值对文档进行排序的阶段
sortStage = {
$sort: { "convertedId": -1 }
};
db.orders.aggregate( [
idConversionStage,
sortStage
] )
The operation returns the following documents:该操作返回以下文档:
{
_id: '5ab9e16431c2ab715d4212b4',
item: 'almonds',
qty: 50,
convertedId: ObjectId("5ab9e16431c2ab715d4212b4")
},
{
_id: ObjectId("5ab9d2d331c2ab715d4212b3"),
item: 'ice cream',
qty: 20,
convertedId: ObjectId("5ab9d2d331c2ab715d4212b3")
},
{
_id: ObjectId("5ab9d0b831c2ab715d4212a8"),
item: 'pie',
qty: 5,
convertedId: ObjectId("5ab9d0b831c2ab715d4212a8")
},
{
_id: '5ab9cbe531c2ab715d42129a',
item: 'apple',
qty: 10,
convertedId: ObjectId("5ab9cbe531c2ab715d42129a")
}
Note
If the conversion operation encounters an error, the aggregation operation stops and throws an error. To override this behavior, use 如果转换操作遇到错误,聚合操作将停止并抛出错误。要覆盖此行为,请改用$convert instead.$converter。