@firebase/firestore

Phiên bản Firestore mặc định của ứng dụng đã cung cấp.

getFirestore(ứng dụng, Cơ sở dữ liệuId)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trên phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.

Trả về thực thể Firestore hiện có và đã liên kết với FirebaseApp được cung cấp. Nếu không có thực thể nào tồn tại, hãy khởi chạy một phiên bản mới với chế độ cài đặt mặc định.

Chữ ký:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng Firebase	Phiên bản FirebaseApp mà phiên bản Firestore đã trả về được liên kết.
mã cơ sở dữ liệu	chuỗi	Tên của cơ sở dữ liệu.

Trường hợp trả lại hàng:

Phiên bản Firestore có tên của ứng dụng đã cung cấp.

derivedFirestore(ứng dụng, chế độ cài đặt, DatabaseId)

Khởi chạy một bản sao mới của Firestore với các chế độ cài đặt đã cho. Chỉ có thể được gọi trước bất kỳ hàm nào khác, bao gồm cả getFirestore(). Nếu chế độ cài đặt tuỳ chỉnh trống, thì hàm này tương đương với việc gọi getFirestore().

Chữ ký:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

Thông số

Thông số	Loại	Mô tả
ứng dụng	Ứng dụng Firebase	FirebaseApp mà phiên bản Firestore sẽ được liên kết.
cài đặt	FirestoreSettings	Đối tượng cài đặt để định cấu hình thực thể Firestore.
mã cơ sở dữ liệu	chuỗi	Tên của cơ sở dữ liệu.

Trường hợp trả lại hàng:

CollectionReference<DocumentData, DocumentData>

Một thực thể Firestore mới khởi tạo.

function(firestore, ...)

clearIndexedDbPersistence(firestore)

Xoá bộ nhớ ổn định. Quy tắc này bao gồm các lượt ghi đang chờ xử lý và tài liệu được lưu vào bộ nhớ đệm.

Phải được gọi khi thực thể Firestore chưa khởi động (sau khi ứng dụng bị chấm dứt hoặc khi khởi động ứng dụng lần đầu). Khi khởi động, hàm này phải được gọi trước các hàm khác (không phải là initializeFirestore() hoặc getFirestore())). Nếu thực thể Firestore vẫn đang chạy, thì lời hứa sẽ bị từ chối kèm theo mã lỗi failed-precondition.

Chữ ký:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để xoá tính năng lưu trữ cố định.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải khi xoá bộ nhớ liên tục. Nếu không, lời hứa sẽ bị từ chối kèm theo lỗi.

