$function (operador de expressão )

Restrição de validação do esquema

Você não pode utilizar como parte $function de um predicado de query de validação de esquema .

Javascript Enablement

Para usar, você deve ter o script do lado do servidor habilitado $function (padrão).

Se você não usar $function (ou, ou), desabilite os scripts do lado do $accumulator $where mapReduceservidor:

• Para uma instância mongod, consulte opção de configuração security.javascriptEnabled ou opção de linha de comando --noscripting.

• Para instâncias do mongos, consulte a opção de configuração security.javascriptEnabled ou a opção de linha de comando --noscripting.

  Em versões anteriores, o MongoDB não permite a execução de JavaScript em instânciasmongos.

Consulte também ➤ Executar o MongoDB com opções de configuração seguras.

Alternativa para $where

O operador de query $where também pode ser utilizado para especificar a expressão JavaScript. No entanto:

• O operador $expr permite o uso de expressões de agregação dentro do idioma da query.

• $function e permitem que os usuários definam expressões de agregação personalizadas em JavaScript se os operadores de pipeline fornecidos não atenderem às necessidades do seu $accumulator aplicativo.

Considerando os operadores de aggregation disponíveis:

• O uso do$exprcom operadores de agregação que não utilizam JavaScript (ou seja, operadores não$functione não$accumulator) é mais rápido do que$whereporque não executa JavaScript e deve ser preferido, se possível.

• No entanto, se você precisar criar expressões personalizadas, é$function preferível $where a.

Funções de array e string não suportadas

O MongoDB atualiza o 6.0 mecanismo JavaScript interno usado para expressões JavaScript,, e do lado$accumulator do$function $where servidor e do MozJS- para60 o91 MozJS-. Várias funções de array e string de caracteres não padrão obsoletas que existiam no MozJS-60 são removidas no91 MozJS-.

Exemplo 1: Exemplo de uso

Crie uma coleção de amostra denominada players com os seguintes 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 ] }
])

A seguinte operação de agregação utiliza o $addFields para adicionar novos campos a cada documento:

• isFound cujo valor é determinado pela $function expressão personalizada que verifica se o5 hash MD do nome é igual a um hash especificado.

• message cujo valor é determinado pela $function expressão personalizada que formata uma mensagem de string utilizando um modelo.

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"
               }
            }
       }
    }
] )

A operação retorna os seguintes 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." }

Exemplo 2: Alternativa a $where

Como alternativa a uma query que usa o operador,$where você pode usar e. Por $expr exemplo, considere o exemplo $function $where a seguir .

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

A operação db.collection.find() retorna o seguinte documento:

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

O exemplo pode ser expresso utilizando $expr $functione:

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