Gerenciar seus recursos do Cloud SQL usando o Knowledge Catalog

Nesta página, explicamos como pesquisar e gerenciar os recursos do Cloud SQL usando o Knowledge Catalog.

O Knowledge Catalog é uma plataforma para armazenar, gerenciar e acessar seus metadados. O Knowledge Catalog recupera automaticamente os seguintes metadados de instâncias, bancos de dados, tabelas, colunas e visualizações do Cloud SQL:

  • Nome
  • Local (região)
  • Data de criação e data da última modificação
  • Esquema (para tabelas e visualizações)
  • Descrição
  • Restrições de chave primária e externa

O Knowledge Catalog recupera metadados somente das instâncias principais do Cloud SQL e não de réplicas de leitura ou de servidores externos.

Use o Knowledge Catalog para descobrir e entender os metadados do Cloud SQL. Use o Knowledge Catalog para ajudar nas seguintes atividades:

  • Descoberta de dados
  • Classificação
  • Análise, incluindo dependências e adequação a um caso de uso
  • Gestão da mudança
  • Movimentação de dados (pipelines)
  • Evolução do esquema

Com o Knowledge Catalog, você seleciona metadados anexando aspectos às entradas de metadados do Cloud SQL. Cada aspecto pode ter vários campos de metadados e podem ser baseados em um tipo de aspecto predefinido ou personalizado.

Por exemplo, você pode anexar o seguinte aspecto a uma coluna que contenha um CPF ou CNPJ, que são informações de identificação pessoal (PII):

  pii:true
  pii_type:SSN

Para mais informações sobre o Knowledge Catalog, consulte Sobre o gerenciamento de metadados no Knowledge Catalog.

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

A atualização esperada dos metadados da instância no Knowledge Catalog depende da data de criação da instância e da versão do banco de dados.

Quase em tempo real

A integração com o Knowledge Catalog é ativada por padrão quando a instância é criada, se ela atender a todos os seguintes critérios:

  1. Hora de criação:a partir de 18 de abril de 2026

  2. Versão:Cloud SQL para MySQL versão 8.0 ou mais recente
  3. Arquitetura de rede:Nova arquitetura de rede

Se a instância não atender a todos esses critérios, consulte Uma vez por dia.

As instâncias que atendem a todos esses critérios são criadas com uma tabela de carimbos de data/hora para rastrear os horários de criação e atualização dos seus recursos. A tabela de carimbo de data/hora é a tabela resource_timestamps no banco de dados mysql. A tabela de carimbo de data/hora pode ser consultada no Cloud SQL no console Cloud de Confiance . Quando a instância tem uma DDL ou uma mudança de esquema, a integração consulta a tabela de carimbo de data/hora para identificar recursos mudados recentemente e carrega as atualizações de esquema mais recentes no Knowledge Catalog quase em tempo real. Em casos raros, por exemplo, quando há instabilidade na rede, o Knowledge Catalog pode perder uma atualização. Embora isso seja raro, as mudanças que não foram feitas se tornam eventualmente consistentes, geralmente em até 24 horas. Para mais informações sobre cenários que podem causar mudanças perdidas, consulte Limitações nesta página.

Ao visualizar as consultas executadas em uma instância, você verá aquelas que são compatíveis com a integração do Knowledge Catalog. É possível identificar essas consultas pelo comentário --Dataplex que elas incluem. Para ver as consultas de uma instância, consulte Ver consultas ativas.

Você pode desativar a integração e reativá-la mais tarde seguindo as instruções em Atualizar a instância.

Uma vez por dia

A integração com o Knowledge Catalog pode ser ativada para instâncias que atendam a qualquer um dos seguintes critérios:

  1. Horário de criação:antes de 18 de abril de 2026
  2. Versão:Cloud SQL para MySQL versão anterior à 8.0
  3. Arquitetura de rede:arquitetura de rede antiga

Se a instância foi criada depois de 18 de abril de 2026, a integração com o Knowledge Catalog está ativada por padrão. Para instâncias criadas antes de 18 de abril de 2026, é possível ativar a integração do Knowledge Catalog em uma instância do Cloud SQL .

Depois de ativar a integração com o Knowledge Catalog, os metadados das instâncias que atendem a qualquer um desses critérios geralmente são atualizados no Knowledge Catalog cerca de uma vez por dia. É possível desativar a integração do Knowledge Catalog e reativá-la conforme necessário.

