Modelo do JDBC para BigQuery

Use o modelo JDBC para BigQuery do Dataproc sem servidor para extrair dados de bancos de dados JDBC para o BigQuery.

Este modelo oferece suporte aos seguintes bancos de dados como entrada:

  • MySQL
  • PostgreSQL
  • Microsoft SQL Server
  • Oracle

Use o modelo

Execute o modelo usando a CLI gcloud ou a API Dataproc.

gcloudREST

Antes de usar os dados do comando abaixo, faça estas substituições:

  • PROJECT_ID: obrigatório. O ID do projeto Google Cloud listado nas Configurações do 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. Acesse gs://dataproc-templates-binaries ou execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelo disponíveis.
  • 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 fazer 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
  • DATASET e TABLE: obrigatório. Conjunto de dados e tabela de destino do BigQuery.
  • As variáveis a seguir são usadas para construir o JDBC_CONNECTION_URL necessário:
    • JDBC_HOST
    • JDBC_PORT
    • JDBC_DATABASE ou, no Oracle, JDBC_SERVICE
    • JDBC_USERNAME
    • JDBC_PASSWORD

    Crie o JDBC_CONNECTION_URL usando um dos seguintes 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=JDBC_PASSWORD
  • DRIVER: obrigatório. O driver JDBC que será 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
  • QUERY: obrigatório. Consulta SQL para extrair dados do JDBC.
  • MODE: obrigatório. Modo de gravação para a saída do BigQuery. Opções: append, overwrite, ignore ou errorifexists.
  • TEMP_BUCKET: obrigatório. Nome do bucket do Cloud Storage. Esse bucket é usado para carregar o BigQuery.

    Exemplo: gs://dataproc-templates/jdbc_to_cloud_storage_output

  • INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, PARTITIONS: opcional. Se usado, todos os parâmetros abaixo 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 usada para determinar o passo da partição.
    • UPPERBOUND:limite superior da coluna de partição da tabela de entrada do JDBC usada para decidir o avanço da partição.
    • PARTITIONS:o número máximo de partições que pode ser usado para paralelismo de leituras e gravações de tabelas. Se especificado, esse valor é usado para a conexão de entrada e saída JDBC. Padrão: 10.
  • FETCHSIZE: opcional. Quantas linhas serão buscadas por ida e volta. Padrão: 10.
  • TEMPVIEW e SQL_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL ao carregar dados no BigQuery. TEMPVIEW é o nome da visualização temporária, e SQL_QUERY é a instrução de consulta. TEMPVIEW e o nome da tabela em SQL_QUERY precisam ser iguais.
  • 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 pares propriedade do Spark=value.
  • LABEL e LABEL_VALUE: opcional. Lista separada por vírgulas de pares label=value.
  • LOG_LEVEL: opcional. Nível de registro. Pode ser ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. Padrão: INFO.
  • 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 um 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=JDBCTOBIGQUERY \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" \
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" \
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" \
    --templateProperty jdbctobq.write.mode="MODE" \
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" \
    --templateProperty jdbctobq.sql="QUERY" \
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" \
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" \
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" \
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" \
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" \
    --templateProperty jdbctobq.temp.table="TEMPVIEW" \
    --templateProperty jdbctobq.temp.query="SQL_QUERY"
 
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=JDBCTOBIGQUERY `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" `
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" `
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" `
    --templateProperty jdbctobq.write.mode="MODE" `
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" `
    --templateProperty jdbctobq.sql="QUERY" `
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" `
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" `
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" `
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" `
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" `
    --templateProperty jdbctobq.temp.table="TEMPVIEW" `
    --templateProperty jdbctobq.temp.query="SQL_QUERY"
 
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=JDBCTOBIGQUERY ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty jdbctobq.bigquery.location="DATASET.TABLE" ^
    --templateProperty jdbctobq.jdbc.url="JDBC_CONNECTION_URL" ^
    --templateProperty jdbctobq.jdbc.driver.class.name="DRIVER" ^
    --templateProperty jdbctobq.write.mode="MODE" ^
    --templateProperty jdbctobq.temp.gcs.bucket="TEMP_BUCKET" ^
    --templateProperty jdbctobq.sql="QUERY" ^
    --templateProperty jdbctobq.sql.numPartitions="PARTITIONS" ^
    --templateProperty jdbctobq.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^
    --templateProperty jdbctobq.sql.lowerBound="LOWERBOUND" ^
    --templateProperty jdbctobq.sql.upperBound="UPPERBOUND" ^
    --templateProperty jdbctobq.jdbc.fetchsize="FETCHSIZE" ^
    --templateProperty jdbctobq.temp.table="TEMPVIEW" ^
    --templateProperty jdbctobq.temp.query="SQL_QUERY"

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PROJECT_ID: obrigatório. O ID do projeto Google Cloud listado nas Configurações do 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. Acesse gs://dataproc-templates-binaries ou execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelo disponíveis.
  • 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 fazer 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
  • DATASET e TABLE: obrigatório. Conjunto de dados e tabela de destino do BigQuery.
  • As variáveis a seguir são usadas para construir o JDBC_CONNECTION_URL necessário:
    • JDBC_HOST
    • JDBC_PORT
    • JDBC_DATABASE ou, no Oracle, JDBC_SERVICE
    • JDBC_USERNAME
    • JDBC_PASSWORD

    Crie o JDBC_CONNECTION_URL usando um dos seguintes 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=JDBC_PASSWORD
  • DRIVER: obrigatório. O driver JDBC que será 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
  • QUERY: obrigatório. Consulta SQL para extrair dados do JDBC.
  • MODE: obrigatório. Modo de gravação para a saída do BigQuery. Opções: append, overwrite, ignore ou errorifexists.
  • TEMP_BUCKET: obrigatório. Nome do bucket do Cloud Storage. Esse bucket é usado para carregar o BigQuery.

    Exemplo: gs://dataproc-templates/jdbc_to_cloud_storage_output

  • INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, PARTITIONS: opcional. Se usado, todos os parâmetros abaixo 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 usada para determinar o passo da partição.
    • UPPERBOUND:limite superior da coluna de partição da tabela de entrada do JDBC usada para decidir o avanço da partição.
    • PARTITIONS:o número máximo de partições que pode ser usado para paralelismo de leituras e gravações de tabelas. Se especificado, esse valor é usado para a conexão de entrada e saída JDBC. Padrão: 10.
  • FETCHSIZE: opcional. Quantas linhas serão buscadas por ida e volta. Padrão: 10.
  • TEMPVIEW e SQL_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL ao carregar dados no BigQuery. TEMPVIEW é o nome da visualização temporária, e SQL_QUERY é a instrução de consulta. TEMPVIEW e o nome da tabela em SQL_QUERY precisam ser iguais.
  • 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 pares propriedade do Spark=value.
  • LABEL e LABEL_VALUE: opcional. Lista separada por vírgulas de pares label=value.
  • LOG_LEVEL: opcional. Nível de registro. Pode ser ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. Padrão: INFO.
  • 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 um 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 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","JDBCTOBIGQUERY",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","jdbctobq.bigquery.location=DATASET.TABLE",
      "--templateProperty","jdbctobq.jdbc.url=JDBC_CONNECTION_URL",
      "--templateProperty","jdbctobq.jdbc.driver.class.name=DRIVER",
      "--templateProperty","jdbctobq.sql=QUERY",
      "--templateProperty","jdbctobq.write.mode=MODE",
      "--templateProperty","jdbctobq.temp.gcs.bucket=TEMP_BUCKET",
      "--templateProperty","jdbctobq.sql.partitionColumn=INPUT_PARTITION_COLUMN",
      "--templateProperty","jdbctobq.sql.lowerBound=LOWERBOUND",
      "--templateProperty","jdbctobq.sql.upperBound=UPPERBOUND",
      "--templateProperty","jdbctobq.sql.numPartitions=PARTITIONS",
      "--templateProperty","jdbctobq.jdbc.fetchsize=FETCHSIZE"
    ],
    "jarFileUris": [
      "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar","gs://JDBC_CONNECTOR_GCS_PATH"
    ]
  }
}

Para enviar a solicitação, expanda uma destas opções:

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir: 

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"

Salve o corpo da solicitação em um arquivo com o nome request.json e execute o comando a seguir: 

$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

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"
  }
}