WriteBatch class

Lô ghi, được sử dụng để thực hiện nhiều thao tác ghi dưới dạng một đơn vị nguyên tử.

Một đối tượng WriteBatch có thể được lấy bằng cách gọi writeBatch() . Nó cung cấp các phương thức để thêm ghi vào lô ghi. Sẽ không có thao tác ghi nào được cam kết (hoặc hiển thị cục bộ) cho đến khi WriteBatch.commit() được gọi.

Chữ ký:

export declare class WriteBatch

phương pháp

Phương pháp sửa đổi Sự miêu tả
làm() Cam kết tất cả các lần ghi trong đợt ghi này dưới dạng một đơn vị nguyên tử duy nhất. Kết quả của việc ghi này sẽ chỉ được phản ánh trong các lần đọc tài liệu xảy ra sau khi lời hứa được trả lại được giải quyết. Nếu máy khách ngoại tuyến thì việc ghi không thành công. Nếu bạn muốn xem các sửa đổi cục bộ hoặc ghi vào bộ đệm cho đến khi máy khách trực tuyến, hãy sử dụng SDK Firestore đầy đủ.
xóa(tài liệuRef) Xóa tài liệu được tham chiếu bởi DocumentReference được cung cấp .
set(documentRef, data) Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo.
set(documentRef, data, options) Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo. Nếu bạn cung cấp merge hoặc mergeFields , dữ liệu được cung cấp có thể được hợp nhất vào tài liệu hiện có.
cập nhật(tài liệuRef, dữ liệu) Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại.
cập nhật (documentRef, trường, giá trị, moreFieldsAndValues) Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference này . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại. Các trường lồng nhau có thể được cập nhật 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 .

WriteBatch.commit()

Cam kết tất cả các lần ghi trong đợt ghi này dưới dạng một đơn vị nguyên tử duy nhất.

Kết quả của việc ghi này sẽ chỉ được phản ánh trong các lần đọc tài liệu xảy ra sau khi lời hứa được trả lại được giải quyết. Nếu máy khách ngoại tuyến thì việc ghi không thành công. Nếu bạn muốn xem các sửa đổi cục bộ hoặc ghi vào bộ đệm cho đến khi máy khách trực tuyến, hãy sử dụng SDK Firestore đầy đủ.

Chữ ký:

commit(): Promise<void>;

Trả về:

Hứa<void>

Promise được giải quyết sau khi tất cả nội dung ghi trong lô đã được ghi thành công vào phần phụ trợ dưới dạng đơn vị nguyên tử (lưu ý rằng nó sẽ không được giải quyết khi bạn ngoại tuyến).

WriteBatch.delete()

Xóa tài liệu được tham chiếu bởi DocumentReference được cung cấp .

Chữ ký:

delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ bị xóa.

Trả về:

Viết hàng loạt

Ví dụ WriteBatch này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

WriteBatch.set()

Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo.

Chữ ký:

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được thiết lập.
dữ liệu Với giá trị trường <AppModelType> Đối tượng của các trường và giá trị cho tài liệu.

Trả về:

Viết hàng loạt

Ví dụ WriteBatch này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

WriteBatch.set()

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

Chữ ký:

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được thiết lập.
dữ liệu Một phầnWithFieldValue <AppModelType> Đối tượng của các trường và giá trị cho tài liệu.
tùy chọn Đặt tùy chọn Một đối tượng để cấu hình hành vi đã thiết lập.

Trả về:

Viết hàng loạt

Ví dụ WriteBatch này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Ngoại lệ

Lỗi - Nếu thông tin đầu vào được cung cấp không phải là tài liệu Firestore hợp lệ.

WriteBatch.update()

Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại.

Chữ ký:

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được cập nhật.
dữ liệu Cập nhật dữ liệu <DbModelType> Một đối tượng chứa các trường và giá trị để cập nhật tài liệu. Các trường có thể chứa dấu chấm để tham chiếu các trường lồng nhau trong tài liệu.

Trả về:

Viết hàng loạt

Ví dụ WriteBatch này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Ngoại lệ

Lỗi - Nếu dữ liệu đầu vào được cung cấp không phải là dữ liệu Firestore hợp lệ.

WriteBatch.update()

Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference này . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại.

Các trường lồng nhau có thể được cập nhật 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ý:

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được cập nhật.
cánh đồng chuỗi | Đường dẫn trường Trường đầu tiên được cập nhật.
giá trị không xác định Giá trị đầu tiên.
thêmFieldsAndValues không xác định[] Cặp giá trị khóa bổ sung.

Trả về:

Viết hàng loạt

Ví dụ WriteBatch này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Ngoại lệ

Lỗi - Nếu dữ liệu đầu vào được cung cấp không phải là dữ liệu Firestore hợp lệ.