Quando você usa o agente de engenharia de contexto, ele pode criar e fazer upload de conjuntos de contexto automaticamente pela CLI. Neste documento, descrevemos como criar, editar e excluir conjuntos de contexto no AlloyDB para PostgreSQL Studio quando você quer uma interface visual no console do Google Cloud para gerenciar arquivos de conjuntos de contexto. Quando você cria um conjunto de contexto no AlloyDB 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 AlloyDB 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 AlloyDB Studio mostra apenas os conjuntos de contexto no grupo 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 AlloyDB Studio.
Antes de começar
Conclua os pré-requisitos a seguir antes de criar ou fazer upload de um conjunto de contexto.
Os conjuntos de contexto podem ser criados nas regiões us-central1, us-east1, europe-west4
e asia-southeast1.
Ativar serviços obrigatórios
Ative os seguintes serviços para seu projeto:Preparar um cluster, uma instância e um banco de dados do AlloyDB para PostgreSQL
Verifique se você tem acesso a um cluster e uma instância do AlloyDB ou crie um novo.Para este tutorial, é necessário ter um banco de dados na instância do AlloyDB. Para mais informações, consulte Criar um banco de dados.
Papéis e permissões necessárias
- Ative a autenticação de banco de dados do Identity and Access Management (IAM) na instância definindo a flag de banco de dados
alloydb.iam_authenticationcomoon(alloydb.iam_authentication=on). Para mais informações, consulte Ativar e desativar a autenticação do IAM. - Adicione um usuário do IAM ou uma conta de serviço ao cluster no nível do banco de dados. Para mais informações, consulte Gerenciar a autenticação do IAM.
- Conceda os papéis
roles/alloydb.databaseUser,roles/serviceusage.serviceUsageConsumereroles/geminidataanalytics.queryDataUserao 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 ao usuário do IAM ou
à conta de serviço.
GRANT SELECT ON ALL TABLES IN SCHEMA public TO "USER_NAME";
Substitua USER_NAME pelo endereço de e-mail de um usuário ou pelo endereço da conta de serviço sem o sufixo.gserviceaccount.com(por exemplo,my-sa@my-project.iam). Use aspas ao redor do identificador porque ele contém caracteres especiais (@ e .).
Para mais informações, consulte Conceder as permissões de banco de dados adequadas aos usuários do IAM.
Conceder permissão executesql à instância do AlloyDB para PostgreSQL
Para conceder a permissão executesql à instância do AlloyDB para PostgreSQL e definir
o campo de instância dataApiAccess como ENABLED (necessário para QueryData, mesmo que
o padrão permita alguns serviços internos do Google Cloud , como o AlloyDB Studio),
use o seguinte comando curl:
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json" \
-H "x-goog-user-project: PROJECT_ID" \
https://alloydb.googleapis.com/v1beta/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/instances/INSTANCE_ID?updateMask=dataApiAccess \
-d '{
"dataApiAccess": "ENABLED"
}'
PROJECT_ID: ID do seu projeto do Google Cloud .LOCATION: a região em que o cluster do AlloyDB está localizado.CLUSTER_ID: o ID do cluster do AlloyDB.INSTANCE_ID: o ID da instância do AlloyDB.
Criar um conjunto de contextos
Para criar um conjunto de contexto, siga estas etapas:
No console do Google Cloud , acesse a página do AlloyDB.
Selecione um cluster na lista.
No menu de navegação, clique em AlloyDB Studio.
Faça login no AlloyDB Studio usando a autenticação do IAM.
No painel Explorer, ao lado de Conjuntos de contexto, clique em Ver ações.
Clique em Criar conjunto de contexto.
Em Nome do conjunto de contexto, forneça um nome exclusivo. No AlloyDB Studio, o nome precisa ter de 4 a 30 caracteres e não pode começar com espaços 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 contextodefaultdo projeto para a região selecionada. Por exemplo, o nome do conjunto de contextoquerydata_e2e_testtem o IDquerydata-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.Opcional. Em Descrição do conjunto de contexto, adicione uma descrição para o conjunto de contexto.
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.
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-east1em cada criação). Se você escolher uma região diferente deus-east1, selecione-a antes de inserir o nome do conjunto de contexto para que o AlloyDB Studio valide a exclusividade do nome nessa região.Clique em Criar.
Criar conjuntos de contexto
Se você criou um conjunto de contexto vazio no Studio ou quer atualizar um que já existe, siga as etapas em Criar e otimizar conjuntos de contexto com o agente de engenharia de contexto para gerar e otimizar um arquivo de conjunto de contexto. O agente de engenharia de contexto pode criar e fazer upload do conjunto de contexto diretamente da CLI, ou você pode editar o conjunto de contexto no Studio para fazer upload do arquivo manualmente.
Editar um conjunto de contextos
Para editar um conjunto de contexto, siga estas etapas:
No console do Google Cloud , acesse a página do AlloyDB.
Selecione um cluster na lista.
No menu de navegação, clique em AlloyDB Studio.
Faça login no AlloyDB Studio usando a autenticação do IAM.
Clique em Ver ações ao lado do conjunto de contexto que você quer editar.
Clique em Editar conjunto de contexto.
Opcional. Editar a descrição do conjunto de contextos.
Clique em Procurar na seção Fazer upload do arquivo do conjunto de contexto e selecione o arquivo do conjunto de contexto.
Clique em Salvar.
Excluir um conjunto de contexto
Para excluir um conjunto de contexto, siga estas etapas:
No console do Google Cloud , acesse a página do AlloyDB.
Selecione um cluster na lista.
No menu de navegação, clique em AlloyDB Studio.
Faça login no AlloyDB Studio usando a autenticação do IAM.
Clique em Ver ações ao lado do conjunto de contexto que você quer excluir.
Clique em Excluir conjunto de contexto.
Na caixa de diálogo de confirmação Excluir conjunto de contexto, insira o ID do conjunto de contexto.
Clique em Confirmar para excluir o conjunto de contexto.
A seguir
- Saiba mais sobre os conjuntos de contexto.
- Saiba como testar o QueryData no AlloyDB Studio.
- Saiba como criar e otimizar conjuntos de contexto com o agente de engenharia de contexto.
- Saiba como integrar o QueryData a um aplicativo.