database package

Firebase Realtime Database

Functions

Fungsi	Deskripsi
fungsi(aplikasi, ...)
getDatabase(aplikasi, url)	Menampilkan instance Realtime Database SDK yang terkait dengan FirebaseApp yang disediakan. Menginisialisasi instance baru dengan setelan default jika tidak ada instance atau jika instance yang ada menggunakan URL database kustom.
function(db, ...)
connectDatabaseEmulator(db, host, port, opsi)	Mengubah instance yang diberikan untuk berkomunikasi dengan emulator Realtime Database. Catatan: Metode ini harus dipanggil sebelum melakukan operasi lainnya.
goOffline(db)	Terputus dari server (semua operasi Database akan diselesaikan secara offline).Klien secara otomatis mempertahankan koneksi persisten ke server Database, yang akan tetap aktif tanpa batas waktu dan terhubung kembali ketika terputus. Namun, metode goOffline() dan goOnline() dapat digunakan untuk mengontrol koneksi klien jika koneksi persisten tidak diinginkan.Saat offline, klien tidak akan lagi menerima pembaruan data dari Database. Namun, semua operasi Database yang dijalankan secara lokal akan terus langsung mengaktifkan peristiwa, sehingga aplikasi Anda dapat terus berfungsi normal. Selain itu, setiap operasi yang dilakukan secara lokal akan otomatis dimasukkan ke dalam antrean dan dicoba lagi setelah server Database terhubung kembali.Untuk terhubung kembali ke Database dan mulai menerima peristiwa jarak jauh, lihat goOnline().
goOnline(db)	Menghubungkan 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 ketertinggalan" secara otomatis.
ref(db, path)	Menampilkan Reference yang mewakili lokasi di Database yang sesuai dengan jalur yang diberikan. Jika tidak ada jalur yang diberikan, Reference akan mengarah ke root Database.
refFromURL(db, url)	Menampilkan Reference yang mewakili lokasi di Database yang sesuai dengan URL Firebase yang diberikan.Pengecualian akan ditampilkan jika URL tersebut bukan URL Firebase Database yang valid atau memiliki domain yang berbeda dengan instance Database saat ini.Perhatikan bahwa semua parameter kueri (orderBy, limitToLast, dll.) akan diabaikan dan tidak diterapkan ke Reference yang ditampilkan.
function()
forceLongPolling()	Memaksa penggunaan longPolling, bukan websockets. Nilai ini akan diabaikan jika protokol websocket digunakan dalam databaseURL.
forceWebSockets()	Memaksa penggunaan websockets, bukan longPolling.
orderByKey()	Membuat QueryConstraint baru yang mengurutkan berdasarkan kunci.Mengurutkan hasil kueri berdasarkan nilai kuncinya (menaik).Anda dapat membaca selengkapnya tentang orderByKey() di Urutkan data.
orderByPriority()	Membuat QueryConstraint baru yang mengurutkan berdasarkan prioritas.Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Mengurutkan data untuk alternatif yang diprioritaskan.
orderByValue()	Membuat QueryConstraint baru yang mengurutkan berdasarkan nilai.Jika turunan kueri adalah semua nilai skalar (string, angka, atau boolean), Anda dapat mengurutkan hasilnya menurut nilainya (menaik).Anda dapat membaca selengkapnya tentang orderByValue() di Urutkan data.
serverTimestamp()	Menampilkan nilai placeholder untuk mengisi otomatis stempel waktu saat ini (waktu sejak Unix epoch, dalam milidetik) seperti yang ditentukan oleh server Firebase.
fungsi(delta, ...)
kenaikan(delta)	Menampilkan nilai placeholder yang dapat digunakan untuk menambah nilai database saat ini secara atomik dengan delta yang diberikan.
fungsi(diaktifkan, ...)
enableLogging(aktif, persisten)	Mencatat informasi proses debug ke konsol.
fungsi(batas, ...)
limitToFirst(batas)	Membuat QueryConstraint baru yang jika dibatasi pada jumlah turunan tertentu yang pertama.Metode limitToFirst() digunakan untuk menetapkan jumlah maksimum turunan yang akan disinkronkan untuk callback tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added. Jika kita memiliki kurang dari 100 pesan yang tersimpan di Database, peristiwa child_added akan diaktifkan untuk setiap pesan. Namun, jika ada lebih dari 100 pesan, kita hanya akan menerima peristiwa child_added untuk 100 pesan pertama yang diurutkan. Saat item berubah, kami akan menerima peristiwa child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah totalnya tetap 100.Anda dapat membaca selengkapnya tentang limitToFirst() di Memfilter data.
limitToLast(batas)	Membuat QueryConstraint baru yang dibatasi untuk hanya menampilkan jumlah turunan terakhir yang ditentukan.Metode limitToLast() digunakan untuk menetapkan jumlah turunan maksimum yang akan disinkronkan untuk callback tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added. Jika kita memiliki kurang dari 100 pesan yang tersimpan di Database, peristiwa child_added akan diaktifkan untuk setiap pesan. Namun, jika ada lebih dari 100 pesan, kita hanya akan menerima peristiwa child_added untuk 100 pesan terakhir yang diurutkan. Saat item berubah, kami akan menerima peristiwa 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(logger, ...)
enableLogging(logger)	Mencatat informasi proses debug ke konsol.
fungsi(induk, ...)
turunan(induk, jalur)	Mendapatkan Reference untuk lokasi di jalur relatif yang ditentukan.Jalur relatif dapat berupa nama turunan sederhana (misalnya, "ada") atau jalur yang dipisahkan garis miring yang lebih dalam (misalnya, "ada/name/first").
push(induk, nilai)	Menghasilkan lokasi turunan baru menggunakan kunci unik dan menampilkan Reference-nya.Ini adalah pola yang paling umum untuk menambahkan data ke koleksi item.Jika Anda memberikan nilai ke push(), nilai akan ditulis ke lokasi yang dihasilkan. Jika Anda tidak meneruskan nilai, tidak ada yang akan ditulis ke database dan turunannya akan 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. Kunci ini juga dirancang agar tidak dapat ditebak (berisi 72 bit acak entropi).Lihat Menambahkan ke daftar data. Lihat 2^120 Cara untuk Memastikan ID Unik.
function(jalur, ...)
orderByChild(jalur)	Membuat QueryConstraint baru yang mengurutkan berdasarkan kunci turunan yang ditentukan.Kueri hanya bisa mengurutkan berdasarkan satu kunci pada satu waktu. Memanggil orderByChild() beberapa kali pada kueri yang sama merupakan sebuah error.Kueri Firebase memungkinkan Anda mengurutkan data berdasarkan kunci turunan dengan cepat. Namun, jika sudah mengetahui akan seperti apa indeksnya, Anda dapat menentukannya melalui aturan .indexOn dalam Aturan Keamanan untuk performa yang lebih baik. Lihat aturan https://firebase.google.com/docs/database/security/indexing-data untuk mengetahui informasi selengkapnya.Anda dapat membaca orderByChild() selengkapnya di Mengurutkan data.
fungsi(kueri, ...)
get(query)	Mendapatkan hasil terbaru untuk kueri ini.
off(kueri, eventType, callback)	Melepaskan callback yang sebelumnya dikaitkan dengan pemroses on() (onValue, onChildAdded) yang sesuai. Catatan: Ini bukan cara yang direkomendasikan untuk menghapus pemroses. Sebagai gantinya, gunakan fungsi callback yang ditampilkan dari callback on masing-masing.Lepaskan callback yang sebelumnya dilampirkan dengan on*(). Memanggil off() pada pemroses induk tidak akan otomatis menghapus pemroses yang terdaftar pada node turunan, off() juga harus dipanggil pada pemroses turunan mana pun untuk menghapus callback.Jika callback tidak ditetapkan, semua callback untuk eventType yang ditentukan akan dihapus. Demikian pula, jika tidak ada eventType yang ditentukan, semua callback untuk Reference akan dihapus.Pemroses individual juga dapat dihapus dengan memanggil callback berhenti berlangganan.
onChildAdded(kueri, callback, cancelCallback)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildAdded(kueri, callback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildAdded(kueri, callback, cancelCallback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildChanges(kueri, callback, cancelCallback)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildChanges(kueri, callback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildChanges(kueri, callback, cancelCallback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau turunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildMove(kueri, callback, cancelCallback)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildMove(kueri, callback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildMove(kueri, callback, cancelCallback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.
onChildRemoved(kueri, callback, cancelCallback)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildRemoved akan dipicu sekali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Turunan akan dihapus jika:- klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestornya - semua turunan tersebut telah dihapus - ada kueri yang berlaku, yang sekarang memfilter turunan (karena tata urutannya diubah atau batas maksimum tercapai)
onChildRemoved(kueri, callback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildRemoved akan dipicu sekali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Turunan akan dihapus jika:- klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestornya - semua turunan tersebut telah dihapus - ada kueri yang berlaku, yang sekarang memfilter turunan (karena tata urutannya diubah atau batas maksimum tercapai)
onChildRemoved(kueri, callback, cancelCallback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onChildRemoved akan dipicu sekali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Turunan akan dihapus jika:- klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestornya - semua turunan tersebut telah dihapus - ada kueri yang berlaku, yang sekarang memfilter turunan (karena tata urutannya diubah atau batas maksimum tercapai)
onValue(kueri, callback, cancelCallback)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onValue akan dipicu sekali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).
onValue(kueri, callback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onValue akan dipicu sekali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).
onValue(kueri, callback, cancelCallback, opsi)	Memproses perubahan data di lokasi tertentu.Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.Peristiwa onValue akan dipicu sekali dengan data awal yang disimpan di lokasi ini, lalu terpicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).
query(query, queryConstraints)	Membuat instance Query baru yang tidak dapat diubah dan diperluas agar juga menyertakan batasan kueri tambahan.
fungsi(ref, ...)
onPutuskan koneksi(ref)	Menampilkan objek OnDisconnect - lihat Mengaktifkan Kemampuan Offline di JavaScript untuk mengetahui informasi selengkapnya tentang cara menggunakannya.
remove(ref)	Menghapus data di lokasi Database ini.Data apa pun di lokasi turunan juga akan dihapus.Efek penghapusan akan segera terlihat dan peristiwa yang sesuai 'value' akan dipicu. Sinkronisasi penghapusan ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan diselesaikan setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai.
runTransaction(ref, transaksiUpdate, opsi)	Memodifikasi data di lokasi ini secara atomik.Modifikasi data di lokasi ini secara atomik. Tidak seperti set() normal, yang hanya menimpa data terlepas dari nilai sebelumnya, runTransaction() digunakan untuk mengubah nilai yang ada ke nilai baru, sehingga memastikan tidak ada konflik dengan klien lain yang menulis ke lokasi yang sama secara bersamaan.Untuk melakukannya, Anda meneruskan fungsi pembaruan ke runTransaction() yang digunakan untuk mengubah nilai saat ini menjadi nilai baru. Jika klien lain melakukan operasi tulis ke lokasi ini sebelum nilai baru Anda berhasil ditulis, fungsi pembaruan Anda akan dipanggil lagi dengan nilai saat ini yang baru, dan operasi tulis tersebut akan dicoba ulang. Hal ini akan terjadi berulang kali sampai penulisan Anda berhasil tanpa konflik atau Anda membatalkan transaksi dengan tidak menampilkan nilai dari fungsi pembaruan.Catatan: Mengubah data dengan set() akan membatalkan semua transaksi yang tertunda di lokasi tersebut, sehingga Anda harus sangat berhati-hati jika menggabungkan set() dan runTransaction() untuk memperbarui data yang sama.Catatan: Saat menggunakan transaksi dengan Aturan Keamanan dan Aturan Firebase, perhatikan bahwa klien memerlukan akses .read selain akses .write agar dapat melakukan transaksi. 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 yang sesuai ("value", "child_added", dll.) akan dipicu. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan di-resolve 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 dimaksudkan untuk dipertahankan, Anda harus menggunakan setWithPriority().Perhatikan bahwa mengubah data dengan set() akan membatalkan setiap transaksi yang tertunda di lokasi tersebut, sehingga Anda harus sangat berhati-hati jika menggabungkan set() dan transaction() untuk mengubah data yang sama.Satu set() akan menghasilkan satu "nilai" peristiwa di lokasi tempat set() dijalankan.
setPriority(ref, prioritas)	Menetapkan prioritas untuk data di lokasi Database ini.Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan kumpulan berdasarkan properti biasa (lihat Mengurutkan dan memfilter data).
setWithPriority(ref, nilai, prioritas)	Menulis data di lokasi Database. Seperti set(), tetapi juga menentukan prioritas untuk data tersebut.Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Mengurutkan dan memfilter data ).
update(ref, nilai)	Menulis beberapa nilai ke Database sekaligus.Argumen values berisi beberapa pasangan nilai properti yang akan ditulis ke Database bersama-sama. Tiap properti turunan dapat berupa properti sederhana (misalnya, "name") atau jalur relatif (misalnya, "name/first") dari lokasi saat ini ke data yang akan diperbarui.Berbeda dengan metode set(), update() dapat digunakan untuk mengupdate secara selektif hanya properti yang direferensikan di lokasi saat ini (bukan mengganti semua properti turunan di lokasi saat ini).Efek penulisan akan segera terlihat, dan peristiwa terkait ('value', child.) akan dipicu secara selektif, dan lainnya. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan di-resolve setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai.Satu update() akan menghasilkan satu "nilai" di lokasi tempat update() dilakukan, terlepas dari jumlah turunan yang diubah.Perhatikan bahwa mengubah data dengan update() akan membatalkan semua transaksi yang tertunda di lokasi tersebut, sehingga Anda harus 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 arbitrer untuk kueri.Titik akhir bersifat inklusif, sehingga turunan dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditentukan, turunan yang memiliki nilai yang ditentukan juga harus memiliki nama kunci yang kurang dari atau sama dengan kunci yang ditentukan.Anda dapat membaca endAt() selengkapnya di bagian Memfilter data.
endBefore(nilai, kunci)	Membuat QueryConstraint dengan titik akhir yang ditentukan (eksklusif).Penggunaan startAt(), startAfter(), endBefore(), endAt(), dan equalTo() memungkinkan Anda memilih titik awal dan akhir arbitrer untuk kueri.Titik akhir bersifat eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai yang lebih kecil dari nilai yang ditentukan akan disertakan dalam kueri. Jika kunci ditentukan, turunan harus memiliki nilai yang lebih kecil dari atau sama dengan nilai yang ditentukan dan nama kunci 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 arbitrer untuk kueri.Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditetapkan, turunan yang memiliki nilai yang ditentukan secara persis 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).Penggunaan startAt(), startAfter(), endBefore(), endAt(), dan equalTo() memungkinkan Anda memilih titik awal dan akhir arbitrer untuk kueri.Titik awalnya bersifat eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai yang lebih besar dari nilai yang ditentukan akan disertakan dalam kueri. Jika kunci ditentukan, maka turunan harus memiliki nilai yang lebih besar dari 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 arbitrer untuk kueri.Titik awalnya bersifat inklusif, sehingga turunan dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditentukan, turunan yang memiliki nilai yang ditentukan juga harus memiliki nama kunci yang lebih besar dari atau sama dengan kunci yang ditentukan.Anda dapat membaca startAt() selengkapnya di bagian Memfilter data.

Kelas

Class	Deskripsi
Database	Class yang mewakili Firebase Realtime Database.
DataSnapshot	DataSnapshot berisi data dari sebuah 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(). Atau, Anda dapat melintas ke dalam snapshot dengan memanggil child() untuk menampilkan snapshot turunan (yang kemudian dapat Anda panggil val()).DataSnapshot adalah salinan data yang dibuat secara efisien dan tidak dapat diubah di lokasi Database. Metode tidak dapat diubah dan tidak akan pernah berubah (untuk mengubah data, Anda selalu memanggil metode set() di Reference secara langsung).
OnPutuskan Koneksi	Class onDisconnect memungkinkan Anda menulis atau menghapus data saat klien Anda memutuskan koneksi dari server Database. Update ini akan terjadi, terlepas dari apakah klien Anda memutuskan koneksi secara bersih atau tidak, sehingga Anda dapat mengandalkan update ini untuk membersihkan data meskipun koneksi terputus atau klien mengalami error.Class onDisconnect paling sering digunakan untuk mengelola kehadiran di aplikasi yang berguna untuk mendeteksi berapa banyak klien yang terhubung dan saat klien lain memutuskan koneksi. Lihat Mengaktifkan Kemampuan Offline di JavaScript untuk mengetahui informasi selengkapnya.Untuk menghindari masalah saat koneksi terputus sebelum permintaan dapat ditransfer ke server Database, fungsi ini harus dipanggil sebelum menulis data apa pun.Perhatikan bahwa operasi onDisconnect hanya dipicu satu kali. Jika ingin operasi terjadi setiap kali terjadi pemutusan koneksi, Anda harus membuat kembali operasi onDisconnect setiap kali Anda terhubung kembali.
QueryConstraint	QueryConstraint digunakan untuk mempersempit kumpulan dokumen yang ditampilkan oleh kueri Database. QueryConstraintQueryConstraint
TransactionResult	Jenis untuk nilai penyelesaian runTransaction().

Antarmuka

Antarmuka	Deskripsi
DatabaseReference	DatabaseReference mewakili lokasi tertentu dalam Database Anda dan dapat digunakan untuk membaca atau menulis data ke lokasi Database tersebut.Anda dapat mereferensikan lokasi root atau turunan di Database 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
IteratedDataSnapshot	Merepresentasikan snapshot turunan dari Reference yang sedang diiterasi. Kunci tidak akan pernah ditentukan.
ListenOptions	Objek opsi yang dapat digunakan untuk menyesuaikan pemroses.
Kueri	Query mengurutkan dan memfilter data di lokasi Database sehingga hanya sebagian data turunan yang disertakan. Ini bisa digunakan untuk mengurutkan kumpulan data berdasarkan beberapa atribut (misalnya, tinggi dinosaurus) serta untuk membatasi daftar item yang besar (misalnya, pesan chat) hingga ke angka yang cocok untuk disinkronkan ke klien. Kueri dibuat dengan merangkai satu atau beberapa metode filter yang ditentukan di sini.Sama seperti DatabaseReference, Anda dapat menerima data dari Query 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 mengetahui informasi selengkapnya.
KemudianableReference	Promise yang juga dapat bertindak sebagai DatabaseReference saat ditampilkan oleh push(). Referensi akan segera tersedia dan Promise akan di-resolve saat penulisan ke backend selesai.
TransactionOptions	Objek opsi untuk mengonfigurasi transaksi.

Ketik Alias

Ketik Alias	Deskripsi
EventType	Salah satu string berikut: "value", "child_added", "child_changed", "child_removed", atau "child_moved".
QueryConstraintType	Menjelaskan berbagai batasan kueri yang tersedia di SDK ini.
Berhenti berlangganan	Callback yang dapat dipanggil untuk menghapus pemroses.

function(aplikasi, ...)

getDatabase(aplikasi, url)

Menampilkan instance Realtime Database SDK yang terkait dengan FirebaseApp yang disediakan. Menginisialisasi instance baru dengan setelan 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	Deskripsi
aplikasi	AplikasiFirebase	Instance FirebaseApp yang dikaitkan dengan instance Realtime Database yang ditampilkan.
url	string	URL instance Realtime Database yang akan dihubungkan. Jika tidak diberikan, SDK akan terhubung ke instance default Aplikasi Firebase.

Hasil:

Database

Instance Database dari aplikasi yang disediakan.

function(db, ...)

connectDatabaseEmulator(db, host, port, opsi)

Mengubah instance yang diberikan 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	Deskripsi
db	Database	Instance yang akan diubah.
host	string	Host emulator (misalnya: localhost)
port	angka	Port emulator (mis.: 8080)
opsi	{ mockUserToken?: EmulatorMockTokenOptions | {i>string<i}; }

Hasil:

void

goOffline(db)

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

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

Saat offline, klien tidak akan lagi menerima pembaruan data dari Database. Namun, semua operasi Database yang dijalankan secara lokal akan terus langsung mengaktifkan peristiwa, sehingga aplikasi Anda dapat terus berfungsi normal. Selain itu, setiap operasi yang dilakukan secara lokal akan secara otomatis diantrekan dan dicoba lagi setelah koneksi kembali ke server Database.

Untuk terhubung kembali ke Database dan mulai menerima peristiwa jarak jauh, lihat goOnline().

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
db	Database	Instance yang akan diputus hubungannya.

Hasil:

void

goOnline(db)

Menghubungkan 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 ketertinggalan" secara otomatis.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
db	Database	Instance yang akan dihubungkan kembali.

Hasil:

void

ref(db, path)

Menampilkan Reference yang mewakili lokasi di Database yang sesuai dengan jalur yang diberikan. Jika tidak ada jalur yang diberikan, Reference akan mengarah ke root Database.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
db	Database	Instance database untuk mendapatkan referensi.
jalur	string	Jalur opsional yang mewakili lokasi yang akan ditunjuk Reference Jika tidak diberikan, Reference yang ditampilkan akan mengarah ke root Database.

Hasil:

DatabaseReference

Jika jalur diberikan, Reference yang mengarah ke jalur yang disediakan. Jika tidak, Reference akan mengarah ke root Database.

refFromURL(db, url)

Menampilkan Reference yang mewakili lokasi di Database yang sesuai dengan URL Firebase yang diberikan.

Pengecualian akan ditampilkan jika URL tersebut bukan URL Firebase Database yang valid atau memiliki domain yang berbeda dengan instance Database saat ini.

Perhatikan bahwa semua parameter kueri (orderBy, limitToLast, dll.) diabaikan dan tidak diterapkan ke Reference yang ditampilkan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
db	Database	Instance database untuk mendapatkan referensi.
url	string	URL Firebase tempat Reference yang ditampilkan akan diarahkan.

Hasil:

DatabaseReference

Reference yang mengarah ke URL Firebase yang diberikan.

function()

forceLongPolling()

Memaksa penggunaan longPolling, bukan websockets. Nilai ini akan diabaikan jika protokol websocket digunakan dalam databaseURL.

Tanda Tangan:

export declare function forceLongPolling(): void;

Hasil:

void

forceWebSockets()

Memaksa penggunaan websockets, bukan longPolling.

Tanda Tangan:

export declare function forceWebSockets(): void;

Hasil:

void

orderByKey()

Membuat QueryConstraint baru yang mengurutkan berdasarkan kunci.

Mengurutkan hasil kueri berdasarkan nilai kunci (menaik).

Anda dapat membaca selengkapnya tentang orderByKey() di Mengurutkan data.

Tanda Tangan:

export declare function orderByKey(): QueryConstraint;

Hasil:

QueryConstraint

orderByPriority()

Membuat QueryConstraint baru yang mengurutkan berdasarkan prioritas.

Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan kumpulan berdasarkan properti biasa (lihat Mengurutkan data untuk alternatif prioritas.

Tanda Tangan:

export declare function orderByPriority(): QueryConstraint;

Hasil:

QueryConstraint

orderByValue()

Membuat QueryConstraint baru yang mengurutkan berdasarkan nilai.

Jika turunan kueri adalah semua nilai skalar (string, angka, atau boolean), Anda dapat mengurutkan hasilnya dengan nilai (menaik).

Anda dapat membaca selengkapnya tentang orderByValue() di Mengurutkan data.

Tanda Tangan:

export declare function orderByValue(): QueryConstraint;

Hasil:

QueryConstraint

serverTimestamp()

Menampilkan nilai placeholder untuk mengisi otomatis stempel waktu saat ini (waktu sejak Unix epoch, dalam milidetik) seperti yang ditentukan oleh server Firebase.

Tanda Tangan:

export declare function serverTimestamp(): object;

Hasil:

objek

fungsi(delta, ...)

penambahan(delta)

Menampilkan nilai placeholder yang dapat digunakan untuk menambah nilai database saat ini secara atomik dengan delta yang diberikan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
Delta	angka	jumlah untuk mengubah nilai saat ini secara atomik.

Hasil:

objek

Nilai placeholder untuk mengubah data sisi server secara atomik.

fungsi(diaktifkan, ...)

enableLogging(aktif, persisten)

Mencatat informasi proses debug ke konsol.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
diaktifkan	boolean	Mengaktifkan logging jika true, menonaktifkan logging jika false.
persisten	boolean	Mengingat status logging di antara pemuatan ulang halaman jika true.

Hasil:

apa pun

function(limit, ...)

limitToFirst(batas)

Membuat QueryConstraint baru yang, jika dibatasi pada jumlah turunan spesifik pertama.

Metode limitToFirst() digunakan untuk menetapkan jumlah turunan maksimum yang akan disinkronkan untuk callback tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added. Jika kita memiliki kurang dari 100 pesan yang tersimpan di Database, peristiwa child_added akan diaktifkan untuk setiap pesan. Namun, jika ada lebih dari 100 pesan, kita hanya akan menerima peristiwa child_added untuk 100 pesan pertama yang diurutkan. Saat item berubah, kami akan menerima peristiwa child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah totalnya tetap 100.

Anda dapat membaca selengkapnya tentang limitToFirst() di Memfilter data.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
batas	angka	Jumlah maksimum node yang akan disertakan dalam kueri ini.

Hasil:

QueryConstraint

limitToLast(batas)

Membuat QueryConstraint baru yang dibatasi untuk hanya menampilkan jumlah turunan terakhir yang ditentukan.

Metode limitToLast() digunakan untuk menetapkan jumlah turunan maksimum yang akan disinkronkan untuk callback tertentu. Jika kami menetapkan batas 100, pada awalnya kami hanya akan menerima hingga 100 peristiwa child_added. Jika kita memiliki kurang dari 100 pesan yang tersimpan di Database, peristiwa child_added akan diaktifkan untuk setiap pesan. Namun, jika ada lebih dari 100 pesan, kita hanya akan menerima peristiwa child_added untuk 100 pesan terakhir yang diurutkan. Saat item berubah, kami akan menerima peristiwa child_removed untuk setiap item yang keluar dari daftar aktif sehingga jumlah totalnya tetap 100.

Anda dapat membaca selengkapnya tentang limitToLast() di Memfilter data.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
batas	angka	Jumlah maksimum node yang akan disertakan dalam kueri ini.

Hasil:

QueryConstraint

function(logger, ...)

enableLogging(logger)

Mencatat informasi proses debug ke konsol.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
pencatat log	(pesan: string) => tidak dikenal	Fungsi pencatat log khusus untuk mengontrol bagaimana sesuatu dicatat.

Hasil:

apa pun

function(induk, ...)

turunan(induk, jalur)

Mendapatkan Reference untuk lokasi di jalur relatif yang ditentukan.

Jalur relatif dapat berupa nama turunan sederhana (misalnya, "ada") atau jalur yang dipisahkan garis miring yang lebih dalam (misalnya, "ada/name/first").

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
orang tua	DatabaseReference	Lokasi induk.
jalur	string	Jalur relatif dari lokasi ini ke lokasi turunan yang diinginkan.

Hasil:

DatabaseReference

Lokasi turunan yang telah ditentukan.

push(induk, nilai)

Membuat lokasi turunan baru menggunakan kunci unik dan menampilkan Reference-nya.

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

Jika Anda memberikan nilai ke push(), nilai tersebut akan ditulis ke lokasi yang dihasilkan. Jika Anda tidak meneruskan nilai, tidak ada yang akan ditulis ke database dan turunannya akan tetap kosong (tetapi Anda dapat menggunakan Reference di tempat lain).

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

Lihat Menambahkan ke daftar data. Lihat 2^120 Cara untuk Memastikan ID Unik.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
orang tua	DatabaseReference	Lokasi induk.
value	tidak diketahui	Nilai opsional yang akan ditulis di lokasi yang dibuat.

Hasil:

KemudianableReference

Menggabungkan Promise dan Reference; me-resolve saat operasi tulis selesai, tetapi dapat langsung digunakan sebagai Reference untuk lokasi turunan.

function(jalur, ...)

orderByChild(jalur)

Membuat QueryConstraint baru yang mengurutkan berdasarkan kunci turunan yang ditentukan.

Kueri hanya bisa menerapkan pengurutan dengan satu kunci pada satu waktu. Memanggil orderByChild() beberapa kali pada kueri yang sama merupakan error.

Kueri Firebase memungkinkan Anda mengurutkan data berdasarkan kunci turunan dengan cepat. Namun, jika sudah mengetahui akan seperti apa indeksnya, Anda dapat menentukannya melalui aturan .indexOn dalam Aturan Keamanan untuk performa yang lebih baik. Lihat aturan https://firebase.google.com/docs/database/security/indexing-data untuk mengetahui informasi selengkapnya.

Anda dapat membaca selengkapnya tentang orderByChild() di Mengurutkan data.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
jalur	string	Jalur yang akan diurutkan.

Hasil:

QueryConstraint

function(query, ...)

get(kueri)

Mendapatkan hasil terbaru untuk kueri ini.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.

Hasil:

Promise<DataSnapshot>

Promise yang me-resolve ke DataSnapshot yang dihasilkan jika nilai tersedia, atau menolak jika klien tidak dapat menampilkan nilai (mis., jika server tidak dapat dijangkau dan tidak ada yang disimpan dalam cache).

off(query, eventType, callback)

Melepaskan callback yang sebelumnya dilampirkan dengan pemroses on*() (onValue, onChildAdded) yang sesuai. Catatan: Ini bukan cara yang direkomendasikan untuk menghapus pemroses. Sebagai gantinya, gunakan fungsi callback yang ditampilkan dari callback on* masing-masing.

Lepaskan callback yang sebelumnya dikaitkan dengan on*(). Memanggil off() pada pemroses induk tidak akan otomatis menghapus pemroses yang terdaftar pada node turunan, off() juga harus dipanggil pada pemroses turunan mana pun untuk menghapus callback.

Jika callback tidak ditentukan, semua callback untuk eventType yang ditentukan akan dihapus. Demikian pula, jika tidak ada eventType yang ditentukan, semua callback untuk Reference akan dihapus.

Setiap pemroses juga dapat dihapus dengan memanggil callback berhenti berlangganan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang didaftarkan dengan pemroses.
eventType	EventType	Salah satu string berikut: "value", "child_added", "child_changed", "child_removed", atau "child_moved". Jika dihilangkan, semua callback untuk Reference akan dihapus.
callback	(snapshot: DataSnapshot, previousChildName?: string | null) => tidak dikenal	Fungsi callback yang diteruskan ke on() atau undefined untuk menghapus semua callback.

Hasil:

void

onChildAdded(kueri, callback, cancelCallback)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName?: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildAdded(kueri, callback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildAdded(kueri, callback, cancelCallback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildAdded akan dipicu satu kali untuk setiap turunan awal di lokasi ini, dan akan dipicu lagi setiap kali ada turunan baru yang ditambahkan. DataSnapshot yang diteruskan ke callback akan mencerminkan data untuk turunan yang relevan. Untuk tujuan pengurutan, argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan 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	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildChanges(kueri, callback, cancelCallback)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildChanges(kueri, callback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildChanges(kueri, callback, cancelCallback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildChanged akan dipicu saat data yang disimpan di turunan (atau keturunannya) berubah. Perhatikan bahwa satu peristiwa child_changed dapat mewakili beberapa perubahan pada turunan. DataSnapshot yang diteruskan ke callback akan berisi konten turunan baru. Untuk tujuan pengurutan, callback juga mendapatkan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan 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	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildMove(kueri, callback, cancelCallback)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildMove(kueri, callback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan pertama.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildMove(kueri, callback, cancelCallback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildMoved akan dipicu saat tata urutan turunan berubah sehingga posisinya relatif terhadap kerabatnya berubah. DataSnapshot yang diteruskan ke callback akan ditujukan untuk data turunan yang telah dipindahkan. Contoh ini juga meneruskan argumen kedua yang merupakan string yang berisi kunci dari turunan seinduk sebelumnya berdasarkan tata urutan, atau null jika merupakan turunan 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	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot, previousChildName: string | null) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildRemoved(kueri, callback, cancelCallback)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildRemoved akan dipicu satu kali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Anak akan dihapus jika:

• klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestor-nya - semua turunan tersebut telah dihapus - ada kueri yang sekarang memfilter turunan tersebut (karena tata urutannya berubah atau batas maksimum tercapai)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildRemoved(kueri, callback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildRemoved akan dipicu satu kali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Anak akan dihapus jika:

• klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestor-nya - semua turunan tersebut telah dihapus - ada kueri yang sekarang memfilter turunan tersebut (karena tata urutannya berubah atau batas maksimum tercapai)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onChildRemoved(kueri, callback, cancelCallback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onChildRemoved akan dipicu satu kali setiap kali turunan dihapus. DataSnapshot yang diteruskan ke callback akan menjadi data lama untuk turunan yang telah dihapus. Anak akan dihapus jika:

• klien secara eksplisit memanggil remove() pada turunan tersebut atau salah satu ancestor-nya - klien memanggil set(null) pada turunan tersebut atau salah satu ancestor-nya - semua turunan tersebut telah dihapus - ada kueri yang sekarang memfilter turunan tersebut (karena tata urutannya berubah atau batas maksimum tercapai)

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan menerima DataSnapshot dan string yang berisi kunci dari turunan sebelumnya, berdasarkan tata urutan, atau null jika merupakan turunan pertama.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onValue(kueri, callback, cancelCallback)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onValue akan dipicu satu kali dengan data awal disimpan di lokasi ini, lalu dipicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan diberi DataSnapshot.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onValue(kueri, callback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onValue akan dipicu satu kali dengan data awal disimpan di lokasi ini, lalu dipicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan diberi DataSnapshot.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

onValue(kueri, callback, cancelCallback, opsi)

Memproses perubahan data di lokasi tertentu.

Ini adalah cara utama untuk membaca data dari Database. Callback Anda akan terpicu untuk data awal dan terpicu lagi setiap kali data berubah. Panggil callback berhenti berlangganan yang ditampilkan untuk berhenti menerima update. Lihat Mengambil Data di Web untuk mengetahui detail selengkapnya.

Peristiwa onValue akan dipicu satu kali dengan data awal disimpan di lokasi ini, lalu dipicu lagi setiap kali data berubah. DataSnapshot yang diteruskan ke callback akan menjadi lokasi pemanggilan on(). Tindakan ini tidak akan dipicu hingga seluruh konten telah disinkronkan. Jika lokasi tidak memiliki data, lokasi akan dipicu dengan DataSnapshot kosong (val() akan menampilkan null).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Kueri yang akan dijalankan.
callback	(snapshot: DataSnapshot) => tidak dikenal	Callback yang diaktifkan saat peristiwa yang ditentukan terjadi. Callback akan diberi DataSnapshot.
cancelCallback	(error: Error) => tidak dikenal	Callback opsional yang akan diberi tahu jika langganan peristiwa Anda pernah dibatalkan karena klien Anda tidak memiliki izin untuk membaca data ini (atau klien memiliki izin, tetapi sekarang telah kehilangan izinnya). Callback ini akan diberi objek Error yang menunjukkan penyebab terjadinya kegagalan.
opsi	ListenOptions	Objek yang dapat digunakan untuk mengonfigurasi onlyOnce, yang kemudian akan menghapus pemroses setelah pemanggilan pertamanya.

Hasil:

Berhenti berlangganan

Fungsi yang dapat dipanggil untuk menghapus pemroses.

query(query, queryConstraints)

Membuat instance Query baru yang tidak dapat diubah dan diperluas agar juga menyertakan batasan kueri tambahan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
kueri	Kueri	Instance Query yang akan digunakan sebagai dasar untuk batasan baru.
queryConstraints	QueryConstraint[]	Daftar QueryConstraint yang akan diterapkan.

Hasil:

Kueri

Pengecualian

jika salah satu batasan kueri yang diberikan tidak dapat digabungkan dengan batasan yang ada atau baru.

function(ref, ...)

onPutuskan koneksi(ref)

Menampilkan objek OnDisconnect - lihat Mengaktifkan Kemampuan Offline di JavaScript untuk mengetahui informasi selengkapnya tentang cara menggunakannya.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Referensi untuk menambahkan pemicu OnPutuskan koneksi.

Hasil:

OnPutuskan Koneksi

hapus(ref)

Menghapus data di lokasi Database ini.

Semua data di lokasi turunan juga akan dihapus.

Efek penghapusan akan segera terlihat dan 'value' peristiwa yang sesuai akan dipicu. Sinkronisasi penghapusan ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan diselesaikan setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi yang akan dihapus.

Hasil:

Janji<void>

Menyelesaikan masalah penghapusan di server.

runTransaction(ref, transaksiUpdate, opsi)

Memodifikasi data di lokasi ini secara atomik.

Mengubah data secara atomik di lokasi ini. Tidak seperti set() biasa, yang hanya menimpa data terlepas dari nilai sebelumnya, runTransaction() digunakan untuk mengubah nilai yang ada ke nilai baru, sehingga memastikan tidak ada konflik dengan klien lain yang menulis ke lokasi yang sama secara bersamaan.

Untuk melakukannya, Anda meneruskan fungsi pembaruan ke runTransaction() yang digunakan untuk mengubah nilai saat ini menjadi nilai baru. Jika klien lain melakukan operasi tulis ke lokasi ini sebelum nilai baru Anda berhasil ditulis, fungsi pembaruan Anda akan dipanggil lagi dengan nilai saat ini yang baru, dan operasi tulis tersebut akan dicoba ulang. Hal ini akan terjadi berulang kali sampai penulisan Anda berhasil tanpa konflik atau Anda membatalkan transaksi dengan tidak menampilkan nilai dari fungsi pembaruan.

Catatan: Mengubah data dengan set() akan membatalkan setiap transaksi yang tertunda di lokasi tersebut, sehingga Anda harus sangat berhati-hati jika menggabungkan set() dan runTransaction() untuk memperbarui data yang sama.

Catatan: Saat menggunakan transaksi dengan Aturan Keamanan dan Firebase, perhatikan bahwa klien memerlukan akses .read selain akses .write untuk melakukan transaksi. Hal ini karena sifat transaksi sisi klien mengharuskan klien membaca data agar dapat memperbaruinya secara transaksional.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi yang akan diubah secara atomik.
transaksiUpdate	(currentData: setiap) => tidak dikenal	Fungsi yang disediakan developer yang akan menerima data saat ini yang disimpan di lokasi ini (sebagai objek JavaScript). Fungsi ini akan menampilkan nilai baru yang ingin ditulis (sebagai objek JavaScript). Jika undefined ditampilkan (yaitu Anda kembali tanpa argumen), transaksi akan dibatalkan dan data di lokasi ini tidak akan diubah.
opsi	TransactionOptions	Objek opsi untuk mengonfigurasi transaksi.

Hasil:

Promise<TransactionResult>

Promise yang secara opsional dapat digunakan sebagai pengganti callback onComplete untuk menangani keberhasilan dan kegagalan.

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 ("value", "child_added", dll.) akan dipicu. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan di-resolve 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 dimaksudkan untuk dipertahankan, Anda harus menggunakan setWithPriority().

Perhatikan bahwa memodifikasi data dengan set() akan membatalkan setiap transaksi yang tertunda di lokasi tersebut, sehingga Anda harus sangat berhati-hati jika menggabungkan set() dan transaction() untuk mengubah data yang sama.

Satu set() akan menghasilkan satu "nilai" peristiwa di lokasi tempat set() dilakukan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi tujuan penulisan.
value	tidak diketahui	Nilai yang akan ditulis (string, angka, boolean, objek, array, atau null).

Hasil:

Janji<void>

Menyelesaikan masalah operasi tulis ke server.

setPriority(ref, prioritas)

Menetapkan prioritas untuk data di lokasi Database ini.

Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Mengurutkan dan memfilter data).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi tujuan penulisan.
priority	rangkaian | angka | null (kosong)	Prioritas yang akan ditulis (string, angka, atau null).

Hasil:

Janji<void>

Menyelesaikan masalah operasi tulis ke server.

setWithPriority(ref, nilai, prioritas)

Menulis data di lokasi Database. Seperti set(), tetapi juga menentukan prioritas untuk data tersebut.

Aplikasi tidak perlu menggunakan prioritas, tetapi dapat mengurutkan koleksi berdasarkan properti biasa (lihat Mengurutkan dan memfilter data).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi tujuan penulisan.
value	tidak diketahui	Nilai yang akan ditulis (string, angka, boolean, objek, array, atau null).
priority	rangkaian | angka | null (kosong)	Prioritas yang akan ditulis (string, angka, atau null).

Hasil:

Janji<void>

Menyelesaikan masalah operasi tulis ke server.

update(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 (bukan mengganti semua properti turunan di lokasi saat ini).

Efek penulisan akan segera terlihat, dan peristiwa terkait ('value', 'child_added', dll.) akan dipicu. Sinkronisasi data ke server Firebase juga akan dimulai, dan Promise yang ditampilkan akan di-resolve setelah selesai. Jika disediakan, callback onComplete akan dipanggil secara asinkron setelah sinkronisasi selesai.

Satu update() akan menghasilkan satu "nilai" di lokasi tempat update() dijalankan, terlepas dari berapa banyak turunan yang diubah.

Perhatikan bahwa memodifikasi data dengan update() akan membatalkan setiap transaksi yang tertunda di lokasi tersebut, sehingga Anda harus 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.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
referensi	DatabaseReference	Lokasi tujuan penulisan.
nilai	objek	Objek yang berisi beberapa nilai.

Hasil:

Janji<void>

Terselesaikan saat update di server selesai.

function(value, ...)

endAt(nilai, kunci)

Membuat QueryConstraint dengan titik akhir yang ditentukan.

Dengan menggunakan startAt(), startAfter(), endBefore(), endAt(), dan equalTo(), Anda dapat memilih titik awal dan akhir apa pun untuk kueri Anda.

Titik akhir bersifat inklusif, sehingga turunan dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditentukan, turunan yang memiliki nilai yang ditentukan secara persis juga harus memiliki nama kunci yang kurang dari atau sama dengan kunci yang ditentukan.

Anda dapat membaca selengkapnya tentang endAt() di Memfilter data.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
value	angka | rangkaian | boolean | null (kosong)	Nilai yang diakhiri. Jenis argumen bergantung pada fungsi orderBy() yang digunakan dalam kueri ini. Tentukan nilai yang cocok dengan jenis orderBy(). Jika digunakan bersama dengan orderByKey(), nilai harus berupa string.
kunci	string	Kunci turunan yang akan diakhiri, di antara turunan dengan prioritas yang telah ditetapkan sebelumnya. Argumen ini hanya diperbolehkan jika mengurutkan berdasarkan turunan, nilai, atau prioritas.

Hasil:

QueryConstraint

endSebelum(nilai, kunci)

Membuat QueryConstraint dengan titik akhir yang ditentukan (eksklusif).

Dengan menggunakan startAt(), startAfter(), endBefore(), endAt(), dan equalTo(), Anda dapat memilih titik awal dan akhir apa pun untuk kueri Anda.

Titik akhir bersifat eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai yang lebih kecil dari nilai yang ditentukan akan disertakan dalam kueri. Jika kunci ditentukan, turunan harus memiliki nilai yang lebih kecil dari atau sama dengan nilai yang ditentukan dan nama kunci kurang dari kunci yang ditentukan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
value	angka | rangkaian | boolean | null (kosong)	Nilai yang akan diakhiri sebelum. Jenis argumen bergantung pada fungsi orderBy() yang digunakan dalam kueri ini. Tentukan nilai yang cocok dengan jenis orderBy(). Jika digunakan bersama dengan orderByKey(), nilai harus berupa string.
kunci	string	Kunci turunan yang akan diakhiri sebelumnya, di antara turunan dengan prioritas yang telah ditetapkan sebelumnya. Argumen ini hanya diperbolehkan jika mengurutkan berdasarkan turunan, nilai, atau prioritas.

Hasil:

QueryConstraint

samaDengan(nilai, kunci)

Membuat QueryConstraint yang menyertakan turunan yang cocok dengan nilai yang ditentukan.

Dengan menggunakan startAt(), startAfter(), endBefore(), endAt(), dan equalTo(), Anda dapat memilih titik awal dan akhir apa pun untuk kueri Anda.

Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditetapkan, turunan yang memiliki nilai yang ditentukan secara persis 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.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
value	angka | rangkaian | boolean | null (kosong)	Nilai yang akan dicocokkan. Jenis argumen bergantung pada fungsi orderBy() yang digunakan dalam kueri ini. Tentukan nilai yang cocok dengan jenis orderBy(). Jika digunakan bersama dengan orderByKey(), nilai harus berupa string.
kunci	string	Kunci turunan yang akan dimulai, di antara turunan dengan prioritas yang telah ditetapkan sebelumnya. Argumen ini hanya diperbolehkan jika mengurutkan berdasarkan turunan, nilai, atau prioritas.

Hasil:

QueryConstraint

startAfter(nilai, kunci)

Membuat QueryConstraint dengan titik awal yang ditentukan (eksklusif).

Dengan menggunakan startAt(), startAfter(), endBefore(), endAt(), dan equalTo(), Anda dapat memilih titik awal dan akhir apa pun untuk kueri Anda.

Titik awalnya bersifat eksklusif. Jika hanya nilai yang diberikan, turunan dengan nilai yang lebih besar dari nilai yang ditentukan akan disertakan dalam kueri. Jika kunci ditentukan, maka turunan harus memiliki nilai yang lebih besar dari atau sama dengan nilai yang ditentukan dan nama kunci yang lebih besar dari kunci yang ditentukan.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
value	angka | rangkaian | boolean | null (kosong)	Nilai yang dimulai setelahnya. Jenis argumen bergantung pada fungsi orderBy() yang digunakan dalam kueri ini. Tentukan nilai yang cocok dengan jenis orderBy(). Jika digunakan bersama dengan orderByKey(), nilai harus berupa string.
kunci	string	Kunci turunan untuk memulai setelahnya. Argumen ini hanya diperbolehkan jika mengurutkan berdasarkan turunan, nilai, atau prioritas.

Hasil:

QueryConstraint

startAt(nilai, kunci)

Membuat QueryConstraint dengan titik awal yang ditentukan.

Dengan menggunakan startAt(), startAfter(), endBefore(), endAt(), dan equalTo(), Anda dapat memilih titik awal dan akhir apa pun untuk kueri Anda.

Titik awalnya bersifat inklusif, sehingga turunan dengan nilai yang ditentukan akan disertakan dalam kueri. Argumen kunci opsional dapat digunakan untuk membatasi lebih lanjut rentang kueri. Jika ditetapkan, turunan yang memiliki nilai yang ditentukan secara persis juga harus memiliki nama kunci yang lebih besar atau sama dengan kunci yang ditentukan.

Anda dapat membaca selengkapnya tentang startAt() di Memfilter data.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
value	angka | rangkaian | boolean | null (kosong)	Nilai untuk memulai. Jenis argumen bergantung pada fungsi orderBy() yang digunakan dalam kueri ini. Tentukan nilai yang cocok dengan jenis orderBy(). Jika digunakan bersama dengan orderByKey(), nilai harus berupa string.
kunci	string	Kunci turunan untuk memulai. Argumen ini hanya diperbolehkan jika mengurutkan berdasarkan turunan, nilai, atau prioritas.

Hasil:

QueryConstraint

EventType

Salah satu string berikut: "value", "child_added", "child_changed", "child_removed", atau "child_moved".

Tanda Tangan:

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

QueryConstraintType

Menjelaskan berbagai batasan kueri yang tersedia di SDK ini.

Tanda Tangan:

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

Berhenti berlangganan

Callback yang dapat dipanggil untuk menghapus pemroses.

Tanda Tangan:

export declare type Unsubscribe = () => void;