Releasekonfiguration erstellen

In diesem Dokument erfahren Sie, wie Sie eine Releasekonfiguration in Dataform erstellen, um Vorlagen mit Kompilierungseinstellungen zu konfigurieren, die Sie nach einem Zeitplan ausführen können. Mit Releasekonfigurationen können Sie Ausführungsumgebungen wie Staging und Produktion konfigurieren.

Dataform-Releasekonfigurationen

Zum Ausführen von SQL-Workflows in BigQuery kompiliert Dataform SQL-Workflowcode in ein Kompilierungsergebnis. Dieser Prozess erfolgt automatisch, wenn Sie einen SQL-Workflow in einem Dataform-Arbeitsbereich entwickeln.

Mit Releasekonfigurationen können Sie die Kompilierungsergebnisse anpassen. Sie können damit Ausführungsumgebungen wie Staging erstellen.

Konfigurationseinstellungen für Release

In einer Releasekonfiguration können Sie Kompilierungsüberschreibungen der dataform.json-Einstellungen konfigurieren, Kompilierungsvariablen festlegen und die Häufigkeit der Erstellung von Kompilierungsergebnissen festlegen.

Eine Dataform-Releasekonfiguration enthält die folgenden Kompilierungseinstellungen:

Release-Einstellungen
ID des Release, Git Commitish für Kompilierungsergebnisse und Häufigkeit der Erstellung von Kompilierungsergebnissen. Die Häufigkeit ist eine optionale Einstellung. Wenn festgelegt, beträgt die minimale Häufigkeit 1 Stunde.
Kompilierungsüberschreibungen
Überschreibungen des Google Cloud-Projekts, des Tabellenpräfixes, des Schemasuffixes und der Kompilierungsvariablen, die in dataform.json definiert sind.

Funktionsweise einer Releasekonfiguration

Dataform erstellt Kompilierungsergebnisse aus einer Releasekonfiguration mit der angegebenen Häufigkeit oder wenn Sie die Kompilierung auslösen. Die Häufigkeit ist eine optionale Einstellung und nicht erforderlich, um eine Releasekonfiguration zu erstellen. Wenn festgelegt, beträgt die minimale Häufigkeit 1 Stunde. Sie können die Kompilierung auf der Seite Details zur Releasekonfiguration manuell auslösen oder mit der Dataform API releaseConfigs.

Während der Kompilierung ruft Dataform Code aus dem angegebenen Git-Commitish Ihres Repositorys ab. Anschließend kompiliert Dataform den Code mit den angewendeten Kompilierungsüberschreibungen (falls vorhanden) und erstellt das Kompilierungsergebnis. Das letzte für die Releasekonfiguration erstellte Kompilierungsergebnis ist das Ergebnis der Live-Kompilierung.

Sie können Ausführungen von Kompilierungsergebnissen aus Releasekonfigurationen in Workflowkonfigurationen planen. Sie können auch eine ausgewählte Releasekonfiguration außerhalb eines Zeitplans ausführen. Während der Ausführung einer Workflowkonfiguration führt Dataform das Ergebnis der Livekompilierung aus der ausgewählten Releasekonfiguration aus.

Hinweise

  1. Rufen Sie in der Google Cloud Console die Seite Dataform auf.

    Zur Seite „Dataform“

  2. Wählen Sie ein Repository aus oder erstellen Sie ein Repository.

  3. Optional: Wenn Sie das Google Cloud-Standardprojekt in der Releasekonfiguration überschreiben möchten, gewähren Sie Ihrem Dataform-Dienstkonto Zugriff auf das Google Cloud-Projekt, das Sie verwenden möchten.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Dataform Editor (roles/dataform.editor) für Repositories zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Erstellen einer Releasekonfiguration benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

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

Releasekonfiguration erstellen

So erstellen Sie eine Dataform-Releasekonfiguration:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie im Abschnitt Release-Konfigurationen auf Erstellen.

  3. Konfigurieren Sie im Bereich Release-Konfiguration erstellen die Release-Einstellungen.

    1. Geben Sie im Feld Release-ID eine eindeutige ID für die Releasekonfiguration ein.

      IDs dürfen nur Ziffern, Buchstaben, Bindestriche und Unterstriche enthalten.

    2. Geben Sie im Feld Git commitish den Git-Branch oder den Git-Commit-SHA für den Release ein.

    In einem Dataform-Repository, das nicht mit einem Remote-Repository verbunden ist, ist der Wert immer main.

    1. Optional: Wählen Sie im Drop-down-Menü Häufigkeit die Häufigkeit für die Erstellung von Kompilierungsergebnissen aus.

      Wenn festgelegt, beträgt die minimale Häufigkeit 1 Stunde.

  4. Optional: Konfigurieren Sie im Abschnitt Kompilierungsüberschreibungen die Kompilierungseinstellungen.

    1. Geben Sie im Feld Google Cloud-Projekt-ID die ID des Google Cloud-Projekts ein, in dem das Kompilierungsergebnis gespeichert werden soll.
    2. Geben Sie im Feld Schemasuffix ein Suffix ein, das an das in dataform.json konfigurierte Schema angehängt werden soll.
    3. Geben Sie im Feld Tabellenpräfix ein Präfix für alle Tabellennamen ein.

  5. Optional: Legen Sie im Abschnitt Kompilationsvariablen die Kompilierungsvariablen fest.

    1. Klicken Sie auf Variable hinzufügen.
    2. Geben Sie im Feld Schlüssel die Kompilierungsvariable ein.
    3. Geben Sie im Feld Wert den Wert für die Kompilierungsvariable ein.
    4. Klicken Sie auf Variable hinzufügen, um eine weitere Kompilierungsvariable hinzuzufügen.

  6. Klicken Sie auf Erstellen.

