Modelo de JDBC para Cloud Spanner
Use o modelo Serverless for Apache Spark JDBC to Spanner para extrair dados de bases de dados JDBC para o Spanner.
Este modelo suporta as seguintes bases de dados como entrada:
- MySQL
- PostgreSQL
- Microsoft SQL Server
- Oracle
Use o modelo
Execute o modelo através da CLI gcloud ou da API Dataproc.
gcloud
Antes de usar qualquer um dos dados de comandos abaixo, faça as seguintes substituições:
- PROJECT_ID: obrigatório. O seu Google Cloud ID do projeto indicado nas definições de IAM.
- REGION: obrigatório. Região do Compute Engine.
- TEMPLATE_VERSION: obrigatório. Especifique
latest
para a versão mais recente do modelo ou a data de uma versão específica, por exemplo,2023-03-17_v0.1.0-beta
(visite gs://dataproc-templates-binaries ou executegcloud storage ls gs://dataproc-templates-binaries
para listar as versões de modelos disponíveis). - SUBNET: opcional. Se não for especificada uma sub-rede, é selecionada a sub-rede na REGIÃO especificada na rede
default
.Exemplo:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
- JDBC_CONNECTOR_CLOUD_STORAGE_PATH: obrigatório. O caminho completo do Cloud Storage, incluindo o nome do ficheiro, onde o JAR do conetor JDBC está armazenado. Pode usar os seguintes comandos para transferir
conetores JDBC para carregar para o 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:
-
As seguintes variáveis são usadas para criar o elemento JDBC_CONNECTION_URL obrigatório:
- JDBC_HOST, JDBC_PORT, JDBC_DATABASE ou, para a Oracle, JDBC_SERVICE, JDBC_USERNAME, e JDBC_PASSWORD: obrigatório. Anfitrião, porta, base de dados, nome de utilizador e palavra-passe 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: obrigatório. O controlador JDBC que vai ser usado para a ligação:
- 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 ou QUERY_FILE: obrigatório.
Defina
QUERY
ouQUERY_FILE
para especificar a consulta a usar para extrair dados do JDBC - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS: opcional. Se forem usados, têm de ser especificados todos os seguintes
parâmetros:
- INPUT_PARTITION_COLUMN: nome da coluna de partição da tabela de entrada JDBC.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada JDBC usado para determinar o intervalo de partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada JDBC usado para decidir o intervalo de partição.
- NUM_PARTITIONS: o número máximo de partições que podem ser usadas para o paralelismo de leituras e escritas de tabelas.
Se especificado, este valor é usado para a ligação de entrada e saída JDBC. Predefinição:
10
.
- FETCHSIZE: opcional. O número de linhas a obter por viagem de ida e volta. Predefinição: 10.
- JDBC_SESSION_INIT: opcional. Declaração de inicialização de sessão para ler modelos Java.
- TEMPVIEW e SQL_QUERY: opcional. Pode usar estes dois parâmetros opcionais para aplicar uma transformação Spark SQL enquanto carrega dados para o Spanner. TEMPVIEW é o nome da vista temporária e SQL_QUERY é a declaração de consulta. TEMPVIEW e o nome da tabela em SQL_QUERY têm de corresponder.
- INSTANCE: obrigatório. ID da instância do Spanner.
- SPANNER_DATABASE: obrigatório. ID da base de dados do Spanner.
- TABLE: obrigatório. Nome da tabela de saída do Spanner.
- SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner.
Opções:
googlesql
oupostgresql
. A predefinição égooglesql
. - MODE: opcional. Modo de escrita para saída do Spanner.
Opções:
Append
,Overwrite
,Ignore
ouErrorIfExists
. A predefinição éErrorIfExists
. - PRIMARY_KEY: obrigatório. Colunas de chave principal separadas por vírgulas necessárias ao criar a tabela de saída do Spanner.
- SERVICE_ACCOUNT: opcional. Se não for fornecida, é usada a conta de serviço predefinida do Compute Engine.
- PROPERTY e PROPERTY_VALUE:
Opcional. Lista separada por vírgulas de pares propriedade do Spark=
value
. - LABEL e LABEL_VALUE:
Opcional. Lista de pares
label
=value
separados por vírgulas. - LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes:
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. Predefinição:INFO
. -
KMS_KEY: opcional. A chave do Cloud Key Management Service a usar para encriptação. Se não for especificada uma chave, os dados são encriptados em repouso através de uma Google-owned and Google-managed encryption key.
Exemplo:
projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
Execute o seguinte comando:
Linux, macOS ou 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
Antes de usar qualquer um dos dados do pedido, faça as seguintes substituições:
- PROJECT_ID: obrigatório. O seu Google Cloud ID do projeto indicado nas definições de IAM.
- REGION: obrigatório. Região do Compute Engine.
- TEMPLATE_VERSION: obrigatório. Especifique
latest
para a versão mais recente do modelo ou a data de uma versão específica, por exemplo,2023-03-17_v0.1.0-beta
(visite gs://dataproc-templates-binaries ou executegcloud storage ls gs://dataproc-templates-binaries
para listar as versões de modelos disponíveis). - SUBNET: opcional. Se não for especificada uma sub-rede, é selecionada a sub-rede na REGIÃO especificada na rede
default
.Exemplo:
projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME
- JDBC_CONNECTOR_CLOUD_STORAGE_PATH: obrigatório. O caminho completo do Cloud Storage, incluindo o nome do ficheiro, onde o JAR do conetor JDBC está armazenado. Pode usar os seguintes comandos para transferir
conetores JDBC para carregar para o 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:
-
As seguintes variáveis são usadas para criar o elemento JDBC_CONNECTION_URL obrigatório:
- JDBC_HOST, JDBC_PORT, JDBC_DATABASE ou, para a Oracle, JDBC_SERVICE, JDBC_USERNAME, e JDBC_PASSWORD: obrigatório. Anfitrião, porta, base de dados, nome de utilizador e palavra-passe 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: obrigatório. O controlador JDBC que vai ser usado para a ligação:
- 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 ou QUERY_FILE: obrigatório.
Defina
QUERY
ouQUERY_FILE
para especificar a consulta a usar para extrair dados do JDBC - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS: opcional. Se forem usados, têm de ser especificados todos os seguintes
parâmetros:
- INPUT_PARTITION_COLUMN: nome da coluna de partição da tabela de entrada JDBC.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada JDBC usado para determinar o intervalo de partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada JDBC usado para decidir o intervalo de partição.
- NUM_PARTITIONS: o número máximo de partições que podem ser usadas para o paralelismo de leituras e escritas de tabelas.
Se especificado, este valor é usado para a ligação de entrada e saída JDBC. Predefinição:
10
.
- FETCHSIZE: opcional. O número de linhas a obter por viagem de ida e volta. Predefinição: 10.
- JDBC_SESSION_INIT: opcional. Declaração de inicialização de sessão para ler modelos Java.
- TEMPVIEW e SQL_QUERY: opcional. Pode usar estes dois parâmetros opcionais para aplicar uma transformação Spark SQL enquanto carrega dados para o Spanner. TEMPVIEW é o nome da vista temporária e SQL_QUERY é a declaração de consulta. TEMPVIEW e o nome da tabela em SQL_QUERY têm de corresponder.
- INSTANCE: obrigatório. ID da instância do Spanner.
- SPANNER_DATABASE: obrigatório. ID da base de dados do Spanner.
- TABLE: obrigatório. Nome da tabela de saída do Spanner.
- SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner.
Opções:
googlesql
oupostgresql
. A predefinição égooglesql
. - MODE: opcional. Modo de escrita para saída do Spanner.
Opções:
Append
,Overwrite
,Ignore
ouErrorIfExists
. A predefinição éErrorIfExists
. - PRIMARY_KEY: obrigatório. Colunas de chave principal separadas por vírgulas necessárias ao criar a tabela de saída do Spanner.
- SERVICE_ACCOUNT: opcional. Se não for fornecida, é usada a conta de serviço predefinida do Compute Engine.
- PROPERTY e PROPERTY_VALUE:
Opcional. Lista separada por vírgulas de pares propriedade do Spark=
value
. - LABEL e LABEL_VALUE:
Opcional. Lista de pares
label
=value
separados por vírgulas. - LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes:
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. Predefinição:INFO
. -
KMS_KEY: opcional. A chave do Cloud Key Management Service a usar para encriptação. Se não for especificada uma chave, os dados são encriptados em repouso através de uma Google-owned and Google-managed encryption key.
Exemplo:
projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME
Método HTTP e URL:
POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches
Corpo JSON do pedido:
{ "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" ] } }
Para enviar o seu pedido, expanda uma destas opções:
Deve receber uma resposta JSON semelhante à seguinte:
{ "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" } }