Antes de começar

  1. In the Cloud de Confiance console, on the project selector page, select or create a Cloud de Confiance 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

  2. Verify that billing is enabled for your Cloud de Confiance project.

  3. Ativar a API Dataplex para o projeto.

    Ativar a API Dataplex

  4. Verifique as permissões.

    Você precisa de certos papéis e permissões do Identity and Access Management (IAM) para pesquisar e anexar entradas a recursos do Cloud SQL. Para mais detalhes, consulte Permissões e papéis do IAM necessários para o Knowledge Catalog.

Permissões e papéis do IAM necessários para o Knowledge Catalog

O Cloud SQL usa a permissão cloudsql.schemas.view para fornecer acesso aos metadados no Knowledge Catalog.

Para dar essa permissão, crie um papel personalizado que a inclua ou use um dos papéis predefinidos que tenham essa permissão.

Para mais informações, consulte Papéis predefinidos do IAM do Cloud SQL.

Criar uma instância com a integração do Knowledge Catalog ativada

Por padrão, as novas instâncias são integradas ao Knowledge Catalog. Para criar uma instância com a integração do Knowledge Catalog ativada, basta criar uma instância. Para criar uma instância com o Knowledge Catalog integrado em quase tempo real, a nova instância precisa atender a todos os seguintes critérios:

  1. Hora de criação:a partir de 18 de abril de 2026

  2. Versão:Cloud SQL para MySQL versão 8.0 ou mais recente
  3. Arquitetura de rede:Nova arquitetura de rede

Se você quiser ativar o Knowledge Catalog quase em tempo real para uma nova instância com uma versão de banco de dados anterior ou a arquitetura de rede antiga, poderá clonar a instância ou restaurar de um backup para uma nova instância.

gcloud

Criar instância

Para criar uma instância do Cloud SQL, use o comando gcloud sql instances create.

gcloud sql instances create INSTANCE_NAME \
  --database-version=DATABASE_VERSION \
  --tier=MACHINE_TYPE \
  --region=REGION_NAME

Faça as seguintes substituições:

  • INSTANCE_NAME: nome da instância
  • DATABASE_VERSION: a versão do banco de dados da instância (por exemplo, MYSQL_8_0 ). Para uma lista completa de strings disponíveis, consulte SqlDatabaseVersion
  • MACHINE_TYPE: o tipo de máquina da instância
  • REGION_NAME: o nome da região da instância

Este exemplo é baseado em Linux.

REST v1

Criar instância

Use este exemplo para criar uma instância com a integração ativada. Para uma lista completa de parâmetros disponíveis para essa chamada, consulte a página instances.insert.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância
  • REGION_NAME: o nome da região da instância
  • DATABASE_VERSION: string de enumeração da versão do banco de dados (por exemplo, POSTGRES_13). Para uma lista completa de strings disponíveis, consulte SqlDatabaseVersion.
  • PASSWORD: a senha do usuário root
  • MACHINE_TYPE: string de tipo enumerado do tipo de máquina (camada), como: db-custom-[CPUS]-[MEMORY_MBS]
  • EDITION_TYPE: sua edição do Cloud SQL

Método HTTP e URL:

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

Corpo JSON da solicitação:

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

REST v1beta4

Criar instância

Use este exemplo para criar uma instância com a integração ativada. Para uma lista completa de parâmetros disponíveis para essa chamada, consulte a página instances.insert.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância
  • REGION_NAME: o nome da região da instância
  • DATABASE_VERSION: string de enumeração da versão do banco de dados (por exemplo, POSTGRES_13). Para uma lista completa de strings disponíveis, consulte SqlDatabaseVersion.
  • PASSWORD: a senha do usuário root
  • MACHINE_TYPE: string de tipo enumerado do tipo de máquina (camada), como: db-custom-[CPUS]-[MEMORY_MBS]
  • EDITION_TYPE: sua edição do Cloud SQL

Método HTTP e URL:

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances

Corpo JSON da solicitação:

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

Ativar a integração do Knowledge Catalog em uma instância do Cloud SQL

Esta seção se aplica a instâncias que atendem a qualquer um dos seguintes critérios:
  1. Horário de criação:antes de 18 de abril de 2026
  2. Versão:Cloud SQL para MySQL versão anterior à 8.0
  3. Arquitetura de rede:arquitetura de rede antiga

Você também pode seguir as instruções de atualização nesta seção para reativar a integração do Knowledge Catalog em uma instância que já estava integrada ao Knowledge Catalog quase em tempo real. Leva até 10 minutos para que os dados quase em tempo real comecem a aparecer no Knowledge Catalog após a reativação da integração.

