Trigger di Firestore (2ª generazione)
Puoi configurare le funzioni Cloud Functions in modo che vengano attivate da eventi in un database Firestore. Una volta attivata, la funzione può leggere e aggiornare un database Firestore in risposta a questi eventi tramite le API e le librerie client di Firestore.
In un ciclo di vita tipico, una funzione Firestore esegue queste operazioni:
Attende le modifiche a un determinato documento.
Si attiva quando si verifica un evento ed esegue le sue attività.
Riceve un oggetto dati con uno snapshot del documento interessato. Per gli eventi
write
oupdate
, l'oggetto dati contiene snapshot che rappresentano lo stato del documento prima e dopo l'evento di attivazione.
Tipi di evento
Firestore supporta gli eventi create
, update
, delete
e write
. L'evento
write
include tutte le modifiche a un documento.
Tipo di evento | Trigger |
---|---|
google.cloud.firestore.document.v1.created (valore predefinito) |
Si attiva quando un documento viene scritto per la prima volta. |
google.cloud.firestore.document.v1.updated |
Si attiva quando un documento esiste già e presenta un valore modificato. |
google.cloud.firestore.document.v1.deleted |
Si attiva quando un documento con dati viene eliminato. |
google.cloud.firestore.document.v1.written |
Si attiva quando un documento viene creato, aggiornato o eliminato. |
I caratteri jolly vengono scritti nei trigger utilizzando parentesi graffe, come segue:
"projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}"
Specifica il percorso del documento
Per attivare la funzione, specifica un percorso del documento da ascoltare. Il percorso del documento deve trovarsi nello stesso progetto Google Cloud della funzione.
Ecco alcuni esempi di percorsi di documenti validi:
users/marie
: attivatore valido. Monitora un singolo documento,/users/marie
.users/{username}
: attivatore valido. Monitora tutti i documenti dell'utente. I caratteri jolly vengono utilizzati per monitorare tutti i documenti della raccolta.users/{username}/addresses
: attivatore non valido. Fa riferimento alla raccolta secondariaaddresses
, non a un documento.users/{username}/addresses/home
: attivatore valido. Monitora il documento relativo all'indirizzo di casa per tutti gli utenti.users/{username}/addresses/{addressId}
: attivatore valido. Monitora tutti i documenti degli indirizzi.users/{user=**}
: attivatore valido. Monitora tutti i documenti dell'utente e tutti i documenti nelle sottoraccolte sotto ogni documento dell'utente, ad esempio/users/userID/address/home
o/users/userID/phone/work
.
Caratteri jolly e parametri
Se non conosci il documento specifico da monitorare, utilizza un {wildcard}
anziché l'ID documento:
users/{username}
rimane in ascolto delle modifiche a tutti i documenti dell'utente.
In questo esempio, quando viene modificato un campo in qualsiasi documento in users
, viene corrispondente un carattere jolly chiamato {username}
.
Se un documento in users
ha raccolte secondarie e viene modificato un campo in una di queste raccolte secondarie, il carattere jolly {username}
non viene attivato. Se il tuo obiettivo è rispondere anche agli eventi nelle
raccolte secondarie, utilizza il carattere jolly multisegmento {username=**}
.
Le corrispondenze con caratteri jolly vengono estratte dai percorsi dei documenti. Puoi definire tutti i caratteri jolly che vuoi sostituire con ID raccolta o documento espliciti. Puoi
utilizzare fino a un carattere jolly multisegmento come {username=**}
.
Strutture per eventi
Questo trigger richiama la tua funzione con un evento simile a questo:
{ "oldValue": { // Update and Delete operations only A Document object containing a pre-operation document snapshot }, "updateMask": { // Update operations only A DocumentMask object that lists changed fields. }, "value": { // A Document object containing a post-operation document snapshot } }
Ogni oggetto Document
contiene uno o più oggetti Value
. Consulta la
documentazione di Value
per i riferimenti al tipo. Ciò è particolarmente utile se utilizzi un linguaggio
digitato (come Go) per scrivere le funzioni.
Configura il tuo database Firestore
È necessario un database Firestore per testare gli esempi in questo documento. Deve essere attiva prima di eseguire il deployment delle funzioni. Se non disponi già di un database Firestore, creane uno come segue:
Vai alla pagina Dati di Firestore.
Fai clic su Seleziona modalità nativa.
Scegli la regione (località) in cui si trova il database. Questa scelta è definitiva.
Fai clic su Crea database.
Il modello dei dati Firestore è composto da raccolte che contengono documenti. Un documento contiene una serie di coppie chiave/valore.
Le funzioni create in questo tutorial vengono attivate quando apporti modifiche a un documento all'interno di una raccolta specificata.
Esempio 1: funzione Hello Firestore
La seguente funzione Cloud Function di esempio stampa i campi di un evento Firestore di attivazione:
Node.js
Utilizza protobufjs per decodificare i dati sugli eventi. Includi google.events.cloud.firestore.v1
data.proto
nel codice sorgente.
Python
Go
Java
C#
Esegui il deployment della funzione Hello Firestore
Se non lo hai già fatto, configura il tuo database Firestore.
Per eseguire il deployment della funzione Hello Firestore con un trigger Firestore, esegui questo comando nella directory che contiene il codice di esempio (o, nel caso di Java, il file
pom.xml
):gcloud functions deploy FUNCTION_NAME \ --gen2 \ --runtime=RUNTIME \ --region=REGION \ --trigger-location=TRIGGER REGION \ --source=. \ --entry-point=ENTRY_POINT \ --trigger-event-filters=type=google.cloud.firestore.document.v1.written \ --trigger-event-filters=database='(default)' \ --trigger-event-filters-path-pattern=document='users/{username}'
Sostituisci quanto segue:
FUNCTION_NAME
: un nome per la funzione di cui hai eseguito il deployment.RUNTIME
: il runtime del linguaggio utilizzato dalla tua funzione.REGION
: la regione in cui eseguire il deployment della funzione.TRIGGER_REGION
: la località del trigger, che deve essere uguale alla regione del database Firestore.ENTRY_POINT
: il punto di accesso alla funzione nel codice sorgente. Questo è il codice che viene eseguito quando viene eseguita la funzione.
Utilizza gli altri campi così come sono:
--trigger-event-filters=type=google.cloud.firestore.document.v1.written
specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di eventogoogle.cloud.firestore.document.v1.written
.--trigger-event-filters=database='(default)'
specifica il database Firebase. Per il nome predefinito del database, utilizza(default)
.--trigger-event-filters-path-pattern=document='users/{username}'
fornisce il pattern dei percorsi dei documenti che devono essere monitorati per verificare le modifiche pertinenti. Questo pattern di percorso indica che tutti i documenti nella raccoltausers
devono essere monitorati. Per saperne di più, consulta Comprendere i pattern dei percorsi.
Testa la funzione Hello Firestore
Per testare la funzione Hello Firestore, configura una raccolta denominata users
nel tuo database Firestore:
Nella pagina dei dati di Firestore, fai clic su Avvia una raccolta.
Specifica
users
come ID raccolta.Per iniziare ad aggiungere il primo documento della raccolta, in Aggiungi il primo documento accetta l'ID documento generato automaticamente.
Aggiungi almeno un campo per il documento, specificando un nome e un valore. In questo esempio il nome è "username" e il valore è "rowan:"
Quando hai terminato, fai clic su Salva.
Questa azione crea un nuovo documento e attiva quindi la tua funzione.
Per verificare che la funzione sia stata attivata, fai clic sul nome collegato della funzione nella pagina Panoramica di Cloud Functions della console Google Cloud per aprire la pagina Dettagli funzione.
Apri la scheda Log e cerca questa stringa:
Function triggered by change to: //firestore.googleapis.com/projects/your-project-id/databases/(default)'
Esempio 2: funzione Converti in lettere maiuscole
Questo esempio recupera il valore aggiunto dall'utente, converte la stringa in quella posizione in lettere maiuscole e sostituisce il valore con la stringa in maiuscolo:
Node.js
Utilizza protobufjs per decodificare i dati sugli eventi. Includi google.events.cloud.firestore.v1
data.proto
nel codice sorgente.
Python
Go
Java
C#
Esegui il deployment della funzione Convert to Uppercase
Se non lo hai già fatto, configura il tuo database Firestore.
Utilizza questo comando per eseguire il deployment di una funzione che viene attivata dalla scrittura di eventi nel documento
companies/{CompanyId}
:gcloud functions deploy FUNCTION_NAME \ --gen2 \ --runtime=RUNTIME \ --trigger-location=TRIGGER REGION \ --region=REGION \ --source=. \ --entry-point=ENTRY_POINT \ --trigger-event-filters=type=google.cloud.firestore.document.v1.written \ --trigger-event-filters=database='(default)' \ --trigger-event-filters-path-pattern=document='messages/{pushId}'
Sostituisci quanto segue:
FUNCTION_NAME
: un nome per la funzione di cui hai eseguito il deployment.RUNTIME
: il runtime del linguaggio utilizzato dalla tua funzione.REGION
: la regione in cui eseguire il deployment della funzione.TRIGGER_REGION
: la località del trigger, che deve essere uguale alla regione del database Firestore.ENTRY_POINT
: il punto di accesso alla funzione nel codice sorgente. Questo è il codice che viene eseguito quando viene eseguita la funzione.
Utilizza gli altri campi così come sono:
--trigger-event-filters=type=google.cloud.firestore.document.v1.written
specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di eventogoogle.cloud.firestore.document.v1.written
.--trigger-event-filters=database='(default)'
specifica il database Firestore. Per il nome predefinito del database, utilizza(default)
.--trigger-event-filters-path-pattern=document='messages/{pushId}'
fornisce il pattern del percorso dei documenti che devono essere monitorati per verificare le modifiche pertinenti. Questo pattern di percorso indica che tutti i documenti nella raccoltamessages
devono essere monitorati. Per saperne di più, consulta Comprendere i pattern dei percorsi.
Testa la funzione Converti in lettere maiuscole
Per testare la funzione Converti in maiuscole di cui hai appena eseguito il deployment, configura una raccolta denominata messages
nel tuo database Firestore:
Vai alla pagina dei dati di Firestore.
Fai clic su Crea una raccolta.
Specifica
messages
come ID raccolta.Per iniziare ad aggiungere il primo documento della raccolta, in Aggiungi il primo documento accetta l'ID documento generato automaticamente.
Per attivare la funzione di cui è stato eseguito il deployment, aggiungi un documento in cui il nome del campo è "originale" e il valore del campo è una parola minuscola, ad esempio:
Quando salvi il documento, puoi vedere la parola minuscola nel campo del valore convertita in maiuscolo.
Se in seguito modifichi il valore del campo in modo che contenga lettere minuscole, la funzione viene nuovamente attivata, convertendo tutte le lettere minuscole in lettere maiuscole.
Limitazioni
Tieni presente le seguenti limitazioni per i trigger Firestore per Cloud Functions:
- Cloud Functions (1ª generazione.) prepara un database "(predefinito)" esistente in modalità nativa Firestore. Non supporta i database denominati Firestore o la modalità Datastore. In questi casi, usa Cloud Functions (2ª generazione.) per configurare gli eventi.
- L'ordine non è garantito. Modifiche rapide possono attivare chiamate di funzione in un ordine inaspettato.
- Gli eventi vengono pubblicati almeno una volta, ma un singolo evento può generare più chiamate di funzione. Evita di dipendere dalla meccanica "exactly-once" e scrivi funzioni idempotenti.
- Firestore in modalità Datastore richiede Cloud Functions (2nd gen). Cloud Functions (1ª generazione.) non supporta la modalità Datastore.
- Un trigger è associato a un singolo database. Non puoi creare un trigger che corrisponde a più database.
- L'eliminazione di un database non elimina automaticamente alcun trigger per quel database. L'attivatore interrompe la pubblicazione degli eventi, ma continua a esistere finché non elimini l'attivatore.
- Se un evento corrispondente supera le dimensioni massime della richiesta, l'evento potrebbe non essere pubblicato in Cloud Functions (1ª generazione.).
- Gli eventi non consegnati a causa delle dimensioni della richiesta vengono registrati nei log della piattaforma e conteggiati ai fini dell'utilizzo dei log per il progetto.
- Puoi trovare questi log in Esplora log con il messaggio "Impossibile consegnare l'evento alla funzione Cloud Functions a causa del superamento del limite per la 1ª generazione..." con gravità
error
. Puoi trovare il nome della funzione sotto il campofunctionName
. Se il camporeceiveTimestamp
è ancora a un'ora da questo momento, puoi dedurre i contenuti effettivi dell'evento leggendo il documento in questione con uno snapshot prima e dopo il timestamp. - Per evitare questa frequenza, puoi:
- Esegui la migrazione e l'upgrade a Cloud Functions (2nd gen)
- Ridimensiona il documento
- Elimina le funzioni Cloud Functions in questione
- Puoi disattivare il logging utilizzando le esclusioni, ma tieni presente che gli eventi offensivi non verranno comunque recapitati.