Marcar uma tabela do BigQuery usando o Data Catalog
Este guia de início rápido ajuda você a concluir as seguintes tarefas:
Criar um conjunto de dados e uma tabela do BigQuery.
Crie um modelo de tag com um esquema que defina cinco campos de tag de tipos distintos. Estes são
string
,double
,boolean
,enumerated
erichtext
.Procure a entrada do Data Catalog para sua tabela.
No Console do Google Cloud, crie metadados comerciais para sua entrada que incluem uma visão geral, administrador de dados e uma tag.
Com o Data Catalog, é possível pesquisar e marcar entradas, como tabelas do BigQuery, com metadados. Alguns exemplos de metadados que você pode usar para inclusão de tag incluem tags públicas e privadas, administradores de dados e visão geral de rich text.
Antes de começar
- Criar um projeto.
- 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.
-
No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.
-
Ative as APIs Data Catalog and BigQuery.
- Instale e inicialize a Google Cloud CLI.
-
No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.
-
Ative as APIs Data Catalog and BigQuery.
- Instale e inicialize a Google Cloud CLI.
Adicionar uma entrada de dados pública ao seu projeto
As entradas do Data Catalog incluem recursos de dados, como um conjunto de dados do BigQuery ou um tópico do Pub/Sub.
Adicione um conjunto de dados público ao seu projeto.
No Console do Cloud, acesse a página do BigQuery.
Na seção Explorer, clique em + ADICIONAR DADOS e selecione Explorar conjuntos de dados públicos na lista suspensa.
No painel Marketplace, pesquise por
New York taxi trips
e clique no resultado de pesquisa relevante.Clique em Ver conjunto de dados.
crie um conjunto de dados e uma tabela
Criar um conjunto de dados
No Console do Cloud, abra a página do BigQuery.
No painel Explorador, selecione o projeto em que você quer criar o conjunto de dados.
Clique no ícone
Ações e em Criar conjunto de dados.Na página Criar conjunto de dados, preencha os seguintes detalhes:
- Em código do conjunto de dados, insira
demo_dataset
. - Em Local dos dados, selecione
US multi-region
. - Ative a expiração da tabela e especifique o número de dias.
- Em Criptografia, mantenha a opção Chave gerenciada pelo Google selecionada.
Clique em Criar conjunto de dados.
- Em código do conjunto de dados, insira
Copie uma tabela acessível publicamente para
demo_dataset
.No Console do Cloud, abra a página do BigQuery.
No painel Explorer, pesquise tabelas
tlc_yellow_trips
e selecione uma delas, comotlc_yellow_trips_2017
. Em seguida, clique em Copiar.No painel Copiar tabela, preencha as seguintes informações:
- Na lista suspensa Nome do projeto, selecione seu projeto.
- Na lista suspensa Nome do conjunto de dados, selecione
demo_dataset
. - Em Nome da tabela, insira
trips
e clique em Copiar.
No painel Explorer, confirme se a tabela
trips
está listada emdemo_dataset
.
Você adicionará tags do Data Catalog à tabela na próxima seção.
Crie um modelo de tag público e anexe uma tag à sua entrada
Você precisa ser o proprietário do conjunto de dados para anexar uma tag a uma tabela. Para mais informações sobre tags públicas e privadas, consulte Tags públicas e privadas.
Em um modelo de tag, os campos de tag são opcionais. Não é preciso fornecer um valor para um campo ao anexar uma tag a uma entrada do Data Catalog. No entanto, se um modelo definir um campo conforme necessário, você precisará fornecer um valor para o campo. Se o valor não for informado, um erro será gerado.
É possível usar letras minúsculas e sublinhados para definir nomes de campos. Os campos do modelo de tag criados neste exemplo são apenas campos de demonstração e não são atualizados ou sincronizados automaticamente com o BigQuery.
Console
Acesse a página Data Catalog > Modelos de tag.
Clique em Criar modelo de tag e insira os seguintes detalhes:
- Insira o Nome do modelo como
Demo Tag Template
. - Mantenha o local padrão.
- Mantenha a visibilidade do modelo de tag como Pública.
Clique em Adicionar campo para adicionar cinco campos. Use a tabela a seguir e mantenha a Descrição do campo vazia.
Nome de exibição do campo ID do campo Campo obrigatório Tipo Fonte dos recursos de dados origem Sim String Linhas no recurso num_rows Não Double Tem PII has_pii Não Booleano Tipo de PII tipo_pi Não Enumerado Adicione os valores
EMAIL_ADDRESS
,US_SOCIAL_SECURITY_NUMBER
eNONE
.Contexto context Não Rich text
- Insira o Nome do modelo como
Clique em Criar.
A página Detalhes do modelo lista todas as informações sobre o modelo de tag.
Para anexar uma tag ao
demo_dataset
, acesse a página do Data Catalog.Na caixa de pesquisa, digite
demo_dataset
. No resultado da pesquisa, você verá o conjunto de dadosdemo_dataset
e a tabelatrips
.Clique na tabela
trips
. A página Detalhes da tabela do BigQuery será aberta.Clique em Anexar tags.
No painel Anexar tags, insira os seguintes detalhes:
- Selecione o destino como
trips
. - Selecione o modelo de tag como
Demo Tag Template
. - Para valores de tag, insira os seguintes detalhes:
- Fonte do recurso de dados:
Copied from tlc_yellow_trips_2017
- Número de linhas no recurso de dados:
113496874
- Tem PII:
FALSE
- Tipo de PII:
NONE
- Fonte do recurso de dados:
Clique em Save.
Os campos da tag agora ficam listados na seção Tags nos detalhes da tabela do BigQuery.
- Selecione o destino como
gcloud
Execute o comando gcloud data-catalog tag-templates create abaixo para criar um modelo com os cinco campos a seguir:
-
display_name:
Fonte do recurso de dadosid:
fonterequired:
VERDADEIROtype:
string -
display_name:
Número de linhas no recurso de dadosid:
num_rowsrequired:
FALSOtype:
Duplo -
display_name:
Tem PIIid:
has_piirequired:
FALSOtype:
booleano -
display_name:
Tipo de PIIid:
pii_typerequired:
FALSOtype:
Enumeradovalues:
- EMAIL_ADDRESS
- US_SOCIAL_SECURITY_NUMBER
- NONE
# ------------------------------- # Create a Tag Template. # ------------------------------- gcloud data-catalog tag-templates create demo_template \ --location=us-central1 \ --display-name="Demo Tag Template" \ --field=id=source,display-name="Source of data asset",type=string,required=TRUE \ --field=id=num_rows,display-name="Number of rows in the data asset",type=double \ --field=id=has_pii,display-name="Has PII",type=bool \ --field=id=pii_type,display-name="PII type",type='enum(EMAIL_ADDRESS|US_SOCIAL_SECURITY_NUMBER|NONE)' # ------------------------------- # Lookup the Data Catalog entry for the table. # ------------------------------- ENTRY_NAME=$(gcloud data-catalog entries lookup '//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET/tables/TABLE' --format="value(name)") # ------------------------------- # Attach a Tag to the table. # ------------------------------- # Create the Tag file. cat > tag_file.json << EOF { "source": "BigQuery", "num_rows": 1000, "has_pii": true, "pii_type": "EMAIL_ADDRESS" } EOF gcloud data-catalog tags create --entry=${ENTRY_NAME} \ --tag-template=demo_template --tag-template-location=us-central1 --tag-file=tag_file.json
Go
Antes de testar essa amostra, siga as instruções de configuração para Go no Guia de início rápido do Data Catalog: como usar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Data Catalog em Go.
Java
Antes de testar essa amostra, siga as instruções de configuração para Java no Guia de início rápido do Data Catalog: como usar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Data Catalog em Java.
Node.js
Antes de testar essa amostra, siga as instruções de configuração para Node.js no Guia de início rápido do Data Catalog: como usar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Data Catalog em Node.js.
Python
Antes de testar essa amostra, siga as instruções de configuração para Python no Guia de início rápido do Data Catalog: como usar as bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API Data Catalog em Python.
REST e LINHA DE CMD
REST e linha de comando
Se você não tiver acesso às bibliotecas do Cloud Client para seu idioma ou desejar testar a API usando solicitações REST, consulte os exemplos a seguir e consulte a documentação da API REST.
1. Crie um modelo de tag.
Antes de usar qualquer um dos dados da solicitação, faça as seguintes substituições:
- project-id: ID do projeto do GCP
Método HTTP e URL:
POST https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/tagTemplates?tagTemplateId=demo_tag_template
Corpo JSON da solicitação:
{ "displayName":"Demo Tag Template", "fields":{ "source":{ "displayName":"Source of data asset", "isRequired": "true", "type":{ "primitiveType":"STRING" } }, "num_rows":{ "displayName":"Number of rows in data asset", "isRequired": "false", "type":{ "primitiveType":"DOUBLE" } }, "has_pii":{ "displayName":"Has PII", "isRequired": "false", "type":{ "primitiveType":"BOOL" } }, "pii_type":{ "displayName":"PII type", "isRequired": "false", "type":{ "enumType":{ "allowedValues":[ { "displayName":"EMAIL_ADDRESS" }, { "displayName":"US_SOCIAL_SECURITY_NUMBER" }, { "displayName":"NONE" } ] } } } } }
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{ "name":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template", "displayName":"Demo Tag Template", "fields":{ "num_rows":{ "displayName":"Number of rows in data asset", "isRequired": "false", "type":{ "primitiveType":"DOUBLE" } }, "has_pii":{ "displayName":"Has PII", "isRequired": "false", "type":{ "primitiveType":"BOOL" } }, "pii_type":{ "displayName":"PII type", "isRequired": "false", "type":{ "enumType":{ "allowedValues":[ { "displayName":"EMAIL_ADDRESS" }, { "displayName":"NONE" }, { "displayName":"US_SOCIAL_SECURITY_NUMBER" } ] } } }, "source":{ "displayName":"Source of data asset", "isRequired":"true", "type":{ "primitiveType":"STRING" } } } }
2. Procure o Data Catalog entry-id
na tabela do BigQuery.
Antes de usar qualquer um dos dados da solicitação, faça as seguintes substituições:
- project-id: ID de projeto do GCP.
Método HTTP e URL:
GET https://datacatalog.googleapis.com/v1/entries:lookup?linkedResource=//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips
Corpo JSON da solicitação:
Request body is empty.
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{ "name": "projects/project-id/locations/US/entryGroups/@bigquery/entries/entry-id", "type": "TABLE", "schema": { "columns": [ { "type": "STRING", "description": "A code indicating the TPEP provider that provided the record. 1= ", "mode": "REQUIRED", "column": "vendor_id" }, ... ] }, "sourceSystemTimestamps": { "createTime": "2019-01-25T01:45:29.959Z", "updateTime": "2019-03-19T23:20:26.540Z" }, "linkedResource": "//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips", "bigqueryTableSpec": { "tableSourceType": "BIGQUERY_TABLE" } }
3. Crie uma tag a partir do modelo e anexe-a à tabela do BigQuery.
Antes de usar qualquer um dos dados da solicitação, faça as seguintes substituições:
- project-id: ID de projeto do GCP.
- entry-id: ID da entrada do Data Catalog para a tabela de viagens do conjunto de dados de demonstração (retornada nos resultados da pesquisa na etapa anterior).
Método HTTP e URL:
POST https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/entryGroups/@bigquery/entries/entry-id/tags
Corpo JSON da solicitação:
{ "template":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template", "fields":{ "source":{ "stringValue":"Copied from tlc_yellow_trips_2017" }, "num_rows":{ "doubleValue":113496874 }, "has_pii":{ "boolValue":false }, "pii_type":{ "enumValue":{ "displayName":"NONE" } } } }
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{ "name":"projects/project-id/locations/US/entryGroups/@bigquery/entries/entry-id/tags/tag-id", "template":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template", "fields":{ "pii_type":{ "displayName":"PII type", "enumValue":{ "displayName":"NONE" } }, "has_pii":{ "displayName":"Has PII", "boolValue":false }, "source":{ "displayName":"Source of data asset", "stringValue":"Copied from tlc_yellow_trips_2017" }, "num_rows":{ "displayName":"Number of rows in data asset", "doubleValue":113496874 } }, "templateDisplayName":"Demo Tag Template" }
Crie uma visão geral para sua inscrição
No Console do Cloud, é possível usar rich text para descrever uma entrada no seu projeto do Data Catalog.
Para criar uma visão geral da tabela
trips
, acesse a página do Data Catalog.Na caixa de pesquisa, digite
demo_dataset
.No resultado da pesquisa, você verá o conjunto de dados
demo_dataset
e a tabelatrips
.Clique na tabela
trips
.A página Detalhes da tabela do BigQuery será aberta.
Clique em Visão geral e digite um texto. Também é possível incluir imagens e rich text.
Clique em Save.
Adicionar um administrador para a entrada
No Console do Cloud, é possível adicionar um ou mais administradores de dados a uma entrada no seu projeto do Data Catalog. Um administrador de uma entrada de dados pode ser contatado para solicitar mais informações sobre a entrada de dados.
Para criar uma visão geral para a tabela
trips
, repita as três primeiras etapas da seção anterior.Clique no ícone Edit Steward e adicione um ou mais endereços de e-mail.
Você pode adicionar um usuário com uma conta de e-mail que não seja do Google.
Clique em Save.
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados nesta página, siga as etapas abaixo.
Excluir o projeto
O jeito mais fácil de evitar cobranças é excluindo o projeto que você criou para o tutorial.
Para excluir o projeto:
- No console do Cloud, acesse a página Gerenciar recursos:
- Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir .
- Na caixa de diálogo, digite o ID do projeto e clique em Encerrar para excluí-lo.
Excluir o conjunto de dados
Se necessário, acesse a página do BigQuery.
No painel Explorer, pesquise o conjunto de dados
demo_dataset
que você criou.Clique na opção
Ações e em Excluir conjunto de dados.Confirme a ação de exclusão.
Excluir o modelo de tag
Acesse a página Data Catalog > Modelos.
Selecione Modelo de tag de demonstração.
Na linha, clique na opção
Ações e em Excluir este modelo.Confirme a ação de exclusão.
A seguir
Saiba mais sobre o Data Catalog em Visão geral do Data Catalog.
Saiba mais sobre metadados técnicos e metadados comerciais.
Saiba mais sobre modelos de tags, tags públicas e tags particulares em Tags e modelos de tags.
Navegue pela Visão geral de APIs e bibliotecas de cliente.