/ /

`$function` （ストリームプロセシング）

定義

$function 式は、ストリーム内の各ドキュメントに対して JavaScript コードを実行するために定義できるカスタム JavaScript 関数を指定します。

$function演算子の構文は次のとおりです。

{
  $function: {
    body: <code>,
    args: <array expression>,
    lang: "js"
  }
}

フィールド	タイプ	説明
body	文字列またはコード	関数の定義。関数の定義は、BSON 型のコードまたは string として指定できます。参照 lang. `function(arg1, arg2, ...) { ... }` or `"function(arg1, arg2, ...) { ... }"`
args	配列	関数本体に渡される引数。 body 関数が引数を取らない場合は、空の配列`[ ]` を指定できます。配列要素は、コードを含む任意のBSONタイプにすることができます。例 2を参照してください: $where の代替手段。
lang	文字列	body 内で使用される言語。`lang: "js"` を指定する必要があります。

$function式は、ストリーム内の各ドキュメントに対して指定された関数を実行します。関数は、ドキュメントまたは args 配列から引数を取ることができます。

この関数は、配列やコードタイプを含む任意のBSONタイプを返すことができます。返された値は、$function 式の出力として使用されます。