Template Teks Cloud Storage ke BigQuery dengan Python UDF

Teks Cloud Storage ke BigQuery dengan pipeline Python UDF adalah pipeline batch yang membaca file teks yang disimpan di Cloud Storage, mengubahnya menggunakan fungsi yang ditentukan pengguna (UDF) Python, dan menambahkan hasilnya ke tabel BigQuery.

Persyaratan pipeline

  • Buat file JSON yang mendeskripsikan skema BigQuery Anda.

    Pastikan ada array JSON tingkat atas yang berjudul BigQuery Schema dan bahwa kontennya mengikuti pola {"name": "COLUMN_NAME", "type": "DATA_TYPE"}.

    Template batch Teks ke BigQuery Cloud Storage tidak mendukung pengimporan data ke kolom STRUCT (Record) di tabel BigQuery target.

    JSON berikut menjelaskan contoh skema BigQuery:

    {
      "BigQuery Schema": [
        {
          "name": "name",
          "type": "STRING"
        },
        {
          "name": "age",
          "type": "INTEGER"
        },
      ]
    }
    
  • Buat file Python (.py) dengan fungsi UDF yang menyediakan logika untuk mengubah baris teks. Fungsi Anda harus menampilkan string JSON.

    Misalnya, fungsi ini membagi setiap baris file CSV dan menampilkan string JSON setelah mengubah nilai.

    import json
    def process(value):
      data = value.split(',')
      obj = { 'name': data[0], 'age': int(data[1]) }
      return json.dumps(obj)
    

Parameter template

Parameter Deskripsi
JSONPath Jalur gs:// ke file JSON yang menentukan skema BigQuery, yang disimpan di Cloud Storage. Contoh, gs://path/to/my/schema.json.
pythonExternalTextTransformGcsPath URI Cloud Storage file kode Python yang menentukan fungsi yang ditentukan pengguna (UDF) yang ingin Anda gunakan. Misalnya, gs://my-bucket/my-udfs/my_file.py.
pythonExternalTextTransformFunctionName Nama fungsi yang ditentukan pengguna (UDF) Python yang ingin Anda gunakan.
inputFilePattern Jalur gs:// ke teks di Cloud Storage yang ingin Anda proses. Misalnya, gs://path/to/my/text/data.txt.
outputTable Nama tabel BigQuery yang ingin Anda buat untuk menyimpan data yang diproses. Jika Anda menggunakan kembali tabel BigQuery yang sudah ada, data akan ditambahkan ke tabel tujuan. Misalnya, my-project-name:my-dataset.my-table.
bigQueryLoadingTemporaryDirectory Direktori sementara untuk proses pemuatan BigQuery. Misalnya, gs://my-bucket/my-files/temp_dir.
useStorageWriteApi Opsional: Jika true, pipeline akan menggunakan BigQuery Storage Write API. Nilai defaultnya adalah false. Untuk informasi selengkapnya, lihat Menggunakan Storage Write API.
useStorageWriteApiAtLeastOnce Opsional: Saat menggunakan Storage Write API, menentukan semantik penulisan. Untuk menggunakan semantik minimal satu kali, tetapkan parameter ini ke true. Untuk menggunakan semantik tepat satu kali, tetapkan parameter ke false. Parameter ini hanya berlaku jika useStorageWriteApi adalah true. Nilai defaultnya adalah false.

Fungsi yang ditentukan pengguna

Anda juga dapat memperluas template ini dengan menulis fungsi yang ditentukan pengguna (UDF). Template memanggil UDF untuk setiap elemen input. Payload elemen diserialisasi sebagai string JSON. Untuk mengetahui informasi selengkapnya, lihat Membuat fungsi yang ditentukan pengguna untuk template Dataflow.

Spesifikasi fungsi

UDF memiliki spesifikasi berikut:

  • Input: baris teks dari file input Cloud Storage.
  • Output: string JSON yang cocok dengan skema tabel tujuan BigQuery.

Menjalankan template

Konsol

  1. Buka halaman Create job from template Dataflow.
  2. Buka Buat tugas dari template
  3. Di kolom Job name, masukkan nama pekerjaan yang unik.
  4. Opsional: Untuk Endpoint regional, pilih nilai dari menu drop-down. Region default-nya adalah us-central1.

    Untuk daftar region tempat Anda dapat menjalankan tugas Dataflow, lihat Lokasi Dataflow.

  5. Dari menu drop-down Dataflow template, pilih the Text Files on Cloud Storage to BigQuery with Python UDF (Batch) template.
  6. Di kolom parameter yang disediakan, masukkan parameter value Anda.
  7. Klik Run job.