bộ sưu tập(kho lửa, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể CollectionReference tham chiếu đến tập hợp tại đường dẫn tuyệt đối được chỉ định.

Chữ ký:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Tham chiếu đến thực thể gốc `Firestore`.
đường dẫn	chuỗi	Đường dẫn đến một bộ sưu tập được phân tách bằng dấu gạch chéo.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung cần áp dụng liên quan đến đối số đầu tiên.

Trường hợp trả lại hàng:

Thực thể CollectionReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số lượng phân đoạn bằng nhau và không trỏ đến một tập hợp.

collectionGroup(firestore, collectionId)

Tạo và trả về một thực thể Query mới bao gồm tất cả tài liệu trong cơ sở dữ liệu có trong một tập hợp hoặc bộ sưu tập con có collectionId đã cho.

Chữ ký:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Tham chiếu đến thực thể gốc `Firestore`.
mã bộ sưu tập	chuỗi	Xác định các tập hợp để truy vấn. Mọi bộ sưu tập hoặc bộ sưu tập con có mã nhận dạng này ở phân đoạn cuối cùng của đường dẫn sẽ được đưa vào. Không được chứa dấu gạch chéo.

Trường hợp trả lại hàng:

Truy vấn<DocumentData, DocumentData>

Query đã được tạo.

connectFirestoreEmulator(firestore, máy chủ, cổng, tuỳ chọn)

Sửa đổi phiên bản này để giao tiếp với trình mô phỏng Cloud Firestore.

Chữ ký:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể `Firestore` để định cấu hình kết nối với trình mô phỏng.
máy chủ lưu trữ	chuỗi	máy chủ lưu trữ trình mô phỏng (ví dụ: localhost).
cổng	số	cổng trình mô phỏng (ví dụ: 9000).
tuỳ chọn	{ mockUserToken?: EmulatorMockTokenOptions \| chuỗi; }

Trường hợp trả lại hàng:

trống

vô hiệu hoáNetwork(firestore)

Tắt chế độ sử dụng mạng cho phiên bản này. Bạn có thể bật lại tính năng này thông qua enableNetwork(). Khi mạng bị tắt, mọi trình nghe tổng quan nhanh, lệnh gọi getDoc() hoặc getDocs() đều sẽ trả về kết quả từ bộ nhớ đệm và mọi thao tác ghi sẽ được đưa vào hàng đợi cho đến khi mạng được khôi phục.

Chữ ký:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được giải quyết sau khi mạng bị vô hiệu hoá.

tài liệu(kho lửa, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể DocumentReference tham chiếu đến tài liệu tại đường dẫn tuyệt đối đã chỉ định.

Chữ ký:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Tham chiếu đến thực thể gốc `Firestore`.
đường dẫn	chuỗi	Đường dẫn đến một tài liệu được phân tách bằng dấu gạch chéo.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung sẽ được áp dụng tương ứng với đối số đầu tiên.

Trường hợp trả lại hàng:

DocumentReference<DocumentData, documentData>

Thực thể DocumentReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số đoạn lẻ và không trỏ đến tài liệu.

enableIndexedDbPersistence(Lưu trữ dữ liệu, Lưu trữCài đặt)

Cảnh báo: API này hiện đã lỗi thời.

Hàm này sẽ bị xoá trong một bản phát hành chính sau này. Thay vào đó, hãy đặt FirestoreSettings.localCache thành một thực thể của PersistentLocalCache để bật bộ nhớ đệm IndexedDb. Việc gọi hàm này khi FirestoreSettings.localCache đã được chỉ định sẽ gửi một ngoại lệ.

Nếu có thể, hãy cố gắng bật bộ nhớ liên tục.

Nếu không thành công, enableIndexedDbPersistence() sẽ từ chối lời hứa hoặc đưa ra một ngoại lệ. Có một số nguyên nhân có thể khiến việc xác minh không thành công mà code có thể xác định trên lỗi.

* điều kiện tiên quyết bị lỗi: Ứng dụng đã mở trong một thẻ trình duyệt khác. * chưa triển khai: Trình duyệt không tương thích với triển khai lưu trữ cố định ngoại tuyến.

Lưu ý rằng ngay cả sau khi không thành công, bạn vẫn có thể sử dụng thực thể Firestore. Tuy nhiên, tính năng lưu trữ ngoại tuyến sẽ bị tắt.

Không thể sử dụng tính bền vững trong môi trường Node.js.

Chữ ký:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để bật tính năng lưu trữ cố định.
Cài đặt dữ liệu cố định	Cài đặt cố định	Đối tượng cài đặt không bắt buộc để định cấu hình dữ liệu lưu trữ.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise thể hiện việc bật thành công bộ nhớ liên tục.

enableMultiTabIndexedDbPersistence(firestore)

Cảnh báo: API này hiện đã lỗi thời.

Hàm này sẽ bị xoá trong một bản phát hành chính sau này. Thay vào đó, hãy đặt FirestoreSettings.localCache thành một thực thể của PersistentLocalCache để bật bộ nhớ đệm lập chỉ mục. Việc gọi hàm này khi FirestoreSettings.localCache đã được chỉ định sẽ gửi một ngoại lệ.

Nếu có thể, hãy cố gắng bật tính năng lưu trữ liên tục nhiều thẻ. Nếu được bật trên tất cả các thẻ, thì mọi thao tác đều có quyền truy cập vào dữ liệu cố định cục bộ, bao gồm cả việc thực thi truy vấn được chia sẻ và bản cập nhật tài liệu cục bộ có bù độ trễ trên tất cả thực thể được kết nối.

Nếu không thành công, enableMultiTabIndexedDbPersistence() sẽ từ chối lời hứa hoặc đưa ra một ngoại lệ. Có một số nguyên nhân có thể khiến việc xác minh không thành công mà code có thể xác định trên lỗi.

* điều kiện tiên quyết bị lỗi: Ứng dụng đã mở trong một thẻ trình duyệt khác và tính năng nhiều thẻ chưa được bật. * chưa triển khai: Trình duyệt không tương thích với triển khai lưu trữ cố định ngoại tuyến.

Lưu ý rằng ngay cả sau khi không thành công, bạn vẫn có thể sử dụng thực thể Firestore. Tuy nhiên, tính năng lưu trữ ngoại tuyến sẽ bị tắt.

Chữ ký:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để bật tính năng lưu trữ cố định.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise thể hiện việc bật thành công bộ nhớ liên tục.

enableNetwork(cửa hàng lửa)

Bật lại việc sử dụng mạng cho thực thể Firestore này sau lệnh gọi disableNetwork() trước đó.

Chữ ký:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải sau khi bật mạng.

getPersistentCacheIndexManager(firestore)

Trả về Trình quản lý chỉ mục PersistentCache mà đối tượng Firestore đã cho sử dụng.

Thực thể PersistentCacheIndexManager hoặc null nếu bạn không dùng bộ nhớ cục bộ ổn định.

Chữ ký:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

PersistentCacheIndexManager | rỗng

loadBundle(firestore, bundleData)

Tải một gói Firestore vào bộ nhớ đệm cục bộ.

Chữ ký:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để tải các gói.
BundleData (Dữ liệu gói)	ReadableStream<Uint8Array> \| ArrayBuffer \| chuỗi	Đối tượng đại diện cho gói cần tải. Các đối tượng hợp lệ là `ArrayBuffer`, `ReadableStream<Uint8Array>` hoặc `string`.

Trường hợp trả lại hàng:

LoadBundleTask

Đối tượng LoadBundleTask thông báo cho phương thức gọi về thông tin cập nhật về tiến trình và sự kiện hoàn thành hoặc lỗi. Dữ liệu này có thể được dùng làm Promise<LoadBundleTaskProgress>.

NameQuery(firestore; name)

Đọc một Truy vấn Firestore từ bộ nhớ đệm cục bộ, được xác định theo tên cụ thể.

Các truy vấn có tên được đóng gói thành các gói ở phía máy chủ (cùng với các tài liệu kết quả) và tải vào bộ nhớ đệm cục bộ bằng loadBundle. Sau khi chuyển vào bộ nhớ đệm cục bộ, hãy sử dụng phương thức này để trích xuất Truy vấn theo tên.

Chữ ký:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để đọc truy vấn.
name	chuỗi	Tên của truy vấn.

Trường hợp trả lại hàng:

Cam kết<Truy vấn | rỗng>

Promise được giải quyết bằng Truy vấn hoặc null.

onsnapshotInSync(firestore, trình quan sát)

Đính kèm trình nghe cho một sự kiện đồng bộ hoá ảnh chụp nhanh. Sự kiện đồng bộ hoá tổng quan nhanh cho biết tất cả trình nghe chịu ảnh hưởng của một thay đổi nhất định đều được kích hoạt, ngay cả khi một thay đổi do máy chủ tạo ảnh hưởng đến nhiều trình nghe.

LƯU Ý: Sự kiện bản tổng quan nhanh được đồng bộ hoá chỉ cho biết trình nghe đang đồng bộ hoá với nhau, nhưng không liên quan đến việc các bản tổng quan nhanh đó có đồng bộ hoá với máy chủ hay không. Sử dụng SnapshotMetadata trong từng trình nghe để xác định xem bản tổng quan nhanh đến từ bộ nhớ đệm hay từ máy chủ.

Chữ ký:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể của Firestore để đồng bộ hoá ảnh chụp nhanh.
đối tượng tiếp nhận dữ liệu	{ tiếp theo?: (giá trị: vô hiệu) => vô hiệu; lỗi?: (lỗi: FirestoreError) => vô hiệu; đã hoàn tất?: () => vô hiệu; }	Một đối tượng duy nhất chứa các lệnh gọi lại `next` và `error`.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

trênSnapshotsInSync(firestore, onSync)

LƯU Ý: Sự kiện bản tổng quan nhanh được đồng bộ hoá chỉ cho biết trình nghe đang đồng bộ hoá với nhau, nhưng không liên quan đến việc các bản tổng quan nhanh đó có đồng bộ hoá với máy chủ hay không. Sử dụng SnapshotMetadata trong từng trình nghe để xác định xem bản tổng quan nhanh đến từ bộ nhớ đệm hay từ máy chủ.

Chữ ký:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể `Firestore` để đồng bộ hoá ảnh chụp nhanh.
onSync	() => trống	Một lệnh gọi lại sẽ được gọi mỗi khi tất cả trình nghe tổng quan nhanh đồng bộ hoá với nhau.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

runTransaction(firestore; updateFunction; các tuỳ chọn)

Thực thi updateFunction đã cho và sau đó cố gắng xác nhận các thay đổi được áp dụng trong giao dịch. Nếu bất kỳ tài liệu nào được đọc trong giao dịch đã thay đổi, Cloud Firestore sẽ thử lại updateFunction. Nếu không thực hiện được sau 5 lần thử, thì giao dịch sẽ không thành công.

Số lượt ghi tối đa được phép trong một giao dịch là 500.

Chữ ký:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Mã tham chiếu đến cơ sở dữ liệu Firestore để chạy giao dịch này.
cập nhậtHàm	(giao dịch: Giao dịch) => Cam kết<T>	Hàm thực thi trong ngữ cảnh giao dịch.
tuỳ chọn	Giao dịch	Đối tượng tuỳ chọn để định cấu hình số lần cam kết tối đa.

Trường hợp trả lại hàng:

Cam kết<T>

Nếu giao dịch đã hoàn tất thành công hoặc bị huỷ một cách rõ ràng (updateFunction trả về một hứa hẹn không thành công), thì lời hứa mà updateFunctiontrả về sẽ được trả về ở đây. Ngược lại, nếu giao dịch không thành công, hệ thống sẽ trả về lời hứa bị từ chối kèm theo lỗi không thành công tương ứng.

setIndexConfiguration(firestore, cấu hình)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trên phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.

Cảnh báo: API này hiện đã lỗi thời.

Thay vì tạo chỉ mục bộ nhớ đệm theo cách thủ công, hãy cân nhắc sử dụng enablePersistentCacheIndexAutoCreation() để cho phép SDK quyết định xem có nên tạo chỉ mục bộ nhớ đệm cho các truy vấn chạy cục bộ hay không.

Định cấu hình hoạt động lập chỉ mục để thực thi truy vấn cục bộ. Mọi cấu hình chỉ mục trước đó sẽ bị ghi đè. Promise sẽ phân giải sau khi cấu hình chỉ mục này được duy trì.

Bản thân các mục nhập chỉ mục được tạo không đồng bộ. Bạn có thể tiếp tục sử dụng các truy vấn yêu cầu lập chỉ mục ngay cả khi chưa có chỉ mục. Quá trình thực thi truy vấn sẽ tự động bắt đầu bằng cách sử dụng chỉ mục sau khi các mục nhập trong chỉ mục đã được ghi.

Chỉ mục chỉ được hỗ trợ với tính năng cố định IndexedDb. Nếu IndexedDb không được bật, mọi cấu hình chỉ mục sẽ bị bỏ qua.

Chữ ký:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để định cấu hình chỉ mục.
cấu hình	Cấu hình chỉ mục	Định nghĩa chỉ mục.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise sẽ phân giải sau khi tất cả chỉ mục được định cấu hình thành công.

Trường hợp ngoại lệ

FirestoreError nếu định dạng JSON không hợp lệ.

setIndexConfiguration(firestore, json)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trên phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.

Cảnh báo: API này hiện đã lỗi thời.

Thay vì tạo chỉ mục bộ nhớ đệm theo cách thủ công, hãy cân nhắc sử dụng enablePersistentCacheIndexAutoCreation() để cho phép SDK quyết định xem có nên tạo chỉ mục bộ nhớ đệm cho các truy vấn chạy cục bộ hay không.

Chỉ mục chỉ được hỗ trợ với tính năng cố định IndexedDb. Gọi enableIndexedDbPersistence() hoặc enableMultiTabIndexedDbPersistence() trước khi đặt cấu hình chỉ mục. Nếu IndexedDb không được bật, mọi cấu hình chỉ mục sẽ bị bỏ qua.

Phương thức này chấp nhận định dạng JSON do Firebase CLI (firebase firestore:indexes) xuất. Nếu định dạng JSON không hợp lệ, phương thức này sẽ gửi thông báo lỗi.

Chữ ký:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục	Thực thể Firestore để định cấu hình chỉ mục.
JSON	chuỗi	Định dạng JSON do CLI của Firebase xuất.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise sẽ phân giải sau khi tất cả chỉ mục được định cấu hình thành công.

Trường hợp ngoại lệ

FirestoreError nếu định dạng JSON không hợp lệ.

chấm dứt(cửa hàng lửa)

Chấm dứt phiên bản Firestore được cung cấp.

Sau khi gọi terminate(), bạn chỉ có thể sử dụng hàm clearIndexedDbPersistence(). Mọi hàm khác sẽ gửi một FirestoreError.

Để khởi động lại sau khi chấm dứt, hãy tạo một phiên bản mới của FirebaseFirestore bằng getFirestore().

Việc chấm dứt không huỷ bỏ bất kỳ lệnh ghi đang chờ xử lý nào và mọi lời hứa đang chờ phản hồi từ máy chủ sẽ không được giải quyết. Nếu bạn đã bật tính năng lưu trữ cố định, thì vào lần tiếp theo bạn khởi động thực thể này, phiên bản này sẽ tiếp tục gửi các lượt ghi này tới máy chủ.

Chữ ký:

export declare function terminate(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải khi thực thể đã kết thúc thành công.

PendingForPendingWrites(cửa hàng lửa)

Chờ cho đến khi tất cả lượt ghi hiện đang chờ xử lý cho người dùng đang hoạt động được chương trình phụ trợ xác nhận.

Lời hứa được trả về sẽ phân giải ngay lập tức nếu không có lượt ghi chưa xử lý nào. Nếu không, lời hứa sẽ chờ tất cả các lượt ghi đã phát hành trước đó (bao gồm cả những bản ghi được viết trong một phiên ứng dụng trước đó), nhưng sẽ không chờ các lượt ghi được thêm sau khi hàm được gọi. Nếu bạn muốn đợi lượt ghi thêm, hãy gọi lại waitForPendingWrites().

Mọi lời hứa chưa xử lý xong trong waitForPendingWrites() đều bị từ chối trong quá trình thay đổi người dùng.

Chữ ký:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise phân giải khi tất cả lượt ghi hiện đang chờ xử lý đã được chương trình phụ trợ xác nhận.

ghi lô(firestore)

Tạo một lô ghi, dùng để thực hiện nhiều lần ghi dưới dạng một thao tác ở cấp nguyên tử. Số lần ghi tối đa được phép trong một WriteBatch là 500.

Không giống như giao dịch, lô ghi được lưu trữ khi không có mạng, do đó, bạn nên sử dụng tính năng này khi không cần điều chỉnh quy trình ghi trên dữ liệu đọc.

Chữ ký:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Thông số

Thông số	Loại	Mô tả
kho cứu hoả	Khôi phục

Trường hợp trả lại hàng:

WriteBatch

Một WriteBatch có thể dùng để thực thi nhiều lượt ghi theo tỷ lệ.

Hàm()

số đếm()

Tạo một đối tượng AggregateField có thể dùng để tính số lượng tài liệu trong tập hợp kết quả của một truy vấn.

Chữ ký:

export declare function count(): AggregateField<number>;

Trường hợp trả lại hàng:

AggregateField<number>

deleteField()

Trả về một người gửi để sử dụng với updateDoc() hoặc setDoc() với {merge: true} nhằm đánh dấu một trường cần xoá.

Chữ ký:

export declare function deleteField(): FieldValue;

Trường hợp trả lại hàng:

documentId()

Trả về một giám sát đặc biệt FieldPath để tham chiếu đến mã nhận dạng của một tài liệu. Có thể dùng tên này trong các truy vấn để sắp xếp hoặc lọc theo mã tài liệu.

Chữ ký:

export declare function documentId(): FieldPath;

Trường hợp trả lại hàng:

FieldPath (Đường dẫn trường)

getFirestore()

Trả về phiên bản Firestore mặc định hiện có được liên kết với FirebaseApp mặc định. Nếu không có thực thể nào tồn tại, hãy khởi chạy một phiên bản mới với chế độ cài đặt mặc định.

Chữ ký:

export declare function getFirestore(): Firestore;

Trường hợp trả lại hàng:

MemoryEagerGarbageCollector

Phiên bản Firestore mặc định của ứng dụng mặc định.

bộ nhớEagerGarbage Collector()

Tạo một thực thể của MemoryEagerGarbageCollector. Đây cũng là trình thu gom rác mặc định trừ phi được chỉ định rõ ràng khác.

Chữ ký:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Trường hợp trả lại hàng:

Một số trình quản lý thẻ cố định()

Tạo một thực thể của PersistentMultipleTabManager.

Chữ ký:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Trường hợp trả lại hàng:

PersistentMultipleTabManager

máy chủDấu thời gian()

Trả về một người gửi dùng với setDoc() hoặc updateDoc() để đưa dấu thời gian do máy chủ tạo vào dữ liệu đã ghi.

Chữ ký:

export declare function serverTimestamp(): FieldValue;

Trường hợp trả lại hàng:

function(databaseId, ...)

getFirestore(databaseId)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trên phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.

Trả về thực thể Firestore hiện có được liên kết với FirebaseApp mặc định. Nếu không có thực thể nào tồn tại, hãy khởi chạy một phiên bản mới với chế độ cài đặt mặc định.

Chữ ký:

export declare function getFirestore(databaseId: string): Firestore;

Thông số

Thông số	Loại	Mô tả
mã cơ sở dữ liệu	chuỗi	Tên của cơ sở dữ liệu.

Trường hợp trả lại hàng:

Phiên bản Firestore có tên của ứng dụng mặc định.

hàm(phần tử, ...)

mảngRemove(phần tử)

Trả về một giá trị đặc biệt có thể dùng với setDoc() hoặc yêu cầu máy chủ xoá các phần tử đã cho khỏi bất kỳ giá trị mảng nào đã tồn tại trên máy chủ. Tất cả các bản sao của từng phần tử được chỉ định sẽ bị xóa khỏi mảng. Nếu trường đang được sửa đổi không phải là một mảng, thì trường đó sẽ bị ghi đè bằng một mảng trống.

Chữ ký:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Thông số

Thông số	Loại	Mô tả
phần tử	không xác định[]	Các phần tử cần xoá khỏi mảng.

Trường hợp trả lại hàng:

Gửi yêu cầu FieldValue để dùng trong lệnh gọi đến setDoc() hoặc updateDoc()

mảngUnion(phần tử)

Trả về một giá trị đặc biệt có thể dùng với setDoc() hoặc updateDoc(). Giá trị này yêu cầu máy chủ hợp nhất các phần tử đã cho với bất kỳ giá trị mảng nào đã tồn tại trên máy chủ. Mỗi phần tử được chỉ định chưa tồn tại trong mảng sẽ được thêm vào cuối. Nếu trường đang được sửa đổi không phải là một mảng thì trường đó sẽ bị ghi đè bằng một mảng chứa chính xác các phần tử được chỉ định.

Chữ ký:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Thông số

Thông số	Loại	Mô tả
phần tử	không xác định[]	Các phần tử cần hợp nhất thành mảng.

Trường hợp trả lại hàng:

QueryFieldFilterConstraint

Gửi yêu cầu FieldValue để dùng trong lệnh gọi đến setDoc() hoặc updateDoc().

function(trường, ...)

trung bình(trường)

Tạo một đối tượng AggregateField có thể dùng để tính giá trị trung bình của một trường đã chỉ định trên một dải tài liệu trong tập hợp kết quả của một truy vấn.

Chữ ký:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Thông số

Thông số	Loại	Mô tả
trường	chuỗi \| FieldPath (Đường dẫn trường)	Chỉ định trường để tính giá trị trung bình của tập hợp kết quả.

Trường hợp trả lại hàng:

AggregateField<number | rỗng>

sum(trường)

Tạo một đối tượng AggregateField có thể dùng để tính tổng của một trường chỉ định trên một dải tài liệu trong tập hợp kết quả của một truy vấn.

Chữ ký:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Thông số

Thông số	Loại	Mô tả
trường	chuỗi \| FieldPath (Đường dẫn trường)	Chỉ định trường để tính tổng qua tập hợp kết quả.

Trường hợp trả lại hàng:

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, directionStr)

Tạo một QueryOrderByConstraint để sắp xếp kết quả truy vấn theo trường được chỉ định, không bắt buộc theo thứ tự giảm dần thay vì tăng dần.

Chữ ký:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Thông số

Thông số	Loại	Mô tả
Đường dẫn trường	chuỗi \| FieldPath (Đường dẫn trường)	Trường để sắp xếp theo.
Chỉ đường	OrderByDirection	Hướng không bắt buộc để sắp xếp theo ("theo thứ tự tăng dần" hoặc "theo thứ tự giảm dần"). Nếu bạn không chỉ định, thứ tự sẽ tăng dần.

Trường hợp trả lại hàng:

QueryOrderByConstraint

QueryOrderByConstraint đã tạo.

where(fieldPath; opStr; giá trị)

Tạo một QueryFieldFilterConstraint để thực thi các tài liệu phải chứa trường được chỉ định và giá trị phải đáp ứng quy tắc ràng buộc mối quan hệ đã cung cấp.

Chữ ký:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Thông số

Thông số	Loại	Mô tả
Đường dẫn trường	chuỗi \| FieldPath (Đường dẫn trường)	Lộ trình so sánh
hoạt động	WhereFilterOp	Chuỗi thao tác (ví dụ: "<", "<=", "==", "<", "<=", "!=").
value	không xác định	Giá trị để so sánh

Trường hợp trả lại hàng:

QueryFieldFilterConstraint đã tạo.

function(fieldValues, ...)

endAt(fieldValues)

Tạo một QueryEndAtConstraint để sửa đổi kết quả được đặt thành kết thúc tại các trường đã cung cấp tương ứng với thứ tự của truy vấn. Thứ tự của các giá trị trường phải khớp với thứ tự của thứ tự theo mệnh đề của truy vấn.

Chữ ký:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Thông số

Thông số	Loại	Mô tả
giá trị trường	không xác định[]	Các giá trị trường để kết thúc truy vấn này theo thứ tự của truy vấn.

Trường hợp trả lại hàng:

QueryEndAtConstraint để truyền đến query()

endbefore(giá trị trường)

Tạo một QueryEndAtConstraint để sửa đổi tập hợp kết quả thành kết thúc trước khi các trường được cung cấp tương ứng với thứ tự của truy vấn. Thứ tự của các giá trị trường phải khớp với thứ tự của thứ tự theo mệnh đề của truy vấn.

Chữ ký:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Thông số

Thông số	Loại	Mô tả
giá trị trường	không xác định[]	Các giá trị trường để kết thúc truy vấn này trước, theo thứ tự của truy vấn.

Trường hợp trả lại hàng:

QueryEndAtConstraint để truyền đến query()

startSau(Giá trị trường)

Tạo một QueryStartAtConstraint để sửa đổi tập hợp kết quả để bắt đầu sau các trường đã cung cấp tương ứng với thứ tự của truy vấn. Thứ tự của các giá trị trường phải khớp với thứ tự của thứ tự theo mệnh đề của truy vấn.

Chữ ký:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Thông số

Thông số	Loại	Mô tả
giá trị trường	không xác định[]	Các giá trị trường để bắt đầu truy vấn này sau đó, theo thứ tự của truy vấn.

Trường hợp trả lại hàng:

QueryStartAtConstraint để truyền đến query()

startAt(giá trị trường)

Tạo một QueryStartAtConstraint để sửa đổi tập hợp kết quả để bắt đầu tại các trường đã cung cấp tương ứng với thứ tự của truy vấn. Thứ tự của các giá trị trường phải khớp với thứ tự của thứ tự theo mệnh đề của truy vấn.

Chữ ký:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Thông số

Thông số	Loại	Mô tả
giá trị trường	không xác định[]	Các giá trị trường để bắt đầu truy vấn này theo thứ tự của truy vấn.

Trường hợp trả lại hàng:

QueryStartAtConstraint để truyền đến query().

function(indexManager, ...)

deleteAllPersistentCacheIndexes(indexManager)

Xoá tất cả chỉ mục bộ nhớ đệm cố định.

Xin lưu ý rằng hàm này cũng sẽ xoá các chỉ mục do setIndexConfiguration() tạo (không dùng nữa).

Chữ ký:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

Thông số

Thông số	Loại	Mô tả
trình quản lý chỉ mục	PersistentCacheIndexManager

Trường hợp trả lại hàng:

trống

vô hiệu hoáPersistentCacheIndexAutoCreation(indexManager)

Tự động ngừng tạo chỉ mục bộ nhớ đệm cố định để thực thi truy vấn cục bộ. Các chỉ mục được tạo bằng cách gọi enablePersistentCacheIndexAutoCreation() vẫn có hiệu lực.

Chữ ký:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Thông số

Thông số	Loại	Mô tả
trình quản lý chỉ mục	PersistentCacheIndexManager

Trường hợp trả lại hàng:

trống

enablePersistentCacheIndexAutoCreation(indexManager)

Cho phép SDK tự động tạo chỉ mục bộ nhớ đệm cố định để thực thi truy vấn cục bộ khi SDK cho rằng chỉ mục bộ nhớ đệm có thể giúp cải thiện hiệu suất.

Tính năng này bị tắt theo mặc định.

Chữ ký:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Thông số

Thông số	Loại	Mô tả
trình quản lý chỉ mục	PersistentCacheIndexManager

Trường hợp trả lại hàng:

trống

hàm(trái, ...)

totalFieldEqual(trái, phải)

So sánh hai thực thể "AggregateField" để xét đẳng thức.

Chữ ký:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Thông số

Thông số	Loại	Mô tả
trái	AggregateField<không xác định>	So sánh AggregateField này với `right`.
phải	AggregateField<không xác định>	So sánh AggregateField này với `left`.

Trường hợp trả lại hàng:

boolean

tổng hợpQuerySnapshotEqual(trái, phải)

So sánh 2 thực thể AggregateQuerySnapshot để xem có đẳng thức.

2 thực thể AggregateQuerySnapshot được coi là "bằng" nếu chúng có các truy vấn cơ bản so sánh bằng nhau và cùng dữ liệu.

Chữ ký:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

Thông số

Thông số	Loại	Mô tả
trái	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	`AggregateQuerySnapshot` đầu tiên để so sánh.
phải	AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>	`AggregateQuerySnapshot` thứ hai cần so sánh.

Trường hợp trả lại hàng:

boolean

true nếu các đối tượng "bằng", như định nghĩa ở trên hoặc false nếu không.

queryEqual(trái, phải)

Trả về true nếu các truy vấn đã cho trỏ đến cùng một tập hợp và áp dụng các điều kiện ràng buộc tương tự.

Chữ ký:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Thông số

Thông số	Loại	Mô tả
trái	Truy vấn<AppModelType, DbModelType>	`Query` để so sánh.
phải	Truy vấn<AppModelType, DbModelType>	`Query` để so sánh.

Trường hợp trả lại hàng:

boolean

true nếu các tham chiếu trỏ đến cùng một vị trí trong cùng một cơ sở dữ liệu Firestore.

refEqual(trái; phải)

Trả về true nếu các giá trị tham chiếu đã cho bằng nhau.

Chữ ký:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

Thông số

Thông số	Loại	Mô tả
trái	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Một tài liệu tham khảo để so sánh.
phải	DocumentReference<AppModelType, DbModelType> \| CollectionReference<AppModelType, DbModelType>	Một tài liệu tham khảo để so sánh.

Trường hợp trả lại hàng:

boolean

true nếu các tham chiếu trỏ đến cùng một vị trí trong cùng một cơ sở dữ liệu Firestore.

snapshotEqual(trái, phải)

Trả về true nếu các ảnh chụp nhanh được cung cấp bằng nhau.

Chữ ký:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

Thông số

Thông số	Loại	Mô tả
trái	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	Thông tin tổng quan nhanh để so sánh.
phải	DocumentSnapshot<AppModelType, DbModelType> \| QuerySnapshot<AppModelType, DbModelType>	Thông tin tổng quan nhanh để so sánh.

Trường hợp trả lại hàng:

boolean

true nếu các ảnh chụp nhanh bằng nhau.

hàm(giới hạn, ...)

giới hạn(giới hạn)

Tạo một QueryLimitConstraint chỉ trả về những tài liệu phù hợp đầu tiên.

Chữ ký:

export declare function limit(limit: number): QueryLimitConstraint;

Thông số

Thông số	Loại	Mô tả
giới hạn	số	Số lượng mục tối đa cần trả về.

Trường hợp trả lại hàng:

QueryLimitConstraint

QueryLimitConstraint đã tạo.

limitToLast(giới hạn)

Tạo một QueryLimitConstraint chỉ trả về những tài liệu khớp gần đây nhất.

Bạn phải chỉ định ít nhất một mệnh đề orderBy cho các truy vấn limitToLast, nếu không, hệ thống sẽ gửi một ngoại lệ trong quá trình thực thi.

Chữ ký:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Thông số

Thông số	Loại	Mô tả
giới hạn	số	Số lượng mục tối đa cần trả về.

Trường hợp trả lại hàng:

QueryLimitConstraint

QueryLimitConstraint đã tạo.

hàm(loglevel, ...)

setLogLevel(logLevel)

Đặt độ chi tiết của nhật ký Cloud Firestore (gỡ lỗi, lỗi hoặc im lặng).

Chữ ký:

export declare function setLogLevel(logLevel: LogLevel): void;

Thông số

Thông số	Loại	Mô tả
cấp độ nhật ký	Cấp độ nhật ký	Độ chi tiết mà bạn đặt để ghi nhật ký hoạt động và lỗi. Có thể là bất kỳ giá trị nào sau đây: `debug` cho cấp độ ghi nhật ký chi tiết nhất, chủ yếu cho mục đích gỡ lỗi. `error` để chỉ ghi lại lỗi. `silent to turn off logging.`

Trường hợp trả lại hàng:

trống

function(n, ...)

tăng dần(n)

Trả về một giá trị đặc biệt có thể dùng với setDoc() hoặc updateDoc(). Giá trị này yêu cầu máy chủ tăng giá trị hiện tại của trường theo giá trị đã cho.

Nếu toán hạng hoặc giá trị trường hiện tại sử dụng độ chính xác dấu phẩy động, thì tất cả số học đều tuân theo ngữ nghĩa của IEEE 754. Nếu cả hai giá trị đều là số nguyên, thì các giá trị nằm ngoài phạm vi số an toàn của JavaScript (Number.MIN_SAFE_INTEGER đến Number.MAX_SAFE_INTEGER) cũng bị mất độ chính xác. Hơn nữa, sau khi được xử lý bởi phần phụ trợ Firestore, tất cả các thao tác số nguyên đều được giới hạn trong khoảng từ -2^63 đến 2^63-1.

Nếu giá trị trường hiện tại không thuộc loại number hoặc nếu trường chưa tồn tại, quy tắc chuyển đổi sẽ đặt trường thành giá trị đã cho.

Chữ ký:

export declare function increment(n: number): FieldValue;

Thông số

Thông số	Loại	Mô tả
n	số	Giá trị cần tăng theo.

Trường hợp trả lại hàng:

Gửi yêu cầu FieldValue để dùng trong lệnh gọi đến setDoc() hoặc updateDoc()

function(truy vấn, ...)

getAggregateFromServer(query, aggregateSpec)

Tính toán các dữ liệu tổng hợp được chỉ định trên các tài liệu trong tập hợp kết quả của truy vấn cho trước mà không cần tải tài liệu xuống.

Việc sử dụng hàm này để thực hiện tổng hợp là một cách hiệu quả vì chỉ có các giá trị tổng hợp cuối cùng chứ không phải tài liệu' đã được tải xuống. Hàm này có thể tổng hợp tài liệu trong trường hợp tập hợp kết quả quá lớn để tải xuống hoàn toàn (hàng nghìn tài liệu).

Kết quả nhận được từ máy chủ được trình bày, không thay đổi, mà không cần xem xét bất kỳ trạng thái cục bộ nào. Tức là các tài liệu trong bộ nhớ đệm cục bộ không được xem xét và các nội dung sửa đổi cục bộ chưa được đồng bộ hoá với máy chủ. Các kết quả đã tải xuống trước đó (nếu có) sẽ không được sử dụng. Mỗi lần gọi hàm này nhất thiết phải thực hiện một lượt khứ hồi đến máy chủ.

Chữ ký:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Truy vấn có nhóm kết quả được tổng hợp.
Thông số kỹ thuật tổng hợp	AggregateSpecType	Đối tượng `AggregateSpec` chỉ định các tổng hợp để thực hiện trên tập hợp kết quả. AggregateSpec chỉ định bí danh cho mỗi dữ liệu tổng hợp, có thể dùng để truy xuất kết quả tổng hợp.

Trường hợp trả lại hàng:

Cam kết<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>

Ví dụ

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(truy vấn)

Tính toán số lượng tài liệu trong tập hợp kết quả của truy vấn đã cho mà không thực sự tải tài liệu xuống.

Việc sử dụng hàm này để đếm tài liệu là hiệu quả vì chỉ số lượng cuối cùng chứ không phải tài liệu' đã được tải xuống. Hàm này có thể đếm tài liệu trong trường hợp tập hợp kết quả quá lớn để tải xuống toàn bộ (hàng nghìn tài liệu).

Chữ ký:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Truy vấn có kích thước nhóm kết quả được tính toán.

Trường hợp trả lại hàng:

Hứa hẹn<AggregateQuerySnapshot<{ count: AggregateField<number>; }, AppModelType, DbModelType>>

Lời hứa sẽ được giải quyết với số lượng; số lượng này có thể được truy xuất từ snapshot.data().count, trong đó snapshot là AggregateQuerySnapshot mà Lời hứa được trả về phân giải đến.

getDocuments(truy vấn)

Thực thi truy vấn và trả về kết quả dưới dạng QuerySnapshot.

Chữ ký:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>

Trường hợp trả lại hàng:

Cam kết<QuerySnapshot<AppModelType, DbModelType>>

Promise sẽ được giải quyết bằng kết quả của truy vấn.

get DocsFromCache(truy vấn)

Thực thi truy vấn và trả về kết quả dưới dạng QuerySnapshot từ bộ nhớ đệm. Trả về tập hợp kết quả trống nếu không có tài liệu nào phù hợp với truy vấn hiện được lưu trong bộ nhớ đệm.

Chữ ký:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>

Trường hợp trả lại hàng:

Cam kết<QuerySnapshot<AppModelType, DbModelType>>

Promise sẽ được giải quyết bằng kết quả của truy vấn.

get DocsFromServer(truy vấn)

Thực thi truy vấn và trả về kết quả dưới dạng QuerySnapshot từ máy chủ. Trả về lỗi nếu không có mạng.

Chữ ký:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>

Trường hợp trả lại hàng:

Cam kết<QuerySnapshot<AppModelType, DbModelType>>

Promise sẽ được giải quyết bằng kết quả của truy vấn.

onSnapshot(truy vấn, đối tượng tiếp nhận dữ liệu)

Đính kèm một trình nghe cho các sự kiện QuerySnapshot. Bạn có thể truyền từng lệnh gọi lại onNext và onError hoặc truyền một đối tượng trình quan sát duy nhất thông qua các lệnh gọi lại next và error. Bạn có thể huỷ trình nghe bằng cách gọi hàm được trả về khi onSnapshot được gọi.

LƯU Ý: Mặc dù có thể cung cấp lệnh gọi lại onCompletion, nhưng lệnh gọi lại này sẽ không bao giờ được gọi vì luồng tổng quan nhanh là không bao giờ kết thúc.

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Cụm từ muốn nghe.
đối tượng tiếp nhận dữ liệu	{ tiếp theo?: (ảnh chụp nhanh: QuerySnapshot<AppModelType, DbModelType>) => vô hiệu; lỗi?: (lỗi: FirestoreError) => vô hiệu; đã hoàn tất?: () => vô hiệu; }	Một đối tượng duy nhất chứa các lệnh gọi lại `next` và `error`.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(truy vấn, tuỳ chọn, đối tượng tiếp nhận dữ liệu)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Cụm từ muốn nghe.
tuỳ chọn	SnapshotListenOptions	Các tuỳ chọn kiểm soát hành vi nghe.
đối tượng tiếp nhận dữ liệu	{ tiếp theo?: (ảnh chụp nhanh: QuerySnapshot<AppModelType, DbModelType>) => vô hiệu; lỗi?: (lỗi: FirestoreError) => vô hiệu; đã hoàn tất?: () => vô hiệu; }	Một đối tượng duy nhất chứa các lệnh gọi lại `next` và `error`.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(query; onNext, onError, onCompletion)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Cụm từ muốn nghe.
onNext	(ảnh chụp nhanh: QuerySnapshot<AppModelType, DbModelType>) => trống	Lệnh gọi lại sẽ được gọi mỗi khi có `QuerySnapshot` mới.
lỗi onError	(lỗi: FirestoreError) => trống	Lệnh gọi lại sẽ được gọi nếu lượt nghe không thành công hoặc bị huỷ. Sẽ không có lệnh gọi lại nào khác xảy ra.
hoàn thành	() => trống	Có thể cung cấp nhưng sẽ không được gọi vì luồng không bao giờ kết thúc.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(truy vấn, tuỳ chọn, onNext, onError, onCompletion)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Cụm từ muốn nghe.
tuỳ chọn	SnapshotListenOptions	Các tuỳ chọn kiểm soát hành vi nghe.
onNext	(ảnh chụp nhanh: QuerySnapshot<AppModelType, DbModelType>) => trống	Lệnh gọi lại sẽ được gọi mỗi khi có `QuerySnapshot` mới.
lỗi onError	(lỗi: FirestoreError) => trống	Lệnh gọi lại sẽ được gọi nếu lượt nghe không thành công hoặc bị huỷ. Sẽ không có lệnh gọi lại nào khác xảy ra.
hoàn thành	() => trống	Có thể cung cấp nhưng sẽ không được gọi vì luồng không bao giờ kết thúc.

Trường hợp trả lại hàng:

QueryCompositeFilterConstraint

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

truy vấn(query, compositeFilter, queryConstraints)

Tạo một thực thể Truy vấn bất biến mới và được mở rộng để bao gồm cả các điều kiện ràng buộc khác đối với truy vấn.

Chữ ký:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Thực thể Query để dùng làm cơ sở cho các quy tắc ràng buộc mới.
bộ lọc tổng hợp	QueryCompositeFilterConstraint	QueryCompositeFilterConstraint sẽ được áp dụng. Tạo QueryCompositeFilterConstraint bằng cách sử dụng and() hoặc or().
queryConstraints	QueryNonFilterConstraint[]	Các QueryNonFilterConstraint bổ sung cần áp dụng (ví dụ: orderBy(), limit()).

Trường hợp trả lại hàng:

Truy vấn<AppModelType, DbModelType>

Trường hợp ngoại lệ

nếu không thể kết hợp bất kỳ quy tắc ràng buộc nào đối với truy vấn đã cho với quy tắc ràng buộc hiện tại hoặc mới.

truy vấn(query, queryConstraints)

Tạo một thực thể Truy vấn bất biến mới và được mở rộng để bao gồm cả các điều kiện ràng buộc khác đối với truy vấn.

Chữ ký:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Thông số

Thông số	Loại	Mô tả
truy vấn	Truy vấn<AppModelType, DbModelType>	Thực thể Query để dùng làm cơ sở cho các quy tắc ràng buộc mới.
queryConstraints	QueryConstraint[]	Danh sách QueryConstraints để áp dụng.

Trường hợp trả lại hàng:

Truy vấn<AppModelType, DbModelType>

Trường hợp ngoại lệ

nếu không thể kết hợp bất kỳ quy tắc ràng buộc nào đối với truy vấn đã cho với quy tắc ràng buộc hiện tại hoặc mới.

function(queryConstraints, ...)

và(queryConstraints)

Tạo một QueryCompositeFilterConstraint mới là sự kết hợp của các giới hạn bộ lọc nhất định. Một bộ lọc nối bao gồm một tài liệu nếu tài liệu đó đáp ứng tất cả các bộ lọc đã cho.

Chữ ký:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Thông số

Thông số	Loại	Mô tả
queryConstraints	QueryFilterConstraint[]	Không bắt buộc. Danh sách QueryFilterConstraint để thực hiện việc liên kết. Các toán tử này phải được tạo bằng các lệnh gọi đến where(), or() hoặc and().

Trường hợp trả lại hàng:

QueryCompositeFilterConstraint mới được tạo.

hoặc(queryConstraints)

Tạo một QueryCompositeFilterConstraint mới là sự tách biệt của các hạn chế đối với bộ lọc nhất định. Bộ lọc phân tách bao gồm một tài liệu nếu tài liệu đó đáp ứng bất kỳ bộ lọc nào trong số các bộ lọc đã cho.

Chữ ký:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Thông số

Thông số	Loại	Mô tả
queryConstraints	QueryFilterConstraint[]	Không bắt buộc. Danh sách QueryFilterConstraint để thực hiện tách biệt. Các toán tử này phải được tạo bằng các lệnh gọi đến where(), or() hoặc and().

Trường hợp trả lại hàng:

QueryCompositeFilterConstraint

QueryCompositeFilterConstraint mới được tạo.

hàm(tham chiếu, ...)

addDoc(tài liệu tham khảo, dữ liệu)

Thêm một tài liệu mới vào CollectionReference được chỉ định bằng dữ liệu đã cho, tự động gán mã tài liệu cho tài liệu đó.

Chữ ký:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	CollectionReference<AppModelType, DbModelType>	Tham chiếu đến bộ sưu tập để thêm tài liệu này vào.
dữ liệu	WithFieldValue<AppModelType>	Đối tượng chứa dữ liệu của tài liệu mới.

Trường hợp trả lại hàng:

Cam kết<DocumentReference<AppModelType, DbModelType>>

Promise được phân giải bằng DocumentReference trỏ đến tài liệu mới tạo sau khi tài liệu đó được ghi vào phần phụ trợ (Lưu ý rằng tài liệu này sẽ không phân giải khi bạn không có kết nối mạng).

bộ sưu tập(tham chiếu, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể CollectionReference tham chiếu đến một bộ sưu tập con reference tại đường dẫn tương đối được chỉ định.

Chữ ký:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	CollectionReference<AppModelType, DbModelType>	Tham chiếu đến một bộ sưu tập.
đường dẫn	chuỗi	Đường dẫn đến một bộ sưu tập được phân tách bằng dấu gạch chéo.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung cần áp dụng liên quan đến đối số đầu tiên.

Trường hợp trả lại hàng:

CollectionReference<DocumentData, DocumentData>

Thực thể CollectionReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số lượng phân đoạn bằng nhau và không trỏ đến một tập hợp.

bộ sưu tập(tham chiếu, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể CollectionReference tham chiếu đến một bộ sưu tập con reference tại đường dẫn tương đối được chỉ định.

Chữ ký:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu trên Firestore.
đường dẫn	chuỗi	Đường dẫn đến một bộ sưu tập được phân tách bằng dấu gạch chéo.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung sẽ được áp dụng tương ứng với đối số đầu tiên.

Trường hợp trả lại hàng:

CollectionReference<DocumentData, DocumentData>

Thực thể CollectionReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số lượng phân đoạn bằng nhau và không trỏ đến một tập hợp.

deleteDoc(tài liệu tham khảo)

Xoá tài liệu được tham chiếu bởi DocumentReference được chỉ định.

Chữ ký:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần xoá.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Lời hứa đã được giải quyết sau khi tài liệu được xoá thành công khỏi phần phụ trợ (lưu ý rằng tài liệu đó sẽ không phân giải được khi bạn không có kết nối mạng).

tài liệu(tham chiếu, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể DocumentReference tham chiếu đến một tài liệu trong reference tại đường dẫn tương đối được chỉ định. Nếu bạn không chỉ định đường dẫn, thì hệ thống sẽ dùng một mã nhận dạng duy nhất được tạo tự động cho DocumentReference được trả về.

Chữ ký:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	CollectionReference<AppModelType, DbModelType>	Tham chiếu đến một bộ sưu tập.
đường dẫn	chuỗi	Đường dẫn đến một tài liệu được phân tách bằng dấu gạch chéo. Phải được bỏ qua để sử dụng mã nhận dạng được tạo tự động.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung sẽ được áp dụng tương ứng với đối số đầu tiên.

Trường hợp trả lại hàng:

DocumentReference<AppModelType, DbModelType>

Thực thể DocumentReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số đoạn lẻ và không trỏ đến tài liệu.

tài liệu(tham chiếu, đường dẫn, đường dẫn phân đoạn)

Lấy một thực thể DocumentReference tham chiếu đến một tài liệu trong reference tại đường dẫn tương đối được chỉ định.

Chữ ký:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu trên Firestore.
đường dẫn	chuỗi	Đường dẫn đến một tài liệu được phân tách bằng dấu gạch chéo.
path Segment (Phân đoạn đường dẫn)	chuỗi[]	Các phân đoạn đường dẫn bổ sung sẽ được áp dụng tương ứng với đối số đầu tiên.

Trường hợp trả lại hàng:

DocumentReference<DocumentData, documentData>

Thực thể DocumentReference.

Trường hợp ngoại lệ

Nếu đường dẫn cuối cùng có số đoạn lẻ và không trỏ đến tài liệu.

getDoc(tài liệu tham khảo)

Đọc tài liệu mà DocumentReference này dẫn đến.

Chữ ký:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu của tài liệu cần tìm nạp.

Trường hợp trả lại hàng:

Cam kết<DocumentSnapshot<AppModelType, DbModelType>>

Lời hứa đã được giải quyết bằng DocumentSnapshot chứa nội dung tài liệu hiện tại.

getDocFromCache(tham chiếu)

Đọc tài liệu mà DocumentReference này tham chiếu đến từ bộ nhớ đệm. Trả về lỗi nếu tài liệu hiện không được lưu vào bộ nhớ đệm.

Chữ ký:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>

Trường hợp trả lại hàng:

Cam kết<DocumentSnapshot<AppModelType, DbModelType>>

Promise đã được phân giải bằng DocumentSnapshot chứa nội dung tài liệu hiện tại.

getDocFromServer(tài liệu tham khảo)

Đọc tài liệu do DocumentReference này tham chiếu từ máy chủ. Trả về lỗi nếu không có mạng.

Chữ ký:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>

Trường hợp trả lại hàng:

Cam kết<DocumentSnapshot<AppModelType, DbModelType>>

Promise đã được phân giải bằng DocumentSnapshot chứa nội dung tài liệu hiện tại.

onSnapshot(tham chiếu, đối tượng tiếp nhận dữ liệu)

Đính kèm một trình nghe cho các sự kiện DocumentSnapshot. Bạn có thể truyền từng lệnh gọi lại onNext và onError hoặc truyền một đối tượng trình quan sát duy nhất thông qua các lệnh gọi lại next và error.

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu để nghe.
đối tượng tiếp nhận dữ liệu	{ tiếp theo?: (ảnh chụp nhanh: DocumentSnapshot<AppModelType, DbModelType>) => vô hiệu; lỗi?: (lỗi: FirestoreError) => vô hiệu; đã hoàn tất?: () => vô hiệu; }	Một đối tượng duy nhất chứa các lệnh gọi lại `next` và `error`.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(tham chiếu, tuỳ chọn, trình quan sát)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu để nghe.
tuỳ chọn	SnapshotListenOptions	Các tuỳ chọn kiểm soát hành vi nghe.
đối tượng tiếp nhận dữ liệu	{ tiếp theo?: (ảnh chụp nhanh: DocumentSnapshot<AppModelType, DbModelType>) => vô hiệu; lỗi?: (lỗi: FirestoreError) => vô hiệu; đã hoàn tất?: () => vô hiệu; }	Một đối tượng duy nhất chứa các lệnh gọi lại `next` và `error`.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(tham chiếu, onNext, onError, onCompletion)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu để nghe.
onNext	(ảnh chụp nhanh: DocumentSnapshot<AppModelType, DbModelType>) => trống	Lệnh gọi lại sẽ được gọi mỗi khi có `DocumentSnapshot` mới.
lỗi onError	(lỗi: FirestoreError) => trống	Lệnh gọi lại sẽ được gọi nếu lượt nghe không thành công hoặc bị huỷ. Sẽ không có lệnh gọi lại nào khác xảy ra.
hoàn thành	() => trống	Có thể cung cấp nhưng sẽ không được gọi vì luồng không bao giờ kết thúc.

Trường hợp trả lại hàng:

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

onSnapshot(tham chiếu, tuỳ chọn, onNext, onError, onCompletion)

Chữ ký:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu để nghe.
tuỳ chọn	SnapshotListenOptions	Các tuỳ chọn kiểm soát hành vi nghe.
onNext	(ảnh chụp nhanh: DocumentSnapshot<AppModelType, DbModelType>) => trống	Lệnh gọi lại sẽ được gọi mỗi khi có `DocumentSnapshot` mới.
lỗi onError	(lỗi: FirestoreError) => trống	Lệnh gọi lại sẽ được gọi nếu lượt nghe không thành công hoặc bị huỷ. Sẽ không có lệnh gọi lại nào khác xảy ra.
hoàn thành	() => trống	Có thể cung cấp nhưng sẽ không được gọi vì luồng không bao giờ kết thúc.

Trường hợp trả lại hàng:

MemoryLruGarbageCollector

Bạn có thể gọi hàm huỷ đăng ký để huỷ trình nghe tổng quan nhanh.

setDoc(tài liệu tham khảo, dữ liệu)

Ghi vào tài liệu được dẫn chiếu đến DocumentReference này. Nếu chưa có, tài liệu sẽ được tạo.

Chữ ký:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần viết.
dữ liệu	WithFieldValue<AppModelType>	Bản đồ các trường và giá trị cho tài liệu.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải sau khi dữ liệu đã được ghi thành công vào phần phụ trợ (lưu ý rằng lỗi sẽ không phân giải khi bạn không có kết nối mạng).

setDoc(tài liệu tham khảo, dữ liệu, tuỳ chọn)

Ghi vào tài liệu được tham chiếu đến DocumentReference được chỉ định. Nếu chưa có, tài liệu sẽ được tạo. Nếu cung cấp merge hoặc mergeFields, bạn có thể hợp nhất dữ liệu được cung cấp vào một tài liệu hiện có.

Chữ ký:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần viết.
dữ liệu	Một phầnWithFieldValue<AppModelType>	Bản đồ các trường và giá trị cho tài liệu.
tuỳ chọn	SetOptions	Đối tượng để định cấu hình hành vi đã đặt.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Lời hứa được phân giải sau khi dữ liệu được ghi thành công vào phần phụ trợ (lưu ý rằng lời hứa sẽ không phân giải khi bạn không có kết nối mạng).

updateDoc(tài liệu tham khảo, dữ liệu)

Cập nhật các trường trong tài liệu mà DocumentReference được chỉ định tham chiếu đến. Nội dung cập nhật sẽ không thành công nếu áp dụng cho một tài liệu không tồn tại.

Chữ ký:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần cập nhật.
dữ liệu	UpdateData<DbModelType>	Một đối tượng chứa các trường và giá trị cần cập nhật tài liệu. Các trường có thể chứa dấu chấm để tham chiếu đến các trường lồng nhau trong tài liệu.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải sau khi dữ liệu đã được ghi thành công vào phần phụ trợ (lưu ý rằng lỗi sẽ không phân giải khi bạn không có kết nối mạng).

updateDoc(tham chiếu; trường; giá trị; moreFieldsAndValues)

Các trường cập nhật trong tài liệu do DocumentReference chỉ định tham chiếu đến. Quá trình cập nhật sẽ không thành công nếu được áp dụng cho một tài liệu không tồn tại.

Bạn có thể cập nhật các trường lồng nhau bằng cách cung cấp các chuỗi đường dẫn trường được phân tách bằng dấu chấm hoặc bằng cách cung cấp các đối tượng FieldPath.

Chữ ký:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Thông số

Thông số	Loại	Mô tả
tham chiếu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần cập nhật.
trường	chuỗi \| FieldPath (Đường dẫn trường)	Trường đầu tiên để cập nhật.
value	không xác định	Giá trị đầu tiên.
moreFieldsAndValues	không xác định[]	Cặp khoá-giá trị bổ sung.

Trường hợp trả lại hàng:

Lời hứa<vô hiệu>

Promise được phân giải sau khi dữ liệu đã được ghi thành công vào phần phụ trợ (lưu ý rằng lỗi sẽ không phân giải khi bạn không có kết nối mạng).

chức năng(cài đặt, ...)

MemoryLocalCache(cài đặt)

Tạo một thực thể của MemoryLocalCache. Bạn có thể đặt thực thể này thành FirestoreSettings.cache để cho SDK biết cần sử dụng lớp bộ nhớ đệm nào.

Chữ ký:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

Thông số

Thông số	Loại	Mô tả
cài đặt	MemoryCacheSettings (Cài đặt bộ nhớ)

Trường hợp trả lại hàng:

MemoryLocalCache

MemoryLruGarbageCollector(cài đặt)

Tạo một thực thể của MemoryLruGarbageCollector.

Bạn có thể chỉ định kích thước mục tiêu trong thông số cài đặt. Trình thu thập sẽ bắt đầu xoá tài liệu sau khi kích thước bộ nhớ đệm vượt quá kích thước đã cho. Kích thước bộ nhớ đệm mặc định là 40MB (40 * 1024 * 1024 byte).

Chữ ký:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

Thông số

Thông số	Loại	Mô tả
cài đặt	{ cacheSizeBytes?: number; }

Trường hợp trả lại hàng:

Liên tục LocalCache(cài đặt)

Tạo một thực thể của PersistentLocalCache. Bạn có thể đặt thực thể này thành FirestoreSettings.cache để cho SDK biết cần sử dụng lớp bộ nhớ đệm nào.

Không thể sử dụng bộ nhớ đệm liên tục trong môi trường Node.js.

Chữ ký:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

Thông số

Thông số	Loại	Mô tả
cài đặt	PersistentCacheSettings

Trường hợp trả lại hàng:

PersistentLocalCache

cố địnhSingleTabManager(chế độ cài đặt)

Tạo một thực thể của PersistentSingleTabManager.

Chữ ký:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

Thông số

Thông số	Loại	Mô tả
cài đặt	PersistentSingleTabManagerSettings \| chưa xác định	Định cấu hình trình quản lý thẻ đã tạo.

Trường hợp trả lại hàng:

PersistentSingleTabManager

chức năng(ảnh chụp nhanh, ...)

endAt(ảnh chụp nhanh)

Tạo một QueryEndAtConstraint để sửa đổi kết quả được đặt thành kết thúc tại tài liệu được cung cấp (bao gồm). Vị trí kết thúc tương ứng với thứ tự của truy vấn. Tài liệu phải chứa tất cả các trường được cung cấp theo thứ tự OrderBy của truy vấn.

Chữ ký:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Thông số

Thông số	Loại	Mô tả
ảnh chụp nhanh	DocumentSnapshot<AppModelType, DbModelType>	Ảnh chụp nhanh của tài liệu cần kết thúc vào.

Trường hợp trả lại hàng:

QueryEndAtConstraint để truyền đến query()

endTrước(ảnh chụp nhanh)

Tạo một QueryEndAtConstraint để sửa đổi kết quả đã đặt thành kết thúc trước tài liệu được cung cấp (độc quyền). Vị trí kết thúc tương ứng với thứ tự của truy vấn. Tài liệu phải chứa tất cả các trường được cung cấp theo thứ tự OrderBy của truy vấn.

Chữ ký:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Thông số

Thông số	Loại	Mô tả
ảnh chụp nhanh	DocumentSnapshot<AppModelType, DbModelType>	Ảnh chụp nhanh của tài liệu cần kết thúc trước đó.

Trường hợp trả lại hàng:

QueryEndAtConstraint để truyền đến query()

startSau(ảnh chụp nhanh)

Tạo một QueryStartAtConstraint giúp sửa đổi nhóm kết quả để bắt đầu sau tài liệu được cung cấp (độc quyền). Vị trí bắt đầu tương ứng với thứ tự của truy vấn. Tài liệu phải chứa tất cả các trường được cung cấp theo thứ tự OrderBy của truy vấn.

Chữ ký:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Thông số

Thông số	Loại	Mô tả
ảnh chụp nhanh	DocumentSnapshot<AppModelType, DbModelType>	Ảnh chụp nhanh của tài liệu để bắt đầu sau đó.

Trường hợp trả lại hàng:

QueryStartAtConstraint để truyền đến query()

startAt(ảnh chụp nhanh)

Tạo một QueryStartAtConstraint nhằm sửa đổi tập hợp kết quả để bắt đầu từ tài liệu đã cung cấp (bao gồm). Vị trí bắt đầu tương ứng với thứ tự của truy vấn. Tài liệu phải chứa tất cả các trường được cung cấp trong orderBy của truy vấn này.

Chữ ký:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Thông số

Thông số	Loại	Mô tả
ảnh chụp nhanh	DocumentSnapshot<AppModelType, DbModelType>	Ảnh chụp nhanh của tài liệu để bắt đầu.

Trường hợp trả lại hàng: