Gérer un glossaire d'entreprise

Ce document explique comment créer et gérer des glossaires d'entreprise dans Knowledge Catalog (anciennement Dataplex Universal Catalog). Utilisez un glossaire d'entreprise pour établir un vocabulaire standardisé pour vos composants de données. Cela réduit l'ambiguïté et améliore la découverte et la gouvernance des données dans votre organisation.

Cas d'utilisation du glossaire d'entreprise Knowledge Catalog

En créant un langage commun pour les données à l'aide du glossaire d'entreprise Knowledge Catalog, vous pouvez effectuer les opérations suivantes :

  • Définissez une hiérarchie claire des catégories et des termes d'entreprise.
  • Associez des concepts à l'aide de synonymes et montrez les relations entre les termes.
  • Recherchez des ressources de données en fonction de concepts métier, et pas seulement de noms techniques.

Le glossaire d'entreprise de Knowledge Catalog permet de simplifier la découverte des données et de réduire l'ambiguïté, ce qui améliore la gouvernance, la précision des analyses et la rapidité des insights.

É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 d'entreprise. Vous pouvez ajouter des images, des liens et des tableaux. Bien que la mise en forme HTML ne soit pas prise en charge, vous pouvez inclure du code HTML mis en forme en tant que code ou ajouter un lien vers une page HTML. Vous pouvez également utiliser des options de mise en forme de texte enrichi telles que le gras, l'italique, le souligné, les listes à puces, les paragraphes, les titres et les blocs de code. La taille maximale autorisée est de 120 Ko.

  • Description : description du glossaire. Le texte de ce champ est indexé pour la recherche. La taille maximale accepté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 : désigne la personne responsable de la gestion de la catégorie. Cette propriété est descriptive et n'a aucune incidence sur les autorisations associées à 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 au sein 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 éléments de données, ou entre les termes et les colonnes dans les éléments de données.
  • Règles sur la qualité des données. Spécifie les exigences de qualité des données pour le terme. Pour en savoir plus, consultez Réutiliser des règles de qualité des données.
  • Contacts : désigne la personne responsable de la gestion du terme. Les termes 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 des équipes différentes dans des glossaires différents. 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, 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 règles IAM : Administrateur de catalogue Dataplex (roles/dataplex.catalogAdmin)
  • Pour les responsables ou propriétaires des données, accédez à la création, à la modification ou à la suppression des glossaires, des catégories, des termes, des liens entre les termes, des liens entre les termes et les éléments de données, et à la recherche : Éditeur de catalogue Dataplex (roles/dataplex.catalogEditor)
  • Pour les analystes de données 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 assets 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

Vous devez disposer des autorisations suivantes 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, recherchez et supprimez des liens terme à terme de synonymes dans votre projet :
    • dataplex.entryLinks.create sur le groupe d'entrées Knowledge Catalog dans le projet dans lequel se trouve l'un des termes du glossaire. 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 Knowledge Catalog dans le projet dans lequel se trouve l'un des termes du glossaire. 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.glossaryTerms.get sur le terme dont vous recherchez les liens de synonymes. Knowledge Catalog masque les termes synonymes dans la réponse si vous ne disposez pas de l'autorisation dataplex.glossaryTerms.get pour ces termes.
    • dataplex.entryLinks.delete sur le groupe d'entrées Knowledge Catalog dans le projet où le lien est présent.
  • Créez, recherchez et supprimez les liens terme à terme associés dans votre projet :
    • dataplex.entryLinks.create sur le groupe d'entrées Knowledge Catalog dans le projet dans lequel se trouve l'un des termes du glossaire. 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 Knowledge Catalog dans le projet dans lequel se trouve l'un des termes du glossaire. 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 Knowledge Catalog dans les projets dans lesquels des entrées correspondant à des termes de glossaire sont présentes.
    • dataplex.glossaryTerms.get sur le terme dont vous recherchez les liens associés. Knowledge Catalog masque les termes associés dans la réponse si vous ne disposez pas de l'autorisation dataplex.glossaryTerms.get pour ces termes.
    • dataplex.entryLinks.delete sur le groupe d'entrées Knowledge Catalog dans le projet où le lien est présent.
  • Créez, recherchez et supprimez des associations entre des termes et des éléments ou colonnes de données dans 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é.
    • Autorisation de lecture du système source (par exemple, bigquery.tables.get ou dataplex.glossaryTerms.get) sur l'entrée dont vous recherchez les liens. Knowledge Catalog masque les éléments de données dans la réponse si vous ne disposez pas de l'autorisation de lecture du système source pour ces éléments.
    • 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 IAM Knowledge 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 Knowledge 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 son 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, Knowledge 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 du code HTML pour décrire votre catégorie ou votre terme de glossaire.

Afficher les glossaires disponibles

Console

  • Dans la console Google Cloud , accédez à la page Glossaires de Knowledge 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.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour C#.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

using Google.Api.Gax;
using Google.Api.Gax.ResourceNames;
using Google.Cloud.Dataplex.V1;
using System;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for ListGlossaries</summary>
    /// <remarks>
    /// This snippet has been automatically generated and should be regarded as a code template only.
    /// It will require modifications to work:
    /// - It may require correct/in-range values for request initialization.
    /// - It may require specifying regional endpoints when creating the service client as shown in
    ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint.
    /// </remarks>
    public void ListGlossariesRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        ListGlossariesRequest request = new ListGlossariesRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            Filter = "",
            OrderBy = "",
        };
        // Make the request
        PagedEnumerable<ListGlossariesResponse, Glossary> response = businessGlossaryServiceClient.ListGlossaries(request);

        // Iterate over all response items, lazily performing RPCs as required
        foreach (Glossary item in response)
        {
            // Do something with each item
            Console.WriteLine(item);
        }

        // Or iterate over pages (of server-defined size), performing one RPC per page
        foreach (ListGlossariesResponse page in response.AsRawResponses())
        {
            // Do something with each page of items
            Console.WriteLine("A page of results:");
            foreach (Glossary item in page)
            {
                // Do something with each item
                Console.WriteLine(item);
            }
        }

        // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
        int pageSize = 10;
        Page<Glossary> singlePage = response.ReadPage(pageSize);
        // Do something with the page of items
        Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
        foreach (Glossary item in singlePage)
        {
            // Do something with each item
            Console.WriteLine(item);
        }
        // Store the pageToken, for when the next page is required.
        string nextPageToken = singlePage.NextPageToken;
    }
}

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Go.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.


//go:build examples

package main

import (
	"context"

	dataplex "cloud.google.com/go/dataplex/apiv1"
	dataplexpb "cloud.google.com/go/dataplex/apiv1/dataplexpb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := dataplex.NewBusinessGlossaryClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &dataplexpb.ListGlossariesRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#ListGlossariesRequest.
	}
	it := c.ListGlossaries(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*dataplexpb.ListGlossariesResponse)
	}
}

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Java.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

import com.google.cloud.dataplex.v1.BusinessGlossaryServiceClient;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.ListGlossariesRequest;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncListGlossaries {

  public static void main(String[] args) throws Exception {
    syncListGlossaries();
  }

  public static void syncListGlossaries() throws Exception {
    // This snippet has been automatically generated and should be regarded as a code template only.
    // It will require modifications to work:
    // - It may require correct/in-range values for request initialization.
    // - It may require specifying regional endpoints when creating the service client as shown in
    // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    try (BusinessGlossaryServiceClient businessGlossaryServiceClient =
        BusinessGlossaryServiceClient.create()) {
      ListGlossariesRequest request =
          ListGlossariesRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setPageSize(883849137)
              .setPageToken("pageToken873572522")
              .setFilter("filter-1274492040")
              .setOrderBy("orderBy-1207110587")
              .build();
      for (Glossary element : businessGlossaryServiceClient.listGlossaries(request).iterateAll()) {
        // doThingsWith(element);
      }
    }
  }
}

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Node.js.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent, which has this collection of GlossaryTerms.
 *  Format:
 *  projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of GlossaryTerms to return. The service may
 *  return fewer than this value. If unspecified, at most 50 GlossaryTerms will
 *  be returned. The maximum value is 1000; values above 1000 will be coerced
 *  to 1000.
 */
// const pageSize = 1234
/**
 *  Optional. A page token, received from a previous `ListGlossaryTerms` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListGlossaryTerms` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter expression that filters GlossaryTerms listed in the
 *  response. Filters are supported on the following fields:
 *    - immediate_parent
 *  Examples of using a filter are:
 *    -
 *    `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"`
 *    -
 *    `immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"`
 *  This will only return the GlossaryTerms that are directly nested under the
 *  specified parent.
 */
// const filter = 'abc123'
/**
 *  Optional. Order by expression that orders GlossaryTerms listed in the
 *  response. Order by fields are: `name` or `create_time` for the result. If
 *  not specified, the ordering is undefined.
 */
// const orderBy = 'abc123'

// Imports the Dataplex library
const {BusinessGlossaryServiceClient} = require('@google-cloud/dataplex').v1;

// Instantiates a client
const dataplexClient = new BusinessGlossaryServiceClient();

async function callListGlossaryTerms() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = dataplexClient.listGlossaryTermsAsync(request);
  for await (const response of iterable) {
      console.log(response);
  }
}

callListGlossaryTerms();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Python.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import dataplex_v1


def sample_list_glossaries():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.ListGlossariesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_glossaries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby du guide de démarrage rapide de Knowledge Catalog à l'aide des bibliothèques clientes. Pour en savoir plus, consultez la documentation de référence de l'API Knowledge Catalog pour Ruby.

Pour vous authentifier auprès de Knowledge Catalog, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.

require "google/cloud/dataplex/v1"

##
# Snippet for the list_glossaries call in the BusinessGlossaryService service
#
# This snippet has been automatically generated and should be regarded as a code
# template only. It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in https://cloud.google.com/ruby/docs/reference.
#
# This is an auto-generated example demonstrating basic usage of
# Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client#list_glossaries.
#
def list_glossaries
  # Create a client object. The client can be reused for multiple calls.
  client = Google::Cloud::Dataplex::V1::BusinessGlossaryService::Client.new

  # Create a request. To set request fields, pass in keyword arguments.
  request = Google::Cloud::Dataplex::V1::ListGlossariesRequest.new

  # Call the list_glossaries method.
  result = client.list_glossaries request

  # The returned object is of type Gapic::PagedEnumerable. You can iterate
  # over elements, and API calls will be issued to fetch pages as needed.
  result.each do |item|
    # Each element is of type ::Google::Cloud::Dataplex::V1::Glossary.
    p item
  end
end

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 Knowledge 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 Knowledge 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 Knowledge 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, Knowledge 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 du code HTML pour décrire votre catégorie ou votre 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 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/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 d'entreprise 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 Knowledge 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 Knowledge Catalog.

    Accéder à Glossaires

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

  3. Pour afficher les catégories imbriquées d'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 Knowledge Catalog.

    Accéder à Glossaires

  2. Développez le glossaire et 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 Knowledge 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 termes

Les sections suivantes expliquent comment créer, afficher, accéder à un terme, le modifier et le supprimer.

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 Knowledge 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 intendants, les propriétaires ou les propriétaires de domaine de données. Cliquez ensuite sur Enregistrer.

REST

Lorsque vous créez un terme, Knowledge 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 un aperçu à 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 du code HTML pour décrire votre catégorie ou votre 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. Modifiez 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 Knowledge 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 intendants, les propriétaires ou les propriétaires de domaine de données. Cliquez ensuite sur Enregistrer.

REST

Lorsque vous créez un terme, Knowledge 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 un aperçu à 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 du code HTML pour décrire votre catégorie ou votre 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. Modifiez 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

