Il modello da testo a Firestore di Cloud Storage è una pipeline batch che importa in Firestore dai documenti JSON archiviati in Cloud Storage.
Requisiti della pipeline
Firestore deve essere abilitato nel progetto di destinazione.
Formato di input
Ogni file di input deve contenere JSON delimitato da nuova riga, in cui ogni riga contiene una rappresentazione JSON di un tipo di dati Datastore Entity
.
Ad esempio, il seguente JSON rappresenta un documento in una raccolta denominata Users
. L'esempio è formattato per la leggibilità, ma ogni documento deve apparire come singola riga di input.
{ "key": { "partitionId": { "projectId": "my-project" }, "path": [ { "kind": "users", "name": "alovelace" } ] }, "properties": { "first": { "stringValue": "Ada" }, "last": { "stringValue": "Lovelace" }, "born": { "integerValue": "1815", "excludeFromIndexes": true } } }
Per ulteriori informazioni sul modello di documento, consulta Entità, proprietà e chiavi.
Parametri del modello
Parametro | Descrizione |
---|---|
textReadPattern |
Un pattern di percorso di Cloud Storage che specifica la posizione dei file di dati di testo.
Ad esempio, gs://mybucket/somepath/*.json . |
javascriptTextTransformGcsPath |
(Facoltativo)
L'URI Cloud Storage del file .js che definisce la funzione JavaScript definita dall'utente che vuoi utilizzare. Ad esempio: gs://my-bucket/my-udfs/my_file.js .
|
javascriptTextTransformFunctionName |
(Facoltativo)
Il nome della funzione definita dall'utente di 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, consulta gli esempi di funzioni definite dall'utente.
|
firestoreWriteProjectId |
L'ID progetto Google Cloud di dove scrivere le entità Firestore |
firestoreHintNumWorkers |
(Facoltativo) Suggerimento per il numero previsto di worker nel passaggio di limitazione dell'accelerazione di Firestore. Il valore predefinito è 500 . |
errorWritePath |
Il file di output del log degli errori da utilizzare per gli errori di scrittura che si verificano durante l'elaborazione. Ad
esempio, gs://bucket-name/errors.txt . |
Funzione definita dall'utente
Facoltativamente, puoi estendere questo modello scrivendo una funzione definita dall'utente (UDF). 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 le seguenti specifiche:
- Input: una riga di testo di un file di input di Cloud Storage.
- Output: un
Entity
, serializzato come stringa JSON.
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 delle regioni in cui puoi eseguire un job Dataflow, vedi Località Dataflow.
- Nel menu a discesa Modello Dataflow, seleziona the Text Files on Cloud Storage to Firestore template.
- Nei campi dei parametri forniti, inserisci i valori dei parametri.
- 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/GCS_Text_to_Firestore \ --region REGION_NAME \ --parameters \ textReadPattern=PATH_TO_INPUT_TEXT_FILES,\ javascriptTextTransformGcsPath=PATH_TO_JAVASCRIPT_UDF_FILE,\ javascriptTextTransformFunctionName=JAVASCRIPT_FUNCTION,\ firestoreWriteProjectId=PROJECT_ID,\ errorWritePath=ERROR_FILE_WRITE_PATH
Sostituisci quanto segue:
JOB_NAME
: un nome job univoco a tua sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
REGION_NAME
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
PATH_TO_INPUT_TEXT_FILES
: il pattern dei file di input su Cloud StorageJAVASCRIPT_FUNCTION
: il nome della funzione definita dall'utente dall'utente JavaScript che vuoi utilizzareAd esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }
, il nome della funzione èmyTransform
. Per esempi di funzioni JavaScript definite, consulta gli esempi di funzioni definite dall'utente.PATH_TO_JAVASCRIPT_UDF_FILE
: l'URI Cloud Storage del file.js
che definisce la funzione JavaScript definita dall'utente che vuoi utilizzare, ad esempiogs://my-bucket/my-udfs/my_file.js
ERROR_FILE_WRITE_PATH
: il percorso desiderato per il file degli errori su Cloud Storage
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/GCS_Text_to_Firestore { "jobName": "JOB_NAME", "parameters": { "textReadPattern": "PATH_TO_INPUT_TEXT_FILES", "javascriptTextTransformGcsPath": "PATH_TO_JAVASCRIPT_UDF_FILE", "javascriptTextTransformFunctionName": "JAVASCRIPT_FUNCTION", "firestoreWriteProjectId": "PROJECT_ID", "errorWritePath": "ERROR_FILE_WRITE_PATH" }, "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 sceltaVERSION
: la versione del modello che vuoi utilizzarePuoi utilizzare i seguenti valori:
latest
per utilizzare la versione più recente del modello, disponibile nella cartella padre senza data del bucket: gs://dataflow-templates-REGION_NAME/latest/- il nome della versione, come
2023-09-12-00_RC00
, per utilizzare una versione specifica del modello, che si trova nidificata nella rispettiva cartella padre con data all'interno del bucket: gs://dataflow-templates-REGION_NAME/
LOCATION
: la regione in cui vuoi eseguire il deployment del job Dataflow, ad esempious-central1
PATH_TO_INPUT_TEXT_FILES
: il pattern dei file di input su Cloud StorageJAVASCRIPT_FUNCTION
: il nome della funzione definita dall'utente dall'utente JavaScript che vuoi utilizzareAd esempio, se il codice della funzione JavaScript è
myTransform(inJson) { /*...do stuff...*/ }
, il nome della funzione èmyTransform
. Per esempi di funzioni JavaScript definite, consulta gli esempi di funzioni definite dall'utente.PATH_TO_JAVASCRIPT_UDF_FILE
: l'URI Cloud Storage del file.js
che definisce la funzione JavaScript definita dall'utente che vuoi utilizzare, ad esempiogs://my-bucket/my-udfs/my_file.js
ERROR_FILE_WRITE_PATH
: il percorso desiderato per il file degli errori su Cloud Storage
Passaggi successivi
- Scopri di più sui modelli Dataflow.
- Consulta l'elenco dei modelli forniti da Google.