Gerenciar um glossário de negócios

O glossário de negócios do Dataplex Universal Catalog oferece um único lugar para gerenciar a terminologia e as definições relacionadas aos negócios em toda a empresa.

Quando equipes diferentes trabalham em um projeto compartilhado ou uma grande empresa tem muitos departamentos, é comum que cada parte da empresa crie sua própria terminologia para descrever os vários recursos de dados com que trabalham. Isso pode levar a falhas de comunicação e a uma compreensão inconsistente desses recursos. Além disso, às vezes um conceito pode exigir conhecimento técnico ou especializado. Isso pode dificultar a compreensão do conceito para usuários empresariais em outros domínios.

Com o glossário de negócios do Dataplex Universal Catalog, é possível criar um vocabulário central e padronizado para seus recursos de dados. É possível usar um glossário empresarial para fazer o seguinte:

  • Definir uma estrutura hierárquica de categorias e conceitos de negócios, chamados de termos.
  • Crie conexões entre conceitos definindo sinônimos e termos relacionados.
  • Associe seus recursos de dados a termos no glossário, o que permite pesquisar recursos de dados com base em conceitos de negócios.

Um glossário de negócios ajuda a simplificar a descoberta de dados e reduzir a ambiguidade, o que pode levar a análises mais precisas, melhor governança e insights mais rápidos.

Elementos de um glossário de negócios

Esta seção descreve os principais elementos que podem ser usados para estruturar um glossário de negócios.

Glossário

Um glossário tem as seguintes propriedades:

  • Visão geral. Descreve a finalidade e o conteúdo do glossário de negócios. Você pode adicionar imagens, links, tabelas ou texto formatado ao glossário. O tamanho máximo aceito é de 120 KB.
  • Descrição. Descreve o glossário. O texto neste campo é indexado para pesquisa. O tamanho máximo permitido é 1 KB.
  • Region. Especifica a região em que o glossário está localizado.

Categoria

Uma categoria permite organizar e estruturar várias categorias e termos. As categorias são definidas em um glossário de negócios. É possível aninhar categorias em até três níveis.

Uma categoria tem as propriedades de um glossário, além das seguintes:

  • Contatos. Especifica a pessoa responsável por manter a categoria. Essa propriedade é descritiva e não afeta as permissões da categoria.
  • Principal. Especifica uma relação usada para estabelecer a categoria principal da categoria atual. É possível aninhar até três categorias.

A região de uma categoria é a mesma do glossário que a contém.

Termo

Um termo (abreviação de "termo do glossário") descreve um conceito usado em um ramo específico de negócios na sua empresa. Por exemplo, o departamento de marketing de uma empresa pode criar um termo que descreve o custo por clique. Os termos são definidos em um glossário de negócios, diretamente nele ou em qualquer categoria encontrada nele.

Um termo tem as propriedades de uma categoria, além das seguintes:

  • Sinônimos. Especifica links entre termos que têm o mesmo significado. Consulte Termos de sinônimos.
  • Termos relacionados. Especifica links entre termos que estão conceitualmente relacionados entre si, mas que têm significados diferentes. Consulte Termos relacionados.
  • Entradas relacionadas. Especifica links entre termos e recursos de dados ou entre termos e colunas em recursos de dados.
  • Contatos. Especifica a pessoa responsável por manter o termo. Os termos não herdam os contatos definidos nas categorias.

A região de um termo é a mesma do glossário que o contém.

Termos sinônimos

Um sinônimo é uma relação que indica equivalência entre dois termos diferentes. Use sinônimos quando dois termos com o mesmo significado são definidos por equipes diferentes em glossários diferentes. Por exemplo, é possível criar um sinônimo para vincular os termos "lucro" e "ganhos".

Um termo relacionado é uma relação que indica que dois termos estão associados um ao outro, mas têm significados diferentes. Por exemplo, você pode criar um termo relacionado para vincular "receita" e "lucro".

Limitações

Funções exigidas

Para receber as permissões necessárias para criar e gerenciar glossários, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

  • Para administradores de dados, tenha acesso total a glossários, categorias, termos, sinônimos e termos relacionados, além de definir políticas do IAM: Administrador de catálogo do Dataplex (roles/dataplex.catalogAdmin)
  • Para administradores ou proprietários de dados, tenha acesso à criação, edição ou exclusão de glossários, categorias, termos, links entre termos, links entre termos e recursos de dados e pesquisa: Editor do catálogo do Dataplex (roles/dataplex.catalogEditor)
  • Para analistas ou consumidores de dados, conceda acesso somente leitura a glossários, categorias, termos, links entre termos e entre termos e recursos de dados, além de pesquisa: Leitor do Dataplex Catalog (roles/dataplex.catalogViewer)

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para criar e gerenciar glossários. Para conferir as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para criar e gerenciar glossários:

  • Crie, leia, atualize e exclua um glossário de negócios, uma categoria e termos no seu projeto:
    • dataplex.glossaries.list
    • dataplex.glossaries.create
    • dataplex.glossaries.get
    • dataplex.glossaries.update
    • dataplex.glossaries.delete
    • dataplex.glossaryCategories.create
    • dataplex.glossaryCategories.list
    • dataplex.glossaryCategories.get
    • dataplex.glossaryCategories.update
    • dataplex.glossaryCategories.delete
    • dataplex.glossaryTerms.create
    • dataplex.glossaryTerms.list
    • dataplex.glossaryTerms.get
    • dataplex.glossaryTerms.update
    • dataplex.glossaryTerms.delete
  • Crie e exclua links de sinônimos termo a termo no seu projeto:
    • dataplex.entryLinks.create no grupo de entrada do Dataplex Universal Catalog no projeto em que um dos termos do glossário está presente. O link é criado no grupo de entradas para o qual a permissão é concedida.
    • dataplex.entryGroups.useSynonymEntryLink no grupo de entrada do Dataplex Universal Catalog no projeto em que um dos termos do glossário está presente. O link é criado no grupo de entradas para o qual a permissão é concedida.
    • dataplex.glossaryTerms.use nos glossários cujos termos precisam ser associados.
    • dataplex.entryLinks.delete no grupo de entrada do Dataplex Universal Catalog no projeto em que o link está presente.
  • Crie e exclua links de termo para termo relacionados no seu projeto:
    • dataplex.entryLinks.create no grupo de entrada do Dataplex Universal Catalog no projeto em que um dos termos do glossário está presente. O link é criado no grupo de entradas para o qual a permissão é concedida.
    • dataplex.entryGroups.useRelatedEntryLink no grupo de entrada do Dataplex Universal Catalog no projeto em que um dos termos do glossário está presente. O link é criado no grupo de entradas para o qual a permissão é concedida.
    • dataplex.entries.link no grupo de entradas do Dataplex Universal Catalog em projetos que têm entradas correspondentes a termos do glossário.
    • dataplex.entryLinks.delete no grupo de entrada do Dataplex Universal Catalog no projeto em que o link está presente.
  • Crie links entre termos e recursos ou colunas de dados no seu projeto:
    • dataplex.entryLinks.create no grupo de entradas do sistema correspondente a recursos de dados ou colunas no projeto. O link é criado no projeto para o qual a permissão é concedida.
    • dataplex.entryGroups.useDefinitionEntryLink no grupo de entradas do sistema correspondente a recursos de dados ou colunas no projeto. O link é criado no projeto para o qual a permissão é concedida.
    • dataplex.entries.link no grupo de entradas do sistema correspondente a recursos de dados ou colunas no projeto. O link é criado no projeto para o qual a permissão é concedida.
    • dataplex.glossaryTerms.use no glossário em que o termo precisa ser associado.
    • dataplex.entryLinks.delete no grupo de entradas do sistema em que o link está presente.

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Para mais informações, consulte Papéis predefinidos para o Data Catalog.

Criar e gerenciar glossários de negócios

As seções a seguir descrevem como criar, visualizar, editar e excluir um glossário de negócios.

Criar um glossário de negócios

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Clique em Criar glossário de negócios.

  3. Na página Criar glossário de negócios, especifique um nome e um local para o glossário. Depois de criar o glossário, não é possível mudar o local.

  4. Clique em Criar. O glossário é criado no projeto atual.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

REST

Quando você cria um glossário, o Dataplex Universal Catalog cria uma entrada para representar o glossário.

  1. Crie o glossário.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

    Substitua:

    • PROJECT_ID: o ID do projeto em que você quer criar o glossário
    • LOCATION_ID: o ID do local em que você quer criar o glossário
    • GLOSSARY_ID: o ID do glossário
    • DISPLAY_NAME: o nome de exibição do glossário
    • DESCRIPTION: a descrição do glossário, com um máximo de 1.024 caracteres

  2. Opcional: adicione uma visão geral ao glossário.

    1. Procure a entrada do glossário:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID
\
\&view=ALL

      Substitua PROJECT_NUMBER pelo número do projeto em que o glossário foi criado.

    2. Adicione uma visão geral ao glossário:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview \
--data @- << EOF
{
"aspects": {
   "dataplex-types.global.overview": {
      "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/overview",
      "data": {
      "content": "OVERVIEW",
      "links": []
      },
   }
}
}
EOF

      Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

Confira os glossários disponíveis

Console

  • No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

    O painel Meus glossários mostra todos os glossários da organização que você tem permissão para acessar, além das descrições e dos carimbos de data/hora da última modificação.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries

Editar um glossário

É possível editar o nome e a descrição de um glossário.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Clique no glossário que você quer editar.

  3. Clique em Editar ao lado do nome, da descrição ou da visão geral e faça a mudança.

  4. Clique em Salvar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Excluir um glossário

Antes de excluir um glossário, é necessário excluir todas as categorias e os termos dele.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Clique no glossário que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID

Criar e gerenciar categorias

As seções a seguir descrevem como criar, visualizar, atualizar e excluir categorias.

Criar uma categoria em um glossário

Um glossário empresarial pode ter no máximo 200 categorias.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Selecione o glossário em que você quer criar uma categoria e clique em Criar categoria.

  3. Insira um nome para a categoria.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

REST

Quando você cria uma categoria, o Dataplex Universal Catalog cria uma entrada para representar a categoria.

  1. Crie a categoria.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "CATEGORY_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
}
EOF

    Substitua:

    • CATEGORY_ID: o ID da categoria
    • CATEGORY_DISPLAY_NAME: o nome de exibição da categoria
    • CATEGORY_DESCRIPTION: a descrição da categoria

  2. Opcional: adicione uma visão geral à categoria.

    1. Procure a entrada da sua categoria:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

    2. Adicione uma visão geral à sua categoria:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicione contatos

    1. Procure a entrada da sua categoria:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID
\
\&view=ALL

    2. Atualize a entrada da sua categoria com contatos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Criar uma categoria aninhada

