Firebase Realtime Database
İşlevler
İşlev | Açıklama |
---|---|
fonksiyon(uygulama, ...) | |
getDatabase(uygulama; url) | Sağlanan FirebaseApp ile ilişkilendirilmiş Realtime Database SDK'sının örneğini döndürür. Herhangi bir örnek yoksa veya mevcut örnek bir özel veritabanı URL'si kullanıyorsa yeni bir örneği varsayılan ayarlarla başlatır. |
fonksiyon(db, ...) | |
connectDatabaseEmulator(db, ana makine, bağlantı noktası, seçenekler) | Realtime Database emülatörüyle iletişim kurmak için sağlanan örneği değiştirin. Not: Bu yöntem başka bir işlem yapılmadan önce çağrılmalıdır. |
goÇevrimdışı(db) | Sunucuyla olan bağlantıyı keser (tüm Veritabanı işlemleri çevrimdışı olarak tamamlanır).İstemci otomatik olarak Veritabanı sunucusuyla kalıcı bir bağlantı sürdürür. Bu bağlantı süresiz olarak etkin kalır ve bağlantı kesildiğinde yeniden bağlanır. Ancak goOffline() ve goOnline() yöntemleri, kalıcı bağlantının istenmeyen olduğu durumlarda istemci bağlantısını denetlemek için kullanılabilir.İstemci çevrimdışıyken artık Veritabanı'ndan veri güncellemelerini almaz. Ancak yerel olarak gerçekleştirilen tüm Veritabanı işlemleri etkinlikleri hemen tetiklemeye devam ederek uygulamanızın normal şekilde çalışmaya devam etmesini sağlar. Ayrıca, yerel olarak gerçekleştirilen her işlem otomatik olarak sıraya alınır ve Database sunucusuna yeniden bağlanıldığında yeniden denenir.Veritabanına yeniden bağlanmak ve uzak etkinlikleri almaya başlamak için goOnline() sayfasına bakın. |
goOnline(db) | Sunucuya yeniden bağlanır ve çevrimdışı Veritabanı durumunu sunucu durumuyla senkronize eder.Bu yöntem, goOffline() ile etkin bağlantı devre dışı bırakıldıktan sonra kullanılmalıdır. Yeniden bağlandığında istemci uygun verileri iletir ve istemcinizin "yakalaması" için uygun etkinlikleri tetikler. otomatik olarak oluşturur. |
ref(db; yol) | Veritabanındaki, sağlanan yola karşılık gelen konumu temsil eden bir Reference döndürür. Herhangi bir yol sağlanmazsa Reference , Veritabanının köküne işaret eder. |
refFromURL(db, url) | Veritabanında sağlanan Firebase URL'sine karşılık gelen 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 alan adına sahipse istisnai iptal edilir.Tüm sorgu parametrelerinin (orderBy , limitToLast vb.) yoksayıldığını ve döndürülen Reference öğesine uygulanmadığını unutmayın. |
fonksiyon() | |
forceLongPolling() | Websockets yerine longPolling kullanımını zorunlu kıl. DatabaseURL'de websocket protokolü kullanılırsa bu yoksayılır. |
forceWebSockets() | LongPolling yerine websocket kullanımını zorunlu kıl. |
orderByKey(). | Anahtara göre sıralayan yeni bir QueryConstraint oluşturur.Sorgu sonuçlarını (artan) anahtar değerlerine göre sıralar.Verileri sıralama bölümünde orderByKey() hakkında daha fazla bilgi edinebilirsiniz. |
orderByPriority(). | Önceliğe göre sıralanan yeni bir QueryConstraint oluşturur.Uygulamaların öncelik kullanmasına gerek yoktur, ancak koleksiyonları normal özelliklere göre sıralayabilir (öncelik alternatifleri için Verileri sıralama bölümüne bakın). |
orderByValue(). | Değere göre sıralayan yeni bir QueryConstraint oluşturur.Bir sorgunun alt öğelerinin tümü skaler değerlerden (dize, sayı veya boole) oluşuyorsa sonuçları onlara (artan) değerlerine göre sıralayabilirsiniz.Verileri sıralama bölümünde orderByValue() hakkında daha fazla bilgi edinebilirsiniz. |
serverTimestamp() | Firebase sunucuları tarafından belirlenen ve geçerli zaman damgasını (Unix döneminden beri geçen süre, milisaniye cinsinden) otomatik olarak doldurmak için bir yer tutucu değer döndürür. |
fonksiyon(delta, ...) | |
artım(delta) | Geçerli veritabanı değerini sağlanan delta kadar atomik olarak artırmak için kullanılabilecek bir yer tutucu değer döndürür. |
fonksiyon(etkin, ...) | |
enableLogging(etkin, kalıcı) | Hata ayıklama bilgilerini konsola kaydeder. |
function(limit, ...) | |
limitToFirst(sınır) | Belirli bir ilk alt öğe sayısıyla sınırlı olan yeni bir QueryConstraint oluşturur.limitToFirst() yöntemi, belirli bir geri çağırma için senkronize edilecek maksimum alt öğe sayısını ayarlamak için kullanılır. 100 şeklinde bir sınır belirlersek başlangıçta yalnızca en fazla 100 child_added etkinliği alırız. Veritabanımızda depolanan mesaj sayısı 100'den azsa her ileti için bir child_added etkinliği tetiklenir. Ancak 100'den fazla mesajımız varsa sadece sipariş edilen ilk 100 mesaj için bir child_added etkinliği alırız. Öğeler değiştikçe etkin listeden çıkan her öğe için child_removed etkinlik alırız. Böylece toplam sayı 100'de kalır.Verileri filtreleme bölümünde limitToFirst() hakkında daha fazla bilgi edinebilirsiniz. |
limitToLast(sınır) | Yalnızca belirtilen son sayıda alt öğeyi döndürecek şekilde sınırlı yeni bir QueryConstraint oluşturur.limitToLast() yöntemi, belirli bir geri çağırma için senkronize edilecek maksimum alt öğe sayısını ayarlamak için kullanılır. 100 şeklinde bir sınır belirlersek başlangıçta yalnızca en fazla 100 child_added etkinliği alırız. Veritabanımızda depolanan mesaj sayısı 100'den azsa her ileti için bir child_added etkinliği tetiklenir. Ancak 100'den fazla mesajımız varsa sadece sipariş edilen son 100 mesaj için bir child_added etkinliği alırız. Öğeler değiştikçe etkin listeden çıkan her öğe için child_removed etkinlik alırız. Böylece toplam sayı 100'de kalır.Verileri filtreleme bölümünde limitToLast() hakkında daha fazla bilgi edinebilirsiniz. |
function(logger, ...) | |
enableLogging(logger) | Hata ayıklama bilgilerini konsola kaydeder. |
fonksiyon(üst, ...) | |
child(üst, yol) | Belirtilen göreli yoldaki konum için bir Reference alır.Göreli yol, basit bir alt ad (ör. "ada") veya eğik çizgiyle ayrılmış daha derin bir yol (örneğin, "ada/ad/ilk") olabilir. |
push(üst, değer) | Benzersiz bir anahtar kullanarak yeni bir alt konum oluşturur ve onun Reference değerini döndürür.Bu, bir öğe koleksiyonuna veri eklemek için en sık kullanılan kalıptır.push() öğesine bir değer sağlarsanız 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 öğesini başka bir yerde kullanabilirsiniz).push() tarafından oluşturulan benzersiz anahtarlar geçerli zamana göre sıralanır. Bu nedenle, sonuç olarak elde edilen öğe listesi kronolojik olarak sıralanır. Anahtarlar ayrıca tahmin edilemez olacak şekilde tasarlanmıştır (72 rastgele entropi biti içerirler).Veri listesine ekleme bölümüne bakın. Benzersiz Tanımlayıcılar Sağlamanın 2^120 Yolu bölümüne bakın. |
fonksiyon(yol; ...) | |
orderByChild(path) | Belirtilen alt anahtara göre sıralayan yeni bir QueryConstraint oluşturur.Sorgular aynı anda yalnızca bir anahtara göre sıralanabilir. orderByChild() öğesini aynı sorguda birden çok kez çağırmak hatadır.Firebase sorguları, verilerinizi anında herhangi bir alt anahtara göre sıralamanıza olanak tanır. Bununla birlikte, dizinlerinizin ne olacağını önceden biliyorsanız daha iyi performans için Güvenlik Kurallarınızdaki .indexOn kuralıyla tanımlayabilirsiniz. Daha fazla bilgi için https://firebase.google.com/docs/database/security/indexing-data kuralını inceleyin.Verileri sıralama bölümünde orderByChild() hakkında daha fazla bilgi edinebilirsiniz. |
fonksiyon(sorgu, ...) | |
get(sorgu) | Bu sorgu için en güncel sonucu alır. |
off(query, eventType, callback) | İlgili on() (onValue , onChildAdded ) işleyicisine daha önce ekli bir geri çağırmayı ayırır. Not: Bir işleyiciyi kaldırmak için bu yöntemin önerilmez. Bunun yerine, lütfen ilgili on geri çağırmasından döndürülen geri çağırma işlevini kullanın.on*() ile ekli olan bir geri çağırmayı çıkarın. Bir üst işleyicide off() çağrısı yapıldığında alt düğümlerde kayıtlı işleyiciler otomatik olarak kaldırılmaz. Geri çağırmanın kaldırılması için tüm alt işleyicilerde de off() çağrılmalıdır.Geri çağırma belirtilmezse belirtilen eventType için tüm geri çağırmalar kaldırılır. Benzer şekilde, herhangi bir eventType belirtilmezse Reference için tüm geri çağırmalar kaldırılır.Bağımsız dinleyiciler, e-posta listesinden çıkma geri çağırmaları yapılarak da kaldırılabilir. |
onChildAttach(sorgu, geri çağırma, cancelCallback) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bu konumdaki her ilk çocuk için bir onChildAdded etkinliği tetiklenir ve her yeni alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null iletilir. |
onChildAdded(sorgu, geri arama, seçenekler) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bu konumdaki her ilk çocuk için bir onChildAdded etkinliği tetiklenir ve her yeni alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null iletilir. |
onChildadded(sorgu, geri çağırma, iptalCallback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bu konumdaki her ilk çocuk için bir onChildAdded etkinliği tetiklenir ve her yeni alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null iletilir. |
onChildChanged(query, callback, cancelCallback) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde onChildChanged etkinliği tetiklenir. Tek bir child_changed etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot , yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null de iletilir. |
onChildChanged(sorgu, geri arama, seçenekler) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde onChildChanged etkinliği tetiklenir. Tek bir child_changed etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot , yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null de iletilir. |
onChildChanged(sorgu, geri çağırma, cancelCallback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde onChildChanged etkinliği tetiklenir. Tek bir child_changed etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot , yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null de iletilir. |
onChildMoved(sorgu, geri çağırma, iptalCallback) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bir alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null iletilir. |
onChildMoved(sorgu, geri çağırma, seçenekler) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bir alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null iletilir. |
onChildMoved(sorgu, geri çağırma, cancelCallback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma konusuna bakın.Bir alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null iletilir. |
onChildRemoved(query, callback, cancelCallback) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Her alt öğe kaldırıldığında bir onChildRemoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , kaldırılan alt hesabın eski verileri olur. Bir alt öğe şu durumlarda kaldırılır:- bir istemci bu alt ya da üst öğelerinden biri için açıkça remove() çağrısı yaptığında (istemci bu alt veya üst öğelerinden biri için set(null) çağrısı yaptığında) söz konusu alt çocuğun tüm alt öğeleri kaldırılırsa geçerli bir sorgu olduğunda alt öğe filtrelenir (sıralama ölçütü değiştiği veya maksimum sınıra ulaşıldığı için) |
onChildRemoved(query, callback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Her alt öğe kaldırıldığında bir onChildRemoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , kaldırılan alt hesabın eski verileri olur. Bir alt öğe şu durumlarda kaldırılır:- bir istemci bu alt ya da üst öğelerinden biri için açıkça remove() çağrısı yaptığında (istemci bu alt veya üst öğelerinden biri için set(null) çağrısı yaptığında) söz konusu alt çocuğun tüm alt öğeleri kaldırılırsa geçerli bir sorgu olduğunda alt öğe filtrelenir (sıralama ölçütü değiştiği veya maksimum sınıra ulaşıldığı için) |
onChildRemoved(query, callback, cancelCallback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha ayrıntılı bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.Her alt öğe kaldırıldığında bir onChildRemoved etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot , kaldırılan alt hesabın eski verileri olur. Bir alt öğe şu durumlarda kaldırılır:- bir istemci bu alt ya da üst öğelerinden biri için açıkça remove() çağrısı yaptığında (istemci bu alt veya üst öğelerinden biri için set(null) çağrısı yaptığında) söz konusu alt çocuğun tüm alt öğeleri kaldırılırsa geçerli bir sorgu olduğunda alt öğe filtrelenir (sıralama ölçütü değiştiği veya maksimum sınıra ulaşıldığı için) |
onValue(sorgu, geri çağırma, iptalCallback) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma bölümünü inceleyin.Bir onValue etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , on() çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot ile tetiklenir (val() , null değerini döndürür). |
onValue(sorgu, geri çağırma, seçenekler) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma bölümünü inceleyin.Bir onValue etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , on() çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot ile tetiklenir (val() , null değerini döndürür). |
onValue(query, callback, cancelCallback, options) | Belirli bir konumdaki veri değişikliklerini dinler.Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla ayrıntı için Web'de Veri Alma bölümünü inceleyin.Bir onValue etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot , on() çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot ile tetiklenir (val() , null değerini döndürür). |
sorgu(sorgu; queryConstraints) | Ek sorgu kısıtlamaları da içerecek şekilde genişletilen yeni bir Query örneği oluşturur. |
function(ref, ...) | |
onBağlantıyı kesme(ref) | Bir OnDisconnect nesnesini döndürür. Bu nesnenin nasıl kullanılacağı hakkında daha fazla bilgi için JavaScript'te Çevrimdışı Özellikleri Etkinleştirme konusuna bakın. |
remove(ref) | Bu Veritabanı konumundaki verileri kaldırır.Alt konumlardaki tüm veriler de silinir.Kaldırma işleminin etkisi hemen görünür ve ilgili etkinlik "value" görünür. tetiklenecektir. Kaldırma işleminin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Vaat, işlem tamamlandığında çözüme ulaştırılır. Sağlanmışsa, onComplete geri çağırması senkronizasyon bittikten sonra eşzamansız olarak çağrılır. |
runTransaction(ref, transactionUpdate, options) | Bu konumdaki verileri anomik olarak değiştirir.Bu konumdaki verileri atomik olarak değiştirin. Önceki değerinden bağımsız olarak verilerin üzerine yazan normal set() işlevinin aksine runTransaction() , mevcut değeri yeni bir değerle değiştirmek için kullanılır. Böylece, aynı konuma aynı anda yazan diğer istemcilerle çakışma olmaması sağlanır.Bunu başarmak için runTransaction() , mevcut değeri yeni bir değere dönüştürmek için kullanılan bir güncelleme işlevi aktarır. Başka bir istemci yeni değeriniz başarıyla yazılmadan önce konuma yazarsa güncelleme işleviniz yeni geçerli değerle tekrar çağrılır ve yazma işlemi yeniden denenir. Bu durum, yazma işleminiz çakışma olmadan başarılı olana veya siz güncelleme işlevinizden bir değer döndürmeyerek işlemi iptal edene kadar tekrar eder.Not: set() ile verilerde değişiklik yaptığınızda, söz konusu konumdaki bekleyen tüm işlemler iptal edilir. Bu nedenle, aynı verileri güncellemek için set() ve runTransaction() hizmetlerini birlikte kullanırken son derece dikkatli olmalısınız.Not: İşlemleri Güvenlik ve Firebase Kurallarıyla kullanırken, istemcinin işlem gerçekleştirmek için .write erişimine ek olarak .read erişimine ihtiyacı olduğunu unutmayın. Bunun nedeni, işlemlerin istemci tarafı yapısının, verileri işlemsel olarak güncellemek için istemcinin verileri okumasını gerektirmesidir. |
set(ref; değer) | Bu Veritabanı konumuna veri yazar.Bu işlem, bu konumdaki ve tüm alt konumlardaki tüm verilerin üzerine yazar.Yazma işleminin etkisi hemen görünür ve ilgili etkinlikler ("value", "child_added" vb.) tetiklenir. Verilerin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Promise işlem tamamlandığında çözüme kavuşturulur. Sağlanmışsa, senkronizasyon bittikten sonra onComplete geri çağırması eşzamansız olarak çağrılacaktır.Yeni değer için null değerinin iletilmesi, remove() çağrısına eşdeğerdir; diğer bir deyişle, 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ı amaçlanıyorsa bunun yerine setWithPriority() yöntemini kullanmanız gerekir.set() ile verilerin değiştirilmesinin, ilgili konumdaki beklemedeki tüm işlemleri iptal edeceğini unutmayın. Bu nedenle, aynı verileri değiştirmek için set() ve transaction() öğelerini birlikte kullanırken son derece dikkatli olmalısınız.Tek bir set() tek bir "değer" oluşturur. set() etkinliği gerçekleştirildiği yerdeki etkinlik. |
setPriority(ref, öncelik) | Bu Veritabanı konumundaki veriler için bir öncelik ayarlar.Uygulamaların öncelik kullanması gerekmez, ancak koleksiyonları normal özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme). |
setWithPriority(ref; değer; öncelik) | Verileri Veritabanı konumuna yazar. set() işlevine benzer ancak aynı zamanda bu verilerin önceliğini de belirtir.Uygulamaların öncelik kullanması gerekmez ancak koleksiyonları normal özelliklere göre sıralayabilir (bkz. Verileri sıralama ve filtreleme). |
update(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 fazla özellik-değer çifti içeriyor. Her alt mülk, basit bir mülk (örneğin, "ad") veya mevcut konumdan güncelleme yapılacak verilere giden göreli bir yol (örneğin, "ad/ad") olabilir.set() yönteminin aksine, update() (geçerli konumdaki tüm alt mülkleri değiştirmek yerine) yalnızca geçerli konumdaki referans verilen özellikleri seçerek güncellemek için kullanılabilir.Yazma işleminin etkisi hemen gösterilir ve ilgili etkinlikler ("value" gibi). Verilerin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Promise işlem tamamlandığında çözüme kavuşturulur. Sağlanırsa onComplete geri çağırması, senkronizasyon bittikten sonra eşzamansız olarak çağrılır.Tek bir update() , tek bir "değer" oluşturur update() öğesinin gerçekleştirildiği konumdaki etkinlik.Verilerin update() ile değiştirilmesinin söz konusu konumdaki bekleyen tüm işlemleri iptal edeceğini unutmayın. Bu nedenle, aynı verileri değiştirmek için update() ve transaction() kullanılıyorsa çok dikkatli olunmalıdır.null uygulamasının update() ürününe iletilmesi, bu konumdaki verilerin kaldırılmasına neden olur.Çok konumlu güncellemeler ve daha fazlasının kullanıma sunulması bölümünü inceleyin. |
function(değer, ...) | |
endAt(değer; anahtar) | Belirtilen bitiş noktasıyla bir QueryConstraint oluşturur.startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanarak sorgularınız için rastgele başlangıç ve bitiş noktaları seçebilirsiniz.Bitiş noktası kapsayıcıdır, bu nedenle tam olarak belirtilen değere sahip alt öğeler sorguya dahil edilir. İsteğe bağlı anahtar bağımsız değişkeni, sorgunun aralığını daha fazla sınırlamak için kullanılabilir. Belirtilmişse tam olarak belirtilen değere sahip alt öğelerin de 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ıyla (hariç) bir QueryConstraint oluşturur.startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanarak sorgularınız için rastgele başlangıç ve bitiş noktaları seçebilirsiniz.Bitiş noktası özeldir. Yalnızca bir değer sağlanırsa belirtilen değerden düşük bir değere sahip alt öğeler sorguya dahil edilir. Bir anahtar belirtilirse alt öğelerin, belirtilen değerden küçük veya ona eşit bir değere ve belirtilen anahtardan küçük bir anahtar adına sahip olması gerekir. |
equalTo(değer; anahtar) | Belirtilen değerle eşleşen alt öğeleri içeren bir QueryConstraint oluşturur.startAt() , startAfter() , endBefore() , endAt() ve equalTo() kullanılması sorgularınız için rastgele başlangıç ve bitiş noktaları seçmenize olanak tanır.İsteğe bağlı temel bağımsız değişken, sorgu aralığını daha da sınırlamak için kullanılabilir. Belirtilmişse tam olarak belirtilen değere sahip alt yayıncılar, anahtar adı olarak belirtilen anahtarı da tam olarak kullanmalıdır. Bu özellik, aynı değer için çok sayıda eşleşme içeren 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ıyla (hariç) bir QueryConstraint oluşturur.startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanarak sorgularınız için rastgele başlangıç ve bitiş noktaları seçebilirsiniz.Başlangıç noktası özeldir. Yalnızca değer sağlanırsa belirtilen değerden büyük olan alt öğeler sorguya dahil edilir. Bir anahtar belirtilirse alt öğelerin, 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ıyla bir QueryConstraint oluşturur.startAt() , startAfter() , endBefore() , endAt() ve equalTo() öğelerini kullanarak sorgularınız için rastgele başlangıç ve bitiş noktaları seçebilirsiniz.Başlangıç noktası kapsayıcıdır, bu nedenle tam olarak belirtilen değere sahip alt öğeler sorguya dahil edilir. İsteğe bağlı anahtar bağımsız değişkeni, sorgunun aralığını daha fazla sınırlamak için kullanılabilir. Belirtilmişse tam olarak belirtilen değere sahip alt öğelerin de belirtilen anahtardan büyük veya ona eşit bir anahtar adına sahip olması gerekir.Verileri filtreleme bölümünde startAt() hakkında daha fazla bilgi edinebilirsiniz. |
Sınıflar
Sınıf | Açıklama |
---|---|
Veritabanı | Firebase Realtime Database'i temsil eden sınıf. |
DataSnapshot | DataSnapshot , bir Veritabanı konumundan veriler içerir.Veritabanı'ndan her veri okuduğunuzda verileri DataSnapshot olarak alırsınız. on() veya once() ile eklediğiniz etkinlik geri çağırmalarına bir DataSnapshot iletilir. val() yöntemini çağırarak anlık görüntünün içeriğini JavaScript nesnesi olarak ayıklayabilirsiniz. Alternatif olarak, alt anlık görüntüleri döndürmek için child() öğesini çağırarak anlık görüntüye gezinebilirsiniz (daha sonra val() öğesini çağırabilirsiniz).DataSnapshot , bir Veritabanı konumundaki verilerin verimli bir şekilde oluşturulmuş ve sabit bir kopyasıdır. Değiştirilemez ve hiçbir zaman değiştirilmez (verileri değiştirmek için her zaman doğrudan bir Reference üzerinde set() yöntemini çağırırsınız). |
Bağlantıyı Kes | onDisconnect sınıfı, istemcinizin Veritabanı sunucusuyla olan bağlantısı kesildiğinde veri yazmanıza veya verileri temizlemenize olanak tanır. Bu güncellemeler, istemcinizin bağlantısı düzgün bir şekilde kesilip kesilmemesinden bağımsız olarak gerçekleşir. Bu nedenle, bağlantı kesilse veya istemci çökse bile verileri temizleme konusunda bu güncellemelerin uygulanmasına güvenebilirsiniz.onDisconnect sınıfı en yaygın olarak, kaç istemcinin bağlı olduğunu ve diğer istemcilerin bağlantısını kestiğinde tespit edilmesinin yararlı olduğu uygulamalardaki varlığı yönetmek için kullanılır. Daha fazla bilgi için JavaScript'te Çevrimdışı Özellikleri Etkinleştirme bölümüne bakın.İstekler Veritabanı sunucusuna aktarılmadan önce bir bağlantı kesildiğinde sorun yaşamamak için bu işlevler herhangi bir veri yazmadan önce çağrılmalıdır.onDisconnect işlemlerinin yalnızca bir kez tetiklendiğini unutmayın. Her bağlantı kesildiğinde işlemin gerçekleşmesini istiyorsanız, yeniden bağlandığınızda onDisconnect işlemlerini yeniden oluşturmanız gerekir. |
SorguKısıtlaması | QueryConstraint , bir Veritabanı sorgusu tarafından döndürülen doküman grubunu daraltmak için kullanılır. QueryConstraint QueryConstraint |
TransactionResult | runTransaction() çözümleme değeri için bir tür. |
Arayüzler
Arayüz | Açıklama |
---|---|
DatabaseReference | DatabaseReference , Veritabanınızdaki belirli bir konumu temsil eder ve o Veritabanı konumuna veri okumak veya yazmak için kullanılabilir.Veritabanınızdaki kök veya alt konuma ref() ya da ref("child/path") çağırarak referans verebilirsiniz.Yazma set() yöntemi, okuma işlemi ise on*() yöntemiyle yapılabilir. https://firebase.google.com/docs/database/web/read-and-Write adresine göz atın. |
IteratedDataSnapshot | Yinelenen bir Reference öğesinin alt anlık görüntüsünü temsil eder. Anahtar hiçbir zaman tanımsız olmayacak. |
ListenOptions (Dinleme Seçenekleri) | İşleyiciyi özelleştirmek için kullanılabilecek seçenek nesneleridir. |
Sorgu | Query , Veritabanı konumundaki verileri sıralayıp filtreleyerek alt verilerin yalnızca bir alt kümesini dahil eder. Bu, veri koleksiyonunu belirli bir özelliğe (ör. dinozorların yüksekliği) göre sıralamanın yanı sıra büyük bir öğe listesini (örneğin, sohbet mesajları) istemciyle senkronize edilmeye uygun bir sayıyla kısıtlamak için de kullanılabilir. Sorgular, burada tanımlanan filtre yöntemlerinden biri veya daha fazlası zincirlenerek oluşturulur.Tıpkı DatabaseReference ürününde olduğu gibi, on*() yöntemlerini kullanarak bir Query kaynağından veri alabilirsiniz. Yalnızca sorgunuzla eşleşen verilerin alt kümesi için etkinlik ve DataSnapshot alırsınız.Daha fazla bilgi için https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data adresini ziyaret edin. |
ThenableReference | push() ile döndürüldüğünde bir DatabaseReference işlevi görebilecek bir Promise . Referans hemen kullanılabilir hale gelir ve arka uca yazma işlemi tamamlandığında Promise çözümlenir. |
İşlem Seçenekleri | İşlemleri yapılandıran bir seçenekler nesnesi. |
Tür Takma Adları
Takma Ad yazın | Açıklama |
---|---|
EventType | Şu dizelerden biri: "value", "child_added", "child_changed", "child_removed" veya "child_moved". |
QueryConstraintType | Bu SDK'da kullanılabilen farklı sorgu kısıtlamalarını açıklar. |
E-posta listesinden çık | İşleyiciyi kaldırmak için çağrılabilen bir geri çağırma. |
function(uygulama; ...)
getDatabase(uygulama; url)
Sağlanan FirebaseApp ile ilişkilendirilmiş Realtime Database SDK'sının örneğini döndürür. Herhangi bir örnek yoksa veya mevcut örnek bir özel veritabanı URL'si kullanıyorsa yeni bir örneği varsayılan ayarlarla başlatır.
İmza:
export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
uygulama | FirebaseUygulaması | Döndürülen Realtime Database örneğinin ilişkilendirildiği FirebaseApp örneği. |
url | dize | Bağlanılacak Realtime Database örneğinin URL'si. SDK sağlanmazsa Firebase uygulamasının varsayılan örneğine bağlanır. |
Şunu döndürür:
Sağlanan uygulamanın Database
örneği.
function(db; ...)
connectDatabaseEmulator(db, ana makine, bağlantı noktası, seçenekler)
Realtime Database emülatörüyle iletişim kurmak için sağlanan örneği değiştirin.
Not: Bu yöntem başka bir işlem yapılmadan önce çağrılmalıdır.
İmza:
export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
db | Veritabanı | Değiştirilecek örnek. |
düzenleyen | dize | Emülatör ana makinesi (ör. localhost) |
bağlantı noktası | sayı | Emülatör bağlantı noktası (ör. 8080) |
seçenekler | { mockUserToken?: EmulatorMockTokenOptions | string; } |
Şunu döndürür:
geçersiz
goÇevrimdışı(db)
Sunucu bağlantısı kesilir (tüm Veritabanı işlemleri çevrimdışı olarak tamamlanır).
İstemci otomatik olarak Veritabanı sunucusuyla kalıcı bir bağlantı sürdürür, bu bağlantı süresiz olarak etkin kalır ve bağlantı kesildiğinde yeniden bağlanır. Bununla birlikte, kalıcı bağlantının istenmeyen olduğu 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üncellemelerini almaz. Ancak yerel olarak gerçekleştirilen tüm Veritabanı işlemleri etkinlikleri hemen tetiklemeye devam ederek uygulamanızın normal şekilde çalışmaya devam etmesini sağlar. Ayrıca, yerel olarak gerçekleştirilen her işlem otomatik olarak sıraya alınır ve Veritabanı sunucusuna yeniden bağlanıldığında yeniden denenir.
Veritabanına yeniden bağlanmak ve uzaktan etkinlik almaya başlamak için goOnline()
adresini ziyaret edin.
İmza:
export declare function goOffline(db: Database): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
db | Veritabanı | Bağlantısı kesilecek örnek. |
Şunu döndürür:
geçersiz
GoOnline(db)
Sunucuya yeniden bağlanır ve çevrimdışı Veritabanı durumunu sunucu durumuyla senkronize eder.
Bu yöntem goOffline()
ile etkin bağlantı devre dışı bırakıldıktan sonra kullanılmalıdır. Yeniden bağlandığında istemci uygun verileri iletir ve istemcinizin "yakalaması" için uygun etkinlikleri tetikler. otomatik olarak oluşturur.
İmza:
export declare function goOnline(db: Database): void;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
db | Veritabanı | Yeniden bağlanılacak örnek. |
Şunu döndürür:
geçersiz
ref(db; yol)
Veritabanındaki, sağlanan yola karşılık gelen konumu temsil eden bir Reference
döndürür. Herhangi bir yol sağlanmazsa Reference
, Veritabanının köküne işaret eder.
İmza:
export declare function ref(db: Database, path?: string): DatabaseReference;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
db | Veritabanı | Referans alınacak veritabanı örneği. |
yol | dize | Döndürülen Reference öğesinin göstereceği konumu temsil eden isteğe bağlı yol. Sağlanmazsa döndürülen Reference , Veritabanının köküne işaret eder. |
Şunu döndürür:
Bir yol sağlanmışsa sağlanan yolu işaret eden bir Reference
. Aksi takdirde, Veritabanının kökünü gösteren bir Reference
.
refFromURL(db; url)
Veritabanındaki, sağlanan Firebase URL'sine karşılık gelen konumu temsil eden bir Reference
döndürür.
URL geçerli bir Firebase Veritabanı URL'si değilse veya alan adı geçerli Database
örneğinden farklı bir alan adına sahipse istisna oluşur.
Tüm sorgu parametrelerinin (orderBy
, limitToLast
vb.) yoksayıldığını ve döndürülen Reference
öğesine uygulanmadığını unutmayın.
İmza:
export declare function refFromURL(db: Database, url: string): DatabaseReference;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
db | Veritabanı | Referans alınacak veritabanı örneği. |
url | dize | Döndürülen Reference parametresinin işaret edeceği Firebase URL'si. |
Şunu döndürür:
Sağlanan Firebase URL'sini işaret eden bir Reference
.
fonksiyon()
forceLongPolling()
Websockets yerine longPolling kullanımını zorunlu kıl. DatabaseURL'de websocket protokolü kullanılırsa bu yoksayılır.
İmza:
export declare function forceLongPolling(): void;
Şunu döndürür:
geçersiz
forceWebSockets()
LongPolling yerine websocket kullanımını zorunlu kıl.
İmza:
export declare function forceWebSockets(): void;
Şunu döndürür:
geçersiz
orderByKey()
Anahtara göre sıralayan yeni bir QueryConstraint
oluşturur.
Sorgu sonuçlarını (artan) anahtar değerlerine göre sıralar.
orderByKey()
hakkında daha fazla bilgiyi Verileri sıralama bölümünde bulabilirsiniz.
İmza:
export declare function orderByKey(): QueryConstraint;
Şunu döndürür:
orderByPriority()
Öncelik sırasına göre sıralayan yeni bir QueryConstraint
oluşturur.
Uygulamaların öncelik kullanması gerekmez ancak koleksiyonları normal mülklere göre sıralayabilir (öncelik alternatifleri için Verileri sıralama bölümüne bakın).
İmza:
export declare function orderByPriority(): QueryConstraint;
Şunu döndürür:
orderByValue()
Değere göre sıralanan yeni bir QueryConstraint
oluşturur.
Bir sorgunun alt öğelerinin tümü skaler değerlerden (dize, sayı veya boole) oluşuyorsa sonuçları (artan) değerlerine göre sıralayabilirsiniz.
orderByValue()
hakkında daha fazla bilgiyi Verileri sıralama bölümünde bulabilirsiniz.
İmza:
export declare function orderByValue(): QueryConstraint;
Şunu döndürür:
sunucuZaman Damgası()
Firebase sunucuları tarafından belirlenen ve geçerli zaman damgasını (Unix döneminden beri geçen süre, milisaniye cinsinden) otomatik olarak doldurmak için bir yer tutucu değer döndürür.
İmza:
export declare function serverTimestamp(): object;
Şunu döndürür:
nesne
function(delta; ...)
artım(delta)
Geçerli veritabanı değerini sağlanan delta kadar atomik olarak artırmak için kullanılabilecek bir yer tutucu değer döndürür.
İmza:
export declare function increment(delta: number): object;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
Delta | sayı | geçerli değer atomik olarak değiştirilecek miktar. |
Şunu döndürür:
nesne
Verileri sunucu tarafında temel olarak değiştirmek için bir yer tutucu değer.
işlev(etkin; ...)
allowLogging(etkin, kalıcı)
Hata ayıklama bilgilerini konsola kaydeder.
İmza:
export declare function enableLogging(enabled: boolean, persistent?: boolean): any;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
etkin | boolean | true ise günlüğe kaydetmeyi etkinleştirir, false ise günlük kaydını devre dışı bırakır. |
kalıcı | boolean | true ise sayfa yenilemeleri arasındaki günlük durumunu hatırlar. |
Şunu döndürür:
herhangi bir
function(sınır; ...)
limitToFirst(sınır)
Belirli ilk sayıda alt çocukla sınırlıysa yeni bir QueryConstraint
oluşturur.
limitToFirst()
yöntemi, belirli bir geri çağırma için senkronize edilecek maksimum alt yayıncı sayısını ayarlamak için kullanılır. 100 şeklinde bir sınır belirlersek başlangıçta yalnızca en fazla 100 child_added
etkinliği alırız. Veritabanımızda depolanan mesaj sayısı 100'den azsa her ileti için bir child_added
etkinliği tetiklenir. Ancak 100'den fazla mesajımız varsa sadece sipariş edilen ilk 100 mesaj için bir child_added
etkinliği alırız. Öğeler değiştikçe etkin listeden çıkan her öğe için child_removed
etkinlik sağlayacağız. Böylece toplam sayı 100'de kalır.
limitToFirst()
hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz.
İmza:
export declare function limitToFirst(limit: number): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
sınır | sayı | Bu sorguya dahil edilecek maksimum düğüm sayısı. |
Şunu döndürür:
limitToLast(sınır)
Yalnızca belirtilen son sayıda alt öğeyi döndürecek şekilde sınırlı yeni bir QueryConstraint
oluşturur.
limitToLast()
yöntemi, belirli bir geri çağırma için senkronize edilecek maksimum alt yayıncı sayısını ayarlamak için kullanılır. 100 şeklinde bir sınır belirlersek başlangıçta yalnızca en fazla 100 child_added
etkinliği alırız. Veritabanımızda depolanan mesaj sayısı 100'den azsa her ileti için bir child_added
etkinliği tetiklenir. Ancak 100'den fazla mesajımız varsa sadece sipariş edilen son 100 mesaj için bir child_added
etkinliği alırız. Öğeler değiştikçe etkin listeden çıkan her öğe için child_removed
etkinlik sağlayacağız. Böylece toplam sayı 100'de kalır.
limitToLast()
hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz.
İmza:
export declare function limitToLast(limit: number): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
sınır | sayı | Bu sorguya dahil edilecek maksimum düğüm sayısı. |
Şunu döndürür:
function(logger; ...)
allowLogging(günlük kaydedici)
Hata ayıklama bilgilerini konsola kaydeder.
İmza:
export declare function enableLogging(logger: (message: string) => unknown): any;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
logger | (message: dize) => bilinmiyor | İşlerin nasıl günlüğe kaydedildiğini kontrol eden özel bir logger işlevi. |
Şunu döndürür:
herhangi bir
function(üst öğe; ...)
alt(üst, yol)
Belirtilen göreli yoldaki konum için bir Reference
alır.
Göreli yol, basit bir alt ad (ör. "ada") veya eğik çizgiyle ayrılmış bir yol (örneğin, "ada/ad/ilk") olabilir.
İmza:
export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
üst | DatabaseReference | Üst konumdur. |
yol | dize | Bu konumdan istenen alt konuma giden göreli bir yol. |
Şunu döndürür:
Belirtilen alt konum.
push(üst; 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 sık kullanılan kalıptır.
push()
işlevine bir değer sağlarsanız bu 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
öğesini başka bir yerde kullanabilirsiniz).
push()
tarafından oluşturulan benzersiz anahtarlar geçerli zamana göre sıralandığından ortaya çıkan öğe listesi kronolojik olarak sıralanır. Anahtarlar aynı zamanda tahmin edilemez olacak şekilde tasarlanmıştır (Rastgele 72 entropi biti içerir).
Veri listesine ekleme başlıklı makaleyi inceleyin. Benzersiz Tanımlayıcılar Sağlamanın 2^120 Yolu bölümüne bakın.
İmza:
export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
üst | DatabaseReference | Üst konumdur. |
value | bilinmiyor | Oluşturulan konumda yazılacak isteğe bağlı değer. |
Şunu döndürür:
Promise
ve Reference
birleştirilmiş; değeri, yazma tamamlandığında çözümlenir ancak alt konuma Reference
olarak hemen kullanılabilir.
function(yol; ...)
OrderByChild(yol)
Belirtilen alt anahtara göre sıralayan yeni bir QueryConstraint
oluşturur.
Sorgular aynı anda yalnızca bir anahtara göre sıralanabilir. orderByChild()
uygulamasının aynı sorguda birden çok kez çağrılması hatadır.
Firebase sorguları, verilerinizi anında herhangi bir alt anahtara göre sıralamanıza olanak tanır. Bununla birlikte, dizinlerinizin ne olacağını önceden biliyorsanız daha iyi performans için Güvenlik Kurallarınızdaki .indexOn kuralıyla tanımlayabilirsiniz. Daha fazla bilgi için https://firebase.google.com/docs/database/security/indexing-data kuralını inceleyin.
orderByChild()
hakkında daha fazla bilgiyi Verileri sıralama bölümünde bulabilirsiniz.
İmza:
export declare function orderByChild(path: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
yol | dize | Sıralama ölçütü: |
Şunu döndürür:
function(sorgu; ...)
get(sorgu)
Bu sorgu için en güncel sonucu alır.
İmza:
export declare function get(query: Query): Promise<DataSnapshot>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
Şunu döndürür:
Promise<DataSnapshot>
Bir değer varsa sonuçta oluşturulan DataSnapshot'ı çözümleyen veya istemci bir değer döndüremiyorsa (ör. sunucuya erişilemiyorsa ve önbelleğe alınan hiçbir şey yoksa) reddeden bir Promise
.
off(sorgu, eventType, geri çağırma)
İlgili on*()
(onValue
, onChildAdded
) işleyicisine daha önce ekli bir geri aramayı kaldırır. Not: Bir işleyiciyi kaldırmak için bu yöntemin önerilmez. Bunun yerine, lütfen ilgili on*
geri çağırmasından döndürülen geri çağırma işlevini kullanın.
Daha önce on*()
ile ekli bir geri çağırmayı ayırın. Bir üst işleyicide off()
çağrısı yapıldığında alt düğümlerde kayıtlı işleyiciler otomatik olarak kaldırılmaz. Geri çağırmanın kaldırılması için off()
, tüm alt işleyicilerde de çağrılmalıdır.
Bir geri çağırma belirtilmezse belirtilen eventType için tüm geri çağırmalar kaldırılır. Benzer şekilde, herhangi bir eventType belirtilmezse Reference
için tüm geri çağırmalar kaldırılır.
Bağımsız dinleyiciler, abonelikten çıkma geri arama ç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 | Tür | Açıklama |
---|---|---|
query | Sorgu | İşleyicinin kaydedildiği sorgu. |
eventType | EventType | Şu dizelerden biri: "value", "child_added", "child_changed", "child_removed" veya "child_moved". Atlanırsa Reference için tüm geri çağırmalar kaldırılır. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName?: string | null) => bilinmiyor | Tüm geri çağırmaları kaldırmak için on() veya undefined işlevine geçirilen geri çağırma işlevi. |
Şunu döndürür:
geçersiz
onChildAttach(sorgu, geri çağırma, cancelCallback)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bu konumdaki her ilk alt öğe için bir onChildAdded
etkinliği tetiklenir ve yeni bir alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null
iletilir.
İmza:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName?: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildadded(sorgu, geri arama, seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bu konumdaki her ilk alt öğe için bir onChildAdded
etkinliği tetiklenir ve yeni bir alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null
iletilir.
İmza:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildAttach(sorgu, geri çağırma, cancelCallback, options)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bu konumdaki her ilk alt öğe için bir onChildAdded
etkinliği tetiklenir ve yeni bir alt öğe eklendiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, ilgili alt yayıncının verilerini yansıtır. Sıralama amacıyla, ikinci bir bağımsız değişken, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize veya ilk alt öğeyse null
iletilir.
İmza:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildChanged(sorgu; geri çağırma, cancelCallback)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde bir onChildChanged
etkinliği tetiklenir. Tek bir child_changed
etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot
, yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null
de iletilir.
İmza:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildChanged(sorgu, geri arama, seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde bir onChildChanged
etkinliği tetiklenir. Tek bir child_changed
etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot
, yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null
de iletilir.
İmza:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildChanged(sorgu; geri çağırma, cancelCallback, options)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir alt öğede (veya alt öğelerinde) depolanan veriler değiştiğinde bir onChildChanged
etkinliği tetiklenir. Tek bir child_changed
etkinliğinin, alt öğe için birden fazla değişikliği temsil edebileceğini unutmayın. Geri çağırmaya iletilen DataSnapshot
, yeni alt içerikleri barındırır. Sıralama amacıyla geri çağırma, ikinci bir bağımsız değişken de iletilir. Bu bağımsız değişken, sıralama düzenine göre önceki eşdüzey alt öğenin anahtarını içeren bir dizedir. İlk alt değişkense null
de iletilir.
İmza:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildMoved(sorgu, geri çağırma, cancelCallback)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null
iletilir.
İmza:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildMoved(sorgu, geri arama, seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null
iletilir.
İmza:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildMoved(sorgu, geri çağırma, cancelCallback, options)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Alt yayıncının sıralama düzeni, eşdüzeylerine göre konumu değişecek şekilde değiştiğinde onChildMoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, taşınan alt kullanıcının verileri içindir. Ayrıca, sıralama sırasına göre önceki eşdüzey alt öğenin anahtarını içeren bir dize olan ikinci bir bağımsız değişken veya ilk alt öğe ise null
iletilir.
İmza:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot, beforeChildName: string | null) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildRemoved(sorgu, geri çağırma, cancelCallback)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Her alt öğe kaldırıldığında bir onChildRemoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, kaldırılan alt hesabın eski verileri olur. Çocuklar şu durumlarda kaldırılır:
- bir istemci bu alt veya üst öğelerinden biri için açıkça
remove()
(istemci, bu alt öğe veya üst öğelerinden biri içinset(null)
çağırır) ve tüm alt öğeleri kaldırılmış olur ve geçerli bir sorgu vardır ve artık alt öğe filtrelenir (çünkü sıralama düzeni değiştiği ya da maksimum sınıra ulaşıldığı için).
İmza:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildRemoved(sorgu, geri arama, seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Her alt öğe kaldırıldığında bir onChildRemoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, kaldırılan alt hesabın eski verileri olur. Çocuklar şu durumlarda kaldırılır:
- bir istemci bu alt veya üst öğelerinden biri için açıkça
remove()
(istemci, bu alt öğe veya üst öğelerinden biri içinset(null)
çağırır) ve tüm alt öğeleri kaldırılmış olur ve geçerli bir sorgu vardır ve artık alt öğe filtrelenir (çünkü sıralama düzeni değiştiği ya da maksimum sınıra ulaşıldığı için).
İmza:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onChildRemoved(sorgu, geri çağırma, cancelCallback, options)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Her alt öğe kaldırıldığında bir onChildRemoved
etkinliği tetiklenir. Geri çağırmaya iletilen DataSnapshot
, kaldırılan alt hesabın eski verileri olur. Çocuklar şu durumlarda kaldırılır:
- bir istemci bu alt veya üst öğelerinden biri için açıkça
remove()
(istemci, bu alt öğe veya üst öğelerinden biri içinset(null)
çağırır) ve tüm alt öğeleri kaldırılmış olur ve geçerli bir sorgu vardır ve artık alt öğe filtrelenir (çünkü sıralama düzeni değiştiği ya da maksimum sınıra ulaşıldığı için).
İmza:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırma, sıralama düzenine göre bir DataSnapshot ve önceki alt öğenin anahtarını içeren bir dize ya da ilk alt öğeyse null iletir. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onValue(sorgu, geri çağırma, cancelCallback)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir onValue
etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, on()
çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot
ile tetiklenir (val()
, null
değerini döndürür).
İmza:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırmaya bir DataSnapshot aktarılır. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onValue(sorgu; geri arama; seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir onValue
etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, on()
çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot
ile tetiklenir (val()
, null
değerini döndürür).
İmza:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırmaya bir DataSnapshot aktarılır. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
onValue(sorgu; geri arama, iptalCallback, seçenekler)
Belirli bir konumdaki veri değişikliklerini dinler.
Bu, Veritabanı'ndaki verileri okumanın birincil yoludur. Geri çağırma işleminiz, ilk veriler için ve veriler her değiştiğinde tekrar tetiklenir. Güncelleme almayı durdurmak için döndürülen e-posta listesinden çıkma geri aramasını çağırın. Daha fazla bilgi için Web'de Veri Alma başlıklı makaleyi inceleyin.
Bir onValue
etkinliği, bu konumda depolanan ilk verilerle bir kez tetiklenir ve ardından veriler her değiştiğinde tekrar tetiklenir. Geri çağırmaya iletilen DataSnapshot
, on()
çağrıldığı konum için olacaktır. Bu işlem, içeriğin tamamı senkronize edilene kadar tetiklenmez. Konumda veri yoksa boş bir DataSnapshot
ile tetiklenir (val()
, null
değerini döndürür).
İmza:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Çalıştırılacak sorgu. |
geri çağırma | (anlık görüntü: DataSnapshot) => bilinmiyor | Belirtilen etkinlik gerçekleştiğinde tetiklenen bir geri çağırma. Geri çağırmaya bir DataSnapshot aktarılır. |
iptal | (hata: Hata) => bilinmiyor | İstemcinizin bu verileri okuma izni olmadığı (veya izni olmasına rağmen artık kaybettiği için) etkinlik aboneliğinizin iptal edilmesi halinde bildirilecek isteğe bağlı bir geri arama özelliği. Bu geri çağırma, hatanın neden oluştuğunu belirten bir Error nesnesi iletilecek. |
seçenekler | ListenOptions (Dinleme Seçenekleri) | onlyOnce hizmetini yapılandırmak için kullanılabilecek ve ilk çağrısından sonra işleyiciyi kaldıran bir nesnedir. |
Şunu döndürür:
İşleyiciyi kaldırmak için çağrılabilen bir işlev.
sorgu(sorgu; queryConstraints)
Ek sorgu kısıtlamaları da içerecek şekilde genişletilen yeni bir Query
örneği oluşturur.
İmza:
export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
query | Sorgu | Yeni kısıtlamalar için temel olarak kullanılacak Sorgu örneği. |
sorguKısıtlamaları | SorguKısıtlaması[] | Uygulanacak QueryConstraint listesi. |
Şunu döndürür:
İstisnalar
değerini girin.
function(ref; ...)
onBağlantıyı kesme(ref)
Bir OnDisconnect
nesnesini döndürür. Bu nesnenin nasıl kullanılacağı hakkında daha fazla bilgi için JavaScript'te Çevrimdışı Özellikleri Etkinleştirme konusuna bakın.
İmza:
export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | OnConnection tetikleyicilerinin ekleneceği referans. |
Şunu döndürür:
remove(ref)
Bu Veritabanı konumundaki verileri kaldırır.
Alt konumlardaki tüm veriler de silinir.
Kaldırma işleminin etkisi hemen görünür ve ilgili etkinlik "value" (değer) gösterilir. tetiklenecektir. Kaldırma işleminin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Vaat, işlem tamamlandığında çözüme ulaştırılır. Sağlanmışsa, onComplete geri çağırması senkronizasyon bittikten sonra eşzamansız olarak çağrılır.
İmza:
export declare function remove(ref: DatabaseReference): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Kaldırılacak konum. |
Şunu döndürür:
Taahhüt<void>
Sunucudan kaldırma işlemi tamamlandığında çözümlenir.
runTransaction(ref; transactionUpdate; seçenekler)
Bu konumdaki verileri anomik olarak değiştirir.
Bu konumdaki verileri atomik olarak değiştirin. Önceki değerinden bağımsız olarak verilerin üzerine yazan normal set()
yönteminin aksine runTransaction()
, mevcut değeri yeni bir değerle değiştirmek için kullanılır. Böylece, aynı konuma aynı anda yazan diğer istemcilerle çakışma olmaması sağlanır.
Bunu yapmak için runTransaction()
ürününe mevcut değeri yeni bir değere dönüştürmek için kullanılan bir güncelleme işlevi iletirsiniz. Başka bir istemci yeni değeriniz başarıyla yazılmadan önce konuma yazarsa güncelleme işleviniz yeni geçerli değerle tekrar çağrılır ve yazma işlemi yeniden denenir. Bu durum, yazma işleminiz çakışma olmadan başarılı olana veya güncelleme işlevinizden bir değer döndürmeyerek işlemi iptal edene kadar tekrar tekrar gerçekleşir.
İmza:
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Atom olarak değiştirilecek konum. |
transactionUpdate | (currentData: any) => bilinmiyor | Geliştirici tarafından sağlanan ve bu konumda saklanan mevcut verileri iletecek bir işlev (JavaScript nesnesi olarak). İşlev, yazılmasını istediği yeni değeri (JavaScript nesnesi olarak) döndürmelidir. undefined döndürülürse (yani bağımsız değişken olmadan döndürürseniz) işlem iptal edilir ve bu konumdaki veriler değiştirilmez. |
seçenekler | İşlem Seçenekleri | İşlemleri yapılandıran bir seçenekler nesnesi. |
Şunu döndürür:
Promise<TransactionResult>
Başarılı ve başarısız durumları ele almak için onComplete
geri çağırması yerine isteğe bağlı olarak kullanılabilecek bir Promise
.
set(ref; değer)
Bu Veritabanı konumuna veri yazar.
Bu işlem, bu konumdaki ve tüm alt konumlardaki verilerin üzerine yazacaktır.
Yazma işleminin etkisi hemen görünür ve ilgili etkinlikler ("value", "child_added" vb.) tetiklenir. Verilerin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Promise işlem tamamlandığında çözüme kavuşturulur. Sağlanmışsa onComplete
geri çağırması, senkronizasyon bittikten sonra eşzamansız olarak çağrılır.
Yeni değer için null
iletmek, remove()
yöntemini çağırmakla eşdeğerdir; diğer bir deyişle, bu konumdaki ve tüm alt konumlardaki tüm veriler silinecek.
set()
, bu konumda depolanan tüm öncelikleri kaldırır. Bu nedenle önceliğin korunması isteniyorsa bunun yerine setWithPriority()
yönergesini kullanmanız gerekir.
Verileri set()
ile değiştirmenin söz konusu konumdaki bekleyen tüm işlemleri iptal edeceğini unutmayın. Bu nedenle, aynı verileri değiştirmek için set()
ve transaction()
öğelerini birlikte kullanırken çok dikkatli olmalısınız.
Tek bir set()
tek bir "value" oluşturur set()
etkinliğinin gerçekleştirildiği yerdeki etkinliktir.
İmza:
export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Yazılacak konum. |
value | bilinmiyor | Yazılacak değer (dize, sayı, boole, nesne, dizi veya null). |
Şunu döndürür:
Taahhüt<void>
Sunucuya yazma tamamlandığında çözümlenir.
setPriority(ref; öncelik)
Bu Veritabanı konumundaki verilere öncelik verir.
Uygulamaların öncelik kullanması gerekmez ancak koleksiyonları normal mülklere göre sıralayabilir (Verileri sıralama ve filtreleme bölümüne bakın).
İmza:
export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Yazılacak konum. |
öncelik | dize | sayı | boş | Yazılacak öncelik (dize, sayı veya null). |
Şunu döndürür:
Taahhüt<void>
Sunucuya yazma tamamlandığında çözümlenir.
setWithPriority(ref; değer; öncelik)
Verileri Veritabanı konumuna yazar. set()
gibidir ancak bu verilerin önceliğini de belirtir.
Uygulamaların öncelik kullanması gerekmez ancak koleksiyonları normal mülklere göre sıralayabilir (Verileri sıralama ve filtreleme bölümüne bakın).
İmza:
export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Yazılacak konum. |
value | bilinmiyor | Yazılacak değer (dize, sayı, boole, nesne, dizi veya null). |
öncelik | dize | sayı | boş | Yazılacak öncelik (dize, sayı veya null). |
Şunu döndürür:
Taahhüt<void>
Sunucuya yazma tamamlandığında çözümlenir.
güncelleme(başvuru, değerler)
Veritabanına aynı anda birden fazla değer yazar.
values
bağımsız değişkeni, Veritabanına birlikte yazılacak birden fazla özellik-değer çifti içeriyor. Her alt mülk, basit bir özellik (ör. "ad") veya geçerli konumdan güncellenecek verilere giden göreli bir yol (ör. "ad/ad") olabilir.
set()
yönteminin aksine update()
, geçerli konumdaki tüm alt mülkleri değiştirmek yerine yalnızca geçerli konumdaki başvurulan özellikleri seçerek güncellemek için kullanılabilir.
Yazma işleminin etkisi hemen görünür ve ilgili etkinlikler ("value", "child_added" vb.) tetiklenir. Verilerin Firebase sunucularıyla senkronizasyonu da başlatılır ve döndürülen Promise işlem tamamlandığında çözüme kavuşturulur. Sağlanmışsa onComplete
geri çağırması, senkronizasyon bittikten sonra eşzamansız olarak çağrılır.
Tek bir update()
tek bir "value" oluşturur Değiştirilen çocuk sayısına bakılmaksızın, update()
işleminin gerçekleştirildiği konumdaki etkinlik.
Verileri update()
ile değiştirmenin söz konusu konumdaki bekleyen tüm işlemleri iptal edeceğini unutmayın. Bu nedenle, aynı verileri değiştirmek için update()
ve transaction()
öğelerini birlikte kullanırken çok dikkatli olmalısınız.
update()
adlı cihaza null
aktarmak bu konumdaki verilerin kaldırılmasına neden olur.
Çoklu konum güncellemeleri ve daha fazlasıyla tanışın başlıklı makaleyi inceleyin.
İmza:
export declare function update(ref: DatabaseReference, values: object): Promise<void>;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
referans | DatabaseReference | Yazılacak konum. |
values | nesne | Birden çok değer içeren nesne. |
Şunu döndürür:
Taahhüt<void>
Sunucuda güncelleme tamamlandığında çözümlenir.
fonksiyon(değer; ...)
endAt(değer; anahtar)
Belirtilen bitiş noktasıyla bir QueryConstraint
oluşturur.
startAt()
, startAfter()
, endBefore()
, endAt()
ve equalTo()
özelliklerini 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 alt öğeler sorguya dahil edilir. İsteğe bağlı anahtar bağımsız değişkeni, sorgunun aralığını daha fazla sınırlamak için kullanılabilir. Belirtilirse, tam olarak belirtilen değere sahip alt öğelerin de belirtilen anahtardan küçük veya ona eşit bir anahtar adına sahip olması gerekir.
endAt()
hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz.
İmza:
export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value | sayı | dize | boole | boş | Bitiş tarihi. Bağımsız değişken türü, bu sorguda hangi orderBy() işlevinin kullanıldığına bağlıdır. orderBy () türüyle eşleşen bir değer belirtin. orderByKey() ile birlikte kullanıldığında değer bir dize olmalıdır. |
anahtar | dize | Daha önce belirtilen önceliğe sahip alt öğeler arasında sonlanacak alt anahtar. Bu bağımsız değişkene yalnızca alt öğe, değer veya önceliğe göre sıralama yapılıyorsa izin verilir. |
Şunu döndürür:
endBefore(değer; anahtar)
Belirtilen bitiş noktasıyla (hariç) bir QueryConstraint
oluşturur.
startAt()
, startAfter()
, endBefore()
, endAt()
ve equalTo()
özelliklerini kullanmak, sorgularınız için rastgele başlangıç ve bitiş noktaları seçmenize olanak tanır.
Bitiş noktası dışlayıcıdır. Yalnızca bir değer sağlanırsa belirtilen değerden düşük bir değere sahip alt öğeler sorguya dahil edilir. Bir anahtar belirtilirse alt öğelerin, belirtilen değerden küçük veya ona eşit bir değere ve belirtilen anahtardan küçük bir anahtar adına sahip olması gerekir.
İmza:
export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value | sayı | dize | boole | boş | Kendinden önce bitecek değer. Bağımsız değişken türü, bu sorguda hangi orderBy() işlevinin kullanıldığına bağlıdır. orderBy () türüyle eşleşen bir değer belirtin. orderByKey() ile birlikte kullanıldığında değer bir dize olmalıdır. |
anahtar | dize | Daha önce belirtilen önceliğe sahip alt öğeler arasında önce sona erecek alt anahtar. Bu bağımsız değişkene yalnızca alt öğe, değer veya önceliğe göre sıralama yapılıyorsa izin verilir. |
Şunu döndürür:
eşittir(değer; anahtar)
Belirtilen değerle eşleşen alt öğeleri içeren bir QueryConstraint
oluşturur.
startAt()
, startAfter()
, endBefore()
, endAt()
ve equalTo()
özelliklerini 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, sorgunun aralığını daha fazla sınırlamak için kullanılabilir. Belirtilmişse tam olarak belirtilen değere sahip alt yayıncılar, anahtar adı olarak belirtilen anahtarı da tam olarak kullanmalıdır. Bu özellik, aynı değer için çok sayıda eşleşme içeren sonuç kümelerini filtrelemek için kullanılabilir.
equalTo()
hakkında daha fazla bilgiyi Verileri filtreleme bölümünde bulabilirsiniz.
İmza:
export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value | sayı | dize | boole | boş | Eşleştirilecek değerdir. Bağımsız değişken türü, bu sorguda hangi orderBy() işlevinin kullanıldığına bağlıdır. orderBy () türüyle eşleşen bir değer belirtin. orderByKey() ile birlikte kullanıldığında değer bir dize olmalıdır. |
anahtar | dize | Daha önce belirtilen önceliğe sahip alt öğeler arasında başlatılacak alt anahtar. Bu bağımsız değişkene yalnızca alt öğe, değer veya önceliğe göre sıralama yapılıyorsa izin verilir. |
Şunu döndürür:
startAfter(değer; anahtar)
Belirtilen başlangıç noktasıyla (hariç) bir QueryConstraint
oluşturur.
startAt()
, startAfter()
, endBefore()
, endAt()
ve equalTo()
özelliklerini kullanmak, sorgularınız için rastgele başlangıç ve bitiş noktaları seçmenize olanak tanır.
Başlangıç noktası dışlayıcıdır. Yalnızca değer sağlanırsa belirtilen değerden büyük olan alt öğeler sorguya dahil edilir. Bir anahtar belirtilirse alt öğelerin, 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.
İmza:
export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value | sayı | dize | boole | boş | Sonra başlayacak değer. Bağımsız değişken türü, bu sorguda hangi orderBy() işlevinin kullanıldığına bağlıdır. orderBy () türüyle eşleşen bir değer belirtin. orderByKey() ile birlikte kullanıldığında değer bir dize olmalıdır. |
anahtar | dize | Sonra başlanacak alt anahtar. Bu bağımsız değişkene yalnızca alt öğe, değer veya önceliğe göre sıralama yapılıyorsa izin verilir. |
Şunu döndürür:
startAt(değer; anahtar)
Belirtilen başlangıç noktasıyla bir QueryConstraint
oluşturur.
startAt()
, startAfter()
, endBefore()
, endAt()
ve equalTo()
özelliklerini 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 alt öğeler sorguya dahil edilir. İsteğe bağlı anahtar bağımsız değişkeni, sorgunun aralığını daha fazla sınırlamak için kullanılabilir. Belirtilirse, tam olarak belirtilen değere sahip alt öğelerin de 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.
İmza:
export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
Parametreler
Parametre | Tür | Açıklama |
---|---|---|
value | sayı | dize | boole | boş | Başlangıç değeri. Bağımsız değişken türü, bu sorguda hangi orderBy() işlevinin kullanıldığına bağlıdır. orderBy () türüyle eşleşen bir değer belirtin. orderByKey() ile birlikte kullanıldığında değer bir dize olmalıdır. |
anahtar | dize | Başlangıç için alt anahtardır. Bu bağımsız değişkene yalnızca alt öğe, değer veya önceliğe göre sıralama yapılıyorsa izin verilir. |
Şunu döndürür:
EventType
Şu dizelerden biri: "value", "child_added", "child_changed", "child_removed" veya "child_moved".
İmza:
export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
Sorgu SınırlamasıTürü
Bu SDK'da kullanılabilen farklı sorgu kısıtlamalarını açıklar.
İmza:
export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
Abonelikten çık
İşleyiciyi kaldırmak için çağrılabilen bir geri çağırma.
İmza:
export declare type Unsubscribe = () => void;