Criar e usar verificações de perfil de dados

Esta página mostra como criar uma verificação de perfil de dados usando o console do Google Cloud, Google Cloud CLI ou API REST.

Para mais informações sobre as verificações de perfil de dados do Dataplex, consulte Sobre a criação de perfil de dados.

Antes de começar

No console do Google Cloud, ative a API Dataplex.

Ativar a API

Permissões

Para criar perfis de tabelas do BigQuery, você precisa das seguintes permissões:

  • Para executar uma verificação de perfil de dados em uma tabela do BigQuery, você precisa do seguinte: permissão para ler a tabela do BigQuery e permissão para criar um job do BigQuery no projeto usado para verificar a tabela.

  • Se a tabela do BigQuery e a verificação do perfil de dados estiverem projetos diferentes, dê ao serviço Dataplex permissão de leitura de conta na tabela correspondente do BigQuery.

  • Se os dados do BigQuery estiverem organizados em um Dataplex e, para criar uma verificação de perfil de dados, você precisa do Dataplex papéis roles/dataplex.metadataReader e roles/dataplex.viewer. Isso concede as seguintes permissões:

    • dataplex.lakes.list
    • dataplex.lakes.get
    • dataplex.zones.list
    • dataplex.zones.get
    • dataplex.entities.list
    • dataplex.entities.get
    • dataplex.operations.get

  • Se você estiver verificando uma tabela externa do BigQuery no Cloud Storage, atribua à conta de serviço do Dataplex o papel de leitor de objetos do Cloud Storage (roles/storage.objectViewer) ou as seguintes permissões para o bucket:

    • storage.buckets.get
    • storage.objects.get

  • Se você quiser publicar os resultados da verificação do perfil de dados nas páginas do BigQuery e do Dataplex Catalog no console do Google Cloud para as tabelas de origem, é necessário receber o papel do IAM de editor de dados do BigQuery (roles/bigquery.dataEditor) ou a permissão bigquery.tables.update na tabela.

  • Para exportar os resultados da verificação para uma tabela do BigQuery, sua conta de serviço do Dataplex precisa ter o papel de editor de dados do BigQuery (roles/bigquery.dataEditor). Isso concede as seguintes permissões:

    • bigquery.datasets.get
    • bigquery.tables.create
    • bigquery.tables.get
    • bigquery.tables.getData
    • bigquery.tables.update
    • bigquery.tables.updateData

  • Se você precisar acessar colunas protegidas pelas políticas de acesso no nível da coluna do BigQuery, atribua as permissões da conta de serviço do Dataplex a essas colunas. O usuário que cria ou atualiza uma verificação de dados também precisa de permissões para as colunas.

  • Se uma tabela tiver políticas de acesso no nível da linha do BigQuery ativadas, só será possível verificar as linhas visíveis para a conta de serviço do Dataplex. Observe que os privilégios de acesso do usuário individual não são avaliados para as políticas no nível da linha.

Permissões e papéis de verificação de dados

Para usar o perfil de dados, um administrador do projeto atribui um papel predefinido com permissões já concedidas ou concede permissões individuais. Os papéis são os seguintes:

  • roles/dataplex.dataScanAdmin: acesso total aos recursos DataScan.
  • roles/dataplex.dataScanEditor: acesso de gravação aos recursos DataScan.
  • roles/dataplex.dataScanViewer: acesso de leitura aos recursos DataScan, excluindo os resultados.
  • roles/dataplex.dataScanDataViewer: acesso de leitura a recursos de DataScan. incluindo os resultados.

A tabela a seguir lista as permissões de verificação de dados:

Nome da permissão Concede permissão para fazer o seguinte:
dataplex.datascans.create Criar um DataScan
dataplex.datascans.delete Excluir um DataScan
dataplex.datascans.get Mais detalhes de DataScan excluindo resultados
dataplex.datascans.getData Mais detalhes de DataScan, incluindo resultados
dataplex.datascans.list Listar DataScans
dataplex.datascans.run Executar um DataScan
dataplex.datascans.update Atualizar a descrição de um DataScan
dataplex.datascans.getIamPolicy Consultar as permissões atuais do IAM na verificação
dataplex.datascans.setIamPolicy Definir permissões do IAM na verificação

