Gerenciar seus recursos do AlloyDB usando o Knowledge Catalog

A integração do Knowledge Catalog é ativada por padrão para todos os novos clusters do AlloyDB. Assim, é possível pesquisar e gerenciar seus recursos do AlloyDB para PostgreSQL usando o Knowledge Catalog, uma plataforma que permite armazenar, gerenciar e acessar metadados. Essa integração ajuda você a descobrir e entender os metadados do AlloyDB, oferecendo suporte aos seguintes casos de uso:

  • Análise:entenda as dependências e avalie a adequação para vários casos de uso.
  • Gerenciamento de mudanças:acompanhe e gerencie as mudanças de metadados com eficiência.
  • Evolução do esquema:monitore e planeje modificações no esquema.

O Knowledge Catalog recupera automaticamente os seguintes metadados de clusters, instâncias, bancos de dados, tabelas, colunas e visualizações do AlloyDB:

  • Nome
  • Local (região)
  • Rótulos (para clusters e instâncias)
  • Integração do Dataplex ativada (para clusters)
  • Versão do banco de dados
  • Contagem de CPUs da máquina (para instâncias)
  • Tipo de disponibilidade (para instâncias)
  • Charset (para bancos de dados)
  • Ordenação (para bancos de dados)
  • Proprietário
  • Descrição (para tabelas, visualizações, colunas e chaves estrangeiras)
  • Tipo (para clusters, instâncias e máquinas)
  • Colunas
    • Tipo de dados
    • Modo
  • Chave primária
  • Chaves externas
    • Tabela referenciada
    • Mapeamentos de colunas
  • Horário da criação
  • Horário da última modificação

Tipos de descoberta de metadados

A descoberta de metadados do Knowledge Catalog é um processo automatizado que verifica fontes de dados conectadas, como o AlloyDB, para identificar recursos de dados, como tabelas, visualizações e bancos de dados. Em seguida, o Knowledge Catalog extrai metadados técnicos dos recursos, como esquemas, descrições e locais.

Esse processo sincroniza metadados quase em tempo real, o que mantém o catálogo sincronizado com os sistemas de origem. No AlloyDB, os metadados de cluster e instância são descobertos por padrão. A descoberta de metadados de banco de dados, esquema, tabela e visualização é ativada por padrão em novos clusters. Para clusters criados antes da implementação desse padrão (26 de fevereiro de 2026), ative a integração manualmente.

O catálogo de conhecimento aceita pesquisas por palavras-chave e linguagem natural.

  • A pesquisa por palavras-chave ajuda você a encontrar recursos usando palavras-chave, filtros e uma sintaxe definida. Por exemplo, para ver todos os bancos de dados do AlloyDB, insira system=AlloyDB AND type=Database.
  • A pesquisa em linguagem natural (prévia) usa IA para entender consultas semânticas. Ele ajuda você a encontrar recursos usando linguagem cotidiana, eliminando a necessidade de sintaxes complexas. Por exemplo, insira uma consulta como List all AlloyDB tables related to sales.

Para mais informações, consulte Sintaxe de pesquisa do Catálogo de Conhecimento.

Exemplo: como descobrir um esquema de banco de dados do AlloyDB

Para entender o processo de descoberta de metadados, considere o exemplo de um cluster do AlloyDB chamado user-data-cluster com a integração do Knowledge Catalog ativada. Na instância principal desse cluster, há um banco de dados chamado profiles, que contém uma tabela customers (id, email, signup_date) e uma visualização active_users (id, email).

Como o AlloyDB sincroniza quase em tempo real com o catálogo de dados de conhecimento, os seguintes recursos estão disponíveis:

  • Clusters
  • Colunas
  • Bancos de dados
  • Instâncias
  • Tabelas
  • Visualizações

Depois que a descoberta for concluída, pesquise esses recursos (tabela customers e active_users) na página do catálogo de dados do console Google Cloud ou usando a API. Em seguida, veja os esquemas e enriqueça-os com metadados operacionais ou comerciais adicionais.

Enriquecer metadados usando aspectos

Os tipos de aspecto são recursos reutilizáveis que servem como modelos para aspectos. Os tipos de aspecto ajudam a evitar a duplicação de trabalho e a criação de aspectos incompletos. Crie os tipos de aspecto necessários usando o Knowledge Catalog.

