Utiliser des packages JavaScript

Ce document vous explique comment :

Avant de commencer

  1. Dans la console Google Cloud , accédez à la page Dataform.

    Accéder à Dataform

  2. Effectuez l'une des opérations suivantes ou les deux :

    1. Pour installer un package dans un dépôt ou authentifier un package NPM privé afin de permettre son installation, procédez comme suit :
      1. Sélectionnez ou créez un dépôt.
      2. Sélectionnez ou créez un espace de travail de développement.
      3. Facultatif : Pour installer un package privé, authentifiez-le.
      4. Si votre dépôt ne contient pas de fichier package.json, créez package.json et déplacez le package Dataform Core.
    2. Pour créer un package, procédez comme suit :
      1. Créez un dépôt Dataform dédié à votre package. Faites correspondre le nom du dépôt à celui de votre package.
      2. Connectez le dépôt à un dépôt Git tiers qui hébergera votre package.
      3. Créez et initialisez un espace de travail dans le dépôt Dataform.

  3. Assurez-vous de disposer des autorisations nécessaires pour effectuer les tâches décrites dans ce document.

Rôles requis

Pour obtenir les autorisations nécessaires pour effectuer les tâches décrites dans ce document, demandez à votre administrateur de vous accorder les rôles IAM suivants :

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

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

Installer un package

Cette section vous explique comment installer un package JavaScript et l'importer dans un fichier JavaScript et un fichier SQLX afin de pouvoir utiliser le package pour développer des workflows dans Dataform.

Pour utiliser un package dans Dataform, vous devez l'installer dans votre dépôt.

Vous pouvez installer les types de packages suivants dans Dataform :

Ensuite, pour utiliser le package dans un fichier JavaScript ou SQLX, vous devez importer le contenu sélectionné du package dans le fichier. Vous pouvez également importer un package entier dans un fichier JavaScript ou SQLX au lieu de son contenu sélectionné.

Pour éviter tout problème d'installation de packages dans votre environnement de production, nous vous recommandons de procéder comme suit :

  • Spécifiez explicitement la version du package dans package.json, par exemple 3.0.0. N'utilisez pas d'autres options dependencies de package.json, par exemple >version.

  • Testez les nouvelles versions de package dans un environnement hors production. Pour en savoir plus sur la configuration de différents environnements de cycle de vie de workflow, consultez Bonnes pratiques pour le cycle de vie des workflows.

Ajouter un package en tant que dépendance

Pour installer un package dans un dépôt Dataform, vous devez l'ajouter en tant que dépendance dans le fichier package.json :

  1. Dans votre espace de travail, dans le volet Fichiers, sélectionnez package.json.

  2. Ajoutez le package au bloc dependencies :

    1. Ajoutez un package NPM public publié au format suivant :

      "PACKAGE-NAME": "PACKAGE-VERSION"

      Remplacez les éléments suivants :

      • PACKAGE-NAME par le nom du package.
      • PACKAGE-VERSION avec la dernière version du package NPM public publié. Pour éviter les problèmes d'installation des packages, spécifiez explicitement la version, par exemple 3.0.0.

    2. Ajoutez un package NPM public non publié au format suivant :

      "PACKAGE-NAME": "PACKAGE-URL"

      Remplacez les éléments suivants :

      • PACKAGE-NAME par le nom du package.
      • PACKAGE-URL par l'URL tar.gz du dépôt de packages tiers, par exemple https://github.com/user/sample-package-repository/archive/master.tar.gz.

    3. Ajoutez un package NPM privé authentifié au format suivant :

      "REGISTRY-SCOPE/PACKAGE-NAME": "PACKAGE-URL"

      Remplacez les éléments suivants :

      • REGISTRY-SCOPE par le nom du package. REGISTRY-SCOPE doit correspondre au champ d'application du registre défini dans le fichier .npmrc de votre dépôt.
      • PACKAGE-NAME par le nom du package.
      • PACKAGE-URL par l'URL tar.gz du dépôt de packages, par exemple https://github.com/user/sample-package-repository/archive/master.tar.gz.

  3. Cliquez sur Installer les packages.

  4. Validez et transférez vos modifications.

L'exemple de code suivant montre le package de dimensions à évolution lente open source public ajouté au fichier .package.json :

 ```json
 {
   "name": "repository-name",
   "dependencies": {
     "@dataform/core": "2.0.3",