Gérer un glossaire d'entreprise

Les glossaires d'entreprise dans Knowledge Catalog (anciennement Dataplex Universal Catalog) vous permettent d'établir un vocabulaire standardisé pour vos éléments de données dans l'ensemble de votre organisation. Vous pouvez créer et gérer des catégories et des termes pour réduire l'ambiguïté, et améliorer la découverte et la gouvernance des données. Si vous créez un glossaire d'entreprise pour la première fois, consultez le guide de démarrage rapide Créer et utiliser un glossaire d'entreprise.

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 :

• Définissez une hiérarchie claire des catégories d'activité et des termes.
• 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 Knowledge Catalog permet de simplifier la découverte des données et de réduire l'ambiguïté, ce qui se traduit par une meilleure gouvernance, une analyse plus précise 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 d'entreprise. Vous pouvez ajouter des images, des liens et des tableaux. Bien que la mise en forme HTML ne soit pas acceptée, 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 enrichie telles que le gras, l'italique, le soulignement, les listes à puces, les paragraphes, les titres et les blocs de code. La taille maximale autorisé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 où 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. Il s'agit d'une propriété descriptive qui 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 du 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 qui décrit 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 des termes qui sont conceptuellement liés les uns aux autres, mais qui ont des significations différentes. Consultez 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 des é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 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 une é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".

Termes associés

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

Limites

• Les glossaires d'entreprise sont hébergés dans des projets et des emplacements. Les limites pour les projets et les emplacements s'appliquent aux glossaires.
• Lorsque vous utilisez un glossaire d'entreprise avec un agent de données BigQuery, celui-ci peut importer un maximum de 10 termes du glossaire par table. Si vous associez plus de 10 termes à une table, l'agent de données ignore les termes supplémentaires. Pour des performances optimales de l'agent de données, veillez également à fournir des descriptions complètes au niveau des tables et des colonnes de vos tables.

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, obtenir un accès complet aux glossaires, catégories, termes, synonymes et termes associés, et définir des stratégies IAM : Administrateur de catalogue Dataplex (roles/dataplex.catalogAdmin)
• Pour les intendants des données ou les propriétaires de données, accédez à la création, à la modification ou à la suppression de glossaires, de catégories, de termes, de liens entre les termes, de 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, catégories, termes, 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

Vous devez disposer des autorisations suivantes pour créer et gérer des glossaires :

• Créer, lire, mettre à jour et supprimer 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 de synonymes terme à terme dans votre projet :
  • dataplex.entryLinks.create sur le groupe d'entrées Knowledge Catalog dans le projet où 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 Knowledge Catalog dans le projet où 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.glossaryTerms.get sur le terme dont vous recherchez les liens de synonymes. Knowledge Catalog masque les 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ù se trouve le lien.
• Créez, recherchez et supprimez des liens de terme à terme associés dans votre projet :
  • dataplex.entryLinks.create sur le groupe d'entrées Knowledge Catalog dans le projet où 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 Knowledge Catalog dans le projet où 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 Knowledge Catalog dans les projets où 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ù se trouve le lien.
• Créez, recherchez et supprimez des liens entre les termes et les éléments de données ou les colonnes 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é.
  • 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. Lorsque vous créez des glossaires, des catégories ou des termes d'entreprise, assurez-vous que leurs ID respectent les consignes de dénomination des ressources Knowledge Catalog.

Remarque : Demander des modifications de métadonnées pour les glossaires d'entreprise et les entrées Knowledge Catalog avec des workflows de gouvernance est disponible en version preview privée. Pour demander l'accès à la fonctionnalité, remplissez le formulaire d'accès.

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 l'emplacement.

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

