Esportazione e importazione delle entità

Questa pagina descrive come esportare e importare entità Firestore in modalità Datastore utilizzando il servizio di esportazione e importazione gestito. Il servizio di esportazione e importazione gestito è disponibile tramite la console Google Cloud, Google Cloud CLI e l'API Datastore Admin (REST, RPC).

Con il servizio di esportazione e importazione gestito, puoi recuperare i dati dall'eliminazione accidentale ed esportarli per l'elaborazione offline. Puoi esportare tutte le entità o solo tipi specifici di entità. Allo stesso modo, puoi importare tutti i dati di un'esportazione o solo tipi specifici. Quando utilizzi il servizio di esportazione ed importazione gestito, tieni presente quanto segue:

  • Il servizio di esportazione utilizza letture a coerenza finale. Non puoi assumere che un'esportazione avvenga in un unico momento. L'esportazione potrebbe includere le entità scritte dopo l'inizio dell'esportazione ed escludere quelle scritte prima dell'inizio dell'esportazione.

  • Un'esportazione non contiene indici. Quando importi i dati, gli indici richiesti vengono ricostruiti automaticamente utilizzando le definizioni degli indici correnti del database. Le impostazioni dell'indice dei valori delle proprietà per entità vengono esportate e rispettate durante l'importazione.

  • Le importazioni non assegnano nuovi ID alle entità. Le importazioni utilizzano gli ID esistenti al momento dell'esportazione e sovrascrivono qualsiasi entità esistente con lo stesso ID. Durante un'importazione, gli ID vengono riservati durante il periodo di importazione delle entità. Questa funzionalità impedisce le collisioni di ID con le nuove entità se le scritture sono attivate durante l'esecuzione di un'importazione.

  • Se un'entità nel tuo database non è interessata da un'importazione, rimarrà nel database dopo l'importazione.

  • I dati esportati da un database in modalità Datastore possono essere importati in un altro database in modalità Datastore, anche in un altro progetto.

  • Il servizio di esportazione e importazione gestito limita il numero di esportazioni e importazioni simultanee a 50 e consente un massimo di 20 richieste di esportazione e importazione al minuto per un progetto. Per ogni richiesta, il servizio limita a 100 il numero di combinazioni di filtri delle entità.

  • L'output di un'esportazione gestita utilizza il formato del log LevelDB.

  • Per importare solo un sottoinsieme di entità o per importare i dati in BigQuery, devi specificare un filtro delle entità nell'esportazione.

  • Il nome file .overall_export_metadata deve corrispondere al nome della cartella parente:

    gs://BUCKET_NAME/OPTIONAL_NAMESPACE_PATH/PARENT_FOLDER_NAME/PARENT_FOLDER_NAME.overall_export_metadata

    Se sposti o copi i file di output di un'esportazione, mantieni invariati PARENT_FOLDER_NAME, i contenuti delle sottocartelle e il nome del file .overall_export_metadata.

Prima di iniziare

Prima di poter utilizzare il servizio di esportazione e importazione gestito, devi completare le seguenti attività.

  1. Abilita la fatturazione per il tuo progetto Google Cloud. Solo i progetti Google Cloud con la fatturazione abilitata possono utilizzare le funzionalità di esportazione e importazione.

  2. Crea un bucket Cloud Storage nella stessa posizione del database Firestore in modalità Datastore. Non puoi utilizzare un bucket paga il richiedente per le operazioni di esportazione e importazione.

  3. Assegna al tuo account utente un ruolo IAM che conceda l'autorizzazionedatastore.databases.export, se esporti i dati, o l'autorizzazionedatastore.databases.import, se importi i dati. Ad esempio, il ruolo Datastore Import Export Admin concede entrambe le autorizzazioni.

  4. Se il bucket Cloud Storage si trova in un altro progetto, concedi all'agente di servizio Firestore l'accesso al bucket.

Configura gcloud per il tuo progetto

Se prevedi di utilizzare gcloud per avviare le operazioni di importazione ed esportazione, configura gcloud e connettiti al tuo progetto in uno dei seguenti modi:

Autorizzazioni

Per eseguire operazioni di esportazione e importazione, il tuo account utente e l'agente di servizio in modalità Datastore del tuo progetto richiedono le seguenti autorizzazioni per Identity and Access Management.

Autorizzazioni dell'account utente

L'account utente o l'account di servizio che avvia l'operazione richiede le autorizzazioni IAM datastore.databases.export e datastore.databases.import. Se sei il proprietario del progetto, il tuo account dispone delle autorizzazioni richieste. In caso contrario, i seguenti ruoli IAM grantono le autorizzazioni necessarie:

  • Proprietario Datastore
  • Datastore Import Export Admin

Puoi anche assegnare queste autorizzazioni con un ruolo personalizzato.

Un proprietario del progetto può concedere uno di questi ruoli seguendo i passaggi descritti in Concedi l'accesso.

Autorizzazioni agente di servizio

Le operazioni di esportazione e importazione utilizzano un agente di servizio Firestore per autorizzare le operazioni di Cloud Storage. L'agente di servizio Firestore utilizza la seguente convenzione di denominazione:

Agente di servizio Firestore
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

Per scoprire di più sugli agenti di servizio, consulta Agenti di servizio.