Para ativar ou reativar a integração do Knowledge Catalog em uma instância do Cloud SQL existente, use um dos procedimentos a seguir.

gcloud

Atualizar a instância

Para ativar a integração para uma instância atual, use o comando gcloud sql instances patch.

gcloud sql instances patch INSTANCE_NAME \
  --enable-dataplex-integration

Se você precisar ativar e atualizar todas as instâncias do Cloud SQL no projeto, execute um script semelhante ao seguinte:

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --enable-dataplex-integration

Este exemplo é baseado em Linux.

REST v1

Atualizar a instância

Use este exemplo para atualizar uma instância. Para uma lista completa de parâmetros disponíveis para essa chamada, consulte a página instances.patch.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância

Método HTTP e URL:

PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME

Corpo JSON da solicitação:

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

REST v1beta4

Atualizar a instância

Use este exemplo para atualizar uma instância. Para uma lista completa de parâmetros disponíveis para essa chamada, consulte a página instances.patch.

Use este exemplo para atualizar uma instância. Para uma lista completa de parâmetros disponíveis para essa chamada, consulte a página instances.patch.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância

Método HTTP e URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Corpo JSON da solicitação:

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

Verificar a integração do Knowledge Catalog na instância do Cloud SQL

Para verificar se a integração do Knowledge Catalog está ativada na sua instância, use um dos procedimentos a seguir.

gcloud

Para verificar se a integração do Knowledge Catalog está ativada em uma instância atual, use o comando gcloud sql instances describe.

gcloud sql instances describe INSTANCE_NAME

Substitua INSTANCE_NAME pelo nome da instância. Na saída, procure a configuração enableDataplexIntegration definida como true.

REST v1

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID do projeto
  • INSTANCE_ID: o ID da instância

Método HTTP e URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

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

Você receberá uma resposta JSON semelhante a esta:

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

REST v1beta4

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID do projeto
  • INSTANCE_ID: o ID da instância

Método HTTP e URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

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

Você receberá uma resposta JSON semelhante a esta:

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

Desativar a integração do catálogo de conhecimento na instância do Cloud SQL

Para desativar a integração do Knowledge Catalog na sua instância do Cloud SQL, use um dos procedimentos a seguir. Desativar a integração do Knowledge Catalog em uma instância integrada quase em tempo real leva até 10 minutos.

Console

  1. No console Cloud de Confiance , acesse a página Instâncias do Cloud SQL.

    Acesse "Instâncias do Cloud SQL"

  2. Para abrir a página Visão geral de uma instância, clique no nome dela.
  3. Clique em Editar.
  4. Na seção Personalizar sua instância, expanda o menu Mostrar opções de configuração.
  5. Na seção Flags e parâmetros, desmarque a caixa de seleção Ativar integração do Knowledge Catalog.

  6. Clique em Salvar.

gcloud

Para desativar a integração de uma instância atual, use o comando gcloud sql instances patch.

gcloud sql instances patch INSTANCE_NAME \
  --no-enable-dataplex-integration

Se você precisar desativar a integração e atualizar as instâncias do Cloud SQL no projeto, é possível executar um script semelhante ao seguinte:

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --no-enable-dataplex-integration

Este exemplo é baseado em Linux.

REST v1

Use este exemplo para desativar a integração.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância

Método HTTP e URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Corpo JSON da solicitação:

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

REST v1beta4

Use este exemplo para desativar a integração.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: o ID ou número do projeto do projeto Cloud de Confiance que contém a instância
  • INSTANCE_NAME: nome da instância

Método HTTP e URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

Corpo JSON da solicitação:

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

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

Você receberá uma resposta JSON semelhante a esta:

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

Enriquecer os recursos do Cloud SQL com aspectos

Os tipos de aspecto são recursos reutilizáveis que podem ser usados como modelos. Os tipos de aspecto ajudam a evitar a duplicação de trabalho e aspectos incompletos. É possível usar o Knowledge Catalog para criar os tipos de aspecto que você precisa.

Depois de criar tipos personalizados de aspecto, é possível anexar aspectos aos seus recursos do Cloud SQL. Ao anexar aspectos aos recursos do Cloud SQL 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 Cloud SQL, consulte Gerenciar aspectos e aprimorar metadados.

Pesquisar recursos do Cloud SQL

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

  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 Cloud SQL.

  4. Opcional. Em Aliases de tipo, é possível filtrar os resultados da pesquisa para uma consulta de recurso do Cloud SQL selecionando um ou mais dos aliases de tipo a seguir:

    • Banco de dados
    • Serviço
    • Tabela
    • Ver
    .