5. Facultatif : ajoutez une description courte dans le champ Description (jusqu'à 1 024 caractères) ou une description longue dans le champ Présentation (jusqu'à 120 Ko).

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le 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.ResourceNames;
using Google.Cloud.Dataplex.V1;
using Google.LongRunning;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for CreateGlossary</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 CreateGlossaryRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        CreateGlossaryRequest request = new CreateGlossaryRequest
        {
            ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
            GlossaryId = "",
            Glossary = new Glossary(),
            ValidateOnly = false,
        };
        // Make the request
        Operation<Glossary, OperationMetadata> response = businessGlossaryServiceClient.CreateGlossary(request);

        // Poll until the returned long-running operation is complete
        Operation<Glossary, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Glossary result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Glossary, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceCreateGlossary(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Glossary retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le 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"
)

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.CreateGlossaryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#CreateGlossaryRequest.
	}
	op, err := c.CreateGlossary(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	resp, err := op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le 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.CreateGlossaryRequest;
import com.google.cloud.dataplex.v1.Glossary;
import com.google.cloud.dataplex.v1.LocationName;

public class SyncCreateGlossary {

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

  public static void syncCreateGlossary() 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()) {
      CreateGlossaryRequest request =
          CreateGlossaryRequest.newBuilder()
              .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
              .setGlossaryId("glossaryId1849967577")
              .setGlossary(Glossary.newBuilder().build())
              .setValidateOnly(true)
              .build();
      Glossary response = businessGlossaryServiceClient.createGlossaryAsync(request).get();
    }
  }
}

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le 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 resource where this Glossary will be created.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Required. Glossary ID: Glossary identifier.
 */
// const glossaryId = 'abc123'
/**
 *  Required. The Glossary to create.
 */
// const glossary = {}
/**
 *  Optional. Validates the request without actually creating the Glossary.
 *  Default: false.
 */
// const validateOnly = true

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

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

async function callCreateGlossary() {
  // Construct request
  const request = {
    parent,
    glossaryId,
    glossary,
  };

  // Run request
  const [operation] = await dataplexClient.createGlossary(request);
  const [response] = await operation.promise();
  console.log(response);
}

