Releasekonfiguration erstellen

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

Dataform-Releasekonfigurationen

Zum Ausführen von SQL-Workflows in BigQuery kompiliert Dataform den SQL-Workflowcode 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 verwenden, um Ausführungsumgebungen zu erstellen, z. B. für das Staging.

Konfigurationseinstellungen für Release

In einer Releasekonfiguration können Sie Kompilierungsüberschreibungen von Workfloweinstellungen 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 Mindesthäufigkeit 1 Stunde.
Kompilierungsüberschreibungen
Überschreibungen des Google Cloud-Projekts, des Tabellenpräfixes, des Schemasuffixes und der Kompilierungsvariablen, die in den Workfloweinstellungen definiert sind.

So funktioniert eine 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 für die Erstellung einer Releasekonfiguration nicht erforderlich. Wenn festgelegt, beträgt die Mindesthäufigkeit 1 Stunde. Sie können die Kompilierung auf der Seite Release-Konfigurationsdetails manuell auslösen oder sie mit der Dataform API releaseConfigs auslösen.

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 Kompilierungsergebnis, das für die Releasekonfiguration erstellt wurde, ist das Live-Kompilierungsergebnis.

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

Hinweise

  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 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, damit Sie die Berechtigungen 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. Rufen Sie in Ihrem Repository Releases und Planung auf.
  2. Klicken Sie im Abschnitt Release-Konfigurationen auf Erstellen.

  3. Konfigurieren Sie im Bereich Releasekonfiguration erstellen die Releaseeinstellungen.

    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 das Git-Commit-SHA für den Release ein.

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

    1. Optional: Wählen Sie im Drop-down-Menü Häufigkeit aus, wie häufig die Kompilierungsergebnisse erstellt werden sollen.

      Wenn festgelegt, beträgt die Mindesthäufigkeit 1 Stunde.

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

    1. Geben Sie im Feld Google Cloud Project ID (Google Cloud-Projekt-ID) die ID des Google Cloud-Projekts ein, in dem Sie das Kompilierungsergebnis speichern möchten.
    2. Geben Sie im Feld Schemasuffix ein Suffix ein, das an das in den Workfloweinstellungen 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 Bereich Kompilierungsvariablen die Kompilierungsvariablen fest.

    1. Klicken Sie auf Variable hinzufügen.
    2. Geben Sie im Feld Schlüssel die Kompilierungsvariable ein.
    3. Geben Sie in das 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, prüfen Sie, ob Ihr Dataform-Dienstkonto Zugriff auf das in der Releasekonfiguration festgelegte Google Cloud-Projekt hat.



Die folgende Releasekonfiguration erstellt beispielsweise stündlich ein production-Kompilierungsergebnis aus dem Zweig main ohne Kompilierungsüberschreibungen:

  • 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 ansehen:

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

So rufen Sie die Details einer Releasekonfiguration auf:

  1. Rufen Sie in Ihrem Repository Releases und Planung auf.
  2. Wählen Sie eine Releasekonfiguration aus.
  3. Prüfen Sie auf der Seite Release-Konfigurationsdetails die Details der Releasekonfiguration.

Die Tabelle Ergebnisse der geplanten Kompilierung enthält frühere Kompilierungsergebnisse, die durch die Releasekonfiguration automatisch erstellt wurden.

Die Tabelle Manuelle/API-Kompilierungsergebnisse enthält Kompilierungsergebnisse, die manuell oder durch Aufrufe der Dataform API aus den letzten 1.000 Kompilierungsergebnissen im Repository erstellt wurden.

Kompilierung manuell auslösen

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

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

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

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

Ausführung einer Releasekonfiguration auslösen

Führen Sie die folgenden Schritte aus, um die Ausführung der Livekompilierung mit einer ausgewählten Releasekonfiguration in BigQuery auszulösen:

  1. Rufen Sie in Ihrem Repository Releases und Planung auf.
  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-Workflowaktionen aus:
    1. Klicken Sie auf Alle Aktionen, um den gesamten SQL-Workflow auszuführen.
    2. Klicken Sie auf Auswahl von Aktionen und wählen Sie dann Aktionen aus, um im SQL-Workflow ausgewählte Aktionen auszuführen.
    3. Wenn Sie Aktionen mit ausgewählten Tags ausführen möchten, klicken Sie auf Tags auswählen und wählen Sie dann die gewünschten Tags aus.
  5. Optional: Wählen Sie die Option Abhängigkeiten einbeziehen aus, um ausgewählte Aktionen oder Tags und ihre Abhängigkeiten auszuführen.
  6. Optional: Wählen Sie zum Ausführen ausgewählter Aktionen oder Tags und ihrer abhängigen Elemente die Option Abhängige Elemente einschließen aus.

  7. Optional: Wenn Sie alle Tabellen von Grund auf 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. Rufen Sie in Ihrem Repository Releases und Planung auf.
  2. Klicken Sie neben der Releasekonfiguration, die Sie bearbeiten möchten, auf das Menü Mehr und dann auf Bearbeiten.
  3. Bearbeiten Sie im Bereich Releasekonfiguration bearbeiten die Releasekonfigurationseinstellungen und klicken Sie dann auf Speichern.

Releasekonfiguration löschen

So löschen Sie eine Releasekonfiguration:

  1. Rufen Sie in Ihrem Repository Releases und Planung auf.
  2. Klicken Sie neben 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