Todos os produtos
Search
Central de documentação

Realtime Compute for Apache Flink:Develop jobs using VS Code

Última atualização: Jun 27, 2026

Use a extensão do Realtime Compute for Apache Flink para VS Code para desenvolver, implantar e publicar jobs SQL, JAR e Python localmente, além de sincronizar configurações do ambiente online.

Pré-requisitos

Limitações

  • A configuração de log não é suportada.

  • Não é possível importar jobs existentes.

Instale e configure a extensão

  1. Baixe e instale a extensão.

    • Método 1: Acesse o Visual Studio Marketplace e instale o Flink Realtime Compute Studio.

    • Método 2:

      1. Abra o VS Code e clique em EXTENSIONS no menu de navegação à esquerda.

      2. Na barra de pesquisa, insira Flink Realtime Compute Studio.

      3. Clique em Install.

  2. Na barra de menus, clique em File > Open Folder e selecione uma pasta local.

  3. Configure as credenciais do AccessKey.

    Workspace-wide

    1. Clique em image na barra de menus à esquerda. Na seção Configure AK&SK, clique em Configure in a .vvprc file. A extensão cria automaticamente um arquivo com a extensão .vvprc.

      Configure AccessKey

    2. Insira as seguintes informações de configuração.

      {
        "accessKey": "xxx",
        "secretKey": "xxx",
        "namespace": "xxx",
        "workspace": "xxx",
        "regionId" : "xxx"
      }

      Parâmetro

      Descrição

      Observações

      accessKey

      Seu AccessKey ID.

      Como encontro meu AccessKey ID e AccessKey secret?

      secretKey

      Seu AccessKey secret.

      namespace

      Nome do namespace do Flink.

      Consulte Visualize e exclua um namespace.

      workspace

      ID do workspace do Flink.

      Consulte Visualize informações do workspace.

      regionId

      ID da região.

      Verifique o ID da região em Endpoints.

    Globally

    1. Clique em image na barra de menus à esquerda.

    2. Clique em Configure AK&SK > Configure in global user settings. O VS Code abre as configurações globais.

      image

    3. Selecione User ou Workspace para definir as configurações conforme necessário.

      Nota

      A opção User aplica-se globalmente a todos os projetos do VS Code e fica armazenada no arquivo de configuração global. Já a opção Workspace aplica-se apenas ao workspace atual.

      Parâmetro

      Descrição

      Observações

      Access Key

      Seu AccessKey ID.

      Consulte Visualize AccessKey ID e AccessKey Secret

      Secret Key

      Seu AccessKey secret.

      Consulte Visualize AccessKey ID e AccessKey Secret

      Namespace

      Nome do namespace do Flink.

      Consulte Visualize e exclua um namespace.

      Workspace

      ID do workspace do Flink.

      Consulte Visualize informações do workspace

      Region ID

      ID da região.

      Verifique o ID da região em Endpoints.

    Nota

    Prioridade de configuração: Pasta atual > Pasta pai > Global.

    Após a configuração, o nome do namespace aparece na barra de status.

  4. (Opcional) Instale extensões auxiliares.

    • Flink SQL: Instale o Flink SQL Language Features para obter suporte à sintaxe SQL.

    • Configuração do Flink: Instale a extensão YAML para habilitar o preenchimento automático de arquivos YAML.

Procedimento

Etapa 1: Crie um job

  • Método 1: Clique em image na barra de menus à esquerda. Em QUICK START, clique em Create a new deployment. Insira um nome e pressione Enter para criar um arquivo .vvp com as configurações padrão.

    vscode0

  • Método 2: Na árvore de arquivos, crie um arquivo .vvp.

Etapa 2: Configure o job

Configure o job:

image

Para editar o arquivo source diretamente, clique em Raw File. Clique no nome de qualquer parâmetro para ir diretamente à sua localização no source.