Um glossário de negócios pode ter no máximo três níveis de categoria aninhados, excluindo o nível raiz.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Abra o glossário em que você quer criar uma categoria.

  3. Selecione a categoria principal em que você quer criar outra categoria e clique em Criar categoria.

  4. Insira um nome para a categoria.

  5. Clique em Criar.

  6. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories?category_id=CATEGORY_ID --data @- << EOF
{
  "displayName": "CATEGORY_DISPLAY_NAME",
  "description": "CATEGORY_DESCRIPTION",
  "parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

Substitua PARENT_CATEGORY_ID pelo ID da categoria principal.

Ver as categorias que pertencem a um glossário

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Para ver as categorias em um glossário, expanda-o.

  3. Para ver as categorias aninhadas em uma categoria, expanda-a.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories

Editar uma categoria

É possível editar o nome, a descrição e os contatos de uma categoria. Para categorias aninhadas, também é possível editar a categoria principal.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Abra o glossário e clique na categoria que você quer editar.

  3. Clique em Editar ao lado do nome, da descrição ou da visão geral e faça a mudança.

  4. Clique em Salvar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID?update_mask=displayName,description --data @- << EOF
{
"displayName": "CATEGORY_DISPLAY_NAME",
"description": "DESCRIPTION"
}
EOF

Excluir uma categoria

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Abra o glossário e clique na categoria que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID

Criar e gerenciar termos

As seções a seguir descrevem como criar, visualizar, acessar, editar e excluir termos.

Criar um termo em um glossário de negócios

Um glossário de negócios pode ter no máximo 5.000 termos.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Para criar um termo no nível do glossário, selecione o glossário em que você quer criar um termo e clique em Criar termo.

  3. Insira um nome para o termo.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  6. Opcional: para adicionar contatos, clique em Editar e forneça uma lista de endereços de e-mail dos administradores, proprietários ou donos de domínio de dados. Clique em Salvar.

REST

Quando você cria um termo, o Dataplex Universal Catalog cria uma entrada para representar o termo.

  1. Crie o termo.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
{
"displayName": "TERM_DISPLAY_NAME",
"description": "TERM_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID"
}
EOF

    Substitua:

    • TERM_ID: o ID do termo que você está criando
    • TERM_DISPLAY_NAME: o nome de exibição do termo que você está criando
    • TERM_DESCRIPTION: a descrição do termo que você está criando

  2. Opcional: adicione uma visão geral ao termo.

    1. Procure a entrada do seu termo:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Adicione uma visão geral ao seu termo:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicione contatos.

    1. Procure a entrada do seu termo:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Atualize a entrada do seu termo com contatos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Criar um termo em uma categoria

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Para criar um termo em uma categoria, selecione a categoria em que você quer criar um termo e clique em Adicionar termo.

  3. Insira um nome para o termo.

  4. Clique em Criar.

  5. Opcional: adicione uma descrição curta em Descrição (até 1.024 caracteres) ou uma descrição longa em Visão geral (até 120 KB).

  6. Opcional: para adicionar contatos, clique em Editar e forneça uma lista de endereços de e-mail dos administradores, proprietários ou donos de domínio de dados. Clique em Salvar.

REST

Quando você cria um termo, o Dataplex Universal Catalog cria uma entrada para representar o termo.

  1. Crie um termo.

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms?term_id=TERM_ID --data @- << EOF
{
"displayName": "TERM_DISPLAY_NAME",
"description": "TERM_DESCRIPTION",
"parent": "projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/PARENT_CATEGORY_ID"
}
EOF

    Substitua:

    • TERM_ID: o ID do termo que você está criando
    • TERM_DISPLAY_NAME: o nome de exibição do termo que você está criando
    • TERM_DESCRIPTION: a descrição do termo que você está criando

  2. Opcional: adicione uma visão geral ao termo.

    1. Procure a entrada do seu termo:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Adicione uma visão geral ao seu termo:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": "OVERVIEW",
   "links": []
   },
}
}
}
EOF

      Substitua OVERVIEW por texto simples ou HTML para descrever a categoria ou o termo do glossário.

  3. Opcional: adicione contatos.

    1. Procure a entrada do seu termo:

      gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID
:lookupEntry\
?entry=projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
\
\&view=ALL

    2. Atualize a entrada do seu termo com contatos:

      gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/contacts \
--data @- << EOF
{
"aspects": {
"dataplex-types.global.contacts": {
   "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts",
   "data": {
   "identities": [
      {
         "role": "steward",
         "name": "CONTACT_NAME",
         "id": "CONTACT_EMAIL"
      }
   ]
   },
}
}
}
EOF

Ver os termos em um glossário ou categoria

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Para ver os termos em um glossário, expanda-o. Para ver os termos em uma categoria deste glossário, expanda a categoria. Para ver os termos em uma categoria aninhada, expanda-a.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms

Ver os detalhes de um termo

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Para ver a lista de termos em um glossário, expanda o glossário.

  3. Clique em um termo. A página Detalhes do termo mostra o nome, a descrição, os termos relacionados, os sinônimos e as entradas relacionadas.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

Editar um termo