Depois de criar tipos personalizados de aspecto, anexe aspectos aos seus recursos do AlloyDB. Ao anexar aspectos aos recursos do AlloyDB, você pode fazer o seguinte:

  • Adicionar metadados comerciais aos recursos.
  • Pesquise recursos por metadados da empresa e outros metadados personalizados.

Para saber mais sobre como criar tipos de aspecto e anexar aspectos ao AlloyDB, consulte Gerenciar aspectos e aprimorar metadados.

Fluxo de trabalho de descoberta de metadados

Por padrão, os recursos de cluster e instância são ingeridos e podem ser descobertos. Para ingerir e descobrir recursos de banco de dados, esquema, tabela e visualização, siga estas etapas:

  1. Ative a integração do catálogo de conhecimento para seu cluster do AlloyDB usando a API AlloyDB, se ela ainda não estiver ativada. Isso é necessário para clusters criados antes de 26 de fevereiro de 2026.

  2. Pesquise seus recursos do AlloyDB usando a página de pesquisa do Knowledge Catalog no console Google Cloud . Para mais informações, consulte Pesquisar recursos no Catálogo de Conhecimento.

  3. Para adicionar mais contexto aos seus recursos do AlloyDB, anexe aspectos a eles. Aspectos são entradas de metadados personalizados que ajudam na governança de dados e na análise. Por exemplo, use um aspecto para rotular uma coluna que contenha informações de identificação pessoal (PII). Para mais informações, consulte Gerenciar aspectos e enriquecer metadados.

  4. Navegue pelos recursos do AlloyDB seguindo esta hierarquia: Cluster > Banco de dados > Esquema > Tabela ou visualização > Coluna. Essa hierarquia oferece uma visão detalhada do seu cenário de dados. Para mais informações, consulte Pesquisar recursos no Catálogo de Conhecimento.

Antes de começar

  1. Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. Ativar a API Dataplex para o projeto.

    Ativar a API Dataplex

  7. Verifique as permissões.

    Você precisa de papéis e permissões específicos do Identity and Access Management (IAM) para pesquisar e anexar entradas a recursos do AlloyDB. Para mais informações, consulte Permissões e papéis do IAM necessários para o Knowledge Catalog.

Papéis necessários do IAM

Nesta seção, descrevemos os papéis e as permissões necessários para pesquisar recursos e acessar os resultados da pesquisa.

Papéis necessários para acessar os resultados da pesquisa

Para pesquisar e visualizar metadados do AlloyDB no Knowledge Catalog, os principais precisam de permissões para acessar recursos do AlloyDB, incluindo a permissão dataplex.projects.search.

Para conceder a principais (como usuários, grupos ou contas de serviço) essas permissões, atribua a eles o papel do IAM de Leitor do AlloyDB (roles/alloydb.viewer) no projeto que contém os recursos do AlloyDB.

Operação do Catálogo de Conhecimento Recurso do AlloyDB Funções ou permissões necessárias
Pesquisar recursos do AlloyDB Cluster alloydb.clusters.get
Colunas alloydb.databases.get
Instância alloydb.instances.get
Banco de dados alloydb.databases.get
Tabelas alloydb.databases.get
Visualizações alloydb.databases.get

Se você não quiser usar a função predefinida Leitor do AlloyDB, atribua uma função personalizada que inclua as permissões alloydb.clusters.get, alloydb.instances.get e alloydb.databases.get.

Para mais informações sobre como conceder papéis, consulte Gerenciar o acesso. Para mais informações sobre os papéis do IAM do AlloyDB, consulte Papéis e permissões do IAM para o AlloyDB.

Funções necessárias para pesquisar entradas

Você precisa ter pelo menos um dos seguintes papéis do IAM no projeto usado para pesquisa:

As permissões nos resultados da pesquisa são verificadas independentemente do projeto selecionado. Para mais informações, consulte Pesquisar recursos de dados com o Knowledge Catalog.

Atualização de dados da integração do Catálogo de Conhecimento

Por padrão, o Knowledge Catalog ingere e descobre recursos de cluster e instância, e a atualização dos metadados é quase em tempo real.

A integração do Knowledge Catalog para recursos de banco de dados, esquema, tabela e visualização é ativada por padrão quando você cria um cluster do AlloyDB. Para impedir a sincronização desses metadados, desative a integração.

