Após registrar, publicar e ativar uma extensão na DataWorks Open Platform, o DataWorks envia uma mensagem de evento para a extensão sempre que um evento de ponto de extensão é acionado no workspace relevante. Com base na resposta da extensão, o DataWorks determina se permite a operação. Este tópico descreve os eventos de ponto de extensão compatíveis com o Data Studio e explica como utilizá-los para acionar uma extensão.
Pré-requisitos
Ative a assinatura de mensagens. Para mais informações, consulte Ative a assinatura de mensagens.
Desenvolva e implante a extensão. Para mais informações, consulte Develop and deploy an extension using Function Compute.
Informações básicas
-
Ative a extensão.
Na página Management Center, visualize as Extensions e ative ou desative a verificação de extensão para o workspace atual.
-
Eventos de ponto de extensão no Desenvolvimento de Dados.
O módulo Data Studio do DataWorks oferece suporte a eventos de ponto de extensão como pré-publicação de arquivo, pré-commit de arquivo e pré-envio de tabela. Para obter uma lista detalhada dos eventos de ponto de extensão e conceitos relacionados, consulte List of supported extension point events.
O DataWorks pode enviar notificações para eventos de ponto de extensão. As extensões validam e respondem automaticamente a esses eventos. Para mais detalhes sobre o processo de acionamento, consulte Supported extension point events.
Limites
Quando uma extensão está ativada, aplicam-se os seguintes limites às notificações e respostas para eventos acionados durante o desenvolvimento de dados.
-
Uma extensão integrada ativada oferece suporte apenas a nós ODPS SQL.
Isso significa que, quando um evento de ponto de extensão é acionado para um nó ODPS SQL, o processo é bloqueado. A extensão integrada valida a lógica e retorna um resultado. Se um evento for acionado para um nó que não seja ODPS SQL, o processo também será bloqueado, mas a extensão integrada não realizará validação e retornará imediatamente um resultado de sucesso.
O pre-publish table event e o pre-submit table event são eventos de ponto de extensão acionados exclusivamente para tabelas do MaxCompute.
Em nós compostos que contêm nós internos, como do-while nodes e for-each nodes, todos os nós internos devem passar pela verificação antes que a próxima operação prossiga.
Visão geral das capacidades
Registre um service ou programa local como uma extensão do DataWorks para receber mensagens de eventos específicos de ponto de extensão no módulo Data Studio. Isso permite implementar lógica personalizada para lidar com esses eventos e retornar os resultados à plataforma usando um callback para a API UpdateIDEEventResult. Esse método viabiliza o controle de processos no DataWorks. Os pontos de extensão compatíveis são:
Operações de arquivo: Execute, fazer commit, publicar e exclua arquivos.
-
Operações de tabela: Envie e publicar tabelas.
NotaOs eventos de extensão para operações de tabela no Data Studio só podem ser acionados para tabelas do MaxCompute.
Eventos de ponto de extensão compatíveis
No Data Studio, utilize extensões para validar e responder aos seguintes eventos de ponto de extensão.
DataStudio - Execute File
No editor de código do DataStudio, clique em Run para acionar um evento de pré-verificação da extensão. Uma sobreposição Checking aparece com a mensagem: "The operation will be automatically executed after the check is passed. You can view the results in [Operation Check]." No painel Operation Check à esquerda, visualize todos os registros de verificação (incluindo tipos como execução, commit de arquivo e exclusão). Clique em um registro para abrir sua caixa de diálogo de detalhes e visualizar o tipo de verificação, status e detalhes de cada extensão.
DataStudio - Submit File
Ao enviar um arquivo no DataStudio, o sistema aciona uma verificação de evento de pré-commit de arquivo. Clique em Submit na barra de ferramentas para iniciar a verificação da extensão. O editor exibe um prompt "Checking" e a operação é executada automaticamente após a aprovação na verificação. Visualize o status de cada item de verificação no painel Operation Check à esquerda. A lista exibe "Trigger file pre-commit event check".
DataStudio - Publishing a file
Após clicar em Publish no editor de código para enviar um arquivo, o sistema aciona uma verificação de extensão. A interface Create Deployment Package aparece e exibe o status do nó correspondente na lista de arquivos como Checking and validating. Clique em o status do nó para abrir a caixa de diálogo Operation Check e visualizar o tipo de verificação, status e detalhes da validação.
DataStudio - Delete file
Na árvore de arquivos do Data Studio, clique em o botão direito no nó desejado e selecione Delete. Essa ação aciona um evento de pré-verificação do programa de extensão. Uma notificação azul aparece na parte inferior da página informando: "This operation has triggered a check. The operation takes effect automatically after the check passes. Please view the check result in 'Operation Check'." Acesse a página Operation Check para visualizar a lista de registros de verificação. A lista inclui as colunas Name/Operation Time, Type e Status. Clique em um registro específico para ver os detalhes da verificação da operação. Os detalhes incluem o tipo de verificação, como "Pre-delete combination test", e o status atual, como "Checking". A página também fornece links para View Details e View Document.
DataStudio: Envie table
Ao enviar uma tabela (como xc_table_prod) para um ambiente de desenvolvimento ou produção, o sistema aciona automaticamente uma pré-verificação de um programa de extensão. Uma caixa de diálogo Checking aparece com a mensagem: "The operation runs automatically after the check passes. Please view the results in Operation Check." Na barra lateral Operation Check à esquerda, filtre e visualize todos os registros de verificação por tipo e status. Clique em um registro específico para abrir a caixa de diálogo de detalhes da Verificação de Operação. Esta caixa exibe a lista de validações de programas de extensão acionadas pela operação atual (como o tipo de verificação "Pre-submission check for table - Test program") e seus status de validação. Há suporte para as operações View Details e Re-check.
DataStudio - Publish Table Na página de configuração da tabela, clique em a aba Submit to Production Environment para acionar uma verificação de extensão. O sistema então exibe um prompt: "Checking - The operation will be automatically executed after the check passes. Please view the results in 'Operation Check'." Acesse a página Operation Check para visualizar a lista de registros de verificação. A lista contém o nome da tabela, horário de envio, tipo de verificação e status. Clique em um registro para ver seus detalhes. Os detalhes incluem o tipo de verificação (como Pre-publish Check for Table) e o status atual. Também é possível clicar em View Details e View Documentation. Esta operação aciona a validação de extensões ativadas para o tipo de evento de pré-publicação de tabelas no workspace.
Referências
Para mais informações sobre o uso de extensões, consulte Use extensions.
O Data Studio oferece suporte a eventos adicionais de ponto de extensão. Para mais informações, consulte List of supported extension point events.
Para mais detalhes sobre o formato da entidade de mensagem para eventos de alteração de arquivo, consulte File change events (commit, publish, execute, delete, and code review).
Para mais detalhes sobre o formato da entidade de mensagem para eventos de alteração de tabela, consulte Table change events (submit table to development environment and publish table to production environment).