$función (operador de expresión)

Restricción de validación de esquema

No puedes usar $function como parte de un predicate de validación de esquemas.

Javascript Enablement

Para usar $function, debes tener habilitados los scripts del lado del servidor (por defecto).

Si no utilizas $function (o $accumulator, $where o mapReduce), desactiva los scripts en el lado del servidor:

• Para una instancia de mongod, consulta la opción de configuración security.javascriptEnabled o la opción de línea de comandos --noscripting.

• Para una instancia mongos, consulta la opción de configuración security.javascriptEnabled o la opción de línea de comandos --noscripting.

  En versiones anteriores, MongoDB no permite la ejecución de JavaScript en instancias de mongos.

Consulta también ➤ Ejecutar MongoDB con opciones de configuración seguras.

Alternativa a $where

El operador del query $where también puede utilizarse para especificar expresiones de JavaScript. Sin embargo:

• El operador $expr permite el uso de expresiones de agregación dentro del lenguaje de la query.

• El $function y $accumulator permiten a los usuarios definir expresiones de agregación personalizadas en JavaScript si los operadores proporcionados del pipeline no pueden satisfacer las necesidades de tu aplicación.

Dado los operadores de agregación disponibles:

• El uso de $expr con operadores de agregación que no usan JavaScript (es decir, no son-$function ni son-$accumulator operadores) es más rápido que $where porque no ejecuta JavaScript y debe preferirse si es posible.

• Sin embargo, si es necesario crear expresiones personalizadas, $function es preferible a $where.

Funciones de string y arreglo no compatibles

MongoDB 6.0 actualiza el motor interno de JavaScript utilizado para JavaScript del lado del servidor, $accumulator, $function y $where expresiones, pasando de MozJS-60 a MozJS-91. Varias funciones de arreglos y strings obsoletas y no estándar que existían en MozJS-60 se eliminan en MozJS-91.

Ejemplo 1: Ejemplo de uso

Crea una colección de muestra llamada players con los siguientes documentos:

db.players.insertMany([
   { _id: 1, name: "Miss Cheevous",  scores: [ 10, 5, 10 ] },
   { _id: 2, name: "Miss Ann Thrope", scores: [ 10, 10, 10 ] },
   { _id: 3, name: "Mrs. Eppie Delta ", scores: [ 9, 8, 8 ] }
])

La siguiente operación de agregación utiliza $addFields para añadir nuevos campos a cada documento:

• isFound cuyo valor se determina mediante la expresión personalize $function que comprueba si el hash MD5 del nombre es igual a un hash especificado.

• message cuyo valor es determinado por la expresión personalizada $function que formatea un mensaje de string utilizando una plantilla.

db.players.aggregate( [
   { $addFields:
      {
        isFound:
            { $function:
               {
                  body: function(name) {
                     return hex_md5(name) == "15b0a220baa16331e8d80e15367677ad"
                  },
                  args: [ "$name" ],
                  lang: "js"
               }
            },
         message:
            { $function:
               {
                  body: function(name, scores) {
                     let total = Array.sum(scores);
                     return `Hello ${name}.  Your total score is ${total}.`
                  },
                  args: [ "$name", "$scores"],
                  lang: "js"
               }
            }
       }
    }
] )

La operación devuelve los siguientes documentos:

{ "_id" : 1, "name" : "Miss Cheevous", "scores" : [ 10, 5, 10 ], "isFound" : false, "message" : "Hello Miss Cheevous.  Your total score is 25." }
{ "_id" : 2, "name" : "Miss Ann Thrope", "scores" : [ 10, 10, 10 ], "isFound" : true, "message" : "Hello Miss Ann Thrope.  Your total score is 30." }
{ "_id" : 3, "name" : "Mrs. Eppie Delta ", "scores" : [ 9, 8, 8 ], "isFound" : false, "message" : "Hello Mrs. Eppie Delta .  Your total score is 25." }

Ejemplo 2: Alternativa a $where

Como alternativa a una query que utiliza el operador $where, puedes utilizar $expr y $function. Por ejemplo, considere el siguiente $where ejemplo.

db.players.find( { $where: function() {
   return (hex_md5(this.name) == "15b0a220baa16331e8d80e15367677ad")
} } );

La operación db.collection.find() devuelve el siguiente documento:

{ "_id" : 2, "name" : "Miss Ann Thrope", "scores" : [ 10, 10, 10 ] }

El ejemplo puede expresarse usando $expr y $function:

db.players.find( {$expr: { $function: {
      body: function(name) { return hex_md5(name) == "15b0a220baa16331e8d80e15367677ad"; },
      args: [ "$name" ],
      lang: "js"
} } } )