Wenn Sie das Google Cloud-Standardprojekt überschreiben, muss Ihr Dataform-Dienstkonto Zugriff auf das Google Cloud-Projekt haben, das in der Releasekonfiguration festgelegt ist.



Mit der folgenden Releasekonfiguration wird beispielsweise stündlich ein production-Kompilierungsergebnis aus dem Zweig main ohne Kompilierungsüberschreibungen erstellt:

  • Release-ID: production
  • Git Commitish: main
  • Häufigkeit: stündlich
  • Keine Kompilierungsüberschreibungen

Details einer Releasekonfiguration ansehen

Sie können die folgenden Details einer Releasekonfiguration aufrufen:

  • Release-Einstellungen
    • Git Commitish
    • Zeitstempel des letzten Kompilierungsergebnisses
    • Cron-Zeitplan
    • Kompilierungsüberschreibungen
    • Kompilierungsvariablen
  • Ergebnis der Live-Kompilierung
    • Zeitstempel der Erstellung
    • Git Commitish
    • Commit-SHA
  • Frühere Kompilierungsergebnisse

So rufen Sie die Details einer Releasekonfiguration auf:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Wählen Sie eine Releasekonfiguration aus.
  3. Sehen Sie sich auf der Seite Details zur Releasekonfiguration die Details der Releasekonfiguration an.

Kompilierung manuell auslösen

So erstellen Sie manuell ein Kompilierungsergebnis aus einer ausgewählten Releasekonfiguration:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Wählen Sie eine Releasekonfiguration aus.
  3. Klicken Sie auf der Seite Release-Konfigurationsdetails auf Neue Kompilierung.

Das neu erstellte Kompilierungsergebnis wird zum Liveergebnis für diese Releasekonfiguration.

Ausführung einer Releasekonfiguration auslösen

So lösen Sie die Ausführung der Live-Kompilierung aus, die zu einer ausgewählten Releasekonfiguration in BigQuery führt:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie im Abschnitt Release-Konfigurationen auf Ausführung starten.
  3. Wählen Sie im Bereich Manuellen Workflow ausführen im Drop-down-Menü Releasekonfiguration eine Releasekonfiguration aus.
  4. Wählen Sie die auszuführenden SQL-Workflow-Aktionen aus:
    1. Klicken Sie auf Alle Aktionen, um den gesamten SQL-Workflow auszuführen.
    2. Zum Ausführen ausgewählter Aktionen im SQL-Workflow klicken Sie auf Auswahl von Aktionen und wählen dann Aktionen aus.
    3. Wenn Sie Aktionen mit ausgewählten Tags ausführen möchten, klicken Sie auf Tags auswählen und wählen Sie dann Tags aus.
  5. Optional: Wählen Sie zum Ausführen ausgewählter Aktionen oder Tags und der zugehörigen Abhängigkeiten die Option Abhängigkeiten einbeziehen aus.
  6. Optional: Wählen Sie zum Ausführen ausgewählter Aktionen oder Tags und ihrer abhängigen Elemente die Option Abhängige einbeziehen aus.

  7. Optional: Wählen Sie die Option Mit vollständiger Aktualisierung ausführen aus, um alle Tabellen von Grund auf neu zu erstellen.

    Ohne diese Option aktualisiert Dataform inkrementelle Tabellen, ohne sie von Grund auf neu zu erstellen.

  8. Klicken Sie auf Ausführung starten.

Releasekonfiguration bearbeiten

So bearbeiten Sie eine Releasekonfiguration:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie bei der Releasekonfiguration, die Sie bearbeiten möchten, auf das -Menü Mehr und dann auf Bearbeiten.
  3. Bearbeiten Sie im Bereich Release-Konfiguration bearbeiten die Einstellungen für die Releasekonfiguration und klicken Sie dann auf Speichern.

Releasekonfiguration löschen

So löschen Sie eine Releasekonfiguration:

  1. Wechseln Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie bei der Releasekonfiguration, die Sie löschen möchten, auf das -Menü Mehr und dann auf Löschen.
  3. Klicken Sie im Dialogfeld Releasekonfiguration löschen auf Löschen.

Nächste Schritte