本頁面由 Cloud Translation API 翻譯而成。

JDBC 到 Cloud Storage 範本

使用 Serverless for Apache Spark JDBC to Cloud Storage 範本，從 JDBC 資料庫將資料擷取至 Cloud Storage。

這個範本支援下列資料庫做為輸入：

MySQL
PostgreSQL
Microsoft SQL Server
Oracle

使用範本

使用 gcloud CLI 或 Dataproc API 執行範本。

gcloud

使用下方的任何指令資料之前，請先替換以下項目：

PROJECT_ID：必填。IAM 設定中列出的 Google Cloud 專案 ID。
REGION：必填。Compute Engine 區域。
SUBNET：選用。如未指定子網路，系統會選取 default 網路中指定 REGION 的子網路。
示例：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

下列變數用於建構必要 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=

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

FORMAT：必填。輸出資料格式。選項：avro、 parquet、csv 或 json。預設值：avro。 注意：如果 avro，您必須將「file:///usr/lib/spark/connector/spark-avro.jar」新增至 jars gcloud CLI 旗標或 API 欄位。
範例 (file:// 前置字元會參照 Serverless for Apache Spark JAR 檔案)：
--jars=file:///usr/lib/spark/connector/spark-avro.jar, [, ... other jars]
MODE：必填。Cloud Storage 輸出的寫入模式。選項：append、overwrite、ignore 或 errorifexists。
TEMPLATE_VERSION：必填。指定 latest 代表最新範本版本，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta (請前往 gs://dataproc-templates-binaries 或執行 gcloud storage ls gs://dataproc-templates-binaries，列出可用的範本版本)。
CLOUD_STORAGE_OUTPUT_PATH：必填。輸出內容的儲存位置 Cloud Storage 路徑。
示例：gs://dataproc-templates/jdbc_to_cloud_storage_output
LOG_LEVEL：選用。記錄層級。可設為 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN。預設值：INFO。
INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, NUM_PARTITIONS：選用。如果使用，則必須指定下列所有參數：
- INPUT_PARTITION_COLUMN：JDBC 輸入資料表分區資料欄名稱。
- LOWERBOUND：用於判斷分區步幅的 JDBC 輸入資料表分區資料欄範圍下限。
- UPPERBOUND：用於決定分區步幅的 JDBC 輸入資料表分區資料欄範圍上限。
- NUM_PARTITIONS:可用於平行處理資料表讀寫作業的分區數量上限。如果指定，這個值會用於 JDBC 輸入和輸出連線。預設值：10。
OUTPUT_PARTITION_COLUMN：選用。輸出分區資料欄名稱。
FETCHSIZE：選用。每次往返要擷取的列數。預設值為 10。
QUERY 或 QUERY_FILE：必填。設定其中一個 QUERY 或 QUERY_FILE，指定要用來從 JDBC 擷取資料的查詢
TEMP_VIEW 和 TEMP_QUERY：選用。您可以使用這兩個選用參數，在將資料載入 Cloud Storage 時套用 Spark SQL 轉換。 TEMPVIEW 必須與查詢中使用的資料表名稱相同，而 TEMP_QUERY 則是查詢陳述式。
SERVICE_ACCOUNT：選用。如未提供，系統會使用預設的 Compute Engine 服務帳戶。
PROPERTY 和 PROPERTY_VALUE：選用。以半形逗號分隔的 Spark 屬性=value 組合清單。
LABEL 和 LABEL_VALUE：選用。以半形逗號分隔的 label=value 配對清單。
JDBC_SESSION_INIT：選用。用於讀取 Java 範本的工作階段初始化陳述式。
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 \
    --project="PROJECT_ID" \
    --region="REGION" \
    --version="1.2" \
    --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=JDBCTOGCS \
    --templateProperty project.id="PROJECT_ID" \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty jdbctogcs.jdbc.url="JDBC_CONNECTION_URL" \
    --templateProperty jdbctogcs.jdbc.driver.class.name="DRIVER" \
    --templateProperty jdbctogcs.output.format="FORMAT" \
    --templateProperty jdbctogcs.output.location="CLOUD_STORAGE_OUTPUT_PATH" \
    --templateProperty jdbctogcs.sql="QUERY" \
    --templateProperty jdbctogcs.sql.file="QUERY_FILE" \
    --templateProperty jdbctogcs.sql.partitionColumn="INPUT_PARTITION_COLUMN" \
    --templateProperty jdbctogcs.sql.lowerBound="LOWERBOUND" \
    --templateProperty jdbctogcs.sql.upperBound="UPPERBOUND" \
    --templateProperty jdbctogcs.jdbc.fetchsize="FETCHSIZE" \
    --templateProperty jdbctogcs.sql.numPartitions="NUM_PARTITIONS" \
    --templateProperty jdbctogcs.write.mode="MODE" \
    --templateProperty dbctogcs.output.partition.col="OUTPUT_PARTITION_COLUMN" \
    --templateProperty jdbctogcs.temp.table="TEMP_VIEW" \
    --templateProperty jdbctogcs.temp.query="TEMP_QUERY"

Windows (PowerShell)

gcloud dataproc batches submit spark `
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
    --project="PROJECT_ID" `
    --region="REGION" `
    --version="1.2" `
    --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=JDBCTOGCS `
    --templateProperty project.id="PROJECT_ID" `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty jdbctogcs.jdbc.url="JDBC_CONNECTION_URL" `
    --templateProperty jdbctogcs.jdbc.driver.class.name="DRIVER" `
    --templateProperty jdbctogcs.output.format="FORMAT" `
    --templateProperty jdbctogcs.output.location="CLOUD_STORAGE_OUTPUT_PATH" `
    --templateProperty jdbctogcs.sql="QUERY" `
    --templateProperty jdbctogcs.sql.file="QUERY_FILE" `
    --templateProperty jdbctogcs.sql.partitionColumn="INPUT_PARTITION_COLUMN" `
    --templateProperty jdbctogcs.sql.lowerBound="LOWERBOUND" `
    --templateProperty jdbctogcs.sql.upperBound="UPPERBOUND" `
    --templateProperty jdbctogcs.jdbc.fetchsize="FETCHSIZE" `
    --templateProperty jdbctogcs.sql.numPartitions="NUM_PARTITIONS" `
    --templateProperty jdbctogcs.write.mode="MODE" `
    --templateProperty dbctogcs.output.partition.col="OUTPUT_PARTITION_COLUMN" `
    --templateProperty jdbctogcs.temp.table="TEMP_VIEW" `
    --templateProperty jdbctogcs.temp.query="TEMP_QUERY"

Windows (cmd.exe)

gcloud dataproc batches submit spark ^
    --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
    --project="PROJECT_ID" ^
    --region="REGION" ^
    --version="1.2" ^
    --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=JDBCTOGCS ^
    --templateProperty project.id="PROJECT_ID" ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty jdbctogcs.jdbc.url="JDBC_CONNECTION_URL" ^
    --templateProperty jdbctogcs.jdbc.driver.class.name="DRIVER" ^
    --templateProperty jdbctogcs.output.format="FORMAT" ^
    --templateProperty jdbctogcs.output.location="CLOUD_STORAGE_OUTPUT_PATH" ^
    --templateProperty jdbctogcs.sql="QUERY" ^
    --templateProperty jdbctogcs.sql.file="QUERY_FILE" ^
    --templateProperty jdbctogcs.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^
    --templateProperty jdbctogcs.sql.lowerBound="LOWERBOUND" ^
    --templateProperty jdbctogcs.sql.upperBound="UPPERBOUND" ^
    --templateProperty jdbctogcs.jdbc.fetchsize="FETCHSIZE" ^
    --templateProperty jdbctogcs.sql.numPartitions="NUM_PARTITIONS" ^
    --templateProperty jdbctogcs.write.mode="MODE" ^
    --templateProperty dbctogcs.output.partition.col="OUTPUT_PARTITION_COLUMN" ^
    --templateProperty jdbctogcs.temp.table="TEMP_VIEW" ^
    --templateProperty jdbctogcs.temp.query="TEMP_QUERY"

REST

使用任何要求資料之前，請先替換以下項目：

PROJECT_ID：必填。IAM 設定中列出的 Google Cloud 專案 ID。
REGION：必填。Compute Engine 區域。
SUBNET：選用。如未指定子網路，系統會選取 default 網路中指定 REGION 的子網路。
示例：projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

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

下列變數用於建構必要 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=

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

FORMAT：必填。輸出資料格式。選項：avro、 parquet、csv 或 json。預設值：avro。 注意：如果 avro，您必須將「file:///usr/lib/spark/connector/spark-avro.jar」新增至 jars gcloud CLI 旗標或 API 欄位。
範例 (file:// 前置字元會參照 Serverless for Apache Spark JAR 檔案)：
--jars=file:///usr/lib/spark/connector/spark-avro.jar, [, ... other jars]
MODE：必填。Cloud Storage 輸出的寫入模式。選項：append、overwrite、ignore 或 errorifexists。
TEMPLATE_VERSION：必填。指定 latest 代表最新範本版本，或指定特定版本的日期，例如 2023-03-17_v0.1.0-beta (請前往 gs://dataproc-templates-binaries 或執行 gcloud storage ls gs://dataproc-templates-binaries，列出可用的範本版本)。
CLOUD_STORAGE_OUTPUT_PATH：必填。輸出內容的儲存位置 Cloud Storage 路徑。
示例：gs://dataproc-templates/jdbc_to_cloud_storage_output
LOG_LEVEL：選用。記錄層級。可設為 ALL、DEBUG、ERROR、FATAL、INFO、OFF、TRACE 或 WARN。預設值：INFO。
INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, NUM_PARTITIONS：選用。如果使用，則必須指定下列所有參數：
- INPUT_PARTITION_COLUMN：JDBC 輸入資料表分區資料欄名稱。
- LOWERBOUND：用於判斷分區步幅的 JDBC 輸入資料表分區資料欄範圍下限。
- UPPERBOUND：用於決定分區步幅的 JDBC 輸入資料表分區資料欄範圍上限。
- NUM_PARTITIONS:可用於平行處理資料表讀寫作業的分區數量上限。如果指定，這個值會用於 JDBC 輸入和輸出連線。預設值：10。
OUTPUT_PARTITION_COLUMN：選用。輸出分區資料欄名稱。
FETCHSIZE：選用。每次往返要擷取的列數。預設值為 10。
QUERY 或 QUERY_FILE：必填。設定其中一個 QUERY 或 QUERY_FILE，指定要用來從 JDBC 擷取資料的查詢
TEMP_VIEW 和 TEMP_QUERY：選用。您可以使用這兩個選用參數，在將資料載入 Cloud Storage 時套用 Spark SQL 轉換。 TEMPVIEW 必須與查詢中使用的資料表名稱相同，而 TEMP_QUERY 則是查詢陳述式。
SERVICE_ACCOUNT：選用。如未提供，系統會使用預設的 Compute Engine 服務帳戶。
PROPERTY 和 PROPERTY_VALUE：選用。以半形逗號分隔的 Spark 屬性=value 組合清單。
LABEL 和 LABEL_VALUE：選用。以半形逗號分隔的 label=value 配對清單。
JDBC_SESSION_INIT：選用。用於讀取 Java 範本的工作階段初始化陳述式。
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=JDBCTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","project.id=PROJECT_ID",
      "--templateProperty","jdbctogcs.jdbc.url=JDBC_CONNECTION_URL",
      "--templateProperty","jdbctogcs.jdbc.driver.class.name=DRIVER",
      "--templateProperty","jdbctogcs.output.location=CLOUD_STORAGE_OUTPUT_PATH",
      "--templateProperty","jdbctogcs.write.mode=MODE",
      "--templateProperty","jdbctogcs.output.format=FORMAT",
      "--templateProperty","jdbctogcs.sql.numPartitions=NUM_PARTITIONS",
      "--templateProperty","jdbctogcs.jdbc.fetchsize=FETCHSIZE",
      "--templateProperty","jdbctogcs.sql=QUERY",
      "--templateProperty","jdbctogcs.sql.file=QUERY_FILE",
      "--templateProperty","jdbctogcs.sql.partitionColumn=INPUT_PARTITION_COLUMN",
      "--templateProperty","jdbctogcs.sql.lowerBound=LOWERBOUND",
      "--templateProperty","jdbctogcs.sql.upperBound=UPPERBOUND",
      "--templateProperty","jdbctogcs.output.partition.col=OUTPUT_PARTITION_COLUMN",
      "--templateProperty","jdbctogcs.temp.table=TEMP_VIEW",
      "--templateProperty","jdbctogcs.temp.query=TEMP_QUERY",
      "--templateProperty","jdbctogcs.jdbc.sessioninitstatement=JDBC_SESSION_INIT"
    ],
    "jarFileUris": [
      "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar", "JDBC_CONNECTOR_CLOUD_STORAGE_PATH"
    ]
  }
}

請展開以下其中一個選項，以傳送要求：

curl (Linux、macOS 或 Cloud Shell)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI，或已使用 Cloud Shell 自動登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

將要求主體儲存在名為 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"

PowerShell (Windows)

注意：下列指令假設您已執行 gcloud init 或 gcloud auth login，透過使用者帳戶登入 gcloud CLI。您可以執行 gcloud auth list，查看目前使用的帳戶。

將要求主體儲存在名為 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"
  }
}