Gerenciar recursos usando o Data Catalog

Nesta página, explicamos como pesquisar e gerenciar o Spanner recursos usando o Data Catalog.

Data Catalog é um serviço de gerenciamento de metadados escalonável e totalmente gerenciado o Dataplex. Ele cataloga automaticamente os seguintes metadados sobre Instâncias, bancos de dados, tabelas, colunas e visualizações do Spanner:

• Nome e nome totalmente qualificados
• Local (região)
• Data de criação e data da última modificação
• Esquema (para tabelas e visualizações)
• Descrição

Spanner. os metadados são sincronizados automaticamente com o Data Catalog em intervalos de algumas horas. É possível usar o Data Catalog para descobrir e entender os metadados do Spanner. Usar o Data Catalog para ajudar nas seguintes atividades:

• 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 Data Catalog, é possível selecionar metadados anexando tags a Entradas de metadados do Spanner. Cada tag pode ter vários metadados campos, e podem se basear em um modelo de tag predefinido ou personalizado.

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

pii:true
pii_type:SSN

Quando você mover uma instância que usa tags, elas não são automaticamente movidos para a instância de destino. Em vez disso, você precisa exportar as tags instância de origem antes de mover a instância e importe as tags para o instância de destino. Para mais informações, consulte Exportar e importar tags.

Para saber mais sobre o Data Catalog, consulte O que é Data Catalog.

Observação: o Data Catalog se refere aos recursos em no Spanner e em outros serviços do Google Cloud como recursos. Nesta página, vamos nos referir aos recursos do Spanner: instâncias, bancos de dados, tabelas e visualizações, como recursos do Spanner. Também usamos o termo recursos para se referir aos recursos e ao Data Catalog os metadados dos recursos.

Antes de começar

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, 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. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

5. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

6. Ative a API Data Catalog para o projeto.

   Ativar a API Data Catalog

7. Verifique as permissões.

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

Criar modelos de tag

Os modelos de tag são estruturas reutilizáveis que podem ser usadas para criar novas tags rapidamente. Os modelos ajudam a evitar duplicação de trabalho e tags incompletas. Crie quantos de tags de acordo com suas necessidades.

Para saber mais, consulte Tags e tags de modelos.

Anexar tags aos recursos do Spanner

Anexar tags aos recursos do Spanner permite fazer o seguinte:

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

Para saber mais, consulte Tags e tags de modelos.

Pesquisar recursos do Spanner

Usar a página de pesquisa do Dataplex no console do Google Cloud para pesquisar recursos do Spanner.

1. Acesse a página de pesquisa do Dataplex.

   Acesse o Dataplex.

2. No painel Filtros, em Sistemas, selecione Spanner.

   O Dataplex mostra todos os recursos conhecidos do Spanner.

3. Opcional: siga um destes procedimentos para restringir a pesquisa:

   • Use a pesquisa facetada na página Pesquisa. Marque as caixas de seleção em Tipos de dados, Projetos e Tags.

   • No campo de pesquisa, anexe um parâmetro de pesquisa após system=cloud_spanner. Separe os parâmetros com espaços.

   Por exemplo, para visualizar apenas bancos de dados, digite o seguinte texto na pesquisa campo e, em seguida, pressione Enter.

    system=cloud_spanner type=database
   

   Observação :para pesquisar instâncias do Spanner, use type=service. Para pesquisar uma configuração de instância, use instance_config=configuration-name.

   Também é possível usar parênteses e os operadores lógicos and e or para e expressões complexas. Para saber mais sobre as expressões que você pode usar no campo de pesquisa, consulte Pesquisa do Data Catalog sintaxe.

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

5. Opcional: faça o seguinte:

   • Clique em ADICIONAR VISÃO GERAL para incluir uma descrição em rich text do recurso.
   • Clique em ANEXAR TAGS para adicionar uma ao recurso.
   • Em uma tabela, clique na guia SCHEMA para ver as colunas.
   • Para uma instância (SERVICE), para visualizar os bancos de dados dos membros, clique no LISTA DE INSCRIÇÕES e depois em VER INSCRIÇÕES INFANTIS NA PESQUISA. Se o A guia ENTRY LIST não aparece, significa que a instância não tem bancos de dados.

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

Neste fluxo de trabalho de exemplo, você começa pesquisando um nome do acessar o banco de dados de membros, uma tabela nesse banco de dados e e visualizar as colunas na tabela.

1. Acesse a página de pesquisa do Dataplex.

   Acesse o Dataplex.

2. No painel Filtros, em Sistemas, selecione Spanner.

3. Para conferir todas as instâncias do Spanner no Data Catalog, marque a caixa de seleção Serviço em Tipos de dados ou digite o após o texto no campo de pesquisa e pressione Enter.

   system=cloud_spanner type=service
   

4. Selecione um nome de instância.

5. Na página Detalhes do serviço do Spanner, clique na ENTRADA LISTA e depois em VER INSCRIÇÕES DE CRIANÇAS NA PESQUISA.

   O Dataplex exibe os bancos de dados na instância.

   Observação :se não houver a guia LISTA DE INSCRIÇÕES, volte à página Pesquisar e escolha uma instância diferente.

