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 da 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 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"} ]
Se userOption
è JSON
, la pipeline archivia
il documento nel formato JSON di BigQuery. BigQuery
supporta i dati JSON utilizzando il tipo di dati
JSON.
Per ulteriori informazioni, consulta la pagina
Utilizzo dei dati JSON in GoogleSQL.
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. Ad esempio,
my-db
. - collection: nome della raccolta all'interno del database MongoDB. Ad esempio,
my-collection
. - userOption:
FLATTEN
,JSON
oNONE
.FLATTEN
comprime i documenti in un unico livello.JSON
memorizza il documento in formato JSON BigQuery.NONE
memorizza l'intero documento come STRINGA in formato JSON. Il valore predefinito è NONE. - 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, l'intera stringa di connessione URI di MongoDB deve essere passata in forma 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 Write (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 exactly-once, imposta il parametro sufalse
. Questo parametro si applica solo quandouseStorageWriteApi
ètrue
. Il valore predefinito èfalse
. - bigQuerySchemaPath: il percorso Cloud Storage dello schema JSON 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, vedi Esempi di 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:
Parametro | Descrizione |
---|---|
javascriptDocumentTransformGcsPath |
La posizione Cloud Storage del file JavaScript. |
javascriptDocumentTransformFunctionName |
Il nome della funzione JavaScript. |
Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.
Specifiche della funzione
La funzione definita dall'utente ha le seguenti specifiche:
userOption
è NONE
, l'oggetto JSON deve includere
una proprietà denominata _id
che contiene 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 delle regioni in cui puoi eseguire un job Dataflow, consulta Località di Dataflow.
- Dal menu a discesa Modello di dataflow, seleziona the MongoDB to BigQuery template.
- Nei campi dei parametri forniti, inserisci i valori dei parametri.
- 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 progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome univoco del job 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 l'ultima versione del modello, disponibile nella cartella principale senza data nel 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 si trova 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
: il tuo URI MongoDB.DATABASE
: il tuo database MongoDB.COLLECTION
: la tua raccolta MongoDB.USER_OPTION
: FLATTEN, JSON o NONE.
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 progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome univoco del job 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 l'ultima versione del modello, disponibile nella cartella principale senza data nel 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 si trova 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
: il tuo URI MongoDB.DATABASE
: il tuo database MongoDB.COLLECTION
: la tua raccolta MongoDB.USER_OPTION
: FLATTEN, JSON o NONE.
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.