Faça a gestão de aspetos e enriqueça os metadados

Este documento descreve como criar e gerir tipos de aspetos e anotar entradas com aspetos.

O Dataplex Universal Catalog descreve as entradas através de um conjunto de aspetos. Pode descrever as suas entradas com metadados adicionais através de aspetos e tipos de aspetos.

Para mais informações, consulte o artigo Acerca da gestão de metadados no Dataplex Universal Catalog.

Aspetos

Os aspetos permitem-lhe captar metadados nas entradas. Adicionar aspetos a uma entrada ajuda a fornecer contexto significativo a qualquer pessoa que precise de usar o recurso. Pode usar aspetos para armazenar metadados da empresa (por exemplo, classificação de dados) e metadados técnicos (por exemplo, esquema).

Os aspetos são considerados partes do recurso de entrada e não recursos separados. Quando modifica um aspeto, está a modificar a entrada que contém o aspeto.

Pode especificar aspetos ao nível da entrada para descrever uma entrada ou ao nível da coluna para descrever uma coluna numa entrada.

Cada aspeto é uma instância de um tipo de aspeto. Um tipo de aspeto define um modelo para os respetivos aspetos. Cada tipo de aspeto contém um conjunto de campos. Quando cria aspetos, tem de fornecer valores para esses campos.

Para uma determinada entrada, pode existir, no máximo, um aspeto associado à entrada, por tipo de aspeto. Pode ter vários aspetos associados a colunas de entrada por tipo de aspeto.

Categorias de aspetos

Os aspetos são categorizados da seguinte forma:

  • Aspetos obrigatórios: aspetos que são obrigatórios no momento da criação de uma entrada. Estes aspetos são definidos pelo tipo de entrada de uma determinada entrada. Todas as entradas pertencentes a um tipo de entrada têm de ter sempre todos os aspetos necessários definidos por esse tipo de entrada.

    O Dataplex Universal Catalog gere os aspetos necessários (por exemplo, esquema) para as entradas do sistema.

    Tenha em conta o seguinte:

    • Só pode associar aspetos obrigatórios a entradas e não às colunas de uma entrada.

    • Não pode eliminar os aspetos obrigatórios de uma entrada.

    • Pode ler os aspetos necessários das entradas do sistema, mas não os pode modificar.

  • Aspetos opcionais: pode associar aspetos opcionais a entradas ou a colunas de entradas. Pode preencher aspetos opcionais no momento da criação da entrada ou mais tarde, atualizando a entrada.

    Pode eliminar aspetos opcionais depois de os preencher.

Tipos de aspetos

Os tipos de aspetos são recursos reutilizáveis que fornecem modelos para aspetos.

Categorias de tipos de aspetos

Os tipos de aspetos estão categorizados da seguinte forma:

  • Tipos de aspetos personalizados: tipos de aspetos que cria no Dataplex Universal Catalog.

  • Tipos de aspetos do sistema: tipos de aspetos que o catálogo universal do Dataplex fornece, usa e gere.

    Os tipos de aspeto do sistema são ainda categorizados como reutilizáveis e restritos. A tabela seguinte descreve as categorias de tipos de aspetos do sistema e a lista de tipos de aspetos que o catálogo universal do Dataplex fornece para cada uma das categorias:

    Categoria do tipo de aspeto do sistema Descrição Tipos de aspetos que o Dataplex Universal Catalog oferece
    Tipo de aspeto do sistema reutilizável Pode usar estes tipos de aspetos para criar ou modificar aspetos.
    • contacts
    • data-quality-scorecard
    • generic
    • overview
    • schema
    • usage
    Tipo de aspeto do sistema restrito O Dataplex Universal Catalog gere estes tipos de aspetos.
    Pode ler aspetos nestes tipos de aspetos, mas não pode criar nem editar aspetos nestes tipos de aspetos.     		Incluindo, entre outros:
    • analytics-hub
    • aspecttype-aspect
    • bigquery-dataset
    • bigquery-table
    • cloudsql-database
    • cloudsql-instance
    • cloudsql-table
    • entrygroup-aspect
    • entrytype-aspect
    • sensitive-data-protection-profile
    • storage
    • storage-bucket
    • storage-folder

Os tipos de aspeto personalizados podem ser globais ou regionais. Pode criar tipos de aspetos personalizados numa localização regional específica ou como recurso global.

