Esporta database da Spanner ad Avro

Questa pagina descrive come esportare i database Spanner con la console Google Cloud. Per esportare un database Spanner utilizzando l'API REST o lo strumento a riga di comando gcloud spanner, completa i passaggi nella sezione Prima di iniziare di questa pagina, quindi consulta le istruzioni dettagliate in Spanner to Cloud Storage Avro nella documentazione di Dataflow. Il processo di esportazione utilizza Dataflow e scrive i dati in una cartella di un bucket Cloud Storage. La cartella risultante contiene un insieme di file Avro e file manifest JSON.

Prima di iniziare

Per esportare un database Spanner, devi prima abilitare le API Spanner, Cloud Storage, Compute Engine e Dataflow:

Abilita le API

Devi anche avere una quota sufficiente e le autorizzazioni IAM richieste.

Requisiti per le quote

I requisiti di quota per i job di esportazione sono i seguenti:

  • Spanner: non è richiesta alcuna capacità di calcolo aggiuntiva per esportare un database, anche se potresti dover aggiungere ulteriore capacità di calcolo in modo che il job venga completato entro un periodo di tempo ragionevole. Per ulteriori dettagli, consulta Ottimizzare le offerte di lavoro.
  • Cloud Storage: per esportare i file, devi creare un bucket per i tuoi file esportati, se non ne hai già uno. Puoi eseguire questa operazione nella console Google Cloud, tramite la pagina Cloud Storage o durante la creazione dell'esportazione tramite la pagina Spanner. Non è necessario impostare una dimensione per il bucket.
  • Dataflow: i job di esportazione sono soggetti alle stesse quote di Compute Engine di CPU, utilizzo del disco e indirizzo IP degli altri job Dataflow.
  • Compute Engine: prima di eseguire il job di esportazione, devi configurare le quote iniziali per Compute Engine, utilizzato da Dataflow. Queste quote rappresentano il numero massimo di risorse che puoi consentire a Dataflow di utilizzare per il tuo job. I valori iniziali consigliati sono:

    • CPU: 200
    • Indirizzi IP in uso: 200
    • Disco permanente standard: 50 TB

    In genere, non è necessario apportare altre modifiche. La scalabilità automatica di Dataflow ti consente di pagare solo per le risorse effettivamente utilizzate durante l'esportazione. Se il job può utilizzare più risorse, l'interfaccia utente di Dataflow mostra un'icona di avviso. Il job dovrebbe terminare anche se è presente un'icona di avviso.

Requisiti IAM

Per esportare un database, devi inoltre disporre di ruoli IAM con autorizzazioni sufficienti per utilizzare tutti i servizi coinvolti in un job di esportazione. Per informazioni sulla concessione di ruoli e autorizzazioni, consulta Applicare ruoli IAM.

Per esportare un database, sono necessari i seguenti ruoli:

Per utilizzare le risorse di calcolo indipendenti di Spanner Data Boost durante un'esportazione, devi disporre anche dell'autorizzazione IAM spanner.databases.useDataBoost. Per ulteriori informazioni, consulta la panoramica di Data Boost.

Esporta un database

Dopo aver soddisfatto i requisiti di quota e IAM descritti in precedenza, puoi esportare un database Spanner esistente.

