Todos os produtos
Search

Este produto

    DataWorks:Criar uma função Aviator

    Central de documentação

    DataWorks:Criar uma função Aviator

    Última atualização: Jun 27, 2026

    Este tópico explica como criar uma função Aviator.

    Pré-requisitos

    Contexto

    No DataService Studio, é possível criar, testar e implantar funções. Após a implantação, associe a função a uma API e utilize-a como filtro para processar parâmetros de solicitação ou dados de resposta. Esse recurso permite atender a requisitos complexos de consulta e adaptar-se a diversos cenários de negócios. Para exemplos de código de casos de uso comuns, consulte Melhores práticas: Usar uma função Aviator como filtro.

    Limitações

    • As funções Aviator exigem execução em um grupo de recursos exclusivo para o DataService Studio.

    • Ao usar uma função como filtro de API, os tipos de função do pré-filtro e do pós-filtro devem ser idênticos. Selecione o tipo de função Aviator ou Python para ambos.

    Observações de uso

    Por motivos de segurança e desempenho, as funções Aviator devem ser executadas em um grupo de recursos exclusivo para o DataService Studio. Portanto:

    • Ao editar ou testar uma função, associe-a a um grupo de recursos exclusivo para o DataService Studio. Para mais detalhes, consulte Gerenciar uma função.

    • Durante o desenvolvimento da API, ao ativar um filtro e associá-lo à função de destino, vincule a API a um grupo de recursos exclusivo para o DataService Studio. Para mais informações, consulte Gerar uma API a partir de uma fonte de dados (API Gateway).

    Estrutura da função

    As funções Aviator usam o modelo integrado a seguir. Para obter detalhes sobre a sintaxe, consulte Sintaxe de função Aviator.

    ## --- AviatorScript ---
## $0: the default name of the input param.
## Expressions must be separated by the semicolon ";".
## Example 1:
## $0.a: Get the attribute "a" from the input param "$0".
## $0.b[index]: Get the element at the specified index from the array "b" in the input param "$0". The index cannot be an expression or a variable.
## Example 2:
## Input: {"keyA":[1,2],"keyB":"value"}
## Function: $0.keyA[0]=3; $0.keyB="new_value"; return $0;
## Output: {"keyA":[3,2],"keyB":"new_value"}
return $0;

    Modifique a função com base neste modelo.

    • O nome padrão do parâmetro de entrada de uma função Aviator é $0 e não pode ser alterado. Use $0 para obter toda a entrada da função.

    • No DataService Studio, as funções atuam como filtros de API para processar parâmetros de solicitação e dados de resposta. Por isso, a entrada da função, representada por $0, é um objeto JSON. Os parâmetros de solicitação são passados como uma estrutura JSON plana (profundidade 1), enquanto os dados de resposta seguem uma estrutura JSON aninhada (profundidade N).

    • Quando usada como pré-filtro de API, o sistema converte os parâmetros de solicitação da API ou a saída de uma função anterior de um key-value map para um objeto JSON e o passa ao parâmetro $0. O valor de cada chave no objeto JSON deve ser uma string.

    • Se a função atuar como pré-filtro de API, sua saída deverá ser um key-value map. Essa saída serve como parâmetros de entrada para a execução de instruções SQL. Portanto, apenas um key-value map plano, com profundidade de um nível, é compatível.

    Acessar o DataService Studio

    Faça login no console do DataWorks. Na região desejada, clique em Data Analysis and Service > DataService Studio no painel de navegação à esquerda. Selecione um workspace na lista suspensa e clique em Go to DataService Studio.

    Criar uma função

    1. Na página Service Development, passe o mouse sobre o ícone image.png e clique em Create Function > Create Aviator Function.

      Como alternativa, localize o workflow desejado, clique com o botão direito em Function e escolha Create Function > Create Aviator Function.

    2. Na caixa de diálogo Create Aviator Function, configure os parâmetros.

      Parâmetro

      Descrição

      Function Name

      Nome exclusivo para a função, com até 256 caracteres.

      Function Template

      Somente AviatorScript Standard v1 é compatível.

      Function Description

      Breve descrição da função, limitada a 512 caracteres.

      Location

      Diretório de destino da função.

      Nota

      Selecione um workflow específico, uma pasta ou uma categoria de função. Caso não exista nenhum workflow, crie um antes de prosseguir.

    3. Clique em Determine.

    4. Na área Edit Code, insira o código da função.

    5. Configure o grupo de recursos.

      1. No painel direito da página de edição da função, clique em Resource Group for DataService Studio. Na seção Resource Group Type, defina o tipo de grupo de recursos para chamadas de API.

        Selecione apenas grupos de recursos exclusivos para o DataService Studio.

        Nota

        Se o nome do grupo de recursos desejado não aparecer na lista, acesse o console do DataWorks e vincule o grupo de recursos ao seu workspace usando Modify Workspace Ownership. Também é possível clicar em Purchase Exclusive Resource Group for DataService Studio para adquirir um novo. Para mais informações, consulte Usar um grupo de recursos exclusivo para o DataService Studio.

      2. Na seção Environment Configuration, defina a Memory e o Timeout.

        Para grupos de recursos exclusivos do DataService Studio, recomenda-se que o tempo limite da função seja de 100 ms ou menos.

    6. Clique no ícone 保存 na barra de ferramentas para salvar a função.

    Após criar a função, teste-a e implante-a para uso como pré-filtro ou pós-filtro de API.

    Próximos passos