Modello da MongoDB a BigQuery

Questo modello crea una pipeline batch che legge i documenti da MongoDB e li scrive in BigQuery.

Se vuoi acquisire i dati del flusso di modifiche di MongoDB, puoi utilizzare il modello MongoDB a BigQuery (CDC).

Requisiti della pipeline

  • Deve esistere il set di dati BigQuery di destinazione.
  • L'istanza MongoDB di origine deve essere accessibile dalle macchine worker di Dataflow.

Formato di output

Il formato dei record di output dipende dal valore del parametro userOption. Se userOption è NONE, l'output ha lo schema seguente. Il campo source_data contiene il documento in formato JSON.

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

Se userOption è FLATTEN, la pipeline appiattisce i documenti e scrive i campi di primo livello come colonne di tabella. Ad esempio, supponiamo che i documenti nella raccolta MongoDB contengano i seguenti campi:

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

Se utilizzi FLATTEN, l'output avrà lo schema seguente. Il campo timestamp viene aggiunto dal modello.

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

Se userOption è JSON, la pipeline archivia il documento nel formato JSON di BigQuery. BigQuery supporta i dati JSON utilizzando il tipo di dato JSON. Per ulteriori informazioni, consulta Utilizzare i dati JSON in GoogleSQL.

Parametri del modello

Parametri obbligatori

  • mongoDbUri: l'URI di connessione a MongoDB nel formato mongodb+srv://:@..
  • database: il database in MongoDB da cui leggere la raccolta. Ad esempio, my-db.
  • collection: il nome della raccolta all'interno del database MongoDB. Ad esempio, my-collection.
  • userOption: FLATTEN, JSON o NONE. FLATTEN appiattisce i documenti a un unico livello. JSON archivia il documento in formato JSON BigQuery. NONE memorizza l'intero documento come STRINGA in formato JSON. Il valore predefinito è NESSUNO.
  • outputTableSpec: la tabella BigQuery in cui scrivere. Ad esempio, bigquery-project:dataset.output_table.

Parametri facoltativi

  • KMSEncryptionKey: chiave di crittografia Cloud KMS per decriptare la stringa di connessione uri MongoDB. Se viene passata la chiave Cloud KMS, la stringa di connessione uri mongodb deve essere passata criptata. Ad esempio, projects/your-project/locations/global/keyRings/your-keyring/cryptoKeys/your-key.
  • filter: filtro Bson in formato JSON. Ad esempio, { "val": { $gt: 0, $lt: 9 }}.
  • useStorageWriteApi: se true, la pipeline utilizza l'API BigQuery Storage di scrittura (https://cloud.google.com/bigquery/docs/write-api). Il valore predefinito è false. Per ulteriori informazioni, consulta Utilizzo dell'API Storage Write (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).
  • useStorageWriteApiAtLeastOnce: quando utilizzi l'API Storage Write, specifica la semantica di scrittura. Per utilizzare la semantica almeno una volta (https://beam.apache.org/documentation/io/built-in/google-bigquery/#at-least-once-semantics), imposta questo parametro su true. Per utilizzare la semantica esattamente una volta, imposta il parametro su false. Questo parametro si applica solo quando useStorageWriteApi è true. Il valore predefinito è false.
  • bigQuerySchemaPath: il percorso di Cloud Storage per lo schema JSON di BigQuery. Ad esempio, gs://your-bucket/your-schema.json.
  • javascriptDocumentTransformGcsPath: l'URI Cloud Storage del file .js che definisce la funzione definita dall'utente (UDF) JavaScript da utilizzare. Ad esempio: gs://your-bucket/your-transforms/*.js.
  • javascriptDocumentTransformFunctionName: il nome della funzione definita dall'utente (UDF) JavaScript da utilizzare. Ad esempio, se il codice della funzione JavaScript è myTransform(inJson) { /*...do stuff...*/ }, il nome della funzione è myTransform. Per esempi di funzioni JavaScript definite dall'utente, consulta Esempi di funzioni UDF (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples). Ad esempio: transform.

Funzione definita dall'utente

Se vuoi, puoi estendere questo modello scrivendo una funzione definita dall'utente (UDF) in JavaScript. Il modello chiama la UDF per ogni elemento di input. I payload degli elementi vengono serializzati come stringhe JSON.

Per utilizzare una funzione definita dall'utente, carica il file JavaScript in Cloud Storage e imposta i seguenti parametri del modello:

ParametroDescrizione
javascriptDocumentTransformGcsPath La posizione del file JavaScript in Cloud Storage.
javascriptDocumentTransformFunctionName Il nome della funzione JavaScript.

Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.

Specifiche della funzione

La UDF ha la seguente specifica:

  • Input: un documento MongoDB.
  • Output: un oggetto serializzato come stringa JSON. Se userOption è NONE, l'oggetto JSON deve includere una proprietà denominata _id che contiene l'ID documento.

    • Esegui il modello

    Console

    1. Vai alla pagina Crea job da modello di Dataflow.
      2. Vai a Crea job da modello
    2. Nel campo Nome job, inserisci un nome univoco per il job.
    3. (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è us-central1.

      Per un elenco delle regioni in cui puoi eseguire un job Dataflow, consulta Località di Dataflow.

    4. Nel menu a discesa Modello di flusso di dati, seleziona the MongoDB to BigQuery template.
    5. Nei campi dei parametri forniti, inserisci i valori dei parametri.
    6. Fai clic su Esegui job.

    gcloud

    Nella shell o nel terminale, esegui il modello:

    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

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID del progetto Google Cloud in cui vuoi eseguire il job Dataflow
    • JOB_NAME: un nome di job univoco a tua scelta
    • REGION_NAME: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempio us-central1
    • VERSION: la versione del modello che vuoi utilizzare

      Puoi utilizzare i seguenti valori:

    • OUTPUT_TABLE_SPEC: il nome della tabella BigQuery di destinazione.
    • MONGO_DB_URI: il tuo URI MongoDB.
    • DATABASE: il tuo database MongoDB.
    • COLLECTION: la tua raccolta MongoDB.
    • USER_OPTION: FLATTEN, JSON o NESSUNO.

    API

    Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per ulteriori informazioni sull'API e sui relativi ambiti di autorizzazione, consulta 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",
   }
}

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID del progetto Google Cloud in cui vuoi eseguire il job Dataflow
    • JOB_NAME: un nome di job univoco a tua scelta
    • LOCATION: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempio us-central1
    • VERSION: la versione del modello che vuoi utilizzare

      Puoi utilizzare i seguenti valori:

    • OUTPUT_TABLE_SPEC: il nome della tabella BigQuery di destinazione.
    • MONGO_DB_URI: il tuo URI MongoDB.
    • DATABASE: il tuo database MongoDB.
    • COLLECTION: la tua raccolta MongoDB.
    • USER_OPTION: FLATTEN, JSON o NESSUNO.

    Passaggi successivi