Ao ativar a integração, você ativa a exportação de metadados do AlloyDB, como bancos de dados, esquemas e tabelas, para buckets do Cloud Storage para sincronização periódica ou para tópicos do Pub/Sub para sincronização quase em tempo real, disponibilizando-os para o Knowledge Catalog. Esse recurso só é aplicável a clusters principais. Os clusters secundários usados para replicação entre regiões não oferecem suporte à integração do Knowledge Catalog para metadados de banco de dados, esquema, tabela e visualização.

A atualização dos metadados desses recursos depende de quando o cluster foi criado ou restaurado:

  • Quase em tempo real:os clusters criados ou restaurados a partir de 3 de abril de 2026 sincronizam metadados com o Knowledge Catalog quase em tempo real. As atualizações ficam disponíveis no Catálogo de dados em até 5 minutos. O processo de extração geralmente leva alguns segundos.

  • A cada poucas horas:os clusters criados ou restaurados entre 26 de fevereiro de 2026 e 3 de abril de 2026 atualizam os metadados no Knowledge Catalog a cada poucas horas. As atualizações ficam disponíveis no Catálogo de conhecimento em até 48 horas. O processo de extração normalmente leva alguns minutos, mas o tempo até a conclusão depende do tamanho da CPU e da contagem de tabelas.

Criar o AlloyDB com a integração do catálogo de conhecimento desativada

É possível controlar essa integração ao criar ou atualizar um cluster usando a Google Cloud CLI ou a API AlloyDB:

gcloud

Use o comando gcloud alloydb clusters create para criar um cluster do AlloyDB. Se você omitir a flag --enable-dataplex-integration, a integração do Knowledge Catalog será ativada por padrão para metadados de banco de dados, esquema, tabela e visualização. Para uma lista completa de parâmetros dessa chamada, consulte gcloud alloydb clusters create. Para informações sobre as configurações de cluster, consulte Ver configurações de cluster e instância.

Não inclua informações sensíveis ou informações de identificação pessoal no ID do cluster, porque ele pode ficar visível em vários contextos operacionais, como registros do sistema, painéis de monitoramento e comunicações de suporte. Não é necessário incluir o ID do projeto no nome do cluster. O sistema inclui isso automaticamente quando necessário, por exemplo, nos arquivos de registro.

Para desativar a integração do catálogo de conhecimento para recursos de banco de dados, esquema, tabela e visualização, inclua a flag --no-enable-dataplex-integration:

gcloud alloydb clusters create CLUSTER_ID \
    --password=PASSWORD \
    --region=REGION \
    --no-enable-dataplex-integration

Faça as seguintes substituições:

  • CLUSTER_ID: o ID do cluster que você criou. O ID do cluster precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hifens.
  • PASSWORD: a senha que você usa para o usuário postgres padrão.
  • REGION: o ID da região do cluster.

REST

Use o método POST para criar um cluster do AlloyDB. Se você omitir o dataplexConfig da solicitação, a integração do catálogo de conhecimento será ativada por padrão para metadados de banco de dados, esquema, tabela e visualização. Para uma lista completa de parâmetros dessa chamada, consulte Método: projects.locations.clusters.create. Para informações sobre as configurações de cluster, consulte Ver configurações de cluster e instância.

Não inclua informações sensíveis ou informações de identificação pessoal no ID do cluster, porque ele pode ficar visível em vários contextos operacionais, como registros do sistema, painéis de monitoramento e comunicações de suporte. Não é necessário incluir o ID do projeto no nome do cluster. O sistema inclui isso automaticamente quando necessário, por exemplo, nos arquivos de registro.

Para desativar a integração do catálogo de conhecimento para recursos de banco de dados, esquema, tabela e visualização, inclua "dataplexConfig": { "enabled": false } no corpo da solicitação:

{
  "databaseVersion": "DATABASE_VERSION",
  "initialUser": {
    "user": "INITIAL_USERNAME",
    "password": "INITIAL_USER_PASSWORD"
  },
  "labels": {
    "test": "alloydb-cluster-full"
  },
  "dataplexConfig" : {
    "enabled" : false
  }
}

Faça as seguintes substituições:

  • DATABASE_VERSION: string de enumeração da versão do banco de dados. Por exemplo, POSTGRES_16.
  • INITIAL_USERNAME: o nome de usuário que você usa para o usuário padrão do postgres.
  • INITIAL_USER_PASSWORD: a senha que você usa para o usuário padrão do postgres.

