Modello da MongoDB a BigQuery (CDC)

Questo modello crea una pipeline di inserimento flussi che funziona con MongoDB le modifiche in tempo reale. Per utilizzare questo modello, pubblica i dati delle modifiche in tempo reale in Pub/Sub. La pipeline legge i record JSON in Pub/Sub e le scrive in BigQuery. I record scritte in BigQuery hanno lo stesso formato del Modello batch da MongoDB a BigQuery.

Requisiti della pipeline

  • Deve esistere il set di dati BigQuery di destinazione.
  • L'istanza MongoDB di origine deve essere accessibile dalle macchine worker Dataflow.
  • Per leggere il flusso di modifiche, devi creare un argomento Pub/Sub. Mentre la pipeline è in esecuzione, esamina gli eventi Change Data Capture (CDC) sul flusso di modifiche MongoDB e pubblicarli Pub/Sub come record JSON. Per ulteriori informazioni quando pubblichi messaggi in Pub/Sub, Pubblicare messaggi negli argomenti.

Parametri del modello

Parametri obbligatori

  • mongoDbUri : l'URI di connessione MongoDB nel formato mongodb+srv://:@..
  • database: il database in MongoDB da cui leggere la raccolta. Esempio: my-db.
  • collection : nome della raccolta all'interno del database MongoDB. (Esempio: la-mia-raccolta).
  • userOption : FLATTEN o NONE. FLATTEN consente di riunire i documenti in un unico livello. NONE archivia l'intero documento come stringa JSON. Il valore predefinito è: NESSUNO.
  • inputTopic: l'argomento di input Pub/Sub da cui leggere, nel formato projects/<PROJECT_ID>/topics/<TOPIC_NAME>.
  • outputTableSpec: la tabella BigQuery in cui scrivere. Ad esempio, bigquery-project:dataset.output_table.

Parametri facoltativi

  • useStorageWriteApiAtLeastOnce: quando utilizzi l'API Storage Write, specifica la semantica di scrittura. Per utilizzare la semantica "at-least-once" (https://beam.apache.org/documentation/io/built-in/google-bigquery/#at-least-once-semantics), imposta questo parametro su true. Per utilizzare la semantica "exactly-o", imposta il parametro su false. Questo parametro si applica solo quando useStorageWriteApi è true. Il valore predefinito è false.
  • KMSEncryptionKey : chiave di crittografia di 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.
  • useStorageWriteApi : se true, la pipeline utilizza l'API BigQuery Storage Scrivi (https://cloud.google.com/bigquery/docs/write-api). Il valore predefinito è false. Per ulteriori informazioni, consulta Utilizzo dell'API StorageWrite (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api).
  • numStorageWriteApiStreams : quando si utilizza l'API StorageWrite, specifica il numero di flussi di scrittura. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro. Il valore predefinito è 0.
  • storageWriteApiTriggeringFrequencySec : quando utilizzi l'API StorageWrite, specifica la frequenza di attivazione in secondi. Se useStorageWriteApi è true e useStorageWriteApiAtLeastOnce è false, devi impostare questo parametro.
  • 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 gli esempi di funzioni definite dall'utente (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples). (ad esempio: transform).

Funzione definita dall'utente

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

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

ParametroDescrizione
javascriptDocumentTransformGcsPath Il percorso Cloud Storage del file JavaScript.
javascriptDocumentTransformFunctionName Il nome della funzione JavaScript.

Per ulteriori informazioni, vedi Crea funzioni definite dall'utente per i modelli Dataflow.

Specifiche della funzione

La funzione definita dall'utente ha la seguente specifica:

  • Input: un documento MongoDB.
  • Output: un oggetto serializzato come stringa JSON.
  • Esegui il modello

    Console

    1. Vai alla pagina Crea job da modello di Dataflow.
    2. Vai a Crea job da modello
    3. Nel campo Nome job, inserisci un nome univoco per il job.
    4. (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.

    5. Dal menu a discesa Modello Dataflow, seleziona the MongoDB to BigQuery (CDC) template.
    6. Inserisci i valori parametro negli appositi campi.
    7. 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_CDC \
        --parameters \
    outputTableSpec=OUTPUT_TABLE_SPEC,\
    mongoDbUri=MONGO_DB_URI,\
    database=DATABASE,\
    collection=COLLECTION,\
    userOption=USER_OPTION,\
    inputTopic=INPUT_TOPIC

    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 di eseguire il deployment del job Dataflow, ad esempio us-central1
    • VERSION: la versione del modello che vuoi utilizzare

      Puoi utilizzare i seguenti valori:

      di Gemini Advanced.
    • OUTPUT_TABLE_SPEC: il nome della tabella BigQuery di destinazione.
    • MONGO_DB_URI: l'URI MongoDB.
    • DATABASE: il tuo database MongoDB.
    • COLLECTION: la tua raccolta MongoDB.
    • USER_OPTION: FLATTEN o NONE.
    • INPUT_TOPIC: l'argomento di input Pub/Sub.

    API

    Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per ulteriori informazioni sul API e i 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",
              "inputTopic": "INPUT_TOPIC"
          },
          "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/MongoDB_to_BigQuery_CDC",
       }
    }

    Sostituisci quanto segue:

    • PROJECT_ID: l'ID del progetto Google Cloud in cui vuoi eseguire il job Dataflow
    • JOB_NAME: un nome job univoco di 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:

      di Gemini Advanced.
    • OUTPUT_TABLE_SPEC: il nome della tabella BigQuery di destinazione.
    • MONGO_DB_URI: l'URI MongoDB.
    • DATABASE: il tuo database MongoDB.
    • COLLECTION: la tua raccolta MongoDB.
    • USER_OPTION: FLATTEN o NONE.
    • INPUT_TOPIC: argomento di input di Pub/Sub.

    Passaggi successivi