É possível editar o nome, a descrição, a visão geral, os contatos e o termo principal.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Abra o glossário e clique no termo que você quer editar.

  3. Clique em Editar.

  4. Edite qualquer um dos campos e clique em Salvar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=displayName,description --data @- << EOF
{
  "displayName": "TERM_DISPLAY_NAME",
  "description": "TERM_DESCRIPTION"
}
EOF

Excluir um termo

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Expanda o glossário e clique no termo que você quer excluir.

  3. Clique em Excluir e confirme quando solicitado.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID

É possível adicionar relações entre termos vinculando-os como sinônimos ou termos relacionados.

As relações entre termos são bidirecionais. Por exemplo, quando você vincula profit como sinônimo de earnings, earnings também se torna um sinônimo de profit.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Expanda o glossário e clique no termo com que você quer criar links.

  3. Clique em Editar ao lado de Termos sinônimos.

  4. Pesquise e selecione os termos que você quer vincular.

    O termo é vinculado imediatamente quando você o seleciona.

  5. Clique em Fechar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

Substitua:

  • TERM1_PROJECT_NUMBER: o número do projeto do primeiro termo a ser vinculado.
  • TERM1_LOCATION_ID: o ID de local do glossário que contém o primeiro termo.
  • TERM1_GLOSSARY_ID: o ID do glossário que contém o primeiro termo.
  • TERM1_ID: o ID do primeiro termo.
  • TERM2_PROJECT_NUMBER: o número do projeto do segundo termo que você quer vincular como um sinônimo. Se os dois termos estiverem no mesmo projeto, esse valor será igual ao número do projeto do primeiro termo.
  • TERM2_LOCATION_ID: o ID de local do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo local, esse valor será igual ao ID do local do primeiro termo.
  • TERM2_GLOSSARY_ID: o ID do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo glossário, esse valor será igual ao ID do glossário do primeiro termo.
  • TERM2_ID: o ID do segundo termo.
  • ENTRY_LINK_ID: um ID para a vinculação entre os dois termos. Cada termo é representado como uma entrada do Dataplex Universal Catalog. O link de entrada é a relação entre termos sinônimos.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Expanda o glossário e clique no termo com que você quer criar links.

  3. Clique em Editar ao lado de Termos relacionados.

  4. Pesquise e selecione os termos que você quer vincular.

    O termo é vinculado imediatamente quando você o seleciona.

  5. Clique em Fechar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/TERM1_PROJECT_ID/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/related",
"entry_references": [{
     "name": "projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM1_PROJECT_NUMBER/locations/TERM1_LOCATION_ID/glossaries/TERM1_GLOSSARY_ID/terms/TERM1_ID",
     "type": "UNSPECIFIED"
  }, {
     "name": "projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM2_PROJECT_NUMBER/locations/TERM2_LOCATION_ID/glossaries/TERM2_GLOSSARY_ID/terms/TERM2_ID",
     "type": "UNSPECIFIED"
  }
  ]

}
EOF
)"

Substitua:

  • TERM1_PROJECT_NUMBER: o número do projeto do primeiro termo vinculado.
  • TERM1_LOCATION_ID: o ID de local do glossário que contém o primeiro termo.
  • TERM1_GLOSSARY_ID: o ID do glossário que contém o primeiro termo.
  • TERM1_ID: o ID do primeiro termo.
  • TERM2_PROJECT_NUMBER: o número do projeto do segundo termo que você quer vincular como um termo relacionado. Se os dois termos estiverem no mesmo projeto, esse valor será igual ao número do projeto do primeiro termo.
  • TERM2_LOCATION_ID: o ID de local do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo local, esse valor será igual ao ID do local do primeiro termo.
  • TERM2_GLOSSARY_ID: o ID do glossário que contém o segundo termo. Se os dois termos estiverem no mesmo glossário, esse valor será igual ao ID do glossário do primeiro termo.
  • TERM2_ID: o ID do segundo termo.
  • ENTRY_LINK_ID: um ID para a vinculação entre os dois termos. Cada termo é representado como uma entrada do Dataplex Universal Catalog. O link de entrada é a relação entre termos relacionados.

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Expanda o glossário e clique no termo que você quer remover.

  3. Para excluir links entre termos relacionados, clique em Editar ao lado de Termos relacionados. Exclua os termos relacionados e clique em Fechar.

  4. Para excluir links entre sinônimos, clique em Editar ao lado de Termos sinônimos. Exclua os sinônimos e clique em Fechar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

É possível anexar termos a recursos ou colunas de recursos de dados. Por exemplo, é possível anexar termos a um conjunto de dados do BigQuery.

Console

  1. No console Google Cloud , acesse a página Pesquisa do Universal Catalog do Dataplex.

    Acesse Pesquisar

  2. Pesquise e clique no recurso de dados (como um conjunto de dados, arquivo ou tabela) a que você quer vincular um termo.

  3. Na página do recurso de dados, faça o seguinte:

    • Para vincular termos a um recurso, na guia Detalhes, na seção Termos do glossário, clique em Adicionar. Pesquise e selecione os termos e clique em Fechar.
    • Se o recurso tiver um esquema, você poderá vincular termos a uma coluna. Na guia Esquema, selecione uma coluna para vincular os termos e clique em Adicionar termo comercial. Pesquise e selecione os termos e clique em Fechar.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<<EOF
{
  "entry_link_type": "projects/dataplex-types/locations/global/entryLinkTypes/definition",
  "entry_references": [{
     "name": "projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
     "type": "SOURCE"
  }, {
     "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
     "type": "TARGET"
  }
  ]
}
EOF
)"

Substitua:

  • PROJECT_NUMBER: o número do projeto do recurso de dados que está sendo vinculado.
  • ENTRY_LOCATION_ID: o ID do local do recurso de dados que está sendo vinculado.
  • ENTRY_GROUP_ID: o grupo de entrada do recurso de dados que está sendo vinculado
  • ENTRY_LINK_ID: um ID para o link entre o termo e a entrada do Dataplex Universal Catalog que representa o recurso de dados.
  • TERM_PROJECT_NUMBER: o número do projeto do termo que está sendo vinculado.

Anexar termos a uma coluna em um esquema de entrada

Console

  1. No console Google Cloud , acesse a página Pesquisa do Universal Catalog do Dataplex.

    Acesse Pesquisar

  2. Pesquise o recurso de dados (como um conjunto de dados, arquivo ou tabela) que tenha um esquema com uma coluna a que você quer vincular um termo. Clique no recurso de dados.

  3. Na página do recurso de dados, faça o seguinte:

    • Para vincular termos a uma coluna no recurso de dados, na guia "Esquema", selecione as colunas a que você quer anexar o termo.
    • Clique em Adicionar termo de negócios. Pesquise o termo que você quer anexar e clique nele.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks?entry_link_id=ENTRY_LINK_ID -d "$(cat<PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID",
  "type": "SOURCE"
  "path": "Schema/COLUMN_NAME"
}, {
  "name": "projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/entryGroups/@dataplex/entries/projects/TERM_PROJECT_NUMBER/locations/TERM_LOCATION_ID/glossaries/TERM_GLOSSARY_ID/terms/TERM_ID",
  "type": "TARGET"
}
]
}
EOF
)"

Substitua:

  • PROJECT_NUMBER: o número do projeto do recurso de dados que está sendo vinculado.
  • ENTRY_LOCATION_ID: o ID do local do recurso de dados que está sendo vinculado.
  • ENTRY_GROUP_ID: o grupo de entrada do recurso de dados que está sendo vinculado
  • ENTRY_LINK_ID: um ID para o link entre o termo e a entrada do Dataplex Universal Catalog que representa o recurso de dados.
  • TERM_PROJECT_NUMBER: o número do projeto do termo que está sendo vinculado
  • COLUMN_NAME: a coluna a que você quer anexar o termo

Console

  1. No console Google Cloud , acesse a página Pesquisa do Universal Catalog do Dataplex.

    Acesse Pesquisar

  2. Pesquise e clique no recurso de dados (como um conjunto de dados, arquivo ou tabela) em que você quer remover os termos.

  3. Na página do recurso de dados, faça o seguinte:

    • Para remover um termo de um recurso, na guia Detalhes, na seção Termos do glossário, clique no termo. Em seguida, clique em .
    • Para remover um termo de uma coluna, na guia Esquema, clique em ao lado dele.

