命名空間：Firestore

規則。firestore

命名空間   static

Cloud Firestore 的情境專屬變數和方法 安全性規則。

這個命名空間中的函式只能在內部使用 service cloud.firestore { ... } 個區塊和 使用時不必前置字元 (get()) 而非 firestore.get())。

介面

要求

Firestore 作業的傳入要求內容。

資源

正在讀取或寫入的 Firestore 文件。

屬性

要求

靜態圖像

非空值 rules.firestore.Request

要求情境，包括驗證資訊 和待處理資料

資源

靜態圖像

非空值 rules.firestore.Resource

正在讀取或寫入的資源。

方法

存在

靜態圖像

native(path) 會傳回 rules.Boolean

檢查文件是否存在。

參數
路徑	rules.Path 路徑。 值不得為空值。

傳回

non-null rules.Boolean：如果資源存在，則為 true。

範例

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

已存在後

靜態圖像

nativeAfter(path) 會傳回 rules.Boolean

檢查文件是否存在 (假設目前的要求成功)。對等 to getAfter(path) != null。

參數
路徑	rules.Path 路徑。 值不得為空值。

傳回

non-null rules.Boolean：如果資源存在，則為 true。

get

靜態圖像

get(path) 會傳回 rules.firestore.Resource

取得 Firestore 文件的內容。

參數
路徑	rules.Path 路徑。 值不得為空值。

傳回

non-null rules.firestore.Resource 文件；如果沒有文件，則為空值 個值。

範例

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

getAfter 的

靜態圖像

getAfter(path) 會傳回 rules.firestore.Resource

取得文件的投影內容。文件會以 。適合用來驗證文件 作為批次寫入或交易的一部分

參數
路徑	rules.Path 路徑。 值不得為空值。

傳回

non-null rules.firestore.Resource 文件；如果沒有文件，則為空值 個值。