Programar scripts e notebooks SQL

Programar scripts SQL e notebooks permite operacionalizar os recursos que foram Criada no workbench de exploração de dados (Análise).

Programar um script SQL ou um notebook cria uma tarefa do Dataplex que é executada em um horário predeterminado, uma vez ou com frequência. A cada execução, um job é criado que captura os metadados de execução, como horário de início e término da execução, status, registros e saídas geradas.

Quando uma execução é acionada para um script SQL programado ou um notebook, a versão atual do notebook ou script SQL é executado. Isso significa que se você agendar um notebook ou script SQL e atualizar seu conteúdo, a atualização também será refletida no as execuções programadas do notebook ou do script SQL.

Custos

Scripts SQL programados e notebooks programados acionam a execução de jobs usando o Dataproc sem servidor. Os usos são cobrados de acordo com o modelo de preços e cobranças do Dataproc aparecem no Dataproc, e não no Dataplex.

Antes de começar

Analise e conclua os pré-requisitos descritos nos seguintes documentos:

Se um script SQL ou uma programação de notebook usar a API BigQuery, você deverá conceder o à conta de serviço o papel Consumidor do Service Usage (roles/serviceusage.serviceUsageConsumer).

Limitações conhecidas

  • Ao programar um notebook usando o console do Google Cloud, outros pacotes Python configurado no ambiente selecionado não estará disponível no ambiente de execução para o notebook programado. Para disponibilizá-los no ambiente de execução, é preciso criar uma programação de notebook referenciando um imagem de contêiner com os pacotes adicionais necessários. Para mais informações, consulte Programar notebooks com pacotes personalizados.

  • Como usar o console do Google Cloud para fazer referência ao contêiner personalizado imagens ao programar notebooks não há suporte. Em vez disso, use a CLI gcloud.

  • Não é possível editar uma programação depois de criada. Para atualizar os parâmetros da programação, recrie a programação com novos parâmetros.

  • Não é possível definir uma versão específica de um script SQL ou notebook para ser usada um cronograma. Quando a programação é acionada, a versão atual do script SQL ou do notebook é usada.

  • Ao programar scripts e notebooks SQL usando o console do Google Cloud, a sub-rede padrão é usados. Para especificar outra rede ou sub-rede, use a CLI gcloud.

Além disso, leia as limitações conhecidas da Análise.

Criar e gerenciar programações para scripts SQL

Configuração do ambiente de execução para scripts SQL programados

Quando um script SQL é programado, ele é executado como uma tarefa do Dataplex. Quando uma programação é criada usando o console do Google Cloud, os parâmetros de ambiente de execução da tarefa correspondentes para o SQL programado os scripts são herdados do ambiente desse script SQL com base na seguinte mapeamento:

Parâmetro de configuração do ambiente Parâmetro de configuração de tarefa de script SQL programada
Tamanho do disco principal Imagem / propriedades do contêiner:
spark.dataproc.driver.disk.size
spark.dataproc.executor.disk.size
Número de nós Contagem de lotes / executores
Número máximo de nós Contagem máxima de executores em lote / máximo
Versão de imagem Não herdado
Arquivos JAR Imagem do contêiner / Java JARS
Pacotes do Python Não herdado
Outras propriedades Imagem / propriedades do contêiner

Programar um script SQL

Console

  1. No console do Google Cloud, acesse a página Explorar do Dataplex.

    Acessar o Dataplex Explore

  2. Selecione um script SQL que você quer programar, selecionando um único SQL da lista de Scripts do Spark SQL ou abrindo um script SQL no Editor do Spark SQL.

  3. No menu Programação, clique em Criar programação.

  4. No campo Nome da programação, insira o nome da instância programada.

  5. Na seção Opções de programação, selecione se você quer executar o script SQL. apenas uma vez ou regularmente:

    1. Se você selecionar Executar uma vez, especifique se quer executar o script SQL imediatamente. ou em um horário programado, usando as opções no menu Iniciar. Para uma execução programada, especificar a data de início e o horário de execução.

    2. Se você selecionar Repetir, especifique se você quer executar o script SQL diariamente, semanalmente ou mensal ou em uma programação personalizada especificada com a expressão cron. Além disso, especificar a data de início e o horário de execução da execução programada inicial.

  6. Na seção Destino dos resultados, faça o seguinte:

    1. No campo Nome da pasta de saída, clique em Procurar e selecione uma pasta O bucket do Cloud Storage em que você quer armazenar as saídas do script.

    2. Clique em Selecionar.

    3. Selecione o Formato de saída do script. Os formatos aceitos são CSV, JSON, ORC e Parquet.

  7. Na seção Credenciais de script programadas, selecione uma conta de serviço no menu Conta de serviço do usuário.

  8. Clique em Programação.

gcloud