REST

alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X DELETE https://dataplex.googleapis.com/v1/projects/ENTRY_PROJECT_ID/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entryLinks/ENTRY_LINK_ID

Encontrar glossários, termos e recursos de dados vinculados

Console

Para navegar pelo conteúdo do glossário de negócios, use a árvore de glossários e termos na página Glossários.

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Na página Glossários, use a barra de filtro para encontrar categorias. Os seguintes filtros estão disponíveis:

    • Nome: retorna os glossários, categorias e termos cujo nome contém o texto fornecido.
    • Parent: retorna os termos cujo nome ou descrição do glossário principal corresponde ao texto fornecido. Por exemplo, parent:Finance retorna os termos conectados ao glossário principal cujo nome ou descrição contém a frase Finance.
    • Sinônimo: retorna a lista de termos com um sinônimo cujo nome ou ID contém o texto fornecido. Por exemplo, synonym:Profit retorna os termos que têm um sinônimo cujo nome ou ID contém a frase profit.
    • Contato: retorna os termos em que o administrador de dados está listado como um contato. Por exemplo, contact:alex@example.com retorna as entradas conectadas a termos com um administrador de dados que corresponda a alex@example.com.

REST

Para encontrar glossários, termos e recursos de dados vinculados usando a API REST, inscreva-se na prévia.

Pesquisar recursos de dados vinculados a termos

Console

  1. No console Google Cloud , acesse a página Glossários do Universal Catalog do Dataplex.

    Acessar "Glossários"

  2. Na página Glossários, use a barra de filtro para inserir uma consulta de pesquisa de texto livre. Isso retorna uma lista de correspondências no glossário, na categoria e nos nomes dos termos.

  3. Clique em um termo correspondente.

  4. Na página Detalhes do termo, confira os termos vinculados (sinônimos e termos relacionados) e as entradas vinculadas (ativos de dados) a esse termo.

  5. Para conferir os detalhes de uma entrada no Dataplex Universal Catalog, clique nela.

REST

Para encontrar glossários, termos e recursos de dados vinculados usando a API REST, inscreva-se na prévia.

Para importar glossários e links de outra ferramenta de catalogação ou atualizar seus glossários no Dataplex Universal Catalog, é possível importar em massa glossários, categorias, termos, links entre termos, links entre termos e recursos de dados ou colunas usando a API REST.

  1. Crie o glossário de destino.

    REST

    alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/glossaries?glossary_id=GLOSSARY_ID -d "$(cat<<EOF