L'agente di servizio Firestore richiede l'accesso al bucket Cloud Storage utilizzato in un'operazione di esportazione o importazione. Se il bucket Cloud Storage si trova nello stesso progetto del database Firestore, l'agente di servizio Firestore può accedere al bucket per impostazione predefinita.

Se il bucket Cloud Storage si trova in un altro progetto, devi fornire all'agente di servizio Firestore l'accesso al bucket Cloud Storage.

Assegna i ruoli all'agente di servizio

Puoi utilizzare lo strumento a riga di comando gsutil per assegnare uno dei ruoli riportati di seguito. Ad esempio, per assegnare il ruolo Amministratore dello spazio di archiviazione all'agente di servizio Firestore, esegui quanto segue:

gsutil iam ch serviceAccount:service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com:roles/storage.admin \
    gs://[BUCKET_NAME]

Sostituisci PROJECT_NUMBER con il numero del progetto, che viene utilizzato per assegnare un nome all'agente di servizio Firestore. Per visualizzare il nome dell'agente di servizio, vedi Visualizzare il nome dell'agente di servizio.

In alternativa, puoi assegnare questo ruolo utilizzando la console Google Cloud.

Visualizza il nome dell'agente di servizio

Puoi visualizzare l'account utilizzato dalle operazioni di importazione ed esportazione per autorizzare le richieste dalla pagina Importa/Esporta nella console Google Cloud. Puoi anche controllare se il tuo database utilizza l'agente di servizio Firestore o l'account di servizio App Engine precedente.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Visualizza l'account di autorizzazione accanto all'etichetta I job di importazione/esportazione vengono eseguiti come.

Operazioni di esportazione

Per le operazioni di esportazione che coinvolgono un bucket in un altro progetto, modifica le autorizzazioni del bucket per assegnare uno dei seguenti ruoli di Identity and Access Management all'agente di servizio in modalità Datastore del progetto che contiene il database in modalità Datastore:

  • Amministratore Storage
  • Proprietario (ruolo di base)

Puoi anche creare un ruolo IAM personalizzato con autorizzazioni leggermente diverse da quelle contenute nei ruoli elencati in precedenza:

  • storage.buckets.get
  • storage.objects.create
  • storage.objects.delete
  • storage.objects.list

Operazioni di importazione

Per le operazioni di importazione che coinvolgono un bucket Cloud Storage in un altro progetto, modifica le autorizzazioni del bucket per assegnare uno dei seguenti ruoli Cloud Storage all'agente di servizio della modalità Datastore del progetto che contiene il database della modalità Datastore:

  • Amministratore Storage
  • Sia Storage Object Viewer sia Storage Legacy Bucket Reader

Puoi anche creare un ruolo IAM personalizzato con le seguenti autorizzazioni:

  • storage.buckets.get
  • storage.objects.get

Avvio di operazioni di esportazione e importazione gestite

Questa sezione descrive come avviare un'operazione di esportazione o importazione gestita.

Esportazione di tutte le entità

Console

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  1. Nel menu di navigazione, fai clic su Importazione/esportazione.
  2. Fai clic su Esporta.
  3. Imposta il campo Namespace su All Namespaces e il campo Tipo su All Kinds.
  4. Sotto Destinazione, inserisci il nome del bucket Cloud Storage.
  5. Fai clic su Esporta.

La console torna alla pagina Importa/Esporta. Un avviso segnala il buon esito o l'errore della richiesta di esportazione gestita.

gcloud

Utilizza il comando gcloud firestore export per esportare tutte le entità nel database.

 gcloud firestore export gs://bucket-name --async --database=DATABASE

dove bucket-name è il nome del bucket Cloud Storage e un prefisso facoltativo, ad esempio bucket-name/datastore-exports/export-name. Non puoi riutilizzare lo stesso prefisso per un'altra operazione di esportazione. Se non fornisci un prefisso del file, il servizio di esportazione gestita ne crea uno in base all'ora corrente.

Utilizza il flag [--async][async-flag] per impedire a gcloud di attendere il completamento dell'operazione. Se ometti il flag --async, puoi digitare Ctrl+c per interrompere l'attesa di un'operazione. L'operazione non verrà annullata.

Imposta il flag --database sul nome del database da cui vuoi esportare le entità. Per il database predefinito, utilizza --database='(default)'.

rest

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

  • project-id: il tuo ID progetto
  • bucket-name: il nome del bucket Cloud Storage

Metodo HTTP e URL:

POST https://datastore.googleapis.com/v1/projects/project-id:export

Corpo JSON della richiesta:

{
  "outputUrlPrefix": "gs://bucket-name",
}

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/project-id/operations/operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
    "common": {
      "startTime": "2019-09-18T18:42:26.591949Z",
      "operationType": "EXPORT_ENTITIES",
      "state": "PROCESSING"
    },
    "entityFilter": {},
    "outputUrlPrefix": "gs://bucket-name/2019-09-18T18:42:26_85726"
  }
}
La risposta è un'operazione a lunga esecuzione, che puoi verificare se è stata completata.

Esportazione di tipi o spazi dei nomi specifici