Para mais informações sobre como programar scripts SQL usando a CLI gcloud, consulte Programar uma tarefa do SparkSQL

REST

Use o APIs Explorer para criar uma tarefa.

Gerenciar programações de scripts SQL

Console

Abrir a lista de todas as programações de script SQL

  1. No console do Google Cloud, acesse a página Processo do Dataplex.

  2. Clique na guia Consultas programadas para ver a lista de programações de scripts SQL.

Abrir a lista de todas as programações de um script SQL específico

  1. No console do Google Cloud, acesse a página Explorar do Dataplex.

  2. Selecione o script SQL necessário.

  3. No menu Programação, clique em Ver programações.

    A guia Consultas programadas é aberta com uma lista de programações de script SQL filtradas pelo script SQL selecionado.

Visualizar os detalhes de uma programação de script SQL

  1. Acesse a guia Consultas programadas e selecione a programação de script SQL necessária.

  2. Clique na guia Detalhes para exibir os detalhes da programação do script SQL e prévia do conteúdo do script SQL programado.

Ativar e desativar uma programação de script SQL

  1. Acesse a guia Consultas programadas e selecione a programação de script SQL necessária.

  2. Clique em Desativar para desativar uma programação de script SQL ativa.

  3. Clique em Ativar para ativar uma programação de script SQL inativa.

Excluir uma programação de script SQL

  1. Acesse a guia Consultas programadas e selecione a programação de script SQL necessária.

  2. Clique em Excluir para remover permanentemente uma programação de script SQL.

Conferir registros e gerenciar uma programação de script SQL

  1. Acesse a guia Consultas programadas e selecione a programação de script SQL necessária.

  2. Clique na guia Jobs e depois no ID do job do SQL programado. execução do script que você quer visualizar.

  3. Clique em Ver registros para acessar os registros relacionados ao SQL programado selecionado. script executado no Cloud Logging.

  4. Clique em Código de lote do Dataproc para abrir a página do Dataproc no console do Google Cloud. Acesse os detalhes da sessão correspondente do Dataproc sem servidor.

  5. Clique em Gerenciar no Cloud Storage ao lado do rótulo de Saída para abrir a página do Cloud Storage no console do Google Cloud. Acessar os detalhes do Cloud Storage correspondente que contém a saída da execução do script SQL.

gcloud

Para mais informações sobre como monitorar scripts SQL programados com a CLI gcloud, consulte a guia gcloud em Monitor your task.

Para mais informações sobre como gerenciar scripts SQL programados com a CLI gcloud, consulte a guia gcloud em Gerenciar a programação.

REST

Para informações sobre como monitorar scripts SQL programados usando REST, consulte a guia REST em Monitore sua tarefa.

Para mais informações sobre como gerenciar scripts SQL programados usando REST, consulte a guia REST em Gerenciar a programação.

Saída de um script SQL programado

A saída de cada execução de um script SQL programado é armazenada no local. especificado por você para a pasta do Cloud Storage, na seguinte estrutura:

CLOUD_STORAGE_FOLDER_LOCATION/projects/PROJECT_ID/locations/LOCATION_ID/lakes/LAKE_ID/tasks/TASK_ID/JOB_ID/QUERY_NUMBER

Criar e gerenciar programações para notebooks

Configuração de ambiente de execução para notebooks programados

Quando um notebook é programado, ele é executado como uma tarefa do Dataplex. Quando uma programação é criada usando o console do Google Cloud, o ambiente de execução da tarefa correspondente os parâmetros dos notebooks programados são herdados do ambiente do notebook, com base no seguinte mapeamento:

Parâmetro de configuração do ambiente Parâmetro de configuração de tarefa programada do notebook
Tamanho do disco principal Imagem / propriedades do contêiner:
spark.dataproc.driver.disk.size
spark.dataproc.executor.disk.size
Número de nós Contagem de lotes / executores
Número máximo de nós Contagem máxima de executores em lote / máximo
Versão de imagem Não herdado
Arquivos JAR Imagem do contêiner / Java JARS
Pacotes do Python Não herdado
Outras propriedades Imagem / propriedades do contêiner

Programar notebooks com pacotes personalizados

Para notebooks interativos, ao configurar um ambiente, O Dataplex permite especificar pacotes Python personalizados a serem instalados em sessões de usuários provisionadas para o ambiente. Quando um notebook é programado, os pacotes Python personalizados configurados em seu ambiente não estejam disponíveis no ambiente de execução para o programado, e o ambiente de execução padrão tem apenas os componentes do ambiente de execução Spark sem servidor do Dataproc versão 1.0. Para que os pacotes Python personalizados estejam disponíveis no ambiente de execução para notebooks programados, fornecer uma imagem de contêiner personalizada com os pacotes personalizados necessários.

