JDBC to BigQuery 模板

使用 Dataproc Serverless JDBC to BigQuery 模板将数据从 JDBC 数据库提取到 BigQuery。

此模板支持以下数据库作为输入：

  • MySQL
  • PostgreSQL
  • Microsoft SQL Server
  • Oracle

使用模板

使用 gcloud CLI 或 Dataproc API 运行模板。

gcloudREST

在使用下面的命令数据之前，请先进行以下替换：

  • PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID。
  • REGION：必填。Compute Engine 区域。
  • TEMPLATE_VERSION：必填。为最新模板版本指定 latest，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta（访问 gs://dataproc-templates-binaries 或运行 gcloud storage ls gs://dataproc-templates-binaries 以列出可用的模板版本）。
  • SUBNET：可选。如果未指定子网，系统会选择 default 网络中指定区域中的子网。

    示例： projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

  • JDBC_CONNECTOR_CLOUD_STORAGE_PATH：必填。存储 JDBC 连接器 jar 的完整 Cloud Storage 路径（包括文件名）。您可以使用以下命令下载 JDBC 连接器，以便上传到 Cloud Storage：
    • MySQL： 
      wget http://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.30.tar.gz
    • Postgres SQL： 
      wget https://jdbc.postgresql.org/download/postgresql-42.2.6.jar
    • Microsoft SQL Server： 
        
wget https://repo1.maven.org/maven2/com/microsoft/sqlserver/mssql-jdbc/6.4.0.jre8/mssql-jdbc-6.4.0.jre8.jar
    • Oracle： 
      wget https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/21.7.0.0/ojdbc8-21.7.0.0.jar
  • DATASET 和 TABLE：必需。目标 BigQuery 数据集和表。
  • 以下变量用于构建所需的 JDBC_CONNECTION_URL：
    • JDBC_HOST
    • JDBC_PORT
    • JDBC_DATABASE，对于 Oracle，则为 JDBC_SERVICE
    • JDBC_USERNAME
    • JDBC_PASSWORD

    使用以下任一特定于连接器的格式构建 JDBC_CONNECTION_URL：

    • MySQL： 
      jdbc:mysql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
    • Postgres SQL： 
      jdbc:postgresql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
    • Microsoft SQL Server： 
        
jdbc:sqlserver://JDBC_HOST:JDBC_PORT;databaseName=JDBC_DATABASE;user=JDBC_USERNAME;password=JDBC_PASSWORD
    • Oracle： 
      jdbc:oracle:thin:@//JDBC_HOST:JDBC_PORT/JDBC_SERVICE?user=JDBC_USERNAME&password=JDBC_PASSWORD
  • DRIVER：必填。将用于连接的 JDBC 驱动程序：
    • MySQL： 
      com.mysql.cj.jdbc.Driver
    • Postgres SQL： 
      org.postgresql.Driver
    • Microsoft SQL Server： 
        
com.microsoft.sqlserver.jdbc.SQLServerDriver
    • Oracle： 
      oracle.jdbc.driver.OracleDriver
  • QUERY：必填。用于从 JDBC 中提取数据的 SQL 查询。
  • MODE：必填。BigQuery 输出的写入模式。 选项：append、overwrite、ignore 或 errorifexists。
  • TEMP_BUCKET：必填。Cloud Storage 存储分区名称。此存储分区用于 BigQuery 加载。

    示例： gs://dataproc-templates/jdbc_to_cloud_storage_output

  • INPUT_PARTITION_COLUMN、LOWERBOUND、UPPERBOUND、PARTITIONS：可选。如果使用，则必须指定以下所有参数：
    • INPUT_PARTITION_COLUMN：JDBC 输入表分区列名称。
    • LOWERBOUND：用于确定分区步长的 JDBC 输入表分区列下限。
    • UPPERBOUND：用于确定分区步长的 JDBC 输入表分区列上限。
    • PARTITIONS：可用于表读写并行处理的分区数量上限。 如果指定，此值将用于 JDBC 输入和输出连接。默认值：10。
  • FETCHSIZE：可选。每次往返要提取的行数。默认值：10。
  • TEMPVIEW 和 SQL_QUERY：可选。 您可以在将数据加载到 BigQuery 时使用这两个可选参数来应用 Spark SQL 转换。 TEMPVIEW 是临时视图名称，SQL_QUERY 是查询语句。TEMPVIEW 和 SQL_QUERY 中的表名称必须匹配。
  • SERVICE_ACCOUNT：可选。如果未提供，则系统会使用默认 Compute Engine 服务账号。
  • PROPERTY 和 PROPERTY_VALUE：可选。以英文逗号分隔的 Spark 属性=value 对列表。
  • LABEL 和 LABEL_VALUE：可选。以英文逗号分隔的 label=value 对列表。
  • LOG_LEVEL：可选。日志记录级别。可以是 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN 中的一个。默认值：INFO。
  • KMS_KEY：可选。要用于加密的 Cloud Key Management Service 密钥。如果未指定密钥，系统会使用 Google-owned and Google-managed encryption key对数据进行静态加密。

    示例： projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

