Database Manual / Reference / Query Language / Expressions

$toDecimal (expression operator)(表达式运算符)

Definition定义

$toDecimal

Converts a value to a decimal. If the value cannot be converted to a decimal, $toDecimal errors. If the value is null or missing, $toDecimal returns null.将值转换为十进制。如果该值无法转换为十进制,则$toDecimal错误。如果该值为null或缺失,$toDecial将返回null

$toDecimal has the following syntax:具有以下语法:

{
$toDecimal: <expression>
}

The $toDecimal takes any valid expression.$toDecimal接受任何有效表达式。

The $toDecimal is a shorthand for the following $convert expression:$toDecimal是以下$convert表达式的简写:

{ $convert: { input: <expression>, to: "decimal" } }

Behavior行为

The following table lists the input types that can be converted to a decimal:下表列出了可以转换为十进制的输入类型:

Input Type输入类型Behavior行为
Boolean布尔值Returns Decimal128("0") for false.false返回Decimal128("0")
Returns Decimal128("1") for true.true返回Decimal128("1")
Double双精度浮点数Returns double value as a decimal.以十进制形式返回双精度值。
DecimalNo-op. Returns the decimal.否。返回小数。
Integer整数Returns the int value as a decimal.以十进制形式返回int值。
Long长整数Returns the long value as a decimal.以小数形式返回长值。
String字符串

Returns the numerical value of the string as a decimal.以十进制形式返回字符串的数值。

The string value must be of a base 10 numeric value (e.g. "-5.5", "123456").字符串值必须是以10为底的数值(例如"-5.5""123456")。

You cannot convert a string value of a non-base 10 number (e.g. "0x6400")您无法转换非十进制数字的字符串值(例如"0x6400"

DateReturns the number of milliseconds since the epoch that corresponds to the date value.返回自与日期值对应的历元以来的毫秒数。

The following table lists some conversion to decimal examples:下表列出了一些转换为十进制的示例:

Example示例Results结果
{$toDecimal: true}Decimal128("1")
{$toDecimal: false}Decimal128("0")
{$toDecimal: 2.5}Decimal128("2.50000000000000")
{$toDecimal: Int32(5)}Decimal128("5")
{$toDecimal: Long(10000)}Decimal128("10000")
{$toDecimal: "-5.5"}Decimal128("-5.5")
{$toDecimal: ISODate("2018-03-27T05:04:47.890Z")}Decimal128("1522127087890")

Example示例

Create a collection orders with the following documents:使用以下文档创建集合orders

db.orders.insertMany( [
{ _id: 1, item: "apple", qty: 5, price: 10 },
{ _id: 2, item: "pie", qty: 10, price: Decimal128("20.0") },
{ _id: 3, item: "ice cream", qty: 2, price: "4.99" },
{ _id: 4, item: "almonds", qty: 5, price: 5 }
] )

The following aggregation operation on the orders collection converts the price to a decimal and the qty to an integer before calculating the total price:在计算总价之前,orders集合的以下聚合操作将price转换为小数,将qty转换为整数:

// Define stage to add convertedPrice and convertedQty fields with the converted price and qty values定义阶段以添加转换价格和转换数量字段,其中包含转换价格和数量值

priceQtyConversionStage = {
$addFields: {
convertedPrice: { $toDecimal: "$price" },
convertedQty: { $toInt: "$qty" },
}
};

// Define stage to calculate total price by multiplying convertedPrice and convertedQty fields定义阶段,通过将转换后的价格和转换后的数量字段相乘来计算总价


totalPriceCalculationStage = {
$project: { item: 1, totalPrice: { $multiply: [ "$convertedPrice", "$convertedQty" ] } }
};

db.orders.aggregate( [
priceQtyConversionStage,
totalPriceCalculationStage
] )

The operation returns the following documents:该操作返回以下文档:

{ _id: 1, item: 'apple', totalPrice: Decimal128("50") },
{ _id: 2, item: 'pie', totalPrice: Decimal128("200.0") },
{ _id: 3, item: 'ice cream', totalPrice: Decimal128("9.98") },
{ _id: 4, item: 'almonds', totalPrice: Decimal128("25") }

Note

If the conversion operation encounters an error, the aggregation operation stops and throws an error. To override this behavior, use $convert instead.如果转换操作遇到错误,聚合操作将停止并抛出错误。要覆盖此行为,请改用$converter