database package

Basis Data Waktu Nyata Firebase

Fungsi

Fungsi Keterangan
fungsi(aplikasi, ...)
getDatabase(aplikasi, url) Mengembalikan instance Realtime Database SDK yang dikaitkan dengan FirebaseApp yang disediakan . Menginisialisasi instance baru dengan pengaturan default jika tidak ada instance atau jika instance yang ada menggunakan URL database kustom.
fungsi(db, ...)
connectDatabaseEmulator(db, host, port, opsi) Ubah instance yang disediakan untuk berkomunikasi dengan emulator Realtime Database.

Catatan: Metode ini harus dipanggil sebelum melakukan operasi lainnya.

buka Offline(db) Terputus dari server (semua operasi Database akan diselesaikan secara offline). Klien secara otomatis memelihara koneksi persisten ke server Database, yang akan tetap aktif tanpa batas waktu dan menyambung kembali ketika terputus. Namun, metode goOffline() dan goOnline() dapat digunakan untuk mengontrol koneksi klien jika koneksi persisten tidak diinginkan. Saat offline, klien tidak lagi menerima update data dari Database. Namun, semua operasi Database yang dilakukan secara lokal akan terus memicu peristiwa secara langsung, sehingga aplikasi Anda dapat terus berperilaku normal. Selain itu, setiap operasi yang dilakukan secara lokal akan secara otomatis dimasukkan ke dalam antrean dan dicoba ulang setelah tersambung kembali ke server Database. Untuk menyambung kembali ke Database dan mulai menerima kejadian jarak jauh, lihat goOnline() .
pergi Online(db) Menyambungkan kembali ke server dan menyinkronkan status Database offline dengan status server. Metode ini harus digunakan setelah menonaktifkan koneksi aktif dengan goOffline() . Setelah terhubung kembali, klien akan mengirimkan data yang tepat dan mengaktifkan peristiwa yang sesuai sehingga klien Anda "mengejar" secara otomatis.
ref(db, jalur) Mengembalikan Reference yang mewakili lokasi di Database sesuai dengan jalur yang disediakan. Jika tidak ada jalur yang disediakan, Reference akan menunjuk ke root Database.
refFromURL(db, url) Mengembalikan Reference yang mewakili lokasi di Database yang sesuai dengan URL Firebase yang disediakan. Pengecualian diberikan jika URL tersebut bukan URL Firebase Database yang valid atau memiliki domain yang berbeda dari instance Database saat ini. Perhatikan bahwa semua parameter kueri ( orderBy , limitToLast , dll.) diabaikan dan tidak diterapkan ke Reference yang dikembalikan.
fungsi()
forceLongPolling() Paksa penggunaan longPolling alih-alih websockets. Ini akan diabaikan jika protokol websocket digunakan di databaseURL.
kekuatanWebSockets() Paksa penggunaan soket web alih-alih longPolling.
pesananByKey() Membuat QueryConstraint baru yang diurutkan berdasarkan kunci. Mengurutkan hasil kueri berdasarkan nilai kuncinya (menaik). Anda dapat membaca lebih lanjut tentang orderByKey() di Sortir data .
pesananBerdasarkan Prioritas() Membuat QueryConstraint baru yang diurutkan berdasarkan prioritas. Aplikasi tidak perlu menggunakan prioritas tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Mengurutkan data untuk alternatif prioritas.
pesananBerdasarkanNilai() Membuat QueryConstraint baru yang diurutkan berdasarkan nilai. Jika turunan kueri semuanya merupakan nilai skalar (string, angka, atau boolean), Anda dapat mengurutkan hasilnya berdasarkan nilainya (menaik). Anda dapat membaca selengkapnya tentang orderByValue() di Sortir data .
server Stempel Waktu() Mengembalikan nilai placeholder untuk mengisi stempel waktu saat ini secara otomatis (waktu sejak zaman Unix, dalam milidetik) sebagaimana ditentukan oleh server Firebase.
fungsi(delta, ...)
kenaikan (delta) Mengembalikan nilai placeholder yang dapat digunakan untuk menaikkan nilai database saat ini secara atomik berdasarkan delta yang disediakan.
fungsi (diaktifkan, ...)
aktifkanLogging(diaktifkan, persisten) Mencatat informasi debug ke konsol.
fungsi(batas, ...)
batasKePertama(batas) Membuat QueryConstraint baru yang jika dibatasi pada jumlah anak tertentu yang pertama. Metode limitToFirst() digunakan untuk menetapkan jumlah maksimum anak yang akan disinkronkan untuk panggilan balik tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added . Jika kami memiliki kurang dari 100 pesan yang disimpan di Database kami, acara child_added akan diaktifkan untuk setiap pesan. Namun, jika kami memiliki lebih dari 100 pesan, kami hanya akan menerima acara child_added untuk 100 pesan pertama yang dipesan. Saat item berubah, kami akan menerima acara child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah totalnya tetap 100. Anda dapat membaca selengkapnya tentang limitToFirst() di Memfilter data .
batasKe Terakhir(batas) Membuat QueryConstraint baru yang dibatasi hanya untuk mengembalikan jumlah anak terakhir yang ditentukan. Metode limitToLast() digunakan untuk menetapkan jumlah maksimum anak yang akan disinkronkan untuk panggilan balik tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added . Jika kami memiliki kurang dari 100 pesan yang disimpan di Database kami, acara child_added akan diaktifkan untuk setiap pesan. Namun, jika kami memiliki lebih dari 100 pesan, kami hanya akan menerima acara child_added untuk 100 pesan terakhir yang dipesan. Saat item berubah, kami akan menerima acara child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah totalnya tetap 100. Anda dapat membaca selengkapnya tentang limitToLast() di Memfilter data .
fungsi (pencatat, ...)
aktifkanLogging(logger) Mencatat informasi debug ke konsol.
fungsi(induk, ...)
anak (orang tua, jalur) Mendapat Reference untuk lokasi di jalur relatif yang ditentukan. Jalur relatif dapat berupa nama anak sederhana (misalnya, "ada") atau jalur yang dipisahkan garis miring (misalnya, "ada/nama/depan").
push(induk, nilai) Menghasilkan lokasi anak baru menggunakan kunci unik dan mengembalikan Reference . Ini adalah pola paling umum untuk menambahkan data ke kumpulan item. Jika Anda memberikan nilai ke push() , nilai tersebut ditulis ke lokasi yang dihasilkan. Jika Anda tidak memberikan nilai, tidak ada yang ditulis ke database dan turunannya tetap kosong (tetapi Anda dapat menggunakan Reference di tempat lain). Kunci unik yang dihasilkan oleh push() diurutkan berdasarkan waktu saat ini, sehingga daftar item yang dihasilkan diurutkan secara kronologis. Kuncinya juga dirancang agar tidak dapat ditebak (mengandung 72 bit entropi acak). Lihat Menambahkan ke daftar data . Lihat 2^120 Cara Memastikan Pengidentifikasi Unik .
fungsi(jalur, ...)
pesananOlehAnak(jalur) Membuat QueryConstraint baru yang diurutkan berdasarkan kunci anak yang ditentukan. Kueri hanya dapat diurutkan dengan satu kunci dalam satu waktu. Memanggil orderByChild() beberapa kali pada kueri yang sama adalah sebuah kesalahan. Kueri Firebase memungkinkan Anda mengurutkan data berdasarkan kunci anak mana pun dengan cepat. Namun, jika Anda mengetahui sebelumnya apa yang akan menjadi indeks Anda, Anda dapat menentukannya melalui aturan .indexOn di Aturan Keamanan Anda untuk kinerja yang lebih baik. Lihat aturan https://firebase.google.com/docs/database/security/indexing-data untuk informasi lebih lanjut. Anda dapat membaca selengkapnya tentang orderByChild() di Sortir data .
fungsi(kueri, ...)
dapatkan (kueri) Mendapatkan hasil terkini untuk kueri ini.
mati (kueri, eventType, panggilan balik) Melepaskan panggilan balik yang sebelumnya dilampirkan dengan pendengar on () ( onValue , onChildAdded ) yang sesuai. Catatan: Ini bukan cara yang disarankan untuk menghapus pendengar. Sebagai gantinya, silakan gunakan fungsi panggilan balik yang dikembalikan dari masing-masing panggilan on . Lepaskan panggilan balik yang sebelumnya dilampirkan dengan on*() . Memanggil off() pada pendengar induk tidak akan secara otomatis menghapus pendengar yang terdaftar pada node anak, off() juga harus dipanggil pada pendengar anak mana pun untuk menghapus panggilan balik. Jika panggilan balik tidak ditentukan, semua panggilan balik untuk eventType yang ditentukan akan dihapus. Demikian pula, jika tidak ada eventType yang ditentukan, semua callback untuk Reference akan dihapus. Masing-masing pendengar juga dapat dihapus dengan menjalankan panggilan balik berhenti berlangganan.
onChildAdded(kueri, panggilan balik, pembatalanCallback) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali turunan baru ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua dilewatkan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildAdded (kueri, panggilan balik, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali turunan baru ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua dilewatkan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildAdded(kueri, panggilan balik, pembatalanCallback, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali turunan baru ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua dilewatkan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildChanged(kueri, panggilan balik, pembatalanCallback) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildChanged akan dipicu ketika data yang disimpan di anak (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan tersebut. DataSnapshot yang diteruskan ke callback akan berisi konten anak baru. Untuk tujuan pengurutan, callback juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildChanged (kueri, panggilan balik, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildChanged akan dipicu ketika data yang disimpan di anak (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan tersebut. DataSnapshot yang diteruskan ke callback akan berisi konten anak baru. Untuk tujuan pengurutan, callback juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildChanged(kueri, panggilan balik, pembatalanCallback, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildChanged akan dipicu ketika data yang disimpan di anak (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan tersebut. DataSnapshot yang diteruskan ke callback akan berisi konten anak baru. Untuk tujuan pengurutan, callback juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildMoved(kueri, panggilan balik, pembatalanCallback) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildMoved akan terpicu ketika susunan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap saudara kandungnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data anak yang telah dipindahkan. Argumen kedua juga diteruskan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildMoved(kueri, panggilan balik, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildMoved akan terpicu ketika susunan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap saudara kandungnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data anak yang telah dipindahkan. Argumen kedua juga diteruskan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildMoved(kueri, panggilan balik, pembatalanCallback, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildMoved akan terpicu ketika susunan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap saudara kandungnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data anak yang telah dipindahkan. Argumen kedua juga diteruskan, yaitu string yang berisi kunci dari anak saudara sebelumnya berdasarkan urutan, atau null jika itu adalah anak pertama.
onChildRemoved(kueri, panggilan balik, pembatalanCallback) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildRemoved akan dipicu setiap kali ada anak yang dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk anak yang telah dihapus. Seorang anak akan dikeluarkan jika: - klien secara eksplisit memanggil remove() pada anak tersebut atau salah satu leluhurnya - klien memanggil set(null) pada anak tersebut atau salah satu leluhurnya - anak tersebut telah menghapus semua anaknya - ada kueri yang berlaku yang sekarang memfilter anak (karena urutannya berubah atau batas maksimal tercapai)
onChildRemoved(kueri, panggilan balik, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildRemoved akan dipicu setiap kali ada anak yang dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk anak yang telah dihapus. Seorang anak akan dikeluarkan jika: - klien secara eksplisit memanggil remove() pada anak tersebut atau salah satu leluhurnya - klien memanggil set(null) pada anak tersebut atau salah satu leluhurnya - anak tersebut telah menghapus semua anaknya - ada kueri yang berlaku yang sekarang memfilter anak (karena urutannya berubah atau batas maksimal tercapai)
onChildRemoved(kueri, panggilan balik, pembatalanCallback, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onChildRemoved akan dipicu setiap kali ada anak yang dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk anak yang telah dihapus. Seorang anak akan dikeluarkan jika: - klien secara eksplisit memanggil remove() pada anak tersebut atau salah satu leluhurnya - klien memanggil set(null) pada anak tersebut atau salah satu leluhurnya - anak tersebut telah menghapus semua anaknya - ada kueri yang berlaku yang sekarang memfilter anak (karena urutannya berubah atau batas maksimal tercapai)
onValue(kueri, panggilan balik, pembatalanCallback) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onValue akan terpicu satu kali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi di mana on() dipanggil. Itu tidak akan terpicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, maka akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).
onValue(kueri, panggilan balik, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onValue akan terpicu satu kali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi di mana on() dipanggil. Itu tidak akan terpicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, maka akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).
onValue(kueri, panggilan balik, pembatalanCallback, opsi) Mendengarkan perubahan data di lokasi tertentu. Ini adalah cara utama untuk membaca data dari Database. Panggilan balik Anda akan dipicu untuk data awal dan dipicu lagi setiap kali data berubah. Panggil panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Mengambil Data di Web untuk detail selengkapnya. Peristiwa onValue akan terpicu satu kali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi di mana on() dipanggil. Itu tidak akan terpicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, maka akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).
kueri(kueri, batasan kueri) Membuat instance Query baru yang tidak dapat diubah yang diperluas untuk juga menyertakan batasan kueri tambahan.
fungsi(ref, ...)
padaDisconnect(ref) Mengembalikan objek OnDisconnect - lihat Mengaktifkan Kemampuan Offline di JavaScript untuk informasi selengkapnya tentang cara menggunakannya.
hapus (ref) Menghapus data di lokasi Database ini. Data apa pun di lokasi turunan juga akan dihapus. Efek penghapusan akan segera terlihat dan 'nilai' peristiwa terkait akan dipicu. Sinkronisasi penghapusan ke server Firebase juga akan dimulai, dan Promise yang dikembalikan akan teratasi setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai.
runTransaction(ref, pembaruan transaksi, opsi) Memodifikasi data secara atom di lokasi ini. Ubah data secara atom di lokasi ini. Berbeda dengan set() biasa, yang hanya menimpa data berapa pun nilai sebelumnya, runTransaction() digunakan untuk mengubah nilai yang ada ke nilai baru, memastikan tidak ada konflik dengan klien lain yang menulis ke lokasi yang sama pada waktu yang sama . Untuk mencapai hal ini, Anda meneruskan runTransaction() fungsi pembaruan yang digunakan untuk mengubah nilai saat ini menjadi nilai baru. Jika klien lain menulis ke lokasi sebelum nilai baru Anda berhasil ditulis, fungsi pembaruan Anda akan dipanggil lagi dengan nilai baru saat ini, dan penulisan akan dicoba lagi. Hal ini akan terjadi berulang kali hingga penulisan Anda berhasil tanpa konflik atau Anda membatalkan transaksi dengan tidak mengembalikan nilai dari fungsi pembaruan Anda. Catatan: Memodifikasi data dengan set() akan membatalkan transaksi yang tertunda di lokasi tersebut, jadi sangat berhati-hati jika menggabungkan set() dan runTransaction() untuk memperbarui data yang sama. Catatan: Saat menggunakan transaksi dengan Aturan Keamanan dan Firebase, ketahuilah bahwa klien memerlukan akses .read selain akses .write untuk melakukan transaksi. Hal ini karena sifat transaksi sisi klien mengharuskan klien membaca data untuk memperbaruinya secara transaksional.
set(ref, nilai) Menulis data ke lokasi Database ini. Tindakan ini akan menimpa data apa pun di lokasi ini dan semua lokasi turunan. Efek penulisan akan segera terlihat, dan peristiwa terkait ("nilai", "tambahan_anak", dll.) akan dipicu. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang dikembalikan akan teratasi setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai. Meneruskan null untuk nilai baru sama dengan memanggil remove() ; yaitu, semua data di lokasi ini dan semua lokasi turunan akan dihapus. set() akan menghapus prioritas apa pun yang disimpan di lokasi ini, jadi jika prioritas ingin dipertahankan, Anda perlu menggunakan setWithPriority() sebagai gantinya. Perhatikan bahwa mengubah data dengan set() akan membatalkan transaksi yang tertunda di lokasi tersebut, jadi sangat berhati-hati jika mencampur set() dan transaction() untuk mengubah data yang sama. Satu set() akan menghasilkan satu peristiwa "nilai" di lokasi di mana set() dilakukan.
setPriority(ref, prioritas) Menetapkan prioritas untuk data di lokasi Database ini. Aplikasi tidak perlu menggunakan prioritas tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Menyortir dan memfilter data ).
setWithPriority(ref, nilai, prioritas) Menulis data lokasi Database. Seperti set() tetapi juga menentukan prioritas untuk data tersebut. Aplikasi tidak perlu menggunakan prioritas tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Menyortir dan memfilter data ).
perbarui(ref, nilai) Menulis beberapa nilai ke Database sekaligus. Argumen values berisi beberapa pasangan nilai properti yang akan ditulis ke Database bersama-sama. Setiap properti turunan dapat berupa properti sederhana (misalnya, "nama") atau jalur relatif (misalnya, "nama/depan") dari lokasi saat ini ke data yang akan diperbarui. Berbeda dengan metode set() , update() dapat digunakan untuk memperbarui secara selektif hanya properti yang direferensikan di lokasi saat ini (alih-alih mengganti semua properti anak di lokasi saat ini). Efek penulisan akan segera terlihat, dan peristiwa terkait ('nilai', 'tambahan_anak', dll.) akan dipicu. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang dikembalikan akan teratasi setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai. Satu update() akan menghasilkan satu peristiwa "nilai" di lokasi di mana update() dilakukan, terlepas dari berapa banyak turunan yang dimodifikasi. Perhatikan bahwa mengubah data dengan update() akan membatalkan transaksi yang tertunda di lokasi tersebut, jadi sangat berhati-hati jika menggabungkan update() dan transaction() untuk mengubah data yang sama. Meneruskan null ke update() akan menghapus data di lokasi ini. Lihat Memperkenalkan pembaruan multi-lokasi dan lainnya .
fungsi(nilai, ...)
endAt(nilai, kunci) Membuat QueryConstraint dengan titik akhir yang ditentukan. Menggunakan startAt() , startAfter() , endBefore() , endAt() dan equalTo() memungkinkan Anda memilih titik awal dan akhir untuk kueri Anda. Titik akhir bersifat inklusif, sehingga anak-anak dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk lebih membatasi rentang kueri. Jika ditentukan, maka turunan yang memiliki nilai persis yang ditentukan juga harus memiliki nama kunci yang kurang dari atau sama dengan kunci yang ditentukan. Anda dapat membaca selengkapnya tentang endAt() di Memfilter data .
endBefore(nilai, kunci) Membuat QueryConstraint dengan titik akhir yang ditentukan (eksklusif). Menggunakan startAt() , startAfter() , endBefore() , endAt() dan equalTo() memungkinkan Anda memilih titik awal dan akhir untuk kueri Anda. Titik akhirnya bersifat eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai kurang dari nilai yang ditentukan akan disertakan dalam kueri. Jika suatu kunci ditentukan, maka turunannya harus memiliki nilai yang kurang dari atau sama dengan nilai yang ditentukan dan nama kunci yang kurang dari kunci yang ditentukan.
equalTo(nilai, kunci) Membuat QueryConstraint yang menyertakan turunan yang cocok dengan nilai yang ditentukan. Menggunakan startAt() , startAfter() , endBefore() , endAt() dan equalTo() memungkinkan Anda memilih titik awal dan akhir untuk kueri Anda. Argumen kunci opsional dapat digunakan untuk lebih membatasi rentang kueri. Jika ditentukan, maka turunan yang memiliki nilai persis yang ditentukan juga harus memiliki kunci yang ditentukan sebagai nama kuncinya. Ini dapat digunakan untuk memfilter kumpulan hasil dengan banyak kecocokan untuk nilai yang sama. Anda dapat membaca selengkapnya tentang equalTo() di Memfilter data .
startAfter(nilai, kunci) Membuat QueryConstraint dengan titik awal yang ditentukan (eksklusif). Menggunakan startAt() , startAfter() , endBefore() , endAt() dan equalTo() memungkinkan Anda memilih titik awal dan akhir untuk kueri Anda. Titik awalnya adalah eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai lebih besar dari nilai yang ditentukan akan disertakan dalam kueri. Jika suatu kunci ditentukan, maka turunannya harus memiliki nilai yang lebih besar atau sama dengan nilai yang ditentukan dan nama kunci yang lebih besar dari kunci yang ditentukan.
startAt(nilai, kunci) Membuat QueryConstraint dengan titik awal yang ditentukan. Menggunakan startAt() , startAfter() , endBefore() , endAt() dan equalTo() memungkinkan Anda memilih titik awal dan akhir untuk kueri Anda. Titik awalnya bersifat inklusif, sehingga anak-anak dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk lebih membatasi rentang kueri. Jika ditentukan, maka turunan yang memiliki nilai persis yang ditentukan juga harus memiliki nama kunci yang lebih besar atau sama dengan kunci yang ditentukan. Anda dapat membaca selengkapnya tentang startAt() di Memfilter data .

Kelas

Kelas Keterangan
Basis data Kelas yang mewakili Firebase Realtime Database.
Cuplikan Data DataSnapshot berisi data dari lokasi Database. Setiap kali Anda membaca data dari Database, Anda menerima data sebagai DataSnapshot . DataSnapshot diteruskan ke callback peristiwa yang Anda lampirkan dengan on() atau once() . Anda dapat mengekstrak konten snapshot sebagai objek JavaScript dengan memanggil metode val() . Alternatifnya, Anda dapat menelusuri snapshot dengan memanggil child() untuk mengembalikan snapshot anak (yang kemudian dapat Anda panggil val() aktif). DataSnapshot adalah salinan data yang dihasilkan secara efisien dan tidak dapat diubah di lokasi Database. Itu tidak dapat diubah dan tidak akan pernah berubah (untuk mengubah data, Anda selalu memanggil metode set() pada Reference secara langsung).
Sedang Putus Kelas onDisconnect memungkinkan Anda untuk menulis atau menghapus data ketika klien Anda terputus dari server Database. Pembaruan ini terjadi baik koneksi klien Anda terputus dengan baik atau tidak, sehingga Anda dapat mengandalkan pembaruan ini untuk membersihkan data bahkan jika koneksi terputus atau klien mengalami crash. Kelas onDisconnect paling sering digunakan untuk mengelola kehadiran dalam aplikasi yang berguna untuk mendeteksi berapa banyak klien yang terhubung dan kapan klien lain terputus. Lihat Mengaktifkan Kemampuan Offline di JavaScript untuk informasi lebih lanjut. Untuk menghindari masalah ketika koneksi terputus sebelum permintaan dapat ditransfer ke server Database, fungsi-fungsi ini harus dipanggil sebelum menulis data apa pun. Perhatikan bahwa operasi onDisconnect hanya dipicu satu kali. Jika Anda ingin operasi terjadi setiap kali terjadi pemutusan sambungan, Anda harus menjalankan kembali operasi onDisconnect setiap kali Anda menyambung kembali.
Batasan Kueri QueryConstraint digunakan untuk mempersempit kumpulan dokumen yang dikembalikan oleh kueri Database. QueryConstraint dibuat dengan memanggil endAt() , akhirSebelum() , dimulai dari() , mulaiSetelah() , batasKePertama() , batasKeTerakhir() , pesananByChild() , pesananByChild() , orderByKey() , orderByPriority() , orderByValue() atau equalTo() dan kemudian dapat diteruskan ke query() untuk membuat instance kueri baru yang juga berisi QueryConstraint ini.
Hasil Transaksi Tipe untuk nilai penyelesaian runTransaction() .

Antarmuka

Antarmuka Keterangan
Referensi Basis Data DatabaseReference mewakili lokasi tertentu di Database Anda dan dapat digunakan untuk membaca atau menulis data ke lokasi Database tersebut. Anda dapat mereferensikan lokasi root atau lokasi anak di Database Anda dengan memanggil ref() atau ref("child/path") . Penulisan dilakukan dengan metode set() dan pembacaan dapat dilakukan dengan metode on*() . Lihat https://firebase.google.com/docs/database/web/read-and-write
IterasiDataSnapshot Merupakan snapshot anak dari Reference yang sedang diulang. Kuncinya tidak akan pernah terdefinisi.
Opsi Dengar Objek opsi yang dapat digunakan untuk menyesuaikan pendengar.
Pertanyaan Query mengurutkan dan memfilter data di lokasi Database sehingga hanya sebagian dari data anak yang disertakan. Ini dapat digunakan untuk mengurutkan kumpulan data berdasarkan beberapa atribut (misalnya, tinggi dinosaurus) serta untuk membatasi daftar item yang besar (misalnya, pesan obrolan) ke jumlah yang sesuai untuk disinkronkan ke klien. Kueri dibuat dengan menyatukan satu atau lebih metode filter yang ditentukan di sini. Sama seperti DatabaseReference , Anda bisa menerima data dari Query dengan menggunakan metode on*() . Anda hanya akan menerima peristiwa dan DataSnapshot untuk subkumpulan data yang cocok dengan kueri Anda. Lihat https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data untuk informasi lebih lanjut.
Referensi yang Dapat Dilakukan Promise yang juga dapat bertindak sebagai DatabaseReference ketika dikembalikan oleh push() . Referensi segera tersedia dan Promise diselesaikan setelah penulisan ke backend selesai.
Opsi Transaksi Objek opsi untuk mengonfigurasi transaksi.

Ketik Alias

Ketik Alias Keterangan
Tipe Peristiwa Salah satu string berikut: "value", "child_added", "child_changed", "child_removed", atau "child_moved".
Tipe Batasan Kueri Menjelaskan berbagai batasan kueri yang tersedia di SDK ini.
Berhenti berlangganan Panggilan balik yang dapat dipanggil untuk menghapus pendengar.

fungsi(aplikasi, ...)

getDatabase(aplikasi, url)

Mengembalikan instance Realtime Database SDK yang dikaitkan dengan FirebaseApp yang disediakan . Menginisialisasi instance baru dengan pengaturan default jika tidak ada instance atau jika instance yang ada menggunakan URL database kustom.

Tanda tangan:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Parameter

Parameter Jenis Keterangan
aplikasi Aplikasi Firebase Instance FirebaseApp yang dikaitkan dengan instance Realtime Database yang dikembalikan.
url rangkaian URL instance Realtime Database yang akan dihubungkan. Jika tidak disediakan, SDK akan terhubung ke instance default Aplikasi Firebase.

Pengembalian:

Basis data

Contoh Database dari aplikasi yang disediakan.

fungsi(db, ...)

connectDatabaseEmulator(db, host, port, opsi)

Ubah instance yang disediakan untuk berkomunikasi dengan emulator Realtime Database.

Catatan: Metode ini harus dipanggil sebelum melakukan operasi lainnya.

Tanda tangan:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parameter

Parameter Jenis Keterangan
db Basis data Contoh yang akan diubah.
tuan rumah rangkaian Host emulator (misal: localhost)
pelabuhan nomor Port emulator (misal: 8080)
pilihan { mockUserToken?: EmulatorMockTokenOptions | rangkaian; }

Pengembalian:

ruang kosong

buka Offline(db)

Terputus dari server (semua operasi Database akan diselesaikan secara offline).

Klien secara otomatis memelihara koneksi persisten ke server Database, yang akan tetap aktif tanpa batas waktu dan menyambung kembali ketika terputus. Namun, metode goOffline() dan goOnline() dapat digunakan untuk mengontrol koneksi klien jika koneksi persisten tidak diinginkan.

Saat offline, klien tidak lagi menerima update data dari Database. Namun, semua operasi Database yang dilakukan secara lokal akan terus memicu peristiwa secara langsung, sehingga aplikasi Anda dapat terus berperilaku normal. Selain itu, setiap operasi yang dilakukan secara lokal akan secara otomatis dimasukkan ke dalam antrean dan dicoba ulang setelah tersambung kembali ke server Database.

Untuk terhubung kembali ke database dan mulai menerima acara jarak jauh, lihat goOnline() .

Tanda tangan:

export declare function goOffline(db: Database): void;

Parameter

Parameter Jenis Keterangan
db Basis data Contoh untuk memutuskan.

Pengembalian:

ruang kosong

Goonline (DB)

Berhubungan kembali ke server dan menyinkronkan status basis data offline dengan status server.

Metode ini harus digunakan setelah menonaktifkan koneksi aktif dengan goOffline() . Setelah terhubung kembali, klien akan mengirimkan data yang tepat dan memecat acara yang sesuai sehingga klien Anda "mengejar" secara otomatis.

Tanda tangan:

export declare function goOnline(db: Database): void;

Parameter

Parameter Jenis Keterangan
db Basis data Contoh untuk terhubung kembali.

Pengembalian:

ruang kosong

Ref (DB, Path)

Mengembalikan Reference yang mewakili lokasi dalam database yang sesuai dengan jalur yang disediakan. Jika tidak ada jalur yang disediakan, Reference akan menunjuk ke akar database.

Tanda tangan:

export declare function ref(db: Database, path?: string): DatabaseReference;

Parameter

Parameter Jenis Keterangan
db Basis data Instance database untuk mendapatkan referensi untuk.
jalur rangkaian Jalur opsional yang mewakili lokasi Reference yang dikembalikan akan menunjuk. Jika tidak disediakan, Reference yang dikembalikan akan menunjuk ke akar database.

Pengembalian:

Referensi Basis Data

Jika jalur disediakan, Reference yang menunjuk ke jalur yang disediakan. Kalau tidak, Reference yang menunjuk ke akar database.

Refromurl (DB, URL)

Mengembalikan Reference yang mewakili lokasi dalam database yang sesuai dengan URL firebase yang disediakan.

Pengecualian dilemparkan jika URL bukan URL basis data Firebase yang valid atau memiliki domain yang berbeda dari instance Database saat ini.

Perhatikan bahwa semua parameter kueri ( orderBy , limitToLast , dll.) Diabaikan dan tidak diterapkan pada Reference yang dikembalikan .

Tanda tangan:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Parameter

Parameter Jenis Keterangan
db Basis data Instance database untuk mendapatkan referensi untuk.
url rangkaian URL Firebase di mana Reference yang dikembalikan akan menunjuk.

Pengembalian:

Referensi Basis Data

Reference yang menunjuk ke URL firebase yang disediakan.

fungsi()

forcelongpolling ()

Paksa penggunaan panjang alih -alih websockets. Ini akan diabaikan jika protokol WebSocket digunakan dalam databaseurl.

Tanda tangan:

export declare function forceLongPolling(): void;

Pengembalian:

ruang kosong

forceWebsockets ()

Paksa penggunaan websocket bukannya panjang.

Tanda tangan:

export declare function forceWebSockets(): void;

Pengembalian:

ruang kosong

orderbykey ()

Membuat QueryConstraint baru yang diperintahkan oleh kunci.

Mengurutkan hasil kueri berdasarkan nilai -nilai kunci (naik) mereka.

Anda dapat membaca lebih lanjut tentang orderByKey() dalam data sortir .

Tanda tangan:

export declare function orderByKey(): QueryConstraint;

Pengembalian:

Queryconstraint

orderbypriority ()

Membuat QueryConstraint baru yang diperintahkan berdasarkan prioritas.

Aplikasi tidak perlu menggunakan prioritas tetapi dapat memesan koleksi berdasarkan properti biasa (lihat data sortir untuk alternatif untuk prioritas.

Tanda tangan:

export declare function orderByPriority(): QueryConstraint;

Pengembalian:

Queryconstraint

orderbyvalue ()

Menciptakan QueryConstraint baru yang memesan berdasarkan nilai.

Jika anak -anak dari suatu kueri adalah semua nilai skalar (string, angka, atau boolean), Anda dapat memesan hasil dengan nilai (naik) mereka.

Anda dapat membaca lebih lanjut tentang orderByValue() dalam data sortir .

Tanda tangan:

export declare function orderByValue(): QueryConstraint;

Pengembalian:

Queryconstraint

serverTimestamp ()

Mengembalikan nilai placeholder untuk populasi timestamp saat ini (waktu sejak zaman UNIX, dalam milidetik) sebagaimana ditentukan oleh server Firebase.

Tanda tangan:

export declare function serverTimestamp(): object;

Pengembalian:

obyek

fungsi (delta, ...)

kenaikan (delta)

Mengembalikan nilai placeholder yang dapat digunakan untuk secara atom meningkatkan nilai basis data saat ini oleh delta yang disediakan.

Tanda tangan:

export declare function increment(delta: number): object;

Parameter

Parameter Jenis Keterangan
delta nomor Jumlah untuk memodifikasi nilai saat ini secara atom.

Pengembalian:

obyek

Nilai placeholder untuk memodifikasi data sisi server atom.

fungsi (diaktifkan, ...)

aktifkanLogging(diaktifkan, persisten)

Log debugging informasi ke konsol.

Tanda tangan:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Parameter

Parameter Jenis Keterangan
diaktifkan boolean Mengaktifkan logging jika true , menonaktifkan logging jika false .
gigih boolean Mengingat keadaan logging antara halaman menyegarkan jika true .

Pengembalian:

setiap

fungsi (batas, ...)

limittofirst (batas)

Membuat QueryConstraint baru bahwa jika terbatas pada jumlah spesifik pertama anak -anak.

Metode limitToFirst() digunakan untuk menetapkan jumlah maksimum anak -anak yang akan disinkronkan untuk panggilan balik yang diberikan. Jika kami menetapkan batas 100, kami awalnya hanya akan menerima hingga 100 acara child_added . Jika kami memiliki kurang dari 100 pesan yang disimpan dalam database kami, acara child_added akan menembak untuk setiap pesan. Namun, jika kami memiliki lebih dari 100 pesan, kami hanya akan menerima acara child_added untuk 100 pesan yang dipesan pertama. Saat item berubah, kami akan menerima acara child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah total tetap di 100.

Anda dapat membaca lebih lanjut tentang limitToFirst() dalam data penyaringan .

Tanda tangan:

export declare function limitToFirst(limit: number): QueryConstraint;

Parameter

Parameter Jenis Keterangan
membatasi nomor Jumlah node maksimum yang akan dimasukkan dalam kueri ini.

Pengembalian:

Queryconstraint

batasKe Terakhir(batas)

Membuat QueryConstraint baru yang terbatas untuk mengembalikan hanya jumlah anak terakhir yang ditentukan.

Metode limitToLast() digunakan untuk menetapkan jumlah maksimum anak -anak untuk disinkronkan untuk panggilan balik yang diberikan. Jika kami menetapkan batas 100, kami awalnya hanya akan menerima hingga 100 acara child_added . Jika kami memiliki kurang dari 100 pesan yang disimpan dalam database kami, acara child_added akan menembak untuk setiap pesan. Namun, jika kami memiliki lebih dari 100 pesan, kami hanya akan menerima acara child_added untuk 100 pesan yang dipesan terakhir. Saat item berubah, kami akan menerima acara child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah total tetap di 100.

Anda dapat membaca lebih lanjut tentang limitToLast() dalam data penyaringan .

Tanda tangan:

export declare function limitToLast(limit: number): QueryConstraint;

Parameter

Parameter Jenis Keterangan
membatasi nomor Jumlah node maksimum yang akan dimasukkan dalam kueri ini.

Pengembalian:

Queryconstraint

fungsi (pencatat, ...)

Enablelogging (Logger)

Log debugging informasi ke konsol.

Tanda tangan:

export declare function enableLogging(logger: (message: string) => unknown): any;

Parameter

Parameter Jenis Keterangan
penebang (pesan: string) => tidak diketahui Fungsi logger khusus untuk mengontrol bagaimana hal -hal dicatat.

Pengembalian:

setiap

fungsi (orang tua, ...)

anak (orang tua, jalur)

Mendapat Reference untuk lokasi di jalur relatif yang ditentukan.

Jalur relatif dapat berupa nama anak sederhana (misalnya, "Ada") atau jalur yang dipisahkan lebih dalam (misalnya, "Ada/Nama/Pertama").

Tanda tangan:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Parameter

Parameter Jenis Keterangan
induk Referensi Basis Data Lokasi induk.
jalur rangkaian Jalur relatif dari lokasi ini ke lokasi anak yang diinginkan.

Pengembalian:

Referensi Basis Data

Lokasi anak yang ditentukan.

Push (Parent, Nilai)

Menghasilkan lokasi anak baru menggunakan kunci unik dan mengembalikan Reference .

Ini adalah pola yang paling umum untuk menambahkan data ke kumpulan item.

Jika Anda memberikan nilai untuk push() , nilainya ditulis ke lokasi yang dihasilkan. Jika Anda tidak memberikan nilai, tidak ada yang ditulis ke database dan anak tetap kosong (tetapi Anda dapat menggunakan Reference di tempat lain).

Kunci unik yang dihasilkan oleh push() dipesan oleh waktu saat ini, sehingga daftar item yang dihasilkan diurutkan secara kronologis. Kunci juga dirancang agar tidak dapat dialami (mereka berisi 72 bit entropi acak).

Lihat Tambahkan daftar data . Lihat 2^120 cara untuk memastikan pengidentifikasi unik .

Tanda tangan:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Parameter

Parameter Jenis Keterangan
induk Referensi Basis Data Lokasi induk.
nilai tidak dikenal Nilai opsional yang akan ditulis di lokasi yang dihasilkan.

Pengembalian:

Referensi yang Dapat Dilakukan

Promise dan Reference gabungan ; Selesaikan saat menulis selesai, tetapi dapat digunakan segera sebagai Reference ke lokasi anak.

fungsi (jalur, ...)

pesananOlehAnak(jalur)

Membuat QueryConstraint baru yang diperintahkan oleh kunci anak yang ditentukan.

Kueri hanya dapat memesan dengan satu kunci pada satu waktu. Memanggil orderByChild() Beberapa kali pada kueri yang sama adalah kesalahan.

Pertanyaan Firebase memungkinkan Anda memesan data Anda dengan kunci anak mana pun dengan cepat. Namun, jika Anda tahu sebelumnya apa indeks Anda nantinya, Anda dapat mendefinisikannya melalui aturan .indexon dalam aturan keamanan Anda untuk kinerja yang lebih baik. Lihat https://firebase.google.com/docs/database/security/indexing-data aturan untuk informasi lebih lanjut.

Anda dapat membaca lebih lanjut tentang orderByChild() dalam data sortir .

Tanda tangan:

export declare function orderByChild(path: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
jalur rangkaian Jalan untuk memesan oleh.

Pengembalian:

Queryconstraint

fungsi (kueri, ...)

dapatkan (kueri)

Mendapat hasil paling mutakhir untuk kueri ini.

Tanda tangan:

export declare function get(query: Query): Promise<DataSnapshot>;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.

Pengembalian:

Janji < DataSnapshot >

Promise yang diselesaikan dengan DATASNAPSHOT yang dihasilkan jika nilai tersedia, atau menolak jika klien tidak dapat mengembalikan nilai (misalnya, jika server tidak dapat dijangkau dan tidak ada yang di -cache).

Off (kueri, eventType, callback)

Lepaskan panggilan balik yang sebelumnya dilampirkan dengan yang sesuai on*() ( onValue , onChildAdded ) pendengar. Catatan: Ini bukan cara yang disarankan untuk menghapus pendengar. Sebagai gantinya, silakan gunakan fungsi panggilan balik yang dikembalikan dari masing -masing on* callback.

Lepaskan panggilan balik yang sebelumnya dilampirkan dengan on*() . Calling off() pada pendengar orang tua tidak akan secara otomatis menghapus pendengar yang terdaftar di node anak, off() juga harus dipanggil pada pendengar anak mana pun untuk menghapus panggilan balik.

Jika panggilan balik tidak ditentukan, semua panggilan balik untuk EventType yang ditentukan akan dihapus. Demikian pula, jika tidak ada EventType yang ditentukan, semua panggilan balik untuk Reference akan dihapus.

Pendengar individu juga dapat dihapus dengan memohon panggilan balik mereka yang berhenti berlangganan.

Tanda tangan:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri tempat pendengar terdaftar.
tipe acara Tipe Peristiwa Salah satu string berikut: "Nilai", "Child_added", "Child_Changed", "Child_removed", atau "Child_Moved." Jika dihilangkan, semua panggilan balik untuk Reference akan dihapus.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName?: String | null) => tidak diketahui Fungsi panggilan balik yang diteruskan ke on() atau undefined untuk menghapus semua panggilan balik.

Pengembalian:

ruang kosong

onChildAdded(kueri, panggilan balik, pembatalanCallback)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildAdded akan dipicu sekali untuk setiap anak awal di lokasi ini, dan itu akan dipicu lagi setiap kali anak baru ditambahkan. DataSnapshot yang disahkan ke dalam panggilan balik akan mencerminkan data untuk anak yang relevan. Untuk tujuan pemesanan, disahkan argumen kedua yang merupakan string yang berisi kunci anak saudara kandung sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName?: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

onChildAdded (kueri, panggilan balik, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildAdded akan dipicu sekali untuk setiap anak awal di lokasi ini, dan itu akan dipicu lagi setiap kali anak baru ditambahkan. DataSnapshot yang disahkan ke dalam panggilan balik akan mencerminkan data untuk anak yang relevan. Untuk tujuan pemesanan, disahkan argumen kedua yang merupakan string yang berisi kunci anak saudara kandung sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

onChildAdded(kueri, panggilan balik, pembatalanCallback, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildAdded akan dipicu sekali untuk setiap anak awal di lokasi ini, dan itu akan dipicu lagi setiap kali anak baru ditambahkan. DataSnapshot yang disahkan ke dalam panggilan balik akan mencerminkan data untuk anak yang relevan. Untuk tujuan pemesanan, disahkan argumen kedua yang merupakan string yang berisi kunci anak saudara kandung sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

OnchildChanged (kueri, panggilan balik, cancelcallback)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildChanged akan dipicu ketika data yang disimpan pada anak (atau salah satu keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed tunggal dapat mewakili banyak perubahan pada anak. DataSnapshot yang diteruskan ke panggilan balik akan berisi konten anak baru. Untuk tujuan pemesanan, panggilan balik juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak saudara kandung sebelumnya dengan urutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

Onchildchanged (kueri, panggilan balik, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildChanged akan dipicu ketika data yang disimpan pada anak (atau salah satu keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed tunggal dapat mewakili banyak perubahan pada anak. DataSnapshot yang diteruskan ke panggilan balik akan berisi konten anak baru. Untuk tujuan pemesanan, panggilan balik juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak saudara kandung sebelumnya dengan urutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

OnchildChanged (kueri, panggilan balik, cancelcallback, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildChanged akan dipicu ketika data yang disimpan pada anak (atau salah satu keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed tunggal dapat mewakili banyak perubahan pada anak. DataSnapshot yang diteruskan ke panggilan balik akan berisi konten anak baru. Untuk tujuan pemesanan, panggilan balik juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak saudara kandung sebelumnya dengan urutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

Onchildmoved (kueri, panggilan balik, cancelCallback)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Peristiwa onChildMoved akan dipicu ketika urutan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap perubahan saudara -saudaranya. DataSnapshot yang diteruskan ke panggilan balik akan untuk data anak yang telah pindah. Ini juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak -anak saudara sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

Onchildmoved (kueri, panggilan balik, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Peristiwa onChildMoved akan dipicu ketika urutan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap perubahan saudara -saudaranya. DataSnapshot yang diteruskan ke panggilan balik akan untuk data anak yang telah pindah. Ini juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak -anak saudara sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

onChildMoved(kueri, panggilan balik, pembatalanCallback, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Peristiwa onChildMoved akan dipicu ketika urutan pengurutan anak berubah sedemikian rupa sehingga posisinya relatif terhadap perubahan saudara -saudaranya. DataSnapshot yang diteruskan ke panggilan balik akan untuk data anak yang telah pindah. Ini juga disahkan argumen kedua yang merupakan string yang berisi kunci dari anak -anak saudara sebelumnya dengan urutan pengurutan, atau null jika itu adalah anak pertama.

Tanda tangan:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot , PriSterChildName: String | null) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

Onchildremoved (kueri, panggilan balik, cancelCallback)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildRemoved akan dipicu sekali setiap kali seorang anak dihapus. DataSnapshot yang disahkan ke dalam panggilan balik akan menjadi data lama untuk anak yang dihapus. Seorang anak akan dihapus saat keduanya:

  • Seorang klien secara eksplisit memanggil remove() pada anak itu atau salah satu leluhurnya - klien menelepon set(null) pada anak itu atau salah satu leluhurnya - anak itu telah dihapus semua anaknya - ada pertanyaan yang berlaku yang sekarang sedang menyaring Keluar dari anak (karena pesanan semacam itu berubah atau batas maksimal dipukul)

Tanda tangan:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

Onchildremoved (kueri, panggilan balik, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildRemoved akan dipicu sekali setiap kali seorang anak dihapus. DataSnapshot yang disahkan ke dalam panggilan balik akan menjadi data lama untuk anak yang dihapus. Seorang anak akan dihapus saat keduanya:

  • Seorang klien secara eksplisit memanggil remove() pada anak itu atau salah satu leluhurnya - klien menelepon set(null) pada anak itu atau salah satu leluhurnya - anak itu telah dihapus semua anaknya - ada pertanyaan yang berlaku yang sekarang sedang menyaring Keluar dari anak (karena pesanan semacam itu berubah atau batas maksimal dipukul)

Tanda tangan:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

onChildRemoved(kueri, panggilan balik, pembatalanCallback, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onChildRemoved akan dipicu sekali setiap kali seorang anak dihapus. DataSnapshot yang disahkan ke dalam panggilan balik akan menjadi data lama untuk anak yang dihapus. Seorang anak akan dihapus saat keduanya:

  • Seorang klien secara eksplisit memanggil remove() pada anak itu atau salah satu leluhurnya - klien menelepon set(null) pada anak itu atau salah satu leluhurnya - anak itu telah dihapus semua anaknya - ada pertanyaan yang berlaku yang sekarang sedang menyaring Keluar dari anak (karena pesanan semacam itu berubah atau batas maksimal dipukul)

Tanda tangan:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewatkan DataSnapShot dan string yang berisi kunci anak sebelumnya, dengan urutan pengurutan, atau null jika itu adalah anak pertama.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

OnValue (kueri, panggilan balik, cancelCallback)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onValue akan memicu sekali dengan data awal yang disimpan di lokasi ini, dan kemudian memicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke panggilan balik akan untuk lokasi di mana on() dipanggil. Ini tidak akan memicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, itu akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).

Tanda tangan:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewati DataSnapShot.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

onValue(kueri, panggilan balik, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onValue akan memicu sekali dengan data awal yang disimpan di lokasi ini, dan kemudian memicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke panggilan balik akan untuk lokasi di mana on() dipanggil. Ini tidak akan memicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, itu akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).

Tanda tangan:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewati DataSnapShot.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

OnValue (kueri, panggilan balik, cancelcallback, opsi)

Mendengarkan perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari database. Panggilan balik Anda akan dipicu untuk data awal dan sekali lagi setiap kali data berubah. Ajukan panggilan balik berhenti berlangganan yang dikembalikan untuk berhenti menerima pembaruan. Lihat Ambil Data di Web untuk lebih jelasnya.

Acara onValue akan memicu sekali dengan data awal yang disimpan di lokasi ini, dan kemudian memicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke panggilan balik akan untuk lokasi di mana on() dipanggil. Ini tidak akan memicu sampai seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, itu akan dipicu dengan DataSnapshot kosong ( val() akan mengembalikan null ).

Tanda tangan:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Kueri yang akan dijalankan.
panggilan balik (Snapshot: DataSnapshot ) => tidak diketahui Panggilan balik yang menembak ketika peristiwa yang ditentukan terjadi. Callback akan dilewati DataSnapShot.
BatalCallback (Kesalahan: kesalahan) => tidak diketahui Panggilan balik opsional yang akan diberitahu jika langganan acara Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau memiliki izin tetapi sekarang telah kehilangannya). Panggilan balik ini akan dilewati objek Error yang menunjukkan mengapa kegagalan terjadi.
pilihan Opsi Dengar Objek yang dapat digunakan untuk mengonfigurasi onlyOnce , yang kemudian menghapus pendengar setelah doa pertama.

Pengembalian:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pendengar.

kueri (kueri, queryconstraints)

Membuat contoh Query baru yang tidak dapat diubah yang diperluas juga untuk memasukkan kendala kueri tambahan.

Tanda tangan:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Parameter

Parameter Jenis Keterangan
pertanyaan Pertanyaan Instance kueri untuk digunakan sebagai basis untuk kendala baru.
queryconstraints Queryconstraint [] Daftar QueryConstraint s untuk diterapkan.

Pengembalian:

Pertanyaan

Pengecualian

Jika salah satu dari kendala kueri yang disediakan tidak dapat dikombinasikan dengan kendala yang ada atau baru.

fungsi (ref, ...)

OnDisconnect (Ref)

Mengembalikan Objek OnDisconnect - lihat Mengaktifkan kemampuan offline di JavaScript untuk informasi lebih lanjut tentang cara menggunakannya.

Tanda tangan:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data Referensi untuk menambahkan pemicu ondisconnect untuk.

Pengembalian:

Sedang Putus

hapus (Ref)

Menghapus data di lokasi basis data ini.

Data apa pun di lokasi anak juga akan dihapus.

Efek penghapusan akan segera terlihat dan 'nilai' peristiwa yang sesuai akan dipicu. Sinkronisasi hapus ke server firebase juga akan dimulai, dan janji yang dikembalikan akan diselesaikan ketika selesai. Jika disediakan, panggilan balik onComplete akan disebut secara tidak sinkron setelah sinkronisasi selesai.

Tanda tangan:

export declare function remove(ref: DatabaseReference): Promise<void>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data Lokasi untuk dihapus.

Pengembalian:

Janji<batal>

Menyelesaikan saat menghapus di server selesai.

Runtransaction (REF, TransactionUpdate, Opsi)

Secara atom memodifikasi data di lokasi ini.

Secara atom memodifikasi data di lokasi ini. Tidak seperti set() , yang hanya menimpa data terlepas dari nilai sebelumnya, runTransaction() digunakan untuk memodifikasi nilai yang ada ke nilai baru, memastikan tidak ada konflik dengan klien lain yang menulis ke lokasi yang sama pada waktu yang sama.

Untuk mencapai ini, Anda melewati runTransaction() fungsi pembaruan yang digunakan untuk mengubah nilai saat ini menjadi nilai baru. Jika klien lain menulis ke lokasi sebelum nilai baru Anda berhasil ditulis, fungsi pembaruan Anda akan dipanggil lagi dengan nilai saat ini yang baru, dan penulisan akan diceritakan kembali. Ini akan terjadi berulang kali sampai tulisan Anda berhasil tanpa konflik atau Anda membatalkan transaksi dengan tidak mengembalikan nilai dari fungsi pembaruan Anda.

Tanda tangan:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data Lokasi untuk memodifikasi secara atom.
TransactionUpdate (CurrentData: any) => tidak diketahui Fungsi yang disediakan pengembang yang akan dilewatkan data saat ini yang disimpan di lokasi ini (sebagai objek JavaScript). Fungsi harus mengembalikan nilai baru yang diinginkannya (sebagai objek JavaScript). Jika undefined dikembalikan (yaitu Anda kembali tanpa argumen) transaksi akan dibatalkan dan data di lokasi ini tidak akan dimodifikasi.
pilihan Opsi Transaksi Opsi Opsi untuk Mengkonfigurasi Transaksi.

Pengembalian:

Janji < TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

Tanda tangan:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data The location to write to.
nilai tidak dikenal The value to be written (string, number, boolean, object, array, or null).

Pengembalian:

Janji<batal>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Tanda tangan:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data The location to write to.
prioritas tali | nomor | batal The priority to be written (string, number, or null).

Pengembalian:

Janji<batal>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

Tanda tangan:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data The location to write to.
nilai tidak dikenal The value to be written (string, number, boolean, object, array, or null).
prioritas tali | nomor | batal The priority to be written (string, number, or null).

Pengembalian:

Janji<batal>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

Tanda tangan:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Parameter

Parameter Jenis Keterangan
referensi Referensi Basis Data The location to write to.
nilai-nilai obyek Object containing multiple values.

Pengembalian:

Janji<batal>

Resolves when update on server is complete.

fungsi(nilai, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

Tanda tangan:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
nilai nomor | tali | boolean | batal The value to end at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
kunci rangkaian The child key to end at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Pengembalian:

QueryConstraint

endBefore(nilai, kunci)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

Tanda tangan:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
nilai nomor | tali | boolean | batal The value to end before. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
kunci rangkaian The child key to end before, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Pengembalian:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

Tanda tangan:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
nilai nomor | tali | boolean | batal The value to match for. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
kunci rangkaian The child key to start at, among the children with the previously specified priority. This argument is only allowed if ordering by child, value, or priority.

Pengembalian:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

Tanda tangan:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
nilai nomor | tali | boolean | batal The value to start after. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
kunci rangkaian The child key to start after. This argument is only allowed if ordering by child, value, or priority.

Pengembalian:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

Tanda tangan:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Parameter

Parameter Jenis Keterangan
nilai nomor | tali | boolean | batal The value to start at. The argument type depends on which orderBy () function was used in this query. Specify a value that matches the orderBy () type. When used in combination with orderByKey() , the value must be a string.
kunci rangkaian The child key to start at. This argument is only allowed if ordering by child, value, or priority.

Pengembalian:

QueryConstraint

Tipe Peristiwa

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

Tanda tangan:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

Tanda tangan:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Berhenti berlangganan

A callback that can invoked to remove a listener.

Tanda tangan:

export declare type Unsubscribe = () => void;