Modelo de JDBC para o Cloud Storage
Use o modelo JDBC do Serverless para Apache Spark para o Cloud Storage para extrair dados de bases de dados JDBC para o Cloud Storage.
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.
- 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 obrigatório
JDBC_CONNECTION_URL:
- JDBC_HOST
- JDBC_PORT
- JDBC_DATABASE ou, para o Oracle, JDBC_SERVICE
- JDBC_USERNAME
- JDBC_PASSWORD
Construa o elemento JDBC_CONNECTION_URL usando um dos seguintes formatos específicos do conetor:
- 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 controlador JDBC 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:
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro,parquet,csvoujson. Predefinição:avro. Nota: seavro, tem de adicionar "file:///usr/lib/spark/connector/spark-avro.jar" à flag da CLI gcloudjarsou ao campo da API.Exemplo (o prefixo
file://faz referência a um ficheiro JAR do Serverless para Apache Spark):--jars=file:///usr/lib/spark/connector/spark-avro.jar,[, ... other jars] - MODE: obrigatório. Modo de escrita para a saída do Cloud Storage.
Opções:
append,overwrite,ignoreouerrorifexists. - TEMPLATE_VERSION: obrigatório. Especifique
latestpara 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-binariespara listar as versões de modelos disponíveis). - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage
onde o resultado vai ser armazenado.
Exemplo:
gs://dataproc-templates/jdbc_to_cloud_storage_output - LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes:
ALL,DEBUG,ERROR,FATAL,INFO,OFF,TRACEouWARN. Predefinição:INFO. - 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.
- OUTPUT_PARTITION_COLUMN: opcional. Nome da coluna de partição de saída.
- FETCHSIZE: opcional. O número de linhas a obter por viagem de ida e volta. Predefinição: 10.
- QUERY ou QUERY_FILE: obrigatório.
Defina
QUERYouQUERY_FILEpara especificar a consulta a usar para extrair dados do JDBC - TEMP_VIEW e TEMP_QUERY: opcional. Pode usar estes dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados para o Cloud Storage. TEMPVIEW tem de ser igual ao nome da tabela usado na consulta, e TEMP_QUERY é a declaração de consulta.
- 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=valueseparados por vírgulas. - JDBC_SESSION_INIT: opcional. Declaração de inicialização da sessão para ler modelos Java.
-
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 \ --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 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.
- 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 obrigatório
JDBC_CONNECTION_URL:
- JDBC_HOST
- JDBC_PORT
- JDBC_DATABASE ou, para o Oracle, JDBC_SERVICE
- JDBC_USERNAME
- JDBC_PASSWORD
Construa o elemento JDBC_CONNECTION_URL usando um dos seguintes formatos específicos do conetor:
- 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 controlador JDBC 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:
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro,parquet,csvoujson. Predefinição:avro. Nota: seavro, tem de adicionar "file:///usr/lib/spark/connector/spark-avro.jar" à flag da CLI gcloudjarsou ao campo da API.Exemplo (o prefixo
file://faz referência a um ficheiro JAR do Serverless para Apache Spark):--jars=file:///usr/lib/spark/connector/spark-avro.jar,[, ... other jars] - MODE: obrigatório. Modo de escrita para a saída do Cloud Storage.
Opções:
append,overwrite,ignoreouerrorifexists. - TEMPLATE_VERSION: obrigatório. Especifique
latestpara 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-binariespara listar as versões de modelos disponíveis). - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage
onde o resultado vai ser armazenado.
Exemplo:
gs://dataproc-templates/jdbc_to_cloud_storage_output - LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes:
ALL,DEBUG,ERROR,FATAL,INFO,OFF,TRACEouWARN. Predefinição:INFO. - 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.
- OUTPUT_PARTITION_COLUMN: opcional. Nome da coluna de partição de saída.
- FETCHSIZE: opcional. O número de linhas a obter por viagem de ida e volta. Predefinição: 10.
- QUERY ou QUERY_FILE: obrigatório.
Defina
QUERYouQUERY_FILEpara especificar a consulta a usar para extrair dados do JDBC - TEMP_VIEW e TEMP_QUERY: opcional. Pode usar estes dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados para o Cloud Storage. TEMPVIEW tem de ser igual ao nome da tabela usado na consulta, e TEMP_QUERY é a declaração de consulta.
- 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=valueseparados por vírgulas. - JDBC_SESSION_INIT: opcional. Declaração de inicialização da sessão para ler modelos Java.
-
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=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 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"
}
}