callCreateGlossary();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le 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_create_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.CreateGlossaryRequest(
        parent="parent_value",
        glossary_id="glossary_id_value",
    )

    # Make the request
    operation = client.create_glossary(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le 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 create_glossary 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#create_glossary.
#
def create_glossary
  # 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::CreateGlossaryRequest.new

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

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

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 où vous souhaitez créer le glossaire
   • GLOSSARY_ID : ID du glossaire
   • DISPLAY_NAME : nom à afficher du glossaire
   • DESCRIPTION : description du glossaire, d'une longueur maximale de 1 024 caractères

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 est 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 la catégorie ou le terme de votre 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# décrites dans le 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 décrites dans le 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 décrites dans le 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 décrites dans le 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 Glossaries.
 *  Format: projects/{project_id_or_number}/locations/{location_id}
 *  where `location_id` refers to a Google Cloud region.
 */
// const parent = 'abc123'
/**
 *  Optional. The maximum number of Glossaries to return. The service may
 *  return fewer than this value. If unspecified, at most 50 Glossaries 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 `ListGlossaries` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListGlossaries` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. Filter expression that filters Glossaries listed in the response.
 *  Filters on proto fields of Glossary are supported.
 *  Examples of using a filter are:
 *    - `display_name="my-glossary"`
 *    - `categoryCount=1`
 *    - `termCount=0`
 */
// const filter = 'abc123'
/**
 *  Optional. Order by expression that orders Glossaries 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 callListGlossaries() {
  // Construct request
  const request = {
    parent,
  };

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

callListGlossaries();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le 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 décrites dans le 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 effectuez vos modifications.

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 qu'il contient.

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é.

C#

C#

Avant d'essayer cet exemple, suivez les instructions de configuration pour C# décrites dans le 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.Cloud.Dataplex.V1;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;

public sealed partial class GeneratedBusinessGlossaryServiceClientSnippets
{
    /// <summary>Snippet for DeleteGlossary</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 DeleteGlossaryRequestObject()
    {
        // Create client
        BusinessGlossaryServiceClient businessGlossaryServiceClient = BusinessGlossaryServiceClient.Create();
        // Initialize request argument(s)
        DeleteGlossaryRequest request = new DeleteGlossaryRequest
        {
            GlossaryName = GlossaryName.FromProjectLocationGlossary("[PROJECT]", "[LOCATION]", "[GLOSSARY]"),
            Etag = "",
        };
        // Make the request
        Operation<Empty, OperationMetadata> response = businessGlossaryServiceClient.DeleteGlossary(request);

        // Poll until the returned long-running operation is complete
        Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
        // Retrieve the operation result
        Empty result = completedResponse.Result;

        // Or get the name of the operation
        string operationName = response.Name;
        // This name can be stored, then the long-running operation retrieved later by name
        Operation<Empty, OperationMetadata> retrievedResponse = businessGlossaryServiceClient.PollOnceDeleteGlossary(operationName);
        // Check if the retrieved long-running operation has completed
        if (retrievedResponse.IsCompleted)
        {
            // If it has completed, then access the result
            Empty retrievedResult = retrievedResponse.Result;
        }
    }
}

Go

Go

Avant d'essayer cet exemple, suivez les instructions de configuration pour Go décrites dans le 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"
)

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.DeleteGlossaryRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/dataplex/apiv1/dataplexpb#DeleteGlossaryRequest.
	}
	op, err := c.DeleteGlossary(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}

	err = op.Wait(ctx)
	if err != nil {
		// TODO: Handle error.
	}
}

Java

Java

Avant d'essayer cet exemple, suivez les instructions de configuration pour Java décrites dans le 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.DeleteGlossaryRequest;
import com.google.cloud.dataplex.v1.GlossaryName;
import com.google.protobuf.Empty;

public class SyncDeleteGlossary {

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

  public static void syncDeleteGlossary() 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()) {
      DeleteGlossaryRequest request =
          DeleteGlossaryRequest.newBuilder()
              .setName(GlossaryName.of("[PROJECT]", "[LOCATION]", "[GLOSSARY]").toString())
              .setEtag("etag3123477")
              .build();
      businessGlossaryServiceClient.deleteGlossaryAsync(request).get();
    }
  }
}

Node.js

Node.js

Avant d'essayer cet exemple, suivez les instructions de configuration pour Node.js décrites dans le 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 name of the Glossary to delete.
 *  Format:
 *  projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
 */
// const name = 'abc123'
/**
 *  Optional. The etag of the Glossary.
 *  If this is provided, it must match the server's etag.
 *  If the etag is provided and does not match the server-computed etag,
 *  the request must fail with a ABORTED error code.
 */
// const etag = 'abc123'

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

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

async function callDeleteGlossary() {
  // Construct request
  const request = {
    name,
  };

  // Run request
  const [operation] = await dataplexClient.deleteGlossary(request);
  const [response] = await operation.promise();
  console.log(response);
}

callDeleteGlossary();

Python

Python

Avant d'essayer cet exemple, suivez les instructions de configuration pour Python décrites dans le 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_delete_glossary():
    # Create a client
    client = dataplex_v1.BusinessGlossaryServiceClient()

    # Initialize request argument(s)
    request = dataplex_v1.DeleteGlossaryRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_glossary(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Ruby

Ruby

Avant d'essayer cet exemple, suivez les instructions de configuration pour Ruby décrites dans le 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 delete_glossary 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#delete_glossary.
#
def delete_glossary
  # 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::DeleteGlossaryRequest.new

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

  # The returned object is of type Gapic::Operation. You can use it to
  # check the status of an operation, cancel it, or wait for results.
  # Here is how to wait for a response.
  result.wait_until_done! timeout: 60
  if result.response?
    p result.response
  else
    puts "No response received."
  end
end

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 description courte dans le champ Description (jusqu'à 1 024 caractères) ou une description longue dans le champ Présentation (jusqu'à 120 Ko).

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 un aperçu à 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 la catégorie ou le terme de votre glossaire.

3. Facultatif : Ajouter 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 d'entreprise peut comporter jusqu'à trois niveaux de catégories imbriquées, à l'exclusion du niveau du glossaire racine.

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 description courte dans le champ Description (jusqu'à 1 024 caractères) ou une description longue dans le champ Présentation (jusqu'à 120 Ko).

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 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 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 vos modifications.

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 à des termes, les modifier et les supprimer.

Créer un terme dans un glossaire d'entreprise

Un glossaire d'entreprise peut contenir 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 description courte dans le champ Description (jusqu'à 1 024 caractères) ou une description longue dans le champ Présentation (jusqu'à 120 Ko).

6. Facultatif : Pour ajouter des contacts, cliquez sur Modifier, puis fournissez une liste d'adresses e-mail pour les intendants des données, les propriétaires de données ou les propriétaires de domaines 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 au 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 du code HTML pour décrire la catégorie ou le terme de votre 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 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 description courte dans le champ Description (jusqu'à 1 024 caractères) ou une description longue dans le champ Présentation (jusqu'à 120 Ko).

6. Facultatif : Pour ajouter des contacts, cliquez sur Modifier, puis fournissez une liste d'adresses e-mail pour les intendants des données, les propriétaires de données ou les propriétaires de domaines 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éer 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 au 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 du code HTML pour décrire la catégorie ou le terme de votre 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

Ajouter un aspect à un terme

Vous pouvez ajouter des aspects aux termes pour fournir un 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 détails sur l'aspect, puis cliquez sur Enregistrer.

REST

Les termes du glossaire sont des entrées. Pour associer un aspect, appliquez un correctif à 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": "[e-mail]"
     }
   }
 }
}
EOF

