Gérer un glossaire d'entreprise

Le glossaire d'entreprise Dataplex Universal Catalog fournit un emplacement unique pour gérer la terminologie et les définitions liées à l'activité dans toute votre entreprise.

Lorsque différentes équipes travaillent sur un projet commun ou qu'une grande entreprise compte de nombreux services, il est courant que chaque partie de l'entreprise crée sa propre terminologie pour décrire les différentes ressources de données avec lesquelles elle travaille. Cela peut entraîner des problèmes de communication et une compréhension incohérente de ces ressources. De plus, un concept peut parfois nécessiter des connaissances techniques ou spécialisées. Les utilisateurs métier d'autres domaines peuvent alors avoir du mal à comprendre le concept.

Le glossaire d'entreprise Dataplex Universal Catalog vous permet de créer un vocabulaire centralisé et standardisé pour vos ressources de données. Vous pouvez utiliser un glossaire d'entreprise pour effectuer les opérations suivantes :

  • Définissez une structure hiérarchique de catégories et de concepts d'entreprise, appelés termes.
  • Créez des liens entre les concepts en définissant des synonymes et des termes associés.
  • Associez vos ressources de données à des termes du glossaire. Vous pourrez ainsi rechercher des ressources de données en fonction de concepts commerciaux.

Un glossaire d'entreprise permet de simplifier la découverte des données et de réduire l'ambiguïté, ce qui peut conduire à des analyses plus précises, à une meilleure gouvernance et à des insights plus rapides.

Éléments d'un glossaire d'entreprise

Cette section décrit les éléments clés que vous pouvez utiliser pour structurer un glossaire d'entreprise.

Glossaire

Un glossaire possède les propriétés suivantes :

  • Présentation. Décrit l'objectif et le contenu du glossaire métier. Vous pouvez ajouter des images, des liens, des tableaux ou du texte mis en forme au glossaire. La taille maximale acceptée est de 120 Ko.
  • Description. Décrit le glossaire. Le texte de ce champ est indexé pour la recherche. La taille maximale autorisée est de 1 Ko.
  • Région : Spécifie la région dans laquelle se trouve le glossaire.

Catégorie

Une catégorie vous permet d'organiser et de structurer différentes catégories et différents termes. Les catégories sont définies dans un glossaire d'entreprise. Vous pouvez imbriquer des catégories sur trois niveaux maximum.

Une catégorie possède les propriétés d'un glossaire, ainsi que les propriétés suivantes :

  • Contacts. Spécifie la personne responsable de la gestion de la catégorie. Cette propriété est descriptive et n'a aucune incidence sur les autorisations de la catégorie.
  • Parent Spécifie une relation utilisée pour établir le parent de la catégorie actuelle. Vous pouvez imbriquer jusqu'à trois catégories.

La région d'une catégorie est la même que celle du glossaire qui la contient.

Terme

Un terme (abréviation de "terme de glossaire") décrit un concept utilisé dans une branche d'activité spécifique de votre entreprise. Par exemple, le service marketing d'une entreprise peut créer un terme décrivant le coût par clic. Les termes sont définis dans un glossaire d'entreprise, soit directement dans le glossaire, soit dans une catégorie du glossaire.

Un terme possède les propriétés d'une catégorie, ainsi que les propriétés suivantes :

  • Synonymes. Spécifie les liens entre les termes qui ont la même signification. Consultez Termes synonymes.
  • Termes associés : Spécifie les liens entre les termes qui sont conceptuellement liés les uns aux autres, mais qui ont des significations différentes. Consultez les termes associés.
  • Entrées associées Spécifie les liens entre les termes et les composants de données, ou entre les termes et les colonnes dans les composants de données.
  • Contacts. Indique la personne responsable de la gestion du terme. Les conditions n'héritent pas des contacts définis dans les catégories.

La région d'un terme est la même que celle du glossaire qui le contient.

Synonymes

Un synonyme est une relation qui indique l'équivalence entre deux termes différents. Utilisez des synonymes lorsque deux termes ayant la même signification sont définis par différentes équipes dans différents glossaires. Par exemple, vous pouvez créer un synonyme pour associer les termes "bénéfice" et "revenus".