Criar uma verificação do perfil de dados

Console

  1. No console do Google Cloud, acesse a página Perfil.

    Acessar o perfil do Dataplex

  2. Clique em Criar verificação de perfil de dados.

  3. Insira um Nome de exibição.

  4. Para mudar o ID de verificação gerado automaticamente, forneça o seu. Consulte a Convenção de nomenclatura de recursos.

  5. Opcional: digite uma Descrição.

  6. No campo Tabela, clique em Procurar.

  7. Selecione uma tabela e clique em Selecionar.

  8. No campo Escopo, escolha Incremental ou Dados inteiros.

    • Se você escolher Dados incrementais, no campo Coluna de carimbo de data/hora, faça o seguinte: selecione uma coluna do tipo DATE ou TIMESTAMP em seu do tabela do BigQuery que aumenta monotonicamente e pode ser usados para identificar novos registros. Para tabelas particionadas em uma coluna do tipo DATE ou TIMESTAMP, recomendamos usar a coluna de partição como o campo de carimbo de data/hora.

  9. Para aplicar a amostragem à verificação do perfil de dados, selecione uma porcentagem de amostragem na lista Tamanho da amostragem.

    • Escolha um valor de porcentagem entre 0,0% e 100%, com no máximo 3 dígitos decimais.
    • Para conjuntos de dados maiores, escolha uma porcentagem de amostragem menor. Por exemplo: para uma tabela de ~1 PB, se você inserir um valor entre 0,1% e 1,0%, O Dataplex faz amostras entre 1 e 10 TB de dados.
    • Você precisa ter pelo menos 100 registros nos dados amostrados para retornar um resultado.
    • Para verificações de dados incrementais, o Dataplex aplica a amostragem ao incremento mais recente.

  10. Para filtrar por linha, clique em Filtros e selecione Filtrar linhas.

    • Insira uma expressão SQL válida que possa ser usada em uma cláusula WHERE em Sintaxe SQL padrão do BigQuery. Por exemplo: col1 >= 0.

    • O filtro pode ser uma combinação de condições SQL em várias colunas. Por exemplo, col1 >= 0 AND col2 < 10.

  11. Opcional: clique em Filtros. Marque a caixa de seleção Filtrar colunas.

    a. No campo Incluir colunas, clique em Procurar.

    • Especifique as colunas a serem incluídas na verificação de perfil. Selecione as colunas de sua preferência marcando as caixas e clicando em Selecionar.

    b. No campo Excluir colunas, clique em Procurar.

    • Especifique as colunas a serem excluídas da verificação de perfil. Selecione as colunas de sua preferência marcando as caixas e clicando em Selecionar.

  12. Opcional: publique os resultados da verificação de perfil de dados nas páginas do BigQuery e do Data Catalog no console do Google Cloud para a tabela de origem. Clique na caixa de seleção Publicar resultados na interface do Dataplex Catalog e do BigQuery.

    É possível conferir os resultados mais recentes da verificação na guia Perfil de dados nas páginas do BigQuery e do Data Catalog para a tabela de origem. Para permitir que os usuários acessem os resultados da verificação publicados, consulte Compartilhar os resultados publicados.

    A opção de publicação pode não estar disponível nos seguintes casos:

    • Você não tem as permissões necessárias na tabela.
    • Outra verificação de qualidade de dados está definida para publicar resultados.

    Para mais informações sobre as permissões necessárias para visualizar o resultados publicados, consulte Permissões.

  13. Opcional: exporte os resultados da verificação para uma tabela padrão do BigQuery. Clique em Procurar para selecionar um conjunto de dados do BigQuery já existente e armazenar os resultados da verificação do perfil de dados.

    Se a tabela especificada não existir, o Dataplex a criará para para você. Se você estiver usando uma tabela existente, verifique se ela é compatível com o esquema da tabela descrito mais adiante nesta seção.

  14. Opcional: adicione rótulos. Rótulos são pares de key:value que permitem agrupar objetos relacionados entre si ou com outros recursos do Google Cloud.

  15. Em Opções de programação, escolha uma das seguintes opções:

    • Repetir: execute o job de verificação de perfil de dados em uma programação: diária, semanal, mensal ou personalizada. Especifique com que frequência a verificação precisa ser executada e em que horário. Se você escolher "Personalizado", use cron para especificar cronograma.

    • Sob demanda: crie a verificação do perfil de dados e execute-a a qualquer momento. usando a ação "Executar agora".

  16. Clique em Criar.

