Modelo do Cloud Spanner para Cloud Storage
Use o modelo do Dataproc Serverless Cloud Spanner para Cloud Storage para extrair dados dos bancos de dados do Spanner para o Cloud Storage.
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 nas Configurações do IAM.
- REGION: obrigatório. Compute Engine região.
- 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
- 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). - INSTANCE: obrigatório. ID da instância do Spanner.
- DATABASE: obrigatório. ID do banco 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 precisa estar entre parênteses):
(select * from TABLE)
- SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner.
Opções:
googlesql
oupostgresql
. O padrão égooglesql
. - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage em que a saída será armazenada.
Exemplo:
gs://example-bucket/example-folder/
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro
,parquet
,csv
oujson
. 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 frascos] - MODE: obrigatório. Modo de gravação para a saída do Cloud Storage.
Opções:
append
,overwrite
,ignore
ouerrorifexists
. - NUM_PARTITIONS: opcional. O número máximo de que podem ser usadas para paralelismo de leituras e gravações de tabelas.
- INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND: 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 Spanner.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do Spanner usado para determinar o o salto de partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada do Spanner usado para decidir o o salto de partição.
- TEMP_VIEW e TEMP_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL ao carregar dados no Cloud Storage. TEMP_VIEW precisa ser igual ao nome da tabela usado na consulta, e TEMP_QUERY é a instrução de 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
. - LOG_LEVEL: opcional. Nível de registro. Pode ser um dos seguintes:
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. 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 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 os dados da solicitação abaixo, faça as substituições a seguir:
- PROJECT_ID: obrigatório. O ID do projeto do Google Cloud listado nas Configurações do IAM.
- REGION: obrigatório. Compute Engine região.
- 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
- 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). - INSTANCE: obrigatório. ID da instância do Spanner.
- DATABASE: obrigatório. ID do banco 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 precisa estar entre parênteses):
(select * from TABLE)
- SPANNER_JDBC_DIALECT: obrigatório. Dialeto JDBC do Spanner.
Opções:
googlesql
oupostgresql
. O padrão égooglesql
. - CLOUD_STORAGE_OUTPUT_PATH: obrigatório. Caminho do Cloud Storage em que a saída será armazenada.
Exemplo:
gs://example-bucket/example-folder/
- FORMAT: obrigatório. Formato de dados de saída. Opções:
avro
,parquet
,csv
oujson
. 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 frascos] - MODE: obrigatório. Modo de gravação para a saída do Cloud Storage.
Opções:
append
,overwrite
,ignore
ouerrorifexists
. - NUM_PARTITIONS: opcional. O número máximo de que podem ser usadas para paralelismo de leituras e gravações de tabelas.
- INPUT_PARTITION_COLUMN,
LOWERBOUND,
UPPERBOUND: 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 Spanner.
- LOWERBOUND: limite inferior da coluna de partição da tabela de entrada do Spanner usado para determinar o o salto de partição.
- UPPERBOUND: limite superior da coluna de partição da tabela de entrada do Spanner usado para decidir o o salto de partição.
- TEMP_VIEW e TEMP_QUERY: opcional. É possível usar esses dois parâmetros opcionais para aplicar uma transformação do Spark SQL ao carregar dados no Cloud Storage. TEMP_VIEW precisa ser igual ao nome da tabela usado na consulta, e TEMP_QUERY é a instrução de 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
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 um dos seguintes:
ALL
,DEBUG
,ERROR
,FATAL
,INFO
,OFF
,TRACE
ouWARN
. Padrão:INFO
. -
KMS_KEY: opcional. A chave do Cloud Key Management Service a ser usada para criptografia. Se nenhuma chave for especificada, os dados serão criptografados em repouso usando uma chave de propriedade 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","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 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" } }