Un terme associé est une relation qui indique que deux termes sont associés l'un à l'autre, mais ont des significations différentes. Par exemple, vous pouvez créer un terme associé pour relier les termes "revenus" et "bénéfices".

Limites

Rôles requis

Pour obtenir les autorisations nécessaires pour créer et gérer des glossaires, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

  • Pour les administrateurs de données, obtenez un accès complet aux glossaires, catégories, termes, synonymes et termes associés, et définissez des stratégies IAM : Administrateur de catalogue Dataplex (roles/dataplex.catalogAdmin)
  • Les responsables ou propriétaires des données peuvent créer, modifier ou supprimer des glossaires, des catégories, des termes et des liens entre les termes, des liens entre les termes et les éléments de données, et effectuer des recherches : Éditeur de catalogue Dataplex (roles/dataplex.catalogEditor)
  • Pour les analystes ou les consommateurs de données, obtenez un accès en lecture seule aux glossaires, aux catégories, aux termes, aux liens entre les termes et entre les termes et les éléments de données, ainsi qu'à la recherche : Lecteur de catalogue Dataplex (roles/dataplex.catalogViewer)

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ces rôles prédéfinis contiennent les autorisations requises pour créer et gérer des glossaires. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour créer et gérer des glossaires :

  • Créez, lisez, mettez à jour et supprimez un glossaire d'entreprise, une catégorie et des termes dans votre projet :
    • 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
  • Créez et supprimez des liens de synonymes terme à terme dans votre projet :
    • dataplex.entryLinks.create sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel l'un des termes du glossaire est présent. Le lien est créé dans le groupe d'entrées pour lequel l'autorisation est accordée.
    • dataplex.entryGroups.useSynonymEntryLink sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel l'un des termes du glossaire est présent. Le lien est créé dans le groupe d'entrées pour lequel l'autorisation est accordée.
    • dataplex.glossaryTerms.use sur les glossaires dont les termes doivent être associés.
    • dataplex.entryLinks.delete sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel le lien est présent.
  • Créez et supprimez des liens terme à terme associés dans votre projet :
    • dataplex.entryLinks.create sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel l'un des termes du glossaire est présent. Le lien est créé dans le groupe d'entrées pour lequel l'autorisation est accordée.
    • dataplex.entryGroups.useRelatedEntryLink sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel l'un des termes du glossaire est présent. Le lien est créé dans le groupe d'entrées pour lequel l'autorisation est accordée.
    • dataplex.entries.link sur le groupe d'entrées Dataplex Universal Catalog dans les projets dans lesquels des entrées correspondant à des termes du glossaire sont présentes.
    • dataplex.entryLinks.delete sur le groupe d'entrées Dataplex Universal Catalog dans le projet dans lequel le lien est présent.
  • Créez des liens entre les termes et les assets ou colonnes de données de votre projet :
    • dataplex.entryLinks.create sur le groupe d'entrées système correspondant aux éléments de données ou aux colonnes du projet. Le lien est créé dans le projet pour lequel l'autorisation est accordée.
    • dataplex.entryGroups.useDefinitionEntryLink sur le groupe d'entrées système correspondant aux éléments de données ou aux colonnes du projet. Le lien est créé dans le projet pour lequel l'autorisation est accordée.
    • dataplex.entries.link sur le groupe d'entrées système correspondant aux éléments de données ou aux colonnes du projet. Le lien est créé dans le projet pour lequel l'autorisation est accordée.
    • dataplex.glossaryTerms.use sur le glossaire dont le terme doit être associé.
    • dataplex.entryLinks.delete sur le groupe d'entrées système dans lequel le lien est présent.

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Pour en savoir plus, consultez Rôles prédéfinis pour Data Catalog.

Créer et gérer des glossaires d'entreprise

Les sections suivantes expliquent comment créer, afficher, modifier et supprimer un glossaire d'entreprise.

Créer un glossaire d'entreprise

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Cliquez sur Créer un glossaire d'entreprise.

  3. Sur la page Créer un glossaire d'entreprise, spécifiez un nom et un emplacement pour le glossaire d'entreprise. Une fois le glossaire créé, vous ne pouvez plus modifier l'emplacement.

  4. Cliquez sur Créer. Le glossaire est créé dans le projet actuel.

  5. Facultatif : Ajoutez une brève description dans Description (1 024 caractères maximum) ou une description détaillée dans Présentation (120 Ko maximum).