Per esportare un sottoinsieme specifico di tipi e/o spazi dei nomi, fornisci un filtro delle entità con i valori per i tipi e gli ID spazio dei nomi. Ogni richiesta è limitata a 100 combinazioni di filtri delle entità, dove ogni combinazione di tipo e spazio dei nomi filtrati viene conteggiata come un filtro separato ai fini di questo limite.

Console

Nella console puoi selezionare tutti i tipi o uno specifico. Analogamente, puoi selezionare tutti gli spazi dei nomi o uno spazio dei nomi specifico.

Per specificare un elenco di spazi dei nomi e tipi da esportare, utilizza gcloud.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Fai clic su Esporta.

  5. Imposta il campo Spazio dei nomi su All Namespaces o sul nome di uno dei tuoi spazi dei nomi.

  6. Imposta il campo Tipo su All Kinds o sul nome di un tipo.

  7. In Destinazione, inserisci il nome del bucket Cloud Storage.

  8. Fai clic su Esporta.

La console torna alla pagina Importa/Esporta. Un avviso segnala il buon esito o l'errore della richiesta di esportazione gestita.

gcloud

  gcloud firestore export --collection-ids="KIND1,KIND2" \
  --namespaces="(default),NAMESPACE2" \
  gs://bucket-name \
  --async \
  --database=DATABASE

dove bucket-name è il nome del bucket Cloud Storage e un prefisso facoltativo, ad esempio bucket-name/datastore-exports/export-name. Non puoi riutilizzare lo stesso prefisso per un'altra operazione di esportazione. Se non fornisci un prefisso del file, il servizio di esportazione gestita ne crea uno in base all'ora corrente.

Utilizza il flag [--async][async-flag] per impedire a gcloud di attendere il completamento dell'operazione. Se ometti il flag --async, puoi digitare Ctrl+c per interrompere l'attesa di un'operazione. L'operazione non verrà annullata.

Imposta il flag --database sul nome del database da cui vuoi esportare tipi o spazi dei nomi specifici. Per il database predefinito, utilizza --database='(default)'.

rest

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

  • project-id: il tuo ID progetto
  • bucket-name: il nome del bucket Cloud Storage
  • kind: il tipo di entità
  • namespace: l'ID del namespace (utilizza "" per l'ID del namespace predefinito)

Metodo HTTP e URL:

POST https://datastore.googleapis.com/v1/projects/project-id:export

Corpo JSON della richiesta:

{
  "outputUrlPrefix": "gs://bucket-name",
  "entityFilter": {
    "kinds": ["kind"],
    "namespaceIds": ["namespace"],
  },
}

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/project-id/operations/operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
    "common": {
      "startTime": "2019-09-18T21:17:36.232704Z",
      "operationType": "EXPORT_ENTITIES",
      "state": "PROCESSING"
    },
    "entityFilter": {
      "kinds": [
        "Task"
      ],
      "namespaceIds": [
        ""
      ]
    },
    "outputUrlPrefix": "gs://bucket-name/2019-09-18T21:17:36_82974"
  }
}
La risposta è un'operazione a lunga esecuzione, che puoi verificare se è stata completata.

File di metadati

Un'operazione di esportazione crea un file di metadati per ogni coppia di tipo e spazio dei nomi specificata. I file di metadati sono in genere denominati NAMESPACE_NAME_KIND_NAME.export_metadata. Tuttavia, se uno spazio dei nomi o un tipo creasse un nome dell'oggetto Cloud Storage non valido, il file verrà chiamato export[NUM].export_metadata.

I file di metadati sono buffer di protocollo e possono essere decodificati con il compilatore di protocolli protoc. Ad esempio, puoi decodificare un file di metadati per determinare lo spazio dei nomi e i tipi contenuti nei file di esportazione:

protoc --decode_raw < export0.export_metadata

Importazione di tutte le entità

Console

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Fai clic su Importa.

  5. Nel campo File, fai clic su Sfoglia e seleziona un file .overall_export_metadata.

    Assicurati che il file .overall_export_metadata non venga spostato dalla posizione predefinita.

  6. Imposta il campo Namespace su All Namespaces e il campo Tipo su All Kinds.

  7. Fai clic su Importa.

La console torna alla pagina Importa/Esporta. Un avviso segnala il buon esito o l'errore della richiesta di importazione gestita.

gcloud

Utilizza il comando gcloud firestore import per importare tutte le entità esportate in precedenza con il servizio di esportazione gestita.

gcloud firestore import gs://bucket-name/file-path/file-name.overall_export_metadata \
--async \
--database=DATABASE

dove bucket-name/file-path/file-name è il percorso del file overall_export_metadata all'interno del bucket Cloud Storage.

Utilizza il flag [--async][async-flag] per impedire a gcloud di attendere il completamento dell'operazione. Se ometti il flag --async, puoi digitare Ctrl+c per interrompere l'attesa di un'operazione. L'operazione non verrà annullata.

Imposta il flag --database sul nome del database in cui vuoi importare tutte le entità. Per il database predefinito, utilizza --database='(default)'.

rest

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

  • project-id: il tuo ID progetto
  • bucket-name: il nome del bucket Cloud Storage
  • object-name: il nome dell'oggetto Cloud Storage (ad es. 2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata

Metodo HTTP e URL:

POST https://datastore.googleapis.com/v1/projects/project-id:import

Corpo JSON della richiesta:

