Query class

Query cập đến một truy vấn mà bạn có thể đọc hoặc nghe. Bạn cũng có thể xây dựng các đối tượng Query đã được tinh chỉnh bằng cách thêm các bộ lọc và sắp xếp.

Chữ ký:

export declare class Query<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

nhà xây dựng

Người xây dựng sửa đổi Sự miêu tả
(người xây dựng)() Xây dựng một thể hiện mới của lớp Query

Của cải

Tài sản sửa đổi Kiểu Sự miêu tả
bộ chuyển đổi Bộ chuyển đổi dữ liệu Firestore <AppModelType, DbModelType> | vô giá trị Nếu được cung cấp, FirestoreDataConverter được liên kết với phiên bản này.
lò sưởi lò sưởi Phiên bản Firestore cho cơ sở dữ liệu Firestore (hữu ích để thực hiện các giao dịch, v.v.).
kiểu 'truy vấn' | 'bộ sưu tập' Loại tham chiếu Firestore này.

phương pháp

Phương pháp sửa đổi Sự miêu tả
withConverter(bộ chuyển đổi) Loại bỏ bộ chuyển đổi hiện tại.
withConverter(bộ chuyển đổi) Áp dụng trình chuyển đổi dữ liệu tùy chỉnh cho truy vấn này, cho phép bạn sử dụng các đối tượng mô hình tùy chỉnh của riêng mình với Firestore. Khi bạn gọi getDocs() bằng truy vấn được trả về, trình chuyển đổi được cung cấp sẽ chuyển đổi giữa dữ liệu Firestore thuộc loại NewDbModelType và loại tùy chỉnh NewAppModelType của bạn.

Truy vấn.(hàm tạo)

Xây dựng một thể hiện mới của lớp Query

Chữ ký:

protected constructor();

Query.converter

Nếu được cung cấp, FirestoreDataConverter được liên kết với phiên bản này.

Chữ ký:

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

Truy vấn.firestore

Phiên bản Firestore cho cơ sở dữ liệu Firestore (hữu ích để thực hiện các giao dịch, v.v.).

Chữ ký:

readonly firestore: Firestore;

Truy vấn.type

Loại tham chiếu Firestore này.

Chữ ký:

readonly type: 'query' | 'collection';

Query.withConverter()

Loại bỏ bộ chuyển đổi hiện tại.

Chữ ký:

withConverter(converter: null): Query<DocumentData, DocumentData>;

Thông số

Tham số Kiểu Sự miêu tả
bộ chuyển đổi vô giá trị null loại bỏ bộ chuyển đổi hiện tại.

Trả về:

Truy vấn < Dữ liệu tài liệu , Dữ liệu tài liệu >

Query<DocumentData, DocumentData> không sử dụng trình chuyển đổi.

Query.withConverter()

Áp dụng trình chuyển đổi dữ liệu tùy chỉnh cho truy vấn này, cho phép bạn sử dụng các đối tượng mô hình tùy chỉnh của riêng mình với Firestore. Khi bạn gọi getDocs() bằng truy vấn được trả về, trình chuyển đổi được cung cấp sẽ chuyển đổi giữa dữ liệu Firestore thuộc loại NewDbModelType và loại tùy chỉnh NewAppModelType của bạn .

Chữ ký:

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): Query<NewAppModelType, NewDbModelType>;

Thông số

Tham số Kiểu Sự miêu tả
bộ chuyển đổi Bộ chuyển đổi dữ liệu Firestore <NewAppModelType, NewDbModelType> Chuyển đổi các đối tượng đến và đi từ Firestore.

Trả về:

Truy vấn <NewAppModelType, NewDbModelType>

Query sử dụng trình chuyển đổi được cung cấp.