Questa pagina è stata tradotta dall'API Cloud Translation.

Pianificare le esportazioni di dati

Questa pagina descrive come pianificare le esportazioni dei dati Firestore. Per eseguire le esportazioni in base a una pianificazione, ti consigliamo di utilizzare Cloud Run 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 i progetti con la fatturazione abilitata possono utilizzare la funzionalità di esportazione e importazione.
Nota:per utilizzare la funzionalità di esportazione e importazione gestita, i progetti Firebase devono essere nel piano Blaze. L'abilitazione della fatturazione per Google Cloud esegue automaticamente l'upgrade del progetto Firebase al piano Blaze.
Le operazioni di esportazione richiedono un bucket Cloud Storage di destinazione. Crea un bucket Cloud Storage in una località vicina alla località del tuo database Firestore. Non puoi utilizzare un bucket con pagamenti a carico del richiedente per le operazioni di esportazione.

Crea una Cloud Function e un job Cloud Scheduler

Segui i passaggi riportati di seguito per creare una Cloud Function Node.js che avvia un'esportazione di dati 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 la CLI per Cloud Run Functions:
```
firebase init functions --project PROJECT_ID
```
1. Seleziona JavaScript come lingua.
2. (Facoltativo) Attiva 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 precedente, modifica quanto segue:
- Sostituisci BUCKET_NAME con il nome del tuo bucket.
- Sostituisci YOUR_PROJECT_ID con l'ID del tuo progetto.
- Modifica every 24 hours per impostare la pianificazione dell'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 tutte le raccolte.
  
  Nota: se esporti tutte le raccolte, tutte le operazioni di importazione successive devono importare tutte le raccolte nei file di dati di esportazione.
Esegui il deployment della funzione pianificata:
```
firebase deploy --only functions
```

ConsoleGoogle 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 funzione, ad esempio firestore-export.
In Trigger, seleziona Cloud Pub/Sub.
Nella sezione 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 collections
      // or define a list of collection 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 tutte le raccolte.

Nota: se esporti tutte le raccolte, tutte le operazioni di importazione successive devono importare tutte le 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 Cloud Function.

Crea un job Cloud Scheduler

Successivamente, crea un job Cloud Scheduler che chiami la tua Cloud Function:

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

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

Configurare le autorizzazioni di accesso

Dopodiché, concedi alla Cloud Function l'autorizzazione per avviare le operazioni di esportazione e scrivere nel bucket GCS.

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

PROJECT_ID@appspot.gserviceaccount.com

Questo account di servizio richiede l'autorizzazione per avviare un'operazione di esportazione e per scrivere nel tuo bucket Cloud Storage. Per concedere queste autorizzazioni, assegna i seguenti ruoli IAM al account di servizio predefinito:

Cloud Datastore Import Export Admin
Nota: questo ruolo Datastore concede anche le autorizzazioni per Firestore.
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 questo 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 al tuo 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 account di servizio predefinito di App Engine, la tua app App Engine perderà l'accesso al tuo database Firestore. Se hai disattivato il account di servizio App Engine, puoi riattivarlo. Consulta la sezione Abilitare un service account. Se hai eliminato il account di servizio App Engine negli ultimi 30 giorni, puoi ripristinarlo. Consulta la sezione Annullare l'eliminazione di un service account.

Testa il job Cloud Scheduler e Cloud Function

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 Success e Last run all'ora corrente. Potrebbe essere necessario fare clic su Aggiorna.

La pagina Cloud Scheduler conferma solo che il job ha chiamato la tua Cloud Functions. Apri la pagina Cloud Function per visualizzare i log della funzione.

Visualizza i log di Cloud Function

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

Console Firebase

Vai alla pagina Cloud Run Functions nella console Firebase.

Vai a Log delle funzioni

Console di GCP

Vai alla pagina Cloud Run Functions nella console Google Cloud .

Vai al visualizzatore log

Visualizzare l'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 Gestione delle operazioni di importazione ed esportazione.

Una volta completata un'operazione di esportazione, puoi visualizzare i file di output nel bucket Cloud Storage:

Apri il browser Cloud Storage