Baza danych czasu rzeczywistego Firebase
Funkcje
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
getDatabase(aplikacja, adres URL) | Zwraca instancję zestawu SDK bazy danych czasu rzeczywistego, która jest powiązana z dostarczoną aplikacją FirebaseApp . Inicjuje nową instancję z ustawieniami domyślnymi, jeśli żadna instancja nie istnieje lub jeśli istniejąca instancja używa niestandardowego adresu URL bazy danych. |
funkcja(db, ...) | |
connectDatabaseEmulator(db, host, port, opcje) | Zmodyfikuj podaną instancję, aby komunikować się z emulatorem bazy danych czasu rzeczywistego. Uwaga: Tę metodę należy wywołać przed wykonaniem jakiejkolwiek innej operacji. |
przejdź do trybu Offline (db) | Rozłącza się z serwerem (wszystkie operacje na bazie danych zostaną zakończone w trybie offline). Klient automatycznie utrzymuje trwałe połączenie z serwerem bazy danych, które pozostanie aktywne przez czas nieokreślony i ponownie połączy się po rozłączeniu. Jednakże metody goOffline() i goOnline() mogą służyć do kontrolowania połączenia klienta w przypadkach, gdy trwałe połączenie jest niepożądane. W trybie offline klient nie będzie już otrzymywać aktualizacji danych z bazy danych. Jednak wszystkie operacje na bazie danych wykonywane lokalnie będą nadal natychmiast wywoływać zdarzenia, umożliwiając normalne działanie aplikacji. Dodatkowo każda operacja wykonywana lokalnie zostanie automatycznie umieszczona w kolejce i ponowiona po ponownym połączeniu z serwerem bazy danych. Aby ponownie połączyć się z bazą danych i rozpocząć odbieranie zdalnych zdarzeń, zobacz goOnline() . |
idźOnline(db) | Ponownie łączy się z serwerem i synchronizuje stan bazy danych offline ze stanem serwera. Metodę tę należy zastosować po wyłączeniu aktywnego połączenia za pomocą goOffline() . Po ponownym połączeniu klient prześle odpowiednie dane i uruchomi odpowiednie zdarzenia, tak aby Twój klient automatycznie „nadrobił zaległości”. |
ref(db, ścieżka) | Zwraca Reference reprezentującą lokalizację w bazie danych odpowiadającą podanej ścieżce. Jeśli nie zostanie podana ścieżka, Reference wskaże katalog główny bazy danych. |
refFromURL(db, url) | Zwraca Reference reprezentującą lokalizację w bazie danych odpowiadającą podanemu adresowi URL Firebase. Zgłaszany jest wyjątek, jeśli adres URL nie jest prawidłowym adresem URL bazy danych Firebase lub ma inną domenę niż bieżąca instancja Database . Należy pamiętać, że wszystkie parametry zapytania ( orderBy , limitToLast itp.) są ignorowane i nie są stosowane do zwróconej Reference . |
funkcjonować() | |
wymuszenie długiego odpytywania() | Wymuś użycie longPolling zamiast gniazd internetowych. Zostanie to zignorowane, jeśli w adresie URL bazy danych używany jest protokół websocket. |
forceWebSockets() | Wymuś użycie gniazd internetowych zamiast longPolling. |
zamówienieByKey() | Tworzy nowy QueryConstraint , który porządkuje według klucza. Sortuje wyniki zapytania według ich (rosnąco) wartości kluczy. Możesz przeczytać więcej o orderByKey() w Sortuj dane . |
zamówienieWedługPriorytetu() | Tworzy nowy QueryConstraint , który porządkuje według priorytetu. Aplikacje nie muszą używać priorytetu, ale mogą porządkować kolekcje według zwykłych właściwości (zobacz Sortowanie danych , aby poznać alternatywy dla priorytetu. |
zamówienieWedługWartości() | Tworzy nowy QueryConstraint , który porządkuje według wartości. Jeśli wszystkie elementy podrzędne zapytania są wartościami skalarnymi (łańcuch, liczba lub wartość logiczna), wyniki można uporządkować według ich (rosnąco) wartości. Więcej informacji na temat orderByValue() można znaleźć w artykule Sortowanie danych . |
serwerTimestamp() | Zwraca wartość zastępczą do automatycznego wypełniania bieżącego znacznika czasu (czas od epoki Uniksa w milisekundach) określony przez serwery Firebase. |
funkcja(delta, ...) | |
przyrost (delta) | Zwraca wartość zastępczą, której można użyć do niepodzielnego zwiększenia bieżącej wartości bazy danych o podaną różnicę. |
funkcja (włączona, ...) | |
włączLogging(włączone, trwałe) | Rejestruje informacje dotyczące debugowania w konsoli. |
funkcja(limit, ...) | |
limitDoFirst(limit) | Tworzy nowy QueryConstraint , który jest ograniczony do pierwszej określonej liczby elementów podrzędnych. Metoda limitToFirst() służy do ustawiania maksymalnej liczby dzieci, które mają być synchronizowane dla danego wywołania zwrotnego. Jeśli ustawimy limit na 100, początkowo otrzymamy maksymalnie 100 zdarzeń child_added . Jeśli w naszej bazie danych mamy mniej niż 100 wiadomości, dla każdej wiadomości zostanie uruchomione zdarzenie child_added . Jeśli jednak będziemy mieć ponad 100 wiadomości, zdarzenie child_added otrzymamy tylko dla pierwszych 100 zamówionych wiadomości. Gdy elementy się zmienią, będziemy otrzymywać zdarzenia child_removed dla każdego elementu, który wypadnie z aktywnej listy, tak że łączna liczba pozostanie na poziomie 100. Więcej o limitToFirst() możesz przeczytać w części Filtrowanie danych . |
limitToLast(limit) | Tworzy nowy QueryConstraint , który jest ograniczony do zwracania tylko ostatniej określonej liczby elementów podrzędnych. Metoda limitToLast() służy do ustawiania maksymalnej liczby dzieci, które mają być synchronizowane dla danego wywołania zwrotnego. Jeśli ustawimy limit na 100, początkowo otrzymamy maksymalnie 100 zdarzeń child_added . Jeśli w naszej bazie danych mamy mniej niż 100 wiadomości, dla każdej wiadomości zostanie uruchomione zdarzenie child_added . Jeśli jednak będziemy mieć ponad 100 wiadomości, otrzymamy zdarzenie child_added tylko dla ostatnich 100 zamówionych wiadomości. Gdy elementy się zmienią, będziemy otrzymywać zdarzenia child_removed dla każdego elementu, który wypadnie z aktywnej listy, tak że łączna liczba pozostanie na poziomie 100. Możesz przeczytać więcej o limitToLast() w Filtrowaniu danych . |
funkcja (rejestrator, ...) | |
włącz logowanie (rejestrator) | Rejestruje informacje dotyczące debugowania w konsoli. |
funkcja (rodzic, ...) | |
dziecko (rodzic, ścieżka) | Pobiera Reference dla lokalizacji w określonej ścieżce względnej. Ścieżka względna może być prostą nazwą podrzędną (na przykład „ada”) lub głębszą ścieżką oddzieloną ukośnikami (na przykład „ada/imię/pierwszy”). |
push(rodzic, wartość) | Generuje nową lokalizację podrzędną przy użyciu unikalnego klucza i zwraca jej Reference . Jest to najczęstszy wzorzec dodawania danych do kolekcji elementów. Jeśli podasz wartość do push() , wartość zostanie zapisana w wygenerowanej lokalizacji. Jeśli nie przekażesz wartości, nic nie zostanie zapisane w bazie danych, a element podrzędny pozostanie pusty (ale możesz użyć Reference w innym miejscu). Unikalne klucze generowane przez push() są uporządkowane według aktualnego czasu, więc wynikowa lista elementów jest posortowana chronologicznie. Klucze są również zaprojektowane tak, aby były niemożliwe do odgadnięcia (zawierają 72 losowe bity entropii). Zobacz Dołączanie do listy danych . Zobacz 2^120 sposobów zapewnienia unikalnych identyfikatorów . |
funkcja (ścieżka, ...) | |
zamówienieByChild(ścieżka) | Tworzy nowy QueryConstraint , który porządkuje według określonego klucza podrzędnego. Zapytania można porządkować tylko według jednego klucza na raz. Wielokrotne wywoływanie orderByChild() w tym samym zapytaniu jest błędem. Zapytania Firebase umożliwiają porządkowanie danych według dowolnego klucza podrzędnego w locie. Jeśli jednak wiesz z góry, jakie będą Twoje indeksy, możesz je zdefiniować za pomocą reguły .indexOn w Regułach bezpieczeństwa, aby uzyskać lepszą wydajność. Więcej informacji znajdziesz w https://firebase.google.com/docs/database/security/indexing-data regule. Więcej o orderByChild() możesz przeczytać w Sortuj dane . |
funkcja(zapytanie, ...) | |
uzyskać (zapytanie) | Pobiera najbardziej aktualny wynik dla tego zapytania. |
off(zapytanie, typ zdarzenia, wywołanie zwrotne) | Odłącza wywołanie zwrotne wcześniej dołączone do odpowiedniego odbiornika on () ( onValue , onChildAdded ). Uwaga: nie jest to zalecany sposób usuwania słuchacza. Zamiast tego skorzystaj ze zwróconej funkcji wywołania zwrotnego z odpowiednich wywołań on . Odłącz wywołanie zwrotne dołączone wcześniej za pomocą on*() . Wywołanie off() na odbiorniku nadrzędnym nie usunie automatycznie słuchaczy zarejestrowanych w węzłach podrzędnych. Aby usunąć wywołanie zwrotne, należy także wywołać funkcję off() na wszystkich odbiornikach podrzędnych. Jeśli wywołanie zwrotne nie zostanie określone, wszystkie wywołania zwrotne dla określonego typu zdarzenia zostaną usunięte. Podobnie, jeśli nie określono typu zdarzenia, wszystkie wywołania zwrotne dla Reference zostaną usunięte. Poszczególnych słuchaczy można również usunąć, wywołując ich wywołania zwrotne anulowania subskrypcji. |
onChildAdded (zapytanie, oddzwonienie, anulowanie oddzwaniania) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildAdded zostanie wywołane raz dla każdego początkowego dziecka w tej lokalizacji i zostanie wywołane ponownie za każdym razem, gdy zostanie dodane nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego będzie odzwierciedlał dane odpowiedniego elementu podrzędnego. W celu uporządkowania przekazywany jest drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildAdded (zapytanie, wywołanie zwrotne, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildAdded zostanie wywołane raz dla każdego początkowego dziecka w tej lokalizacji i zostanie wywołane ponownie za każdym razem, gdy zostanie dodane nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego będzie odzwierciedlał dane odpowiedniego elementu podrzędnego. W celu uporządkowania przekazywany jest drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildAdded (zapytanie, wywołanie zwrotne, anulowanie oddzwaniania, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildAdded zostanie wywołane raz dla każdego początkowego dziecka w tej lokalizacji i zostanie wywołane ponownie za każdym razem, gdy zostanie dodane nowe dziecko. DataSnapshot przekazany do wywołania zwrotnego będzie odzwierciedlał dane odpowiedniego elementu podrzędnego. W celu uporządkowania przekazywany jest drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildChanged (zapytanie, oddzwonienie, anulowanie oddzwaniania) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildChanged zostanie wywołane, gdy zmienią się dane przechowywane w elemencie podrzędnym (lub dowolnym z jego potomków). Należy pamiętać, że pojedyncze zdarzenie child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do wywołania zwrotnego będzie zawierał nową zawartość podrzędną. W celu uporządkowania do wywołania zwrotnego przekazywany jest również drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego elementu potomnego rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildChanged (zapytanie, wywołanie zwrotne, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildChanged zostanie wywołane, gdy zmienią się dane przechowywane w elemencie podrzędnym (lub dowolnym z jego potomków). Należy pamiętać, że pojedyncze zdarzenie child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do wywołania zwrotnego będzie zawierał nową zawartość podrzędną. W celu uporządkowania do wywołania zwrotnego przekazywany jest również drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego elementu potomnego rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildChanged(zapytanie, wywołanie zwrotne, anulowanie oddzwaniania, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildChanged zostanie wywołane, gdy zmienią się dane przechowywane w elemencie podrzędnym (lub dowolnym z jego potomków). Należy pamiętać, że pojedyncze zdarzenie child_changed może reprezentować wiele zmian w dziecku. DataSnapshot przekazany do wywołania zwrotnego będzie zawierał nową zawartość podrzędną. W celu uporządkowania do wywołania zwrotnego przekazywany jest również drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego elementu potomnego rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildMoved (zapytanie, oddzwonienie, anulowanie oddzwaniania) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildMoved zostanie wywołane, gdy porządek sortowania dziecka zmieni się w taki sposób, że zmieni się jego pozycja względem rodzeństwa. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył danych przeniesionego elementu podrzędnego. Przekazuje się także drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildMoved (zapytanie, wywołanie zwrotne, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildMoved zostanie wywołane, gdy porządek sortowania dziecka zmieni się w taki sposób, że zmieni się jego pozycja względem rodzeństwa. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył danych przeniesionego elementu podrzędnego. Przekazuje się także drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildMoved (zapytanie, wywołanie zwrotne, anulowanie oddzwaniania, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildMoved zostanie wywołane, gdy porządek sortowania dziecka zmieni się w taki sposób, że zmieni się jego pozycja względem rodzeństwa. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył danych przeniesionego elementu podrzędnego. Przekazuje się także drugi argument, który jest ciągiem znaków zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
onChildRemoved (zapytanie, oddzwonienie, anulowanie oddzwaniania) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildRemoved będzie wyzwalane za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do wywołania zwrotnego będzie starymi danymi elementu podrzędnego, który został usunięty. Dziecko zostanie usunięte, gdy: - klient jawnie wywołuje metodę remove() na tym dziecku lub jednym z jego przodków - klient wywołuje metodę set(null) na tym dziecku lub jednym z jego przodków - z tego dziecka usunięto wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje element podrzędny (ponieważ zmienił się porządek sortowania lub osiągnięto maksymalny limit) |
onChildRemoved (zapytanie, wywołanie zwrotne, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildRemoved będzie wyzwalane za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do wywołania zwrotnego będzie starymi danymi elementu podrzędnego, który został usunięty. Dziecko zostanie usunięte, gdy: - klient jawnie wywołuje metodę remove() na tym dziecku lub jednym z jego przodków - klient wywołuje metodę set(null) na tym dziecku lub jednym z jego przodków - z tego dziecka usunięto wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje element podrzędny (ponieważ zmienił się porządek sortowania lub osiągnięto maksymalny limit) |
onChildRemoved(zapytanie, wywołanie zwrotne, anulowanie oddzwaniania, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onChildRemoved będzie wyzwalane za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot przekazany do wywołania zwrotnego będzie starymi danymi elementu podrzędnego, który został usunięty. Dziecko zostanie usunięte, gdy: - klient jawnie wywołuje metodę remove() na tym dziecku lub jednym z jego przodków - klient wywołuje metodę set(null) na tym dziecku lub jednym z jego przodków - z tego dziecka usunięto wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje element podrzędny (ponieważ zmienił się porządek sortowania lub osiągnięto maksymalny limit) |
onValue (zapytanie, wywołanie zwrotne, anulowanie oddzwaniania) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onValue zostanie wywołane raz, gdy dane początkowe będą przechowywane w tej lokalizacji, a następnie zostanie wywołane ponownie przy każdej zmianie danych. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył lokalizacji, w której wywołano funkcję on() . Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie zawiera danych, zostanie uruchomiona z pustym DataSnapshot ( val() zwróci null ). |
onValue (zapytanie, wywołanie zwrotne, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onValue zostanie wywołane raz, gdy dane początkowe będą przechowywane w tej lokalizacji, a następnie zostanie wywołane ponownie przy każdej zmianie danych. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył lokalizacji, w której wywołano funkcję on() . Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie zawiera danych, zostanie uruchomiona z pustym DataSnapshot ( val() zwróci null ). |
onValue(zapytanie, wywołanie zwrotne, anulowanie oddzwaniania, opcje) | Nasłuchuje zmian danych w określonej lokalizacji. Jest to podstawowy sposób odczytywania danych z bazy danych. Twoje wywołanie zwrotne zostanie uruchomione dla danych początkowych i ponownie przy każdej zmianie danych. Wywołaj zwrócone wywołanie zwrotne anulowania subskrypcji, aby przestać otrzymywać aktualizacje. Aby uzyskać więcej informacji, zobacz Odzyskiwanie danych w Internecie . Zdarzenie onValue zostanie wywołane raz, gdy dane początkowe będą przechowywane w tej lokalizacji, a następnie zostanie wywołane ponownie przy każdej zmianie danych. DataSnapshot przekazany do wywołania zwrotnego będzie dotyczył lokalizacji, w której wywołano funkcję on() . Nie zostanie uruchomione, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie zawiera danych, zostanie uruchomiona z pustym DataSnapshot ( val() zwróci null ). |
zapytanie(zapytanie, queryConstraints) | Tworzy nową, niemodyfikowaną instancję Query , która jest rozszerzona o dodatkowe ograniczenia zapytań. |
funkcja(ref, ...) | |
onDisconnect(ref) | Zwraca obiekt OnDisconnect — zobacz Włączanie funkcji offline w JavaScript, aby uzyskać więcej informacji o tym, jak z niego korzystać. |
usuń(ref) | Usuwa dane z tej lokalizacji bazy danych. Wszelkie dane w lokalizacjach podrzędnych również zostaną usunięte. Efekt usunięcia będzie natychmiast widoczny i zostanie uruchomiona odpowiednia „wartość” zdarzenia. Rozpocznie się również synchronizacja usuwania z serwerami Firebase, a zwrócona obietnica zostanie rozpatrzona po zakończeniu. Jeśli zostanie podany, wywołanie zwrotne onComplete zostanie wywołane asynchronicznie po zakończeniu synchronizacji. |
runTransaction(ref, aktualizacja transakcji, opcje) | Atomowo modyfikuje dane w tej lokalizacji. Zmodyfikuj niepodzielnie dane w tej lokalizacji. W przeciwieństwie do zwykłej set() , która po prostu nadpisuje dane niezależnie od ich poprzedniej wartości, runTransaction() służy do modyfikowania istniejącej wartości na nową, zapewniając brak konfliktów z innymi klientami piszącymi w tym samym czasie do tej samej lokalizacji . Aby to osiągnąć, przekazujesz runTransaction() funkcję aktualizacji, która służy do przekształcania bieżącej wartości na nową. Jeśli inny klient zapisze do lokalizacji przed pomyślnym zapisaniem nowej wartości, funkcja aktualizacji zostanie wywołana ponownie z nową, bieżącą wartością i próba zapisu zostanie ponowiona. Będzie się to powtarzać, dopóki zapis nie powiedzie się bez konfliktu lub przerwiesz transakcję, nie zwracając wartości z funkcji aktualizacji. Uwaga: Modyfikowanie danych za pomocą set() spowoduje anulowanie wszystkich oczekujących transakcji w tej lokalizacji, dlatego należy zachować szczególną ostrożność podczas mieszania set() i runTransaction() w celu aktualizacji tych samych danych. Uwaga: korzystając z transakcji z włączonymi regułami bezpieczeństwa i Firebase, należy pamiętać, że klient potrzebuje dostępu .read oprócz dostępu .write , aby wykonać transakcję. Dzieje się tak dlatego, że charakter transakcji po stronie klienta wymaga od klienta odczytania danych w celu ich transakcyjnej aktualizacji. |
zestaw(ref, wartość) | Zapisuje dane w tej lokalizacji bazy danych. Spowoduje to zastąpienie wszelkich danych w tej lokalizacji i we wszystkich lokalizacjach podrzędnych. Efekt zapisu będzie natychmiast widoczny i zostaną wywołane odpowiednie zdarzenia („wartość”, „dziecko_dodane” itp.). Rozpocznie się również synchronizacja danych z serwerami Firebase, a zwrócona obietnica zostanie rozpatrzona po zakończeniu. Jeśli zostanie podany, wywołanie zwrotne onComplete zostanie wywołane asynchronicznie po zakończeniu synchronizacji. Przekazanie null nowej wartości jest równoznaczne z wywołaniem metody remove() ; mianowicie wszystkie dane w tej lokalizacji i we wszystkich lokalizacjach podrzędnych zostaną usunięte. set() usunie wszelkie priorytety przechowywane w tej lokalizacji, więc jeśli priorytet ma zostać zachowany, musisz zamiast tego użyć setWithPriority() . Należy pamiętać, że modyfikowanie danych za pomocą set() spowoduje anulowanie wszystkich oczekujących transakcji w tej lokalizacji, dlatego należy zachować szczególną ostrożność podczas mieszania set() i transaction() w celu zmodyfikowania tych samych danych. Pojedyncza funkcja set() wygeneruje pojedyncze zdarzenie „wartość” w miejscu, w którym wykonano funkcję set() . |
setPriority(ref, priorytet) | Ustawia priorytet danych w tej lokalizacji bazy danych. Aplikacje nie muszą używać priorytetu, ale mogą porządkować kolekcje według zwykłych właściwości (zobacz Sortowanie i filtrowanie danych ). |
setWithPriority(ref, wartość, priorytet) | Zapisuje dane w lokalizacji bazy danych. Podobnie jak set() , ale określa również priorytet tych danych. Aplikacje nie muszą używać priorytetu, ale mogą porządkować kolekcje według zwykłych właściwości (zobacz Sortowanie i filtrowanie danych ). |
aktualizacja (ref, wartości) | Zapisuje wiele wartości do bazy danych jednocześnie. Argument values zawiera wiele par właściwość-wartość, które zostaną zapisane razem w bazie danych. Każda właściwość podrzędna może być prostą właściwością (na przykład „nazwa”) lub ścieżką względną (na przykład „nazwa/imię”) od bieżącej lokalizacji do danych do zaktualizowania. W przeciwieństwie do metody set() , metody update() można używać do selektywnego aktualizowania tylko właściwości, do których istnieją odniesienia, w bieżącej lokalizacji (zamiast zastępowania wszystkich właściwości podrzędnych w bieżącej lokalizacji). Efekt zapisu będzie natychmiast widoczny i zostaną wywołane odpowiednie zdarzenia („wartość”, „dziecko_dodane” itp.). Rozpocznie się również synchronizacja danych z serwerami Firebase, a zwrócona obietnica zostanie rozpatrzona po zakończeniu. Jeśli zostanie podany, wywołanie zwrotne onComplete zostanie wywołane asynchronicznie po zakończeniu synchronizacji. Pojedyncza update() wygeneruje pojedyncze zdarzenie „wartość” w lokalizacji, w której wykonano update() , niezależnie od liczby zmodyfikowanych elementów podrzędnych. Należy pamiętać, że modyfikowanie danych za pomocą update() spowoduje anulowanie wszystkich oczekujących transakcji w tej lokalizacji, dlatego należy zachować szczególną ostrożność podczas łączenia funkcji update() i transaction() w celu modyfikacji tych samych danych. Przekazanie null do update() spowoduje usunięcie danych z tej lokalizacji. Zobacz Przedstawiamy aktualizacje obejmujące wiele lokalizacji i nie tylko . |
funkcja(wartość, ...) | |
endAt(wartość, klucz) | Tworzy QueryConstraint z określonym punktem końcowym. Użycie startAt() , startAfter() , endBefore() , endAt() i equalTo() pozwala wybrać dowolny punkt początkowy i końcowy dla zapytań. Punkt końcowy jest inkluzywny, więc w zapytaniu zostaną uwzględnione dzieci o dokładnie określonej wartości. Opcjonalnego argumentu klucza można użyć w celu dalszego ograniczenia zakresu zapytania. Jeśli jest określony, wówczas dzieci mające dokładnie określoną wartość muszą mieć również nazwę klucza mniejszą lub równą podanemu kluczowi. Możesz przeczytać więcej o endAt() w Filtrowaniu danych . |
endBefore(wartość, klucz) | Tworzy QueryConstraint z określonym punktem końcowym (wyłącznie). Użycie startAt() , startAfter() , endBefore() , endAt() i equalTo() pozwala wybrać dowolny punkt początkowy i końcowy dla zapytań. Punkt końcowy jest ekskluzywny. Jeśli zostanie podana tylko wartość, w zapytaniu zostaną uwzględnione elementy podrzędne o wartości mniejszej niż określona. Jeśli określono klucz, elementy podrzędne muszą mieć wartość mniejszą lub równą określonej wartości i nazwę klucza mniejszą niż określony klucz. |
równy(wartość, klucz) | Tworzy QueryConstraint zawierający elementy podrzędne pasujące do określonej wartości. Użycie startAt() , startAfter() , endBefore() , endAt() i equalTo() pozwala wybrać dowolny punkt początkowy i końcowy dla zapytań. Opcjonalnego argumentu klucza można użyć w celu dalszego ograniczenia zakresu zapytania. Jeśli jest określony, wówczas dzieci, które mają dokładnie określoną wartość, muszą również mieć dokładnie określony klucz jako nazwę klucza. Można tego użyć do filtrowania zestawów wyników z wieloma dopasowaniami dla tej samej wartości. Więcej informacji na temat equalTo() można znaleźć w sekcji Filtrowanie danych . |
startAfter(wartość, klucz) | Tworzy QueryConstraint z określonym punktem początkowym (wyłącznie). Użycie startAt() , startAfter() , endBefore() , endAt() i equalTo() pozwala wybrać dowolny punkt początkowy i końcowy dla zapytań. Punkt wyjścia jest ekskluzywny. Jeśli zostanie podana tylko wartość, w zapytaniu zostaną uwzględnione elementy podrzędne o wartości większej niż podana. Jeżeli określono klucz, wówczas elementy podrzędne muszą mieć wartość większą lub równą określonej wartości oraz nazwę klucza większą niż określony klucz. |
startAt(wartość, klucz) | Tworzy QueryConstraint z określonym punktem początkowym. Użycie startAt() , startAfter() , endBefore() , endAt() i equalTo() pozwala wybrać dowolny punkt początkowy i końcowy dla zapytań. Punkt początkowy jest inkluzywny, więc w zapytaniu zostaną uwzględnione dzieci o dokładnie określonej wartości. Opcjonalnego argumentu klucza można użyć w celu dalszego ograniczenia zakresu zapytania. Jeśli jest określony, wówczas dzieci mające dokładnie określoną wartość muszą mieć również nazwę klucza większą lub równą określonemu kluczowi. Możesz przeczytać więcej o startAt() w Filtrowaniu danych . |
Zajęcia
Klasa | Opis |
---|---|
Baza danych | Klasa reprezentująca bazę danych czasu rzeczywistego Firebase. |
Migawka danych | DataSnapshot zawiera dane z lokalizacji bazy danych. Za każdym razem, gdy odczytujesz dane z bazy danych, otrzymujesz je w postaci DataSnapshot . DataSnapshot jest przekazywany do wywołań zwrotnych zdarzeń, które dołączasz za pomocą on() lub once() . Możesz wyodrębnić zawartość migawki jako obiekt JavaScript, wywołując metodę val() . Alternatywnie możesz przejść do migawki, wywołując metodę child() w celu zwrócenia migawek podrzędnych (które możesz następnie wywołać metodą val() ). DataSnapshot to efektywnie wygenerowana, niezmienna kopia danych w lokalizacji bazy danych. Nie można go modyfikować i nigdy się nie zmieni (aby zmodyfikować dane, zawsze wywołujesz metodę set() bezpośrednio w Reference ). |
WłączRozłącz | Klasa onDisconnect umożliwia zapisanie lub wyczyszczenie danych, gdy klient rozłączy się z serwerem bazy danych. Te aktualizacje pojawiają się niezależnie od tego, czy klient rozłączy się prawidłowo, czy nie, więc możesz na nich polegać, jeśli chodzi o czyszczenie danych nawet w przypadku zerwania połączenia lub awarii klienta. Klasa onDisconnect jest najczęściej używana do zarządzania obecnością w aplikacjach, w których przydatne jest wykrywanie liczby podłączonych klientów i rozłączania się innych klientów. Aby uzyskać więcej informacji, zobacz Włączanie funkcji offline w JavaScript . Aby uniknąć problemów w przypadku zerwania połączenia przed przesłaniem żądań do serwera bazy danych, funkcje te należy wywołać przed zapisaniem jakichkolwiek danych. Należy pamiętać, że operacje onDisconnect są wyzwalane tylko raz. Jeśli chcesz, aby operacja była wykonywana za każdym razem, gdy nastąpi rozłączenie, musisz ponownie ustanowić operację onDisconnect za każdym razem, gdy ponownie się połączysz. |
Ograniczenie zapytania | QueryConstraint służy do zawężania zestawu dokumentów zwracanych przez zapytanie do bazy danych. QueryConstraint są tworzone przez wywołanie endAt() , koniecPrzed() , zacznij od() , rozpocznijPo() , limitToFirst() , limitToLast() , zamówPrzezDziecka() , zamówPrzezDziecka() , OrderByKey() , OrderByPriority() , OrderByValue() lub równościTo() i można je następnie przekazać do query() w celu utworzenia nowej instancji zapytania, która również zawiera to QueryConstraint . |
Wynik transakcji | Typ rozpoznawania wartości runTransaction() . |
Interfejsy
Interfejs | Opis |
---|---|
Baza danych referencyjna | DatabaseReference reprezentuje określoną lokalizację w bazie danych i może służyć do odczytywania lub zapisywania danych w tej lokalizacji bazy danych. Możesz odwołać się do lokalizacji głównej lub podrzędnej w swojej bazie danych, wywołując ref() lub ref("child/path") . Zapis odbywa się za pomocą metody set() , a odczyt można wykonać za pomocą metody on*() . Zobacz https://firebase.google.com/docs/database/web/read-and-write |
Iterowana migawka danych | Reprezentuje migawkę podrzędną Reference , która jest iterowana. Klucz nigdy nie będzie niezdefiniowany. |
Opcje słuchania | Obiekty opcji, których można użyć do dostosowania odbiornika. |
Zapytanie | Query sortuje i filtruje dane w lokalizacji bazy danych, więc uwzględniany jest tylko podzbiór danych podrzędnych. Można to wykorzystać do uporządkowania gromadzenia danych według jakiegoś atrybutu (na przykład wzrostu dinozaurów), a także do ograniczenia dużej listy elementów (na przykład wiadomości czatu) do liczby odpowiedniej do synchronizacji z klientem. Zapytania są tworzone poprzez połączenie jednej lub większej liczby zdefiniowanych tutaj metod filtrowania. Podobnie jak w przypadku DatabaseReference , możesz odbierać dane z Query za pomocą metod on*() . Będziesz otrzymywać zdarzenia i DataSnapshot tylko dla podzbioru danych pasujących do Twojego zapytania. Więcej informacji można znaleźć na stronie https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data . |
Następnie możliwe odniesienie | Promise , która może również działać jako DatabaseReference , gdy zostanie zwrócona przez funkcję push() . Odniesienie jest dostępne natychmiast, a Promise zostaje rozpatrzona po zakończeniu zapisu do backendu. |
Opcje transakcji | Obiekt opcji służący do konfigurowania transakcji. |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
Typ wydarzenia | Jeden z następujących ciągów: „wartość”, „dodano_dziecko”, „zmienione_dziecko”, „usunięte_dziecko” lub „przeniesione_dziecko”. |
Typ ograniczenia zapytania | Opisuje różne ograniczenia zapytań dostępne w tym zestawie SDK. |
Zrezygnuj z subskrypcji | Wywołanie zwrotne, które można wywołać w celu usunięcia słuchacza. |
funkcja (aplikacja, ...)
getDatabase(aplikacja, adres URL)
Zwraca instancję zestawu SDK bazy danych czasu rzeczywistego, która jest powiązana z dostarczoną aplikacją FirebaseApp . Inicjuje nową instancję z ustawieniami domyślnymi, jeśli żadna instancja nie istnieje lub jeśli istniejąca instancja używa niestandardowego adresu URL bazy danych.
Podpis:
export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
Parametry
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja Firebase | Instancja FireBaseApp , z którą powiązana jest instancja bazy danych w czasie rzeczywistym. |
adres URL | strunowy | URL instancji bazy danych w czasie rzeczywistym, z którym należy się połączyć. Jeśli nie jest dostarczony, SDK łączy się z domyślną instancją aplikacji FireBase. |
Zwroty:
Instancja Database
dostarczonej aplikacji.
funkcja (db, ...)
ConnectDatabaseemulator (DB, host, port, opcje)
Zmodyfikuj dostarczoną instancję, aby komunikować się z emulatorem bazy danych w czasie rzeczywistym.
Uwaga: Ta metoda należy wywołać przed wykonaniem jakiejkolwiek innej operacji.
Podpis:
export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
pierś | Baza danych | Instancja do modyfikacji. |
gospodarz | strunowy | Host emulatorowy (np.: Localhost) |
Port | numer | Port emulatora (np. 8080) |
opcje | {Mockusertoken?: EmulatormockTokenOptions | strunowy; } |
Zwroty:
próżnia
Gooffline (DB)
Odłącza się od serwera (wszystkie operacje bazy danych zostaną zakończone offline).
Klient automatycznie utrzymuje trwałe połączenie z serwerem bazy danych, który pozostanie aktywny w nieskończoność i ponownie się łączy po odłączeniu. Jednak metody goOffline()
i goOnline()
mogą być użyte do kontrolowania połączenia klienta w przypadkach, gdy trwałe połączenie jest niepożądane.
Podczas offline klient nie będzie już odbierać aktualizacji danych z bazy danych. Jednak wszystkie operacje bazy danych wykonywane lokalnie będą nadal natychmiast strzelać, umożliwiając normalne zachowanie aplikacji. Dodatkowo każda operacja wykonywana lokalnie będzie automatycznie w kolejce i ponowne ponowne połączenie z serwerem bazy danych.
Aby ponownie połączyć się z bazą danych i rozpocząć odbieranie zdalnych zdarzeń, patrz goOnline()
.
Podpis:
export declare function goOffline(db: Database): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
pierś | Baza danych | Instancja do odłączenia. |
Zwroty:
próżnia
Goonline (DB)
Ponowne połączenie z serwerem i synchronizuje stan bazy danych offline ze stanem serwera.
Tę metodę należy zastosować po wyłączeniu aktywnego połączenia z goOffline()
. Po ponownym połączeniu klient przesyła odpowiednie dane i wystrzeliwuje odpowiednie zdarzenia, aby klient „dogania” „dogania”.
Podpis:
export declare function goOnline(db: Database): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
pierś | Baza danych | Instancja do ponownego połączenia. |
Zwroty:
próżnia
Ref (db, ścieżka)
Zwraca Reference
reprezentujące lokalizację w bazie danych odpowiadającej dostarczonej ścieżce. Jeśli nie zostanie podana ścieżka, Reference
wskazuje na źródło bazy danych.
Podpis:
export declare function ref(db: Database, path?: string): DatabaseReference;
Parametry
Parametr | Typ | Opis |
---|---|---|
pierś | Baza danych | Instancja bazy danych w celu uzyskania odniesienia. |
ścieżka | strunowy | Opcjonalna ścieżka reprezentująca lokalizację, który zwróci się Reference . Jeśli nie jest dostarczone, zwrócone Reference wskazuje na źródło bazy danych. |
Zwroty:
Jeśli podano ścieżkę, Reference
wskazujące na dostarczoną ścieżkę. W przeciwnym razie Reference
wskazujące na pierwiastek bazy danych.
Reffromurl (DB, URL)
Zwraca Reference
reprezentującą lokalizację w bazie danych odpowiadającej dostarczonym adresie URL Firebase.
Wyjątek jest rzucany, jeśli adres URL nie jest prawidłowym adresem URL bazy danych Firebase lub ma inną domenę niż bieżąca instancja Database
.
Zauważ, że wszystkie parametry zapytania ( orderBy
, limitToLast
, itp.) są ignorowane i nie są stosowane do zwróconego Reference
.
Podpis:
export declare function refFromURL(db: Database, url: string): DatabaseReference;
Parametry
Parametr | Typ | Opis |
---|---|---|
pierś | Baza danych | Instancja bazy danych w celu uzyskania odniesienia. |
adres URL | strunowy | URL Firebase, na której wskazuje zwrócone Reference . |
Zwroty:
Reference
wskazujące na dostarczony adres URL bazy ogniowej.
funkcjonować()
ForcelongPolling ()
Wymień użycie Longpolling zamiast koktajli. Zostanie to zignorowane, jeśli protokół WebSocket zostanie użyty w DatabaseURL.
Podpis:
export declare function forceLongPolling(): void;
Zwroty:
próżnia
ForceWebSockets ()
Wymień użycie WebSockets zamiast Longpolling.
Podpis:
export declare function forceWebSockets(): void;
Zwroty:
próżnia
OrderByey ()
Tworzy nowy QueryConstraint
, który rozkazuje według klucza.
Sortuje wyniki zapytania według ich (wznoszących się) kluczowych wartości.
Możesz przeczytać więcej o danych orderByKey()
.
Podpis:
export declare function orderByKey(): QueryConstraint;
Zwroty:
OrderbyPriority ()
Tworzy nowy QueryConstraint
, który nakazuje priorytetowo.
Aplikacje nie muszą używać priorytetu, ale mogą zamówić kolekcje według zwykłych właściwości (patrz dane sortowania dla alternatyw dla priorytetu.
Podpis:
export declare function orderByPriority(): QueryConstraint;
Zwroty:
orderbyValue ()
Tworzy nowe QueryConstraint
, które zamówi według wartości.
Jeśli dzieci zapytania to wszystkie wartości skalarne (ciąg, liczba lub boolean), możesz zamówić wyniki według ich wartości (wznoszących się).
Możesz przeczytać więcej o danych orderByValue()
.
Podpis:
export declare function orderByValue(): QueryConstraint;
Zwroty:
servertimestamp ()
Zwraca wartość symboliczną do automatycznego populacji bieżącego znacznika czasu (czas od Epochu UNIX, w milisekundach), zgodnie z serwerami bazy Fire Base.
Podpis:
export declare function serverTimestamp(): object;
Zwroty:
obiekt
funkcja (Delta, ...)
Przyrost (Delta)
Zwraca wartość symboliczną, którą można wykorzystać do atomowego zwiększania bieżącej wartości bazy danych przez dostarczoną deltę.
Podpis:
export declare function increment(delta: number): object;
Parametry
Parametr | Typ | Opis |
---|---|---|
delta | numer | kwota do modyfikacji bieżącej wartości atomowo. |
Zwroty:
obiekt
Wartość zastępcza do modyfikowania danych atomowo po stronie serwera.
funkcja (włączona, ...)
EnableLogging (włączone, trwałe)
Dzienniki debugują informacje do konsoli.
Podpis:
export declare function enableLogging(enabled: boolean, persistent?: boolean): any;
Parametry
Parametr | Typ | Opis |
---|---|---|
włączony | Boolean | Umożliwia rejestrowanie, jeśli true , wyłącza rejestrowanie, jeśli false . |
uporczywy | Boolean | Pamięta stan rejestrowania między stroną odświeża się, jeśli jest true . |
Zwroty:
każdy
funkcja (limit, ...)
limittoFirst (limit)
Tworzy nowy QueryConstraint
, który jest ograniczony do pierwszej konkretnej liczby dzieci.
Metoda limitToFirst()
służy do ustawiania maksymalnej liczby dzieci do synchronizacji dla danego zwrotu oddzwonienia. Jeśli ustalimy limit 100, początkowo otrzymamy tylko do 100 wydarzeń child_added
. Jeśli w naszej bazie danych przechowywamy mniej niż 100 wiadomości, zdarzenie child_added
wystrzeli dla każdej wiadomości. Jeśli jednak będziemy mieli ponad 100 wiadomości, otrzymamy tylko zdarzenie child_added
dla pierwszych 100 uporządkowanych wiadomości. Wraz ze zmianą pozycji otrzymamy zdarzenia child_removed
dla każdego elementu, który spadnie z aktywnej listy, aby całkowita liczba pozostała na 100.
Możesz przeczytać więcej o limitToFirst()
w filtrowaniu danych .
Podpis:
export declare function limitToFirst(limit: number): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
limit | numer | Maksymalna liczba węzłów, które należy uwzględnić w tym zapytaniu. |
Zwroty:
limitolast (limit)
Tworzy nowy QueryConstraint
, który ogranicza się do zwrotu tylko ostatniej określonej liczby dzieci.
Metoda limitToLast()
służy do ustawiania maksymalnej liczby dzieci do synchronizacji dla danego zwrotu oddzwonienia. Jeśli ustalimy limit 100, początkowo otrzymamy tylko do 100 wydarzeń child_added
. Jeśli w naszej bazie danych przechowywamy mniej niż 100 wiadomości, zdarzenie child_added
wystrzeli dla każdej wiadomości. Jeśli jednak mamy ponad 100 wiadomości, otrzymamy tylko zdarzenie child_added
dla ostatnich 100 uporządkowanych wiadomości. Wraz ze zmianą pozycji otrzymamy zdarzenia child_removed
dla każdego elementu, który spadnie z aktywnej listy, aby całkowita liczba pozostała na 100.
Możesz przeczytać więcej o limitToLast()
w filtrowaniu danych .
Podpis:
export declare function limitToLast(limit: number): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
limit | numer | Maksymalna liczba węzłów, które należy uwzględnić w tym zapytaniu. |
Zwroty:
funkcja (logger, ...)
EnableLogging (logger)
Dzienniki debugują informacje do konsoli.
Podpis:
export declare function enableLogging(logger: (message: string) => unknown): any;
Parametry
Parametr | Typ | Opis |
---|---|---|
rejestrator | (wiadomość: string) => nieznane | Niestandardowa funkcja rejestratora do kontrolowania sposobu rejestrowania rzeczy. |
Zwroty:
każdy
funkcja (rodzic, ...)
Dziecko (rodzic, ścieżka)
Otrzymuje Reference
do lokalizacji na określonej ścieżce względnej.
Ścieżka względna może być prostym imieniem dziecięcym (na przykład „Ada”) lub głębszą ścieżką oddzieloną odcinającą (na przykład „ADA/Nazwa/First”).
Podpis:
export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
Parametry
Parametr | Typ | Opis |
---|---|---|
rodzic | DatabaseReference | Lokalizacja rodzica. |
ścieżka | strunowy | Względna ścieżka z tej lokalizacji do pożądanej lokalizacji dziecka. |
Zwroty:
Określona lokalizacja dziecka.
push (rodzic, wartość)
Generuje nową lokalizację dziecka przy użyciu unikalnego klucza i zwraca jego Reference
.
Jest to najczęstszy wzorzec dodawania danych do zbioru elementów.
Jeśli podasz wartość do push()
, Wartość jest zapisywana w wygenerowanej lokalizacji. Jeśli nie przekroczysz wartości, nic nie jest zapisywane do bazy danych, a dziecko pozostaje puste (ale możesz użyć Reference
w innym miejscu).
Unikalne klucze generowane przez push()
są uporządkowane w bieżącym czasie, więc wynikowa lista elementów jest sortowana chronologicznie. Klucze są również zaprojektowane tak, aby były niewłaściwe (zawierają 72 losowe kawałki entropii).
Zobacz dołącz do listy danych . Zobacz 2^120 sposobów na zapewnienie unikalnych identyfikatorów .
Podpis:
export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;
Parametry
Parametr | Typ | Opis |
---|---|---|
rodzic | DatabaseReference | Lokalizacja rodzica. |
wartość | nieznany | Wartość opcjonalna do zapisania w wygenerowanej lokalizacji. |
Zwroty:
Połączona Promise
i Reference
; Rozwiązuje się, gdy zapis jest kompletny, ale może być używany natychmiast jako Reference
do lokalizacji dziecka.
funkcja (ścieżka, ...)
OrderbyChild (ścieżka)
Tworzy nowe QueryConstraint
, które zamówi przez określony klucz dziecięcy.
Zapytania mogą zamówić tylko jeden klucz na raz. Calling orderByChild()
wiele razy na tym samym zapytaniu jest błędem.
Zapytania Firebase pozwalają zamówić dane według dowolnego klucza dziecięcego w locie. Jeśli jednak wiesz z góry, jakie będą twoje indeksy, możesz je zdefiniować za pomocą reguły .Indexon w swoich zasadach bezpieczeństwa w celu lepszej wydajności. Więcej informacji można znaleźć w zasadzie https://firebase.google.com/docs/database/security/indexing-data .
Możesz przeczytać więcej o orderByChild()
w danych sortowania .
Podpis:
export declare function orderByChild(path: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
ścieżka | strunowy | Ścieżka do zamówienia przez. |
Zwroty:
funkcja (zapytanie, ...)
Get (zapytanie)
Uzyskuje najbardziej aktualny wynik tego zapytania.
Podpis:
export declare function get(query: Query): Promise<DataSnapshot>;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
Zwroty:
Obiecaj < DataSnapshot >
Promise
, która ustępuje wynikowej danych danych, jeśli wartość jest dostępna, lub odrzuca, jeśli klient nie jest w stanie zwrócić wartości (np. Jeśli serwer jest nieosiągalny i nie ma żadnego buforowania).
Off (zapytanie, eventType, callback)
Odłącza wywołanie wywoławcze uprzednio dołączone do odpowiedniego on*()
( onValue
, onChildAdded
) słuchacz. Uwaga: Nie jest to zalecany sposób usunięcia słuchacza. Zamiast tego użyj zwróconej funkcji wywołania zwrotnego z odpowiedniego on*
Callback.
Odłącz oddzwonienie wcześniej dołączone do on*()
. Calling off()
na słuchaczu nadrzędnym nie usunie automatycznie słuchaczy off()
na węzłach dziecięcych, należy również wezwać słuchaczy dziecięcych, aby usunęły zwrot oddzwonienia.
Jeśli wywołanie zwrotne nie zostanie określone, wszystkie wywołania zwrotne dla określonego typu zdarzenia zostaną usunięte. Podobnie, jeśli nie zostanie określony typ zdarzenia, wszystkie wywołania zwrotne na podstawie Reference
zostaną usunięte.
Poszczególnych słuchaczy można również usunąć, wywołując swoje oddzwonienia do subskrypcji.
Podpis:
export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie, z którymi zarejestrowano słuchacz. |
typ wydarzenia | Typ wydarzenia | Jeden z poniższych ciągów: „Wartość”, „Child_added”, „Child_changed”, „Child_Removed” lub „Child_moved”. Jeśli zostanie pominięte, wszystkie wywołania zwrotne na Reference zostaną usunięte. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName?: String | null) => nieznane | Funkcja wywołania zwrotnego, która została przekazana on() lub undefined w celu usunięcia wszystkich zwrotów. |
Zwroty:
próżnia
onChildAdded (zapytanie, oddzwonienie, anulowanie oddzwaniania)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildAdded
zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot
przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName?: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onChildAdded (zapytanie, wywołanie zwrotne, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildAdded
zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot
przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onchildadded (zapytanie, oddzwonienie, anulowaniecalback, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildAdded
zostanie uruchomione raz dla każdego początkowego dziecka w tym miejscu i zostanie ponownie uruchomione za każdym razem, gdy dodaje się nowe dziecko. DataSnapshot
przekazany do wywołania zwrotnego odzwierciedla dane dla odpowiedniego dziecka. W celu zamawiania jest to drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
OnchildChanged (zapytanie, oddzwonienie, anulowaniecallback)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildChanged
zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed
może reprezentować wiele zmian w dziecku. DataSnapshot
przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onChildChanged (zapytanie, wywołanie zwrotne, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildChanged
zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed
może reprezentować wiele zmian w dziecku. DataSnapshot
przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
OnchildChanged (zapytanie, oddzwonienie, anulowaniecalback, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildChanged
zostanie uruchomione, gdy dane przechowywane u dziecka (lub któregokolwiek z jego potomków) zmienia się. Zauważ, że zdarzenie pojedynczego child_changed
może reprezentować wiele zmian w dziecku. DataSnapshot
przekazany do oddzwaniania będzie zawierać nową zawartość dziecka. W celu zamawiania oddzwonienie jest również przekazywane drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onChildMoved (zapytanie, oddzwonienie, anulowanie oddzwaniania)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildMoved
zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot
przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onChildMoved (zapytanie, wywołanie zwrotne, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildMoved
zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot
przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onchildmoved (zapytanie, oddzwonienie, anulowaniecalback, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onChildMoved
zostanie uruchomione, gdy zmienia się kolejność sortowania dziecka w taki sposób, że jego pozycja w stosunku do rodzeństwa się zmienia. DataSnapshot
przekazany do wywołania zwrotnym będzie dotyczyło danych, które poruszyło się dziecko. Jest to również drugi argument, który jest ciągiem zawierającym klucz poprzedniego dziecka rodzeństwa według kolejności sortowania lub null
, jeśli jest to pierwsze dziecko.
Podpis:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot , PoprzednimchildName: String | null) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onchildRemoved (zapytanie, oddzwonienie, anulowaniecallback)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildRemoved
zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot
przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:
- Klient wyraźnie dzwoni do
remove()
na to dziecko lub jednego z jego przodków - klient wywołujeset(null)
na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)
Podpis:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onchildRemoved (zapytanie, oddzwonienie, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildRemoved
zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot
przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:
- Klient wyraźnie dzwoni do
remove()
na to dziecko lub jednego z jego przodków - klient wywołujeset(null)
na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)
Podpis:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onchildRemoved (zapytanie, oddzwonienie, anulowaniecalback, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Wydarzenie onChildRemoved
zostanie uruchomione raz za każdym razem, gdy dziecko zostanie usunięte. DataSnapshot
przekazany do oddzwaniania będzie starymi danymi dla usuniętego dziecka. Dziecko zostanie usunięte, gdy:
- Klient wyraźnie dzwoni do
remove()
na to dziecko lub jednego z jego przodków - klient wywołujeset(null)
na to dziecko lub jeden z jego przodków - to dziecko ma usunięte wszystkie swoje dzieci - obowiązuje zapytanie, które teraz filtruje filtry Out dziecko (ponieważ jest to kolejność sortowania lub maksymalny limit został trafiony)
Podpis:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane DataSnapshot i ciąg zawierający klucz poprzedniego dziecka, według kolejności sortowania lub null , jeśli jest to pierwsze dziecko. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
OnValue (zapytanie, oddzwonienie, anulowaniecalback)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onValue
uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot
przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on()
. Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot
( val()
zwróci null
).
Podpis:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane z danych DataSnapshot. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
OnValue (zapytanie, oddzwonienie, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onValue
uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot
przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on()
. Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot
( val()
zwróci null
).
Podpis:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane z danych DataSnapshot. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
onValue (zapytanie, oddzwonienie, odwołanie, opcje)
Słucha zmian danych w określonej lokalizacji.
Jest to główny sposób odczytu danych z bazy danych. Twoje oddzwonienie zostanie uruchomione dla danych początkowych i ponownie za każdym razem, gdy dane dane. Wywołaj zwrócone oddzwonienie do subskrypcji, aby przestać odbierać aktualizacje. Więcej informacji można znaleźć w Internecie w Internecie .
Zdarzenie onValue
uruchomi się raz z początkowymi danymi przechowywanymi w tej lokalizacji, a następnie wywoła ponownie za każdym razem, gdy dane dane. DataSnapshot
przekazany do oddzwaniania będzie miało miejsce dla lokalizacji, w której wezwano on()
. Nie uruchomi się, dopóki cała zawartość nie zostanie zsynchronizowana. Jeśli lokalizacja nie ma danych, zostanie uruchomiona pustym DataSnapshot
( val()
zwróci null
).
Podpis:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Zapytanie do uruchomienia. |
oddzwonić | (Snapshot: DataSnapshot ) => nieznane | Oddzwanianie, które wystawia się, gdy nastąpi określone zdarzenie. Oddzwanianie zostanie przekazane z danych DataSnapshot. |
anulowaniecallback | (błąd: błąd) => nieznane | Opcjonalne oddzwonienie, które zostanie powiadomione, jeśli subskrypcja zdarzenia zostanie kiedykolwiek anulowana, ponieważ Twój klient nie ma pozwolenia na odczyt tych danych (lub miał pozwolenie, ale teraz je straciło). To wywołanie zwrotne zostanie przekazane obiekt Error wskazujący, dlaczego wystąpiła awaria. |
opcje | Słuchaj | Obiekt, którego można użyć do konfigurowania onlyOnce , który następnie usuwa słuchacza po jego pierwszym wywołaniu. |
Zwroty:
Funkcja, którą można wywołać w celu usunięcia słuchacza.
Zapytanie (zapytanie, QueryConstraints)
Tworzy nowy niezmienny przykład Query
, który jest rozszerzony o dodatkowe ograniczenia zapytania.
Podpis:
export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
Parametry
Parametr | Typ | Opis |
---|---|---|
zapytanie | Zapytanie | Instancja zapytania, którą należy użyć jako podstawy nowych ograniczeń. |
QueryConstraints | QueryConstraint [] | Lista QueryConstraint s. |
Zwroty:
Wyjątki
Jeżeli którekolwiek z dostarczonych ograniczeń zapytania nie można połączyć z istniejącymi lub nowymi ograniczeniami.
funkcja (ref, ...)
ondisconnect (ref)
Zwraca obiekt OnDisconnect
- patrz Włączanie możliwości offline w JavaScript, aby uzyskać więcej informacji o tym, jak go używać.
Podpis:
export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | Odniesienie do dodania wyzwalaczy Ondisconnect. |
Zwroty:
Usuń (Ref)
Usuwa dane w tej lokalizacji bazy danych.
Wszelkie dane w lokalizacjach dzieci również zostaną usunięte.
Efekt usunięcia będzie natychmiast widoczny, a odpowiednia „wartość” zdarzenia zostanie uruchomiona. 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.
Podpis:
export declare function remove(ref: DatabaseReference): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | The location to remove. |
Zwroty:
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.
Podpis:
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | 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. |
opcje | TransactionOptions | An options object to configure transactions. |
Zwroty:
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.
Podpis:
export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | The location to write to. |
wartość | nieznany | The value to be written (string, number, boolean, object, array, or null). |
Zwroty:
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 ).
Podpis:
export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | The location to write to. |
priorytet | string | numer | zero | The priority to be written (string, number, or null). |
Zwroty:
Promise<void>
Resolves when write to server is complete.
setWithPriority(ref, wartość, priorytet)
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 ).
Podpis:
export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | The location to write to. |
wartość | nieznany | The value to be written (string, number, boolean, object, array, or null). |
priorytet | string | numer | zero | The priority to be written (string, number, or null). |
Zwroty:
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 .
Podpis:
export declare function update(ref: DatabaseReference, values: object): Promise<void>;
Parametry
Parametr | Typ | Opis |
---|---|---|
ref | DatabaseReference | The location to write to. |
wartości | obiekt | Object containing multiple values. |
Zwroty:
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 .
Podpis:
export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
wartość | numer | string | boolean | zero | 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. |
klucz | strunowy | 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. |
Zwroty:
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.
Podpis:
export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
wartość | numer | string | boolean | zero | 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. |
klucz | strunowy | 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. |
Zwroty:
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 .
Podpis:
export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
wartość | numer | string | boolean | zero | 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. |
klucz | strunowy | 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. |
Zwroty:
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.
Podpis:
export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
wartość | numer | string | boolean | zero | 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. |
klucz | strunowy | The child key to start after. This argument is only allowed if ordering by child, value, or priority. |
Zwroty:
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 .
Podpis:
export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
Parametry
Parametr | Typ | Opis |
---|---|---|
wartość | numer | string | boolean | zero | 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. |
klucz | strunowy | The child key to start at. This argument is only allowed if ordering by child, value, or priority. |
Zwroty:
Typ wydarzenia
One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."
Podpis:
export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
QueryConstraintType
Describes the different query constraints available in this SDK.
Podpis:
export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
Zrezygnuj z subskrypcji
A callback that can invoked to remove a listener.
Podpis:
export declare type Unsubscribe = () => void;