Zusätzliche Aktionen konfigurieren

Dieses Dokument enthält Anleitungen für folgende Aufgaben:

Hinweis

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

    Zu Dataform

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

  3. Wählen Sie einen Entwicklungsarbeitsbereich aus oder erstellen Sie einen.

  4. Erstellen Sie eine Tabelle.

  5. Definieren Sie eine SQLX-Datei eines der folgenden Typen:

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Ausführen der Aufgaben in diesem Dokument 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.

SQL-Anweisung definieren, die vor der Tabellenerstellung ausgeführt werden soll

Sie können Dataform so konfigurieren, dass eine oder mehrere SQL-Anweisungen ausgeführt werden, bevor eine ausgewählte Tabelle in BigQuery erstellt wird. Wenn Sie eine SQL-Anweisung ausführen möchten, bevor Dataform eine ausgewählte Tabelle erstellt, fügen Sie die Anweisung dem Block pre_operations in der SQLX-Datei der Tabellendefinition hinzu.

So erstellen Sie eine benutzerdefinierte SQL-Anweisung, die ausgeführt wird, bevor Dataform eine bestimmte Tabelle erstellt:

  1. Rufen Sie Ihren Entwicklungsarbeitsbereich auf.
  2. Maximieren Sie im Bereich Dateien definitions/.
  3. Öffnen Sie eine SQLX-Datei mit der Tabellendefinition.
  4. Geben Sie außerhalb des Blocks config die Anweisung pre_operations { ... } ein.
  5. Fügen Sie innerhalb von pre_operations { ... } Ihre SQL-Anweisung hinzu.
  6. Optional: Wenn Sie mehrere Anweisungen hinzufügen möchten, trennen Sie sie durch ---.
  7. Optional: Klicken Sie auf Formatieren.

Das folgende Codebeispiel zeigt eine pre_operations-Anweisung, mit der eine temporäre Funktion erstellt wird, die in der SELECT-Anweisung verwendet werden kann:

pre_operations {
  CREATE TEMP FUNCTION AddFourAndDivide(x INT64, y INT64)
    RETURNS FLOAT64
    AS ((x + 4) / y);
}

SQL-Anweisung definieren, die nach der Tabellenerstellung ausgeführt werden soll

Sie können Dataform so konfigurieren, dass eine oder mehrere SQL-Anweisungen ausgeführt werden, nachdem eine ausgewählte Tabelle in BigQuery erstellt wurde. Wenn Sie eine SQL-Anweisung ausführen möchten, nachdem Dataform eine ausgewählte Tabelle erstellt hat, fügen Sie die Anweisung dem Block post_operations in der SQLX-Datei der Tabellendefinition hinzu. Sie können dem Block post_operations mehrere SQL-Anweisungen hinzufügen.

So erstellen Sie eine benutzerdefinierte SQL-Anweisung, die ausgeführt wird, nachdem Dataform eine bestimmte Tabelle erstellt hat:

  1. Rufen Sie Ihren Entwicklungsarbeitsbereich auf.
  2. Maximieren Sie im Bereich Dateien definitions/.
  3. Öffnen Sie eine SQLX-Datei mit der Tabellendefinition.
  4. Geben Sie außerhalb des Blocks config die Anweisung post_operations { ... } ein.
  5. Fügen Sie innerhalb von post_operations { ... } Ihre SQL-Anweisung hinzu.
  6. Optional: Klicken Sie auf Formatieren.

Das folgende Codebeispiel zeigt post_operations-Anweisungen, mit denen Gruppen Zugriff auf die erstellte Tabelle gewährt wird:

  post_operations {
    GRANT `roles/bigquery.dataViewer`
    ON
    TABLE ${self()}
    TO "group:allusers@example.com", "user:otheruser@example.com"
  }

Automatische Metadatenanreicherung