Per esportare il tuo database Spanner in un bucket Cloud Storage, segui questi passaggi.

  1. Vai alla pagina Istanze di Spanner.

    Vai alla pagina Istanze

  2. Fai clic sul nome dell'istanza contenente il database.

  3. Fai clic sulla voce di menu Importa/Esporta nel riquadro a sinistra, quindi fai clic sul pulsante Esporta.

  4. In Scegli dove archiviare l'esportazione, fai clic su Sfoglia.

  5. Se non hai già un bucket Cloud Storage per l'esportazione:

    1. Fai clic su Nuovo bucket Screenshot del nuovo elemento UI del bucket.
    2. Inserisci un nome per il bucket. I nomi dei bucket devono essere univoci in Cloud Storage.
    3. Seleziona una classe di archiviazione e una località predefinite e fai clic su Crea.
    4. Fai clic sul bucket per selezionarlo.

    Se hai già un bucket, seleziona il bucket dall'elenco iniziale o fai clic su Cerca Screenshot dell'elemento UI di ricerca per filtrare l'elenco, quindi fai clic sul bucket per selezionarlo.

  6. Fai clic su Seleziona.

  7. Seleziona il database da esportare nel menu a discesa Scegli un database da esportare.

  8. (Facoltativo) Per esportare il database da un momento precedente, seleziona la casella e inserisci un timestamp.

  9. Seleziona una regione dal menu a discesa Scegli una regione per il job di esportazione.

  10. (Facoltativo) Per criptare lo stato della pipeline Dataflow con una chiave di crittografia gestita dal cliente:

    1. Fai clic su Mostra opzioni di crittografia.
    2. Seleziona Utilizza una chiave di crittografia gestita dal cliente (CMEK).
    3. Seleziona la chiave dall'elenco a discesa.

    Questa opzione non influisce sulla crittografia a livello di bucket Cloud Storage di destinazione. Per abilitare CMEK per il tuo bucket Cloud Storage, consulta Utilizzare CMEK con Cloud Storage.

  11. (Facoltativo) Per eseguire l'esportazione utilizzando Spanner Data Boost, seleziona la casella di controllo Utilizza Spanner Data Boost. Per ulteriori informazioni, consulta la panoramica di Data Boost.

  12. Seleziona la casella di controllo in Conferma addebiti per confermare che sono presenti addebiti aggiuntivi a quelli sostenuti dall'istanza Spanner esistente.

  13. Fai clic su Esporta.

    La console Google Cloud mostra la pagina Importazione/esportazione di database, che ora mostra una voce relativa al job di esportazione nell'elenco dei job di importazione/esportazione, incluso il tempo trascorso del job:

    Screenshot del job in corso

Quando il job termina o termina, lo stato viene aggiornato nell'elenco di importazione/esportazione. Se il job è riuscito, viene visualizzato lo stato Riuscito:

Messaggio di esportazione riuscita

Se il job non è riuscito, viene visualizzato lo stato Non riuscito:

Messaggio di errore del job di esportazione

Per visualizzare i dettagli dell'operazione Dataflow per il job, fai clic sul nome del job nella colonna Nome job Dataflow.

Se il job non riesce, controlla i log Dataflow del job per conoscere i dettagli dell'errore.

Per evitare addebiti di Cloud Storage per i file creati dal job di esportazione non riuscito, elimina la cartella e i relativi file. Per informazioni su come trovare la cartella, consulta Visualizzare l'esportazione.

Una nota sull'esportazione delle colonne generate e delle modifiche in tempo reale

I valori in una colonna generata archiviata non vengono esportati. La definizione della colonna viene esportata nello schema Avro come campo di record di tipo nullo, con la definizione della colonna come proprietà personalizzate del campo. Finché l'operazione di backfill di una colonna generata appena aggiunta non viene completata, la colonna generata viene ignorata come se non esistesse nello schema.

Le modifiche in tempo reale esportati come file Avro contengono solo lo schema dei flussi di modifiche e non i record delle modifiche dei dati.

Nota sull'esportazione delle sequenze

Le sequenze (GoogleSQL, PostgreSQL) sono oggetti dello schema che vengono utilizzati per generare valori interi univoci. Spanner esporta ogni oggetto dello schema nello schema Avro come campo record, con il tipo di sequenza, l'intervallo ignorato e il contatore come proprietà del campo. Tieni presente che per impedire che una sequenza venga reimpostata e generi valori duplicati dopo l'importazione, durante l'esportazione dello schema la funzione GET_INTERNAL_SEQUENCE_STATE() (GoogleSQL, PostgreSQL) acquisisce il contatore della sequenza. Spanner aggiunge un buffer di 1000 al contatore e scrive il nuovo valore nel campo del record. Questo approccio evita errori nei valori duplicati che potrebbero verificarsi dopo l'importazione. Se sono presenti più scritture nel database di origine durante l'esportazione dei dati, devi regolare il contatore delle sequenze effettive utilizzando l'istruzione ALTER SEQUENCE (GoogleSQL, PostgreSQL).

