Template ini membuat pipeline batch yang membaca dokumen dari MongoDB dan menuliskannya ke BigQuery.
Jika ingin mengambil data aliran perubahan MongoDB, Anda dapat menggunakan template MongoDB ke BigQuery (CDC).
Persyaratan pipeline
- Set data BigQuery target harus ada.
- Instance MongoDB sumber harus dapat diakses dari mesin pekerja Dataflow.
Format output
Format rekaman output bergantung pada nilai parameter userOption
. Jika userOption
adalah
NONE
, output memiliki skema berikut. Kolom
source_data
berisi dokumen dalam format JSON.
[ {"name":"id","type":"STRING"}, {"name":"source_data","type":"STRING"}, {"name":"timestamp","type":"TIMESTAMP"} ]
Jika userOption
adalah FLATTEN
, pipeline akan meratakan
dokumen dan menulis kolom tingkat teratas sebagai kolom tabel. Misalnya,
anggap dokumen dalam koleksi MongoDB berisi kolom berikut:
"_id"
(string
)"title"
(string
)"genre"
(string
)
Dengan menggunakan FLATTEN
, output memiliki skema berikut. Kolom
timestamp
ditambahkan oleh template.
[ {"name":"_id","type":"STRING"}, {"name":"title","type":"STRING"}, {"name":"genre","type":"STRING"}, {"name":"timestamp","type":"TIMESTAMP"} ]
Jika userOption
adalah JSON
, pipeline akan menyimpan
dokumen dalam format JSON BigQuery. BigQuery
memiliki dukungan bawaan untuk data JSON menggunakan jenis data
JSON.
Untuk mengetahui informasi selengkapnya, lihat
Bekerja dengan data JSON di GoogleSQL.
Parameter template
Parameter yang diperlukan
- mongoDbUri: URI koneksi MongoDB dalam format
mongodb+srv://:@.
. - database: Database di MongoDB untuk membaca koleksi. Contoh,
my-db
. - collection: Nama koleksi di dalam database MongoDB. Contoh,
my-collection
. - userOption:
FLATTEN
,JSON
, atauNONE
.FLATTEN
meratakan dokumen ke satu tingkat.JSON
menyimpan dokumen dalam format JSON BigQuery.NONE
menyimpan seluruh dokumen sebagai STRING berformat JSON. Default: NONE. - outputTableSpec: Tabel BigQuery yang akan ditulis. Contoh,
bigquery-project:dataset.output_table
.
Parameter opsional
- KMSEncryptionKey: Kunci Enkripsi Cloud KMS untuk mendekripsi string koneksi URI MongoDB. Jika kunci Cloud KMS diteruskan, string koneksi URI mongodb harus diteruskan dalam bentuk terenkripsi. Contoh,
projects/your-project/locations/global/keyRings/your-keyring/cryptoKeys/your-key
. - filter: Filter Bson dalam format json. Contoh,
{ "val": { $gt: 0, $lt: 9 }}
. - useStorageWriteApi: Jika
true
, pipeline menggunakan BigQuery Storage Write API (https://cloud.google.com/bigquery/docs/write-api). Nilai defaultnya adalahfalse
. Untuk mengetahui informasi selengkapnya, lihat Menggunakan Storage Write API (https://beam.apache.org/documentation/io/built-in/google-bigquery/#storage-write-api). - useStorageWriteApiAtLeastOnce: Saat menggunakan Storage Write API, menentukan semantik penulisan. Untuk menggunakan semantik minimal satu kali (https://beam.apache.org/documentation/io/built-in/google-bigquery/#at-least-once-semantics), tetapkan parameter ini ke
true
. Untuk menggunakan semantik tepat satu kali, tetapkan parameter kefalse
. Parameter ini hanya berlaku jikauseStorageWriteApi
adalahtrue
. Nilai defaultnya adalahfalse
. - bigQuerySchemaPath: Jalur Cloud Storage untuk skema JSON BigQuery. Contoh,
gs://your-bucket/your-schema.json
. - javascriptDocumentTransformGcsPath: URI Cloud Storage dari file
.js
yang menentukan fungsi yang ditentukan pengguna (UDF) JavaScript yang akan digunakan. Misalnya,gs://your-bucket/your-transforms/*.js
. - javascriptDocumentTransformFunctionName: Nama fungsi yang ditentukan pengguna (UDF) JavaScript yang akan digunakan. Misalnya, jika kode fungsi JavaScript Anda adalah
myTransform(inJson) { /*...do stuff...*/ }
, maka nama fungsinya adalah myTransform. Untuk contoh UDF JavaScript, lihat Contoh UDF (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples). Contohnya,transform
Fungsi yang ditentukan pengguna
Secara opsional, Anda dapat memperluas template ini dengan menulis fungsi yang ditentukan pengguna (UDF) di JavaScript. Template memanggil UDF untuk setiap elemen input. Payload elemen diserialisasi sebagai string JSON.
Untuk menggunakan UDF, upload file JavaScript ke Cloud Storage dan tetapkan parameter template berikut:
Parameter | Deskripsi |
---|---|
javascriptDocumentTransformGcsPath |
Lokasi file JavaScript di Cloud Storage. |
javascriptDocumentTransformFunctionName |
Nama fungsi JavaScript. |
Untuk mengetahui informasi selengkapnya, lihat Membuat fungsi yang ditentukan pengguna untuk template Dataflow.
Spesifikasi fungsi
UDF memiliki spesifikasi berikut:
userOption
adalah NONE
, objek JSON harus menyertakan
properti bernama _id
yang berisi ID dokumen.Menjalankan template
Konsol
- Buka halaman Dataflow Create job from template. Buka Membuat tugas dari template
- Di kolom Nama tugas, masukkan nama tugas yang unik.
- Opsional: Untuk Endpoint regional, pilih nilai dari menu drop-down. Region
default-nya adalah
us-central1
.Untuk mengetahui daftar region tempat Anda dapat menjalankan tugas Dataflow, lihat Lokasi Dataflow.
- Dari menu drop-down Template Dataflow, pilih the MongoDB to BigQuery template.
- Di kolom parameter yang disediakan, masukkan nilai parameter Anda.
- Klik Run job.
gcloud
Di shell atau terminal Anda, jalankan template:
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
Ganti kode berikut:
PROJECT_ID
: ID Google Cloud project tempat Anda ingin menjalankan tugas DataflowJOB_NAME
: nama tugas unik pilihan AndaREGION_NAME
: region tempat Anda ingin men-deploy tugas Dataflow—misalnya,us-central1
VERSION
: versi template yang ingin Anda gunakanAnda dapat menggunakan nilai berikut:
latest
untuk menggunakan versi template terbaru, yang tersedia di folder induk tanpa tanggal di bucket— gs://dataflow-templates-REGION_NAME/latest/- nama versi, seperti
2023-09-12-00_RC00
, untuk menggunakan versi template tertentu, yang dapat ditemukan bertingkat di folder induk yang diberi tanggal di bucket— gs://dataflow-templates-REGION_NAME/
OUTPUT_TABLE_SPEC
: nama tabel BigQuery target Anda.MONGO_DB_URI
: URI MongoDB Anda.DATABASE
: database MongoDB Anda.COLLECTION
: koleksi MongoDB Anda.USER_OPTION
: FLATTEN, JSON, atau NONE.
API
Untuk menjalankan template menggunakan REST API, kirim permintaan HTTP POST. Untuk mengetahui informasi selengkapnya tentang
API dan cakupan otorisasinya, lihat
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", } }
Ganti kode berikut:
PROJECT_ID
: ID Google Cloud project tempat Anda ingin menjalankan tugas DataflowJOB_NAME
: nama tugas unik pilihan AndaLOCATION
: region tempat Anda ingin men-deploy tugas Dataflow—misalnya,us-central1
VERSION
: versi template yang ingin Anda gunakanAnda dapat menggunakan nilai berikut:
latest
untuk menggunakan versi template terbaru, yang tersedia di folder induk tanpa tanggal di bucket— gs://dataflow-templates-REGION_NAME/latest/- nama versi, seperti
2023-09-12-00_RC00
, untuk menggunakan versi template tertentu, yang dapat ditemukan bertingkat di folder induk yang diberi tanggal di bucket— gs://dataflow-templates-REGION_NAME/
OUTPUT_TABLE_SPEC
: nama tabel BigQuery target Anda.MONGO_DB_URI
: URI MongoDB Anda.DATABASE
: database MongoDB Anda.COLLECTION
: koleksi MongoDB Anda.USER_OPTION
: FLATTEN, JSON, atau NONE.
Langkah berikutnya
- Pelajari template Dataflow.
- Lihat daftar template yang disediakan Google.