{
  "inputUrl": "gs://bucket-name/object-name",
}

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/project-id/operations/operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ImportEntitiesMetadata",
    "common": {
      "startTime": "2019-09-18T21:25:02.863621Z",
      "operationType": "IMPORT_ENTITIES",
      "state": "PROCESSING"
    },
    "entityFilter": {},
    "inputUrl": "gs://bucket-name/2019-09-18T18:42:26_85726/2019-09-18T18:42:26_85726.overall_export_metadata"
  }
}
La risposta è un'operazione a lunga esecuzione, che puoi verificare se è stata completata.

Individuare il file overall_export_metadata

Puoi determinare il valore da utilizzare per la posizione di importazione utilizzando il browser Cloud Storage nella console Google Cloud:

Apri il browser Cloud Storage

Puoi anche elencare e descrivere le operazioni completate. Il campo outputURL mostra il nome del file overall_export_metadata:

"outputUrl": "gs://bucket-name/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata",

Importazione di tipi o spazi dei nomi specifici

Per importare un sottoinsieme specifico di tipi e/o spazi dei nomi, fornisci un filtro delle entità con i valori per i tipi e gli ID spazio dei nomi.

Puoi specificare tipi e spazi dei nomi solo se i file di esportazione sono stati creati con un filtro delle entità. Non puoi importare un sottoinsieme di tipi e spazi dei nomi da un'esportazione di tutte le entità.

Console

Nella console puoi selezionare tutti i tipi o uno specifico. Analogamente, puoi selezionare tutti gli spazi dei nomi o uno spazio dei nomi specifico.

Per specificare un elenco di spazi dei nomi e tipi da importare, utilizza gcloud.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Fai clic su Importa.

  5. Nel campo File, fai clic su Sfoglia e seleziona un file .overall_export_metadata.

    Assicurati di importare il file .overall_export_metadata e non un file .export_metadata.

  6. Imposta il campo Spazio dei nomi su All Namespaces o su uno spazio dei nomi specifico.

  7. Imposta il campo Tipo su All Kinds o su un tipo specifico.

  8. Fai clic su Importa.

La console torna alla pagina Importa/Esporta. Un avviso segnala il buon esito o l'errore della richiesta di importazione gestita.

gcloud

  gcloud firestore import --collection-ids="KIND1,KIND2" \
  --namespaces="(default),NAMESPACE2" \
  gs://bucket-name/file-path/file-nameoverall_export_metadata \
  --async \
  --database=DATABASE

dove bucket-name/file-path/file-name è il percorso del file overall_export_metadata all'interno del bucket Cloud Storage.

Utilizza il flag [--async][async-flag] per impedire a gcloud di attendere il completamento dell'operazione. Se ometti il flag --async, puoi digitare Ctrl+c per interrompere l'attesa di un'operazione. L'operazione non verrà annullata.

Imposta il flag --database sul nome del database in cui vuoi importare i tipi o gli spazi dei nomi specifici. Per il database predefinito, utilizza --database='(default)'.

rest

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

  • project-id: il tuo ID progetto
  • bucket-name: il nome del bucket Cloud Storage
  • object-name: il nome dell'oggetto Cloud Storage (ad es. 2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata
  • kind: il tipo di entità
  • namespace: l'ID del namespace (utilizza "" per l'ID del namespace predefinito)

Metodo HTTP e URL:

POST https://datastore.googleapis.com/v1/projects/project-id:import

Corpo JSON della richiesta:

{
  "inputUrl": "gs://bucket-name/object-name",
  "entityFilter": {
    "kinds": ["kind"],
    "namespaceIds": ["namespace"],
  },
}

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/project-id/operations/operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ImportEntitiesMetadata",
    "common": {
      "startTime": "2019-09-18T21:51:02.830608Z",
      "operationType": "IMPORT_ENTITIES",
      "state": "PROCESSING"
    },
    "entityFilter": {
      "kinds": [
        "Task"
      ],
      "namespaceIds": [
        ""
      ]
    },
    "inputUrl": "gs://bucket-name/2019-09-18T21:49:25_96833/2019-09-18T21:49:25_96833.overall_export_metadata"
  }
}
La risposta è un'operazione a lunga esecuzione, che puoi verificare se è stata completata.

Esportazione e importazione dai dati PITR

Puoi esportare il database in Cloud Storage dai dati PITR utilizzando il comando gcloud firestore export. Puoi esportare i dati PITR in cui il timestamp è un timestamp intero di un minuto negli ultimi sette giorni, ma non prima del giorno earliestVersionTime. Se i dati non esistono più al timestamp specificato, l'operazione di esportazione non va a buon fine.