Remplacez les éléments suivants :

• PROJECT_NUMBER : numéro du projet contenant le terme du glossaire.
• LOCATION_ID : emplacement du terme du 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 son nom, sa 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, la présentation, les contacts et le parent d'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 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 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

Gérer les synonymes et les termes associés

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.

Créer des liens de synonymie entre les termes

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 Synonymes.

4. Recherchez, puis sélectionnez les conditions à associer.

   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 de projet du deuxième terme que vous souhaitez associer en tant que 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 zone géographique du premier terme.
• TERM2_GLOSSARY_ID : ID du glossaire contenant le deuxième terme. Si les deux termes se trouvent 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é par une entrée Knowledge Catalog. Le lien d'entrée est la relation entre les termes synonymes.

Créer des liens associés entre les termes

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, puis sélectionnez les conditions à associer.

   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 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 zone géographique du premier terme.
• TERM2_GLOSSARY_ID : ID du glossaire contenant le deuxième terme. Si les deux termes se trouvent 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é par une entrée Knowledge Catalog. Le lien d'entrée est la relation entre les termes associés.

Rechercher les liens de synonymes d'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/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 où 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.

Remarque : Pour récupérer les pages suivantes, ajoutez &page_token=PAGE_TOKEN à la requête. Remplacez PAGE_TOKEN par la valeur du jeton de page que vous avez reçue de la réponse lookupEntryLinks précédente.

Rechercher des liens 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/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.

Remarque : Pour récupérer les pages suivantes, ajoutez &page_token=PAGE_TOKEN à la requête. Remplacez PAGE_TOKEN par la valeur du jeton de page que vous avez reçue de la réponse lookupEntryLinks précédente.

Supprimer les liens entre les synonymes et les termes associés

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 les liens entre les synonymes, cliquez sur Modifier à côté de Synonymes. Supprimez les synonymes, puis cliquez sur Fermer.

REST

1. Recherchez les liens d'entrée pour trouver l'ID d'association du lien que vous souhaitez supprimer. Pour en savoir plus, consultez Rechercher des liens de synonymes pour un terme ou Rechercher des 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

Gérer les liens entre les termes et les éléments de données

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 de catalogue REST Iceberg.

Associer des termes à un é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 l'élément de données (un ensemble de données, un fichier ou une table, 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 asset, 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 l'élément 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.

Python

from google.cloud import dataplex_v1

