Modelo do JDBC para Cloud Storage
Use o modelo do Dataproc Serverless JDBC para Cloud Storage para extrair dados de bancos de dados JDBC para o Cloud Storage.
Este modelo oferece suporte aos seguintes bancos de dados como entrada:
- MySQL
- PostgreSQL
- Microsoft SQL Server
- Oracle
Use o modelo
Executar o modelo usando a CLI gcloud ou o Dataproc API.
gcloud
Antes de usar os dados do comando abaixo, faça estas substituições:
- PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM.
- REGION: obrigatório. Região do Compute Engine.
- SUBNET: opcional. Se uma sub-rede não for especificada, a sub-rede
na REGIÃO especificada na rede
default
será selecionada.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 arquivo, em que o jar do conector JDBC é armazenado. Use os comandos a seguir para fazer o download de conectores JDBC para upload no 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 variáveis a seguir são usadas para criar o
JDBC_CONNECTION_URL:
- JDBC_HOST
- JDBC_PORT
- JDBC_DATABASE ou, para o Oracle, JDBC_SERVICE
- JDBC_USERNAME
- JDBC_PASSWORD
Crie a JDBC_CONNECTION_URL usando uma das seguintes opções: formatos específicos do conector:
- 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: obrigatório. O driver JDBC usado para
a conexã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:
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro
,parquet
,csv
oujson
. Padrão:avro
. Observação: seavro
, adicione "file:///usr/lib/spark/connector/spark-avro.jar
" à flagjars
da CLI gcloud ou ao campo da API.Exemplo (o prefixo
file://
faz referência a um arquivo JAR do Dataproc sem servidor):--jars=file:///usr/lib/spark/connector/spark-avro.jar,
[, ... outros potes] - MODE: obrigatório. Modo de gravação para a saída do Cloud Storage.
Opções:
append
,overwrite
,ignore
, ouerrorifexists
. - 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
. Acesse gs://dataproc-templates-binaries ou executegcloud storage ls gs://dataproc-templates-binaries
para listar as versões de modelo disponíveis. - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Cloud Storage
caminho em que a saída será armazenada.
Exemplo:
gs://dataproc-templates/jdbc_to_cloud_storage_output
- LOG_LEVEL: opcional. Nível de geração de registros. Pode ser
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. Padrão:INFO
. - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS: opcional. Se usado, todos os parâmetros
a seguir precisam ser especificados:
- INPUT_PARTITION_COLUMN: nome da coluna de partição da tabela de entrada do JDBC.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do JDBC usado para determinar o o salto de partição.
- UPPERBOUND:limite superior da coluna de partição da tabela de entrada do JDBC usado para decidir o salto da partição.
- NUM_PARTITIONS::o número máximo de partições que podem ser usadas para paralelismo de leituras e gravações de tabelas.
Se especificado, esse valor será usado para a conexão de entrada e saída do JDBC. Padrão:
10
.
- OUTPUT_PARTITION_COLUMN: opcional. Nome da coluna da partição de saída.
- FETCHSIZE: opcional. Quantas linhas buscar por ida e volta. Padrão: 10.
- QUERY ou QUERY_FILE: obrigatório.
Defina
QUERY
ouQUERY_FILE
para especificar a consulta a ser usada para extrair dados do JDBC - TEMP_VIEW e TEMP_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados no Cloud Storage. TEMPVIEW precisa ser o mesmo nome da tabela usado na consulta e TEMP_QUERY é a instrução da consulta.
- SERVICE_ACCOUNT: opcional. Se não forem fornecidos, os conta de serviço padrão do Compute Engine é usado.
- PROPERTY e PROPERTY_VALUE:
Opcional. Lista separada por vírgulas de
pares propriedade do Spark=
value
. - LABEL e LABEL_VALUE:
Opcional. Lista separada por vírgulas de pares
label
=value
. - JDBC_SESSION_INIT: opcional. Declaração de inicialização de sessão para ler modelos Java.
-
KMS_KEY: opcional. A chave do Cloud Key Management Service a ser usada para criptografia. Se uma chave não for especificada, os dados serão criptografados em repouso usando uma chave pertencente e gerenciada pelo Google.
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 \ --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
Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: obrigatório. O ID do seu projeto do Google Cloud listado em Configurações do IAM.
- REGION: obrigatório. Região do Compute Engine.
- SUBNET: opcional. Se uma sub-rede não for especificada, ela
na REGIÃO especificada da rede
default
está selecionada.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 arquivo, em que o jar do conector JDBC é armazenado. Use os comandos a seguir para fazer o download de conectores JDBC para upload no 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 variáveis a seguir são usadas para criar o
JDBC_CONNECTION_URL:
- JDBC_HOST
- JDBC_PORT
- JDBC_DATABASE ou, para o Oracle, JDBC_SERVICE
- JDBC_USERNAME
- JDBC_PASSWORD
Crie a JDBC_CONNECTION_URL usando uma das seguintes opções: formatos específicos do conector:
- 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: obrigatório. O driver JDBC usado para
a conexã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:
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro
,parquet
,csv
oujson
. Padrão:avro
. Observação: seavro
, adicione "file:///usr/lib/spark/connector/spark-avro.jar
" à flagjars
da CLI gcloud ou ao campo da API.Exemplo (o prefixo
file://
faz referência a um arquivo JAR do Dataproc sem servidor):--jars=file:///usr/lib/spark/connector/spark-avro.jar,
[, ... outros potes] - MODE: obrigatório. Modo de gravação para a saída do Cloud Storage.
Opções:
append
,overwrite
,ignore
, ouerrorifexists
. - TEMPLATE_VERSION: obrigatório. Especifique
latest
para a versão mais recente versão do modelo ou a data de uma versão específica, por exemplo,2023-03-17_v0.1.0-beta
Acesse gs://dataproc-templates-binaries ou executegcloud storage ls gs://dataproc-templates-binaries
para listar as versões de modelo disponíveis. - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage em que a saída será armazenada.
Exemplo:
gs://dataproc-templates/jdbc_to_cloud_storage_output
- LOG_LEVEL: opcional. Nível de geração de registros. Pode ser
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. Padrão:INFO
. - INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND,
NUM_PARTITIONS: opcional. Se usado, todos os parâmetros
a seguir precisam ser especificados:
- INPUT_PARTITION_COLUMN: nome da coluna de partição da tabela de entrada do JDBC.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do JDBC usado para determinar o o salto de partição.
- UPPERBOUND:limite superior da coluna de partição da tabela de entrada do JDBC usado para decidir o salto da partição.
- NUM_PARTITIONS::o número máximo de partições que podem ser usadas para paralelismo de leituras e gravações de tabelas.
Se especificado, esse valor será usado para a conexão de entrada e saída do JDBC. Padrão:
10
.
- OUTPUT_PARTITION_COLUMN: opcional. Nome da coluna da partição de saída.
- FETCHSIZE: opcional. Quantas linhas buscar por ida e volta. Padrão: 10.
- QUERY ou QUERY_FILE: obrigatório.
Defina
QUERY
ouQUERY_FILE
para especificar a consulta a ser usada para extrair dados do JDBC - TEMP_VIEW e TEMP_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados no Cloud Storage. TEMPVIEW precisa ser o mesmo nome da tabela usado na consulta e TEMP_QUERY é a instrução da consulta.
- SERVICE_ACCOUNT: opcional. Se não for fornecido, a conta de serviço padrão do Compute Engine será usada.
- PROPERTY e PROPERTY_VALUE:
Opcional. Lista separada por vírgulas de
Propriedade do Spark=pares
value
. - LABEL e LABEL_VALUE:
opcional. Lista separada por vírgulas de pares
label
=value
. - JDBC_SESSION_INIT: opcional. Declaração de inicialização de sessão para ler modelos Java.
-
KMS_KEY: opcional. A chave do Cloud Key Management Service a ser usada para criptografia. Se uma chave não for especificada, os dados serão criptografados em repouso usando uma chave pertencente e gerenciada pelo Google.
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 da solicitação:
{ "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" ] } }
Para enviar a solicitação, expanda uma destas opções:
Você receberá uma resposta JSON semelhante a esta:
{ "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" } }