Namespace: Firestore

Schnittstellen

Eigenschaften

Anfrage

statisch

Nicht-Null- rules.firestore.Request

Der Anforderungskontext, einschließlich Authentifizierungsinformationen und ausstehenden Daten.

Ressource

statisch

Nicht-Null- rules.firestore.Resource

Die Ressource, die gelesen oder geschrieben wird.

Methoden

existiert

statisch

exist(path) gibt Rules.Boolean zurück

Prüfen Sie, ob ein Dokument vorhanden ist.

Parameter

Weg

Regeln.Pfad

Der Weg.

Der Wert darf nicht null sein.

Kehrt zurück

non-null rules.Boolean true, wenn die Ressource vorhanden ist.

Beispiel

// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)

existiert nach

statisch

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

Regeln.Pfad

Der Weg.

Der Wert darf nicht null sein.

Kehrt zurück

non-null rules.Boolean true, wenn die Ressource vorhanden ist.

erhalten

statisch

get(path) gibt Rules.firestore.Resource zurück

Rufen Sie den Inhalt eines Firestore-Dokuments ab.

Parameter

Weg

Regeln.Pfad

Der Weg.

Der Wert darf nicht null sein.

Kehrt zurück

non-null rules.firestore.Resource des Dokuments oder null, wenn es nicht existiert.

Beispiel

// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)

getAfter

statisch

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

Regeln.Pfad

Der Weg.

Der Wert darf nicht null sein.

Kehrt zurück

non-null rules.firestore.Resource des Dokuments oder null, wenn es nicht existiert.