Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Serviços Atlas App

Arquivos de configuração da função

Nesta página

  • Manifesto da função
  • Código fonte da função

Observação

Esta página descreve um formato de arquivo de configuração legado. Você só deve usar essas informações se estiver usando o realm-cli obsoleto.

Todos os arquivos de configuração que você extrai com o App Services CLI ou exporta da UI utilizam a versão de configuração mais recente. Para obter informações detalhadas sobre o formato do arquivo de configuração atual, consulte Configuração do aplicativo.

app/
└── functions/
    ├── config.json
    └── <function>.js

Manifesto da função

Cada função no seu aplicativo tem uma entrada de metadados correspondente no arquivo de manifesto da função: /functions/config.json.

Dica

O Atlas App Services adiciona automaticamente funções ao manifesto na importação, se ainda não tiver uma configuração definida. Se você estiver de acordo com as configurações padrão, poderá ignorar a definição da configuração de uma função e permitir que o App Services faça isso por você. O manifesto incluirá as configurações geradas na próxima vez que você exportar ou extrair sua aplicação.

functions/config.json
[
  {
    "name": "<Function Name>",
    "private": <Boolean>,
    "can_evaluate": { <JSON Expression> },
    "disable_arg_logs": <Boolean>,
    "run_as_system": <Boolean>,
    "run_as_user_id": "<App Services User ID>",
    "run_as_user_id_script_source": "<Function Source Code>"
  },
  ...
]
Campo
Descrição
name
String
O nome da função. O nome deve corresponder ao nome de umarquivo de código-fonte e ser exclusivo entre todas as funções em seu aplicação.
private
Boolean
Se true, esta função só pode ser chamada a partir de outras funções ou em %function expressões de regras. Você não pode chamar uma função privada diretamente de um aplicativo cliente ou com um SDK.
can_evaluate
JSON Expression (default: true)
Uma expressão JSON que avalia para true se a função tem permissão para ser executada. O App Services avalia essa expressão para cada solicitação recebida.
disable_arg_logs
Boolean
Se true, o App Services omite os argumentos fornecidos à função a partir da entrada do registro de execução da função.
run_as_system
Boolean
Se true, esta função é executada como o usuário do sistema. Isso substitui quaisquer valores definidos para run_as_user_id e run_as_user_id_script_source.
run_as_user_id
String
O ID exclusivo de um usuário do App Services com o qual a função sempre é executada. Não é possível usar com run_as_user_id_script_source.
run_as_user_id_script_source
String
Uma função em string que é executada sempre que a função é chamada e retorna o ID exclusivo de um usuário do App Services com o qual a função é executada. Não é possível usar com run_as_user_id.

Código fonte da função

Você define o código-fonte de uma função em um arquivo .js no diretório /functions que utiliza o nome da função como nome de arquivo. Cada arquivo deve exportar a função principal que é executada sempre que uma solicitação chama a função.

Importante

Todos os seus arquivos de código-fonte de função devem estar no diretório /functions .

/functions/<nome da<function name> função>.js
exports = function addOne(input) {
  if(typeof input !== "number") {
    throw new Error("You must call addOne() with a number");
  }
  return input + 1;
};

Próximo

O que são os Serviços de Aplicativo Atlas?