Use o método HTTP e o URL a seguir:

POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID

Faça as seguintes substituições:

  • PROJECT_ID: o ID ou número do projeto do projeto Google Cloud que contém o cluster.
  • LOCATION_ID: o ID da região do cluster.
  • CLUSTER_ID: o ID do cluster que você criou. O ID do cluster precisa começar com uma letra minúscula e pode conter letras minúsculas, números e hifens.

Para enviar a solicitação, use uma das seguintes opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"| Select-Object -Expand Content

Você vai receber uma resposta JSON semelhante a esta:

Resposta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Ativar a integração do Catálogo de Conhecimento para o cluster do AlloyDB

Para ativar a integração do Knowledge Catalog em um cluster atual, use um dos procedimentos a seguir:

gcloud

Para ativar a integração do catálogo de conhecimento em um cluster atual, use o comando gcloud alloydb clusters update com a flag --enable-dataplex-integration.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --enable-dataplex-integration

Faça as seguintes substituições:

  • CLUSTER_ID: o nome do cluster.
  • REGION: o ID da região do cluster.

REST

Para atualizar campos específicos de um cluster atual, use o método PATCH no projects.locations.clusters resource.

Use o método HTTP e o URL a seguir:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Faça as seguintes substituições:

  • PROJECT_ID: o ID ou número do projeto do projeto Google Cloud que contém o cluster.
  • LOCATION_ID: o ID da região do cluster.
  • CLUSTER_ID: o nome do cluster.

Corpo JSON da solicitação:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Para enviar a solicitação, use uma das seguintes opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

    curl -X PATCH \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Você vai receber uma resposta JSON semelhante a esta:

Resposta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Verificar a integração do Knowledge Catalog no cluster do AlloyDB

Para verificar se a integração do Knowledge Catalog está ativada em um cluster atual, use um dos procedimentos a seguir:

gcloud

Para verificar se a integração do Knowledge Catalog está ativada em um cluster atual, use o comando gcloud alloydb clusters describe.

gcloud alloydb clusters describe CLUSTER_ID --region=REGION

Faça as seguintes substituições:

  • CLUSTER_ID: o ID do cluster.
  • REGION: o ID da região do cluster.

A saída inclui a seção dataplexConfig no formato YAML. Se enabled for true, a integração do Catálogo de Conhecimento será ativada:

dataplexConfig:
  enabled: true

REST

Para verificar se a integração do Knowledge Catalog está ativada em um cluster atual, use o método GET.

Use o método HTTP e o URL a seguir:

GET https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID

Faça as seguintes substituições:

  • PROJECT_ID: o ID ou número do projeto do projeto Google Cloud que contém o cluster.
  • LOCATION_ID: o ID da região do cluster.
  • CLUSTER_ID: o ID do cluster.

Para enviar a solicitação, use uma das seguintes opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"| Select-Object -Expand Content

Você recebe uma resposta JSON para todo o proto do cluster, que inclui a mensagem dataplexConfig:

{
  "dataplexConfig": {
    "enabled": true
  }
}

Desativar a integração do Catálogo de dados no cluster do AlloyDB

Quando você desativa a integração do Knowledge Catalog no cluster do AlloyDB, apenas os metadados do cluster e da instância ficam disponíveis.

gcloud

Use o comando gcloud alloydb clusters update com a flag --no-enable-dataplex-integration para desativar a integração.

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --no-enable-dataplex-integration

Faça as seguintes substituições:

  • CLUSTER_ID: o ID do cluster.
  • REGION: o ID da região do cluster.

REST

Use o exemplo a seguir para desativar a integração.

Use o método HTTP e o URL a seguir:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

Faça as seguintes substituições:

  • PROJECT_ID: o ID ou número do projeto do projeto Google Cloud que contém o cluster.
  • LOCATION_ID: o ID da região do cluster.
  • CLUSTER_ID: o ID do cluster.

Corpo JSON da solicitação:

{
  "dataplexConfig": {
    "enabled": false
  }
}

Para enviar a solicitação, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell (Windows)

Salve o corpo da solicitação em um arquivo chamado request.json e execute o comando a seguir:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

Você vai receber uma resposta JSON semelhante a esta:

Resposta