Os tipos de aspetos globais são usados para criar aspetos para entradas em qualquer região. O conteúdo dos tipos de aspetos globais é replicado em todas as regiões. Os tipos de aspetos regionais são usados para criar aspetos para entradas na mesma região.

A localização de um tipo de aspeto afeta o âmbito da respetiva aplicabilidade. Para mais informações, consulte o artigo Restrições de projetos e localizações.

Os tipos de aspetos do sistema são sempre globais. Os tipos de aspetos do sistema são armazenados num projeto gerido pela Google com o ID do projeto 655216118709. Por exemplo, projects/655216118709/locations/global/aspectTypes/schema.

Antes de começar

Antes de criar e gerir tipos de aspetos e aspetos, conclua as tarefas descritas nesta secção.

Funções necessárias

Para receber as autorizações de que precisa para criar e gerir tipos de aspetos e aspetos, peça ao seu administrador para lhe conceder as seguintes funções do IAM no recurso:

Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

Para mais informações, consulte o artigo Funções de IAM do Dataplex Universal Catalog.

Ative a API

Ative a API Dataplex no seu projeto do Dataplex Universal Catalog.

Ative a API

Crie um tipo de aspeto

Consola

  1. Na Google Cloud consola, aceda à página Catálogo do Dataplex Universal Catalog.

    Aceder ao catálogo

  2. Clique no separador Tipos de aspetos e modelos de etiquetas > Personalizado.

  3. Clique em Criar tipo de aspeto.

  4. Na janela Criar tipo de aspeto, introduza o seguinte:

    1. Opcional: no campo Nome a apresentar, introduza um nome para o tipo de aspeto.
    2. No campo ID do tipo de aspeto, introduza um ID exclusivo para o tipo de aspeto.
    3. Opcional: no campo Descrição, introduza uma descrição para o tipo de aspeto.
    4. No campo Localização, selecione uma localização para o tipo de aspeto. Não pode modificar a localização de um tipo de aspeto depois de o criar.

  5. Opcional: defina um modelo para o seu tipo de aspeto.

    Na secção Modelo, clique em Adicionar campo. Na secção Novo campo, introduza o seguinte:

    1. No campo Nome, introduza um nome.
    2. Opcional: no campo Nome a apresentar, introduza um nome a apresentar.
    3. Opcional: no campo Descrição, introduza uma descrição.

    4. No campo Tipo, selecione um tipo de dados para o campo. Com base na sua seleção, é apresentado o conjunto seguinte de campos e opções:

      • Se selecionou Texto como o tipo de dados, siga estes passos:

        1. No campo Tipo de texto, selecione o tipo de texto.
        2. No campo Valores de texto, indique uma sugestão para o campo de texto. Para tal, clique em Adicionar valor e introduza a sugestão. Pode adicionar várias sugestões para um campo de texto.
        3. Clique em Concluído.

      • Se selecionou Enum como o tipo de dados, adicione um valor enum:

        1. Clique em Adicionar um valor de enumeração.
        2. No campo Valor, introduza um valor de enumeração. Pode adicionar vários valores enum.
        3. Clique em Concluído.

      • Se selecionou Matriz como tipo de dados, na secção Item da matriz, defina os tipos de itens a apresentar na matriz:

        1. Clique em Adicionar item de matriz.
        2. No campo Nome, introduza um nome para os itens da matriz.
        3. Opcional: no campo Nome a apresentar, introduza um nome a apresentar para os itens da matriz.
        4. Opcional: no campo Descrição, introduza uma descrição dos itens da matriz.

        5. No campo Tipo, selecione um tipo de dados para os itens da matriz.

          Com base na sua seleção, é apresentado o conjunto seguinte de campos e opções. São semelhantes às opções descritas para os tipos de dados Text, Enum, Map, Array e Record noutras partes desta secção.

        6. Clique em Concluído.

      • Se selecionou Mapa como o tipo de dados, na secção Valor do mapa, defina os tipos de valores a apresentar no mapa:

        1. Clique em Adicionar valor de mapeamento.
        2. No campo Nome, introduza um nome para o mapa.
        3. Opcional: no campo Nome a apresentar, introduza um nome a apresentar para o mapa.
        4. Opcional: no campo Descrição, introduza uma descrição do mapa.

        5. No campo Tipo, selecione um tipo de dados para o mapa.

          Com base na sua seleção, é apresentado o conjunto seguinte de campos e opções. São semelhantes às opções descritas para os tipos de dados Text, Enum, Map, Array e Record noutras partes desta secção.

        6. Clique em Concluído.

      • Se selecionou Registo como o tipo de dados, introduza o seguinte:

        1. No campo ID do registo, introduza um ID exclusivo que outros campos de registo possam usar para se referirem a este registo. Consulte a secção Exemplo de utilização dos campos ID do registo e Referência do registo deste documento.
        2. Opcional: se quiser adicionar uma referência a outro registo a partir deste modelo, use o campo Referência de registo. Não pode modificar esta opção depois de criar o tipo de aspeto. Consulte a secção Exemplo de utilização dos campos ID do registo e Referência do registo deste documento.

        3. Na secção Campos de registo, pode definir um objeto complexo com vários campos aninhados. Para o fazer, clique em Adicionar item de campo de registo e especifique o seguinte:

        4. No campo Nome, introduza um nome para o campo de registo.

        5. Opcional: no campo Nome a apresentar, introduza um nome a apresentar para o campo de registo.

        6. Opcional: no campo Descrição, introduza uma descrição para o campo de registo.

        7. No campo Tipo, selecione um tipo de dados.

          Com base na sua seleção, é apresentado o conjunto seguinte de campos e opções. São semelhantes às opções descritas para os tipos de dados Texto, Enumeração, Mapa, Matriz e Registo anteriormente nesta secção.

        8. Clique em Concluído.

    5. Para tornar o campo obrigatório para um aspeto deste tipo, selecione É obrigatório. Para mais informações sobre os aspetos obrigatórios e opcionais, consulte a secção Categorias de aspetos deste documento.

    6. Clique em Concluído.

    7. Para adicionar vários campos, clique em Adicionar campo e repita os passos anteriores.

  6. Opcional: na secção Etiquetas, adicione etiquetas arbitrárias como pares chave-valor aos seus recursos:

    1. Clique em Adicionar etiqueta.
    2. No campo Chave, introduza uma chave.
    3. No campo Valor, introduza um valor para a chave.
    4. Para adicionar mais etiquetas, clique em Adicionar etiqueta e repita os passos.

  7. Clique em Guardar.