L'operazione di esportazione PITR supporta tutti i filtri, inclusa l'esportazione di tutte le entità e di tipi o spazi dei nomi specifici.

  1. Esporta il database specificando il parametro snapshot-time con il timestamp di recupero richiesto.

    gcloud

    Esegui il comando seguente per esportare il database nel bucket.

    gcloud firestore export gs://[BUCKET_NAME_PATH] \
        --snapshot-time=[PITR_TIMESTAMP] \
        --collection-ids=[COLLECTION_IDS] \
        --namespace-ids=[NAMESPACE_IDS]
    

    Dove,

    • PITR_TIMESTAMP: un timestamp PITR con granularità a livello di minuto, ad esempio 2023-05-26T10:20:00.00Z.

    È supportata anche l'[esportazione di un sottoinsieme specifico di tipi e/o spazi dei nomi con un filtro delle entità][export-kind].

    Tieni presente quanto segue prima di esportare i dati PITR:

    • Specifica il timestamp nel formato RFC 3339. Ad esempio, 2020-09-01T23:59:30.234233Z.
    • Assicurati che il timestamp specificato sia un timestamp di un minuto intero compreso negli ultimi sette giorni, ma non precedente al giorno earliestVersionTime. Se i dati non esistono più al timestamp specificato, viene visualizzato un errore.
    • Non ti verrà addebitato alcun importo per un'esportazione PITR non riuscita.
  2. Importazione in un database.

    Segui i passaggi descritti in Importare tutte le entità per importare il database esportato. Se nel database esiste già un'entità, verrà sovrascritta. È supportata anche l'[importazione di un sottoinsieme specifico di tipi e/o spazi dei nomi con un filtro delle entità][import-kind].

Importare le trasformazioni

Quando importi entità da un altro progetto, tieni presente che le chiavi delle entità includono l'ID progetto. Un'operazione di importazione aggiorna le chiavi delle entità e le proprietà di riferimento chiave nei dati di importazione con l'ID progetto del progetto di destinazione. Se questo aggiornamento aumenta le dimensioni delle entità, può causare errori "entità troppo grande" o "voci dell'indice troppo grandi" per le operazioni di importazione.

Per evitare entrambi gli errori, importa in un progetto di destinazione con un ID progetto più breve. Ciò non influisce sulle operazioni di importazione con i dati dello stesso progetto.

Gestione di operazioni a lunga esecuzione

Le operazioni di importazione ed esportazione gestite sono operazioni a lunga esecuzione. Il completamento di queste chiamate al metodo può richiedere molto tempo.

Dopo aver avviato un'operazione di esportazione o importazione, la modalità Datastore assegna all'operazione un nome univoco. Puoi utilizzare il nome dell'operazione per eliminarla, annullarla o verificarne lo stato.

I nomi delle operazioni sono preceduti da projects/[PROJECT_ID]/databases/(default)/operations/, ad esempio:

projects/project-id/databases/(default)/operations/ASA1MTAwNDQxNAgadGx1YWZlZAcSeWx0aGdpbi1zYm9qLW5pbWRhEgopEg

Puoi omettere il prefisso quando specifichi un nome dell'operazione per i comandi gcloud.

Elenco di tutte le operazioni a lunga esecuzione

Puoi visualizzare le operazioni in corso e quelle completate di recente nei seguenti modi. Le operazioni vengono elencate per alcuni giorni dopo il completamento:

Console

Puoi visualizzare un elenco delle operazioni a lungo termine nella pagina Importa/Esporta della console Google Cloud.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

gcloud

Per elencare le operazioni di lunga durata, utilizza il comando gcloud datastore operations list.

gcloud datastore operations list

Ad esempio, un'operazione di esportazione completata di recente mostra le seguenti informazioni:

{
  "operations": [
    {
      "name": "projects/project-id/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
      "metadata": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
        "common": {
          "startTime": "2017-12-05T23:01:39.583780Z",
          "endTime": "2017-12-05T23:54:58.474750Z",
          "operationType": "EXPORT_ENTITIES"
        },
        "progressEntities": {
          "workCompleted": "21933027",
          "workEstimated": "21898182"
        },
        "progressBytes": {
          "workCompleted": "12421451292",
          "workEstimated": "9759724245"
        },
        "entityFilter": {
          "namespaceIds": [
            ""
          ]
        },
        "outputUrlPrefix": "gs://bucket-name"
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesResponse",
        "outputUrl": "gs://bucket-name/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata"
      }
    }
  ]
}

rest

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

  • project-id: il tuo ID progetto

Metodo HTTP e URL:

GET https://datastore.googleapis.com/v1/projects/project-id/operations

Per inviare la richiesta, espandi una di queste opzioni:

Consulta le informazioni sulla risposta di seguito.

Ad esempio, un'operazione di esportazione completata di recente mostra le seguenti informazioni:

{
  "operations": [
    {
      "name": "projects/project-id/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
      "metadata": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
        "common": {
          "startTime": "2017-12-05T23:01:39.583780Z",
          "endTime": "2017-12-05T23:54:58.474750Z",
          "operationType": "EXPORT_ENTITIES"
        },
        "progressEntities": {
          "workCompleted": "21933027",
          "workEstimated": "21898182"
        },
        "progressBytes": {
          "workCompleted": "12421451292",
          "workEstimated": "9759724245"
        },
        "entityFilter": {
          "namespaceIds": [
            ""
          ]
        },
        "outputUrlPrefix": "gs://bucket-name"
      },
      "done": true,
      "response": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesResponse",
        "outputUrl": "gs://bucket-name/2017-05-25T23:54:39_76544/2017-05-25T23:54:39_76544.overall_export_metadata"
      }
    }
  ]
}

Controllare lo stato dell'operazione

Per visualizzare lo stato di un'operazione a lunga esecuzione:

Console

Puoi visualizzare un elenco delle operazioni di esportazione e importazione più recenti nella pagina Importa/Esporta della console Google Cloud.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

