aturan. firestore
Variabel dan metode khusus konteks untuk Cloud Firestore aturan keamanan.
Fungsi dalam namespace ini hanya tersedia di dalam
service cloud.firestore { ... }
blok dan
tidak perlu diberi awalan saat digunakan (get()
bukan firestore.get()
).
Antarmuka
Permintaan
Konteks permintaan yang masuk untuk operasi Firestore.
Resource
Dokumen Firestore yang sedang dibaca atau ditulis.
Properti
permintaan
rules.firestore.Request non-null
Konteks permintaan, termasuk informasi autentikasi dan data tertunda.
referensi
rules.firestore.Resource non-null
Resource yang sedang dibaca atau ditulis.
Metode
ada
ada(jalur) menampilkan rules.Boolean
Periksa apakah dokumen ada.
Parameter |
|
---|---|
jalur |
Jalur. Nilai tidak boleh nol. |
- Hasil
-
non-null rules.Boolean
benar jika resource ada.
Contoh
// Check if another document exists
allow write: if exists(/databases/$(database)/documents/things/other)
adaSetelah
existingAfter(path) menampilkan rules.Boolean
Memeriksa apakah dokumen ada, dengan asumsi bahwa permintaan saat ini berhasil. Setara ke getAfter(path) != null.
Parameter |
|
---|---|
jalur |
Jalur. Nilai tidak boleh nol. |
- Hasil
-
non-null rules.Boolean
benar jika resource ada.
get
get(path) menampilkan rules.firestore.Resource
Dapatkan konten dokumen firestore.
Parameter |
|
---|---|
jalur |
Jalur. Nilai tidak boleh nol. |
- Hasil
-
non-null rules.firestore.Resource
dokumen, atau null jika tidak ada.
Contoh
// Get the 'thing1' document from the 'things' collection
get(/databases/$(database)/documents/things/thing1)
getAfter
getAfter(path) menampilkan rules.firestore.Resource
Mendapatkan proyeksi isi dokumen. Dokumen ditampilkan sebagai jika permintaan saat ini berhasil. Berguna untuk memvalidasi dokumen yang merupakan bagian dari batch operasi tulis atau transaksi.
Parameter |
|
---|---|
jalur |
Jalur. Nilai tidak boleh nol. |
- Hasil
-
non-null rules.firestore.Resource
dokumen, atau null jika tidak ada.