Faça a gestão dos notebooks

Este documento descreve como gerir os blocos de notas do Colab Enterprise no BigQuery, incluindo como ver, comparar, restaurar e eliminar blocos de notas.

Este documento também descreve como ver e gerir metadados de blocos de notas no Dataplex Universal Catalog.

Os blocos de notas são recursos de código do BigQuery Studio com tecnologia Dataform.

Antes de começar

1. Crie um notebook.
2. Para gerir metadados de blocos de notas no Dataplex Universal Catalog, certifique-se de que a API Dataplex está ativada no seu Google Cloud projeto.

Autorizações necessárias

Para partilhar blocos de notas, precisa das seguintes funções de gestão de identidade e de acesso (IAM):

• Utilizador de tarefas do BigQuery (roles/bigquery.jobUser)
• Utilizador da sessão de leitura do BigQuery (roles/bigquery.readSessionUser)
• Proprietário do código (roles/dataform.codeOwner) ao nível do recurso.

Para guardar e eliminar blocos de notas, precisa das seguintes funções do IAM:

• Utilizador de tarefas do BigQuery (roles/bigquery.jobUser)
• Utilizador da sessão de leitura do BigQuery (roles/bigquery.readSessionUser)
• Proprietário do código (roles/dataform.codeOwner) ou Editor de código (roles/dataform.codeEditor)

Para trabalhar com revisões de blocos de notas, precisa das seguintes funções do IAM:

• Utilizador de tarefas do BigQuery (roles/bigquery.jobUser)
• Utilizador da sessão de leitura do BigQuery (roles/bigquery.readSessionUser)

• Qualquer uma das seguintes funções:

  • Proprietário do código (roles/dataform.codeOwner)
  • Editor de código (roles/dataform.codeEditor)
  • Visualizador de código (roles/dataform.codeViewer)

Para mais informações sobre o IAM do BigQuery, consulte o artigo Controlo de acesso com o IAM.

Para gerir os metadados dos blocos de notas no Dataplex Universal Catalog, certifique-se de que tem as funções do Dataplex Universal Catalog necessárias.

Conceda acesso a notebooks

Para conceder a outros utilizadores acesso a um notebook, adicione esses utilizadores a uma função do IAM adequada.

Importante: os utilizadores que têm acesso ao bloco de notas podem ver todos os resultados gerados pelo código no bloco de notas, mesmo que estes resultados contenham dados de tabelas às quais não têm acesso. Para impedir a partilha da saída guardada, desative a opção de guardar a saída do bloco de notas.

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

   Se não vir o painel do lado esquerdo, clique em Expandir painel do lado esquerdo para o abrir.

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Encontre o bloco de notas ao qual quer conceder acesso.

5. Clique em Abrir ações junto ao bloco de notas e, de seguida, em Partilhar.

6. No painel Partilhar autorizações, clique em Adicionar utilizador/grupo.

7. No campo Novos membros, introduza um membro.

8. Na lista Função, selecione uma das seguintes funções:

   • Proprietário do código: pode realizar qualquer ação no bloco de notas, incluindo eliminá-lo ou partilhá-lo.
   • Editor de código: pode editar o notebook.
   • Leitor de código: pode ver o notebook.
   Nota: o principal também tem de ter as funções Utilizador do tempo de execução do bloco de notas (roles/aiplatform.notebookRuntimeUser) e Utilizador do BigQuery (roles/bigquery.user) para executar o bloco de notas.

9. Opcional: para ver uma lista completa de funções e definições de partilha avançadas, clique em Partilha avançada.

10. Clique em Guardar.

11. Para voltar à página de informações do bloco de notas, clique em Fechar.

Partilhe notebooks

Para partilhar um notebook com outros utilizadores, pode gerar e partilhar um link para o notebook. Para que outros utilizadores vejam o notebook que partilha, tem de conceder acesso ao notebook.

Para executar um notebook, os utilizadores têm de ter acesso aos dados aos quais o notebook acede. Para mais informações, consulte o artigo Conceda acesso a um conjunto de dados.

