Gerenciar conjuntos de contexto no Cloud SQL Studio

Visualizar

Este recurso está sujeito aos "Termos da Pré-GA" nos Termos Gerais de Serviço dos Termos Específicos de Serviço e aos Termos Adicionais para Produtos Pré-lançamento de IA Generativa. Os recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições das fases de lançamento.

Neste documento, descrevemos como criar conjuntos de contexto no Cloud SQL para PostgreSQL Studio usando um arquivo de conjunto de contexto. Quando você cria um conjunto de contexto no Cloud SQL Studio, ele é armazenado no grupo de conjuntos de contexto default do projeto para a região selecionada e vinculado ao banco de dados atual. Os nomes dos conjuntos de contexto (e os IDs derivados deles) precisam ser exclusivos no grupo de conjuntos de contexto default do projeto para uma determinada região, em todos os bancos de dados e instâncias. No Cloud SQL Studio, a criação de um conjunto de contexto com um nome cujo ID derivado já existe falha na validação. Para substituir o conteúdo mantendo as associações de banco de dados, edite o conjunto de contexto atual. O upload direto pelo agente de engenharia de contexto ou pela API Dataplex com um ID de conjunto de contexto atual substitui o conteúdo e, se especificado, as associações de banco de dados.

A lista Conjuntos de contexto no Cloud SQL Studio mostra apenas os conjuntos de contexto no grupo de conjuntos de contexto default em todas as regiões com disponibilidade que estão vinculadas ao banco de dados atual. Os conjuntos de contexto criados para outro banco de dados ou criados pela API sem vincular o recurso de banco de dados em databases (ou em um grupo de conjuntos de contexto personalizado) não aparecem na lista do Cloud SQL Studio.

Para saber mais sobre conjuntos de contexto, consulte Visão geral dos conjuntos de contexto.

Antes de começar

Conclua os seguintes pré-requisitos antes de criar um agente.

Ativar serviços obrigatórios

Ative os seguintes serviços para seu projeto:

• API Data Analytics com Gemini
• API Gemini para Google Cloud
• API Knowledge Catalog

Preparar uma instância do Cloud SQL

Verifique se você tem acesso a uma instância do Cloud SQL ou crie uma nova. Para mais informações, consulte Criar instâncias para o Cloud SQL.

Este tutorial exige que você tenha um banco de dados na instância do Cloud SQL. Para mais informações, consulte Criar um banco de dados na instância do Cloud SQL.

Papéis e permissões necessárias

• Ative a autenticação do banco de dados do IAM na instância definindo a flag de banco de dados cloudsql.iam_authentication como on (cloudsql.iam_authentication=on). Para mais informações, consulte Configurar instâncias atuais para autenticação do banco de dados do IAM.
• Adicione um usuário do IAM ou uma conta de serviço à instância. Para mais informações, consulte Gerenciar usuários com autenticação de banco de dados do IAM para o Cloud SQL.
• Conceda os papéis cloudsql.studioUser, cloudsql.instanceUser e geminidataanalytics.queryDataUser ao usuário do IAM no nível do projeto. Para mais informações, consulte Adicionar vinculação de política do IAM a um projeto.
• Para criar, fazer upload e gerenciar conjuntos de contexto, conceda o papel de Editor do Dataplex Catalog (roles/dataplex.catalogEditor) ou Administrador do Dataplex Catalog (roles/dataplex.catalogAdmin) ao usuário do IAM no nível do projeto. Para mais informações, consulte Permissões de conjuntos de contexto.
• Também é necessário conceder privilégios de banco de dados somente leitura a um usuário do IAM ou a uma conta de serviço fazendo login como um usuário com privilégios de superusuário, como o usuário postgres.
  
  GRANT SELECT ON ALL TABLES IN SCHEMA public TO USER_NAME;
  
  Substitua USER_NAME pelo endereço de e-mail do usuário. É preciso usar aspas ao redor do e-mail porque ele contém caracteres especiais (@ e .).
  
  Para mais informações, consulte Conceder privilégios de banco de dados a um usuário individual do IAM ou a uma conta de serviço.

Conceder permissão executesql à instância do Cloud SQL

Para conceder a permissão executesql à instância do Cloud SQL e ativar a API Data do Cloud SQL, execute o seguinte comando:

gcloud sql instances patch INSTANCE_ID --project=PROJECT_ID --data-api-access=ALLOW_DATA_API

Substitua o seguinte:

