Query oznacza zapytanie, które można przeczytać lub odsłuchać. Możesz także konstruować udoskonalone obiekty Query , dodając filtry i porządkując.
Podpis:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Konstruktorzy
| Konstruktor | Modyfikatory | Opis |
|---|---|---|
| (konstruktor)() | Konstruuje nową instancję klasy Query |
Nieruchomości
| Nieruchomość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| przetwornik | Konwerter danych Firestore <AppModelType, DbModelType> | zero | Jeśli podano, FirestoreDataConverter powiązany z tą instancją. | |
| sklep z ogniem | Sklep z ogniem | Instancja Firestore dla bazy danych Firestore (przydatna przy wykonywaniu transakcji itp.). | |
| typ | „zapytanie” | 'kolekcja' | Typ tego odniesienia do Firestore. |
Metody
| metoda | Modyfikatory | Opis |
|---|---|---|
| z konwerterem (konwerterem) | Usuwa konwerter prądu. | |
| z konwerterem (konwerterem) | Stosuje niestandardowy konwerter danych do tego zapytania, umożliwiając używanie własnych niestandardowych obiektów modelu w Firestore. Gdy wywołasz funkcję getDocs() ze zwróconym zapytaniem, dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i Twoim niestandardowym typem NewAppModelType . |
Zapytanie.(konstruktor)
Konstruuje nową instancję klasy Query
Podpis:
protected constructor();
Konwerter zapytań
Jeśli podano, FirestoreDataConverter powiązany z tą instancją.
Podpis:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Zapytanie.firestore
Instancja Firestore dla bazy danych Firestore (przydatna przy wykonywaniu transakcji itp.).
Podpis:
readonly firestore: Firestore;
Typ.zapytania
Typ tego odniesienia do Firestore.
Podpis:
readonly type: 'query' | 'collection';
Zapytanie.z konwerterem()
Usuwa konwerter prądu.
Podpis:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | zero | null usuwa bieżący konwerter. |
Zwroty:
Zapytanie < Dane dokumentu , Dane dokumentu >
Query<DocumentData, DocumentData> , który nie używa konwertera.
Zapytanie.z konwerterem()
Stosuje niestandardowy konwerter danych do tego zapytania, umożliwiając używanie własnych niestandardowych obiektów modelu w Firestore. Gdy wywołasz funkcję getDocs() ze zwróconym zapytaniem, dostarczony konwerter dokona konwersji pomiędzy danymi Firestore typu NewDbModelType i Twoim niestandardowym typem NewAppModelType .
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| przetwornik | Konwerter danych Firestore <Typ NewAppModel, Typ NewDbModel> | Konwertuje obiekty do i z Firestore. |
Zwroty:
Zapytanie <Typ NewAppModel, Typ NewDbModel>
Query korzystające z dostarczonego konwertera.