Query odnosi się do zapytania, które można odczytać lub odsłuchać. Możesz też tworzyć dopracowane obiekty Query, dodając filtry i kolejność.
Podpis:
export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Zespoły
| Zespół | Modyfikatory | Opis |
|---|---|---|
| (konstruktor)() | Tworzy nową instancję klasy Query |
Właściwości
| Właściwość | Modyfikatory | Typ | Opis |
|---|---|---|---|
| konwerter | FirestoreDataConverter<AppModelType, DbModelType> | wartość null | Jeśli podano, FirestoreDataConverter powiązane z tą instancją. |
|
| firestore | Firestore | Instancja Firestore bazy danych Firestore (przydatna do wykonywania transakcji itp.). |
|
| type | „query” | „collection” | Typ tego odwołania Firestore. |
Metody
| Metoda | Modyfikatory | Opis |
|---|---|---|
| withConverter(konwerter) | Usuwa bieżący konwerter. | |
| withConverter(konwerter) | Stosuje do tego zapytania niestandardowy konwerter danych, dzięki czemu możesz używać w Firestore własnych obiektów modelu. Gdy wywołasz funkcję getDocuments() ze zwróconym zapytaniem, podany konwerter zostanie przekonwertowany między danymi Firestore typu NewDbModelType a niestandardowym typem NewAppModelType. |
Zapytanie.(konstruktor)
Tworzy nową instancję klasy Query
Podpis:
protected constructor();
Query.converter
Jeśli podano, FirestoreDataConverter powiązane z tą instancją.
Podpis:
readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;
Query.firestore
Instancja Firestore bazy danych Firestore (przydatna do wykonywania transakcji itp.).
Podpis:
readonly firestore: Firestore;
Typ zapytania
Typ tego odwołania Firestore.
Podpis:
readonly type: 'query' | 'collection';
Query.withConverter()
Usuwa bieżący konwerter.
Podpis:
withConverter(converter: null): Query<DocumentData, DocumentData>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | null | Funkcja null usuwa aktualny konwerter. |
Zwroty:
Zapytanie<DocumentData, DocumentData>
Identyfikator Query<DocumentData, DocumentData>, który nie korzysta z konwertera.
Query.withConverter()
Stosuje do tego zapytania niestandardowy konwerter danych, dzięki czemu możesz używać w Firestore własnych obiektów modelu. Gdy wywołasz funkcję getDocuments() ze zwróconym zapytaniem, podany konwerter zostanie przekonwertowany między danymi Firestore typu NewDbModelType a niestandardowym typem NewAppModelType.
Podpis:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| użytkownik dokonujący konwersji | FirestoreDataConverter<NewAppModelType, NewDbModelType> | Konwertuje obiekty do i z Firestore. |
Zwroty:
Zapytanie<NewAppModelType, NewDbModelType>
Pole Query, które korzysta z podanego konwertera.