Regeln . Feuerladen
Kontextspezifische Variablen und Methoden für Cloud Firestore-Sicherheitsregeln.
Funktionen in diesem Namespace sind nur innerhalb service cloud.firestore { ... } -Blöcken verfügbar und müssen bei Verwendung nicht mit einem Präfix versehen werden ( get() nicht firestore.get() ).
Schnittstellen
Anfrage
Der eingehende Anforderungskontext für einen Firestore-Vorgang.
Ressource
Das Firestore-Dokument, das gelesen oder geschrieben wird.
Eigenschaften
Anfrage
Nicht-Null- rules.firestore.Request
Der Anforderungskontext, einschließlich Authentifizierungsinformationen und ausstehenden Daten.
Ressource
Nicht-Null- rules.firestore.Resource
Die Ressource, die gelesen oder geschrieben wird.
Methoden
existiert
exist(path) gibt Rules.Boolean zurück
Prüfen Sie, ob ein Dokument vorhanden ist.
Parameter | |
|---|---|
Weg | Der Weg. Der Wert darf nicht null sein. |
- Kehrt zurück
non-null rules.Booleantrue, wenn die Ressource vorhanden ist.
Beispiel
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)existiert nach
existAfter(path) gibt Rules.Boolean zurück
Überprüfen Sie, ob ein Dokument vorhanden ist, vorausgesetzt, die aktuelle Anfrage ist erfolgreich. Entspricht getAfter(path) != null.
Parameter | |
|---|---|
Weg | Der Weg. Der Wert darf nicht null sein. |
- Kehrt zurück
non-null rules.Booleantrue, wenn die Ressource vorhanden ist.
erhalten
get(path) gibt Rules.firestore.Resource zurück
Rufen Sie den Inhalt eines Firestore-Dokuments ab.
Parameter | |
|---|---|
Weg | Der Weg. Der Wert darf nicht null sein. |
- Kehrt zurück
non-null rules.firestore.Resourcedes Dokuments oder null, wenn es nicht existiert.
Beispiel
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)getAfter
getAfter(path) gibt Rules.firestore.Resource zurück
Rufen Sie den projizierten Inhalt eines Dokuments ab. Das Dokument wird zurückgegeben, als ob die aktuelle Anfrage erfolgreich gewesen wäre. Nützlich für die Validierung von Dokumenten, die Teil eines Batch-Schreibvorgangs oder einer Transaktion sind.
Parameter | |
|---|---|
Weg | Der Weg. Der Wert darf nicht null sein. |
- Kehrt zurück
non-null rules.firestore.Resourcedes Dokuments oder null, wenn es nicht existiert.