Releasekonfiguration erstellen

In diesem Dokument erfahren Sie, wie Sie in Dataform eine Release-Konfiguration erstellen, um Vorlagen für Kompilierungseinstellungen zu konfigurieren, die Sie nach einem Zeitplan ausführen können. Mit Releasekonfigurationen können Sie Ausführungsumgebungen konfigurieren, z. B. Staging- und Produktionsumgebungen.

Dataform-Releasekonfigurationen

Um SQL-Workflows in BigQuery auszuführen, kompiliert Dataform den SQL-Workflow-Code in ein Kompilierungsergebnis. Dieser Vorgang erfolgt automatisch, wenn Sie einen SQL-Workflow in einem Dataform-Arbeitsbereich entwickeln.

Mit Releasekonfigurationen können Sie Kompilierungsergebnisse anpassen. Sie können sie zum Erstellen von Ausführungsumgebungen wie Staging verwenden.

Einstellungen für die Releasekonfiguration

In einer Releasekonfiguration können Sie Kompilierungsüberschreibungen von Workfloweinstellungen konfigurieren, Kompilierungsvariablen festlegen und die Häufigkeit festlegen, mit der Kompilierungsergebnisse erstellt werden.

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. Die Mindesthäufigkeit beträgt 1 Stunde.
Kompilierungsüberschreibungen
Überschreibungen des Google CloudProject, des Tabellenpräfixes, des Schemasuffixes und der Kompilierungsvariablen, die in den Workflow-Einstellungen 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 Release-Konfiguration zu erstellen. Die Mindesthäufigkeit beträgt 1 Stunde. Sie können die Kompilierung auf der Seite Details zur Release-Konfiguration manuell auslösen oder die Kompilierung mit der Dataform API releaseConfigs auslösen.

Während der Kompilierung ruft Dataform Code aus dem angegebenen Git-Commit Ihres Repositorys ab. Anschließend kompiliert Dataform den Code mit den angewendeten Compile-Überschreibungen (falls vorhanden) und erstellt das Compile-Ergebnis. Das aktuelle Kompilierungsergebnis, das für die Release-Konfiguration erstellt wurde, ist das Ergebnis der Live-Kompilierung.

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

Hinweis

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

    Zur Seite „Dataform“

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

  3. Optional: Wenn Sie das Standard Google Cloud projekt in der Release-Konfiguration ü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 zuzuweisen, damit Sie die Berechtigungen erhalten, die Sie zum Erstellen einer Release-Konfiguration benötigen. 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.

Releasekonfiguration erstellen

So erstellen Sie eine Dataform-Releasekonfiguration:

  1. Gehen Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie im Bereich Releasekonfigurationen auf Erstellen.

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

    1. Geben Sie im Feld Release-ID eine eindeutige ID für die Release-Konfiguration 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 die Version 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 aus, wie oft die Zusammenstellungsergebnisse erstellt werden sollen.

      Die Mindesthäufigkeit beträgt 1 Stunde.

  4. Optional: Konfigurieren Sie im Abschnitt Überschreibungen der Kompilierung die Kompilierungseinstellungen.

    1. Geben Sie im Feld Google Cloud-Projekt-ID die ID des Google Cloud-Projekts ein, in dem Sie das Kompilierungsergebnis speichern möchten.
    2. Geben Sie im Feld Schema-Suffix ein Suffix ein, das an das in den Workflow-Einstellungen 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 Kompilierungsvariablen 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. Wenn Sie eine weitere Kompilierungsvariable hinzufügen möchten, klicken Sie auf Variable hinzufügen.

  6. Klicken Sie auf Erstellen.

Wenn Sie das Standard Google Cloud projekt überschreiben, muss Ihr Dataform-Dienstkonto Zugriff auf das in der Release-Konfiguration festgelegte Google Cloud projekt haben.



Mit der folgenden Release-Konfiguration wird beispielsweise stündlich ein production-Kompilierungsergebnis aus dem main-Branch erstellt, ohne Überschreibungen der Kompilierung:

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

Details einer Releasekonfiguration ansehen

Sie können sich die folgenden Details einer Releasekonfiguration ansehen:

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

So rufen Sie die Details einer Releasekonfiguration auf:

  1. Gehen Sie in Ihrem Repository zu Releases und Planung.
  2. Wählen Sie eine Releasekonfiguration aus.
  3. Prüfen Sie auf der Seite Releasekonfigurationsdetails die Details der Releasekonfiguration.

In der Tabelle Ergebnisse der geplanten Kompilierung werden bisherige Kompilierungsergebnisse angezeigt, die automatisch von der Releasekonfiguration erstellt wurden.

In der Tabelle Ergebnisse der manuellen bzw. API-Kompilierung werden die Ergebnisse der manuellen oder über Aufrufe der Dataform API erstellten Kompilierung aus den letzten 1.000 Kompilierungsergebnissen im Repository angezeigt.

Kompilierung manuell auslösen

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

  1. Gehen Sie in Ihrem Repository zu Releases und Planung.
  2. Wählen Sie eine Releasekonfiguration aus.
  3. Klicken Sie auf der Seite Details zur Releasekonfiguration auf Neue Kompilierung.

Das neu erstellte Kompilierungsergebnis wird zum Live-Ergebnis für diese Release-Konfiguration.

Die Ergebnisse der manuellen Kompilierung werden in der Tabelle Ergebnisse der manuellen/API-Kompilierung auf der Seite Details zur Release-Konfiguration angezeigt.

Ausführung einer Releasekonfiguration auslösen

So lösen Sie die Ausführung des Live-Kompilierungsergebnisses in einer ausgewählten Release-Konfiguration in BigQuery aus:

  1. Gehen Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie im Bereich Releasekonfigurationen 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. Wenn Sie ausgewählte Aktionen im SQL-Workflow ausführen möchten, klicken Sie auf Auswahl von Aktionen und wählen Sie die Aktionen aus.
    3. Wenn Sie Aktionen mit ausgewählten Tags ausführen möchten, klicken Sie auf Auswahl von Tags und wählen Sie die entsprechenden Tags aus.
  5. Optional: Wenn Sie ausgewählte Aktionen oder Tags und ihre Abhängigkeiten ausführen möchten, wählen Sie die Option Abhängigkeiten einschließen aus.
  6. Optional: Wenn Sie ausgewählte Aktionen oder Tags und ihre abhängigen Elemente ausführen möchten, wählen Sie die Option Abhängige Elemente einschließen aus.

  7. Optional: Wenn Sie alle Tabellen neu erstellen möchten, wählen Sie die Option Mit vollständiger Aktualisierung ausführen aus.

    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. Gehen Sie in Ihrem Repository zu Releases und Planung.
  2. Klicken Sie neben der Releasekonfiguration, die Sie bearbeiten möchten, auf das Dreipunkt-Menü  Mehr und dann auf Bearbeiten.
  3. Bearbeiten Sie im Bereich Releasekonfiguration bearbeiten die Einstellungen für die Releasekonfiguration und klicken Sie dann auf Speichern.

Releasekonfiguration löschen

So löschen Sie eine Releasekonfiguration:

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

Nächste Schritte