REST

Lorsque vous créez un glossaire, Dataplex Universal Catalog crée une entrée pour le représenter.

  1. Créez le glossaire.

    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

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet dans lequel vous souhaitez créer le glossaire
    • LOCATION_ID : ID de l'emplacement dans lequel vous souhaitez créer le glossaire
    • GLOSSARY_ID : ID du glossaire
    • DISPLAY_NAME : nom à afficher du glossaire
    • DESCRIPTION : description du glossaire (1 024 caractères maximum)
  2. Facultatif : Ajoutez une présentation au glossaire.

    1. Recherchez l'entrée de votre glossaire :

      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

      Remplacez PROJECT_NUMBER par le numéro du projet dans lequel votre glossaire a été créé.

    2. Ajoutez une présentation à votre glossaire :

      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

      Remplacez OVERVIEW par du texte brut ou HTML pour décrire votre catégorie ou terme de glossaire.

Afficher les glossaires disponibles

Console

  • Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

    Le volet Mes glossaires affiche tous les glossaires de l'organisation que vous êtes autorisé à consulter, ainsi que leurs descriptions et les codes temporels de leur dernière modification.

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

Modifier un glossaire

Vous pouvez modifier le nom et la description d'un glossaire.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Cliquez sur le glossaire que vous souhaitez modifier.

  3. Cliquez sur Modifier à côté du nom, de la description ou de l'aperçu, puis apportez les modifications souhaitées.

  4. Cliquez sur Enregistrer.

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

Supprimer un glossaire

Avant de pouvoir supprimer un glossaire, vous devez d'abord supprimer toutes les catégories et tous les termes du glossaire.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Cliquez sur le glossaire que vous souhaitez supprimer.

  3. Cliquez sur Supprimer, puis confirmez l'opération lorsque vous y êtes invité.

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

Créer et gérer des catégories

Les sections suivantes expliquent comment créer, afficher, modifier et supprimer des catégories.

Créer une catégorie dans un glossaire

Un glossaire d'entreprise peut comporter jusqu'à 200 catégories.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Sélectionnez le glossaire dans lequel vous souhaitez créer une catégorie, puis cliquez sur Créer une catégorie.

  3. Saisissez un nom pour la catégorie.

  4. Cliquez sur Créer.

  5. Facultatif : Ajoutez une brève description dans Description (1 024 caractères maximum) ou une description détaillée dans Présentation (120 Ko maximum).

REST

Lorsque vous créez une catégorie, Dataplex Universal Catalog crée une entrée pour la représenter.

  1. Créez la catégorie.

    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

    Remplacez les éléments suivants :

    • CATEGORY_ID : ID de la catégorie
    • CATEGORY_DISPLAY_NAME : nom à afficher de la catégorie
    • CATEGORY_DESCRIPTION : description de la catégorie
  2. Facultatif : Ajoutez une présentation à la catégorie.

    1. Recherchez l'entrée correspondant à votre catégorie :

      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. Ajoutez une présentation à votre catégorie :

      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

      Remplacez OVERVIEW par du texte brut ou HTML pour décrire votre catégorie ou terme de glossaire.

  3. Facultatif : ajoutez des contacts.

    1. Recherchez l'entrée correspondant à votre catégorie :

      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. Mettez à jour l'entrée de votre catégorie avec des contacts :

      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

Créer une catégorie imbriquée

Un glossaire métier peut comporter jusqu'à trois niveaux de catégories imbriquées, sans compter le niveau racine du glossaire.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire dans lequel vous souhaitez créer une catégorie.

  3. Sélectionnez la catégorie parente dans laquelle vous souhaitez créer une autre catégorie, puis cliquez sur Créer une catégorie.

  4. Saisissez un nom pour la catégorie.

  5. Cliquez sur Créer.

  6. Facultatif : Ajoutez une brève description dans Description (1 024 caractères maximum) ou une description détaillée dans Présentation (120 Ko maximum).

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

Remplacez PARENT_CATEGORY_ID par l'ID de la catégorie parente.

