ルール。消防署
Cloud Firestore セキュリティ ルールのコンテキスト固有の変数とメソッド。
この名前空間の関数はservice cloud.firestore { ... }
ブロック内でのみ使用でき、使用時にプレフィックスを付ける必要はありません ( firestore.get()
get()
なく get() )。
インターフェース
リクエスト
Firestore オペレーションの受信リクエスト コンテキスト。
リソース
読み取りまたは書き込み中の Firestore ドキュメント。
プロパティ
リクエスト
null 以外のrules.firestore.Request
認証情報や保留中のデータを含むリクエスト コンテキスト。
リソース
null 以外のrules.firestore.Resource
読み取りまたは書き込み中のリソース。
メソッド
存在します
存在する (パス) はrules.Booleanを返します。
文書が存在するかどうかを確認します。
パラメータ | |
---|---|
パス | パス。 値は null であってはなりません。 |
- 戻り値
non-null rules.Boolean
リソースが存在する場合は true。
例
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
後に存在します
existsAfter(path) はrules.Booleanを返します。
現在のリクエストが成功したと仮定して、ドキュメントが存在するかどうかを確認します。 getAfter(path) != null と同等。
パラメータ | |
---|---|
パス | パス。 値は null であってはなりません。 |
- 戻り値
non-null rules.Boolean
リソースが存在する場合は true。
得る
get(path) はrules.firestore.Resourceを返します
Firestore ドキュメントのコンテンツを取得します。
パラメータ | |
---|---|
パス | パス。 値は null であってはなりません。 |
- 戻り値
non-null rules.firestore.Resource
ドキュメント、またはドキュメントが存在しない場合は null。
例
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
取得後
getAfter(path) はrules.firestore.Resourceを返します
ドキュメントの投影されたコンテンツを取得します。現在のリクエストが成功したかのようにドキュメントが返されます。バッチ書き込みまたはトランザクションの一部であるドキュメントを検証する場合に役立ちます。
パラメータ | |
---|---|
パス | パス。 値は null であってはなりません。 |
- 戻り値
non-null rules.firestore.Resource
ドキュメント、またはドキュメントが存在しない場合は null。