Modelo do JDBC para o Cloud Spanner

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

Este modelo é compatível com os 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.

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 em Configurações do IAM.
  • REGION: obrigatório. Região do Compute Engine.
  • TEMPLATE_VERSION: obrigatório. Especifique latest para a versão do modelo mais recente 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 gsutil 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 está armazenado. É possível usar os seguintes comandos 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
    • SQL do Postgres:
      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
  • As variáveis a seguir são usadas para criar o JDBC_CONNECTION_URL obrigatório:
    • JDBC_HOST, JDBC_PORT, JDBC_DATABASE ou, para Oracle, JDBC_SERVICE, JDBC_USERNAME e JDBC_PASSWORD: obrigatório. Host, porta, banco de dados, nome de usuário e senha do 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 driver JDBC que será usado para a conexão:
      • MySQL::
        com.mysql.cj.jdbc.Driver
      • SQL do Postgres:
        org.postgresql.Driver
      • Microsoft SQL Server:
          com.microsoft.sqlserver.jdbc.SQLServerDriver
      • Oracle:
        oracle.jdbc.driver.OracleDriver
    • QUERY ou QUERY_FILE: obrigatório. Defina QUERY ou QUERY_FILE para especificar a consulta a ser usada para extrair dados do JDBC
    • INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, NUM_PARTITIONS: opcional. Se usado, todos os parâmetros a seguir precisarão 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 salto da 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.
    • FETCHSIZE: opcional. Quantas linhas buscar por viagem de ida e volta. Padrão: 10.
    • JDBC_SESSION_INIT: opcional. Instrução de inicialização da sessão para ler modelos Java.
    • TEMPVIEW e SQL_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados no Spanner. 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 corresponder.
    • INSTANCE: obrigatório. ID da instância do Spanner.
    • SPANNER_DATABASE: obrigatório. ID do banco de dados do Spanner.
    • TABLE: obrigatório. Nome da tabela de saída do Spanner.
    • MODE: opcional. Modo de gravação para a saída do Spanner. Opções: Append, Overwrite, Ignore ou ErrorIfExists. O padrão é ErrorIfExists.
    • PRIMARY_KEY: obrigatório. Colunas de chave primária separadas por vírgula, necessárias ao criar a tabela de saída do Spanner.
    • SERVICE_ACCOUNT: opcional. Se não for fornecida, a conta de serviço padrão do Compute Engine será usada.
    • PROPERTY e PROPERTY_VALUE: opcionais. Lista separada por vírgulas de pares de propriedade do Spark=value.
    • LABEL e LABEL_VALUE: opcionais. Lista separada por vírgulas de pares label=value.
    • LOG_LEVEL: opcional. Nível de geração de registros. 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 uma chave pertencente e gerenciada pelo Google.

      Exemplo: projects/PROJECT_ID/regions/REGION/keyRings/KEY_RING_NAME/cryptoKeys/KEY_NAME

    Execute o comando a seguir:

    Linux, macOS ou Cloud Shell

    gcloud dataproc batches submit spark \
        --class=com.google.cloud.dataproc.templates.main.DataProcTemplate \
        --version="1.1" \
        --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" 
    
    
    

    Windows (PowerShell)

    gcloud dataproc batches submit spark `
        --class=com.google.cloud.dataproc.templates.main.DataProcTemplate `
        --version="1.1" `
        --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" 
    
    
    

    Windows (cmd.exe)

    gcloud dataproc batches submit spark ^
        --class=com.google.cloud.dataproc.templates.main.DataProcTemplate ^
        --version="1.1" ^
        --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" 
    
    
    

REST

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

  • PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado em Configurações do IAM.
  • REGION: obrigatório. Região do Compute Engine.
  • TEMPLATE_VERSION: obrigatório. Especifique latest para a versão do modelo mais recente 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 gsutil 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 está armazenado. É possível usar os seguintes comandos 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
    • SQL do Postgres:
      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
  • As variáveis a seguir são usadas para criar o JDBC_CONNECTION_URL obrigatório:
    • JDBC_HOST, JDBC_PORT, JDBC_DATABASE ou, para Oracle, JDBC_SERVICE, JDBC_USERNAME e JDBC_PASSWORD: obrigatório. Host, porta, banco de dados, nome de usuário e senha do 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 driver JDBC que será usado para a conexão:
      • MySQL::
        com.mysql.cj.jdbc.Driver
      • SQL do Postgres:
        org.postgresql.Driver
      • Microsoft SQL Server:
          com.microsoft.sqlserver.jdbc.SQLServerDriver
      • Oracle:
        oracle.jdbc.driver.OracleDriver
    • QUERY ou QUERY_FILE: obrigatório. Defina QUERY ou QUERY_FILE para especificar a consulta a ser usada para extrair dados do JDBC
    • INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND, NUM_PARTITIONS: opcional. Se usado, todos os parâmetros a seguir precisarão 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 salto da 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.
    • FETCHSIZE: opcional. Quantas linhas buscar por viagem de ida e volta. Padrão: 10.
    • JDBC_SESSION_INIT: opcional. Instrução de inicialização da sessão para ler modelos Java.
    • TEMPVIEW e SQL_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL enquanto carrega dados no Spanner. 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 corresponder.
    • INSTANCE: obrigatório. ID da instância do Spanner.
    • SPANNER_DATABASE: obrigatório. ID do banco de dados do Spanner.
    • TABLE: obrigatório. Nome da tabela de saída do Spanner.
    • MODE: opcional. Modo de gravação para a saída do Spanner. Opções: Append, Overwrite, Ignore ou ErrorIfExists. O padrão é ErrorIfExists.
    • PRIMARY_KEY: obrigatório. Colunas de chave primária separadas por vírgula, necessárias ao criar a tabela de saída do Spanner.
    • SERVICE_ACCOUNT: opcional. Se não for fornecida, a conta de serviço padrão do Compute Engine será usada.
    • PROPERTY e PROPERTY_VALUE: opcionais. Lista separada por vírgulas de pares de propriedade do Spark=value.
    • LABEL e LABEL_VALUE: opcionais. Lista separada por vírgulas de pares label=value.
    • LOG_LEVEL: opcional. Nível de geração de registros. 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 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.1",
        "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" 
        ],
        "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"
      }
    }