def attach_term_to_asset(
    project_id: str,
    location: str,
    entry_group_id: str,
    entry_link_id: str,
    source_entry_name: str,
    target_term_name: str,
) -> dataplex_v1.EntryLink:
    """Creates an entry link attaching a glossary term to a data asset."""
    client = dataplex_v1.CatalogServiceClient()
    parent_group = (
        f"projects/{project_id}/locations/{location}/"
        f"entryGroups/{entry_group_id}"
    )

    entry_link = dataplex_v1.EntryLink(
        entry_link_type=(
            "projects/dataplex-types/locations/global/"
            "entryLinkTypes/definition"
        ),
        entry_references=[
            dataplex_v1.EntryLink.EntryReference(
                name=source_entry_name, type_="SOURCE"
            ),
            dataplex_v1.EntryLink.EntryReference(
                name=target_term_name, type_="TARGET"
            ),
        ],
    )

    return client.create_entry_link(
        parent=parent_group,
        entry_link_id=entry_link_id,
        entry_link=entry_link,
    )

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'élément de données associé
• ENTRY_LOCATION_ID : ID de zone géographique de l'élément de données associé
• ENTRY_GROUP_ID : groupe d'entrées de l'élément de données associé
• ENTRY_LINK_ID : ID du lien entre le terme et l'entrée 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 l'élément de données (un ensemble de données, un fichier ou une table, par exemple) dont le schéma comporte une colonne à laquelle vous souhaitez associer un terme. Cliquez sur l'élément 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'élément 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<<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 associé
• ENTRY_LOCATION_ID : ID de zone géographique de l'élément de données associé
• ENTRY_GROUP_ID : groupe d'entrées de l'élément de données associé
• ENTRY_LINK_ID : ID du lien entre le terme et l'entrée Knowledge Catalog qui représente l'élément 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 éléments ou colonnes de données

Vous pouvez associer un même terme de glossaire à plusieurs éléments ou colonnes de données simultanément. 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 associées, procédez comme suit :

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

      Par exemple, pour rechercher 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 éléments correspondants.

   2. Sélectionnez les éléments de données et les colonnes que vous souhaitez associer.

   3. Pour examiner 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 de projet du terme dont vous recherchez les liens de définition.
• DEFINITION_LINKS_LOCATION_ID : ID de zone géographique où 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.

Remarque : Les colonnes associées au terme sont renvoyées dans le champ path.

Pour récupérer les pages suivantes, ajoutez &page_token=PAGE_TOKEN à la requête. Remplacez PAGE_TOKEN par la valeur du jeton de page que vous avez reçue de la réponse lookupEntryLinks précédente.

Rechercher des termes associés à un asset 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'élément de données dont vous recherchez les liens de définition.
• PROJECT_NUMBER : numéro du projet de l'élément de données dont vous recherchez les liens de définition.
• DEFINITION_LINKS_LOCATION_ID : ID de zone géographique où vous recherchez les liens de définition.
• ENTRY_LOCATION_ID : ID de l'emplacement de l'élément 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.

Remarque : Les colonnes associées au terme dans un élément de données sont renvoyées dans le champ path.

Pour récupérer les pages suivantes, ajoutez &page_token=PAGE_TOKEN à la requête. Remplacez PAGE_TOKEN par la valeur du jeton de page que vous avez reçue de la réponse lookupEntryLinks précédente.

Supprimer des termes d'un é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 l'élément de données (par exemple, un ensemble de données, un fichier ou une table) dont vous souhaitez supprimer les termes, 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 élément, dans l'onglet Détails, dans la section Termes du glossaire, cliquez sur le terme. Cliquez ensuite 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 filtre 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 correspond 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 qui ont un synonyme dont le nom ou l'ID contient l'expression profit.
   • Contact : renvoie les termes pour lesquels l'intendant des données est listé comme contact. Par exemple, contact:[e-mail] renvoie les entrées associées à des termes dont l'intendance des données correspond à [e-mail].

REST

Pour rechercher 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 Knowledge Catalog.

   Accéder à Glossaires

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

3. Cliquez sur un terme correspondant.

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

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

REST

Pour rechercher 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.

Importer des glossaires et des liens entre des termes et des termes ou des éléments 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 de manière groupée 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, à 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 voulons 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 éléments de données dans le glossaire cible créé, importez des fichiers pour chacun d'eux 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 éléments 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 de données ou les colonnes.

   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.

   Remarque : Assurez-vous que le fichier d'importation dans le bucket Cloud Storage contient un fichier pour les liens d'un groupe d'entrées. Pour créer un lien entre un terme et une entrée pour l'élément de données dans un autre groupe d'entrées, fournissez un nouveau fichier dans le bucket Cloud Storage.

   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 2025, le glossaire d'entreprise Knowledge Catalog sera facturé au même tarif que le stockage des métadonnées. Consultez les tarifs applicables au stockage de métadonnées Knowledge Catalog.

Étapes suivantes

• Découvrez comment établir un contexte de données de base.