JDBC 到 Cloud Spanner 範本
使用「Serverless for Apache Spark JDBC to Spanner」範本,將資料從 JDBC 資料庫擷取至 Spanner。
這個範本支援下列資料庫做為輸入:
- MySQL
- PostgreSQL
- Microsoft SQL Server
- Oracle
使用範本
使用 gcloud CLI 或 Dataproc API 執行範本。
gcloud
使用下方的任何指令資料之前,請先替換以下項目:
- 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
網路中指定 REGION 的子網路。示例:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
- JDBC_CONNECTOR_CLOUD_STORAGE_PATH:必填。完整的 Cloud Storage 路徑,包括儲存 JDBC 連接器 JAR 的檔案名稱。您可以使用下列指令下載 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
- MySQL:
-
下列變數用於建構必要 JDBC_CONNECTION_URL:
- JDBC_HOST、 JDBC_PORT、 JDBC_DATABASE,或 Oracle 的 JDBC_SERVICE、 JDBC_USERNAME、 和 JDBC_PASSWORD:必要。 JDBC 主機、通訊埠、資料庫、使用者名稱和密碼。
-
MySQL:
jdbc:mysql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
-
PostgreSQL:
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
- MySQL:
- QUERY 或 QUERY_FILE:必填。
設定其中一個
QUERY
或QUERY_FILE
,指定要用來從 JDBC 擷取資料的查詢 - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS:選用。如果使用,則必須指定下列所有參數:
- INPUT_PARTITION_COLUMN:JDBC 輸入資料表分區資料欄名稱。
- LOWERBOUND:用於判斷分區步幅的 JDBC 輸入資料表分區資料欄範圍下限。
- UPPERBOUND:用於決定分區步幅的 JDBC 輸入資料表分區資料欄範圍上限。
- NUM_PARTITIONS:可用於平行處理資料表讀寫作業的分區數量上限。如果指定這個值,系統會用於 JDBC 輸入和輸出連線。預設值:
10
。
- FETCHSIZE:選用。每次往返要擷取的列數。預設值為 10。
- JDBC_SESSION_INIT:選用。工作階段 初始化陳述式,用於讀取 Java 範本。
- TEMPVIEW 和 SQL_QUERY:選用。 載入資料至 Spanner 時,您可以使用這兩個選用參數套用 Spark SQL 轉換。 TEMPVIEW 是臨時檢視表名稱,SQL_QUERY 則是查詢陳述式。TEMPVIEW 和 SQL_QUERY 中的資料表名稱必須相符。
- INSTANCE:必填。Spanner 執行個體 ID。
- SPANNER_DATABASE:必填。Spanner 資料庫 ID。
- TABLE:必填。Spanner 輸出資料表名稱。
- SPANNER_JDBC_DIALECT:必填。Spanner JDBC 方言。
選項:
googlesql
或postgresql
。預設值為googlesql
。 - MODE:選用。Spanner 輸出內容的寫入模式。
選項:
Append
、Overwrite
、Ignore
或ErrorIfExists
。預設值為ErrorIfExists
。 - PRIMARY_KEY:必填。建立 Spanner 輸出資料表時,需要以半形逗號分隔的主鍵資料欄。
- 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=JDBCTOSPANNER \ --templateProperty log.level="LOG_LEVEL" \ --templateProperty project.id="PROJECT_ID" \ --templateProperty jdbctospanner.jdbc.url="JDBC_CONNECTION_URL" \ --templateProperty jdbctospanner.jdbc.driver.class.name="DRIVER" \ --templateProperty jdbctospanner.jdbc.fetchsize="FETCHSIZE" \ --templateProperty jdbctospanner.jdbc.sessioninitstatement="JDBC_SESSION_INIT" \ --templateProperty jdbctospanner.sql="QUERY" \ --templateProperty jdbctospanner.sql.file="QUERY_FILE" \ --templateProperty jdbctospanner.sql.numPartitions="NUM_PARTITIONS" \ --templateProperty jdbctospanner.sql.partitionColumn="INPUT_PARTITION_COLUMN" \ --templateProperty jdbctospanner.sql.lowerBound="LOWERBOUND" \ --templateProperty jdbctospanner.sql.upperBound="UPPERBOUND" \ --templateProperty jdbctospanner.output.instance="INSTANCE" \ --templateProperty jdbctospanner.output.database="SPANNER_DATABASE" \ --templateProperty jdbctospanner.output.table="TABLE" \ --templateProperty jdbctospanner.output.saveMode="MODE" \ --templateProperty jdbctospanner.output.primaryKey="PRIMARY_KEY" \ --templateProperty jdbctospanner.output.batch.size="BATCHSIZE" \ --templateProperty jdbctospanner.temp.table="TEMPVIEW" \ --templateProperty jdbctospanner.temp.query="SQL_QUERY" \ --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT"
Windows (PowerShell)
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=JDBCTOSPANNER ` --templateProperty log.level="LOG_LEVEL" ` --templateProperty project.id="PROJECT_ID" ` --templateProperty jdbctospanner.jdbc.url="JDBC_CONNECTION_URL" ` --templateProperty jdbctospanner.jdbc.driver.class.name="DRIVER" ` --templateProperty jdbctospanner.jdbc.fetchsize="FETCHSIZE" ` --templateProperty jdbctospanner.jdbc.sessioninitstatement="JDBC_SESSION_INIT" ` --templateProperty jdbctospanner.sql="QUERY" ` --templateProperty jdbctospanner.sql.file="QUERY_FILE" ` --templateProperty jdbctospanner.sql.numPartitions="NUM_PARTITIONS" ` --templateProperty jdbctospanner.sql.partitionColumn="INPUT_PARTITION_COLUMN" ` --templateProperty jdbctospanner.sql.lowerBound="LOWERBOUND" ` --templateProperty jdbctospanner.sql.upperBound="UPPERBOUND" ` --templateProperty jdbctospanner.output.instance="INSTANCE" ` --templateProperty jdbctospanner.output.database="SPANNER_DATABASE" ` --templateProperty jdbctospanner.output.table="TABLE" ` --templateProperty jdbctospanner.output.saveMode="MODE" ` --templateProperty jdbctospanner.output.primaryKey="PRIMARY_KEY" ` --templateProperty jdbctospanner.output.batch.size="BATCHSIZE" ` --templateProperty jdbctospanner.temp.table="TEMPVIEW" ` --templateProperty jdbctospanner.temp.query="SQL_QUERY" ` --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT"
Windows (cmd.exe)
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=JDBCTOSPANNER ^ --templateProperty log.level="LOG_LEVEL" ^ --templateProperty project.id="PROJECT_ID" ^ --templateProperty jdbctospanner.jdbc.url="JDBC_CONNECTION_URL" ^ --templateProperty jdbctospanner.jdbc.driver.class.name="DRIVER" ^ --templateProperty jdbctospanner.jdbc.fetchsize="FETCHSIZE" ^ --templateProperty jdbctospanner.jdbc.sessioninitstatement="JDBC_SESSION_INIT" ^ --templateProperty jdbctospanner.sql="QUERY" ^ --templateProperty jdbctospanner.sql.file="QUERY_FILE" ^ --templateProperty jdbctospanner.sql.numPartitions="NUM_PARTITIONS" ^ --templateProperty jdbctospanner.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^ --templateProperty jdbctospanner.sql.lowerBound="LOWERBOUND" ^ --templateProperty jdbctospanner.sql.upperBound="UPPERBOUND" ^ --templateProperty jdbctospanner.output.instance="INSTANCE" ^ --templateProperty jdbctospanner.output.database="SPANNER_DATABASE" ^ --templateProperty jdbctospanner.output.table="TABLE" ^ --templateProperty jdbctospanner.output.saveMode="MODE" ^ --templateProperty jdbctospanner.output.primaryKey="PRIMARY_KEY" ^ --templateProperty jdbctospanner.output.batch.size="BATCHSIZE" ^ --templateProperty jdbctospanner.temp.table="TEMPVIEW" ^ --templateProperty jdbctospanner.temp.query="SQL_QUERY" ^ --templateProperty spanner.jdbc.dialect="SPANNER_JDBC_DIALECT"
REST
使用任何要求資料之前,請先替換以下項目:
- 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
網路中指定 REGION 的子網路。示例:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
- JDBC_CONNECTOR_CLOUD_STORAGE_PATH:必填。完整的 Cloud Storage 路徑,包括儲存 JDBC 連接器 JAR 的檔案名稱。您可以使用下列指令下載 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
- MySQL:
-
下列變數用於建構必要 JDBC_CONNECTION_URL:
- JDBC_HOST、 JDBC_PORT、 JDBC_DATABASE,或 Oracle 的 JDBC_SERVICE、 JDBC_USERNAME、 和 JDBC_PASSWORD:必要。 JDBC 主機、通訊埠、資料庫、使用者名稱和密碼。
-
MySQL:
jdbc:mysql://JDBC_HOST:JDBC_PORT/JDBC_DATABASE?user=JDBC_USERNAME&password=JDBC_PASSWORD
-
PostgreSQL:
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
- MySQL:
- QUERY 或 QUERY_FILE:必填。
設定其中一個
QUERY
或QUERY_FILE
,指定要用來從 JDBC 擷取資料的查詢 - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS:選用。如果使用,則必須指定下列所有參數:
- INPUT_PARTITION_COLUMN:JDBC 輸入資料表分區資料欄名稱。
- LOWERBOUND:用於判斷分區步幅的 JDBC 輸入資料表分區資料欄範圍下限。
- UPPERBOUND:用於決定分區步幅的 JDBC 輸入資料表分區資料欄範圍上限。
- NUM_PARTITIONS:可用於平行處理資料表讀寫作業的分區數量上限。如果指定這個值,系統會用於 JDBC 輸入和輸出連線。預設值:
10
。
- FETCHSIZE:選用。每次往返要擷取的列數。預設值為 10。
- JDBC_SESSION_INIT:選用。工作階段 初始化陳述式,用於讀取 Java 範本。
- TEMPVIEW 和 SQL_QUERY:選用。 載入資料至 Spanner 時,您可以使用這兩個選用參數套用 Spark SQL 轉換。 TEMPVIEW 是臨時檢視表名稱,SQL_QUERY 則是查詢陳述式。TEMPVIEW 和 SQL_QUERY 中的資料表名稱必須相符。
- INSTANCE:必填。Spanner 執行個體 ID。
- SPANNER_DATABASE:必填。Spanner 資料庫 ID。
- TABLE:必填。Spanner 輸出資料表名稱。
- SPANNER_JDBC_DIALECT:必填。Spanner JDBC 方言。
選項:
googlesql
或postgresql
。預設值為googlesql
。 - MODE:選用。Spanner 輸出內容的寫入模式。
選項:
Append
、Overwrite
、Ignore
或ErrorIfExists
。預設值為ErrorIfExists
。 - PRIMARY_KEY:必填。建立 Spanner 輸出資料表時,需要以半形逗號分隔的主鍵資料欄。
- 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","JDBCTOSPANNER", "--templateProperty","log.level=LOG_LEVEL", "--templateProperty","project.id=PROJECT_ID", "--templateProperty","jdbctospanner.jdbc.url=JDBC_CONNECTION_URL", "--templateProperty","jdbctospanner.jdbc.driver.class.name=DRIVER", "--templateProperty","jdbctospanner.jdbc.fetchsize=FETCHSIZE", "--templateProperty","jdbctospanner.jdbc.sessioninitstatement=JDBC_SESSION_INIT", "--templateProperty","jdbctospanner.sql=QUERY", "--templateProperty","jdbctospanner.sql.file=QUERY_FILE", "--templateProperty","jdbctospanner.sql.numPartitions=NUM_PARTITIONS", "--templateProperty","jdbctospanner.sql.partitionColumn=INPUT_PARTITION_COLUMN", "--templateProperty","jdbctospanner.sql.lowerBound=LOWERBOUND", "--templateProperty","jdbctospanner.sql.upperBound=UPPERBOUND", "--templateProperty","jdbctospanner.output.instance=INSTANCE", "--templateProperty","jdbctospanner.output.database=SPANNER_DATABASE", "--templateProperty","jdbctospanner.output.table=TABLE", "--templateProperty","jdbctospanner.output.saveMode=MODE", "--templateProperty","jdbctospanner.output.primaryKey=PRIMARY_KEY", "--templateProperty","jdbctospanner.output.batch.size=BATCHSIZE", "--templateProperty","jdbctospanner.temp.table=TEMPVIEW", "--templateProperty","jdbctospanner.temp.query=SQL_QUERY", "--templateProperty spanner.jdbc.dialect=SPANNER_JDBC_DIALECT" ], "jarFileUris": [ "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar" ] } }
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 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" } }