6. Na página Detalhes do banco de dados do Spanner, clique na ENTRADA LISTA e depois em VER INSCRIÇÕES DE CRIANÇAS NA PESQUISA.

   O Dataplex mostra as tabelas no banco de dados.

7. Selecione um nome para a tabela e, na página Detalhes da tabela do Spanner, clique em SCHEMA para ver as colunas da tabela.

8. Opcional: para adicionar uma tag a uma coluna, clique no sinal de adição em Coluna tags.

.

Observação: este fluxo de trabalho demonstra o detalhamento de uma instância para uma tabela. Você podem acessar diretamente uma lista de tabelas usando o painel Filtros ou digitando system=cloud_spanner,type=table no campo de pesquisa.

Exportar e importar tags

Ao mover uma instância do Spanner, faça o seguinte: o processo de mudança exclui as tags de instância que você criou o Data Catalog. Para preservar suas tags, você precisa fazer o seguinte:

• Consulte as tags associadas à instância.
• Copie os detalhes das tags.
• Crie as tags na instância movida.

O Spanner sincroniza os dados a cada seis horas. Alterações de metadados feitas em Recursos do Spanner, como instâncias, bancos de dados, tabelas, visualizações ou as colunas podem levar cerca de 6 horas para serem propagadas para o Data Catalog.

Exportar tags da configuração da instância de origem

Para listar as tags de uma instância (entrada ou grupo de entradas), use a Google Cloud CLI gcloud data-catalog tags list da seguinte forma:

curl \
'https://datacatalog.googleapis.com/v1/projects/PROJECT/locations/LOCATION/entryGroups/ENTRY_GROUP/tags?key=API_KEY' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --compressed

Substitua:

• PROJECT: projeto que contém as tags.
• LOCATION: local das tags.
• API_KEY: uma string exclusiva que permite acessar uma API.
• ACCESS_TOKEN: o token de acesso que o aplicativo usa para se autenticar no serviço.

Importar tags para a configuração de destino

Antes de concluir este procedimento, faça o seguinte:

• Mova a instância.
• Atualizar o Data Catalog com metadados.

Para copiar uma tag, crie as tags na instância movida usando o gcloud data-catalog tags create da seguinte forma:

curl --request POST \
'https://datacatalog.googleapis.com/v1/entries:lookup?fullyQualifiedName=FQN&location=LOCATION&project=PROJECT&key=API_KEY' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"column":"myColumnName","name":"myTagName","template":"myTemplateName","fields":{"myDoubleField":{"doubleValue":0}}}' \
  --compressed

Substitua:

• FQN: nome totalmente qualificado (FQN, na sigla em inglês) do recurso. As FQNs levam dois formas:

  Para recursos não regionalizados: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

  Para recursos regionalizados: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

  Exemplo de uma tabela DPMS:

  dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

• LOCATION: local em que a pesquisa é realizada.

• PROJECT: projeto em que a pesquisa é realizada.

• API_KEY: uma string exclusiva que permite acessar uma API.

• ACCESS_TOKEN: o token de acesso que o aplicativo usa para se autenticar no serviço.

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

A tabela a seguir mostra as permissões e os papéis do IAM necessários para as várias operações do Data Catalog.

Observação: o Data Catalog não oferece suporte ao Spanner um controle de acesso refinado.

Operação do Data Catalog	Recurso do Spanner	Papéis ou permissões necessários
Criar um modelo de tag	N/A	roles/datacatalog.tagTemplateCreator
Pesquisar recursos do Spanner	Instância	spanner.instances.get
	Banco de dados	spanner.databases.get
	Tabela	spanner.databases.get
	Visualizações	spanner.databases.get
Ver tags públicas	Instância	spanner.instances.get
	Banco de dados	spanner.databases.get
	Tabela	spanner.databases.get
	Visualizações	spanner.databases.get
Ver tags particulares	Instâncias	datacatalog.tagTemplates.getTag + spanner.instances.get
	Bancos de dados	datacatalog.tagTemplates.getTag + spanner.databases.get
	Tabelas	datacatalog.tagTemplates.getTag + spanner.databases.get
	Visualizações	datacatalog.tagTemplates.getTag + spanner.databases.get
Anexar uma tag a um recurso do Spanner usando um modelo de tag	Instâncias	datacatalog.tagTemplates.use + spanner.instances.updateTag
	Bancos de dados	datacatalog.tagTemplates.use + spanner.databases.updateTag
	Tabelas	datacatalog.tagTemplates.use + spanner.databases.updateTag
	Visualizações	datacatalog.tagTemplates.use + spanner.databases.updateTag

A permissão spanner.instances.UpdateTag está incluída no seguinte papel:

• roles/spanner.admin

A permissão spanner.databases.UpdateTag está incluída nos seguintes papéis:

• roles/spanner.admin
• roles/spanner.databaseAdmin
• roles/spanner.databaseUser

Para mais informações, consulte Papéis predefinidos.

A seguir

• O que é o Data Catalog
• Papéis para pesquisar recursos do Google Cloud
• Sobre o controle de acesso detalhado