Afficher les catégories d'un glossaire

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Pour afficher les catégories d'un glossaire, développez-le.

  3. Pour afficher les catégories imbriquées dans une catégorie, développez-la.

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

Modifier une catégorie

Vous pouvez modifier le nom, la description et les contacts d'une catégorie. Pour les catégories imbriquées, vous pouvez également modifier la catégorie parente.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur la catégorie que vous souhaitez modifier.

  3. Cliquez sur  Modifier à côté du nom, de la description ou de l'aperçu, puis apportez les modifications souhaitées.

  4. Cliquez sur Enregistrer.

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

Supprimer une catégorie

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur la catégorie que vous souhaitez supprimer.

  3. Cliquez sur Supprimer, puis confirmez l'opération lorsque vous y êtes invité.

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

Créer et gérer des conditions

Les sections suivantes expliquent comment créer, afficher, accéder, modifier et supprimer des termes.

Créer un terme dans un glossaire d'entreprise

Un glossaire d'entreprise peut comporter jusqu'à 5 000 termes.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Pour créer un terme au niveau du glossaire, sélectionnez le glossaire dans lequel vous souhaitez créer un terme, puis cliquez sur Créer un terme.

  3. Saisissez un nom pour le terme.

  4. Cliquez sur Créer.

  5. Facultatif : Ajoutez une brève description dans Description (1 024 caractères maximum) ou une description détaillée dans Présentation (120 Ko maximum).

  6. Facultatif : Pour ajouter des contacts, cliquez sur Modifier, puis fournissez une liste d'adresses e-mail pour les responsables des données, les propriétaires des données ou les propriétaires des domaines de données. Cliquez ensuite sur Enregistrer.

REST

Lorsque vous créez un terme, Dataplex Universal Catalog crée une entrée pour le représenter.

  1. Créez le terme.

    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

    Remplacez les éléments suivants :

    • TERM_ID : ID du terme que vous créez
    • TERM_DISPLAY_NAME : nom à afficher du terme que vous créez
    • TERM_DESCRIPTION : description du terme que vous créez
  2. Facultatif : Ajoutez une présentation du terme.

    1. Recherchez l'entrée correspondant à votre terme :

      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. Ajoutez une présentation à votre terme :

      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

      Remplacez OVERVIEW par du texte brut ou HTML pour décrire votre catégorie ou terme de glossaire.

  3. Facultatif : Ajoutez des contacts.

    1. Recherchez l'entrée correspondant à votre terme :

      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. Mettez à jour l'entrée de votre terme avec les contacts :

      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

Créer un terme dans une catégorie

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Pour créer un terme dans une catégorie, sélectionnez la catégorie dans laquelle vous souhaitez créer un terme, puis cliquez sur Ajouter un terme.

  3. Saisissez un nom pour le terme.

  4. Cliquez sur Créer.

  5. Facultatif : Ajoutez une brève description dans Description (1 024 caractères maximum) ou une description détaillée dans Présentation (120 Ko maximum).

  6. Facultatif : Pour ajouter des contacts, cliquez sur Modifier, puis fournissez une liste d'adresses e-mail pour les responsables des données, les propriétaires des données ou les propriétaires des domaines de données. Cliquez ensuite sur Enregistrer.

REST

Lorsque vous créez un terme, Dataplex Universal Catalog crée une entrée pour le représenter.

  1. Créez un terme.

    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

    Remplacez les éléments suivants :

    • TERM_ID : ID du terme que vous créez
    • TERM_DISPLAY_NAME : nom à afficher du terme que vous créez
    • TERM_DESCRIPTION : description du terme que vous créez
  2. Facultatif : Ajoutez une présentation du terme.

    1. Recherchez l'entrée correspondant à votre terme :

      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. Ajoutez une présentation à votre terme :

      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

      Remplacez OVERVIEW par du texte brut ou HTML pour décrire votre catégorie ou terme de glossaire.

  3. Facultatif : Ajoutez des contacts.

    1. Recherchez l'entrée correspondant à votre terme :

      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. Mettez à jour l'entrée de votre terme avec les contacts :

      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

Afficher les termes dans un glossaire ou une catégorie

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Pour afficher les termes d'un glossaire, développez-le. Pour afficher les termes d'une catégorie de ce glossaire, développez-la. Pour afficher les termes d'une catégorie imbriquée, développez-la.

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