Como especificar uma imagem de contêiner personalizada ao programar um notebook usando o console do Google Cloud não é compatível. Em vez disso, use a CLI gcloud. Para mais mais informações, consulte Programar um notebook.

Se você programar um notebook com um ambiente que tem pacotes personalizados configurados, você receberá o seguinte aviso:

Selected environment  has additional Python packages configured.
These packages will not be available in the default runtime for the scheduled notebook
when scheduling in the Console. To make the required additional Python packages
available in the runtime, please create Notebook Schedule using gcloud command
instead, referencing a container image with required additional packages.

Criar uma imagem de contêiner personalizada para notebooks programados

Para informações sobre como estabelecer uma imagem de contêiner para notebooks programados e instalar os pacotes Python personalizados necessários no dockerfile da imagem do contêiner, consulte Crie uma imagem de contêiner personalizada para o Dataproc sem servidor para Spark.

Verifique se você instalou os seguintes pacotes conda na imagem do contêiner:

  • gcsfs
  • google-cloud-bigquery
  • google-cloud-storage
  • google-auth
  • ipykernel
  • papermill
.

Para instalar os componentes gcloud em uma imagem de contêiner, abra o dockerfile da imagem de contêiner e conclua as etapas a seguir:

  1. Adicione o pacote google-cloud-sdk à lista de pacotes conda a serem instalados.

  2. Adicione as seguintes linhas após a etapa de instalação dos pacotes conda:

    # (Optional) Installing gcloud components
RUN gcloud components install alpha beta bq gsutil

Programar um notebook

Console

  1. No console do Google Cloud, acesse a página Explorar do Dataplex.

    Acessar o Dataplex Explore

  2. Selecione um notebook que você quer programar, selecionando um único notebook no a visualização Notebooks ou abrindo um notebook na página de detalhes.

  3. No menu Programação, clique em Criar programação.

  4. No campo Nome da programação, insira o nome da instância programada.

  5. Na seção Opções de programação, selecione se quer executar o notebook apenas uma vez ou regularmente:

    1. Se você selecionar Executar uma vez, especifique se quer executar o notebook imediatamente. ou em um horário programado, usando as opções no menu Iniciar. Para uma execução programada, especificar a data de início e o horário de execução.

    2. Ao selecionar Repetir, especifique se você quer executar o notebook diariamente, semanalmente ou mensal ou em uma programação personalizada especificada com a expressão cron. Além disso, especifique a data e o horário de início da execução programada inicial.

  6. Na seção Destino dos resultados, escolha um local onde você quer que a saída do notebook seja armazenada:

    1. No campo Nome da pasta de saída, faça o seguinte: Clique em Procurar e selecione uma pasta no bucket do Cloud Storage quer que a saída do notebook seja armazenada.

    2. Clique em Selecionar.

    3. Selecione o Formato de saída do script. Os formatos aceitos são CSV, JSON, ORC e Parquet.

  7. Na seção Credenciais programadas do notebook, selecione uma conta de serviço no menu Conta de serviço do usuário.

  8. Na seção Parâmetros, adicione parâmetros de execução para o notebook como chave-valor. clicando em Adicionar novo.

  9. Clique em Programação.

gcloud

Execute o comando da CLI gcloud descrito em Programar uma tarefa do Spark (Java ou Python) com os seguintes parâmetros adicionais:

Parâmetro Descrição
--notebook Caminho para o conteúdo de um notebook de entrada. Os argumentos de execução podem ser acessados variáveis de ambiente. Por exemplo, TASK_key=value
Observação: Na documentação de referência gcloud para programar notebooks como tarefas, é mencionou que o valor do parâmetro --notebook pode ser o URI do Cloud Storage do no arquivo do notebook. Não há suporte para isso. Você só deve especificar o caminho para Notebook Conteúdo do parâmetro --notebook.
--notebook-archive-uris URIs do Cloud Storage de arquivos a serem extraídos para o diretório de trabalho de cada executor. Os tipos de arquivo aceitos são JAR, tar, tar.gz, tgz e zip.
--notebook-file-uris URIs do Cloud Storage de arquivos a serem colocados no diretório de trabalho de cada executor.
Recursos de computação necessários para uma tarefa ao usar o Dataproc sem servidor
--notebook-batch-executors-count Número de executores de job.
--notebook-batch-max-executors-count Máximo de executores configuráveis.
Se notebook-batch-max-executors-count for maior que notebook-batch-executors-count, o escalonamento automático será ativado.
Configuração do ambiente de execução da imagem do contêiner
--notebook-container-image Opcional: imagem de contêiner personalizada para a vaga.
--notebook-container-image-java-jars Uma lista de JARs Java para adicionar ao caminho de classe. A entrada válida inclui URIs do Cloud Storage para Binários JAR. Por exemplo, gs://BUCKET_NAME/my/path/to/file.jar.
--notebook-container-image-properties As propriedades a serem definidas nos arquivos de configuração daemon.
As chaves de propriedade são especificadas no formato prefix:property. Por exemplo::
core:hadoop.tmp.dir.
Para mais informações, consulte Propriedades do cluster.
rede VPC do Google Cloud usada para executar a infraestrutura
--notebook-vpc-network-tags Lista de tags de rede para aplicar à vaga.
O identificador de rede VPC do Cloud. É possível especificar no máximo uma das opções a seguir.
--notebook-vpc-network-name A rede VPC do Cloud em que o job é executado. Por padrão, a rede VPC do Cloud chamada O padrão dentro do projeto é usado.
--notebook-vpc-sub-network-name A sub-rede VPC do Cloud em que o job é executado.
Local para saídas do notebook
--execution-args Para tarefas de notebook, o argumento a seguir é obrigatório e precisa seja transmitido como TASK_ARGS.
--execution-args=^::^TASK_ARGS="--output_location,CLOUD_STORAGE_URI_OF_OUTPUT_DIRECTORY"

