database package

Firebase Gerçek Zamanlı Veritabanı

Fonksiyonlar

İşlev Tanım
işlev(uygulama, ...)
getDatabase(uygulama, url) Sağlanan FirebaseApp ile ilişkili Gerçek Zamanlı Veritabanı SDK'sının örneğini döndürür . Hiçbir örnek yoksa veya mevcut örnek özel bir veritabanı URL'si kullanıyorsa, varsayılan ayarlarla yeni bir örneği başlatır.
işlev(db, ...)
connectDatabaseEmulator(db, ana bilgisayar, bağlantı noktası, seçenekler) Gerçek Zamanlı Veritabanı öykünücüsüyle iletişim kurmak için sağlanan örneği değiştirin.

Not: Başka bir işlem yapılmadan önce bu yöntemin çağrılması gerekir.

Çevrimdışına Git(db) Sunucuyla bağlantı kesilir (tüm Veritabanı işlemleri çevrimdışı tamamlanacaktır). İstemci, Veritabanı sunucusuyla otomatik olarak kalıcı bir bağlantı kurar; bu bağlantı süresiz olarak aktif kalır ve bağlantı kesildiğinde yeniden bağlanır. Ancak, kalıcı bir bağlantının istenmediği durumlarda istemci bağlantısını kontrol etmek için goOffline() ve goOnline() yöntemleri kullanılabilir. Çevrimdışıyken istemci artık Veritabanından veri güncellemeleri almayacaktır. Ancak yerel olarak gerçekleştirilen tüm Veritabanı işlemleri, olayları anında başlatmaya devam ederek uygulamanızın normal şekilde davranmaya devam etmesine olanak tanır. Ek olarak, yerel olarak gerçekleştirilen her işlem otomatik olarak sıraya alınacak ve Veritabanı sunucusuna yeniden bağlanıldığında yeniden denenecektir. Veritabanına yeniden bağlanmak ve uzak olayları almaya başlamak için goOnline() a bakın.
çevrimiçine git(db) Sunucuya yeniden bağlanır ve çevrimdışı Veritabanı durumunu sunucu durumuyla senkronize eder. Bu yöntem goOffline() ile aktif bağlantı devre dışı bırakıldıktan sonra kullanılmalıdır. Yeniden bağlanıldığında, istemci uygun verileri iletecek ve uygun olayları başlatacak, böylece istemciniz otomatik olarak "yetişecektir".
başvuru(db, yol) Sağlanan yola karşılık gelen Veritabanındaki konumu temsil eden bir Reference döndürür. Hiçbir yol sağlanmazsa Reference , Veritabanının kökünü işaret edecektir.
refFromURL(db, url) Sağlanan Firebase URL'sine karşılık gelen Veritabanındaki konumu temsil eden bir Reference döndürür. URL'nin geçerli bir Firebase Veritabanı URL'si olmaması veya mevcut Database örneğinden farklı bir etki alanına sahip olması durumunda bir istisna oluşturulur. Tüm sorgu parametrelerinin ( orderBy , limitToLast vb.) yok sayıldığını ve döndürülen Reference uygulanmadığını unutmayın.
işlev()
ForceLongPolling() Websockets yerine longPolling kullanımını zorlayın. DatabaseURL'de websocket protokolü kullanılıyorsa bu göz ardı edilecektir.
ForceWebSockets() LongPolling yerine websockets kullanımını zorlayın.
orderByKey() Anahtara göre sipariş veren yeni bir QueryConstraint oluşturur. Bir sorgunun sonuçlarını (artan) anahtar değerlerine göre sıralar. orderByKey() hakkında daha fazla bilgiyi Verileri sırala bölümünde okuyabilirsiniz. .
orderByPriority() Önceliğe göre sıralanan yeni bir QueryConstraint oluşturur. Uygulamaların öncelik kullanmasına gerek yoktur ancak koleksiyonları sıradan özelliklere göre sıralayabilir (önceliğe alternatifler için bkz . Verileri sıralama .
orderByValue() Değere göre sipariş veren yeni bir QueryConstraint oluşturur. Bir sorgunun alt öğelerinin tümü skaler değerlerse (dize, sayı veya boole), sonuçları (artan) değerlerine göre sıralayabilirsiniz. orderByValue() hakkında daha fazla bilgiyi Verileri sırala bölümünde okuyabilirsiniz. .
sunucuTimestamp() Firebase sunucuları tarafından belirlenen geçerli zaman damgasını (Unix döneminden bu yana geçen süre, milisaniye cinsinden) otomatik olarak doldurmak için bir yer tutucu değeri döndürür.
fonksiyon(delta, ...)
artış(delta) Geçerli veritabanı değerini belirtilen deltaya göre atomik olarak artırmak için kullanılabilecek bir yer tutucu değeri döndürür.
fonksiyon(etkin, ...)
activeLogging(etkin, kalıcı) Hata ayıklama bilgilerini konsola kaydeder.
fonksiyon(limit, ...)
limitToFirst(sınır) İlk belirli alt öğe sayısıyla sınırlıysa yeni bir QueryConstraint oluşturur. limitToFirst() yöntemi, belirli bir geri arama için senkronize edilecek maksimum alt çocuk sayısını ayarlamak için kullanılır. Eğer 100'lük bir limit belirlersek, başlangıçta yalnızca 100'e kadar child_added olayı alacağız. Veritabanımızda 100'den az mesaj depolanıyorsa, her mesaj için bir child_added olayı tetiklenecektir. Ancak 100'ün üzerinde mesajımız varsa yalnızca ilk 100 sıralı mesaj için child_added olayı alırız. Öğeler değiştikçe, aktif listeden çıkan her öğe için child_removed olaylarını alacağız, böylece toplam sayı 100'de kalacak. limitToFirst() hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz. .
limitToLast(sınır) Yalnızca son belirtilen sayıda alt öğeyi döndürmekle sınırlı olan yeni bir QueryConstraint oluşturur. limitToLast() yöntemi, belirli bir geri arama için senkronize edilecek maksimum alt çocuk sayısını ayarlamak için kullanılır. Eğer 100'lük bir limit belirlersek, başlangıçta yalnızca 100'e kadar child_added olayı alacağız. Veritabanımızda 100'den az mesaj depolanıyorsa, her mesaj için bir child_added olayı tetiklenecektir. Ancak 100'ün üzerinde mesajımız varsa yalnızca son 100 sıralı mesaj için child_added olayı alırız. Öğeler değiştikçe, aktif listeden çıkan her öğe için child_removed olaylarını alacağız, böylece toplam sayı 100'de kalacak. limitToLast() hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz. .
fonksiyon(günlükçü, ...)
EnableLogging(günlükçü) Hata ayıklama bilgilerini konsola kaydeder.
fonksiyon(üst, ...)
çocuk(ebeveyn, yol) Belirtilen göreli yoldaki konum için bir Reference alır. Göreli yol, basit bir alt ad (örneğin, "ada") veya eğik çizgiyle ayrılmış daha derin bir yol (örneğin, "ada/ad/ilk") olabilir.
push(ebeveyn, değer) Benzersiz bir anahtar kullanarak yeni bir alt konum oluşturur ve Reference değerini döndürür. Bu, bir öğe koleksiyonuna veri eklemek için en yaygın kalıptır. push() işlevine bir değer girerseniz değer oluşturulan konuma yazılır. Bir değer iletmezseniz, veritabanına hiçbir şey yazılmaz ve alt öğe boş kalır (ancak Reference başka bir yerde kullanabilirsiniz). push() tarafından oluşturulan benzersiz anahtarlar geçerli zamana göre sıralanır, böylece ortaya çıkan öğe listesi kronolojik olarak sıralanır. Anahtarlar aynı zamanda tahmin edilemez olacak şekilde tasarlanmıştır (72 rastgele bit entropi içerirler). Bkz . Veri listesine ekleme . Benzersiz Tanımlayıcılar Sağlamanın 2^120 Yolunu Görün .
fonksiyon(yol,...)
orderByChild(yol) Belirtilen alt anahtara göre sipariş veren yeni bir QueryConstraint oluşturur. Sorgular aynı anda yalnızca bir anahtara göre sıralanabilir. Aynı sorguda orderByChild() işlevinin birden çok kez çağrılması bir hatadır. Firebase sorguları, verilerinizi anında herhangi bir alt anahtara göre sıralamanıza olanak tanır. Ancak indekslerinizin ne olacağını önceden biliyorsanız, daha iyi performans için bunları Güvenlik Kurallarınızda .indexOn kuralı aracılığıyla tanımlayabilirsiniz. Daha fazla bilgi için https://firebase.google.com/docs/database/security/indexing-data kuralına bakın. orderByChild() hakkında daha fazla bilgiyi Verileri sırala bölümünde okuyabilirsiniz. .
işlev (sorgu, ...)
al(sorgu) Bu sorgu için en güncel sonucu alır.
off(sorgu, eventType, geri arama) İlgili on () ( onValue , onChildAdded ) dinleyicisine önceden eklenmiş bir geri aramayı ayırır. Not: Bu, bir dinleyiciyi kaldırmanın önerilen yolu değildir. Bunun yerine, lütfen ilgili geri on döndürülen geri arama işlevini kullanın. Daha önce on*() ile eklenmiş bir geri aramayı ayırın. Bir ana dinleyicide off() çağrılması, alt düğümlerde kayıtlı dinleyicileri otomatik olarak kaldırmaz; geri aramayı kaldırmak için herhangi bir alt dinleyicide de off() çağrılmalıdır. Bir geri arama belirtilmezse belirtilen eventType için tüm geri aramalar kaldırılacaktır. Benzer şekilde, herhangi bir eventType belirtilmezse Reference için tüm geri aramalar kaldırılacaktır. Bireysel dinleyiciler, abonelikten çıkma geri aramaları başlatılarak da çıkarılabilir.
onChildAdded(sorgu, geri arama, iptalGeri arama) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bu konumdaki her ilk alt öğe için bir onChildAdded olayı bir kez tetiklenecek ve her yeni alt öğe eklendiğinde yeniden tetiklenecektir. Geri aramaya iletilen DataSnapshot ilgili alt öğenin verilerini yansıtacaktır. Sıralama amacıyla, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildAdded(sorgu, geri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bu konumdaki her ilk alt öğe için bir onChildAdded olayı bir kez tetiklenecek ve her yeni alt öğe eklendiğinde yeniden tetiklenecektir. Geri aramaya iletilen DataSnapshot ilgili alt öğenin verilerini yansıtacaktır. Sıralama amacıyla, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildAdded(sorgu, geri arama, iptalGeri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bu konumdaki her ilk alt öğe için bir onChildAdded olayı bir kez tetiklenecek ve her yeni alt öğe eklendiğinde yeniden tetiklenecektir. Geri aramaya iletilen DataSnapshot ilgili alt öğenin verilerini yansıtacaktır. Sıralama amacıyla, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildChanged(sorgu, geri arama, iptalGeri arama) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir alt öğede (veya alt öğelerinden herhangi birinde) depolanan veriler değiştiğinde bir onChildChanged olayı tetiklenir. Tek bir child_changed olayının, alt öğede birden fazla değişikliği temsil edebileceğini unutmayın. Geri aramaya iletilen DataSnapshot yeni alt içerikleri içerecektir. Sıralama amacıyla, geri çağırmaya ayrıca sıralama düzenine göre önceki kardeş çocuğun anahtarını içeren bir dize olan ikinci bir argüman veya eğer ilk çocuksa null iletilir.
onChildChanged(sorgu, geri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir alt öğede (veya alt öğelerinden herhangi birinde) depolanan veriler değiştiğinde bir onChildChanged olayı tetiklenir. Tek bir child_changed olayının, alt öğede birden fazla değişikliği temsil edebileceğini unutmayın. Geri aramaya iletilen DataSnapshot yeni alt içerikleri içerecektir. Sıralama amacıyla, geri çağırmaya ayrıca sıralama düzenine göre önceki kardeş çocuğun anahtarını içeren bir dize olan ikinci bir argüman veya eğer ilk çocuksa null iletilir.
onChildChanged(sorgu, geri arama, iptalGeri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir alt öğede (veya alt öğelerinden herhangi birinde) depolanan veriler değiştiğinde bir onChildChanged olayı tetiklenir. Tek bir child_changed olayının, alt öğede birden fazla değişikliği temsil edebileceğini unutmayın. Geri aramaya iletilen DataSnapshot yeni alt içerikleri içerecektir. Sıralama amacıyla, geri çağırmaya ayrıca sıralama düzenine göre önceki kardeş çocuğun anahtarını içeren bir dize olan ikinci bir argüman veya eğer ilk çocuksa null iletilir.
onChildMoved(sorgu, geri arama, iptalGeri arama) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuğun sıralama düzeni kardeşlerine göre konumunu değiştirecek şekilde değiştiğinde onChildMoved olayı tetiklenir. Geri aramaya iletilen DataSnapshot taşınan alt öğenin verileri için olacaktır. Ayrıca, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildMoved(sorgu, geri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuğun sıralama düzeni kardeşlerine göre konumunu değiştirecek şekilde değiştiğinde onChildMoved olayı tetiklenir. Geri aramaya iletilen DataSnapshot taşınan alt öğenin verileri için olacaktır. Ayrıca, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildMoved(sorgu, geri arama, iptalGeri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuğun sıralama düzeni kardeşlerine göre konumunu değiştirecek şekilde değiştiğinde onChildMoved olayı tetiklenir. Geri aramaya iletilen DataSnapshot taşınan alt öğenin verileri için olacaktır. Ayrıca, önceki kardeş çocuğun anahtarını sıralama düzenine göre içeren bir dize olan ikinci bir argüman iletilir veya bu ilk çocuksa null .
onChildRemoved(sorgu, geri arama, iptalGeri arama) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuk her kaldırıldığında bir onChildRemoved olayı tetiklenecektir. Geri aramaya iletilen DataSnapshot kaldırılan alt öğenin eski verileri olacaktır. Aşağıdaki durumlarda bir çocuk okuldan alınır: - bir istemci bu çocuk veya onun atalarından biri üzerinde açıkça remove() öğesini çağırır - bir istemci o çocuk veya onun atalarından biri üzerinde set(null) işlevini çağırır - bu çocuğun tüm çocukları kaldırılmıştır - şu anda yürürlükte olan bir sorgu vardır çocuğu filtreler (çünkü sıralama düzeni değişti veya maksimum sınıra ulaşıldı)
onChildRemoved(sorgu, geri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuk her kaldırıldığında bir onChildRemoved olayı tetiklenecektir. Geri aramaya iletilen DataSnapshot kaldırılan alt öğenin eski verileri olacaktır. Aşağıdaki durumlarda bir çocuk okuldan alınır: - bir istemci bu çocuk veya onun atalarından biri üzerinde açıkça remove() öğesini çağırır - bir istemci o çocuk veya onun atalarından biri üzerinde set(null) işlevini çağırır - bu çocuğun tüm çocukları kaldırılmıştır - şu anda yürürlükte olan bir sorgu vardır çocuğu filtreler (çünkü sıralama düzeni değişti veya maksimum sınıra ulaşıldı)
onChildRemoved(sorgu, geri arama, iptalGeri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir çocuk her kaldırıldığında bir onChildRemoved olayı tetiklenir. Geri aramaya iletilen DataSnapshot kaldırılan alt öğenin eski verileri olacaktır. Aşağıdaki durumlarda bir çocuk okuldan alınır: - bir istemci bu çocuk veya onun atalarından biri üzerinde açıkça remove() öğesini çağırır - bir istemci o çocuk veya onun atalarından biri üzerinde set(null) işlevini çağırır - bu çocuğun tüm çocukları kaldırılmıştır - şu anda yürürlükte olan bir sorgu vardır çocuğu filtreler (çünkü sıralama düzeni değişti veya maksimum sınıra ulaşıldı)
onValue(sorgu, geri arama, cancelgeri arama) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde yeniden tetiklenir. Geri aramaya iletilen DataSnapshot on() işlevinin çağrıldığı konum için olacaktır. İçeriğin tamamı senkronize edilene kadar tetiklenmez. Konumun verisi yoksa boş bir DataSnapshot ile tetiklenir ( val() null değerini döndürür).
onValue(sorgu, geri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde yeniden tetiklenir. Geri aramaya iletilen DataSnapshot on() işlevinin çağrıldığı konum için olacaktır. İçeriğin tamamı senkronize edilene kadar tetiklenmez. Konumun verisi yoksa boş bir DataSnapshot ile tetiklenir ( val() null değerini döndürür).
onValue(sorgu, geri arama, iptalGeri arama, seçenekler) Belirli bir konumdaki veri değişikliklerini dinler. Bu, bir Veritabanından veri okumanın birincil yoludur. Geri aramanız ilk veriler için ve veriler değiştiğinde tekrar tetiklenecektir. Güncellemeleri almayı durdurmak için geri gönderilen abonelikten çıkma geri aramasını çağırın. Daha fazla ayrıntı için bkz . Web'deki Verileri Alma . Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde yeniden tetiklenir. Geri aramaya iletilen DataSnapshot on() işlevinin çağrıldığı konum için olacaktır. İçeriğin tamamı senkronize edilene kadar tetiklenmez. Konumun verisi yoksa boş bir DataSnapshot ile tetiklenir ( val() null değerini döndürür).
sorgu(sorgu, queryConstraints) Ek sorgu kısıtlamalarını da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.
fonksiyon(ref, ...)
onDisconnect(ref) Bir OnDisconnect nesnesi döndürür - bunun nasıl kullanılacağı hakkında daha fazla bilgi için bkz . JavaScript'te Çevrimdışı Özellikleri Etkinleştirme .
kaldır(ref) Bu Veritabanı konumundaki verileri kaldırır. Alt konumlardaki tüm veriler de silinecektir. Kaldırma işleminin etkisi hemen görülecek ve karşılık gelen 'değer' olayı tetiklenecektir. Kaldırma işleminin Firebase sunucularıyla senkronizasyonu da başlatılacak ve döndürülen Söz tamamlandığında çözülecektir. Sağlanırsa, senkronizasyon tamamlandıktan sonra onComplete geri çağrısı eşzamansız olarak çağrılır.
runTransaction(ref, transactionUpdate, seçenekler) Bu konumdaki verileri atomik olarak değiştirir. Bu konumdaki verileri atomik olarak değiştirin. Önceki değerinden bağımsız olarak yalnızca verilerin üzerine yazan normal set() farklı olarak runTransaction() , mevcut değeri yeni bir değerle değiştirmek için kullanılır ve diğer istemcilerin aynı anda aynı konuma yazmalarıyla çakışma olmamasını sağlar. . Bunu başarmak için, mevcut değeri yeni bir değere dönüştürmek için kullanılan bir güncelleme işlevi olan runTransaction() a iletirsiniz. Yeni değeriniz başarıyla yazılmadan önce başka bir istemci konuma yazarsa güncelleme fonksiyonunuz yeni mevcut değerle tekrar çağrılacak ve yazma işlemi yeniden denenecektir. Bu, yazma işleminiz çakışmadan başarılı olana veya güncelleme işlevinizden bir değer döndürmeyerek işlemi iptal edene kadar tekrar tekrar gerçekleşecektir. Not: Verileri set() ile değiştirmek, o konumda bekleyen tüm işlemleri iptal edecektir; bu nedenle, aynı verileri güncellemek için set() ve runTransaction() ı karıştırırken çok dikkatli olunmalıdır. Not: İşlemleri Güvenlik ve Firebase Kuralları uygulanarak kullanırken, bir istemcinin bir işlemi gerçekleştirmek için .write .read de ihtiyacı olduğunu unutmayın. Bunun nedeni, işlemlerin müşteri tarafı doğasının, müşterinin verileri işlemsel olarak güncellemek için okumasını gerektirmesidir.
set(ref, değer) Verileri bu Veritabanı konumuna yazar. Bu, bu konumdaki ve tüm alt konumlardaki tüm verilerin üzerine yazılacaktır. Yazmanın etkisi hemen görülecek ve karşılık gelen olaylar ("value", "child_added" vb.) tetiklenecektir. Verilerin Firebase sunucularına senkronizasyonu da başlatılacak ve döndürülen Söz tamamlandığında çözülecektir. Sağlanırsa, senkronizasyon tamamlandıktan sonra onComplete geri çağrısı eşzamansız olarak çağrılır. Yeni değer için null iletmek, remove() işlevinin çağrılmasına eşdeğerdir; yani bu konumdaki ve tüm alt konumlardaki tüm veriler silinecek. set() bu konumda depolanan tüm öncelikleri kaldıracaktır; dolayısıyla önceliğin korunması gerekiyorsa bunun yerine setWithPriority() kullanmanız gerekir. Verileri set() ile değiştirmenin o konumda bekleyen tüm işlemleri iptal edeceğini unutmayın; bu nedenle, aynı verileri değiştirmek için set() ve transaction() ı karıştırırken çok dikkatli olunmalıdır. Tek bir set() set() işleminin gerçekleştirildiği yerde tek bir "değer" olayı üretecektir.
setPriority(ref, öncelik) Bu Veritabanı konumundaki veriler için bir öncelik belirler. Uygulamaların öncelik kullanmasına gerek yoktur ancak koleksiyonları sıradan özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme ).
setWithPriority(ref, değer, öncelik) Verileri Veritabanı konumuna yazar. set() gibi ama aynı zamanda bu verinin önceliğini de belirtir. Uygulamaların öncelik kullanmasına gerek yoktur ancak koleksiyonları sıradan özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme ).
güncelleme(ref, değerler) Veritabanına aynı anda birden fazla değer yazar. values bağımsız değişkeni, Veritabanına birlikte yazılacak birden çok özellik-değer çifti içerir. Her alt özellik, basit bir özellik (örneğin, "ad") veya geçerli konumdan güncellenecek verilere giden göreceli bir yol (örneğin, "ad/ilk") olabilir. set() yönteminin aksine, update() yalnızca geçerli konumdaki referans verilen özellikleri seçmeli olarak güncellemek için kullanılabilir (geçerli konumdaki tüm alt özellikleri değiştirmek yerine). Yazmanın etkisi hemen görülecek ve karşılık gelen olaylar ('value', 'child_added' vb.) tetiklenecektir. Verilerin Firebase sunucularına senkronizasyonu da başlatılacak ve döndürülen Söz tamamlandığında çözülecektir. Sağlanırsa, senkronizasyon tamamlandıktan sonra onComplete geri çağrısı eşzamansız olarak çağrılır. Tek bir update() kaç alt öğenin değiştirildiğine bakılmaksızın, update() işleminin gerçekleştirildiği yerde tek bir "değer" olayı üretecektir. Verileri update() ile değiştirmenin o konumda bekleyen tüm işlemleri iptal edeceğini unutmayın; bu nedenle, aynı verileri değiştirmek için update() ve transaction() ı karıştırırken çok dikkatli olunmalıdır. update() işlevine null iletmek bu konumdaki verileri kaldıracaktır. Bkz . Çok konumlu güncellemelerle tanışma ve daha fazlası .
fonksiyon(değer, ...)
endAt(değer, anahtar) Belirtilen bitiş noktasına sahip bir QueryConstraint oluşturur. startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanmak, sorgularınız için rastgele başlangıç ​​ve bitiş noktaları seçmenize olanak tanır. Bitiş noktası kapsayıcı olduğundan, tam olarak belirtilen değere sahip çocuklar sorguya dahil edilecektir. İsteğe bağlı anahtar bağımsız değişkeni, sorgu aralığını daha da sınırlamak için kullanılabilir. Belirtilmişse, tam olarak belirtilen değere sahip olan çocukların da belirtilen anahtardan küçük veya ona eşit bir anahtar adına sahip olması gerekir. Verileri filtreleme bölümünde endAt() hakkında daha fazla bilgi edinebilirsiniz. .
endBefore(değer; anahtar) Belirtilen bitiş noktasına (hariç) sahip bir QueryConstraint oluşturur. startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanmak, sorgularınız için rastgele başlangıç ​​ve bitiş noktaları seçmenize olanak tanır. Bitiş noktası özeldir. Yalnızca değer girilmesi durumunda belirtilen değerden küçük değere sahip çocuklar sorguya dahil edilecektir. Bir anahtar belirtilirse, çocukların belirtilen değerden küçük veya ona eşit bir değere ve belirtilen anahtardan daha küçük bir anahtar adına sahip olması gerekir.
equalTo(değer, anahtar) Belirtilen değerle eşleşen çocukları içeren bir QueryConstraint oluşturur. startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanmak, sorgularınız için rastgele başlangıç ​​ve bitiş noktaları seçmenize olanak tanır. İsteğe bağlı anahtar bağımsız değişkeni, sorgu aralığını daha da sınırlamak için kullanılabilir. Belirtilmişse, tam olarak belirtilen değere sahip olan çocukların, anahtar adı olarak tam olarak belirtilen anahtara da sahip olmaları gerekir. Bu, aynı değer için birçok eşleşmenin olduğu sonuç kümelerini filtrelemek için kullanılabilir. Verileri filtreleme bölümünde equalTo() hakkında daha fazla bilgi edinebilirsiniz .
startAfter(değer, anahtar) Belirtilen başlangıç ​​noktasına (özel) sahip bir QueryConstraint oluşturur. startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanmak, sorgularınız için rastgele başlangıç ​​ve bitiş noktaları seçmenize olanak tanır. Başlangıç ​​noktası özeldir. Yalnızca değer girilirse belirtilen değerden büyük değere sahip çocuklar sorguya dahil edilecektir. Bir anahtar belirtilirse, çocukların belirtilen değerden büyük veya ona eşit bir değere ve belirtilen anahtardan büyük bir anahtar adına sahip olması gerekir.
startAt(değer, anahtar) Belirtilen başlangıç ​​noktasına sahip bir QueryConstraint oluşturur. startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanmak, sorgularınız için rastgele başlangıç ​​ve bitiş noktaları seçmenize olanak tanır. Başlangıç ​​noktası kapsayıcı olduğundan, tam olarak belirtilen değere sahip çocuklar sorguya dahil edilecektir. İsteğe bağlı anahtar bağımsız değişkeni, sorgu aralığını daha da sınırlamak için kullanılabilir. Belirtilmişse, tam olarak belirtilen değere sahip olan çocukların da belirtilen anahtardan büyük veya ona eşit bir anahtar adına sahip olması gerekir. startAt() hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz. .

Sınıflar

Sınıf Tanım
Veri tabanı Firebase Gerçek Zamanlı Veritabanını temsil eden sınıf.
Veri Anlık Görüntüsü DataSnapshot bir Veritabanı konumundan veri içerir. Veritabanından veri okuduğunuzda, verileri DataSnapshot olarak alırsınız. on() veya once() ile eklediğiniz olay geri çağrılarına bir DataSnapshot iletilir. Anlık görüntünün içeriğini val() yöntemini çağırarak bir JavaScript nesnesi olarak çıkarabilirsiniz. Alternatif olarak, alt anlık görüntüleri döndürmek için child() öğesini çağırarak anlık görüntüye geçiş yapabilirsiniz (buna daha sonra val() adını verebilirsiniz). DataSnapshot bir Veritabanı konumundaki verilerin verimli bir şekilde oluşturulmuş, değişmez bir kopyasıdır. Değiştirilemez ve hiçbir zaman değişmeyecektir (verileri değiştirmek için her zaman set() yöntemini doğrudan bir Reference çağırırsınız).
Bağlantı Kesildiğinde onDisconnect sınıfı, istemcinizin Veritabanı sunucusuyla bağlantısı kesildiğinde verileri yazmanıza veya silmenize olanak tanır. Bu güncellemeler, istemcinizin bağlantısı temiz bir şekilde kesilse de kesilmese de gerçekleşir; böylece bağlantı kesilse veya istemci çökse bile verileri temizlemek için bunlara güvenebilirsiniz. onDisconnect sınıfı en yaygın olarak, kaç istemcinin bağlı olduğunu ve diğer istemcilerin bağlantısının ne zaman kesildiğini tespit etmenin yararlı olduğu uygulamalardaki varlığı yönetmek için kullanılır. Daha fazla bilgi için bkz . JavaScript'te Çevrimdışı Özellikleri Etkinleştirme . İstekler Veritabanı sunucusuna aktarılmadan önce bağlantı kesildiğinde sorun yaşamamak için, bu işlevler herhangi bir veri yazılmadan önce çağrılmalıdır. onDisconnect işlemlerinin yalnızca bir kez tetiklendiğini unutmayın. Her bağlantı kesildiğinde bir işlemin gerçekleşmesini istiyorsanız, her yeniden bağlandığınızda onDisconnect işlemlerini yeniden kurmanız gerekir.
Sorgu Kısıtlaması Bir Veritabanı sorgusu tarafından döndürülen belge kümesini daraltmak için QueryConstraint kullanılır. QueryConstraint endAt() çağrılarak oluşturulur. , endBefore() , başlamak() , startAfter() , limitToFirst() , limitToLast() , orderByChild() , orderByChild() , orderByKey() , orderByPriority() , orderByValue() veya equalTo() ve daha sonra bu QueryConstraint de içeren yeni bir sorgu örneği oluşturmak için query() öğesine iletilebilir.
İşlemSonucu runTransaction() işlevinin çözümleme değeri için bir tür .

Arayüzler

Arayüz Tanım
Veritabanı Referansı DatabaseReference Veritabanınızdaki belirli bir konumu temsil eder ve bu Veritabanı konumuna veri okumak veya yazmak için kullanılabilir. ref() veya ref("child/path") çağırarak Veritabanınızdaki kök veya alt konuma başvurabilirsiniz. Yazma set() yöntemiyle, okuma ise on*() yöntemiyle yapılabilir. Bkz. https://firebase.google.com/docs/database/web/read-and-write
Yinelenen Veri Anlık Görüntüsü Üzerinde yinelenen bir Reference alt anlık görüntüsünü temsil eder. Anahtar hiçbir zaman tanımsız olmayacaktır.
DinlemeSeçenekleri Bir dinleyiciyi özelleştirmek için kullanılabilecek bir seçenek nesneleri.
Sorgu Bir Query bir Veritabanı konumundaki verileri sıralar ve filtreler; böylece alt verilerin yalnızca bir alt kümesi dahil edilir. Bu, bir veri koleksiyonunu bazı niteliklere (örneğin, dinozorların yüksekliği) göre sıralamak için kullanılabileceği gibi, geniş bir öğe listesini (örneğin, sohbet mesajları) istemciyle senkronize edilmeye uygun bir sayıyla sınırlamak için de kullanılabilir. Sorgular, burada tanımlanan filtre yöntemlerinden bir veya daha fazlasının birbirine zincirlenmesiyle oluşturulur. DatabaseReference olduğu gibi, on*() yöntemlerini kullanarak bir Query veri alabilirsiniz. Yalnızca sorgunuzla eşleşen verilerin alt kümesine ilişkin etkinlikleri ve DataSnapshot alacaksınız. Daha fazla bilgi için https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data adresine bakın.
OlabilirReferans Push() tarafından döndürüldüğünde DatabaseReference görevi de görebilecek bir Promise . Referans hemen kullanılabilir hale gelir ve arka uca yazma işlemi tamamlandığında Promise çözümlenir.
İşlemSeçenekleri İşlemleri yapılandırmak için bir seçenekler nesnesi.

Takma Adları Yazın

Takma Ad yazın Tanım
Etkinlik tipi Şu dizelerden biri: "değer", "child_added", "child_changed", "child_removed" veya "child_moved."
Sorgu Kısıtlaması Türü Bu SDK'da bulunan farklı sorgu kısıtlamalarını açıklar.
Abonelikten çık Bir dinleyiciyi kaldırmak için çağrılabilecek bir geri arama.

işlev(uygulama, ...)

getDatabase (uygulama, url)

Sağlanan Firebaseapp ile ilişkili olan gerçek zamanlı veritabanı SDK örneğini döndürür . Örnek yoksa veya mevcut örnek özel bir veritabanı URL'si kullanıyorsa, varsayılan ayarlarla yeni bir örneği başlatır.

İmza:

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

Parametreler

Parametre Tip Tanım
uygulama Firebaseapp Dönen RealTime Veritabanı örneğinin ilişkili olduğu Firebaseapp örneği.
URL sicim Bağlanacak gerçek zamanlı veritabanı örneğinin URL'si. Sağlanmazsa, SDK Firebase uygulamasının varsayılan örneğine bağlanır.

İadeler:

Veri tabanı

Sağlanan uygulamanın Database örneği.

işlev (db, ...)

ConnectDatabaseEmulator (DB, ana bilgisayar, bağlantı noktası, seçenekler)

Gerçek zamanlı veritabanı emülatörü ile iletişim kurmak için sağlanan örneği değiştirin.

Not: Başka bir işlem yapmadan önce bu yöntem çağrılmalıdır.

İmza:

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

Parametreler

Parametre Tip Tanım
db Veri tabanı Değiştirilecek örnek.
ev sahibi sicim Emülatör ana bilgisayar (Örn: Localhost)
liman sayı Emülatör bağlantı noktası (Örn: 8080)
seçenekler {Mockusertoken?: EmulatormockTokenOptions | sicim; }

İadeler:

geçersiz

Gooffline (DB)

Sunucudan Keserler (tüm veritabanı işlemleri çevrimdışı tamamlanacaktır).

İstemci, veritabanı sunucusuna otomatik olarak kalıcı bir bağlantıyı korur, bu da süresiz olarak aktif kalacak ve bağlantısı kesildiğinde yeniden bağlanır. Bununla birlikte, kalıcı bir bağlantının istenmeyen olduğu durumlarda müşteri bağlantısını kontrol etmek için goOffline() ve goOnline() yöntemleri kullanılabilir.

Çevrimdışı olsa da, istemci artık veritabanından veri güncellemeleri almayacaktır. Ancak, yerel olarak gerçekleştirilen tüm veritabanı işlemleri, etkinlikleri hemen yangın göstermeye devam ederek uygulamanızın normal davranmaya devam etmesini sağlayacaktır. Ek olarak, yerel olarak gerçekleştirilen her işlem otomatik olarak sıralanır ve veritabanı sunucusuna yeniden bağlanma üzerine geri alınır.

Veritabanına yeniden bağlantı kurmak ve uzaktan etkinlikler almaya başlamak için bkz goOnline() .

İmza:

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

Parametreler

Parametre Tip Tanım
db Veri tabanı Bağlantı kesilecek örnek.

İadeler:

geçersiz

Goonline (DB)

Sunucuya yeniden bağlanır ve çevrimdışı veritabanı durumunu sunucu durumu ile senkronize eder.

Bu yöntem goOffline() ile aktif bağlantıyı devre dışı bıraktıktan sonra kullanılmalıdır. . Yeniden bağlandıktan sonra, istemci uygun verileri iletir ve müşterinizin otomatik olarak "yakalanması" için uygun olayları ateşler.

İmza:

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

Parametreler

Parametre Tip Tanım
db Veri tabanı Yeniden bağlanacak örnek.

İadeler:

geçersiz

Ref (db, yol)

Veritabanındaki konumu temsil eden bir Reference döndürür. Herhangi bir yol sağlanmazsa, Reference veritabanının köküne işaret edecektir.

İmza:

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

Parametreler

Parametre Tip Tanım
db Veri tabanı Bir referans almak için veritabanı örneği.
yol sicim Dönen Reference işaretleneceği yeri temsil eden isteğe bağlı yol. Sağlanmazsa, döndürülen Reference veritabanının köküne işaret edecektir.

İadeler:

DatabaserEmeneference

Bir yol sağlanırsa, sağlanan yolu gösteren bir Reference . Aksi takdirde, veritabanının köküne işaret eden bir Reference .

Reffromurl (DB, URL)

Verilen Firebase URL'sine karşılık gelen veritabanındaki konumu temsil eden bir Reference döndürür.

URL geçerli bir Firebase Veritabanı URL'si değilse veya geçerli Database örneğinden farklı bir etki alanına sahipse bir istisna atılır.

Tüm sorgu parametrelerinin ( orderBy , limitToLast , vb.) Göz ardı edilir ve iade edilen Reference uygulanmaz .

İmza:

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

Parametreler

Parametre Tip Tanım
db Veri tabanı Bir referans almak için veritabanı örneği.
URL sicim İade edilen Reference işaret edileceği Firebase URL'si.

İadeler:

DatabaserEmeneference

Sağlanan Firebase URL'sine işaret eden bir Reference .

işlev()

forcelongpolling ()

WebSockets yerine Longpolling kullanımını zorlayın. DatabaseURL'de WebSocket Protokolü kullanılırsa bu göz ardı edilecektir.

İmza:

export declare function forceLongPolling(): void;

İadeler:

geçersiz

forcewebsockets ()

Longpolling yerine WebSockets kullanımını zorlayın.

İmza:

export declare function forceWebSockets(): void;

İadeler:

geçersiz

orderbykey ()

Anahtar tarafından sipariş veren yeni bir QueryConstraint oluşturur.

Bir sorgunun sonuçlarını (artan) anahtar değerlerine göre sıralar.

Sıralama verilerinde orderByKey() .

İmza:

export declare function orderByKey(): QueryConstraint;

İadeler:

Queryconstraint

DüzenliPriority ()

Önceliğe göre sipariş veren yeni bir QueryConstraint oluşturur.

Uygulamaların öncelik kullanması gerekmez, ancak koleksiyonları sıradan özelliklere göre sipariş edebilir (önceliğe alternatifler için sıralama verilerine bakın.

İmza:

export declare function orderByPriority(): QueryConstraint;

İadeler:

Queryconstraint

orderbyvalue ()

Değere göre sipariş veren yeni bir QueryConstraint oluşturma oluşturur.

Bir sorgunun çocuklarının tümü skaler değerler (String, Numara veya Boolean) ise, sonuçları (artan) değerlerine göre sipariş edebilirsiniz.

Sıralama verilerinde orderByValue() hakkında daha fazla bilgi edinebilirsiniz .

İmza:

export declare function orderByValue(): QueryConstraint;

İadeler:

Queryconstraint

ServerTIMESTAMP ()

Firebase sunucuları tarafından belirlenen geçerli zaman damgasını (Unix Epoch'tan, milisaniye cinsinden bu yana zaman) otomatik olarak doldurması için bir yer tutucu değeri döndürür.

İmza:

export declare function serverTimestamp(): object;

İadeler:

nesne

işlev (delta, ...)

Artış (Delta)

Verilen delta tarafından geçerli veritabanı değerini atomik olarak arttırmak için kullanılabilecek bir yer tutucu değeri döndürür.

İmza:

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

Parametreler

Parametre Tip Tanım
delta sayı Geçerli değeri atomik olarak değiştirme miktarı.

İadeler:

nesne

Verileri atomik olarak sunucu tarafı değiştirmek için bir yer tutucu değeri.

işlev (etkin, ...)

Enablelogging (etkin, kalıcı)

Kayıtları Konsola Hata Ayıklama.

İmza:

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

Parametreler

Parametre Tip Tanım
etkinleştirilmiş boolean true kaydetmeyi etkinleştirirse, false durumdaysa günlüğe kaydetmeyi devre dışı bırakır.
kalıcı boolean true sayfa yenilemeleri arasındaki kayıt durumunu hatırlar.

İadeler:

herhangi

işlev (limit, ...)

Limittofirst (Limit)

İlk belirli çocuk sayısıyla sınırlı ise yeni bir QueryConstraint oluşturur.

limitToFirst() yöntemi, belirli bir geri arama için senkronize edilecek maksimum çocuk sayısını ayarlamak için kullanılır. 100 limit belirlersek, başlangıçta sadece 100'e kadar child_added kadar etkinlik alacağız. Veritabanımızda depolanan 100'den az mesajımız varsa, her mesaj için child_added bir etkinlik ateşlenir. Ancak, 100'den fazla mesajımız varsa, yalnızca ilk 100 sıralı mesaj için child_added etkinliği alacağız. Öğeler değiştikçe, toplam sayı 100'de kalması için etkin listeden ayrılan her öğe için child_removed olayları alacağız.

limitToFirst() hakkında daha fazla bilgiyi filtreleme verilerini okuyabilirsiniz. .

İmza:

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

Parametreler

Parametre Tip Tanım
sınır sayı Bu sorguya dahil edilecek maksimum düğüm sayısı.

İadeler:

Queryconstraint

Limittolast (Limit)

Yalnızca belirtilen son çocuk sayısını iade etmekle sınırlı yeni bir QueryConstraint oluşturur.

limitToLast() yöntemi, belirli bir geri arama için senkronize edilecek maksimum çocuk sayısını ayarlamak için kullanılır. 100 limit belirlersek, başlangıçta sadece 100'e kadar child_added kadar etkinlik alacağız. Veritabanımızda depolanan 100'den az mesajımız varsa, her mesaj için child_added bir etkinlik ateşlenir. Ancak, 100'den fazla mesajımız varsa, yalnızca son 100 sıralı mesaj için child_added etkinliği alacağız. Öğeler değiştikçe, toplam sayı 100'de kalması için etkin listeden ayrılan her öğe için child_removed olayları alacağız.

Filtreleme verilerinde limitToLast() hakkında daha fazla bilgi edinebilirsiniz .

İmza:

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

Parametreler

Parametre Tip Tanım
sınır sayı Bu sorguya dahil edilecek maksimum düğüm sayısı.

İadeler:

Queryconstraint

işlev (logger, ...)

Enablelogging (logger)

Kayıtları Konsola Hata Ayıklama.

İmza:

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

Parametreler

Parametre Tip Tanım
ağaç kesicisi (Mesaj: String) => Bilinmiyor İşlerin nasıl günlüğe kaydedildiğini kontrol etmek için özel bir logger işlevi.

İadeler:

herhangi

işlev (ebeveyn, ...)

çocuk (ebeveyn, yol)

Belirtilen göreceli yoldaki konum için bir Reference alır.

Göreceli yol ya basit bir çocuk adı (örneğin "Ada") veya daha derin eğik çizgi ile ayrılmış bir yol (örneğin, "Ada/Name/İlk") olabilir.

İmza:

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

Parametreler

Parametre Tip Tanım
ebeveyn DatabaserEmeneference Ana konum.
yol sicim Bu yerden istenen çocuk konumuna göreceli bir yol.

İadeler:

DatabaserEmeneference

Belirtilen çocuk yeri.

Push (ebeveyn, değer)

Benzersiz bir anahtar kullanarak yeni bir çocuk konumu oluşturur ve Reference döndürür .

Bu, bir öğe koleksiyonuna veri eklemek için en yaygın modeldir.

push() için bir değer sağlarsanız , değer oluşturulan konuma yazılır. Bir değer geçmezseniz, veritabanına hiçbir şey yazılmaz ve çocuk boş kalır (ancak Reference başka bir yerde kullanabilirsiniz).

push() tarafından oluşturulan benzersiz tuşlar güncel zamana kadar sipariş edilir, bu nedenle ortaya çıkan öğelerin listesi kronolojik olarak sıralanır. Anahtarlar ayrıca korunamayacak şekilde tasarlanmıştır (72 rastgele entropi parçası içerirler).

Bir veri listesine ekle bakın . Benzersiz tanımlayıcıları sağlamanın 2^120 yoluna bakın .

İmza:

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

Parametreler

Parametre Tip Tanım
ebeveyn DatabaserEmeneference Ana konum.
değer Bilinmeyen Oluşturulan konumda yazılacak isteğe bağlı değer.

İadeler:

Sonra

Birleşik Promise ve Reference ; Yazma tamamlandığında çözer, ancak hemen çocuk konumuna Reference olarak kullanılabilir.

işlev (yol, ...)

Düzenli (Yol)

Belirtilen alt anahtar tarafından sipariş veren yeni bir QueryConstraint oluşturur.

Sorgular her seferinde yalnızca bir anahtar sipariş edebilir. Aynı sorguda orderByChild() birden çok kez çağırmak bir hatadır.

Firebase sorguları, verilerinizi anında herhangi bir alt anahtarla sipariş etmenizi sağlar. Ancak, dizinlerinizin ne olacağını önceden biliyorsanız, bunları daha iyi performans için güvenlik kurallarınızdaki .Indexon kuralı aracılığıyla tanımlayabilirsiniz. Daha fazla bilgi için https://firebase.google.com/docs/database/security/indexing-data kuralına bakın.

Sıralama verilerinde orderByChild() .

İmza:

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

Parametreler

Parametre Tip Tanım
yol sicim Sipariş yolu.

İadeler:

Queryconstraint

işlev (sorgu, ...)

Get (sorgu)

Bu sorgu için en güncel sonucu alır.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.

İadeler:

Söz < datasnapshot >

Bir değer mevcutsa ortaya çıkan DatasNapShot'a karar veren veya istemci bir değer döndüremiyorsa reddeden bir Promise (örneğin, sunucu ulaşılamazsa ve önbelleğe alınmazsa).

Kapalı (sorgu, eventType, geri arama)

on*() (Onvalue ( onValue ) , onChildAdded ) dinleyici. Not: Bu, bir dinleyiciyi kaldırmanın önerilen yolu değildir. Bunun yerine, lütfen ilgili on* geri çağrılardan döndürülen geri arama işlevini kullanın.

Daha önce eklenmiş bir geri çağrı ayırın on*() . Ana dinleyiciye çağırmak off() çocuk düğümlerine kayıtlı dinleyicileri otomatik olarak kaldırmaz, off() geri çağrıyı kaldırmak için herhangi bir çocuk dinleyicisine de çağrılmalıdır.

Bir geri arama belirtilmezse, belirtilen EventType için tüm geri aramalar kaldırılır. Benzer şekilde, herhangi bir OlayType belirtilmezse, Reference için tüm geri aramalar kaldırılır.

Bireysel dinleyiciler, abonelikten çıkma geri çağrılarını çağırarak da kaldırılabilir.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Dinleyicinin kayıtlı olduğu sorgu.
etkinlik tipi Etkinlik tipi Aşağıdaki dizelerden biri: "değer", "child_added", "child_changed", "child_removed" veya "child_moved". Atlanırsa, Reference için tüm geri aramalar kaldırılır.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildname?: String | null) => Bilinmiyor Tüm geri çağrıları kaldırmak için on() aktarılan veya undefined geri arama işlevi.

İadeler:

geçersiz

onchildadded (sorgu, geri arama, iptal)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bu yerde her onChildAdded çocuk için bir kez tetiklenecek ve her yeni çocuk eklendiğinde tekrar tetiklenecektir. Geri çağrıya aktarılan DataSnapshot ilgili çocuğun verilerini yansıtacaktır. Sipariş amacıyla, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildname?: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildadded (sorgu, geri arama, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bu yerde her onChildAdded çocuk için bir kez tetiklenecek ve her yeni çocuk eklendiğinde tekrar tetiklenecektir. Geri çağrıya aktarılan DataSnapshot ilgili çocuğun verilerini yansıtacaktır. Sipariş amacıyla, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnChildAdded (Sorgu, Geri Arama, CangelCallback, Seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bu yerde her onChildAdded çocuk için bir kez tetiklenecek ve her yeni çocuk eklendiğinde tekrar tetiklenecektir. Geri çağrıya aktarılan DataSnapshot ilgili çocuğun verilerini yansıtacaktır. Sipariş amacıyla, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildchanged (sorgu, geri arama, iptal)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocukta (veya torunlarından herhangi birinde) depolanan veriler değiştiğinde onChildChanged bir olay tetiklenecektir. Tek bir child_changed olayın çocukta birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağrıya aktarılan DataSnapshot yeni çocuk içeriğini içerecek. Sipariş amacıyla, geri arama, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null olarak geçer.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildchanged (sorgu, geri arama, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocukta (veya torunlarından herhangi birinde) depolanan veriler değiştiğinde onChildChanged bir olay tetiklenecektir. Tek bir child_changed olayın çocukta birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağrıya aktarılan DataSnapshot yeni çocuk içeriğini içerecektir. Sipariş amacıyla, geri arama, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null olarak geçer.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildchanged (sorgu, geri arama, iptal, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocukta (veya torunlarından herhangi birinde) depolanan veriler değiştiğinde onChildChanged bir olay tetiklenecektir. Tek bir child_changed olayın çocukta birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağrıya aktarılan DataSnapshot yeni çocuk içeriğini içerecektir. Sipariş amacıyla, geri arama, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuksa null olarak geçer.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildmoved (sorgu, geri arama, iptal)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuğun sıralama sırası değiştiğinde, kardeşlerine göre konumunun değişeceği şekilde onChildMoved olayı tetiklenecektir. Geri çağrıya aktarılan DataSnapshot hareket eden çocuğun verileri için olacaktır. Ayrıca, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuk ise null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildmoved (sorgu, geri arama, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuğun sıralama sırası değiştiğinde, kardeşlerine göre konumunun değişeceği şekilde onChildMoved olayı tetiklenecektir. Geri çağrıya aktarılan DataSnapshot hareket eden çocuğun verileri için olacaktır. Ayrıca, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuk ise null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildmoved (sorgu, geri arama, iptal, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuğun sıralama sırası değiştiğinde, kardeşlerine göre konumunun değişeceği şekilde onChildMoved olayı tetiklenecektir. Geri çağrıya aktarılan DataSnapshot hareket eden çocuğun verileri için olacaktır. Ayrıca, önceki kardeş çocuğunun anahtarını sıralama sırasına göre içeren bir ip olan ikinci bir argüman veya ilk çocuk ise null .

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot , ÖncekiChildName: String | null) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

onchildremoved (sorgu, geri arama, iptal)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuk her çıkarıldığında onChildRemoved olayı tetiklenir. Geri çağrıya aktarılan DataSnapshot kaldırılan çocuğun eski verileri olacak. Bir çocuk da aşağıdakileri kaldırır.

  • Bir müşteri, o çocuğa veya atalarından birine - bir müşteri çağrısı set(null) bir müşteri çağrısı remove() açıkça ararlar - o çocuğa veya atalarından birine - tüm çocuklarının kaldırıldığı - şimdi filtreleyen bir sorgu var çocuktan çıkın (çünkü sıralama sırası değiştiğinden veya maksimum limit vuruldu)

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnchildRemoved (sorgu, geri arama, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuk her çıkarıldığında onChildRemoved olayı tetiklenir. Geri çağrıya aktarılan DataSnapshot kaldırılan çocuğun eski verileri olacak. Bir çocuk da aşağıdakileri kaldırır.

  • Bir müşteri, o çocuğa veya atalarından birine - bir müşteri çağrısı set(null) bir müşteri çağrısı remove() açıkça ararlar - o çocuğa veya atalarından birine - tüm çocuklarının kaldırıldığı - şimdi filtreleyen bir sorgu var çocuktan çıkın (çünkü sıralama sırası değiştiğinden veya maksimum limit vuruldu)

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnchildRemoved (sorgu, geri arama, iptal, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir çocuk her çıkarıldığında onChildRemoved olayı tetiklenir. Geri çağrıya aktarılan DataSnapshot kaldırılan çocuğun eski verileri olacak. Bir çocuk da aşağıdakileri kaldırır.

  • Bir müşteri, o çocuğa veya atalarından birine - bir müşteri çağrısı set(null) bir müşteri çağrısı remove() açıkça ararlar - o çocuğa veya atalarından birine - tüm çocuklarının kaldırıldığı - şimdi filtreleyen bir sorgu var çocuktan çıkın (çünkü sıralama sırası değiştiğinden veya maksimum limit vuruldu)

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama, bir dataSnapShot ve önceki çocuğun anahtarını içeren bir dize, sıralama sırasına göre veya ilk çocuksa null iletilecektir.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnValue (Sorgu, Geri Arama, CangelCallback)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve daha sonra veriler her değiştiğinde tekrar tetiklenir. Geri çağrıya aktarılan DataSnapshot on() nın çağrıldığı yer için olacaktır. Tüm içerik senkronize olana kadar tetiklenmez. Konumun verisi yoksa, boş bir DataSnapshot ( val() ile null . ).

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama bir DataSnapShot geçirilecek.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği) herhangi bir şekilde iptal edilirse bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnValue (sorgu, geri arama, seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve daha sonra veriler her değiştiğinde tekrar tetiklenir. Geri çağrıya aktarılan DataSnapshot on() nın çağrıldığı yer için olacaktır. Tüm içerik senkronize olana kadar tetiklenmez. Konumun verisi yoksa, boş bir DataSnapshot ( val() ile null . ).

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama bir DataSnapShot geçirilecek.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

OnValue (Sorgu, Geri Arama, CangelCallback, Seçenekler)

Belirli bir konumda veri değişikliklerini dinler.

Bir veritabanından verileri okumanın birincil yolu budur. İlk veriler için ve veriler her değiştiğinde geri aramanız tetiklenecektir. Güncellemeleri almayı durdurmak için Dönen Abscribe geri çağrısını çağırın. Daha fazla ayrıntı için Web'deki verileri alın.

Bir onValue olayı, bu konumda depolanan ilk verilerle bir kez tetiklenir ve daha sonra veriler her değiştiğinde tekrar tetiklenir. Geri çağrıya aktarılan DataSnapshot on() nın çağrıldığı yer için olacaktır. Tüm içerik senkronize olana kadar tetiklenmez. Konumun verisi yoksa, boş bir DataSnapshot ( val() ile null . ).

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Çalıştırılacak sorgu.
geri çağırmak (Anlık görüntü: datasnapshot ) => Bilinmiyor Belirtilen olay meydana geldiğinde ateş eden bir geri arama. Geri arama bir DataSnapShot geçirilecek.
CangelCallback (hata: hata) => Bilinmiyor Müşterinizin bu verileri okumak için izni olmadığı için olay aboneliğiniz iptal edilirse (veya şimdi kaybettiği ancak şimdi kaybettiği için) bildirilecek isteğe bağlı bir geri arama. Bu geri arama, hatanın neden meydana geldiğini gösteren bir Error nesnesi geçirilecektir.
seçenekler Dinleme onlyOnce , daha sonra ilk çağrılmasından sonra dinleyiciyi kaldıran sadece yapılandırması için kullanılabilecek bir nesne.

İadeler:

Abonelikten çık

Dinleyiciyi kaldırmak için çağrılabilecek bir işlev.

Sorgu (Sorgu, QueryConstraints)

Ek sorgu kısıtlamaları da içerecek şekilde genişletilen yeni bir değişmez Query örneği oluşturur.

İmza:

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

Parametreler

Parametre Tip Tanım
sorgu Sorgu Yeni kısıtlamalar için bir temel olarak kullanılacak sorgu örneği.
queryconstraints Queryconstraint [] Uygulanacak QueryConstraint S listesi.

İadeler:

Sorgu

İstisnalar

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The reference to add OnDisconnect triggers for.

İadeler:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove 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.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to remove.

İadeler:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to atomically modify.
transactionUpdate (currentData: any) => unknown A developer-supplied function which will be passed the current data stored at this location (as a JavaScript object). The function should return the new value it would like written (as a JavaScript object). If undefined is returned (ie you return with no arguments) the transaction will be aborted and the data at this location will not be modified.
seçenekler TransactionOptions An options object to configure transactions.

İadeler:

Promise< 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.

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to write to.
değer Bilinmeyen The value to be written (string, number, boolean, object, array, or null).

İadeler:

Promise<void>

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 ).

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to write to.
öncelik string | sayı | hükümsüz The priority to be written (string, number, or null).

İadeler:

Promise<void>

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 ).

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to write to.
değer Bilinmeyen The value to be written (string, number, boolean, object, array, or null).
öncelik string | sayı | hükümsüz The priority to be written (string, number, or null).

İadeler:

Promise<void>

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 .

İmza:

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

Parametreler

Parametre Tip Tanım
referans DatabaseReference The location to write to.
değerler nesne Object containing multiple values.

İadeler:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

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 .

İmza:

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

Parametreler

Parametre Tip Tanım
değer sayı | string | boolean | hükümsüz 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.
anahtar sicim 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.

İadeler:

QueryConstraint

endBefore(value, key)

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.

İmza:

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

Parametreler

Parametre Tip Tanım
değer sayı | string | boolean | hükümsüz 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.
anahtar sicim 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.

İadeler:

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 .

İmza:

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

Parametreler

Parametre Tip Tanım
değer sayı | string | boolean | hükümsüz 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.
anahtar sicim 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.

İadeler:

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.

İmza:

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

Parametreler

Parametre Tip Tanım
değer sayı | string | boolean | hükümsüz 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.
anahtar sicim The child key to start after. This argument is only allowed if ordering by child, value, or priority.

İadeler:

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 .

İmza:

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

Parametreler

Parametre Tip Tanım
değer sayı | string | boolean | hükümsüz 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.
anahtar sicim The child key to start at. This argument is only allowed if ordering by child, value, or priority.

İadeler:

QueryConstraint

Etkinlik tipi

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

İmza:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

İmza:

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

Abonelikten çık

A callback that can invoked to remove a listener.

İmza:

export declare type Unsubscribe = () => void;