Vorlage „MongoDB für BigQuery“

Diese Vorlage erstellt eine Batchpipeline, die Dokumente aus MongoDB liest und in BigQuery schreibt.

Wenn Sie Daten aus dem MongoDB-Änderungsstream erfassen möchten, können Sie die MongoDB-zu-BigQuery-Vorlage (CDC) verwenden.

Pipelineanforderungen

  • Das BigQuery-Ziel-Dataset muss vorhanden sein.
  • Die MongoDB-Quellinstanz muss über die Dataflow-Worker-Maschinen zugänglich sein.

Ausgabeformat

Das Format der Ausgabedatensätze hängt vom Wert des Parameters userOption ab. Wenn userOption den Wert NONE hat, hat die Ausgabe das folgende Schema. Das Feld source_data enthält das Dokument im JSON-Format.

  [
    {"name":"id","type":"STRING"},
    {"name":"source_data","type":"STRING"},
    {"name":"timestamp","type":"TIMESTAMP"}
  ]
  

Wenn userOption den Wert FLATTEN hat, vereinfacht die Pipeline die Dokumente und schreibt die Felder der obersten Ebene als Tabellenspalten. Angenommen, die Dokumente in der MongoDB-Sammlung enthalten die folgenden Felder:

  • "_id" (string)
  • "title" (string)
  • "genre" (string)

Bei FLATTEN hat die Ausgabe das folgende Schema. Das Feld timestamp wird von der Vorlage hinzugefügt.

  [
    {"name":"_id","type":"STRING"},
    {"name":"title","type":"STRING"},
    {"name":"genre","type":"STRING"},
    {"name":"timestamp","type":"TIMESTAMP"}
  ]
  

Vorlagenparameter

Erforderliche Parameter

  • mongoDbUri: MongoDB-Verbindungs-URI im Format mongodb+srv://:@..
  • database: Datenbank in MongoDB, aus der die Sammlung gelesen werden soll. (Beispiel: my-db).
  • collection: Name der Sammlung in der MongoDB-Datenbank. (Beispiel: my-collection).
  • userOption : FLATTEN oder NONE. FLATTEN vereinfacht die Dokumente auf die Einzelebene. NONE speichert das gesamte Dokument als JSON-String. Die Standardeinstellung ist NONE.
  • outputTableSpec : Die BigQuery-Tabelle, in die Daten geschrieben werden sollen. Beispiel: bigquery-project:dataset.output_table.