执行以下命令：

Linux、macOS 或 Cloud Shell

 
gcloud dataproc batches submit spark \
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
    --version="1.2" \
    --project="PROJECT_ID" \
    --region="REGION" \
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar,JDBC_CONNECTOR_CLOUD_STORAGE_PATH" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=JDBCTOBIGQUERY \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" \
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" \
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" \
    --templateProperty jdbctobq.write.mode="MODE" \
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" \
    --templateProperty jdbctobq.sql="QUERY" \
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" \
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" \
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" \
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" \
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" \
    --templateProperty jdbctobq.temp.table="TEMPVIEW" \
    --templateProperty jdbctobq.temp.query="SQL_QUERY"
 
gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --version="1.2" `
    --project="PROJECT_ID" `
    --region="REGION" `
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar,JDBC_CONNECTOR_CLOUD_STORAGE_PATH" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=JDBCTOBIGQUERY `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" `
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" `
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" `
    --templateProperty jdbctobq.write.mode="MODE" `
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" `
    --templateProperty jdbctobq.sql="QUERY" `
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" `
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" `
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" `
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" `
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" `
    --templateProperty jdbctobq.temp.table="TEMPVIEW" `
    --templateProperty jdbctobq.temp.query="SQL_QUERY"
 
gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --version="1.2" ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --jars="gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar,JDBC_CONNECTOR_CLOUD_STORAGE_PATH" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=JDBCTOBIGQUERY ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" ^
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" ^
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" ^
    --templateProperty jdbctobq.write.mode="MODE" ^
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" ^
    --templateProperty jdbctobq.sql="QUERY" ^
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" ^
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" ^
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" ^
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" ^
    --templateProperty jdbctobq.temp.table="TEMPVIEW" ^
    --templateProperty jdbctobq.temp.query="SQL_QUERY"

在使用任何请求数据之前，请先进行以下替换：

  • PROJECT_ID：必填。IAM 设置中列出的 Google Cloud 项目 ID。
  • REGION：必填。Compute Engine 区域。
  • TEMPLATE_VERSION：必填。为最新模板版本指定 latest，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta（访问 gs://dataproc-templates-binaries 或运行 gcloud storage ls gs://dataproc-templates-binaries 以列出可用的模板版本）。
  • SUBNET：可选。如果未指定子网，系统会选择 default 网络中指定区域中的子网。

    示例： projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

  • JDBC_CONNECTOR_CLOUD_STORAGE_PATH：必填。存储 JDBC 连接器 jar 的完整 Cloud Storage 路径（包括文件名）。您可以使用以下命令下载 JDBC 连接器，以便上传到 Cloud Storage：
    • MySQL： 
      wget http://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-5.1.30.tar.gz
    • Postgres SQL： 
      wget https://jdbc.postgresql.org/download/postgresql-42.2.6.jar
    • Microsoft SQL Server： 
        
wget https://repo1.maven.org/maven2/com/microsoft/sqlserver/mssql-jdbc/6.4.0.jre8/mssql-jdbc-6.4.0.jre8.jar
    • Oracle： 
      wget https://repo1.maven.org/maven2/com/oracle/database/jdbc/ojdbc8/21.7.0.0/ojdbc8-21.7.0.0.jar
  • DATASET 和 TABLE：必需。目标 BigQuery 数据集和表。
  • 以下变量用于构建所需的 JDBC_CONNECTION_URL：
    • JDBC_HOST
    • JDBC_PORT
    • JDBC_DATABASE，对于 Oracle，则为 JDBC_SERVICE
    • JDBC_USERNAME
    • JDBC_PASSWORD

    使用以下任一特定于连接器的格式构建 JDBC_CONNECTION_URL：

    • MySQL： 
      jdbc:mysql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
    • Postgres SQL： 
      jdbc:postgresql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
    • Microsoft SQL Server： 
        
jdbc:sqlserver://JDBC_HOST:JDBC_PORT;databaseName=JDBC_DATABASE;user=JDBC_USERNAME;password=JDBC_PASSWORD
    • Oracle： 
      jdbc:oracle:thin:@//JDBC_HOST:JDBC_PORT/JDBC_SERVICE?user=JDBC_USERNAME&password=JDBC_PASSWORD
  • DRIVER：必填。将用于连接的 JDBC 驱动程序：
    • MySQL： 
      com.mysql.cj.jdbc.Driver
    • Postgres SQL： 
      org.postgresql.Driver
    • Microsoft SQL Server： 
        
com.microsoft.sqlserver.jdbc.SQLServerDriver
    • Oracle： 
      oracle.jdbc.driver.OracleDriver
  • QUERY：必填。用于从 JDBC 中提取数据的 SQL 查询。
  • MODE：必填。BigQuery 输出的写入模式。 选项：append、overwrite、ignore 或 errorifexists。
  • TEMP_BUCKET：必填。Cloud Storage 存储分区名称。此存储分区用于 BigQuery 加载。

    示例： gs://dataproc-templates/jdbc_to_cloud_storage_output

  • INPUT_PARTITION_COLUMN、LOWERBOUND、UPPERBOUND、PARTITIONS：可选。如果使用，则必须指定以下所有参数：
    • INPUT_PARTITION_COLUMN：JDBC 输入表分区列名称。
    • LOWERBOUND：用于确定分区步长的 JDBC 输入表分区列下限。
    • UPPERBOUND：用于确定分区步长的 JDBC 输入表分区列上限。
    • PARTITIONS：可用于表读写并行处理的分区数量上限。 如果指定，此值将用于 JDBC 输入和输出连接。默认值：10。
  • FETCHSIZE：可选。每次往返要提取的行数。默认值：10。
  • TEMPVIEW 和 SQL_QUERY：可选。 您可以在将数据加载到 BigQuery 时使用这两个可选参数来应用 Spark SQL 转换。 TEMPVIEW 是临时视图名称，SQL_QUERY 是查询语句。TEMPVIEW 和 SQL_QUERY 中的表名称必须匹配。
  • SERVICE_ACCOUNT：可选。如果未提供，则系统会使用默认 Compute Engine 服务账号。
  • PROPERTY 和 PROPERTY_VALUE：可选。以英文逗号分隔的 Spark 属性=value 对列表。
  • LABEL 和 LABEL_VALUE：可选。以英文逗号分隔的 label=value 对列表。
  • LOG_LEVEL：可选。日志记录级别。可以是 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN 中的一个。默认值：INFO。
  • KMS_KEY：可选。要用于加密的 Cloud Key Management Service 密钥。如果未指定密钥，系统会使用 Google-owned and Google-managed encryption key对数据进行静态加密。

    示例： projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

HTTP 方法和网址：

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

请求 JSON 正文：

{
  "environmentConfig": {
    "executionConfig": {
      "subnetworkUri": "SUBNET",
      "kmsKey": "KMS_KEY",
      "serviceAccount": "SERVICE_ACCOUNT"
    }
  },
  "labels": {
    "LABEL": "LABEL_VALUE"
  },
  "runtimeConfig": {
    "version": "1.2",
    "properties": {
      "PROPERTY": "PROPERTY_VALUE"
    }
  },
  "sparkBatch": {
    "mainClass": "com.google.cloud.dataproc.templates.main.DataProcTemplate",
    "args": [
      "--template","JDBCTOBIGQUERY",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","jdbctobq.bigquery.location=DATASET.TABLE",
      "--templateProperty","jdbctobq.jdbc.url=JDBC_CONNECTION_URL",
      "--templateProperty","jdbctobq.jdbc.driver.class.name=DRIVER",
      "--templateProperty","jdbctobq.sql=QUERY",
      "--templateProperty","jdbctobq.write.mode=MODE",
      "--templateProperty","jdbctobq.temp.gcs.bucket=TEMP_BUCKET",
      "--templateProperty","jdbctobq.sql.partitionColumn=INPUT_PARTITION_COLUMN",
      "--templateProperty","jdbctobq.sql.lowerBound=LOWERBOUND",
      "--templateProperty","jdbctobq.sql.upperBound=UPPERBOUND",
      "--templateProperty","jdbctobq.sql.numPartitions=PARTITIONS",
      "--templateProperty","jdbctobq.jdbc.fetchsize=FETCHSIZE"
    ],
    "jarFileUris": [
      "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar","gs://JDBC_CONNECTOR_GCS_PATH"
    ]
  }
}

如需发送您的请求，请展开以下选项之一：

将请求正文保存在名为 request.json 的文件中，然后执行以下命令： 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches"

将请求正文保存在名为 request.json 的文件中，然后执行以下命令： 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

{
  "name": "projects/PROJECT_ID/regions/REGION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dataproc.v1.BatchOperationMetadata",
    "batch": "projects/PROJECT_ID/locations/REGION/batches/BATCH_ID",
    "batchUuid": "de8af8d4-3599-4a7c-915c-798201ed1583",
    "createTime": "2023-02-24T03:31:03.440329Z",
    "operationType": "BATCH",
    "description": "Batch"
  }
}