$trim (aggregation)

Definition定义

$trim

New in version 4.0.在版本4.0中新增。

Removes whitespace characters, including null, or the specified characters from the beginning and end of a string.删除字符串开头和结尾的空白字符（包括null）或指定字符。

$trim has the following syntax:语法如下：

{ $trim: { input: <string>,  chars: <string> } }

The $trim takes a document with the following fields:$trim获取包含以下字段的文档：

Field字段	Description描述
input	The string to trim. The argument can be any valid expression that resolves to a string. 要修剪的字符串。参数可以是解析为字符串的任何有效表达式。For more information on expressions, see Expressions.有关表达式的详细信息，请参阅表达式。
chars	Optional. 可选。The character(s) to trim from input.要从input中修剪的字符。 The argument can be any valid expression that resolves to a string. 参数可以是解析为字符串的任何有效表达式。The $trim operator breaks down the string into individual UTF code point to trim from input.$trim运算符将字符串分解为单独的UTF代码点，以便从输入中进行裁剪。 If unspecified, $trim removes whitespace characters, including the null character. 如果未指定，$trim将删除空白字符，包括空字符。For the list of whitespace characters, see Whitespace Characters.有关空白字符的列表，请参阅空白字符。

Tip提示

See also: 参阅：

• $ltrim
• $rtrim

Behavior行为

• By default, $trim removes whitespace characters, including the null character:默认情况下，$trim删除空白字符，包括空字符：

  Example示例	Results结果
  { $trim: { input: " \n good bye \t " } }	"good bye"

• You can override the default characters to trim using the chars field.可以使用chars字段覆盖要修剪的默认字符。

  For example, the following trims any g and e from the start and end of the input. 例如，以下命令从输入的开始和结束处修剪任何g和e。Since the input starts with a whitespace, neither character can be trimmed from the start of the string.由于输入以空格开头，因此不能从字符串的开头修剪任何字符。

  Example示例	Results结果
  { $trim: { input: " ggggoodbyeeeee", chars: "ge" } }	" ggggoodby"

• If overriding the default characters to trim, you can explicitly include the whitespace character(s) to trim in the chars field.如果覆盖要修剪的默认字符，可以在chars字段中显式包含要修剪的空白字符。

  For example, the following trims any space, g, e from the start and end of the input.例如，以下命令将从输入的开始和结束处修剪任何空格、g，e。

  Example示例	Results结果
  { $trim: { input: " ggggoodbyeeeee", chars: " ge" } }	"oodby"

Example示例

Consider an inventory collection with the following documents:考虑使用以下文档进行inventory集合：

{ "_id" : 1, "item" : "ABC1", quarter: "13Q1", "description" : " product 1" }
{ "_id" : 2, "item" : "ABC2", quarter: "13Q4", "description" : "product 2 \n The product is in stock.  \n\n  " }
{ "_id" : 3, "item" : "XYZ1", quarter: "14Q2", "description" : null }

The following operation uses the $trim operator to remove leading and trailing whitespaces from the description field:以下操作使用$trim运算符从description字段中删除前导空格和尾随空格：

db.inventory.aggregate([
   { $project: { item: 1, description: { $trim: { input: "$description" } } } }
])

The operation returns the following results:该操作返回以下结果：

{ "_id" : 1, "item" : "ABC1", "description" : "product 1" }
{ "_id" : 3, "item" : "XYZ1", "description" : null }
{ "_id" : 2, "item" : "ABC2", "description" : "product 2 \n The product is in stock." }