Usar consultas para realizar pesquisas

Também é possível usar o campo de pesquisa no Knowledge Catalog para realizar consultas de pesquisa. Para visualizar todos os recursos do Cloud SQL, insira system=Cloud_SQL.

Em seguida, insira palavras-chave específicas. Por exemplo, para exibir todas os bancos de dados do Cloud SQL:

system=Cloud_SQL AND type=Database

Para visualizar todas as tabelas do Cloud SQL, insira a seguinte consulta:

system=Cloud_SQL AND type=Table

Também é possível usar parênteses e os operadores lógicos AND e OR para expressões complexas. Para saber mais sobre as expressões que você pode usar no campo de pesquisa, consulte Sintaxe de pesquisa do Catálogo de Conhecimento.

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

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

Substitua QUERY_STRING por uma string de consulta com base no mecanismo do Cloud SQL e no tipo de recurso que você quer consultar. Use a tabela a seguir para identificar a string de consulta adequada.

Mecanismo do Cloud SQL Strings de consulta
Cloud SQL para MySQL
  • cloudsql-mysql-database
  • cloudsql-mysql-instance
  • cloudsql-mysql-table
  • cloudsql-mysql-view
Cloud SQL para PostgreSQL
  • cloudsql-postgresql-database
  • cloudsql-postgresql-instance
  • cloudsql-postgresql-table
  • cloudsql-postgresql-schema
  • cloudsql-postgresql-view
Cloud SQL para SQL Server
  • cloudsql-sqlserver-database
  • cloudsql-sqlserver-instance
  • cloudsql-sqlserver-table
  • cloudsql-sqlserver-schema
  • cloudsql-sqlserver-view

Um exemplo de consulta pode ser semelhante ao seguinte:

type="projects/dataplex-types/locations/global/entryTypes/cloudsql-postgresql-instance"

Filtrar recursos do Cloud SQL por dialeto do Cloud SQL

Por padrão, o Knowledge Catalog mostra todos os recursos do Cloud SQL. Para filtrar os recursos do Cloud SQL para MySQL, Cloud SQL para PostgreSQL, ou apenas SQL Server, siga as etapas abaixo.

  1. No painel Aspectos, clique no menu Adicionar mais tipos de aspecto.

  2. Selecione Acesso SQL.

  3. Clique em OK.

  4. Clique no botão "Editar aspecto" playlist_add . Na página Acesso SQL, faça o seguinte:

    • No campo Dialeto, selecione MySQL para filtrar os recursos do Cloud SQL para MySQL.
    • Opcional. Selecione o campo Versão e insira uma versão específica do Cloud SQL para MySQL.
  5. Clique em Aplicar. O Knowledge Catalog só exibe recursos do Cloud SQL para MySQL.

O Knowledge Catalog inclui alguns tipos de aspectos integrados que você pode usar para realizar pesquisas.

  1. No painel Aspectos, clique no menu Adicionar mais tipos de aspecto.

  2. Opcional. Selecione Acesso SQL para filtrar os resultados por dialeto do Cloud SQL. Para mais informações, consulte o procedimento anterior, Filtrar recursos do Cloud SQL por dialeto do Cloud SQL.

  3. Selecione um ou mais dos seguintes tipos de aspecto para limitar os resultados da pesquisa a esse tipo.

    • Banco de dados do Cloud SQL
    • Instância do Cloud SQL
    • Visualização do Cloud SQL
    • Esquema do Cloud SQL
    • Tabela do Cloud SQL
  4. Clique em OK.

  5. Na tabela de resultados, clique no nome de um recurso para visualizar os metadados dele.

  6. Opcional: aprimore ou visualize seus recursos. Você poderá escolher qualquer uma das seguintes opções:

    • Em Visão geral, clique em Adicionar para incluir uma descrição em rich text do recurso.
    • Em Aspectos, clique em Adicionar para anexar um aspecto ao recurso.
    • Em uma instância, para visualizar os bancos de dados dos membros, clique no botão Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa. Se a guia Lista de entradas não for exibida, isso significa que a instância não tem bancos de dados.
    • Em Detalhes da entrada, confira todos os detalhes do recurso. Clique no nome da entrada para detalhar até entradas adicionais.

Exemplo de fluxo de trabalho: detalhamento da instância para as colunas

