Questa pagina descrive come pianificare le esportazioni dei tuoi Cloud Firestore dati. Per eseguire le esportazioni in base a una pianificazione, ti consigliamo di utilizzare Cloud Functions e Cloud Scheduler.
Prima di iniziare
Prima di pianificare le esportazioni di dati gestite, devi completare le seguenti attività:
- Abilita la fatturazione per il tuo progetto Google Cloud. Solo Google Cloud progetti con fatturazione abilitata possono utilizzare la funzionalità di esportazione e importazione.
- Le operazioni di esportazione richiedono un bucket Cloud Storage di destinazione. Crea un bucket in una località vicina alla località del tuo database.Cloud StorageCloud Firestore Non puoi utilizzare un bucket con pagamento a carico del richiedente per le operazioni di esportazione.
Creare una funzione Cloud Functions e un Cloud Scheduler job
Per creare una funzione Cloud Functions Node.js che avvii un'esportazione dei dati Cloud Firestore e un job Cloud Scheduler per chiamare questa funzione:
Interfaccia a riga di comando di Firebase
-
Installa l'interfaccia a riga di comando di Firebase. In una nuova directory, inizializza l'interfaccia a riga di comando per Cloud Functions:
firebase init functions --project PROJECT_ID
- Seleziona JavaScript come linguaggio.
- (Facoltativo) Abilita ESLint.
- Inserisci
yper installare le dipendenze.
-
Sostituisci il codice nel file
functions/index.jscon il seguente:const functions = require('firebase-functions'); const firestore = require('@google-cloud/firestore'); const client = new firestore.v1.FirestoreAdminClient(); // Replace BUCKET_NAME const bucket = 'gs://BUCKET_NAME'; exports.scheduledFirestoreExport = functions.pubsub .schedule('every 24 hours') .onRun((context) => { const projectId = process.env.GCP_PROJECT; const databaseName = client.databasePath(projectId, '(default)'); return client.exportDocuments({ name: databaseName, outputUriPrefix: bucket, // Leave collectionIds empty to export all collections // or set to a list of collection IDs to export, // collectionIds: ['users', 'posts'] collectionIds: [] }) .then(responses => { const response = responses[0]; console.log(`Operation Name: ${response['name']}`); }) .catch(err => { console.error(err); throw new Error('Export operation failed'); }); });
-
Nel codice precedente, modifica quanto segue:
- Sostituisci
BUCKET_NAMEcon il nome del tuo bucket. - Sostituisci
YOUR_PROJECT_IDcon l'ID progetto . - Modifica
every 24 hoursper impostare la pianificazione di esportazione. Utilizza la sintassi cron.yaml di App Engine o il formato cron di Unix (* * * * *). -
Modifica
collectionIds: []per esportare solo i gruppi di raccolte specificati Lascia invariato per esportare tutti i gruppi di raccolte.
- Sostituisci
-
Esegui il deployment della funzione pianificata:
firebase deploy --only functions
Console Google Cloud
Creare una funzione Cloud Functions
-
Vai alla pagina Cloud Functions nella console Google Cloud:
- Fai clic su Scrivi una funzione.
- Inserisci un nome della funzione, ad esempio
firestore-export. - In Trigger, seleziona Cloud Pub/Sub.
- In Argomento, seleziona Crea nuovo argomento. Inserisci un nome per
l'argomento Pub/Sub, ad esempio
initiateFirestoreExport. Prendi nota del nome dell'argomento, perché ti servirà per creare il job Cloud Scheduler. - In Codice sorgente, seleziona Editor incorporato. Inserisci il
seguente codice in
index.js: Nel codice precedente, modifica quanto segue:const firestore = require('@google-cloud/firestore'); const client = new firestore.v1.FirestoreAdminClient(); // Replace BUCKET_NAME const bucket = 'gs://BUCKET_NAME' exports.scheduledFirestoreExport = (event, context) => { // Access the GCLOUD_PROJECT environment variable set by the runtime. const projectId = process.env.GOOGLE_CLOUD_PROJECT || process.env.GCLOUD_PROJECT; // Use the DATABASE_ID environment variable if set, // otherwise default to '(default)' const databaseId = process.env.DATABASE_ID || '(default)'; const databaseName = client.databasePath( projectId, databaseId ); return client .exportDocuments({ name: databaseName, outputUriPrefix: bucket, // Leave collectionIds empty to export all collection groups // or define a list of collection group IDs: // collectionIds: ['users', 'posts'] collectionIds: [], }) .then(responses => { const response = responses[0]; console.log(`Operation Name: ${response['name']}`); return response; }) .catch(err => { console.error(err); }); };
- Sostituisci
BUCKET_NAMEcon il nome del tuo bucket. -
Modifica
collectionIds: []per esportare solo i gruppi di raccolte specificati Lascia invariato per esportare tutti i gruppi di raccolte. -
(Facoltativo) Se utilizzi un database non predefinito, assicurati di impostare la variabile di ambiente
DATABASE_IDquando crei la funzione Cloud Functions. Se utilizzi un runtime in cuiGOOGLE_CLOUD_PROJECTnon è impostato automaticamente, potresti doverlo impostare manualmente o sostituirlo con l'ID progetto nel codice.
- Sostituisci
- In
package.json, aggiungi la seguente dipendenza:{ "dependencies": { "@google-cloud/firestore": "^1.3.0" } } - In Funzione da eseguire, inserisci
scheduledFirestoreExport, il nome della funzione inindex.js. - Fai clic su Crea per eseguire il deployment della funzione Cloud Functions.
Creare un job Cloud Scheduler
Ora crea un job Cloud Scheduler che chiama la funzione Cloud Functions:
-
Vai alla pagina Cloud Scheduler nella console Google Cloud:
- Fai clic su Crea job.
- Inserisci un Nome per il job, ad esempio
scheduledFirestoreExport. - Inserisci una Frequenza, ad esempio
every 24 hours. - Seleziona un Fuso orario.
- In Target, seleziona Pub/Sub. Nel campo Argomento, inserisci il nome dell'argomento Pub/Sub che hai definito insieme alla funzione Cloud Functions,
initiateFirestoreExportnell'esempio precedente. - Nel campo Payload, inserisci
start export. Il job richiede un payload definito, ma la funzione Cloud Functions precedente non utilizza questo valore. - Fai clic su Crea.
Configurare le autorizzazioni di accesso
Ora concedi alla funzione Cloud Functions l'autorizzazione per avviare le operazioni di esportazione e scrivere nel bucket GCS.
Questa funzione Cloud Run utilizza un service account per autenticare e autorizzare le operazioni di esportazione. Il service account utilizzato dipende dalla tua Cloud Functions configurazione:
- Cloud Functions (1ª gen): utilizza il App Engine service account
predefinito:
PROJECT_ID@appspot.gserviceaccount.com - Cloud Functions (2ª gen): utilizza il Compute Engine
service account predefinito:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
Questo service account richiede l'autorizzazione per avviare un'operazione di esportazione e scrivere nel bucket Cloud Storage. Per concedere queste autorizzazioni, assegna i seguenti ruoli IAM al service account:
Cloud Datastore Import Export AdminDatastore- Ruolo
Storage Adminnel bucket Cloud Run Invoker(obbligatorio per Cloud Functions (2ª gen) per consentire al servizio di attivazione di richiamare la funzione)
Puoi utilizzare gli strumenti a riga di comando gcloud e gsutil
per assegnare questi ruoli.
Se non sono già installati, puoi accedere a questi
strumenti da Cloud Shell nella console Google Cloud:
Avvia Cloud Shell
-
Assegna il ruolo Cloud Datastore Import Export Admin. Sostituisci PROJECT_ID e SERVICE_ACCOUNT (ad es.
PROJECT_ID@appspot.gserviceaccount.comoPROJECT_NUMBER-compute@developer.gserviceaccount.com) ed esegui il seguente comando:gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT \ --role roles/datastore.importExportAdmin -
Assegna il ruolo Storage Admin al bucket. Sostituisci SERVICE_ACCOUNT e BUCKET_NAME, ed esegui il seguente comando:
gsutil iam ch serviceAccount:SERVICE_ACCOUNT:admin \ gs://BUCKET_NAME -
(Per Cloud Functions (2ª gen)) Assegna il Cloud Run Invoker ruolo al service account. Sostituisci PROJECT_ID e SERVICE_ACCOUNT, ed esegui il seguente comando:
gcloud projects add-iam-policy-binding PROJECT_ID \ --member serviceAccount:SERVICE_ACCOUNT \ --role roles/run.invoker
Se disabiliti o elimini il tuo App Engine service account predefinito, la tua App Engine app perderà l'accesso al tuo Cloud Firestore database. Se hai disabilitato il tuo service account App Engine, puoi riattivarlo. Per maggiori informazioni, consulta la sezione relativa all'abilitazione di un service account. Se hai eliminato il service account App Engine negli ultimi 30 giorni, puoi ripristinarlo. Per maggiori informazioni, consulta la sezione relativa all'annullamento dell'eliminazione di un service account.
Testare il job Cloud Scheduler e la funzione Cloud
Puoi testare il job Cloud Scheduler nella pagina Cloud Scheduler della console Google Cloud.
Vai alla pagina Cloud Scheduler nella console Google Cloud.
Vai a Cloud SchedulerNella riga del nuovo job Cloud Scheduler, fai clic su Esegui ora.
Dopo qualche secondo, il job Cloud Scheduler dovrebbe aggiornare la colonna dei risultati a Successo e Ultima esecuzione all'ora corrente. Potrebbe essere necessario fare clic su Aggiorna.
La pagina Cloud Scheduler conferma solo che il job ha chiamato la funzione Cloud Functions. Apri la pagina Cloud Functions per visualizzare i log della funzione.
Visualizzare i log di Cloud Functions
Per verificare se la funzione Cloud Functions ha avviato correttamente un'operazione di esportazione, apri i log della funzione:
Console Firebase
Nella console Firebase, vai a Hosting e serverless > Funzioni.
Console di GCP
Vai alla pagina Cloud Functions nella console Google Cloud.
Visualizzare l'avanzamento dell'esportazione
Puoi utilizzare il comando gcloud firestore operations list per visualizzare l'
avanzamento delle operazioni di esportazione. Per maggiori informazioni, consulta la sezione relativa alla
gestione delle operazioni di esportazione e importazione.
Al termine di un'operazione di esportazione, puoi visualizzare i file di output nel tuo Cloud Storage bucket: