Modello Cloud Spanner to Cloud Storage

Utilizza il modello Dataproc Serverless Cloud Spanner to Cloud Storage per estrarre i dati dai database Spanner in Cloud Storage.

Utilizzare il modello

Esegui il modello utilizzando l'interfaccia a riga di comando gcloud o l'API Dataproc.

gcloud

Prima di utilizzare i dati dei comandi riportati di seguito, effettua le seguenti sostituzioni:

• PROJECT_ID: obbligatorio. L'ID del tuo progetto Google Cloud elencato nelle Impostazioni IAM.
• REGION: obbligatorio. Regione Compute Engine.
• SUBNET: facoltativo. Se non viene specificata una subnet, viene selezionata la subnet nella REGIONE specificata nella rete default.

  Esempio: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obbligatorio. Specifica latest per la versione del modello più recente o la data di una versione specifica, ad esempio 2023-03-17_v0.1.0-beta (visita gs://dataproc-templates-binaries o esegui gcloud storage ls gs://dataproc-templates-binaries per elencare le versioni del modello disponibili).
• INSTANCE: obbligatorio. ID istanza Spanner.
• DATABASE: obbligatorio. ID database Spanner.
• TABLE: obbligatorio. Nome della tabella di input Spanner o una query SQL sulla tabella di input Spanner.

  Esempio (la query SQL deve essere tra parentesi): (select * from TABLE)

• SPANNER_JDBC_DIALECT: obbligatorio. Dialetto JDBC di Spanner. Opzioni: googlesql o postgresql. Il valore predefinito è googlesql.
• CLOUD_STORAGE_OUTPUT_PATH: obbligatorio. Percorso di Cloud Storage in cui verrà archiviato l'output.

  Esempio: gs://example-bucket/example-folder/

• FORMAT: obbligatorio. Formato dei dati di output. Opzioni: avro, parquet, csv o json. Nota: se avro, devi aggiungere "file:///usr/lib/spark/connector/spark-avro.jar" al campo dell'API o del flag gcloud CLI jars.

  Esempio (il prefisso file:// fa riferimento a un file jar di Dataproc Serverless):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... other jars]
• MODE: obbligatorio. Modalità di scrittura per l'output di Cloud Storage. Opzioni: append, overwrite, ignore o errorifexists.
• NUM_PARTITIONS: facoltativo. Il numero massimo di partizioni che possono essere utilizzate per il parallelismo delle letture e delle scritture delle tabelle.
• INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND: facoltativo. Se utilizzati, tutti i seguenti parametri devono essere specificati:
  • INPUT_PARTITION_COLUMN: nome della colonna di partizione della tabella di input Spanner.
  • LOWERBOUND: limite inferiore della colonna di partizione della tabella di input Spanner utilizzato per determinare il passo della partizione.
  • LIMITE SUPERIORE: limite superiore della colonna di partizione della tabella di input Spanner utilizzato per decidere il passo della partizione.
• TEMP_VIEW e TEMP_QUERY: facoltativi. Puoi utilizzare questi due parametri facoltativi per applicare una trasformazione Spark SQL durante il caricamento dei dati in Cloud Storage. TEMP_VIEW deve corrispondere al nome della tabella utilizzato nella query e TEMP_QUERY è l'istruzione di query.
• SERVICE_ACCOUNT: facoltativo. Se non viene specificato, viene utilizzato l'account di servizio Compute Engine predefinito.
• PROPERTY e PROPERTY_VALUE: facoltativo. Elenco separato da virgole di coppie Proprietà Spark=value.
• LABEL e LABEL_VALUE: facoltativo. Elenco separato da virgole di coppie label=value.
• LOG_LEVEL: facoltativo. Livello di registrazione. Può essere uno dei seguenti valori: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE o WARN. Valore predefinito: INFO.
• KMS_KEY: facoltativo. La chiave Cloud Key Management Service da utilizzare per la crittografia. Se non viene specificata una chiave, i dati vengono criptati at-rest utilizzando una chiave di proprietà di Google e gestita da Google.

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

Esegui il seguente comando:

Linux, macOS o Cloud Shell

Nota: assicurati di aver inizializzato Google Cloud CLI con l'autenticazione e un progetto eseguendo gcloud init; oppure gcloud auth login e gcloud config set project.

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)

Nota: assicurati di aver inizializzato Google Cloud CLI con l'autenticazione e un progetto eseguendo gcloud init; oppure gcloud auth login e gcloud config set project.

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)

Nota: assicurati di aver inizializzato Google Cloud CLI con l'autenticazione e un progetto eseguendo gcloud init; oppure gcloud auth login e gcloud config set project.

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

Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