gcloud

Para criar uma verificação de perfil de dados, execute o seguinte comando:

gcloud dataplex datascans create data-profile DATASCAN \
--location=LOCATION \
--data-source-entity=DATA_SOURCE_ENTITY
| --data-source-resource=DATA_SOURCE_RESOURCE

Substitua as seguintes variáveis:

  • DATASCAN: o nome da verificação do perfil de dados.
  • LOCATION: a região do Google Cloud em que o recurso de verificação de perfil de dados será criado.
  • DATA_SOURCE_ENTITY: a entidade do Dataplex que contém os dados da verificação do perfil de dados. Por exemplo, projects/test-project/locations/test-location/lakes/test-lake/zones/test-zone/entities/test-entity.
  • DATA_SOURCE_RESOURCE: o nome do recurso que contém os dados para a verificação do perfil de dados. Por exemplo, //bigquery.googleapis.com/projects/test-project/datasets/test-dataset/tables/test-table.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para criar uma verificação de perfil de dados.

Criar várias verificações de perfil de dados

Console

  1. No console do Google Cloud, acesse a página Perfil.

    Acessar o perfil do Dataplex

  2. Clique em Criar várias verificações de perfil.

  3. Insira um prefixo de ID. O Dataplex gera automaticamente IDs de verificação usando o prefixo e os sufixos exclusivos fornecidos.

  4. Insira uma Descrição para todas as verificações do perfil de dados.

  5. No campo Conjunto de dados, clique em Procurar. Selecione um conjunto de dados para selecionar tabelas. Clique em Selecionar.

  6. Se o conjunto de dados for multirregional, selecione uma Região na qual criar as verificações do perfil de dados.

  7. Selecione Opções de configuração comuns:

    1. No campo Escopo, escolha Incremental ou Dados inteiros.

    2. Para aplicar amostragem às verificações do perfil de dados, na coluna Tamanho da amostragem selecione uma porcentagem de amostragem.

      Escolha um valor percentual entre 0% e 100% com até três casas decimais dígitos.

    3. Para mostrar os resultados de todas as verificações, selecione Publicação. Você pode visualizar os resultados na guia Perfil do BigQuery; ou Detalhes da tabela do Data Catalog. Verifique se você tem as permissões bigquery.tables.update nas tabelas de origem.

    4. Em Opções de programação, escolha uma das seguintes opções:

      1. Repetir: execute os jobs de verificação de perfil de dados em uma programação. Especificar a frequência de execução da verificação (diária, semanal, mensal ou personalizada) e em que horário. Se você escolher "Personalizado", use o formato cron para especificar a programação.

      2. Sob demanda: crie seus jobs de verificação do perfil de dados e execute-os a qualquer momento clicando em Run.

  8. Na opção Escolher tabelas, clique em Procurar. Escolha uma ou mais das tabelas a serem digitalizadas. Clique em Selecionar.

  9. Selecione Configurações adicionais:

    1. Para salvar os resultados das verificações do seu perfil de dados em um tabela do BigQuery de sua preferência, escolha uma tabela Exportar os resultados da verificação para a tabela do BigQuery O Dataplex copia e salva automaticamente os resultados nessa tabela para cada job de verificação.

      1. Clique em Procurar para selecionar um conjunto de dados.

      2. Insira uma tabela do BigQuery para salvar os resultados. Ela pode ser uma tabela existente, usada por outras verificações de perfil de dados do Dataplex para salvar resultados. Se não houver uma tabela com o nome especificado, o Dataplex vai criar uma.

    2. Adicione Rótulos para anotar a verificação de perfil de dados.

  10. Clique em Executar verificação para criar e executar todas as verificações. Essa opção está disponível apenas para verificações sob demanda.

  11. Clique em Criar para gerar todas as verificações.