image

  • Configurações básicas:

    Job SQL

    Parâmetro

    Descrição

    Deployment Name

    Nome do job.

    Execution Mode

    Modo de implantação. Valores válidos: STREAM e BATCH.

    Engine Version

    Versão do mecanismo para executar o job. Consulte Versões do mecanismo. Utilize a versão recomendada.

    Deployment Target

    Fila de recursos de destino para o job. Para mais informações, consulte Gerencie filas.

    Deployment Type

    Selecione SQL.

    SQL Script

    Clique em Open in external editor para abrir o editor local e escrever seu código.

    Nota

    Isso abre um arquivo virtual. Se o VS Code exibir The editor could not be opened because the file was not found após uma reinicialização, clique em Open in external editor novamente.

    Additional Dependencies

    URI das dependências adicionais para o job.

    Description

    Insira observações sobre o job.

    Job JAR

    Para mais informações sobre as configurações de parâmetros, consulte Implantar um job JAR.

    Parâmetro

    Descrição

    DeploymentName

    Nome do job.

    Execution Mode

    Modo de implantação. Valores válidos: STREAM e BATCH.

    Engine Version

    Versão do mecanismo para executar o job. Consulte Versões do mecanismo. Utilize a versão recomendada.

    Deployment Target

    Fila de recursos de destino para o job. Para mais informações, consulte Gerencie filas.

    Deployment Type

    Tipo de job a ser implantado. Selecione JAR.

    JAR URI

    Caminho do OSS ou URL do pacote JAR.

    Faça upload das dependências para Artifacts no Development Console ou para um bucket OSS vinculado antes de prosseguir.

    Entry Point Class

    Classe de ponto de entrada. Caso o JAR não especifique uma classe principal, insira o caminho padrão da sua classe de ponto de entrada.

    Entry Point Main Arguments

    Parâmetros de entrada para o método main.

    Additional Dependencies

    Caminho do OSS ou URL dos arquivos de dependência adicionais. As URLs devem terminar com o nome do arquivo.

    Faça upload das dependências para Artifacts no Development Console ou para um bucket OSS vinculado antes de prosseguir.

    Description

    Insira observações sobre o job.

    Job Python

    Para mais informações sobre as configurações de parâmetros, consulte Implantar um job Python.

    Parâmetro

    Descrição

    Deployment Name

    Nome do job.

    Execution Mode

    Modo de implantação. Valores válidos: STREAM e BATCH.

    Engine Version

    Versão do mecanismo para executar o job. Consulte Versões do mecanismo. Utilize a versão recomendada.

    Deployment Target

    Fila de recursos de destino para o job. Para mais informações, consulte Gerencie filas.

    Deployment Type

    Tipo de job a ser implantado. Selecione Python.

    Python Uri

    Caminho do arquivo do job Python. Suporta arquivos .py e .zip.

    Entry Module

    Classe de entrada do programa.

    • Opcional para arquivos .py.

    • Obrigatório para arquivos .zip.

    Entry Point Main Arguments

    Argumentos de entrada para o método main.

    Python Libraries

    Pacotes Python de terceiros para UDFs Python, adicionados ao PYTHONPATH do processo worker Python. Usar pacotes Python de terceiros.

    Python Archives

    Arquivos compactados. Para mais informações, consulte Usar um ambiente virtual Python personalizado e Usar arquivos de dados.

    Additional Dependencies

    Caminho do OSS ou URL dos arquivos de dependência adicionais.

    Faça upload das dependências para Artifacts no Development Console ou para um bucket OSS vinculado antes de prosseguir.

    Description

    Insira observações sobre o job.

  • Resources: Consulte Configurar recursos do job.

  • Parameters: Consulte Parâmetros.

Etapa 3: Implante o job

Clique em Create para implantar o job ou em Update para jobs existentes.

Para jobs SQL, a extensão valida o script SQL, o plano de recursos e as configurações, exibindo os resultados.

Etapa 4: Inicie o job

Para um job implantado, o status aparece no canto superior direito. Clique em Start e selecione um modo de inicialização. Iniciar um job.

image

Etapa 5: Execute a O&M do job

vscode.png

  • Open Online: Visualize o status do job ou realize operações de O&M no Development Console.

  • Synchronize: Importe as configurações do console. Clique em Synchronize para visualizar a versão na nuvem e, em seguida, clique em Accept para sobrescrever o arquivo local. Atualizações de rascunhos SQL não são incluídas.

  • Cancel: Interrompe o job.

Referências