• PROJECT_ID: ID do seu projeto do Google Cloud .
• INSTANCE_ID: o ID da instância do Cloud SQL.

Para realizar as etapas deste tutorial, faça login no Google Cloud e autentique-se no banco de dados usando a autenticação do IAM.

Criar um conjunto de contextos

Para criar um conjunto de contexto, siga estas etapas:

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

   Acessar o Cloud SQL

2. Selecione uma instância na lista.

3. No menu de navegação, clique em Cloud SQL Studio.

4. Faça login no Cloud SQL Studio usando a autenticação do IAM.

5. No painel Explorer, ao lado de Conjuntos de contexto, clique em Ver ações.

6. Clique em Criar conjunto de contexto.

7. Em Nome do conjunto de contexto, forneça um nome exclusivo. No Cloud SQL Studio, o nome precisa ter de 4 a 30 caracteres e não pode começar com espaço em branco. O Studio deriva o ID do conjunto de contexto convertendo o nome em letras minúsculas e substituindo caracteres não alfanuméricos por hifens (-). O ID do conjunto de contexto derivado precisa ser exclusivo no grupo de conjuntos de contexto default do projeto para a região selecionada. Por exemplo, o nome do conjunto de contexto querydata_e2e_test tem o ID querydata-e2e-test. Quando você faz upload de um conjunto de contexto diretamente usando o agente de engenharia de contexto ou a API Dataplex, o ID do conjunto de contexto diferencia maiúsculas de minúsculas, não pode conter barras (/) e não é restrito a 4 a 30 caracteres ou caracteres alfanuméricos, hifens e sublinhados.

8. Opcional. Em Descrição do conjunto de contexto, adicione uma descrição para o conjunto de contexto.

9. Opcional. Para fazer upload de um arquivo de conjunto de contexto, clique em Procurar na seção Fazer upload do arquivo de conjunto de contexto e selecione o arquivo.

10. Opcional. Para escolher uma região para o conjunto de contexto, clique em Mostrar opções avançadas e selecione uma região em Selecionar um local (o padrão é us-east1 em cada criação). Se você escolher uma região diferente de us-east1, selecione-a antes de inserir o nome do conjunto de contexto para que o Cloud SQL Studio valide a exclusividade do nome nessa região.

11. Clique em Criar.

Observação: a criação de um conjunto de contexto no Cloud SQL Studio pode levar alguns minutos enquanto o Cloud SQL Studio processa o conjunto de contexto. A criação ou o upload de um conjunto de contexto pelo agente de engenharia de contexto ou pela API Dataplex geralmente é concluído em alguns segundos.

Criar conjuntos de contexto

Depois de criar um conjunto de contextos, siga as etapas em Criar contextos usando a CLI do Gemini para criar um arquivo de conjunto de contextos. Em seguida, edite o conjunto de contexto para fazer upload do arquivo.

Editar um conjunto de contextos

Para editar um conjunto de contexto, siga estas etapas:

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

   Acessar o Cloud SQL

2. Selecione uma instância na lista.

3. No menu de navegação, clique em Cloud SQL Studio.

4. Faça login no Cloud SQL Studio usando a autenticação do IAM.

5. Clique em Ver ações ao lado do conjunto de contexto que você quer editar.

6. Clique em Editar conjunto de contexto.

7. Opcional. Editar a descrição do conjunto de contextos.

8. Clique em Procurar na seção Fazer upload do arquivo do conjunto de contexto e selecione o arquivo do conjunto de contexto.

9. Clique em Salvar.

Excluir um conjunto de contexto

Para excluir um conjunto de contexto, siga estas etapas:

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

   Acessar o Cloud SQL

2. Selecione uma instância na lista.

3. No menu de navegação, clique em Cloud SQL Studio.

4. Faça login no Cloud SQL Studio usando a autenticação do IAM.

5. Clique em Ver ações ao lado do conjunto de contexto que você quer excluir.

6. Clique em Excluir conjunto de contexto.

7. Na caixa de diálogo de confirmação Excluir conjunto de contexto, insira o ID do conjunto de contexto.

8. Clique em Confirmar para excluir o conjunto de contexto.

Observação: excluir um banco de dados não exclui os conjuntos de contexto dele. Para evitar conjuntos de contexto órfãos que ainda expõem detalhes do esquema, exclua-os antes de excluir o banco de dados.

A seguir

• Saiba mais sobre os conjuntos de contexto.
• Saiba como testar um conjunto de contexto.
• Saiba como criar contextos usando a CLI do Gemini.