Trigger di Firestore (2ª generazione)
Puoi configurare le tue funzioni Cloud Functions in modo che vengano attivate da eventi in una 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 quanto segue:
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
write
oupdate
eventi, l'oggetto dati contiene snapshot che rappresentano prima e dopo l'evento di attivazione.
Tipi di evento
Firestore supporta gli eventi create
, update
, delete
e write
. La
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 sono 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 documento il percorso 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 sono utilizzata per monitorare tutti i documenti nella raccolta.users/{username}/addresses
: attivatore non valido. Fa riferimento alla sottoraccoltaaddresses
, non un documento.users/{username}/addresses/home
: attivatore valido. Monitora l'indirizzo di casa per tutti gli utenti.users/{username}/addresses/{addressId}
: attivatore valido. Monitora tutti gli indirizzi documenti.users/{user=**}
: attivatore valido. Monitora tutti i documenti utente e qualsiasi documenti in sottoraccolte sotto ogni documento utente, come/users/userID/address/home
o/users/userID/phone/work
.
Caratteri jolly e parametri
Se non conosci il documento specifico che vuoi monitorare, usa 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
,
corrisponde a un carattere jolly denominato {username}
.
Se un documento in users
ha
sottoraccolte e una
in una delle sottoraccolte documenti vengono modificati, {username}
il carattere jolly non viene attivato. Se il tuo obiettivo è rispondere agli eventi in
Inoltre, utilizza il carattere jolly multisegmento {username=**}
.
Le corrispondenze con caratteri jolly vengono estratte dai percorsi dei documenti. Puoi definire quante più opzioni
caratteri jolly che preferisci per sostituire ID raccolta o documenti espliciti. Puoi
utilizza 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 le
Documentazione di Value
per i riferimenti al tipo. Ciò è particolarmente utile se utilizzi una lingua digitata
(come Go) per scrivere le tue funzioni.
Configura il tuo database Firestore
È necessario un database Firestore per testare gli esempi in questo documento. it che sia disponibile 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. Questo la scelta è definitiva.
Fai clic su Crea database.
Il modello dei dati Firestore è costituito 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 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 trigger Evento Firestore:
Node.js
Utilizzare protobufjs per decodificare l'evento
e i dati di Google Cloud. Includi google.events.cloud.firestore.v1
data.proto
nel codice sorgente.
Python
Vai
Java
C#
Esegui il deployment della funzione Hello Firestore
Se non l'hai ancora fatto, configura Database Firestore.
Per eseguire il deployment della funzione Hello Firestore con un file Firestore esegui questo comando nella directory che contiene l'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 posizione dell'attivatore, che deve essere la stessa regione del database Firestore.ENTRY_POINT
: il punto di accesso alla funzione in 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 alla creazione di un documento, aggiornate o eliminate, in base Tipo di eventogoogle.cloud.firestore.document.v1.written
.--trigger-event-filters=database='(default)'
specifica l'account di servizio per configurare un database. Per il nome predefinito del database, utilizza(default)
.--trigger-event-filters-path-pattern=document='users/{username}'
fornisce il parametro del percorso dei documenti che devono essere monitorati per verificare le modifiche pertinenti. Questo pattern di percorso indica che tutti i documenti nella raccoltausers
devono monitorare. Per ulteriori informazioni, vedi Comprendi i pattern dei percorsi.
Testa la funzione Hello Firestore
Per testare la funzione Hello Firestore, configura una raccolta chiamata
users
nel tuo database Firestore:
Nella pagina dei dati di Firestore, fai clic su Crea una raccolta.
Specifica
users
come ID raccolta.Per iniziare ad aggiungere il primo documento della raccolta, in Aggiungi il primo documento e 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 confermare che la funzione è stata attivata, fai clic sul nome collegato del nella console Google Cloud Pagina Panoramica di Cloud Functions 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 e converte la stringa in la posizione in lettere maiuscole e sostituisce il valore con la stringa in maiuscolo:
Node.js
Utilizzare protobufjs per decodificare l'evento
e i dati di Google Cloud. Includi google.events.cloud.firestore.v1
data.proto
nel codice sorgente.
Python
Vai
Java
C#
Esegui il deployment della funzione Convert to Uppercase
Se non l'hai ancora fatto, configura Database Firestore.
Utilizza questo comando per eseguire il deployment di una funzione che viene attivata scrivi eventi sul 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 posizione dell'attivatore, che deve essere la stessa regione del database Firestore.ENTRY_POINT
: il punto di accesso alla funzione in 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 alla creazione di un documento, aggiornate o eliminate, in base algoogle.cloud.firestore.document.v1.written
tipo di evento.--trigger-event-filters=database='(default)'
specifica un 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 modifiche. Questo pattern di percorso indica che tutti i documenti inmessages
raccolta dei dati. Per ulteriori informazioni, vedi Comprendi 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 chiamata 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 e accetta l'ID documento generato automaticamente.
Per attivare la funzione di cui hai 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 valore viene convertito in lettere maiuscole.
Se in seguito modifichi il valore del campo in modo che contenga lettere minuscole, attiva di nuovo la funzione, convertendo tutte le lettere minuscole in in maiuscolo.
Limitazioni
- 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ò comportare più chiamate di funzione. Da evitare in base a la meccanica "exactly-once" e scrivere funzioni idempotenti.
- 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. La interrompe la pubblicazione degli eventi, ma continua a esistere finché non elimini l'attivatore.