Dataform-Kernpaket verwalten

In diesem Dokument erfahren Sie, wie Sie das Abhängigkeitspaket des Dataform-Kernframeworks verwalten und auf die neueste Version aktualisieren.

Dataform Core ist das Open-Source-Dataform-Framework zum Entwickeln von SQL-Workflows mit SQL, SQLX und JavaScript. Verwenden Sie immer die neueste verfügbare Version des Dataform-Kernframeworks. Informationen zu Releases des Dataform-Kernframeworks finden Sie unter Dataform-Releases auf GitHub.

Hinweis

  1. Erstellen Sie ein Repository.
  2. Erstellen und initialisieren Sie einen Entwicklungsarbeitsbereich.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Verwalten und Aktualisieren von Dataform Core benötigen:

  • Speicherort des Dataform-Kernpakets verwalten: Dataform Admin (roles/dataform.admin) für Repositories
  • Dataform-Kernpaket aktualisieren: Dataform-Bearbeiter (roles/dataform.editor) für Arbeitsbereiche

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Speicherort des Dataform-Kernpakets verwalten

Wenn Sie den ersten Arbeitsbereich in einem Repository initialisieren, wird Dataform Core automatisch als Abhängigkeitspaket festgelegt. Ab Dataform Core 3.0.0 installiert Dataform das Dataform Core-Paket standardmäßig in der Datei workflow_settings.yaml. In früheren Versionen von Dataform Core wurde Dataform Core in der Datei package.json festgelegt.

Wenn Dataform Core in Dataform Core 3.0.0 und höher das einzige Paket in Ihrem Repository ist, sollten Sie es in der Datei workflow_settings.yaml festlegen. Bei Repositories, die mit früheren Versionen von Dataform Core erstellt wurden, verschieben Sie das Dataform Core-Paket zu workflow_settings.yaml.

Die Datei package.json ist erforderlich, um zusätzliche Pakete in Dataform zu installieren. Wenn in Ihrem Repository zusätzliche Pakete verwendet werden, legen Sie das Dataform-Kernpaket in package.json fest, damit alle Pakete an einem Ort festgelegt sind. Wenn Ihr Repository package.json nicht enthält, erstellen Sie package.json und verschieben Sie das Dataform-Kernpaket, um zusätzliche Pakete zu installieren.

Dataform-Kern zu workflow_settings.yaml verschieben

Wenn Sie für Repositories, die mit Versionen von Dataform Core vor 3.0.0 erstellt wurden, keine anderen Abhängigkeitspakete als Dataform Core haben, sollten Sie das Dataform Core-Paket von package.json nach workflow_settings.yaml verschieben und die redundante package.json-Datei löschen.

So migrieren Sie das Dataform-Kernpaket von package.json zu workflow_settings.yaml:

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zur Seite „Dataform“

  2. Wählen Sie ein Repository und dann einen Arbeitsbereich aus.

  3. Wählen Sie im Bereich Dateien die Datei workflow_settings.yaml aus.

  4. Fügen Sie in der Datei workflow_settings.yaml das Dataform-Kernpaket im folgenden Format hinzu:

    dataformCoreVersion: "VERSION"

    Ersetzen Sie VERSION durch die neueste Version von Dataform, z. B. 3.0.0.

  5. Klicken Sie im Bereich Dateien neben package.json auf das Dreipunkt-Menü Mehr und dann auf Löschen.

  6. Klicken Sie auf Löschen, um das Löschen von dataform.json zu bestätigen.

  7. Klicken Sie auf Pakete installieren.

Dataform-Kern zu package.json verschieben

Die Datei package.json ist erforderlich, um zusätzliche Pakete in einem Repository zu installieren. Wenn in Ihrem Repository zusätzliche Pakete verwendet werden, sollten Sie alle Pakete, einschließlich des Dataform-Kernpakets, in package.json speichern.

Wenn Ihr Repository die Datei package.json nicht enthält, weil das Dataform-Kernpaket in der Datei workflow_settings.yaml festgelegt ist, müssen Sie die Datei package.json erstellen, um zusätzliche Pakete zu installieren, und dann das Dataform-Kernpaket von workflow_settings.yaml in die neu erstellte package.json verschieben.

So erstellen Sie die package.json-Datei und verschieben das Dataform-Kernpaket:

  1. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zur Seite „Dataform“

  2. Wählen Sie ein Repository und dann einen Arbeitsbereich aus.

  3. Klicken Sie im Bereich Dateien auf HinzufügenHinzufügen und dann auf Datei erstellen.

  4. Geben Sie im Feld Dateipfad hinzufügen package.json ein.

  5. Klicken Sie auf Datei erstellen.

  6. Fügen Sie in der Datei package.json das Dataform-Kernpaket im folgenden Format hinzu:

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

    Ersetzen Sie VERSION durch die neueste Version von Dataform, z. B. 3.0.0.

  7. Klicken Sie auf Pakete installieren.

  8. Wählen Sie im Bereich Dateien die Option workflow_settings.yaml aus.

  9. Löschen Sie in der Datei workflow_settings.yaml die Property dataformCoreVersion.

Dataform-Kern aktualisieren

Testen Sie neue Paketversionen immer in einer Nicht-Produktionsumgebung, bevor Sie sie in Ihrer Produktionsumgebung bereitstellen.

So aktualisieren Sie das Abhängigkeitspaket „Dataform Core“:

  1. Die neueste Version von @dataform/core finden Sie auf der Seite mit den Dataform-Releases auf GitHub.

  2. Öffnen Sie in der Google Cloud Console die Seite Dataform.

    Zur Seite „Dataform“

  3. Wählen Sie ein Repository und dann einen Arbeitsbereich aus.

  4. Wählen Sie im Bereich Dateien die Datei package.json oder workflow_settings.yaml aus.

    Der Speicherort, an dem das Abhängigkeitspaket für Dataform Core festgelegt ist, hängt von Ihrer Version von Dataform Core und Ihrer Verwendung von Paketen ab. Weitere Informationen finden Sie unter Speicherort des Dataform-Kernpakets verwalten.

  5. Aktualisieren Sie das Dataform-Kernabhängigkeitspaket auf die neueste Version:

    package.json

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

    Ersetzen Sie VERSION durch die neueste Version von Dataform, z. B. 3.0.0. Geben Sie die Version des Dataform-Kernpakets an, um Probleme bei der Paketinstallation zu vermeiden. Verwenden Sie keine anderen dependencies-Optionen von package.json, z. B. >version.

    1. Klicken Sie auf Pakete installieren.

    workflow_settings.yaml

    dataformCoreVersion: "VERSION"

    Ersetzen Sie VERSION durch die neueste Version von Dataform, z. B. 3.0.0.

    1. Klicken Sie auf Pakete installieren.

  6. Änderungen übernehmen

  7. Übertragen Sie die Änderungen per Push in Ihr Repository.

Im folgenden Codebeispiel wird die @dataform/core-Abhängigkeit in der Datei package.json auf die Version 3.0.0 aktualisiert:

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

Nächste Schritte