WriteBatch class

Một lô ghi, dùng để ghi nhiều lần dưới dạng một đơn vị nguyên tử.

Bạn có thể thu nạp đối tượng WriteBatch bằng cách gọi writeBatch(). Lớp này cung cấp các phương thức để thêm các lượt ghi vào lô ghi. Không có lượt ghi nào được cam kết (hoặc hiển thị trên thiết bị) cho đến khi WriteBatch.commit() được gọi.

Chữ ký:

export declare class WriteBatch 

Phương thức

Phương thức	Công cụ sửa đổi	Mô tả
commit()		Xác nhận tất cả các lượt ghi trong lô ghi này dưới dạng một đơn vị nguyên tử.Kết quả của các lượt ghi này sẽ chỉ được phản ánh trong các lần đọc tài liệu xảy ra sau khi hàm đảm bảo được trả về phân giải. Nếu ứng dụng không có kết nối mạng, thì quá trình ghi sẽ không thành công. Nếu bạn muốn xem nội dung sửa đổi cục bộ hoặc ghi vùng đệm cho đến khi ứng dụng có kết nối mạng, hãy sử dụng toàn bộ SDK Firestore.
delete(documentRef)		Xoá tài liệu do DocumentReference cung cấp,
set(documentRef; data)		Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo.
set(documentRef; dữ liệu; tuỳ chọn)		Ghi vào tài liệu do DocumentReference cung cấp, 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 mà bạn cung cấp vào một tài liệu hiện có.
update(documentRef; data)		Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. 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.
update(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. 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 chuỗi đường dẫn trường được phân tách bằng dấu chấm hoặc cung cấp các đối tượng FieldPath.

Viết lô.commit()

Xác nhận tất cả lượt ghi trong lô ghi này dưới dạng một đơn vị nguyên tử.

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

Chữ ký:

commit(): Promise<void>;

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

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

Promise được phân giải sau khi tất cả lượt ghi trong lô đã được ghi thành công vào phần phụ trợ ở dạng đơn vị nguyên tử (lưu ý rằng lỗi này sẽ không phân giải khi bạn không có kết nối mạng).

WriteBatch.delete()

Xoá tài liệu do DocumentReference cung cấp,

Chữ ký:

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

Thông số

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

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

WriteBatch

Thực thể WriteBatch này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Viết lô.set()

Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo.

Chữ ký:

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

Thông số

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

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

WriteBatch

Thực thể WriteBatch này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Viết lô.set()

Ghi vào tài liệu do DocumentReference cung cấp, 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ý:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần đặt.
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.
tuỳ chọn	SetOptions	Đối tượng để định cấu hình hành vi đã đặt.

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

WriteBatch

Thực thể WriteBatch này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

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

Lỗi – Nếu thông tin đầu vào mà bạn cung cấp không phải là tài liệu hợp lệ trên Firestore.

Viết lô.update()

Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. 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ý:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần được 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:

WriteBatch

Thực thể WriteBatch này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp 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ệ.

Viết lô.update()

Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference này. 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.

Bạn có thể cập nhật các trường lồng nhau bằng cách cung cấp chuỗi đường dẫn trường được phân tách bằng dấu chấm hoặc 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ố

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần được 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:

WriteBatch

Thực thể WriteBatch này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp 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ệ.