Importante: os utilizadores que têm acesso ao bloco de notas podem ver todos os resultados gerados pelo código no bloco de notas, mesmo que estes resultados contenham dados de tabelas às quais não têm acesso. Para impedir a partilha da saída guardada, desative a opção de guardar a saída do bloco de notas.

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

   Se não vir o painel do lado esquerdo, clique em Expandir painel do lado esquerdo para o abrir.

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Encontre o bloco de notas que quer partilhar. Pode usar a funcionalidade de pesquisa ou os filtros para encontrar o seu bloco de notas.

5. Clique em Ver ações junto ao bloco de notas e, de seguida, clique em Partilhar > Copiar link.

6. Partilhe o link com outros utilizadores.

Ver todos os notebooks

Para ver uma lista de todos os blocos de notas no seu projeto, faça o seguinte:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

   Se não vir o painel do lado esquerdo, clique em Expandir painel do lado esquerdo para o abrir.

3. No painel Explorador, clique em Ver ações junto a Blocos de notas e, de seguida, faça uma das seguintes ações:

• Para abrir a lista no separador atual, clique em Mostrar tudo.
• Para abrir a lista num novo separador, clique em Mostrar tudo em > Novo separador.
• Para abrir a lista num separador dividido, clique em Mostrar tudo em > Separador dividido.

Veja os metadados do bloco de notas

Para ver os metadados do bloco de notas, siga estes passos:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Clique no nome do bloco de notas cujos metadados quer ver.

5. Consulte os detalhes do resumo para ver informações sobre o bloco de notas, como a região que usa para dados e a data da última modificação.

Trabalhe com versões de blocos de notas

Pode optar por criar um notebook dentro ou fora de um repositório. O controlo de versões dos blocos de notas é processado de forma diferente consoante a localização do bloco de notas.

Controlo de versões de blocos de notas em repositórios

Os repositórios são repositórios Git que residem no BigQuery ou num fornecedor de terceiros. Pode usar espaços de trabalho em repositórios para fazer o controlo de versões em blocos de notas. Para mais informações, consulte o artigo Use o controlo de versões com um ficheiro.

Controlo de versões de blocos de notas fora dos repositórios

Use as secções seguintes para saber como ver, comparar e restaurar versões de um bloco de notas.

Veja as versões do bloco de notas

Para ver as versões do bloco de notas, siga estes passos:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas. Clique no nome do bloco de notas cujo histórico de versões quer ver.

4. Para ver uma lista das versões do bloco de notas por ordem descendente de data, clique em Histórico de versões.

Compare versões de notebooks

Para comparar versões de blocos de notas, siga estes passos:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Clique no nome do bloco de notas para o qual quer comparar as informações da versão.

5. Clique em Histórico de versões.

6. Clique em Ver ações junto a uma versão do bloco de notas e, de seguida, clique em Comparar. O painel de comparação é aberto, comparando a versão do bloco de notas que selecionou com a versão atual do bloco de notas.

7. Opcional: para comparar as versões inline em vez de em painéis separados, clique em Comparar e, de seguida, clique em Inline.

8. Opcional: para comparar o código fonte das versões, clique em Comparar e, de seguida, clique em Mostrar origem não processada.

9. Opcional: para ocultar o resultado do comando no bloco de notas, clique em Comparar e, em seguida, desmarque a opção Mostrar resultado.

Restaure uma versão de um bloco de notas

A restauração de uma versão do bloco de notas a partir do painel de comparação permite-lhe comparar as versões atual e anterior do bloco de notas antes de optar por restaurar a versão anterior. A restauração de um bloco de notas cria uma nova versão de um bloco de notas em vez de substituir a versão atual. Não se perde nenhum histórico de versões.

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Clique no nome do bloco de notas do qual quer restaurar uma versão anterior.

5. Clique em Histórico de versões.

6. Clique em Ver ações junto à versão e, de seguida, clique em Comparar. O painel de comparação é aberto, comparando a versão do bloco de notas que selecionou com a versão mais recente do bloco de notas.

7. Se quiser restaurar a versão anterior do bloco de notas após a comparação, clique em Restaurar.

8. Clique em Confirm.

Transfira um notebook

Para transferir um bloco de notas, siga estes passos:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Clique no nome do bloco de notas que quer transferir. Pode usar a funcionalidade de pesquisa ou os filtros para encontrar o seu bloco de notas.

