Modèle MongoDB vers BigQuery

Ce modèle crée un pipeline par lots qui lit les documents de MongoDB et les écrit dans BigQuery.

Si vous souhaitez capturer des données de flux de modifications MongoDB, vous pouvez utiliser le modèle MongoDB vers BigQuery (CDC).

Conditions requises pour ce pipeline

  • L'ensemble de données BigQuery cible doit exister.
  • L'instance MongoDB source doit être accessible à partir des machines de nœud de calcul Dataflow.

Output format

Le format des enregistrements de sortie dépend de la valeur du paramètre userOption. Si la valeur de userOption est NONE, le résultat ressemble au suivant. Le champ source_data contient le document au format JSON.

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

Si la valeur de userOption est FLATTEN, le pipeline aplatit les documents et écrit les champs de premier niveau en tant que colonnes de table. Par exemple, supposons que les documents de la collection MongoDB contiennent les champs suivants :

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

En utilisant FLATTEN, le résultat ressemble au suivant. Le champ timestamp est ajouté par le modèle.

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

Paramètres de modèle

Paramètres Description
mongoDbUri URI de connexion MongoDB au format mongodb+srv://:@.
database Base de données de MongoDB à partir de laquelle lire la collection. Exemple : my-db.
collection Nom de la collection dans la base de données MongoDB. Exemple : my-collection.
outputTableSpec Table BigQuery dans laquelle écrire. Par exemple, bigquery-project:dataset.output_table.
userOption FLATTEN ou NONE. FLATTEN aplatit les documents au premier niveau. NONE stocke l'intégralité du document sous forme de chaîne JSON.
javascriptDocumentTransformGcsPath (Facultatif) URI Cloud Storage du fichier .js contenant la fonction JavaScript définie par l'utilisateur que vous souhaitez utiliser. Par exemple, gs://my-bucket/my-udfs/my_file.js.
javascriptDocumentTransformFunctionName (Facultatif) Nom de la fonction JavaScript définie par l'utilisateur que vous souhaitez utiliser. Par exemple, si le code de votre fonction JavaScript est myTransform(inJson) { /*...do stuff...*/ }, le nom de la fonction est myTransform. Pour obtenir des exemples de fonctions JavaScript définies par l'utilisateur, consultez la page Exemples de fonctions définies par l'utilisateur.
useStorageWriteApi (Facultatif) Si la valeur est true, le pipeline utilise l' API BigQuery Storage Write. La valeur par défaut est false. Pour en savoir plus, consultez la page Utiliser l'API Storage Write.
useStorageWriteApiAtLeastOnce (Facultatif) Lorsque vous utilisez l'API Storage Write, spécifie la sémantique d'écriture. Pour utiliser la sémantique de type "au moins une fois", définissez ce paramètre sur true. Pour utiliser la sémantique de type "exactement une fois", définissez le paramètre sur false. Ce paramètre ne s'applique que lorsque la valeur de useStorageWriteApi est définie sur true. La valeur par défaut est false.

Fonction définie par l'utilisateur

Vous pouvez éventuellement étendre ce modèle en écrivant une fonction définie par l'utilisateur (UDF) en JavaScript. Le modèle appelle l'UDF pour chaque élément d'entrée. Les charges utiles des éléments sont sérialisées sous forme de chaînes JSON.

Pour utiliser une UDF, importez le fichier JavaScript dans Cloud Storage et définissez les paramètres de modèle suivants :

ParamètresDescription
javascriptDocumentTransformGcsPath Emplacement Cloud Storage du fichier JavaScript.
javascriptDocumentTransformFunctionName Nom de la fonction JavaScript.

Pour en savoir plus, consultez la page Créer des fonctions définies par l'utilisateur pour les modèles Dataflow.

Spécification de la fonction

La spécification de l'UDF se présente comme suit :

  • Entrée : document MongoDB.
  • Résultat : objet sérialisé en tant que chaîne JSON. Si la valeur de userOption est NONE, l'objet JSON doit inclure une propriété nommée _id contenant l'ID du document.

    • Exécuter le modèle

    Console

    1. Accédez à la page Dataflow Créer un job à partir d'un modèle.
      2. Accéder à la page Créer un job à partir d'un modèle
    2. Dans le champ Nom du job, saisissez un nom de job unique.
    3. Facultatif : pour Point de terminaison régional, sélectionnez une valeur dans le menu déroulant. La région par défaut est us-central1.

      Pour obtenir la liste des régions dans lesquelles vous pouvez exécuter un job Dataflow, consultez la page Emplacements Dataflow.

    4. Dans le menu déroulant Modèle Dataflow, sélectionnez the MongoDB to BigQuery template.
    5. Dans les champs fournis, saisissez vos valeurs de paramètres.
    6. Cliquez sur Run Job (Exécuter la tâche).

    gcloud

    Dans le shell ou le terminal, exécutez le modèle :

    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

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet Google Cloud dans lequel vous souhaitez exécuter le job Dataflow
    • JOB_NAME : nom de job unique de votre choix
    • REGION_NAME : région dans laquelle vous souhaitez déployer votre job Dataflow, par exemple us-central1
    • VERSION : version du modèle que vous souhaitez utiliser

      Vous pouvez utiliser les valeurs suivantes :

    • OUTPUT_TABLE_SPEC : nom de votre table BigQuery cible.
    • MONGO_DB_URI : votre URI MongoDB.
    • DATABASE : votre base de données MongoDB.
    • COLLECTION : votre collection MongoDB.
    • USER_OPTION : FLATTEN ou NONE.

    API

    Pour exécuter le modèle à l'aide de l'API REST, envoyez une requête HTTP POST. Pour en savoir plus sur l'API, ses autorisations et leurs champs d'application, consultez la section 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",
   }
}

    Remplacez les éléments suivants :

    • PROJECT_ID : ID du projet Google Cloud dans lequel vous souhaitez exécuter le job Dataflow
    • JOB_NAME : nom de job unique de votre choix
    • LOCATION : région dans laquelle vous souhaitez déployer votre job Dataflow, par exemple us-central1
    • VERSION : version du modèle que vous souhaitez utiliser

      Vous pouvez utiliser les valeurs suivantes :

    • OUTPUT_TABLE_SPEC : nom de votre table BigQuery cible.
    • MONGO_DB_URI : votre URI MongoDB.
    • DATABASE : votre base de données MongoDB.
    • COLLECTION : votre collection MongoDB.
    • USER_OPTION : FLATTEN ou NONE.

    Étapes suivantes