Questo modello crea una pipeline batch che legge i documenti da MongoDB e li scrive in BigQuery.
Se vuoi acquisire i dati delle modifiche in tempo reale di MongoDB, puoi utilizzare il modello MongoDB to 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 Dataflow.
Formato di output
Il formato dei record di output dipende dal valore del
parametro userOption
. Se userOption
è
NONE
, l'output ha il seguente schema. 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 della tabella. Ad esempio, supponiamo che i documenti nella raccolta MongoDB contengano i seguenti campi:
"_id"
(string
)"title"
(string
)"genre"
(string
)
Utilizzando FLATTEN
, l'output ha 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"} ]
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
oNONE
.FLATTEN
consente di riunire i documenti in un unico livello.NONE
archivia l'intero documento come stringa 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 di Cloud KMS per decriptare la stringa di connessione URI mongodb. Se viene passata la chiave di Cloud KMS, la stringa di connessione URI mongodb deve essere trasmessa in forma criptata. ad esempio projects/your-project/locations/global/keyRings/your-keyring/cryptoKeys/your-key.
- useStorageWriteApi : se
true
, la pipeline utilizza l'API BigQuery Storage Writer (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). - useStorageWriteApiAtLeastOnce : quando si utilizza l'API StorageWrite, specifica la semantica della 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-once", imposta il parametro sufalse
. Questo parametro si applica solo quandouseStorageWriteApi
ètrue
. Il valore predefinito èfalse
. - 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) di 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 dall'utente 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 i seguenti parametri del modello:
Parametro | Descrizione |
---|---|
javascriptDocumentTransformGcsPath |
Il percorso Cloud Storage del file JavaScript. |
javascriptDocumentTransformFunctionName |
Il nome della funzione JavaScript. |
Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.
Specifica della funzione
La funzione definita dall'utente ha la seguente specifica:
userOption
è NONE
, l'oggetto JSON deve includere una proprietà denominata _id
contenente l'ID documento.Esegui il modello
Console
- Vai alla pagina Crea job da modello di Dataflow. Vai a Crea job da modello
- Nel campo Nome job, inserisci un nome univoco per il job.
- (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è
us-central1
.Per un elenco di regioni in cui è possibile eseguire un job Dataflow, consulta Località di Dataflow.
- Dal menu a discesa Modello Dataflow, seleziona the MongoDB to BigQuery template.
- Inserisci i valori parametro negli appositi campi.
- 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 DataflowJOB_NAME
: un nome job univoco a tua sceltaREGION_NAME
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
VERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre non con data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che è possibile trovare nidificata nella rispettiva cartella principale con data nel bucket: gs://dataflow-templates-REGION_NAME/
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
: APPUNTAMENTO o NESSUNO.
API
Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per maggiori 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 DataflowJOB_NAME
: un nome job univoco a tua sceltaLOCATION
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
VERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre non con data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che è possibile trovare nidificata nella rispettiva cartella principale con data nel bucket: gs://dataflow-templates-REGION_NAME/
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
: APPUNTAMENTO o NESSUNO.
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.