gcloud

Para criar um tipo de aspeto, use o comando gcloud dataplex aspect-types create.

REST

Para criar um tipo de aspeto, use o método aspectType.create.

Depois de criar um tipo de aspeto, pode adicionar aspetos às entradas.

Exemplo de utilização dos campos ID do registo e Referência do registo

Pode usar os campos ID do registo e Referência do registo para referências recursivas. O exemplo seguinte mostra como usar estes campos:

Considere um tipo de aspeto denominado Employee, com os seguintes campos:

  • Nome (tipo:Text)
  • Data de início (tipo:Date & time)
  • Designação (tipo:Text)
  • Morada atual (tipo:Record)
  • Morada permanente (tipo:Record)

Os dois campos de morada Morada atual e Morada permanente são do mesmo tipo de dados Record. Para evitar a duplicação, pode definir os valores de ID do registo e Referência do registo quando definir estes campos.

Quando define o campo Morada atual, pode especificar ID do registo como address-field. Para Morada permanente, pode especificar o mesmo valor (address-field) para Referência do registo. Por exemplo:

  • Nome (tipo:Text)
  • Data de início (tipo:Date & time)
  • Designação (tipo:Text)
  • Morada atual (tipo:Record, ID do registo:address-field)
  • Morada permanente (tipo:Record, referência do registo:address-field)

Desta forma, não tem de duplicar os campos de outro endereço.

Adicione aspetos a uma entrada

Depois de criar um tipo de aspeto, pode criar aspetos desse tipo. Para adicionar aspetos a uma entrada, tem de atualizar a entrada, uma vez que os aspetos são armazenados nas entradas.

Tenha em conta o seguinte:

  • Pode adicionar aspetos a uma entrada ou às colunas de uma entrada.
  • Só pode editar os aspetos necessários para entradas personalizadas. Não pode eliminar os aspetos obrigatórios.
  • Pode editar e eliminar os aspetos opcionais das entradas personalizadas e das entradas do sistema.