Neste fluxo de trabalho de exemplo, você começa pesquisando uma instância do Cloud SQL. Em seguida, você visualiza o banco de dados de membros, uma tabela nesse banco de dados e as colunas na tabela.

  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, Cloud SQL. Se preferir, digite system=Cloud_SQL no campo de pesquisa.

  4. Selecione um nome de instância.

  5. Na página Detalhes do Cloud SQL, clique na guia Lista de entradas e depois em Mostrar todas as entradas filhas na pesquisa. O Knowledge Catalog mostra os bancos de dados na instância.

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

  7. Selecione um nome de tabela e, na página Detalhes da tabela do Cloud SQL, 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.

Esse fluxo de trabalho demonstra o detalhamento de uma instância para uma tabela. Você pode acessar diretamente uma lista de tabelas inserindo system=Cloud_SQL AND type=Table; no campo de pesquisa.

Preços

Não há custos para armazenar metadados técnicos do Cloud SQL no Knowledge Catalog. 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

Enquanto a integração do Knowledge Catalog está ativada, ele extrai dados das suas instâncias periodicamente. O processo de extração exige uma certa quantidade de uso da CPU. As instâncias integradas ao Knowledge Catalog quase em tempo real e outras instâncias criadas após 18 de abril de 2026 geralmente têm um impacto mínimo no uso da CPU. Para a maioria das instâncias criadas antes de 18 de abril de 2026, incluindo todas as instâncias criadas antes de 19 de março de 2026, o uso da CPU pode ser maior. Isso é especialmente perceptível em instâncias com tipos de máquina menores, por exemplo,máquinas com núcleos compartilhados e esquemas maiores (10.000 ou mais tabelas), que podem usar até 40% da CPU durante o processo de extração.

Limitações

Nesta seção, listamos as limitações de uso do Cloud SQL e do Knowledge Catalog.

  • Para instâncias criadas antes de 18 de abril de 2026, a integração do Knowledge Catalog com o Cloud SQL é desativada para todas as instâncias que restringem o acesso a recursos devido à inscrição de recursos no Assured Workloads.

  • Depois de ativar o Knowledge Catalog em uma instância, pode levar de 2 a 48 horas para que os recursos do Cloud SQL apareçam no Knowledge Catalog como recursos, dependendo do tamanho da máquina, da versão e do tipo de mecanismo do Cloud SQL que você está usando. Essa limitação não se aplica quando a instância é atualizada quase em tempo real, conforme descrito em Quase em tempo real.

  • As instâncias configuradas para alta disponibilidade (HA) não serão ativadas automaticamente com o catálogo do Knowledge ao serem criadas. Se você ativar a alta disponibilidade em uma instância com o Knowledge Catalog já ativado, ele vai permanecer ativado, a menos que você o desative.

  • Ao excluir um banco de dados, uma tabela ou uma visualização do Cloud SQL para MySQL e recriar esse banco de dados, tabela ou visualização com o nome anterior, todas as entradas do catálogo do Knowledge Catalog que pertencem ao banco de dados original, tabela ou visualização permanecem no Knowledge Catalog. Quando você executa as mesmas operações de exclusão e recriação em um banco de dados do Cloud SQL para PostgreSQL ou SQL Server, as entradas são removidas do Knowledge Catalog, que é o comportamento esperado.
  • Quando você executa uma operação TRUNCATE em um banco de dados do Cloud SQL para MySQL, todas as entradas do catálogo de conhecimento são removidas do banco de dados.
As limitações a seguir só se aplicam quando a instância é atualizada em quase em tempo real, conforme descrito em Quase em tempo real:

  • Quando um banco de dados é renomeado, apenas a atualização dele fica disponível no Knowledge Catalog quase em tempo real. O mapeamento subjacente do banco de dados e de todas as tabelas correspondentes será eventualmente consistente no Knowledge Catalog.
  • A integração do Knowledge Catalog em quase tempo real não é compatível com instâncias em que o VPC Service Controls está ativado.
  • Uma instância pode descartar mensagens, o que pode fazer com que os dados no Knowledge Catalog se tornem apenas eventualmente consistentes. Se as mensagens forem descartadas, as atualizações perdidas vão ficar visíveis no Knowledge Catalog eventualmente. Os casos em que uma instância pode descartar mensagens incluem o seguinte:
    • Instâncias que estão passando por uma alta taxa de DDLs em um curto período de tempo.
    • Instâncias que são clones de uma instância atual.
    • Instâncias restauradas de um backup.
    • Instâncias que estão ficando sem memória.
    • Instâncias que estão sendo reiniciadas ou reiniciando os bancos de dados.
    • Instâncias com problemas de rede ou interrupção do processo de sincronização com o Knowledge Catalog.

A seguir