Datenquelle deklarieren

In diesem Dokument erfahren Sie, wie Sie BigQuery-Datenquellen mit Dataform Core deklarieren.

Sie können in Dataform jeden BigQuery-Tabellentyp als Datenquelle deklarieren. Durch das Deklarieren von BigQuery-Datenquellen außerhalb von Dataform können Sie diese Datenquellen als erstklassige Dataform-Objekte behandeln. Nachdem Sie eine Datenquelle deklariert haben, können Sie wie jede andere Tabelle in Dataform auf sie verweisen oder sie auflösen.

Hinweise

Bevor Sie eine Datenquelle deklarieren, müssen Sie einen Entwicklungsarbeitsbereich in Ihrem Repository erstellen und initialisieren.

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Dataform Editor (roles/dataform.editor) für Arbeitsbereiche zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Deklarieren einer Datenquelle 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.

SQLX-Datei für Datenquellendeklaration erstellen

Speichern Sie SQLX-Dateien für Datenquellendeklarationen im Verzeichnis definitions/. So erstellen Sie eine neue SQLX-Datei im Verzeichnis definitions/:

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

    Zur Seite „Dataform“

  2. Wählen Sie ein Repository aus.

  3. Wählen Sie einen Entwicklungsarbeitsbereich aus.

  4. Klicken Sie im Bereich Dateien neben definitions/ auf das Menü Mehr.

  5. Klicken Sie auf Datei erstellen.

  6. Führen Sie im Bereich Neue Datei erstellen die folgenden Schritte aus:

    1. Geben Sie im Feld Dateipfad hinzufügen nach definitions/ den Namen der Datei gefolgt von .sqlx ein. Beispiel: definitions/dataset-declaration.sqlx.

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

    2. Klicken Sie auf Datei erstellen.

Datenquelle deklarieren

Sie können pro SQLX-Deklarationsdatei eine Datenquelle deklarieren. So deklarieren Sie eine Datenquelle im Konfigurationsblock einer SQLX-Datei:

  1. Klicken Sie in Ihrem Entwicklungsarbeitsbereich im Bereich Files (Dateien) auf Ihre SQLX-Datei, um die Datenquellendeklaration aufzurufen.

  2. Geben Sie in die Datei das folgende Code-Snippet ein:

    config {
  type: "declaration",
  database: "DATABASE",
  schema: "SCHEMA",
  name: "NAME",
}

    Ersetzen Sie Folgendes:

    • DATABASE: die Projekt-ID des Projekts, das die Datenquelle enthält.
    • SCHEMA: Das BigQuery-Dataset, in dem sich die Datenquelle befindet.
    • NAME: der Name der Tabelle oder Ansicht, die Sie als Datenquelle verwenden möchten Sie können diesen Namen später verwenden, um auf die Datenquelle in Dataform zu verweisen.

  3. Optional: Klicken Sie auf Format.

Das folgende Codebeispiel zeigt eine Beispieldeklaration der Tabelle shakespeare im Dataset samples des Projekts bigquery-public-data als Datenquelle:

    config {
      type: "declaration",
      database: "bigquery-public-data",
      schema: "samples",
      name: "shakespeare",
    }

Nächste Schritte