原生模式下的 Cloud Firestore 企业版现已推出！了解详情。

Pianificare le esportazioni di dati

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.
Nota: i progetti Firebase devono essere inclusi nel piano Blaze per utilizzare la funzionalità di esportazione e importazione gestita. Se abiliti la fatturazione per il Google Cloud il progetto Firebase viene automaticamente sottoposto ad upgrade al piano Blaze.
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 job Cloud Scheduler

Segui i passaggi riportati di seguito per creare una funzione Cloud Functions Node.js che avvia un'esportazione dei dati Cloud Firestore e un job Cloud Scheduler per chiamare la 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
```
1. Seleziona JavaScript come linguaggio.
2. (Facoltativo) Abilita ESLint.
3. Inserisci y per installare le dipendenze.

Sostituisci il codice nel file functions/index.js con 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');
  });
});index.js

Nel codice riportato sopra, modifica quanto segue:
- Sostituisci BUCKET_NAME con il nome del tuo bucket.
- Sostituisci YOUR_PROJECT_ID con l'ID del progetto
- Modifica every 24 hours per impostare la pianificazione di esportazione. Utilizza la sintassi cron.yaml di App Engine o il formato unix-cron (* * * * *).
- Modifica collectionIds: [] per esportare solo i gruppi di raccolte specificati Lascia invariato per esportare tutti i gruppi di raccolte.
  
  Nota: se esporti tutte le raccolte, le successive operazioni di importazione devono importare tutte le raccolte nei file di dati di esportazione.
Esegui il deployment della funzione pianificata:
```
firebase deploy --only functions
```

Console Google Cloud

Crea una funzione Cloud

Vai alla pagina Cloud Functions nella console Google Cloud:

Vai a Cloud Functions
Fai clic su Scrivi una funzione.
Inserisci un nome per la 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:

const firestore = require('@google-cloud/firestore');
const client = new firestore.v1.FirestoreAdminClient();
// Replace BUCKET_NAME
const bucket = 'gs://BUCKET_NAME'

exports.scheduledFirestoreExport = (event, context) => {
  const databaseName = client.databasePath(
    YOUR_PROJECT_ID,
    '(default)'
  );

  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);
    });
};

Nel codice riportato sopra, modifica quanto segue:

Sostituisci BUCKET_NAME con il nome del tuo bucket.
Modifica collectionIds: [] per esportare solo i gruppi di raccolte specificati Lascia invariato per esportare tutti i gruppi di raccolte.

Nota: se esporti tutti i gruppi di raccolte, le successive operazioni di importazione devono importare tutti i gruppi di raccolte nei file di dati di esportazione.

In package.json, aggiungi la seguente dipendenza:

{
  "dependencies": {
    "@google-cloud/firestore": "^1.3.0"
  }
}

In Funzione da eseguire, inserisci scheduledFirestoreExport, il nome della funzione in index.js.
Fai clic su Crea per eseguire il deployment della funzione Cloud.

Crea un job Cloud Scheduler

Poi, crea un job Cloud Scheduler che chiama la funzione Cloud:

Vai alla pagina Cloud Scheduler nella console Google Cloud:

Vai a Cloud Scheduler
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, initiateFirestoreExport nell'esempio precedente.
Nel campo Payload, inserisci start export. Il job richiede un payload definito, ma la funzione Cloud riportata sopra non utilizza questo valore.
Fai clic su Crea.

A questo punto, hai eseguito il deployment della funzione Cloud e Cloud Scheduler del job, ma la funzione Cloud ha ancora bisogno delle autorizzazioni di accesso per eseguire le operazioni di esportazione.

Configurare le autorizzazioni di accesso

Poi, concedi alla funzione Cloud l'autorizzazione per avviare le operazioni di esportazione e scrivere nel bucket GCS.

Questa funzione Cloud utilizza il service account predefinito del progetto per autenticare e autorizzare le operazioni di esportazione. Quando crei un progetto, viene creato un service account predefinito con il seguente nome:

PROJECT_ID@appspot.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 predefinito:

Cloud Datastore Import Export Admin
Nota: Questo ruolo concede anche le autorizzazioni per Cloud Firestore.Datastore
Ruolo Owner o Storage Admin nel bucket

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, ed esegui il seguente comando:

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \
    --role roles/datastore.importExportAdmin

Assegna il ruolo Amministratore Storage nel bucket. Sostituisci PROJECT_ID e BUCKET_NAME, ed esegui il seguente comando:
```
gsutil iam ch serviceAccount:PROJECT_ID@appspot.gserviceaccount.com:admin \
    gs://BUCKET_NAME
```

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 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 Scheduler
Nella riga del nuovo job Cloud Scheduler, fai clic su Esegui ora.

Dopo alcuni secondi, 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. Apri la pagina della funzione Cloud per visualizzare i log della funzione.

Visualizzare i log della funzione Cloud

Per verificare se la funzione Cloud ha avviato correttamente un'operazione di esportazione, apri i log della funzione:

Console Firebase

Vai alla pagina Cloud Functions nella console Firebase.

Vai ai log delle funzioni

Console di GCP

Vai alla pagina Cloud Functions nella console Google Cloud.

Vai al visualizzatore log

Visualizzare lo stato di avanzamento dell'esportazione

Puoi utilizzare il comando gcloud firestore operations list per visualizzare lo stato di 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:

Apri il browser Cloud Storage