{
  "kind": "alloydb#operation",
  "targetLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/clusters/CLUSTER_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "CLUSTER_ID",
  "selfLink": "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Enriquecer recursos do AlloyDB com aspectos

Os tipos de aspecto são recursos reutilizáveis que servem como modelos para aspectos. Os tipos de aspecto ajudam a evitar a duplicação de trabalho e a criação de aspectos incompletos. Crie os tipos de aspecto necessários usando o Knowledge Catalog.

Depois de criar tipos personalizados de aspecto, anexe aspectos aos seus recursos do AlloyDB. Ao anexar aspectos aos recursos do AlloyDB, você tem os seguintes recursos:

  • Adicionar metadados comerciais aos recursos
  • Pesquise recursos por metadados da empresa e outros metadados personalizados

Para saber mais sobre como criar tipos de aspecto e anexar aspectos ao AlloyDB, consulte Gerenciar aspectos e aprimorar metadados.

Pesquisar recursos do AlloyDB

Use a página de pesquisa do Knowledge Catalog no console Google Cloud para pesquisar recursos do AlloyDB.

  1. Acesse a página Pesquisa do Knowledge Catalog.

    Acesse Pesquisar

  2. Em Escolher plataforma de pesquisa, selecione Knowledge Catalog.

  3. No painel Filtros, clique em Sistemas e selecione AlloyDB.

  4. Opcional. Em Aliases de tipo, filtre os resultados da pesquisa para um tipo específico de recurso do AlloyDB selecionando um ou mais dos seguintes aliases de tipo:

    • Banco de dados
    • Database schema
    • Cluster
    • Instância
    • Serviço
    • Tabela
    • Ver

Use o campo de pesquisa no Knowledge Catalog para realizar consultas de pesquisa por palavras-chave. Por exemplo, insira system=AlloyDB AND type=Database para ver todos os bancos de dados do AlloyDB.

Para mais informações, consulte Sintaxe de pesquisa do Catálogo de Conhecimento.

Para ver todos os recursos do AlloyDB, insira system=AlloyDB.

Em seguida, insira palavras-chave específicas. Por exemplo, para ver todos os bancos de dados do AlloyDB:

system=AlloyDB AND type=Database

Para conferir todas as tabelas do AlloyDB, insira a seguinte consulta:

system=AlloyDB AND type=Table

Também é possível usar parênteses e os operadores lógicos AND e OR para expressões complexas. Para mais informações sobre as expressões que podem ser usadas no campo de pesquisa, consulte Sintaxe de pesquisa do Knowledge Catalog.

É possível inserir diretamente consultas de pesquisa para recursos específicos do AlloyDB no campo de pesquisa. O formato da string de consulta é o seguinte:

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

Substitua:

  • QUERY_STRING: use a lista a seguir para identificar uma string de consulta com base no tipo de recurso do AlloyDB que você quer consultar:

    • alloydb-database
    • alloydb-cluster
    • alloydb-instance
    • alloydb-table
    • alloydb-schema
    • alloydb-view

Um exemplo de consulta pode ser semelhante ao seguinte:

type="projects/1234567890/locations/global/entryTypes/alloydb-cluster"

Pesquisar por tipo de aspecto

O Knowledge Catalog inclui alguns tipos de aspectos integrados que ajudam você a realizar pesquisas.

Para pesquisar por tipo de aspecto, siga estas etapas:

  1. No painel Aspectos, clique no menu Adicionar mais tipos de aspecto.
  2. Opcional. Selecione Acesso ao AlloyDB para filtrar os resultados por dialeto do AlloyDB.
  3. Selecione um ou mais dos seguintes tipos de aspecto para limitar os resultados da pesquisa a esse tipo.
    • Banco de dados do AlloyDB
    • Cluster do AlloyDB
    • Instância do AlloyDB
    • Visualização do AlloyDB
    • Esquema do AlloyDB
    • Tabela do AlloyDB
  4. Clique em OK.
  5. Na tabela de resultados, clique no nome do recurso para visualizar os metadados dele.
  6. Opcional: aprimore ou visualize seus recursos. É possível aprimorar ou visualizar seus recursos das seguintes maneiras:
    • Para adicionar uma descrição em rich text do recurso, clique em Adicionar em Visão geral.
    • Para anexar um aspecto ao recurso, clique em Adicionar em Aspectos.
    • Para conferir os bancos de dados de membros de uma instância, clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa. Se a guia Lista de entradas não aparecer, isso significa que o cluster não tem bancos de dados.
    • Confira todos os detalhes do recurso em Detalhes da entrada. Clique no nome da entrada para detalhar até entradas adicionais.

Pesquisa com linguagem natural no AlloyDB

A pesquisa em linguagem natural (prévia) usa IA para entender consultas semânticas. Ele ajuda você a encontrar recursos usando linguagem cotidiana, eliminando a necessidade de sintaxe complexa. Por exemplo, insira consultas como List all AlloyDB tables related to sales.

Para mais informações, consulte Sintaxe de pesquisa do Catálogo de Conhecimento.

Pesquisa de sintaxe no AlloyDB

A pesquisa por palavras-chave ajuda você a encontrar recursos usando palavras-chave, filtros e uma sintaxe definida. Por exemplo, insira system=AlloyDB AND type=Database para ver todos os bancos de dados do AlloyDB.

Para mais informações, consulte Sintaxe de pesquisa do Catálogo de Conhecimento.

Exemplo de fluxo de trabalho: detalhamento do cluster para as colunas

Para detalhar do cluster até as colunas, siga estas etapas:

  1. Acesse a página Pesquisa do Knowledge Catalog.

    Acesse Pesquisar

  2. Na opção Escolher plataforma de pesquisa, selecione Knowledge Catalog.

  3. No painel Filtros, selecione Sistemas e, em seguida, AlloyDB. Se preferir, digite system=AlloyDB no campo de pesquisa.

  4. Selecione um nome de cluster.

  5. Na página Detalhes do AlloyDB, clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa. O Knowledge Catalog mostra os bancos de dados no cluster.

  6. Na página Detalhes do banco de dados do AlloyDB, clique na guia Lista de entradas e depois em Exibir entradas filhas na pesquisa. O Knowledge Catalog mostra as tabelas no cluster.

  7. Selecione um nome de tabela e, na página Detalhes da tabela do AlloyDB, clique em Esquema para ver as colunas da tabela.

  8. Opcional: para adicionar um tipo de aspecto a uma coluna, clique no botão Adicionar aspecto.

Preços

Não há custos para armazenar metadados técnicos do AlloyDB no Catálogo de Conhecimento. Os preços padrão do Knowledge Catalog se aplicam a chamadas de API e ao aprimoramento de outros metadados comerciais. Para mais informações, consulte a página de preços do catálogo de dados.

Uso de recursos

O Knowledge Catalog extrai metadados periodicamente dos seus clusters do AlloyDB. Esse processo de extração consome recursos de CPU no cluster. O uso da CPU geralmente é mínimo. Por exemplo, clusters com tipos de máquinas menores (como n2-highmem-2-icelake) que gerenciam esquemas grandes (como aqueles com 100.000 ou mais tabelas) podem ter um aumento no uso da CPU de até 5% durante a extração.

Limitações

  • A integração aceita no máximo um milhão de tabelas por banco de dados e uma média de 150 colunas por tabela. Se um desses limites for excedido, os metadados de recursos como bancos de dados, esquemas, tabelas e visualizações não serão extraídos. Somente metadados de cluster e instância estão disponíveis no Knowledge Catalog.
  • Quando um cluster é criado, a sincronização inicial de todos os metadados com o Knowledge Catalog pode levar até 48 horas. Após a sincronização inicial, as atualizações subsequentes ficam disponíveis quase em tempo real.
  • Em caso de uma alta taxa de mudanças de metadados (mais de 100 alterações de DDL por segundo) no seu banco de dados, a sincronização de metadados quase em tempo real com o Knowledge Catalog pode ser pausada por até 30 minutos antes de ser retomada.
  • Se alguma atualização for perdida devido a uma alta taxa de mudanças de metadados, problemas de rede ou interrupção do processo de sincronização, ela vai aparecer no Catálogo de dados em até 48 horas.
  • Quando uma instância não existe ou não está em execução, pode levar sete dias para que os metadados sejam excluídos.
  • Quando um banco de dados é renomeado, apenas a atualização dele fica disponível no Knowledge Catalog quase em tempo real. O mapeamento do banco de dados e todas as tabelas correspondentes serão atualizados no catálogo do Knowledge em até 48 horas.

A seguir