Al momento dell'importazione, la sequenza inizia da questo nuovo contatore anziché dal contatore trovato nello schema. In alternativa, puoi utilizzare l'istruzione ALTER SEQUENCE (GoogleSQL, PostgreSQL) per aggiornare la sequenza con un nuovo contatore.

Visualizza la tua esportazione in Cloud Storage

Per visualizzare nella console Google Cloud la cartella contenente il database esportato, vai al browser Cloud Storage e scegli il bucket selezionato in precedenza:

Vai al browser di Cloud Storage

Il bucket ora contiene una cartella che contiene il database esportato. Il nome della cartella inizia con l'ID dell'istanza, il nome del database e il timestamp del job di esportazione. La cartella contiene:

  • Un file spanner-export.json
  • Un file TableName-manifest.json per ogni tabella nel database che hai esportato.
  • Uno o più file TableName.avro-#####-of-#####. Il primo numero nell'estensione .avro-#####-of-##### rappresenta l'indice del file Avro, a partire da zero, e il secondo rappresenta il numero di file Avro generati per ogni tabella.

    Ad esempio, Songs.avro-00001-of-00002 è il secondo di due file che contengono i dati per la tabella Songs.

  • Un file ChangeStreamName-manifest.json per ogni flusso di modifiche nel database che hai esportato.

  • Un file ChangeStreamName.avro-00000-of-00001 per ogni flusso di modifiche. Questo file contiene dati vuoti con solo lo schema Avro della modifica in tempo reale.

Scegli una regione per il job di importazione

Potresti voler scegliere una regione diversa in base alla località del bucket Cloud Storage. Per evitare addebiti per il trasferimento di dati in uscita, scegli una regione che corrisponda alla località del bucket Cloud Storage.

  • Se la località del bucket Cloud Storage è una regione, puoi sfruttare l'utilizzo gratuito della rete scegliendo la stessa regione per il job di importazione, supponendo che quella regione sia disponibile.

  • Se la località del bucket Cloud Storage è due regioni, puoi sfruttare l'utilizzo gratuito della rete scegliendo una delle due regioni che compongono la doppia regione per il job di importazione, supponendo che una delle regioni sia disponibile.

  • Se una regione con sede condivisa non è disponibile per il job di importazione o se la località del bucket Cloud Storage è più regioni, si applicano i costi per il trasferimento di dati in uscita. Consulta i prezzi del trasferimento di dati di Cloud Storage per scegliere una regione che comporta i costi più bassi per il trasferimento di dati.

Esporta un sottoinsieme di tabelle

Se vuoi esportare solo i dati di determinate tabelle e non l'intero database, puoi specificare queste tabelle durante l'esportazione. In questo caso, Spanner esporta l'intero schema del database, inclusi i dati delle tabelle specificate, lasciando tutte le altre tabelle presenti ma vuote nel file esportato.

Puoi specificare un sottoinsieme di tabelle da esportare utilizzando la pagina Dataflow nella console Google Cloud o la riga di comando. (La pagina di Spanner non fornisce questa azione.)

Se esporti i dati di una tabella figlio di un'altra, devi esportare anche i dati della tabella parent. Se non vengono esportati gli elementi principali, il job di esportazione non va a buon fine.

Per esportare un sottoinsieme di tabelle, avvia l'esportazione utilizzando il modello Avro da Spanner a Cloud Storage di Dataflow e specifica le tabelle utilizzando la pagina Dataflow nella console Google Cloud o Google Cloud CLI, come descritto di seguito:

Console Google Cloud

Se utilizzi la pagina Dataflow nella console Google Cloud, il parametro Nome tabella Cloud Spanner si trova nella sezione Parametri facoltativi della pagina Crea job da modello. È possibile specificare più tabelle in un formato separato da virgole.