gcloud

Di shell atau terminal Anda, jalankan template:

gcloud dataflow flex-template run JOB_NAME \
    --template-file-gcs-location gs://dataflow-templates-REGION_NAME/VERSION/flex/GCS_Text_to_BigQuery_Xlang \
    --region REGION_NAME \
    --parameters \
pythonExternalTextTransformFunctionName=PYTHON_FUNCTION,\
JSONPath=PATH_TO_BIGQUERY_SCHEMA_JSON,\
pythonExternalTextTransformGcsPath=PATH_TO_PYTHON_UDF_FILE,\
inputFilePattern=PATH_TO_TEXT_DATA,\
outputTable=BIGQUERY_TABLE,\
bigQueryLoadingTemporaryDirectory=PATH_TO_TEMP_DIR_ON_GCS

Ganti kode berikut:

  • PROJECT_ID: ID project Google Cloud tempat Anda ingin menjalankan tugas Dataflow
  • JOB_NAME: nama pekerjaan unik pilihan Anda
  • VERSION: versi template yang ingin Anda gunakan

    Anda dapat menggunakan nilai berikut:

  • REGION_NAME: region tempat Anda ingin men-deploy tugas Dataflow, misalnya us-central1
  • PYTHON_FUNCTION: Nama fungsi yang ditentukan pengguna (UDF) Python yang ingin Anda gunakan.
  • PATH_TO_BIGQUERY_SCHEMA_JSON: jalur Cloud Storage ke file JSON yang berisi definisi skema
  • PATH_TO_PYTHON_UDF_FILE: URI Cloud Storage file kode Python yang menentukan fungsi yang ditentukan pengguna (UDF) yang ingin Anda gunakan. Contoh, gs://my-bucket/my-udfs/my_file.py.
  • PATH_TO_TEXT_DATA: jalur Cloud Storage ke set data teks Anda
  • BIGQUERY_TABLE: nama tabel BigQuery Anda
  • PATH_TO_TEMP_DIR_ON_GCS: jalur Cloud Storage Anda ke direktori sementara

API

Untuk menjalankan template menggunakan REST API, kirim permintaan HTTP POST. Untuk 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": {
        "pythonExternalTextTransformFunctionName": "PYTHON_FUNCTION",
        "JSONPath": "PATH_TO_BIGQUERY_SCHEMA_JSON",
        "pythonExternalTextTransformGcsPath": "PATH_TO_PYTHON_UDF_FILE",
        "inputFilePattern":"PATH_TO_TEXT_DATA",
        "outputTable":"BIGQUERY_TABLE",
        "bigQueryLoadingTemporaryDirectory": "PATH_TO_TEMP_DIR_ON_GCS"
      },
      "containerSpecGcsPath": "gs://dataflow-templates-LOCATION/VERSION/flex/GCS_Text_to_BigQuery_Xlang",
   }
}

Ganti kode berikut:

  • PROJECT_ID: ID project Google Cloud tempat Anda ingin menjalankan tugas Dataflow
  • JOB_NAME: nama pekerjaan unik pilihan Anda
  • VERSION: versi template yang ingin Anda gunakan

    Anda dapat menggunakan nilai berikut:

  • LOCATION: region tempat Anda ingin men-deploy tugas Dataflow, misalnya us-central1
  • PYTHON_FUNCTION: Nama fungsi yang ditentukan pengguna (UDF) Python yang ingin Anda gunakan.
  • PATH_TO_BIGQUERY_SCHEMA_JSON: jalur Cloud Storage ke file JSON yang berisi definisi skema
  • PATH_TO_PYTHON_UDF_FILE: URI Cloud Storage file kode Python yang menentukan fungsi yang ditentukan pengguna (UDF) yang ingin Anda gunakan. Contoh, gs://my-bucket/my-udfs/my_file.py.
  • PATH_TO_TEXT_DATA: jalur Cloud Storage ke set data teks Anda
  • BIGQUERY_TABLE: nama tabel BigQuery Anda
  • PATH_TO_TEMP_DIR_ON_GCS: jalur Cloud Storage Anda ke direktori sementara

Langkah selanjutnya