gcloud

Incompatível.

REST

Incompatível.

Exportar esquema da tabela

Se você quiser exportar os resultados da verificação do perfil de dados para uma tabela do BigQuery, verifique se ela é compatível com o seguinte esquema de tabela:

Nome da coluna Tipo de dados da coluna Nome do subcampo
(se aplicável)		 Tipo de dados do subcampo Modo Exemplo
data_profile_scan struct/record resource_name string anulável //dataplex.googleapis.com/projects/test-project/locations/europe-west2/datascans/test-datascan
project_id string anulável test-project
location string anulável us-central1
data_scan_id string anulável test-datascan
data_source struct/record resource_name string anulável Caso de entidade:
//dataplex.googleapis.com/projects/test-project/locations/europe-west2/lakes/test-lake/zones/test-zone/entities/test-entity
Caso de tabela: //bigquery.googleapis.com/projects/test-project/datasets/test-dataset/tables/test-table
dataplex_entity_project_id string anulável test-project
dataplex_entity_project_number integer anulável 123456789012
dataplex_lake_id string anulável Válido somente se a origem for uma entidade.
test-lake
dataplex_zone_id string anulável (Valid only if source is entity)
test-zone
dataplex_entity_id string anulável Válido somente se a origem for uma entidade.
test-entity
table_project_id string anulável dataplex-table
table_project_number int64 anulável 345678901234
dataset_id string anulável (Valid only if source is table)
test-dataset
table_id string anulável (Valid only if source is table)
test-table
data_profile_job_id string anulável caeba234-cfde-4fca-9e5b-fe02a9812e38
data_profile_job_configuration json trigger string anulável ondemand/schedule
incremental boolean anulável true/false
sampling_percent float anulável (0-100)
20.0 (indica 20%)
row_filter string anulável col1 >= 0 AND col2 < 10
column_filter json anulável {"include_fields":["col1","col2"], "exclude_fields":["col3"]}
job_labels json anulável {"key1":value1}
job_start_time timestamp anulável 2023-01-01 00:00:00 UTC
job_end_time timestamp anulável 2023-01-01 00:00:00 UTC
job_rows_scanned integer anulável 7500
column_name string anulável column-1
column_type string anulável string
column_mode string anulável repeated
percent_null float anulável (0,0-100,0)
20.0 (indica 20%)
percent_unique float anulável (0,0-100,0)
92.5
min_string_length integer anulável Válido apenas se o tipo da coluna for string.
10
max_string_length integer anulável Válido apenas se o tipo da coluna for string.
4
average_string_length float anulável (Válido apenas se o tipo de coluna for string)
7.2
min_value float anulável (Válido apenas se o tipo de coluna for numérico: inteiro/flutuante)
max_value float anulável Válido somente se o tipo de coluna for numérico: inteiro/flutuante.
average_value float anulável Válido somente se o tipo de coluna for numérico: inteiro/flutuante.
standard_deviation float anulável (Válido apenas se o tipo de coluna for numérico: inteiro/flutuante)
quartile_lower integer anulável Válido somente se o tipo de coluna for numérico: inteiro/flutuante.
quartile_median integer anulável Válido somente se o tipo de coluna for numérico: inteiro/flutuante.
quartile_upper integer anulável Válido somente se o tipo de coluna for numérico: inteiro/flutuante.
top_n struct/record - repeated value string anulável "4009"
count integer anulável 20
percent float anulável 10 (indica 10%)