Interfaccia a riga di comando gcloud

Se utilizzi Google Cloud CLI, usa l'argomento tableNames per specificare la tabella. Ad esempio:

gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='instanceId=test-instance,databaseId=example-db,tableNames=table1,outputDir=gs://my-gcs-bucket' \
--max-workers=10

Specificare più tabelle in gcloud richiede l'utilizzo di caratteri di escape per l'argomento dictionary-type. Nell'esempio seguente viene utilizzato "|" come carattere di escape:

 gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='^|^instanceId=test-instance|databaseId=example-db|tableNames=table1,table2|outputDir=gs://my-gcs-bucket' \
--max-workers=10

Il parametro shouldExportRelatedTables consente di esportare automaticamente tutte le tabelle padre delle tabelle desiderate. Ad esempio, in questa gerarchia degli schemi con le tabelle Singers, Albums e Songs, dobbiamo specificare solo Songs. L'opzione shouldExportRelatedTables esporterà anche Singers e Albums perché Songs è un discendente di entrambi.

gcloud dataflow jobs run my-export-job \
--gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
--region=us-central1 \
--parameters='instanceId=test-instance,databaseId=example-db,tableNames=Songs,shouldExportRelatedTables=true,outputDir=gs://my-gcs-bucket' \
--max-workers=10

Visualizza o risolvi i problemi dei job nell'interfaccia utente di Dataflow

Dopo aver avviato un job di esportazione, puoi visualizzare i relativi dettagli, inclusi i log, nella sezione Dataflow della console Google Cloud.

Visualizza i dettagli del job Dataflow

Per visualizzare i dettagli di eventuali job di importazione/esportazione eseguiti nell'ultima settimana, inclusi eventuali job attualmente in esecuzione:

  1. Vai alla pagina Panoramica del database per il database.
  2. Fai clic sulla voce di menu Importa/Esporta nel riquadro a sinistra. La pagina Importa/Esporta del database mostra un elenco dei job recenti.
  3. Nella pagina Importa/Esporta del database, fai clic sul nome del job nella colonna Nome job Dataflow:

    Messaggio di stato del job in corso

    La console Google Cloud mostra i dettagli del job Dataflow.

Per visualizzare un job eseguito più di una settimana fa:

  1. Vai alla pagina dei job Dataflow nella console Google Cloud.

    Vai alla pagina dei job

  2. Trova il lavoro nell'elenco, quindi fai clic sul suo nome.

    La console Google Cloud mostra i dettagli del job Dataflow.

Visualizza i log di Dataflow per il tuo job

Per visualizzare i log di un job Dataflow, vai alla pagina dei dettagli del job come descritto in precedenza, quindi fai clic su Log a destra del nome del job.

Se un job ha esito negativo, cerca gli errori nei log. In caso di errori, il numero di errori viene visualizzato accanto a Log:

Esempio di conteggio degli errori accanto al pulsante Log

Per visualizzare gli errori del job:

  1. Fai clic sul conteggio degli errori accanto a Log.

    La console Google Cloud visualizza i log del job. Potrebbe essere necessario scorrere per vedere gli errori.

  2. Individua le voci con l'icona di errore Icona di errore.

  3. Fai clic su una singola voce di log per espanderne il contenuto.

Per ulteriori informazioni sulla risoluzione dei problemi dei job Dataflow, consulta Risolvere i problemi della pipeline.

Risolvere i problemi relativi ai job di esportazione non riusciti

Se nei log del job vengono visualizzati i seguenti errori:

com.google.cloud.spanner.SpannerException: NOT_FOUND: Session not found

--or--

com.google.cloud.spanner.SpannerException: DEADLINE_EXCEEDED: Deadline expired before operation could complete.

Controlla la latenza di lettura del 99% nella scheda Monitoring del tuo database Spanner nella console Google Cloud. Se vengono mostrati valori elevati (più secondi), significa che l'istanza è sovraccarica, con conseguente timeout e esito negativo delle letture.

