Utilizzare i pacchetti JavaScript

Questo documento mostra come:

Prima di iniziare

  1. Nella console Google Cloud , vai alla pagina Dataform.

    Vai a Dataform

  2. Esegui una o entrambe le seguenti operazioni:

    1. Per installare un pacchetto in un repository o autenticare un pacchetto NPM privato per abilitarne l'installazione, segui questi passaggi:
      1. Seleziona o crea un repository.
      2. Seleziona o crea un workspace di sviluppo.
      3. (Facoltativo) Per installare un pacchetto privato, autentica il pacchetto privato.
      4. Se il repository non contiene un file package.json, crea package.json e sposta il pacchetto principale Dataform.
    2. Per creare un pacchetto:
      1. Crea un repository Dataform dedicato al tuo pacchetto. Fai in modo che il nome del repository corrisponda al nome del tuo pacchetto.
      2. Collega il repository a un repository Git di terze parti che ospiterà il pacchetto.
      3. Crea e inizializza un workspace nel repository Dataform.

  3. Assicurati di disporre delle autorizzazioni necessarie per completare le attività descritte in questo documento.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per completare le attività descritte in questo documento, chiedi all'amministratore di concederti i seguenti ruoli IAM:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Installare un pacchetto

Questa sezione mostra come installare un pacchetto JavaScript e importarlo in un file JavaScript e in un file SQLX in modo da poter utilizzare il pacchetto per sviluppare workflow in Dataform.

Per utilizzare un pacchetto in Dataform, devi installarlo nel repository.

Puoi installare i seguenti tipi di pacchetti in Dataform:

Poi, per utilizzare il pacchetto in un file JavaScript o SQLX, devi importare i contenuti selezionati del pacchetto nel file. Puoi anche importare un intero pacchetto in un file JavaScript o SQLX anziché nei relativi contenuti selezionati.

Per evitare problemi con l'installazione dei pacchetti nell'ambiente di produzione, ti consigliamo di procedere nel seguente modo:

  • Specifica esplicitamente la versione del pacchetto in package.json, ad esempio 3.0.0. Non utilizzare altre opzioni di dependencies di package.json, ad esempio >version.

  • Testare le nuove versioni dei pacchetti in un ambiente non di produzione. Per saperne di più sulla configurazione di diversi ambienti del ciclo di vita del flusso di lavoro, consulta Best practice per il ciclo di vita del flusso di lavoro.

Aggiungere un pacchetto come dipendenza

Per installare un pacchetto all'interno di un repository Dataform, devi aggiungerlo come dipendenza nel file package.json:

  1. Nel workspace, nel riquadro File, seleziona package.json.

  2. Aggiungi il pacchetto al blocco dependencies:

    1. Aggiungi un pacchetto NPM pubblico pubblicato nel seguente formato:

      "PACKAGE-NAME": "PACKAGE-VERSION"

      Sostituisci quanto segue:

      • PACKAGE-NAME con il nome del pacchetto.
      • PACKAGE-VERSION con l'ultima versione del pacchetto NPM pubblico pubblicato. Per evitare problemi con l'installazione del pacchetto, specifica esplicitamente la versione, ad esempio 3.0.0.

    2. Aggiungi un pacchetto NPM pubblico non pubblicato nel seguente formato:

      "PACKAGE-NAME": "PACKAGE-URL"

      Sostituisci quanto segue: