Il modello di eliminazione in blocco di Firestore è una pipeline che legge in Entità da Firestore con una determinata query GQL, quindi elimina tutte le entità corrispondenti nel progetto di destinazione selezionato. La pipeline può passare facoltativamente le entità Firestore codificate con JSON alla funzione JavaScript definita dall'utente, che puoi utilizzare per filtrare le entità restituendo valori nulli.
Requisiti della pipeline
- Firestore deve essere configurato nel progetto prima di eseguire il modello.
- In caso di lettura ed eliminazione da istanze Firestore separate, l'account di servizio worker di Dataflow deve disporre dell'autorizzazione per leggere da un'istanza ed eliminarla dall'altra.
- Le scritture di database devono essere abilitate sull'istanza Firestore.
Parametri del modello
Parametro | Descrizione |
---|---|
firestoreReadGqlQuery |
Query GQL che specifica le entità da associare per l'eliminazione. L'utilizzo di una query basata solo su chiavi può migliorare le prestazioni. Ad esempio: "SELECT __key__ FROM MyKind". |
firestoreReadProjectId |
ID progetto dell'istanza Firestore da cui vuoi leggere le entità (utilizzando la query GQL) utilizzate per la corrispondenza. |
firestoreDeleteProjectId |
ID progetto dell'istanza Firestore da cui eliminare le entità corrispondenti. Può essere uguale a firestoreReadProjectId se vuoi leggere ed eliminare all'interno della stessa istanza Firestore. |
firestoreReadNamespace |
(Facoltativo) Spazio dei nomi delle entità richieste. Imposta come "" per lo spazio dei nomi predefinito. |
firestoreHintNumWorkers |
(Facoltativo) Suggerimento per il numero previsto di worker nel passaggio di limitazione dell'applicazione graduale di Firestore. Il valore predefinito è 500 . |
javascriptTextTransformGcsPath |
(Facoltativo)
L'URI Cloud Storage del file .js che definisce la funzione JavaScript definita dall'utente (UDF) che vuoi utilizzare. Ad esempio: gs://my-bucket/my-udfs/my_file.js .
|
javascriptTextTransformFunctionName |
(Facoltativo)
Il nome della funzione definita dall'utente (UDF) JavaScript che vuoi utilizzare.
Ad esempio, se il codice della funzione JavaScript è myTransform(inJson) { /*...do stuff...*/ } , il nome della funzione è myTransform . Per esempi di funzioni JavaScript definite dall'utente, consulta gli esempi di funzioni definite dall'utente.
Se questa funzione restituisce un valore non definito o nullo per una determinata entità Firestore, l'entità non viene eliminata. |
Funzione definita dall'utente
Facoltativamente, puoi estendere questo modello scrivendo una funzione definita dall'utente dall'utente. Il modello chiama la funzione definita dall'utente per ogni elemento di input. I payload degli elementi sono serializzati come stringhe JSON. Per ulteriori informazioni, consulta Creare funzioni definite dall'utente per i modelli Dataflow.
Specifica della funzione
La funzione definita dall'utente ha la seguente specifica:
- Input: un'entità Firestore, serializzata come stringa JSON.
- Output: se vuoi mantenere l'entità senza eliminarla,
restituisce
null
oundefined
. In caso contrario, restituisci l'entità originale per l'eliminazione.
Esegui il modello
Console
- Vai alla pagina Crea job da modello di Dataflow. Vai a Crea job da modello
- Nel campo Nome job, inserisci un nome univoco per il job.
- (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è
us-central1
.Per un elenco di regioni in cui è possibile eseguire un job Dataflow, consulta Località di Dataflow.
- Dal menu a discesa Modello Dataflow, seleziona the Bulk Delete Entities in Firestore template.
- Inserisci i valori parametro negli appositi campi.
- Fai clic su Esegui job.
gcloud
Nella shell o nel terminale, esegui il modello:
gcloud dataflow jobs run JOB_NAME \ --gcs-location gs://dataflow-templates-REGION_NAME/VERSION/Firestore_to_Firestore_Delete \ --region REGION_NAME \ --parameters \ firestoreReadGqlQuery="GQL_QUERY",\ firestoreReadProjectId=FIRESTORE_READ_AND_DELETE_PROJECT_ID,\ firestoreDeleteProjectId=FIRESTORE_READ_AND_DELETE_PROJECT_ID
Sostituisci quanto segue:
JOB_NAME
: un nome job univoco a tua sceltaREGION_NAME
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
VERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre non con data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che è possibile trovare nidificata nella rispettiva cartella principale con data nel bucket: gs://dataflow-templates-REGION_NAME/
GQL_QUERY
: la query che utilizzerai per associare le entità da eliminareFIRESTORE_READ_AND_DELETE_PROJECT_ID
: ID progetto della tua istanza Firestore. Questo esempio esegue sia la lettura sia l'eliminazione dalla stessa istanza Firestore.
API
Per eseguire il modello utilizzando l'API REST, invia una richiesta POST HTTP. Per maggiori informazioni
sull'API e sui relativi ambiti di autorizzazione, consulta
projects.templates.launch
.
POST https://dataflow.googleapis.com/v1b3/projects/PROJECT_ID/locations/LOCATION/templates:launch?gcsPath=gs://dataflow-templates-LOCATION/VERSION/Firestore_to_Firestore_Delete { "jobName": "JOB_NAME", "parameters": { "firestoreReadGqlQuery": "GQL_QUERY", "firestoreReadProjectId": "FIRESTORE_READ_AND_DELETE_PROJECT_ID", "firestoreDeleteProjectId": "FIRESTORE_READ_AND_DELETE_PROJECT_ID" }, "environment": { "zone": "us-central1-f" } }
Sostituisci quanto segue:
PROJECT_ID
: l'ID del progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME
: un nome job univoco a tua sceltaLOCATION
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
VERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre non con data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che è possibile trovare nidificata nella rispettiva cartella principale con data nel bucket: gs://dataflow-templates-REGION_NAME/
GQL_QUERY
: la query che utilizzerai per associare le entità da eliminareFIRESTORE_READ_AND_DELETE_PROJECT_ID
: ID progetto della tua istanza Firestore. Questo esempio esegue sia la lettura sia l'eliminazione dalla stessa istanza Firestore.
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.