Dataform unterstützt die automatische Metadatenanreicherung für BigQuery-Tabellen und -Ansichten, die mit SQLX-Workflows erstellt wurden. Wenn eine Tabellenaktion erfolgreich abgeschlossen wurde, versucht Dataform, die definierten Metadaten in den entsprechenden Knowledge Catalog-Eintrag zu schreiben. Dieser Vorgang ist auf folgende Weise von der SQL-Ausführung entkoppelt:

  • Latenz: Die Synchronisierung ist asynchron. Das bedeutet, dass Ihre BigQuery -Jobs nicht darauf warten, dass die Knowledge Catalog-Aktualisierung abgeschlossen ist.
  • Zuverlässigkeit: Wenn die Synchronisierung fehlschlägt (z. B. aufgrund von API-Ratenlimits), wiederholt Dataform die Aktualisierung automatisch. Ein fehlgeschlagenes Metadatenupdate führt nicht dazu, dass Ihre Dataform-Aktion oder Ihr Workflow fehlschlägt.

Das folgende Codebeispiel zeigt, wie Sie Metadaten für Knowledge Catalog im Konfigurationsblock einer SQLX-Datei definieren:

config {
  type: "table",
  metadata: {
    overview: "This table provides standardized trip data.",
    extraProperties: {
      generic: {
        system: "BigQuery",
        type: "table"
      }
    }
  }
}

Informationen zum Prüfen des Status eines Metadatenupdates finden Sie unter Ausführungsprotokolle des Arbeitsbereichs prüfen.

Wenn Sie die angereicherten Metadaten ansehen möchten, können Sie in Knowledge Catalog nach Ihren BigQuery-Tabellen und -Ansichten suchen. Weitere Informationen finden Sie unter siehe Nach Ressourcen suchen.

Tabellenerstellung deaktivieren

Wenn Sie verhindern möchten, dass Dataform eine ausgewählte Tabelle in BigQuery erstellt, können Sie die Tabelle in der SQLX-Datei der Tabellendefinition deaktivieren. Dataform behält eine deaktivierte Tabelle im Abhängigkeitsdiagramm, kompiliert und erstellt sie aber nicht. Das kann beispielsweise nützlich sein, wenn eine Tabelle fehlschlägt und Sie nicht möchten, dass der gesamte Workflow fehlschlägt, während Sie das Problem beheben.

So deaktivieren Sie eine Tabelle:

  1. Rufen Sie Ihren Entwicklungsarbeitsbereich auf.
  2. Maximieren Sie im Bereich Dateien definitions/.
  3. Wählen Sie eine SQLX-Datei mit der Tabellendefinition aus.
  4. Geben Sie im Block config der Datei disabled: true ein.
  5. Optional: Klicken Sie auf Formatieren.

Das folgende Codebeispiel zeigt eine deaktivierte Tabelle:

config {
  type: "table",
  disabled: true
}

select * from ${ref("source_data")}

Ausführungstags hinzufügen

In diesem Abschnitt erfahren Sie, wie Sie Dataform-SQLX-Kerndateien Tags hinzufügen, um Ihren Workflow zu kategorisieren.

Wenn Sie die Komponenten Ihres Workflows in Sammlungen organisieren möchten, können Sie SQLX-Dateien der folgenden Typen benutzerdefinierte Tags hinzufügen:

  • table
  • view
  • incremental
  • assertion
  • operations

Während einer Workflowausführung können Sie nur Dateien mit einem ausgewählten Tag ausführen.

Mit Managed Service for Apache Airflow oder Workflows zusammen mit Cloud Scheduler, können Sie einen Zeitplan erstellen, mit dem ein Dataform-Workflow mit einem ausgewählten Tag in einem bestimmten Intervall ausgeführt wird.

Tag hinzufügen

Sie können einer SQLX-Datei mehrere Tags hinzufügen.

So fügen Sie einer SQLX-Datei ein Tag hinzu:

  1. Rufen Sie Ihren Entwicklungsarbeitsbereich auf.
  2. Maximieren Sie im Bereich Dateien definitions/.
  3. Wählen Sie eine SQLX-Datei aus.

  4. Fügen Sie im Block config ein Tag im folgenden Format hinzu:

    tags: ["CUSTOM_TAG"]

    Ersetzen Sie CUSTOM_TAG durch Ihr Tag.

  5. Optional: Wenn Sie mehrere Tags hinzufügen möchten, trennen Sie sie durch ein Komma (,).

  6. Optional: Klicken Sie auf Formatieren.

Das folgende Codebeispiel zeigt die Ansicht user_counts mit den Tags daily und hourly:

config {
  type: "view",
  name: "user_counts",
  tags: ["daily", "hourly"]
}

Nächste Schritte