Ajouter un aspect à un terme

Vous pouvez ajouter des aspects aux termes pour fournir du contexte ou des métadonnées supplémentaires.

Console

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

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur le terme auquel vous souhaitez ajouter un aspect.

  3. Dans la section Aspects, cliquez sur Ajouter.

  4. Recherchez l'aspect, fournissez des informations le concernant, puis cliquez sur Enregistrer.

REST

Les termes du glossaire sont des entrées. Pour associer un aspect, corrigez la ressource d'entrée. Le groupe d'entrées pour les glossaires est @dataplex.

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_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
{
 "aspects": {
   "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
     "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
     "data": {
       "sensitivity": "HIGH",
       "data_owner": "achalg@google.com"
     }
   }
 }
}
EOF

Remplacez les éléments suivants :

  • PROJECT_NUMBER : numéro du projet contenant le terme du glossaire.
  • LOCATION_ID : emplacement du terme de glossaire.
  • GLOSSARY_ID : ID du glossaire contenant le terme.
  • TERM_ID : ID du terme auquel associer l'aspect.
  • ASPECT_PROJECT_ID : ID du projet contenant le type d'aspect.
  • ASPECT_LOCATION_ID : emplacement du type d'aspect.
  • ASPECT_TYPE_ID : ID du type d'aspect.

Afficher les termes d'un glossaire ou d'une catégorie

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Knowledge 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 Knowledge 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 Knowledge Catalog.

Ajouter un aspect à un terme

Vous pouvez ajouter des aspects aux termes pour fournir du contexte ou des métadonnées supplémentaires.

Console

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

    Accéder à Glossaires

  2. Développez le glossaire, puis cliquez sur le terme auquel vous souhaitez ajouter un aspect.

  3. Dans la section Aspects, cliquez sur Ajouter.

  4. Recherchez l'aspect, fournissez des informations le concernant, puis cliquez sur Enregistrer.

REST

Les termes du glossaire sont des entrées. Pour associer un aspect, corrigez la ressource d'entrée. Le groupe d'entrées pour les glossaires est @dataplex.

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_NUMBER/locations/LOCATION_ID/entryGroups/@dataplex/entries/projects/PROJECT_NUMBER/locations/LOCATION_ID/glossaries/GLOSSARY_ID/terms/TERM_ID?update_mask=aspects\&aspect_keys=ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID --data @- << EOF
{
 "aspects": {
   "ASPECT_PROJECT_ID.ASPECT_LOCATION_ID.ASPECT_TYPE_ID": {
     "aspect_type": "projects/ASPECT_PROJECT_ID/locations/ASPECT_LOCATION_ID/aspectTypes/ASPECT_TYPE_ID",
     "data": {
       "sensitivity": "HIGH",
       "data_owner": "achalg@google.com"
     }
   }
 }
}
EOF

Remplacez les éléments suivants :

  • PROJECT_NUMBER : numéro du projet contenant le terme du glossaire.
  • LOCATION_ID : emplacement du terme de glossaire.
  • GLOSSARY_ID : ID du glossaire contenant le terme.
  • TERM_ID : ID du terme auquel associer l'aspect.
  • ASPECT_PROJECT_ID : ID du projet contenant le type d'aspect.
  • ASPECT_LOCATION_ID : emplacement du type d'aspect.
  • ASPECT_TYPE_ID : ID du type d'aspect. Accéder à Glossaires
  1. Développez le glossaire et cliquez sur le terme que vous souhaitez modifier.

  2. Cliquez sur Modifier.

  3. 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 Knowledge 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 Knowledge Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis 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 zone géographique 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 zone géographique du glossaire contenant le deuxième terme. Si les deux termes se trouvent au même emplacement, cette valeur est identique à l'ID de zone géographique 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 Knowledge 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 Knowledge Catalog.

    Accéder à Glossaires

  2. Développez le glossaire, puis 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 zone géographique 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 du 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 zone géographique du glossaire contenant le deuxième terme. Si les deux termes se trouvent au même emplacement, cette valeur est identique à l'ID de zone géographique 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 Knowledge Catalog. Le lien d'entrée est la relation entre les termes associés.

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/TERM_PROJECT_ID/locations/SYNONYM_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/synonym&page_size=10