Una delle cause della latenza elevata è che il job Dataflow è in esecuzione con troppi worker, causando un carico eccessivo sull'istanza Spanner.

Per specificare un limite al numero di worker Dataflow, invece di utilizzare la scheda Importa/Esporta nella pagina dei dettagli dell'istanza del database Spanner nella console Google Cloud, devi avviare l'esportazione utilizzando il modello Avro di Dataflow Da Cloud Spanner a Cloud Storage e specificare il numero massimo di worker come descritto di seguito:
  • Se utilizzi la console Dataflow, il parametro Max worker si trova nella sezione Parametri facoltativi della pagina Crea job da modello.

  • Se utilizzi gcloud, specifica l'argomento max-workers. Ad esempio:

    gcloud dataflow jobs run my-export-job \
    --gcs-location='gs://dataflow-templates/latest/Cloud_Spanner_to_GCS_Avro' \
    --region=us-central1 \
    --parameters='instanceId=test-instance,databaseId=example-db,outputDir=gs://my-gcs-bucket' \
    --max-workers=10
    

Ottimizza i job di esportazione a esecuzione lenta

Se hai seguito i suggerimenti nelle impostazioni iniziali, di solito non dovresti apportare altre modifiche. Se il job viene eseguito lentamente, puoi provare alcune altre ottimizzazioni:

  • Ottimizza il job e la posizione dei dati: esegui il job Dataflow nella stessa regione in cui si trovano l'istanza Spanner e il bucket Cloud Storage.

  • Garantire risorse Dataflow sufficienti: se le quote di Compute Engine pertinenti limitano le risorse del job Dataflow, la pagina Dataflow del job nella console Google Cloud mostra un'icona di avviso Icona di avviso e messaggi di log:

    Screenshot dell'avviso relativo al limite di quota

    In questa situazione, l'aumento delle quote per CPU, indirizzi IP in uso e disco permanente standard potrebbe ridurre il tempo di esecuzione del job, ma potrebbero esserti addebitati maggiori costi per Compute Engine.

  • Controlla l'utilizzo della CPU di Spanner: se noti che l'utilizzo della CPU per l'istanza supera il 65%, puoi aumentare la capacità di calcolo nell'istanza. La capacità aggiunge più risorse di Spanner e il job dovrebbe essere più veloce, ma ti vengono addebitati più costi di Spanner.

Fattori che influiscono sulle prestazioni del job di esportazione

Diversi fattori influenzano il tempo necessario per completare un job di esportazione.

  • Dimensione del database di Spanner: l'elaborazione di più dati richiede più tempo e risorse.

  • Schema del database Spanner, tra cui:

    • Il numero di tabelle
    • La dimensione delle righe
    • Il numero di indici secondari
    • Il numero di chiavi esterne
    • Il numero di modifiche in tempo reale

  • Posizione dei dati: i dati vengono trasferiti tra Spanner e Cloud Storage utilizzando Dataflow. Idealmente, tutti e tre i componenti si trovano nella stessa regione. Se i componenti non si trovano nella stessa regione, lo spostamento dei dati tra regioni rallenta il job.

  • Numero di worker Dataflow: sono necessari i worker Dataflow ottimali per ottenere buone prestazioni. Utilizzando la scalabilità automatica, Dataflow sceglie il numero di worker per il job in base alla quantità di lavoro da svolgere. Tuttavia, il numero di worker sarà limitato dalle quote per CPU, indirizzi IP in uso e disco permanente standard. L'interfaccia utente di Dataflow mostra un'icona di avviso se rileva limiti di quota. In questa situazione, l'avanzamento è più lento, ma il job dovrebbe comunque essere completato.

  • Carico esistente su Spanner: un job di esportazione in genere aggiunge un carico leggero su un'istanza Spanner. Se l'istanza ha già un carico esistente sostanziale, il job viene eseguito più lentamente.

  • Quantità di capacità di calcolo di Spanner: se l'utilizzo della CPU per l'istanza è superiore al 65%, il job viene eseguito più lentamente.