Afficher les détails d'un terme

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Pour afficher la liste des termes d'un glossaire, développez-le.

  3. Cliquez sur un terme. La page Détails du terme affiche le nom, la description, les termes associés, les synonymes et les entrées associées.

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

Modifier un terme

Vous pouvez modifier le nom, la description, l'aperçu, les contacts et le parent d'un terme.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur le terme que vous souhaitez modifier.

  3. Cliquez sur Modifier.

  4. Modifiez les champs de votre choix, puis cliquez sur Enregistrer.

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

Supprimer un terme

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire et cliquez sur le terme que vous souhaitez supprimer.

  3. Cliquez sur Supprimer, puis confirmez l'opération lorsque vous y êtes invité.

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

Vous pouvez ajouter des relations entre les termes en les associant en tant que synonymes ou termes associés.

Les relations entre les termes sont bidirectionnelles. Par exemple, lorsque vous associez profit comme synonyme de earnings, earnings devient également un synonyme de profit.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire et cliquez sur le terme avec lequel vous souhaitez créer des liens.

  3. Cliquez sur Modifier à côté de Termes synonymes.

  4. Recherchez les termes à associer, puis sélectionnez-les.

    Le terme est associé immédiatement lorsque vous le sélectionnez.

  5. Cliquez sur Fermer.

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
)"

Remplacez les éléments suivants :

  • TERM1_PROJECT_NUMBER : numéro du projet pour le premier terme associé.
  • TERM1_LOCATION_ID : ID de l'emplacement du glossaire contenant le premier terme.
  • TERM1_GLOSSARY_ID : ID du glossaire contenant le premier terme.
  • TERM1_ID : ID du premier terme.
  • TERM2_PROJECT_NUMBER : numéro du projet pour le deuxième terme que vous souhaitez associer en tant que terme synonyme. Si les deux termes se trouvent dans le même projet, cette valeur est identique au numéro de projet du premier terme.
  • TERM2_LOCATION_ID : ID de l'emplacement du glossaire contenant le deuxième terme. Si les deux termes se trouvent au même emplacement, cette valeur est identique à l'ID de l'emplacement du premier terme.
  • TERM2_GLOSSARY_ID : ID du glossaire contenant le deuxième terme. Si les deux termes figurent dans le même glossaire, cette valeur est identique à l'ID du glossaire pour le premier terme.
  • TERM2_ID : ID du deuxième terme.
  • ENTRY_LINK_ID : ID du lien entre les deux termes. Chaque terme est représenté sous la forme d'une entrée Dataplex Universal Catalog. Le lien d'entrée est la relation entre les termes synonymes.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire et cliquez sur le terme avec lequel vous souhaitez créer des liens.

  3. Cliquez sur Modifier à côté de Termes associés.

  4. Recherchez les termes à associer, puis sélectionnez-les.

    Le terme est associé immédiatement lorsque vous le sélectionnez.

  5. Cliquez sur Fermer.

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
)"

Remplacez les éléments suivants :

  • TERM1_PROJECT_NUMBER : numéro du projet pour le premier terme associé.
  • TERM1_LOCATION_ID : ID de l'emplacement du glossaire contenant le premier terme.
  • TERM1_GLOSSARY_ID : ID du glossaire contenant le premier terme.
  • TERM1_ID : ID du premier terme.
  • TERM2_PROJECT_NUMBER : numéro du projet pour le deuxième terme que vous souhaitez associer en tant que terme associé. Si les deux termes se trouvent dans le même projet, cette valeur est identique au numéro de projet du premier terme.
  • TERM2_LOCATION_ID : ID de l'emplacement du glossaire contenant le deuxième terme. Si les deux termes se trouvent au même emplacement, cette valeur est identique à l'ID de l'emplacement du premier terme.
  • TERM2_GLOSSARY_ID : ID du glossaire contenant le deuxième terme. Si les deux termes figurent dans le même glossaire, cette valeur est identique à l'ID du glossaire pour le premier terme.
  • TERM2_ID : ID du deuxième terme.
  • ENTRY_LINK_ID : ID du lien entre les deux termes. Chaque terme est représenté sous la forme d'une entrée Dataplex Universal Catalog. Le lien d'entrée est la relation entre les termes associés.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur le terme dont vous souhaitez supprimer les synonymes ou les termes associés.

  3. Pour supprimer des liens entre des termes associés, cliquez sur Modifier à côté de Termes associés. Supprimez les termes associés, puis cliquez sur Fermer.

  4. Pour supprimer des liens entre des synonymes, cliquez sur Modifier  à côté de Termes synonymes. Supprimez les synonymes, puis cliquez sur Fermer.

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

