Esta página foi traduzida pela API Cloud Translation.

Modelo do Cloud Spanner para o Cloud Storage

Use o modelo Serverless for Apache Spark Cloud Spanner to Cloud Storage para extrair dados de bases de dados do Spanner para o Cloud Storage.

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
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 execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelos disponíveis).
INSTANCE: obrigatório. ID da instância do Spanner.
DATABASE: obrigatório. ID da base de dados do Spanner.
TABLE: obrigatório. Nome da tabela de entrada do Spanner ou uma consulta SQL na tabela de entrada do Spanner.
Exemplo (a consulta SQL deve estar entre parênteses): (select * from TABLE)
SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner. Opções: googlesql ou postgresql. A predefinição é googlesql.
CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage onde o resultado vai ser armazenado.
Exemplo: gs://example-bucket/example-folder/
FORMAT: obrigatório. Formato de dados de saída. Opções: avro, parquet, csv ou json. Nota: se avro, tem de adicionar "file:///usr/lib/spark/connector/spark-avro.jar" à flag da CLI gcloud jars ou 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, ignore ou errorifexists.
NUM_PARTITIONS: opcional. O número máximo de partições que podem ser usadas para o paralelismo de leituras e escritas de tabelas.
INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND: 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 do Spanner.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do Spanner usado para determinar o intervalo da partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada do Spanner usado para decidir o intervalo de partição.
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. TEMP_VIEW 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=value separados por vírgulas.
LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. 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" \
    --subnet="SUBNET" \
    --kms-key="KMS_KEY" \
    --service-account="SERVICE_ACCOUNT" \
    --properties="PROPERTY=PROPERTY_VALUE" \
    --labels="LABEL=LABEL_VALUE" \
    -- --template=SPANNERTOGCS \
    --templateProperty log.level="LOG_LEVEL" \
    --templateProperty project.id="PROJECT_ID" \
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" \
    --templateProperty spanner.gcs.input.database.id="DATABASE" \
    --templateProperty spanner.gcs.input.table.id="TABLE" \
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" \
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" \
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" \
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" \
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" \
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" \
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" \
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" \
    --templateProperty spanner.gcs.temp.query="TEMP_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" `
    --subnet="SUBNET" `
    --kms-key="KMS_KEY" `
    --service-account="SERVICE_ACCOUNT" `
    --properties="PROPERTY=PROPERTY_VALUE" `
    --labels="LABEL=LABEL_VALUE" `
    -- --template=SPANNERTOGCS `
    --templateProperty log.level="LOG_LEVEL" `
    --templateProperty project.id="PROJECT_ID" `
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" `
    --templateProperty spanner.gcs.input.database.id="DATABASE" `
    --templateProperty spanner.gcs.input.table.id="TABLE" `
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" `
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" `
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" `
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" `
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" `
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" `
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" `
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" `
    --templateProperty spanner.gcs.temp.query="TEMP_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" ^
    --subnet="SUBNET" ^
    --kms-key="KMS_KEY" ^
    --service-account="SERVICE_ACCOUNT" ^
    --properties="PROPERTY=PROPERTY_VALUE" ^
    --labels="LABEL=LABEL_VALUE" ^
    -- --template=SPANNERTOGCS ^
    --templateProperty log.level="LOG_LEVEL" ^
    --templateProperty project.id="PROJECT_ID" ^
    --templateProperty spanner.gcs.input.spanner.id="INSTANCE" ^
    --templateProperty spanner.gcs.input.database.id="DATABASE" ^
    --templateProperty spanner.gcs.input.table.id="TABLE" ^
    --templateProperty spanner.gcs.output.gcs.path="CLOUD_STORAGE_OUTPUT_PATH" ^
    --templateProperty spanner.gcs.output.gcs.saveMode="MODE" ^
    --templateProperty spanner.gcs.output.gcs.format="FORMAT" ^
    --templateProperty spanner.gcs.input.sql.partitionColumn="INPUT_PARTITION_COLUMN" ^
    --templateProperty spanner.gcs.input.sql.lowerBound="LOWERBOUND" ^
    --templateProperty spanner.gcs.input.sql.upperBound="UPPERBOUND" ^
    --templateProperty spanner.spanner.gcs.input.sql.numPartitions="NUM_PARTITIONS" ^
    --templateProperty spanner.gcs.temp.table="TEMP_VIEW" ^
    --templateProperty spanner.gcs.temp.query="TEMP_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.
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
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 execute gcloud storage ls gs://dataproc-templates-binaries para listar as versões de modelos disponíveis).
INSTANCE: obrigatório. ID da instância do Spanner.
DATABASE: obrigatório. ID da base de dados do Spanner.
TABLE: obrigatório. Nome da tabela de entrada do Spanner ou uma consulta SQL na tabela de entrada do Spanner.
Exemplo (a consulta SQL deve estar entre parênteses): (select * from TABLE)
SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner. Opções: googlesql ou postgresql. A predefinição é googlesql.
CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage onde o resultado vai ser armazenado.
Exemplo: gs://example-bucket/example-folder/
FORMAT: obrigatório. Formato de dados de saída. Opções: avro, parquet, csv ou json. Nota: se avro, tem de adicionar "file:///usr/lib/spark/connector/spark-avro.jar" à flag da CLI gcloud jars ou 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, ignore ou errorifexists.
NUM_PARTITIONS: opcional. O número máximo de partições que podem ser usadas para o paralelismo de leituras e escritas de tabelas.
INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND: 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 do Spanner.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do Spanner usado para determinar o intervalo da partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada do Spanner usado para decidir o intervalo de partição.
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. TEMP_VIEW 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=value separados por vírgulas.
LOG_LEVEL: opcional. Nível de registo. Pode ser um dos seguintes: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE ou WARN. 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","SPANNERTOGCS",
      "--templateProperty","log.level=LOG_LEVEL",
      "--templateProperty","project.id=PROJECT_ID",
      "--templateProperty","spanner.gcs.input.spanner.id=INSTANCE",
      "--templateProperty","spanner.gcs.input.database.id=DATABASE",
      "--templateProperty","spanner.gcs.input.table.id=TABLE",
      "--templateProperty","spanner.gcs.output.gcs.path=CLOUD_STORAGE_OUTPUT_PATH",
      "--templateProperty","spanner.gcs.output.gcs.saveMode=MODE",
      "--templateProperty","spanner.gcs.output.gcs.format=FORMAT",
      "--templateProperty","spanner.gcs.input.sql.partitionColumn=INPUT_PARTITION_COLUMN",
      "--templateProperty","spanner.gcs.input.sql.lowerBound=LOWERBOUND",
      "--templateProperty","spanner.gcs.input.sql.upperBound=UPPERBOUND",
      "--templateProperty","spanner.gcs.input.sql.numPartitions=NUM_PARTITIONS",
      "--templateProperty","spanner.gcs.temp.table=TEMP_VIEW",
      "--templateProperty","spanner.gcs.temp.query=TEMP_QUERY",
      "--templateProperty spanner.jdbc.dialect=SPANNER_JDBC_DIALECT"
    ],
    "jarFileUris":[
      "file:///usr/lib/spark/connector/spark-avro.jar", "gs://dataproc-templates-binaries/TEMPLATE_VERSION/java/dataproc-templates.jar"
    ]
  }
}

Para enviar o seu pedido, expanda uma destas opções:

curl (Linux, macOS ou Cloud Shell)

Nota: O comando seguinte pressupõe que tem sessão iniciada na CLI gcloud com a sua conta de utilizador executando gcloud init ou gcloud auth login, ou usando o Cloud Shell, que inicia automaticamente sessão na CLI gcloud. Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

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"

PowerShell (Windows)

Nota: O comando seguinte pressupõe que iniciou sessão na CLI do Google Cloud com a sua conta de utilizador executando gcloud init ou gcloud auth login .gcloud Pode verificar a conta atualmente ativa executando o comando gcloud auth list.

Guarde o corpo do pedido num ficheiro com o nome request.json, e execute o seguinte comando:

$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

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