Configuração da tabela de exportação

Ao exportar para as tabelas do BigQueryExport, siga estas diretrizes:

  • Para o campo resultsTable, use o formato: //bigquery.googleapis.com/projects/{project-id}/datasets/{dataset-id}/tables/{table-id}.
  • Use uma tabela padrão do BigQuery.
  • Se a tabela não existir quando a verificação for criada ou atualizada, O Dataplex cria a tabela para você.
  • Por padrão, a tabela é particionada na coluna job_start_time diariamente.
  • Se você quiser que a tabela seja particionada em outras configurações ou se sem a partição e recrie a tabela com as e suas configurações e, em seguida, fornecer a tabela pré-criada como na tabela de resultados.
  • Verifique se a tabela de resultados está no mesmo local que a tabela de origem.
  • Se a VPC-SC estiver configurada no projeto, a tabela de resultados precisará estar no mesmo perímetro da VPC-SC que a tabela de origem.
  • Se a tabela for modificada durante a fase de execução da verificação, o job atual será exportado para a tabela de resultados anterior, e a mudança vai entrar em vigor no próximo job de verificação.
  • Não modifique o esquema da tabela. Se você precisar de colunas personalizadas, crie uma visualização na tabela.
  • Para reduzir custos, defina uma expiração na partição com base no seu caso de uso. Para mais informações, consulte como definir a expiração da partição.

Fazer uma verificação do perfil de dados

Console

  1. No console do Google Cloud, acesse o Dataplex Perfil. Acessar o perfil
  2. Clique na verificação do perfil de dados para executar.
  3. Clique em Executar agora.

gcloud

Para fazer uma verificação do perfil de dados, execute o seguinte comando:

gcloud dataplex datascans run DATASCAN \
--location=LOCATION

Substitua as seguintes variáveis:

  • DATASCAN: o nome da verificação do perfil de dados.
  • LOCATION: a região do Google Cloud em que o a verificação do perfil de dados foi criada.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para executar a verificação de perfil de dados.

Acessar os resultados do job de verificação do perfil de dados

Console

Todas as verificações de perfil de dados que você criar vão aparecer na página Perfil.

Para conferir os resultados detalhados de uma verificação, clique no nome dela.

  • A seção Visão geral exibe as execuções de verificação, o horário de cada execução, os número de registros da tabela verificados e o status do job.

  • A seção Configuração da verificação de perfil contém detalhes sobre a verificação.

gcloud

Para conferir os resultados de um job de verificação de perfil de dados, execute o seguinte comando:

gcloud dataplex datascans jobs describe JOB \
--location=LOCATION \
--datascan=DATASCAN \
--view=FULL

Substitua as seguintes variáveis:

  • JOB: o ID do job de verificação do perfil de dados.
  • LOCATION: a região do Google Cloud em que o a verificação do perfil de dados foi criada.
  • DATASCAN: o nome da verificação do perfil de dados a qual vaga pertence.
  • --view=FULL: para ver o resultado do job de verificação, especifique FULL.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para ver os resultados de uma verificação de perfil de dados.

Acessar o job mais recente de verificação do perfil de dados

Console

A guia Resultados mais recentes do job, quando há pelo menos um resultado execução concluída, fornece informações sobre o job mais recente. Ele lista os dados as colunas da tabela e as estatísticas sobre as colunas encontradas na verificação.

gcloud

Para conferir a verificação de perfil de dados mais recente, execute o seguinte comando:

gcloud dataplex datascans describe DATASCAN \
--location=LOCATION \
--view=FULL

Substitua as seguintes variáveis:

  • DATASCAN: o nome da verificação do perfil de dados para conferir o job mais recente.
  • LOCATION: a região do Google Cloud em que os dados a verificação de perfil foi criada.
  • --view=FULL: para ver o resultado do job de verificação, especifique FULL.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para visualizar o job de verificação mais recente.