Consola

  1. Na Google Cloud consola, aceda à página Pesquisa do Dataplex Universal Catalog.

    Aceda à pesquisa

  2. Em Escolher plataforma de pesquisa, selecione Dataplex Universal Catalog como o modo de pesquisa.

  3. Pesquise a entrada à qual quer adicionar aspetos e clique na entrada. É apresentada a página de detalhes da entrada.

  4. Para adicionar aspetos à entrada, siga estes passos:

    1. Clique no separador Detalhes.
    2. Para adicionar aspetos obrigatórios ou opcionais à entrada, na secção Etiquetas e aspetos, clique em Adicionar para a respetiva categoria.
      Não pode adicionar aspetos obrigatórios se o tipo de entrada da entrada selecionada não tiver aspetos obrigatórios definidos.
    3. Pesquise e selecione o aspeto que quer adicionar.
    4. Na janela Adicionar aspeto, introduza os valores dos campos.
    5. Clique em Guardar.

  5. Para adicionar aspetos a uma coluna da entrada, siga estes passos:

    1. Na página de detalhes da entrada, clique no separador Esquema.
    2. Selecione as colunas às quais quer adicionar aspetos.
    3. Clique em Adicionar aspeto.
    4. Pesquise e selecione o aspeto que quer adicionar.
    5. Na janela Adicionar aspeto, introduza os valores dos campos.
    6. Clique em Guardar.

gcloud

Para adicionar aspetos a uma entrada ou a uma coluna de uma entrada, use o comando gcloud dataplex entries update.

REST

Para adicionar aspetos a uma entrada ou a uma coluna de uma entrada, use o método entry.patch.

A criação e a utilização de aspetos numa entrada em que o tipo de aspeto respetivo e a entrada estão em organizações Google Cloud diferentes não são suportadas.

Faça a gestão dos aspetos existentes de uma entrada

Esta secção descreve como atualizar e eliminar os aspetos existentes de uma entrada.

Atualize um aspeto

Pode editar os aspetos opcionais das entradas personalizadas e do sistema. Só pode editar os aspetos necessários para entradas personalizadas.

Consola

  1. Na Google Cloud consola, aceda à página Pesquisa do Dataplex Universal Catalog.

    Aceda à pesquisa

  2. Em Escolher plataforma de pesquisa, selecione Dataplex Universal Catalog como o modo de pesquisa.

  3. Pesquise a entrada cujos aspetos quer atualizar e clique na entrada.

    É apresentada a página de detalhes da entrada.

  4. Clique no separador Detalhes.

  5. Na secção Etiquetas e aspetos, expanda o aspeto ou a etiqueta que quer atualizar e clique em Editar.

  6. Na janela Editar aspeto, atualize os campos obrigatórios.

  7. Clique em Guardar.

gcloud

Para atualizar aspetos de uma entrada ou de uma coluna de uma entrada, use o comando gcloud dataplex entries update.

REST

Para atualizar aspetos de uma entrada ou de uma coluna de uma entrada, use o método entry.update.

Elimine um aspeto

Consola

  1. Na Google Cloud consola, aceda à página Pesquisa do Dataplex Universal Catalog.

    Aceda à pesquisa

  2. Em Escolher plataforma de pesquisa, selecione Dataplex Universal Catalog como o modo de pesquisa.

  3. Pesquise a entrada cujos aspetos quer eliminar e clique na entrada.

    É apresentada a página de detalhes da entrada.

  4. Clique no separador Detalhes.

  5. Na secção Etiquetas e aspetos, expanda o aspeto ou a etiqueta que quer eliminar e clique em Eliminar.

  6. Clique em Confirm.

gcloud

Para eliminar um aspeto de uma entrada, use o comando gcloud dataplex entries update.

REST

Para eliminar um aspeto de uma entrada, use o método entry.update.

Faça a gestão dos tipos de aspetos

Esta secção descreve como ver, atualizar e eliminar tipos de aspetos.

Veja a lista de tipos de aspetos e modelos de etiquetas disponíveis