gcloud

Utilizza il comando operations describe per visualizzare lo stato di un'operazione a lunga esecuzione.

gcloud datastore operations describe operation-name

rest

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

  • project-id: il tuo ID progetto
  • operation-name: il nome dell'operazione

Metodo HTTP e URL:

GET https://datastore.googleapis.com/v1/projects/project-id/operations/operation-name

Per inviare la richiesta, espandi una di queste opzioni:

Dovresti ricevere una risposta JSON simile alla seguente:

{
  "name": "projects/project-id/operations/ASA3ODAwMzQxNjIyChp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKLRI",
  "metadata": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
    "common": {
      "startTime": "2019-10-08T20:07:28.105236Z",
      "endTime": "2019-10-08T20:07:36.310653Z",
      "operationType": "EXPORT_ENTITIES",
      "state": "SUCCESSFUL"
    },
    "progressEntities": {
      "workCompleted": "21",
      "workEstimated": "21"
    },
    "progressBytes": {
      "workCompleted": "2272",
      "workEstimated": "2065"
    },
    "entityFilter": {},
    "outputUrlPrefix": "gs://bucket-name/2019-10-08T20:07:28_28481"
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesResponse",
    "outputUrl": "gs://bucket-name/2019-10-08T20:07:28_28481/2019-10-08T20:07:28_28481.overall_export_metadata"
  }
}

Stima del tempo di completamento

Durante l'esecuzione dell'operazione, controlla il valore del campo state per lo stato complessivo dell'operazione.

Una richiesta relativa allo stato di un'operazione a lunga esecuzione restituisce le metriche workEstimated e workCompleted. Ognuna di queste metriche viene restituita sia in termini di numero di byte sia in termini di numero di entità:

  • workEstimated mostra il numero totale stimato di byte e documenti che verrà elaborato da un'operazione. La modalità Datastore potrebbe omettere questa metrica se non riesce a fare una stima.

  • workCompleted mostra il numero di byte e documenti elaborati fino a quel momento. Al termine dell'operazione, il valore mostra il numero totale di byte e documenti effettivamente elaborati, che potrebbe essere superiore al valore di workEstimated.

Dividi workCompleted per workEstimated per una stima approssimativa dei progressi. Questa stima potrebbe non essere precisa, in quanto dipende dalla raccolta delle statistiche con ritardo.

Ad esempio, di seguito è riportato lo stato di avanzamento di un'operazione di esportazione:

