Il template da Firestore a testo di Cloud Storage è una pipeline batch che legge le entità Firestore e le scrive in Cloud Storage come file di testo. Puoi fornire una funzione per elaborare ogni entità come stringa JSON. Se non fornisci una funzione di questo tipo, ogni riga del file di output sarà un'entità serializzata in JSON.
Requisiti della pipeline
Firestore deve essere configurato nel progetto prima di eseguire la pipeline.
Parametri del modello
Parametri obbligatori
- firestoreReadGqlQuery: una query GQL (https://cloud.google.com/datastore/docs/reference/gql_reference) che specifica le entità da recuperare. Ad esempio:
SELECT * FROM MyKind. - firestoreReadProjectId: l'ID del progetto Google Cloud che contiene l'istanza Firestore da cui vuoi leggere i dati.
- textWritePrefix: il prefisso del percorso di Cloud Storage che specifica dove vengono scritti i dati. Ad esempio,
gs://mybucket/somefolder/.
Parametri facoltativi
- firestoreReadNamespace: lo spazio dei nomi delle entità richieste. Per utilizzare lo spazio dei nomi predefinito, lascia vuoto questo parametro.
- javascriptTextTransformGcsPath: l'URI Cloud Storage del file .js che definisce la funzione definita dall'utente (UDF) JavaScript da utilizzare. Ad esempio,
gs://my-bucket/my-udfs/my_file.js. - javascriptTextTransformFunctionName: il nome della funzione definita dall'utente (UDF) JavaScript da utilizzare. Ad esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }, il nome della funzione èmyTransform. Per esempi di UDF JavaScript, consulta Esempi di UDF (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).
Funzione definita dall'utente
Se vuoi, puoi estendere questo modello scrivendo una funzione definita dall'utente (UDF). Il template chiama la funzione definita dall'utente per ogni elemento di input. I payload degli elementi vengono serializzati come stringhe JSON. Per saperne di più, consulta Crea funzioni definite dall'utente per i template Dataflow.
Specifica della funzione
La funzione definita dall'utente ha la seguente specifica:
- Input: un'entità Firestore, serializzata come stringa JSON.
- Output: il valore della stringa da scrivere in Cloud Storage.
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 job univoco.
- (Facoltativo) Per Endpoint a livello di regione, seleziona un valore dal menu a discesa. La regione predefinita è
us-central1.Per un elenco delle regioni in cui puoi eseguire un job Dataflow, consulta Località di Dataflow.
- Dal menu a discesa Modello Dataflow, seleziona il modello Da Firestore a file di testo su Cloud Storage.
- Nei campi dei parametri forniti, inserisci i valori dei parametri.
- Fai clic su Esegui job.
gcloud
Nella shell o nel terminale, esegui il template:
gcloud dataflow jobs run JOB_NAME \ --gcs-location gs://dataflow-templates/VERSION/Firestore_to_GCS_Text \ --region REGION_NAME \ --parameters \ firestoreReadGqlQuery="SELECT * FROM FIRESTORE_KIND",\ firestoreReadProjectId=FIRESTORE_PROJECT_ID,\ firestoreReadNamespace=FIRESTORE_NAMESPACE,\ javascriptTextTransformGcsPath=PATH_TO_JAVASCRIPT_UDF_FILE,\ javascriptTextTransformFunctionName=JAVASCRIPT_FUNCTION,\ textWritePrefix=gs://BUCKET_NAME/output/
Sostituisci quanto segue:
JOB_NAME: un nome job univoco di tua sceltaREGION_NAME: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1VERSION: la versione del template che vuoi utilizzarePuoi utilizzare i seguenti valori:
latestper utilizzare l'ultima versione del template, disponibile nella cartella padre senza data nel bucket: gs://dataflow-templates/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00, per utilizzare una versione specifica del template, che si trova nidificata nella rispettiva cartella padre con data nel bucket: gs://dataflow-templates/
BUCKET_NAME: il nome del bucket Cloud StorageFIRESTORE_PROJECT_ID: l'ID progetto Google Cloud in cui esiste l'istanza FirestoreFIRESTORE_KIND: il tipo di entità FirestoreFIRESTORE_NAMESPACE: lo spazio dei nomi delle entità FirestoreJAVASCRIPT_FUNCTION: il nome della funzione definita dall'utente (UDF) JavaScript che vuoi utilizzareAd esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }, il nome della funzione èmyTransform. Per esempi di UDF JavaScript, consulta Esempi di UDF.PATH_TO_JAVASCRIPT_UDF_FILE: l'URI Cloud Storage del file.jsche definisce la funzione definita dall'utente (UDF) JavaScript che vuoi utilizzare, ad esempiogs://my-bucket/my-udfs/my_file.js
API
Per eseguire il template utilizzando l'API REST, invia una richiesta POST HTTP. Per saperne di più 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/VERSION/Firestore_to_GCS_Text { "jobName": "JOB_NAME", "parameters": { "firestoreReadGqlQuery": "SELECT * FROM FIRESTORE_KIND" "firestoreReadProjectId": "FIRESTORE_PROJECT_ID", "firestoreReadNamespace": "FIRESTORE_NAMESPACE", "javascriptTextTransformGcsPath": "PATH_TO_JAVASCRIPT_UDF_FILE", "javascriptTextTransformFunctionName": "JAVASCRIPT_FUNCTION", "textWritePrefix": "gs://BUCKET_NAME/output/" }, "environment": { "zone": "us-central1-f" } }
Sostituisci quanto segue:
PROJECT_ID: l'ID progetto Google Cloud in cui vuoi eseguire il job DataflowJOB_NAME: un nome job univoco di tua sceltaLOCATION: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1VERSION: la versione del template che vuoi utilizzarePuoi utilizzare i seguenti valori:
latestper utilizzare l'ultima versione del template, disponibile nella cartella padre senza data nel bucket: gs://dataflow-templates/latest/- il nome della versione, ad esempio
2023-09-12-00_RC00, per utilizzare una versione specifica del template, che si trova nidificata nella rispettiva cartella padre con data nel bucket: gs://dataflow-templates/
BUCKET_NAME: il nome del bucket Cloud StorageFIRESTORE_PROJECT_ID: l'ID progetto Google Cloud in cui esiste l'istanza FirestoreFIRESTORE_KIND: il tipo di entità FirestoreFIRESTORE_NAMESPACE: lo spazio dei nomi delle entità FirestoreJAVASCRIPT_FUNCTION: il nome della funzione definita dall'utente (UDF) JavaScript che vuoi utilizzareAd esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }, il nome della funzione èmyTransform. Per esempi di UDF JavaScript, consulta Esempi di UDF.PATH_TO_JAVASCRIPT_UDF_FILE: l'URI Cloud Storage del file.jsche definisce la funzione definita dall'utente (UDF) JavaScript che vuoi utilizzare, ad esempiogs://my-bucket/my-udfs/my_file.js
Passaggi successivi
- Scopri di più sui template Dataflow.
- Consulta l'elenco dei modelli forniti da Google.