Optionale Parameter

  • KMSEncryptionKey : Cloud KMS-Verschlüsselungsschlüssel zum Entschlüsseln des Mongodb-URI-Verbindungsstrings. Wenn der Cloud KMS-Schlüssel übergeben wird, muss der Mongodb-URI-Verbindungsstring verschlüsselt übergeben werden. (Beispiel: projects/your-project/locations/global/keyRings/your-keyring/cryptoKeys/your-key).
  • useStorageWriteApi : Wenn true, verwendet die Pipeline die BigQuery Storage Write API (https://cloud.google.com/bigquery/docs/write-api). Der Standardwert ist false. Weitere Informationen finden Sie unter „Storage Write API verwenden“ (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).
  • useStorageWriteApiAtLeastOnce: Gibt bei Verwendung der Storage Write API die Schreibsemantik an. Wenn Sie die "Mindestens einmal"-Semantik verwenden möchten (https://beam.apache.org/documentation/io/built-in/google-bigquery/#at-least-once-semantics), legen Sie diesen Parameter auf true fest. Wenn Sie die "Genau einmal"-Semantik verwenden möchten, legen Sie den Parameter auf false fest. Dieser Parameter gilt nur, wenn useStorageWriteApi true ist. Der Standardwert ist false.
  • javascriptDocumentTransformGcsPath : Der Cloud Storage-URI der Datei .js, in der die benutzerdefinierte JavaScript-Funktion (UDF) definiert wird. (Beispiel: gs://your-bucket/your-transforms/*.js).
  • javascriptDocumentTransformFunctionName : Der Name der benutzerdefinierten JavaScript-Funktion (UDF), die verwendet werden soll. Wenn Ihre JavaScript-Funktion beispielsweise myTransform(inJson) { /*...do stuff...*/ } ist, lautet der Funktionsname myTransform. Beispiele für JavaScript-UDFs finden Sie unter UDF-Beispiele (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples). (Beispiel: transform).
  • bigQuerySchemaPath : Der Cloud Storage-Pfad für das BigQuery-JSON-Schema. (Beispiel: gs://your-bucket/your-schema.json).

Benutzerdefinierte Funktion

Optional können Sie diese Vorlage erweitern, indem Sie eine benutzerdefinierte Funktion (UDF) in JavaScript schreiben. Die Vorlage ruft die UDF für jedes Eingabeelement auf. Nutzlasten von Elementen werden als JSON-Strings serialisiert.

Wenn Sie eine UDF verwenden möchten, laden Sie die JavaScript-Datei in Cloud Storage hoch und legen Sie die folgenden Vorlagenparameter fest:

ParameterBeschreibung
javascriptDocumentTransformGcsPath Der Cloud Storage-Speicherort der JavaScript-Datei.
javascriptDocumentTransformFunctionName Der Name der JavaScript-Funktion.

Weitere Informationen finden Sie unter Benutzerdefinierte Funktionen für Dataflow-Vorlagen erstellen.

Funktionsspezifikation

UDFs haben die folgende Spezifikation:

  • Eingabe: Ein MongoDB-Dokument.
  • Ausgabe: ein Objekt, das als JSON-String serialisiert ist. Wenn userOption den Wert NONE hat, muss das JSON-Objekt ein Attribut namens _id enthalten, das die Dokument-ID enthält.
  • Führen Sie die Vorlage aus.

    Console

    1. Rufen Sie die Dataflow-Seite Job aus Vorlage erstellen auf.
    2. Zur Seite "Job aus Vorlage erstellen“
    3. Geben Sie im Feld Jobname einen eindeutigen Jobnamen ein.
    4. Optional: Wählen Sie für Regionaler Endpunkt einen Wert aus dem Drop-down-Menü aus. Die Standardregion ist us-central1.

      Eine Liste der Regionen, in denen Sie einen Dataflow-Job ausführen können, finden Sie unter Dataflow-Standorte.

    5. Wählen Sie im Drop-down-Menü Dataflow-Vorlage die Option the MongoDB to BigQuery templateaus.
    6. Geben Sie Ihre Parameterwerte in die Parameterfelder ein.
    7. Klicken Sie auf Job ausführen.

    gcloud

    Führen Sie die Vorlage in der Shell oder im Terminal aus:

    gcloud dataflow flex-template run JOB_NAME \
        --project=PROJECT_ID \
        --region=REGION_NAME \
        --template-file-gcs-location=gs://dataflow-templates-REGION_NAME/VERSION/flex/MongoDB_to_BigQuery \
        --parameters \
    outputTableSpec=OUTPUT_TABLE_SPEC,\
    mongoDbUri=MONGO_DB_URI,\
    database=DATABASE,\
    collection=COLLECTION,\
    userOption=USER_OPTION
    

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID des Google Cloud-Projekts, in dem Sie den Dataflow-Job ausführen möchten
    • JOB_NAME: ein eindeutiger Jobname Ihrer Wahl
    • REGION_NAME: die Region, in der Sie Ihren Dataflow-Job bereitstellen möchten, z. B. us-central1
    • VERSION: Die Version der Vorlage, die Sie verwenden möchten

      Sie können die folgenden Werte verwenden:

      • latest zur Verwendung der neuesten Version der Vorlage, die im nicht datierten übergeordneten Ordner im Bucket verfügbar ist: gs://dataflow-templates-REGION_NAME/latest/
      • Den Versionsnamen wie 2023-09-12-00_RC00, um eine bestimmte Version der Vorlage zu verwenden. Diese ist verschachtelt im jeweiligen datierten übergeordneten Ordner im Bucket enthalten: gs://dataflow-templates-REGION_NAME/.
    • OUTPUT_TABLE_SPEC: Der Name Ihrer BigQuery-Zieltabelle.
    • MONGO_DB_URI: Ihr MongoDB-URI.
    • DATABASE: Ihre MongoDB-Datenbank.
    • COLLECTION: Ihre MongoDB-Sammlung.
    • USER_OPTION: FLATTEN oder NONE.

    API

    Senden Sie eine HTTP-POST-Anfrage, um die Vorlage mithilfe der REST API auszuführen. Weitere Informationen zur API und ihren Autorisierungsbereichen finden Sie unter projects.templates.launch.

    POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/flexTemplates:launch
    {
       "launch_parameter": {
          "jobName": "JOB_NAME",
          "parameters": {
              "inputTableSpec": "INPUT_TABLE_SPEC",
              "mongoDbUri": "MONGO_DB_URI",
              "database": "DATABASE",
              "collection": "COLLECTION",
              "userOption": "USER_OPTION"
          },
          "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/MongoDB_to_BigQuery",
       }
    }

    Ersetzen Sie Folgendes:

    • PROJECT_ID: die ID des Google Cloud-Projekts, in dem Sie den Dataflow-Job ausführen möchten
    • JOB_NAME: ein eindeutiger Jobname Ihrer Wahl
    • LOCATION: die Region, in der Sie Ihren Dataflow-Job bereitstellen möchten, z. B. us-central1
    • VERSION: Die Version der Vorlage, die Sie verwenden möchten

      Sie können die folgenden Werte verwenden:

      • latest zur Verwendung der neuesten Version der Vorlage, die im nicht datierten übergeordneten Ordner im Bucket verfügbar ist: gs://dataflow-templates-REGION_NAME/latest/
      • Den Versionsnamen wie 2023-09-12-00_RC00, um eine bestimmte Version der Vorlage zu verwenden. Diese ist verschachtelt im jeweiligen datierten übergeordneten Ordner im Bucket enthalten: gs://dataflow-templates-REGION_NAME/.
    • OUTPUT_TABLE_SPEC: Der Name Ihrer BigQuery-Zieltabelle.
    • MONGO_DB_URI: Ihr MongoDB-URI.
    • DATABASE: Ihre MongoDB-Datenbank.
    • COLLECTION: Ihre MongoDB-Sammlung.
    • USER_OPTION: FLATTEN oder NONE.

    Nächste Schritte