命名空间：firestore

rules.firestore

namespace   static

适用于 Cloud Firestore 的特定于上下文的变量和方法 安全规则。

此命名空间中的函数仅在 service cloud.firestore { ... } 个块和 使用时无需添加前缀 (get()) 而非 firestore.get()）。

接口

属性

请求

静态

非 null rules.firestore.Request

请求上下文，包括身份验证信息 和待处理数据

资源

静态

非 null rules.firestore.Resource

要读取或写入的资源。

方法

存在

静态

exists(path) 会返回 rules.Boolean

检查文档是否存在。

参数

路径

rules.Path

路径。

值不能为 null。
返回值

non-null rules.Boolean：如果资源存在，则返回 true。

示例 

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

存在时间晚于

静态

existsAfter(path) 会返回 rules.Boolean

检查文档是否存在（假设当前请求成功）。等效 to getAfter(path) != null。

参数

路径

rules.Path

路径。

值不能为 null。
返回值

non-null rules.Boolean：如果资源存在，则返回 true。

get

静态

get(path) 返回 rules.firestore.Resource

获取 Firestore 文档的内容。

参数

路径

rules.Path

路径。

值不能为 null。
返回值

non-null rules.firestore.Resource 表示文档；如果不是，则返回 null 存在。

示例 

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

getAfter 项

静态

getAfter(path) 会返回 rules.firestore.Resource

获取文档的投影内容。该文档会以 如果当前请求成功，则会发生此错误。可用于验证文档 属于批量写入或事务的一部分。

参数

路径

rules.Path

路径。

值不能为 null。
返回值

non-null rules.firestore.Resource 表示文档；如果不是，则返回 null 存在。