{
  "operations": [
    {
      "name": "projects/project-id/operations/ASAyMDAwOTEzBxp0bHVhZmVkBxJsYXJ0bmVjc3Utc2Jvai1uaW1kYRQKKhI",
      "metadata": {
        "@type": "type.googleapis.com/google.datastore.admin.v1.ExportEntitiesMetadata",
        ...
        "progressEntities": {
          "workCompleted": "1",
          "workEstimated": "3"
        },
        "progressBytes": {
          "workCompleted": "85",
          "workEstimated": "257"
        },
        ...

Al termine di un'operazione, la descrizione dell'operazione contiene "done": true. Consulta il valore del campo state per il risultato dell'operazione. Se il campo done non è impostato nella risposta, il suo valore è false. Non fare affidamento sull'esistenza del valore done per le operazioni in corso.

Annullare un'operazione

Console

Puoi annullare un'operazione di esportazione o importazione in esecuzione nella pagina Importa/Esporta della console Google Cloud.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.

  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

Nella tabella Importazioni ed esportazioni recenti, le operazioni in esecuzione includono un pulsante Annulla nella colonna Completata. Fai clic sul pulsante Annulla per interrompere l'operazione. Il pulsante diventa un messaggio Annullamento e poi Annullato quando l'operazione si interrompe completamente.

gcloud

Utilizza il comando operations cancel per interrompere un'operazione in corso:

gcloud datastore operations cancel operation-name

L'annullamento di un'operazione in esecuzione non annulla l'operazione. Un'operazione di esportazione annullata lascia i documenti già esportati in Cloud Storage e un'operazione di importazione annullata lascia invariati gli aggiornamenti già apportati al database. Non puoi importare un'esportazione completata parzialmente.

Eliminare un'operazione

gcloud

Utilizza il comando operations delete per rimuovere un'operazione dall'elenco delle operazioni recenti. Questo comando non elimina i file di esportazione da Cloud Storage.

gcloud datastore operations delete operation-name

Fatturazione e prezzi per le esportazioni e le importazioni gestite

Prima di utilizzare il servizio di esportazione e importazione gestito, devi abilitare la fatturazione per il tuo progetto Google Cloud. Le operazioni di esportazione e importazione contribuiscono ai costi di Google Cloud nei seguenti modi:

  • Le letture e le scritture delle entità eseguite dalle operazioni di esportazione e importazione vengono conteggiate ai fini dei costi di Firestore in modalità Datastore. Le operazioni di esportazione comportano un'operazione di lettura per entità esportata. Le operazioni di importazione comportano un'operazione di scrittura per ogni entità importata.
  • I file di output archiviati in Cloud Storage vengono conteggiati ai fini dei costi di archiviazione dei dati di Cloud Storage.

Le operazioni di esportazione o importazione non attivano gli avvisi relativi al budget di Google Cloud fino al termine. Analogamente, le letture e le scritture eseguite durante un'operazione di esportazione o importazione vengono applicate alla quota giornaliera al termine dell'operazione.

Visualizzare i costi di esportazione e importazione

Le operazioni di esportazione e importazione applicano l'etichetta goog-firestoremanaged:exportimport alle operazioni fatturate. Nella pagina Report di fatturazione Cloud, puoi utilizzare questa etichetta per visualizzare i costi relativi alle operazioni di importazione ed esportazione:

Accedi all&#39;etichetta goog-firestoremanaged dal menu dei filtri.

Differenze rispetto ai backup di Datastore Admin

Se in precedenza utilizzavi la Console di amministrazione di Datastore per i backup, tieni presente le seguenti differenze:

  • Le esportazioni create da un'esportazione gestita non vengono visualizzate nella Console di amministrazione di Datastore. Le esportazioni e le importazioni gestite sono un nuovo servizio che non condivide i dati con la funzionalità di backup e ripristino di App Engine, che viene amministrata tramite la console Google Cloud.

  • Il servizio di esportazione e importazione gestito non supporta gli stessi metadati del backup di Datastore Admin e non memorizza lo stato di avanzamento nel database. Per informazioni su come controllare lo stato di avanzamento delle operazioni di esportazione e importazione, consulta Gestione di operazioni a lunga esecuzione.

  • Non puoi visualizzare i log di servizio delle operazioni di esportazione e importazione gestite.

  • Il servizio di importazione gestita è compatibile con le versioni precedenti dei file di backup di Datastore Admin. Puoi importare un file di backup di Datastore Admin utilizzando il servizio di importazione gestita, ma non puoi importare l'output di un'esportazione gestita utilizzando la Console di amministrazione di Datastore.

Importazione in BigQuery

Per importare i dati da un'esportazione gestita in BigQuery, consulta Caricare i dati del servizio di esportazione di Datastore.

I dati esportati senza specificare un filtro delle entità non possono essere caricati in BigQuery. Se vuoi importare i dati in BigQuery, la richiesta di esportazione deve includere uno o più nomi di tipo nel filtro delle entità.

Limite di colonne BigQuery

BigQuery impone un limite di 10.000 colonne per tabella. Le operazioni di esportazione generano uno schema della tabella BigQuery per ogni tipo. In questo schema, ogni proprietà univoca all'interno delle entità di un tipo diventa una colonna dello schema.

Se lo schema BigQuery di un tipo supera le 10.000 colonne, l'operazione di esportazione tenta di rimanere al di sotto del limite di colonne trattando le entità incorporate come blob. Se questa conversione riduce il numero di colonne nello schema a meno di 10.000, puoi caricare i dati in BigQuery, ma non puoi eseguire query sulle proprietà all'interno delle entità incorporate. Se il numero di colonne supera ancora 10.000, l'operazione di esportazione non genera uno schema BigQuery per il tipo e non puoi caricarne i dati in BigQuery.

Migrazione dell'agente di servizio

Firestore utilizza un agente di servizio Firestore per autorizzare le operazioni di importazione e esportazione anziché l'account di servizio App Engine. L'agente di servizio e l'account di servizio utilizzano le seguenti convenzioni di denominazione:

Agente di servizio Firestore
service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com

In precedenza, Firestore utilizzava l'account di servizio predefinito di App Engine anziché l'agente di servizio Firestore. Se il tuo database utilizza ancora l'account di servizio App Engine per importare o esportare dati, ti consigliamo di seguire le istruzioni riportate in questa sezione per eseguire la migrazione all'utilizzo dell'agente di servizio Firestore.

Service account App Engine
PROJECT_ID@appspot.gserviceaccount.com

L'agente di servizio Firestore è preferibile perché è specifico per Firestore. L'account di servizio App Engine è condiviso da più di un servizio.

Visualizza l'account di autorizzazione

Puoi visualizzare l'account utilizzato dalle operazioni di importazione ed esportazione per autorizzare le richieste dalla pagina Importa/Esporta nella console Google Cloud. Puoi anche controllare se il tuo database utilizza già l'agente di servizio Firestore.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Visualizza l'account di autorizzazione accanto all'etichetta I job di importazione/esportazione vengono eseguiti come.

Se il tuo progetto non utilizza l'agente di servizio Firestore, puoi eseguire la migrazione all'agente di servizio Firestore utilizzando una di queste tecniche:

La prima di queste tecniche è preferibile perché localizza l'ambito dell'effetto a un singolo progetto in modalità Datastore. La seconda tecnica non è preferita perché non esegue la migrazione delle autorizzazioni dei bucket Cloud Storage esistenti. Tuttavia, offre la conformità alla sicurezza a livello di organizzazione.

Esegui la migrazione controllando e aggiornando le autorizzazioni del bucket Cloud Storage

La procedura di migrazione prevede due passaggi:

  1. Aggiorna le autorizzazioni del bucket Cloud Storage. Per maggiori dettagli, consulta la sezione che segue.
  2. Conferma la migrazione all'agente di servizio Firestore.

Autorizzazioni del bucket dell'agente di servizio

Per qualsiasi operazione di esportazione o importazione che utilizza un bucket Cloud Storage in un altro progetto, devi concedere all'agente di servizio Firestore le autorizzazioni per quel bucket. Ad esempio, le operazioni che spostano i dati in un altro progetto devono accedere a un bucket in quel progetto. In caso contrario, queste operazioni non andranno a buon fine dopo la migrazione all'agente di servizio Firestore.

I flussi di lavoro di importazione ed esportazione che rimangono nello stesso progetto non richiedono modifiche alle autorizzazioni. Per impostazione predefinita, l'agente di servizio Firestore può accedere ai bucket nello stesso progetto.

Aggiorna le autorizzazioni per i bucket Cloud Storage di altri progetti per dare accesso all'agente di servizioservice-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com. Concedi all'agente di servizio il ruolo Firestore Service Agent.

Il ruolo Firestore Service Agent concede le autorizzazioni di lettura e scrittura per un bucket Cloud Storage. Se devi concedere solo autorizzazioni di lettura o di scrittura, utilizza un ruolo personalizzato.

La procedura di migrazione descritta nella sezione seguente ti aiuta a identificare i bucket Cloud Storage che potrebbero richiedere aggiornamenti delle autorizzazioni.

Esegui la migrazione di un progetto all'agente di servizio Firestore

Completa i seguenti passaggi per eseguire la migrazione dall'account di servizio App Engine all'agente di servizio Firestore. Una volta completata, la migrazione non può essere annullata.

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Se non è ancora stata eseguita la migrazione del progetto all'agente di servizio Firestore, viene visualizzato un banner che descrive la migrazione e un pulsante Controlla stato del bucket. Il passaggio successivo ti aiuta a identificare e risolvere potenziali errori di autorizzazione.

    Fai clic su Controlla lo stato del bucket.

    Viene visualizzato un menu con l'opzione per completare la migrazione e un elenco di bucket Cloud Storage. Potrebbero essere necessari alcuni minuti per completare il caricamento dell'elenco.

    Questo elenco include i bucket utilizzati di recente nelle operazioni di importazione ed esportazione, ma che al momento non forniscono autorizzazioni di lettura e scrittura all'agente di servizio della modalità Datastore.

  5. Prendi nota del nome principale dell'agente di servizio della modalità Datastore del tuo progetto. Il nome dell'agente di servizio viene visualizzato sotto l'etichetta Agente di servizio a cui concedere l'accesso.
  6. Per ogni bucket nell'elenco che utilizzerai per future operazioni di importazione o esportazione, completa i seguenti passaggi:

    1. Nella riga della tabella di questo bucket, fai clic su Correggi. Si apre la pagina delle autorizzazioni del bucket in una nuova scheda.

    2. Fai clic su Aggiungi.
    3. Nel campo Nuove entità, inserisci il nome dell'agente di servizio Firestore.
    4. Nel campo Seleziona un ruolo, seleziona Agenti di servizio > Agente di servizio Firestore.
    5. Fai clic su Salva.
    6. Torna alla scheda con la pagina Importazione/esportazione in modalità Datastore.
    7. Ripeti questi passaggi per gli altri bucket nell'elenco. Assicurati di visualizzare tutte le pagine dell'elenco.
  7. Fai clic su Esegui la migrazione all'agente di servizio Firestore. Se hai ancora bucket con controlli delle autorizzazioni non riusciti, devi confermare la migrazione facendo clic su Esegui migrazione.

    Un avviso ti informa al termine della migrazione. La migrazione non può essere annullata.

Visualizzare lo stato della migrazione

Per verificare lo stato della migrazione del progetto:

  1. Nella console Google Cloud, vai alla pagina Database.

    Vai a Database

  2. Seleziona il database richiesto dall'elenco dei database.
  3. Nel menu di navigazione, fai clic su Importazione/esportazione.

  4. Cerca il principale accanto all'etichetta I job di importazione/esportazione vengono eseguiti come.

    Se l'entità è service-PROJECT_NUMBER@gcp-sa-firestore.iam.gserviceaccount.com, significa che è già stata eseguita la migrazione del progetto all'agente di servizio Firestore. La migrazione non può essere annullata.

    Se non è stata eseguita la migrazione del progetto, nella parte superiore della pagina viene visualizzato un banner con il pulsante Verifica stato del bucket. Per completare la migrazione, consulta Eseguire la migrazione all'agente di servizio Firestore.

Aggiungere un vincolo dei criteri a livello di organizzazione

  • Imposta il seguente vincolo nei criteri della tua organizzazione:

    Richiedi l'agente di servizio Firestore per l'importazione/esportazione (firestore.requireP4SAforImportExport).

    Questo vincolo richiede che le operazioni di importazione ed esportazione utilizzino l'agente di servizio Firestore per autorizzare le richieste. Per impostare questo vincolo, consulta Creare e gestire i criteri dell'organizzazione .

L'applicazione di questo vincolo dei criteri dell'organizzazione non concede automaticamente le autorizzazioni del bucket Cloud Storage appropriate per l'agente di servizio Firestore.

Se la limitazione crea errori di autorizzazione per i flussi di lavoro di importazione o esportazione, puoi disattivarla per tornare a utilizzare l'account di servizio predefinito. Dopo aver controllato e aggiornato le autorizzazioni del bucket Cloud Storage, puoi riattivare il vincolo.