Remplacez les éléments suivants :

  • TERM_PROJECT_ID : ID du projet du terme dont vous recherchez les liens de synonymes.
  • TERM_PROJECT_NUMBER : numéro du projet du terme dont vous recherchez les liens de synonymes.
  • SYNONYM_LINKS_LOCATION_ID : ID de zone géographique pour lequel vous recherchez les liens de synonymes.
  • TERM_LOCATION_ID : ID de zone géographique du terme.
  • TERM_GLOSSARY_ID : ID du glossaire contenant le terme.
  • TERM_ID : ID du terme.

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/TERM_PROJECT_ID/locations/RELATED_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/related&page_size=10

Remplacez les éléments suivants :

  • TERM_PROJECT_ID : ID du projet du terme dont vous recherchez les liens associés.
  • TERM_PROJECT_NUMBER : numéro du projet du terme dont vous recherchez les liens associés.
  • RELATED_LINKS_LOCATION_ID : ID de zone géographique où vous recherchez les liens associés.
  • TERM_LOCATION_ID : ID de zone géographique du terme.
  • TERM_GLOSSARY_ID : ID du glossaire contenant le terme.
  • TERM_ID : ID du terme.

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Knowledge 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 les liens entre les 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

  1. Recherchez les liens d'entrée pour trouver l'ID du lien que vous souhaitez supprimer. Pour en savoir plus, consultez Rechercher les liens de synonymes pour un terme ou Rechercher les liens associés pour un terme.

  2. Supprimez l'association en envoyant la requête DELETE suivante :

    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 éléments de données ou à des colonnes d'éléments de données. Par exemple, vous pouvez associer des termes à des ensembles de données BigQuery et à des tables Iceberg REST Catalog.

Console

  1. Dans la console Google Cloud , accédez à la page Rechercher de Knowledge 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, dans l'onglet Détails, dans la section Termes du glossaire, cliquez sur Ajouter. Recherchez les termes, puis sélectionnez-les. Cliquez ensuite 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 en cours d'association
  • ENTRY_LOCATION_ID : ID de zone géographique 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 du Knowledge Catalog qui représente l'élément 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 Knowledge 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, dans l'onglet Schéma, sélectionnez les colonnes auxquelles vous souhaitez associer le terme.
    • 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<<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",
     "path": "Schema.COLUMN_NAME",
     "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'élément de données auquel le lien est associé
  • ENTRY_LOCATION_ID : ID de zone géographique 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 du Knowledge 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.

Associer un terme à plusieurs ressources ou colonnes de données

Vous pouvez associer un seul terme de glossaire à plusieurs ressources ou colonnes de données à la fois. Vous pouvez sélectionner jusqu'à 20 ressources ou colonnes en une seule opération.

Console

Pour associer un terme à plusieurs ressources, procédez comme suit :

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

    Accéder à Glossaires

  2. Dans la liste Glossaires, développez le glossaire contenant le terme que vous souhaitez associer.

  3. Cliquez sur le terme.

  4. Dans la section Entrées associées, cliquez sur Ajouter .

  5. Dans la boîte de dialogue Associer des entrées, procédez comme suit :

    1. Recherchez les ressources ou les colonnes que vous souhaitez associer. Pour affiner les résultats de recherche, utilisez Filtrer pour effectuer une recherche par nom de ressource, type de ressource ou nom de colonne.

      Par exemple, pour trouver une colonne nommée sample-column dans une table BigQuery nommée sample-table au sein d'un projet dont l'ID est sample-project, utilisez la requête suivante :

      project id:sample-project
      Resource Name:sample-table
      Column Name:sample-column
      

      Vous pouvez saisir des chaînes partielles pour trouver les composants correspondants.

    2. Sélectionnez les composants de données et les colonnes que vous souhaitez joindre.

    3. Pour vérifier vos sélections avant de les ajouter, cliquez sur le bouton Afficher les ressources sélectionnées.

    4. Cliquez sur Ajouter.

  6. Pour vérifier les ressources et les colonnes nouvellement associées, accédez à la section Entrées associées de la page d'informations du terme.