Consola

  1. Na Google Cloud consola, aceda à página Catálogo do Dataplex Universal Catalog.

    Aceder ao catálogo

  2. Clique no separador Tipos de aspetos e modelos de etiquetas.

    Esta página apresenta uma lista de todos os tipos de aspetos do Dataplex Universal Catalog disponíveis e modelos de etiquetas do Data Catalog.

  3. Para ver tipos de aspetos personalizados e modelos de etiquetas, clique no separador Personalizado. No separador Personalizado, a coluna Origem do catálogo mostra onde o recurso reside: no catálogo universal do Dataplex ou no Data Catalog.

    Para ver os tipos de aspetos do sistema, clique no separador Sistema.

    Para mais informações sobre os tipos de aspeto personalizados e do sistema, consulte a secção Categorias de tipos de aspeto deste documento.

  4. Opcional: para ver a lista de tipos de aspetos e modelos de etiquetas no projeto selecionado, clique no separador Personalizado e, de seguida, clique no botão Mostrar de todos os projetos para o desativar.

    O botão Mostrar de todos os projetos está ativado por predefinição e a lista inclui recursos do Dataplex Universal Catalog da sua organização selecionada e recursos do Data Catalog de todas as organizações às quais pode aceder.

gcloud

Para listar todos os tipos de aspetos disponíveis, use o comando gcloud dataplex aspect-types list.

REST

Para apresentar uma lista de todos os tipos de aspetos disponíveis, use o método aspectTypes.list.

Veja os detalhes de um tipo de aspeto ou de um modelo de etiqueta

Consola

  1. Na Google Cloud consola, aceda à página Catálogo do Dataplex Universal Catalog.

    Aceder ao catálogo

  2. Clique no separador Tipos de aspetos e modelos de etiquetas.

  3. Para ver os detalhes de um tipo de aspeto do catálogo universal do Dataplex, clique no tipo de aspeto. É apresentada a página de detalhes do tipo de aspeto, onde pode aceder a detalhes, como o nome a apresentar, o ID do tipo de aspeto, a descrição, o ID do projeto, a localização, as etiquetas, a data de criação e a data da última modificação.

    • Para ver a estrutura do tipo de aspeto selecionado, clique no separador Modelo.
    • Para ver a lista de 10 entradas relacionadas criadas recentemente, clique no separador Entradas de exemplo.
    • Para pesquisar todas as entradas relacionadas, clique em Mostrar todas as entradas relacionadas na Pesquisa. Este botão só aparece se existir, pelo menos, uma entrada relacionada.

  4. Para ver os detalhes de um modelo de etiqueta do catálogo de dados, clique no modelo de etiqueta. A página de detalhes do modelo de etiqueta é aberta no catálogo de dados, onde pode aceder a detalhes como o nome a apresentar, o ID do modelo, o ID do projeto, a localização, a visibilidade e as etiquetas.

gcloud

Para obter os detalhes de um tipo de aspeto, use o comando gcloud dataplex aspect-types describe.

REST

Para obter os detalhes de um tipo de aspeto, use o método aspectTypes.get.

Atualize um tipo de aspeto

Pode atualizar o nome a apresentar, a descrição, os campos do modelo e as etiquetas de um tipo de aspeto. Não pode eliminar um campo existente num modelo.

Não pode atualizar o ID e a localização do tipo de aspeto depois de criar o tipo de aspeto.

Consola

  1. Na Google Cloud consola, aceda à página Catálogo do Dataplex Universal Catalog.

    Aceder ao catálogo

  2. Clique no separador Tipos de aspetos e modelos de etiquetas.

  3. Clique no tipo de aspeto que quer atualizar.

  4. Na página Detalhes do tipo de aspeto, clique em Editar.

  5. Edite o nome a apresentar, a descrição, os campos do modelo e as etiquetas, conforme necessário.

  6. Opcional: para marcar um campo no tipo de aspeto como descontinuado, siga estes passos:

    1. Na secção Modelo, expanda o campo.
    2. Selecione Está descontinuado.
    3. No campo Motivo da descontinuação, introduza um motivo para descontinuar o campo selecionado.
    4. Clique em Concluído.

  7. Clique em Guardar.

gcloud

Para atualizar um tipo de aspeto, use o comando gcloud dataplex aspect-types update.

REST

Para atualizar um tipo de aspeto, use o método aspectTypes.patch.

Elimine um tipo de aspeto

Consola

  1. Na Google Cloud consola, aceda à página Catálogo do Dataplex Universal Catalog.

    Aceder ao catálogo

  2. Clique no separador Tipos de aspetos e modelos de etiquetas.

  3. Clique no tipo de aspeto que quer eliminar.

  4. Na página Detalhes do tipo de aspeto, clique em Eliminar. Confirme quando lhe for pedido.

gcloud

Para eliminar um tipo de aspeto, use o comando gcloud dataplex aspect-types delete.

REST

Para eliminar um tipo de aspeto existente, use o método aspectTypes.delete.

O que se segue?