Gerenciar notebooks

Neste documento, descrevemos como gerenciar notebooks do Colab Enterprise no BigQuery, incluindo como visualizar, comparar, restaurar e excluir notebooks.

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

Antes de começar

Antes de começar, crie um notebook.

Permissões necessárias

Para compartilhar notebooks, você precisa dos seguintes papéis do Identity and Access Management (IAM):

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

Para salvar e excluir notebooks, você precisa dos seguintes papéis do IAM:

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

Para trabalhar com revisões de notebook, você precisa dos seguintes papéis do IAM:

• Usuário de jobs do BigQuery(roles/bigquery.jobUser)
• Usuário de sessão de leitura do BigQuery(roles/bigquery.readSessionUser)

• Qualquer um dos seguintes papéis:

  • Proprietário de 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 Controle de acesso com o IAM.

Conceder acesso a notebooks

Para conceder acesso a um notebook a outros usuários, adicione-os a um papel apropriado do IAM.

Importante: os usuários que têm acesso ao notebook podem ver toda a saída gerada pelo código no notebook, mesmo que ela contenha dados de tabelas às quais eles não têm acesso. Para evitar que a saída salva seja compartilhada, desative o salvamento de saída do notebook.

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, a pasta Notebooks compartilhados. Encontre o notebook a que você quer conceder acesso.

3. Clique em Ver ações ao lado do notebook e depois selecione Compartilhar > Gerenciar permissões.

4. No painel Gerenciar permissões, clique em Adicionar usuário/grupo.

5. No campo Novos principais, digite um principal..

6. Na lista Papel, selecione um dos seguintes papéis:

   • Proprietário de código: pode executar qualquer ação no notebook, inclusive excluí-lo ou compartilhá-lo.
   • Editor de código: pode editar o notebook.
   • Leitor de código: pode visualizar o notebook.
   Observação: o principal também precisa ter os papéis Usuário de ambiente de execução do notebook (roles/aiplatform.notebookRuntimeUser) e Usuário do BigQuery (roles/bigquery.user) para executar o notebook.

7. Opcional: para ver uma lista completa de papéis e configurações de compartilhamento avançadas, clique em Compartilhamento avançado.

8. Clique em Salvar.

9. Para retornar à página de informações do notebook, clique em Fechar.

Compartilhar notebooks

Para compartilhar um notebook com outros usuários, gere e compartilhe um link para ele. Para que outros usuários vejam o notebook que você compartilha, primeiro é necessário conceder acesso a ele.

Para executar um notebook, os usuários precisam ter acesso aos dados que ele acessa. Para mais informações, consulte Conceder acesso a um conjunto de dados.

Importante: os usuários que têm acesso ao notebook podem ver toda a saída gerada pelo código no notebook, mesmo que ela contenha dados de tabelas às quais eles não têm acesso. Para evitar que a saída salva seja compartilhada, desative o salvamento de saída do notebook.

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, expanda a pasta Notebooks compartilhados. Localize o notebook que você quer compartilhar.

3. Clique em Conferir ações ao lado do notebook e depois em Compartilhar > Copiar link.

4. Compartilhe o link com outros usuários.

Mostrar todos os notebooks

Para ver uma lista de todos os notebooks do projeto, faça o seguinte:

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

   Acessar o BigQuery

2. No painel Explorer, clique em Ver ações ao lado de Notebooks e execute uma das seguintes ações:

• Para abrir a lista na guia atual, clique em Mostrar tudo.
• Para abrir a lista em uma nova guia, clique em Mostrar tudo em > Nova guia.
• Para abrir a lista em uma guia dividida, clique em Mostrar tudo em > Dividir guia.

Ver metadados do notebook

Para visualizar os metadados do notebook, siga estas etapas:

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, a pasta Notebooks compartilhados. Clique no nome do notebook cujos metadados você quer ver.

3. Consulte o painel Resumo para ver informações sobre o notebook, como a região que ele usa para dados e a data da última modificação.

Trabalhar com versões de notebook

Use as seções a seguir para aprender a visualizar, comparar e restaurar versões de um notebook.

Ver versões do notebook

Para ver as versões do notebook, siga estas etapas:

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, a pasta Notebooks compartilhados. Clique no nome do notebook com a atividade que você quer ver.

3. Clique na guia Atividade para ver uma lista das versões do notebook em ordem decrescente por data.

Comparar versões do notebook

Para comparar as versões do notebook, siga estas etapas:

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, a pasta Notebooks compartilhados. Clique no nome do notebook com as informações de versão que você quer comparar.

3. Na guia Atividade, clique em Ver ações ao lado de uma versão do notebook e clique em Comparar. O painel de comparação é aberto, comparando a versão do notebook selecionada com a versão atual.

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

5. Opcional: para comparar o código-fonte das versões, clique em Comparar e em Mostrar a origem bruta.

6. Opcional: para ocultar a saída do comando no notebook, clique em Comparar e desmarque Mostrar resultado.

Restaurar uma versão do notebook

Use uma das seguintes opções para restaurar uma versão do notebook. A restauração do painel de comparação permite comparar as versões atuais e anteriores do notebook antes de optar por restaurar a versão anterior. Restaurar um notebook cria uma nova versão dele em vez de substituir a atual. Nenhum histórico de versões é perdido.

Painel de atividades

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, expanda a pasta Notebooks compartilhados. Clique no nome do notebook que tem uma versão anterior que você quer restaurar.

3. Selecione o painel Atividade.

4. Clique em Ver ações ao lado da versão do notebook que você quer restaurar e, em seguida, clique em Restaurar.

5. Clique em Confirmar.

Painel de comparação

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, expanda a pasta Notebooks compartilhados. Clique no nome do notebook que tem uma versão anterior que você quer restaurar.

3. Selecione o painel Atividade.

4. Clique em Ver ações ao lado de uma versão do notebook e depois em Comparar. O painel de comparação é aberto, comparando a versão do notebook selecionada com a versão mais recente.

5. Se quiser restaurar a versão anterior do notebook após a comparação, clique em Restaurar.

6. Clique em Confirmar.

Fazer o download de um notebook

Para fazer o download de um notebook, siga estas etapas:

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, a pasta Notebooks compartilhados. Clique no nome do notebook que você quer transferir por download.

3. Clique em Fazer download.

Excluir notebooks

Para excluir um notebook, siga estas etapas:

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

   Acessar o BigQuery

2. No painel Explorer, expanda seu projeto e a pasta Notebooks e, se necessário, expanda a pasta Notebooks compartilhados. Encontre o notebook que você quer excluir.

3. Clique em Ver ações ao lado do notebook e clique em Excluir.

4. Para confirmar a exclusão, digite delete na caixa de diálogo.

5. Clique em Excluir.

Solução de problemas

Confira mais informações em Resolver problemas no Colab Enterprise.

A seguir

• Saiba mais sobre os notebooks do Colab Enterprise no BigQuery.
• Saiba como criar notebooks.
• Saiba como orquestrar notebooks.