• PROJECT_ID: obbligatorio. L'ID del tuo progetto Google Cloud elencato nelle Impostazioni IAM.
• REGION: obbligatorio. Regione Compute Engine.
• SUBNET: facoltativo. Se non viene specificata una subnet, viene selezionata la subnet nella REGIONE specificata nella rete default.

  Esempio: projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_NAME

• TEMPLATE_VERSION: obbligatorio. Specifica latest per la versione del modello più recente o la data di una versione specifica, ad esempio 2023-03-17_v0.1.0-beta (visita gs://dataproc-templates-binaries o esegui gcloud storage ls gs://dataproc-templates-binaries per elencare le versioni del modello disponibili).
• INSTANCE: obbligatorio. ID istanza Spanner.
• DATABASE: obbligatorio. ID database Spanner.
• TABLE: obbligatorio. Nome della tabella di input Spanner o una query SQL sulla tabella di input Spanner.

  Esempio (la query SQL deve essere tra parentesi): (select * from TABLE)

• SPANNER_JDBC_DIALECT: obbligatorio. Dialetto JDBC di Spanner. Opzioni: googlesql o postgresql. Il valore predefinito è googlesql.
• CLOUD_STORAGE_OUTPUT_PATH: obbligatorio. Percorso di Cloud Storage in cui verrà archiviato l'output.

  Esempio: gs://example-bucket/example-folder/

• FORMAT: obbligatorio. Formato dei dati di output. Opzioni: avro, parquet, csv o json. Nota: se avro, devi aggiungere "file:///usr/lib/spark/connector/spark-avro.jar" al campo dell'API o del flag gcloud CLI jars.

  Esempio (il prefisso file:// fa riferimento a un file jar di Dataproc Serverless):

  --jars=file:///usr/lib/spark/connector/spark-avro.jar, [ ... other jars]
• MODE: obbligatorio. Modalità di scrittura per l'output di Cloud Storage. Opzioni: append, overwrite, ignore o errorifexists.
• NUM_PARTITIONS: facoltativo. Il numero massimo di partizioni che possono essere utilizzate per il parallelismo delle letture e delle scritture delle tabelle.
• INPUT_PARTITION_COLUMN, LOWERBOUND, UPPERBOUND: facoltativo. Se utilizzati, tutti i seguenti parametri devono essere specificati:
  • INPUT_PARTITION_COLUMN: nome della colonna di partizione della tabella di input Spanner.
  • LOWERBOUND: limite inferiore della colonna di partizione della tabella di input Spanner utilizzato per determinare il passo della partizione.
  • LIMITE SUPERIORE: limite superiore della colonna di partizione della tabella di input Spanner utilizzato per decidere il passo della partizione.
• TEMP_VIEW e TEMP_QUERY: facoltativi. Puoi utilizzare questi due parametri facoltativi per applicare una trasformazione Spark SQL durante il caricamento dei dati in Cloud Storage. TEMP_VIEW deve corrispondere al nome della tabella utilizzato nella query e TEMP_QUERY è l'istruzione di query.
• SERVICE_ACCOUNT: facoltativo. Se non viene specificato, viene utilizzato l'account di servizio Compute Engine predefinito.
• PROPERTY e PROPERTY_VALUE: facoltativo. Elenco separato da virgole di coppie Proprietà Spark=value.
• LABEL e LABEL_VALUE: facoltativo. Elenco separato da virgole di coppie label=value.
• LOG_LEVEL: facoltativo. Livello di registrazione. Può essere uno dei seguenti valori: ALL, DEBUG, ERROR, FATAL, INFO, OFF, TRACE o WARN. Valore predefinito: INFO.
• KMS_KEY: facoltativo. La chiave Cloud Key Management Service da utilizzare per la crittografia. Se non viene specificata una chiave, i dati vengono criptati at-rest utilizzando una chiave di proprietà di Google e gestita da Google.

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

Metodo HTTP e URL:

POST https://dataproc.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/batches

Corpo JSON della richiesta:

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

Per inviare la richiesta, espandi una di queste opzioni:

curl (Linux, macOS o Cloud Shell)

Nota: il seguente comando presuppone che tu abbia eseguito l'accesso all'interfaccia a riga di comando gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login oppure utilizzando Cloud Shell, che ti consente di accedere automaticamente all'interfaccia a riga di comando gcloud. Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

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: il comando seguente presuppone che tu abbia eseguito l'accesso alla CLI gcloud con il tuo account utente eseguendo gcloud init o gcloud auth login . Puoi controllare l'account attualmente attivo eseguendo gcloud auth list.

Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente:

$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

Dovresti ricevere una risposta JSON simile alla seguente:

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