Vous pouvez associer des termes à des composants ou des colonnes de composants de données. Par exemple, vous pouvez associer des conditions à un ensemble de données BigQuery.

Console

  1. Dans la console Google Cloud , accédez à la page Rechercher de Dataplex Universal Catalog.

    Accéder à la recherche

  2. Recherchez le composant de données (ensemble de données, fichier ou tableau, par exemple) auquel vous souhaitez associer un terme, puis cliquez dessus.

  3. Sur la page de l'élément de données, effectuez l'une des opérations suivantes :

    • Pour associer des termes à un composant, cliquez sur Ajouter dans la section Termes du glossaire de l'onglet Détails. Recherchez et sélectionnez les termes, puis cliquez sur Fermer.
    • Si le composant possède un schéma, vous pouvez associer des termes à une colonne. Dans l'onglet Schéma, sélectionnez une colonne à laquelle associer des termes, puis cliquez sur Ajouter un terme métier. Recherchez et sélectionnez les termes, puis cliquez sur Fermer.

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
)"

Remplacez les éléments suivants :

  • PROJECT_NUMBER : numéro du projet de l'asset de données associé
  • ENTRY_LOCATION_ID : ID de l'emplacement du composant de données en cours d'association
  • ENTRY_GROUP_ID : groupe d'entrées de l'élément de données en cours d'association
  • ENTRY_LINK_ID : ID du lien entre le terme et l'entrée Dataplex Universal Catalog qui représente le composant de données.
  • TERM_PROJECT_NUMBER : numéro du projet pour le terme associé.

Associer des termes à une colonne dans un schéma d'entrée

Console

  1. Dans la console Google Cloud , accédez à la page Rechercher de Dataplex Universal Catalog.

    Accéder à la recherche

  2. Recherchez le composant de données (ensemble de données, fichier ou table, par exemple) dont le schéma comporte une colonne à laquelle vous souhaitez associer un terme. Cliquez sur le composant de données.

  3. Sur la page de l'élément de données, effectuez l'une des opérations suivantes :

    • Pour associer des termes à une colonne de l'ensemble de données, sélectionnez les colonnes auxquelles vous souhaitez associer le terme dans l'onglet "Schéma".
    • Cliquez sur Ajouter un terme métier. Recherchez le terme que vous souhaitez associer, puis cliquez dessus.

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
)"

Remplacez les éléments suivants :

  • PROJECT_NUMBER : numéro du projet de l'élément de données auquel est associé le lien
  • ENTRY_LOCATION_ID : ID de l'emplacement du composant de données en cours d'association
  • ENTRY_GROUP_ID : groupe d'entrées de l'élément de données en cours d'association
  • ENTRY_LINK_ID : ID du lien entre le terme et l'entrée Dataplex Universal Catalog qui représente le composant de données
  • TERM_PROJECT_NUMBER : numéro du projet pour le terme associé
  • COLUMN_NAME : colonne à laquelle vous souhaitez associer le terme

Console

  1. Dans la console Google Cloud , accédez à la page Rechercher de Dataplex Universal Catalog.

    Accéder à la recherche

  2. Recherchez le composant de données (ensemble de données, fichier ou tableau, par exemple) dont vous souhaitez supprimer les conditions, puis cliquez dessus.

  3. Sur la page de l'élément de données, effectuez l'une des opérations suivantes :

    • Pour supprimer un terme d'un composant, cliquez dessus dans la section Termes du glossaire de l'onglet Détails. Cliquez ensuite sur .
    • Pour supprimer un terme d'une colonne, dans l'onglet Schéma, cliquez sur  à côté du terme.

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

Rechercher des glossaires, des termes et des éléments de données associés

Console