Este é um exemplo do comando gcloud usado para programar notebooks:

gcloud dataplex tasks create sample-task --project=sample-project --location=us-central1 --lake=my-lake --trigger-type=ON_DEMAND --notebook="projects/my-project-id/locations/us-central1/lakes/my-lake/content/my-notebook.ipynb" --execution-service-account=associated-service-account@sample-project.iam.gserviceaccount.com  --execution-args=^::^TASK_ARGS="--output_location,gs://my-bucket/Demo" --notebook-batch-executors-count=2 --notebook-batch-max-executors-count=5 --notebook-container-image=container-image --notebook-container-image-java-jars=java-jar1,java-jar-2

REST

Use o APIs Explorer para criar uma tarefa.

Gerenciar programações de notebooks

Console

Abrir a lista de todas as programações de notebook

  1. No console do Google Cloud, acesse a página Processo do Dataplex.

  2. Clique na guia Notebooks programados para acessar a lista de programações de scripts SQL.

Abrir a lista de todas as programações de um notebook específico

  1. No console do Google Cloud, acesse a página Explorar do Dataplex.

  2. Selecione o notebook necessário.

  3. No menu Programação, clique em Ver programações.

    A guia Consultas programadas é aberta com uma lista de programações de notebooks filtradas pelo notebook selecionado.

Mais detalhes de uma programação de notebook

  1. Acesse a guia Notebooks programados e selecione a programação necessária do notebook.

  2. Clique nos detalhes de Detalhes da programação do notebook e confira uma prévia do conteúdo programado.

Ativar e desativar uma programação do notebook

  1. Acesse a guia Notebook programado e selecione a programação necessária do notebook.

  2. Clique em Desativar para desativar uma programação ativa de notebooks.

  3. Clique em Ativar para ativar uma programação inativa de notebook.

Excluir uma programação de notebook atual

  1. Acesse a guia Notebook programado e selecione a programação necessária do notebook.

  2. Clique em Excluir para remover permanentemente uma programação de notebook.

Visualizar registros e gerenciar uma programação de notebook

  1. Acesse a guia Notebook programado e selecione a programação necessária do notebook.

  2. Clique na guia Jobs e depois no ID do job da execução programada do notebook que você quer visualizar.

  3. Na seção Saída da visualização, revise a saída da execução do notebook.

  4. Clique em Ver registros para acessar os registros relacionados à execução do notebook programado selecionado no Cloud Logging.

  5. Clique em Código de lote do Dataproc para abrir a página do Dataproc no console do Google Cloud. Acesse os detalhes da sessão correspondente do Dataproc sem servidor.

  6. Clique em Gerenciar no Cloud Storage ao lado do rótulo Saída para abrir a página do Cloud Storage no console do Google Cloud. Acessar os detalhes do Cloud Storage correspondente que contém a saída da execução do notebook.

gcloud

Para mais informações sobre como monitorar notebooks programados usando a CLI gcloud, consulte a guia gcloud em Monitor your task.

Para mais informações sobre como gerenciar notebooks programados usando a CLI gcloud, consulte a guia gcloud em Gerenciar a programação.

REST

Para informações sobre como monitorar notebooks programados usando REST, consulte a guia REST (link em inglês) em Monitore sua tarefa.

Para mais informações sobre como gerenciar notebooks programados usando REST, consulte a guia REST em Gerenciar a programação.

Saída de um notebook programado

A saída de cada execução de um notebook programado é armazenada no local especificado por você para a pasta do Cloud Storage, na seguinte estrutura:

CLOUD_STORAGE_FOLDER_LOCATION/projects/PROJECT_ID/locations/LOCATION_ID/lakes/LAKE_ID/tasks/TASK_ID/JOB_ID/QUERY_NUMBER

A seguir