Acessar todos os jobs de verificação de perfil de dados

O Dataplex salva o histórico de verificações do perfil de dados dos últimos 300 empregos ou no ano passado, o que ocorrer primeiro.

Console

A guia Histórico de jobs mostra informações sobre jobs anteriores. Ela lista todos os jobs, o número de registros verificados em cada job, o status, o tempo de execução e muito mais.

Para visualizar as informações detalhadas de um job, clique em qualquer um dos jobs em ID do job.

gcloud

Para acessar todos os jobs de uma verificação de perfil de dados, execute o seguinte comando:

gcloud dataplex datascans jobs list \
--location=LOCATION \
--datascan=DATASCAN

Substitua as seguintes variáveis:

  • LOCATION: a região do Google Cloud em que a verificação de perfil de dados foi criada.
  • DATASCAN: o nome da verificação do perfil de dados para conferir todos os trabalhos.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para acessar todos os jobs de verificação.

Compartilhar os resultados publicados

Ao criar uma verificação de perfil de dados, se você optar por publicar os resultados da verificação nas páginas do BigQuery e do Data Catalog no console do Google Cloud, os resultados mais recentes da verificação vão estar disponíveis na guia Perfil de dados nessas páginas.

É possível permitir que os usuários da sua organização acessem os resultados de verificação publicados. Para conceder acesso aos resultados da verificação, siga estas etapas:

  1. No console do Google Cloud, acesse a página Perfil.

    Acessar o perfil do Dataplex

  2. Clique na verificação do perfil de dados com os resultados que você quer compartilhar.

  3. Acesse a guia Permissões.

  4. Clique em Conceder acesso.

  5. No campo Novos principais, adicione o principal a que você quer conceder acesso.

  6. No campo Selecionar um papel, escolha Leitor de dados do DataScan Dataplex.

  7. Clique em Salvar.

Para remover o acesso aos resultados da verificação publicados de um participante, siga estas etapas:

  1. No console do Google Cloud, acesse a página Perfil.

    Acessar o perfil do Dataplex

  2. Clique na verificação do perfil de dados com os resultados que você quer compartilhar.

  3. Acesse a guia Permissões.

  4. Selecione o principal de que você quer remover o Dataplex DataScan DataViewer. de rede.

  5. Clique em Remover acesso.

  6. Clique em Confirmar.

Atualizar uma verificação de perfil de dados

Console

  1. No console do Google Cloud, acesse a página Perfil.

    Acessar o perfil do Dataplex

  2. Na linha com a leitura que você quer editar, clique em > Editar.

  3. Edite os valores.

  4. Clique em Salvar.

gcloud

Para atualizar uma verificação do perfil de dados, execute o seguinte comando:

gcloud dataplex datascans update data-profile DATASCAN \
--location=LOCATION \
--description=DESCRIPTION

Substitua as seguintes variáveis:

  • DATASCAN: o nome da verificação do perfil de dados para atualizar.
  • LOCATION: a região do Google Cloud em que a verificação de perfil de dados foi criada.
  • DESCRIPTION: a nova descrição dos dados. verificação de perfil.

Para atualizar os campos de especificação, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para editar uma verificação de perfil de dados.

Excluir uma verificação de perfil de dados

Console

  1. No console do Google Cloud, acesse a página Perfil. Acesse o Perfil do Dataplex.

  2. Clique na verificação que você quer excluir.

  3. Clique em Excluir.

gcloud

Para excluir uma verificação de perfil de dados, execute o seguinte comando:

gcloud dataplex datascans delete \
DATASCAN --location=LOCATION \
--async

Substitua as seguintes variáveis:

  • DATASCAN: o nome da verificação do perfil de dados a ser excluída.
  • LOCATION: a região do Google Cloud em que a verificação de perfil de dados foi criada.

Para argumentos opcionais, consulte a referência da CLI gcloud.

REST

Use o APIs Explorer para excluir a verificação do perfil de dados.

A seguir