{
 "displayName": "DISPLAY_NAME",
 "description": "DESCRIPTION"
}
EOF
)"

    Substitua:

    • PROJECT_ID: o ID do projeto em que você está criando o glossário.
    • LOCATION_ID: o local em que queremos criar o glossário.
    • GLOSSARY_ID: o ID do glossário
    • DISPLAY_NAME: o nome de exibição do glossário
    • DESCRIPTION: a descrição do glossário

  2. Para importar categorias, termos e links entre termos e recursos de dados no glossário de destino criado, faça upload de arquivos para cada um deles em um bucket do Cloud Storage. Esses arquivos têm o seguinte formato:

    • Exemplo de formato para termos e categorias de um glossário

       {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-category","aspects":{"dataplex-types.global.glossary-category-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","displayName":"CATEGORY_NAME","description":"CATEGORY_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"}]}}}
 {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM1_ID","displayName":"TERM1_DISPLAY_NAME","description":"TERM1_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}
 {"entry":{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","entryType":"projects/dataplex-types/locations/global/entryTypes/glossary-term","aspects":{"dataplex-types.global.glossary-term-aspect":{"data":{}},"dataplex-types.global.overview":{"data":{"content":"TERM1_CONTENT"}},"dataplex-types.global.contacts":{"data":{"identities":[{role: "steward", name: "CONTACT_DISPLAY_NAME", id: "CONTACT_EMAIL"}]}}},"parentEntry":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","entrySource":{"resource":"projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM2_ID","displayName":"TERM2_DISPLAY_NAME","description":"TERM2_DESCRIPTION","ancestors":[{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary"},{"name":"projects/PROJECT_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/categories/CATEGORY_ID","type":"projects/dataplex-types/locations/global/entryTypes/glossary-category"}]}}}

    • Formato de exemplo para links entre termos

       {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/synonym","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}
 {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-2f7408e3-af3d-405d-81bb-861cf9ec5146","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/related","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-2"}]}}

    • Exemplo de formato para links entre termos e recursos de dados

       projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1 and term projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1
 {"entryLink":{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048","entryLinkType":"projects/dataplex-types/locations/global/entryLinkTypes/definition","entryReferences":[{"name":"projects/PROJECT_NUMBER/locations/global/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/global/glossaries/import-glossary/terms/term-1"},{"name":"projects/PROJECT_NUMBER/locations/us-central1/entryGroups/entry-group-1/entries/entry-1"}]}}
 
    # Set GCURL alias
alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
{
  "type":"IMPORT",
  "import_spec":{
     "log_level":"DEBUG",
     "source_storage_uri":"gs://STORAGE_BUCKET/",
     "entry_sync_mode":"FULL",
     "aspect_sync_mode":"INCREMENTAL",
     "scope":{
        "glossaries": "GLOSSARY_NAME"
     }
  }
}
EOF
)"

    Substitua DATAPLEX_API pelo endpoint de API do Dataplex Universal Catalog no formato dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  3. Opcional: confira o status da operação.

    gcurl https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/operations/operation-OPERATION_ID

    Substitua OPERATION_ID pelo ID da operação.

  4. Opcional: confira o status do job de metadados.

    gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataJobs/JOB_ID

  5. Importe links entre termos como sinônimos ou termos relacionados.

    gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
{
  "type":"IMPORT",
  "import_spec":{
     "log_level":"DEBUG",
     "source_storage_uri":"gs://STORAGE_BUCKET/",
     "entry_sync_mode":"FULL",
     "aspect_sync_mode":"INCREMENTAL",
     "scope":{
        "entry_groups":[  "projects/PROJECT_ID/locations/LOCATION_ID/entryGroups/@dataplex"
        ],
        "entry_link_types":[
           "projects/dataplex-types/locations/global/entryLinkTypes/synonym",
           "projects/dataplex-types/locations/global/entryLinkTypes/related"
        ],
        "referenced_entry_scopes":[
           "PROJECT_IDS"
        ]
     }
  }
}
EOF
)"

    Substitua DATAPLEX_API por dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  6. Importar links entre termos e recursos ou colunas de dados.

    Para criar um link entre termos do glossário e recursos de dados, execute o trabalho de importação para cada grupo de entradas a que a entrada do recurso de dados pertence. Todos os links de entrada de definição são criados nesse grupo de entradas.

    gcurl https://DATAPLEX_API/metadataJobs?metadata_job_id=JOB_ID -d "$(cat<<EOF
{
"type":"IMPORT",
"import_spec":{
  "log_level":"DEBUG",
  "source_storage_uri":"gs://STORAGE_BUCKET/",
  "entry_sync_mode":"FULL",
  "aspect_sync_mode":"INCREMENTAL",
  "scope":{
     "entry_groups":[  "projects/PROJECT_ID/locations/ENTRY_GROUP_LOCATION_ID/entryGroups/@dataplex"
     ],
     "entry_link_types":[
        "projects/dataplex-types/locations/global/entryLinkTypes/definition"
     ],
     "referenced_entry_scopes":[
        "PROJECT_IDS"
     ]
  }
}
}
EOF
)"

    Substitua DATAPLEX_API por dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

Preços

A partir de julho de 2026, o glossário empresarial do Dataplex Universal Catalog será cobrado da mesma forma que os preços de armazenamento de metadados. Consulte Preços do armazenamento de metadados do Dataplex Universal Catalog.

A seguir