Gestire il pacchetto principale Dataform

Questo documento mostra come gestire il framework di base di Dataform pacchetto delle dipendenze e aggiornarlo alla versione più recente.

Il core Dataform è il framework Dataform open source per sviluppare flussi di lavoro SQL con SQL, SQLX e JavaScript. Come best practice, usare sempre l'ultima versione disponibile del framework di base Dataform. Per informazioni sulle release del framework di base Dataform, consulta le Release di Dataform su GitHub.

Prima di iniziare

  1. Crea un repository.
  2. Crea e inizializza un'area di lavoro di sviluppo.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per gestire e aggiornare Dataform core: chiedi all'amministratore di concederti seguenti ruoli IAM:

  • Gestisci la posizione del pacchetto principale Dataform: Amministratore Dataform (roles/dataform.admin) nei repository
  • Aggiorna il pacchetto principale di Dataform: Editor Dataform (roles/dataform.editor) nelle aree di lavoro

Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso.

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

Gestisci la località del pacchetto principale Dataform

Quando inizializza la prima area di lavoro in un repository, Dataform imposta automaticamente il core Dataform come pacchetto di dipendenze. A partire dal core Dataform 3.0.0, Dataform installa il pacchetto principale Dataform nel workflow_settings.yaml per impostazione predefinita. Nelle versioni precedenti di Il core Dataform è stato impostato in il file package.json.

Nel core Dataform 3.0.0 e versioni successive, se il core Dataform è pacchetti nel repository, allora dovresti impostarlo in il file workflow_settings.yaml. Per i repository creati con versioni precedenti delle versioni core Dataform, spostare il pacchetto principale Dataform in workflow_settings.yaml.

Il file package.json è per installare pacchetti aggiuntivi in Dataform. Se il repository utilizza pacchetti aggiuntivi, imposta il valore Pacchetto Dataform principale in package.json, quindi tutti i pacchetti sono impostati in un unico posto. Se il repository non ha package.json, crea package.json e sposta il pacchetto principale Dataform per installare pacchetti aggiuntivi.

Sposta il core Dataform in workflow_settings.yaml

Per i repository creati con versioni del core Dataform precedenti al 3.0.0, se non hai pacchetti di dipendenze diversi dal core Dataform, devi spostare il pacchetto Dataform principale da package.json a workflow_settings.yaml ed elimina i file ridondanti package.json file.

Per eseguire la migrazione del pacchetto principale Dataform da package.json a workflow_settings.yaml, procedi nel seguente modo:

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

    Vai alla pagina Dataform

  2. Seleziona un repository, quindi seleziona un'area di lavoro.

  3. Nel riquadro File, seleziona il file workflow_settings.yaml.

  4. Nel file workflow_settings.yaml, aggiungi il core Dataform nel seguente formato:

    dataformCoreVersion: "VERSION"
    
    

    Sostituisci VERSION con la versione più recente di Dataform, ad esempio 3.0.0.

  5. Nel riquadro File, fai clic sul menu Altro accanto a package.json, e fai clic su Elimina.

  6. Per confermare l'eliminazione di dataform.json, fai clic su Elimina.

  7. Fai clic su Installa pacchetti.

Sposta il core Dataform in package.json

Il file package.json è obbligatorio per installare pacchetti aggiuntivi in un repository. Se il repository utilizza pacchetti aggiuntivi, devi archiviare tutti i pacchetti, incluso il pacchetto principale Dataform in package.json.

Se il repository non contiene il file package.json perché Il pacchetto principale Dataform è impostato nel workflow_settings.yaml, devi creare package.json per installare pacchetti aggiuntivi, quindi sposterai il core Dataform pacchetto da workflow_settings.yaml al nuovo package.json.

Per creare il file package.json e spostare Per il pacchetto Dataform principale:

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

    Vai alla pagina Dataform

  2. Seleziona un repository, quindi seleziona un'area di lavoro.

  3. Nel riquadro File, fai clic su addAdd, e fai clic su Crea file.

  4. Nel campo Aggiungi un percorso file, inserisci package.json.

  5. Fai clic su Crea file.

  6. Nel file package.json, aggiungi il core Dataform nel seguente formato:

    {
        "dependencies": {
            "@dataform/core": "VERSION"
        }
    }
    

    Sostituisci VERSION con la versione più recente di Dataform, ad esempio 3.0.0.

  7. Fai clic su Installa pacchetti.

  8. Nel riquadro File, seleziona workflow_settings.yaml.

  9. Nel file workflow_settings.yaml, elimina proprietà dataformCoreVersion.

Aggiorna core Dataform

Testa sempre le nuove versioni dei pacchetti in un ambiente non di produzione prima il deployment nel tuo ambiente di produzione.

Per aggiornare il pacchetto di dipendenze principale di Dataform, segui questi passaggi:

  1. Cerca l'ultima versione di @dataform/core sul Pagina delle release di Dataform su GitHub.

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

    Vai alla pagina Dataform

  3. Seleziona un repository, quindi seleziona un'area di lavoro.

  4. Nel riquadro File, seleziona il file package.json o la workflow_settings.yaml file.

    La località in cui è impostato il pacchetto di dipendenze principale di Dataform dipende dalla versione del core Dataform e dall'utilizzo dei pacchetti. Per ulteriori informazioni, vedi Gestisci la località del pacchetto principale Dataform.

  5. Aggiorna il pacchetto di dipendenze principale di Dataform con l'ultima versione versione:

    package.json

    {
        "dependencies": {
            "@dataform/core": "VERSION"
        }
    }
    

    Sostituisci VERSION con la versione più recente di Dataform, ad esempio 3.0.0. Per evitare problemi con l'installazione dei pacchetti, specificare esplicitamente la versione del pacchetto principale Dataform. Non utilizzare altro dependencies opzioni di package.json, ad esempio >version.

    1. Fai clic su Installa pacchetti.

    workflow_settings.yaml

    dataformCoreVersion: "VERSION"
    

    Sostituisci VERSION con la versione più recente di Dataform, ad esempio 3.0.0.

    1. Fai clic su Installa pacchetti.
  6. Esegui il commit delle modifiche.

  7. Esegui il push delle modifiche al repository.

Il seguente esempio di codice mostra la dipendenza @dataform/core aggiornata in la versione 3.0.0 nel file package.json:

{
    "dependencies": {
        "@dataform/core": "3.0.0"
    }
}

Passaggi successivi