5. Expanda a barra de menu e aceda ao menu Ficheiro:

   

6. Selecione Transferir e, de seguida, selecione o tipo de ficheiro no qual quer transferir o ficheiro.

Elimine notebooks

Para eliminar um bloco de notas, siga estes passos:

1. Na Google Cloud consola, aceda à página BigQuery.

   Aceda ao BigQuery

2. No painel esquerdo, clique em Explorador:

   

3. No painel Explorador, expanda o projeto e clique em Blocos de notas.

4. Encontre o bloco de notas que quer eliminar.

5. Clique em Ver ações junto ao bloco de notas e, de seguida, clique em Eliminar.

6. Para confirmar a eliminação, escreva delete na caixa de diálogo.

7. Clique em Eliminar.

Faça a gestão de metadados no Dataplex Universal Catalog

O Dataplex Universal Catalog permite-lhe armazenar e gerir metadados para blocos de notas. Os blocos de notas estão disponíveis no Dataplex Universal Catalog por predefinição, sem configuração adicional.

Pode usar o Dataplex Universal Catalog para gerir blocos de notas em todas as localizações do BigQuery. A gestão de blocos de notas no Dataplex Universal Catalog está sujeita a quotas e limites do Dataplex Universal Catalog e preços do Dataplex Universal Catalog.

O Dataplex Universal Catalog extrai automaticamente os seguintes metadados dos blocos de notas:

• Nome do recurso de dados
• Recurso de dados principal
• Localização do recurso de dados
• Tipo de recurso de dados
• Projeto Google Cloud correspondente

O Dataplex Universal Catalog regista os blocos de notas como entradas com os seguintes valores de entrada:

Grupo de entradas do sistema

O grupo de entradas do sistema para blocos de notas é @dataform. Para ver os detalhes das entradas do bloco de notas no Dataplex Universal Catalog, tem de ver o grupo de entradas do sistema dataform. Para ver instruções sobre como ver uma lista de todas as entradas num grupo de entradas, consulte o artigo Ver detalhes de um grupo de entradas na documentação do Dataplex Universal Catalog.

Tipo de entrada do sistema

O tipo de entrada do sistema para blocos de notas é dataform-code-asset. Para ver os detalhes dos blocos de notas, tem de ver o dataform-code-asset tipo de entrada do sistema, filtrar os resultados com um filtro baseado em aspetos, e definir o campo type no aspeto dataform-code-asset como NOTEBOOK. Em seguida, selecione uma entrada do bloco de notas selecionado. Para ver instruções sobre como ver os detalhes de um tipo de entrada selecionado, consulte o artigo Ver detalhes de um tipo de entrada na documentação do catálogo universal do Dataplex. Para ver instruções sobre como ver os detalhes de uma entrada selecionada, consulte a secção Ver detalhes de uma entrada na documentação do Dataplex Universal Catalog.

Tipo de aspeto do sistema

O tipo de aspeto do sistema para portáteis é dataform-code-asset. Para fornecer contexto adicional aos blocos de notas no Dataplex Universal Catalog anotando as entradas dos blocos de notas com aspetos, veja o tipo de aspeto dataform-code-asset, filtre os resultados com um filtro baseado em aspetos e defina o campo type no aspeto dataform-code-asset como NOTEBOOK. Para ver instruções sobre como anotar entradas com aspetos, consulte o artigo Gerir aspetos e enriquecer metadados na documentação do catálogo universal do Dataplex.

Tipo

O tipo de telas de dados é NOTEBOOK. Este tipo permite-lhe filtrar blocos de notas no dataform-code-assettipo de entrada do sistema e no tipo de aspeto dataform-code-asset usando a consulta num filtro baseado em aspetos.aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK

Para obter instruções sobre como pesquisar recursos no Dataplex Universal Catalog, consulte o artigo Pesquise recursos de dados no Dataplex Universal Catalog na documentação do Dataplex Universal Catalog.

Resolução de problemas

Para mais informações, consulte o artigo Resolva problemas do Colab Enterprise.

O que se segue?

• Saiba mais sobre os blocos de notas do Colab Enterprise no BigQuery.
• Saiba como criar blocos de notas.
• Saiba como agendar blocos de notas.