Pour parcourir le contenu de votre glossaire d'entreprise, utilisez l'arborescence du glossaire et des termes sur la page Glossaires.

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Sur la page Glossaires, utilisez la barre de filtres pour trouver des catégories. Les filtres suivants sont disponibles :

    • Nom : renvoie les glossaires, les catégories et les termes dont le nom contient le texte que vous fournissez.
    • Parent : renvoie les termes dont le nom ou la description du glossaire parent correspondent au texte que vous fournissez. Par exemple, parent:Finance renvoie les termes associés au glossaire parent dont le nom ou la description contiennent l'expression Finance.
    • Synonyme : renvoie la liste des termes dont le nom ou l'ID de synonyme contient le texte que vous fournissez. Par exemple, synonym:Profit renvoie les termes qui ont un synonyme dont le nom ou l'ID contient l'expression profit.
    • Contact : renvoie les conditions dans lesquelles le responsable des données est listé comme contact. Par exemple, contact:alex@example.com renvoie les entrées associées à des termes dont le responsable des données correspond à alex@example.com.

REST

Pour trouver des glossaires, des termes et des éléments de données associés à l'aide de l'API REST, vous devez vous inscrire à la version Preview.

Rechercher des éléments de données associés à des termes

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Dataplex Universal Catalog.

    Accéder à Glossaires

  2. Sur la page Glossaires, utilisez la barre de filtres pour saisir une requête de recherche en texte libre. Cela renvoie une liste des correspondances dans les noms de glossaires, de catégories et de termes.

  3. Cliquez sur un terme mis en correspondance.

  4. Sur la page Détails du terme, consultez les termes associés (synonymes et termes associés) et les entrées associées (assets de données) à ce terme.

  5. Si vous souhaitez afficher les détails d'une entrée dans Dataplex Universal Catalog, cliquez dessus.

REST

Pour trouver des glossaires, des termes et des éléments de données associés à l'aide de l'API REST, vous devez vous inscrire à la version Preview.

Pour importer des glossaires et des liens depuis un autre outil de catalogage ou pour mettre à jour vos glossaires dans Dataplex Universal Catalog, vous pouvez importer des glossaires, des catégories, des termes, des liens entre les termes, des liens entre les termes et les éléments de données, ou des colonnes de manière groupée à l'aide de l'API REST.

  1. Créez le glossaire cible.

    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
    )"

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet dans lequel vous créez le glossaire
    • LOCATION_ID : emplacement dans lequel nous souhaitons créer le glossaire
    • GLOSSARY_ID : ID du glossaire
    • DISPLAY_NAME : nom à afficher du glossaire
    • DESCRIPTION : description du glossaire
  2. Pour importer des catégories, des termes et des liens entre les termes et les assets de données dans le glossaire cible créé, importez les fichiers correspondants dans un bucket Cloud Storage. Ces fichiers sont au format suivant :

    • Exemple de format pour les termes et les catégories d'un glossaire

       {"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"}]}}}
       
    • Exemple de format pour les liens entre les termes

       {"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"}]}}
       
    • Exemple de format pour les liens entre les termes et les composants de données

       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
    )"

    Remplacez DATAPLEX_API par le point de terminaison de l'API Dataplex Universal Catalog au format dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  3. Facultatif : Obtenez l'état de l'opération.

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

    Remplacez OPERATION_ID par l'ID de l'opération.

  4. Facultatif : Obtenez l'état du job de métadonnées.

    gcurl -X GET https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/metadataJobs/JOB_ID
  5. Importez des liens entre les termes en tant que synonymes ou termes associés.

    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
    )"

    Remplacez DATAPLEX_API par dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

  6. Importer des liens entre les termes et les composants ou colonnes de données.

    Pour créer un lien entre des termes du glossaire et des composants de données, exécutez le job d'importation pour chaque groupe d'entrées auquel appartient l'entrée du composant de données. Tous les liens vers les entrées de définition sont créés dans ce groupe d'entrées.

    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
    )"

    Remplacez DATAPLEX_API par dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID.

Tarifs

À partir de juillet 2026, le glossaire d'entreprise Dataplex Universal Catalog sera facturé au même prix que le stockage des métadonnées. Consultez les tarifs de stockage des métadonnées Dataplex Universal Catalog.

Étapes suivantes