Rechercher des éléments de données associés à un terme

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/TERM_PROJECT_ID/locations/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=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&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=TARGET&page_size=10

Remplacez les éléments suivants :

  • TERM_PROJECT_ID : ID du projet du terme dont vous recherchez les liens de définition.
  • TERM_PROJECT_NUMBER : numéro du projet du terme dont vous recherchez les liens de définition.
  • DEFINITION_LINKS_LOCATION_ID : ID de zone géographique pour lequel vous recherchez les liens de définition.
  • TERM_LOCATION_ID : ID de zone géographique du terme.
  • TERM_GLOSSARY_ID : ID du glossaire contenant le terme.
  • TERM_ID : ID du terme.

Rechercher des termes associés à un élément de données

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/DEFINITION_LINKS_LOCATION_ID:lookupEntryLinks?entry=projects/PROJECT_NUMBER/locations/ENTRY_LOCATION_ID/entryGroups/ENTRY_GROUP_ID/entries/ENTRY_ID&entry_link_types=projects/dataplex-types/locations/global/entryLinkTypes/definition&entry_mode=SOURCE&page_size=10

Remplacez les éléments suivants :

  • PROJECT_ID : ID du projet de l'asset de données dont vous recherchez les liens de définition.
  • PROJECT_NUMBER : numéro de projet du composant de données dont vous recherchez les liens de définition.
  • DEFINITION_LINKS_LOCATION_ID : ID de zone géographique pour lequel vous recherchez les liens de définition.
  • ENTRY_LOCATION_ID : ID de l'emplacement du composant de données.
  • ENTRY_GROUP_ID : ID du groupe d'entrées pour l'élément de données.
  • ENTRY_ID : ID de l'élément de données.

Console

  1. Dans la console Google Cloud , accédez à la page Rechercher de Knowledge 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 sur le terme dans la section Termes du glossaire de l'onglet Détails, puis sur .
    • Pour supprimer un terme d'une colonne, cliquez sur  à côté du terme dans l'onglet Schéma.

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 des glossaires et des termes sur la page Glossaires.

  1. Dans la console Google Cloud , accédez à la page Glossaires de Knowledge 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 comportant un synonyme dont le nom ou l'ID contient le texte que vous fournissez. Par exemple, synonym:Profit renvoie les termes comportant un synonyme dont le nom ou l'ID contient l'expression profit.
    • Contact : renvoie les termes pour lesquels l'intendant des données est répertorié comme contact. Par exemple, contact:alex@example.com renvoie les entrées associées à des termes dont l'intendant 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 à l'aperçu.

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

Console

  1. Dans la console Google Cloud , accédez à la page Glossaires de Knowledge 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 (composants de données) à ce terme.

  5. Pour afficher les détails d'une entrée dans Knowledge 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 à l'aperçu.

Importer des glossaires et des liens entre les termes et les termes ou les composants de données

Pour importer des glossaires et des liens depuis un autre outil de catalogage ou pour mettre à jour vos glossaires dans Knowledge Catalog, vous pouvez importer des glossaires, des catégories, des termes, des liens entre les termes, des liens entre les termes et les assets 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 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. Importer 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. Importez des liens entre les termes et les éléments ou colonnes de données.

    Pour créer un lien entre les termes du glossaire et les éléments de données, exécutez le job d'importation pour chaque groupe d'entrées auquel appartient l'entrée de l'élément de données. Tous les liens d'entrée 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 Knowledge Catalog sera facturé au même prix que le stockage de métadonnées. Consultez les tarifs de stockage des métadonnées Knowledge Catalog.

Étapes suivantes