$trim（集計）

定義

$trim

文字列の先頭と末尾から、null を含む空白文字または指定した文字を除きます。

$trim の構文は次のとおりです。

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

$trimは、次のフィールドを持つドキュメントを取得します。

フィールド	説明
input	削除する string。 引数は、string に変換されるなら、どのような有効な式でも使用できます。 式の詳細については、「式 」を参照してください。
chars	任意。input から削除する文字。 引数は、string に変換されるなら、どのような有効な式でも使用できます。 $trim演算子は string を個々の UTF コード ポイント inputに分割します。 は から削除されます。 指定されていない場合、 $trim では null 文字を含む空白文字が除かれます。空白文字のリストについては、「空白文字」を参照してください。

Tip

以下も参照してください。

• $ltrim

• $rtrim

動作

• デフォルトでは、 $trim では null 文字を含む空白文字が除かれます。

  例	結果
  { $trim: { input: " \n good bye \t " } }	"good bye"

• chars フィールドを使用して、削除するデフォルトの文字を上書きできます。

  例えば、次の例では、入力の先頭と末尾から任意の g と e を削除します。入力は空白で始まるので、どちらの文字も文字列の先頭から削除することはできません。

  例	結果
  { $trim: { input: " ggggoodbyeeeee", chars: "ge" } }	" ggggoodby"

• 削除するデフォルトの文字をオーバーライドする場合は、削除する空白文字を chars フィールドに明示的に含めることができます。

  例えば、次の例では、入力の先頭と末尾から、スペース、 g 、 e が削除されます。

  例	結果
  { $trim: { input: " ggggoodbyeeeee", chars: " ge" } }	"oodby"

例

以下のドキュメントを持つ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 }

次の操作では、 $trim演算子を使用して、 descriptionフィールドから先頭と末尾の空白を削除します。

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

この操作は次の結果を返します。

{ "_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." }